Merge pull request #19 from miles-grant-ibigroup/master

Add Typescript Types

.github/workflows/node-ci.yml

@@ -0,0 +1,37 @@
+name: Node.js CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js 14
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14.x
+      - name: Install npm packages using cache
+        uses: bahmutov/npm-install@v1
+        with:
+          # the IBI Group TSDX fork has some dependency issues
+          # that cause yarn install to fail on a ci runner. Disabling
+          # concurrency allows installation to complete successfully
+          install-command: yarn --frozen-lockfile --network-concurrency 1
+      - name: Lint Code
+        run: yarn lint
+      - name: Lint Docs
+        run: yarn lint-docs
+      - name: Test Code
+        run: yarn jest
+      - name: Build Package
+        run: yarn build
+
+      # at this point, the build is successful
+      - name: Semantic Release
+        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: yarn semantic-release

.gitignore

@@ -23,6 +23,7 @@ tmp
 
 # Compiled binary addons (http://nodejs.org/api/addons.html)
 build/Release
+dist/
 
 # Dependency directory
 node_modules
@@ -32,3 +33,9 @@ node_modules
 
 # Optional REPL history
 .node_repl_history
+
+# MacOS
+.DS_Store
+
+# Typescript type files
+*.d.ts

.npmignore

@@ -0,0 +1,6 @@
+# Coverage directory used by tools like istanbul
+coverage
+tmp
+
+# Lock file
+yarn.lock