spitch 0.0.1-alpha.1 → 0.1.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.
- package/CHANGELOG.md +18 -5
- package/LICENSE +1 -1
- package/README.md +201 -65
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/client.d.mts +192 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +192 -0
- package/client.d.ts.map +1 -0
- package/client.js +473 -0
- package/client.js.map +1 -0
- package/client.mjs +469 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/pagination.d.mts +54 -0
- package/core/pagination.d.mts.map +1 -0
- package/core/pagination.d.ts +54 -0
- package/core/pagination.d.ts.map +1 -0
- package/core/pagination.js +101 -0
- package/core/pagination.js.map +1 -0
- package/core/pagination.mjs +95 -0
- package/core/pagination.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +1 -52
- package/error.d.ts.map +1 -1
- package/error.js +3 -140
- package/error.js.map +1 -1
- package/error.mjs +1 -126
- package/error.mjs.map +1 -1
- package/index.d.mts +7 -117
- package/index.d.mts.map +1 -0
- package/index.d.ts +6 -116
- package/index.d.ts.map +1 -1
- package/index.js +28 -107
- package/index.js.map +1 -1
- package/index.mjs +6 -81
- package/index.mjs.map +1 -1
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +35 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +32 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/request-options.d.mts +75 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +75 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +85 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +79 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +7 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +7 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +11 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +8 -0
- package/internal/utils.mjs.map +1 -0
- package/package.json +117 -72
- package/pagination.d.mts +2 -0
- package/pagination.d.mts.map +1 -0
- package/pagination.d.ts +2 -0
- package/pagination.d.ts.map +1 -0
- package/pagination.js +6 -0
- package/pagination.js.map +1 -0
- package/pagination.mjs +2 -0
- package/pagination.mjs.map +1 -0
- package/resource.d.mts +2 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +1 -5
- package/resource.d.ts.map +1 -1
- package/resource.js +3 -8
- package/resource.js.map +1 -1
- package/resource.mjs +1 -6
- package/resource.mjs.map +1 -1
- package/resources/files.d.mts +74 -0
- package/resources/files.d.mts.map +1 -0
- package/resources/files.d.ts +74 -0
- package/resources/files.d.ts.map +1 -0
- package/resources/files.js +48 -0
- package/resources/files.js.map +1 -0
- package/resources/files.mjs +44 -0
- package/resources/files.mjs.map +1 -0
- package/resources/index.d.mts +4 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +3 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -1
- package/resources/index.mjs.map +1 -1
- package/resources/speech.d.mts +45 -0
- package/resources/speech.d.mts.map +1 -0
- package/resources/speech.d.ts +29 -28
- package/resources/speech.d.ts.map +1 -1
- package/resources/speech.js +12 -32
- package/resources/speech.js.map +1 -1
- package/resources/speech.mjs +12 -9
- package/resources/speech.mjs.map +1 -1
- package/resources/text.d.mts +34 -0
- package/resources/text.d.mts.map +1 -0
- package/resources/text.d.ts +23 -8
- package/resources/text.d.ts.map +1 -1
- package/resources/text.js +7 -3
- package/resources/text.js.map +1 -1
- package/resources/text.mjs +7 -3
- package/resources/text.mjs.map +1 -1
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts +2 -0
- package/resources.d.ts.map +1 -0
- package/resources.js +5 -0
- package/resources.js.map +1 -0
- package/resources.mjs +2 -0
- package/resources.mjs.map +1 -0
- package/src/api-promise.ts +2 -0
- package/src/client.ts +790 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/pagination.ts +157 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -146
- package/src/index.ts +7 -177
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +50 -0
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +126 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +8 -0
- package/src/pagination.ts +2 -0
- package/src/resource.ts +2 -11
- package/src/resources/files.ts +136 -0
- package/src/resources/index.ts +19 -2
- package/src/resources/speech.ts +77 -32
- package/src/resources/text.ts +38 -9
- package/src/resources.ts +1 -0
- package/src/tsconfig.json +2 -2
- package/src/uploads.ts +2 -255
- package/src/version.ts +1 -1
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +1 -74
- package/uploads.d.ts.map +1 -1
- package/uploads.js +3 -168
- package/uploads.js.map +1 -1
- package/uploads.mjs +1 -157
- package/uploads.mjs.map +1 -1
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
- package/_shims/MultipartBody.d.ts +0 -9
- package/_shims/MultipartBody.d.ts.map +0 -1
- package/_shims/MultipartBody.js +0 -16
- package/_shims/MultipartBody.js.map +0 -1
- package/_shims/MultipartBody.mjs +0 -12
- package/_shims/MultipartBody.mjs.map +0 -1
- package/_shims/README.md +0 -46
- package/_shims/auto/runtime-bun.d.ts +0 -5
- package/_shims/auto/runtime-bun.d.ts.map +0 -1
- package/_shims/auto/runtime-bun.js +0 -21
- package/_shims/auto/runtime-bun.js.map +0 -1
- package/_shims/auto/runtime-bun.mjs +0 -2
- package/_shims/auto/runtime-bun.mjs.map +0 -1
- package/_shims/auto/runtime-node.d.ts +0 -5
- package/_shims/auto/runtime-node.d.ts.map +0 -1
- package/_shims/auto/runtime-node.js +0 -21
- package/_shims/auto/runtime-node.js.map +0 -1
- package/_shims/auto/runtime-node.mjs +0 -2
- package/_shims/auto/runtime-node.mjs.map +0 -1
- package/_shims/auto/runtime.d.ts +0 -5
- package/_shims/auto/runtime.d.ts.map +0 -1
- package/_shims/auto/runtime.js +0 -21
- package/_shims/auto/runtime.js.map +0 -1
- package/_shims/auto/runtime.mjs +0 -2
- package/_shims/auto/runtime.mjs.map +0 -1
- package/_shims/auto/types-node.d.ts +0 -5
- package/_shims/auto/types-node.d.ts.map +0 -1
- package/_shims/auto/types-node.js +0 -21
- package/_shims/auto/types-node.js.map +0 -1
- package/_shims/auto/types-node.mjs +0 -2
- package/_shims/auto/types-node.mjs.map +0 -1
- package/_shims/auto/types.d.ts +0 -101
- package/_shims/auto/types.js +0 -3
- package/_shims/auto/types.mjs +0 -3
- package/_shims/bun-runtime.d.ts +0 -6
- package/_shims/bun-runtime.d.ts.map +0 -1
- package/_shims/bun-runtime.js +0 -14
- package/_shims/bun-runtime.js.map +0 -1
- package/_shims/bun-runtime.mjs +0 -10
- package/_shims/bun-runtime.mjs.map +0 -1
- package/_shims/index.d.ts +0 -81
- package/_shims/index.js +0 -13
- package/_shims/index.mjs +0 -7
- package/_shims/manual-types.d.ts +0 -12
- package/_shims/manual-types.js +0 -3
- package/_shims/manual-types.mjs +0 -3
- package/_shims/node-runtime.d.ts +0 -3
- package/_shims/node-runtime.d.ts.map +0 -1
- package/_shims/node-runtime.js +0 -89
- package/_shims/node-runtime.js.map +0 -1
- package/_shims/node-runtime.mjs +0 -56
- package/_shims/node-runtime.mjs.map +0 -1
- package/_shims/node-types.d.ts +0 -42
- package/_shims/node-types.js +0 -3
- package/_shims/node-types.mjs +0 -3
- package/_shims/registry.d.ts +0 -37
- package/_shims/registry.d.ts.map +0 -1
- package/_shims/registry.js +0 -41
- package/_shims/registry.js.map +0 -1
- package/_shims/registry.mjs +0 -37
- package/_shims/registry.mjs.map +0 -1
- package/_shims/web-runtime.d.ts +0 -5
- package/_shims/web-runtime.d.ts.map +0 -1
- package/_shims/web-runtime.js +0 -78
- package/_shims/web-runtime.js.map +0 -1
- package/_shims/web-runtime.mjs +0 -71
- package/_shims/web-runtime.mjs.map +0 -1
- package/_shims/web-types.d.ts +0 -83
- package/_shims/web-types.js +0 -3
- package/_shims/web-types.mjs +0 -3
- package/core.d.ts +0 -242
- package/core.d.ts.map +0 -1
- package/core.js +0 -901
- package/core.js.map +0 -1
- package/core.mjs +0 -869
- package/core.mjs.map +0 -1
- package/shims/node.d.ts +0 -30
- package/shims/node.d.ts.map +0 -1
- package/shims/node.js +0 -31
- package/shims/node.js.map +0 -1
- package/shims/node.mjs +0 -5
- package/shims/node.mjs.map +0 -1
- package/shims/web.d.ts +0 -26
- package/shims/web.d.ts.map +0 -1
- package/shims/web.js +0 -31
- package/shims/web.js.map +0 -1
- package/shims/web.mjs +0 -5
- package/shims/web.mjs.map +0 -1
- package/src/_shims/MultipartBody.ts +0 -9
- package/src/_shims/README.md +0 -46
- package/src/_shims/auto/runtime-bun.ts +0 -4
- package/src/_shims/auto/runtime-node.ts +0 -4
- package/src/_shims/auto/runtime.ts +0 -4
- package/src/_shims/auto/types-node.ts +0 -4
- package/src/_shims/auto/types.d.ts +0 -101
- package/src/_shims/auto/types.js +0 -3
- package/src/_shims/auto/types.mjs +0 -3
- package/src/_shims/bun-runtime.ts +0 -14
- package/src/_shims/index.d.ts +0 -81
- package/src/_shims/index.js +0 -13
- package/src/_shims/index.mjs +0 -7
- package/src/_shims/manual-types.d.ts +0 -12
- package/src/_shims/manual-types.js +0 -3
- package/src/_shims/manual-types.mjs +0 -3
- package/src/_shims/node-runtime.ts +0 -81
- package/src/_shims/node-types.d.ts +0 -42
- package/src/_shims/node-types.js +0 -3
- package/src/_shims/node-types.mjs +0 -3
- package/src/_shims/registry.ts +0 -65
- package/src/_shims/web-runtime.ts +0 -103
- package/src/_shims/web-types.d.ts +0 -83
- package/src/_shims/web-types.js +0 -3
- package/src/_shims/web-types.mjs +0 -3
- package/src/core.ts +0 -1190
- package/src/shims/node.ts +0 -50
- package/src/shims/web.ts +0 -50
package/CHANGELOG.md
CHANGED
|
@@ -1,11 +1,24 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
-
## 0.
|
|
3
|
+
## 0.1.0 (2025-10-06)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.0.1...v0.1.0](https://github.com/spi-tch/spitch-typescript/compare/v0.0.1...v0.1.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** update via SDK Studio ([7a00c7f](https://github.com/spi-tch/spitch-typescript/commit/7a00c7f914ee0b5c7561b1b1a82df1718b5fc8ad))
|
|
10
|
+
* **api:** update via SDK Studio ([ce17d2f](https://github.com/spi-tch/spitch-typescript/commit/ce17d2f0347935cdc6ab70e97ae74010f2c19df3))
|
|
11
|
+
* **api:** update via SDK Studio ([737a0bc](https://github.com/spi-tch/spitch-typescript/commit/737a0bc7b4b28723e725474844fa85bfc926e092))
|
|
12
|
+
* **api:** update via SDK Studio ([2e7d18d](https://github.com/spi-tch/spitch-typescript/commit/2e7d18d58f7263095303fc6e809289fe45674f80))
|
|
13
|
+
* **api:** update via SDK Studio ([7a1064a](https://github.com/spi-tch/spitch-typescript/commit/7a1064a21ff0f29a22de6f366d83cbeba0737154))
|
|
14
|
+
* **api:** update via SDK Studio ([f73d00e](https://github.com/spi-tch/spitch-typescript/commit/f73d00ee3d5701d1f1904402353ef7f70c70f93d))
|
|
15
|
+
* **api:** update via SDK Studio ([a34386f](https://github.com/spi-tch/spitch-typescript/commit/a34386f023f82cb9cea023b634fd2bc422845015))
|
|
16
|
+
* **api:** update via SDK Studio ([034dd1d](https://github.com/spi-tch/spitch-typescript/commit/034dd1df081f1590dfeaeef4e57baf849bbc6e9e))
|
|
4
17
|
|
|
5
|
-
Full Changelog: [v0.0.1-alpha.0...v0.0.1-alpha.1](https://github.com/spi-tch/spitch-node/compare/v0.0.1-alpha.0...v0.0.1-alpha.1)
|
|
6
18
|
|
|
7
19
|
### Chores
|
|
8
20
|
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
21
|
+
* sync repo ([58d95ba](https://github.com/spi-tch/spitch-typescript/commit/58d95ba27cc553cce62c7398351872a18e80de1e))
|
|
22
|
+
* update SDK settings ([f9860e3](https://github.com/spi-tch/spitch-typescript/commit/f9860e3f6ec93c5698445574b3b43b3c373a61f4))
|
|
23
|
+
* update SDK settings ([62b07a3](https://github.com/spi-tch/spitch-typescript/commit/62b07a379a86104a2ed9fd8fbeb459f352b13071))
|
|
24
|
+
* update SDK settings ([fa5033d](https://github.com/spi-tch/spitch-typescript/commit/fa5033d84fcf7235a201072b965b65fcf771b492))
|
package/LICENSE
CHANGED
|
@@ -186,7 +186,7 @@
|
|
|
186
186
|
same "printed page" as the copyright notice for easier
|
|
187
187
|
identification within third-party archives.
|
|
188
188
|
|
|
189
|
-
Copyright
|
|
189
|
+
Copyright 2025 Spitch
|
|
190
190
|
|
|
191
191
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
192
|
you may not use this file except in compliance with the License.
|
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
# Spitch
|
|
1
|
+
# Spitch TypeScript API Library
|
|
2
2
|
|
|
3
|
-
[](https://npmjs.org/package/spitch) 
|
|
3
|
+
[>)](https://npmjs.org/package/spitch) 
|
|
4
4
|
|
|
5
5
|
This library provides convenient access to the Spitch REST API from server-side TypeScript or JavaScript.
|
|
6
6
|
|
|
7
|
-
The REST API documentation can be found on [docs.
|
|
7
|
+
The REST API documentation can be found on [docs.spitch.app](https://docs.spitch.app). The full API of this library can be found in [api.md](api.md).
|
|
8
8
|
|
|
9
|
-
It is generated with [Stainless](https://www.
|
|
9
|
+
It is generated with [Stainless](https://www.stainless.com/).
|
|
10
10
|
|
|
11
11
|
## Installation
|
|
12
12
|
|
|
@@ -26,11 +26,10 @@ const client = new Spitch({
|
|
|
26
26
|
apiKey: process.env['SPITCH_API_KEY'], // This is the default and can be omitted
|
|
27
27
|
});
|
|
28
28
|
|
|
29
|
-
|
|
30
|
-
const response = await client.speech.transcibe({ language: 'yo' });
|
|
31
|
-
}
|
|
29
|
+
const response = await client.speech.generate({ language: 'yo', text: 'Bawo ni, ololufe?', voice: 'femi' });
|
|
32
30
|
|
|
33
|
-
|
|
31
|
+
const content = await response.blob();
|
|
32
|
+
console.log(content);
|
|
34
33
|
```
|
|
35
34
|
|
|
36
35
|
### Request & Response types
|
|
@@ -45,16 +44,41 @@ const client = new Spitch({
|
|
|
45
44
|
apiKey: process.env['SPITCH_API_KEY'], // This is the default and can be omitted
|
|
46
45
|
});
|
|
47
46
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
const response: unknown = await client.speech.transcibe(params);
|
|
51
|
-
}
|
|
52
|
-
|
|
53
|
-
main();
|
|
47
|
+
const params: Spitch.SpeechGenerateParams = { language: 'yo', text: 'Bawo ni, ololufe?', voice: 'sade' };
|
|
48
|
+
const response: Response = await client.speech.generate(params);
|
|
54
49
|
```
|
|
55
50
|
|
|
56
51
|
Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
|
|
57
52
|
|
|
53
|
+
## File uploads
|
|
54
|
+
|
|
55
|
+
Request parameters that correspond to file uploads can be passed in many different forms:
|
|
56
|
+
|
|
57
|
+
- `File` (or an object with the same structure)
|
|
58
|
+
- a `fetch` `Response` (or an object with the same structure)
|
|
59
|
+
- an `fs.ReadStream`
|
|
60
|
+
- the return value of our `toFile` helper
|
|
61
|
+
|
|
62
|
+
```ts
|
|
63
|
+
import fs from 'fs';
|
|
64
|
+
import Spitch, { toFile } from 'spitch';
|
|
65
|
+
|
|
66
|
+
const client = new Spitch();
|
|
67
|
+
|
|
68
|
+
// If you have access to Node `fs` we recommend using `fs.createReadStream()`:
|
|
69
|
+
await client.speech.transcribe({ language: 'yo', content: fs.createReadStream('/path/to/file') });
|
|
70
|
+
|
|
71
|
+
// Or if you have the web `File` API you can pass a `File` instance:
|
|
72
|
+
await client.speech.transcribe({ language: 'yo', content: new File(['my bytes'], 'file') });
|
|
73
|
+
|
|
74
|
+
// You can also pass a `fetch` `Response`:
|
|
75
|
+
await client.speech.transcribe({ language: 'yo', content: await fetch('https://somesite/file') });
|
|
76
|
+
|
|
77
|
+
// Finally, if none of the above are convenient, you can use our `toFile` helper:
|
|
78
|
+
await client.speech.transcribe({ language: 'yo', content: await toFile(Buffer.from('my bytes'), 'file') });
|
|
79
|
+
await client.speech.transcribe({ language: 'yo', content: await toFile(new Uint8Array([0, 1, 2]), 'file') });
|
|
80
|
+
```
|
|
81
|
+
|
|
58
82
|
## Handling errors
|
|
59
83
|
|
|
60
84
|
When the library is unable to connect to the API,
|
|
@@ -63,8 +87,9 @@ a subclass of `APIError` will be thrown:
|
|
|
63
87
|
|
|
64
88
|
<!-- prettier-ignore -->
|
|
65
89
|
```ts
|
|
66
|
-
|
|
67
|
-
|
|
90
|
+
const response = await client.speech
|
|
91
|
+
.generate({ language: 'yo', text: 'Bawo ni, ololufe?', voice: 'sade' })
|
|
92
|
+
.catch(async (err) => {
|
|
68
93
|
if (err instanceof Spitch.APIError) {
|
|
69
94
|
console.log(err.status); // 400
|
|
70
95
|
console.log(err.name); // BadRequestError
|
|
@@ -73,12 +98,9 @@ async function main() {
|
|
|
73
98
|
throw err;
|
|
74
99
|
}
|
|
75
100
|
});
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
main();
|
|
79
101
|
```
|
|
80
102
|
|
|
81
|
-
Error codes are as
|
|
103
|
+
Error codes are as follows:
|
|
82
104
|
|
|
83
105
|
| Status Code | Error Type |
|
|
84
106
|
| ----------- | -------------------------- |
|
|
@@ -107,7 +129,7 @@ const client = new Spitch({
|
|
|
107
129
|
});
|
|
108
130
|
|
|
109
131
|
// Or, configure per-request:
|
|
110
|
-
await client.speech.
|
|
132
|
+
await client.speech.generate({ language: 'yo', text: 'Bawo ni, ololufe?', voice: 'sade' }, {
|
|
111
133
|
maxRetries: 5,
|
|
112
134
|
});
|
|
113
135
|
```
|
|
@@ -124,7 +146,7 @@ const client = new Spitch({
|
|
|
124
146
|
});
|
|
125
147
|
|
|
126
148
|
// Override per-request:
|
|
127
|
-
await client.speech.
|
|
149
|
+
await client.speech.generate({ language: 'yo', text: 'Bawo ni, ololufe?', voice: 'sade' }, {
|
|
128
150
|
timeout: 5 * 1000,
|
|
129
151
|
});
|
|
130
152
|
```
|
|
@@ -133,27 +155,117 @@ On timeout, an `APIConnectionTimeoutError` is thrown.
|
|
|
133
155
|
|
|
134
156
|
Note that requests which time out will be [retried twice by default](#retries).
|
|
135
157
|
|
|
158
|
+
## Auto-pagination
|
|
159
|
+
|
|
160
|
+
List methods in the Spitch API are paginated.
|
|
161
|
+
You can use the `for await … of` syntax to iterate through items across all pages:
|
|
162
|
+
|
|
163
|
+
```ts
|
|
164
|
+
async function fetchAllFiles(params) {
|
|
165
|
+
const allFiles = [];
|
|
166
|
+
// Automatically fetches more pages as needed.
|
|
167
|
+
for await (const file of client.files.list({ limit: 10 })) {
|
|
168
|
+
allFiles.push(file);
|
|
169
|
+
}
|
|
170
|
+
return allFiles;
|
|
171
|
+
}
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
Alternatively, you can request a single page at a time:
|
|
175
|
+
|
|
176
|
+
```ts
|
|
177
|
+
let page = await client.files.list({ limit: 10 });
|
|
178
|
+
for (const file of page.items) {
|
|
179
|
+
console.log(file);
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
// Convenience methods are provided for manually paginating:
|
|
183
|
+
while (page.hasNextPage()) {
|
|
184
|
+
page = await page.getNextPage();
|
|
185
|
+
// ...
|
|
186
|
+
}
|
|
187
|
+
```
|
|
188
|
+
|
|
136
189
|
## Advanced Usage
|
|
137
190
|
|
|
138
191
|
### Accessing raw Response data (e.g., headers)
|
|
139
192
|
|
|
140
193
|
The "raw" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.
|
|
194
|
+
This method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.
|
|
141
195
|
|
|
142
196
|
You can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.
|
|
197
|
+
Unlike `.asResponse()` this method consumes the body, returning once it is parsed.
|
|
143
198
|
|
|
144
199
|
<!-- prettier-ignore -->
|
|
145
200
|
```ts
|
|
146
201
|
const client = new Spitch();
|
|
147
202
|
|
|
148
|
-
const response = await client.speech
|
|
203
|
+
const response = await client.speech
|
|
204
|
+
.generate({ language: 'yo', text: 'Bawo ni, ololufe?', voice: 'sade' })
|
|
205
|
+
.asResponse();
|
|
149
206
|
console.log(response.headers.get('X-My-Header'));
|
|
150
207
|
console.log(response.statusText); // access the underlying Response object
|
|
151
208
|
|
|
152
|
-
const { data: response, response: raw } = await client.speech
|
|
209
|
+
const { data: response, response: raw } = await client.speech
|
|
210
|
+
.generate({ language: 'yo', text: 'Bawo ni, ololufe?', voice: 'sade' })
|
|
211
|
+
.withResponse();
|
|
153
212
|
console.log(raw.headers.get('X-My-Header'));
|
|
154
213
|
console.log(response);
|
|
155
214
|
```
|
|
156
215
|
|
|
216
|
+
### Logging
|
|
217
|
+
|
|
218
|
+
> [!IMPORTANT]
|
|
219
|
+
> All log messages are intended for debugging only. The format and content of log messages
|
|
220
|
+
> may change between releases.
|
|
221
|
+
|
|
222
|
+
#### Log levels
|
|
223
|
+
|
|
224
|
+
The log level can be configured in two ways:
|
|
225
|
+
|
|
226
|
+
1. Via the `SPITCH_LOG` environment variable
|
|
227
|
+
2. Using the `logLevel` client option (overrides the environment variable if set)
|
|
228
|
+
|
|
229
|
+
```ts
|
|
230
|
+
import Spitch from 'spitch';
|
|
231
|
+
|
|
232
|
+
const client = new Spitch({
|
|
233
|
+
logLevel: 'debug', // Show all log messages
|
|
234
|
+
});
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
Available log levels, from most to least verbose:
|
|
238
|
+
|
|
239
|
+
- `'debug'` - Show debug messages, info, warnings, and errors
|
|
240
|
+
- `'info'` - Show info messages, warnings, and errors
|
|
241
|
+
- `'warn'` - Show warnings and errors (default)
|
|
242
|
+
- `'error'` - Show only errors
|
|
243
|
+
- `'off'` - Disable all logging
|
|
244
|
+
|
|
245
|
+
At the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.
|
|
246
|
+
Some authentication-related headers are redacted, but sensitive data in request and response bodies
|
|
247
|
+
may still be visible.
|
|
248
|
+
|
|
249
|
+
#### Custom logger
|
|
250
|
+
|
|
251
|
+
By default, this library logs to `globalThis.console`. You can also provide a custom logger.
|
|
252
|
+
Most logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.
|
|
253
|
+
|
|
254
|
+
When providing a custom logger, the `logLevel` option still controls which messages are emitted, messages
|
|
255
|
+
below the configured level will not be sent to your logger.
|
|
256
|
+
|
|
257
|
+
```ts
|
|
258
|
+
import Spitch from 'spitch';
|
|
259
|
+
import pino from 'pino';
|
|
260
|
+
|
|
261
|
+
const logger = pino();
|
|
262
|
+
|
|
263
|
+
const client = new Spitch({
|
|
264
|
+
logger: logger.child({ name: 'Spitch' }),
|
|
265
|
+
logLevel: 'debug', // Send all messages to pino, allowing it to filter
|
|
266
|
+
});
|
|
267
|
+
```
|
|
268
|
+
|
|
157
269
|
### Making custom/undocumented requests
|
|
158
270
|
|
|
159
271
|
This library is typed for convenient access to the documented API. If you need to access undocumented
|
|
@@ -178,9 +290,8 @@ parameter. This library doesn't validate at runtime that the request matches the
|
|
|
178
290
|
send will be sent as-is.
|
|
179
291
|
|
|
180
292
|
```ts
|
|
181
|
-
client.
|
|
182
|
-
|
|
183
|
-
bar: 12,
|
|
293
|
+
client.speech.generate({
|
|
294
|
+
// ...
|
|
184
295
|
// @ts-expect-error baz is not yet public
|
|
185
296
|
baz: 'undocumented option',
|
|
186
297
|
});
|
|
@@ -200,87 +311,112 @@ validate or strip extra properties from the response from the API.
|
|
|
200
311
|
|
|
201
312
|
### Customizing the fetch client
|
|
202
313
|
|
|
203
|
-
By default, this library
|
|
314
|
+
By default, this library expects a global `fetch` function is defined.
|
|
204
315
|
|
|
205
|
-
If you
|
|
206
|
-
(for example, if you are running Node with `--experimental-fetch` or using NextJS which polyfills with `undici`),
|
|
207
|
-
add the following import before your first import `from "Spitch"`:
|
|
316
|
+
If you want to use a different `fetch` function, you can either polyfill the global:
|
|
208
317
|
|
|
209
318
|
```ts
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
import Spitch from 'spitch';
|
|
319
|
+
import fetch from 'my-fetch';
|
|
320
|
+
|
|
321
|
+
globalThis.fetch = fetch;
|
|
214
322
|
```
|
|
215
323
|
|
|
216
|
-
|
|
217
|
-
|
|
324
|
+
Or pass it to the client:
|
|
325
|
+
|
|
326
|
+
```ts
|
|
327
|
+
import Spitch from 'spitch';
|
|
328
|
+
import fetch from 'my-fetch';
|
|
329
|
+
|
|
330
|
+
const client = new Spitch({ fetch });
|
|
331
|
+
```
|
|
218
332
|
|
|
219
|
-
###
|
|
333
|
+
### Fetch options
|
|
220
334
|
|
|
221
|
-
|
|
222
|
-
which can be used to inspect or alter the `Request` or `Response` before/after each request:
|
|
335
|
+
If you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)
|
|
223
336
|
|
|
224
337
|
```ts
|
|
225
|
-
import { fetch } from 'undici'; // as one example
|
|
226
338
|
import Spitch from 'spitch';
|
|
227
339
|
|
|
228
340
|
const client = new Spitch({
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
const response = await fetch(url, init);
|
|
232
|
-
console.log('Got response', response);
|
|
233
|
-
return response;
|
|
341
|
+
fetchOptions: {
|
|
342
|
+
// `RequestInit` options
|
|
234
343
|
},
|
|
235
344
|
});
|
|
236
345
|
```
|
|
237
346
|
|
|
238
|
-
|
|
239
|
-
This is intended for debugging purposes only and may change in the future without notice.
|
|
347
|
+
#### Configuring proxies
|
|
240
348
|
|
|
241
|
-
|
|
349
|
+
To modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy
|
|
350
|
+
options to requests:
|
|
242
351
|
|
|
243
|
-
|
|
352
|
+
<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/node.svg" align="top" width="18" height="21"> **Node** <sup>[[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]</sup>
|
|
244
353
|
|
|
245
|
-
|
|
354
|
+
```ts
|
|
355
|
+
import Spitch from 'spitch';
|
|
356
|
+
import * as undici from 'undici';
|
|
357
|
+
|
|
358
|
+
const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
|
|
359
|
+
const client = new Spitch({
|
|
360
|
+
fetchOptions: {
|
|
361
|
+
dispatcher: proxyAgent,
|
|
362
|
+
},
|
|
363
|
+
});
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/bun.svg" align="top" width="18" height="21"> **Bun** <sup>[[docs](https://bun.sh/guides/http/proxy)]</sup>
|
|
246
367
|
|
|
247
|
-
<!-- prettier-ignore -->
|
|
248
368
|
```ts
|
|
249
|
-
import
|
|
250
|
-
import { HttpsProxyAgent } from 'https-proxy-agent';
|
|
369
|
+
import Spitch from 'spitch';
|
|
251
370
|
|
|
252
|
-
// Configure the default for all requests:
|
|
253
371
|
const client = new Spitch({
|
|
254
|
-
|
|
372
|
+
fetchOptions: {
|
|
373
|
+
proxy: 'http://localhost:8888',
|
|
374
|
+
},
|
|
255
375
|
});
|
|
376
|
+
```
|
|
256
377
|
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
378
|
+
<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/deno.svg" align="top" width="18" height="21"> **Deno** <sup>[[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]</sup>
|
|
379
|
+
|
|
380
|
+
```ts
|
|
381
|
+
import Spitch from 'npm:spitch';
|
|
382
|
+
|
|
383
|
+
const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
|
|
384
|
+
const client = new Spitch({
|
|
385
|
+
fetchOptions: {
|
|
386
|
+
client: httpClient,
|
|
262
387
|
},
|
|
263
|
-
);
|
|
388
|
+
});
|
|
264
389
|
```
|
|
265
390
|
|
|
391
|
+
## Frequently Asked Questions
|
|
392
|
+
|
|
266
393
|
## Semantic versioning
|
|
267
394
|
|
|
268
395
|
This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
|
|
269
396
|
|
|
270
397
|
1. Changes that only affect static types, without breaking runtime behavior.
|
|
271
|
-
2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_
|
|
398
|
+
2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_
|
|
272
399
|
3. Changes that we do not expect to impact the vast majority of users in practice.
|
|
273
400
|
|
|
274
401
|
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
|
|
275
402
|
|
|
276
|
-
We are keen for your feedback; please open an [issue](https://www.github.com/spi-tch/spitch-
|
|
403
|
+
We are keen for your feedback; please open an [issue](https://www.github.com/spi-tch/spitch-typescript/issues) with questions, bugs, or suggestions.
|
|
277
404
|
|
|
278
405
|
## Requirements
|
|
279
406
|
|
|
280
|
-
TypeScript >= 4.
|
|
407
|
+
TypeScript >= 4.9 is supported.
|
|
281
408
|
|
|
282
409
|
The following runtimes are supported:
|
|
283
410
|
|
|
411
|
+
- Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)
|
|
412
|
+
- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
|
|
413
|
+
- Deno v1.28.0 or higher.
|
|
414
|
+
- Bun 1.0 or later.
|
|
415
|
+
- Cloudflare Workers.
|
|
416
|
+
- Vercel Edge Runtime.
|
|
417
|
+
- Jest 28 or greater with the `"node"` environment (`"jsdom"` is not supported at this time).
|
|
418
|
+
- Nitro v2.6 or greater.
|
|
419
|
+
|
|
284
420
|
Note that React Native is not supported at this time.
|
|
285
421
|
|
|
286
422
|
If you are interested in other runtime environments, please open or upvote an issue on GitHub.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-promise.d.mts","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}
|
package/api-promise.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-promise.d.ts","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}
|
package/api-promise.js
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const tslib_1 = require("./internal/tslib.js");
|
|
4
|
+
/** @deprecated Import from ./core/api-promise instead */
|
|
5
|
+
tslib_1.__exportStar(require("./core/api-promise.js"), exports);
|
|
6
|
+
//# sourceMappingURL=api-promise.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-promise.js","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":";;;AAAA,yDAAyD;AACzD,gEAAmC"}
|
package/api-promise.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-promise.mjs","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}
|