@deepgram/sdk 3.5.1 → 3.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. package/README.md +22 -0
  2. package/dist/main/DeepgramClient.d.ts +7 -1
  3. package/dist/main/DeepgramClient.d.ts.map +1 -1
  4. package/dist/main/DeepgramClient.js +8 -0
  5. package/dist/main/DeepgramClient.js.map +1 -1
  6. package/dist/main/lib/enums/LiveTTSEvents.d.ts +34 -0
  7. package/dist/main/lib/enums/LiveTTSEvents.d.ts.map +1 -0
  8. package/dist/main/lib/enums/LiveTTSEvents.js +38 -0
  9. package/dist/main/lib/enums/LiveTTSEvents.js.map +1 -0
  10. package/dist/main/lib/enums/index.d.ts +1 -0
  11. package/dist/main/lib/enums/index.d.ts.map +1 -1
  12. package/dist/main/lib/enums/index.js +1 -0
  13. package/dist/main/lib/enums/index.js.map +1 -1
  14. package/dist/main/lib/types/GetModelsResponse.d.ts +24 -0
  15. package/dist/main/lib/types/GetModelsResponse.d.ts.map +1 -0
  16. package/dist/main/lib/types/GetModelsResponse.js +3 -0
  17. package/dist/main/lib/types/GetModelsResponse.js.map +1 -0
  18. package/dist/main/lib/types/GetModelsSchema.d.ts +4 -0
  19. package/dist/main/lib/types/GetModelsSchema.d.ts.map +1 -0
  20. package/dist/main/lib/types/GetModelsSchema.js +3 -0
  21. package/dist/main/lib/types/GetModelsSchema.js.map +1 -0
  22. package/dist/main/lib/types/index.d.ts +2 -0
  23. package/dist/main/lib/types/index.d.ts.map +1 -1
  24. package/dist/main/lib/types/index.js +2 -0
  25. package/dist/main/lib/types/index.js.map +1 -1
  26. package/dist/main/lib/version.d.ts +1 -1
  27. package/dist/main/lib/version.js +1 -1
  28. package/dist/main/packages/ManageRestClient.d.ts +44 -1
  29. package/dist/main/packages/ManageRestClient.d.ts.map +1 -1
  30. package/dist/main/packages/ManageRestClient.js +71 -0
  31. package/dist/main/packages/ManageRestClient.js.map +1 -1
  32. package/dist/main/packages/ModelsRestClient.d.ts +53 -0
  33. package/dist/main/packages/ModelsRestClient.d.ts.map +1 -0
  34. package/dist/main/packages/ModelsRestClient.js +97 -0
  35. package/dist/main/packages/ModelsRestClient.js.map +1 -0
  36. package/dist/main/packages/SpeakClient.d.ts +27 -0
  37. package/dist/main/packages/SpeakClient.d.ts.map +1 -0
  38. package/dist/main/packages/SpeakClient.js +37 -0
  39. package/dist/main/packages/SpeakClient.js.map +1 -0
  40. package/dist/main/packages/SpeakLiveClient.d.ts +67 -0
  41. package/dist/main/packages/SpeakLiveClient.d.ts.map +1 -0
  42. package/dist/main/packages/SpeakLiveClient.js +148 -0
  43. package/dist/main/packages/SpeakLiveClient.js.map +1 -0
  44. package/dist/main/packages/SpeakRestClient.d.ts +0 -1
  45. package/dist/main/packages/SpeakRestClient.d.ts.map +1 -1
  46. package/dist/main/packages/SpeakRestClient.js +1 -2
  47. package/dist/main/packages/SpeakRestClient.js.map +1 -1
  48. package/dist/main/packages/index.d.ts +3 -0
  49. package/dist/main/packages/index.d.ts.map +1 -1
  50. package/dist/main/packages/index.js +3 -0
  51. package/dist/main/packages/index.js.map +1 -1
  52. package/dist/module/DeepgramClient.d.ts +7 -1
  53. package/dist/module/DeepgramClient.d.ts.map +1 -1
  54. package/dist/module/DeepgramClient.js +9 -1
  55. package/dist/module/DeepgramClient.js.map +1 -1
  56. package/dist/module/lib/enums/LiveTTSEvents.d.ts +34 -0
  57. package/dist/module/lib/enums/LiveTTSEvents.d.ts.map +1 -0
  58. package/dist/module/lib/enums/LiveTTSEvents.js +35 -0
  59. package/dist/module/lib/enums/LiveTTSEvents.js.map +1 -0
  60. package/dist/module/lib/enums/index.d.ts +1 -0
  61. package/dist/module/lib/enums/index.d.ts.map +1 -1
  62. package/dist/module/lib/enums/index.js +1 -0
  63. package/dist/module/lib/enums/index.js.map +1 -1
  64. package/dist/module/lib/types/GetModelsResponse.d.ts +24 -0
  65. package/dist/module/lib/types/GetModelsResponse.d.ts.map +1 -0
  66. package/dist/module/lib/types/GetModelsResponse.js +2 -0
  67. package/dist/module/lib/types/GetModelsResponse.js.map +1 -0
  68. package/dist/module/lib/types/GetModelsSchema.d.ts +4 -0
  69. package/dist/module/lib/types/GetModelsSchema.d.ts.map +1 -0
  70. package/dist/module/lib/types/GetModelsSchema.js +2 -0
  71. package/dist/module/lib/types/GetModelsSchema.js.map +1 -0
  72. package/dist/module/lib/types/index.d.ts +2 -0
  73. package/dist/module/lib/types/index.d.ts.map +1 -1
  74. package/dist/module/lib/types/index.js +2 -0
  75. package/dist/module/lib/types/index.js.map +1 -1
  76. package/dist/module/lib/version.d.ts +1 -1
  77. package/dist/module/lib/version.js +1 -1
  78. package/dist/module/packages/ManageRestClient.d.ts +44 -1
  79. package/dist/module/packages/ManageRestClient.d.ts.map +1 -1
  80. package/dist/module/packages/ManageRestClient.js +71 -0
  81. package/dist/module/packages/ManageRestClient.js.map +1 -1
  82. package/dist/module/packages/ModelsRestClient.d.ts +53 -0
  83. package/dist/module/packages/ModelsRestClient.d.ts.map +1 -0
  84. package/dist/module/packages/ModelsRestClient.js +93 -0
  85. package/dist/module/packages/ModelsRestClient.js.map +1 -0
  86. package/dist/module/packages/SpeakClient.d.ts +27 -0
  87. package/dist/module/packages/SpeakClient.d.ts.map +1 -0
  88. package/dist/module/packages/SpeakClient.js +33 -0
  89. package/dist/module/packages/SpeakClient.js.map +1 -0
  90. package/dist/module/packages/SpeakLiveClient.d.ts +67 -0
  91. package/dist/module/packages/SpeakLiveClient.d.ts.map +1 -0
  92. package/dist/module/packages/SpeakLiveClient.js +144 -0
  93. package/dist/module/packages/SpeakLiveClient.js.map +1 -0
  94. package/dist/module/packages/SpeakRestClient.d.ts +0 -1
  95. package/dist/module/packages/SpeakRestClient.d.ts.map +1 -1
  96. package/dist/module/packages/SpeakRestClient.js +0 -1
  97. package/dist/module/packages/SpeakRestClient.js.map +1 -1
  98. package/dist/module/packages/index.d.ts +3 -0
  99. package/dist/module/packages/index.d.ts.map +1 -1
  100. package/dist/module/packages/index.js +3 -0
  101. package/dist/module/packages/index.js.map +1 -1
  102. package/dist/umd/deepgram.js +1 -1
  103. package/package.json +1 -1
  104. package/src/DeepgramClient.ts +10 -0
  105. package/src/lib/enums/LiveTTSEvents.ts +36 -0
  106. package/src/lib/enums/index.ts +1 -0
  107. package/src/lib/types/GetModelsResponse.ts +24 -0
  108. package/src/lib/types/GetModelsSchema.ts +3 -0
  109. package/src/lib/types/index.ts +2 -0
  110. package/src/lib/version.ts +1 -1
  111. package/src/packages/ManageRestClient.ts +82 -0
  112. package/src/packages/ModelsRestClient.ts +93 -0
  113. package/src/packages/SpeakClient.ts +35 -0
  114. package/src/packages/SpeakLiveClient.ts +163 -0
  115. package/src/packages/SpeakRestClient.ts +0 -2
  116. package/src/packages/index.ts +3 -0
@@ -0,0 +1,97 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.ModelsRestClient = void 0;
13
+ const errors_1 = require("../lib/errors");
14
+ const AbstractRestClient_1 = require("./AbstractRestClient");
15
+ /**
16
+ * Represents a REST client for interacting with the Deepgram API.
17
+ *
18
+ * The `ModelsRestClient` class provides methods for interacting with the Deepgram API to retrieve information about available models.
19
+ * @extends AbstractRestClient
20
+ */
21
+ class ModelsRestClient extends AbstractRestClient_1.AbstractRestClient {
22
+ constructor() {
23
+ super(...arguments);
24
+ this.namespace = "models";
25
+ }
26
+ /**
27
+ * Retrieves a list of all available models.
28
+ *
29
+ * @param endpoint - (optional) The endpoint to request.
30
+ * @returns A promise that resolves with the response from the Deepgram API.
31
+ * @example
32
+ * ```typescript
33
+ * import { createClient } from "@deepgram/sdk";
34
+ *
35
+ * const deepgram = createClient(DEEPGRAM_API_KEY);
36
+ * const { result: models, error } = deepgram.models.getAll();
37
+ *
38
+ * if (error) {
39
+ * console.error(error);
40
+ * } else {
41
+ * console.log(models);
42
+ * }
43
+ * ```
44
+ */
45
+ getAll(endpoint = ":version/models", options = {}) {
46
+ return __awaiter(this, void 0, void 0, function* () {
47
+ try {
48
+ const requestUrl = this.getRequestUrl(endpoint, {}, options);
49
+ const result = yield this.get(requestUrl).then((result) => result.json());
50
+ return { result, error: null };
51
+ }
52
+ catch (error) {
53
+ if ((0, errors_1.isDeepgramError)(error)) {
54
+ return { result: null, error };
55
+ }
56
+ throw error;
57
+ }
58
+ });
59
+ }
60
+ /**
61
+ * Retrieves information about a specific model.
62
+ *
63
+ * @param modelId - The UUID of the model to retrieve.
64
+ * @param endpoint - (optional) The endpoint to request.
65
+ * @returns A promise that resolves with the response from the Deepgram API.
66
+ * @example
67
+ * ```typescript
68
+ * import { createClient } from "@deepgram/sdk";
69
+ *
70
+ * const deepgram = createClient(DEEPGRAM_API_KEY);
71
+ * const { result: model, error } = deepgram.models.getModel("modelId");
72
+ *
73
+ * if (error) {
74
+ * console.error(error);
75
+ * } else {
76
+ * console.log(model);
77
+ * }
78
+ * ```
79
+ */
80
+ getModel(modelId, endpoint = ":version/models/:modelId") {
81
+ return __awaiter(this, void 0, void 0, function* () {
82
+ try {
83
+ const requestUrl = this.getRequestUrl(endpoint, { modelId });
84
+ const result = yield this.get(requestUrl).then((result) => result.json());
85
+ return { result, error: null };
86
+ }
87
+ catch (error) {
88
+ if ((0, errors_1.isDeepgramError)(error)) {
89
+ return { result: null, error };
90
+ }
91
+ throw error;
92
+ }
93
+ });
94
+ }
95
+ }
96
+ exports.ModelsRestClient = ModelsRestClient;
97
+ //# sourceMappingURL=ModelsRestClient.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ModelsRestClient.js","sourceRoot":"","sources":["../../../src/packages/ModelsRestClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAAgD;AAOhD,6DAA0D;AAE1D;;;;;GAKG;AACH,MAAa,gBAAiB,SAAQ,uCAAkB;IAAxD;;QACS,cAAS,GAAW,QAAQ,CAAC;IA4EtC,CAAC;IA1EC;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,QAAQ,GAAG,iBAAiB,EAC5B,UAA2B,EAAE;;YAE7B,IAAI;gBACF,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;gBAC7D,MAAM,MAAM,GAAsB,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;gBAE7F,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;aAChC;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,IAAA,wBAAe,EAAC,KAAK,CAAC,EAAE;oBAC1B,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;iBAChC;gBAED,MAAM,KAAK,CAAC;aACb;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACG,QAAQ,CACZ,OAAe,EACf,QAAQ,GAAG,0BAA0B;;YAErC,IAAI;gBACF,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;gBAC7D,MAAM,MAAM,GAAqB,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;gBAE5F,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;aAChC;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,IAAA,wBAAe,EAAC,KAAK,CAAC,EAAE;oBAC1B,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;iBAChC;gBAED,MAAM,KAAK,CAAC;aACb;QACH,CAAC;KAAA;CACF;AA7ED,4CA6EC"}
@@ -0,0 +1,27 @@
1
+ import { AbstractClient } from "./AbstractClient";
2
+ import { SpeakLiveClient } from "./SpeakLiveClient";
3
+ import { SpeakRestClient } from "./SpeakRestClient";
4
+ import { SpeakSchema } from "../lib/types";
5
+ import { TextSource } from "../lib/types";
6
+ /**
7
+ * The `SpeakClient` class extends the `AbstractClient` class and provides access to the "speak" namespace.
8
+ * It exposes two methods:
9
+ *
10
+ * 1. `request()`: Returns a `SpeakRestClient` instance for interacting with the rest speak API.
11
+ * 2. `live(ttsOptions: SpeakSchema = {}, endpoint = ":version/speak")`: Returns a `SpeakLiveClient` instance for interacting with the live speak API, with the provided TTS options and endpoint.
12
+ */
13
+ export declare class SpeakClient extends AbstractClient {
14
+ namespace: string;
15
+ /**
16
+ * Returns a `SpeakRestClient` instance for interacting with the rest speak API.
17
+ */
18
+ request(source: TextSource, options?: SpeakSchema, endpoint?: string): Promise<SpeakRestClient>;
19
+ /**
20
+ * Returns a `SpeakLiveClient` instance for interacting with the live speak API, with the provided TTS options and endpoint.
21
+ * @param {SpeakSchema} [ttsOptions={}] - The TTS options to use for the live speak API.
22
+ * @param {string} [endpoint=":version/speak"] - The endpoint to use for the live speak API.
23
+ * @returns {SpeakLiveClient} - A `SpeakLiveClient` instance for interacting with the live speak API.
24
+ */
25
+ live(ttsOptions?: SpeakSchema, endpoint?: string): SpeakLiveClient;
26
+ }
27
+ //# sourceMappingURL=SpeakClient.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SpeakClient.d.ts","sourceRoot":"","sources":["../../../src/packages/SpeakClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;;;;GAMG;AACH,qBAAa,WAAY,SAAQ,cAAc;IACtC,SAAS,EAAE,MAAM,CAAW;IAEnC;;OAEG;IACI,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,WAAW,EAAE,QAAQ,SAAmB;IAMrF;;;;;OAKG;IACI,IAAI,CAAC,UAAU,GAAE,WAAgB,EAAE,QAAQ,GAAE,MAAyB,GAAG,eAAe;CAGhG"}
@@ -0,0 +1,37 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SpeakClient = void 0;
4
+ const AbstractClient_1 = require("./AbstractClient");
5
+ const SpeakLiveClient_1 = require("./SpeakLiveClient");
6
+ const SpeakRestClient_1 = require("./SpeakRestClient");
7
+ /**
8
+ * The `SpeakClient` class extends the `AbstractClient` class and provides access to the "speak" namespace.
9
+ * It exposes two methods:
10
+ *
11
+ * 1. `request()`: Returns a `SpeakRestClient` instance for interacting with the rest speak API.
12
+ * 2. `live(ttsOptions: SpeakSchema = {}, endpoint = ":version/speak")`: Returns a `SpeakLiveClient` instance for interacting with the live speak API, with the provided TTS options and endpoint.
13
+ */
14
+ class SpeakClient extends AbstractClient_1.AbstractClient {
15
+ constructor() {
16
+ super(...arguments);
17
+ this.namespace = "speak";
18
+ }
19
+ /**
20
+ * Returns a `SpeakRestClient` instance for interacting with the rest speak API.
21
+ */
22
+ request(source, options, endpoint = ":version/speak") {
23
+ const client = new SpeakRestClient_1.SpeakRestClient(this.options);
24
+ return client.request(source, options, endpoint);
25
+ }
26
+ /**
27
+ * Returns a `SpeakLiveClient` instance for interacting with the live speak API, with the provided TTS options and endpoint.
28
+ * @param {SpeakSchema} [ttsOptions={}] - The TTS options to use for the live speak API.
29
+ * @param {string} [endpoint=":version/speak"] - The endpoint to use for the live speak API.
30
+ * @returns {SpeakLiveClient} - A `SpeakLiveClient` instance for interacting with the live speak API.
31
+ */
32
+ live(ttsOptions = {}, endpoint = ":version/speak") {
33
+ return new SpeakLiveClient_1.SpeakLiveClient(this.options, ttsOptions, endpoint);
34
+ }
35
+ }
36
+ exports.SpeakClient = SpeakClient;
37
+ //# sourceMappingURL=SpeakClient.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SpeakClient.js","sourceRoot":"","sources":["../../../src/packages/SpeakClient.ts"],"names":[],"mappings":";;;AAAA,qDAAkD;AAClD,uDAAoD;AACpD,uDAAoD;AAIpD;;;;;;GAMG;AACH,MAAa,WAAY,SAAQ,+BAAc;IAA/C;;QACS,cAAS,GAAW,OAAO,CAAC;IAoBrC,CAAC;IAlBC;;OAEG;IACI,OAAO,CAAC,MAAkB,EAAE,OAAqB,EAAE,QAAQ,GAAG,gBAAgB;QACnF,MAAM,MAAM,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEjD,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACI,IAAI,CAAC,aAA0B,EAAE,EAAE,WAAmB,gBAAgB;QAC3E,OAAO,IAAI,iCAAe,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;IACjE,CAAC;CACF;AArBD,kCAqBC"}
@@ -0,0 +1,67 @@
1
+ import { AbstractLiveClient } from "./AbstractLiveClient";
2
+ import type { SpeakSchema, DeepgramClientOptions } from "../lib/types";
3
+ /**
4
+ * The `SpeakLiveClient` class extends the `AbstractLiveClient` class and provides functionality for setting up and managing a WebSocket connection for live text-to-speech synthesis.
5
+ *
6
+ * The constructor takes in `DeepgramClientOptions` and an optional `SpeakSchema` object, as well as an optional `endpoint` string. It then calls the `connect` method of the parent `AbstractLiveClient` class to establish the WebSocket connection.
7
+ *
8
+ * The `setupConnection` method is responsible for handling the various events that can occur on the WebSocket connection, such as opening, closing, and receiving messages. It sets up event handlers for these events and emits the appropriate events based on the message type.
9
+ *
10
+ * The `configure` method allows you to send additional configuration options to the connected session.
11
+ *
12
+ * The `requestClose` method requests the server to close the connection.
13
+ */
14
+ export declare class SpeakLiveClient extends AbstractLiveClient {
15
+ namespace: string;
16
+ /**
17
+ * Constructs a new `SpeakLiveClient` instance with the provided options.
18
+ *
19
+ * @param options - The `DeepgramClientOptions` to use for the client connection.
20
+ * @param speakOptions - An optional `SpeakSchema` object containing additional configuration options for the text-to-speech.
21
+ * @param endpoint - An optional string representing the WebSocket endpoint to connect to. Defaults to `:version/speak`.
22
+ */
23
+ constructor(options: DeepgramClientOptions, speakOptions?: Omit<SpeakSchema, "container">, endpoint?: string);
24
+ /**
25
+ * Sets up the connection event handlers.
26
+ * This method is responsible for handling the various events that can occur on the WebSocket connection, such as opening, closing, and receiving data.
27
+ * - When the connection is opened, it emits the `LiveTTSEvents.Open` event.
28
+ * - When the connection is closed, it emits the `LiveTTSEvents.Close` event.
29
+ * - When an error occurs on the connection, it emits the `LiveTTSEvents.Error` event.
30
+ * - When a message is received, it parses the message and emits the appropriate event based on the message type, such as `LiveTTSEvents.Metadata`, `LiveTTSEvents.Flushed`, and `LiveTTSEvents.Warning`.
31
+ */
32
+ setupConnection(): void;
33
+ /**
34
+ * Handles text messages received from the WebSocket connection.
35
+ * @param data - The parsed JSON data.
36
+ */
37
+ protected handleTextMessage(data: any): void;
38
+ /**
39
+ * Handles binary messages received from the WebSocket connection.
40
+ * @param data - The binary data.
41
+ */
42
+ protected handleBinaryMessage(data: ArrayBuffer): void;
43
+ /**
44
+ * Sends a text input message to the server.
45
+ *
46
+ * @param {string} text - The text to convert to speech.
47
+ */
48
+ sendText(text: string): void;
49
+ /**
50
+ * Requests the server flush the current buffer and return generated audio.
51
+ */
52
+ flush(): void;
53
+ /**
54
+ * Requests the server clear the current buffer.
55
+ */
56
+ clear(): void;
57
+ /**
58
+ * Requests the server close the connection.
59
+ */
60
+ requestClose(): void;
61
+ /**
62
+ * Handles incoming messages from the WebSocket connection.
63
+ * @param event - The MessageEvent object representing the received message.
64
+ */
65
+ protected handleMessage(event: MessageEvent): void;
66
+ }
67
+ //# sourceMappingURL=SpeakLiveClient.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SpeakLiveClient.d.ts","sourceRoot":"","sources":["../../../src/packages/SpeakLiveClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,KAAK,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAEvE;;;;;;;;;;GAUG;AACH,qBAAa,eAAgB,SAAQ,kBAAkB;IAC9C,SAAS,EAAE,MAAM,CAAW;IAEnC;;;;;;OAMG;gBAED,OAAO,EAAE,qBAAqB,EAC9B,YAAY,GAAE,IAAI,CAAC,WAAW,EAAE,WAAW,CAAM,EACjD,QAAQ,GAAE,MAAyB;IAOrC;;;;;;;OAOG;IACI,eAAe,IAAI,IAAI;IAoB9B;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IAY5C;;;OAGG;IACH,SAAS,CAAC,mBAAmB,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI;IAItD;;;;OAIG;IACI,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IASnC;;OAEG;IACI,KAAK,IAAI,IAAI;IAQpB;;OAEG;IACI,KAAK,IAAI,IAAI;IAQpB;;OAEG;IACI,YAAY,IAAI,IAAI;IAQ3B;;;OAGG;IACH,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;CAwBnD"}
@@ -0,0 +1,148 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SpeakLiveClient = void 0;
4
+ const AbstractLiveClient_1 = require("./AbstractLiveClient");
5
+ const enums_1 = require("../lib/enums");
6
+ /**
7
+ * The `SpeakLiveClient` class extends the `AbstractLiveClient` class and provides functionality for setting up and managing a WebSocket connection for live text-to-speech synthesis.
8
+ *
9
+ * The constructor takes in `DeepgramClientOptions` and an optional `SpeakSchema` object, as well as an optional `endpoint` string. It then calls the `connect` method of the parent `AbstractLiveClient` class to establish the WebSocket connection.
10
+ *
11
+ * The `setupConnection` method is responsible for handling the various events that can occur on the WebSocket connection, such as opening, closing, and receiving messages. It sets up event handlers for these events and emits the appropriate events based on the message type.
12
+ *
13
+ * The `configure` method allows you to send additional configuration options to the connected session.
14
+ *
15
+ * The `requestClose` method requests the server to close the connection.
16
+ */
17
+ class SpeakLiveClient extends AbstractLiveClient_1.AbstractLiveClient {
18
+ /**
19
+ * Constructs a new `SpeakLiveClient` instance with the provided options.
20
+ *
21
+ * @param options - The `DeepgramClientOptions` to use for the client connection.
22
+ * @param speakOptions - An optional `SpeakSchema` object containing additional configuration options for the text-to-speech.
23
+ * @param endpoint - An optional string representing the WebSocket endpoint to connect to. Defaults to `:version/speak`.
24
+ */
25
+ constructor(options, speakOptions = {}, endpoint = ":version/speak") {
26
+ super(options);
27
+ this.namespace = "speak";
28
+ this.connect(speakOptions, endpoint);
29
+ }
30
+ /**
31
+ * Sets up the connection event handlers.
32
+ * This method is responsible for handling the various events that can occur on the WebSocket connection, such as opening, closing, and receiving data.
33
+ * - When the connection is opened, it emits the `LiveTTSEvents.Open` event.
34
+ * - When the connection is closed, it emits the `LiveTTSEvents.Close` event.
35
+ * - When an error occurs on the connection, it emits the `LiveTTSEvents.Error` event.
36
+ * - When a message is received, it parses the message and emits the appropriate event based on the message type, such as `LiveTTSEvents.Metadata`, `LiveTTSEvents.Flushed`, and `LiveTTSEvents.Warning`.
37
+ */
38
+ setupConnection() {
39
+ if (this.conn) {
40
+ this.conn.onopen = () => {
41
+ this.emit(enums_1.LiveTTSEvents.Open, this);
42
+ };
43
+ this.conn.onclose = (event) => {
44
+ this.emit(enums_1.LiveTTSEvents.Close, event);
45
+ };
46
+ this.conn.onerror = (event) => {
47
+ this.emit(enums_1.LiveTTSEvents.Error, event);
48
+ };
49
+ this.conn.onmessage = (event) => {
50
+ this.handleMessage(event);
51
+ };
52
+ }
53
+ }
54
+ /**
55
+ * Handles text messages received from the WebSocket connection.
56
+ * @param data - The parsed JSON data.
57
+ */
58
+ handleTextMessage(data) {
59
+ if (data.type === enums_1.LiveTTSEvents.Metadata) {
60
+ this.emit(enums_1.LiveTTSEvents.Metadata, data);
61
+ }
62
+ else if (data.type === enums_1.LiveTTSEvents.Flushed) {
63
+ this.emit(enums_1.LiveTTSEvents.Flushed, data);
64
+ }
65
+ else if (data.type === enums_1.LiveTTSEvents.Warning) {
66
+ this.emit(enums_1.LiveTTSEvents.Warning, data);
67
+ }
68
+ else {
69
+ this.emit(enums_1.LiveTTSEvents.Unhandled, data);
70
+ }
71
+ }
72
+ /**
73
+ * Handles binary messages received from the WebSocket connection.
74
+ * @param data - The binary data.
75
+ */
76
+ handleBinaryMessage(data) {
77
+ this.emit(enums_1.LiveTTSEvents.Audio, data);
78
+ }
79
+ /**
80
+ * Sends a text input message to the server.
81
+ *
82
+ * @param {string} text - The text to convert to speech.
83
+ */
84
+ sendText(text) {
85
+ this.send(JSON.stringify({
86
+ type: "Speak",
87
+ text,
88
+ }));
89
+ }
90
+ /**
91
+ * Requests the server flush the current buffer and return generated audio.
92
+ */
93
+ flush() {
94
+ this.send(JSON.stringify({
95
+ type: "Flush",
96
+ }));
97
+ }
98
+ /**
99
+ * Requests the server clear the current buffer.
100
+ */
101
+ clear() {
102
+ this.send(JSON.stringify({
103
+ type: "Clear",
104
+ }));
105
+ }
106
+ /**
107
+ * Requests the server close the connection.
108
+ */
109
+ requestClose() {
110
+ this.send(JSON.stringify({
111
+ type: "Close",
112
+ }));
113
+ }
114
+ /**
115
+ * Handles incoming messages from the WebSocket connection.
116
+ * @param event - The MessageEvent object representing the received message.
117
+ */
118
+ handleMessage(event) {
119
+ if (typeof event.data === "string") {
120
+ try {
121
+ const data = JSON.parse(event.data);
122
+ this.handleTextMessage(data);
123
+ }
124
+ catch (error) {
125
+ this.emit(enums_1.LiveTTSEvents.Error, {
126
+ event,
127
+ message: "Unable to parse `data` as JSON.",
128
+ error,
129
+ });
130
+ }
131
+ }
132
+ else if (event.data instanceof ArrayBuffer) {
133
+ this.handleBinaryMessage(event.data);
134
+ }
135
+ else if (Buffer.isBuffer(event.data)) {
136
+ this.handleBinaryMessage(event.data.buffer);
137
+ }
138
+ else {
139
+ console.log("Received unknown data type", event.data);
140
+ this.emit(enums_1.LiveTTSEvents.Error, {
141
+ event,
142
+ message: "Received unknown data type.",
143
+ });
144
+ }
145
+ }
146
+ }
147
+ exports.SpeakLiveClient = SpeakLiveClient;
148
+ //# sourceMappingURL=SpeakLiveClient.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SpeakLiveClient.js","sourceRoot":"","sources":["../../../src/packages/SpeakLiveClient.ts"],"names":[],"mappings":";;;AAAA,6DAA0D;AAC1D,wCAA6C;AAG7C;;;;;;;;;;GAUG;AACH,MAAa,eAAgB,SAAQ,uCAAkB;IAGrD;;;;;;OAMG;IACH,YACE,OAA8B,EAC9B,eAA+C,EAAE,EACjD,WAAmB,gBAAgB;QAEnC,KAAK,CAAC,OAAO,CAAC,CAAC;QAdV,cAAS,GAAW,OAAO,CAAC;QAgBjC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;OAOG;IACI,eAAe;QACpB,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE;gBACtB,IAAI,CAAC,IAAI,CAAC,qBAAa,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACtC,CAAC,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,KAAU,EAAE,EAAE;gBACjC,IAAI,CAAC,IAAI,CAAC,qBAAa,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YACxC,CAAC,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,KAAiB,EAAE,EAAE;gBACxC,IAAI,CAAC,IAAI,CAAC,qBAAa,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YACxC,CAAC,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,KAAmB,EAAE,EAAE;gBAC5C,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAC5B,CAAC,CAAC;SACH;IACH,CAAC;IAED;;;OAGG;IACO,iBAAiB,CAAC,IAAS;QACnC,IAAI,IAAI,CAAC,IAAI,KAAK,qBAAa,CAAC,QAAQ,EAAE;YACxC,IAAI,CAAC,IAAI,CAAC,qBAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;SACzC;aAAM,IAAI,IAAI,CAAC,IAAI,KAAK,qBAAa,CAAC,OAAO,EAAE;YAC9C,IAAI,CAAC,IAAI,CAAC,qBAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;SACxC;aAAM,IAAI,IAAI,CAAC,IAAI,KAAK,qBAAa,CAAC,OAAO,EAAE;YAC9C,IAAI,CAAC,IAAI,CAAC,qBAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;SACxC;aAAM;YACL,IAAI,CAAC,IAAI,CAAC,qBAAa,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;SAC1C;IACH,CAAC;IAED;;;OAGG;IACO,mBAAmB,CAAC,IAAiB;QAC7C,IAAI,CAAC,IAAI,CAAC,qBAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,IAAY;QAC1B,IAAI,CAAC,IAAI,CACP,IAAI,CAAC,SAAS,CAAC;YACb,IAAI,EAAE,OAAO;YACb,IAAI;SACL,CAAC,CACH,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,KAAK;QACV,IAAI,CAAC,IAAI,CACP,IAAI,CAAC,SAAS,CAAC;YACb,IAAI,EAAE,OAAO;SACd,CAAC,CACH,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,KAAK;QACV,IAAI,CAAC,IAAI,CACP,IAAI,CAAC,SAAS,CAAC;YACb,IAAI,EAAE,OAAO;SACd,CAAC,CACH,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,IAAI,CAAC,IAAI,CACP,IAAI,CAAC,SAAS,CAAC;YACb,IAAI,EAAE,OAAO;SACd,CAAC,CACH,CAAC;IACJ,CAAC;IAED;;;OAGG;IACO,aAAa,CAAC,KAAmB;QACzC,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YAClC,IAAI;gBACF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACpC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;aAC9B;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,CAAC,IAAI,CAAC,qBAAa,CAAC,KAAK,EAAE;oBAC7B,KAAK;oBACL,OAAO,EAAE,iCAAiC;oBAC1C,KAAK;iBACN,CAAC,CAAC;aACJ;SACF;aAAM,IAAI,KAAK,CAAC,IAAI,YAAY,WAAW,EAAE;YAC5C,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SACtC;aAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YACtC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAC7C;aAAM;YACL,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YACtD,IAAI,CAAC,IAAI,CAAC,qBAAa,CAAC,KAAK,EAAE;gBAC7B,KAAK;gBACL,OAAO,EAAE,6BAA6B;aACvC,CAAC,CAAC;SACJ;IACH,CAAC;CACF;AAnJD,0CAmJC"}
@@ -32,5 +32,4 @@ export declare class SpeakRestClient extends AbstractRestClient {
32
32
  */
33
33
  getHeaders(): Promise<Headers>;
34
34
  }
35
- export { SpeakRestClient as SpeakClient };
36
35
  //# sourceMappingURL=SpeakRestClient.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SpeakRestClient.d.ts","sourceRoot":"","sources":["../../../src/packages/SpeakRestClient.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D;;GAEG;AACH,qBAAa,eAAgB,SAAQ,kBAAkB;IAC9C,SAAS,EAAE,MAAM,CAAW;IAC5B,MAAM,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEpC;;;;;;;;;;OAUG;IACG,OAAO,CACX,MAAM,EAAE,UAAU,EAClB,OAAO,CAAC,EAAE,WAAW,EACrB,QAAQ,SAAmB,GAC1B,OAAO,CAAC,eAAe,CAAC;IAyB3B;;;;;OAKG;IACG,SAAS,IAAI,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAO7D;;;;OAIG;IACG,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC;CAMrC;AAED,OAAO,EAAE,eAAe,IAAI,WAAW,EAAE,CAAC"}
1
+ {"version":3,"file":"SpeakRestClient.d.ts","sourceRoot":"","sources":["../../../src/packages/SpeakRestClient.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D;;GAEG;AACH,qBAAa,eAAgB,SAAQ,kBAAkB;IAC9C,SAAS,EAAE,MAAM,CAAW;IAC5B,MAAM,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEpC;;;;;;;;;;OAUG;IACG,OAAO,CACX,MAAM,EAAE,UAAU,EAClB,OAAO,CAAC,EAAE,WAAW,EACrB,QAAQ,SAAmB,GAC1B,OAAO,CAAC,eAAe,CAAC;IAyB3B;;;;;OAKG;IACG,SAAS,IAAI,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAO7D;;;;OAIG;IACG,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC;CAMrC"}
@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
9
9
  });
