@credal/sdk 0.1.8 → 0.1.10

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 (299) hide show
  1. package/dist/cjs/BaseClient.d.ts +2 -2
  2. package/dist/cjs/Client.d.ts +1 -1
  3. package/dist/cjs/Client.js +4 -4
  4. package/dist/cjs/api/resources/common/types/Collaborator.d.ts +1 -1
  5. package/dist/cjs/api/resources/common/types/ExternalResourceId.d.ts +1 -1
  6. package/dist/cjs/api/resources/common/types/ResourceIdentifier.d.ts +1 -1
  7. package/dist/cjs/api/resources/common/types/index.d.ts +5 -5
  8. package/dist/cjs/api/resources/common/types/index.js +5 -5
  9. package/dist/cjs/api/resources/copilots/client/Client.d.ts +1 -1
  10. package/dist/cjs/api/resources/copilots/client/Client.js +12 -12
  11. package/dist/cjs/api/resources/copilots/client/index.d.ts +0 -1
  12. package/dist/cjs/api/resources/copilots/client/requests/CreateCopilotRequest.d.ts +1 -1
  13. package/dist/cjs/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts +1 -1
  14. package/dist/cjs/api/resources/copilots/client/requests/SendMessageRequest.d.ts +1 -1
  15. package/dist/cjs/api/resources/copilots/client/requests/StreamMessageRequest.d.ts +1 -1
  16. package/dist/cjs/api/resources/copilots/client/requests/UpdateConfigurationRequest.d.ts +1 -1
  17. package/dist/cjs/api/resources/copilots/client/requests/index.d.ts +9 -9
  18. package/dist/cjs/api/resources/copilots/index.d.ts +1 -1
  19. package/dist/cjs/api/resources/copilots/index.js +1 -1
  20. package/dist/cjs/api/resources/copilots/types/CollectionFilteredData.d.ts +1 -1
  21. package/dist/cjs/api/resources/copilots/types/Configuration.d.ts +1 -1
  22. package/dist/cjs/api/resources/copilots/types/DataFilter.d.ts +1 -1
  23. package/dist/cjs/api/resources/copilots/types/DatetimeFieldSchema.d.ts +1 -1
  24. package/dist/cjs/api/resources/copilots/types/EndOfMessageChunk.d.ts +1 -2
  25. package/dist/cjs/api/resources/copilots/types/ErrorChunk.d.ts +1 -1
  26. package/dist/cjs/api/resources/copilots/types/Filter.d.ts +1 -1
  27. package/dist/cjs/api/resources/copilots/types/FinalChunk.d.ts +1 -1
  28. package/dist/cjs/api/resources/copilots/types/InitialChunk.d.ts +1 -1
  29. package/dist/cjs/api/resources/copilots/types/MessageBlocked.d.ts +1 -1
  30. package/dist/cjs/api/resources/copilots/types/MessageFeedback.d.ts +1 -1
  31. package/dist/cjs/api/resources/copilots/types/MessageReply.d.ts +1 -1
  32. package/dist/cjs/api/resources/copilots/types/NumberFieldSchema.d.ts +1 -1
  33. package/dist/cjs/api/resources/copilots/types/ReferencedSource.d.ts +1 -1
  34. package/dist/cjs/api/resources/copilots/types/SendAgentMessageResponse.d.ts +1 -1
  35. package/dist/cjs/api/resources/copilots/types/SendMessageResponse.d.ts +1 -1
  36. package/dist/cjs/api/resources/copilots/types/StreamingChunk.d.ts +1 -1
  37. package/dist/cjs/api/resources/copilots/types/StringFieldSchema.d.ts +1 -1
  38. package/dist/cjs/api/resources/copilots/types/index.d.ts +24 -24
  39. package/dist/cjs/api/resources/copilots/types/index.js +24 -24
  40. package/dist/cjs/api/resources/documentCatalog/client/Client.d.ts +9 -1
  41. package/dist/cjs/api/resources/documentCatalog/client/Client.js +90 -6
  42. package/dist/cjs/api/resources/documentCatalog/client/index.d.ts +0 -1
  43. package/dist/cjs/api/resources/documentCatalog/client/requests/UploadDocumentContentsRequest.d.ts +1 -1
  44. package/dist/cjs/api/resources/documentCatalog/client/requests/UploadFileRequest.d.ts +27 -0
  45. package/dist/cjs/api/resources/documentCatalog/client/requests/UploadFileRequest.js +3 -0
  46. package/dist/cjs/api/resources/documentCatalog/client/requests/index.d.ts +2 -1
  47. package/dist/cjs/api/resources/documentCatalog/index.d.ts +1 -1
  48. package/dist/cjs/api/resources/documentCatalog/index.js +1 -1
  49. package/dist/cjs/api/resources/documentCatalog/types/DocumentMetadataPatch.d.ts +1 -1
  50. package/dist/cjs/api/resources/documentCatalog/types/DocumentMetadataPatchRequest.d.ts +1 -1
  51. package/dist/cjs/api/resources/documentCatalog/types/index.d.ts +1 -1
  52. package/dist/cjs/api/resources/documentCatalog/types/index.js +1 -1
  53. package/dist/cjs/api/resources/documentCollections/client/Client.d.ts +1 -1
  54. package/dist/cjs/api/resources/documentCollections/client/Client.js +11 -11
  55. package/dist/cjs/api/resources/documentCollections/client/index.d.ts +0 -1
  56. package/dist/cjs/api/resources/documentCollections/client/requests/AddDocumentsToCollectionRequest.d.ts +1 -1
  57. package/dist/cjs/api/resources/documentCollections/client/requests/CreateCollectionRequest.d.ts +1 -1
  58. package/dist/cjs/api/resources/documentCollections/client/requests/CreateMongoCollectionSyncRequest.d.ts +1 -1
  59. package/dist/cjs/api/resources/documentCollections/client/requests/RemoveDocumentsFromCollectionRequest.d.ts +1 -1
  60. package/dist/cjs/api/resources/documentCollections/client/requests/UpdateMongoCollectionSyncRequest.d.ts +1 -1
  61. package/dist/cjs/api/resources/documentCollections/client/requests/index.d.ts +7 -7
  62. package/dist/cjs/api/resources/documentCollections/index.d.ts +1 -1
  63. package/dist/cjs/api/resources/documentCollections/index.js +1 -1
  64. package/dist/cjs/api/resources/documentCollections/types/ListDocumentsInCollectionResponse.d.ts +1 -1
  65. package/dist/cjs/api/resources/documentCollections/types/MongoCollectionSyncConfig.d.ts +1 -1
  66. package/dist/cjs/api/resources/documentCollections/types/index.d.ts +1 -1
  67. package/dist/cjs/api/resources/documentCollections/types/index.js +1 -1
  68. package/dist/cjs/api/resources/index.d.ts +4 -4
  69. package/dist/cjs/api/resources/index.js +4 -4
  70. package/dist/cjs/api/resources/search/client/Client.d.ts +1 -1
  71. package/dist/cjs/api/resources/search/client/Client.js +4 -4
  72. package/dist/cjs/api/resources/search/client/index.d.ts +0 -1
  73. package/dist/cjs/api/resources/search/client/requests/SearchDocumentCollectionRequest.d.ts +1 -1
  74. package/dist/cjs/api/resources/search/client/requests/index.d.ts +1 -1
  75. package/dist/cjs/api/resources/search/index.d.ts +1 -1
  76. package/dist/cjs/api/resources/search/index.js +1 -1
  77. package/dist/cjs/api/resources/search/types/DocumentCollectionSearchResult.d.ts +1 -1
  78. package/dist/cjs/api/resources/search/types/SearchDocumentCollectionResponse.d.ts +1 -1
  79. package/dist/cjs/api/resources/search/types/SingleFieldFilter.d.ts +1 -1
  80. package/dist/cjs/api/resources/search/types/index.d.ts +1 -1
  81. package/dist/cjs/api/resources/search/types/index.js +1 -1
  82. package/dist/cjs/api/resources/users/client/Client.d.ts +1 -1
  83. package/dist/cjs/api/resources/users/client/Client.js +4 -4
  84. package/dist/cjs/api/resources/users/index.d.ts +1 -1
  85. package/dist/cjs/api/resources/users/index.js +1 -1
  86. package/dist/cjs/core/exports.d.ts +1 -0
  87. package/dist/cjs/core/exports.js +17 -0
  88. package/dist/cjs/core/fetcher/EndpointSupplier.d.ts +1 -1
  89. package/dist/cjs/core/fetcher/Fetcher.js +2 -1
  90. package/dist/cjs/core/fetcher/getErrorResponseBody.js +2 -1
  91. package/dist/cjs/core/fetcher/getResponseBody.js +3 -3
  92. package/dist/cjs/core/fetcher/makeRequest.js +2 -2
  93. package/dist/cjs/core/fetcher/requestWithRetries.js +3 -3
  94. package/dist/cjs/core/file/exports.d.ts +1 -0
  95. package/dist/cjs/core/file/exports.js +2 -0
  96. package/dist/cjs/core/file/file.d.ts +10 -0
  97. package/dist/cjs/core/file/file.js +221 -0
  98. package/dist/cjs/core/file/index.d.ts +2 -0
  99. package/dist/cjs/core/file/index.js +18 -0
  100. package/dist/cjs/core/file/types.d.ts +66 -0
  101. package/dist/cjs/core/file/types.js +2 -0
  102. package/dist/cjs/core/form-data-utils/FormDataWrapper.d.ts +15 -0
  103. package/dist/cjs/core/form-data-utils/FormDataWrapper.js +185 -0
  104. package/dist/cjs/core/form-data-utils/encodeAsFormParameter.d.ts +1 -0
  105. package/dist/cjs/core/form-data-utils/encodeAsFormParameter.js +12 -0
  106. package/dist/cjs/core/form-data-utils/index.d.ts +2 -0
  107. package/dist/cjs/core/form-data-utils/index.js +20 -0
  108. package/dist/cjs/core/index.d.ts +5 -3
  109. package/dist/cjs/core/index.js +6 -4
  110. package/dist/cjs/core/stream/Stream.d.ts +1 -0
  111. package/dist/cjs/core/stream/Stream.js +8 -5
  112. package/dist/cjs/core/url/encodePathParam.d.ts +1 -0
  113. package/dist/cjs/core/url/encodePathParam.js +21 -0
  114. package/dist/cjs/core/url/index.d.ts +1 -0
  115. package/dist/cjs/core/url/index.js +3 -1
  116. package/dist/cjs/core/url/join.js +3 -3
  117. package/dist/cjs/errors/CredalError.d.ts +1 -1
  118. package/dist/cjs/errors/CredalError.js +1 -1
  119. package/dist/cjs/exports.d.ts +1 -0
  120. package/dist/cjs/exports.js +17 -0
  121. package/dist/cjs/index.d.ts +3 -2
  122. package/dist/cjs/index.js +8 -4
  123. package/dist/cjs/version.d.ts +1 -1
  124. package/dist/cjs/version.js +1 -1
  125. package/dist/esm/BaseClient.d.mts +2 -2
  126. package/dist/esm/BaseClient.mjs +1 -2
  127. package/dist/esm/Client.d.mts +1 -1
  128. package/dist/esm/Client.mjs +4 -5
  129. package/dist/esm/api/resources/common/types/Collaborator.d.mts +1 -1
  130. package/dist/esm/api/resources/common/types/Collaborator.mjs +1 -1
  131. package/dist/esm/api/resources/common/types/ExternalResourceId.d.mts +1 -1
  132. package/dist/esm/api/resources/common/types/ExternalResourceId.mjs +1 -1
  133. package/dist/esm/api/resources/common/types/ResourceIdentifier.d.mts +1 -1
  134. package/dist/esm/api/resources/common/types/ResourceIdentifier.mjs +1 -1
  135. package/dist/esm/api/resources/common/types/index.d.mts +5 -5
  136. package/dist/esm/api/resources/common/types/index.mjs +5 -5
  137. package/dist/esm/api/resources/copilots/client/Client.d.mts +1 -1
  138. package/dist/esm/api/resources/copilots/client/Client.mjs +12 -13
  139. package/dist/esm/api/resources/copilots/client/index.d.mts +0 -1
  140. package/dist/esm/api/resources/copilots/client/index.mjs +0 -1
  141. package/dist/esm/api/resources/copilots/client/requests/CreateCopilotRequest.d.mts +1 -1
  142. package/dist/esm/api/resources/copilots/client/requests/CreateCopilotRequest.mjs +1 -1
  143. package/dist/esm/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.mts +1 -1
  144. package/dist/esm/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.mjs +1 -1
  145. package/dist/esm/api/resources/copilots/client/requests/SendMessageRequest.d.mts +1 -1
  146. package/dist/esm/api/resources/copilots/client/requests/SendMessageRequest.mjs +1 -1
  147. package/dist/esm/api/resources/copilots/client/requests/StreamMessageRequest.d.mts +1 -1
  148. package/dist/esm/api/resources/copilots/client/requests/StreamMessageRequest.mjs +1 -1
  149. package/dist/esm/api/resources/copilots/client/requests/UpdateConfigurationRequest.d.mts +1 -1
  150. package/dist/esm/api/resources/copilots/client/requests/UpdateConfigurationRequest.mjs +1 -1
  151. package/dist/esm/api/resources/copilots/client/requests/index.d.mts +9 -9
  152. package/dist/esm/api/resources/copilots/client/requests/index.mjs +1 -9
  153. package/dist/esm/api/resources/copilots/index.d.mts +1 -1
  154. package/dist/esm/api/resources/copilots/index.mjs +1 -1
  155. package/dist/esm/api/resources/copilots/types/CollectionFilteredData.d.mts +1 -1
  156. package/dist/esm/api/resources/copilots/types/CollectionFilteredData.mjs +1 -1
  157. package/dist/esm/api/resources/copilots/types/Configuration.d.mts +1 -1
  158. package/dist/esm/api/resources/copilots/types/Configuration.mjs +1 -1
  159. package/dist/esm/api/resources/copilots/types/DataFilter.d.mts +1 -1
  160. package/dist/esm/api/resources/copilots/types/DataFilter.mjs +1 -1
  161. package/dist/esm/api/resources/copilots/types/DatetimeFieldSchema.d.mts +1 -1
  162. package/dist/esm/api/resources/copilots/types/DatetimeFieldSchema.mjs +1 -1
  163. package/dist/esm/api/resources/copilots/types/EndOfMessageChunk.d.mts +1 -2
  164. package/dist/esm/api/resources/copilots/types/ErrorChunk.d.mts +1 -1
  165. package/dist/esm/api/resources/copilots/types/ErrorChunk.mjs +1 -1
  166. package/dist/esm/api/resources/copilots/types/Filter.d.mts +1 -1
  167. package/dist/esm/api/resources/copilots/types/Filter.mjs +1 -1
  168. package/dist/esm/api/resources/copilots/types/FinalChunk.d.mts +1 -1
  169. package/dist/esm/api/resources/copilots/types/FinalChunk.mjs +1 -1
  170. package/dist/esm/api/resources/copilots/types/InitialChunk.d.mts +1 -1
  171. package/dist/esm/api/resources/copilots/types/InitialChunk.mjs +1 -1
  172. package/dist/esm/api/resources/copilots/types/MessageBlocked.d.mts +1 -1
  173. package/dist/esm/api/resources/copilots/types/MessageBlocked.mjs +1 -1
  174. package/dist/esm/api/resources/copilots/types/MessageFeedback.d.mts +1 -1
  175. package/dist/esm/api/resources/copilots/types/MessageFeedback.mjs +1 -1
  176. package/dist/esm/api/resources/copilots/types/MessageReply.d.mts +1 -1
  177. package/dist/esm/api/resources/copilots/types/MessageReply.mjs +1 -1
  178. package/dist/esm/api/resources/copilots/types/NumberFieldSchema.d.mts +1 -1
  179. package/dist/esm/api/resources/copilots/types/NumberFieldSchema.mjs +1 -1
  180. package/dist/esm/api/resources/copilots/types/ReferencedSource.d.mts +1 -1
  181. package/dist/esm/api/resources/copilots/types/ReferencedSource.mjs +1 -1
  182. package/dist/esm/api/resources/copilots/types/SendAgentMessageResponse.d.mts +1 -1
  183. package/dist/esm/api/resources/copilots/types/SendAgentMessageResponse.mjs +1 -1
  184. package/dist/esm/api/resources/copilots/types/SendMessageResponse.d.mts +1 -1
  185. package/dist/esm/api/resources/copilots/types/SendMessageResponse.mjs +1 -1
  186. package/dist/esm/api/resources/copilots/types/StreamingChunk.d.mts +1 -1
  187. package/dist/esm/api/resources/copilots/types/StreamingChunk.mjs +1 -1
  188. package/dist/esm/api/resources/copilots/types/StringFieldSchema.d.mts +1 -1
  189. package/dist/esm/api/resources/copilots/types/StringFieldSchema.mjs +1 -1
  190. package/dist/esm/api/resources/copilots/types/index.d.mts +24 -24
  191. package/dist/esm/api/resources/copilots/types/index.mjs +24 -24
  192. package/dist/esm/api/resources/documentCatalog/client/Client.d.mts +9 -1
  193. package/dist/esm/api/resources/documentCatalog/client/Client.mjs +90 -7
  194. package/dist/esm/api/resources/documentCatalog/client/index.d.mts +0 -1
  195. package/dist/esm/api/resources/documentCatalog/client/index.mjs +0 -1
  196. package/dist/esm/api/resources/documentCatalog/client/requests/UploadDocumentContentsRequest.d.mts +1 -1
  197. package/dist/esm/api/resources/documentCatalog/client/requests/UploadDocumentContentsRequest.mjs +1 -1
  198. package/dist/esm/api/resources/documentCatalog/client/requests/UploadFileRequest.d.mts +27 -0
  199. package/dist/esm/api/resources/documentCatalog/client/requests/UploadFileRequest.mjs +2 -0
  200. package/dist/esm/api/resources/documentCatalog/client/requests/index.d.mts +2 -1
  201. package/dist/esm/api/resources/documentCatalog/client/requests/index.mjs +1 -1
  202. package/dist/esm/api/resources/documentCatalog/index.d.mts +1 -1
  203. package/dist/esm/api/resources/documentCatalog/index.mjs +1 -1
  204. package/dist/esm/api/resources/documentCatalog/types/DocumentMetadataPatch.d.mts +1 -1
  205. package/dist/esm/api/resources/documentCatalog/types/DocumentMetadataPatch.mjs +1 -1
  206. package/dist/esm/api/resources/documentCatalog/types/DocumentMetadataPatchRequest.d.mts +1 -1
  207. package/dist/esm/api/resources/documentCatalog/types/DocumentMetadataPatchRequest.mjs +1 -1
  208. package/dist/esm/api/resources/documentCatalog/types/index.d.mts +1 -1
  209. package/dist/esm/api/resources/documentCatalog/types/index.mjs +1 -1
  210. package/dist/esm/api/resources/documentCollections/client/Client.d.mts +1 -1
  211. package/dist/esm/api/resources/documentCollections/client/Client.mjs +11 -12
  212. package/dist/esm/api/resources/documentCollections/client/index.d.mts +0 -1
  213. package/dist/esm/api/resources/documentCollections/client/index.mjs +0 -1
  214. package/dist/esm/api/resources/documentCollections/client/requests/AddDocumentsToCollectionRequest.d.mts +1 -1
  215. package/dist/esm/api/resources/documentCollections/client/requests/AddDocumentsToCollectionRequest.mjs +1 -1
  216. package/dist/esm/api/resources/documentCollections/client/requests/CreateCollectionRequest.d.mts +1 -1
  217. package/dist/esm/api/resources/documentCollections/client/requests/CreateCollectionRequest.mjs +1 -1
  218. package/dist/esm/api/resources/documentCollections/client/requests/CreateMongoCollectionSyncRequest.d.mts +1 -1
  219. package/dist/esm/api/resources/documentCollections/client/requests/CreateMongoCollectionSyncRequest.mjs +1 -1
  220. package/dist/esm/api/resources/documentCollections/client/requests/RemoveDocumentsFromCollectionRequest.d.mts +1 -1
  221. package/dist/esm/api/resources/documentCollections/client/requests/RemoveDocumentsFromCollectionRequest.mjs +1 -1
  222. package/dist/esm/api/resources/documentCollections/client/requests/UpdateMongoCollectionSyncRequest.d.mts +1 -1
  223. package/dist/esm/api/resources/documentCollections/client/requests/UpdateMongoCollectionSyncRequest.mjs +1 -1
  224. package/dist/esm/api/resources/documentCollections/client/requests/index.d.mts +7 -7
  225. package/dist/esm/api/resources/documentCollections/client/requests/index.mjs +1 -7
  226. package/dist/esm/api/resources/documentCollections/index.d.mts +1 -1
  227. package/dist/esm/api/resources/documentCollections/index.mjs +1 -1
  228. package/dist/esm/api/resources/documentCollections/types/ListDocumentsInCollectionResponse.d.mts +1 -1
  229. package/dist/esm/api/resources/documentCollections/types/ListDocumentsInCollectionResponse.mjs +1 -1
  230. package/dist/esm/api/resources/documentCollections/types/MongoCollectionSyncConfig.d.mts +1 -1
  231. package/dist/esm/api/resources/documentCollections/types/MongoCollectionSyncConfig.mjs +1 -1
  232. package/dist/esm/api/resources/documentCollections/types/index.d.mts +1 -1
  233. package/dist/esm/api/resources/documentCollections/types/index.mjs +1 -1
  234. package/dist/esm/api/resources/index.d.mts +4 -4
  235. package/dist/esm/api/resources/index.mjs +4 -4
  236. package/dist/esm/api/resources/search/client/Client.d.mts +1 -1
  237. package/dist/esm/api/resources/search/client/Client.mjs +4 -5
  238. package/dist/esm/api/resources/search/client/index.d.mts +0 -1
  239. package/dist/esm/api/resources/search/client/index.mjs +0 -1
  240. package/dist/esm/api/resources/search/client/requests/SearchDocumentCollectionRequest.d.mts +1 -1
  241. package/dist/esm/api/resources/search/client/requests/SearchDocumentCollectionRequest.mjs +1 -1
  242. package/dist/esm/api/resources/search/client/requests/index.d.mts +1 -1
  243. package/dist/esm/api/resources/search/client/requests/index.mjs +1 -1
  244. package/dist/esm/api/resources/search/index.d.mts +1 -1
  245. package/dist/esm/api/resources/search/index.mjs +1 -1
  246. package/dist/esm/api/resources/search/types/DocumentCollectionSearchResult.d.mts +1 -1
  247. package/dist/esm/api/resources/search/types/DocumentCollectionSearchResult.mjs +1 -1
  248. package/dist/esm/api/resources/search/types/SearchDocumentCollectionResponse.d.mts +1 -1
  249. package/dist/esm/api/resources/search/types/SearchDocumentCollectionResponse.mjs +1 -1
  250. package/dist/esm/api/resources/search/types/SingleFieldFilter.d.mts +1 -1
  251. package/dist/esm/api/resources/search/types/SingleFieldFilter.mjs +1 -1
  252. package/dist/esm/api/resources/search/types/index.d.mts +1 -1
  253. package/dist/esm/api/resources/search/types/index.mjs +1 -1
  254. package/dist/esm/api/resources/users/client/Client.d.mts +1 -1
  255. package/dist/esm/api/resources/users/client/Client.mjs +4 -5
  256. package/dist/esm/api/resources/users/index.d.mts +1 -1
  257. package/dist/esm/api/resources/users/index.mjs +1 -1
  258. package/dist/esm/core/exports.d.mts +1 -0
  259. package/dist/esm/core/exports.mjs +1 -0
  260. package/dist/esm/core/fetcher/EndpointSupplier.d.mts +1 -1
  261. package/dist/esm/core/fetcher/EndpointSupplier.mjs +0 -1
  262. package/dist/esm/core/fetcher/Fetcher.mjs +2 -1
  263. package/dist/esm/core/fetcher/getErrorResponseBody.mjs +2 -1
  264. package/dist/esm/core/fetcher/getResponseBody.mjs +3 -3
  265. package/dist/esm/core/fetcher/makeRequest.mjs +2 -2
  266. package/dist/esm/core/fetcher/requestWithRetries.mjs +3 -3
  267. package/dist/esm/core/file/exports.d.mts +1 -0
  268. package/dist/esm/core/file/exports.mjs +1 -0
  269. package/dist/esm/core/file/file.d.mts +10 -0
  270. package/dist/esm/core/file/file.mjs +184 -0
  271. package/dist/esm/core/file/index.d.mts +2 -0
  272. package/dist/esm/core/file/index.mjs +2 -0
  273. package/dist/esm/core/file/types.d.mts +66 -0
  274. package/dist/esm/core/file/types.mjs +1 -0
  275. package/dist/esm/core/form-data-utils/FormDataWrapper.d.mts +15 -0
  276. package/dist/esm/core/form-data-utils/FormDataWrapper.mjs +147 -0
  277. package/dist/esm/core/form-data-utils/encodeAsFormParameter.d.mts +1 -0
  278. package/dist/esm/core/form-data-utils/encodeAsFormParameter.mjs +9 -0
  279. package/dist/esm/core/form-data-utils/index.d.mts +2 -0
  280. package/dist/esm/core/form-data-utils/index.mjs +2 -0
  281. package/dist/esm/core/index.d.mts +5 -3
  282. package/dist/esm/core/index.mjs +5 -3
  283. package/dist/esm/core/stream/Stream.d.mts +1 -0
  284. package/dist/esm/core/stream/Stream.mjs +8 -5
  285. package/dist/esm/core/url/encodePathParam.d.mts +1 -0
  286. package/dist/esm/core/url/encodePathParam.mjs +18 -0
  287. package/dist/esm/core/url/index.d.mts +1 -0
  288. package/dist/esm/core/url/index.mjs +1 -0
  289. package/dist/esm/core/url/join.mjs +3 -3
  290. package/dist/esm/errors/CredalError.d.mts +1 -1
  291. package/dist/esm/errors/CredalError.mjs +1 -2
  292. package/dist/esm/exports.d.mts +1 -0
  293. package/dist/esm/exports.mjs +1 -0
  294. package/dist/esm/index.d.mts +3 -2
  295. package/dist/esm/index.mjs +2 -2
  296. package/dist/esm/version.d.mts +1 -1
  297. package/dist/esm/version.mjs +1 -1
  298. package/package.json +9 -4
  299. package/reference.md +203 -229
