@usehercules/sdk 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +31 -0
- package/LICENSE +201 -0
- package/README.md +414 -0
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/client.d.mts +189 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +189 -0
- package/client.d.ts.map +1 -0
- package/client.js +481 -0
- package/client.js.map +1 -0
- package/client.mjs +477 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/pagination.d.mts +55 -0
- package/core/pagination.d.mts.map +1 -0
- package/core/pagination.d.ts +55 -0
- package/core/pagination.d.ts.map +1 -0
- package/core/pagination.js +115 -0
- package/core/pagination.js.map +1 -0
- package/core/pagination.mjs +109 -0
- package/core/pagination.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +2 -0
- package/error.d.ts.map +1 -0
- package/error.js +6 -0
- package/error.js.map +1 -0
- package/error.mjs +2 -0
- package/error.mjs.map +1 -0
- package/index.d.mts +7 -0
- package/index.d.mts.map +1 -0
- package/index.d.ts +7 -0
- package/index.d.ts.map +1 -0
- package/index.js +32 -0
- package/index.js.map +1 -0
- package/index.mjs +8 -0
- package/index.mjs.map +1 -0
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +35 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +32 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/request-options.d.mts +75 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +75 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +85 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +79 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +7 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +7 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +11 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +8 -0
- package/internal/utils.mjs.map +1 -0
- package/package.json +147 -0
- package/pagination.d.mts +2 -0
- package/pagination.d.mts.map +1 -0
- package/pagination.d.ts +2 -0
- package/pagination.d.ts.map +1 -0
- package/pagination.js +6 -0
- package/pagination.js.map +1 -0
- package/pagination.mjs +2 -0
- package/pagination.mjs.map +1 -0
- package/resource.d.mts +2 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +2 -0
- package/resource.d.ts.map +1 -0
- package/resource.js +6 -0
- package/resource.js.map +1 -0
- package/resource.mjs +2 -0
- package/resource.mjs.map +1 -0
- package/resources/beta/beta.d.mts +10 -0
- package/resources/beta/beta.d.mts.map +1 -0
- package/resources/beta/beta.d.ts +10 -0
- package/resources/beta/beta.d.ts.map +1 -0
- package/resources/beta/beta.js +17 -0
- package/resources/beta/beta.js.map +1 -0
- package/resources/beta/beta.mjs +12 -0
- package/resources/beta/beta.mjs.map +1 -0
- package/resources/beta/index.d.mts +3 -0
- package/resources/beta/index.d.mts.map +1 -0
- package/resources/beta/index.d.ts +3 -0
- package/resources/beta/index.d.ts.map +1 -0
- package/resources/beta/index.js +9 -0
- package/resources/beta/index.js.map +1 -0
- package/resources/beta/index.mjs +4 -0
- package/resources/beta/index.mjs.map +1 -0
- package/resources/beta/subscriptions/coupons.d.mts +151 -0
- package/resources/beta/subscriptions/coupons.d.mts.map +1 -0
- package/resources/beta/subscriptions/coupons.d.ts +151 -0
- package/resources/beta/subscriptions/coupons.d.ts.map +1 -0
- package/resources/beta/subscriptions/coupons.js +51 -0
- package/resources/beta/subscriptions/coupons.js.map +1 -0
- package/resources/beta/subscriptions/coupons.mjs +47 -0
- package/resources/beta/subscriptions/coupons.mjs.map +1 -0
- package/resources/beta/subscriptions/customers.d.mts +93 -0
- package/resources/beta/subscriptions/customers.d.mts.map +1 -0
- package/resources/beta/subscriptions/customers.d.ts +93 -0
- package/resources/beta/subscriptions/customers.d.ts.map +1 -0
- package/resources/beta/subscriptions/customers.js +57 -0
- package/resources/beta/subscriptions/customers.js.map +1 -0
- package/resources/beta/subscriptions/customers.mjs +53 -0
- package/resources/beta/subscriptions/customers.mjs.map +1 -0
- package/resources/beta/subscriptions/entitlements.d.mts +70 -0
- package/resources/beta/subscriptions/entitlements.d.mts.map +1 -0
- package/resources/beta/subscriptions/entitlements.d.ts +70 -0
- package/resources/beta/subscriptions/entitlements.d.ts.map +1 -0
- package/resources/beta/subscriptions/entitlements.js +38 -0
- package/resources/beta/subscriptions/entitlements.js.map +1 -0
- package/resources/beta/subscriptions/entitlements.mjs +34 -0
- package/resources/beta/subscriptions/entitlements.mjs.map +1 -0
- package/resources/beta/subscriptions/index.d.mts +6 -0
- package/resources/beta/subscriptions/index.d.mts.map +1 -0
- package/resources/beta/subscriptions/index.d.ts +6 -0
- package/resources/beta/subscriptions/index.d.ts.map +1 -0
- package/resources/beta/subscriptions/index.js +15 -0
- package/resources/beta/subscriptions/index.js.map +1 -0
- package/resources/beta/subscriptions/index.mjs +7 -0
- package/resources/beta/subscriptions/index.mjs.map +1 -0
- package/resources/beta/subscriptions/plans/entitlements.d.mts +48 -0
- package/resources/beta/subscriptions/plans/entitlements.d.mts.map +1 -0
- package/resources/beta/subscriptions/plans/entitlements.d.ts +48 -0
- package/resources/beta/subscriptions/plans/entitlements.d.ts.map +1 -0
- package/resources/beta/subscriptions/plans/entitlements.js +34 -0
- package/resources/beta/subscriptions/plans/entitlements.js.map +1 -0
- package/resources/beta/subscriptions/plans/entitlements.mjs +30 -0
- package/resources/beta/subscriptions/plans/entitlements.mjs.map +1 -0
- package/resources/beta/subscriptions/plans/index.d.mts +3 -0
- package/resources/beta/subscriptions/plans/index.d.mts.map +1 -0
- package/resources/beta/subscriptions/plans/index.d.ts +3 -0
- package/resources/beta/subscriptions/plans/index.d.ts.map +1 -0
- package/resources/beta/subscriptions/plans/index.js +9 -0
- package/resources/beta/subscriptions/plans/index.js.map +1 -0
- package/resources/beta/subscriptions/plans/index.mjs +4 -0
- package/resources/beta/subscriptions/plans/index.mjs.map +1 -0
- package/resources/beta/subscriptions/plans/plans.d.mts +87 -0
- package/resources/beta/subscriptions/plans/plans.d.mts.map +1 -0
- package/resources/beta/subscriptions/plans/plans.d.ts +87 -0
- package/resources/beta/subscriptions/plans/plans.d.ts.map +1 -0
- package/resources/beta/subscriptions/plans/plans.js +49 -0
- package/resources/beta/subscriptions/plans/plans.js.map +1 -0
- package/resources/beta/subscriptions/plans/plans.mjs +44 -0
- package/resources/beta/subscriptions/plans/plans.mjs.map +1 -0
- package/resources/beta/subscriptions/plans.d.mts +2 -0
- package/resources/beta/subscriptions/plans.d.mts.map +1 -0
- package/resources/beta/subscriptions/plans.d.ts +2 -0
- package/resources/beta/subscriptions/plans.d.ts.map +1 -0
- package/resources/beta/subscriptions/plans.js +6 -0
- package/resources/beta/subscriptions/plans.js.map +1 -0
- package/resources/beta/subscriptions/plans.mjs +3 -0
- package/resources/beta/subscriptions/plans.mjs.map +1 -0
- package/resources/beta/subscriptions/subscriptions.d.mts +130 -0
- package/resources/beta/subscriptions/subscriptions.d.mts.map +1 -0
- package/resources/beta/subscriptions/subscriptions.d.ts +130 -0
- package/resources/beta/subscriptions/subscriptions.d.ts.map +1 -0
- package/resources/beta/subscriptions/subscriptions.js +47 -0
- package/resources/beta/subscriptions/subscriptions.js.map +1 -0
- package/resources/beta/subscriptions/subscriptions.mjs +42 -0
- package/resources/beta/subscriptions/subscriptions.mjs.map +1 -0
- package/resources/beta/subscriptions.d.mts +2 -0
- package/resources/beta/subscriptions.d.mts.map +1 -0
- package/resources/beta/subscriptions.d.ts +2 -0
- package/resources/beta/subscriptions.d.ts.map +1 -0
- package/resources/beta/subscriptions.js +6 -0
- package/resources/beta/subscriptions.js.map +1 -0
- package/resources/beta/subscriptions.mjs +3 -0
- package/resources/beta/subscriptions.mjs.map +1 -0
- package/resources/beta.d.mts +2 -0
- package/resources/beta.d.mts.map +1 -0
- package/resources/beta.d.ts +2 -0
- package/resources/beta.d.ts.map +1 -0
- package/resources/beta.js +6 -0
- package/resources/beta.js.map +1 -0
- package/resources/beta.mjs +3 -0
- package/resources/beta.mjs.map +1 -0
- package/resources/index.d.mts +2 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +2 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +7 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +3 -0
- package/resources/index.mjs.map +1 -0
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts +2 -0
- package/resources.d.ts.map +1 -0
- package/resources.js +5 -0
- package/resources.js.map +1 -0
- package/resources.mjs +2 -0
- package/resources.mjs.map +1 -0
- package/src/api-promise.ts +2 -0
- package/src/client.ts +766 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/pagination.ts +177 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -0
- package/src/index.ts +23 -0
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +50 -0
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +126 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +8 -0
- package/src/lib/.keep +4 -0
- package/src/pagination.ts +2 -0
- package/src/resource.ts +2 -0
- package/src/resources/beta/beta.ts +31 -0
- package/src/resources/beta/index.ts +12 -0
- package/src/resources/beta/subscriptions/coupons.ts +221 -0
- package/src/resources/beta/subscriptions/customers.ts +168 -0
- package/src/resources/beta/subscriptions/entitlements.ts +113 -0
- package/src/resources/beta/subscriptions/index.ts +48 -0
- package/src/resources/beta/subscriptions/plans/entitlements.ts +88 -0
- package/src/resources/beta/subscriptions/plans/index.ts +18 -0
- package/src/resources/beta/subscriptions/plans/plans.ts +159 -0
- package/src/resources/beta/subscriptions/plans.ts +3 -0
- package/src/resources/beta/subscriptions/subscriptions.ts +245 -0
- package/src/resources/beta/subscriptions.ts +3 -0
- package/src/resources/beta.ts +3 -0
- package/src/resources/index.ts +3 -0
- package/src/resources.ts +1 -0
- package/src/tsconfig.json +11 -0
- package/src/uploads.ts +2 -0
- package/src/version.ts +1 -0
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +2 -0
- package/uploads.d.ts.map +1 -0
- package/uploads.js +6 -0
- package/uploads.js.map +1 -0
- package/uploads.mjs +2 -0
- package/uploads.mjs.map +1 -0
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +2 -0
- package/version.d.ts.map +1 -0
- package/version.js +5 -0
- package/version.js.map +1 -0
- package/version.mjs +2 -0
- package/version.mjs.map +1 -0
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
import { BlobPart, getName, makeFile, isAsyncIterable } from './uploads';
|
|
2
|
+
import type { FilePropertyBag } from './builtin-types';
|
|
3
|
+
import { checkFileSupport } from './uploads';
|
|
4
|
+
|
|
5
|
+
type BlobLikePart = string | ArrayBuffer | ArrayBufferView | BlobLike | DataView;
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Intended to match DOM Blob, node-fetch Blob, node:buffer Blob, etc.
|
|
9
|
+
* Don't add arrayBuffer here, node-fetch doesn't have it
|
|
10
|
+
*/
|
|
11
|
+
interface BlobLike {
|
|
12
|
+
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/size) */
|
|
13
|
+
readonly size: number;
|
|
14
|
+
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/type) */
|
|
15
|
+
readonly type: string;
|
|
16
|
+
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/text) */
|
|
17
|
+
text(): Promise<string>;
|
|
18
|
+
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/slice) */
|
|
19
|
+
slice(start?: number, end?: number): BlobLike;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* This check adds the arrayBuffer() method type because it is available and used at runtime
|
|
24
|
+
*/
|
|
25
|
+
const isBlobLike = (value: any): value is BlobLike & { arrayBuffer(): Promise<ArrayBuffer> } =>
|
|
26
|
+
value != null &&
|
|
27
|
+
typeof value === 'object' &&
|
|
28
|
+
typeof value.size === 'number' &&
|
|
29
|
+
typeof value.type === 'string' &&
|
|
30
|
+
typeof value.text === 'function' &&
|
|
31
|
+
typeof value.slice === 'function' &&
|
|
32
|
+
typeof value.arrayBuffer === 'function';
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* Intended to match DOM File, node:buffer File, undici File, etc.
|
|
36
|
+
*/
|
|
37
|
+
interface FileLike extends BlobLike {
|
|
38
|
+
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/lastModified) */
|
|
39
|
+
readonly lastModified: number;
|
|
40
|
+
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/name) */
|
|
41
|
+
readonly name?: string | undefined;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* This check adds the arrayBuffer() method type because it is available and used at runtime
|
|
46
|
+
*/
|
|
47
|
+
const isFileLike = (value: any): value is FileLike & { arrayBuffer(): Promise<ArrayBuffer> } =>
|
|
48
|
+
value != null &&
|
|
49
|
+
typeof value === 'object' &&
|
|
50
|
+
typeof value.name === 'string' &&
|
|
51
|
+
typeof value.lastModified === 'number' &&
|
|
52
|
+
isBlobLike(value);
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Intended to match DOM Response, node-fetch Response, undici Response, etc.
|
|
56
|
+
*/
|
|
57
|
+
export interface ResponseLike {
|
|
58
|
+
url: string;
|
|
59
|
+
blob(): Promise<BlobLike>;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
const isResponseLike = (value: any): value is ResponseLike =>
|
|
63
|
+
value != null &&
|
|
64
|
+
typeof value === 'object' &&
|
|
65
|
+
typeof value.url === 'string' &&
|
|
66
|
+
typeof value.blob === 'function';
|
|
67
|
+
|
|
68
|
+
export type ToFileInput =
|
|
69
|
+
| FileLike
|
|
70
|
+
| ResponseLike
|
|
71
|
+
| Exclude<BlobLikePart, string>
|
|
72
|
+
| AsyncIterable<BlobLikePart>;
|
|
73
|
+
|
|
74
|
+
/**
|
|
75
|
+
* Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
|
|
76
|
+
* @param value the raw content of the file. Can be an {@link Uploadable}, BlobLikePart, or AsyncIterable of BlobLikeParts
|
|
77
|
+
* @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
|
|
78
|
+
* @param {Object=} options additional properties
|
|
79
|
+
* @param {string=} options.type the MIME type of the content
|
|
80
|
+
* @param {number=} options.lastModified the last modified timestamp
|
|
81
|
+
* @returns a {@link File} with the given properties
|
|
82
|
+
*/
|
|
83
|
+
export async function toFile(
|
|
84
|
+
value: ToFileInput | PromiseLike<ToFileInput>,
|
|
85
|
+
name?: string | null | undefined,
|
|
86
|
+
options?: FilePropertyBag | undefined,
|
|
87
|
+
): Promise<File> {
|
|
88
|
+
checkFileSupport();
|
|
89
|
+
|
|
90
|
+
// If it's a promise, resolve it.
|
|
91
|
+
value = await value;
|
|
92
|
+
|
|
93
|
+
// If we've been given a `File` we don't need to do anything
|
|
94
|
+
if (isFileLike(value)) {
|
|
95
|
+
if (value instanceof File) {
|
|
96
|
+
return value;
|
|
97
|
+
}
|
|
98
|
+
return makeFile([await value.arrayBuffer()], value.name);
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
if (isResponseLike(value)) {
|
|
102
|
+
const blob = await value.blob();
|
|
103
|
+
name ||= new URL(value.url).pathname.split(/[\\/]/).pop();
|
|
104
|
+
|
|
105
|
+
return makeFile(await getBytes(blob), name, options);
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
const parts = await getBytes(value);
|
|
109
|
+
|
|
110
|
+
name ||= getName(value);
|
|
111
|
+
|
|
112
|
+
if (!options?.type) {
|
|
113
|
+
const type = parts.find((part) => typeof part === 'object' && 'type' in part && part.type);
|
|
114
|
+
if (typeof type === 'string') {
|
|
115
|
+
options = { ...options, type };
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
return makeFile(parts, name, options);
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
async function getBytes(value: BlobLikePart | AsyncIterable<BlobLikePart>): Promise<Array<BlobPart>> {
|
|
123
|
+
let parts: Array<BlobPart> = [];
|
|
124
|
+
if (
|
|
125
|
+
typeof value === 'string' ||
|
|
126
|
+
ArrayBuffer.isView(value) || // includes Uint8Array, Buffer, etc.
|
|
127
|
+
value instanceof ArrayBuffer
|
|
128
|
+
) {
|
|
129
|
+
parts.push(value);
|
|
130
|
+
} else if (isBlobLike(value)) {
|
|
131
|
+
parts.push(value instanceof Blob ? value : await value.arrayBuffer());
|
|
132
|
+
} else if (
|
|
133
|
+
isAsyncIterable(value) // includes Readable, ReadableStream, etc.
|
|
134
|
+
) {
|
|
135
|
+
for await (const chunk of value) {
|
|
136
|
+
parts.push(...(await getBytes(chunk as BlobLikePart))); // TODO, consider validating?
|
|
137
|
+
}
|
|
138
|
+
} else {
|
|
139
|
+
const constructor = value?.constructor?.name;
|
|
140
|
+
throw new Error(
|
|
141
|
+
`Unexpected data type: ${typeof value}${
|
|
142
|
+
constructor ? `; constructor: ${constructor}` : ''
|
|
143
|
+
}${propsForError(value)}`,
|
|
144
|
+
);
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
return parts;
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
function propsForError(value: unknown): string {
|
|
151
|
+
if (typeof value !== 'object' || value === null) return '';
|
|
152
|
+
const props = Object.getOwnPropertyNames(value);
|
|
153
|
+
return `; props: [${props.map((p) => `"${p}"`).join(', ')}]`;
|
|
154
|
+
}
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
export type PromiseOrValue<T> = T | Promise<T>;
|
|
4
|
+
export type HTTPMethod = 'get' | 'post' | 'put' | 'patch' | 'delete';
|
|
5
|
+
|
|
6
|
+
export type KeysEnum<T> = { [P in keyof Required<T>]: true };
|
|
7
|
+
|
|
8
|
+
export type FinalizedRequestInit = RequestInit & { headers: Headers };
|
|
9
|
+
|
|
10
|
+
type NotAny<T> = [0] extends [1 & T] ? never : T;
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* Some environments overload the global fetch function, and Parameters<T> only gets the last signature.
|
|
14
|
+
*/
|
|
15
|
+
type OverloadedParameters<T> =
|
|
16
|
+
T extends (
|
|
17
|
+
{
|
|
18
|
+
(...args: infer A): unknown;
|
|
19
|
+
(...args: infer B): unknown;
|
|
20
|
+
(...args: infer C): unknown;
|
|
21
|
+
(...args: infer D): unknown;
|
|
22
|
+
}
|
|
23
|
+
) ?
|
|
24
|
+
A | B | C | D
|
|
25
|
+
: T extends (
|
|
26
|
+
{
|
|
27
|
+
(...args: infer A): unknown;
|
|
28
|
+
(...args: infer B): unknown;
|
|
29
|
+
(...args: infer C): unknown;
|
|
30
|
+
}
|
|
31
|
+
) ?
|
|
32
|
+
A | B | C
|
|
33
|
+
: T extends (
|
|
34
|
+
{
|
|
35
|
+
(...args: infer A): unknown;
|
|
36
|
+
(...args: infer B): unknown;
|
|
37
|
+
}
|
|
38
|
+
) ?
|
|
39
|
+
A | B
|
|
40
|
+
: T extends (...args: infer A) => unknown ? A
|
|
41
|
+
: never;
|
|
42
|
+
|
|
43
|
+
/* eslint-disable */
|
|
44
|
+
/**
|
|
45
|
+
* These imports attempt to get types from a parent package's dependencies.
|
|
46
|
+
* Unresolved bare specifiers can trigger [automatic type acquisition][1] in some projects, which
|
|
47
|
+
* would cause typescript to show types not present at runtime. To avoid this, we import
|
|
48
|
+
* directly from parent node_modules folders.
|
|
49
|
+
*
|
|
50
|
+
* We need to check multiple levels because we don't know what directory structure we'll be in.
|
|
51
|
+
* For example, pnpm generates directories like this:
|
|
52
|
+
* ```
|
|
53
|
+
* node_modules
|
|
54
|
+
* ├── .pnpm
|
|
55
|
+
* │ └── pkg@1.0.0
|
|
56
|
+
* │ └── node_modules
|
|
57
|
+
* │ └── pkg
|
|
58
|
+
* │ └── internal
|
|
59
|
+
* │ └── types.d.ts
|
|
60
|
+
* ├── pkg -> .pnpm/pkg@1.0.0/node_modules/pkg
|
|
61
|
+
* └── undici
|
|
62
|
+
* ```
|
|
63
|
+
*
|
|
64
|
+
* [1]: https://www.typescriptlang.org/tsconfig/#typeAcquisition
|
|
65
|
+
*/
|
|
66
|
+
/** @ts-ignore For users with \@types/node */
|
|
67
|
+
type UndiciTypesRequestInit = NotAny<import('../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit>;
|
|
68
|
+
/** @ts-ignore For users with undici */
|
|
69
|
+
type UndiciRequestInit = NotAny<import('../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici/index.d.ts').RequestInit>;
|
|
70
|
+
/** @ts-ignore For users with \@types/bun */
|
|
71
|
+
type BunRequestInit = globalThis.FetchRequestInit;
|
|
72
|
+
/** @ts-ignore For users with node-fetch@2 */
|
|
73
|
+
type NodeFetch2RequestInit = NotAny<import('../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit>;
|
|
74
|
+
/** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */
|
|
75
|
+
type NodeFetch3RequestInit = NotAny<import('../node_modules/node-fetch').RequestInit> | NotAny<import('../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/node-fetch').RequestInit>;
|
|
76
|
+
/** @ts-ignore For users who use Deno */
|
|
77
|
+
type FetchRequestInit = NonNullable<OverloadedParameters<typeof fetch>[1]>;
|
|
78
|
+
/* eslint-enable */
|
|
79
|
+
|
|
80
|
+
type RequestInits =
|
|
81
|
+
| NotAny<UndiciTypesRequestInit>
|
|
82
|
+
| NotAny<UndiciRequestInit>
|
|
83
|
+
| NotAny<BunRequestInit>
|
|
84
|
+
| NotAny<NodeFetch2RequestInit>
|
|
85
|
+
| NotAny<NodeFetch3RequestInit>
|
|
86
|
+
| NotAny<RequestInit>
|
|
87
|
+
| NotAny<FetchRequestInit>;
|
|
88
|
+
|
|
89
|
+
/**
|
|
90
|
+
* This type contains `RequestInit` options that may be available on the current runtime,
|
|
91
|
+
* including per-platform extensions like `dispatcher`, `agent`, `client`, etc.
|
|
92
|
+
*/
|
|
93
|
+
export type MergedRequestInit = RequestInits &
|
|
94
|
+
/** We don't include these in the types as they'll be overridden for every request. */
|
|
95
|
+
Partial<Record<'body' | 'headers' | 'method' | 'signal', never>>;
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
import { type RequestOptions } from './request-options';
|
|
2
|
+
import type { FilePropertyBag, Fetch } from './builtin-types';
|
|
3
|
+
import type { Hercules } from '../client';
|
|
4
|
+
import { ReadableStreamFrom } from './shims';
|
|
5
|
+
|
|
6
|
+
export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | DataView;
|
|
7
|
+
type FsReadStream = AsyncIterable<Uint8Array> & { path: string | { toString(): string } };
|
|
8
|
+
|
|
9
|
+
// https://github.com/oven-sh/bun/issues/5980
|
|
10
|
+
interface BunFile extends Blob {
|
|
11
|
+
readonly name?: string | undefined;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
export const checkFileSupport = () => {
|
|
15
|
+
if (typeof File === 'undefined') {
|
|
16
|
+
const { process } = globalThis as any;
|
|
17
|
+
const isOldNode =
|
|
18
|
+
typeof process?.versions?.node === 'string' && parseInt(process.versions.node.split('.')) < 20;
|
|
19
|
+
throw new Error(
|
|
20
|
+
'`File` is not defined as a global, which is required for file uploads.' +
|
|
21
|
+
(isOldNode ?
|
|
22
|
+
" Update to Node 20 LTS or newer, or set `globalThis.File` to `import('node:buffer').File`."
|
|
23
|
+
: ''),
|
|
24
|
+
);
|
|
25
|
+
}
|
|
26
|
+
};
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Typically, this is a native "File" class.
|
|
30
|
+
*
|
|
31
|
+
* We provide the {@link toFile} utility to convert a variety of objects
|
|
32
|
+
* into the File class.
|
|
33
|
+
*
|
|
34
|
+
* For convenience, you can also pass a fetch Response, or in Node,
|
|
35
|
+
* the result of fs.createReadStream().
|
|
36
|
+
*/
|
|
37
|
+
export type Uploadable = File | Response | FsReadStream | BunFile;
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* Construct a `File` instance. This is used to ensure a helpful error is thrown
|
|
41
|
+
* for environments that don't define a global `File` yet.
|
|
42
|
+
*/
|
|
43
|
+
export function makeFile(
|
|
44
|
+
fileBits: BlobPart[],
|
|
45
|
+
fileName: string | undefined,
|
|
46
|
+
options?: FilePropertyBag,
|
|
47
|
+
): File {
|
|
48
|
+
checkFileSupport();
|
|
49
|
+
return new File(fileBits as any, fileName ?? 'unknown_file', options);
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
export function getName(value: any): string | undefined {
|
|
53
|
+
return (
|
|
54
|
+
(
|
|
55
|
+
(typeof value === 'object' &&
|
|
56
|
+
value !== null &&
|
|
57
|
+
(('name' in value && value.name && String(value.name)) ||
|
|
58
|
+
('url' in value && value.url && String(value.url)) ||
|
|
59
|
+
('filename' in value && value.filename && String(value.filename)) ||
|
|
60
|
+
('path' in value && value.path && String(value.path)))) ||
|
|
61
|
+
''
|
|
62
|
+
)
|
|
63
|
+
.split(/[\\/]/)
|
|
64
|
+
.pop() || undefined
|
|
65
|
+
);
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export const isAsyncIterable = (value: any): value is AsyncIterable<any> =>
|
|
69
|
+
value != null && typeof value === 'object' && typeof value[Symbol.asyncIterator] === 'function';
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* Returns a multipart/form-data request if any part of the given request body contains a File / Blob value.
|
|
73
|
+
* Otherwise returns the request as is.
|
|
74
|
+
*/
|
|
75
|
+
export const maybeMultipartFormRequestOptions = async (
|
|
76
|
+
opts: RequestOptions,
|
|
77
|
+
fetch: Hercules | Fetch,
|
|
78
|
+
): Promise<RequestOptions> => {
|
|
79
|
+
if (!hasUploadableValue(opts.body)) return opts;
|
|
80
|
+
|
|
81
|
+
return { ...opts, body: await createForm(opts.body, fetch) };
|
|
82
|
+
};
|
|
83
|
+
|
|
84
|
+
type MultipartFormRequestOptions = Omit<RequestOptions, 'body'> & { body: unknown };
|
|
85
|
+
|
|
86
|
+
export const multipartFormRequestOptions = async (
|
|
87
|
+
opts: MultipartFormRequestOptions,
|
|
88
|
+
fetch: Hercules | Fetch,
|
|
89
|
+
): Promise<RequestOptions> => {
|
|
90
|
+
return { ...opts, body: await createForm(opts.body, fetch) };
|
|
91
|
+
};
|
|
92
|
+
|
|
93
|
+
const supportsFormDataMap = /* @__PURE__ */ new WeakMap<Fetch, Promise<boolean>>();
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* node-fetch doesn't support the global FormData object in recent node versions. Instead of sending
|
|
97
|
+
* properly-encoded form data, it just stringifies the object, resulting in a request body of "[object FormData]".
|
|
98
|
+
* This function detects if the fetch function provided supports the global FormData object to avoid
|
|
99
|
+
* confusing error messages later on.
|
|
100
|
+
*/
|
|
101
|
+
function supportsFormData(fetchObject: Hercules | Fetch): Promise<boolean> {
|
|
102
|
+
const fetch: Fetch = typeof fetchObject === 'function' ? fetchObject : (fetchObject as any).fetch;
|
|
103
|
+
const cached = supportsFormDataMap.get(fetch);
|
|
104
|
+
if (cached) return cached;
|
|
105
|
+
const promise = (async () => {
|
|
106
|
+
try {
|
|
107
|
+
const FetchResponse = (
|
|
108
|
+
'Response' in fetch ?
|
|
109
|
+
fetch.Response
|
|
110
|
+
: (await fetch('data:,')).constructor) as typeof Response;
|
|
111
|
+
const data = new FormData();
|
|
112
|
+
if (data.toString() === (await new FetchResponse(data).text())) {
|
|
113
|
+
return false;
|
|
114
|
+
}
|
|
115
|
+
return true;
|
|
116
|
+
} catch {
|
|
117
|
+
// avoid false negatives
|
|
118
|
+
return true;
|
|
119
|
+
}
|
|
120
|
+
})();
|
|
121
|
+
supportsFormDataMap.set(fetch, promise);
|
|
122
|
+
return promise;
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
export const createForm = async <T = Record<string, unknown>>(
|
|
126
|
+
body: T | undefined,
|
|
127
|
+
fetch: Hercules | Fetch,
|
|
128
|
+
): Promise<FormData> => {
|
|
129
|
+
if (!(await supportsFormData(fetch))) {
|
|
130
|
+
throw new TypeError(
|
|
131
|
+
'The provided fetch function does not support file uploads with the current global FormData class.',
|
|
132
|
+
);
|
|
133
|
+
}
|
|
134
|
+
const form = new FormData();
|
|
135
|
+
await Promise.all(Object.entries(body || {}).map(([key, value]) => addFormValue(form, key, value)));
|
|
136
|
+
return form;
|
|
137
|
+
};
|
|
138
|
+
|
|
139
|
+
// We check for Blob not File because Bun.File doesn't inherit from File,
|
|
140
|
+
// but they both inherit from Blob and have a `name` property at runtime.
|
|
141
|
+
const isNamedBlob = (value: unknown) => value instanceof Blob && 'name' in value;
|
|
142
|
+
|
|
143
|
+
const isUploadable = (value: unknown) =>
|
|
144
|
+
typeof value === 'object' &&
|
|
145
|
+
value !== null &&
|
|
146
|
+
(value instanceof Response || isAsyncIterable(value) || isNamedBlob(value));
|
|
147
|
+
|
|
148
|
+
const hasUploadableValue = (value: unknown): boolean => {
|
|
149
|
+
if (isUploadable(value)) return true;
|
|
150
|
+
if (Array.isArray(value)) return value.some(hasUploadableValue);
|
|
151
|
+
if (value && typeof value === 'object') {
|
|
152
|
+
for (const k in value) {
|
|
153
|
+
if (hasUploadableValue((value as any)[k])) return true;
|
|
154
|
+
}
|
|
155
|
+
}
|
|
156
|
+
return false;
|
|
157
|
+
};
|
|
158
|
+
|
|
159
|
+
const addFormValue = async (form: FormData, key: string, value: unknown): Promise<void> => {
|
|
160
|
+
if (value === undefined) return;
|
|
161
|
+
if (value == null) {
|
|
162
|
+
throw new TypeError(
|
|
163
|
+
`Received null for "${key}"; to pass null in FormData, you must use the string 'null'`,
|
|
164
|
+
);
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
// TODO: make nested formats configurable
|
|
168
|
+
if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
|
|
169
|
+
form.append(key, String(value));
|
|
170
|
+
} else if (value instanceof Response) {
|
|
171
|
+
form.append(key, makeFile([await value.blob()], getName(value)));
|
|
172
|
+
} else if (isAsyncIterable(value)) {
|
|
173
|
+
form.append(key, makeFile([await new Response(ReadableStreamFrom(value)).blob()], getName(value)));
|
|
174
|
+
} else if (isNamedBlob(value)) {
|
|
175
|
+
form.append(key, value, getName(value));
|
|
176
|
+
} else if (Array.isArray(value)) {
|
|
177
|
+
await Promise.all(value.map((entry) => addFormValue(form, key + '[]', entry)));
|
|
178
|
+
} else if (typeof value === 'object') {
|
|
179
|
+
await Promise.all(
|
|
180
|
+
Object.entries(value).map(([name, prop]) => addFormValue(form, `${key}[${name}]`, prop)),
|
|
181
|
+
);
|
|
182
|
+
} else {
|
|
183
|
+
throw new TypeError(
|
|
184
|
+
`Invalid value given to form, expected a string, number, boolean, object, Array, File or Blob but got ${value} instead`,
|
|
185
|
+
);
|
|
186
|
+
}
|
|
187
|
+
};
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { HerculesError } from '../../core/error';
|
|
4
|
+
import { encodeUTF8 } from './bytes';
|
|
5
|
+
|
|
6
|
+
export const toBase64 = (data: string | Uint8Array | null | undefined): string => {
|
|
7
|
+
if (!data) return '';
|
|
8
|
+
|
|
9
|
+
if (typeof (globalThis as any).Buffer !== 'undefined') {
|
|
10
|
+
return (globalThis as any).Buffer.from(data).toString('base64');
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
if (typeof data === 'string') {
|
|
14
|
+
data = encodeUTF8(data);
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
if (typeof btoa !== 'undefined') {
|
|
18
|
+
return btoa(String.fromCharCode.apply(null, data as any));
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
throw new HerculesError('Cannot generate base64 string; Expected `Buffer` or `btoa` to be defined');
|
|
22
|
+
};
|
|
23
|
+
|
|
24
|
+
export const fromBase64 = (str: string): Uint8Array => {
|
|
25
|
+
if (typeof (globalThis as any).Buffer !== 'undefined') {
|
|
26
|
+
const buf = (globalThis as any).Buffer.from(str, 'base64');
|
|
27
|
+
return new Uint8Array(buf.buffer, buf.byteOffset, buf.byteLength);
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
if (typeof atob !== 'undefined') {
|
|
31
|
+
const bstr = atob(str);
|
|
32
|
+
const buf = new Uint8Array(bstr.length);
|
|
33
|
+
for (let i = 0; i < bstr.length; i++) {
|
|
34
|
+
buf[i] = bstr.charCodeAt(i);
|
|
35
|
+
}
|
|
36
|
+
return buf;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
throw new HerculesError('Cannot decode base64 string; Expected `Buffer` or `atob` to be defined');
|
|
40
|
+
};
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
export function concatBytes(buffers: Uint8Array[]): Uint8Array {
|
|
2
|
+
let length = 0;
|
|
3
|
+
for (const buffer of buffers) {
|
|
4
|
+
length += buffer.length;
|
|
5
|
+
}
|
|
6
|
+
const output = new Uint8Array(length);
|
|
7
|
+
let index = 0;
|
|
8
|
+
for (const buffer of buffers) {
|
|
9
|
+
output.set(buffer, index);
|
|
10
|
+
index += buffer.length;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
return output;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
let encodeUTF8_: (str: string) => Uint8Array;
|
|
17
|
+
export function encodeUTF8(str: string) {
|
|
18
|
+
let encoder;
|
|
19
|
+
return (
|
|
20
|
+
encodeUTF8_ ??
|
|
21
|
+
((encoder = new (globalThis as any).TextEncoder()), (encodeUTF8_ = encoder.encode.bind(encoder)))
|
|
22
|
+
)(str);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
let decodeUTF8_: (bytes: Uint8Array) => string;
|
|
26
|
+
export function decodeUTF8(bytes: Uint8Array) {
|
|
27
|
+
let decoder;
|
|
28
|
+
return (
|
|
29
|
+
decodeUTF8_ ??
|
|
30
|
+
((decoder = new (globalThis as any).TextDecoder()), (decodeUTF8_ = decoder.decode.bind(decoder)))
|
|
31
|
+
)(bytes);
|
|
32
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Read an environment variable.
|
|
5
|
+
*
|
|
6
|
+
* Trims beginning and trailing whitespace.
|
|
7
|
+
*
|
|
8
|
+
* Will return undefined if the environment variable doesn't exist or cannot be accessed.
|
|
9
|
+
*/
|
|
10
|
+
export const readEnv = (env: string): string | undefined => {
|
|
11
|
+
if (typeof (globalThis as any).process !== 'undefined') {
|
|
12
|
+
return (globalThis as any).process.env?.[env]?.trim() ?? undefined;
|
|
13
|
+
}
|
|
14
|
+
if (typeof (globalThis as any).Deno !== 'undefined') {
|
|
15
|
+
return (globalThis as any).Deno.env?.get?.(env)?.trim();
|
|
16
|
+
}
|
|
17
|
+
return undefined;
|
|
18
|
+
};
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { hasOwn } from './values';
|
|
4
|
+
import { type Hercules } from '../../client';
|
|
5
|
+
import { RequestOptions } from '../request-options';
|
|
6
|
+
|
|
7
|
+
type LogFn = (message: string, ...rest: unknown[]) => void;
|
|
8
|
+
export type Logger = {
|
|
9
|
+
error: LogFn;
|
|
10
|
+
warn: LogFn;
|
|
11
|
+
info: LogFn;
|
|
12
|
+
debug: LogFn;
|
|
13
|
+
};
|
|
14
|
+
export type LogLevel = 'off' | 'error' | 'warn' | 'info' | 'debug';
|
|
15
|
+
|
|
16
|
+
const levelNumbers = {
|
|
17
|
+
off: 0,
|
|
18
|
+
error: 200,
|
|
19
|
+
warn: 300,
|
|
20
|
+
info: 400,
|
|
21
|
+
debug: 500,
|
|
22
|
+
};
|
|
23
|
+
|
|
24
|
+
export const parseLogLevel = (
|
|
25
|
+
maybeLevel: string | undefined,
|
|
26
|
+
sourceName: string,
|
|
27
|
+
client: Hercules,
|
|
28
|
+
): LogLevel | undefined => {
|
|
29
|
+
if (!maybeLevel) {
|
|
30
|
+
return undefined;
|
|
31
|
+
}
|
|
32
|
+
if (hasOwn(levelNumbers, maybeLevel)) {
|
|
33
|
+
return maybeLevel;
|
|
34
|
+
}
|
|
35
|
+
loggerFor(client).warn(
|
|
36
|
+
`${sourceName} was set to ${JSON.stringify(maybeLevel)}, expected one of ${JSON.stringify(
|
|
37
|
+
Object.keys(levelNumbers),
|
|
38
|
+
)}`,
|
|
39
|
+
);
|
|
40
|
+
return undefined;
|
|
41
|
+
};
|
|
42
|
+
|
|
43
|
+
function noop() {}
|
|
44
|
+
|
|
45
|
+
function makeLogFn(fnLevel: keyof Logger, logger: Logger | undefined, logLevel: LogLevel) {
|
|
46
|
+
if (!logger || levelNumbers[fnLevel] > levelNumbers[logLevel]) {
|
|
47
|
+
return noop;
|
|
48
|
+
} else {
|
|
49
|
+
// Don't wrap logger functions, we want the stacktrace intact!
|
|
50
|
+
return logger[fnLevel].bind(logger);
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
const noopLogger = {
|
|
55
|
+
error: noop,
|
|
56
|
+
warn: noop,
|
|
57
|
+
info: noop,
|
|
58
|
+
debug: noop,
|
|
59
|
+
};
|
|
60
|
+
|
|
61
|
+
let cachedLoggers = /* @__PURE__ */ new WeakMap<Logger, [LogLevel, Logger]>();
|
|
62
|
+
|
|
63
|
+
export function loggerFor(client: Hercules): Logger {
|
|
64
|
+
const logger = client.logger;
|
|
65
|
+
const logLevel = client.logLevel ?? 'off';
|
|
66
|
+
if (!logger) {
|
|
67
|
+
return noopLogger;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
const cachedLogger = cachedLoggers.get(logger);
|
|
71
|
+
if (cachedLogger && cachedLogger[0] === logLevel) {
|
|
72
|
+
return cachedLogger[1];
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
const levelLogger = {
|
|
76
|
+
error: makeLogFn('error', logger, logLevel),
|
|
77
|
+
warn: makeLogFn('warn', logger, logLevel),
|
|
78
|
+
info: makeLogFn('info', logger, logLevel),
|
|
79
|
+
debug: makeLogFn('debug', logger, logLevel),
|
|
80
|
+
};
|
|
81
|
+
|
|
82
|
+
cachedLoggers.set(logger, [logLevel, levelLogger]);
|
|
83
|
+
|
|
84
|
+
return levelLogger;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
export const formatRequestDetails = (details: {
|
|
88
|
+
options?: RequestOptions | undefined;
|
|
89
|
+
headers?: Headers | Record<string, string> | undefined;
|
|
90
|
+
retryOfRequestLogID?: string | undefined;
|
|
91
|
+
retryOf?: string | undefined;
|
|
92
|
+
url?: string | undefined;
|
|
93
|
+
status?: number | undefined;
|
|
94
|
+
method?: string | undefined;
|
|
95
|
+
durationMs?: number | undefined;
|
|
96
|
+
message?: unknown;
|
|
97
|
+
body?: unknown;
|
|
98
|
+
}) => {
|
|
99
|
+
if (details.options) {
|
|
100
|
+
details.options = { ...details.options };
|
|
101
|
+
delete details.options['headers']; // redundant + leaks internals
|
|
102
|
+
}
|
|
103
|
+
if (details.headers) {
|
|
104
|
+
details.headers = Object.fromEntries(
|
|
105
|
+
(details.headers instanceof Headers ? [...details.headers] : Object.entries(details.headers)).map(
|
|
106
|
+
([name, value]) => [
|
|
107
|
+
name,
|
|
108
|
+
(
|
|
109
|
+
name.toLowerCase() === 'authorization' ||
|
|
110
|
+
name.toLowerCase() === 'cookie' ||
|
|
111
|
+
name.toLowerCase() === 'set-cookie'
|
|
112
|
+
) ?
|
|
113
|
+
'***'
|
|
114
|
+
: value,
|
|
115
|
+
],
|
|
116
|
+
),
|
|
117
|
+
);
|
|
118
|
+
}
|
|
119
|
+
if ('retryOfRequestLogID' in details) {
|
|
120
|
+
if (details.retryOfRequestLogID) {
|
|
121
|
+
details.retryOf = details.retryOfRequestLogID;
|
|
122
|
+
}
|
|
123
|
+
delete details.retryOfRequestLogID;
|
|
124
|
+
}
|
|
125
|
+
return details;
|
|
126
|
+
};
|