@tabstack/sdk 1.0.5 → 2.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 +117 -0
- package/LICENSE +1 -1
- package/README.md +282 -356
- 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 +186 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +186 -0
- package/client.d.ts.map +1 -0
- package/client.js +467 -0
- package/client.js.map +1 -0
- package/client.mjs +463 -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/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/streaming.d.mts +33 -0
- package/core/streaming.d.mts.map +1 -0
- package/core/streaming.d.ts +33 -0
- package/core/streaming.d.ts.map +1 -0
- package/core/streaming.js +263 -0
- package/core/streaming.js.map +1 -0
- package/core/streaming.mjs +258 -0
- package/core/streaming.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 +6 -0
- package/index.d.mts.map +1 -0
- package/index.d.ts +6 -0
- package/index.d.ts.map +1 -0
- package/index.js +30 -0
- package/index.js.map +1 -0
- package/index.mjs +7 -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/decoders/line.d.mts +17 -0
- package/internal/decoders/line.d.mts.map +1 -0
- package/internal/decoders/line.d.ts +17 -0
- package/internal/decoders/line.d.ts.map +1 -0
- package/internal/decoders/line.js +113 -0
- package/internal/decoders/line.js.map +1 -0
- package/internal/decoders/line.mjs +108 -0
- package/internal/decoders/line.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 +45 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +42 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/request-options.d.mts +77 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +77 -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 +139 -82
- 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/agent.d.mts +154 -0
- package/resources/agent.d.mts.map +1 -0
- package/resources/agent.d.ts +154 -0
- package/resources/agent.d.ts.map +1 -0
- package/resources/agent.js +88 -0
- package/resources/agent.js.map +1 -0
- package/resources/agent.mjs +84 -0
- package/resources/agent.mjs.map +1 -0
- package/resources/extract.d.mts +207 -0
- package/resources/extract.d.mts.map +1 -0
- package/resources/extract.d.ts +207 -0
- package/resources/extract.d.ts.map +1 -0
- package/resources/extract.js +61 -0
- package/resources/extract.js.map +1 -0
- package/resources/extract.mjs +57 -0
- package/resources/extract.mjs.map +1 -0
- package/resources/generate.d.mts +79 -0
- package/resources/generate.d.mts.map +1 -0
- package/resources/generate.d.ts +79 -0
- package/resources/generate.d.ts.map +1 -0
- package/resources/generate.js +44 -0
- package/resources/generate.js.map +1 -0
- package/resources/generate.mjs +40 -0
- package/resources/generate.mjs.map +1 -0
- package/resources/index.d.mts +4 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +4 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +11 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +5 -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 +764 -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/resource.ts +11 -0
- package/src/core/streaming.ts +315 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -0
- package/src/index.ts +22 -0
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/decoders/line.ts +135 -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 +64 -0
- package/src/internal/request-options.ts +93 -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/resource.ts +2 -0
- package/src/resources/agent.ts +194 -0
- package/src/resources/extract.ts +248 -0
- package/src/resources/generate.ts +89 -0
- package/src/resources/index.ts +17 -0
- package/src/resources.ts +1 -0
- package/src/streaming.ts +2 -0
- package/src/tsconfig.json +11 -0
- package/src/uploads.ts +2 -0
- package/src/version.ts +1 -0
- package/streaming.d.mts +2 -0
- package/streaming.d.mts.map +1 -0
- package/streaming.d.ts +2 -0
- package/streaming.d.ts.map +1 -0
- package/streaming.js +6 -0
- package/streaming.js.map +1 -0
- package/streaming.mjs +2 -0
- package/streaming.mjs.map +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
- package/dist/cjs/agent.d.ts +0 -156
- package/dist/cjs/agent.d.ts.map +0 -1
- package/dist/cjs/agent.js +0 -211
- package/dist/cjs/agent.js.map +0 -1
- package/dist/cjs/agent.test.d.ts +0 -5
- package/dist/cjs/agent.test.d.ts.map +0 -1
- package/dist/cjs/agent.test.js +0 -441
- package/dist/cjs/agent.test.js.map +0 -1
- package/dist/cjs/client.d.ts +0 -58
- package/dist/cjs/client.d.ts.map +0 -1
- package/dist/cjs/client.js +0 -58
- package/dist/cjs/client.js.map +0 -1
- package/dist/cjs/client.test.d.ts +0 -5
- package/dist/cjs/client.test.d.ts.map +0 -1
- package/dist/cjs/client.test.js +0 -255
- package/dist/cjs/client.test.js.map +0 -1
- package/dist/cjs/exceptions.d.ts +0 -57
- package/dist/cjs/exceptions.d.ts.map +0 -1
- package/dist/cjs/exceptions.js +0 -95
- package/dist/cjs/exceptions.js.map +0 -1
- package/dist/cjs/exceptions.test.d.ts +0 -5
- package/dist/cjs/exceptions.test.d.ts.map +0 -1
- package/dist/cjs/exceptions.test.js +0 -239
- package/dist/cjs/exceptions.test.js.map +0 -1
- package/dist/cjs/extract.d.ts +0 -151
- package/dist/cjs/extract.d.ts.map +0 -1
- package/dist/cjs/extract.js +0 -165
- package/dist/cjs/extract.js.map +0 -1
- package/dist/cjs/extract.test.d.ts +0 -5
- package/dist/cjs/extract.test.d.ts.map +0 -1
- package/dist/cjs/extract.test.js +0 -250
- package/dist/cjs/extract.test.js.map +0 -1
- package/dist/cjs/generate.d.ts +0 -113
- package/dist/cjs/generate.d.ts.map +0 -1
- package/dist/cjs/generate.js +0 -124
- package/dist/cjs/generate.js.map +0 -1
- package/dist/cjs/generate.test.d.ts +0 -5
- package/dist/cjs/generate.test.d.ts.map +0 -1
- package/dist/cjs/generate.test.js +0 -314
- package/dist/cjs/generate.test.js.map +0 -1
- package/dist/cjs/index.d.ts +0 -52
- package/dist/cjs/index.d.ts.map +0 -1
- package/dist/cjs/index.js +0 -72
- package/dist/cjs/index.js.map +0 -1
- package/dist/cjs/package.json +0 -3
- package/dist/cjs/types.d.ts +0 -73
- package/dist/cjs/types.d.ts.map +0 -1
- package/dist/cjs/types.js +0 -118
- package/dist/cjs/types.js.map +0 -1
- package/dist/cjs/types.test.d.ts +0 -5
- package/dist/cjs/types.test.d.ts.map +0 -1
- package/dist/cjs/types.test.js +0 -370
- package/dist/cjs/types.test.js.map +0 -1
- package/dist/cjs/util/http.d.ts +0 -29
- package/dist/cjs/util/http.d.ts.map +0 -1
- package/dist/cjs/util/http.js +0 -201
- package/dist/cjs/util/http.js.map +0 -1
- package/dist/cjs/util/http.test.d.ts +0 -5
- package/dist/cjs/util/http.test.d.ts.map +0 -1
- package/dist/cjs/util/http.test.js +0 -237
- package/dist/cjs/util/http.test.js.map +0 -1
- package/dist/esm/agent.d.ts +0 -156
- package/dist/esm/agent.d.ts.map +0 -1
- package/dist/esm/agent.js +0 -207
- package/dist/esm/agent.js.map +0 -1
- package/dist/esm/agent.test.d.ts +0 -5
- package/dist/esm/agent.test.d.ts.map +0 -1
- package/dist/esm/agent.test.js +0 -439
- package/dist/esm/agent.test.js.map +0 -1
- package/dist/esm/client.d.ts +0 -58
- package/dist/esm/client.d.ts.map +0 -1
- package/dist/esm/client.js +0 -54
- package/dist/esm/client.js.map +0 -1
- package/dist/esm/client.test.d.ts +0 -5
- package/dist/esm/client.test.d.ts.map +0 -1
- package/dist/esm/client.test.js +0 -253
- package/dist/esm/client.test.js.map +0 -1
- package/dist/esm/exceptions.d.ts +0 -57
- package/dist/esm/exceptions.d.ts.map +0 -1
- package/dist/esm/exceptions.js +0 -85
- package/dist/esm/exceptions.js.map +0 -1
- package/dist/esm/exceptions.test.d.ts +0 -5
- package/dist/esm/exceptions.test.d.ts.map +0 -1
- package/dist/esm/exceptions.test.js +0 -237
- package/dist/esm/exceptions.test.js.map +0 -1
- package/dist/esm/extract.d.ts +0 -151
- package/dist/esm/extract.d.ts.map +0 -1
- package/dist/esm/extract.js +0 -161
- package/dist/esm/extract.js.map +0 -1
- package/dist/esm/extract.test.d.ts +0 -5
- package/dist/esm/extract.test.d.ts.map +0 -1
- package/dist/esm/extract.test.js +0 -248
- package/dist/esm/extract.test.js.map +0 -1
- package/dist/esm/generate.d.ts +0 -113
- package/dist/esm/generate.d.ts.map +0 -1
- package/dist/esm/generate.js +0 -120
- package/dist/esm/generate.js.map +0 -1
- package/dist/esm/generate.test.d.ts +0 -5
- package/dist/esm/generate.test.d.ts.map +0 -1
- package/dist/esm/generate.test.js +0 -312
- package/dist/esm/generate.test.js.map +0 -1
- package/dist/esm/index.d.ts +0 -52
- package/dist/esm/index.d.ts.map +0 -1
- package/dist/esm/index.js +0 -53
- package/dist/esm/index.js.map +0 -1
- package/dist/esm/package.json +0 -3
- package/dist/esm/types.d.ts +0 -73
- package/dist/esm/types.d.ts.map +0 -1
- package/dist/esm/types.js +0 -110
- package/dist/esm/types.js.map +0 -1
- package/dist/esm/types.test.d.ts +0 -5
- package/dist/esm/types.test.d.ts.map +0 -1
- package/dist/esm/types.test.js +0 -368
- package/dist/esm/types.test.js.map +0 -1
- package/dist/esm/util/http.d.ts +0 -29
- package/dist/esm/util/http.d.ts.map +0 -1
- package/dist/esm/util/http.js +0 -164
- package/dist/esm/util/http.js.map +0 -1
- package/dist/esm/util/http.test.d.ts +0 -5
- package/dist/esm/util/http.test.d.ts.map +0 -1
- package/dist/esm/util/http.test.js +0 -232
- package/dist/esm/util/http.test.js.map +0 -1
- package/dist/types/agent.d.ts +0 -156
- package/dist/types/agent.d.ts.map +0 -1
- package/dist/types/agent.test.d.ts +0 -5
- package/dist/types/agent.test.d.ts.map +0 -1
- package/dist/types/client.d.ts +0 -58
- package/dist/types/client.d.ts.map +0 -1
- package/dist/types/client.test.d.ts +0 -5
- package/dist/types/client.test.d.ts.map +0 -1
- package/dist/types/exceptions.d.ts +0 -57
- package/dist/types/exceptions.d.ts.map +0 -1
- package/dist/types/exceptions.test.d.ts +0 -5
- package/dist/types/exceptions.test.d.ts.map +0 -1
- package/dist/types/extract.d.ts +0 -151
- package/dist/types/extract.d.ts.map +0 -1
- package/dist/types/extract.test.d.ts +0 -5
- package/dist/types/extract.test.d.ts.map +0 -1
- package/dist/types/generate.d.ts +0 -113
- package/dist/types/generate.d.ts.map +0 -1
- package/dist/types/generate.test.d.ts +0 -5
- package/dist/types/generate.test.d.ts.map +0 -1
- package/dist/types/index.d.ts +0 -52
- package/dist/types/index.d.ts.map +0 -1
- package/dist/types/types.d.ts +0 -73
- package/dist/types/types.d.ts.map +0 -1
- package/dist/types/types.test.d.ts +0 -5
- package/dist/types/types.test.d.ts.map +0 -1
- package/dist/types/util/http.d.ts +0 -29
- package/dist/types/util/http.d.ts.map +0 -1
- package/dist/types/util/http.test.d.ts +0 -5
- package/dist/types/util/http.test.d.ts.map +0 -1
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
|
+
export declare class Extract extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Fetches a URL and extracts structured data according to a provided JSON schema
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```ts
|
|
10
|
+
* const response = await client.extract.json({
|
|
11
|
+
* json_schema: {
|
|
12
|
+
* properties: {
|
|
13
|
+
* stories: {
|
|
14
|
+
* items: {
|
|
15
|
+
* properties: {
|
|
16
|
+
* author: {
|
|
17
|
+
* description: 'Author username',
|
|
18
|
+
* type: 'string',
|
|
19
|
+
* },
|
|
20
|
+
* points: {
|
|
21
|
+
* description: 'Story points',
|
|
22
|
+
* type: 'number',
|
|
23
|
+
* },
|
|
24
|
+
* title: {
|
|
25
|
+
* description: 'Story title',
|
|
26
|
+
* type: 'string',
|
|
27
|
+
* },
|
|
28
|
+
* },
|
|
29
|
+
* type: 'object',
|
|
30
|
+
* },
|
|
31
|
+
* type: 'array',
|
|
32
|
+
* },
|
|
33
|
+
* },
|
|
34
|
+
* type: 'object',
|
|
35
|
+
* },
|
|
36
|
+
* url: 'https://news.ycombinator.com',
|
|
37
|
+
* });
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
40
|
+
json(body: ExtractJsonParams, options?: RequestOptions): APIPromise<ExtractJsonResponse>;
|
|
41
|
+
/**
|
|
42
|
+
* Fetches a URL and converts its HTML content to clean Markdown format with
|
|
43
|
+
* optional metadata extraction
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* ```ts
|
|
47
|
+
* const response = await client.extract.markdown({
|
|
48
|
+
* url: 'https://example.com/blog/article',
|
|
49
|
+
* });
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
52
|
+
markdown(body: ExtractMarkdownParams, options?: RequestOptions): APIPromise<ExtractMarkdownResponse>;
|
|
53
|
+
}
|
|
54
|
+
export type ExtractJsonResponse = {
|
|
55
|
+
[key: string]: unknown;
|
|
56
|
+
};
|
|
57
|
+
export interface ExtractMarkdownResponse {
|
|
58
|
+
/**
|
|
59
|
+
* The markdown content (includes metadata as YAML frontmatter by default)
|
|
60
|
+
*/
|
|
61
|
+
content: string;
|
|
62
|
+
/**
|
|
63
|
+
* The URL that was converted to markdown
|
|
64
|
+
*/
|
|
65
|
+
url: string;
|
|
66
|
+
/**
|
|
67
|
+
* Extracted metadata from the page (only included when metadata parameter is true)
|
|
68
|
+
*/
|
|
69
|
+
metadata?: ExtractMarkdownResponse.Metadata;
|
|
70
|
+
}
|
|
71
|
+
export declare namespace ExtractMarkdownResponse {
|
|
72
|
+
/**
|
|
73
|
+
* Extracted metadata from the page (only included when metadata parameter is true)
|
|
74
|
+
*/
|
|
75
|
+
interface Metadata {
|
|
76
|
+
/**
|
|
77
|
+
* Author information from HTML metadata
|
|
78
|
+
*/
|
|
79
|
+
author?: string;
|
|
80
|
+
/**
|
|
81
|
+
* Document creation date (ISO 8601)
|
|
82
|
+
*/
|
|
83
|
+
created_at?: string;
|
|
84
|
+
/**
|
|
85
|
+
* Creator application (e.g., "Microsoft Word")
|
|
86
|
+
*/
|
|
87
|
+
creator?: string;
|
|
88
|
+
/**
|
|
89
|
+
* Page description from Open Graph or HTML
|
|
90
|
+
*/
|
|
91
|
+
description?: string;
|
|
92
|
+
/**
|
|
93
|
+
* Featured image URL from Open Graph
|
|
94
|
+
*/
|
|
95
|
+
image?: string;
|
|
96
|
+
/**
|
|
97
|
+
* PDF keywords as array
|
|
98
|
+
*/
|
|
99
|
+
keywords?: Array<string>;
|
|
100
|
+
/**
|
|
101
|
+
* Document modification date (ISO 8601)
|
|
102
|
+
*/
|
|
103
|
+
modified_at?: string;
|
|
104
|
+
/**
|
|
105
|
+
* Number of pages (PDF documents)
|
|
106
|
+
*/
|
|
107
|
+
page_count?: number;
|
|
108
|
+
/**
|
|
109
|
+
* PDF version (e.g., "1.5")
|
|
110
|
+
*/
|
|
111
|
+
pdf_version?: string;
|
|
112
|
+
/**
|
|
113
|
+
* PDF producer software (e.g., "Adobe PDF Library")
|
|
114
|
+
*/
|
|
115
|
+
producer?: string;
|
|
116
|
+
/**
|
|
117
|
+
* Publisher information from Open Graph
|
|
118
|
+
*/
|
|
119
|
+
publisher?: string;
|
|
120
|
+
/**
|
|
121
|
+
* Site name from Open Graph
|
|
122
|
+
*/
|
|
123
|
+
site_name?: string;
|
|
124
|
+
/**
|
|
125
|
+
* PDF-specific metadata fields (populated for PDF documents) PDF subject or
|
|
126
|
+
* summary
|
|
127
|
+
*/
|
|
128
|
+
subject?: string;
|
|
129
|
+
/**
|
|
130
|
+
* Page title from Open Graph or HTML
|
|
131
|
+
*/
|
|
132
|
+
title?: string;
|
|
133
|
+
/**
|
|
134
|
+
* Content type from Open Graph (e.g., article, website)
|
|
135
|
+
*/
|
|
136
|
+
type?: string;
|
|
137
|
+
/**
|
|
138
|
+
* Canonical URL from Open Graph
|
|
139
|
+
*/
|
|
140
|
+
url?: string;
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
export interface ExtractJsonParams {
|
|
144
|
+
/**
|
|
145
|
+
* JSON schema definition that describes the structure of data to extract.
|
|
146
|
+
*/
|
|
147
|
+
json_schema: unknown;
|
|
148
|
+
/**
|
|
149
|
+
* URL to fetch and extract data from
|
|
150
|
+
*/
|
|
151
|
+
url: string;
|
|
152
|
+
/**
|
|
153
|
+
* Optional geotargeting parameters for proxy requests
|
|
154
|
+
*/
|
|
155
|
+
geo_target?: ExtractJsonParams.GeoTarget;
|
|
156
|
+
/**
|
|
157
|
+
* Bypass cache and force fresh data retrieval
|
|
158
|
+
*/
|
|
159
|
+
nocache?: boolean;
|
|
160
|
+
}
|
|
161
|
+
export declare namespace ExtractJsonParams {
|
|
162
|
+
/**
|
|
163
|
+
* Optional geotargeting parameters for proxy requests
|
|
164
|
+
*/
|
|
165
|
+
interface GeoTarget {
|
|
166
|
+
/**
|
|
167
|
+
* Country code using ISO 3166-1 alpha-2 standard (2 letters, e.g., "US", "GB",
|
|
168
|
+
* "JP"). See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
|
|
169
|
+
*/
|
|
170
|
+
country?: string;
|
|
171
|
+
}
|
|
172
|
+
}
|
|
173
|
+
export interface ExtractMarkdownParams {
|
|
174
|
+
/**
|
|
175
|
+
* URL to fetch and convert to markdown
|
|
176
|
+
*/
|
|
177
|
+
url: string;
|
|
178
|
+
/**
|
|
179
|
+
* Optional geotargeting parameters for proxy requests
|
|
180
|
+
*/
|
|
181
|
+
geo_target?: ExtractMarkdownParams.GeoTarget;
|
|
182
|
+
/**
|
|
183
|
+
* Include extracted metadata (Open Graph and HTML metadata) as a separate field in
|
|
184
|
+
* the response
|
|
185
|
+
*/
|
|
186
|
+
metadata?: boolean;
|
|
187
|
+
/**
|
|
188
|
+
* Bypass cache and force fresh data retrieval
|
|
189
|
+
*/
|
|
190
|
+
nocache?: boolean;
|
|
191
|
+
}
|
|
192
|
+
export declare namespace ExtractMarkdownParams {
|
|
193
|
+
/**
|
|
194
|
+
* Optional geotargeting parameters for proxy requests
|
|
195
|
+
*/
|
|
196
|
+
interface GeoTarget {
|
|
197
|
+
/**
|
|
198
|
+
* Country code using ISO 3166-1 alpha-2 standard (2 letters, e.g., "US", "GB",
|
|
199
|
+
* "JP"). See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
|
|
200
|
+
*/
|
|
201
|
+
country?: string;
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
export declare namespace Extract {
|
|
205
|
+
export { type ExtractJsonResponse as ExtractJsonResponse, type ExtractMarkdownResponse as ExtractMarkdownResponse, type ExtractJsonParams as ExtractJsonParams, type ExtractMarkdownParams as ExtractMarkdownParams, };
|
|
206
|
+
}
|
|
207
|
+
//# sourceMappingURL=extract.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"extract.d.mts","sourceRoot":"","sources":["../src/resources/extract.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,IAAI,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIxF;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAGrG;AAED,MAAM,MAAM,mBAAmB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE7D,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,uBAAuB,CAAC,QAAQ,CAAC;CAC7C;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC,SAAS,CAAC;IAEzC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,SAAS;QACxB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,qBAAqB,CAAC,SAAS,CAAC;IAE7C;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,SAAS;QACxB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
4
|
+
export declare class Extract extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Fetches a URL and extracts structured data according to a provided JSON schema
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```ts
|
|
10
|
+
* const response = await client.extract.json({
|
|
11
|
+
* json_schema: {
|
|
12
|
+
* properties: {
|
|
13
|
+
* stories: {
|
|
14
|
+
* items: {
|
|
15
|
+
* properties: {
|
|
16
|
+
* author: {
|
|
17
|
+
* description: 'Author username',
|
|
18
|
+
* type: 'string',
|
|
19
|
+
* },
|
|
20
|
+
* points: {
|
|
21
|
+
* description: 'Story points',
|
|
22
|
+
* type: 'number',
|
|
23
|
+
* },
|
|
24
|
+
* title: {
|
|
25
|
+
* description: 'Story title',
|
|
26
|
+
* type: 'string',
|
|
27
|
+
* },
|
|
28
|
+
* },
|
|
29
|
+
* type: 'object',
|
|
30
|
+
* },
|
|
31
|
+
* type: 'array',
|
|
32
|
+
* },
|
|
33
|
+
* },
|
|
34
|
+
* type: 'object',
|
|
35
|
+
* },
|
|
36
|
+
* url: 'https://news.ycombinator.com',
|
|
37
|
+
* });
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
40
|
+
json(body: ExtractJsonParams, options?: RequestOptions): APIPromise<ExtractJsonResponse>;
|
|
41
|
+
/**
|
|
42
|
+
* Fetches a URL and converts its HTML content to clean Markdown format with
|
|
43
|
+
* optional metadata extraction
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* ```ts
|
|
47
|
+
* const response = await client.extract.markdown({
|
|
48
|
+
* url: 'https://example.com/blog/article',
|
|
49
|
+
* });
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
52
|
+
markdown(body: ExtractMarkdownParams, options?: RequestOptions): APIPromise<ExtractMarkdownResponse>;
|
|
53
|
+
}
|
|
54
|
+
export type ExtractJsonResponse = {
|
|
55
|
+
[key: string]: unknown;
|
|
56
|
+
};
|
|
57
|
+
export interface ExtractMarkdownResponse {
|
|
58
|
+
/**
|
|
59
|
+
* The markdown content (includes metadata as YAML frontmatter by default)
|
|
60
|
+
*/
|
|
61
|
+
content: string;
|
|
62
|
+
/**
|
|
63
|
+
* The URL that was converted to markdown
|
|
64
|
+
*/
|
|
65
|
+
url: string;
|
|
66
|
+
/**
|
|
67
|
+
* Extracted metadata from the page (only included when metadata parameter is true)
|
|
68
|
+
*/
|
|
69
|
+
metadata?: ExtractMarkdownResponse.Metadata;
|
|
70
|
+
}
|
|
71
|
+
export declare namespace ExtractMarkdownResponse {
|
|
72
|
+
/**
|
|
73
|
+
* Extracted metadata from the page (only included when metadata parameter is true)
|
|
74
|
+
*/
|
|
75
|
+
interface Metadata {
|
|
76
|
+
/**
|
|
77
|
+
* Author information from HTML metadata
|
|
78
|
+
*/
|
|
79
|
+
author?: string;
|
|
80
|
+
/**
|
|
81
|
+
* Document creation date (ISO 8601)
|
|
82
|
+
*/
|
|
83
|
+
created_at?: string;
|
|
84
|
+
/**
|
|
85
|
+
* Creator application (e.g., "Microsoft Word")
|
|
86
|
+
*/
|
|
87
|
+
creator?: string;
|
|
88
|
+
/**
|
|
89
|
+
* Page description from Open Graph or HTML
|
|
90
|
+
*/
|
|
91
|
+
description?: string;
|
|
92
|
+
/**
|
|
93
|
+
* Featured image URL from Open Graph
|
|
94
|
+
*/
|
|
95
|
+
image?: string;
|
|
96
|
+
/**
|
|
97
|
+
* PDF keywords as array
|
|
98
|
+
*/
|
|
99
|
+
keywords?: Array<string>;
|
|
100
|
+
/**
|
|
101
|
+
* Document modification date (ISO 8601)
|
|
102
|
+
*/
|
|
103
|
+
modified_at?: string;
|
|
104
|
+
/**
|
|
105
|
+
* Number of pages (PDF documents)
|
|
106
|
+
*/
|
|
107
|
+
page_count?: number;
|
|
108
|
+
/**
|
|
109
|
+
* PDF version (e.g., "1.5")
|
|
110
|
+
*/
|
|
111
|
+
pdf_version?: string;
|
|
112
|
+
/**
|
|
113
|
+
* PDF producer software (e.g., "Adobe PDF Library")
|
|
114
|
+
*/
|
|
115
|
+
producer?: string;
|
|
116
|
+
/**
|
|
117
|
+
* Publisher information from Open Graph
|
|
118
|
+
*/
|
|
119
|
+
publisher?: string;
|
|
120
|
+
/**
|
|
121
|
+
* Site name from Open Graph
|
|
122
|
+
*/
|
|
123
|
+
site_name?: string;
|
|
124
|
+
/**
|
|
125
|
+
* PDF-specific metadata fields (populated for PDF documents) PDF subject or
|
|
126
|
+
* summary
|
|
127
|
+
*/
|
|
128
|
+
subject?: string;
|
|
129
|
+
/**
|
|
130
|
+
* Page title from Open Graph or HTML
|
|
131
|
+
*/
|
|
132
|
+
title?: string;
|
|
133
|
+
/**
|
|
134
|
+
* Content type from Open Graph (e.g., article, website)
|
|
135
|
+
*/
|
|
136
|
+
type?: string;
|
|
137
|
+
/**
|
|
138
|
+
* Canonical URL from Open Graph
|
|
139
|
+
*/
|
|
140
|
+
url?: string;
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
export interface ExtractJsonParams {
|
|
144
|
+
/**
|
|
145
|
+
* JSON schema definition that describes the structure of data to extract.
|
|
146
|
+
*/
|
|
147
|
+
json_schema: unknown;
|
|
148
|
+
/**
|
|
149
|
+
* URL to fetch and extract data from
|
|
150
|
+
*/
|
|
151
|
+
url: string;
|
|
152
|
+
/**
|
|
153
|
+
* Optional geotargeting parameters for proxy requests
|
|
154
|
+
*/
|
|
155
|
+
geo_target?: ExtractJsonParams.GeoTarget;
|
|
156
|
+
/**
|
|
157
|
+
* Bypass cache and force fresh data retrieval
|
|
158
|
+
*/
|
|
159
|
+
nocache?: boolean;
|
|
160
|
+
}
|
|
161
|
+
export declare namespace ExtractJsonParams {
|
|
162
|
+
/**
|
|
163
|
+
* Optional geotargeting parameters for proxy requests
|
|
164
|
+
*/
|
|
165
|
+
interface GeoTarget {
|
|
166
|
+
/**
|
|
167
|
+
* Country code using ISO 3166-1 alpha-2 standard (2 letters, e.g., "US", "GB",
|
|
168
|
+
* "JP"). See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
|
|
169
|
+
*/
|
|
170
|
+
country?: string;
|
|
171
|
+
}
|
|
172
|
+
}
|
|
173
|
+
export interface ExtractMarkdownParams {
|
|
174
|
+
/**
|
|
175
|
+
* URL to fetch and convert to markdown
|
|
176
|
+
*/
|
|
177
|
+
url: string;
|
|
178
|
+
/**
|
|
179
|
+
* Optional geotargeting parameters for proxy requests
|
|
180
|
+
*/
|
|
181
|
+
geo_target?: ExtractMarkdownParams.GeoTarget;
|
|
182
|
+
/**
|
|
183
|
+
* Include extracted metadata (Open Graph and HTML metadata) as a separate field in
|
|
184
|
+
* the response
|
|
185
|
+
*/
|
|
186
|
+
metadata?: boolean;
|
|
187
|
+
/**
|
|
188
|
+
* Bypass cache and force fresh data retrieval
|
|
189
|
+
*/
|
|
190
|
+
nocache?: boolean;
|
|
191
|
+
}
|
|
192
|
+
export declare namespace ExtractMarkdownParams {
|
|
193
|
+
/**
|
|
194
|
+
* Optional geotargeting parameters for proxy requests
|
|
195
|
+
*/
|
|
196
|
+
interface GeoTarget {
|
|
197
|
+
/**
|
|
198
|
+
* Country code using ISO 3166-1 alpha-2 standard (2 letters, e.g., "US", "GB",
|
|
199
|
+
* "JP"). See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
|
|
200
|
+
*/
|
|
201
|
+
country?: string;
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
export declare namespace Extract {
|
|
205
|
+
export { type ExtractJsonResponse as ExtractJsonResponse, type ExtractMarkdownResponse as ExtractMarkdownResponse, type ExtractJsonParams as ExtractJsonParams, type ExtractMarkdownParams as ExtractMarkdownParams, };
|
|
206
|
+
}
|
|
207
|
+
//# sourceMappingURL=extract.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"extract.d.ts","sourceRoot":"","sources":["../src/resources/extract.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,IAAI,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIxF;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAGrG;AAED,MAAM,MAAM,mBAAmB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE7D,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,uBAAuB,CAAC,QAAQ,CAAC;CAC7C;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC,SAAS,CAAC;IAEzC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,SAAS;QACxB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,qBAAqB,CAAC,SAAS,CAAC;IAE7C;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,SAAS;QACxB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Extract = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
class Extract extends resource_1.APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Fetches a URL and extracts structured data according to a provided JSON schema
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const response = await client.extract.json({
|
|
13
|
+
* json_schema: {
|
|
14
|
+
* properties: {
|
|
15
|
+
* stories: {
|
|
16
|
+
* items: {
|
|
17
|
+
* properties: {
|
|
18
|
+
* author: {
|
|
19
|
+
* description: 'Author username',
|
|
20
|
+
* type: 'string',
|
|
21
|
+
* },
|
|
22
|
+
* points: {
|
|
23
|
+
* description: 'Story points',
|
|
24
|
+
* type: 'number',
|
|
25
|
+
* },
|
|
26
|
+
* title: {
|
|
27
|
+
* description: 'Story title',
|
|
28
|
+
* type: 'string',
|
|
29
|
+
* },
|
|
30
|
+
* },
|
|
31
|
+
* type: 'object',
|
|
32
|
+
* },
|
|
33
|
+
* type: 'array',
|
|
34
|
+
* },
|
|
35
|
+
* },
|
|
36
|
+
* type: 'object',
|
|
37
|
+
* },
|
|
38
|
+
* url: 'https://news.ycombinator.com',
|
|
39
|
+
* });
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
json(body, options) {
|
|
43
|
+
return this._client.post('/extract/json', { body, ...options });
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Fetches a URL and converts its HTML content to clean Markdown format with
|
|
47
|
+
* optional metadata extraction
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* const response = await client.extract.markdown({
|
|
52
|
+
* url: 'https://example.com/blog/article',
|
|
53
|
+
* });
|
|
54
|
+
* ```
|
|
55
|
+
*/
|
|
56
|
+
markdown(body, options) {
|
|
57
|
+
return this._client.post('/extract/markdown', { body, ...options });
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
exports.Extract = Extract;
|
|
61
|
+
//# sourceMappingURL=extract.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"extract.js","sourceRoot":"","sources":["../src/resources/extract.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,IAAI,CAAC,IAAuB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAA2B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AAtDD,0BAsDC"}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
export class Extract extends APIResource {
|
|
4
|
+
/**
|
|
5
|
+
* Fetches a URL and extracts structured data according to a provided JSON schema
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* ```ts
|
|
9
|
+
* const response = await client.extract.json({
|
|
10
|
+
* json_schema: {
|
|
11
|
+
* properties: {
|
|
12
|
+
* stories: {
|
|
13
|
+
* items: {
|
|
14
|
+
* properties: {
|
|
15
|
+
* author: {
|
|
16
|
+
* description: 'Author username',
|
|
17
|
+
* type: 'string',
|
|
18
|
+
* },
|
|
19
|
+
* points: {
|
|
20
|
+
* description: 'Story points',
|
|
21
|
+
* type: 'number',
|
|
22
|
+
* },
|
|
23
|
+
* title: {
|
|
24
|
+
* description: 'Story title',
|
|
25
|
+
* type: 'string',
|
|
26
|
+
* },
|
|
27
|
+
* },
|
|
28
|
+
* type: 'object',
|
|
29
|
+
* },
|
|
30
|
+
* type: 'array',
|
|
31
|
+
* },
|
|
32
|
+
* },
|
|
33
|
+
* type: 'object',
|
|
34
|
+
* },
|
|
35
|
+
* url: 'https://news.ycombinator.com',
|
|
36
|
+
* });
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
json(body, options) {
|
|
40
|
+
return this._client.post('/extract/json', { body, ...options });
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Fetches a URL and converts its HTML content to clean Markdown format with
|
|
44
|
+
* optional metadata extraction
|
|
45
|
+
*
|
|
46
|
+
* @example
|
|
47
|
+
* ```ts
|
|
48
|
+
* const response = await client.extract.markdown({
|
|
49
|
+
* url: 'https://example.com/blog/article',
|
|
50
|
+
* });
|
|
51
|
+
* ```
|
|
52
|
+
*/
|
|
53
|
+
markdown(body, options) {
|
|
54
|
+
return this._client.post('/extract/markdown', { body, ...options });
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
//# sourceMappingURL=extract.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"extract.mjs","sourceRoot":"","sources":["../src/resources/extract.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,IAAI,CAAC,IAAuB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAA2B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
|
+
export declare class Generate extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Fetches URL content, extracts data, and transforms it using AI based on custom
|
|
7
|
+
* instructions. Use this to generate new content, summaries, or restructured data.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* const response = await client.generate.json({
|
|
12
|
+
* instructions:
|
|
13
|
+
* "For each story, categorize it (tech/business/science/other) and write a one-sentence summary explaining what it's about in simple terms.",
|
|
14
|
+
* json_schema: {
|
|
15
|
+
* properties: {
|
|
16
|
+
* summaries: {
|
|
17
|
+
* items: {
|
|
18
|
+
* properties: {
|
|
19
|
+
* category: {
|
|
20
|
+
* description: 'Story category (tech/business/science/etc)',
|
|
21
|
+
* type: 'string',
|
|
22
|
+
* },
|
|
23
|
+
* summary: { description: 'One-sentence summary of the story', type: 'string' },
|
|
24
|
+
* title: { description: 'Story title', type: 'string' },
|
|
25
|
+
* },
|
|
26
|
+
* type: 'object',
|
|
27
|
+
* },
|
|
28
|
+
* type: 'array',
|
|
29
|
+
* },
|
|
30
|
+
* },
|
|
31
|
+
* type: 'object',
|
|
32
|
+
* },
|
|
33
|
+
* url: 'https://news.ycombinator.com',
|
|
34
|
+
* });
|
|
35
|
+
* ```
|
|
36
|
+
*/
|
|
37
|
+
json(body: GenerateJsonParams, options?: RequestOptions): APIPromise<GenerateJsonResponse>;
|
|
38
|
+
}
|
|
39
|
+
export type GenerateJsonResponse = {
|
|
40
|
+
[key: string]: unknown;
|
|
41
|
+
};
|
|
42
|
+
export interface GenerateJsonParams {
|
|
43
|
+
/**
|
|
44
|
+
* Instructions describing how to transform the data
|
|
45
|
+
*/
|
|
46
|
+
instructions: string;
|
|
47
|
+
/**
|
|
48
|
+
* JSON schema defining the structure of the transformed output
|
|
49
|
+
*/
|
|
50
|
+
json_schema: unknown;
|
|
51
|
+
/**
|
|
52
|
+
* URL to fetch content from
|
|
53
|
+
*/
|
|
54
|
+
url: string;
|
|
55
|
+
/**
|
|
56
|
+
* Optional geotargeting parameters for proxy requests
|
|
57
|
+
*/
|
|
58
|
+
geo_target?: GenerateJsonParams.GeoTarget;
|
|
59
|
+
/**
|
|
60
|
+
* Bypass cache and force fresh data retrieval
|
|
61
|
+
*/
|
|
62
|
+
nocache?: boolean;
|
|
63
|
+
}
|
|
64
|
+
export declare namespace GenerateJsonParams {
|
|
65
|
+
/**
|
|
66
|
+
* Optional geotargeting parameters for proxy requests
|
|
67
|
+
*/
|
|
68
|
+
interface GeoTarget {
|
|
69
|
+
/**
|
|
70
|
+
* Country code using ISO 3166-1 alpha-2 standard (2 letters, e.g., "US", "GB",
|
|
71
|
+
* "JP"). See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
|
|
72
|
+
*/
|
|
73
|
+
country?: string;
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
export declare namespace Generate {
|
|
77
|
+
export { type GenerateJsonResponse as GenerateJsonResponse, type GenerateJsonParams as GenerateJsonParams };
|
|
78
|
+
}
|
|
79
|
+
//# sourceMappingURL=generate.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generate.d.mts","sourceRoot":"","sources":["../src/resources/generate.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,IAAI,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG3F;AAED,MAAM,MAAM,oBAAoB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE9D,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC,SAAS,CAAC;IAE1C;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,SAAS;QACxB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EAAE,KAAK,oBAAoB,IAAI,oBAAoB,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CAC7G"}
|