@@ -1,6 +1,6 @@
1
1
  import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
2
2
  import * as core from "../../../../core/index.js";
3
- import * as Credal from "../../../index.js";
3
+ import type * as Credal from "../../../index.js";
4
4
  export declare namespace Users {
5
5
  interface Options extends BaseClientOptions {
6
6
  }
@@ -44,9 +44,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
44
44
  };
45
45
  Object.defineProperty(exports, "__esModule", { value: true });
46
46
  exports.Users = void 0;
47
- const environments = __importStar(require("../../../../environments.js"));
48
- const core = __importStar(require("../../../../core/index.js"));
49
47
  const headers_js_1 = require("../../../../core/headers.js");
48
+ const core = __importStar(require("../../../../core/index.js"));
49
+ const environments = __importStar(require("../../../../environments.js"));
50
50
  const errors = __importStar(require("../../../../errors/index.js"));
51
51
  class Users {
52
52
  constructor(_options = {}) {
@@ -79,7 +79,7 @@ class Users {
79
79
  __metadata(request, requestOptions) {
80
80
  return __awaiter(this, void 0, void 0, function* () {
81
81
  var _a, _b, _c, _d, _e, _f, _g, _h, _j;
82
- let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
82
+ const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
83
83
  const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
84
84
  url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/users/metadata"),
85
85
  method: "PATCH",
@@ -122,7 +122,7 @@ class Users {
122
122
  _getAuthorizationHeader() {
123
123
  return __awaiter(this, void 0, void 0, function* () {
124
124
  var _a;
125
- const bearer = (_a = (yield core.Supplier.get(this._options.apiKey))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["CREDAL_API_KEY"];
125
+ const bearer = (_a = (yield core.Supplier.get(this._options.apiKey))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env.CREDAL_API_KEY;
126
126
  if (bearer == null) {
127
127
  throw new errors.CredalError({
128
128
  message: "Please specify a bearer by either passing it in to the constructor or initializing a CREDAL_API_KEY environment variable",
@@ -1,2 +1,2 @@
1
- export * from "./types/index.js";
2
1
  export * from "./client/index.js";
2
+ export * from "./types/index.js";
@@ -14,5 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./types/index.js"), exports);
18
17
  __exportStar(require("./client/index.js"), exports);
18
+ __exportStar(require("./types/index.js"), exports);
@@ -0,0 +1 @@
1
+ export * from "./file/exports.js";
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./file/exports.js"), exports);
@@ -1,5 +1,5 @@
1
1
  import type { EndpointMetadata } from "./EndpointMetadata.js";
2
- import { Supplier } from "./Supplier.js";
2
+ import type { Supplier } from "./Supplier.js";
3
3
  type EndpointSupplierFn<T> = (arg: {
4
4
  endpointMetadata: EndpointMetadata;
5
5
  }) => T | Promise<T>;
@@ -47,6 +47,7 @@ function getHeaders(args) {
47
47
  }
48
48
  function fetcherImpl(args) {
49
49
  return __awaiter(this, void 0, void 0, function* () {
50
+ var _a;
50
51
  const url = (0, createRequestUrl_js_1.createRequestUrl)(args.url, args.queryParameters);
51
52
  const requestBody = yield (0, getRequestBody_js_1.getRequestBody)({
52
53
  body: args.body,
@@ -78,7 +79,7 @@ function fetcherImpl(args) {
78
79
  }
79
80
  }
80
81
  catch (error) {
81
- if (args.abortSignal != null && args.abortSignal.aborted) {
82
+ if ((_a = args.abortSignal) === null || _a === void 0 ? void 0 : _a.aborted) {
82
83
  return {
83
84
  ok: false,
84
85
  error: {
@@ -28,9 +28,10 @@ function getErrorResponseBody(response) {
28
28
  case "application/ld+json":
29
29
  case "application/problem+json":
30
30
  case "application/vnd.api+json":
31
- case "text/json":
31
+ case "text/json": {
32
32
  const text = yield response.text();
33
33
  return text.length > 0 ? (0, json_js_1.fromJson)(text) : undefined;
34
+ }
34
35
  default:
35
36
  if (contentType.startsWith("application/vnd.") && contentType.endsWith("+json")) {
36
37
  const text = yield response.text();
@@ -10,9 +10,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
10
10
  };
11
11
  Object.defineProperty(exports, "__esModule", { value: true });
12
12
  exports.getResponseBody = getResponseBody;
13
+ const json_js_1 = require("../json.js");
13
14
  const BinaryResponse_js_1 = require("./BinaryResponse.js");
14
15
  const ResponseWithBody_js_1 = require("./ResponseWithBody.js");
15
- const json_js_1 = require("../json.js");
16
16
  function getResponseBody(response, responseType) {
17
17
  return __awaiter(this, void 0, void 0, function* () {
18
18
  if (!(0, ResponseWithBody_js_1.isResponseWithBody)(response)) {
@@ -36,10 +36,10 @@ function getResponseBody(response, responseType) {
36
36
  const text = yield response.text();
37
37
  if (text.length > 0) {
38
38
  try {
39
- let responseBody = (0, json_js_1.fromJson)(text);
39
+ const responseBody = (0, json_js_1.fromJson)(text);
40
40
  return responseBody;
41
41
  }
42
- catch (err) {
42
+ catch (_err) {
43
43
  return {
44
44
  ok: false,
45
45
  error: {
@@ -14,7 +14,7 @@ const signals_js_1 = require("./signals.js");
14
14
  const makeRequest = (fetchFn, url, method, headers, requestBody, timeoutMs, abortSignal, withCredentials, duplex) => __awaiter(void 0, void 0, void 0, function* () {
15
15
  const signals = [];
16
16
  // Add timeout signal
17
- let timeoutAbortId = undefined;
17
+ let timeoutAbortId;
18
18
  if (timeoutMs != null) {
19
19
  const { signal, abortId } = (0, signals_js_1.getTimeoutSignal)(timeoutMs);
20
20
  timeoutAbortId = abortId;
@@ -24,7 +24,7 @@ const makeRequest = (fetchFn, url, method, headers, requestBody, timeoutMs, abor
24
24
  if (abortSignal != null) {
25
25
  signals.push(abortSignal);
26
26
  }
27
- let newSignals = (0, signals_js_1.anySignal)(signals);
27
+ const newSignals = (0, signals_js_1.anySignal)(signals);
28
28
  const response = yield fetchFn(url, {
29
29
  method: method,
30
30
  headers,
@@ -30,12 +30,12 @@ function getRetryDelayFromHeaders(response, retryAttempt) {
30
30
  if (retryAfter) {
31
31
  // Parse as number of seconds...
32
32
  const retryAfterSeconds = parseInt(retryAfter, 10);
33
- if (!isNaN(retryAfterSeconds) && retryAfterSeconds > 0) {
33
+ if (!Number.isNaN(retryAfterSeconds) && retryAfterSeconds > 0) {
34
34
  return Math.min(retryAfterSeconds * 1000, MAX_RETRY_DELAY);
35
35
  }
36
36
  // ...or as an HTTP date; both are valid
37
37
  const retryAfterDate = new Date(retryAfter);
38
- if (!isNaN(retryAfterDate.getTime())) {
38
+ if (!Number.isNaN(retryAfterDate.getTime())) {
39
39
  const delay = retryAfterDate.getTime() - Date.now();
40
40
  if (delay > 0) {
41
41
  return Math.min(Math.max(delay, 0), MAX_RETRY_DELAY);
@@ -46,7 +46,7 @@ function getRetryDelayFromHeaders(response, retryAttempt) {
46
46
  const rateLimitReset = response.headers.get("X-RateLimit-Reset");
47
47
  if (rateLimitReset) {
48
48
  const resetTime = parseInt(rateLimitReset, 10);
49
- if (!isNaN(resetTime)) {
49
+ if (!Number.isNaN(resetTime)) {
50
50
  // Assume Unix timestamp in epoch seconds
51
51
  const delay = resetTime * 1000 - Date.now();
52
52
  if (delay > 0) {
@@ -0,0 +1 @@
1
+ export type { Uploadable } from "./types.js";
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,10 @@
1
+ import type { Uploadable } from "./types.js";
2
+ export declare function toBinaryUploadRequest(file: Uploadable): Promise<{
3
+ body: Uploadable.FileLike;
4
+ headers?: Record<string, string>;
5
+ }>;
6
+ export declare function toMultipartDataPart(file: Uploadable): Promise<{
7
+ data: Uploadable.FileLike;
8
+ filename?: string;
9
+ contentType?: string;
10
+ }>;
@@ -0,0 +1,221 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
35
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
36
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
37
+ return new (P || (P = Promise))(function (resolve, reject) {
38
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
39
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
40
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
41
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
42
+ });
43
+ };
44
+ Object.defineProperty(exports, "__esModule", { value: true });
45
+ exports.toBinaryUploadRequest = toBinaryUploadRequest;
46
+ exports.toMultipartDataPart = toMultipartDataPart;
47
+ function toBinaryUploadRequest(file) {
48
+ return __awaiter(this, void 0, void 0, function* () {
49
+ const { data, filename, contentLength, contentType } = yield getFileWithMetadata(file);
50
+ const request = {
51
+ body: data,
52
+ headers: {},
53
+ };
54
+ if (filename) {
55
+ request.headers["Content-Disposition"] = `attachment; filename="${filename}"`;
56
+ }
57
+ if (contentType) {
58
+ request.headers["Content-Type"] = contentType;
59
+ }
60
+ if (contentLength != null) {
61
+ request.headers["Content-Length"] = contentLength.toString();
62
+ }
63
+ return request;
64
+ });
65
+ }
66
+ function toMultipartDataPart(file) {
67
+ return __awaiter(this, void 0, void 0, function* () {
68
+ const { data, filename, contentType } = yield getFileWithMetadata(file, {
69
+ noSniffFileSize: true,
70
+ });
71
+ return {
72
+ data,
73
+ filename,
74
+ contentType,
75
+ };
76
+ });
77
+ }
78
+ function getFileWithMetadata(file_1) {
79
+ return __awaiter(this, arguments, void 0, function* (file, { noSniffFileSize } = {}) {
80
+ var _a, _b, _c, _d, _e;
81
+ if (isFileLike(file)) {
82
+ return getFileWithMetadata({
83
+ data: file,
84
+ }, { noSniffFileSize });
85
+ }
86
+ if ("path" in file) {
87
+ const fs = yield Promise.resolve().then(() => __importStar(require("fs")));
88
+ if (!fs || !fs.createReadStream) {
89
+ throw new Error("File path uploads are not supported in this environment.");
90
+ }
91
+ const data = fs.createReadStream(file.path);
92
+ const contentLength = (_a = file.contentLength) !== null && _a !== void 0 ? _a : (noSniffFileSize === true ? undefined : yield tryGetFileSizeFromPath(file.path));
93
+ const filename = (_b = file.filename) !== null && _b !== void 0 ? _b : getNameFromPath(file.path);
94
+ return {
95
+ data,
96
+ filename,
97
+ contentType: file.contentType,
98
+ contentLength,
99
+ };
100
+ }
101
+ if ("data" in file) {
102
+ const data = file.data;
103
+ const contentLength = (_c = file.contentLength) !== null && _c !== void 0 ? _c : (yield tryGetContentLengthFromFileLike(data, {
104
+ noSniffFileSize,
105
+ }));
106
+ const filename = (_d = file.filename) !== null && _d !== void 0 ? _d : tryGetNameFromFileLike(data);
107
+ return {
108
+ data,
109
+ filename,
110
+ contentType: (_e = file.contentType) !== null && _e !== void 0 ? _e : tryGetContentTypeFromFileLike(data),
111
+ contentLength,
112
+ };
113
+ }
114
+ throw new Error(`Invalid FileUpload of type ${typeof file}: ${JSON.stringify(file)}`);
115
+ });
116
+ }
117
+ function isFileLike(value) {
118
+ return (isBuffer(value) ||
119
+ isArrayBufferView(value) ||
120
+ isArrayBuffer(value) ||
121
+ isUint8Array(value) ||
122
+ isBlob(value) ||
123
+ isFile(value) ||
124
+ isStreamLike(value) ||
125
+ isReadableStream(value));
126
+ }
127
+ function tryGetFileSizeFromPath(path) {
128
+ return __awaiter(this, void 0, void 0, function* () {
129
+ try {
130
+ const fs = yield Promise.resolve().then(() => __importStar(require("fs")));
131
+ if (!fs || !fs.promises || !fs.promises.stat) {
132
+ return undefined;
133
+ }
134
+ const fileStat = yield fs.promises.stat(path);
135
+ return fileStat.size;
136
+ }
137
+ catch (_fallbackError) {
138
+ return undefined;
139
+ }
140
+ });
141
+ }
142
+ function tryGetNameFromFileLike(data) {
143
+ if (isNamedValue(data)) {
144
+ return data.name;
145
+ }
146
+ if (isPathedValue(data)) {
147
+ return getNameFromPath(data.path.toString());
148
+ }
149
+ return undefined;
150
+ }
151
+ function tryGetContentLengthFromFileLike(data_1) {
152
+ return __awaiter(this, arguments, void 0, function* (data, { noSniffFileSize } = {}) {
153
+ if (isBuffer(data)) {
154
+ return data.length;
155
+ }
156
+ if (isArrayBufferView(data)) {
157
+ return data.byteLength;
158
+ }
159
+ if (isArrayBuffer(data)) {
160
+ return data.byteLength;
161
+ }
162
+ if (isBlob(data)) {
163
+ return data.size;
164
+ }
165
+ if (isFile(data)) {
166
+ return data.size;
167
+ }
168
+ if (noSniffFileSize === true) {
169
+ return undefined;
170
+ }
171
+ if (isPathedValue(data)) {
172
+ return yield tryGetFileSizeFromPath(data.path.toString());
173
+ }
174
+ return undefined;
175
+ });
176
+ }
177
+ function tryGetContentTypeFromFileLike(data) {
178
+ if (isBlob(data)) {
179
+ return data.type;
180
+ }
181
+ if (isFile(data)) {
182
+ return data.type;
183
+ }
184
+ return undefined;
185
+ }
186
+ function getNameFromPath(path) {
187
+ const lastForwardSlash = path.lastIndexOf("/");
188
+ const lastBackSlash = path.lastIndexOf("\\");
189
+ const lastSlashIndex = Math.max(lastForwardSlash, lastBackSlash);
190
+ return lastSlashIndex >= 0 ? path.substring(lastSlashIndex + 1) : path;
191
+ }
192
+ function isNamedValue(value) {
193
+ return typeof value === "object" && value != null && "name" in value;
194
+ }
195
+ function isPathedValue(value) {
196
+ return typeof value === "object" && value != null && "path" in value;
197
+ }
198
+ function isStreamLike(value) {
199
+ return typeof value === "object" && value != null && ("read" in value || "pipe" in value);
200
+ }
201
+ function isReadableStream(value) {
202
+ return typeof value === "object" && value != null && "getReader" in value;
203
+ }
204
+ function isBuffer(value) {
205
+ return typeof Buffer !== "undefined" && Buffer.isBuffer && Buffer.isBuffer(value);
206
+ }
207
+ function isArrayBufferView(value) {
208
+ return typeof ArrayBuffer !== "undefined" && ArrayBuffer.isView(value);
209
+ }
210
+ function isArrayBuffer(value) {
211
+ return typeof ArrayBuffer !== "undefined" && value instanceof ArrayBuffer;
212
+ }
213
+ function isUint8Array(value) {
214
+ return typeof Uint8Array !== "undefined" && value instanceof Uint8Array;
215
+ }
216
+ function isBlob(value) {
217
+ return typeof Blob !== "undefined" && value instanceof Blob;
218
+ }
219
+ function isFile(value) {
220
+ return typeof File !== "undefined" && value instanceof File;
221
+ }
@@ -0,0 +1,2 @@
1
+ export * from "./file.js";
2
+ export * from "./types.js";
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./file.js"), exports);
18
+ __exportStar(require("./types.js"), exports);
@@ -0,0 +1,66 @@
1
+ /**
2
+ * A file that can be uploaded. Can be a file-like object (stream, buffer, blob, etc.),
3
+ * a path to a file, or an object with a file-like object and metadata.
4
+ */
5
+ export type Uploadable = Uploadable.FileLike | Uploadable.FromPath | Uploadable.WithMetadata;
6
+ export declare namespace Uploadable {
7
+ /**
8
+ * Various file-like objects that can be used to upload a file.
9
+ */
10
+ type FileLike = ArrayBuffer | ArrayBufferLike | ArrayBufferView | Uint8Array | import("buffer").Buffer | import("buffer").Blob | import("buffer").File | import("stream").Readable | import("stream/web").ReadableStream | globalThis.Blob | globalThis.File | ReadableStream;
11
+ /**
12
+ * A file path with optional metadata, used for uploading a file from the file system.
13
+ */
14
+ type FromPath = {
15
+ /** The path to the file to upload */
16
+ path: string;
17
+ /**
18
+ * Optional override for the file name (defaults to basename of path).
19
+ * This is used to set the `Content-Disposition` header in upload requests.
20
+ */
21
+ filename?: string;
22
+ /**
23
+ * Optional MIME type of the file (e.g., 'image/jpeg', 'text/plain').
24
+ * This is used to set the `Content-Type` header in upload requests.
25
+ */
26
+ contentType?: string;
27
+ /**
28
+ * Optional file size in bytes.
29
+ * If not provided, the file size will be determined from the file system.
30
+ * The content length is used to set the `Content-Length` header in upload requests.
31
+ */
32
+ contentLength?: number;
33
+ };
34
+ /**
35
+ * A file-like object with metadata, used for uploading files.
36
+ */
37
+ type WithMetadata = {
38
+ /** The file data */
39
+ data: FileLike;
40
+ /**
41
+ * Optional override for the file name (defaults to basename of path).
42
+ * This is used to set the `Content-Disposition` header in upload requests.
43
+ */
44
+ filename?: string;
45
+ /**
46
+ * Optional MIME type of the file (e.g., 'image/jpeg', 'text/plain').
47
+ * This is used to set the `Content-Type` header in upload requests.
48
+ *
49
+ * If not provided, the content type may be determined from the data itself.
50
+ * * If the data is a `File`, `Blob`, or similar, the content type will be determined from the file itself, if the type is set.
51
+ * * Any other data type will not have a content type set, and the upload request will use `Content-Type: application/octet-stream` instead.
52
+ */
53
+ contentType?: string;
54
+ /**
55
+ * Optional file size in bytes.
56
+ * The content length is used to set the `Content-Length` header in upload requests.
57
+ * If the content length is not provided and cannot be determined, the upload request will not include the `Content-Length` header, but will use `Transfer-Encoding: chunked` instead.
58
+ *
59
+ * If not provided, the file size will be determined depending on the data type.
60
+ * * If the data is of type `fs.ReadStream` (`createReadStream`), the size will be determined from the file system.
61
+ * * If the data is a `Buffer`, `ArrayBuffer`, `Uint8Array`, `Blob`, `File`, or similar, the size will be determined from the data itself.
62
+ * * If the data is a `Readable` or `ReadableStream`, the size will not be determined.
63
+ */
64
+ contentLength?: number;
65
+ };
66
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,15 @@
1
+ import { type Uploadable } from "../../core/file/index.js";
2
+ interface FormDataRequest<Body> {
3
+ body: Body;
4
+ headers: Record<string, string>;
5
+ duplex?: "half";
6
+ }
7
+ export declare function newFormData(): Promise<FormDataWrapper>;
8
+ export declare class FormDataWrapper {
9
+ private fd;
10
+ setup(): Promise<void>;
11
+ append(key: string, value: unknown): void;
12
+ appendFile(key: string, value: Uploadable): Promise<void>;
13
+ getRequest(): FormDataRequest<FormData>;
14
+ }
15
+ export {};