Release: JS SDK V3 (#208)

* feat!: promote v3.0.0-alpha.12 to v3.0.0-beta (#187)

* feat!: create new structure for isomorphic SDK

* feat: add commitlint

* feat: add test coverage for client

* chore: remove unused variables

* feat: sort out default options, tests for helpers

* fix: remove postinstall script

* chore: updating various bits and constants

* feat: laying out the structure of the new library

* feat: get requests working

* feat: add tests, prerecorded samples, prerecorded requests

* feat: working live transcription

* feat: rejig the architecture to more closely reflect the documented high-level architecture plan

* feat: storing the API domain as a URL object, easier to pass around all clients

* fix: missing endpoint from fetch requests to the API

* chore: update integration test samples for new usage pattern

* feat: types rewriten for all endpoints

* feat: add tests for making transcription requests

* fix: rename listen test to prerecorded test

* chore: reorder some imports for tidiness

* fix: rename project API to manage API in the main client

* feat: added manage and onprem tests, fixed issues caught by tests

* feat: large amount of tests, websocket tests, test server changes, fixes to types

* feat: test server and dockerfile

* feat: use the mock server's current address to run tests against

* feat: fixes to live stream client

* fix: fix event types

* fix: working live

* fix: string should be integer

* chore: link to RFC for conforming code

* chore: configure prerelease channels

* fix: case-sensitive file system issues on mac

* feat: marking alpha as a major release version (#166)

BREAKING CHANGE: complete rearchitecture of the Node/JavaScript SDK to work in browsers and Node.

* feat: export types and enums from main module (#167)

* feat: export enums and types from the main module

* fix: fix CI workflow not finding coverage report

* chore: switch from coveralls to codecov

* feat: remove test server code from sdk repo, and fix tests (#170)

* feat: remove duplicate example apps (#172)

* feat: update workflows so PRs run on all release channel PRs (#175)

* chore: ran npm audit

* chore: update workflows so CI runs on alpha pulls

* feat: remove mimetype requirement from batch requests (rfc #4) (#177)

* feat: remove mimetype requirement from local file transcirption (rfc #4)

* fix: fix stray array of boolean type (#179)

* feat: making schema's possible from request types (#180)

* feat: any typing of request options renamed to schema for schema type generation

* feat: rename request options types to schema

* feat: remove json from this repo

* fix: default to application/json when not provided deepgram/audio+video content-type (#181)

* fix: blob datatype issues where blob as arraybufferlike had no bytelength (#182)

* fix: remove unused package from lock

* fix: fixed blob data type issue where blob as arraybufferlike had no bytelength in the browser

* fix: remove erroneous browser check

* fix: we need node 18 to be blob friendly

* fix(types): nested arrays defined as singular tuples incorrectly (#184)

* fix(types): nested arrays in LiveTranscriptionEvent (#183)

* fix(types): this many array types were defined as singlular tuples - whoops

* chore(test): update tests for new mock API url

---------

Co-authored-by: Luke Wilson <[email protected]>

* feat: proxy, CORs, README rewrite (#185)

* feat: overhaul client interfaces and scoped option handling

* feat: add proxy options for REST calls in the browser, error for browser REST calls without proxy

* chore: update code snippets for v-3 (#186)

* chore: remove unused packages/vars

* feat: add captions as a dependency

* feat: small changes to docs

* feat: smol changes to README

* feat: smol changes to README again

* fix(readme): remove version from ESM include example

* fix(dependency): fix dependency issue caused by adding the captions library

* feat: export client/packages from the entryfile

---------

Co-authored-by: Sandra Rodgers <[email protected]>

---------

Co-authored-by: Luke Wilson <[email protected]>
Co-authored-by: Sandra Rodgers <[email protected]>

* fix: fix dependency issues up and downstream (#188)

* fix: find a fix to allow the client to work in either websocket environment (#199)

* fix: fixes issues 197 and 198 (#202)

* fix: closing the socket too early (#201)

* fix: a wild fix for this has appeared (#200)

* chore: update examples to match console missions [no ci] (#204)

* feat: update websocket to use w3cwebsocket for node/browser/edge worker examples (#205)

* feat: tightly couple the api key to the proxy logic, so an api can't mistakenly be made public (#206)

---------

Co-authored-by: Luke Wilson <[email protected]>
Co-authored-by: Sandra Rodgers <[email protected]>

.dockerignore

@@ -0,0 +1,110 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.DS_Store
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+docs/v2
+
+# testing
+testServer/

.github/workflows/CI.yml

@@ -1,30 +1,55 @@
 name: CI
 
 on:
-  push:
-    branches: [ main ]
   pull_request:
-    branches: [ main ]
+    branches:
+      - main
+      - next
+      - rc
+      - beta
+      - alpha
+    paths-ignore:
+      - "docs/**"
+      - "**/*.md"
+      - ".prettierrc"
+      - "**/*ignore"
+  push:
+    branches:
+      - main
+      - next
+      - rc
+      - beta
+      - alpha
+    paths-ignore:
+      - "docs/**"
+      - "**/*.md"
+      - ".prettierrc"
+      - "**/*ignore"
+
 jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 12
-
-      - name: Update Version in package.json
-        run: sed -i 's/X.X.X/0.0.1/g' ./package.json
+  test:
+    name: Test / OS ${{ matrix.os }} / Node ${{ matrix.node }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node: ["18"]
+
+    runs-on: ${{ matrix.os }}
 
-      - name: Install Dependencies
-        run: npm install
+    steps:
+      - uses: actions/checkout@v3
 
-      - name: Run Tests
-        run: npm run test
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
 
-      - name: Lint Source
-        run: npm run lint
+      - name: Run tests
+        run: |
+          npm clean-install
+          npm run test:coverage
 
-      - name: Build TypeScript
-        run: npm run build
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/docs.yml

@@ -0,0 +1,38 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  docs:
+    name: Publish docs / OS ${{ matrix.os }} / Node ${{ matrix.node }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node: ["18"]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+
+      - run: |
+          npm ci
+          npm run docs
+          npm run docs:json
+
+      - name: Publish
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs
+          force_orphan: true
+          commit_message: "docs: update"

.github/workflows/release.yml

@@ -0,0 +1,38 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+      - next
+      - rc
+      - beta
+      - alpha
+  workflow_dispatch:
+
+jobs:
+  release:
+    name: Release / Node ${{ matrix.node }}
+    strategy:
+      matrix:
+        node: ["18"]
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+
+      - run: |
+          npm ci
+          npm run build
+
+      - name: Create a release
+        run: npx semantic-release@^18.0.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}