@tabstack/sdk 1.0.4 → 2.0.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 +90 -0
- package/LICENSE +22 -11
- package/README.md +276 -377
- 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 +74 -0
- package/resources/agent.d.mts.map +1 -0
- package/resources/agent.d.ts +74 -0
- package/resources/agent.d.ts.map +1 -0
- package/resources/agent.js +45 -0
- package/resources/agent.js.map +1 -0
- package/resources/agent.mjs +41 -0
- package/resources/agent.mjs.map +1 -0
- package/resources/extract.d.mts +118 -0
- package/resources/extract.d.mts.map +1 -0
- package/resources/extract.d.ts +118 -0
- package/resources/extract.d.ts.map +1 -0
- package/resources/extract.js +37 -0
- package/resources/extract.js.map +1 -0
- package/resources/extract.mjs +33 -0
- package/resources/extract.mjs.map +1 -0
- package/resources/generate.d.mts +45 -0
- package/resources/generate.d.mts.map +1 -0
- package/resources/generate.d.ts +45 -0
- package/resources/generate.d.ts.map +1 -0
- package/resources/generate.js +26 -0
- package/resources/generate.js.map +1 -0
- package/resources/generate.mjs +22 -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 +756 -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 +93 -0
- package/src/resources/extract.ts +147 -0
- package/src/resources/generate.ts +53 -0
- package/src/resources/index.ts +11 -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/automate.d.ts +0 -156
- package/dist/cjs/automate.d.ts.map +0 -1
- package/dist/cjs/automate.js +0 -211
- package/dist/cjs/automate.js.map +0 -1
- package/dist/cjs/automate.test.d.ts +0 -5
- package/dist/cjs/automate.test.d.ts.map +0 -1
- package/dist/cjs/automate.test.js +0 -441
- package/dist/cjs/automate.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 -256
- 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 -206
- package/dist/cjs/extract.d.ts.map +0 -1
- package/dist/cjs/extract.js +0 -223
- 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 -364
- 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/automate.d.ts +0 -156
- package/dist/esm/automate.d.ts.map +0 -1
- package/dist/esm/automate.js +0 -207
- package/dist/esm/automate.js.map +0 -1
- package/dist/esm/automate.test.d.ts +0 -5
- package/dist/esm/automate.test.d.ts.map +0 -1
- package/dist/esm/automate.test.js +0 -439
- package/dist/esm/automate.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 -254
- 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 -206
- package/dist/esm/extract.d.ts.map +0 -1
- package/dist/esm/extract.js +0 -219
- 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 -362
- 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/automate.d.ts +0 -156
- package/dist/types/automate.d.ts.map +0 -1
- package/dist/types/automate.test.d.ts +0 -5
- package/dist/types/automate.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 -206
- 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
|
@@ -1,239 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/**
|
|
3
|
-
* Tests for Exception classes
|
|
4
|
-
*/
|
|
5
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
const exceptions_1 = require("./exceptions");
|
|
7
|
-
describe('Exception Classes', () => {
|
|
8
|
-
describe('TABStackError', () => {
|
|
9
|
-
it('should create error with message', () => {
|
|
10
|
-
const error = new exceptions_1.TABStackError('Test error');
|
|
11
|
-
expect(error).toBeInstanceOf(Error);
|
|
12
|
-
expect(error).toBeInstanceOf(exceptions_1.TABStackError);
|
|
13
|
-
expect(error.message).toBe('Test error');
|
|
14
|
-
expect(error.name).toBe('TABStackError');
|
|
15
|
-
});
|
|
16
|
-
it('should create error with message and status code', () => {
|
|
17
|
-
const error = new exceptions_1.TABStackError('Test error', 418);
|
|
18
|
-
expect(error.message).toBe('Test error');
|
|
19
|
-
expect(error.statusCode).toBe(418);
|
|
20
|
-
});
|
|
21
|
-
it('should create error without status code', () => {
|
|
22
|
-
const error = new exceptions_1.TABStackError('Test error');
|
|
23
|
-
expect(error.message).toBe('Test error');
|
|
24
|
-
expect(error.statusCode).toBeUndefined();
|
|
25
|
-
});
|
|
26
|
-
it('should have correct prototype chain', () => {
|
|
27
|
-
const error = new exceptions_1.TABStackError('Test');
|
|
28
|
-
expect(Object.getPrototypeOf(error)).toBe(exceptions_1.TABStackError.prototype);
|
|
29
|
-
});
|
|
30
|
-
it('should be catchable as Error', () => {
|
|
31
|
-
try {
|
|
32
|
-
throw new exceptions_1.TABStackError('Test');
|
|
33
|
-
}
|
|
34
|
-
catch (error) {
|
|
35
|
-
expect(error).toBeInstanceOf(Error);
|
|
36
|
-
expect(error).toBeInstanceOf(exceptions_1.TABStackError);
|
|
37
|
-
}
|
|
38
|
-
});
|
|
39
|
-
});
|
|
40
|
-
describe('BadRequestError', () => {
|
|
41
|
-
it('should create error with message', () => {
|
|
42
|
-
const error = new exceptions_1.BadRequestError('Invalid request');
|
|
43
|
-
expect(error).toBeInstanceOf(Error);
|
|
44
|
-
expect(error).toBeInstanceOf(exceptions_1.TABStackError);
|
|
45
|
-
expect(error).toBeInstanceOf(exceptions_1.BadRequestError);
|
|
46
|
-
expect(error.message).toBe('Invalid request');
|
|
47
|
-
expect(error.name).toBe('BadRequestError');
|
|
48
|
-
});
|
|
49
|
-
it('should have status code 400', () => {
|
|
50
|
-
const error = new exceptions_1.BadRequestError('Test');
|
|
51
|
-
expect(error.statusCode).toBe(400);
|
|
52
|
-
});
|
|
53
|
-
it('should have correct prototype chain', () => {
|
|
54
|
-
const error = new exceptions_1.BadRequestError('Test');
|
|
55
|
-
expect(Object.getPrototypeOf(error)).toBe(exceptions_1.BadRequestError.prototype);
|
|
56
|
-
expect(error).toBeInstanceOf(exceptions_1.TABStackError);
|
|
57
|
-
});
|
|
58
|
-
it('should be catchable as TABStackError', () => {
|
|
59
|
-
try {
|
|
60
|
-
throw new exceptions_1.BadRequestError('Test');
|
|
61
|
-
}
|
|
62
|
-
catch (error) {
|
|
63
|
-
expect(error).toBeInstanceOf(exceptions_1.TABStackError);
|
|
64
|
-
expect(error).toBeInstanceOf(exceptions_1.BadRequestError);
|
|
65
|
-
}
|
|
66
|
-
});
|
|
67
|
-
});
|
|
68
|
-
describe('UnauthorizedError', () => {
|
|
69
|
-
it('should create error with custom message', () => {
|
|
70
|
-
const error = new exceptions_1.UnauthorizedError('Custom auth error');
|
|
71
|
-
expect(error).toBeInstanceOf(Error);
|
|
72
|
-
expect(error).toBeInstanceOf(exceptions_1.TABStackError);
|
|
73
|
-
expect(error).toBeInstanceOf(exceptions_1.UnauthorizedError);
|
|
74
|
-
expect(error.message).toBe('Custom auth error');
|
|
75
|
-
expect(error.name).toBe('UnauthorizedError');
|
|
76
|
-
});
|
|
77
|
-
it('should have default message', () => {
|
|
78
|
-
const error = new exceptions_1.UnauthorizedError();
|
|
79
|
-
expect(error.message).toBe('Unauthorized - Invalid or missing API key');
|
|
80
|
-
});
|
|
81
|
-
it('should have status code 401', () => {
|
|
82
|
-
const error = new exceptions_1.UnauthorizedError();
|
|
83
|
-
expect(error.statusCode).toBe(401);
|
|
84
|
-
});
|
|
85
|
-
it('should have correct prototype chain', () => {
|
|
86
|
-
const error = new exceptions_1.UnauthorizedError();
|
|
87
|
-
expect(Object.getPrototypeOf(error)).toBe(exceptions_1.UnauthorizedError.prototype);
|
|
88
|
-
expect(error).toBeInstanceOf(exceptions_1.TABStackError);
|
|
89
|
-
});
|
|
90
|
-
});
|
|
91
|
-
describe('InvalidURLError', () => {
|
|
92
|
-
it('should create error with custom message', () => {
|
|
93
|
-
const error = new exceptions_1.InvalidURLError('URL is malformed');
|
|
94
|
-
expect(error).toBeInstanceOf(Error);
|
|
95
|
-
expect(error).toBeInstanceOf(exceptions_1.TABStackError);
|
|
96
|
-
expect(error).toBeInstanceOf(exceptions_1.InvalidURLError);
|
|
97
|
-
expect(error.message).toBe('URL is malformed');
|
|
98
|
-
expect(error.name).toBe('InvalidURLError');
|
|
99
|
-
});
|
|
100
|
-
it('should have default message', () => {
|
|
101
|
-
const error = new exceptions_1.InvalidURLError();
|
|
102
|
-
expect(error.message).toBe('Invalid or inaccessible URL');
|
|
103
|
-
});
|
|
104
|
-
it('should have status code 422', () => {
|
|
105
|
-
const error = new exceptions_1.InvalidURLError();
|
|
106
|
-
expect(error.statusCode).toBe(422);
|
|
107
|
-
});
|
|
108
|
-
it('should have correct prototype chain', () => {
|
|
109
|
-
const error = new exceptions_1.InvalidURLError();
|
|
110
|
-
expect(Object.getPrototypeOf(error)).toBe(exceptions_1.InvalidURLError.prototype);
|
|
111
|
-
expect(error).toBeInstanceOf(exceptions_1.TABStackError);
|
|
112
|
-
});
|
|
113
|
-
});
|
|
114
|
-
describe('ServerError', () => {
|
|
115
|
-
it('should create error with custom message', () => {
|
|
116
|
-
const error = new exceptions_1.ServerError('Database connection failed');
|
|
117
|
-
expect(error).toBeInstanceOf(Error);
|
|
118
|
-
expect(error).toBeInstanceOf(exceptions_1.TABStackError);
|
|
119
|
-
expect(error).toBeInstanceOf(exceptions_1.ServerError);
|
|
120
|
-
expect(error.message).toBe('Database connection failed');
|
|
121
|
-
expect(error.name).toBe('ServerError');
|
|
122
|
-
});
|
|
123
|
-
it('should have default message', () => {
|
|
124
|
-
const error = new exceptions_1.ServerError();
|
|
125
|
-
expect(error.message).toBe('Internal server error');
|
|
126
|
-
});
|
|
127
|
-
it('should have status code 500', () => {
|
|
128
|
-
const error = new exceptions_1.ServerError();
|
|
129
|
-
expect(error.statusCode).toBe(500);
|
|
130
|
-
});
|
|
131
|
-
it('should have correct prototype chain', () => {
|
|
132
|
-
const error = new exceptions_1.ServerError();
|
|
133
|
-
expect(Object.getPrototypeOf(error)).toBe(exceptions_1.ServerError.prototype);
|
|
134
|
-
expect(error).toBeInstanceOf(exceptions_1.TABStackError);
|
|
135
|
-
});
|
|
136
|
-
});
|
|
137
|
-
describe('ServiceUnavailableError', () => {
|
|
138
|
-
it('should create error with custom message', () => {
|
|
139
|
-
const error = new exceptions_1.ServiceUnavailableError('Automate service is down');
|
|
140
|
-
expect(error).toBeInstanceOf(Error);
|
|
141
|
-
expect(error).toBeInstanceOf(exceptions_1.TABStackError);
|
|
142
|
-
expect(error).toBeInstanceOf(exceptions_1.ServiceUnavailableError);
|
|
143
|
-
expect(error.message).toBe('Automate service is down');
|
|
144
|
-
expect(error.name).toBe('ServiceUnavailableError');
|
|
145
|
-
});
|
|
146
|
-
it('should have default message', () => {
|
|
147
|
-
const error = new exceptions_1.ServiceUnavailableError();
|
|
148
|
-
expect(error.message).toBe('Service unavailable');
|
|
149
|
-
});
|
|
150
|
-
it('should have status code 503', () => {
|
|
151
|
-
const error = new exceptions_1.ServiceUnavailableError();
|
|
152
|
-
expect(error.statusCode).toBe(503);
|
|
153
|
-
});
|
|
154
|
-
it('should have correct prototype chain', () => {
|
|
155
|
-
const error = new exceptions_1.ServiceUnavailableError();
|
|
156
|
-
expect(Object.getPrototypeOf(error)).toBe(exceptions_1.ServiceUnavailableError.prototype);
|
|
157
|
-
expect(error).toBeInstanceOf(exceptions_1.TABStackError);
|
|
158
|
-
});
|
|
159
|
-
});
|
|
160
|
-
describe('APIError', () => {
|
|
161
|
-
it('should create error with message and status code', () => {
|
|
162
|
-
const error = new exceptions_1.APIError('Rate limit exceeded', 429);
|
|
163
|
-
expect(error).toBeInstanceOf(Error);
|
|
164
|
-
expect(error).toBeInstanceOf(exceptions_1.TABStackError);
|
|
165
|
-
expect(error).toBeInstanceOf(exceptions_1.APIError);
|
|
166
|
-
expect(error.message).toBe('Rate limit exceeded');
|
|
167
|
-
expect(error.statusCode).toBe(429);
|
|
168
|
-
expect(error.name).toBe('APIError');
|
|
169
|
-
});
|
|
170
|
-
it('should accept any status code', () => {
|
|
171
|
-
const error = new exceptions_1.APIError('Teapot', 418);
|
|
172
|
-
expect(error.statusCode).toBe(418);
|
|
173
|
-
});
|
|
174
|
-
it('should have correct prototype chain', () => {
|
|
175
|
-
const error = new exceptions_1.APIError('Test', 999);
|
|
176
|
-
expect(Object.getPrototypeOf(error)).toBe(exceptions_1.APIError.prototype);
|
|
177
|
-
expect(error).toBeInstanceOf(exceptions_1.TABStackError);
|
|
178
|
-
});
|
|
179
|
-
});
|
|
180
|
-
describe('Error inheritance and type checking', () => {
|
|
181
|
-
it('should distinguish between different error types', () => {
|
|
182
|
-
const badRequest = new exceptions_1.BadRequestError('Bad');
|
|
183
|
-
const unauthorized = new exceptions_1.UnauthorizedError('Unauth');
|
|
184
|
-
const serverError = new exceptions_1.ServerError('Server');
|
|
185
|
-
expect(badRequest).not.toBeInstanceOf(exceptions_1.UnauthorizedError);
|
|
186
|
-
expect(unauthorized).not.toBeInstanceOf(exceptions_1.BadRequestError);
|
|
187
|
-
expect(serverError).not.toBeInstanceOf(exceptions_1.UnauthorizedError);
|
|
188
|
-
expect(badRequest).toBeInstanceOf(exceptions_1.TABStackError);
|
|
189
|
-
expect(unauthorized).toBeInstanceOf(exceptions_1.TABStackError);
|
|
190
|
-
expect(serverError).toBeInstanceOf(exceptions_1.TABStackError);
|
|
191
|
-
});
|
|
192
|
-
it('should preserve error properties when caught and rethrown', () => {
|
|
193
|
-
try {
|
|
194
|
-
throw new exceptions_1.InvalidURLError('Bad URL');
|
|
195
|
-
}
|
|
196
|
-
catch (error) {
|
|
197
|
-
if (error instanceof exceptions_1.InvalidURLError) {
|
|
198
|
-
expect(error.message).toBe('Bad URL');
|
|
199
|
-
expect(error.statusCode).toBe(422);
|
|
200
|
-
expect(error.name).toBe('InvalidURLError');
|
|
201
|
-
}
|
|
202
|
-
else {
|
|
203
|
-
fail('Error should be InvalidURLError');
|
|
204
|
-
}
|
|
205
|
-
}
|
|
206
|
-
});
|
|
207
|
-
it('should work with instanceof checks in catch blocks', () => {
|
|
208
|
-
const testError = (error) => {
|
|
209
|
-
if (error instanceof exceptions_1.BadRequestError) {
|
|
210
|
-
return 'bad-request';
|
|
211
|
-
}
|
|
212
|
-
else if (error instanceof exceptions_1.UnauthorizedError) {
|
|
213
|
-
return 'unauthorized';
|
|
214
|
-
}
|
|
215
|
-
else if (error instanceof exceptions_1.TABStackError) {
|
|
216
|
-
return 'tabstack-error';
|
|
217
|
-
}
|
|
218
|
-
return 'unknown';
|
|
219
|
-
};
|
|
220
|
-
expect(testError(new exceptions_1.BadRequestError('test'))).toBe('bad-request');
|
|
221
|
-
expect(testError(new exceptions_1.UnauthorizedError('test'))).toBe('unauthorized');
|
|
222
|
-
expect(testError(new exceptions_1.ServerError('test'))).toBe('tabstack-error');
|
|
223
|
-
expect(testError(new Error('test'))).toBe('unknown');
|
|
224
|
-
});
|
|
225
|
-
});
|
|
226
|
-
describe('Error stack traces', () => {
|
|
227
|
-
it('should have stack trace', () => {
|
|
228
|
-
const error = new exceptions_1.TABStackError('Test');
|
|
229
|
-
expect(error.stack).toBeDefined();
|
|
230
|
-
expect(error.stack).toContain('TABStackError');
|
|
231
|
-
});
|
|
232
|
-
it('should have stack trace for derived errors', () => {
|
|
233
|
-
const error = new exceptions_1.BadRequestError('Test');
|
|
234
|
-
expect(error.stack).toBeDefined();
|
|
235
|
-
expect(error.stack).toContain('BadRequestError');
|
|
236
|
-
});
|
|
237
|
-
});
|
|
238
|
-
});
|
|
239
|
-
//# sourceMappingURL=exceptions.test.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"exceptions.test.js","sourceRoot":"","sources":["../../src/exceptions.test.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAEH,6CAQsB;AAEtB,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;YAC1C,MAAM,KAAK,GAAG,IAAI,0BAAa,CAAC,YAAY,CAAC,CAAC;YAC9C,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YACpC,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,0BAAa,CAAC,CAAC;YAC5C,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACzC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,KAAK,GAAG,IAAI,0BAAa,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;YACnD,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACzC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,MAAM,KAAK,GAAG,IAAI,0BAAa,CAAC,YAAY,CAAC,CAAC;YAC9C,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACzC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,aAAa,EAAE,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;YAC7C,MAAM,KAAK,GAAG,IAAI,0BAAa,CAAC,MAAM,CAAC,CAAC;YACxC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,0BAAa,CAAC,SAAS,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;YACtC,IAAI,CAAC;gBACH,MAAM,IAAI,0BAAa,CAAC,MAAM,CAAC,CAAC;YAClC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;gBACpC,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,0BAAa,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;QAC/B,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;YAC1C,MAAM,KAAK,GAAG,IAAI,4BAAe,CAAC,iBAAiB,CAAC,CAAC;YACrD,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YACpC,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,0BAAa,CAAC,CAAC;YAC5C,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,4BAAe,CAAC,CAAC;YAC9C,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC9C,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,KAAK,GAAG,IAAI,4BAAe,CAAC,MAAM,CAAC,CAAC;YAC1C,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;YAC7C,MAAM,KAAK,GAAG,IAAI,4BAAe,CAAC,MAAM,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,4BAAe,CAAC,SAAS,CAAC,CAAC;YACrE,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,0BAAa,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAC9C,IAAI,CAAC;gBACH,MAAM,IAAI,4BAAe,CAAC,MAAM,CAAC,CAAC;YACpC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,0BAAa,CAAC,CAAC;gBAC5C,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,4BAAe,CAAC,CAAC;YAChD,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,MAAM,KAAK,GAAG,IAAI,8BAAiB,CAAC,mBAAmB,CAAC,CAAC;YACzD,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YACpC,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,0BAAa,CAAC,CAAC;YAC5C,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,8BAAiB,CAAC,CAAC;YAChD,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;YAChD,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,KAAK,GAAG,IAAI,8BAAiB,EAAE,CAAC;YACtC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,KAAK,GAAG,IAAI,8BAAiB,EAAE,CAAC;YACtC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;YAC7C,MAAM,KAAK,GAAG,IAAI,8BAAiB,EAAE,CAAC;YACtC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,8BAAiB,CAAC,SAAS,CAAC,CAAC;YACvE,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,0BAAa,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;QAC/B,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,MAAM,KAAK,GAAG,IAAI,4BAAe,CAAC,kBAAkB,CAAC,CAAC;YACtD,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YACpC,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,0BAAa,CAAC,CAAC;YAC5C,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,4BAAe,CAAC,CAAC;YAC9C,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAC/C,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,KAAK,GAAG,IAAI,4BAAe,EAAE,CAAC;YACpC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,KAAK,GAAG,IAAI,4BAAe,EAAE,CAAC;YACpC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;YAC7C,MAAM,KAAK,GAAG,IAAI,4BAAe,EAAE,CAAC;YACpC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,4BAAe,CAAC,SAAS,CAAC,CAAC;YACrE,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,0BAAa,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAC3B,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,MAAM,KAAK,GAAG,IAAI,wBAAW,CAAC,4BAA4B,CAAC,CAAC;YAC5D,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YACpC,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,0BAAa,CAAC,CAAC;YAC5C,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,wBAAW,CAAC,CAAC;YAC1C,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;YACzD,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,KAAK,GAAG,IAAI,wBAAW,EAAE,CAAC;YAChC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,KAAK,GAAG,IAAI,wBAAW,EAAE,CAAC;YAChC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;YAC7C,MAAM,KAAK,GAAG,IAAI,wBAAW,EAAE,CAAC;YAChC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAW,CAAC,SAAS,CAAC,CAAC;YACjE,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,0BAAa,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACvC,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,MAAM,KAAK,GAAG,IAAI,oCAAuB,CAAC,0BAA0B,CAAC,CAAC;YACtE,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YACpC,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,0BAAa,CAAC,CAAC;YAC5C,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,oCAAuB,CAAC,CAAC;YACtD,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;YACvD,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,KAAK,GAAG,IAAI,oCAAuB,EAAE,CAAC;YAC5C,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,KAAK,GAAG,IAAI,oCAAuB,EAAE,CAAC;YAC5C,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;YAC7C,MAAM,KAAK,GAAG,IAAI,oCAAuB,EAAE,CAAC;YAC5C,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,oCAAuB,CAAC,SAAS,CAAC,CAAC;YAC7E,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,0BAAa,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;QACxB,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,KAAK,GAAG,IAAI,qBAAQ,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAC;YACvD,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YACpC,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,0BAAa,CAAC,CAAC;YAC5C,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,qBAAQ,CAAC,CAAC;YACvC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YAClD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACnC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;YACvC,MAAM,KAAK,GAAG,IAAI,qBAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;YAC1C,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;YAC7C,MAAM,KAAK,GAAG,IAAI,qBAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YACxC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAQ,CAAC,SAAS,CAAC,CAAC;YAC9D,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,0BAAa,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,qCAAqC,EAAE,GAAG,EAAE;QACnD,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,UAAU,GAAG,IAAI,4BAAe,CAAC,KAAK,CAAC,CAAC;YAC9C,MAAM,YAAY,GAAG,IAAI,8BAAiB,CAAC,QAAQ,CAAC,CAAC;YACrD,MAAM,WAAW,GAAG,IAAI,wBAAW,CAAC,QAAQ,CAAC,CAAC;YAE9C,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,8BAAiB,CAAC,CAAC;YACzD,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,4BAAe,CAAC,CAAC;YACzD,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,8BAAiB,CAAC,CAAC;YAE1D,MAAM,CAAC,UAAU,CAAC,CAAC,cAAc,CAAC,0BAAa,CAAC,CAAC;YACjD,MAAM,CAAC,YAAY,CAAC,CAAC,cAAc,CAAC,0BAAa,CAAC,CAAC;YACnD,MAAM,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC,0BAAa,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACnE,IAAI,CAAC;gBACH,MAAM,IAAI,4BAAe,CAAC,SAAS,CAAC,CAAC;YACvC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,KAAK,YAAY,4BAAe,EAAE,CAAC;oBACrC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBACtC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACnC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;gBAC7C,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,iCAAiC,CAAC,CAAC;gBAC1C,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC5D,MAAM,SAAS,GAAG,CAAC,KAAY,EAAE,EAAE;gBACjC,IAAI,KAAK,YAAY,4BAAe,EAAE,CAAC;oBACrC,OAAO,aAAa,CAAC;gBACvB,CAAC;qBAAM,IAAI,KAAK,YAAY,8BAAiB,EAAE,CAAC;oBAC9C,OAAO,cAAc,CAAC;gBACxB,CAAC;qBAAM,IAAI,KAAK,YAAY,0BAAa,EAAE,CAAC;oBAC1C,OAAO,gBAAgB,CAAC;gBAC1B,CAAC;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC,CAAC;YAEF,MAAM,CAAC,SAAS,CAAC,IAAI,4BAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACnE,MAAM,CAAC,SAAS,CAAC,IAAI,8BAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACtE,MAAM,CAAC,SAAS,CAAC,IAAI,wBAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAClE,MAAM,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;YACjC,MAAM,KAAK,GAAG,IAAI,0BAAa,CAAC,MAAM,CAAC,CAAC;YACxC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YAClC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,KAAK,GAAG,IAAI,4BAAe,CAAC,MAAM,CAAC,CAAC;YAC1C,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;YAClC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
package/dist/cjs/extract.d.ts
DELETED
|
@@ -1,206 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Extract operator for TABStack AI SDK
|
|
3
|
-
*/
|
|
4
|
-
import { HTTPClient } from './util/http';
|
|
5
|
-
import { MarkdownResponse, JsonResponse } from './types';
|
|
6
|
-
export interface ExtractMarkdownOptions {
|
|
7
|
-
metadata?: boolean;
|
|
8
|
-
nocache?: boolean;
|
|
9
|
-
}
|
|
10
|
-
export interface ExtractSchemaOptions {
|
|
11
|
-
instructions?: string;
|
|
12
|
-
nocache?: boolean;
|
|
13
|
-
}
|
|
14
|
-
export interface ExtractJsonOptions {
|
|
15
|
-
nocache?: boolean;
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* Extract operator for converting and extracting web content
|
|
19
|
-
*
|
|
20
|
-
* This class provides methods for extracting content from URLs in various formats:
|
|
21
|
-
* - Markdown conversion
|
|
22
|
-
* - Schema generation
|
|
23
|
-
* - Structured JSON extraction
|
|
24
|
-
*/
|
|
25
|
-
export declare class Extract {
|
|
26
|
-
private httpClient;
|
|
27
|
-
constructor(httpClient: HTTPClient);
|
|
28
|
-
/**
|
|
29
|
-
* Convert URL content to Markdown format
|
|
30
|
-
*
|
|
31
|
-
* Fetches a URL and converts its HTML content to clean Markdown format with
|
|
32
|
-
* optional metadata extraction. By default, metadata is included in the content
|
|
33
|
-
* as YAML frontmatter. When metadata option is true, it's also returned as
|
|
34
|
-
* a separate field in the response.
|
|
35
|
-
*
|
|
36
|
-
* @param url - URL to fetch and convert to markdown
|
|
37
|
-
* @param options - Optional extraction options
|
|
38
|
-
* @param options.metadata - Include extracted metadata (Open Graph and HTML metadata) as a separate field in the response. Default: false
|
|
39
|
-
* @param options.nocache - Bypass cache and force fresh data retrieval. Default: false
|
|
40
|
-
*
|
|
41
|
-
* @returns MarkdownResponse containing the converted content and optional metadata
|
|
42
|
-
*
|
|
43
|
-
* @throws {BadRequestError} When URL is missing
|
|
44
|
-
* @throws {UnauthorizedError} When API key is invalid or missing
|
|
45
|
-
* @throws {InvalidURLError} When URL is invalid or inaccessible
|
|
46
|
-
* @throws {ServerError} When server fails to fetch or convert the content
|
|
47
|
-
*
|
|
48
|
-
* @example
|
|
49
|
-
* Basic usage:
|
|
50
|
-
* ```typescript
|
|
51
|
-
* const result = await tabs.extract.markdown('https://example.com/blog/article');
|
|
52
|
-
* console.log(result.content); // Markdown with YAML frontmatter
|
|
53
|
-
* ```
|
|
54
|
-
*
|
|
55
|
-
* @example
|
|
56
|
-
* With separate metadata field:
|
|
57
|
-
* ```typescript
|
|
58
|
-
* const result = await tabs.extract.markdown('https://example.com/blog/article', {
|
|
59
|
-
* metadata: true
|
|
60
|
-
* });
|
|
61
|
-
* console.log(result.content); // Markdown without frontmatter
|
|
62
|
-
* console.log(result.metadata?.title); // "Example Article Title"
|
|
63
|
-
* console.log(result.metadata?.author); // "Example Author"
|
|
64
|
-
* console.log(result.metadata?.image); // "https://example.com/images/article.jpg"
|
|
65
|
-
* ```
|
|
66
|
-
*
|
|
67
|
-
* @example
|
|
68
|
-
* Force fresh data retrieval:
|
|
69
|
-
* ```typescript
|
|
70
|
-
* const result = await tabs.extract.markdown('https://example.com/blog/article', {
|
|
71
|
-
* nocache: true
|
|
72
|
-
* });
|
|
73
|
-
* ```
|
|
74
|
-
*/
|
|
75
|
-
markdown(url: string, options?: ExtractMarkdownOptions): Promise<MarkdownResponse>;
|
|
76
|
-
/**
|
|
77
|
-
* Generate JSON schema from URL content
|
|
78
|
-
*
|
|
79
|
-
* Analyzes URL content and generates a JSON schema that describes the structure
|
|
80
|
-
* of the data. Use this to create schemas for the json() method when you don't
|
|
81
|
-
* know the structure in advance. The generated schema can then be used to extract
|
|
82
|
-
* structured data from similar pages.
|
|
83
|
-
*
|
|
84
|
-
* @param url - URL to analyze and extract schema from
|
|
85
|
-
* @param options - Optional schema generation options
|
|
86
|
-
* @param options.instructions - Optional instructions to guide schema generation (max 1000 characters). Example: "extract only the top stories, for each story include the title, points, author, and comment count"
|
|
87
|
-
* @param options.nocache - Bypass cache and force fresh data retrieval. Default: false
|
|
88
|
-
*
|
|
89
|
-
* @returns The generated JSON schema object
|
|
90
|
-
*
|
|
91
|
-
* @throws {BadRequestError} When URL is missing or schema format is invalid
|
|
92
|
-
* @throws {UnauthorizedError} When API key is invalid or missing
|
|
93
|
-
* @throws {InvalidURLError} When URL is invalid
|
|
94
|
-
* @throws {ServerError} When server fails to fetch URL, page is too large, or schema generation fails
|
|
95
|
-
*
|
|
96
|
-
* @example
|
|
97
|
-
* Basic usage:
|
|
98
|
-
* ```typescript
|
|
99
|
-
* const schema = await tabs.extract.schema('https://news.ycombinator.com');
|
|
100
|
-
* console.log(schema); // JSON schema object describing the page structure
|
|
101
|
-
* ```
|
|
102
|
-
*
|
|
103
|
-
* @example
|
|
104
|
-
* With instructions:
|
|
105
|
-
* ```typescript
|
|
106
|
-
* const schema = await tabs.extract.schema('https://news.ycombinator.com', {
|
|
107
|
-
* instructions: 'extract only the top stories, for each story include the title, points, author, and comment count'
|
|
108
|
-
* });
|
|
109
|
-
* // Use the generated schema to extract data
|
|
110
|
-
* const data = await tabs.extract.json('https://news.ycombinator.com', schema);
|
|
111
|
-
* console.log(data.data); // Structured data matching the schema
|
|
112
|
-
* ```
|
|
113
|
-
*/
|
|
114
|
-
schema(url: string, options?: ExtractSchemaOptions): Promise<Record<string, unknown>>;
|
|
115
|
-
/**
|
|
116
|
-
* Extract structured JSON from URL content
|
|
117
|
-
*
|
|
118
|
-
* Fetches a URL and extracts structured data according to a provided JSON schema.
|
|
119
|
-
* The schema defines what data to extract and its structure. You can define your
|
|
120
|
-
* schema manually or generate one using the schema() method.
|
|
121
|
-
*
|
|
122
|
-
* @param url - URL to fetch and extract data from
|
|
123
|
-
* @param schema - JSON schema object defining the structure of data to extract
|
|
124
|
-
* @param options - Optional extraction options
|
|
125
|
-
* @param options.nocache - Bypass cache and force fresh data retrieval. Default: false
|
|
126
|
-
*
|
|
127
|
-
* @returns JsonResponse containing the extracted data matching the schema
|
|
128
|
-
*
|
|
129
|
-
* @throws {BadRequestError} When URL or schema is missing, or schema format is invalid
|
|
130
|
-
* @throws {UnauthorizedError} When API key is invalid or missing
|
|
131
|
-
* @throws {InvalidURLError} When URL is invalid
|
|
132
|
-
* @throws {ServerError} When server fails to fetch URL, page is too large, or JSON generation fails
|
|
133
|
-
*
|
|
134
|
-
* @example
|
|
135
|
-
* Extract news stories:
|
|
136
|
-
* ```typescript
|
|
137
|
-
* const schema = {
|
|
138
|
-
* type: 'object',
|
|
139
|
-
* properties: {
|
|
140
|
-
* stories: {
|
|
141
|
-
* type: 'array',
|
|
142
|
-
* items: {
|
|
143
|
-
* type: 'object',
|
|
144
|
-
* properties: {
|
|
145
|
-
* title: { type: 'string' },
|
|
146
|
-
* points: { type: 'number' },
|
|
147
|
-
* author: { type: 'string' }
|
|
148
|
-
* },
|
|
149
|
-
* required: ['title', 'points', 'author']
|
|
150
|
-
* }
|
|
151
|
-
* }
|
|
152
|
-
* },
|
|
153
|
-
* required: ['stories']
|
|
154
|
-
* };
|
|
155
|
-
*
|
|
156
|
-
* const result = await tabs.extract.json('https://news.ycombinator.com', schema);
|
|
157
|
-
* console.log(result.data.stories); // Array of story objects
|
|
158
|
-
* ```
|
|
159
|
-
*
|
|
160
|
-
* @example
|
|
161
|
-
* Extract product information:
|
|
162
|
-
* ```typescript
|
|
163
|
-
* const schema = {
|
|
164
|
-
* type: 'object',
|
|
165
|
-
* properties: {
|
|
166
|
-
* name: { type: 'string' },
|
|
167
|
-
* price: { type: 'number' },
|
|
168
|
-
* inStock: { type: 'boolean' },
|
|
169
|
-
* features: {
|
|
170
|
-
* type: 'array',
|
|
171
|
-
* items: { type: 'string' }
|
|
172
|
-
* }
|
|
173
|
-
* },
|
|
174
|
-
* required: ['name', 'price', 'inStock']
|
|
175
|
-
* };
|
|
176
|
-
*
|
|
177
|
-
* const result = await tabs.extract.json(
|
|
178
|
-
* 'https://example-store.com/product/wireless-headphones',
|
|
179
|
-
* schema
|
|
180
|
-
* );
|
|
181
|
-
* console.log(result.data.name); // "Premium Wireless Headphones"
|
|
182
|
-
* console.log(result.data.price); // 299.99
|
|
183
|
-
* console.log(result.data.inStock); // true
|
|
184
|
-
* ```
|
|
185
|
-
*
|
|
186
|
-
* @example
|
|
187
|
-
* Using generated schema:
|
|
188
|
-
* ```typescript
|
|
189
|
-
* const schema = await tabs.extract.schema('https://news.ycombinator.com', {
|
|
190
|
-
* instructions: 'extract top stories with title, points, and author'
|
|
191
|
-
* });
|
|
192
|
-
* const result = await tabs.extract.json('https://news.ycombinator.com', schema);
|
|
193
|
-
* console.log(result.data);
|
|
194
|
-
* ```
|
|
195
|
-
*
|
|
196
|
-
* @example
|
|
197
|
-
* Force fresh data retrieval:
|
|
198
|
-
* ```typescript
|
|
199
|
-
* const result = await tabs.extract.json('https://news.ycombinator.com', schema, {
|
|
200
|
-
* nocache: true
|
|
201
|
-
* });
|
|
202
|
-
* ```
|
|
203
|
-
*/
|
|
204
|
-
json<T = unknown>(url: string, schema: Record<string, unknown>, options?: ExtractJsonOptions): Promise<JsonResponse<T>>;
|
|
205
|
-
}
|
|
206
|
-
//# sourceMappingURL=extract.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"extract.d.ts","sourceRoot":"","sources":["../../src/extract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEzD,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;GAOG;AACH,qBAAa,OAAO;IACN,OAAO,CAAC,UAAU;gBAAV,UAAU,EAAE,UAAU;IAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYxF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAW3F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwFG;IACG,IAAI,CAAC,CAAC,GAAG,OAAO,EACpB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,OAAO,CAAC,EAAE,kBAAkB,GAC3B,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;CAU5B"}
|