fluidapi 0.0.3

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 (321) hide show
  1. package/FUNCTIONS.md +85 -0
  2. package/README.md +429 -0
  3. package/RUNTIMES.md +48 -0
  4. package/esm/core.d.ts +10 -0
  5. package/esm/core.d.ts.map +1 -0
  6. package/esm/core.js +13 -0
  7. package/esm/core.js.map +1 -0
  8. package/esm/funcs/metadata-get-jwks.d.ts +18 -0
  9. package/esm/funcs/metadata-get-jwks.d.ts.map +1 -0
  10. package/esm/funcs/metadata-get-jwks.js +67 -0
  11. package/esm/funcs/metadata-get-jwks.js.map +1 -0
  12. package/esm/funcs/metadata-health-check.d.ts +15 -0
  13. package/esm/funcs/metadata-health-check.d.ts.map +1 -0
  14. package/esm/funcs/metadata-health-check.js +64 -0
  15. package/esm/funcs/metadata-health-check.js.map +1 -0
  16. package/esm/funcs/tokens-issue-fluid-token.d.ts +25 -0
  17. package/esm/funcs/tokens-issue-fluid-token.d.ts.map +1 -0
  18. package/esm/funcs/tokens-issue-fluid-token.js +87 -0
  19. package/esm/funcs/tokens-issue-fluid-token.js.map +1 -0
  20. package/esm/funcs/tokens-issue-token.d.ts +31 -0
  21. package/esm/funcs/tokens-issue-token.d.ts.map +1 -0
  22. package/esm/funcs/tokens-issue-token.js +93 -0
  23. package/esm/funcs/tokens-issue-token.js.map +1 -0
  24. package/esm/funcs/tokens-issue-user-token.d.ts +37 -0
  25. package/esm/funcs/tokens-issue-user-token.d.ts.map +1 -0
  26. package/esm/funcs/tokens-issue-user-token.js +97 -0
  27. package/esm/funcs/tokens-issue-user-token.js.map +1 -0
  28. package/esm/hooks/hooks.d.ts +25 -0
  29. package/esm/hooks/hooks.d.ts.map +1 -0
  30. package/esm/hooks/hooks.js +82 -0
  31. package/esm/hooks/hooks.js.map +1 -0
  32. package/esm/hooks/index.d.ts +3 -0
  33. package/esm/hooks/index.d.ts.map +1 -0
  34. package/esm/hooks/index.js +6 -0
  35. package/esm/hooks/index.js.map +1 -0
  36. package/esm/hooks/registration.d.ts +3 -0
  37. package/esm/hooks/registration.d.ts.map +1 -0
  38. package/esm/hooks/registration.js +12 -0
  39. package/esm/hooks/registration.js.map +1 -0
  40. package/esm/hooks/types.d.ts +76 -0
  41. package/esm/hooks/types.d.ts.map +1 -0
  42. package/esm/hooks/types.js +5 -0
  43. package/esm/hooks/types.js.map +1 -0
  44. package/esm/index.d.ts +6 -0
  45. package/esm/index.d.ts.map +1 -0
  46. package/esm/index.js +8 -0
  47. package/esm/index.js.map +1 -0
  48. package/esm/lib/base64.d.ts +10 -0
  49. package/esm/lib/base64.d.ts.map +1 -0
  50. package/esm/lib/base64.js +31 -0
  51. package/esm/lib/base64.js.map +1 -0
  52. package/esm/lib/config.d.ts +57 -0
  53. package/esm/lib/config.d.ts.map +1 -0
  54. package/esm/lib/config.js +50 -0
  55. package/esm/lib/config.js.map +1 -0
  56. package/esm/lib/dlv.d.ts +14 -0
  57. package/esm/lib/dlv.d.ts.map +1 -0
  58. package/esm/lib/dlv.js +46 -0
  59. package/esm/lib/dlv.js.map +1 -0
  60. package/esm/lib/encodings.d.ts +53 -0
  61. package/esm/lib/encodings.d.ts.map +1 -0
  62. package/esm/lib/encodings.js +370 -0
  63. package/esm/lib/encodings.js.map +1 -0
  64. package/esm/lib/env.d.ts +14 -0
  65. package/esm/lib/env.d.ts.map +1 -0
  66. package/esm/lib/env.js +43 -0
  67. package/esm/lib/env.js.map +1 -0
  68. package/esm/lib/files.d.ts +13 -0
  69. package/esm/lib/files.d.ts.map +1 -0
  70. package/esm/lib/files.js +73 -0
  71. package/esm/lib/files.js.map +1 -0
  72. package/esm/lib/http.d.ts +67 -0
  73. package/esm/lib/http.d.ts.map +1 -0
  74. package/esm/lib/http.js +209 -0
  75. package/esm/lib/http.js.map +1 -0
  76. package/esm/lib/is-plain-object.d.ts +2 -0
  77. package/esm/lib/is-plain-object.d.ts.map +1 -0
  78. package/esm/lib/is-plain-object.js +38 -0
  79. package/esm/lib/is-plain-object.js.map +1 -0
  80. package/esm/lib/logger.d.ts +6 -0
  81. package/esm/lib/logger.d.ts.map +1 -0
  82. package/esm/lib/logger.js +5 -0
  83. package/esm/lib/logger.js.map +1 -0
  84. package/esm/lib/matchers.d.ts +59 -0
  85. package/esm/lib/matchers.d.ts.map +1 -0
  86. package/esm/lib/matchers.js +202 -0
  87. package/esm/lib/matchers.js.map +1 -0
  88. package/esm/lib/primitives.d.ts +26 -0
  89. package/esm/lib/primitives.d.ts.map +1 -0
  90. package/esm/lib/primitives.js +103 -0
  91. package/esm/lib/primitives.js.map +1 -0
  92. package/esm/lib/retries.d.ts +38 -0
  93. package/esm/lib/retries.d.ts.map +1 -0
  94. package/esm/lib/retries.js +150 -0
  95. package/esm/lib/retries.js.map +1 -0
  96. package/esm/lib/schemas.d.ts +21 -0
  97. package/esm/lib/schemas.d.ts.map +1 -0
  98. package/esm/lib/schemas.js +57 -0
  99. package/esm/lib/schemas.js.map +1 -0
  100. package/esm/lib/sdks.d.ts +63 -0
  101. package/esm/lib/sdks.d.ts.map +1 -0
  102. package/esm/lib/sdks.js +258 -0
  103. package/esm/lib/sdks.js.map +1 -0
  104. package/esm/lib/security.d.ts +80 -0
  105. package/esm/lib/security.d.ts.map +1 -0
  106. package/esm/lib/security.js +122 -0
  107. package/esm/lib/security.js.map +1 -0
  108. package/esm/lib/url.d.ts +5 -0
  109. package/esm/lib/url.d.ts.map +1 -0
  110. package/esm/lib/url.js +22 -0
  111. package/esm/lib/url.js.map +1 -0
  112. package/esm/models/error-response.d.ts +17 -0
  113. package/esm/models/error-response.d.ts.map +1 -0
  114. package/esm/models/error-response.js +15 -0
  115. package/esm/models/error-response.js.map +1 -0
  116. package/esm/models/errors/error-response.d.ts +21 -0
  117. package/esm/models/errors/error-response.d.ts.map +1 -0
  118. package/esm/models/errors/error-response.js +37 -0
  119. package/esm/models/errors/error-response.js.map +1 -0
  120. package/esm/models/errors/fluidapi-default-error.d.ts +10 -0
  121. package/esm/models/errors/fluidapi-default-error.d.ts.map +1 -0
  122. package/esm/models/errors/fluidapi-default-error.js +30 -0
  123. package/esm/models/errors/fluidapi-default-error.js.map +1 -0
  124. package/esm/models/errors/fluidapi-error.d.ts +19 -0
  125. package/esm/models/errors/fluidapi-error.d.ts.map +1 -0
  126. package/esm/models/errors/fluidapi-error.js +26 -0
  127. package/esm/models/errors/fluidapi-error.js.map +1 -0
  128. package/esm/models/errors/http-client-errors.d.ts +44 -0
  129. package/esm/models/errors/http-client-errors.d.ts.map +1 -0
  130. package/esm/models/errors/http-client-errors.js +56 -0
  131. package/esm/models/errors/http-client-errors.js.map +1 -0
  132. package/esm/models/errors/index.d.ts +7 -0
  133. package/esm/models/errors/index.d.ts.map +1 -0
  134. package/esm/models/errors/index.js +10 -0
  135. package/esm/models/errors/index.js.map +1 -0
  136. package/esm/models/errors/response-validation-error.d.ts +26 -0
  137. package/esm/models/errors/response-validation-error.d.ts.map +1 -0
  138. package/esm/models/errors/response-validation-error.js +37 -0
  139. package/esm/models/errors/response-validation-error.js.map +1 -0
  140. package/esm/models/errors/sdk-validation-error.d.ts +21 -0
  141. package/esm/models/errors/sdk-validation-error.d.ts.map +1 -0
  142. package/esm/models/errors/sdk-validation-error.js +52 -0
  143. package/esm/models/errors/sdk-validation-error.js.map +1 -0
  144. package/esm/models/health-response.d.ts +10 -0
  145. package/esm/models/health-response.d.ts.map +1 -0
  146. package/esm/models/health-response.js +14 -0
  147. package/esm/models/health-response.js.map +1 -0
  148. package/esm/models/index.d.ts +8 -0
  149. package/esm/models/index.d.ts.map +1 -0
  150. package/esm/models/index.js +11 -0
  151. package/esm/models/index.js.map +1 -0
  152. package/esm/models/issue-token-request.d.ts +31 -0
  153. package/esm/models/issue-token-request.d.ts.map +1 -0
  154. package/esm/models/issue-token-request.js +27 -0
  155. package/esm/models/issue-token-request.js.map +1 -0
  156. package/esm/models/jwk-set.d.ts +21 -0
  157. package/esm/models/jwk-set.d.ts.map +1 -0
  158. package/esm/models/jwk-set.js +26 -0
  159. package/esm/models/jwk-set.js.map +1 -0
  160. package/esm/models/operations/index.d.ts +4 -0
  161. package/esm/models/operations/index.d.ts.map +1 -0
  162. package/esm/models/operations/index.js +7 -0
  163. package/esm/models/operations/index.js.map +1 -0
  164. package/esm/models/operations/issue-fluid-token.d.ts +15 -0
  165. package/esm/models/operations/issue-fluid-token.d.ts.map +1 -0
  166. package/esm/models/operations/issue-fluid-token.js +16 -0
  167. package/esm/models/operations/issue-fluid-token.js.map +1 -0
  168. package/esm/models/operations/issue-token.d.ts +15 -0
  169. package/esm/models/operations/issue-token.d.ts.map +1 -0
  170. package/esm/models/operations/issue-token.js +16 -0
  171. package/esm/models/operations/issue-token.js.map +1 -0
  172. package/esm/models/operations/issue-user-token.d.ts +15 -0
  173. package/esm/models/operations/issue-user-token.d.ts.map +1 -0
  174. package/esm/models/operations/issue-user-token.js +16 -0
  175. package/esm/models/operations/issue-user-token.js.map +1 -0
  176. package/esm/models/token-data.d.ts +29 -0
  177. package/esm/models/token-data.d.ts.map +1 -0
  178. package/esm/models/token-data.js +30 -0
  179. package/esm/models/token-data.js.map +1 -0
  180. package/esm/models/user-token-data.d.ts +12 -0
  181. package/esm/models/user-token-data.d.ts.map +1 -0
  182. package/esm/models/user-token-data.js +23 -0
  183. package/esm/models/user-token-data.js.map +1 -0
  184. package/esm/models/user-token-request.d.ts +25 -0
  185. package/esm/models/user-token-request.d.ts.map +1 -0
  186. package/esm/models/user-token-request.js +26 -0
  187. package/esm/models/user-token-request.js.map +1 -0
  188. package/esm/sdk/index.d.ts +2 -0
  189. package/esm/sdk/index.d.ts.map +1 -0
  190. package/esm/sdk/index.js +5 -0
  191. package/esm/sdk/index.js.map +1 -0
  192. package/esm/sdk/metadata.d.ts +16 -0
  193. package/esm/sdk/metadata.d.ts.map +1 -0
  194. package/esm/sdk/metadata.js +25 -0
  195. package/esm/sdk/metadata.js.map +1 -0
  196. package/esm/sdk/sdk.d.ts +10 -0
  197. package/esm/sdk/sdk.d.ts.map +1 -0
  198. package/esm/sdk/sdk.js +17 -0
  199. package/esm/sdk/sdk.js.map +1 -0
  200. package/esm/sdk/tokens.d.ts +63 -0
  201. package/esm/sdk/tokens.d.ts.map +1 -0
  202. package/esm/sdk/tokens.js +74 -0
  203. package/esm/sdk/tokens.js.map +1 -0
  204. package/esm/types/async.d.ts +23 -0
  205. package/esm/types/async.d.ts.map +1 -0
  206. package/esm/types/async.js +28 -0
  207. package/esm/types/async.js.map +1 -0
  208. package/esm/types/blobs.d.ts +4 -0
  209. package/esm/types/blobs.d.ts.map +1 -0
  210. package/esm/types/blobs.js +25 -0
  211. package/esm/types/blobs.js.map +1 -0
  212. package/esm/types/const-date-time.d.ts +3 -0
  213. package/esm/types/const-date-time.d.ts.map +1 -0
  214. package/esm/types/const-date-time.js +10 -0
  215. package/esm/types/const-date-time.js.map +1 -0
  216. package/esm/types/default-to-zero-value.d.ts +12 -0
  217. package/esm/types/default-to-zero-value.d.ts.map +1 -0
  218. package/esm/types/default-to-zero-value.js +31 -0
  219. package/esm/types/default-to-zero-value.js.map +1 -0
  220. package/esm/types/enums.d.ts +9 -0
  221. package/esm/types/enums.d.ts.map +1 -0
  222. package/esm/types/enums.js +27 -0
  223. package/esm/types/enums.js.map +1 -0
  224. package/esm/types/fp.d.ts +31 -0
  225. package/esm/types/fp.d.ts.map +1 -0
  226. package/esm/types/fp.js +31 -0
  227. package/esm/types/fp.js.map +1 -0
  228. package/esm/types/index.d.ts +10 -0
  229. package/esm/types/index.d.ts.map +1 -0
  230. package/esm/types/index.js +10 -0
  231. package/esm/types/index.js.map +1 -0
  232. package/esm/types/operations.d.ts +27 -0
  233. package/esm/types/operations.d.ts.map +1 -0
  234. package/esm/types/operations.js +77 -0
  235. package/esm/types/operations.js.map +1 -0
  236. package/esm/types/primitives.d.ts +11 -0
  237. package/esm/types/primitives.d.ts.map +1 -0
  238. package/esm/types/primitives.js +132 -0
  239. package/esm/types/primitives.js.map +1 -0
  240. package/esm/types/rfcdate.d.ts +21 -0
  241. package/esm/types/rfcdate.d.ts.map +1 -0
  242. package/esm/types/rfcdate.js +43 -0
  243. package/esm/types/rfcdate.js.map +1 -0
  244. package/esm/types/smart-union.d.ts +7 -0
  245. package/esm/types/smart-union.d.ts.map +1 -0
  246. package/esm/types/smart-union.js +117 -0
  247. package/esm/types/smart-union.js.map +1 -0
  248. package/esm/types/streams.d.ts +2 -0
  249. package/esm/types/streams.d.ts.map +1 -0
  250. package/esm/types/streams.js +15 -0
  251. package/esm/types/streams.js.map +1 -0
  252. package/esm/types/unrecognized.d.ts +16 -0
  253. package/esm/types/unrecognized.d.ts.map +1 -0
  254. package/esm/types/unrecognized.js +31 -0
  255. package/esm/types/unrecognized.js.map +1 -0
  256. package/examples/metadataHealthCheck.example.ts +24 -0
  257. package/jsr.json +27 -0
  258. package/package.json +62 -0
  259. package/src/core.ts +13 -0
  260. package/src/funcs/metadata-get-jwks.ts +145 -0
  261. package/src/funcs/metadata-health-check.ts +142 -0
  262. package/src/funcs/tokens-issue-fluid-token.ts +175 -0
  263. package/src/funcs/tokens-issue-token.ts +181 -0
  264. package/src/funcs/tokens-issue-user-token.ts +184 -0
  265. package/src/hooks/hooks.ts +132 -0
  266. package/src/hooks/index.ts +6 -0
  267. package/src/hooks/registration.ts +14 -0
  268. package/src/hooks/types.ts +107 -0
  269. package/src/index.ts +9 -0
  270. package/src/lib/base64.ts +39 -0
  271. package/src/lib/config.ts +94 -0
  272. package/src/lib/dlv.ts +53 -0
  273. package/src/lib/encodings.ts +501 -0
  274. package/src/lib/env.ts +53 -0
  275. package/src/lib/files.ts +82 -0
  276. package/src/lib/http.ts +323 -0
  277. package/src/lib/is-plain-object.ts +43 -0
  278. package/src/lib/logger.ts +9 -0
  279. package/src/lib/matchers.ts +353 -0
  280. package/src/lib/primitives.ts +150 -0
  281. package/src/lib/retries.ts +218 -0
  282. package/src/lib/schemas.ts +94 -0
  283. package/src/lib/sdks.ts +406 -0
  284. package/src/lib/security.ts +236 -0
  285. package/src/lib/url.ts +33 -0
  286. package/src/models/error-response.ts +36 -0
  287. package/src/models/errors/error-response.ts +56 -0
  288. package/src/models/errors/fluidapi-default-error.ts +40 -0
  289. package/src/models/errors/fluidapi-error.ts +35 -0
  290. package/src/models/errors/http-client-errors.ts +62 -0
  291. package/src/models/errors/index.ts +10 -0
  292. package/src/models/errors/response-validation-error.ts +50 -0
  293. package/src/models/errors/sdk-validation-error.ts +54 -0
  294. package/src/models/health-response.ts +31 -0
  295. package/src/models/index.ts +11 -0
  296. package/src/models/issue-token-request.ts +66 -0
  297. package/src/models/jwk-set.ts +57 -0
  298. package/src/models/operations/index.ts +7 -0
  299. package/src/models/operations/issue-fluid-token.ts +37 -0
  300. package/src/models/operations/issue-token.ts +37 -0
  301. package/src/models/operations/issue-user-token.ts +37 -0
  302. package/src/models/token-data.ts +65 -0
  303. package/src/models/user-token-data.ts +45 -0
  304. package/src/models/user-token-request.ts +60 -0
  305. package/src/sdk/index.ts +5 -0
  306. package/src/sdk/metadata.ts +38 -0
  307. package/src/sdk/sdk.ts +19 -0
  308. package/src/sdk/tokens.ts +100 -0
  309. package/src/types/async.ts +68 -0
  310. package/src/types/blobs.ts +33 -0
  311. package/src/types/const-date-time.ts +15 -0
  312. package/src/types/default-to-zero-value.ts +33 -0
  313. package/src/types/enums.ts +45 -0
  314. package/src/types/fp.ts +50 -0
  315. package/src/types/index.ts +13 -0
  316. package/src/types/operations.ts +105 -0
  317. package/src/types/primitives.ts +168 -0
  318. package/src/types/rfcdate.ts +54 -0
  319. package/src/types/smart-union.ts +153 -0
  320. package/src/types/streams.ts +21 -0
  321. package/src/types/unrecognized.ts +35 -0
