spitch 0.1.0-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.
Files changed (467) hide show
  1. package/CHANGELOG.md +14 -9
  2. package/LICENSE +1 -1
  3. package/README.md +201 -65
  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 +192 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +192 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +473 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +469 -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/pagination.d.mts +54 -0
  37. package/core/pagination.d.mts.map +1 -0
  38. package/core/pagination.d.ts +54 -0
  39. package/core/pagination.d.ts.map +1 -0
  40. package/core/pagination.js +101 -0
  41. package/core/pagination.js.map +1 -0
  42. package/core/pagination.mjs +95 -0
  43. package/core/pagination.mjs.map +1 -0
  44. package/core/resource.d.mts +6 -0
  45. package/core/resource.d.mts.map +1 -0
  46. package/core/resource.d.ts +6 -0
  47. package/core/resource.d.ts.map +1 -0
  48. package/core/resource.js +11 -0
  49. package/core/resource.js.map +1 -0
  50. package/core/resource.mjs +7 -0
  51. package/core/resource.mjs.map +1 -0
  52. package/core/uploads.d.mts +3 -0
  53. package/core/uploads.d.mts.map +1 -0
  54. package/core/uploads.d.ts +3 -0
  55. package/core/uploads.d.ts.map +1 -0
  56. package/core/uploads.js +6 -0
  57. package/core/uploads.js.map +1 -0
  58. package/core/uploads.mjs +2 -0
  59. package/core/uploads.mjs.map +1 -0
  60. package/error.d.mts +2 -0
  61. package/error.d.mts.map +1 -0
  62. package/error.d.ts +1 -52
  63. package/error.d.ts.map +1 -1
  64. package/error.js +3 -140
  65. package/error.js.map +1 -1
  66. package/error.mjs +1 -126
  67. package/error.mjs.map +1 -1
  68. package/index.d.mts +7 -118
  69. package/index.d.mts.map +1 -0
  70. package/index.d.ts +6 -117
  71. package/index.d.ts.map +1 -1
  72. package/index.js +28 -107
  73. package/index.js.map +1 -1
  74. package/index.mjs +6 -81
  75. package/index.mjs.map +1 -1
  76. package/internal/builtin-types.d.mts +73 -0
  77. package/internal/builtin-types.d.mts.map +1 -0
  78. package/internal/builtin-types.d.ts +73 -0
  79. package/internal/builtin-types.d.ts.map +1 -0
  80. package/internal/builtin-types.js +4 -0
  81. package/internal/builtin-types.js.map +1 -0
  82. package/internal/builtin-types.mjs +3 -0
  83. package/internal/builtin-types.mjs.map +1 -0
  84. package/internal/detect-platform.d.mts +15 -0
  85. package/internal/detect-platform.d.mts.map +1 -0
  86. package/internal/detect-platform.d.ts +15 -0
  87. package/internal/detect-platform.d.ts.map +1 -0
  88. package/internal/detect-platform.js +162 -0
  89. package/internal/detect-platform.js.map +1 -0
  90. package/internal/detect-platform.mjs +157 -0
  91. package/internal/detect-platform.mjs.map +1 -0
  92. package/internal/errors.d.mts +3 -0
  93. package/internal/errors.d.mts.map +1 -0
  94. package/internal/errors.d.ts +3 -0
  95. package/internal/errors.d.ts.map +1 -0
  96. package/internal/errors.js +41 -0
  97. package/internal/errors.js.map +1 -0
  98. package/internal/errors.mjs +36 -0
  99. package/internal/errors.mjs.map +1 -0
  100. package/internal/headers.d.mts +20 -0
  101. package/internal/headers.d.mts.map +1 -0
  102. package/internal/headers.d.ts +20 -0
  103. package/internal/headers.d.ts.map +1 -0
  104. package/internal/headers.js +79 -0
  105. package/internal/headers.js.map +1 -0
  106. package/internal/headers.mjs +74 -0
  107. package/internal/headers.mjs.map +1 -0
  108. package/internal/parse.d.mts +12 -0
  109. package/internal/parse.d.mts.map +1 -0
  110. package/internal/parse.d.ts +12 -0
  111. package/internal/parse.d.ts.map +1 -0
  112. package/internal/parse.js +35 -0
  113. package/internal/parse.js.map +1 -0
  114. package/internal/parse.mjs +32 -0
  115. package/internal/parse.mjs.map +1 -0
  116. package/internal/request-options.d.mts +75 -0
  117. package/internal/request-options.d.mts.map +1 -0
  118. package/internal/request-options.d.ts +75 -0
  119. package/internal/request-options.d.ts.map +1 -0
  120. package/internal/request-options.js +14 -0
  121. package/internal/request-options.js.map +1 -0
  122. package/internal/request-options.mjs +10 -0
  123. package/internal/request-options.mjs.map +1 -0
  124. package/internal/shim-types.d.mts +17 -0
  125. package/internal/shim-types.d.mts.map +1 -0
  126. package/internal/shim-types.d.ts +17 -0
  127. package/internal/shim-types.d.ts.map +1 -0
  128. package/internal/shim-types.js +4 -0
  129. package/internal/shim-types.js.map +1 -0
  130. package/internal/shim-types.mjs +3 -0
  131. package/internal/shim-types.mjs.map +1 -0
  132. package/internal/shims.d.mts +20 -0
  133. package/internal/shims.d.mts.map +1 -0
  134. package/internal/shims.d.ts +20 -0
  135. package/internal/shims.d.ts.map +1 -0
  136. package/internal/shims.js +92 -0
  137. package/internal/shims.js.map +1 -0
  138. package/internal/shims.mjs +85 -0
  139. package/internal/shims.mjs.map +1 -0
  140. package/internal/to-file.d.mts +45 -0
  141. package/internal/to-file.d.mts.map +1 -0
  142. package/internal/to-file.d.ts +45 -0
  143. package/internal/to-file.d.ts.map +1 -0
  144. package/internal/to-file.js +91 -0
  145. package/internal/to-file.js.map +1 -0
  146. package/internal/to-file.mjs +88 -0
  147. package/internal/to-file.mjs.map +1 -0
  148. package/internal/tslib.js +81 -0
  149. package/internal/tslib.mjs +17 -0
  150. package/internal/types.d.mts +69 -0
  151. package/internal/types.d.mts.map +1 -0
  152. package/internal/types.d.ts +69 -0
  153. package/internal/types.d.ts.map +1 -0
  154. package/internal/types.js +4 -0
  155. package/internal/types.js.map +1 -0
  156. package/internal/types.mjs +3 -0
  157. package/internal/types.mjs.map +1 -0
  158. package/internal/uploads.d.mts +42 -0
  159. package/internal/uploads.d.mts.map +1 -0
  160. package/internal/uploads.d.ts +42 -0
  161. package/internal/uploads.d.ts.map +1 -0
  162. package/internal/uploads.js +141 -0
  163. package/internal/uploads.js.map +1 -0
  164. package/internal/uploads.mjs +131 -0
  165. package/internal/uploads.mjs.map +1 -0
  166. package/internal/utils/base64.d.mts +3 -0
  167. package/internal/utils/base64.d.mts.map +1 -0
  168. package/internal/utils/base64.d.ts +3 -0
  169. package/internal/utils/base64.d.ts.map +1 -0
  170. package/internal/utils/base64.js +38 -0
  171. package/internal/utils/base64.js.map +1 -0
  172. package/internal/utils/base64.mjs +33 -0
  173. package/internal/utils/base64.mjs.map +1 -0
  174. package/internal/utils/bytes.d.mts +4 -0
  175. package/internal/utils/bytes.d.mts.map +1 -0
  176. package/internal/utils/bytes.d.ts +4 -0
  177. package/internal/utils/bytes.d.ts.map +1 -0
  178. package/internal/utils/bytes.js +31 -0
  179. package/internal/utils/bytes.js.map +1 -0
  180. package/internal/utils/bytes.mjs +26 -0
  181. package/internal/utils/bytes.mjs.map +1 -0
  182. package/internal/utils/env.d.mts +9 -0
  183. package/internal/utils/env.d.mts.map +1 -0
  184. package/internal/utils/env.d.ts +9 -0
  185. package/internal/utils/env.d.ts.map +1 -0
  186. package/internal/utils/env.js +22 -0
  187. package/internal/utils/env.js.map +1 -0
  188. package/internal/utils/env.mjs +18 -0
  189. package/internal/utils/env.mjs.map +1 -0
  190. package/internal/utils/log.d.mts +37 -0
  191. package/internal/utils/log.d.mts.map +1 -0
  192. package/internal/utils/log.d.ts +37 -0
  193. package/internal/utils/log.d.ts.map +1 -0
  194. package/internal/utils/log.js +85 -0
  195. package/internal/utils/log.js.map +1 -0
  196. package/internal/utils/log.mjs +79 -0
  197. package/internal/utils/log.mjs.map +1 -0
  198. package/internal/utils/path.d.mts +15 -0
  199. package/internal/utils/path.d.mts.map +1 -0
  200. package/internal/utils/path.d.ts +15 -0
  201. package/internal/utils/path.d.ts.map +1 -0
  202. package/internal/utils/path.js +79 -0
  203. package/internal/utils/path.js.map +1 -0
  204. package/internal/utils/path.mjs +74 -0
  205. package/internal/utils/path.mjs.map +1 -0
  206. package/internal/utils/sleep.d.mts +2 -0
  207. package/internal/utils/sleep.d.mts.map +1 -0
  208. package/internal/utils/sleep.d.ts +2 -0
  209. package/internal/utils/sleep.d.ts.map +1 -0
  210. package/internal/utils/sleep.js +7 -0
  211. package/internal/utils/sleep.js.map +1 -0
  212. package/internal/utils/sleep.mjs +3 -0
  213. package/internal/utils/sleep.mjs.map +1 -0
  214. package/internal/utils/uuid.d.mts +5 -0
  215. package/internal/utils/uuid.d.mts.map +1 -0
  216. package/internal/utils/uuid.d.ts +5 -0
  217. package/internal/utils/uuid.d.ts.map +1 -0
  218. package/internal/utils/uuid.js +19 -0
  219. package/internal/utils/uuid.js.map +1 -0
  220. package/internal/utils/uuid.mjs +15 -0
  221. package/internal/utils/uuid.mjs.map +1 -0
  222. package/internal/utils/values.d.mts +18 -0
  223. package/internal/utils/values.d.mts.map +1 -0
  224. package/internal/utils/values.d.ts +18 -0
  225. package/internal/utils/values.d.ts.map +1 -0
  226. package/internal/utils/values.js +112 -0
  227. package/internal/utils/values.js.map +1 -0
  228. package/internal/utils/values.mjs +94 -0
  229. package/internal/utils/values.mjs.map +1 -0
  230. package/internal/utils.d.mts +7 -0
  231. package/internal/utils.d.mts.map +1 -0
  232. package/internal/utils.d.ts +7 -0
  233. package/internal/utils.d.ts.map +1 -0
  234. package/internal/utils.js +11 -0
  235. package/internal/utils.js.map +1 -0
  236. package/internal/utils.mjs +8 -0
  237. package/internal/utils.mjs.map +1 -0
  238. package/package.json +117 -72
  239. package/pagination.d.mts +2 -0
  240. package/pagination.d.mts.map +1 -0
  241. package/pagination.d.ts +2 -0
  242. package/pagination.d.ts.map +1 -0
  243. package/pagination.js +6 -0
  244. package/pagination.js.map +1 -0
  245. package/pagination.mjs +2 -0
  246. package/pagination.mjs.map +1 -0
  247. package/resource.d.mts +2 -0
  248. package/resource.d.mts.map +1 -0
  249. package/resource.d.ts +1 -5
  250. package/resource.d.ts.map +1 -1
  251. package/resource.js +3 -8
  252. package/resource.js.map +1 -1
  253. package/resource.mjs +1 -6
  254. package/resource.mjs.map +1 -1
  255. package/resources/files.d.mts +74 -0
  256. package/resources/files.d.mts.map +1 -0
  257. package/resources/files.d.ts +74 -0
  258. package/resources/files.d.ts.map +1 -0
  259. package/resources/files.js +48 -0
  260. package/resources/files.js.map +1 -0
  261. package/resources/files.mjs +44 -0
  262. package/resources/files.mjs.map +1 -0
  263. package/resources/index.d.mts +4 -0
  264. package/resources/index.d.mts.map +1 -0
  265. package/resources/index.d.ts +3 -2
  266. package/resources/index.d.ts.map +1 -1
  267. package/resources/index.js +3 -1
  268. package/resources/index.js.map +1 -1
  269. package/resources/index.mjs +3 -2
  270. package/resources/index.mjs.map +1 -1
  271. package/resources/speech.d.mts +45 -0
  272. package/resources/speech.d.mts.map +1 -0
  273. package/resources/speech.d.ts +29 -29
  274. package/resources/speech.d.ts.map +1 -1
  275. package/resources/speech.js +12 -32
  276. package/resources/speech.js.map +1 -1
  277. package/resources/speech.mjs +12 -9
  278. package/resources/speech.mjs.map +1 -1
  279. package/resources/text.d.mts +34 -0
  280. package/resources/text.d.mts.map +1 -0
  281. package/resources/text.d.ts +23 -8
  282. package/resources/text.d.ts.map +1 -1
  283. package/resources/text.js +7 -3
  284. package/resources/text.js.map +1 -1
  285. package/resources/text.mjs +7 -3
  286. package/resources/text.mjs.map +1 -1
  287. package/resources.d.mts +2 -0
  288. package/resources.d.mts.map +1 -0
  289. package/resources.d.ts +2 -0
  290. package/resources.d.ts.map +1 -0
  291. package/resources.js +5 -0
  292. package/resources.js.map +1 -0
  293. package/resources.mjs +2 -0
  294. package/resources.mjs.map +1 -0
  295. package/src/api-promise.ts +2 -0
  296. package/src/client.ts +790 -0
  297. package/src/core/README.md +3 -0
  298. package/src/core/api-promise.ts +92 -0
  299. package/src/core/error.ts +130 -0
  300. package/src/core/pagination.ts +157 -0
  301. package/src/core/resource.ts +11 -0
  302. package/src/core/uploads.ts +2 -0
  303. package/src/error.ts +2 -146
  304. package/src/index.ts +7 -178
  305. package/src/internal/README.md +3 -0
  306. package/src/internal/builtin-types.ts +93 -0
  307. package/src/internal/detect-platform.ts +196 -0
  308. package/src/internal/errors.ts +33 -0
  309. package/src/internal/headers.ts +97 -0
  310. package/src/internal/parse.ts +50 -0
  311. package/src/internal/request-options.ts +91 -0
  312. package/src/internal/shim-types.ts +26 -0
  313. package/src/internal/shims.ts +107 -0
  314. package/src/internal/to-file.ts +154 -0
  315. package/src/internal/types.ts +95 -0
  316. package/src/internal/uploads.ts +187 -0
  317. package/src/internal/utils/base64.ts +40 -0
  318. package/src/internal/utils/bytes.ts +32 -0
  319. package/src/internal/utils/env.ts +18 -0
  320. package/src/internal/utils/log.ts +126 -0
  321. package/src/internal/utils/path.ts +88 -0
  322. package/src/internal/utils/sleep.ts +3 -0
  323. package/src/internal/utils/uuid.ts +17 -0
  324. package/src/internal/utils/values.ts +105 -0
  325. package/src/internal/utils.ts +8 -0
  326. package/src/pagination.ts +2 -0
  327. package/src/resource.ts +2 -11
  328. package/src/resources/files.ts +136 -0
  329. package/src/resources/index.ts +18 -7
  330. package/src/resources/speech.ts +76 -33
  331. package/src/resources/text.ts +38 -9
  332. package/src/resources.ts +1 -0
  333. package/src/tsconfig.json +2 -2
  334. package/src/uploads.ts +2 -255
  335. package/src/version.ts +1 -1
  336. package/uploads.d.mts +2 -0
  337. package/uploads.d.mts.map +1 -0
  338. package/uploads.d.ts +1 -74
  339. package/uploads.d.ts.map +1 -1
  340. package/uploads.js +3 -168
  341. package/uploads.js.map +1 -1
  342. package/uploads.mjs +1 -157
  343. package/uploads.mjs.map +1 -1
  344. package/version.d.mts +2 -0
  345. package/version.d.mts.map +1 -0
  346. package/version.d.ts +1 -1
  347. package/version.d.ts.map +1 -1
  348. package/version.js +1 -1
  349. package/version.js.map +1 -1
  350. package/version.mjs +1 -1
  351. package/version.mjs.map +1 -1
  352. package/_shims/MultipartBody.d.ts +0 -9
  353. package/_shims/MultipartBody.d.ts.map +0 -1
  354. package/_shims/MultipartBody.js +0 -16
  355. package/_shims/MultipartBody.js.map +0 -1
  356. package/_shims/MultipartBody.mjs +0 -12
  357. package/_shims/MultipartBody.mjs.map +0 -1
  358. package/_shims/README.md +0 -46
  359. package/_shims/auto/runtime-bun.d.ts +0 -5
  360. package/_shims/auto/runtime-bun.d.ts.map +0 -1
  361. package/_shims/auto/runtime-bun.js +0 -21
  362. package/_shims/auto/runtime-bun.js.map +0 -1
  363. package/_shims/auto/runtime-bun.mjs +0 -2
  364. package/_shims/auto/runtime-bun.mjs.map +0 -1
  365. package/_shims/auto/runtime-node.d.ts +0 -5
  366. package/_shims/auto/runtime-node.d.ts.map +0 -1
  367. package/_shims/auto/runtime-node.js +0 -21
  368. package/_shims/auto/runtime-node.js.map +0 -1
  369. package/_shims/auto/runtime-node.mjs +0 -2
  370. package/_shims/auto/runtime-node.mjs.map +0 -1
  371. package/_shims/auto/runtime.d.ts +0 -5
  372. package/_shims/auto/runtime.d.ts.map +0 -1
  373. package/_shims/auto/runtime.js +0 -21
  374. package/_shims/auto/runtime.js.map +0 -1
  375. package/_shims/auto/runtime.mjs +0 -2
  376. package/_shims/auto/runtime.mjs.map +0 -1
  377. package/_shims/auto/types-node.d.ts +0 -5
  378. package/_shims/auto/types-node.d.ts.map +0 -1
  379. package/_shims/auto/types-node.js +0 -21
  380. package/_shims/auto/types-node.js.map +0 -1
  381. package/_shims/auto/types-node.mjs +0 -2
  382. package/_shims/auto/types-node.mjs.map +0 -1
  383. package/_shims/auto/types.d.ts +0 -101
  384. package/_shims/auto/types.js +0 -3
  385. package/_shims/auto/types.mjs +0 -3
  386. package/_shims/bun-runtime.d.ts +0 -6
  387. package/_shims/bun-runtime.d.ts.map +0 -1
  388. package/_shims/bun-runtime.js +0 -14
  389. package/_shims/bun-runtime.js.map +0 -1
  390. package/_shims/bun-runtime.mjs +0 -10
  391. package/_shims/bun-runtime.mjs.map +0 -1
  392. package/_shims/index.d.ts +0 -81
  393. package/_shims/index.js +0 -13
  394. package/_shims/index.mjs +0 -7
  395. package/_shims/manual-types.d.ts +0 -12
  396. package/_shims/manual-types.js +0 -3
  397. package/_shims/manual-types.mjs +0 -3
  398. package/_shims/node-runtime.d.ts +0 -3
  399. package/_shims/node-runtime.d.ts.map +0 -1
  400. package/_shims/node-runtime.js +0 -89
  401. package/_shims/node-runtime.js.map +0 -1
  402. package/_shims/node-runtime.mjs +0 -56
  403. package/_shims/node-runtime.mjs.map +0 -1
  404. package/_shims/node-types.d.ts +0 -42
  405. package/_shims/node-types.js +0 -3
  406. package/_shims/node-types.mjs +0 -3
  407. package/_shims/registry.d.ts +0 -37
  408. package/_shims/registry.d.ts.map +0 -1
  409. package/_shims/registry.js +0 -41
  410. package/_shims/registry.js.map +0 -1
  411. package/_shims/registry.mjs +0 -37
  412. package/_shims/registry.mjs.map +0 -1
  413. package/_shims/web-runtime.d.ts +0 -5
  414. package/_shims/web-runtime.d.ts.map +0 -1
  415. package/_shims/web-runtime.js +0 -78
  416. package/_shims/web-runtime.js.map +0 -1
  417. package/_shims/web-runtime.mjs +0 -71
  418. package/_shims/web-runtime.mjs.map +0 -1
  419. package/_shims/web-types.d.ts +0 -83
  420. package/_shims/web-types.js +0 -3
  421. package/_shims/web-types.mjs +0 -3
  422. package/core.d.ts +0 -242
  423. package/core.d.ts.map +0 -1
  424. package/core.js +0 -901
  425. package/core.js.map +0 -1
  426. package/core.mjs +0 -869
  427. package/core.mjs.map +0 -1
  428. package/shims/node.d.ts +0 -30
  429. package/shims/node.d.ts.map +0 -1
  430. package/shims/node.js +0 -31
  431. package/shims/node.js.map +0 -1
  432. package/shims/node.mjs +0 -5
  433. package/shims/node.mjs.map +0 -1
  434. package/shims/web.d.ts +0 -26
  435. package/shims/web.d.ts.map +0 -1
  436. package/shims/web.js +0 -31
  437. package/shims/web.js.map +0 -1
  438. package/shims/web.mjs +0 -5
  439. package/shims/web.mjs.map +0 -1
  440. package/src/_shims/MultipartBody.ts +0 -9
  441. package/src/_shims/README.md +0 -46
  442. package/src/_shims/auto/runtime-bun.ts +0 -4
  443. package/src/_shims/auto/runtime-node.ts +0 -4
  444. package/src/_shims/auto/runtime.ts +0 -4
  445. package/src/_shims/auto/types-node.ts +0 -4
  446. package/src/_shims/auto/types.d.ts +0 -101
  447. package/src/_shims/auto/types.js +0 -3
  448. package/src/_shims/auto/types.mjs +0 -3
  449. package/src/_shims/bun-runtime.ts +0 -14
  450. package/src/_shims/index.d.ts +0 -81
  451. package/src/_shims/index.js +0 -13
  452. package/src/_shims/index.mjs +0 -7
  453. package/src/_shims/manual-types.d.ts +0 -12
  454. package/src/_shims/manual-types.js +0 -3
  455. package/src/_shims/manual-types.mjs +0 -3
  456. package/src/_shims/node-runtime.ts +0 -81
  457. package/src/_shims/node-types.d.ts +0 -42
  458. package/src/_shims/node-types.js +0 -3
  459. package/src/_shims/node-types.mjs +0 -3
  460. package/src/_shims/registry.ts +0 -65
  461. package/src/_shims/web-runtime.ts +0 -103
  462. package/src/_shims/web-types.d.ts +0 -83
  463. package/src/_shims/web-types.js +0 -3
  464. package/src/_shims/web-types.mjs +0 -3
  465. package/src/core.ts +0 -1190
  466. package/src/shims/node.ts +0 -50
  467. package/src/shims/web.ts +0 -50
package/CHANGELOG.md CHANGED
@@ -1,19 +1,24 @@
1
1
  # Changelog
2
2
 
3
- ## 0.1.0-alpha.1 (2024-10-07)
3
+ ## 0.1.0 (2025-10-06)
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: [v0.0.1...v0.1.0](https://github.com/spi-tch/spitch-typescript/compare/v0.0.1...v0.1.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 ([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))
10
17
 
11
- ## 0.0.1-alpha.1 (2024-10-07)
12
-
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
18
 
15
19
  ### Chores
16
20
 
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))
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 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
 
@@ -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
- async function main() {
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
- main();
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
- async function main() {
49
- const params: Spitch.SpeechTranscibeParams = { language: 'yo' };
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
- async function main() {
67
- const response = await client.speech.transcibe({ language: 'yo' }).catch(async (err) => {
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 followed:
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.transcibe({ language: 'yo' }, {
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.transcibe({ language: 'yo' }, {
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.transcibe({ language: 'yo' }).asResponse();
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.transcibe({ language: 'yo' }).withResponse();
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.foo.create({
182
- foo: 'my_param',
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 uses `node-fetch` in Node, and expects a global `fetch` function in other environments.
314
+ By default, this library expects a global `fetch` function is defined.
204
315
 
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"`:
316
+ If you want to use a different `fetch` function, you can either polyfill the global:
208
317
 
209
318
  ```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';
319
+ import fetch from 'my-fetch';
320
+
321
+ globalThis.fetch = fetch;
214
322
  ```
215
323
 
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)).
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
- ### Logging and middleware
333
+ ### Fetch options
220
334
 
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:
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
- 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;
341
+ fetchOptions: {
342
+ // `RequestInit` options
234
343
  },
235
344
  });
236
345
  ```
237
346
 
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.
347
+ #### Configuring proxies
240
348
 
241
- ### Configuring an HTTP(S) Agent (e.g., for proxies)
349
+ To modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy
350
+ options to requests:
242
351
 
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.
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
- 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:
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 http from 'http';
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
- httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
372
+ fetchOptions: {
373
+ proxy: 'http://localhost:8888',
374
+ },
255
375
  });
376
+ ```
256
377
 
257
- // Override per-request:
258
- await client.speech.transcibe(
259
- { language: 'yo' },
260
- {
261
- httpAgent: new http.Agent({ keepAlive: false }),
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-node/issues) with questions, bugs, or suggestions.
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.5 is supported.
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,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":""}