spitch 0.1.0-alpha.1 → 1.18.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 (439) hide show
  1. package/CHANGELOG.md +21 -8
  2. package/LICENSE +1 -1
  3. package/README.md +170 -71
  4. package/api-promise.d.mts +2 -0
  5. package/api-promise.d.mts.map +1 -0
  6. package/api-promise.d.ts +2 -0
  7. package/api-promise.d.ts.map +1 -0
  8. package/api-promise.js +6 -0
  9. package/api-promise.js.map +1 -0
  10. package/api-promise.mjs +2 -0
  11. package/api-promise.mjs.map +1 -0
  12. package/client.d.mts +183 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +183 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +464 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +460 -0
  19. package/client.mjs.map +1 -0
  20. package/core/api-promise.d.mts +46 -0
  21. package/core/api-promise.d.mts.map +1 -0
  22. package/core/api-promise.d.ts +46 -0
  23. package/core/api-promise.d.ts.map +1 -0
  24. package/core/api-promise.js +74 -0
  25. package/core/api-promise.js.map +1 -0
  26. package/core/api-promise.mjs +70 -0
  27. package/core/api-promise.mjs.map +1 -0
  28. package/core/error.d.mts +46 -0
  29. package/core/error.d.mts.map +1 -0
  30. package/core/error.d.ts +46 -0
  31. package/core/error.d.ts.map +1 -0
  32. package/core/error.js +113 -0
  33. package/core/error.js.map +1 -0
  34. package/core/error.mjs +97 -0
  35. package/core/error.mjs.map +1 -0
  36. package/core/resource.d.mts +6 -0
  37. package/core/resource.d.mts.map +1 -0
  38. package/core/resource.d.ts +6 -0
  39. package/core/resource.d.ts.map +1 -0
  40. package/core/resource.js +11 -0
  41. package/core/resource.js.map +1 -0
  42. package/core/resource.mjs +7 -0
  43. package/core/resource.mjs.map +1 -0
  44. package/core/uploads.d.mts +3 -0
  45. package/core/uploads.d.mts.map +1 -0
  46. package/core/uploads.d.ts +3 -0
  47. package/core/uploads.d.ts.map +1 -0
  48. package/core/uploads.js +6 -0
  49. package/core/uploads.js.map +1 -0
  50. package/core/uploads.mjs +2 -0
  51. package/core/uploads.mjs.map +1 -0
  52. package/error.d.mts +2 -0
  53. package/error.d.mts.map +1 -0
  54. package/error.d.ts +1 -52
  55. package/error.d.ts.map +1 -1
  56. package/error.js +3 -140
  57. package/error.js.map +1 -1
  58. package/error.mjs +1 -126
  59. package/error.mjs.map +1 -1
  60. package/index.d.mts +6 -118
  61. package/index.d.mts.map +1 -0
  62. package/index.d.ts +5 -117
  63. package/index.d.ts.map +1 -1
  64. package/index.js +26 -107
  65. package/index.js.map +1 -1
  66. package/index.mjs +5 -81
  67. package/index.mjs.map +1 -1
  68. package/internal/builtin-types.d.mts +73 -0
  69. package/internal/builtin-types.d.mts.map +1 -0
  70. package/internal/builtin-types.d.ts +73 -0
  71. package/internal/builtin-types.d.ts.map +1 -0
  72. package/internal/builtin-types.js +4 -0
  73. package/internal/builtin-types.js.map +1 -0
  74. package/internal/builtin-types.mjs +3 -0
  75. package/internal/builtin-types.mjs.map +1 -0
  76. package/internal/detect-platform.d.mts +15 -0
  77. package/internal/detect-platform.d.mts.map +1 -0
  78. package/internal/detect-platform.d.ts +15 -0
  79. package/internal/detect-platform.d.ts.map +1 -0
  80. package/internal/detect-platform.js +162 -0
  81. package/internal/detect-platform.js.map +1 -0
  82. package/internal/detect-platform.mjs +157 -0
  83. package/internal/detect-platform.mjs.map +1 -0
  84. package/internal/errors.d.mts +3 -0
  85. package/internal/errors.d.mts.map +1 -0
  86. package/internal/errors.d.ts +3 -0
  87. package/internal/errors.d.ts.map +1 -0
  88. package/internal/errors.js +41 -0
  89. package/internal/errors.js.map +1 -0
  90. package/internal/errors.mjs +36 -0
  91. package/internal/errors.mjs.map +1 -0
  92. package/internal/headers.d.mts +20 -0
  93. package/internal/headers.d.mts.map +1 -0
  94. package/internal/headers.d.ts +20 -0
  95. package/internal/headers.d.ts.map +1 -0
  96. package/internal/headers.js +79 -0
  97. package/internal/headers.js.map +1 -0
  98. package/internal/headers.mjs +74 -0
  99. package/internal/headers.mjs.map +1 -0
  100. package/internal/parse.d.mts +12 -0
  101. package/internal/parse.d.mts.map +1 -0
  102. package/internal/parse.d.ts +12 -0
  103. package/internal/parse.d.ts.map +1 -0
  104. package/internal/parse.js +35 -0
  105. package/internal/parse.js.map +1 -0
  106. package/internal/parse.mjs +32 -0
  107. package/internal/parse.mjs.map +1 -0
  108. package/internal/request-options.d.mts +75 -0
  109. package/internal/request-options.d.mts.map +1 -0
  110. package/internal/request-options.d.ts +75 -0
  111. package/internal/request-options.d.ts.map +1 -0
  112. package/internal/request-options.js +14 -0
  113. package/internal/request-options.js.map +1 -0
  114. package/internal/request-options.mjs +10 -0
  115. package/internal/request-options.mjs.map +1 -0
  116. package/internal/shim-types.d.mts +17 -0
  117. package/internal/shim-types.d.mts.map +1 -0
  118. package/internal/shim-types.d.ts +17 -0
  119. package/internal/shim-types.d.ts.map +1 -0
  120. package/internal/shim-types.js +4 -0
  121. package/internal/shim-types.js.map +1 -0
  122. package/internal/shim-types.mjs +3 -0
  123. package/internal/shim-types.mjs.map +1 -0
  124. package/internal/shims.d.mts +20 -0
  125. package/internal/shims.d.mts.map +1 -0
  126. package/internal/shims.d.ts +20 -0
  127. package/internal/shims.d.ts.map +1 -0
  128. package/internal/shims.js +92 -0
  129. package/internal/shims.js.map +1 -0
  130. package/internal/shims.mjs +85 -0
  131. package/internal/shims.mjs.map +1 -0
  132. package/internal/to-file.d.mts +45 -0
  133. package/internal/to-file.d.mts.map +1 -0
  134. package/internal/to-file.d.ts +45 -0
  135. package/internal/to-file.d.ts.map +1 -0
  136. package/internal/to-file.js +91 -0
  137. package/internal/to-file.js.map +1 -0
  138. package/internal/to-file.mjs +88 -0
  139. package/internal/to-file.mjs.map +1 -0
  140. package/internal/tslib.js +81 -0
  141. package/internal/tslib.mjs +17 -0
  142. package/internal/types.d.mts +69 -0
  143. package/internal/types.d.mts.map +1 -0
  144. package/internal/types.d.ts +69 -0
  145. package/internal/types.d.ts.map +1 -0
  146. package/internal/types.js +4 -0
  147. package/internal/types.js.map +1 -0
  148. package/internal/types.mjs +3 -0
  149. package/internal/types.mjs.map +1 -0
  150. package/internal/uploads.d.mts +42 -0
  151. package/internal/uploads.d.mts.map +1 -0
  152. package/internal/uploads.d.ts +42 -0
  153. package/internal/uploads.d.ts.map +1 -0
  154. package/internal/uploads.js +141 -0
  155. package/internal/uploads.js.map +1 -0
  156. package/internal/uploads.mjs +131 -0
  157. package/internal/uploads.mjs.map +1 -0
  158. package/internal/utils/base64.d.mts +3 -0
  159. package/internal/utils/base64.d.mts.map +1 -0
  160. package/internal/utils/base64.d.ts +3 -0
  161. package/internal/utils/base64.d.ts.map +1 -0
  162. package/internal/utils/base64.js +38 -0
  163. package/internal/utils/base64.js.map +1 -0
  164. package/internal/utils/base64.mjs +33 -0
  165. package/internal/utils/base64.mjs.map +1 -0
  166. package/internal/utils/bytes.d.mts +4 -0
  167. package/internal/utils/bytes.d.mts.map +1 -0
  168. package/internal/utils/bytes.d.ts +4 -0
  169. package/internal/utils/bytes.d.ts.map +1 -0
  170. package/internal/utils/bytes.js +31 -0
  171. package/internal/utils/bytes.js.map +1 -0
  172. package/internal/utils/bytes.mjs +26 -0
  173. package/internal/utils/bytes.mjs.map +1 -0
  174. package/internal/utils/env.d.mts +9 -0
  175. package/internal/utils/env.d.mts.map +1 -0
  176. package/internal/utils/env.d.ts +9 -0
  177. package/internal/utils/env.d.ts.map +1 -0
  178. package/internal/utils/env.js +22 -0
  179. package/internal/utils/env.js.map +1 -0
  180. package/internal/utils/env.mjs +18 -0
  181. package/internal/utils/env.mjs.map +1 -0
  182. package/internal/utils/log.d.mts +37 -0
  183. package/internal/utils/log.d.mts.map +1 -0
  184. package/internal/utils/log.d.ts +37 -0
  185. package/internal/utils/log.d.ts.map +1 -0
  186. package/internal/utils/log.js +85 -0
  187. package/internal/utils/log.js.map +1 -0
  188. package/internal/utils/log.mjs +79 -0
  189. package/internal/utils/log.mjs.map +1 -0
  190. package/internal/utils/path.d.mts +15 -0
  191. package/internal/utils/path.d.mts.map +1 -0
  192. package/internal/utils/path.d.ts +15 -0
  193. package/internal/utils/path.d.ts.map +1 -0
  194. package/internal/utils/path.js +79 -0
  195. package/internal/utils/path.js.map +1 -0
  196. package/internal/utils/path.mjs +74 -0
  197. package/internal/utils/path.mjs.map +1 -0
  198. package/internal/utils/sleep.d.mts +2 -0
  199. package/internal/utils/sleep.d.mts.map +1 -0
  200. package/internal/utils/sleep.d.ts +2 -0
  201. package/internal/utils/sleep.d.ts.map +1 -0
  202. package/internal/utils/sleep.js +7 -0
  203. package/internal/utils/sleep.js.map +1 -0
  204. package/internal/utils/sleep.mjs +3 -0
  205. package/internal/utils/sleep.mjs.map +1 -0
  206. package/internal/utils/uuid.d.mts +5 -0
  207. package/internal/utils/uuid.d.mts.map +1 -0
  208. package/internal/utils/uuid.d.ts +5 -0
  209. package/internal/utils/uuid.d.ts.map +1 -0
  210. package/internal/utils/uuid.js +19 -0
  211. package/internal/utils/uuid.js.map +1 -0
  212. package/internal/utils/uuid.mjs +15 -0
  213. package/internal/utils/uuid.mjs.map +1 -0
  214. package/internal/utils/values.d.mts +18 -0
  215. package/internal/utils/values.d.mts.map +1 -0
  216. package/internal/utils/values.d.ts +18 -0
  217. package/internal/utils/values.d.ts.map +1 -0
  218. package/internal/utils/values.js +112 -0
  219. package/internal/utils/values.js.map +1 -0
  220. package/internal/utils/values.mjs +94 -0
  221. package/internal/utils/values.mjs.map +1 -0
  222. package/internal/utils.d.mts +7 -0
  223. package/internal/utils.d.mts.map +1 -0
  224. package/internal/utils.d.ts +7 -0
  225. package/internal/utils.d.ts.map +1 -0
  226. package/internal/utils.js +11 -0
  227. package/internal/utils.js.map +1 -0
  228. package/internal/utils.mjs +8 -0
  229. package/internal/utils.mjs.map +1 -0
  230. package/package.json +104 -72
  231. package/resource.d.mts +2 -0
  232. package/resource.d.mts.map +1 -0
  233. package/resource.d.ts +1 -5
  234. package/resource.d.ts.map +1 -1
  235. package/resource.js +3 -8
  236. package/resource.js.map +1 -1
  237. package/resource.mjs +1 -6
  238. package/resource.mjs.map +1 -1
  239. package/resources/index.d.mts +3 -0
  240. package/resources/index.d.mts.map +1 -0
  241. package/resources/index.d.ts +2 -2
  242. package/resources/index.d.ts.map +1 -1
  243. package/resources/index.js.map +1 -1
  244. package/resources/index.mjs +1 -1
  245. package/resources/index.mjs.map +1 -1
  246. package/resources/speech.d.mts +44 -0
  247. package/resources/speech.d.mts.map +1 -0
  248. package/resources/speech.d.ts +28 -29
  249. package/resources/speech.d.ts.map +1 -1
  250. package/resources/speech.js +15 -32
  251. package/resources/speech.js.map +1 -1
  252. package/resources/speech.mjs +15 -9
  253. package/resources/speech.mjs.map +1 -1
  254. package/resources/text.d.mts +34 -0
  255. package/resources/text.d.mts.map +1 -0
  256. package/resources/text.d.ts +23 -8
  257. package/resources/text.d.ts.map +1 -1
  258. package/resources/text.js +7 -3
  259. package/resources/text.js.map +1 -1
  260. package/resources/text.mjs +7 -3
  261. package/resources/text.mjs.map +1 -1
  262. package/resources.d.mts +2 -0
  263. package/resources.d.mts.map +1 -0
  264. package/resources.d.ts +2 -0
  265. package/resources.d.ts.map +1 -0
  266. package/resources.js +5 -0
  267. package/resources.js.map +1 -0
  268. package/resources.mjs +2 -0
  269. package/resources.mjs.map +1 -0
  270. package/src/api-promise.ts +2 -0
  271. package/src/client.ts +751 -0
  272. package/src/core/README.md +3 -0
  273. package/src/core/api-promise.ts +92 -0
  274. package/src/core/error.ts +130 -0
  275. package/src/core/resource.ts +11 -0
  276. package/src/core/uploads.ts +2 -0
  277. package/src/error.ts +2 -146
  278. package/src/index.ts +6 -178
  279. package/src/internal/README.md +3 -0
  280. package/src/internal/builtin-types.ts +93 -0
  281. package/src/internal/detect-platform.ts +196 -0
  282. package/src/internal/errors.ts +33 -0
  283. package/src/internal/headers.ts +97 -0
  284. package/src/internal/parse.ts +50 -0
  285. package/src/internal/request-options.ts +91 -0
  286. package/src/internal/shim-types.ts +26 -0
  287. package/src/internal/shims.ts +107 -0
  288. package/src/internal/to-file.ts +154 -0
  289. package/src/internal/types.ts +95 -0
  290. package/src/internal/uploads.ts +187 -0
  291. package/src/internal/utils/base64.ts +40 -0
  292. package/src/internal/utils/bytes.ts +32 -0
  293. package/src/internal/utils/env.ts +18 -0
  294. package/src/internal/utils/log.ts +126 -0
  295. package/src/internal/utils/path.ts +88 -0
  296. package/src/internal/utils/sleep.ts +3 -0
  297. package/src/internal/utils/uuid.ts +17 -0
  298. package/src/internal/utils/values.ts +105 -0
  299. package/src/internal/utils.ts +8 -0
  300. package/src/resource.ts +2 -11
  301. package/src/resources/index.ts +10 -5
  302. package/src/resources/speech.ts +74 -33
  303. package/src/resources/text.ts +38 -9
  304. package/src/resources.ts +1 -0
  305. package/src/tsconfig.json +2 -2
  306. package/src/uploads.ts +2 -255
  307. package/src/version.ts +1 -1
  308. package/uploads.d.mts +2 -0
  309. package/uploads.d.mts.map +1 -0
  310. package/uploads.d.ts +1 -74
  311. package/uploads.d.ts.map +1 -1
  312. package/uploads.js +3 -168
  313. package/uploads.js.map +1 -1
  314. package/uploads.mjs +1 -157
  315. package/uploads.mjs.map +1 -1
  316. package/version.d.mts +2 -0
  317. package/version.d.mts.map +1 -0
  318. package/version.d.ts +1 -1
  319. package/version.d.ts.map +1 -1
  320. package/version.js +1 -1
  321. package/version.js.map +1 -1
  322. package/version.mjs +1 -1
  323. package/version.mjs.map +1 -1
  324. package/_shims/MultipartBody.d.ts +0 -9
  325. package/_shims/MultipartBody.d.ts.map +0 -1
  326. package/_shims/MultipartBody.js +0 -16
  327. package/_shims/MultipartBody.js.map +0 -1
  328. package/_shims/MultipartBody.mjs +0 -12
  329. package/_shims/MultipartBody.mjs.map +0 -1
  330. package/_shims/README.md +0 -46
  331. package/_shims/auto/runtime-bun.d.ts +0 -5
  332. package/_shims/auto/runtime-bun.d.ts.map +0 -1
  333. package/_shims/auto/runtime-bun.js +0 -21
  334. package/_shims/auto/runtime-bun.js.map +0 -1
  335. package/_shims/auto/runtime-bun.mjs +0 -2
  336. package/_shims/auto/runtime-bun.mjs.map +0 -1
  337. package/_shims/auto/runtime-node.d.ts +0 -5
  338. package/_shims/auto/runtime-node.d.ts.map +0 -1
  339. package/_shims/auto/runtime-node.js +0 -21
  340. package/_shims/auto/runtime-node.js.map +0 -1
  341. package/_shims/auto/runtime-node.mjs +0 -2
  342. package/_shims/auto/runtime-node.mjs.map +0 -1
  343. package/_shims/auto/runtime.d.ts +0 -5
  344. package/_shims/auto/runtime.d.ts.map +0 -1
  345. package/_shims/auto/runtime.js +0 -21
  346. package/_shims/auto/runtime.js.map +0 -1
  347. package/_shims/auto/runtime.mjs +0 -2
  348. package/_shims/auto/runtime.mjs.map +0 -1
  349. package/_shims/auto/types-node.d.ts +0 -5
  350. package/_shims/auto/types-node.d.ts.map +0 -1
  351. package/_shims/auto/types-node.js +0 -21
  352. package/_shims/auto/types-node.js.map +0 -1
  353. package/_shims/auto/types-node.mjs +0 -2
  354. package/_shims/auto/types-node.mjs.map +0 -1
  355. package/_shims/auto/types.d.ts +0 -101
  356. package/_shims/auto/types.js +0 -3
  357. package/_shims/auto/types.mjs +0 -3
  358. package/_shims/bun-runtime.d.ts +0 -6
  359. package/_shims/bun-runtime.d.ts.map +0 -1
  360. package/_shims/bun-runtime.js +0 -14
  361. package/_shims/bun-runtime.js.map +0 -1
  362. package/_shims/bun-runtime.mjs +0 -10
  363. package/_shims/bun-runtime.mjs.map +0 -1
  364. package/_shims/index.d.ts +0 -81
  365. package/_shims/index.js +0 -13
  366. package/_shims/index.mjs +0 -7
  367. package/_shims/manual-types.d.ts +0 -12
  368. package/_shims/manual-types.js +0 -3
  369. package/_shims/manual-types.mjs +0 -3
  370. package/_shims/node-runtime.d.ts +0 -3
  371. package/_shims/node-runtime.d.ts.map +0 -1
  372. package/_shims/node-runtime.js +0 -89
  373. package/_shims/node-runtime.js.map +0 -1
  374. package/_shims/node-runtime.mjs +0 -56
  375. package/_shims/node-runtime.mjs.map +0 -1
  376. package/_shims/node-types.d.ts +0 -42
  377. package/_shims/node-types.js +0 -3
  378. package/_shims/node-types.mjs +0 -3
  379. package/_shims/registry.d.ts +0 -37
  380. package/_shims/registry.d.ts.map +0 -1
  381. package/_shims/registry.js +0 -41
  382. package/_shims/registry.js.map +0 -1
  383. package/_shims/registry.mjs +0 -37
  384. package/_shims/registry.mjs.map +0 -1
  385. package/_shims/web-runtime.d.ts +0 -5
  386. package/_shims/web-runtime.d.ts.map +0 -1
  387. package/_shims/web-runtime.js +0 -78
  388. package/_shims/web-runtime.js.map +0 -1
  389. package/_shims/web-runtime.mjs +0 -71
  390. package/_shims/web-runtime.mjs.map +0 -1
  391. package/_shims/web-types.d.ts +0 -83
  392. package/_shims/web-types.js +0 -3
  393. package/_shims/web-types.mjs +0 -3
  394. package/core.d.ts +0 -242
  395. package/core.d.ts.map +0 -1
  396. package/core.js +0 -901
  397. package/core.js.map +0 -1
  398. package/core.mjs +0 -869
  399. package/core.mjs.map +0 -1
  400. package/shims/node.d.ts +0 -30
  401. package/shims/node.d.ts.map +0 -1
  402. package/shims/node.js +0 -31
  403. package/shims/node.js.map +0 -1
  404. package/shims/node.mjs +0 -5
  405. package/shims/node.mjs.map +0 -1
  406. package/shims/web.d.ts +0 -26
  407. package/shims/web.d.ts.map +0 -1
  408. package/shims/web.js +0 -31
  409. package/shims/web.js.map +0 -1
  410. package/shims/web.mjs +0 -5
  411. package/shims/web.mjs.map +0 -1
  412. package/src/_shims/MultipartBody.ts +0 -9
  413. package/src/_shims/README.md +0 -46
  414. package/src/_shims/auto/runtime-bun.ts +0 -4
  415. package/src/_shims/auto/runtime-node.ts +0 -4
  416. package/src/_shims/auto/runtime.ts +0 -4
  417. package/src/_shims/auto/types-node.ts +0 -4
  418. package/src/_shims/auto/types.d.ts +0 -101
  419. package/src/_shims/auto/types.js +0 -3
  420. package/src/_shims/auto/types.mjs +0 -3
  421. package/src/_shims/bun-runtime.ts +0 -14
  422. package/src/_shims/index.d.ts +0 -81
  423. package/src/_shims/index.js +0 -13
  424. package/src/_shims/index.mjs +0 -7
  425. package/src/_shims/manual-types.d.ts +0 -12
  426. package/src/_shims/manual-types.js +0 -3
  427. package/src/_shims/manual-types.mjs +0 -3
  428. package/src/_shims/node-runtime.ts +0 -81
  429. package/src/_shims/node-types.d.ts +0 -42
  430. package/src/_shims/node-types.js +0 -3
  431. package/src/_shims/node-types.mjs +0 -3
  432. package/src/_shims/registry.ts +0 -65
  433. package/src/_shims/web-runtime.ts +0 -103
  434. package/src/_shims/web-types.d.ts +0 -83
  435. package/src/_shims/web-types.js +0 -3
  436. package/src/_shims/web-types.mjs +0 -3
  437. package/src/core.ts +0 -1190
  438. package/src/shims/node.ts +0 -50
  439. package/src/shims/web.ts +0 -50
package/CHANGELOG.md CHANGED
@@ -1,19 +1,32 @@
1
1
  # Changelog
2
2
 
3
- ## 0.1.0-alpha.1 (2024-10-07)
3
+ ## 1.18.0 (2025-08-02)
4
4
 
5
- Full Changelog: [v0.0.1-alpha.1...v0.1.0-alpha.1](https://github.com/spi-tch/spitch-node/compare/v0.0.1-alpha.1...v0.1.0-alpha.1)
5
+ Full Changelog: [v1.17.0...v1.18.0](https://github.com/spi-tch/spitch-typescript/compare/v1.17.0...v1.18.0)
6
6
 
7
7
  ### Features
8
8
 
9
- * **api:** update via SDK Studio ([#4](https://github.com/spi-tch/spitch-node/issues/4)) ([b47be40](https://github.com/spi-tch/spitch-node/commit/b47be4008b54df199f59a1da9f6bd12c9cdf2db0))
9
+ * **api:** update via SDK Studio ([7a1064a](https://github.com/spi-tch/spitch-typescript/commit/7a1064a21ff0f29a22de6f366d83cbeba0737154))
10
10
 
11
- ## 0.0.1-alpha.1 (2024-10-07)
11
+ ## 1.17.0 (2025-08-02)
12
+
13
+ Full Changelog: [v0.1.0-alpha.1...v1.17.0](https://github.com/spi-tch/spitch-typescript/compare/v0.1.0-alpha.1...v1.17.0)
14
+
15
+ ### Features
16
+
17
+ * **api:** update via SDK Studio ([f73d00e](https://github.com/spi-tch/spitch-typescript/commit/f73d00ee3d5701d1f1904402353ef7f70c70f93d))
18
+
19
+ ## 0.1.0-alpha.1 (2025-08-01)
20
+
21
+ Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/spi-tch/spitch-typescript/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)
22
+
23
+ ### Features
24
+
25
+ * **api:** update via SDK Studio ([a34386f](https://github.com/spi-tch/spitch-typescript/commit/a34386f023f82cb9cea023b634fd2bc422845015))
26
+ * **api:** update via SDK Studio ([034dd1d](https://github.com/spi-tch/spitch-typescript/commit/034dd1df081f1590dfeaeef4e57baf849bbc6e9e))
12
27
 
13
- 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)
14
28
 
15
29
  ### Chores
16
30
 
17
- * configure new SDK language ([e2332da](https://github.com/spi-tch/spitch-node/commit/e2332dae13707ef0202557747eea4c297da5443c))
18
- * configure new SDK language ([eba18ed](https://github.com/spi-tch/spitch-node/commit/eba18edb6352524f1b1c12726b85e7e4ef2640f8))
19
- * go live ([#1](https://github.com/spi-tch/spitch-node/issues/1)) ([0ef989d](https://github.com/spi-tch/spitch-node/commit/0ef989d934571aca2926db0b1c1d0c4ff11497b1))
31
+ * update SDK settings ([62b07a3](https://github.com/spi-tch/spitch-typescript/commit/62b07a379a86104a2ed9fd8fbeb459f352b13071))
32
+ * 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 2024 Spitch
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 Node API Library
1
+ # Spitch TypeScript API Library
2
2
 
3
- [![NPM version](https://img.shields.io/npm/v/spitch.svg)](https://npmjs.org/package/spitch) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/spitch)
3
+ [![NPM version](<https://img.shields.io/npm/v/spitch.svg?label=npm%20(stable)>)](https://npmjs.org/package/spitch) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/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.spi-tch.com](https://docs.spi-tch.com). The full API of this library can be found in [api.md](api.md).
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.stainlessapi.com/).
9
+ It is generated with [Stainless](https://www.stainless.com/).
10
10
 
11
11
  ## Installation
12
12
 
@@ -22,15 +22,12 @@ The full API of this library can be found in [api.md](api.md).
22
22
  ```js
23
23
  import Spitch from 'spitch';
24
24
 
25
- const client = new Spitch({
26
- apiKey: process.env['SPITCH_API_KEY'], // This is the default and can be omitted
27
- });
25
+ const client = new Spitch();
28
26
 
29
- async function main() {
30
- const response = await client.speech.transcibe({ language: 'yo' });
31
- }
27
+ const response = await client.speech.generate({ language: 'yo', text: 'text', voice: 'sade' });
32
28
 
33
- main();
29
+ const content = await response.blob();
30
+ console.log(content);
34
31
  ```
35
32
 
36
33
  ### Request & Response types
@@ -41,20 +38,43 @@ This library includes TypeScript definitions for all request params and response
41
38
  ```ts
42
39
  import Spitch from 'spitch';
43
40
 
44
- const client = new Spitch({
45
- apiKey: process.env['SPITCH_API_KEY'], // This is the default and can be omitted
46
- });
47
-
48
- async function main() {
49
- const params: Spitch.SpeechTranscibeParams = { language: 'yo' };
50
- const response: unknown = await client.speech.transcibe(params);
51
- }
41
+ const client = new Spitch();
52
42
 
53
- main();
43
+ const params: Spitch.SpeechGenerateParams = { language: 'yo', text: 'text', voice: 'sade' };
44
+ const response: Response = await client.speech.generate(params);
54
45
  ```
55
46
 
56
47
  Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
57
48
 
49
+ ## File uploads
50
+
51
+ Request parameters that correspond to file uploads can be passed in many different forms:
52
+
53
+ - `File` (or an object with the same structure)
54
+ - a `fetch` `Response` (or an object with the same structure)
55
+ - an `fs.ReadStream`
56
+ - the return value of our `toFile` helper
57
+
58
+ ```ts
59
+ import fs from 'fs';
60
+ import Spitch, { toFile } from 'spitch';
61
+
62
+ const client = new Spitch();
63
+
64
+ // If you have access to Node `fs` we recommend using `fs.createReadStream()`:
65
+ await client.speech.transcribe({ language: 'yo', content: fs.createReadStream('/path/to/file') });
66
+
67
+ // Or if you have the web `File` API you can pass a `File` instance:
68
+ await client.speech.transcribe({ language: 'yo', content: new File(['my bytes'], 'file') });
69
+
70
+ // You can also pass a `fetch` `Response`:
71
+ await client.speech.transcribe({ language: 'yo', content: await fetch('https://somesite/file') });
72
+
73
+ // Finally, if none of the above are convenient, you can use our `toFile` helper:
74
+ await client.speech.transcribe({ language: 'yo', content: await toFile(Buffer.from('my bytes'), 'file') });
75
+ await client.speech.transcribe({ language: 'yo', content: await toFile(new Uint8Array([0, 1, 2]), 'file') });
76
+ ```
77
+
58
78
  ## Handling errors
59
79
 
60
80
  When the library is unable to connect to the API,
@@ -63,8 +83,9 @@ a subclass of `APIError` will be thrown:
63
83
 
64
84
  <!-- prettier-ignore -->
65
85
  ```ts
66
- async function main() {
67
- const response = await client.speech.transcibe({ language: 'yo' }).catch(async (err) => {
86
+ const response = await client.speech
87
+ .generate({ language: 'yo', text: 'text', voice: 'sade' })
88
+ .catch(async (err) => {
68
89
  if (err instanceof Spitch.APIError) {
69
90
  console.log(err.status); // 400
70
91
  console.log(err.name); // BadRequestError
@@ -73,12 +94,9 @@ async function main() {
73
94
  throw err;
74
95
  }
75
96
  });
76
- }
77
-
78
- main();
79
97
  ```
80
98
 
81
- Error codes are as followed:
99
+ Error codes are as follows:
82
100
 
83
101
  | Status Code | Error Type |
84
102
  | ----------- | -------------------------- |
@@ -107,7 +125,7 @@ const client = new Spitch({
107
125
  });
108
126
 
109
127
  // Or, configure per-request:
110
- await client.speech.transcibe({ language: 'yo' }, {
128
+ await client.speech.generate({ language: 'yo', text: 'text', voice: 'sade' }, {
111
129
  maxRetries: 5,
112
130
  });
113
131
  ```
@@ -124,7 +142,7 @@ const client = new Spitch({
124
142
  });
125
143
 
126
144
  // Override per-request:
127
- await client.speech.transcibe({ language: 'yo' }, {
145
+ await client.speech.generate({ language: 'yo', text: 'text', voice: 'sade' }, {
128
146
  timeout: 5 * 1000,
129
147
  });
130
148
  ```
@@ -138,22 +156,79 @@ Note that requests which time out will be [retried twice by default](#retries).
138
156
  ### Accessing raw Response data (e.g., headers)
139
157
 
140
158
  The "raw" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.
159
+ 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
160
 
142
161
  You can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.
162
+ Unlike `.asResponse()` this method consumes the body, returning once it is parsed.
143
163
 
144
164
  <!-- prettier-ignore -->
145
165
  ```ts
146
166
  const client = new Spitch();
147
167
 
148
- const response = await client.speech.transcibe({ language: 'yo' }).asResponse();
168
+ const response = await client.speech.generate({ language: 'yo', text: 'text', voice: 'sade' }).asResponse();
149
169
  console.log(response.headers.get('X-My-Header'));
150
170
  console.log(response.statusText); // access the underlying Response object
151
171
 
152
- const { data: response, response: raw } = await client.speech.transcibe({ language: 'yo' }).withResponse();
172
+ const { data: response, response: raw } = await client.speech
173
+ .generate({ language: 'yo', text: 'text', voice: 'sade' })
174
+ .withResponse();
153
175
  console.log(raw.headers.get('X-My-Header'));
154
176
  console.log(response);
155
177
  ```
156
178
 
179
+ ### Logging
180
+
181
+ > [!IMPORTANT]
182
+ > All log messages are intended for debugging only. The format and content of log messages
183
+ > may change between releases.
184
+
185
+ #### Log levels
186
+
187
+ The log level can be configured in two ways:
188
+
189
+ 1. Via the `SPITCH_LOG` environment variable
190
+ 2. Using the `logLevel` client option (overrides the environment variable if set)
191
+
192
+ ```ts
193
+ import Spitch from 'spitch';
194
+
195
+ const client = new Spitch({
196
+ logLevel: 'debug', // Show all log messages
197
+ });
198
+ ```
199
+
200
+ Available log levels, from most to least verbose:
201
+
202
+ - `'debug'` - Show debug messages, info, warnings, and errors
203
+ - `'info'` - Show info messages, warnings, and errors
204
+ - `'warn'` - Show warnings and errors (default)
205
+ - `'error'` - Show only errors
206
+ - `'off'` - Disable all logging
207
+
208
+ At the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.
209
+ Some authentication-related headers are redacted, but sensitive data in request and response bodies
210
+ may still be visible.
211
+
212
+ #### Custom logger
213
+
214
+ By default, this library logs to `globalThis.console`. You can also provide a custom logger.
215
+ 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.
216
+
217
+ When providing a custom logger, the `logLevel` option still controls which messages are emitted, messages
218
+ below the configured level will not be sent to your logger.
219
+
220
+ ```ts
221
+ import Spitch from 'spitch';
222
+ import pino from 'pino';
223
+
224
+ const logger = pino();
225
+
226
+ const client = new Spitch({
227
+ logger: logger.child({ name: 'Spitch' }),
228
+ logLevel: 'debug', // Send all messages to pino, allowing it to filter
229
+ });
230
+ ```
231
+
157
232
  ### Making custom/undocumented requests
158
233
 
159
234
  This library is typed for convenient access to the documented API. If you need to access undocumented
@@ -178,9 +253,8 @@ parameter. This library doesn't validate at runtime that the request matches the
178
253
  send will be sent as-is.
179
254
 
180
255
  ```ts
181
- client.foo.create({
182
- foo: 'my_param',
183
- bar: 12,
256
+ client.speech.generate({
257
+ // ...
184
258
  // @ts-expect-error baz is not yet public
185
259
  baz: 'undocumented option',
186
260
  });
@@ -200,87 +274,112 @@ validate or strip extra properties from the response from the API.
200
274
 
201
275
  ### Customizing the fetch client
202
276
 
203
- By default, this library uses `node-fetch` in Node, and expects a global `fetch` function in other environments.
277
+ By default, this library expects a global `fetch` function is defined.
204
278
 
205
- If you would prefer to use a global, web-standards-compliant `fetch` function even in a Node environment,
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"`:
279
+ If you want to use a different `fetch` function, you can either polyfill the global:
208
280
 
209
281
  ```ts
210
- // Tell TypeScript and the package to use the global web fetch instead of node-fetch.
211
- // Note, despite the name, this does not add any polyfills, but expects them to be provided if needed.
212
- import 'spitch/shims/web';
213
- import Spitch from 'spitch';
282
+ import fetch from 'my-fetch';
283
+
284
+ globalThis.fetch = fetch;
214
285
  ```
215
286
 
216
- To do the inverse, add `import "spitch/shims/node"` (which does import polyfills).
217
- This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/spi-tch/spitch-node/tree/main/src/_shims#readme)).
287
+ Or pass it to the client:
218
288
 
219
- ### Logging and middleware
289
+ ```ts
290
+ import Spitch from 'spitch';
291
+ import fetch from 'my-fetch';
292
+
293
+ const client = new Spitch({ fetch });
294
+ ```
220
295
 
221
- You may also provide a custom `fetch` function when instantiating the client,
222
- which can be used to inspect or alter the `Request` or `Response` before/after each request:
296
+ ### Fetch options
297
+
298
+ 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
299
 
224
300
  ```ts
225
- import { fetch } from 'undici'; // as one example
226
301
  import Spitch from 'spitch';
227
302
 
228
303
  const client = new Spitch({
229
- fetch: async (url: RequestInfo, init?: RequestInit): Promise<Response> => {
230
- console.log('About to make a request', url, init);
231
- const response = await fetch(url, init);
232
- console.log('Got response', response);
233
- return response;
304
+ fetchOptions: {
305
+ // `RequestInit` options
234
306
  },
235
307
  });
236
308
  ```
237
309
 
238
- Note that if given a `DEBUG=true` environment variable, this library will log all requests and responses automatically.
239
- This is intended for debugging purposes only and may change in the future without notice.
310
+ #### Configuring proxies
240
311
 
241
- ### Configuring an HTTP(S) Agent (e.g., for proxies)
312
+ To modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy
313
+ options to requests:
242
314
 
243
- By default, this library uses a stable agent for all http/https requests to reuse TCP connections, eliminating many TCP & TLS handshakes and shaving around 100ms off most requests.
315
+ <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
316
 
245
- If you would like to disable or customize this behavior, for example to use the API behind a proxy, you can pass an `httpAgent` which is used for all requests (be they http or https), for example:
317
+ ```ts
318
+ import Spitch from 'spitch';
319
+ import * as undici from 'undici';
320
+
321
+ const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
322
+ const client = new Spitch({
323
+ fetchOptions: {
324
+ dispatcher: proxyAgent,
325
+ },
326
+ });
327
+ ```
328
+
329
+ <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
330
 
247
- <!-- prettier-ignore -->
248
331
  ```ts
249
- import http from 'http';
250
- import { HttpsProxyAgent } from 'https-proxy-agent';
332
+ import Spitch from 'spitch';
251
333
 
252
- // Configure the default for all requests:
253
334
  const client = new Spitch({
254
- httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
335
+ fetchOptions: {
336
+ proxy: 'http://localhost:8888',
337
+ },
255
338
  });
339
+ ```
256
340
 
257
- // Override per-request:
258
- await client.speech.transcibe(
259
- { language: 'yo' },
260
- {
261
- httpAgent: new http.Agent({ keepAlive: false }),
341
+ <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>
342
+
343
+ ```ts
344
+ import Spitch from 'npm:spitch';
345
+
346
+ const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
347
+ const client = new Spitch({
348
+ fetchOptions: {
349
+ client: httpClient,
262
350
  },
263
- );
351
+ });
264
352
  ```
265
353
 
354
+ ## Frequently Asked Questions
355
+
266
356
  ## Semantic versioning
267
357
 
268
358
  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
359
 
270
360
  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)_.
361
+ 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
362
  3. Changes that we do not expect to impact the vast majority of users in practice.
273
363
 
274
364
  We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
275
365
 
276
- We are keen for your feedback; please open an [issue](https://www.github.com/spi-tch/spitch-node/issues) with questions, bugs, or suggestions.
366
+ 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
367
 
278
368
  ## Requirements
279
369
 
280
- TypeScript >= 4.5 is supported.
370
+ TypeScript >= 4.9 is supported.
281
371
 
282
372
  The following runtimes are supported:
283
373
 
374
+ - Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)
375
+ - Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
376
+ - Deno v1.28.0 or higher.
377
+ - Bun 1.0 or later.
378
+ - Cloudflare Workers.
379
+ - Vercel Edge Runtime.
380
+ - Jest 28 or greater with the `"node"` environment (`"jsdom"` is not supported at this time).
381
+ - Nitro v2.6 or greater.
382
+
284
383
  Note that React Native is not supported at this time.
285
384
 
286
385
  If you are interested in other runtime environments, please open or upvote an issue on GitHub.
@@ -0,0 +1,2 @@
1
+ export * from "./core/api-promise.mjs";
2
+ //# sourceMappingURL=api-promise.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"api-promise.d.mts","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export * from "./core/api-promise.js";
2
+ //# sourceMappingURL=api-promise.d.ts.map
@@ -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"}
@@ -0,0 +1,2 @@
1
+ export * from "./core/api-promise.mjs";
2
+ //# sourceMappingURL=api-promise.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"api-promise.mjs","sourceRoot":"","sources":["src/api-promise.ts"],"names":[],"mappings":""}
package/client.d.mts ADDED
@@ -0,0 +1,183 @@
1
+ import type { RequestInit, RequestInfo } from "./internal/builtin-types.mjs";
2
+ import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./internal/types.mjs";
3
+ export type { Logger, LogLevel } from "./internal/utils/log.mjs";
4
+ import * as Opts from "./internal/request-options.mjs";
5
+ import * as Errors from "./core/error.mjs";
6
+ import * as Uploads from "./core/uploads.mjs";
7
+ import * as API from "./resources/index.mjs";
8
+ import { APIPromise } from "./core/api-promise.mjs";
9
+ import { Speech, SpeechGenerateParams, SpeechTranscribeParams, SpeechTranscribeResponse } from "./resources/speech.mjs";
10
+ import { Text, TextToneMarkParams, TextToneMarkResponse, TextTranslateParams, TextTranslateResponse } from "./resources/text.mjs";
11
+ import { type Fetch } from "./internal/builtin-types.mjs";
12
+ import { HeadersLike, NullableHeaders } from "./internal/headers.mjs";
13
+ import { FinalRequestOptions, RequestOptions } from "./internal/request-options.mjs";
14
+ import { type LogLevel, type Logger } from "./internal/utils/log.mjs";
15
+ export interface ClientOptions {
16
+ /**
17
+ * Defaults to process.env['SPITCH_API_KEY'].
18
+ */
19
+ apiKey?: string | undefined;
20
+ /**
21
+ * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
22
+ *
23
+ * Defaults to process.env['SPITCH_BASE_URL'].
24
+ */
25
+ baseURL?: string | null | undefined;
26
+ /**
27
+ * The maximum amount of time (in milliseconds) that the client should wait for a response
28
+ * from the server before timing out a single request.
29
+ *
30
+ * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
31
+ * much longer than this timeout before the promise succeeds or fails.
32
+ *
33
+ * @unit milliseconds
34
+ */
35
+ timeout?: number | undefined;
36
+ /**
37
+ * Additional `RequestInit` options to be passed to `fetch` calls.
38
+ * Properties will be overridden by per-request `fetchOptions`.
39
+ */
40
+ fetchOptions?: MergedRequestInit | undefined;
41
+ /**
42
+ * Specify a custom `fetch` function implementation.
43
+ *
44
+ * If not provided, we expect that `fetch` is defined globally.
45
+ */
46
+ fetch?: Fetch | undefined;
47
+ /**
48
+ * The maximum number of times that the client will retry a request in case of a
49
+ * temporary failure, like a network error or a 5XX error from the server.
50
+ *
51
+ * @default 2
52
+ */
53
+ maxRetries?: number | undefined;
54
+ /**
55
+ * Default headers to include with every request to the API.
56
+ *
57
+ * These can be removed in individual requests by explicitly setting the
58
+ * header to `null` in request options.
59
+ */
60
+ defaultHeaders?: HeadersLike | undefined;
61
+ /**
62
+ * Default query parameters to include with every request to the API.
63
+ *
64
+ * These can be removed in individual requests by explicitly setting the
65
+ * param to `undefined` in request options.
66
+ */
67
+ defaultQuery?: Record<string, string | undefined> | undefined;
68
+ /**
69
+ * Set the log level.
70
+ *
71
+ * Defaults to process.env['SPITCH_LOG'] or 'warn' if it isn't set.
72
+ */
73
+ logLevel?: LogLevel | undefined;
74
+ /**
75
+ * Set the logger.
76
+ *
77
+ * Defaults to globalThis.console.
78
+ */
79
+ logger?: Logger | undefined;
80
+ }
81
+ /**
82
+ * API Client for interfacing with the Spitch API.
83
+ */
84
+ export declare class Spitch {
85
+ #private;
86
+ apiKey: string;
87
+ baseURL: string;
88
+ maxRetries: number;
89
+ timeout: number;
90
+ logger: Logger | undefined;
91
+ logLevel: LogLevel | undefined;
92
+ fetchOptions: MergedRequestInit | undefined;
93
+ private fetch;
94
+ protected idempotencyHeader?: string;
95
+ private _options;
96
+ /**
97
+ * API Client for interfacing with the Spitch API.
98
+ *
99
+ * @param {string | undefined} [opts.apiKey=process.env['SPITCH_API_KEY'] ?? undefined]
100
+ * @param {string} [opts.baseURL=process.env['SPITCH_BASE_URL'] ?? https://api.spi-tch.com] - Override the default base URL for the API.
101
+ * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
102
+ * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
103
+ * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
104
+ * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
105
+ * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.
106
+ * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
107
+ */
108
+ constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
109
+ /**
110
+ * Create a new client instance re-using the same options given to the current client with optional overriding.
111
+ */
112
+ withOptions(options: Partial<ClientOptions>): this;
113
+ protected defaultQuery(): Record<string, string | undefined> | undefined;
114
+ protected validateHeaders({ values, nulls }: NullableHeaders): void;
115
+ protected authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined>;
116
+ /**
117
+ * Basic re-implementation of `qs.stringify` for primitive types.
118
+ */
119
+ protected stringifyQuery(query: Record<string, unknown>): string;
120
+ private getUserAgent;
121
+ protected defaultIdempotencyKey(): string;
122
+ protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError;
123
+ buildURL(path: string, query: Record<string, unknown> | null | undefined, defaultBaseURL?: string | undefined): string;
124
+ /**
125
+ * Used as a callback for mutating the given `FinalRequestOptions` object.
126
+ */
127
+ protected prepareOptions(options: FinalRequestOptions): Promise<void>;
128
+ /**
129
+ * Used as a callback for mutating the given `RequestInit` object.
130
+ *
131
+ * This is useful for cases where you want to add certain headers based off of
132
+ * the request properties, e.g. `method` or `url`.
133
+ */
134
+ protected prepareRequest(request: RequestInit, { url, options }: {
135
+ url: string;
136
+ options: FinalRequestOptions;
137
+ }): Promise<void>;
138
+ get<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
139
+ post<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
140
+ patch<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
141
+ put<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
142
+ delete<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
143
+ private methodRequest;
144
+ request<Rsp>(options: PromiseOrValue<FinalRequestOptions>, remainingRetries?: number | null): APIPromise<Rsp>;
145
+ private makeRequest;
146
+ fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise<Response>;
147
+ private shouldRetry;
148
+ private retryRequest;
149
+ private calculateDefaultRetryTimeoutMillis;
150
+ buildRequest(inputOptions: FinalRequestOptions, { retryCount }?: {
151
+ retryCount?: number;
152
+ }): Promise<{
153
+ req: FinalizedRequestInit;
154
+ url: string;
155
+ timeout: number;
156
+ }>;
157
+ private buildHeaders;
158
+ private buildBody;
159
+ static Spitch: typeof Spitch;
160
+ static DEFAULT_TIMEOUT: number;
161
+ static SpitchError: typeof Errors.SpitchError;
162
+ static APIError: typeof Errors.APIError;
163
+ static APIConnectionError: typeof Errors.APIConnectionError;
164
+ static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
165
+ static APIUserAbortError: typeof Errors.APIUserAbortError;
166
+ static NotFoundError: typeof Errors.NotFoundError;
167
+ static ConflictError: typeof Errors.ConflictError;
168
+ static RateLimitError: typeof Errors.RateLimitError;
169
+ static BadRequestError: typeof Errors.BadRequestError;
170
+ static AuthenticationError: typeof Errors.AuthenticationError;
171
+ static InternalServerError: typeof Errors.InternalServerError;
172
+ static PermissionDeniedError: typeof Errors.PermissionDeniedError;
173
+ static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
174
+ static toFile: typeof Uploads.toFile;
175
+ speech: API.Speech;
176
+ text: API.Text;
177
+ }
178
+ export declare namespace Spitch {
179
+ export type RequestOptions = Opts.RequestOptions;
180
+ export { Speech as Speech, type SpeechTranscribeResponse as SpeechTranscribeResponse, type SpeechGenerateParams as SpeechGenerateParams, type SpeechTranscribeParams as SpeechTranscribeParams, };
181
+ export { Text as Text, type TextToneMarkResponse as TextToneMarkResponse, type TextTranslateResponse as TextTranslateResponse, type TextToneMarkParams as TextToneMarkParams, type TextTranslateParams as TextTranslateParams, };
182
+ }
183
+ //# sourceMappingURL=client.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.d.mts","sourceRoot":"","sources":["src/client.ts"],"names":[],"mappings":"OAEO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAY;OAC3C,KAAK,EAAc,cAAc,EAAE,iBAAiB,EAAE,oBAAoB,EAAE;YAIvE,EAAE,MAAM,EAAE,QAAQ,EAAE;OAKzB,KAAK,IAAI;OAET,KAAK,MAAM;OACX,KAAK,OAAO;OACZ,KAAK,GAAG;OACR,EAAE,UAAU,EAAE;OACd,EACL,MAAM,EACN,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACzB;OACM,EACL,IAAI,EACJ,kBAAkB,EAClB,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACtB;OACM,EAAE,KAAK,KAAK,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAgB;OAC9C,EAAE,mBAAmB,EAAE,cAAc,EAAE;OAEvC,EACL,KAAK,QAAQ,EACb,KAAK,MAAM,EAIZ;AAGD,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE7C;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAE1B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAEzC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;IAE9D;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAEhC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,MAAM;;IACjB,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC/B,YAAY,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE5C,OAAO,CAAC,KAAK,CAAQ;IAErB,SAAS,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACrC,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;OAWG;gBACS,EACV,OAAoC,EACpC,MAAkC,EAClC,GAAG,IAAI,EACR,GAAE,aAAkB;IAiCrB;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI;IAuBlD,SAAS,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS;IAIxE,SAAS,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,eAAe;cAI5C,WAAW,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAI5F;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAiBhE,OAAO,CAAC,YAAY;IAIpB,SAAS,CAAC,qBAAqB,IAAI,MAAM;IAIzC,SAAS,CAAC,eAAe,CACvB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,OAAO,EAAE,OAAO,GACf,MAAM,CAAC,QAAQ;IAIlB,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,EACjD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,GAClC,MAAM;IAmBT;;OAEG;cACa,cAAc,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE3E;;;;;OAKG;cACa,cAAc,CAC5B,OAAO,EAAE,WAAW,EACpB,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,mBAAmB,CAAA;KAAE,GAC9D,OAAO,CAAC,IAAI,CAAC;IAEhB,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI9E,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI/E,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAIhF,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI9E,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAIjF,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,GAAG,EACT,OAAO,EAAE,cAAc,CAAC,mBAAmB,CAAC,EAC5C,gBAAgB,GAAE,MAAM,GAAG,IAAW,GACrC,UAAU,CAAC,GAAG,CAAC;YAIJ,WAAW;IA6JnB,gBAAgB,CACpB,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE,WAAW,GAAG,SAAS,EAC7B,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,eAAe,GAC1B,OAAO,CAAC,QAAQ,CAAC;YA8BN,WAAW;YAuBX,YAAY;IAuC1B,OAAO,CAAC,kCAAkC;IAepC,YAAY,CAChB,YAAY,EAAE,mBAAmB,EACjC,EAAE,UAAc,EAAE,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO,GAC/C,OAAO,CAAC;QAAE,GAAG,EAAE,oBAAoB,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;YAwBzD,YAAY;IAqC1B,OAAO,CAAC,SAAS;IAqCjB,MAAM,CAAC,MAAM,gBAAQ;IACrB,MAAM,CAAC,eAAe,SAAS;IAE/B,MAAM,CAAC,WAAW,4BAAsB;IACxC,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;IAElE,MAAM,CAAC,MAAM,wBAAkB;IAE/B,MAAM,EAAE,GAAG,CAAC,MAAM,CAAwB;IAC1C,IAAI,EAAE,GAAG,CAAC,IAAI,CAAsB;CACrC;AAGD,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;IAEF,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}