@apifuse/provider-sdk 2.2.0-beta.2 → 2.2.0-beta.21
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 +487 -0
- package/CHANGELOG.md +90 -0
- package/README.md +49 -3
- package/SUBMISSION.md +1 -1
- package/bin/apifuse-check.ts +44 -59
- package/bin/apifuse-create.ts +1 -1
- package/bin/apifuse-dev.ts +27 -52
- package/bin/apifuse-pack-check.ts +14 -0
- package/bin/apifuse-pack-smoke.ts +36 -81
- package/bin/apifuse-pack-types.ts +305 -0
- package/bin/apifuse-perf.ts +45 -127
- package/bin/apifuse-record.ts +659 -111
- package/bin/apifuse-submit-check.ts +546 -48
- package/bin/apifuse-sync-assets.ts +117 -0
- package/bin/apifuse.ts +1 -1
- package/bin/submit-check-delimited-text.ts +50 -0
- package/bin/submit-check-xml-semantics.ts +204 -0
- package/bin/submit-check-xml.ts +134 -0
- package/dist/auth-turn/index.d.ts +3 -3
- package/dist/auth.d.ts +2 -2
- package/dist/auth.js +9 -18
- package/dist/ceremonies/index.d.ts +9 -1
- package/dist/ceremonies/index.js +65 -18
- package/dist/cli/commands.d.ts +1 -1
- package/dist/cli/commands.js +8 -0
- package/dist/cli/create.d.ts +3 -0
- package/dist/cli/create.js +34 -35
- 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/config/loader.d.ts +176 -8
- package/dist/config/loader.js +424 -95
- package/dist/contract-serialization.d.ts +2 -2
- package/dist/contract-serialization.js +3 -6
- package/dist/contract-types.d.ts +2 -2
- package/dist/contract.d.ts +3 -3
- package/dist/contract.js +4 -6
- package/dist/define.d.ts +9 -1
- package/dist/define.js +304 -119
- package/dist/dev.d.ts +1 -1
- package/dist/dev.js +1 -1
- package/dist/error-resolution.d.ts +2 -0
- package/dist/error-resolution.js +90 -0
- package/dist/errors.d.ts +22 -1
- package/dist/errors.js +88 -0
- package/dist/fixture-sanitization.d.ts +26 -0
- package/dist/fixture-sanitization.js +216 -0
- package/dist/i18n/catalog.d.ts +2 -2
- package/dist/i18n/catalog.js +4 -10
- package/dist/i18n/index.d.ts +2 -2
- package/dist/i18n/index.js +2 -2
- package/dist/i18n/keys.d.ts +2 -2
- package/dist/index.d.ts +46 -42
- package/dist/index.js +41 -37
- package/dist/lint.d.ts +1 -1
- package/dist/lint.js +8 -15
- 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 +12 -11
- package/dist/provider.js +10 -9
- package/dist/public-schema-field-lint.d.ts +1 -1
- package/dist/recipes/gov-api.js +1 -1
- package/dist/runtime/auth-flow.d.ts +2 -1
- package/dist/runtime/auth-flow.js +4 -3
- package/dist/runtime/browser.d.ts +1 -1
- package/dist/runtime/browser.js +15 -29
- package/dist/runtime/cache.d.ts +1 -1
- package/dist/runtime/cache.js +4 -8
- package/dist/runtime/choice.d.ts +1 -1
- package/dist/runtime/choice.js +31 -35
- package/dist/runtime/credential.d.ts +1 -1
- package/dist/runtime/credential.js +1 -1
- package/dist/runtime/env.d.ts +1 -1
- package/dist/runtime/executor.d.ts +1 -1
- package/dist/runtime/executor.js +31 -4
- package/dist/runtime/http.d.ts +2 -2
- package/dist/runtime/http.js +387 -47
- package/dist/runtime/insights.d.ts +1 -1
- package/dist/runtime/insights.js +6 -13
- package/dist/runtime/instrumentation.d.ts +2 -2
- package/dist/runtime/instrumentation.js +345 -22
- package/dist/runtime/keyring.js +1 -1
- package/dist/runtime/namespace.js +1 -1
- package/dist/runtime/native-network.d.ts +127 -0
- package/dist/runtime/native-network.js +1298 -0
- package/dist/runtime/otlp.d.ts +1 -1
- package/dist/runtime/perf.d.ts +1 -1
- package/dist/runtime/provider.d.ts +1 -1
- package/dist/runtime/provider.js +1 -2
- package/dist/runtime/proxy-errors.d.ts +1 -1
- package/dist/runtime/proxy-errors.js +9 -7
- package/dist/runtime/proxy-nodemaven.d.ts +56 -0
- package/dist/runtime/proxy-nodemaven.js +146 -0
- package/dist/runtime/proxy-retry-policy.d.ts +2 -2
- package/dist/runtime/proxy-retry-policy.js +2 -2
- package/dist/runtime/proxy-telemetry.d.ts +2 -1
- package/dist/runtime/proxy-telemetry.js +55 -52
- 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 +2 -4
- package/dist/runtime/request-options.d.ts +68 -1
- package/dist/runtime/request-options.js +548 -0
- package/dist/runtime/secrets.d.ts +27 -0
- package/dist/runtime/secrets.js +51 -0
- package/dist/runtime/state.d.ts +2 -2
- package/dist/runtime/state.js +238 -26
- package/dist/runtime/stealth.d.ts +5 -3
- package/dist/runtime/stealth.js +423 -143
- package/dist/runtime/stt.d.ts +1 -1
- package/dist/runtime/stt.js +11 -15
- package/dist/runtime/trace.d.ts +2 -2
- package/dist/runtime/trace.js +2 -4
- package/dist/runtime/waterfall.d.ts +1 -1
- package/dist/schema.d.ts +1 -1
- package/dist/schema.js +7 -15
- package/dist/serve.d.ts +1 -1
- package/dist/serve.js +1 -1
- package/dist/server/index.d.ts +7 -7
- package/dist/server/index.js +6 -6
- 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-redaction.d.ts +1 -1
- package/dist/server/self-test-redaction.js +1 -1
- package/dist/server/self-test.d.ts +104 -3
- package/dist/server/self-test.js +673 -115
- package/dist/server/serve.d.ts +116 -4
- package/dist/server/serve.js +799 -128
- package/dist/server/types.d.ts +34 -9
- package/dist/server/types.js +8 -1
- package/dist/stateful/errors.d.ts +14 -0
- package/dist/stateful/errors.js +14 -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 +71 -0
- package/dist/stateful/stateful-provider-session-routing.js +353 -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 +1 -1
- package/dist/stealth/profiles.js +5 -14
- package/dist/stream-evidence.d.ts +74 -0
- package/dist/stream-evidence.js +785 -0
- package/dist/stream.d.ts +1 -1
- package/dist/testing/index.d.ts +2 -2
- package/dist/testing/index.js +2 -2
- package/dist/testing/run.d.ts +32 -2
- package/dist/testing/run.js +478 -28
- package/dist/types.d.ts +342 -14
- package/dist/types.js +1 -0
- package/dist/user-input.d.ts +30 -0
- package/dist/user-input.js +66 -0
- package/package.json +16 -5
- package/src/auth-turn/index.ts +1 -1
- package/src/auth.ts +28 -86
- package/src/ceremonies/index.ts +103 -78
- package/src/cli/commands.ts +10 -0
- package/src/cli/create.ts +42 -35
- package/src/cli/prompt-assets.ts +865 -0
- package/src/cli/templates/provider/AGENTS.md.tpl +17 -8
- package/src/config/loader.ts +652 -204
- package/src/contract-serialization.ts +5 -11
- package/src/contract-types.ts +2 -2
- package/src/contract.ts +12 -28
- package/src/define.ts +499 -498
- package/src/dev.ts +4 -9
- package/src/error-resolution.ts +91 -0
- package/src/errors.ts +110 -5
- package/src/fixture-sanitization.ts +247 -0
- package/src/i18n/catalog.ts +10 -32
- package/src/i18n/index.ts +2 -2
- package/src/i18n/keys.ts +5 -11
- package/src/index.ts +112 -42
- package/src/lint.ts +88 -152
- 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 +66 -11
- package/src/public-schema-field-lint.ts +7 -33
- package/src/recipes/gov-api.ts +2 -5
- package/src/runtime/auth-flow.ts +7 -7
- package/src/runtime/browser.ts +64 -187
- package/src/runtime/cache.ts +20 -67
- package/src/runtime/choice.ts +79 -132
- package/src/runtime/credential.ts +2 -2
- package/src/runtime/env.ts +1 -1
- package/src/runtime/executor.ts +43 -20
- package/src/runtime/http.ts +494 -57
- package/src/runtime/insights.ts +15 -53
- package/src/runtime/instrumentation.ts +495 -66
- package/src/runtime/keyring.ts +7 -19
- package/src/runtime/namespace.ts +2 -7
- package/src/runtime/native-network.ts +1686 -0
- package/src/runtime/otlp.ts +12 -23
- package/src/runtime/perf.ts +1 -1
- package/src/runtime/provider.ts +4 -9
- package/src/runtime/proxy-errors.ts +29 -42
- package/src/runtime/proxy-nodemaven.ts +221 -0
- package/src/runtime/proxy-retry-policy.ts +3 -3
- package/src/runtime/proxy-telemetry.ts +79 -77
- package/src/runtime/redirects.ts +66 -0
- package/src/runtime/redis.ts +4 -12
- package/src/runtime/request-options.ts +679 -9
- package/src/runtime/secrets.ts +64 -0
- package/src/runtime/state.ts +353 -133
- package/src/runtime/stealth.ts +505 -154
- package/src/runtime/stt.ts +38 -94
- package/src/runtime/trace.ts +14 -44
- package/src/runtime/waterfall.ts +5 -18
- package/src/schema.ts +23 -84
- package/src/serve.ts +1 -1
- package/src/server/index.ts +29 -7
- package/src/server/self-test-input-tokens.ts +29 -14
- package/src/server/self-test-redaction.ts +2 -2
- package/src/server/self-test.ts +857 -132
- package/src/server/serve.ts +1151 -328
- package/src/server/types.ts +12 -13
- package/src/stateful/README.md +146 -0
- package/src/stateful/errors.ts +23 -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 +555 -0
- package/src/stateful/stateful-provider-session-runtime.ts +403 -0
- package/src/stateful-signing.ts +46 -0
- package/src/stealth/profiles.ts +10 -26
- package/src/stream-evidence.ts +988 -0
- package/src/stream.ts +8 -19
- package/src/testing/index.ts +10 -2
- package/src/testing/run.ts +653 -74
- package/src/types.ts +408 -28
- package/src/user-input.ts +118 -0
- 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
|
@@ -1,3 +1,70 @@
|
|
|
1
|
-
import type { RequestParams } from "../types";
|
|
1
|
+
import type { HttpClient, RequestOptions, RequestParams } from "../types.js";
|
|
2
|
+
export declare const REDACTED_QUERY_VALUE = "[REDACTED]";
|
|
3
|
+
/** Internal heuristic shared by diagnostic and fixture structural redaction. */
|
|
4
|
+
export declare function isSensitiveKey(key: string): boolean;
|
|
5
|
+
declare const HTTP_REQUEST_METHOD_CONFIG: {
|
|
6
|
+
readonly request: {
|
|
7
|
+
readonly optionsIndex: 1;
|
|
8
|
+
};
|
|
9
|
+
readonly get: {
|
|
10
|
+
readonly optionsIndex: 1;
|
|
11
|
+
};
|
|
12
|
+
readonly post: {
|
|
13
|
+
readonly optionsIndex: 2;
|
|
14
|
+
};
|
|
15
|
+
readonly put: {
|
|
16
|
+
readonly optionsIndex: 2;
|
|
17
|
+
};
|
|
18
|
+
readonly delete: {
|
|
19
|
+
readonly optionsIndex: 1;
|
|
20
|
+
};
|
|
21
|
+
readonly stream: {
|
|
22
|
+
readonly optionsIndex: 1;
|
|
23
|
+
};
|
|
24
|
+
readonly sse: {
|
|
25
|
+
readonly optionsIndex: 1;
|
|
26
|
+
};
|
|
27
|
+
};
|
|
28
|
+
export type HttpRequestMethod = keyof typeof HTTP_REQUEST_METHOD_CONFIG;
|
|
29
|
+
export type HttpRequestInvocation = {
|
|
30
|
+
[M in HttpRequestMethod]: {
|
|
31
|
+
method: M;
|
|
32
|
+
args: Parameters<HttpClient[M]>;
|
|
33
|
+
};
|
|
34
|
+
}[HttpRequestMethod];
|
|
35
|
+
export declare const HTTP_REQUEST_METHOD_NAMES: HttpRequestMethod[];
|
|
36
|
+
export declare function isHttpRequestMethod(method: PropertyKey): method is HttpRequestMethod;
|
|
37
|
+
export type SerializedRequestUrl = {
|
|
38
|
+
requestUrl: string;
|
|
39
|
+
redactedUrl: string;
|
|
40
|
+
sensitiveValues: readonly string[];
|
|
41
|
+
};
|
|
42
|
+
export declare function normalizeSensitiveParams(sensitiveParams?: Record<string, string>): Record<string, string> | undefined;
|
|
2
43
|
export declare function appendQueryParams(url: string, params?: RequestParams): string;
|
|
44
|
+
/** Redacts matching query keys without reserializing any other URL bytes. */
|
|
45
|
+
export declare function redactUrlQueryParams(url: string, sensitiveParamNames: readonly string[]): {
|
|
46
|
+
redactedUrl: string;
|
|
47
|
+
sensitiveValues: readonly string[];
|
|
48
|
+
};
|
|
49
|
+
/**
|
|
50
|
+
* Serializes public and secret query parameters together while constructing a
|
|
51
|
+
* separate, structurally redacted URL for diagnostics and observability.
|
|
52
|
+
*/
|
|
53
|
+
export declare function serializeRequestUrl(url: string, params?: RequestParams, sensitiveParams?: Record<string, string>): SerializedRequestUrl;
|
|
54
|
+
/** Scrubs raw and URL-encoded secret values from diagnostic text. */
|
|
55
|
+
export declare function redactSensitiveText(text: string, sensitiveValues: readonly string[], requestUrl?: string, redactedUrl?: string): string;
|
|
56
|
+
/**
|
|
57
|
+
* Redacts error text and recursively serializable diagnostic metadata.
|
|
58
|
+
* Mutable errors retain identity; readonly/frozen errors may be replaced, so
|
|
59
|
+
* callers must use the returned value.
|
|
60
|
+
*/
|
|
61
|
+
export declare function redactSensitiveError<T>(error: T, sensitiveValues: readonly string[], requestUrl?: string, redactedUrl?: string): T;
|
|
62
|
+
/** Redacts failures that occur before a request URL can be fully serialized. */
|
|
63
|
+
export declare function redactSensitiveRequestError<T>(error: T, url: string, sensitiveParams?: Record<string, string>): T;
|
|
64
|
+
/** Validates an untyped proxy invocation before narrowing it to the HttpClient contract. */
|
|
65
|
+
export declare function parseHttpRequestInvocation(method: PropertyKey, args: unknown[]): HttpRequestInvocation | undefined;
|
|
66
|
+
/** Internal typed registry for the request-options position of HttpClient calls. */
|
|
67
|
+
export declare function requestOptionsFromHttpInvocation(invocation: HttpRequestInvocation): RequestOptions | undefined;
|
|
68
|
+
export declare function replaceRequestOptionsInHttpInvocation(invocation: HttpRequestInvocation, options: RequestOptions): void;
|
|
3
69
|
export declare function normalizeHttpRequestBody(body: unknown): string | Buffer | undefined;
|
|
70
|
+
export {};
|
|
@@ -1,3 +1,26 @@
|
|
|
1
|
+
import { isProviderError } from "../errors.js";
|
|
2
|
+
export const REDACTED_QUERY_VALUE = "[REDACTED]";
|
|
3
|
+
/** Internal heuristic shared by diagnostic and fixture structural redaction. */
|
|
4
|
+
export function isSensitiveKey(key) {
|
|
5
|
+
return /authorization|token|api[-_]?key|(^|[-_])(code|key|secret|signature|session|state)($|[-_])/i.test(key);
|
|
6
|
+
}
|
|
7
|
+
const HTTP_REQUEST_METHOD_CONFIG = {
|
|
8
|
+
request: { optionsIndex: 1 },
|
|
9
|
+
get: { optionsIndex: 1 },
|
|
10
|
+
post: { optionsIndex: 2 },
|
|
11
|
+
put: { optionsIndex: 2 },
|
|
12
|
+
delete: { optionsIndex: 1 },
|
|
13
|
+
stream: { optionsIndex: 1 },
|
|
14
|
+
sse: { optionsIndex: 1 },
|
|
15
|
+
};
|
|
16
|
+
export const HTTP_REQUEST_METHOD_NAMES = Object.keys(HTTP_REQUEST_METHOD_CONFIG);
|
|
17
|
+
const HTTP_REQUEST_METHOD_SET = new Set(HTTP_REQUEST_METHOD_NAMES);
|
|
18
|
+
export function isHttpRequestMethod(method) {
|
|
19
|
+
return typeof method === "string" && HTTP_REQUEST_METHOD_SET.has(method);
|
|
20
|
+
}
|
|
21
|
+
export function normalizeSensitiveParams(sensitiveParams) {
|
|
22
|
+
return sensitiveParams && Object.keys(sensitiveParams).length > 0 ? sensitiveParams : undefined;
|
|
23
|
+
}
|
|
1
24
|
function isParamArray(value) {
|
|
2
25
|
return Array.isArray(value);
|
|
3
26
|
}
|
|
@@ -22,6 +45,531 @@ export function appendQueryParams(url, params) {
|
|
|
22
45
|
}
|
|
23
46
|
return parsed.toString();
|
|
24
47
|
}
|
|
48
|
+
function decodeQueryComponent(value) {
|
|
49
|
+
try {
|
|
50
|
+
return decodeURIComponent(value.replaceAll("+", " "));
|
|
51
|
+
}
|
|
52
|
+
catch {
|
|
53
|
+
return value;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
/** Redacts matching query keys without reserializing any other URL bytes. */
|
|
57
|
+
export function redactUrlQueryParams(url, sensitiveParamNames) {
|
|
58
|
+
if (sensitiveParamNames.length === 0)
|
|
59
|
+
return { redactedUrl: url, sensitiveValues: [] };
|
|
60
|
+
const names = new Set(sensitiveParamNames);
|
|
61
|
+
const queryStart = url.indexOf("?");
|
|
62
|
+
if (queryStart === -1)
|
|
63
|
+
return { redactedUrl: url, sensitiveValues: [] };
|
|
64
|
+
const fragmentStart = url.indexOf("#", queryStart);
|
|
65
|
+
const queryEnd = fragmentStart === -1 ? url.length : fragmentStart;
|
|
66
|
+
const query = url.slice(queryStart + 1, queryEnd);
|
|
67
|
+
const sensitiveValues = [];
|
|
68
|
+
const redactedQuery = query
|
|
69
|
+
.split("&")
|
|
70
|
+
.map((part) => {
|
|
71
|
+
const assignment = part.indexOf("=");
|
|
72
|
+
const encodedKey = assignment === -1 ? part : part.slice(0, assignment);
|
|
73
|
+
if (!names.has(decodeQueryComponent(encodedKey)))
|
|
74
|
+
return part;
|
|
75
|
+
const encodedValue = assignment === -1 ? "" : part.slice(assignment + 1);
|
|
76
|
+
sensitiveValues.push(decodeQueryComponent(encodedValue));
|
|
77
|
+
return `${encodedKey}=${REDACTED_QUERY_VALUE}`;
|
|
78
|
+
})
|
|
79
|
+
.join("&");
|
|
80
|
+
return {
|
|
81
|
+
redactedUrl: `${url.slice(0, queryStart + 1)}${redactedQuery}${url.slice(queryEnd)}`,
|
|
82
|
+
sensitiveValues,
|
|
83
|
+
};
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Serializes public and secret query parameters together while constructing a
|
|
87
|
+
* separate, structurally redacted URL for diagnostics and observability.
|
|
88
|
+
*/
|
|
89
|
+
export function serializeRequestUrl(url, params, sensitiveParams) {
|
|
90
|
+
const urlWithParams = appendQueryParams(url, params);
|
|
91
|
+
const normalizedSensitiveParams = normalizeSensitiveParams(sensitiveParams);
|
|
92
|
+
if (!normalizedSensitiveParams) {
|
|
93
|
+
return { requestUrl: urlWithParams, redactedUrl: urlWithParams, sensitiveValues: [] };
|
|
94
|
+
}
|
|
95
|
+
const sensitiveParamNames = Object.keys(normalizedSensitiveParams);
|
|
96
|
+
const existing = redactUrlQueryParams(urlWithParams, sensitiveParamNames);
|
|
97
|
+
const sensitiveValues = new Set(existing.sensitiveValues);
|
|
98
|
+
let requestUrl = urlWithParams;
|
|
99
|
+
for (const [key, value] of Object.entries(normalizedSensitiveParams)) {
|
|
100
|
+
const serializedValue = String(value);
|
|
101
|
+
requestUrl = appendQueryParams(requestUrl, { [key]: serializedValue });
|
|
102
|
+
sensitiveValues.add(serializedValue);
|
|
103
|
+
}
|
|
104
|
+
const redacted = redactUrlQueryParams(requestUrl, sensitiveParamNames);
|
|
105
|
+
return {
|
|
106
|
+
requestUrl,
|
|
107
|
+
redactedUrl: redacted.redactedUrl,
|
|
108
|
+
sensitiveValues: [...sensitiveValues],
|
|
109
|
+
};
|
|
110
|
+
}
|
|
111
|
+
const MIN_UNSCOPED_SENSITIVE_VALUE_LENGTH = 4;
|
|
112
|
+
function normalizePercentEscapes(value) {
|
|
113
|
+
return value.replace(/%[\da-f]{2}/gi, (percentEscape) => percentEscape.toUpperCase());
|
|
114
|
+
}
|
|
115
|
+
function sensitiveValueVariants(value) {
|
|
116
|
+
if (!value || value === REDACTED_QUERY_VALUE)
|
|
117
|
+
return [];
|
|
118
|
+
const formEncoded = new URLSearchParams({ value }).toString().slice("value=".length);
|
|
119
|
+
let componentEncoded;
|
|
120
|
+
try {
|
|
121
|
+
componentEncoded = encodeURIComponent(value);
|
|
122
|
+
}
|
|
123
|
+
catch {
|
|
124
|
+
// encodeURIComponent rejects lone UTF-16 surrogates. The raw value is
|
|
125
|
+
// still safe to scrub, and URLSearchParams supplies its well-formed form.
|
|
126
|
+
componentEncoded = value;
|
|
127
|
+
}
|
|
128
|
+
return [...new Set([value, componentEncoded, formEncoded].map(normalizePercentEscapes))];
|
|
129
|
+
}
|
|
130
|
+
function allSensitiveValueVariants(sensitiveValues) {
|
|
131
|
+
const variants = new Map();
|
|
132
|
+
for (const sensitiveValue of sensitiveValues) {
|
|
133
|
+
const requiresTokenBoundary = sensitiveValue.length < MIN_UNSCOPED_SENSITIVE_VALUE_LENGTH;
|
|
134
|
+
for (const value of sensitiveValueVariants(sensitiveValue)) {
|
|
135
|
+
const existing = variants.get(value);
|
|
136
|
+
variants.set(value, {
|
|
137
|
+
value,
|
|
138
|
+
requiresTokenBoundary: existing
|
|
139
|
+
? existing.requiresTokenBoundary && requiresTokenBoundary
|
|
140
|
+
: requiresTokenBoundary,
|
|
141
|
+
});
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
return [...variants.values()].sort((left, right) => right.value.length - left.value.length || left.value.localeCompare(right.value));
|
|
145
|
+
}
|
|
146
|
+
function isTokenCharacter(value) {
|
|
147
|
+
return value !== undefined && /[\p{L}\p{N}]/u.test(value);
|
|
148
|
+
}
|
|
149
|
+
function replaceSensitiveVariant(text, variant) {
|
|
150
|
+
const pattern = variant.value.replace(/%([\da-f]{2})|[.*+?^${}()|[\]\\]/gi, (match, hex) => {
|
|
151
|
+
if (hex) {
|
|
152
|
+
return `%${[...String(hex)]
|
|
153
|
+
.map((character) => /[a-f]/i.test(character)
|
|
154
|
+
? `[${character.toLowerCase()}${character.toUpperCase()}]`
|
|
155
|
+
: character)
|
|
156
|
+
.join("")}`;
|
|
157
|
+
}
|
|
158
|
+
return `\\${match}`;
|
|
159
|
+
});
|
|
160
|
+
return text.replace(new RegExp(pattern, "gu"), (match, offset, source) => {
|
|
161
|
+
const end = offset + match.length;
|
|
162
|
+
if (variant.requiresTokenBoundary &&
|
|
163
|
+
(isTokenCharacter(source[offset - 1]) || isTokenCharacter(source[end]))) {
|
|
164
|
+
return match;
|
|
165
|
+
}
|
|
166
|
+
return REDACTED_QUERY_VALUE;
|
|
167
|
+
});
|
|
168
|
+
}
|
|
169
|
+
/** Scrubs raw and URL-encoded secret values from diagnostic text. */
|
|
170
|
+
export function redactSensitiveText(text, sensitiveValues, requestUrl, redactedUrl) {
|
|
171
|
+
let redacted = requestUrl && redactedUrl ? text.replaceAll(requestUrl, redactedUrl) : text;
|
|
172
|
+
for (const variant of allSensitiveValueVariants(sensitiveValues)) {
|
|
173
|
+
// Low-entropy values are still redacted, but only as complete tokens. This
|
|
174
|
+
// covers query values and diagnostic phrases such as "credential api rejected"
|
|
175
|
+
// without corrupting timestamps or words such as "rapid".
|
|
176
|
+
redacted = replaceSensitiveVariant(redacted, variant);
|
|
177
|
+
}
|
|
178
|
+
return redacted;
|
|
179
|
+
}
|
|
180
|
+
function isSdkErrorBrand(key) {
|
|
181
|
+
return (typeof key === "symbol" &&
|
|
182
|
+
Symbol.keyFor(key)?.startsWith("@apifuse/provider-sdk/error-") === true);
|
|
183
|
+
}
|
|
184
|
+
function redactDiagnosticString(value, context) {
|
|
185
|
+
return redactSensitiveText(value, context.sensitiveValues, context.requestUrl, context.redactedUrl);
|
|
186
|
+
}
|
|
187
|
+
function redactClassificationString(value, context) {
|
|
188
|
+
let redacted = context.requestUrl && context.redactedUrl
|
|
189
|
+
? value.replaceAll(context.requestUrl, context.redactedUrl)
|
|
190
|
+
: value;
|
|
191
|
+
for (const variant of allSensitiveValueVariants(context.sensitiveValues)) {
|
|
192
|
+
redacted = replaceSensitiveVariant(redacted, {
|
|
193
|
+
...variant,
|
|
194
|
+
requiresTokenBoundary: false,
|
|
195
|
+
});
|
|
196
|
+
}
|
|
197
|
+
return redacted;
|
|
198
|
+
}
|
|
199
|
+
function cloneForRedaction(source) {
|
|
200
|
+
let clone;
|
|
201
|
+
try {
|
|
202
|
+
clone = Array.isArray(source)
|
|
203
|
+
? []
|
|
204
|
+
: source instanceof DOMException
|
|
205
|
+
? new DOMException(source.message, source.name)
|
|
206
|
+
: Object.create(Object.getPrototypeOf(source));
|
|
207
|
+
if (Array.isArray(source) && Object.getPrototypeOf(source) !== Array.prototype) {
|
|
208
|
+
Object.setPrototypeOf(clone, Object.getPrototypeOf(source));
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
catch {
|
|
212
|
+
clone = source instanceof Error ? new Error() : {};
|
|
213
|
+
}
|
|
214
|
+
for (const key of Reflect.ownKeys(source)) {
|
|
215
|
+
const descriptor = Object.getOwnPropertyDescriptor(source, key);
|
|
216
|
+
if (!descriptor)
|
|
217
|
+
continue;
|
|
218
|
+
if (Array.isArray(source) && key === "length")
|
|
219
|
+
continue;
|
|
220
|
+
try {
|
|
221
|
+
const preserveSdkBrand = isSdkErrorBrand(key);
|
|
222
|
+
Object.defineProperty(clone, key, preserveSdkBrand
|
|
223
|
+
? descriptor
|
|
224
|
+
: {
|
|
225
|
+
...descriptor,
|
|
226
|
+
configurable: true,
|
|
227
|
+
...(Object.hasOwn(descriptor, "value") ? { writable: true } : {}),
|
|
228
|
+
});
|
|
229
|
+
}
|
|
230
|
+
catch {
|
|
231
|
+
// A hostile or exotic diagnostic property must not make redaction fail.
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
if (source instanceof Error) {
|
|
235
|
+
// DOMException exposes name/message through internal-slot getters. An
|
|
236
|
+
// Object.create clone does not carry those slots, so materialize the
|
|
237
|
+
// classification fields as safe own properties on the replacement.
|
|
238
|
+
for (const key of ["name", "message", "stack"]) {
|
|
239
|
+
if (Object.hasOwn(clone, key))
|
|
240
|
+
continue;
|
|
241
|
+
const property = readDiagnosticProperty(source, key);
|
|
242
|
+
if (!property.ok)
|
|
243
|
+
continue;
|
|
244
|
+
const propertyValue = key === "stack" && typeof property.value !== "string" ? new Error().stack : property.value;
|
|
245
|
+
try {
|
|
246
|
+
Object.defineProperty(clone, key, {
|
|
247
|
+
value: propertyValue,
|
|
248
|
+
configurable: true,
|
|
249
|
+
enumerable: false,
|
|
250
|
+
writable: true,
|
|
251
|
+
});
|
|
252
|
+
}
|
|
253
|
+
catch {
|
|
254
|
+
// The generic Error fallback remains classifiable even if an exotic
|
|
255
|
+
// prototype rejects an own diagnostic property.
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
}
|
|
259
|
+
return clone;
|
|
260
|
+
}
|
|
261
|
+
function setDiagnosticProperty(target, key, value) {
|
|
262
|
+
try {
|
|
263
|
+
return Reflect.set(target, key, value, target);
|
|
264
|
+
}
|
|
265
|
+
catch {
|
|
266
|
+
return false;
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
function diagnosticPropertyKeys(value) {
|
|
270
|
+
const keys = new Set(Reflect.ownKeys(value));
|
|
271
|
+
if (value instanceof Error) {
|
|
272
|
+
// Built-in error text and AggregateError.errors are commonly
|
|
273
|
+
// non-enumerable, while SDK options carry serializable details.
|
|
274
|
+
for (const key of ["name", "message", "stack", "cause", "errors", "options"]) {
|
|
275
|
+
if (key in value)
|
|
276
|
+
keys.add(key);
|
|
277
|
+
}
|
|
278
|
+
}
|
|
279
|
+
if (!(value instanceof Error) && "toJSON" in value)
|
|
280
|
+
keys.add("toJSON");
|
|
281
|
+
return [...keys];
|
|
282
|
+
}
|
|
283
|
+
function requiresCloneBeforeRedaction(value, keys) {
|
|
284
|
+
for (const key of keys) {
|
|
285
|
+
if (isSdkErrorBrand(key))
|
|
286
|
+
continue;
|
|
287
|
+
let owner = value;
|
|
288
|
+
while (owner) {
|
|
289
|
+
const descriptor = Object.getOwnPropertyDescriptor(owner, key);
|
|
290
|
+
if (descriptor) {
|
|
291
|
+
if (Object.hasOwn(descriptor, "value")) {
|
|
292
|
+
if (owner === value && descriptor.writable === false)
|
|
293
|
+
return true;
|
|
294
|
+
}
|
|
295
|
+
else if (descriptor.set === undefined) {
|
|
296
|
+
return true;
|
|
297
|
+
}
|
|
298
|
+
break;
|
|
299
|
+
}
|
|
300
|
+
owner = Object.getPrototypeOf(owner);
|
|
301
|
+
}
|
|
302
|
+
}
|
|
303
|
+
return false;
|
|
304
|
+
}
|
|
305
|
+
function readDiagnosticProperty(value, key) {
|
|
306
|
+
try {
|
|
307
|
+
return { ok: true, value: Reflect.get(value, key, value) };
|
|
308
|
+
}
|
|
309
|
+
catch {
|
|
310
|
+
return { ok: false };
|
|
311
|
+
}
|
|
312
|
+
}
|
|
313
|
+
// These fields control error identity/classification downstream. Their values
|
|
314
|
+
// are exempt from whole-value replacement, but strings are still scrubbed when
|
|
315
|
+
// they contain an actual declared credential or request URL.
|
|
316
|
+
const DIAGNOSTIC_CLASSIFICATION_FIELDS = new Set([
|
|
317
|
+
"name",
|
|
318
|
+
"code",
|
|
319
|
+
"status",
|
|
320
|
+
"upstreamStatus",
|
|
321
|
+
"category",
|
|
322
|
+
"retryable",
|
|
323
|
+
]);
|
|
324
|
+
// Underscore-delimited error codes are semantic identities, not diagnostic
|
|
325
|
+
// payload. Preserve the shared SDK/provider code convention without maintaining
|
|
326
|
+
// a second, inevitably partial list of codes declared by individual transports.
|
|
327
|
+
function isSemanticErrorCode(value) {
|
|
328
|
+
return /^(?:[A-Za-z][A-Za-z0-9]*_)+[A-Za-z0-9]+$/.test(value);
|
|
329
|
+
}
|
|
330
|
+
function isClassificationField(context, propertyName, parent) {
|
|
331
|
+
return Boolean(propertyName &&
|
|
332
|
+
parent &&
|
|
333
|
+
context.classificationObjects.has(parent) &&
|
|
334
|
+
DIAGNOSTIC_CLASSIFICATION_FIELDS.has(propertyName));
|
|
335
|
+
}
|
|
336
|
+
function redactedDiagnosticKey(key, context) {
|
|
337
|
+
return redactClassificationString(key, context);
|
|
338
|
+
}
|
|
339
|
+
function hasRedactedOwnKey(value, context) {
|
|
340
|
+
return Object.getOwnPropertyNames(value).some((key) => redactedDiagnosticKey(key, context) !== key);
|
|
341
|
+
}
|
|
342
|
+
function collisionSafeDiagnosticKey(target, preferredKey) {
|
|
343
|
+
if (!Object.hasOwn(target, preferredKey))
|
|
344
|
+
return preferredKey;
|
|
345
|
+
let suffix = 2;
|
|
346
|
+
while (Object.hasOwn(target, `${preferredKey}#${suffix}`))
|
|
347
|
+
suffix += 1;
|
|
348
|
+
return `${preferredKey}#${suffix}`;
|
|
349
|
+
}
|
|
350
|
+
function redactDiagnosticValue(value, context, propertyName, parent) {
|
|
351
|
+
const classificationField = isClassificationField(context, propertyName, parent);
|
|
352
|
+
if (classificationField && typeof value !== "string")
|
|
353
|
+
return value;
|
|
354
|
+
if (typeof value === "string") {
|
|
355
|
+
if (!classificationField)
|
|
356
|
+
return redactDiagnosticString(value, context);
|
|
357
|
+
const redacted = redactClassificationString(value, context);
|
|
358
|
+
if (propertyName === "code" && redacted === value && isSemanticErrorCode(value))
|
|
359
|
+
return value;
|
|
360
|
+
return redacted;
|
|
361
|
+
}
|
|
362
|
+
if (typeof value === "number" || typeof value === "bigint" || typeof value === "boolean") {
|
|
363
|
+
return context.sensitiveValues.includes(String(value)) ? REDACTED_QUERY_VALUE : value;
|
|
364
|
+
}
|
|
365
|
+
if ((typeof value !== "object" && typeof value !== "function") || value === null)
|
|
366
|
+
return value;
|
|
367
|
+
if (value instanceof URL) {
|
|
368
|
+
const redactedUrl = redactDiagnosticString(value.toString(), context);
|
|
369
|
+
if (redactedUrl === value.toString())
|
|
370
|
+
return value;
|
|
371
|
+
try {
|
|
372
|
+
return new URL(redactedUrl);
|
|
373
|
+
}
|
|
374
|
+
catch {
|
|
375
|
+
return redactedUrl;
|
|
376
|
+
}
|
|
377
|
+
}
|
|
378
|
+
if (value instanceof Headers) {
|
|
379
|
+
const redactedHeaders = new Headers();
|
|
380
|
+
for (const [key, headerValue] of value.entries()) {
|
|
381
|
+
redactedHeaders.append(key, redactDiagnosticString(headerValue, context));
|
|
382
|
+
}
|
|
383
|
+
return redactedHeaders;
|
|
384
|
+
}
|
|
385
|
+
if (value instanceof Request) {
|
|
386
|
+
const redactedUrl = redactDiagnosticString(value.url, context);
|
|
387
|
+
const redactedHeaders = redactDiagnosticValue(value.headers, context);
|
|
388
|
+
if (redactedUrl === value.url &&
|
|
389
|
+
[...value.headers].every(([key, headerValue]) => {
|
|
390
|
+
return redactedHeaders.get(key) === headerValue;
|
|
391
|
+
})) {
|
|
392
|
+
return value;
|
|
393
|
+
}
|
|
394
|
+
try {
|
|
395
|
+
const redactedRequest = new Request(redactedUrl, value);
|
|
396
|
+
for (const key of [...redactedRequest.headers.keys()])
|
|
397
|
+
redactedRequest.headers.delete(key);
|
|
398
|
+
for (const [key, headerValue] of redactedHeaders) {
|
|
399
|
+
redactedRequest.headers.append(key, headerValue);
|
|
400
|
+
}
|
|
401
|
+
return redactedRequest;
|
|
402
|
+
}
|
|
403
|
+
catch {
|
|
404
|
+
const redactedRequest = Object.create(Object.getPrototypeOf(value));
|
|
405
|
+
Object.defineProperties(redactedRequest, {
|
|
406
|
+
headers: { value: redactedHeaders, enumerable: true },
|
|
407
|
+
url: { value: redactedUrl, enumerable: true },
|
|
408
|
+
});
|
|
409
|
+
return redactedRequest;
|
|
410
|
+
}
|
|
411
|
+
}
|
|
412
|
+
if (value instanceof Response) {
|
|
413
|
+
const redactedUrl = redactDiagnosticString(value.url, context);
|
|
414
|
+
const redactedHeaders = redactDiagnosticValue(value.headers, context);
|
|
415
|
+
if (redactedUrl === value.url &&
|
|
416
|
+
[...value.headers].every(([key, headerValue]) => {
|
|
417
|
+
return redactedHeaders.get(key) === headerValue;
|
|
418
|
+
})) {
|
|
419
|
+
return value;
|
|
420
|
+
}
|
|
421
|
+
const redactedResponse = Object.create(Object.getPrototypeOf(value));
|
|
422
|
+
Object.defineProperties(redactedResponse, {
|
|
423
|
+
headers: { value: redactedHeaders, enumerable: true },
|
|
424
|
+
ok: { value: value.ok, enumerable: true },
|
|
425
|
+
redirected: { value: value.redirected, enumerable: true },
|
|
426
|
+
status: { value: value.status, enumerable: true },
|
|
427
|
+
statusText: {
|
|
428
|
+
value: redactDiagnosticString(value.statusText, context),
|
|
429
|
+
enumerable: true,
|
|
430
|
+
},
|
|
431
|
+
type: { value: value.type, enumerable: true },
|
|
432
|
+
url: { value: redactedUrl, enumerable: true },
|
|
433
|
+
});
|
|
434
|
+
return redactedResponse;
|
|
435
|
+
}
|
|
436
|
+
const previouslySeen = context.seen.get(value);
|
|
437
|
+
if (previouslySeen !== undefined)
|
|
438
|
+
return previouslySeen;
|
|
439
|
+
if (value instanceof Map) {
|
|
440
|
+
const redactedMap = new Map();
|
|
441
|
+
context.seen.set(value, redactedMap);
|
|
442
|
+
for (const [key, entryValue] of value) {
|
|
443
|
+
redactedMap.set(redactDiagnosticValue(key, context), redactDiagnosticValue(entryValue, context));
|
|
444
|
+
}
|
|
445
|
+
return redactedMap;
|
|
446
|
+
}
|
|
447
|
+
// Clone non-extensible graphs before descending so cycles encountered before
|
|
448
|
+
// a secret-bearing readonly field already point at the eventual replacement.
|
|
449
|
+
// Without this, a frozen `error.cause = error` graph could retain the original
|
|
450
|
+
// secret through the cloned node's earlier self-reference.
|
|
451
|
+
const keys = diagnosticPropertyKeys(value);
|
|
452
|
+
let target = Object.isExtensible(value) &&
|
|
453
|
+
!requiresCloneBeforeRedaction(value, keys) &&
|
|
454
|
+
!hasRedactedOwnKey(value, context)
|
|
455
|
+
? value
|
|
456
|
+
: cloneForRedaction(value);
|
|
457
|
+
context.seen.set(value, target);
|
|
458
|
+
for (const key of keys) {
|
|
459
|
+
const current = readDiagnosticProperty(value, key);
|
|
460
|
+
if (!current.ok)
|
|
461
|
+
continue;
|
|
462
|
+
const propertyName = typeof key === "string" ? key : undefined;
|
|
463
|
+
const redacted = key === "toJSON" && typeof current.value === "function"
|
|
464
|
+
? (...args) => redactDiagnosticValue(Reflect.apply(current.value, value, args), context)
|
|
465
|
+
: redactDiagnosticValue(current.value, context, propertyName, value);
|
|
466
|
+
const ownKey = Object.hasOwn(value, key);
|
|
467
|
+
const preferredKey = ownKey && typeof key === "string" ? redactedDiagnosticKey(key, context) : key;
|
|
468
|
+
let targetKey = key;
|
|
469
|
+
if (preferredKey !== key) {
|
|
470
|
+
try {
|
|
471
|
+
Reflect.deleteProperty(target, key);
|
|
472
|
+
}
|
|
473
|
+
catch {
|
|
474
|
+
// A clone is selected before traversal whenever an own key changes,
|
|
475
|
+
// so this is only a defensive fallback for exotic proxies.
|
|
476
|
+
}
|
|
477
|
+
targetKey = collisionSafeDiagnosticKey(target, preferredKey);
|
|
478
|
+
}
|
|
479
|
+
if (targetKey === key && Object.is(redacted, current.value))
|
|
480
|
+
continue;
|
|
481
|
+
if (!setDiagnosticProperty(target, targetKey, redacted)) {
|
|
482
|
+
if (target === value) {
|
|
483
|
+
target = cloneForRedaction(value);
|
|
484
|
+
context.seen.set(value, target);
|
|
485
|
+
}
|
|
486
|
+
if (!setDiagnosticProperty(target, targetKey, redacted)) {
|
|
487
|
+
// cloneForRedaction deliberately makes string-keyed own properties
|
|
488
|
+
// configurable. This is a last-resort path for inherited readonly
|
|
489
|
+
// accessors such as DOMException.message.
|
|
490
|
+
try {
|
|
491
|
+
Object.defineProperty(target, targetKey, {
|
|
492
|
+
value: redacted,
|
|
493
|
+
configurable: true,
|
|
494
|
+
enumerable: targetKey !== "message" && targetKey !== "stack" && targetKey !== "cause",
|
|
495
|
+
writable: true,
|
|
496
|
+
});
|
|
497
|
+
}
|
|
498
|
+
catch {
|
|
499
|
+
// Redaction is best-effort for inaccessible exotic properties, but
|
|
500
|
+
// it must never mask the original transport failure.
|
|
501
|
+
}
|
|
502
|
+
}
|
|
503
|
+
}
|
|
504
|
+
}
|
|
505
|
+
return target;
|
|
506
|
+
}
|
|
507
|
+
/**
|
|
508
|
+
* Redacts error text and recursively serializable diagnostic metadata.
|
|
509
|
+
* Mutable errors retain identity; readonly/frozen errors may be replaced, so
|
|
510
|
+
* callers must use the returned value.
|
|
511
|
+
*/
|
|
512
|
+
export function redactSensitiveError(error, sensitiveValues, requestUrl, redactedUrl) {
|
|
513
|
+
if (sensitiveValues.length === 0 && (!requestUrl || !redactedUrl || requestUrl === redactedUrl)) {
|
|
514
|
+
return error;
|
|
515
|
+
}
|
|
516
|
+
const classificationObjects = new Set();
|
|
517
|
+
if ((typeof error === "object" || typeof error === "function") && error !== null) {
|
|
518
|
+
classificationObjects.add(error);
|
|
519
|
+
if (isProviderError(error)) {
|
|
520
|
+
const options = readDiagnosticProperty(error, "options");
|
|
521
|
+
if (options.ok && typeof options.value === "object" && options.value !== null) {
|
|
522
|
+
classificationObjects.add(options.value);
|
|
523
|
+
}
|
|
524
|
+
}
|
|
525
|
+
}
|
|
526
|
+
return redactDiagnosticValue(error, {
|
|
527
|
+
classificationObjects,
|
|
528
|
+
sensitiveValues,
|
|
529
|
+
requestUrl,
|
|
530
|
+
redactedUrl,
|
|
531
|
+
seen: new Map(),
|
|
532
|
+
});
|
|
533
|
+
}
|
|
534
|
+
/** Redacts failures that occur before a request URL can be fully serialized. */
|
|
535
|
+
export function redactSensitiveRequestError(error, url, sensitiveParams) {
|
|
536
|
+
const normalizedSensitiveParams = normalizeSensitiveParams(sensitiveParams);
|
|
537
|
+
const structural = redactUrlQueryParams(url, Object.keys(normalizedSensitiveParams ?? {}));
|
|
538
|
+
return redactSensitiveError(error, [
|
|
539
|
+
...new Set([
|
|
540
|
+
...Object.values(normalizedSensitiveParams ?? {}).map(String),
|
|
541
|
+
...structural.sensitiveValues,
|
|
542
|
+
]),
|
|
543
|
+
], url, structural.redactedUrl);
|
|
544
|
+
}
|
|
545
|
+
function isRequestOptions(value) {
|
|
546
|
+
return value !== null && typeof value === "object" && !Array.isArray(value);
|
|
547
|
+
}
|
|
548
|
+
/** Validates an untyped proxy invocation before narrowing it to the HttpClient contract. */
|
|
549
|
+
export function parseHttpRequestInvocation(method, args) {
|
|
550
|
+
if (!isHttpRequestMethod(method) || typeof args[0] !== "string")
|
|
551
|
+
return undefined;
|
|
552
|
+
const optionsIndex = HTTP_REQUEST_METHOD_CONFIG[method].optionsIndex;
|
|
553
|
+
const options = args[optionsIndex];
|
|
554
|
+
if (options !== undefined && !isRequestOptions(options))
|
|
555
|
+
return undefined;
|
|
556
|
+
if (method === "post" || method === "put") {
|
|
557
|
+
if (args.length < 2 || args.length > 3)
|
|
558
|
+
return undefined;
|
|
559
|
+
return { method, args: args };
|
|
560
|
+
}
|
|
561
|
+
if (args.length > 2)
|
|
562
|
+
return undefined;
|
|
563
|
+
return { method, args: args };
|
|
564
|
+
}
|
|
565
|
+
/** Internal typed registry for the request-options position of HttpClient calls. */
|
|
566
|
+
export function requestOptionsFromHttpInvocation(invocation) {
|
|
567
|
+
const candidate = invocation.args[HTTP_REQUEST_METHOD_CONFIG[invocation.method].optionsIndex];
|
|
568
|
+
return isRequestOptions(candidate) ? candidate : undefined;
|
|
569
|
+
}
|
|
570
|
+
export function replaceRequestOptionsInHttpInvocation(invocation, options) {
|
|
571
|
+
invocation.args[HTTP_REQUEST_METHOD_CONFIG[invocation.method].optionsIndex] = options;
|
|
572
|
+
}
|
|
25
573
|
export function normalizeHttpRequestBody(body) {
|
|
26
574
|
if (body === undefined) {
|
|
27
575
|
return undefined;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { EnvContext, ProviderDefinition } from "../types.js";
|
|
2
|
+
/**
|
|
3
|
+
* Canonical error code for a declared-but-unprovisioned provider secret.
|
|
4
|
+
*
|
|
5
|
+
* The SDK is the single source of truth for env/secret presence validation:
|
|
6
|
+
* providers declare secrets in `defineProvider({ secrets: [...] })` and the
|
|
7
|
+
* runtime enforces presence before any handler or auth-flow code runs.
|
|
8
|
+
* Provider-local presence guards (requireServiceKey/requireApiKey style) are a
|
|
9
|
+
* deprecated antipattern — see the `sdk-owned-secret-presence` submit-check
|
|
10
|
+
* rule.
|
|
11
|
+
*/
|
|
12
|
+
export declare const MISSING_SECRET_CODE = "MISSING_SECRET";
|
|
13
|
+
/**
|
|
14
|
+
* Names of declared `required: true` secrets whose env values are unset or
|
|
15
|
+
* whitespace-only. Whitespace-only values count as missing for parity with the
|
|
16
|
+
* `.trim()` guards well-built providers used before the SDK owned this check —
|
|
17
|
+
* a blank value provisioned by a broken secret pipeline must not pass the gate.
|
|
18
|
+
*/
|
|
19
|
+
export declare function listMissingRequiredSecrets(provider: ProviderDefinition, env: EnvContext): string[];
|
|
20
|
+
/**
|
|
21
|
+
* Throws the canonical structured missing-secret error when any declared
|
|
22
|
+
* `required: true` secret is absent. All missing names are reported in a
|
|
23
|
+
* single error so operators can provision the full set in one pass instead of
|
|
24
|
+
* discovering them one deploy at a time (the 2026-07-22 unprovisioned-secret
|
|
25
|
+
* incident failure mode).
|
|
26
|
+
*/
|
|
27
|
+
export declare function assertRequiredSecretsPresent(provider: ProviderDefinition, env: EnvContext): void;
|