search

deepgram / deepgram-js-sdk

Official JavaScript SDK for Deepgram's automated speech recognition APIs.
https://developers.deepgram.com
MIT License
127 stars 45 forks source link

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

Closed lukeocodes closed 8 months ago

lukeocodes commented 8 months ago

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 commented 8 months ago

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 ```diff @@ 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](https://app.codecov.io/gh/deepgram/deepgram-node-sdk/pull/185?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepgram) | Coverage Δ | | |---|---|---| | [src/lib/constants.ts](https://app.codecov.io/gh/deepgram/deepgram-node-sdk/pull/185?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepgram#diff-c3JjL2xpYi9jb25zdGFudHMudHM=) | `87.50% <100.00%> (+1.78%)` | :arrow_up: | | [src/index.ts](https://app.codecov.io/gh/deepgram/deepgram-node-sdk/pull/185?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepgram#diff-c3JjL2luZGV4LnRz) | `77.77% <50.00%> (-22.23%)` | :arrow_down: | | [src/lib/helpers.ts](https://app.codecov.io/gh/deepgram/deepgram-node-sdk/pull/185?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepgram#diff-c3JjL2xpYi9oZWxwZXJzLnRz) | `37.50% <50.00%> (-20.08%)` | :arrow_down: | | [src/packages/PrerecordedClient.ts](https://app.codecov.io/gh/deepgram/deepgram-node-sdk/pull/185?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepgram#diff-c3JjL3BhY2thZ2VzL1ByZXJlY29yZGVkQ2xpZW50LnRz) | `6.66% <0.00%> (-54.63%)` | :arrow_down: | | [src/DeepgramClient.ts](https://app.codecov.io/gh/deepgram/deepgram-node-sdk/pull/185?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepgram#diff-c3JjL0RlZXBncmFtQ2xpZW50LnRz) | `62.50% <40.00%> (-29.17%)` | :arrow_down: | | [src/packages/ListenClient.ts](https://app.codecov.io/gh/deepgram/deepgram-node-sdk/pull/185?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepgram#diff-c3JjL3BhY2thZ2VzL0xpc3RlbkNsaWVudC50cw==) | `57.14% <50.00%> (-42.86%)` | :arrow_down: | | [src/packages/OnPremClient.ts](https://app.codecov.io/gh/deepgram/deepgram-node-sdk/pull/185?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepgram#diff-c3JjL3BhY2thZ2VzL09uUHJlbUNsaWVudC50cw==) | `7.50% <0.00%> (-62.50%)` | :arrow_down: | | [src/packages/LiveClient.ts](https://app.codecov.io/gh/deepgram/deepgram-node-sdk/pull/185?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepgram#diff-c3JjL3BhY2thZ2VzL0xpdmVDbGllbnQudHM=) | `13.20% <35.71%> (-52.80%)` | :arrow_down: | | [src/packages/AbstractRestfulClient.ts](https://app.codecov.io/gh/deepgram/deepgram-node-sdk/pull/185?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepgram#diff-c3JjL3BhY2thZ2VzL0Fic3RyYWN0UmVzdGZ1bENsaWVudC50cw==) | `13.88% <20.00%> (-47.41%)` | :arrow_down: | | [src/packages/AbstractWsClient.ts](https://app.codecov.io/gh/deepgram/deepgram-node-sdk/pull/185?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepgram#diff-c3JjL3BhY2thZ2VzL0Fic3RyYWN0V3NDbGllbnQudHM=) | `20.00% <20.00%> (ø)` | | | ... and [2 more](https://app.codecov.io/gh/deepgram/deepgram-node-sdk/pull/185?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepgram) | | ... and [2 files with indirect coverage changes](https://app.codecov.io/gh/deepgram/deepgram-node-sdk/pull/185/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepgram)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.