Skip to content

ALPHA: next alpha release. proxy, CORs, README rewrite#185

Merged
lukeocodes merged 11 commits into
alphafrom
lo/scoped-fetch-options
Nov 1, 2023
Merged

ALPHA: next alpha release. proxy, CORs, README rewrite#185
lukeocodes merged 11 commits into
alphafrom
lo/scoped-fetch-options

Conversation

@lukeocodes

@lukeocodes lukeocodes commented Oct 26, 2023

Copy link
Copy Markdown
Member

feat: overhaul client interfaces for passing options to scoped functionality
feat: overhaul scoped options to pass them through the call stack
feat: add proxy options for REST calls in the browser
feat: error for browser REST calls without proxy
feat(docs): rewrite readme for v3 of the JS SDK

@codecov-commenter

codecov-commenter commented Oct 26, 2023

Copy link
Copy Markdown

Codecov Report

Attention: 96 lines in your changes are missing coverage. Please review.

Comparison is base (a789b86) 70.30% compared to head (500830f) 16.09%.

Additional details and impacted files
@@             Coverage Diff             @@
##            alpha     #185       +/-   ##
===========================================
- Coverage   70.30%   16.09%   -54.22%     
===========================================
  Files          16       18        +2     
  Lines         522      553       +31     
  Branches      101      112       +11     
===========================================
- Hits          367       89      -278     
- Misses        128      463      +335     
+ Partials       27        1       -26     
Files Coverage Δ
src/lib/constants.ts 87.50% <100.00%> (+1.78%) ⬆️
src/index.ts 77.77% <50.00%> (-22.23%) ⬇️
src/lib/helpers.ts 37.50% <50.00%> (-20.08%) ⬇️
src/packages/PrerecordedClient.ts 6.66% <0.00%> (-54.63%) ⬇️
src/DeepgramClient.ts 62.50% <40.00%> (-29.17%) ⬇️
src/packages/ListenClient.ts 57.14% <50.00%> (-42.86%) ⬇️
src/packages/OnPremClient.ts 7.50% <0.00%> (-62.50%) ⬇️
src/packages/LiveClient.ts 13.20% <35.71%> (-52.80%) ⬇️
src/packages/AbstractRestfulClient.ts 13.88% <20.00%> (-47.41%) ⬇️
src/packages/AbstractWsClient.ts 20.00% <20.00%> (ø)
... and 2 more

... and 2 files with indirect coverage changes

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

@lukeocodes lukeocodes removed the wip label Oct 27, 2023
@lukeocodes lukeocodes added this to the Node SDK v3 Release milestone Oct 27, 2023
@lukeocodes lukeocodes changed the title feat: overhaul of client interfaces and scoped options feat: addresses CORS limitations on the Deepgram REST API Oct 27, 2023
SandraRodgers
SandraRodgers previously approved these changes Oct 27, 2023
SandraRodgers
SandraRodgers previously approved these changes Oct 31, 2023
@lukeocodes lukeocodes changed the title feat: addresses CORS limitations on the Deepgram REST API [ALPHA] - next alpha release. proxy, CORs, README rewrite Nov 1, 2023
@lukeocodes lukeocodes changed the title [ALPHA] - next alpha release. proxy, CORs, README rewrite ALPHA: next alpha release. proxy, CORs, README rewrite Nov 1, 2023
@lukeocodes lukeocodes merged commit 972f8d8 into alpha Nov 1, 2023
@lukeocodes lukeocodes deleted the lo/scoped-fetch-options branch November 1, 2023 14:24
lukeocodes added a commit that referenced this pull request Nov 2, 2023
* 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>
lukeocodes added a commit that referenced this pull request Nov 29, 2023
* 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 <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: 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 <111262684+ftr-lwilson@users.noreply.github.com>
Co-authored-by: Sandra Rodgers <45321563+SandraRodgers@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants