@tabstack/sdk 1.0.5 → 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 +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 +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/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
package/dist/types/agent.d.ts
DELETED
|
@@ -1,156 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Agent client for Tabstack SDK
|
|
3
|
-
*/
|
|
4
|
-
import { HTTPClient } from './util/http';
|
|
5
|
-
import { AutomateEvent } from './types';
|
|
6
|
-
export interface AutomateOptions {
|
|
7
|
-
url?: string;
|
|
8
|
-
data?: Record<string, unknown>;
|
|
9
|
-
guardrails?: string;
|
|
10
|
-
maxIterations?: number;
|
|
11
|
-
maxValidationAttempts?: number;
|
|
12
|
-
}
|
|
13
|
-
/**
|
|
14
|
-
* Agent client for AI-powered web automation
|
|
15
|
-
*
|
|
16
|
-
* This class provides methods for executing complex web automation tasks using
|
|
17
|
-
* natural language instructions. The automation runs in a browser and streams
|
|
18
|
-
* real-time progress updates.
|
|
19
|
-
*/
|
|
20
|
-
export declare class Agent {
|
|
21
|
-
private httpClient;
|
|
22
|
-
constructor(httpClient: HTTPClient);
|
|
23
|
-
/**
|
|
24
|
-
* Execute AI-powered browser automation task with streaming updates
|
|
25
|
-
*
|
|
26
|
-
* Execute complex web automation tasks using natural language instructions. This method
|
|
27
|
-
* always streams responses using Server-Sent Events (SSE), providing real-time progress
|
|
28
|
-
* updates as the task executes. Perfect for web scraping, form filling, navigation,
|
|
29
|
-
* information gathering, and multi-step workflows.
|
|
30
|
-
*
|
|
31
|
-
* @param task - The task description in natural language. Example: "Find the top 3 trending repositories on GitHub and extract their names, descriptions, and star counts"
|
|
32
|
-
* @param options - Optional automation options
|
|
33
|
-
* @param options.url - Starting URL for the task. Optional but recommended for better context.
|
|
34
|
-
* @param options.data - JSON data to provide context for form filling or complex tasks. Example: { "language": "Python", "timeRange": "today" }
|
|
35
|
-
* @param options.guardrails - Safety constraints for execution. Example: "browse and extract data only, don't star or fork repositories"
|
|
36
|
-
* @param options.maxIterations - Maximum task iterations. Default: 50, Min: 1, Max: 100
|
|
37
|
-
* @param options.maxValidationAttempts - Maximum validation attempts. Default: 3, Min: 1, Max: 10
|
|
38
|
-
*
|
|
39
|
-
* @yields AutomateEvent objects representing different stages of task execution
|
|
40
|
-
*
|
|
41
|
-
* @throws {BadRequestError} When task is missing, URL format is invalid, or maxIterations is out of range
|
|
42
|
-
* @throws {UnauthorizedError} When API key is invalid or missing
|
|
43
|
-
* @throws {ServerError} When automation server call fails
|
|
44
|
-
* @throws {ServiceUnavailableError} When automate service is not available
|
|
45
|
-
*
|
|
46
|
-
* Event Types:
|
|
47
|
-
* - **Task Events**: `start`, `task:setup`, `task:started`, `task:completed`, `task:aborted`, `task:validated`, `task:validation_error`
|
|
48
|
-
* - **Agent Events**: `agent:processing`, `agent:status`, `agent:step`, `agent:action`, `agent:reasoned`, `agent:extracted`, `agent:waiting`
|
|
49
|
-
* - **Browser Events**: `browser:navigated`, `browser:action_started`, `browser:action_completed`, `browser:screenshot_captured`
|
|
50
|
-
* - **System Events**: `system:debug_compression`, `system:debug_message`
|
|
51
|
-
* - **Stream Control**: `complete`, `done`, `error`
|
|
52
|
-
*
|
|
53
|
-
* @example
|
|
54
|
-
* Extract GitHub trending repositories:
|
|
55
|
-
* ```typescript
|
|
56
|
-
* for await (const event of tabs.agent.automate(
|
|
57
|
-
* 'Find the top 3 trending repositories and extract their names, descriptions, and star counts',
|
|
58
|
-
* {
|
|
59
|
-
* url: 'https://github.com/trending',
|
|
60
|
-
* guardrails: 'browse and extract only, don\'t interact with repositories'
|
|
61
|
-
* }
|
|
62
|
-
* )) {
|
|
63
|
-
* console.log(`Event: ${event.type}`);
|
|
64
|
-
*
|
|
65
|
-
* if (event.type === 'task:completed') {
|
|
66
|
-
* console.log('Result:', event.data.get('finalAnswer'));
|
|
67
|
-
* } else if (event.type === 'agent:extracted') {
|
|
68
|
-
* console.log('Extracted data:', event.data.get('extractedData'));
|
|
69
|
-
* } else if (event.type === 'browser:navigated') {
|
|
70
|
-
* console.log('Navigated to:', event.data.get('url'));
|
|
71
|
-
* }
|
|
72
|
-
* }
|
|
73
|
-
* ```
|
|
74
|
-
*
|
|
75
|
-
* @example
|
|
76
|
-
* Scrape product information:
|
|
77
|
-
* ```typescript
|
|
78
|
-
* for await (const event of tabs.agent.automate(
|
|
79
|
-
* 'Find the product name, price, and availability status',
|
|
80
|
-
* {
|
|
81
|
-
* url: 'https://example-store.com/product/wireless-headphones',
|
|
82
|
-
* guardrails: 'extract product details only, don\'t add to cart or checkout',
|
|
83
|
-
* maxIterations: 20
|
|
84
|
-
* }
|
|
85
|
-
* )) {
|
|
86
|
-
* if (event.type === 'agent:processing') {
|
|
87
|
-
* console.log('Agent thinking:', event.data.get('operation'));
|
|
88
|
-
* } else if (event.type === 'task:completed') {
|
|
89
|
-
* const result = event.data.get('finalAnswer');
|
|
90
|
-
* console.log('Product info:', result);
|
|
91
|
-
* }
|
|
92
|
-
* }
|
|
93
|
-
* ```
|
|
94
|
-
*
|
|
95
|
-
* @example
|
|
96
|
-
* Fill out contact form:
|
|
97
|
-
* ```typescript
|
|
98
|
-
* for await (const event of tabs.agent.automate(
|
|
99
|
-
* 'Submit the contact form with my information',
|
|
100
|
-
* {
|
|
101
|
-
* url: 'https://company.com/contact',
|
|
102
|
-
* data: {
|
|
103
|
-
* name: 'Alex Johnson',
|
|
104
|
-
* email: 'alex@example.com',
|
|
105
|
-
* message: 'Interested in learning more about your enterprise plan'
|
|
106
|
-
* },
|
|
107
|
-
* maxIterations: 30,
|
|
108
|
-
* maxValidationAttempts: 5
|
|
109
|
-
* }
|
|
110
|
-
* )) {
|
|
111
|
-
* if (event.type === 'agent:action') {
|
|
112
|
-
* console.log('Action:', event.data.get('action'), event.data.get('value'));
|
|
113
|
-
* } else if (event.type === 'task:completed') {
|
|
114
|
-
* console.log('Form submitted successfully!');
|
|
115
|
-
* }
|
|
116
|
-
* }
|
|
117
|
-
* ```
|
|
118
|
-
*
|
|
119
|
-
* @example
|
|
120
|
-
* Handle all event types:
|
|
121
|
-
* ```typescript
|
|
122
|
-
* for await (const event of tabs.agent.automate(
|
|
123
|
-
* 'Research TypeScript frameworks and compare them',
|
|
124
|
-
* { url: 'https://www.npmjs.com' }
|
|
125
|
-
* )) {
|
|
126
|
-
* switch (event.type) {
|
|
127
|
-
* case 'start':
|
|
128
|
-
* console.log('Task started');
|
|
129
|
-
* break;
|
|
130
|
-
* case 'agent:status':
|
|
131
|
-
* console.log('Status:', event.data.get('message'));
|
|
132
|
-
* break;
|
|
133
|
-
* case 'agent:step':
|
|
134
|
-
* const iteration = event.data.get('currentIteration');
|
|
135
|
-
* console.log(`Processing step ${iteration}...`);
|
|
136
|
-
* break;
|
|
137
|
-
* case 'browser:navigated':
|
|
138
|
-
* console.log('Page:', event.data.get('title'));
|
|
139
|
-
* break;
|
|
140
|
-
* case 'task:completed':
|
|
141
|
-
* console.log('Final result:', event.data.get('finalAnswer'));
|
|
142
|
-
* break;
|
|
143
|
-
* case 'error':
|
|
144
|
-
* console.error('Error occurred:', event.data.getRaw());
|
|
145
|
-
* break;
|
|
146
|
-
* }
|
|
147
|
-
* }
|
|
148
|
-
* ```
|
|
149
|
-
*/
|
|
150
|
-
automate(task: string, options?: AutomateOptions): AsyncGenerator<AutomateEvent, void, undefined>;
|
|
151
|
-
/**
|
|
152
|
-
* Parse SSE event data
|
|
153
|
-
*/
|
|
154
|
-
private parseEvent;
|
|
155
|
-
}
|
|
156
|
-
//# sourceMappingURL=agent.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../../src/agent.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,MAAM,WAAW,eAAe;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;;;;;GAMG;AACH,qBAAa,KAAK;IACJ,OAAO,CAAC,UAAU;gBAAV,UAAU,EAAE,UAAU;IAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8HG;IACI,QAAQ,CACb,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,eAAe,GACxB,cAAc,CAAC,aAAa,EAAE,IAAI,EAAE,SAAS,CAAC;IAkDjD;;OAEG;IACH,OAAO,CAAC,UAAU;CASnB"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"agent.test.d.ts","sourceRoot":"","sources":["../../src/agent.test.ts"],"names":[],"mappings":"AAAA;;GAEG"}
|
package/dist/types/client.d.ts
DELETED
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Main client for Tabstack SDK
|
|
3
|
-
*/
|
|
4
|
-
import { Extract } from './extract';
|
|
5
|
-
import { Generate } from './generate';
|
|
6
|
-
import { Agent } from './agent';
|
|
7
|
-
export interface TabstackOptions {
|
|
8
|
-
apiKey: string;
|
|
9
|
-
baseURL?: string;
|
|
10
|
-
}
|
|
11
|
-
/**
|
|
12
|
-
* Tabstack client for web content extraction, generation, and automation
|
|
13
|
-
*
|
|
14
|
-
* This is the main entry point for the Tabstack SDK. Initialize it with your
|
|
15
|
-
* API key to access the extract, generate, and automate operators.
|
|
16
|
-
*
|
|
17
|
-
* @example
|
|
18
|
-
* ```typescript
|
|
19
|
-
* import { Tabstack } from '@tabstack/sdk';
|
|
20
|
-
*
|
|
21
|
-
* const tabs = new Tabstack({
|
|
22
|
-
* apiKey: process.env.TABSTACK_API_KEY!
|
|
23
|
-
* });
|
|
24
|
-
*
|
|
25
|
-
* const result = await tabs.extract.markdown('https://example.com');
|
|
26
|
-
* console.log(result.content);
|
|
27
|
-
* ```
|
|
28
|
-
*/
|
|
29
|
-
export declare class Tabstack {
|
|
30
|
-
private httpClient;
|
|
31
|
-
/**
|
|
32
|
-
* Extract operator for converting and extracting web content
|
|
33
|
-
*/
|
|
34
|
-
readonly extract: Extract;
|
|
35
|
-
/**
|
|
36
|
-
* Generate operator for AI-powered content transformation
|
|
37
|
-
*/
|
|
38
|
-
readonly generate: Generate;
|
|
39
|
-
/**
|
|
40
|
-
* Agent client for AI-powered browser automation tasks
|
|
41
|
-
*/
|
|
42
|
-
readonly agent: Agent;
|
|
43
|
-
/**
|
|
44
|
-
* Initialize Tabstack client
|
|
45
|
-
*
|
|
46
|
-
* @param options - Configuration options
|
|
47
|
-
* @throws Error if apiKey is empty or not provided
|
|
48
|
-
*
|
|
49
|
-
* @example
|
|
50
|
-
* ```typescript
|
|
51
|
-
* const tabs = new Tabstack({
|
|
52
|
-
* apiKey: 'your-api-key-here'
|
|
53
|
-
* });
|
|
54
|
-
* ```
|
|
55
|
-
*/
|
|
56
|
-
constructor(options: TabstackOptions);
|
|
57
|
-
}
|
|
58
|
-
//# sourceMappingURL=client.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,UAAU,CAAa;IAE/B;;OAEG;IACH,SAAgB,OAAO,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IAEnC;;OAEG;IACH,SAAgB,KAAK,EAAE,KAAK,CAAC;IAE7B;;;;;;;;;;;;OAYG;gBACS,OAAO,EAAE,eAAe;CAerC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"client.test.d.ts","sourceRoot":"","sources":["../../src/client.test.ts"],"names":[],"mappings":"AAAA;;GAEG"}
|
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Custom exceptions for Tabstack SDK
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* Base error class for all Tabstack errors
|
|
6
|
-
*/
|
|
7
|
-
export declare class TabstackError extends Error {
|
|
8
|
-
statusCode?: number | undefined;
|
|
9
|
-
constructor(message: string, statusCode?: number | undefined);
|
|
10
|
-
}
|
|
11
|
-
/**
|
|
12
|
-
* Error for 400 Bad Request responses
|
|
13
|
-
*
|
|
14
|
-
* Raised when the request is malformed or missing required fields.
|
|
15
|
-
*/
|
|
16
|
-
export declare class BadRequestError extends TabstackError {
|
|
17
|
-
constructor(message: string);
|
|
18
|
-
}
|
|
19
|
-
/**
|
|
20
|
-
* Error for 401 Unauthorized responses
|
|
21
|
-
*
|
|
22
|
-
* Raised when the API key is invalid or missing.
|
|
23
|
-
*/
|
|
24
|
-
export declare class UnauthorizedError extends TabstackError {
|
|
25
|
-
constructor(message?: string);
|
|
26
|
-
}
|
|
27
|
-
/**
|
|
28
|
-
* Error for 422 Unprocessable Entity responses related to URLs
|
|
29
|
-
*
|
|
30
|
-
* Raised when the provided URL is invalid or inaccessible.
|
|
31
|
-
*/
|
|
32
|
-
export declare class InvalidURLError extends TabstackError {
|
|
33
|
-
constructor(message?: string);
|
|
34
|
-
}
|
|
35
|
-
/**
|
|
36
|
-
* Error for 500 Internal Server Error responses
|
|
37
|
-
*
|
|
38
|
-
* Raised when the server encounters an error processing the request.
|
|
39
|
-
*/
|
|
40
|
-
export declare class ServerError extends TabstackError {
|
|
41
|
-
constructor(message?: string);
|
|
42
|
-
}
|
|
43
|
-
/**
|
|
44
|
-
* Error for 503 Service Unavailable responses
|
|
45
|
-
*
|
|
46
|
-
* Raised when a service (e.g., automate) is not available or not configured.
|
|
47
|
-
*/
|
|
48
|
-
export declare class ServiceUnavailableError extends TabstackError {
|
|
49
|
-
constructor(message?: string);
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* Generic API error for unexpected status codes
|
|
53
|
-
*/
|
|
54
|
-
export declare class APIError extends TabstackError {
|
|
55
|
-
constructor(message: string, statusCode: number);
|
|
56
|
-
}
|
|
57
|
-
//# sourceMappingURL=exceptions.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"exceptions.d.ts","sourceRoot":"","sources":["../../src/exceptions.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,qBAAa,aAAc,SAAQ,KAAK;IAG7B,UAAU,CAAC,EAAE,MAAM;gBAD1B,OAAO,EAAE,MAAM,EACR,UAAU,CAAC,EAAE,MAAM,YAAA;CAM7B;AAED;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,aAAa;gBACpC,OAAO,EAAE,MAAM;CAK5B;AAED;;;;GAIG;AACH,qBAAa,iBAAkB,SAAQ,aAAa;gBACtC,OAAO,GAAE,MAAoD;CAK1E;AAED;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,aAAa;gBACpC,OAAO,GAAE,MAAsC;CAK5D;AAED;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,aAAa;gBAChC,OAAO,GAAE,MAAgC;CAKtD;AAED;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,aAAa;gBAC5C,OAAO,GAAE,MAA8B;CAKpD;AAED;;GAEG;AACH,qBAAa,QAAS,SAAQ,aAAa;gBAC7B,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;CAKhD"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"exceptions.test.d.ts","sourceRoot":"","sources":["../../src/exceptions.test.ts"],"names":[],"mappings":"AAAA;;GAEG"}
|
package/dist/types/extract.d.ts
DELETED
|
@@ -1,151 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Extract operator for Tabstack 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 ExtractJsonOptions {
|
|
11
|
-
nocache?: boolean;
|
|
12
|
-
}
|
|
13
|
-
/**
|
|
14
|
-
* Extract operator for converting and extracting web content
|
|
15
|
-
*
|
|
16
|
-
* This class provides methods for extracting content from URLs in various formats:
|
|
17
|
-
* - Markdown conversion
|
|
18
|
-
* - Structured JSON extraction
|
|
19
|
-
*/
|
|
20
|
-
export declare class Extract {
|
|
21
|
-
private httpClient;
|
|
22
|
-
constructor(httpClient: HTTPClient);
|
|
23
|
-
/**
|
|
24
|
-
* Convert URL content to Markdown format
|
|
25
|
-
*
|
|
26
|
-
* Fetches a URL and converts its HTML content to clean Markdown format with
|
|
27
|
-
* optional metadata extraction. By default, metadata is included in the content
|
|
28
|
-
* as YAML frontmatter. When metadata option is true, it's also returned as
|
|
29
|
-
* a separate field in the response.
|
|
30
|
-
*
|
|
31
|
-
* @param url - URL to fetch and convert to markdown
|
|
32
|
-
* @param options - Optional extraction options
|
|
33
|
-
* @param options.metadata - Include extracted metadata (Open Graph and HTML metadata) as a separate field in the response. Default: false
|
|
34
|
-
* @param options.nocache - Bypass cache and force fresh data retrieval. Default: false
|
|
35
|
-
*
|
|
36
|
-
* @returns MarkdownResponse containing the converted content and optional metadata
|
|
37
|
-
*
|
|
38
|
-
* @throws {BadRequestError} When URL is missing
|
|
39
|
-
* @throws {UnauthorizedError} When API key is invalid or missing
|
|
40
|
-
* @throws {InvalidURLError} When URL is invalid or inaccessible
|
|
41
|
-
* @throws {ServerError} When server fails to fetch or convert the content
|
|
42
|
-
*
|
|
43
|
-
* @example
|
|
44
|
-
* Basic usage:
|
|
45
|
-
* ```typescript
|
|
46
|
-
* const result = await tabs.extract.markdown('https://example.com/blog/article');
|
|
47
|
-
* console.log(result.content); // Markdown with YAML frontmatter
|
|
48
|
-
* ```
|
|
49
|
-
*
|
|
50
|
-
* @example
|
|
51
|
-
* With separate metadata field:
|
|
52
|
-
* ```typescript
|
|
53
|
-
* const result = await tabs.extract.markdown('https://example.com/blog/article', {
|
|
54
|
-
* metadata: true
|
|
55
|
-
* });
|
|
56
|
-
* console.log(result.content); // Markdown without frontmatter
|
|
57
|
-
* console.log(result.metadata?.title); // "Example Article Title"
|
|
58
|
-
* console.log(result.metadata?.author); // "Example Author"
|
|
59
|
-
* console.log(result.metadata?.image); // "https://example.com/images/article.jpg"
|
|
60
|
-
* ```
|
|
61
|
-
*
|
|
62
|
-
* @example
|
|
63
|
-
* Force fresh data retrieval:
|
|
64
|
-
* ```typescript
|
|
65
|
-
* const result = await tabs.extract.markdown('https://example.com/blog/article', {
|
|
66
|
-
* nocache: true
|
|
67
|
-
* });
|
|
68
|
-
* ```
|
|
69
|
-
*/
|
|
70
|
-
markdown(url: string, options?: ExtractMarkdownOptions): Promise<MarkdownResponse>;
|
|
71
|
-
/**
|
|
72
|
-
* Extract structured JSON from URL content
|
|
73
|
-
*
|
|
74
|
-
* Fetches a URL and extracts structured data according to a provided JSON schema.
|
|
75
|
-
* The schema defines what data to extract and its structure.
|
|
76
|
-
*
|
|
77
|
-
* @param url - URL to fetch and extract data from
|
|
78
|
-
* @param schema - JSON schema object defining the structure of data to extract
|
|
79
|
-
* @param options - Optional extraction options
|
|
80
|
-
* @param options.nocache - Bypass cache and force fresh data retrieval. Default: false
|
|
81
|
-
*
|
|
82
|
-
* @returns JsonResponse containing the extracted data matching the schema
|
|
83
|
-
*
|
|
84
|
-
* @throws {BadRequestError} When URL or schema is missing, or schema format is invalid
|
|
85
|
-
* @throws {UnauthorizedError} When API key is invalid or missing
|
|
86
|
-
* @throws {InvalidURLError} When URL is invalid
|
|
87
|
-
* @throws {ServerError} When server fails to fetch URL, page is too large, or JSON generation fails
|
|
88
|
-
*
|
|
89
|
-
* @example
|
|
90
|
-
* Extract news stories:
|
|
91
|
-
* ```typescript
|
|
92
|
-
* const schema = {
|
|
93
|
-
* type: 'object',
|
|
94
|
-
* properties: {
|
|
95
|
-
* stories: {
|
|
96
|
-
* type: 'array',
|
|
97
|
-
* items: {
|
|
98
|
-
* type: 'object',
|
|
99
|
-
* properties: {
|
|
100
|
-
* title: { type: 'string' },
|
|
101
|
-
* points: { type: 'number' },
|
|
102
|
-
* author: { type: 'string' }
|
|
103
|
-
* },
|
|
104
|
-
* required: ['title', 'points', 'author']
|
|
105
|
-
* }
|
|
106
|
-
* }
|
|
107
|
-
* },
|
|
108
|
-
* required: ['stories']
|
|
109
|
-
* };
|
|
110
|
-
*
|
|
111
|
-
* const result = await tabs.extract.json('https://news.ycombinator.com', schema);
|
|
112
|
-
* console.log(result.data.stories); // Array of story objects
|
|
113
|
-
* ```
|
|
114
|
-
*
|
|
115
|
-
* @example
|
|
116
|
-
* Extract product information:
|
|
117
|
-
* ```typescript
|
|
118
|
-
* const schema = {
|
|
119
|
-
* type: 'object',
|
|
120
|
-
* properties: {
|
|
121
|
-
* name: { type: 'string' },
|
|
122
|
-
* price: { type: 'number' },
|
|
123
|
-
* inStock: { type: 'boolean' },
|
|
124
|
-
* features: {
|
|
125
|
-
* type: 'array',
|
|
126
|
-
* items: { type: 'string' }
|
|
127
|
-
* }
|
|
128
|
-
* },
|
|
129
|
-
* required: ['name', 'price', 'inStock']
|
|
130
|
-
* };
|
|
131
|
-
*
|
|
132
|
-
* const result = await tabs.extract.json(
|
|
133
|
-
* 'https://example-store.com/product/wireless-headphones',
|
|
134
|
-
* schema
|
|
135
|
-
* );
|
|
136
|
-
* console.log(result.data.name); // "Premium Wireless Headphones"
|
|
137
|
-
* console.log(result.data.price); // 299.99
|
|
138
|
-
* console.log(result.data.inStock); // true
|
|
139
|
-
* ```
|
|
140
|
-
*
|
|
141
|
-
* @example
|
|
142
|
-
* Force fresh data retrieval:
|
|
143
|
-
* ```typescript
|
|
144
|
-
* const result = await tabs.extract.json('https://news.ycombinator.com', schema, {
|
|
145
|
-
* nocache: true
|
|
146
|
-
* });
|
|
147
|
-
* ```
|
|
148
|
-
*/
|
|
149
|
-
json<T = unknown>(url: string, schema: Record<string, unknown>, options?: ExtractJsonOptions): Promise<JsonResponse<T>>;
|
|
150
|
-
}
|
|
151
|
-
//# 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,kBAAkB;IACjC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;GAMG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6EG;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"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"extract.test.d.ts","sourceRoot":"","sources":["../../src/extract.test.ts"],"names":[],"mappings":"AAAA;;GAEG"}
|
package/dist/types/generate.d.ts
DELETED
|
@@ -1,113 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Generate operator for Tabstack SDK
|
|
3
|
-
*/
|
|
4
|
-
import { HTTPClient } from './util/http';
|
|
5
|
-
import { JsonResponse } from './types';
|
|
6
|
-
export interface GenerateJsonOptions {
|
|
7
|
-
nocache?: boolean;
|
|
8
|
-
}
|
|
9
|
-
/**
|
|
10
|
-
* Generate operator for AI-powered content transformation
|
|
11
|
-
*
|
|
12
|
-
* This class provides methods for generating transformed content from URLs using AI,
|
|
13
|
-
* allowing you to create summaries, restructure data, and enhance content based on
|
|
14
|
-
* custom instructions.
|
|
15
|
-
*/
|
|
16
|
-
export declare class Generate {
|
|
17
|
-
private httpClient;
|
|
18
|
-
constructor(httpClient: HTTPClient);
|
|
19
|
-
/**
|
|
20
|
-
* Generate transformed JSON with AI
|
|
21
|
-
*
|
|
22
|
-
* Fetches URL content, extracts data, and transforms it using AI based on custom
|
|
23
|
-
* instructions. Use this to generate new content, summaries, categorizations, or
|
|
24
|
-
* restructured data. Unlike extract.json() which extracts existing data, this
|
|
25
|
-
* method creates new content based on your instructions.
|
|
26
|
-
*
|
|
27
|
-
* @param url - URL to fetch content from
|
|
28
|
-
* @param schema - JSON schema object defining the structure of the transformed output
|
|
29
|
-
* @param instructions - Instructions describing how to transform the data. Example: "For each story, categorize it (tech/business/science/other) and write a one-sentence summary explaining what it's about in simple terms."
|
|
30
|
-
* @param options - Optional generation options
|
|
31
|
-
* @param options.nocache - Bypass cache and force fresh data retrieval. Default: false
|
|
32
|
-
*
|
|
33
|
-
* @returns JsonResponse containing the transformed data matching the schema
|
|
34
|
-
*
|
|
35
|
-
* @throws {BadRequestError} When URL, schema, or instructions are missing, or schema format is invalid
|
|
36
|
-
* @throws {UnauthorizedError} When API key is invalid or missing
|
|
37
|
-
* @throws {InvalidURLError} When URL is invalid
|
|
38
|
-
* @throws {ServerError} When server fails to fetch URL, page is too large, or data transformation fails
|
|
39
|
-
*
|
|
40
|
-
* @example
|
|
41
|
-
* Categorize and summarize news stories:
|
|
42
|
-
* ```typescript
|
|
43
|
-
* const schema = {
|
|
44
|
-
* type: 'object',
|
|
45
|
-
* properties: {
|
|
46
|
-
* summaries: {
|
|
47
|
-
* type: 'array',
|
|
48
|
-
* items: {
|
|
49
|
-
* type: 'object',
|
|
50
|
-
* properties: {
|
|
51
|
-
* title: { type: 'string' },
|
|
52
|
-
* category: { type: 'string' },
|
|
53
|
-
* summary: { type: 'string' }
|
|
54
|
-
* },
|
|
55
|
-
* required: ['title', 'category', 'summary']
|
|
56
|
-
* }
|
|
57
|
-
* }
|
|
58
|
-
* },
|
|
59
|
-
* required: ['summaries']
|
|
60
|
-
* };
|
|
61
|
-
*
|
|
62
|
-
* const result = await tabs.generate.json(
|
|
63
|
-
* 'https://news.ycombinator.com',
|
|
64
|
-
* schema,
|
|
65
|
-
* 'For each story, categorize it (tech/business/science/other) and write a one-sentence summary explaining what it\'s about in simple terms.'
|
|
66
|
-
* );
|
|
67
|
-
*
|
|
68
|
-
* console.log(result.data.summaries);
|
|
69
|
-
* // [
|
|
70
|
-
* // {
|
|
71
|
-
* // title: "New AI Model Released",
|
|
72
|
-
* // category: "tech",
|
|
73
|
-
* // summary: "A research lab announced a new large language model that achieves state-of-the-art performance on reasoning tasks."
|
|
74
|
-
* // },
|
|
75
|
-
* // ...
|
|
76
|
-
* // ]
|
|
77
|
-
* ```
|
|
78
|
-
*
|
|
79
|
-
* @example
|
|
80
|
-
* Create structured analysis:
|
|
81
|
-
* ```typescript
|
|
82
|
-
* const schema = {
|
|
83
|
-
* type: 'object',
|
|
84
|
-
* properties: {
|
|
85
|
-
* sentiment: { type: 'string' },
|
|
86
|
-
* keyPoints: {
|
|
87
|
-
* type: 'array',
|
|
88
|
-
* items: { type: 'string' }
|
|
89
|
-
* },
|
|
90
|
-
* summary: { type: 'string' },
|
|
91
|
-
* tags: {
|
|
92
|
-
* type: 'array',
|
|
93
|
-
* items: { type: 'string' }
|
|
94
|
-
* }
|
|
95
|
-
* },
|
|
96
|
-
* required: ['sentiment', 'keyPoints', 'summary', 'tags']
|
|
97
|
-
* };
|
|
98
|
-
*
|
|
99
|
-
* const result = await tabs.generate.json(
|
|
100
|
-
* 'https://example.com/article',
|
|
101
|
-
* schema,
|
|
102
|
-
* 'Analyze the sentiment (positive/negative/neutral), extract key points, create a brief summary, and add relevant tags'
|
|
103
|
-
* );
|
|
104
|
-
*
|
|
105
|
-
* console.log(result.data.sentiment); // "positive"
|
|
106
|
-
* console.log(result.data.keyPoints); // ["Key point 1", "Key point 2", ...]
|
|
107
|
-
* console.log(result.data.summary); // "Brief summary of the article..."
|
|
108
|
-
* console.log(result.data.tags); // ["technology", "innovation", ...]
|
|
109
|
-
* ```
|
|
110
|
-
*/
|
|
111
|
-
json<T = unknown>(url: string, schema: Record<string, unknown>, instructions: string, options?: GenerateJsonOptions): Promise<JsonResponse<T>>;
|
|
112
|
-
}
|
|
113
|
-
//# sourceMappingURL=generate.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../src/generate.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;GAMG;AACH,qBAAa,QAAQ;IACP,OAAO,CAAC,UAAU;gBAAV,UAAU,EAAE,UAAU;IAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2FG;IACG,IAAI,CAAC,CAAC,GAAG,OAAO,EACpB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;CAW5B"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"generate.test.d.ts","sourceRoot":"","sources":["../../src/generate.test.ts"],"names":[],"mappings":"AAAA;;GAEG"}
|
package/dist/types/index.d.ts
DELETED
|
@@ -1,52 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Tabstack TypeScript/JavaScript SDK
|
|
3
|
-
*
|
|
4
|
-
* This SDK provides a TypeScript/JavaScript interface to the Tabstack API for web
|
|
5
|
-
* content extraction, AI-powered content generation, and browser automation.
|
|
6
|
-
*
|
|
7
|
-
* @example
|
|
8
|
-
* ```typescript
|
|
9
|
-
* import { Tabstack } from '@tabstack/sdk';
|
|
10
|
-
*
|
|
11
|
-
* const tabs = new Tabstack({
|
|
12
|
-
* apiKey: process.env.TABSTACK_API_KEY!
|
|
13
|
-
* });
|
|
14
|
-
*
|
|
15
|
-
* // Extract markdown
|
|
16
|
-
* const result = await tabs.extract.markdown('https://example.com');
|
|
17
|
-
* console.log(result.content);
|
|
18
|
-
*
|
|
19
|
-
* // Extract structured JSON
|
|
20
|
-
* const schema = {
|
|
21
|
-
* type: 'object',
|
|
22
|
-
* properties: {
|
|
23
|
-
* stories: {
|
|
24
|
-
* type: 'array',
|
|
25
|
-
* items: {
|
|
26
|
-
* type: 'object',
|
|
27
|
-
* properties: {
|
|
28
|
-
* title: { type: 'string' },
|
|
29
|
-
* points: { type: 'number' },
|
|
30
|
-
* author: { type: 'string' }
|
|
31
|
-
* }
|
|
32
|
-
* }
|
|
33
|
-
* }
|
|
34
|
-
* }
|
|
35
|
-
* };
|
|
36
|
-
*
|
|
37
|
-
* const data = await tabs.extract.json('https://news.ycombinator.com', schema);
|
|
38
|
-
* console.log(data.data);
|
|
39
|
-
* ```
|
|
40
|
-
*
|
|
41
|
-
* @packageDocumentation
|
|
42
|
-
*/
|
|
43
|
-
export { Tabstack, TabstackOptions } from './client';
|
|
44
|
-
export { Extract } from './extract';
|
|
45
|
-
export { Generate } from './generate';
|
|
46
|
-
export { Agent } from './agent';
|
|
47
|
-
export { Metadata, MetadataFields, MarkdownResponse, JsonResponse, AutomateEvent, EventData, } from './types';
|
|
48
|
-
export { TabstackError, BadRequestError, UnauthorizedError, InvalidURLError, ServerError, ServiceUnavailableError, APIError, } from './exceptions';
|
|
49
|
-
export type { ExtractMarkdownOptions, ExtractJsonOptions } from './extract';
|
|
50
|
-
export type { GenerateJsonOptions } from './generate';
|
|
51
|
-
export type { AutomateOptions } from './agent';
|
|
52
|
-
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AAGH,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAGrD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAGhC,OAAO,EACL,QAAQ,EACR,cAAc,EACd,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,SAAS,GACV,MAAM,SAAS,CAAC;AAGjB,OAAO,EACL,aAAa,EACb,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,WAAW,EACX,uBAAuB,EACvB,QAAQ,GACT,MAAM,cAAc,CAAC;AAGtB,YAAY,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC5E,YAAY,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACtD,YAAY,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC"}
|