Skip to content

Release: JS SDK V3#208

Merged
lukeocodes merged 7 commits into
mainfrom
lo/js-sdk-v3-release
Nov 29, 2023
Merged

Release: JS SDK V3#208
lukeocodes merged 7 commits into
mainfrom
lo/js-sdk-v3-release

Conversation

@lukeocodes

Copy link
Copy Markdown
Member

Notable Changes

  • ESM and UMD support
  • WebVTT and SRT captions published as a standalone package
  • Separate async and sync transcription methods.
  • JavaScript and Node.js friendly (isomorphic)
  • Improved live transcription events
  • Switch from request to fetch
  • Initialization by function instead of class
  • Scoped constructor config
  • Better error handling
  • Support for future products
  • Support for on-prem deployments

lukeocodes and others added 7 commits November 2, 2023 13:31
* 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 <111262684+ftr-lwilson@users.noreply.github.com>

* 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 <45321563+SandraRodgers@users.noreply.github.com>

---------

Co-authored-by: Luke Wilson <111262684+ftr-lwilson@users.noreply.github.com>
Co-authored-by: Sandra Rodgers <45321563+SandraRodgers@users.noreply.github.com>
* fix: closing the socket too early (#201)

* fix: a wild fix for this has appeared (#200)
@lukeocodes lukeocodes self-assigned this Nov 29, 2023
@lukeocodes lukeocodes added the enhancement New feature or request label Nov 29, 2023
@lukeocodes lukeocodes added this to the Node SDK v3 Release milestone Nov 29, 2023
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (main@95f9291). Click here to learn what that means.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #208   +/-   ##
=======================================
  Coverage        ?   69.75%           
=======================================
  Files           ?       19           
  Lines           ?      562           
  Branches        ?      109           
=======================================
  Hits            ?      392           
  Misses          ?      140           
  Partials        ?       30           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lukeocodes lukeocodes merged commit 2734f69 into main Nov 29, 2023
@lukeocodes lukeocodes deleted the lo/js-sdk-v3-release branch November 29, 2023 21:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants