@speechall/sdk 0.0.1 → 2.0.4

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 (151) hide show
  1. package/.beads/README.md +81 -0
  2. package/.beads/config.yaml +62 -0
  3. package/.beads/issues.jsonl +46 -0
  4. package/.beads/metadata.json +4 -0
  5. package/.env.example +5 -0
  6. package/.fernignore +45 -0
  7. package/.gitattributes +3 -0
  8. package/.github/copilot-instructions.md +78 -0
  9. package/.github/workflows/auto-release-simple.yml.deprecated +106 -0
  10. package/.github/workflows/auto-release.yml +67 -0
  11. package/.github/workflows/ci.yml +41 -0
  12. package/.github/workflows/release.yml +57 -0
  13. package/AGENTS.md +94 -0
  14. package/CHANGELOG.md +58 -0
  15. package/CLAUDE.md +75 -0
  16. package/README.md +294 -155
  17. package/examples/CLAUDE.md +136 -0
  18. package/examples/advanced-options.ts +213 -0
  19. package/examples/basic-transcription.ts +66 -0
  20. package/examples/error-handling.ts +251 -0
  21. package/examples/list-models.ts +112 -0
  22. package/examples/remote-transcription.ts +60 -0
  23. package/fern/fern.config.json +4 -0
  24. package/fern/generators.yml +43 -0
  25. package/jest.config.js +11 -0
  26. package/package.json +26 -44
  27. package/regenerate.sh +45 -0
  28. package/scripts/fix-generated-code.sh +25 -0
  29. package/src/BaseClient.ts +82 -0
  30. package/src/Client.ts +30 -0
  31. package/src/api/errors/BadRequestError.ts +22 -0
  32. package/src/api/errors/GatewayTimeoutError.ts +22 -0
  33. package/src/api/errors/InternalServerError.ts +22 -0
  34. package/src/api/errors/NotFoundError.ts +22 -0
  35. package/src/api/errors/PaymentRequiredError.ts +22 -0
  36. package/src/api/errors/ServiceUnavailableError.ts +22 -0
  37. package/src/api/errors/TooManyRequestsError.ts +22 -0
  38. package/src/api/errors/UnauthorizedError.ts +22 -0
  39. package/src/api/errors/index.ts +8 -0
  40. package/src/api/index.ts +3 -0
  41. package/src/api/resources/index.ts +5 -0
  42. package/src/api/resources/replacementRules/client/Client.ts +148 -0
  43. package/src/api/resources/replacementRules/client/index.ts +1 -0
  44. package/src/api/resources/replacementRules/client/requests/CreateReplacementRulesetRequest.ts +25 -0
  45. package/src/api/resources/replacementRules/client/requests/index.ts +1 -0
  46. package/src/api/resources/replacementRules/index.ts +2 -0
  47. package/src/api/resources/replacementRules/types/CreateReplacementRulesetResponse.ts +6 -0
  48. package/src/api/resources/replacementRules/types/index.ts +1 -0
  49. package/src/api/resources/speechToText/client/Client.ts +275 -0
  50. package/src/api/resources/speechToText/client/index.ts +1 -0
  51. package/src/api/resources/speechToText/client/requests/RemoteTranscriptionConfiguration.ts +20 -0
  52. package/src/api/resources/speechToText/client/requests/TranscribeRequest.ts +26 -0
  53. package/src/api/resources/speechToText/client/requests/index.ts +2 -0
  54. package/src/api/resources/speechToText/index.ts +1 -0
  55. package/src/api/types/BaseTranscriptionConfiguration.ts +29 -0
  56. package/src/api/types/ErrorResponse.ts +11 -0
  57. package/src/api/types/ExactRule.ts +13 -0
  58. package/src/api/types/RegexGroupRule.ts +28 -0
  59. package/src/api/types/RegexRule.ts +28 -0
  60. package/src/api/types/ReplacementRule.ts +25 -0
  61. package/src/api/types/SpeechToTextModel.ts +90 -0
  62. package/src/api/types/TranscriptLanguageCode.ts +114 -0
  63. package/src/api/types/TranscriptOutputFormat.ts +18 -0
  64. package/src/api/types/TranscriptionDetailed.ts +19 -0
  65. package/src/api/types/TranscriptionModelIdentifier.ts +80 -0
  66. package/src/api/types/TranscriptionOnlyText.ts +11 -0
  67. package/src/api/types/TranscriptionProvider.ts +23 -0
  68. package/src/api/types/TranscriptionResponse.ts +8 -0
  69. package/src/api/types/TranscriptionSegment.ts +17 -0
  70. package/src/api/types/TranscriptionWord.ts +17 -0
  71. package/src/api/types/index.ts +16 -0
  72. package/src/auth/BearerAuthProvider.ts +37 -0
  73. package/src/auth/index.ts +1 -0
  74. package/src/core/auth/AuthProvider.ts +6 -0
  75. package/src/core/auth/AuthRequest.ts +9 -0
  76. package/src/core/auth/BasicAuth.ts +32 -0
  77. package/src/core/auth/BearerToken.ts +20 -0
  78. package/src/core/auth/NoOpAuthProvider.ts +8 -0
  79. package/src/core/auth/index.ts +5 -0
  80. package/src/core/base64.ts +27 -0
  81. package/src/core/exports.ts +2 -0
  82. package/src/core/fetcher/APIResponse.ts +23 -0
  83. package/src/core/fetcher/BinaryResponse.ts +34 -0
  84. package/src/core/fetcher/EndpointMetadata.ts +13 -0
  85. package/src/core/fetcher/EndpointSupplier.ts +14 -0
  86. package/src/core/fetcher/Fetcher.ts +391 -0
  87. package/src/core/fetcher/Headers.ts +93 -0
  88. package/src/core/fetcher/HttpResponsePromise.ts +116 -0
  89. package/src/core/fetcher/RawResponse.ts +61 -0
  90. package/src/core/fetcher/Supplier.ts +11 -0
  91. package/src/core/fetcher/createRequestUrl.ts +6 -0
  92. package/src/core/fetcher/getErrorResponseBody.ts +33 -0
  93. package/src/core/fetcher/getFetchFn.ts +3 -0
  94. package/src/core/fetcher/getHeader.ts +8 -0
  95. package/src/core/fetcher/getRequestBody.ts +20 -0
  96. package/src/core/fetcher/getResponseBody.ts +58 -0
  97. package/src/core/fetcher/index.ts +11 -0
  98. package/src/core/fetcher/makeRequest.ts +42 -0
  99. package/src/core/fetcher/requestWithRetries.ts +64 -0
  100. package/src/core/fetcher/signals.ts +26 -0
  101. package/src/core/file/exports.ts +1 -0
  102. package/src/core/file/file.ts +217 -0
  103. package/src/core/file/index.ts +2 -0
  104. package/src/core/file/types.ts +81 -0
  105. package/src/core/headers.ts +35 -0
  106. package/src/core/index.ts +7 -0
  107. package/src/core/json.ts +27 -0
  108. package/src/core/logging/exports.ts +19 -0
  109. package/src/core/logging/index.ts +1 -0
  110. package/src/core/logging/logger.ts +203 -0
  111. package/src/core/runtime/index.ts +1 -0
  112. package/src/core/runtime/runtime.ts +134 -0
  113. package/src/core/url/encodePathParam.ts +18 -0
  114. package/src/core/url/index.ts +3 -0
  115. package/src/core/url/join.ts +79 -0
  116. package/src/core/url/qs.ts +74 -0
  117. package/src/environments.ts +7 -0
  118. package/src/errors/SpeechallError.ts +58 -0
  119. package/src/errors/SpeechallTimeoutError.ts +13 -0
  120. package/src/errors/handleNonStatusCodeError.ts +37 -0
  121. package/src/errors/index.ts +2 -0
  122. package/src/exports.ts +1 -0
  123. package/src/index.ts +6 -0
  124. package/test-import.ts +17 -0
  125. package/tests/integration/api.test.ts +93 -0
  126. package/tests/unit/client.test.ts +91 -0
  127. package/tsconfig.json +20 -0
  128. package/dist/api.d.ts +0 -467
  129. package/dist/api.d.ts.map +0 -1
  130. package/dist/api.js +0 -592
  131. package/dist/base.d.ts +0 -32
  132. package/dist/base.d.ts.map +0 -1
  133. package/dist/base.js +0 -35
  134. package/dist/common.d.ts +0 -14
  135. package/dist/common.d.ts.map +0 -1
  136. package/dist/common.js +0 -91
  137. package/dist/configuration.d.ts +0 -23
  138. package/dist/configuration.d.ts.map +0 -1
  139. package/dist/configuration.js +0 -25
  140. package/dist/esm/api.js +0 -574
  141. package/dist/esm/base.js +0 -27
  142. package/dist/esm/common.js +0 -79
  143. package/dist/esm/configuration.js +0 -21
  144. package/dist/esm/example.js +0 -131
  145. package/dist/esm/index.js +0 -2
  146. package/dist/example.d.ts +0 -3
  147. package/dist/example.d.ts.map +0 -1
  148. package/dist/example.js +0 -133
  149. package/dist/index.d.ts +0 -3
  150. package/dist/index.d.ts.map +0 -1
  151. package/dist/index.js +0 -18
package/dist/common.d.ts DELETED
@@ -1,14 +0,0 @@
1
- import type { Configuration } from "./configuration";
2
- import type { RequestArgs } from "./base";
3
- import type { AxiosInstance, AxiosResponse } from 'axios';
4
- export declare const DUMMY_BASE_URL = "https://example.com";
5
- export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
6
- export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
7
- export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
8
- export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
9
- export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
10
- export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
11
- export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
12
- export declare const toPathString: (url: URL) => string;
13
- export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
14
- //# sourceMappingURL=common.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../common.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAO1D,eAAO,MAAM,cAAc,wBAAwB,CAAA;AAOnD,eAAO,MAAM,iBAAiB,GAAa,cAAc,MAAM,EAAE,WAAW,MAAM,EAAE,YAAY,OAAO,SAItG,CAAA;AAMD,eAAO,MAAM,iBAAiB,GAAmB,QAAQ,GAAG,EAAE,cAAc,MAAM,EAAE,gBAAgB,aAAa,kBAOhH,CAAA;AAMD,eAAO,MAAM,oBAAoB,GAAa,QAAQ,GAAG,EAAE,gBAAgB,aAAa,SAIvF,CAAA;AAMD,eAAO,MAAM,qBAAqB,GAAmB,QAAQ,GAAG,EAAE,gBAAgB,aAAa,kBAO9F,CAAA;AAMD,eAAO,MAAM,gBAAgB,GAAmB,QAAQ,GAAG,EAAE,MAAM,MAAM,EAAE,QAAQ,MAAM,EAAE,EAAE,gBAAgB,aAAa,kBAOzH,CAAA;AA4BD,eAAO,MAAM,eAAe,GAAa,KAAK,GAAG,EAAE,GAAG,SAAS,GAAG,EAAE,SAInE,CAAA;AAMD,eAAO,MAAM,qBAAqB,GAAa,OAAO,GAAG,EAAE,gBAAgB,GAAG,EAAE,gBAAgB,aAAa,QAQ5G,CAAA;AAMD,eAAO,MAAM,YAAY,GAAa,KAAK,GAAG,WAE7C,CAAA;AAMD,eAAO,MAAM,qBAAqB,GAAa,WAAW,WAAW,EAAE,aAAa,aAAa,EAAE,WAAW,MAAM,EAAE,gBAAgB,aAAa,MACvI,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,EAAE,QAAO,aAA2B,EAAE,WAAU,MAAkB,eAI9G,CAAA"}
package/dist/common.js DELETED
@@ -1,91 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
4
- const base_1 = require("./base");
5
- exports.DUMMY_BASE_URL = 'https://example.com';
6
- const assertParamExists = function (functionName, paramName, paramValue) {
7
- if (paramValue === null || paramValue === undefined) {
8
- throw new base_1.RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
9
- }
10
- };
11
- exports.assertParamExists = assertParamExists;
12
- const setApiKeyToObject = async function (object, keyParamName, configuration) {
13
- if (configuration && configuration.apiKey) {
14
- const localVarApiKeyValue = typeof configuration.apiKey === 'function'
15
- ? await configuration.apiKey(keyParamName)
16
- : await configuration.apiKey;
17
- object[keyParamName] = localVarApiKeyValue;
18
- }
19
- };
20
- exports.setApiKeyToObject = setApiKeyToObject;
21
- const setBasicAuthToObject = function (object, configuration) {
22
- if (configuration && (configuration.username || configuration.password)) {
23
- object["auth"] = { username: configuration.username, password: configuration.password };
24
- }
25
- };
26
- exports.setBasicAuthToObject = setBasicAuthToObject;
27
- const setBearerAuthToObject = async function (object, configuration) {
28
- if (configuration && configuration.accessToken) {
29
- const accessToken = typeof configuration.accessToken === 'function'
30
- ? await configuration.accessToken()
31
- : await configuration.accessToken;
32
- object["Authorization"] = "Bearer " + accessToken;
33
- }
34
- };
35
- exports.setBearerAuthToObject = setBearerAuthToObject;
36
- const setOAuthToObject = async function (object, name, scopes, configuration) {
37
- if (configuration && configuration.accessToken) {
38
- const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
39
- ? await configuration.accessToken(name, scopes)
40
- : await configuration.accessToken;
41
- object["Authorization"] = "Bearer " + localVarAccessTokenValue;
42
- }
43
- };
44
- exports.setOAuthToObject = setOAuthToObject;
45
- function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
46
- if (parameter == null)
47
- return;
48
- if (typeof parameter === "object") {
49
- if (Array.isArray(parameter)) {
50
- parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
51
- }
52
- else {
53
- Object.keys(parameter).forEach(currentKey => setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`));
54
- }
55
- }
56
- else {
57
- if (urlSearchParams.has(key)) {
58
- urlSearchParams.append(key, parameter);
59
- }
60
- else {
61
- urlSearchParams.set(key, parameter);
62
- }
63
- }
64
- }
65
- const setSearchParams = function (url, ...objects) {
66
- const searchParams = new URLSearchParams(url.search);
67
- setFlattenedQueryParams(searchParams, objects);
68
- url.search = searchParams.toString();
69
- };
70
- exports.setSearchParams = setSearchParams;
71
- const serializeDataIfNeeded = function (value, requestOptions, configuration) {
72
- const nonString = typeof value !== 'string';
73
- const needsSerialization = nonString && configuration && configuration.isJsonMime
74
- ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
75
- : nonString;
76
- return needsSerialization
77
- ? JSON.stringify(value !== undefined ? value : {})
78
- : (value || "");
79
- };
80
- exports.serializeDataIfNeeded = serializeDataIfNeeded;
81
- const toPathString = function (url) {
82
- return url.pathname + url.search + url.hash;
83
- };
84
- exports.toPathString = toPathString;
85
- const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
86
- return (axios = globalAxios, basePath = BASE_PATH) => {
87
- const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
88
- return axios.request(axiosRequestArgs);
89
- };
90
- };
91
- exports.createRequestFunction = createRequestFunction;
@@ -1,23 +0,0 @@
1
- export interface ConfigurationParameters {
2
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
3
- username?: string;
4
- password?: string;
5
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
6
- basePath?: string;
7
- serverIndex?: number;
8
- baseOptions?: any;
9
- formDataCtor?: new () => any;
10
- }
11
- export declare class Configuration {
12
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
13
- username?: string;
14
- password?: string;
15
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
16
- basePath?: string;
17
- serverIndex?: number;
18
- baseOptions?: any;
19
- formDataCtor?: new () => any;
20
- constructor(param?: ConfigurationParameters);
21
- isJsonMime(mime: string): boolean;
22
- }
23
- //# sourceMappingURL=configuration.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"configuration.d.ts","sourceRoot":"","sources":["../configuration.ts"],"names":[],"mappings":"AAeA,MAAM,WAAW,uBAAuB;IACpC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IACrG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAClJ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,GAAG,CAAC;IAClB,YAAY,CAAC,EAAE,UAAU,GAAG,CAAC;CAChC;AAED,qBAAa,aAAa;IAMtB,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAOrG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAOlB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAOlB,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAOlJ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAOlB,WAAW,CAAC,EAAE,MAAM,CAAC;IAOrB,WAAW,CAAC,EAAE,GAAG,CAAC;IAQlB,YAAY,CAAC,EAAE,UAAU,GAAG,CAAC;gBAEjB,KAAK,GAAE,uBAA4B;IA0BxC,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;CAI3C"}
@@ -1,25 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Configuration = void 0;
4
- class Configuration {
5
- constructor(param = {}) {
6
- this.apiKey = param.apiKey;
7
- this.username = param.username;
8
- this.password = param.password;
9
- this.accessToken = param.accessToken;
10
- this.basePath = param.basePath;
11
- this.serverIndex = param.serverIndex;
12
- this.baseOptions = {
13
- ...param.baseOptions,
14
- headers: {
15
- ...param.baseOptions?.headers,
16
- },
17
- };
18
- this.formDataCtor = param.formDataCtor;
19
- }
20
- isJsonMime(mime) {
21
- const jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
22
- return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
23
- }
24
- }
25
- exports.Configuration = Configuration;