@apifuse/provider-sdk 2.2.0-beta.5 → 2.2.0-beta.51
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/AUTHORING.md +537 -33
- package/CHANGELOG.md +205 -1
- package/README.md +83 -22
- package/SUBMISSION.md +2 -2
- package/bin/apifuse-check.ts +165 -11
- package/bin/apifuse-dev.ts +57 -13
- package/bin/apifuse-migrate-operation-declaration.ts +55 -0
- package/bin/apifuse-migrate-shape.ts +202 -0
- package/bin/apifuse-pack-check.ts +22 -2
- package/bin/apifuse-pack-smoke.ts +57 -2
- package/bin/apifuse-pack-types.ts +357 -38
- package/bin/apifuse-perf.ts +14 -13
- package/bin/apifuse-record.ts +709 -72
- package/bin/apifuse-submit-check.ts +2344 -324
- package/bin/apifuse-sync-assets.ts +117 -0
- package/bin/submit-check-delimited-text.ts +50 -0
- package/dist/auth-turn/index.d.ts +3 -3
- package/dist/auth-turn/index.js +1 -1
- package/dist/auth.d.ts +14 -0
- package/dist/auth.js +67 -0
- package/dist/ceremonies/index.d.ts +16 -0
- package/dist/ceremonies/index.js +141 -36
- package/dist/cli/commands.d.ts +1 -1
- package/dist/cli/commands.js +27 -0
- package/dist/cli/create.d.ts +4 -1
- package/dist/cli/create.js +42 -37
- package/dist/cli/migrate-operation-declaration.d.ts +59 -0
- package/dist/cli/migrate-operation-declaration.js +1249 -0
- package/dist/cli/migrate-operation-shape.d.ts +44 -0
- package/dist/cli/migrate-operation-shape.js +113 -0
- package/dist/cli/migrate-provider-shape.d.ts +52 -0
- package/dist/cli/migrate-provider-shape.js +578 -0
- package/dist/cli/prompt-assets.d.ts +80 -0
- package/dist/cli/prompt-assets.js +743 -0
- package/dist/cli/templates/provider/AGENTS.md.tpl +17 -8
- package/dist/cli/templates/provider/Dockerfile.tpl +1 -1
- package/dist/cli/templates/provider/README.md.tpl +5 -5
- package/dist/cli/templates/provider/index.ts.tpl +6 -3
- package/dist/cli/templates/provider/operations/ping.ts.tpl +4 -1
- package/dist/cli/templates/provider/provider.json.tpl +6 -0
- package/dist/config/loader.d.ts +179 -16
- package/dist/config/loader.js +435 -127
- package/dist/contract-serialization.js +4 -8
- package/dist/contract-types.d.ts +12 -5
- package/dist/contract.js +24 -10
- package/dist/declaration-validation.d.ts +33 -0
- package/dist/declaration-validation.js +266 -0
- package/dist/define.d.ts +66 -29
- package/dist/define.js +778 -69
- package/dist/dev.d.ts +3 -0
- package/dist/dev.js +1 -1
- package/dist/engine.d.ts +78 -0
- package/dist/engine.js +133 -0
- package/dist/error-observability.d.ts +7 -0
- package/dist/error-observability.js +61 -0
- package/dist/error-resolution.d.ts +4 -0
- package/dist/error-resolution.js +122 -0
- package/dist/errors.d.ts +33 -0
- package/dist/errors.js +40 -0
- package/dist/fixture-sanitization.d.ts +28 -0
- package/dist/fixture-sanitization.js +227 -0
- package/dist/health-scenario.d.ts +1842 -0
- package/dist/health-scenario.js +624 -0
- package/dist/index.d.ts +21 -10
- package/dist/index.js +12 -7
- package/dist/lint.d.ts +23 -11
- package/dist/lint.js +572 -69
- package/dist/native-address.d.ts +43 -0
- package/dist/native-address.js +281 -0
- package/dist/native-egress-policy.d.ts +31 -0
- package/dist/native-egress-policy.js +288 -0
- package/dist/observability.d.ts +5 -2
- package/dist/observability.js +48 -1
- package/dist/provider.d.ts +10 -2
- package/dist/provider.js +4 -1
- package/dist/runtime/auth-flow.d.ts +5 -1
- package/dist/runtime/auth-flow.js +6 -0
- package/dist/runtime/browser.d.ts +1 -0
- package/dist/runtime/browser.js +492 -49
- package/dist/runtime/cache.d.ts +1 -0
- package/dist/runtime/cache.js +169 -15
- package/dist/runtime/choice-wordlist.d.ts +9 -0
- package/dist/runtime/choice-wordlist.js +138 -0
- package/dist/runtime/choice.d.ts +13 -1
- package/dist/runtime/choice.js +490 -102
- package/dist/runtime/chrome149-header-order.d.ts +58 -0
- package/dist/runtime/chrome149-header-order.js +289 -0
- package/dist/runtime/env.js +12 -0
- package/dist/runtime/executor.d.ts +3 -2
- package/dist/runtime/executor.js +26 -25
- package/dist/runtime/http.d.ts +1 -0
- package/dist/runtime/http.js +515 -53
- package/dist/runtime/insights.js +2 -2
- package/dist/runtime/instrumentation.d.ts +2 -2
- package/dist/runtime/instrumentation.js +366 -8
- package/dist/runtime/native-network-errors.d.ts +33 -0
- package/dist/runtime/native-network-errors.js +69 -0
- package/dist/runtime/native-network.d.ts +96 -0
- package/dist/runtime/native-network.js +1232 -0
- package/dist/runtime/ocr.d.ts +29 -0
- package/dist/runtime/ocr.js +440 -0
- package/dist/runtime/otlp.d.ts +71 -2
- package/dist/runtime/otlp.js +397 -16
- package/dist/runtime/proxy-errors.js +6 -2
- package/dist/runtime/proxy-nodemaven.d.ts +56 -0
- package/dist/runtime/proxy-nodemaven.js +146 -0
- package/dist/runtime/proxy-telemetry.d.ts +80 -1
- package/dist/runtime/proxy-telemetry.js +154 -47
- package/dist/runtime/redirects.d.ts +29 -0
- package/dist/runtime/redirects.js +36 -0
- package/dist/runtime/redis.d.ts +1 -1
- package/dist/runtime/redis.js +4 -2
- package/dist/runtime/request-options.d.ts +68 -1
- package/dist/runtime/request-options.js +548 -0
- package/dist/runtime/resolver-config.d.ts +6 -0
- package/dist/runtime/resolver-config.js +6 -0
- package/dist/runtime/resolver-public.d.ts +1 -0
- package/dist/runtime/resolver-public.js +1 -0
- package/dist/runtime/resolver-shared.d.ts +14 -0
- package/dist/runtime/resolver-shared.js +12 -0
- package/dist/runtime/resolver-vendors/bindings.d.ts +48 -0
- package/dist/runtime/resolver-vendors/bindings.js +40 -0
- package/dist/runtime/resolver-vendors/browser.d.ts +22 -0
- package/dist/runtime/resolver-vendors/browser.js +377 -0
- package/dist/runtime/resolver-vendors/capsolver.d.ts +22 -0
- package/dist/runtime/resolver-vendors/capsolver.js +531 -0
- package/dist/runtime/resolver-vendors/hosts.d.ts +2 -0
- package/dist/runtime/resolver-vendors/hosts.js +33 -0
- package/dist/runtime/resolver-vendors/twocaptcha.d.ts +24 -0
- package/dist/runtime/resolver-vendors/twocaptcha.js +408 -0
- package/dist/runtime/resolver-vendors/types.d.ts +94 -0
- package/dist/runtime/resolver-vendors/types.js +96 -0
- package/dist/runtime/resolver.d.ts +72 -0
- package/dist/runtime/resolver.js +771 -0
- package/dist/runtime/secrets.d.ts +27 -0
- package/dist/runtime/secrets.js +51 -0
- package/dist/runtime/state.d.ts +3 -0
- package/dist/runtime/state.js +277 -71
- package/dist/runtime/stealth-cookies.d.ts +20 -0
- package/dist/runtime/stealth-cookies.js +111 -0
- package/dist/runtime/stealth.d.ts +41 -5
- package/dist/runtime/stealth.js +997 -291
- package/dist/runtime/stt.js +1 -12
- package/dist/runtime/timeout.d.ts +5 -0
- package/dist/runtime/timeout.js +12 -0
- package/dist/runtime/trace-config.d.ts +12 -0
- package/dist/runtime/trace-config.js +62 -0
- package/dist/runtime/trace.d.ts +5 -0
- package/dist/runtime/trace.js +43 -10
- package/dist/serve.d.ts +1 -1
- package/dist/serve.js +1 -1
- package/dist/server/error-observability.d.ts +1 -0
- package/dist/server/error-observability.js +1 -0
- package/dist/server/index.d.ts +5 -2
- package/dist/server/index.js +2 -2
- package/dist/server/self-test-input-tokens.d.ts +2 -1
- package/dist/server/self-test-input-tokens.js +18 -14
- package/dist/server/self-test.d.ts +14 -3
- package/dist/server/self-test.js +129 -58
- package/dist/server/serve-implementation.d.ts +230 -0
- package/dist/server/serve-implementation.js +2265 -0
- package/dist/server/serve.d.ts +1 -70
- package/dist/server/serve.js +1 -1131
- package/dist/server/trace-output.d.ts +6 -0
- package/dist/server/trace-output.js +79 -0
- package/dist/server/types.d.ts +30 -5
- package/dist/server/types.js +13 -1
- package/dist/stateful/errors.d.ts +19 -0
- package/dist/stateful/errors.js +24 -0
- package/dist/stateful/http-provider-event-emitter.d.ts +40 -0
- package/dist/stateful/http-provider-event-emitter.js +237 -0
- package/dist/stateful/http-session-owner-registry.d.ts +44 -0
- package/dist/stateful/http-session-owner-registry.js +210 -0
- package/dist/stateful/index.d.ts +18 -0
- package/dist/stateful/index.js +18 -0
- package/dist/stateful/provider-event-delivery-failures.d.ts +32 -0
- package/dist/stateful/provider-event-delivery-failures.js +43 -0
- package/dist/stateful/provider-event-pipeline-metrics.d.ts +46 -0
- package/dist/stateful/provider-event-pipeline-metrics.js +48 -0
- package/dist/stateful/provider-event-pipeline.d.ts +50 -0
- package/dist/stateful/provider-event-pipeline.js +1 -0
- package/dist/stateful/provider-events.d.ts +101 -0
- package/dist/stateful/provider-events.js +289 -0
- package/dist/stateful/session-key.d.ts +15 -0
- package/dist/stateful/session-key.js +86 -0
- package/dist/stateful/stateful-provider-adapter-context.d.ts +5 -0
- package/dist/stateful/stateful-provider-adapter-context.js +42 -0
- package/dist/stateful/stateful-provider-adapter-metrics.d.ts +15 -0
- package/dist/stateful/stateful-provider-adapter-metrics.js +21 -0
- package/dist/stateful/stateful-provider-adapter.d.ts +98 -0
- package/dist/stateful/stateful-provider-adapter.js +287 -0
- package/dist/stateful/stateful-provider-observability.d.ts +62 -0
- package/dist/stateful/stateful-provider-observability.js +161 -0
- package/dist/stateful/stateful-provider-owner-forwarder.d.ts +41 -0
- package/dist/stateful/stateful-provider-owner-forwarder.js +215 -0
- package/dist/stateful/stateful-provider-runtime-context.d.ts +32 -0
- package/dist/stateful/stateful-provider-runtime-context.js +60 -0
- package/dist/stateful/stateful-provider-runtime-executor.d.ts +34 -0
- package/dist/stateful/stateful-provider-runtime-executor.js +52 -0
- package/dist/stateful/stateful-provider-session-routing.d.ts +67 -0
- package/dist/stateful/stateful-provider-session-routing.js +345 -0
- package/dist/stateful/stateful-provider-session-runtime.d.ts +98 -0
- package/dist/stateful/stateful-provider-session-runtime.js +245 -0
- package/dist/stateful-signing.d.ts +18 -0
- package/dist/stateful-signing.js +27 -0
- package/dist/stealth/profiles.d.ts +9 -4
- package/dist/stealth/profiles.js +160 -211
- package/dist/stream-evidence.d.ts +74 -0
- package/dist/stream-evidence.js +785 -0
- package/dist/stream.js +7 -1
- package/dist/testing/index.d.ts +2 -1
- package/dist/testing/index.js +2 -1
- package/dist/testing/run.d.ts +32 -2
- package/dist/testing/run.js +489 -21
- package/dist/trace-sanitization.d.ts +5 -0
- package/dist/trace-sanitization.js +45 -0
- package/dist/types.d.ts +673 -131
- package/dist/types.js +1 -0
- package/package.json +45 -5
- package/src/auth-turn/index.ts +1 -1
- package/src/auth.ts +118 -0
- package/src/ceremonies/index.ts +189 -46
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/approval-override.ts.txt +6 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/codemod-syntax.ts.txt +3 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/connection-precedence.ts.txt +10 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/docs-conflict.ts.txt +8 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/examples-hoisted-array-spread.ts.txt +15 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/examples-imported-array-spread.ts.txt +9 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/examples-map.ts.txt +5 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/examples-mixed-array-spread.ts.txt +24 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/examples-operation.ts.txt +16 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/factory-map.ts.txt +3 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/hoist-all.ts.txt +31 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/hoisted-const.ts.txt +11 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/imported-spread.ts.txt +11 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/inline-map.ts.txt +11 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/inline-spread-cast-tail.ts.txt +21 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/inline-spread-ekitan.ts.txt +11 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/inline-spread-override.ts.txt +14 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/missing-english-locale.ts.txt +7 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/no-safety.ts.txt +6 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/non-literal.ts.txt +7 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/redundant-approval.ts.txt +6 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/safety-conflict.ts.txt +7 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/stream.ts.txt +7 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/tool-router-spread.ts.txt +15 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/unparseable.ts.txt +4 -0
- package/src/cli/__tests__/fixtures/migrate-operation-declaration/verbatim-template.ts.txt +12 -0
- package/src/cli/commands.ts +33 -0
- package/src/cli/create.ts +50 -37
- package/src/cli/migrate-operation-declaration.ts +1751 -0
- package/src/cli/migrate-operation-shape.ts +184 -0
- package/src/cli/migrate-provider-shape.ts +772 -0
- package/src/cli/prompt-assets.ts +865 -0
- package/src/cli/templates/provider/AGENTS.md.tpl +17 -8
- package/src/cli/templates/provider/Dockerfile.tpl +1 -1
- package/src/cli/templates/provider/README.md.tpl +5 -5
- package/src/cli/templates/provider/index.ts.tpl +6 -3
- package/src/cli/templates/provider/operations/ping.ts.tpl +4 -1
- package/src/cli/templates/provider/provider.json.tpl +6 -0
- package/src/config/loader.ts +690 -163
- package/src/contract-serialization.ts +5 -7
- package/src/contract-types.ts +12 -5
- package/src/contract.ts +24 -10
- package/src/declaration-validation.ts +330 -0
- package/src/define.ts +1048 -131
- package/src/dev.ts +4 -1
- package/src/engine.ts +279 -0
- package/src/error-observability.ts +64 -0
- package/src/error-resolution.ts +127 -0
- package/src/errors.ts +68 -0
- package/src/fixture-sanitization.ts +264 -0
- package/src/health-scenario.ts +875 -0
- package/src/index.ts +220 -13
- package/src/lint.ts +698 -90
- package/src/native-address.ts +340 -0
- package/src/native-egress-policy.ts +358 -0
- package/src/observability.ts +51 -1
- package/src/provider.ts +161 -3
- package/src/runtime/auth-flow.ts +12 -0
- package/src/runtime/browser.ts +661 -63
- package/src/runtime/cache.ts +189 -14
- package/src/runtime/choice-wordlist.ts +145 -0
- package/src/runtime/choice.ts +631 -120
- package/src/runtime/chrome149-header-order.ts +330 -0
- package/src/runtime/env.ts +13 -0
- package/src/runtime/executor.ts +43 -31
- package/src/runtime/http.ts +641 -61
- package/src/runtime/insights.ts +2 -2
- package/src/runtime/instrumentation.ts +520 -15
- package/src/runtime/native-network-errors.ts +99 -0
- package/src/runtime/native-network.ts +1605 -0
- package/src/runtime/ocr.ts +523 -0
- package/src/runtime/otlp.ts +467 -21
- package/src/runtime/proxy-errors.ts +12 -4
- package/src/runtime/proxy-nodemaven.ts +221 -0
- package/src/runtime/proxy-telemetry.ts +244 -75
- package/src/runtime/redirects.ts +66 -0
- package/src/runtime/redis.ts +7 -2
- package/src/runtime/request-options.ts +680 -1
- package/src/runtime/resolver-config.ts +6 -0
- package/src/runtime/resolver-public.ts +23 -0
- package/src/runtime/resolver-shared.ts +33 -0
- package/src/runtime/resolver-vendors/bindings.ts +56 -0
- package/src/runtime/resolver-vendors/browser.ts +533 -0
- package/src/runtime/resolver-vendors/capsolver.ts +707 -0
- package/src/runtime/resolver-vendors/hosts.ts +38 -0
- package/src/runtime/resolver-vendors/twocaptcha.ts +540 -0
- package/src/runtime/resolver-vendors/types.ts +212 -0
- package/src/runtime/resolver.ts +1157 -0
- package/src/runtime/secrets.ts +64 -0
- package/src/runtime/state.ts +394 -77
- package/src/runtime/stealth-cookies.ts +132 -0
- package/src/runtime/stealth.ts +1280 -336
- package/src/runtime/stt.ts +1 -19
- package/src/runtime/timeout.ts +18 -0
- package/src/runtime/trace-config.ts +78 -0
- package/src/runtime/trace.ts +57 -17
- package/src/serve.ts +6 -1
- package/src/server/error-observability.ts +1 -0
- package/src/server/index.ts +34 -2
- package/src/server/self-test-input-tokens.ts +29 -14
- package/src/server/self-test.ts +191 -68
- package/src/server/serve-implementation.ts +3378 -0
- package/src/server/serve.ts +1 -1632
- package/src/server/trace-output.ts +129 -0
- package/src/server/types.ts +13 -1
- package/src/stateful/README.md +146 -0
- package/src/stateful/errors.ts +35 -0
- package/src/stateful/http-provider-event-emitter.ts +314 -0
- package/src/stateful/http-session-owner-registry.ts +306 -0
- package/src/stateful/index.ts +18 -0
- package/src/stateful/provider-event-delivery-failures.ts +80 -0
- package/src/stateful/provider-event-pipeline-metrics.ts +95 -0
- package/src/stateful/provider-event-pipeline.ts +61 -0
- package/src/stateful/provider-events.ts +462 -0
- package/src/stateful/session-key.ts +111 -0
- package/src/stateful/stateful-provider-adapter-context.ts +59 -0
- package/src/stateful/stateful-provider-adapter-metrics.ts +48 -0
- package/src/stateful/stateful-provider-adapter.ts +562 -0
- package/src/stateful/stateful-provider-observability.ts +261 -0
- package/src/stateful/stateful-provider-owner-forwarder.ts +287 -0
- package/src/stateful/stateful-provider-runtime-context.ts +92 -0
- package/src/stateful/stateful-provider-runtime-executor.ts +96 -0
- package/src/stateful/stateful-provider-session-routing.ts +546 -0
- package/src/stateful/stateful-provider-session-runtime.ts +403 -0
- package/src/stateful-signing.ts +46 -0
- package/src/stealth/profiles.ts +202 -231
- package/src/stream-evidence.ts +988 -0
- package/src/stream.ts +8 -1
- package/src/testing/index.ts +10 -1
- package/src/testing/run.ts +658 -15
- package/src/trace-sanitization.ts +63 -0
- package/src/types.ts +788 -174
- package/dist/cli/templates/provider/CLAUDE.md.tpl +0 -1
- package/src/cli/templates/provider/CLAUDE.md.tpl +0 -1
- /package/dist/cli/templates/provider/{skills → .agents/skills}/fixtures-and-recording/SKILL.md.tpl +0 -0
- /package/dist/cli/templates/provider/{skills → .agents/skills}/health-checks-and-fail-closed/SKILL.md.tpl +0 -0
- /package/dist/cli/templates/provider/{skills → .agents/skills}/normalization-standards/SKILL.md.tpl +0 -0
- /package/dist/cli/templates/provider/{skills → .agents/skills}/pagination-and-counts/SKILL.md.tpl +0 -0
- /package/dist/cli/templates/provider/{skills → .agents/skills}/upstream-contract-verification/SKILL.md.tpl +0 -0
- /package/dist/cli/templates/provider/{skills → .agents/skills}/upstream-notes/README.md.tpl +0 -0
- /package/src/cli/templates/provider/{skills → .agents/skills}/fixtures-and-recording/SKILL.md.tpl +0 -0
- /package/src/cli/templates/provider/{skills → .agents/skills}/health-checks-and-fail-closed/SKILL.md.tpl +0 -0
- /package/src/cli/templates/provider/{skills → .agents/skills}/normalization-standards/SKILL.md.tpl +0 -0
- /package/src/cli/templates/provider/{skills → .agents/skills}/pagination-and-counts/SKILL.md.tpl +0 -0
- /package/src/cli/templates/provider/{skills → .agents/skills}/upstream-contract-verification/SKILL.md.tpl +0 -0
- /package/src/cli/templates/provider/{skills → .agents/skills}/upstream-notes/README.md.tpl +0 -0
package/dist/dev.d.ts
CHANGED
|
@@ -1,7 +1,10 @@
|
|
|
1
|
+
import type { ProviderEngine } from "./engine.js";
|
|
1
2
|
import type { ProviderDefinition } from "./types.js";
|
|
2
3
|
export interface DevServerOptions {
|
|
3
4
|
port?: number;
|
|
4
5
|
sessionDbPath?: string;
|
|
6
|
+
/** Override the default in-process engine attachment. */
|
|
7
|
+
engine?: ProviderEngine;
|
|
5
8
|
}
|
|
6
9
|
export declare function createDevServer(provider: ProviderDefinition, options?: DevServerOptions): {
|
|
7
10
|
start: () => void;
|
package/dist/dev.js
CHANGED
|
@@ -3,7 +3,7 @@ export function createDevServer(provider, options) {
|
|
|
3
3
|
const port = options?.port ?? 3900;
|
|
4
4
|
return {
|
|
5
5
|
start: () => {
|
|
6
|
-
void serve(provider, { port });
|
|
6
|
+
void serve(provider, { port, engine: options?.engine });
|
|
7
7
|
console.log(`[apifuse dev] ${provider.id}@${provider.version} running at http://localhost:${port}`);
|
|
8
8
|
console.log(`[apifuse dev] Operations: ${Object.keys(provider.operations).join(", ")}`);
|
|
9
9
|
console.log(`[apifuse dev] Health: http://localhost:${port}/health`);
|
package/dist/engine.d.ts
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import type { AuthContext, BrowserClient, CredentialContext, EnvContext, HttpClient, NativeContext, OcrContext, ProviderCache, ProviderChoiceContext, ProviderContext, ProviderDefinition, ProviderFilesContext, ProviderRequestContext, ProviderRuntimeState, ResolverContext, StealthClient, SttContext, TraceContext } from "./types.js";
|
|
2
|
+
/** Versioned envelope protocol used by out-of-process engine transports. */
|
|
3
|
+
export declare const PROVIDER_ENGINE_PROTOCOL_VERSION: "provider-engine.v1";
|
|
4
|
+
/** Credential names owned by the engine and forbidden in provider declarations. */
|
|
5
|
+
export declare const ENGINE_OWNED_PROXY_CREDENTIAL_ENV_NAMES: readonly ["APIFUSE__PROXY__SMARTPROXY_APP_KEY", "APIFUSE__PROXY__NODEMAVEN_USERNAME", "APIFUSE__PROXY__NODEMAVEN_PASSWORD"];
|
|
6
|
+
export declare function isEngineOwnedProxyCredentialName(name: string): boolean;
|
|
7
|
+
/**
|
|
8
|
+
* Trace-export configuration owned by the engine and forbidden in provider
|
|
9
|
+
* declarations. The header variables carry collector credentials; the rest are
|
|
10
|
+
* engine deployment settings a provider has no reason to read.
|
|
11
|
+
*/
|
|
12
|
+
export declare const ENGINE_OWNED_TELEMETRY_ENV_NAMES: readonly ["OTEL_EXPORTER_OTLP_TRACES_ENDPOINT", "OTEL_EXPORTER_OTLP_ENDPOINT", "OTEL_EXPORTER_OTLP_TRACES_HEADERS", "OTEL_EXPORTER_OTLP_HEADERS", "OTEL_SERVICE_NAME", "OTEL_RESOURCE_ATTRIBUTES"];
|
|
13
|
+
export declare function isEngineOwnedTelemetryEnvName(name: string): boolean;
|
|
14
|
+
/** Every environment name the engine owns: rejected in declarations and filtered from provider projections. */
|
|
15
|
+
export declare function isEngineOwnedEnvName(name: string): boolean;
|
|
16
|
+
/** Capture credentials in the engine host before constructing provider bindings. */
|
|
17
|
+
export declare function readEngineProxyCredentials(environment?: Readonly<Record<string, string | undefined>>): Readonly<Record<string, string>>;
|
|
18
|
+
/** Build the exact environment projection permitted to enter a provider runtime. */
|
|
19
|
+
export declare function createProviderEnvironment(environment: Readonly<Record<string, string | undefined>>, declaredNames: readonly string[]): Readonly<Record<string, string>>;
|
|
20
|
+
/**
|
|
21
|
+
* Request/response is the first remote transport lane. Stream and session
|
|
22
|
+
* handles are separate lanes so lifecycle-bearing capabilities are never
|
|
23
|
+
* disguised as ordinary JSON calls.
|
|
24
|
+
*/
|
|
25
|
+
export interface ProviderEngineTransport {
|
|
26
|
+
request<TResponse = unknown>(request: ProviderEngineRequest): Promise<TResponse>;
|
|
27
|
+
openStream?(request: ProviderEngineRequest): Promise<ReadableStream<Uint8Array>>;
|
|
28
|
+
openSession?(request: ProviderEngineRequest): Promise<ProviderEngineSession>;
|
|
29
|
+
}
|
|
30
|
+
export interface ProviderEngineRequest {
|
|
31
|
+
readonly version: typeof PROVIDER_ENGINE_PROTOCOL_VERSION;
|
|
32
|
+
readonly providerId: string;
|
|
33
|
+
readonly requestId: string;
|
|
34
|
+
readonly capability: ProviderCapabilityKey;
|
|
35
|
+
readonly method: string;
|
|
36
|
+
readonly payload: unknown;
|
|
37
|
+
}
|
|
38
|
+
export interface ProviderEngineSession {
|
|
39
|
+
request<TResponse = unknown>(method: string, payload: unknown): Promise<TResponse>;
|
|
40
|
+
close(): Promise<void>;
|
|
41
|
+
}
|
|
42
|
+
/** Capability implementations owned by the engine rather than provider code. */
|
|
43
|
+
export interface ProviderEngineCapabilitySurface {
|
|
44
|
+
readonly http: HttpClient;
|
|
45
|
+
readonly browser: BrowserClient;
|
|
46
|
+
readonly stealth: StealthClient;
|
|
47
|
+
readonly stt: SttContext;
|
|
48
|
+
readonly ocr: OcrContext;
|
|
49
|
+
readonly resolver: ResolverContext;
|
|
50
|
+
readonly cache: ProviderCache;
|
|
51
|
+
readonly state: ProviderRuntimeState;
|
|
52
|
+
}
|
|
53
|
+
/** Engine-resident-only capabilities, kept separate from the portable surface. */
|
|
54
|
+
export interface ProviderEngineResidentSurface {
|
|
55
|
+
readonly native: NativeContext;
|
|
56
|
+
}
|
|
57
|
+
export declare const PROVIDER_CAPABILITY_KEYS: readonly ["env", "credential", "http", "files", "native", "cache", "state", "stealth", "browser", "auth", "ocr", "stt", "resolver", "choice"];
|
|
58
|
+
export type ProviderCapabilityKey = (typeof PROVIDER_CAPABILITY_KEYS)[number];
|
|
59
|
+
export type ProviderEngineBindingCandidates = Partial<ProviderEngineCapabilitySurface & ProviderEngineResidentSurface & {
|
|
60
|
+
readonly env: EnvContext;
|
|
61
|
+
readonly credential: CredentialContext;
|
|
62
|
+
readonly files: ProviderFilesContext;
|
|
63
|
+
readonly auth: AuthContext;
|
|
64
|
+
readonly choice: ProviderChoiceContext;
|
|
65
|
+
}> & {
|
|
66
|
+
readonly request?: ProviderRequestContext;
|
|
67
|
+
readonly trace: TraceContext;
|
|
68
|
+
};
|
|
69
|
+
export interface ProviderEngineAttachmentInput {
|
|
70
|
+
readonly provider: ProviderDefinition;
|
|
71
|
+
readonly bindings: ProviderEngineBindingCandidates;
|
|
72
|
+
}
|
|
73
|
+
/** Attachment boundary shared by in-process development and remote RPC bridges. */
|
|
74
|
+
export interface ProviderEngine {
|
|
75
|
+
attach<TDeclaration extends object = Record<string, unknown>>(input: ProviderEngineAttachmentInput): ProviderContext<TDeclaration>;
|
|
76
|
+
}
|
|
77
|
+
/** Local engine attachment; deployed bridges implement the same interface with RPC clients. */
|
|
78
|
+
export declare function createInProcessProviderEngine(): ProviderEngine;
|
package/dist/engine.js
ADDED
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
import { ProviderError } from "./errors.js";
|
|
2
|
+
import { OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_TRACES_ENDPOINT, OTEL_EXPORTER_OTLP_TRACES_HEADERS, OTEL_RESOURCE_ATTRIBUTES, OTEL_SERVICE_NAME, } from "./runtime/otlp.js";
|
|
3
|
+
/** Versioned envelope protocol used by out-of-process engine transports. */
|
|
4
|
+
export const PROVIDER_ENGINE_PROTOCOL_VERSION = "provider-engine.v1";
|
|
5
|
+
/** Credential names owned by the engine and forbidden in provider declarations. */
|
|
6
|
+
export const ENGINE_OWNED_PROXY_CREDENTIAL_ENV_NAMES = [
|
|
7
|
+
"APIFUSE__PROXY__SMARTPROXY_APP_KEY",
|
|
8
|
+
"APIFUSE__PROXY__NODEMAVEN_USERNAME",
|
|
9
|
+
"APIFUSE__PROXY__NODEMAVEN_PASSWORD",
|
|
10
|
+
];
|
|
11
|
+
const ENGINE_OWNED_PROXY_CREDENTIAL_ENV_NAME_SET = new Set(ENGINE_OWNED_PROXY_CREDENTIAL_ENV_NAMES);
|
|
12
|
+
/**
|
|
13
|
+
* Environment names are compared case-insensitively: Windows resolves `otel_exporter_otlp_headers`
|
|
14
|
+
* to the same variable as `OTEL_EXPORTER_OTLP_HEADERS`, so a mixed-case alias must be treated as
|
|
15
|
+
* the engine-owned name it resolves to.
|
|
16
|
+
*/
|
|
17
|
+
function canonicalEnvName(name) {
|
|
18
|
+
return name.toUpperCase();
|
|
19
|
+
}
|
|
20
|
+
export function isEngineOwnedProxyCredentialName(name) {
|
|
21
|
+
return ENGINE_OWNED_PROXY_CREDENTIAL_ENV_NAME_SET.has(canonicalEnvName(name));
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Trace-export configuration owned by the engine and forbidden in provider
|
|
25
|
+
* declarations. The header variables carry collector credentials; the rest are
|
|
26
|
+
* engine deployment settings a provider has no reason to read.
|
|
27
|
+
*/
|
|
28
|
+
export const ENGINE_OWNED_TELEMETRY_ENV_NAMES = [
|
|
29
|
+
OTEL_EXPORTER_OTLP_TRACES_ENDPOINT,
|
|
30
|
+
OTEL_EXPORTER_OTLP_ENDPOINT,
|
|
31
|
+
OTEL_EXPORTER_OTLP_TRACES_HEADERS,
|
|
32
|
+
OTEL_EXPORTER_OTLP_HEADERS,
|
|
33
|
+
OTEL_SERVICE_NAME,
|
|
34
|
+
OTEL_RESOURCE_ATTRIBUTES,
|
|
35
|
+
];
|
|
36
|
+
const ENGINE_OWNED_TELEMETRY_ENV_NAME_SET = new Set(ENGINE_OWNED_TELEMETRY_ENV_NAMES);
|
|
37
|
+
export function isEngineOwnedTelemetryEnvName(name) {
|
|
38
|
+
return ENGINE_OWNED_TELEMETRY_ENV_NAME_SET.has(canonicalEnvName(name));
|
|
39
|
+
}
|
|
40
|
+
/** Every environment name the engine owns: rejected in declarations and filtered from provider projections. */
|
|
41
|
+
export function isEngineOwnedEnvName(name) {
|
|
42
|
+
return isEngineOwnedProxyCredentialName(name) || isEngineOwnedTelemetryEnvName(name);
|
|
43
|
+
}
|
|
44
|
+
/** Capture credentials in the engine host before constructing provider bindings. */
|
|
45
|
+
export function readEngineProxyCredentials(environment = process.env) {
|
|
46
|
+
return Object.fromEntries(ENGINE_OWNED_PROXY_CREDENTIAL_ENV_NAMES.flatMap((name) => {
|
|
47
|
+
const value = environment[name]?.trim();
|
|
48
|
+
return value ? [[name, value]] : [];
|
|
49
|
+
}));
|
|
50
|
+
}
|
|
51
|
+
/** Build the exact environment projection permitted to enter a provider runtime. */
|
|
52
|
+
export function createProviderEnvironment(environment, declaredNames) {
|
|
53
|
+
return Object.fromEntries(declaredNames.flatMap((name) => {
|
|
54
|
+
if (isEngineOwnedEnvName(name))
|
|
55
|
+
return [];
|
|
56
|
+
const value = environment[name];
|
|
57
|
+
return value === undefined ? [] : [[name, value]];
|
|
58
|
+
}));
|
|
59
|
+
}
|
|
60
|
+
export const PROVIDER_CAPABILITY_KEYS = [
|
|
61
|
+
"env",
|
|
62
|
+
"credential",
|
|
63
|
+
"http",
|
|
64
|
+
"files",
|
|
65
|
+
"native",
|
|
66
|
+
"cache",
|
|
67
|
+
"state",
|
|
68
|
+
"stealth",
|
|
69
|
+
"browser",
|
|
70
|
+
"auth",
|
|
71
|
+
"ocr",
|
|
72
|
+
"stt",
|
|
73
|
+
"resolver",
|
|
74
|
+
"choice",
|
|
75
|
+
];
|
|
76
|
+
const CAPABILITY_KEY_SET = new Set(PROVIDER_CAPABILITY_KEYS);
|
|
77
|
+
function declaresCapability(provider, capability) {
|
|
78
|
+
return Object.hasOwn(provider, capability) && provider[capability] !== undefined;
|
|
79
|
+
}
|
|
80
|
+
function attachmentError(provider, capability) {
|
|
81
|
+
return new ProviderError(`Provider engine could not attach declared capability "${capability}" for provider "${provider.id}"`, {
|
|
82
|
+
code: "PROVIDER_ENGINE_ATTACHMENT_FAILED",
|
|
83
|
+
details: { providerId: provider.id, capability },
|
|
84
|
+
fix: `Configure the engine binding for "${capability}" before starting the provider.`,
|
|
85
|
+
});
|
|
86
|
+
}
|
|
87
|
+
function undeclaredCapabilityError(provider, capability) {
|
|
88
|
+
return new ProviderError(`Provider "${provider.id}" accessed undeclared capability "${capability}"; add the "${capability}" declaration`, {
|
|
89
|
+
code: "PROVIDER_CAPABILITY_UNDECLARED",
|
|
90
|
+
details: { providerId: provider.id, capability },
|
|
91
|
+
fix: `Add ${capability}: {} to the provider declaration, or remove the access.`,
|
|
92
|
+
});
|
|
93
|
+
}
|
|
94
|
+
function attachInProcess(input) {
|
|
95
|
+
const { provider, bindings } = input;
|
|
96
|
+
if (provider.runtimeTarget === "vanilla" && declaresCapability(provider, "native")) {
|
|
97
|
+
throw new ProviderError(`Provider "${provider.id}" cannot attach capability "native" to runtime target "vanilla"; native requires an engine-resident runtime`, {
|
|
98
|
+
code: "PROVIDER_RUNTIME_CAPABILITY_CONFLICT",
|
|
99
|
+
details: { providerId: provider.id, capability: "native", runtimeTarget: "vanilla" },
|
|
100
|
+
});
|
|
101
|
+
}
|
|
102
|
+
const context = { trace: bindings.trace };
|
|
103
|
+
if (bindings.request !== undefined)
|
|
104
|
+
context.request = bindings.request;
|
|
105
|
+
for (const capability of PROVIDER_CAPABILITY_KEYS) {
|
|
106
|
+
if (!declaresCapability(provider, capability))
|
|
107
|
+
continue;
|
|
108
|
+
const binding = bindings[capability];
|
|
109
|
+
if (binding === undefined || binding === null)
|
|
110
|
+
throw attachmentError(provider, capability);
|
|
111
|
+
context[capability] = binding;
|
|
112
|
+
}
|
|
113
|
+
return new Proxy(context, {
|
|
114
|
+
get(target, property, receiver) {
|
|
115
|
+
if (typeof property === "string" &&
|
|
116
|
+
CAPABILITY_KEY_SET.has(property) &&
|
|
117
|
+
!declaresCapability(provider, property)) {
|
|
118
|
+
throw undeclaredCapabilityError(provider, property);
|
|
119
|
+
}
|
|
120
|
+
return Reflect.get(target, property, receiver);
|
|
121
|
+
},
|
|
122
|
+
has(target, property) {
|
|
123
|
+
if (typeof property === "string" && CAPABILITY_KEY_SET.has(property)) {
|
|
124
|
+
return declaresCapability(provider, property);
|
|
125
|
+
}
|
|
126
|
+
return Reflect.has(target, property);
|
|
127
|
+
},
|
|
128
|
+
});
|
|
129
|
+
}
|
|
130
|
+
/** Local engine attachment; deployed bridges implement the same interface with RPC clients. */
|
|
131
|
+
export function createInProcessProviderEngine() {
|
|
132
|
+
return { attach: attachInProcess };
|
|
133
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { type ProviderErrorObservability } from "./errors.js";
|
|
2
|
+
/**
|
|
3
|
+
* Extracts only own data properties from branded provider errors. In
|
|
4
|
+
* particular, descriptor reads reject options/observability accessors without
|
|
5
|
+
* invoking provider-controlled getters.
|
|
6
|
+
*/
|
|
7
|
+
export declare function safeProviderErrorObservability(error: unknown): ProviderErrorObservability | undefined;
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import { isProviderError } from "./errors.js";
|
|
2
|
+
const PROVIDER_OBSERVABILITY_TOKEN_PATTERN = /^[A-Za-z0-9_.-]{1,64}$/;
|
|
3
|
+
const PROVIDER_OBSERVABILITY_FINGERPRINT_PATTERN = /^[A-Fa-f0-9]{12}$/;
|
|
4
|
+
const MAX_PROVIDER_OBSERVABILITY_MESSAGE_LENGTH = 10_000_000;
|
|
5
|
+
/**
|
|
6
|
+
* Extracts only own data properties from branded provider errors. In
|
|
7
|
+
* particular, descriptor reads reject options/observability accessors without
|
|
8
|
+
* invoking provider-controlled getters.
|
|
9
|
+
*/
|
|
10
|
+
export function safeProviderErrorObservability(error) {
|
|
11
|
+
if (!isProviderError(error))
|
|
12
|
+
return undefined;
|
|
13
|
+
let candidate;
|
|
14
|
+
let reason;
|
|
15
|
+
let fingerprint;
|
|
16
|
+
let messageLength;
|
|
17
|
+
try {
|
|
18
|
+
const optionsDescriptor = Object.getOwnPropertyDescriptor(error, "options");
|
|
19
|
+
if (optionsDescriptor === undefined || !Object.hasOwn(optionsDescriptor, "value")) {
|
|
20
|
+
return undefined;
|
|
21
|
+
}
|
|
22
|
+
const options = optionsDescriptor.value;
|
|
23
|
+
if (options === null || typeof options !== "object" || Array.isArray(options)) {
|
|
24
|
+
return undefined;
|
|
25
|
+
}
|
|
26
|
+
const observabilityDescriptor = Object.getOwnPropertyDescriptor(options, "observability");
|
|
27
|
+
if (observabilityDescriptor === undefined || !Object.hasOwn(observabilityDescriptor, "value")) {
|
|
28
|
+
return undefined;
|
|
29
|
+
}
|
|
30
|
+
candidate = observabilityDescriptor.value;
|
|
31
|
+
if (candidate === null || typeof candidate !== "object" || Array.isArray(candidate)) {
|
|
32
|
+
return undefined;
|
|
33
|
+
}
|
|
34
|
+
const ownValue = (key) => {
|
|
35
|
+
const descriptor = Object.getOwnPropertyDescriptor(candidate, key);
|
|
36
|
+
return descriptor && Object.hasOwn(descriptor, "value") ? descriptor.value : undefined;
|
|
37
|
+
};
|
|
38
|
+
reason = ownValue("reason");
|
|
39
|
+
fingerprint = ownValue("fingerprint");
|
|
40
|
+
messageLength = ownValue("messageLength");
|
|
41
|
+
}
|
|
42
|
+
catch {
|
|
43
|
+
return undefined;
|
|
44
|
+
}
|
|
45
|
+
const safe = {
|
|
46
|
+
...(typeof reason === "string" && PROVIDER_OBSERVABILITY_TOKEN_PATTERN.test(reason)
|
|
47
|
+
? { reason }
|
|
48
|
+
: {}),
|
|
49
|
+
...(typeof fingerprint === "string" &&
|
|
50
|
+
PROVIDER_OBSERVABILITY_FINGERPRINT_PATTERN.test(fingerprint)
|
|
51
|
+
? { fingerprint }
|
|
52
|
+
: {}),
|
|
53
|
+
...(typeof messageLength === "number" &&
|
|
54
|
+
Number.isInteger(messageLength) &&
|
|
55
|
+
messageLength >= 0 &&
|
|
56
|
+
messageLength <= MAX_PROVIDER_OBSERVABILITY_MESSAGE_LENGTH
|
|
57
|
+
? { messageLength }
|
|
58
|
+
: {}),
|
|
59
|
+
};
|
|
60
|
+
return Object.keys(safe).length > 0 ? safe : undefined;
|
|
61
|
+
}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { ProviderErrorStatus } from "./types.js";
|
|
2
|
+
export declare const SDK_OWNED_PROVIDER_ERROR_CODES: Set<string>;
|
|
3
|
+
export declare const SDK_RUNTIME_OWNED_ERROR_CODES: Set<string>;
|
|
4
|
+
export declare const SDK_STATUS_MAPPED_PROVIDER_ERROR_CODES: ReadonlyMap<string, ProviderErrorStatus>;
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
// This set suppresses the unregistered-provider-error-code signal for codes
|
|
2
|
+
// intentionally emitted by SDK paths. It is not the complete authority for
|
|
3
|
+
// runtime error resolution: branded errors and additional canonical SDK codes
|
|
4
|
+
// must also remain immune to provider-declared status/retryability overrides.
|
|
5
|
+
export const SDK_OWNED_PROVIDER_ERROR_CODES = new Set([
|
|
6
|
+
"MISSING_SECRET",
|
|
7
|
+
"AUTH_PROMPT_UNAVAILABLE",
|
|
8
|
+
"BROWSER_CDP_POOL_REQUIRED",
|
|
9
|
+
"BROWSER_RUNTIME_UNSUPPORTED",
|
|
10
|
+
"STEALTH_RUNTIME_UNSUPPORTED",
|
|
11
|
+
"SSE_EVENT_UNDECLARED",
|
|
12
|
+
"STREAM_EVENT_TOO_LARGE",
|
|
13
|
+
"STREAM_CHUNK_TOO_LARGE",
|
|
14
|
+
"SSE_RESULT_UNSUPPORTED",
|
|
15
|
+
"STREAM_RESULT_UNSUPPORTED",
|
|
16
|
+
"AUTH_FLOW_NOT_CONFIGURED",
|
|
17
|
+
"refresh_not_supported",
|
|
18
|
+
"RUNTIME_UNSUPPORTED",
|
|
19
|
+
"PROVIDER_STATE_UNSUPPORTED",
|
|
20
|
+
"CHOICE_TOKEN_MASTER_SECRET_NOT_CONFIGURED",
|
|
21
|
+
"CHOICE_STATE_PAYLOAD_TOO_LARGE",
|
|
22
|
+
"CHOICE_STATE_UNAVAILABLE",
|
|
23
|
+
"CHOICE_CONTEXT_REQUIRED",
|
|
24
|
+
"unsupported_stealth_cookie_store_version",
|
|
25
|
+
"provider_secret_error",
|
|
26
|
+
"credential_key_error",
|
|
27
|
+
"credential_mode_error",
|
|
28
|
+
"flow_expired",
|
|
29
|
+
"turn_validation_error",
|
|
30
|
+
"context_access_error",
|
|
31
|
+
"OCR_UPSTREAM_FAILED",
|
|
32
|
+
"UNSUPPORTED_STT_OPTION",
|
|
33
|
+
"INVALID_STT_AUDIO",
|
|
34
|
+
"STT_AUDIO_TOO_LARGE",
|
|
35
|
+
"STT_UPSTREAM_FAILED",
|
|
36
|
+
"INVALID_STT_VERIFICATION_CODE_OPTIONS",
|
|
37
|
+
"NO_CODE_FOUND",
|
|
38
|
+
"AMBIGUOUS_CODE",
|
|
39
|
+
"retry_invalid_policy",
|
|
40
|
+
"retry_unsafe_method",
|
|
41
|
+
"stealth_cookie_store_serialize_failed",
|
|
42
|
+
"response_too_large",
|
|
43
|
+
"transport_stream_unavailable",
|
|
44
|
+
"transport_invalid_method",
|
|
45
|
+
"http_transport_override_unsupported",
|
|
46
|
+
"http_redirect_policy_invalid",
|
|
47
|
+
"http_redirect_stopped",
|
|
48
|
+
"http_redirect_max_hops",
|
|
49
|
+
"http_redirect_missing_location",
|
|
50
|
+
"http_redirect_loop",
|
|
51
|
+
"transport_invalid_url",
|
|
52
|
+
"retry_exhausted",
|
|
53
|
+
"auth_abort_unsafe_data",
|
|
54
|
+
"credentials_auth_missing_credential_keys",
|
|
55
|
+
"credentials_auth_missing_credential",
|
|
56
|
+
"credentials_auth_invalid_login_result",
|
|
57
|
+
"credentials_auth_unknown_challenge",
|
|
58
|
+
"credentials_auth_unknown_pending_challenge",
|
|
59
|
+
"STATEFUL_FORWARDING_NOT_CONFIGURED",
|
|
60
|
+
"STATEFUL_FORWARDING_SIGNATURE_MISSING",
|
|
61
|
+
"STATEFUL_FORWARDING_NONCE_INVALID",
|
|
62
|
+
"STATEFUL_FORWARDING_TIMESTAMP_INVALID",
|
|
63
|
+
"STATEFUL_FORWARDING_SIGNATURE_INVALID",
|
|
64
|
+
"STATEFUL_FORWARDING_REPLAY_DETECTED",
|
|
65
|
+
"STATEFUL_FORWARDING_REPLAY_CACHE_FULL",
|
|
66
|
+
"STATEFUL_FORWARDING_ENVELOPE_INVALID",
|
|
67
|
+
"STATEFUL_FORWARDING_PROVIDER_MISMATCH",
|
|
68
|
+
"STATEFUL_FORWARDING_SOURCE_POD_MISMATCH",
|
|
69
|
+
"STATEFUL_FORWARDING_OWNER_FENCE_INVALID",
|
|
70
|
+
"STATEFUL_FORWARDING_REQUEST_FAILED",
|
|
71
|
+
"STATEFUL_FORWARDING_CONTEXT_MISSING",
|
|
72
|
+
"STATEFUL_FORWARDING_BAD_RESPONSE",
|
|
73
|
+
"STATEFUL_INTERNAL_EXECUTOR_NOT_CONFIGURED",
|
|
74
|
+
"STATEFUL_FILE_FORWARDING_UNSUPPORTED",
|
|
75
|
+
"STATEFUL_CONTROL_PLANE_OPERATION_AMBIGUOUS",
|
|
76
|
+
"STATEFUL_CONTROL_PLANE_REQUEST_FAILED",
|
|
77
|
+
"STATEFUL_CONTROL_PLANE_HTTP_ERROR",
|
|
78
|
+
"STATEFUL_CONTROL_PLANE_INVALID_RESPONSE",
|
|
79
|
+
]);
|
|
80
|
+
// Complete code authority for provider-declared runtime resolution. Keep this
|
|
81
|
+
// separate from signal suppression: declarations may document these codes, but
|
|
82
|
+
// their status and retryability can never override the SDK's canonical result.
|
|
83
|
+
export const SDK_RUNTIME_OWNED_ERROR_CODES = new Set([
|
|
84
|
+
...SDK_OWNED_PROVIDER_ERROR_CODES,
|
|
85
|
+
"reauth_required",
|
|
86
|
+
"OCR_UNAVAILABLE",
|
|
87
|
+
"UNSUPPORTED_OCR_BACKEND",
|
|
88
|
+
"STT_UNAVAILABLE",
|
|
89
|
+
"UNSUPPORTED_STT_BACKEND",
|
|
90
|
+
"OUTPUT_VALIDATION_FAILED",
|
|
91
|
+
"NOT_FOUND",
|
|
92
|
+
"not_found",
|
|
93
|
+
]);
|
|
94
|
+
// Canonical SDK status mapping for recognized provider-thrown error codes.
|
|
95
|
+
// serve.ts toStatusCode consults this map (after operation-declared overrides
|
|
96
|
+
// for non-SDK-owned codes), and the authoring lint treats these codes as
|
|
97
|
+
// SDK-registered. Add new codes here instead of duplicating literals in
|
|
98
|
+
// either consumer.
|
|
99
|
+
export const SDK_STATUS_MAPPED_PROVIDER_ERROR_CODES = new Map([
|
|
100
|
+
["AUTH_REQUIRED", 401],
|
|
101
|
+
["reauth_required", 401],
|
|
102
|
+
// Unprovisioned declared secret: a deployment/config defect, never an
|
|
103
|
+
// upstream failure — explicit 400.
|
|
104
|
+
["MISSING_SECRET", 400],
|
|
105
|
+
["NOT_FOUND", 404],
|
|
106
|
+
["not_found", 404],
|
|
107
|
+
["NO_DATA", 404],
|
|
108
|
+
["RATE_LIMITED", 429],
|
|
109
|
+
["UPSTREAM_RATE_LIMIT", 429],
|
|
110
|
+
["LIMITED_NUMBER_OF_SERVICE_REQUESTS_EXCEEDS_ERROR", 429],
|
|
111
|
+
// Deterministic upstream business refusal (honest-provider-error-
|
|
112
|
+
// contract): the upstream evaluated the request and said no under its
|
|
113
|
+
// own rules — a conflict with upstream state, never a 5xx.
|
|
114
|
+
["UPSTREAM_REJECTED", 409],
|
|
115
|
+
["UPSTREAM_ERROR", 502],
|
|
116
|
+
["BLOCKED", 502],
|
|
117
|
+
["OCR_UNAVAILABLE", 503],
|
|
118
|
+
["UNSUPPORTED_OCR_BACKEND", 503],
|
|
119
|
+
["STT_UNAVAILABLE", 503],
|
|
120
|
+
["UNSUPPORTED_STT_BACKEND", 503],
|
|
121
|
+
["STATEFUL_FORWARDING_REPLAY_CACHE_FULL", 503],
|
|
122
|
+
]);
|
package/dist/errors.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { ProviderErrorCategory } from "./observability.js";
|
|
2
|
+
import type { HttpRedirectFailureReason } from "./types.js";
|
|
2
3
|
export type ProviderErrorOptions = {
|
|
3
4
|
fix?: string;
|
|
4
5
|
code?: string;
|
|
@@ -6,6 +7,21 @@ export type ProviderErrorOptions = {
|
|
|
6
7
|
cause?: Error;
|
|
7
8
|
category?: ProviderErrorCategory;
|
|
8
9
|
retryable?: boolean;
|
|
10
|
+
/** Provider-authored, bounded metadata safe for operational logs and error headers. */
|
|
11
|
+
observability?: ProviderErrorObservability;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* Provider-authored error diagnostics whose runtime values are validated before emission.
|
|
15
|
+
* Classification tokens such as `reason` are source literals, not runtime user input or
|
|
16
|
+
* credentials. The gateway removes the observability header from tenant responses.
|
|
17
|
+
*/
|
|
18
|
+
export type ProviderErrorObservability = {
|
|
19
|
+
/** A 1-64 character `[A-Za-z0-9_.-]` classification token, for example `LOGIN_COMPLETE_FAILED`. */
|
|
20
|
+
reason?: string;
|
|
21
|
+
/** A provider-computed 12-hex-character fingerprint of private diagnostic input. */
|
|
22
|
+
fingerprint?: string;
|
|
23
|
+
/** The non-negative length of the private diagnostic input, capped at 10,000,000. */
|
|
24
|
+
messageLength?: number;
|
|
9
25
|
};
|
|
10
26
|
export declare class ProviderError extends Error {
|
|
11
27
|
readonly options?: ProviderErrorOptions | undefined;
|
|
@@ -17,6 +33,11 @@ export declare class ProviderError extends Error {
|
|
|
17
33
|
export declare class SDKError extends ProviderError {
|
|
18
34
|
constructor(message: string, options?: ProviderErrorOptions);
|
|
19
35
|
}
|
|
36
|
+
/** Raised when persisted stealth cookies use a store version this SDK cannot read. */
|
|
37
|
+
export declare class StealthCookieStoreVersionError extends SDKError {
|
|
38
|
+
readonly version: unknown;
|
|
39
|
+
constructor(version: unknown);
|
|
40
|
+
}
|
|
20
41
|
export declare class AuthError extends ProviderError {
|
|
21
42
|
constructor(message: string, options?: ProviderErrorOptions);
|
|
22
43
|
}
|
|
@@ -39,9 +60,21 @@ export declare class TransportError extends ProviderError {
|
|
|
39
60
|
readonly upstreamStatus?: number;
|
|
40
61
|
constructor(message: string, options?: TransportErrorOptions);
|
|
41
62
|
}
|
|
63
|
+
export type HttpRedirectErrorOptions = TransportErrorOptions & {
|
|
64
|
+
reason: HttpRedirectFailureReason;
|
|
65
|
+
/** Redacted redirect target suitable for provider diagnostics. */
|
|
66
|
+
target?: string;
|
|
67
|
+
};
|
|
68
|
+
/** Raised when an opt-in ctx.http redirect policy refuses or cannot resolve a hop. */
|
|
69
|
+
export declare class HttpRedirectError extends TransportError {
|
|
70
|
+
readonly reason: HttpRedirectFailureReason;
|
|
71
|
+
readonly target?: string;
|
|
72
|
+
constructor(message: string, options: HttpRedirectErrorOptions);
|
|
73
|
+
}
|
|
42
74
|
export declare function isProviderError(value: unknown): value is ProviderError;
|
|
43
75
|
export declare function isSessionExpiredError(value: unknown): value is SessionExpiredError;
|
|
44
76
|
export declare function isTransportError(value: unknown): value is TransportError;
|
|
77
|
+
export declare function isValidationError(value: unknown): value is ValidationError;
|
|
45
78
|
export declare class ProviderSecretError extends ProviderError {
|
|
46
79
|
constructor(message: string, options?: ProviderErrorOptions);
|
|
47
80
|
}
|
package/dist/errors.js
CHANGED
|
@@ -8,6 +8,7 @@ const PROVIDER_ERROR_BRAND = Symbol.for("@apifuse/provider-sdk/error-brand@1");
|
|
|
8
8
|
const PROVIDER_ERROR_BRAND_VALUE = 1;
|
|
9
9
|
const SESSION_EXPIRED_BRAND = Symbol.for("@apifuse/provider-sdk/error-kind/session-expired@1");
|
|
10
10
|
const TRANSPORT_BRAND = Symbol.for("@apifuse/provider-sdk/error-kind/transport@1");
|
|
11
|
+
const VALIDATION_BRAND = Symbol.for("@apifuse/provider-sdk/error-kind/validation@1");
|
|
11
12
|
// Defines a non-enumerable, non-writable, non-configurable own data property.
|
|
12
13
|
// Immutable + own means a guard can trust it via a single descriptor read
|
|
13
14
|
// without invoking attacker-controlled getters or accepting inherited brands.
|
|
@@ -57,6 +58,21 @@ export class SDKError extends ProviderError {
|
|
|
57
58
|
this.name = "SDKError";
|
|
58
59
|
}
|
|
59
60
|
}
|
|
61
|
+
/** Raised when persisted stealth cookies use a store version this SDK cannot read. */
|
|
62
|
+
export class StealthCookieStoreVersionError extends SDKError {
|
|
63
|
+
version;
|
|
64
|
+
constructor(version) {
|
|
65
|
+
const displayedVersion = typeof version === "string" || typeof version === "number"
|
|
66
|
+
? String(version)
|
|
67
|
+
: "missing or invalid";
|
|
68
|
+
super(`Unsupported stealth cookie store version: ${displayedVersion}`, {
|
|
69
|
+
code: "unsupported_stealth_cookie_store_version",
|
|
70
|
+
details: { receivedVersion: version, supportedVersions: [1] },
|
|
71
|
+
});
|
|
72
|
+
this.version = version;
|
|
73
|
+
this.name = "StealthCookieStoreVersionError";
|
|
74
|
+
}
|
|
75
|
+
}
|
|
60
76
|
export class AuthError extends ProviderError {
|
|
61
77
|
constructor(message, options) {
|
|
62
78
|
super(message, options);
|
|
@@ -81,6 +97,7 @@ export class ValidationError extends ProviderError {
|
|
|
81
97
|
super(message, options);
|
|
82
98
|
this.name = "ValidationError";
|
|
83
99
|
this.zodError = options?.zodError;
|
|
100
|
+
defineErrorBrand(this, VALIDATION_BRAND, true);
|
|
84
101
|
}
|
|
85
102
|
}
|
|
86
103
|
export class TransportError extends ProviderError {
|
|
@@ -94,6 +111,25 @@ export class TransportError extends ProviderError {
|
|
|
94
111
|
defineErrorBrand(this, TRANSPORT_BRAND, true);
|
|
95
112
|
}
|
|
96
113
|
}
|
|
114
|
+
/** Raised when an opt-in ctx.http redirect policy refuses or cannot resolve a hop. */
|
|
115
|
+
export class HttpRedirectError extends TransportError {
|
|
116
|
+
reason;
|
|
117
|
+
target;
|
|
118
|
+
constructor(message, options) {
|
|
119
|
+
const { reason, target, ...transportOptions } = options;
|
|
120
|
+
super(message, {
|
|
121
|
+
...transportOptions,
|
|
122
|
+
code: `http_redirect_${reason}`,
|
|
123
|
+
details: {
|
|
124
|
+
reason,
|
|
125
|
+
...(target ? { target } : {}),
|
|
126
|
+
},
|
|
127
|
+
});
|
|
128
|
+
this.name = "HttpRedirectError";
|
|
129
|
+
this.reason = reason;
|
|
130
|
+
this.target = target;
|
|
131
|
+
}
|
|
132
|
+
}
|
|
97
133
|
// Cross-module type guards. Prefer these over `instanceof` at any boundary that
|
|
98
134
|
// may receive an error from a different copy/entrypoint of the SDK (see the HTTP
|
|
99
135
|
// server error boundary). They recognize branded errors regardless of which
|
|
@@ -107,6 +143,10 @@ export function isSessionExpiredError(value) {
|
|
|
107
143
|
export function isTransportError(value) {
|
|
108
144
|
return isProviderError(value) && hasOwnBrand(value, TRANSPORT_BRAND, true);
|
|
109
145
|
}
|
|
146
|
+
export function isValidationError(value) {
|
|
147
|
+
return (isProviderError(value) &&
|
|
148
|
+
(hasOwnBrand(value, VALIDATION_BRAND, true) || value.name === "ValidationError"));
|
|
149
|
+
}
|
|
110
150
|
export class ProviderSecretError extends ProviderError {
|
|
111
151
|
constructor(message, options) {
|
|
112
152
|
super(message, { code: "provider_secret_error", ...options });
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { JsonValue } from "./contract-json.js";
|
|
2
|
+
export declare const REDACTED_FIXTURE_VALUE = "[REDACTED]";
|
|
3
|
+
/** Matches credential field names without treating benign prefixes such as `author` as `auth`. */
|
|
4
|
+
export declare function isSensitiveFixtureKey(key: string): boolean;
|
|
5
|
+
/**
|
|
6
|
+
* Returns JSON fixture data with credential-bearing keys and heuristic-confirmed string secrets
|
|
7
|
+
* replaced. Ordinary short prose and identifiers are retained.
|
|
8
|
+
*/
|
|
9
|
+
export declare function sanitizeFixture(value: JsonValue): JsonValue;
|
|
10
|
+
/** Applies the shared credential-key policy to ordinary JSON fixtures. */
|
|
11
|
+
export declare function sanitizeOrdinaryFixture(value: JsonValue): JsonValue;
|
|
12
|
+
/** Sanitizes a primitive fixture string only when textual-secret heuristics match. */
|
|
13
|
+
export declare function sanitizeFixtureString(value: string): string;
|
|
14
|
+
/** True for opaque values that are unsafe to retain in paths or unstructured text. */
|
|
15
|
+
export declare function isSensitiveFixtureValue(value: string): boolean;
|
|
16
|
+
/** Sanitizes every path segment and values following a credential-like segment name. */
|
|
17
|
+
export declare function sanitizePathname(pathname: string): string;
|
|
18
|
+
/** Removes userinfo, query values, fragments, and credential-like path segments from log URLs. */
|
|
19
|
+
export declare function sanitizeUrlForLogs(value: string): string;
|
|
20
|
+
/**
|
|
21
|
+
* Returns query-free request provenance with each path segment scrubbed for credential-like values.
|
|
22
|
+
* Origins, URL userinfo, query values, and fragments are never persisted in request provenance.
|
|
23
|
+
*/
|
|
24
|
+
export declare function requestPathForFixture(value: string): string;
|
|
25
|
+
/** Scrubs secrets and terminal/log control characters before diagnostic text is emitted. */
|
|
26
|
+
export declare function sanitizeDiagnosticText(value: string): string;
|
|
27
|
+
/** Encodes terminal/log control characters without applying value-level secret heuristics. */
|
|
28
|
+
export declare function encodeDiagnosticControls(value: string): string;
|