@@ -0,0 +1,3 @@
1
+ export * from "./hooks.js";
2
+ export * from "./types.js";
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAIA,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}
@@ -0,0 +1,6 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ export * from "./hooks.js";
5
+ export * from "./types.js";
6
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}
@@ -0,0 +1,3 @@
1
+ import { Hooks } from "./types.js";
2
+ export declare function initHooks(hooks: Hooks): void;
3
+ //# sourceMappingURL=registration.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"registration.d.ts","sourceRoot":"","sources":["../../src/hooks/registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AASnC,wBAAgB,SAAS,CAAC,KAAK,EAAE,KAAK,QAIrC"}
@@ -0,0 +1,12 @@
1
+ /*
2
+ * This file is only ever generated once on the first generation and then is free to be modified.
3
+ * Any hooks you wish to add should be registered in the initHooks function. Feel free to define them
4
+ * in this file or in separate files in the hooks folder.
5
+ */
6
+ // @ts-expect-error remove this line when you add your first hook and hooks is used
7
+ export function initHooks(hooks) {
8
+ // Add hooks by calling hooks.register{ClientInit/BeforeCreateRequest/BeforeRequest/AfterSuccess/AfterError}Hook
9
+ // with an instance of a hook that implements that specific Hook interface
10
+ // Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance
11
+ }
12
+ //# sourceMappingURL=registration.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"registration.js","sourceRoot":"","sources":["../../src/hooks/registration.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AAEH,mFAAmF;AACnF,MAAM,UAAU,SAAS,CAAC,KAAY,EAAE;IACtC,gHAAgH;IAChH,0EAA0E;IAC1E,4FAA4F;AAHrD,CAIxC"}
@@ -0,0 +1,76 @@
1
+ import { SDKOptions } from "../lib/config.js";
2
+ import { RequestInput } from "../lib/http.js";
3
+ import { RetryConfig } from "../lib/retries.js";
4
+ import { SecurityState } from "../lib/security.js";
5
+ export type HookContext = {
6
+ baseURL: string | URL;
7
+ operationID: string;
8
+ oAuth2Scopes: string[] | null;
9
+ securitySource?: any | (() => Promise<any>);
10
+ retryConfig: RetryConfig;
11
+ resolvedSecurity: SecurityState | null;
12
+ options: SDKOptions;
13
+ };
14
+ export type Awaitable<T> = T | Promise<T>;
15
+ export type BeforeCreateRequestContext = HookContext & {};
16
+ export type BeforeRequestContext = HookContext & {};
17
+ export type AfterSuccessContext = HookContext & {};
18
+ export type AfterErrorContext = HookContext & {};
19
+ /**
20
+ * SDKInitHook is called when the SDK is initializing. The
21
+ * hook can return a new baseURL and HTTP client to be used by the SDK.
22
+ */
23
+ export interface SDKInitHook {
24
+ sdkInit: (opts: SDKOptions) => SDKOptions;
25
+ }
26
+ export interface BeforeCreateRequestHook {
27
+ /**
28
+ * A hook that is called before the SDK creates a `Request` object. The hook
29
+ * can modify how a request is constructed since certain modifications, like
30
+ * changing the request URL, cannot be done on a request object directly.
31
+ */
32
+ beforeCreateRequest: (hookCtx: BeforeCreateRequestContext, input: RequestInput) => RequestInput;
33
+ }
34
+ export interface BeforeRequestHook {
35
+ /**
36
+ * A hook that is called before the SDK sends a request. The hook can
37
+ * introduce instrumentation code such as logging, tracing and metrics or
38
+ * replace the request before it is sent or throw an error to stop the
39
+ * request from being sent.
40
+ */
41
+ beforeRequest: (hookCtx: BeforeRequestContext, request: Request) => Awaitable<Request>;
42
+ }
43
+ export interface AfterSuccessHook {
44
+ /**
45
+ * A hook that is called after the SDK receives a response. The hook can
46
+ * introduce instrumentation code such as logging, tracing and metrics or
47
+ * modify the response before it is handled or throw an error to stop the
48
+ * response from being handled.
49
+ */
50
+ afterSuccess: (hookCtx: AfterSuccessContext, response: Response) => Awaitable<Response>;
51
+ }
52
+ export interface AfterErrorHook {
53
+ /**
54
+ * A hook that is called after the SDK encounters an error, or a
55
+ * non-successful response. The hook can introduce instrumentation code such
56
+ * as logging, tracing and metrics or modify the response or error values.
57
+ */
58
+ afterError: (hookCtx: AfterErrorContext, response: Response | null, error: unknown) => Awaitable<{
59
+ response: Response | null;
60
+ error: unknown;
61
+ }>;
62
+ }
63
+ export interface Hooks {
64
+ /** Registers a hook to be used by the SDK for initialization event. */
65
+ registerSDKInitHook(hook: SDKInitHook): void;
66
+ /** Registers a hook to be used by the SDK for to modify `Request` construction. */
67
+ registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook): void;
68
+ /** Registers a hook to be used by the SDK for the before request event. */
69
+ registerBeforeRequestHook(hook: BeforeRequestHook): void;
70
+ /** Registers a hook to be used by the SDK for the after success event. */
71
+ registerAfterSuccessHook(hook: AfterSuccessHook): void;
72
+ /** Registers a hook to be used by the SDK for the after error event. */
73
+ registerAfterErrorHook(hook: AfterErrorHook): void;
74
+ }
75
+ export type Hook = SDKInitHook | BeforeCreateRequestHook | BeforeRequestHook | AfterSuccessHook | AfterErrorHook;
76
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/hooks/types.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC9B,cAAc,CAAC,EAAE,GAAG,GAAG,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5C,WAAW,EAAE,WAAW,CAAC;IACzB,gBAAgB,EAAE,aAAa,GAAG,IAAI,CAAC;IACvC,OAAO,EAAE,UAAU,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAE1C,MAAM,MAAM,0BAA0B,GAAG,WAAW,GAAG,EAAE,CAAC;AAC1D,MAAM,MAAM,oBAAoB,GAAG,WAAW,GAAG,EAAE,CAAC;AACpD,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG,EAAE,CAAC;AACnD,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,EAAE,CAAC;AAEjD;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,UAAU,CAAC;CAC3C;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,mBAAmB,EAAE,CACnB,OAAO,EAAE,0BAA0B,EACnC,KAAK,EAAE,YAAY,KAChB,YAAY,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,aAAa,EAAE,CACb,OAAO,EAAE,oBAAoB,EAC7B,OAAO,EAAE,OAAO,KACb,SAAS,CAAC,OAAO,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,YAAY,EAAE,CACZ,OAAO,EAAE,mBAAmB,EAC5B,QAAQ,EAAE,QAAQ,KACf,SAAS,CAAC,QAAQ,CAAC,CAAC;CAC1B;AAED,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,UAAU,EAAE,CACV,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,QAAQ,GAAG,IAAI,EACzB,KAAK,EAAE,OAAO,KACX,SAAS,CAAC;QACb,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;QAC1B,KAAK,EAAE,OAAO,CAAC;KAChB,CAAC,CAAC;CACJ;AAED,MAAM,WAAW,KAAK;IACpB,uEAAuE;IACvE,mBAAmB,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC;IAC7C,mFAAmF;IACnF,+BAA+B,CAAC,IAAI,EAAE,uBAAuB,GAAG,IAAI,CAAC;IACrE,2EAA2E;IAC3E,yBAAyB,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,CAAC;IACzD,0EAA0E;IAC1E,wBAAwB,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACvD,wEAAwE;IACxE,sBAAsB,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;CACpD;AAED,MAAM,MAAM,IAAI,GACZ,WAAW,GACX,uBAAuB,GACvB,iBAAiB,GACjB,gBAAgB,GAChB,cAAc,CAAC"}
@@ -0,0 +1,5 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ export {};
5
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/hooks/types.ts"],"names":[],"mappings":"AAAA;;GAEG"}
package/esm/index.d.ts ADDED
@@ -0,0 +1,6 @@
1
+ export * from "./lib/config.js";
2
+ export * as files from "./lib/files.js";
3
+ export { HTTPClient } from "./lib/http.js";
4
+ export type { Fetcher, HTTPClientOptions } from "./lib/http.js";
5
+ export * from "./sdk/sdk.js";
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,iBAAiB,CAAC;AAChC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,YAAY,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAChE,cAAc,cAAc,CAAC"}
package/esm/index.js ADDED
@@ -0,0 +1,8 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ export * from "./lib/config.js";
5
+ export * as files from "./lib/files.js";
6
+ export { HTTPClient } from "./lib/http.js";
7
+ export * from "./sdk/sdk.js";
8
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,iBAAiB,CAAC;AAChC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,cAAc,cAAc,CAAC"}
@@ -0,0 +1,10 @@
1
+ import * as z from "zod/v4-mini";
2
+ export declare function bytesToBase64(u8arr: Uint8Array): string;
3
+ export declare function bytesFromBase64(encoded: string): Uint8Array;
4
+ export declare function stringToBytes(str: string): Uint8Array;
5
+ export declare function stringFromBytes(u8arr: Uint8Array): string;
6
+ export declare function stringToBase64(str: string): string;
7
+ export declare function stringFromBase64(b64str: string): string;
8
+ export declare const zodOutbound: z.ZodMiniUnion<readonly [z.ZodMiniCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>, z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<Uint8Array<ArrayBufferLike>, string>>]>;
9
+ export declare const zodInbound: z.ZodMiniUnion<readonly [z.ZodMiniCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>, z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<Uint8Array<ArrayBufferLike>, string>>]>;
10
+ //# sourceMappingURL=base64.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"base64.d.ts","sourceRoot":"","sources":["../../src/lib/base64.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,aAAa,CAAC;AAEjC,wBAAgB,aAAa,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAEvD;AAED,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,CAE3D;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAErD;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAEzD;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAElD;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED,eAAO,MAAM,WAAW,uMAGtB,CAAC;AAEH,eAAO,MAAM,UAAU,uMAGrB,CAAC"}
@@ -0,0 +1,31 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ import * as z from "zod/v4-mini";
5
+ export function bytesToBase64(u8arr) {
6
+ return btoa(String.fromCodePoint(...u8arr));
7
+ }
8
+ export function bytesFromBase64(encoded) {
9
+ return Uint8Array.from(atob(encoded), (c) => c.charCodeAt(0));
10
+ }
11
+ export function stringToBytes(str) {
12
+ return new TextEncoder().encode(str);
13
+ }
14
+ export function stringFromBytes(u8arr) {
15
+ return new TextDecoder().decode(u8arr);
16
+ }
17
+ export function stringToBase64(str) {
18
+ return bytesToBase64(stringToBytes(str));
19
+ }
20
+ export function stringFromBase64(b64str) {
21
+ return stringFromBytes(bytesFromBase64(b64str));
22
+ }
23
+ export const zodOutbound = z.union([
24
+ z.custom(x => x instanceof Uint8Array),
25
+ z.pipe(z.string(), z.transform(stringToBytes)),
26
+ ]);
27
+ export const zodInbound = z.union([
28
+ z.custom(x => x instanceof Uint8Array),
29
+ z.pipe(z.string(), z.transform(bytesFromBase64)),
30
+ ]);
31
+ //# sourceMappingURL=base64.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"base64.js","sourceRoot":"","sources":["../../src/lib/base64.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,aAAa,CAAC;AAEjC,MAAM,UAAU,aAAa,CAAC,KAAiB,EAAU;IACvD,OAAO,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;AAAA,CAC7C;AAED,MAAM,UAAU,eAAe,CAAC,OAAe,EAAc;IAC3D,OAAO,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAAA,CAC/D;AAED,MAAM,UAAU,aAAa,CAAC,GAAW,EAAc;IACrD,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAAA,CACtC;AAED,MAAM,UAAU,eAAe,CAAC,KAAiB,EAAU;IACzD,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAAA,CACxC;AAED,MAAM,UAAU,cAAc,CAAC,GAAW,EAAU;IAClD,OAAO,aAAa,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;AAAA,CAC1C;AAED,MAAM,UAAU,gBAAgB,CAAC,MAAc,EAAU;IACvD,OAAO,eAAe,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC;AAAA,CACjD;AAED,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC;IACjC,CAAC,CAAC,MAAM,CAAa,CAAC,CAAC,EAAE,CAAC,CAAC,YAAY,UAAU,CAAC;IAClD,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;CAC/C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC;IAChC,CAAC,CAAC,MAAM,CAAa,CAAC,CAAC,EAAE,CAAC,CAAC,YAAY,UAAU,CAAC;IAClD,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;CACjD,CAAC,CAAC"}
@@ -0,0 +1,57 @@
1
+ import { ClosedEnum } from "../types/enums.js";
2
+ import { HTTPClient } from "./http.js";
3
+ import { Logger } from "./logger.js";
4
+ import { RetryConfig } from "./retries.js";
5
+ /**
6
+ * Contains the list of servers available to the SDK
7
+ */
8
+ export declare const ServerList: readonly ["{scheme}://{host}"];
9
+ export declare const ServerScheme: {
10
+ readonly Http: "http";
11
+ readonly Https: "https";
12
+ };
13
+ export type ServerScheme = ClosedEnum<typeof ServerScheme>;
14
+ export declare const ServerHost: {
15
+ readonly IdDevApiFluidapiIo: "id.dev.api.fluidapi.io";
16
+ readonly IdApiFluidapiIo: "id.api.fluidapi.io";
17
+ readonly Localhost9999: "localhost:9999";
18
+ };
19
+ export type ServerHost = ClosedEnum<typeof ServerHost>;
20
+ export type SDKOptions = {
21
+ httpClient?: HTTPClient;
22
+ /**
23
+ * Allows overriding the default server used by the SDK
24
+ */
25
+ serverIdx?: number | undefined;
26
+ /**
27
+ * Sets the scheme variable for url substitution
28
+ */
29
+ scheme?: ServerScheme | undefined;
30
+ /**
31
+ * Sets the host variable for url substitution
32
+ */
33
+ host?: ServerHost | undefined;
34
+ /**
35
+ * Allows overriding the default server URL used by the SDK
36
+ */
37
+ serverURL?: string | undefined;
38
+ /**
39
+ * Allows overriding the default user agent used by the SDK
40
+ */
41
+ userAgent?: string | undefined;
42
+ /**
43
+ * Allows overriding the default retry config used by the SDK
44
+ */
45
+ retryConfig?: RetryConfig;
46
+ timeoutMs?: number;
47
+ debugLogger?: Logger;
48
+ };
49
+ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
50
+ export declare const SDK_METADATA: {
51
+ readonly language: "typescript";
52
+ readonly openapiDocVersion: "1.0.0";
53
+ readonly sdkVersion: "0.0.3";
54
+ readonly genVersion: "2.865.2";
55
+ readonly userAgent: "speakeasy-sdk/typescript 0.0.3 2.865.2 1.0.0 fluidapi";
56
+ };
57
+ //# sourceMappingURL=config.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/lib/config.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAG3C;;GAEG;AACH,eAAO,MAAM,UAAU,gCAKb,CAAC;AAEX,eAAO,MAAM,YAAY;;;CAGf,CAAC;AACX,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAE3D,eAAO,MAAM,UAAU;;;;CAIb,CAAC;AACX,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;AAEvD,MAAM,MAAM,UAAU,GAAG;IACvB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,UAAU,GAAG,GAAG,GAAG,IAAI,CAsBpE;AAED,eAAO,MAAM,YAAY;;;;;;CAMf,CAAC"}
@@ -0,0 +1,50 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ import { pathToFunc } from "./url.js";
5
+ /**
6
+ * Contains the list of servers available to the SDK
7
+ */
8
+ export const ServerList = [
9
+ /**
10
+ * Configurable environment
11
+ */
12
+ "{scheme}://{host}",
13
+ ];
14
+ export const ServerScheme = {
15
+ Http: "http",
16
+ Https: "https",
17
+ };
18
+ export const ServerHost = {
19
+ IdDevApiFluidapiIo: "id.dev.api.fluidapi.io",
20
+ IdApiFluidapiIo: "id.api.fluidapi.io",
21
+ Localhost9999: "localhost:9999",
22
+ };
23
+ export function serverURLFromOptions(options) {
24
+ let serverURL = options.serverURL;
25
+ const serverParams = [
26
+ {
27
+ "scheme": options.scheme ?? "https",
28
+ "host": options.host ?? "id.dev.api.fluidapi.io",
29
+ },
30
+ ];
31
+ let params = {};
32
+ if (!serverURL) {
33
+ const serverIdx = options.serverIdx ?? 0;
34
+ if (serverIdx < 0 || serverIdx >= ServerList.length) {
35
+ throw new Error(`Invalid server index ${serverIdx}`);
36
+ }
37
+ serverURL = ServerList[serverIdx] || "";
38
+ params = serverParams[serverIdx] || {};
39
+ }
40
+ const u = pathToFunc(serverURL)(params);
41
+ return new URL(u);
42
+ }
43
+ export const SDK_METADATA = {
44
+ language: "typescript",
45
+ openapiDocVersion: "1.0.0",
46
+ sdkVersion: "0.0.3",
47
+ genVersion: "2.865.2",
48
+ userAgent: "speakeasy-sdk/typescript 0.0.3 2.865.2 1.0.0 fluidapi",
49
+ };
50
+ //# sourceMappingURL=config.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/lib/config.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,OAAO,EAAU,UAAU,EAAE,MAAM,UAAU,CAAC;AAE9C;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB;;OAEG;IACH,mBAAmB;CACX,CAAC;AAEX,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;CACN,CAAC;AAGX,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,kBAAkB,EAAE,wBAAwB;IAC5C,eAAe,EAAE,oBAAoB;IACrC,aAAa,EAAE,gBAAgB;CACvB,CAAC;AAiCX,MAAM,UAAU,oBAAoB,CAAC,OAAmB,EAAc;IACpE,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IAElC,MAAM,YAAY,GAAa;QAC7B;YACE,QAAQ,EAAE,OAAO,CAAC,MAAM,IAAI,OAAO;YACnC,MAAM,EAAE,OAAO,CAAC,IAAI,IAAI,wBAAwB;SACjD;KACF,CAAC;IACF,IAAI,MAAM,GAAW,EAAE,CAAC;IAExB,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,CAAC,CAAC;QACzC,IAAI,SAAS,GAAG,CAAC,IAAI,SAAS,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;YACpD,MAAM,IAAI,KAAK,CAAC,wBAAwB,SAAS,EAAE,CAAC,CAAC;QACvD,CAAC;QACD,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QACxC,MAAM,GAAG,YAAY,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IACzC,CAAC;IAED,MAAM,CAAC,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;IACxC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;AAAA,CACnB;AAED,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,QAAQ,EAAE,YAAY;IACtB,iBAAiB,EAAE,OAAO;IAC1B,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,SAAS;IACrB,SAAS,EAAE,uDAAuD;CAC1D,CAAC"}
@@ -0,0 +1,14 @@
1
+ /**
2
+ * @param obj The object to walk
3
+ * @param key The key path to walk the object with
4
+ * @param def A default value to return if the result is undefined
5
+ *
6
+ * @example
7
+ * dlv(obj, "a.b.c.d")
8
+ * @example
9
+ * dlv(object, ["a", "b", "c", "d"])
10
+ * @example
11
+ * dlv(object, "foo.bar.baz", "Hello, default value!")
12
+ */
13
+ export declare function dlv<T = any>(obj: any, key: string | string[], def?: T, p?: number, undef?: never): T | undefined;
14
+ //# sourceMappingURL=dlv.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"dlv.d.ts","sourceRoot":"","sources":["../../src/lib/dlv.ts"],"names":[],"mappings":"AA2BA;;;;;;;;;;;GAWG;AACH,wBAAgB,GAAG,CAAC,CAAC,GAAG,GAAG,EACzB,GAAG,EAAE,GAAG,EACR,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EACtB,GAAG,CAAC,EAAE,CAAC,EACP,CAAC,CAAC,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,KAAK,GACZ,CAAC,GAAG,SAAS,CAOf"}
package/esm/lib/dlv.js ADDED
@@ -0,0 +1,46 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ /*
5
+ MIT License
6
+
7
+ Copyright (c) 2024 Jason Miller <jason@developit.ca> (http://jasonformat.com)
8
+
9
+ Permission is hereby granted, free of charge, to any person obtaining a copy of
10
+ this software and associated documentation files (the "Software"), to deal in
11
+ the Software without restriction, including without limitation the rights to
12
+ use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
13
+ the Software, and to permit persons to whom the Software is furnished to do so,
14
+ subject to the following conditions:
15
+
16
+ The above copyright notice and this permission notice shall be included in all
17
+ copies or substantial portions of the Software.
18
+
19
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
21
+ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
22
+ COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
23
+ IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
24
+ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25
+ */
26
+ /**
27
+ * @param obj The object to walk
28
+ * @param key The key path to walk the object with
29
+ * @param def A default value to return if the result is undefined
30
+ *
31
+ * @example
32
+ * dlv(obj, "a.b.c.d")
33
+ * @example
34
+ * dlv(object, ["a", "b", "c", "d"])
35
+ * @example
36
+ * dlv(object, "foo.bar.baz", "Hello, default value!")
37
+ */
38
+ export function dlv(obj, key, def, p, undef) {
39
+ key = Array.isArray(key) ? key : key.split(".");
40
+ for (p = 0; p < key.length; p++) {
41
+ const k = key[p];
42
+ obj = k != null && obj ? obj[k] : undef;
43
+ }
44
+ return obj === undef ? def : obj;
45
+ }
46
+ //# sourceMappingURL=dlv.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"dlv.js","sourceRoot":"","sources":["../../src/lib/dlv.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;;;;;;;;;;;;;;;;;EAqBE;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,GAAG,CACjB,GAAQ,EACR,GAAsB,EACtB,GAAO,EACP,CAAU,EACV,KAAa,EACE;IACf,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChD,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAChC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QACjB,GAAG,GAAG,CAAC,IAAI,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC1C,CAAC;IACD,OAAO,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;AAAA,CAClC"}
@@ -0,0 +1,53 @@
1
+ export declare class EncodingError extends Error {
2
+ constructor(message: string);
3
+ }
4
+ export declare function encodeMatrix(key: string, value: unknown, options?: {
5
+ explode?: boolean;
6
+ charEncoding?: "percent" | "none";
7
+ }): string | undefined;
8
+ export declare function encodeLabel(key: string, value: unknown, options?: {
9
+ explode?: boolean;
10
+ charEncoding?: "percent" | "none";
11
+ }): string | undefined;
12
+ type FormEncoder = (key: string, value: unknown, options?: {
13
+ explode?: boolean;
14
+ charEncoding?: "percent" | "none";
15
+ }) => string | undefined;
16
+ export declare const encodeForm: FormEncoder;
17
+ export declare const encodeSpaceDelimited: FormEncoder;
18
+ export declare const encodePipeDelimited: FormEncoder;
19
+ export declare function encodeBodyForm(key: string, value: unknown, options?: {
20
+ explode?: boolean;
21
+ charEncoding?: "percent" | "none";
22
+ }): string;
23
+ export declare function encodeDeepObject(key: string, value: unknown, options?: {
24
+ charEncoding?: "percent" | "none";
25
+ }): string | undefined;
26
+ export declare function encodeDeepObjectObject(key: string, value: unknown, options?: {
27
+ charEncoding?: "percent" | "none";
28
+ }): string | undefined;
29
+ export declare function encodeJSON(key: string, value: unknown, options?: {
30
+ explode?: boolean;
31
+ charEncoding?: "percent" | "none";
32
+ }): string | undefined;
33
+ export declare const encodeSimple: (key: string, value: unknown, options?: {
34
+ explode?: boolean;
35
+ charEncoding?: "none" | "percent";
36
+ } | undefined) => string | undefined;
37
+ export declare function queryJoin(...args: (string | undefined)[]): string;
38
+ type QueryEncoderOptions = {
39
+ explode?: boolean;
40
+ charEncoding?: "percent" | "none";
41
+ allowEmptyValue?: string[];
42
+ };
43
+ type QueryEncoder = (key: string, value: unknown, options?: QueryEncoderOptions) => string | undefined;
44
+ type BulkQueryEncoder = (values: Record<string, unknown>, options?: QueryEncoderOptions) => string;
45
+ export declare function queryEncoder(f: QueryEncoder): BulkQueryEncoder;
46
+ export declare const encodeJSONQuery: BulkQueryEncoder;
47
+ export declare const encodeFormQuery: BulkQueryEncoder;
48
+ export declare const encodeSpaceDelimitedQuery: BulkQueryEncoder;
49
+ export declare const encodePipeDelimitedQuery: BulkQueryEncoder;
50
+ export declare const encodeDeepObjectQuery: BulkQueryEncoder;
51
+ export declare function appendForm(fd: FormData, key: string, value: unknown, fileName?: string): void;
52
+ export {};
53
+ //# sourceMappingURL=encodings.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"encodings.d.ts","sourceRoot":"","sources":["../../src/lib/encodings.ts"],"names":[],"mappings":"AAOA,qBAAa,aAAc,SAAQ,KAAK;IACtC,YAAY,OAAO,EAAE,MAAM,EAG1B;CACF;AAED,wBAAgB,YAAY,CAC1B,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;CAAE,GACjE,MAAM,GAAG,SAAS,CAoDpB;AAED,wBAAgB,WAAW,CACzB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;CAAE,GACjE,MAAM,GAAG,SAAS,CAsCpB;AAED,KAAK,WAAW,GAAG,CACjB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;CAAE,KAC/D,MAAM,GAAG,SAAS,CAAC;AA2DxB,eAAO,MAAM,UAAU,aAAmB,CAAC;AAC3C,eAAO,MAAM,oBAAoB,aAAmB,CAAC;AACrD,eAAO,MAAM,mBAAmB,aAAmB,CAAC;AAEpD,wBAAgB,cAAc,CAC5B,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;CAAE,GACjE,MAAM,CAqCR;AAED,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE;IAAE,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;CAAE,GAC9C,MAAM,GAAG,SAAS,CAYpB;AAED,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE;IAAE,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;CAAE,GAC9C,MAAM,GAAG,SAAS,CAuCpB;AAED,wBAAgB,UAAU,CACxB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;CAAE,GACjE,MAAM,GAAG,SAAS,CAYpB;AAED,eAAO,MAAM,YAAY;;;oCAwCxB,CAAC;AA2EF,wBAAgB,SAAS,CAAC,GAAG,IAAI,EAAE,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,GAAG,MAAM,CAEjE;AAED,KAAK,mBAAmB,GAAG;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;IAClC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;CAC5B,CAAC;AAEF,KAAK,YAAY,GAAG,CAClB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,mBAAmB,KAC1B,MAAM,GAAG,SAAS,CAAC;AAExB,KAAK,gBAAgB,GAAG,CACtB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,OAAO,CAAC,EAAE,mBAAmB,KAC1B,MAAM,CAAC;AAEZ,wBAAgB,YAAY,CAAC,CAAC,EAAE,YAAY,GAAG,gBAAgB,CA8B9D;AAED,eAAO,MAAM,eAAe,kBAA2B,CAAC;AACxD,eAAO,MAAM,eAAe,kBAA2B,CAAC;AACxD,eAAO,MAAM,yBAAyB,kBAAqC,CAAC;AAC5E,eAAO,MAAM,wBAAwB,kBAAoC,CAAC;AAC1E,eAAO,MAAM,qBAAqB,kBAAiC,CAAC;AAEpE,wBAAgB,UAAU,CACxB,EAAE,EAAE,QAAQ,EACZ,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,QAAQ,CAAC,EAAE,MAAM,GAChB,IAAI,CAcN"}