botshield-sdk 1.9.0 → 2.0.1
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/FUNCTIONS.md +87 -0
- package/README.md +482 -295
- package/RUNTIMES.md +48 -0
- package/bin/mcp-server.js +52952 -0
- package/bin/mcp-server.js.map +379 -0
- package/dist/commonjs/core.d.ts +10 -0
- package/dist/commonjs/core.d.ts.map +1 -0
- package/dist/commonjs/core.js +17 -0
- package/dist/commonjs/core.js.map +1 -0
- package/dist/commonjs/funcs/actions-cancel-action.d.ts +18 -0
- package/dist/commonjs/funcs/actions-cancel-action.d.ts.map +1 -0
- package/dist/commonjs/funcs/actions-cancel-action.js +118 -0
- package/dist/commonjs/funcs/actions-cancel-action.js.map +1 -0
- package/dist/commonjs/funcs/actions-check-action-status.d.ts +18 -0
- package/dist/commonjs/funcs/actions-check-action-status.d.ts.map +1 -0
- package/dist/commonjs/funcs/actions-check-action-status.js +122 -0
- package/dist/commonjs/funcs/actions-check-action-status.js.map +1 -0
- package/dist/commonjs/funcs/actions-propose-action.d.ts +18 -0
- package/dist/commonjs/funcs/actions-propose-action.d.ts.map +1 -0
- package/dist/commonjs/funcs/actions-propose-action.js +118 -0
- package/dist/commonjs/funcs/actions-propose-action.js.map +1 -0
- package/dist/commonjs/funcs/census-create-session.d.ts +18 -0
- package/dist/commonjs/funcs/census-create-session.d.ts.map +1 -0
- package/dist/commonjs/funcs/census-create-session.js +123 -0
- package/dist/commonjs/funcs/census-create-session.js.map +1 -0
- package/dist/commonjs/funcs/census-create-verification-link.d.ts +18 -0
- package/dist/commonjs/funcs/census-create-verification-link.d.ts.map +1 -0
- package/dist/commonjs/funcs/census-create-verification-link.js +123 -0
- package/dist/commonjs/funcs/census-create-verification-link.js.map +1 -0
- package/dist/commonjs/funcs/census-get-partner-config.d.ts +18 -0
- package/dist/commonjs/funcs/census-get-partner-config.d.ts.map +1 -0
- package/dist/commonjs/funcs/census-get-partner-config.js +132 -0
- package/dist/commonjs/funcs/census-get-partner-config.js.map +1 -0
- package/dist/commonjs/funcs/census-logout.d.ts +15 -0
- package/dist/commonjs/funcs/census-logout.d.ts.map +1 -0
- package/dist/commonjs/funcs/census-logout.js +120 -0
- package/dist/commonjs/funcs/census-logout.js.map +1 -0
- package/dist/commonjs/funcs/census-revoke-verification.d.ts +18 -0
- package/dist/commonjs/funcs/census-revoke-verification.d.ts.map +1 -0
- package/dist/commonjs/funcs/census-revoke-verification.js +123 -0
- package/dist/commonjs/funcs/census-revoke-verification.js.map +1 -0
- package/dist/commonjs/funcs/census-store-signal.d.ts +18 -0
- package/dist/commonjs/funcs/census-store-signal.d.ts.map +1 -0
- package/dist/commonjs/funcs/census-store-signal.js +114 -0
- package/dist/commonjs/funcs/census-store-signal.js.map +1 -0
- package/dist/commonjs/funcs/census-validate-signal.d.ts +18 -0
- package/dist/commonjs/funcs/census-validate-signal.d.ts.map +1 -0
- package/dist/commonjs/funcs/census-validate-signal.js +114 -0
- package/dist/commonjs/funcs/census-validate-signal.js.map +1 -0
- package/dist/commonjs/funcs/census-verify-token.d.ts +18 -0
- package/dist/commonjs/funcs/census-verify-token.d.ts.map +1 -0
- package/dist/commonjs/funcs/census-verify-token.js +129 -0
- package/dist/commonjs/funcs/census-verify-token.js.map +1 -0
- package/dist/commonjs/funcs/verification-get-status.d.ts +18 -0
- package/dist/commonjs/funcs/verification-get-status.d.ts.map +1 -0
- package/dist/commonjs/funcs/verification-get-status.js +132 -0
- package/dist/commonjs/funcs/verification-get-status.js.map +1 -0
- package/dist/commonjs/hooks/hooks.d.ts +25 -0
- package/dist/commonjs/hooks/hooks.d.ts.map +1 -0
- package/dist/commonjs/hooks/hooks.js +84 -0
- package/dist/commonjs/hooks/hooks.js.map +1 -0
- package/dist/commonjs/hooks/index.d.ts +3 -0
- package/dist/commonjs/hooks/index.d.ts.map +1 -0
- package/dist/commonjs/hooks/index.js +22 -0
- package/dist/commonjs/hooks/index.js.map +1 -0
- package/dist/commonjs/hooks/types.d.ts +77 -0
- package/dist/commonjs/hooks/types.d.ts.map +1 -0
- package/dist/commonjs/hooks/types.js +6 -0
- package/dist/commonjs/hooks/types.js.map +1 -0
- package/dist/commonjs/index.d.ts +6 -0
- package/dist/commonjs/index.d.ts.map +1 -0
- package/dist/commonjs/index.js +48 -0
- package/dist/commonjs/index.js.map +1 -0
- package/dist/commonjs/lib/base64.d.ts +10 -0
- package/dist/commonjs/lib/base64.d.ts.map +1 -0
- package/dist/commonjs/lib/base64.js +71 -0
- package/dist/commonjs/lib/base64.js.map +1 -0
- package/dist/commonjs/lib/config.d.ts +42 -0
- package/dist/commonjs/lib/config.d.ts.map +1 -0
- package/dist/commonjs/lib/config.js +42 -0
- package/dist/commonjs/lib/config.js.map +1 -0
- package/dist/commonjs/lib/encodings.d.ts +55 -0
- package/dist/commonjs/lib/encodings.d.ts.map +1 -0
- package/dist/commonjs/lib/encodings.js +422 -0
- package/dist/commonjs/lib/encodings.js.map +1 -0
- package/dist/commonjs/lib/files.d.ts +26 -0
- package/dist/commonjs/lib/files.d.ts.map +1 -0
- package/dist/commonjs/lib/files.js +96 -0
- package/dist/commonjs/lib/files.js.map +1 -0
- package/dist/commonjs/lib/http.d.ts +67 -0
- package/dist/commonjs/lib/http.d.ts.map +1 -0
- package/dist/commonjs/lib/http.js +219 -0
- package/dist/commonjs/lib/http.js.map +1 -0
- package/dist/commonjs/lib/logger.d.ts +6 -0
- package/dist/commonjs/lib/logger.d.ts.map +1 -0
- package/dist/commonjs/lib/logger.js +6 -0
- package/dist/commonjs/lib/logger.js.map +1 -0
- package/dist/commonjs/lib/matchers.d.ts +59 -0
- package/dist/commonjs/lib/matchers.d.ts.map +1 -0
- package/dist/commonjs/lib/matchers.js +221 -0
- package/dist/commonjs/lib/matchers.js.map +1 -0
- package/dist/commonjs/lib/primitives.d.ts +27 -0
- package/dist/commonjs/lib/primitives.d.ts.map +1 -0
- package/dist/commonjs/lib/primitives.js +129 -0
- package/dist/commonjs/lib/primitives.js.map +1 -0
- package/dist/commonjs/lib/retries.d.ts +38 -0
- package/dist/commonjs/lib/retries.d.ts.map +1 -0
- package/dist/commonjs/lib/retries.js +163 -0
- package/dist/commonjs/lib/retries.js.map +1 -0
- package/dist/commonjs/lib/schemas.d.ts +19 -0
- package/dist/commonjs/lib/schemas.d.ts.map +1 -0
- package/dist/commonjs/lib/schemas.js +62 -0
- package/dist/commonjs/lib/schemas.js.map +1 -0
- package/dist/commonjs/lib/sdks.d.ts +63 -0
- package/dist/commonjs/lib/sdks.d.ts.map +1 -0
- package/dist/commonjs/lib/sdks.js +294 -0
- package/dist/commonjs/lib/sdks.js.map +1 -0
- package/dist/commonjs/lib/security.d.ts +84 -0
- package/dist/commonjs/lib/security.d.ts.map +1 -0
- package/dist/commonjs/lib/security.js +160 -0
- package/dist/commonjs/lib/security.js.map +1 -0
- package/dist/commonjs/lib/url.d.ts +5 -0
- package/dist/commonjs/lib/url.d.ts.map +1 -0
- package/dist/commonjs/lib/url.js +27 -0
- package/dist/commonjs/lib/url.js.map +1 -0
- package/dist/commonjs/mcp-server/cli/start/command.d.ts +2 -0
- package/dist/commonjs/mcp-server/cli/start/command.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/cli/start/command.js +141 -0
- package/dist/commonjs/mcp-server/cli/start/command.js.map +1 -0
- package/dist/commonjs/mcp-server/cli/start/impl.d.ts +19 -0
- package/dist/commonjs/mcp-server/cli/start/impl.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/cli/start/impl.js +110 -0
- package/dist/commonjs/mcp-server/cli/start/impl.js.map +1 -0
- package/dist/commonjs/mcp-server/cli.d.ts +6 -0
- package/dist/commonjs/mcp-server/cli.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/cli.js +10 -0
- package/dist/commonjs/mcp-server/cli.js.map +1 -0
- package/dist/commonjs/mcp-server/console-logger.d.ts +7 -0
- package/dist/commonjs/mcp-server/console-logger.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/console-logger.js +59 -0
- package/dist/commonjs/mcp-server/console-logger.js.map +1 -0
- package/dist/commonjs/mcp-server/extensions.d.ts +11 -0
- package/dist/commonjs/mcp-server/extensions.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/extensions.js +6 -0
- package/dist/commonjs/mcp-server/extensions.js.map +1 -0
- package/dist/commonjs/mcp-server/mcp-server.d.ts +2 -0
- package/dist/commonjs/mcp-server/mcp-server.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/mcp-server.js +29 -0
- package/dist/commonjs/mcp-server/mcp-server.js.map +1 -0
- package/dist/commonjs/mcp-server/prompts.d.ts +26 -0
- package/dist/commonjs/mcp-server/prompts.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/prompts.js +51 -0
- package/dist/commonjs/mcp-server/prompts.js.map +1 -0
- package/dist/commonjs/mcp-server/resources.d.ts +32 -0
- package/dist/commonjs/mcp-server/resources.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/resources.js +87 -0
- package/dist/commonjs/mcp-server/resources.js.map +1 -0
- package/dist/commonjs/mcp-server/scopes.d.ts +3 -0
- package/dist/commonjs/mcp-server/scopes.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/scopes.js +10 -0
- package/dist/commonjs/mcp-server/scopes.js.map +1 -0
- package/dist/commonjs/mcp-server/server.d.ts +13 -0
- package/dist/commonjs/mcp-server/server.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/server.js +38 -0
- package/dist/commonjs/mcp-server/server.js.map +1 -0
- package/dist/commonjs/mcp-server/shared.d.ts +7 -0
- package/dist/commonjs/mcp-server/shared.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/shared.js +98 -0
- package/dist/commonjs/mcp-server/shared.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/actions-cancel-action.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/actions-cancel-action.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/actions-cancel-action.js +63 -0
- package/dist/commonjs/mcp-server/tools/actions-cancel-action.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/actions-check-action-status.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/actions-check-action-status.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/actions-check-action-status.js +63 -0
- package/dist/commonjs/mcp-server/tools/actions-check-action-status.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/actions-propose-action.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/actions-propose-action.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/actions-propose-action.js +63 -0
- package/dist/commonjs/mcp-server/tools/actions-propose-action.js.map +1 -0
- package/dist/commonjs/mcp-server/tools.d.ts +25 -0
- package/dist/commonjs/mcp-server/tools.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools.js +82 -0
- package/dist/commonjs/mcp-server/tools.js.map +1 -0
- package/dist/commonjs/models/error-body.d.ts +56 -0
- package/dist/commonjs/models/error-body.d.ts.map +1 -0
- package/dist/commonjs/models/error-body.js +100 -0
- package/dist/commonjs/models/error-body.js.map +1 -0
- package/dist/commonjs/models/error-response.d.ts +19 -0
- package/dist/commonjs/models/error-response.d.ts.map +1 -0
- package/dist/commonjs/models/error-response.js +61 -0
- package/dist/commonjs/models/error-response.js.map +1 -0
- package/dist/commonjs/models/errors/bot-shield-default-error.d.ts +10 -0
- package/dist/commonjs/models/errors/bot-shield-default-error.d.ts.map +1 -0
- package/dist/commonjs/models/errors/bot-shield-default-error.js +34 -0
- package/dist/commonjs/models/errors/bot-shield-default-error.js.map +1 -0
- package/dist/commonjs/models/errors/bot-shield-error.d.ts +19 -0
- package/dist/commonjs/models/errors/bot-shield-error.d.ts.map +1 -0
- package/dist/commonjs/models/errors/bot-shield-error.js +30 -0
- package/dist/commonjs/models/errors/bot-shield-error.js.map +1 -0
- package/dist/commonjs/models/errors/error-response.d.ts +31 -0
- package/dist/commonjs/models/errors/error-response.d.ts.map +1 -0
- package/dist/commonjs/models/errors/error-response.js +80 -0
- package/dist/commonjs/models/errors/error-response.js.map +1 -0
- package/dist/commonjs/models/errors/http-client-errors.d.ts +44 -0
- package/dist/commonjs/models/errors/http-client-errors.d.ts.map +1 -0
- package/dist/commonjs/models/errors/http-client-errors.js +65 -0
- package/dist/commonjs/models/errors/http-client-errors.js.map +1 -0
- package/dist/commonjs/models/errors/index.d.ts +8 -0
- package/dist/commonjs/models/errors/index.d.ts.map +1 -0
- package/dist/commonjs/models/errors/index.js +27 -0
- package/dist/commonjs/models/errors/index.js.map +1 -0
- package/dist/commonjs/models/errors/invalid-input-error.d.ts +42 -0
- package/dist/commonjs/models/errors/invalid-input-error.d.ts.map +1 -0
- package/dist/commonjs/models/errors/invalid-input-error.js +86 -0
- package/dist/commonjs/models/errors/invalid-input-error.js.map +1 -0
- package/dist/commonjs/models/errors/response-validation-error.d.ts +26 -0
- package/dist/commonjs/models/errors/response-validation-error.d.ts.map +1 -0
- package/dist/commonjs/models/errors/response-validation-error.js +74 -0
- package/dist/commonjs/models/errors/response-validation-error.js.map +1 -0
- package/dist/commonjs/models/errors/sdk-validation-error.d.ts +21 -0
- package/dist/commonjs/models/errors/sdk-validation-error.d.ts.map +1 -0
- package/dist/commonjs/models/errors/sdk-validation-error.js +137 -0
- package/dist/commonjs/models/errors/sdk-validation-error.js.map +1 -0
- package/dist/commonjs/models/index.d.ts +5 -0
- package/dist/commonjs/models/index.d.ts.map +1 -0
- package/dist/commonjs/models/index.js +24 -0
- package/dist/commonjs/models/index.js.map +1 -0
- package/dist/commonjs/models/invalid-input-error.d.ts +24 -0
- package/dist/commonjs/models/invalid-input-error.d.ts.map +1 -0
- package/dist/commonjs/models/invalid-input-error.js +63 -0
- package/dist/commonjs/models/invalid-input-error.js.map +1 -0
- package/dist/commonjs/models/operations/actions-cancel.d.ts +104 -0
- package/dist/commonjs/models/operations/actions-cancel.d.ts.map +1 -0
- package/dist/commonjs/models/operations/actions-cancel.js +154 -0
- package/dist/commonjs/models/operations/actions-cancel.js.map +1 -0
- package/dist/commonjs/models/operations/actions-check-status.d.ts +121 -0
- package/dist/commonjs/models/operations/actions-check-status.d.ts.map +1 -0
- package/dist/commonjs/models/operations/actions-check-status.js +176 -0
- package/dist/commonjs/models/operations/actions-check-status.js.map +1 -0
- package/dist/commonjs/models/operations/actions-propose.d.ts +187 -0
- package/dist/commonjs/models/operations/actions-propose.d.ts.map +1 -0
- package/dist/commonjs/models/operations/actions-propose.js +227 -0
- package/dist/commonjs/models/operations/actions-propose.js.map +1 -0
- package/dist/commonjs/models/operations/index.d.ts +13 -0
- package/dist/commonjs/models/operations/index.d.ts.map +1 -0
- package/dist/commonjs/models/operations/index.js +32 -0
- package/dist/commonjs/models/operations/index.js.map +1 -0
- package/dist/commonjs/models/operations/sdk-create-session.d.ts +139 -0
- package/dist/commonjs/models/operations/sdk-create-session.d.ts.map +1 -0
- package/dist/commonjs/models/operations/sdk-create-session.js +205 -0
- package/dist/commonjs/models/operations/sdk-create-session.js.map +1 -0
- package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts +220 -0
- package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts.map +1 -0
- package/dist/commonjs/models/operations/sdk-create-verification-link.js +270 -0
- package/dist/commonjs/models/operations/sdk-create-verification-link.js.map +1 -0
- package/dist/commonjs/models/operations/sdk-get-partner-config.d.ts +126 -0
- package/dist/commonjs/models/operations/sdk-get-partner-config.d.ts.map +1 -0
- package/dist/commonjs/models/operations/sdk-get-partner-config.js +179 -0
- package/dist/commonjs/models/operations/sdk-get-partner-config.js.map +1 -0
- package/dist/commonjs/models/operations/sdk-logout.d.ts +74 -0
- package/dist/commonjs/models/operations/sdk-logout.d.ts.map +1 -0
- package/dist/commonjs/models/operations/sdk-logout.js +143 -0
- package/dist/commonjs/models/operations/sdk-logout.js.map +1 -0
- package/dist/commonjs/models/operations/sdk-revoke-verification.d.ts +97 -0
- package/dist/commonjs/models/operations/sdk-revoke-verification.d.ts.map +1 -0
- package/dist/commonjs/models/operations/sdk-revoke-verification.js +161 -0
- package/dist/commonjs/models/operations/sdk-revoke-verification.js.map +1 -0
- package/dist/commonjs/models/operations/sdk-store-signal.d.ts +93 -0
- package/dist/commonjs/models/operations/sdk-store-signal.d.ts.map +1 -0
- package/dist/commonjs/models/operations/sdk-store-signal.js +155 -0
- package/dist/commonjs/models/operations/sdk-store-signal.js.map +1 -0
- package/dist/commonjs/models/operations/sdk-validate-signal.d.ts +101 -0
- package/dist/commonjs/models/operations/sdk-validate-signal.d.ts.map +1 -0
- package/dist/commonjs/models/operations/sdk-validate-signal.js +164 -0
- package/dist/commonjs/models/operations/sdk-validate-signal.js.map +1 -0
- package/dist/commonjs/models/operations/sdk-verify-token.d.ts +120 -0
- package/dist/commonjs/models/operations/sdk-verify-token.d.ts.map +1 -0
- package/dist/commonjs/models/operations/sdk-verify-token.js +186 -0
- package/dist/commonjs/models/operations/sdk-verify-token.js.map +1 -0
- package/dist/commonjs/models/operations/verification-get-status.d.ts +161 -0
- package/dist/commonjs/models/operations/verification-get-status.d.ts.map +1 -0
- package/dist/commonjs/models/operations/verification-get-status.js +236 -0
- package/dist/commonjs/models/operations/verification-get-status.js.map +1 -0
- package/dist/commonjs/models/security.d.ts +19 -0
- package/dist/commonjs/models/security.d.ts.map +1 -0
- package/dist/commonjs/models/security.js +61 -0
- package/dist/commonjs/models/security.js.map +1 -0
- package/dist/commonjs/package.json +3 -0
- package/dist/commonjs/sdk/actions.d.ts +26 -0
- package/dist/commonjs/sdk/actions.d.ts.map +1 -0
- package/dist/commonjs/sdk/actions.js +42 -0
- package/dist/commonjs/sdk/actions.js.map +1 -0
- package/dist/commonjs/sdk/census.d.ts +58 -0
- package/dist/commonjs/sdk/census.d.ts.map +1 -0
- package/dist/commonjs/sdk/census.js +89 -0
- package/dist/commonjs/sdk/census.js.map +1 -0
- package/dist/commonjs/sdk/index.d.ts +2 -0
- package/dist/commonjs/sdk/index.d.ts.map +1 -0
- package/dist/commonjs/sdk/index.js +21 -0
- package/dist/commonjs/sdk/index.js.map +1 -0
- package/dist/commonjs/sdk/sdk.d.ts +13 -0
- package/dist/commonjs/sdk/sdk.d.ts.map +1 -0
- package/dist/commonjs/sdk/sdk.js +26 -0
- package/dist/commonjs/sdk/sdk.js.map +1 -0
- package/dist/commonjs/sdk/verification.d.ts +12 -0
- package/dist/commonjs/sdk/verification.d.ts.map +1 -0
- package/dist/commonjs/sdk/verification.js +22 -0
- package/dist/commonjs/sdk/verification.js.map +1 -0
- package/dist/commonjs/types/async.d.ts +23 -0
- package/dist/commonjs/types/async.d.ts.map +1 -0
- package/dist/commonjs/types/async.js +32 -0
- package/dist/commonjs/types/async.js.map +1 -0
- package/dist/commonjs/types/blobs.d.ts +4 -0
- package/dist/commonjs/types/blobs.d.ts.map +1 -0
- package/dist/commonjs/types/blobs.js +62 -0
- package/dist/commonjs/types/blobs.js.map +1 -0
- package/dist/commonjs/types/const-date-time.d.ts +3 -0
- package/dist/commonjs/types/const-date-time.d.ts.map +1 -0
- package/dist/commonjs/types/const-date-time.js +46 -0
- package/dist/commonjs/types/const-date-time.js.map +1 -0
- package/dist/commonjs/types/default-to-zero-value.d.ts +12 -0
- package/dist/commonjs/types/default-to-zero-value.d.ts.map +1 -0
- package/dist/commonjs/types/default-to-zero-value.js +35 -0
- package/dist/commonjs/types/default-to-zero-value.js.map +1 -0
- package/dist/commonjs/types/enums.d.ts +9 -0
- package/dist/commonjs/types/enums.d.ts.map +1 -0
- package/dist/commonjs/types/enums.js +66 -0
- package/dist/commonjs/types/enums.js.map +1 -0
- package/dist/commonjs/types/fp.d.ts +31 -0
- package/dist/commonjs/types/fp.d.ts.map +1 -0
- package/dist/commonjs/types/fp.js +37 -0
- package/dist/commonjs/types/fp.js.map +1 -0
- package/dist/commonjs/types/index.d.ts +10 -0
- package/dist/commonjs/types/index.d.ts.map +1 -0
- package/dist/commonjs/types/index.js +31 -0
- package/dist/commonjs/types/index.js.map +1 -0
- package/dist/commonjs/types/operations.d.ts +27 -0
- package/dist/commonjs/types/operations.d.ts.map +1 -0
- package/dist/commonjs/types/operations.js +83 -0
- package/dist/commonjs/types/operations.js.map +1 -0
- package/dist/commonjs/types/primitives.d.ts +9 -0
- package/dist/commonjs/types/primitives.d.ts.map +1 -0
- package/dist/commonjs/types/primitives.js +147 -0
- package/dist/commonjs/types/primitives.js.map +1 -0
- package/dist/commonjs/types/rfcdate.d.ts +21 -0
- package/dist/commonjs/types/rfcdate.d.ts.map +1 -0
- package/dist/commonjs/types/rfcdate.js +47 -0
- package/dist/commonjs/types/rfcdate.js.map +1 -0
- package/dist/commonjs/types/smart-union.d.ts +7 -0
- package/dist/commonjs/types/smart-union.d.ts.map +1 -0
- package/dist/commonjs/types/smart-union.js +152 -0
- package/dist/commonjs/types/smart-union.js.map +1 -0
- package/dist/commonjs/types/streams.d.ts +2 -0
- package/dist/commonjs/types/streams.d.ts.map +1 -0
- package/dist/commonjs/types/streams.js +18 -0
- package/dist/commonjs/types/streams.js.map +1 -0
- package/dist/commonjs/types/unrecognized.d.ts +16 -0
- package/dist/commonjs/types/unrecognized.d.ts.map +1 -0
- package/dist/commonjs/types/unrecognized.js +34 -0
- package/dist/commonjs/types/unrecognized.js.map +1 -0
- package/dist/esm/core.d.ts +10 -0
- package/dist/esm/core.d.ts.map +1 -0
- package/dist/esm/core.js +13 -0
- package/dist/esm/core.js.map +1 -0
- package/dist/esm/funcs/actions-cancel-action.d.ts +18 -0
- package/dist/esm/funcs/actions-cancel-action.d.ts.map +1 -0
- package/dist/esm/funcs/actions-cancel-action.js +82 -0
- package/dist/esm/funcs/actions-cancel-action.js.map +1 -0
- package/dist/esm/funcs/actions-check-action-status.d.ts +18 -0
- package/dist/esm/funcs/actions-check-action-status.d.ts.map +1 -0
- package/dist/esm/funcs/actions-check-action-status.js +86 -0
- package/dist/esm/funcs/actions-check-action-status.js.map +1 -0
- package/dist/esm/funcs/actions-propose-action.d.ts +18 -0
- package/dist/esm/funcs/actions-propose-action.d.ts.map +1 -0
- package/dist/esm/funcs/actions-propose-action.js +82 -0
- package/dist/esm/funcs/actions-propose-action.js.map +1 -0
- package/dist/esm/funcs/census-create-session.d.ts +18 -0
- package/dist/esm/funcs/census-create-session.d.ts.map +1 -0
- package/dist/esm/funcs/census-create-session.js +87 -0
- package/dist/esm/funcs/census-create-session.js.map +1 -0
- package/dist/esm/funcs/census-create-verification-link.d.ts +18 -0
- package/dist/esm/funcs/census-create-verification-link.d.ts.map +1 -0
- package/dist/esm/funcs/census-create-verification-link.js +87 -0
- package/dist/esm/funcs/census-create-verification-link.js.map +1 -0
- package/dist/esm/funcs/census-get-partner-config.d.ts +18 -0
- package/dist/esm/funcs/census-get-partner-config.d.ts.map +1 -0
- package/dist/esm/funcs/census-get-partner-config.js +96 -0
- package/dist/esm/funcs/census-get-partner-config.js.map +1 -0
- package/dist/esm/funcs/census-logout.d.ts +15 -0
- package/dist/esm/funcs/census-logout.d.ts.map +1 -0
- package/dist/esm/funcs/census-logout.js +84 -0
- package/dist/esm/funcs/census-logout.js.map +1 -0
- package/dist/esm/funcs/census-revoke-verification.d.ts +18 -0
- package/dist/esm/funcs/census-revoke-verification.d.ts.map +1 -0
- package/dist/esm/funcs/census-revoke-verification.js +87 -0
- package/dist/esm/funcs/census-revoke-verification.js.map +1 -0
- package/dist/esm/funcs/census-store-signal.d.ts +18 -0
- package/dist/esm/funcs/census-store-signal.d.ts.map +1 -0
- package/dist/esm/funcs/census-store-signal.js +78 -0
- package/dist/esm/funcs/census-store-signal.js.map +1 -0
- package/dist/esm/funcs/census-validate-signal.d.ts +18 -0
- package/dist/esm/funcs/census-validate-signal.d.ts.map +1 -0
- package/dist/esm/funcs/census-validate-signal.js +78 -0
- package/dist/esm/funcs/census-validate-signal.js.map +1 -0
- package/dist/esm/funcs/census-verify-token.d.ts +18 -0
- package/dist/esm/funcs/census-verify-token.d.ts.map +1 -0
- package/dist/esm/funcs/census-verify-token.js +93 -0
- package/dist/esm/funcs/census-verify-token.js.map +1 -0
- package/dist/esm/funcs/verification-get-status.d.ts +18 -0
- package/dist/esm/funcs/verification-get-status.d.ts.map +1 -0
- package/dist/esm/funcs/verification-get-status.js +96 -0
- package/dist/esm/funcs/verification-get-status.js.map +1 -0
- package/dist/esm/hooks/hooks.d.ts +25 -0
- package/dist/esm/hooks/hooks.d.ts.map +1 -0
- package/dist/esm/hooks/hooks.js +80 -0
- package/dist/esm/hooks/hooks.js.map +1 -0
- package/dist/esm/hooks/index.d.ts +3 -0
- package/dist/esm/hooks/index.d.ts.map +1 -0
- package/dist/esm/hooks/index.js +6 -0
- package/dist/esm/hooks/index.js.map +1 -0
- package/dist/esm/hooks/types.d.ts +77 -0
- package/dist/esm/hooks/types.d.ts.map +1 -0
- package/dist/esm/hooks/types.js +5 -0
- package/dist/esm/hooks/types.js.map +1 -0
- package/dist/esm/index.d.ts +6 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +8 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/lib/base64.d.ts +10 -0
- package/dist/esm/lib/base64.d.ts.map +1 -0
- package/dist/esm/lib/base64.js +29 -0
- package/dist/esm/lib/base64.js.map +1 -0
- package/dist/esm/lib/config.d.ts +42 -0
- package/dist/esm/lib/config.d.ts.map +1 -0
- package/dist/esm/lib/config.js +38 -0
- package/dist/esm/lib/config.js.map +1 -0
- package/dist/esm/lib/encodings.d.ts +55 -0
- package/dist/esm/lib/encodings.d.ts.map +1 -0
- package/dist/esm/lib/encodings.js +407 -0
- package/dist/esm/lib/encodings.js.map +1 -0
- package/dist/esm/lib/files.d.ts +26 -0
- package/dist/esm/lib/files.d.ts.map +1 -0
- package/dist/esm/lib/files.js +91 -0
- package/dist/esm/lib/files.js.map +1 -0
- package/dist/esm/lib/http.d.ts +67 -0
- package/dist/esm/lib/http.d.ts.map +1 -0
- package/dist/esm/lib/http.js +209 -0
- package/dist/esm/lib/http.js.map +1 -0
- package/dist/esm/lib/logger.d.ts +6 -0
- package/dist/esm/lib/logger.d.ts.map +1 -0
- package/dist/esm/lib/logger.js +5 -0
- package/dist/esm/lib/logger.js.map +1 -0
- package/dist/esm/lib/matchers.d.ts +59 -0
- package/dist/esm/lib/matchers.d.ts.map +1 -0
- package/dist/esm/lib/matchers.js +202 -0
- package/dist/esm/lib/matchers.js.map +1 -0
- package/dist/esm/lib/primitives.d.ts +27 -0
- package/dist/esm/lib/primitives.d.ts.map +1 -0
- package/dist/esm/lib/primitives.js +120 -0
- package/dist/esm/lib/primitives.js.map +1 -0
- package/dist/esm/lib/retries.d.ts +38 -0
- package/dist/esm/lib/retries.d.ts.map +1 -0
- package/dist/esm/lib/retries.js +157 -0
- package/dist/esm/lib/retries.js.map +1 -0
- package/dist/esm/lib/schemas.d.ts +19 -0
- package/dist/esm/lib/schemas.d.ts.map +1 -0
- package/dist/esm/lib/schemas.js +57 -0
- package/dist/esm/lib/schemas.js.map +1 -0
- package/dist/esm/lib/sdks.d.ts +63 -0
- package/dist/esm/lib/sdks.d.ts.map +1 -0
- package/dist/esm/lib/sdks.js +290 -0
- package/dist/esm/lib/sdks.js.map +1 -0
- package/dist/esm/lib/security.d.ts +84 -0
- package/dist/esm/lib/security.d.ts.map +1 -0
- package/dist/esm/lib/security.js +153 -0
- package/dist/esm/lib/security.js.map +1 -0
- package/dist/esm/lib/url.d.ts +5 -0
- package/dist/esm/lib/url.d.ts.map +1 -0
- package/dist/esm/lib/url.js +24 -0
- package/dist/esm/lib/url.js.map +1 -0
- package/dist/esm/mcp-server/build.d.mts.map +1 -0
- package/dist/esm/mcp-server/build.mjs +14 -0
- package/dist/esm/mcp-server/build.mjs.map +1 -0
- package/dist/esm/mcp-server/cli/start/command.d.ts +2 -0
- package/dist/esm/mcp-server/cli/start/command.d.ts.map +1 -0
- package/dist/esm/mcp-server/cli/start/command.js +105 -0
- package/dist/esm/mcp-server/cli/start/command.js.map +1 -0
- package/dist/esm/mcp-server/cli/start/impl.d.ts +19 -0
- package/dist/esm/mcp-server/cli/start/impl.d.ts.map +1 -0
- package/dist/esm/mcp-server/cli/start/impl.js +104 -0
- package/dist/esm/mcp-server/cli/start/impl.js.map +1 -0
- package/dist/esm/mcp-server/cli.d.ts +6 -0
- package/dist/esm/mcp-server/cli.d.ts.map +1 -0
- package/dist/esm/mcp-server/cli.js +7 -0
- package/dist/esm/mcp-server/cli.js.map +1 -0
- package/dist/esm/mcp-server/console-logger.d.ts +7 -0
- package/dist/esm/mcp-server/console-logger.d.ts.map +1 -0
- package/dist/esm/mcp-server/console-logger.js +55 -0
- package/dist/esm/mcp-server/console-logger.js.map +1 -0
- package/dist/esm/mcp-server/extensions.d.ts +11 -0
- package/dist/esm/mcp-server/extensions.d.ts.map +1 -0
- package/dist/esm/mcp-server/extensions.js +5 -0
- package/dist/esm/mcp-server/extensions.js.map +1 -0
- package/dist/esm/mcp-server/mcp-server.d.ts +2 -0
- package/dist/esm/mcp-server/mcp-server.d.ts.map +1 -0
- package/dist/esm/mcp-server/mcp-server.js +23 -0
- package/dist/esm/mcp-server/mcp-server.js.map +1 -0
- package/dist/esm/mcp-server/prompts.d.ts +26 -0
- package/dist/esm/mcp-server/prompts.d.ts.map +1 -0
- package/dist/esm/mcp-server/prompts.js +47 -0
- package/dist/esm/mcp-server/prompts.js.map +1 -0
- package/dist/esm/mcp-server/resources.d.ts +32 -0
- package/dist/esm/mcp-server/resources.d.ts.map +1 -0
- package/dist/esm/mcp-server/resources.js +82 -0
- package/dist/esm/mcp-server/resources.js.map +1 -0
- package/dist/esm/mcp-server/scopes.d.ts +3 -0
- package/dist/esm/mcp-server/scopes.d.ts.map +1 -0
- package/dist/esm/mcp-server/scopes.js +7 -0
- package/dist/esm/mcp-server/scopes.js.map +1 -0
- package/dist/esm/mcp-server/server.d.ts +13 -0
- package/dist/esm/mcp-server/server.d.ts.map +1 -0
- package/dist/esm/mcp-server/server.js +35 -0
- package/dist/esm/mcp-server/server.js.map +1 -0
- package/dist/esm/mcp-server/shared.d.ts +7 -0
- package/dist/esm/mcp-server/shared.d.ts.map +1 -0
- package/dist/esm/mcp-server/shared.js +59 -0
- package/dist/esm/mcp-server/shared.js.map +1 -0
- package/dist/esm/mcp-server/tools/actions-cancel-action.d.ts +8 -0
- package/dist/esm/mcp-server/tools/actions-cancel-action.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/actions-cancel-action.js +27 -0
- package/dist/esm/mcp-server/tools/actions-cancel-action.js.map +1 -0
- package/dist/esm/mcp-server/tools/actions-check-action-status.d.ts +8 -0
- package/dist/esm/mcp-server/tools/actions-check-action-status.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/actions-check-action-status.js +27 -0
- package/dist/esm/mcp-server/tools/actions-check-action-status.js.map +1 -0
- package/dist/esm/mcp-server/tools/actions-propose-action.d.ts +8 -0
- package/dist/esm/mcp-server/tools/actions-propose-action.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/actions-propose-action.js +27 -0
- package/dist/esm/mcp-server/tools/actions-propose-action.js.map +1 -0
- package/dist/esm/mcp-server/tools.d.ts +25 -0
- package/dist/esm/mcp-server/tools.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools.js +78 -0
- package/dist/esm/mcp-server/tools.js.map +1 -0
- package/dist/esm/models/error-body.d.ts +56 -0
- package/dist/esm/models/error-body.d.ts.map +1 -0
- package/dist/esm/models/error-body.js +60 -0
- package/dist/esm/models/error-body.js.map +1 -0
- package/dist/esm/models/error-response.d.ts +19 -0
- package/dist/esm/models/error-response.d.ts.map +1 -0
- package/dist/esm/models/error-response.js +23 -0
- package/dist/esm/models/error-response.js.map +1 -0
- package/dist/esm/models/errors/bot-shield-default-error.d.ts +10 -0
- package/dist/esm/models/errors/bot-shield-default-error.d.ts.map +1 -0
- package/dist/esm/models/errors/bot-shield-default-error.js +30 -0
- package/dist/esm/models/errors/bot-shield-default-error.js.map +1 -0
- package/dist/esm/models/errors/bot-shield-error.d.ts +19 -0
- package/dist/esm/models/errors/bot-shield-error.d.ts.map +1 -0
- package/dist/esm/models/errors/bot-shield-error.js +26 -0
- package/dist/esm/models/errors/bot-shield-error.js.map +1 -0
- package/dist/esm/models/errors/error-response.d.ts +31 -0
- package/dist/esm/models/errors/error-response.d.ts.map +1 -0
- package/dist/esm/models/errors/error-response.js +43 -0
- package/dist/esm/models/errors/error-response.js.map +1 -0
- package/dist/esm/models/errors/http-client-errors.d.ts +44 -0
- package/dist/esm/models/errors/http-client-errors.d.ts.map +1 -0
- package/dist/esm/models/errors/http-client-errors.js +56 -0
- package/dist/esm/models/errors/http-client-errors.js.map +1 -0
- package/dist/esm/models/errors/index.d.ts +8 -0
- package/dist/esm/models/errors/index.d.ts.map +1 -0
- package/dist/esm/models/errors/index.js +11 -0
- package/dist/esm/models/errors/index.js.map +1 -0
- package/dist/esm/models/errors/invalid-input-error.d.ts +42 -0
- package/dist/esm/models/errors/invalid-input-error.d.ts.map +1 -0
- package/dist/esm/models/errors/invalid-input-error.js +49 -0
- package/dist/esm/models/errors/invalid-input-error.js.map +1 -0
- package/dist/esm/models/errors/response-validation-error.d.ts +26 -0
- package/dist/esm/models/errors/response-validation-error.d.ts.map +1 -0
- package/dist/esm/models/errors/response-validation-error.js +37 -0
- package/dist/esm/models/errors/response-validation-error.js.map +1 -0
- package/dist/esm/models/errors/sdk-validation-error.d.ts +21 -0
- package/dist/esm/models/errors/sdk-validation-error.d.ts.map +1 -0
- package/dist/esm/models/errors/sdk-validation-error.js +99 -0
- package/dist/esm/models/errors/sdk-validation-error.js.map +1 -0
- package/dist/esm/models/index.d.ts +5 -0
- package/dist/esm/models/index.d.ts.map +1 -0
- package/dist/esm/models/index.js +8 -0
- package/dist/esm/models/index.js.map +1 -0
- package/dist/esm/models/invalid-input-error.d.ts +24 -0
- package/dist/esm/models/invalid-input-error.d.ts.map +1 -0
- package/dist/esm/models/invalid-input-error.js +25 -0
- package/dist/esm/models/invalid-input-error.js.map +1 -0
- package/dist/esm/models/operations/actions-cancel.d.ts +104 -0
- package/dist/esm/models/operations/actions-cancel.d.ts.map +1 -0
- package/dist/esm/models/operations/actions-cancel.js +110 -0
- package/dist/esm/models/operations/actions-cancel.js.map +1 -0
- package/dist/esm/models/operations/actions-check-status.d.ts +121 -0
- package/dist/esm/models/operations/actions-check-status.d.ts.map +1 -0
- package/dist/esm/models/operations/actions-check-status.js +132 -0
- package/dist/esm/models/operations/actions-check-status.js.map +1 -0
- package/dist/esm/models/operations/actions-propose.d.ts +187 -0
- package/dist/esm/models/operations/actions-propose.d.ts.map +1 -0
- package/dist/esm/models/operations/actions-propose.js +179 -0
- package/dist/esm/models/operations/actions-propose.js.map +1 -0
- package/dist/esm/models/operations/index.d.ts +13 -0
- package/dist/esm/models/operations/index.d.ts.map +1 -0
- package/dist/esm/models/operations/index.js +16 -0
- package/dist/esm/models/operations/index.js.map +1 -0
- package/dist/esm/models/operations/sdk-create-session.d.ts +139 -0
- package/dist/esm/models/operations/sdk-create-session.d.ts.map +1 -0
- package/dist/esm/models/operations/sdk-create-session.js +157 -0
- package/dist/esm/models/operations/sdk-create-session.js.map +1 -0
- package/dist/esm/models/operations/sdk-create-verification-link.d.ts +220 -0
- package/dist/esm/models/operations/sdk-create-verification-link.d.ts.map +1 -0
- package/dist/esm/models/operations/sdk-create-verification-link.js +222 -0
- package/dist/esm/models/operations/sdk-create-verification-link.js.map +1 -0
- package/dist/esm/models/operations/sdk-get-partner-config.d.ts +126 -0
- package/dist/esm/models/operations/sdk-get-partner-config.d.ts.map +1 -0
- package/dist/esm/models/operations/sdk-get-partner-config.js +131 -0
- package/dist/esm/models/operations/sdk-get-partner-config.js.map +1 -0
- package/dist/esm/models/operations/sdk-logout.d.ts +74 -0
- package/dist/esm/models/operations/sdk-logout.d.ts.map +1 -0
- package/dist/esm/models/operations/sdk-logout.js +99 -0
- package/dist/esm/models/operations/sdk-logout.js.map +1 -0
- package/dist/esm/models/operations/sdk-revoke-verification.d.ts +97 -0
- package/dist/esm/models/operations/sdk-revoke-verification.d.ts.map +1 -0
- package/dist/esm/models/operations/sdk-revoke-verification.js +115 -0
- package/dist/esm/models/operations/sdk-revoke-verification.js.map +1 -0
- package/dist/esm/models/operations/sdk-store-signal.d.ts +93 -0
- package/dist/esm/models/operations/sdk-store-signal.d.ts.map +1 -0
- package/dist/esm/models/operations/sdk-store-signal.js +111 -0
- package/dist/esm/models/operations/sdk-store-signal.js.map +1 -0
- package/dist/esm/models/operations/sdk-validate-signal.d.ts +101 -0
- package/dist/esm/models/operations/sdk-validate-signal.d.ts.map +1 -0
- package/dist/esm/models/operations/sdk-validate-signal.js +120 -0
- package/dist/esm/models/operations/sdk-validate-signal.js.map +1 -0
- package/dist/esm/models/operations/sdk-verify-token.d.ts +120 -0
- package/dist/esm/models/operations/sdk-verify-token.d.ts.map +1 -0
- package/dist/esm/models/operations/sdk-verify-token.js +138 -0
- package/dist/esm/models/operations/sdk-verify-token.js.map +1 -0
- package/dist/esm/models/operations/verification-get-status.d.ts +161 -0
- package/dist/esm/models/operations/verification-get-status.d.ts.map +1 -0
- package/dist/esm/models/operations/verification-get-status.js +190 -0
- package/dist/esm/models/operations/verification-get-status.js.map +1 -0
- package/dist/esm/models/security.d.ts +19 -0
- package/dist/esm/models/security.d.ts.map +1 -0
- package/dist/esm/models/security.js +23 -0
- package/dist/esm/models/security.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/sdk/actions.d.ts +26 -0
- package/dist/esm/sdk/actions.d.ts.map +1 -0
- package/dist/esm/sdk/actions.js +38 -0
- package/dist/esm/sdk/actions.js.map +1 -0
- package/dist/esm/sdk/census.d.ts +58 -0
- package/dist/esm/sdk/census.d.ts.map +1 -0
- package/dist/esm/sdk/census.js +85 -0
- package/dist/esm/sdk/census.js.map +1 -0
- package/dist/esm/sdk/index.d.ts +2 -0
- package/dist/esm/sdk/index.d.ts.map +1 -0
- package/dist/esm/sdk/index.js +5 -0
- package/dist/esm/sdk/index.js.map +1 -0
- package/dist/esm/sdk/sdk.d.ts +13 -0
- package/dist/esm/sdk/sdk.d.ts.map +1 -0
- package/dist/esm/sdk/sdk.js +22 -0
- package/dist/esm/sdk/sdk.js.map +1 -0
- package/dist/esm/sdk/verification.d.ts +12 -0
- package/dist/esm/sdk/verification.d.ts.map +1 -0
- package/dist/esm/sdk/verification.js +18 -0
- package/dist/esm/sdk/verification.js.map +1 -0
- package/dist/esm/types/async.d.ts +23 -0
- package/dist/esm/types/async.d.ts.map +1 -0
- package/dist/esm/types/async.js +28 -0
- package/dist/esm/types/async.js.map +1 -0
- package/dist/esm/types/blobs.d.ts +4 -0
- package/dist/esm/types/blobs.d.ts.map +1 -0
- package/dist/esm/types/blobs.js +25 -0
- package/dist/esm/types/blobs.js.map +1 -0
- package/dist/esm/types/const-date-time.d.ts +3 -0
- package/dist/esm/types/const-date-time.d.ts.map +1 -0
- package/dist/esm/types/const-date-time.js +10 -0
- package/dist/esm/types/const-date-time.js.map +1 -0
- package/dist/esm/types/default-to-zero-value.d.ts +12 -0
- package/dist/esm/types/default-to-zero-value.d.ts.map +1 -0
- package/dist/esm/types/default-to-zero-value.js +31 -0
- package/dist/esm/types/default-to-zero-value.js.map +1 -0
- package/dist/esm/types/enums.d.ts +9 -0
- package/dist/esm/types/enums.d.ts.map +1 -0
- package/dist/esm/types/enums.js +27 -0
- package/dist/esm/types/enums.js.map +1 -0
- package/dist/esm/types/fp.d.ts +31 -0
- package/dist/esm/types/fp.d.ts.map +1 -0
- package/dist/esm/types/fp.js +31 -0
- package/dist/esm/types/fp.js.map +1 -0
- package/dist/esm/types/index.d.ts +10 -0
- package/dist/esm/types/index.d.ts.map +1 -0
- package/dist/esm/types/index.js +10 -0
- package/dist/esm/types/index.js.map +1 -0
- package/dist/esm/types/operations.d.ts +27 -0
- package/dist/esm/types/operations.d.ts.map +1 -0
- package/dist/esm/types/operations.js +77 -0
- package/dist/esm/types/operations.js.map +1 -0
- package/dist/esm/types/primitives.d.ts +9 -0
- package/dist/esm/types/primitives.d.ts.map +1 -0
- package/dist/esm/types/primitives.js +105 -0
- package/dist/esm/types/primitives.js.map +1 -0
- package/dist/esm/types/rfcdate.d.ts +21 -0
- package/dist/esm/types/rfcdate.d.ts.map +1 -0
- package/dist/esm/types/rfcdate.js +43 -0
- package/dist/esm/types/rfcdate.js.map +1 -0
- package/dist/esm/types/smart-union.d.ts +7 -0
- package/dist/esm/types/smart-union.d.ts.map +1 -0
- package/dist/esm/types/smart-union.js +116 -0
- package/dist/esm/types/smart-union.js.map +1 -0
- package/dist/esm/types/streams.d.ts +2 -0
- package/dist/esm/types/streams.d.ts.map +1 -0
- package/dist/esm/types/streams.js +15 -0
- package/dist/esm/types/streams.js.map +1 -0
- package/dist/esm/types/unrecognized.d.ts +16 -0
- package/dist/esm/types/unrecognized.d.ts.map +1 -0
- package/dist/esm/types/unrecognized.js +31 -0
- package/dist/esm/types/unrecognized.js.map +1 -0
- package/examples/censusCreateSession.example.ts +26 -0
- package/jsr.json +27 -0
- package/package.json +124 -132
- package/src/core.ts +13 -0
- package/src/funcs/actions-cancel-action.ts +174 -0
- package/src/funcs/actions-check-action-status.ts +179 -0
- package/src/funcs/actions-propose-action.ts +174 -0
- package/src/funcs/census-create-session.ts +184 -0
- package/src/funcs/census-create-verification-link.ts +185 -0
- package/src/funcs/census-get-partner-config.ts +196 -0
- package/src/funcs/census-logout.ts +181 -0
- package/src/funcs/census-revoke-verification.ts +185 -0
- package/src/funcs/census-store-signal.ts +169 -0
- package/src/funcs/census-validate-signal.ts +169 -0
- package/src/funcs/census-verify-token.ts +191 -0
- package/src/funcs/verification-get-status.ts +196 -0
- package/src/hooks/hooks.ts +129 -0
- package/src/hooks/index.ts +6 -0
- package/src/hooks/types.ts +108 -0
- package/src/index.ts +8 -21
- package/src/lib/base64.ts +37 -0
- package/src/lib/config.ts +75 -0
- package/src/lib/encodings.ts +564 -0
- package/src/lib/files.ts +104 -0
- package/src/lib/http.ts +325 -0
- package/src/lib/logger.ts +9 -0
- package/src/lib/matchers.ts +353 -0
- package/src/lib/primitives.ts +166 -0
- package/src/lib/retries.ts +226 -0
- package/src/lib/schemas.ts +91 -0
- package/src/lib/sdks.ts +438 -0
- package/src/lib/security.ts +286 -0
- package/src/lib/url.ts +35 -0
- package/src/mcp-server/cli/start/command.ts +109 -0
- package/src/mcp-server/cli/start/impl.ts +141 -0
- package/src/mcp-server/cli.ts +13 -0
- package/src/mcp-server/console-logger.ts +71 -0
- package/src/mcp-server/extensions.ts +17 -0
- package/src/mcp-server/mcp-server.ts +26 -0
- package/src/mcp-server/prompts.ts +121 -0
- package/src/mcp-server/resources.ts +176 -0
- package/src/mcp-server/scopes.ts +9 -0
- package/src/mcp-server/server.ts +65 -0
- package/src/mcp-server/shared.ts +74 -0
- package/src/mcp-server/tools/actions-cancel-action.ts +37 -0
- package/src/mcp-server/tools/actions-check-action-status.ts +37 -0
- package/src/mcp-server/tools/actions-propose-action.ts +37 -0
- package/src/mcp-server/tools.ts +133 -0
- package/src/models/error-body.ts +138 -0
- package/src/models/error-response.ts +56 -0
- package/src/models/errors/bot-shield-default-error.ts +40 -0
- package/src/models/errors/bot-shield-error.ts +35 -0
- package/src/models/errors/error-response.ts +72 -0
- package/src/models/errors/http-client-errors.ts +62 -0
- package/src/models/errors/index.ts +11 -0
- package/src/models/errors/invalid-input-error.ts +82 -0
- package/src/models/errors/response-validation-error.ts +50 -0
- package/src/models/errors/sdk-validation-error.ts +109 -0
- package/src/models/index.ts +8 -0
- package/src/models/invalid-input-error.ts +63 -0
- package/src/models/operations/actions-cancel.ts +271 -0
- package/src/models/operations/actions-check-status.ts +308 -0
- package/src/models/operations/actions-propose.ts +439 -0
- package/src/models/operations/index.ts +16 -0
- package/src/models/operations/sdk-create-session.ts +388 -0
- package/src/models/operations/sdk-create-verification-link.ts +550 -0
- package/src/models/operations/sdk-get-partner-config.ts +345 -0
- package/src/models/operations/sdk-logout.ts +230 -0
- package/src/models/operations/sdk-revoke-verification.ts +299 -0
- package/src/models/operations/sdk-store-signal.ts +261 -0
- package/src/models/operations/sdk-validate-signal.ts +274 -0
- package/src/models/operations/sdk-verify-token.ts +343 -0
- package/src/models/operations/verification-get-status.ts +430 -0
- package/src/models/security.ts +52 -0
- package/src/sdk/actions.ts +63 -0
- package/src/sdk/census.ts +162 -0
- package/src/sdk/index.ts +5 -0
- package/src/sdk/sdk.ts +25 -0
- package/src/sdk/verification.ts +29 -0
- package/src/types/async.ts +69 -0
- package/src/types/blobs.ts +32 -0
- package/src/types/const-date-time.ts +15 -0
- package/src/types/default-to-zero-value.ts +33 -0
- package/src/types/enums.ts +45 -0
- package/src/types/fp.ts +50 -0
- package/src/types/index.ts +13 -0
- package/src/types/operations.ts +105 -0
- package/src/types/primitives.ts +122 -0
- package/src/types/rfcdate.ts +54 -0
- package/src/types/smart-union.ts +153 -0
- package/src/types/streams.ts +21 -0
- package/src/types/unrecognized.ts +35 -0
- package/CHANGELOG.md +0 -270
- package/LICENSE +0 -201
- package/api-promise.d.mts +0 -3
- package/api-promise.d.mts.map +0 -1
- package/api-promise.d.ts +0 -3
- package/api-promise.d.ts.map +0 -1
- package/api-promise.js +0 -6
- package/api-promise.js.map +0 -1
- package/api-promise.mjs +0 -3
- package/api-promise.mjs.map +0 -1
- package/client.d.mts +0 -218
- package/client.d.mts.map +0 -1
- package/client.d.ts +0 -218
- package/client.d.ts.map +0 -1
- package/client.js +0 -534
- package/client.js.map +0 -1
- package/client.mjs +0 -530
- package/client.mjs.map +0 -1
- package/core/api-promise.d.mts +0 -46
- package/core/api-promise.d.mts.map +0 -1
- package/core/api-promise.d.ts +0 -46
- package/core/api-promise.d.ts.map +0 -1
- package/core/api-promise.js +0 -74
- package/core/api-promise.js.map +0 -1
- package/core/api-promise.mjs +0 -70
- package/core/api-promise.mjs.map +0 -1
- package/core/error.d.mts +0 -46
- package/core/error.d.mts.map +0 -1
- package/core/error.d.ts +0 -46
- package/core/error.d.ts.map +0 -1
- package/core/error.js +0 -113
- package/core/error.js.map +0 -1
- package/core/error.mjs +0 -97
- package/core/error.mjs.map +0 -1
- package/core/resource.d.mts +0 -6
- package/core/resource.d.mts.map +0 -1
- package/core/resource.d.ts +0 -6
- package/core/resource.d.ts.map +0 -1
- package/core/resource.js +0 -11
- package/core/resource.js.map +0 -1
- package/core/resource.mjs +0 -7
- package/core/resource.mjs.map +0 -1
- package/core/uploads.d.mts +0 -3
- package/core/uploads.d.mts.map +0 -1
- package/core/uploads.d.ts +0 -3
- package/core/uploads.d.ts.map +0 -1
- package/core/uploads.js +0 -6
- package/core/uploads.js.map +0 -1
- package/core/uploads.mjs +0 -2
- package/core/uploads.mjs.map +0 -1
- package/error.d.mts +0 -3
- package/error.d.mts.map +0 -1
- package/error.d.ts +0 -3
- package/error.d.ts.map +0 -1
- package/error.js +0 -6
- package/error.js.map +0 -1
- package/error.mjs +0 -3
- package/error.mjs.map +0 -1
- package/index.d.mts +0 -6
- package/index.d.mts.map +0 -1
- package/index.d.ts +0 -6
- package/index.d.ts.map +0 -1
- package/index.js +0 -30
- package/index.js.map +0 -1
- package/index.mjs +0 -7
- package/index.mjs.map +0 -1
- package/internal/builtin-types.d.mts +0 -73
- package/internal/builtin-types.d.mts.map +0 -1
- package/internal/builtin-types.d.ts +0 -73
- package/internal/builtin-types.d.ts.map +0 -1
- package/internal/builtin-types.js +0 -4
- package/internal/builtin-types.js.map +0 -1
- package/internal/builtin-types.mjs +0 -3
- package/internal/builtin-types.mjs.map +0 -1
- package/internal/detect-platform.d.mts +0 -15
- package/internal/detect-platform.d.mts.map +0 -1
- package/internal/detect-platform.d.ts +0 -15
- package/internal/detect-platform.d.ts.map +0 -1
- package/internal/detect-platform.js +0 -162
- package/internal/detect-platform.js.map +0 -1
- package/internal/detect-platform.mjs +0 -157
- package/internal/detect-platform.mjs.map +0 -1
- package/internal/errors.d.mts +0 -3
- package/internal/errors.d.mts.map +0 -1
- package/internal/errors.d.ts +0 -3
- package/internal/errors.d.ts.map +0 -1
- package/internal/errors.js +0 -41
- package/internal/errors.js.map +0 -1
- package/internal/errors.mjs +0 -36
- package/internal/errors.mjs.map +0 -1
- package/internal/headers.d.mts +0 -20
- package/internal/headers.d.mts.map +0 -1
- package/internal/headers.d.ts +0 -20
- package/internal/headers.d.ts.map +0 -1
- package/internal/headers.js +0 -79
- package/internal/headers.js.map +0 -1
- package/internal/headers.mjs +0 -74
- package/internal/headers.mjs.map +0 -1
- package/internal/parse.d.mts +0 -12
- package/internal/parse.d.mts.map +0 -1
- package/internal/parse.d.ts +0 -12
- package/internal/parse.d.ts.map +0 -1
- package/internal/parse.js +0 -40
- package/internal/parse.js.map +0 -1
- package/internal/parse.mjs +0 -37
- package/internal/parse.mjs.map +0 -1
- package/internal/request-options.d.mts +0 -75
- package/internal/request-options.d.mts.map +0 -1
- package/internal/request-options.d.ts +0 -75
- package/internal/request-options.d.ts.map +0 -1
- package/internal/request-options.js +0 -14
- package/internal/request-options.js.map +0 -1
- package/internal/request-options.mjs +0 -10
- package/internal/request-options.mjs.map +0 -1
- package/internal/shim-types.d.mts +0 -17
- package/internal/shim-types.d.mts.map +0 -1
- package/internal/shim-types.d.ts +0 -17
- package/internal/shim-types.d.ts.map +0 -1
- package/internal/shim-types.js +0 -4
- package/internal/shim-types.js.map +0 -1
- package/internal/shim-types.mjs +0 -3
- package/internal/shim-types.mjs.map +0 -1
- package/internal/shims.d.mts +0 -26
- package/internal/shims.d.mts.map +0 -1
- package/internal/shims.d.ts +0 -26
- package/internal/shims.d.ts.map +0 -1
- package/internal/shims.js +0 -92
- package/internal/shims.js.map +0 -1
- package/internal/shims.mjs +0 -85
- package/internal/shims.mjs.map +0 -1
- package/internal/to-file.d.mts +0 -45
- package/internal/to-file.d.mts.map +0 -1
- package/internal/to-file.d.ts +0 -45
- package/internal/to-file.d.ts.map +0 -1
- package/internal/to-file.js +0 -91
- package/internal/to-file.js.map +0 -1
- package/internal/to-file.mjs +0 -88
- package/internal/to-file.mjs.map +0 -1
- package/internal/tslib.js +0 -81
- package/internal/tslib.mjs +0 -17
- package/internal/types.d.mts +0 -69
- package/internal/types.d.mts.map +0 -1
- package/internal/types.d.ts +0 -69
- package/internal/types.d.ts.map +0 -1
- package/internal/types.js +0 -4
- package/internal/types.js.map +0 -1
- package/internal/types.mjs +0 -3
- package/internal/types.mjs.map +0 -1
- package/internal/uploads.d.mts +0 -42
- package/internal/uploads.d.mts.map +0 -1
- package/internal/uploads.d.ts +0 -42
- package/internal/uploads.d.ts.map +0 -1
- package/internal/uploads.js +0 -141
- package/internal/uploads.js.map +0 -1
- package/internal/uploads.mjs +0 -131
- package/internal/uploads.mjs.map +0 -1
- package/internal/utils/base64.d.mts +0 -3
- package/internal/utils/base64.d.mts.map +0 -1
- package/internal/utils/base64.d.ts +0 -3
- package/internal/utils/base64.d.ts.map +0 -1
- package/internal/utils/base64.js +0 -38
- package/internal/utils/base64.js.map +0 -1
- package/internal/utils/base64.mjs +0 -33
- package/internal/utils/base64.mjs.map +0 -1
- package/internal/utils/bytes.d.mts +0 -4
- package/internal/utils/bytes.d.mts.map +0 -1
- package/internal/utils/bytes.d.ts +0 -4
- package/internal/utils/bytes.d.ts.map +0 -1
- package/internal/utils/bytes.js +0 -31
- package/internal/utils/bytes.js.map +0 -1
- package/internal/utils/bytes.mjs +0 -26
- package/internal/utils/bytes.mjs.map +0 -1
- package/internal/utils/env.d.mts +0 -9
- package/internal/utils/env.d.mts.map +0 -1
- package/internal/utils/env.d.ts +0 -9
- package/internal/utils/env.d.ts.map +0 -1
- package/internal/utils/env.js +0 -22
- package/internal/utils/env.js.map +0 -1
- package/internal/utils/env.mjs +0 -18
- package/internal/utils/env.mjs.map +0 -1
- package/internal/utils/log.d.mts +0 -37
- package/internal/utils/log.d.mts.map +0 -1
- package/internal/utils/log.d.ts +0 -37
- package/internal/utils/log.d.ts.map +0 -1
- package/internal/utils/log.js +0 -87
- package/internal/utils/log.js.map +0 -1
- package/internal/utils/log.mjs +0 -81
- package/internal/utils/log.mjs.map +0 -1
- package/internal/utils/path.d.mts +0 -15
- package/internal/utils/path.d.mts.map +0 -1
- package/internal/utils/path.d.ts +0 -15
- package/internal/utils/path.d.ts.map +0 -1
- package/internal/utils/path.js +0 -79
- package/internal/utils/path.js.map +0 -1
- package/internal/utils/path.mjs +0 -74
- package/internal/utils/path.mjs.map +0 -1
- package/internal/utils/query.d.mts +0 -5
- package/internal/utils/query.d.mts.map +0 -1
- package/internal/utils/query.d.ts +0 -5
- package/internal/utils/query.d.ts.map +0 -1
- package/internal/utils/query.js +0 -23
- package/internal/utils/query.js.map +0 -1
- package/internal/utils/query.mjs +0 -20
- package/internal/utils/query.mjs.map +0 -1
- package/internal/utils/sleep.d.mts +0 -2
- package/internal/utils/sleep.d.mts.map +0 -1
- package/internal/utils/sleep.d.ts +0 -2
- package/internal/utils/sleep.d.ts.map +0 -1
- package/internal/utils/sleep.js +0 -7
- package/internal/utils/sleep.js.map +0 -1
- package/internal/utils/sleep.mjs +0 -3
- package/internal/utils/sleep.mjs.map +0 -1
- package/internal/utils/uuid.d.mts +0 -5
- package/internal/utils/uuid.d.mts.map +0 -1
- package/internal/utils/uuid.d.ts +0 -5
- package/internal/utils/uuid.d.ts.map +0 -1
- package/internal/utils/uuid.js +0 -19
- package/internal/utils/uuid.js.map +0 -1
- package/internal/utils/uuid.mjs +0 -15
- package/internal/utils/uuid.mjs.map +0 -1
- package/internal/utils/values.d.mts +0 -18
- package/internal/utils/values.d.mts.map +0 -1
- package/internal/utils/values.d.ts +0 -18
- package/internal/utils/values.d.ts.map +0 -1
- package/internal/utils/values.js +0 -112
- package/internal/utils/values.js.map +0 -1
- package/internal/utils/values.mjs +0 -94
- package/internal/utils/values.mjs.map +0 -1
- package/internal/utils.d.mts +0 -8
- package/internal/utils.d.mts.map +0 -1
- package/internal/utils.d.ts +0 -8
- package/internal/utils.d.ts.map +0 -1
- package/internal/utils.js +0 -12
- package/internal/utils.js.map +0 -1
- package/internal/utils.mjs +0 -9
- package/internal/utils.mjs.map +0 -1
- package/resource.d.mts +0 -3
- package/resource.d.mts.map +0 -1
- package/resource.d.ts +0 -3
- package/resource.d.ts.map +0 -1
- package/resource.js +0 -6
- package/resource.js.map +0 -1
- package/resource.mjs +0 -3
- package/resource.mjs.map +0 -1
- package/resources/actions.d.mts +0 -133
- package/resources/actions.d.mts.map +0 -1
- package/resources/actions.d.ts +0 -133
- package/resources/actions.d.ts.map +0 -1
- package/resources/actions.js +0 -36
- package/resources/actions.js.map +0 -1
- package/resources/actions.mjs +0 -32
- package/resources/actions.mjs.map +0 -1
- package/resources/index.d.mts +0 -4
- package/resources/index.d.mts.map +0 -1
- package/resources/index.d.ts +0 -4
- package/resources/index.d.ts.map +0 -1
- package/resources/index.js +0 -11
- package/resources/index.js.map +0 -1
- package/resources/index.mjs +0 -5
- package/resources/index.mjs.map +0 -1
- package/resources/sdk.d.mts +0 -261
- package/resources/sdk.d.mts.map +0 -1
- package/resources/sdk.d.ts +0 -261
- package/resources/sdk.d.ts.map +0 -1
- package/resources/sdk.js +0 -69
- package/resources/sdk.js.map +0 -1
- package/resources/sdk.mjs +0 -65
- package/resources/sdk.mjs.map +0 -1
- package/resources/verification.d.mts +0 -64
- package/resources/verification.d.mts.map +0 -1
- package/resources/verification.d.ts +0 -64
- package/resources/verification.d.ts.map +0 -1
- package/resources/verification.js +0 -25
- package/resources/verification.js.map +0 -1
- package/resources/verification.mjs +0 -21
- package/resources/verification.mjs.map +0 -1
- package/resources.d.mts +0 -2
- package/resources.d.mts.map +0 -1
- package/resources.d.ts +0 -2
- package/resources.d.ts.map +0 -1
- package/resources.js +0 -5
- package/resources.js.map +0 -1
- package/resources.mjs +0 -2
- package/resources.mjs.map +0 -1
- package/src/api-promise.ts +0 -2
- package/src/client.ts +0 -892
- package/src/core/README.md +0 -3
- package/src/core/api-promise.ts +0 -92
- package/src/core/error.ts +0 -130
- package/src/core/resource.ts +0 -11
- package/src/core/uploads.ts +0 -2
- package/src/error.ts +0 -2
- package/src/internal/README.md +0 -3
- package/src/internal/builtin-types.ts +0 -93
- package/src/internal/detect-platform.ts +0 -196
- package/src/internal/errors.ts +0 -33
- package/src/internal/headers.ts +0 -97
- package/src/internal/parse.ts +0 -56
- package/src/internal/request-options.ts +0 -91
- package/src/internal/shim-types.ts +0 -26
- package/src/internal/shims.ts +0 -107
- package/src/internal/to-file.ts +0 -154
- package/src/internal/types.ts +0 -93
- package/src/internal/uploads.ts +0 -187
- package/src/internal/utils/base64.ts +0 -40
- package/src/internal/utils/bytes.ts +0 -32
- package/src/internal/utils/env.ts +0 -18
- package/src/internal/utils/log.ts +0 -128
- package/src/internal/utils/path.ts +0 -88
- package/src/internal/utils/query.ts +0 -23
- package/src/internal/utils/sleep.ts +0 -3
- package/src/internal/utils/uuid.ts +0 -17
- package/src/internal/utils/values.ts +0 -105
- package/src/internal/utils.ts +0 -9
- package/src/lib/.keep +0 -4
- package/src/resource.ts +0 -2
- package/src/resources/actions.ts +0 -184
- package/src/resources/index.ts +0 -37
- package/src/resources/sdk.ts +0 -403
- package/src/resources/verification.ts +0 -107
- package/src/resources.ts +0 -1
- package/src/tsconfig.json +0 -11
- package/src/uploads.ts +0 -2
- package/src/version.ts +0 -1
- package/uploads.d.mts +0 -3
- package/uploads.d.mts.map +0 -1
- package/uploads.d.ts +0 -3
- package/uploads.d.ts.map +0 -1
- package/uploads.js +0 -6
- package/uploads.js.map +0 -1
- package/uploads.mjs +0 -3
- package/uploads.mjs.map +0 -1
- package/version.d.mts +0 -2
- package/version.d.mts.map +0 -1
- package/version.d.ts +0 -2
- package/version.d.ts.map +0 -1
- package/version.js +0 -5
- package/version.js.map +0 -1
- package/version.mjs +0 -2
- package/version.mjs.map +0 -1
package/FUNCTIONS.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# Standalone Functions
|
|
2
|
+
|
|
3
|
+
> [!NOTE]
|
|
4
|
+
> This section is useful if you are using a bundler and targeting browsers and
|
|
5
|
+
> runtimes where the size of an application affects performance and load times.
|
|
6
|
+
|
|
7
|
+
Every method in this SDK is also available as a standalone function. This
|
|
8
|
+
alternative API is suitable when targeting the browser or serverless runtimes
|
|
9
|
+
and using a bundler to build your application since all unused functionality
|
|
10
|
+
will be tree-shaken away. This includes code for unused methods, Zod schemas,
|
|
11
|
+
encoding helpers and response handlers. The result is dramatically smaller
|
|
12
|
+
impact on the application's final bundle size which grows very slowly as you use
|
|
13
|
+
more and more functionality from this SDK.
|
|
14
|
+
|
|
15
|
+
Calling methods through the main SDK class remains a valid and generally more
|
|
16
|
+
more ergonomic option. Standalone functions represent an optimisation for a
|
|
17
|
+
specific category of applications.
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { BotShieldCore } from "botshield-sdk/core.js";
|
|
23
|
+
import { censusCreateSession } from "botshield-sdk/funcs/census-create-session.js";
|
|
24
|
+
|
|
25
|
+
// Use `BotShieldCore` for best tree-shaking performance.
|
|
26
|
+
// You can create one instance of it to use across an application.
|
|
27
|
+
const botShield = new BotShieldCore();
|
|
28
|
+
|
|
29
|
+
async function run() {
|
|
30
|
+
const res = await censusCreateSession(botShield, {
|
|
31
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
32
|
+
}, {});
|
|
33
|
+
if (res.ok) {
|
|
34
|
+
const { value: result } = res;
|
|
35
|
+
console.log(result);
|
|
36
|
+
} else {
|
|
37
|
+
console.log("censusCreateSession failed:", res.error);
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
run();
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Result types
|
|
45
|
+
|
|
46
|
+
Standalone functions differ from SDK methods in that they return a
|
|
47
|
+
`Result<Value, Error>` type to capture _known errors_ and document them using
|
|
48
|
+
the type system. By avoiding throwing errors, application code maintains clear
|
|
49
|
+
control flow and error-handling become part of the regular flow of application
|
|
50
|
+
code.
|
|
51
|
+
|
|
52
|
+
> We use the term "known errors" because standalone functions, and JavaScript
|
|
53
|
+
> code in general, can still throw unexpected errors such as `TypeError`s,
|
|
54
|
+
> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
|
|
55
|
+
> something this SDK addresses in the future. Nevertheless, there is still a lot
|
|
56
|
+
> of benefit from capturing most errors and turning them into values.
|
|
57
|
+
|
|
58
|
+
The second reason for this style of programming is because these functions will
|
|
59
|
+
typically be used in front-end applications where exception throwing is
|
|
60
|
+
sometimes discouraged or considered unidiomatic. React and similar ecosystems
|
|
61
|
+
and libraries tend to promote this style of programming so that components
|
|
62
|
+
render useful content under all states (loading, success, error and so on).
|
|
63
|
+
|
|
64
|
+
The general pattern when calling standalone functions looks like this:
|
|
65
|
+
|
|
66
|
+
```typescript
|
|
67
|
+
import { Core } from "<sdk-package-name>";
|
|
68
|
+
import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
|
|
69
|
+
|
|
70
|
+
const client = new Core();
|
|
71
|
+
|
|
72
|
+
async function run() {
|
|
73
|
+
const result = await fetchSomething(client, { id: "123" });
|
|
74
|
+
if (!result.ok) {
|
|
75
|
+
// You can throw the error or handle it. It's your choice now.
|
|
76
|
+
throw result.error;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
console.log(result.value);
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
run();
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Notably, `result.error` above will have an explicit type compared to a try-catch
|
|
86
|
+
variation where the error in the catch block can only be of type `unknown` (or
|
|
87
|
+
`any` depending on your TypeScript settings).
|