10
10
  };
11
11
  Object.defineProperty(exports, "__esModule", { value: true });
12
- exports.SpeakClient = exports.SpeakRestClient = void 0;
12
+ exports.SpeakRestClient = void 0;
13
13
  const errors_1 = require("../lib/errors");
14
14
  const helpers_1 = require("../lib/helpers");
15
15
  const AbstractRestClient_1 = require("./AbstractRestClient");
@@ -80,5 +80,4 @@ class SpeakRestClient extends AbstractRestClient_1.AbstractRestClient {
80
80
  }
81
81
  }
82
82
  exports.SpeakRestClient = SpeakRestClient;
83
- exports.SpeakClient = SpeakRestClient;
84
83
  //# sourceMappingURL=SpeakRestClient.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"SpeakRestClient.js","sourceRoot":"","sources":["../../../src/packages/SpeakRestClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAAoE;AACpE,4CAA8C;AAE9C,6DAA0D;AAE1D;;GAEG;AACH,MAAa,eAAgB,SAAQ,uCAAkB;IAAvD;;QACS,cAAS,GAAW,OAAO,CAAC;IAmErC,CAAC;IAhEC;;;;;;;;;;OAUG;IACG,OAAO,CACX,MAAkB,EAClB,OAAqB,EACrB,QAAQ,GAAG,gBAAgB;;YAE3B,IAAI;gBACF,IAAI,IAAI,CAAC;gBAET,IAAI,IAAA,sBAAY,EAAC,MAAM,CAAC,EAAE;oBACxB,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;iBAC/B;qBAAM;oBACL,MAAM,IAAI,sBAAa,CAAC,mCAAmC,CAAC,CAAC;iBAC9D;gBAED,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CACnC,QAAQ,EACR,EAAE,gBACG,EAAE,KAAK,EAAE,iBAAiB,EAAE,EAAK,OAAO,EAC9C,CAAC;gBACF,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE;oBAC9C,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,kBAAkB,EAAE;iBACnE,CAAC,CAAC;gBAEH,OAAO,IAAI,CAAC;aACb;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,KAAK,CAAC;aACb;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACG,SAAS;;YACb,IAAI,CAAC,IAAI,CAAC,MAAM;gBACd,MAAM,IAAI,6BAAoB,CAAC,2CAA2C,EAAE,EAAE,CAAC,CAAC;YAElF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QAC1B,CAAC;KAAA;IAED;;;;OAIG;IACG,UAAU;;YACd,IAAI,CAAC,IAAI,CAAC,MAAM;gBACd,MAAM,IAAI,6BAAoB,CAAC,4CAA4C,EAAE,EAAE,CAAC,CAAC;YAEnF,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;QAC7B,CAAC;KAAA;CACF;AApED,0CAoEC;AAE2B,sCAAW"}
1
+ {"version":3,"file":"SpeakRestClient.js","sourceRoot":"","sources":["../../../src/packages/SpeakRestClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAAoE;AACpE,4CAA8C;AAE9C,6DAA0D;AAE1D;;GAEG;AACH,MAAa,eAAgB,SAAQ,uCAAkB;IAAvD;;QACS,cAAS,GAAW,OAAO,CAAC;IAmErC,CAAC;IAhEC;;;;;;;;;;OAUG;IACG,OAAO,CACX,MAAkB,EAClB,OAAqB,EACrB,QAAQ,GAAG,gBAAgB;;YAE3B,IAAI;gBACF,IAAI,IAAI,CAAC;gBAET,IAAI,IAAA,sBAAY,EAAC,MAAM,CAAC,EAAE;oBACxB,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;iBAC/B;qBAAM;oBACL,MAAM,IAAI,sBAAa,CAAC,mCAAmC,CAAC,CAAC;iBAC9D;gBAED,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CACnC,QAAQ,EACR,EAAE,gBACG,EAAE,KAAK,EAAE,iBAAiB,EAAE,EAAK,OAAO,EAC9C,CAAC;gBACF,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE;oBAC9C,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,kBAAkB,EAAE;iBACnE,CAAC,CAAC;gBAEH,OAAO,IAAI,CAAC;aACb;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,KAAK,CAAC;aACb;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACG,SAAS;;YACb,IAAI,CAAC,IAAI,CAAC,MAAM;gBACd,MAAM,IAAI,6BAAoB,CAAC,2CAA2C,EAAE,EAAE,CAAC,CAAC;YAElF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QAC1B,CAAC;KAAA;IAED;;;;OAIG;IACG,UAAU;;YACd,IAAI,CAAC,IAAI,CAAC,MAAM;gBACd,MAAM,IAAI,6BAAoB,CAAC,4CAA4C,EAAE,EAAE,CAAC,CAAC;YAEnF,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;QAC7B,CAAC;KAAA;CACF;AApED,0CAoEC"}
@@ -5,7 +5,10 @@ export * from "./ListenClient";
5
5
  export * from "./ListenLiveClient";
6
6
  export * from "./ListenRestClient";
7
7
  export * from "./ManageRestClient";
8
+ export * from "./ModelsRestClient";
8
9
  export * from "./ReadRestClient";
9
10
  export * from "./SelfHostedRestClient";
11
+ export * from "./SpeakClient";
12
+ export * from "./SpeakLiveClient";
10
13
  export * from "./SpeakRestClient";
11
14
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packages/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packages/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC"}
@@ -21,7 +21,10 @@ __exportStar(require("./ListenClient"), exports);
21
21
  __exportStar(require("./ListenLiveClient"), exports);
22
22
  __exportStar(require("./ListenRestClient"), exports);
23
23
  __exportStar(require("./ManageRestClient"), exports);
24
+ __exportStar(require("./ModelsRestClient"), exports);
24
25
  __exportStar(require("./ReadRestClient"), exports);
25
26
  __exportStar(require("./SelfHostedRestClient"), exports);
27
+ __exportStar(require("./SpeakClient"), exports);
28
+ __exportStar(require("./SpeakLiveClient"), exports);
26
29
  __exportStar(require("./SpeakRestClient"), exports);
27
30
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packages/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,uDAAqC;AACrC,uDAAqC;AACrC,iDAA+B;AAC/B,qDAAmC;AACnC,qDAAmC;AACnC,qDAAmC;AACnC,mDAAiC;AACjC,yDAAuC;AACvC,oDAAkC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packages/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,uDAAqC;AACrC,uDAAqC;AACrC,iDAA+B;AAC/B,qDAAmC;AACnC,qDAAmC;AACnC,qDAAmC;AACnC,qDAAmC;AACnC,mDAAiC;AACjC,yDAAuC;AACvC,gDAA8B;AAC9B,oDAAkC;AAClC,oDAAkC"}
@@ -1,4 +1,4 @@
1
- import { AbstractClient, ListenClient, ManageClient, ReadClient, OnPremClient, SelfHostedRestClient, SpeakClient } from "./packages";
1
+ import { AbstractClient, ListenClient, ManageClient, ReadClient, OnPremClient, SelfHostedRestClient, SpeakClient, ModelsRestClient } from "./packages";
2
2
  /**
3
3
  * The DeepgramClient class provides access to various Deepgram API clients, including ListenClient, ManageClient, SelfHostedRestClient, ReadClient, and SpeakClient.
4
4
  *
@@ -17,6 +17,12 @@ export default class DeepgramClient extends AbstractClient {
17
17
  * @returns {ManageClient} A new instance of the ManageClient.
18
18
  */
19
19
  get manage(): ManageClient;
20
+ /**
21
+ * Returns a new instance of the ModelsRestClient, which provides access to the Deepgram API's model functionality.
22
+ *
23
+ * @returns {ModelsRestClient} A new instance of the ModelsRestClient.
24
+ */
25
+ get models(): ModelsRestClient;
20
26
  /**
21
27
  * Returns a new instance of the SelfHostedRestClient, which provides access to the Deepgram API's self-hosted functionality.
22
28
  *
@@ -1 +1 @@
1
- {"version":3,"file":"DeepgramClient.d.ts","sourceRoot":"","sources":["../../src/DeepgramClient.ts"],"names":[],"mappings":"AACA,OAAO,EACL,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,oBAAoB,EACpB,WAAW,EACZ,MAAM,YAAY,CAAC;AAEpB;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,cAAc;IACxD;;;;OAIG;IACH,IAAI,MAAM,IAAI,YAAY,CAEzB;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,YAAY,CAEzB;IAED;;;;;OAKG;IACH,IAAI,MAAM,IAAI,YAAY,CAEzB;IAED;;;;OAIG;IACH,IAAI,UAAU,IAAI,oBAAoB,CAErC;IAED;;;;OAIG;IACH,IAAI,IAAI,IAAI,UAAU,CAErB;IAED;;;;OAIG;IACH,IAAI,KAAK,IAAI,WAAW,CAEvB;IAED;;;OAGG;IACH,IAAI,aAAa,IAAI,GAAG,CAEvB;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,GAAG,CAElB;IAED;;;OAGG;IACH,IAAI,IAAI,IAAI,GAAG,CAEd;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,GAAG,CAEjB;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,GAAG,CAEhB;IAED;;;OAGG;IACH,IAAI,UAAU,IAAI,GAAG,CAEpB;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,GAAG,CAEf;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,GAAG,CAEjB;CACF"}
1
+ {"version":3,"file":"DeepgramClient.d.ts","sourceRoot":"","sources":["../../src/DeepgramClient.ts"],"names":[],"mappings":"AACA,OAAO,EACL,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,oBAAoB,EACpB,WAAW,EACX,gBAAgB,EACjB,MAAM,YAAY,CAAC;AAEpB;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,cAAc;IACxD;;;;OAIG;IACH,IAAI,MAAM,IAAI,YAAY,CAEzB;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,YAAY,CAEzB;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,gBAAgB,CAE7B;IAED;;;;;OAKG;IACH,IAAI,MAAM,IAAI,YAAY,CAEzB;IAED;;;;OAIG;IACH,IAAI,UAAU,IAAI,oBAAoB,CAErC;IAED;;;;OAIG;IACH,IAAI,IAAI,IAAI,UAAU,CAErB;IAED;;;;OAIG;IACH,IAAI,KAAK,IAAI,WAAW,CAEvB;IAED;;;OAGG;IACH,IAAI,aAAa,IAAI,GAAG,CAEvB;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,GAAG,CAElB;IAED;;;OAGG;IACH,IAAI,IAAI,IAAI,GAAG,CAEd;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,GAAG,CAEjB;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,GAAG,CAEhB;IAED;;;OAGG;IACH,IAAI,UAAU,IAAI,GAAG,CAEpB;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,GAAG,CAEf;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,GAAG,CAEjB;CACF"}
@@ -1,5 +1,5 @@
1
1
  import { DeepgramVersionError } from "./lib/errors";
2
- import { AbstractClient, ListenClient, ManageClient, ReadClient, SelfHostedRestClient, SpeakClient, } from "./packages";
2
+ import { AbstractClient, ListenClient, ManageClient, ReadClient, SelfHostedRestClient, SpeakClient, ModelsRestClient, } from "./packages";
3
3
  /**
4
4
  * The DeepgramClient class provides access to various Deepgram API clients, including ListenClient, ManageClient, SelfHostedRestClient, ReadClient, and SpeakClient.
5
5
  *
@@ -22,6 +22,14 @@ export default class DeepgramClient extends AbstractClient {
22
22
  get manage() {
23
23
  return new ManageClient(this.options);
24
24
  }
25
+ /**
26
+ * Returns a new instance of the ModelsRestClient, which provides access to the Deepgram API's model functionality.
27
+ *
28
+ * @returns {ModelsRestClient} A new instance of the ModelsRestClient.
29
+ */
30
+ get models() {
31
+ return new ModelsRestClient(this.options);
32
+ }
25
33
  /**
26
34
  * Returns a new instance of the SelfHostedRestClient, which provides access to the Deepgram API's self-hosted functionality.
27
35
  *
@@ -1 +1 @@
1
- {"version":3,"file":"DeepgramClient.js","sourceRoot":"","sources":["../../src/DeepgramClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EACL,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,UAAU,EAEV,oBAAoB,EACpB,WAAW,GACZ,MAAM,YAAY,CAAC;AAEpB;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,cAAc;IACxD;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,IAAI,aAAa;QACf,MAAM,IAAI,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,IAAI,QAAQ;QACV,MAAM,IAAI,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,IAAI,IAAI;QACN,MAAM,IAAI,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,IAAI,OAAO;QACT,MAAM,IAAI,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,IAAI,MAAM;QACR,MAAM,IAAI,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,IAAI,UAAU;QACZ,MAAM,IAAI,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,IAAI,KAAK;QACP,MAAM,IAAI,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,IAAI,OAAO;QACT,MAAM,IAAI,oBAAoB,EAAE,CAAC;IACnC,CAAC;CACF"}
1
+ {"version":3,"file":"DeepgramClient.js","sourceRoot":"","sources":["../../src/DeepgramClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EACL,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,UAAU,EAEV,oBAAoB,EACpB,WAAW,EACX,gBAAgB,GACjB,MAAM,YAAY,CAAC;AAEpB;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,cAAc;IACxD;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,IAAI,aAAa;QACf,MAAM,IAAI,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,IAAI,QAAQ;QACV,MAAM,IAAI,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,IAAI,IAAI;QACN,MAAM,IAAI,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,IAAI,OAAO;QACT,MAAM,IAAI,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,IAAI,MAAM;QACR,MAAM,IAAI,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,IAAI,UAAU;QACZ,MAAM,IAAI,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,IAAI,KAAK;QACP,MAAM,IAAI,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,IAAI,OAAO;QACT,MAAM,IAAI,oBAAoB,EAAE,CAAC;IACnC,CAAC;CACF"}
@@ -0,0 +1,34 @@
1
+ /**
2
+ * Enumeration of events related to live text-to-speech synthesis.
3
+ *
4
+ * - `Open`: Built-in socket event for when the connection is opened.
5
+ * - `Close`: Built-in socket event for when the connection is closed.
6
+ * - `Error`: Built-in socket event for when an error occurs.
7
+ * - `Metadata`: Event for when metadata is received.
8
+ * - `Flushed`: Event for when the server has flushed the buffer.
9
+ * - `Warning`: Event for when a warning is received.
10
+ * - `Unhandled`: Catch-all event for any other message event.
11
+ */
12
+ export declare enum LiveTTSEvents {
13
+ /**
14
+ * Built in socket events.
15
+ */
16
+ Open = "Open",
17
+ Close = "Close",
18
+ Error = "Error",
19
+ /**
20
+ * Message { type: string }
21
+ */
22
+ Metadata = "Metadata",
23
+ Flushed = "Flushed",
24
+ Warning = "Warning",
25
+ /**
26
+ * Audio data event.
27
+ */
28
+ Audio = "Audio",
29
+ /**
30
+ * Catch all for any other message event
31
+ */
32
+ Unhandled = "Unhandled"
33
+ }
34
+ //# sourceMappingURL=LiveTTSEvents.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"LiveTTSEvents.d.ts","sourceRoot":"","sources":["../../../../src/lib/enums/LiveTTSEvents.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,oBAAY,aAAa;IACvB;;OAEG;IACH,IAAI,SAAS;IACb,KAAK,UAAU;IACf,KAAK,UAAU;IAEf;;OAEG;IACH,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,OAAO,YAAY;IAEnB;;OAEG;IACH,KAAK,UAAU;IAEf;;OAEG;IACH,SAAS,cAAc;CACxB"}
@@ -0,0 +1,35 @@
1
+ /**
2
+ * Enumeration of events related to live text-to-speech synthesis.
3
+ *
4
+ * - `Open`: Built-in socket event for when the connection is opened.
5
+ * - `Close`: Built-in socket event for when the connection is closed.
6
+ * - `Error`: Built-in socket event for when an error occurs.
7
+ * - `Metadata`: Event for when metadata is received.
8
+ * - `Flushed`: Event for when the server has flushed the buffer.
9
+ * - `Warning`: Event for when a warning is received.
10
+ * - `Unhandled`: Catch-all event for any other message event.
11
+ */
12
+ export var LiveTTSEvents;
13
+ (function (LiveTTSEvents) {
14
+ /**
15
+ * Built in socket events.
16
+ */
17
+ LiveTTSEvents["Open"] = "Open";
18
+ LiveTTSEvents["Close"] = "Close";
19
+ LiveTTSEvents["Error"] = "Error";
20
+ /**
21
+ * Message { type: string }
22
+ */
23
+ LiveTTSEvents["Metadata"] = "Metadata";
24
+ LiveTTSEvents["Flushed"] = "Flushed";
25
+ LiveTTSEvents["Warning"] = "Warning";
26
+ /**
27
+ * Audio data event.
28
+ */
29
+ LiveTTSEvents["Audio"] = "Audio";
30
+ /**
31
+ * Catch all for any other message event
32
+ */
33
+ LiveTTSEvents["Unhandled"] = "Unhandled";
34
+ })(LiveTTSEvents || (LiveTTSEvents = {}));
35
+ //# sourceMappingURL=LiveTTSEvents.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"LiveTTSEvents.js","sourceRoot":"","sources":["../../../../src/lib/enums/LiveTTSEvents.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,MAAM,CAAN,IAAY,aAwBX;AAxBD,WAAY,aAAa;IACvB;;OAEG;IACH,8BAAa,CAAA;IACb,gCAAe,CAAA;IACf,gCAAe,CAAA;IAEf;;OAEG;IACH,sCAAqB,CAAA;IACrB,oCAAmB,CAAA;IACnB,oCAAmB,CAAA;IAEnB;;OAEG;IACH,gCAAe,CAAA;IAEf;;OAEG;IACH,wCAAuB,CAAA;AACzB,CAAC,EAxBW,aAAa,KAAb,aAAa,QAwBxB"}
@@ -1,3 +1,4 @@
1
1
  export * from "./LiveConnectionState";
2
2
  export * from "./LiveTranscriptionEvents";
3
+ export * from "./LiveTTSEvents";
3
4
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/enums/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/enums/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC"}
@@ -1,3 +1,4 @@
1
1
  export * from "./LiveConnectionState";
2
2
  export * from "./LiveTranscriptionEvents";
3
+ export * from "./LiveTTSEvents";
3
4
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/enums/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/enums/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC"}