@apifuse/provider-sdk 2.2.0-beta.1 → 2.2.0-beta.10

package/dist/types.d.ts

@@ -650,7 +650,25 @@ export type ConnectionMode = AuthMode;
 export type ProviderReviewed = "first-party" | "community" | "staging";
 export type ProviderAccessVisibility = "public" | "early_access";
 export type ProviderProxyMode = "disabled" | "optional" | "required";
-export type ProviderProxyProvider = "smartproxy" | "decodo" | "custom";
+/**
+ * Proxy egress vendors. These are FOUR DISTINCT services — do not conflate them
+ * (a common mistake because the names collide with a well-known rebrand):
+ *
+ * - `smartproxy` — **api.smartproxy.org**, a residential proxy with an IP
+ *   *extraction/allocation* API (app_key → a pool of raw `ip:port` CONNECT
+ *   endpoints). This is our own vendor. It is NOT the company formerly named
+ *   "Smartproxy". Credentials: `APIFUSE__PROXY__SMARTPROXY_APP_KEY`.
+ * - `nodemaven` — **gate.nodemaven.com**, a *gateway* proxy with static
+ *   credentials; geo/session encoded in the username, no allocation API.
+ * - `decodo` — **decodo.com**, the *gateway* proxy that was named "Smartproxy"
+ *   (smartproxy.com) before its 2025 rebrand to Decodo. Sticky sessions via
+ *   username params. A different company from `smartproxy` above.
+ *   **@deprecated** — unused; no managed adapter. Use `smartproxy`/`nodemaven`,
+ *   or the `APIFUSE__PROXY__URL` bring-your-own escape hatch.
+ * - `custom` — **@deprecated** bring-your-own static proxy URL marker. The
+ *   `APIFUSE__PROXY__URL` env still works without declaring this value.
+ */
+export type ProviderProxyProvider = "smartproxy" | "nodemaven" | "decodo" | "custom";
 export type ProviderProxySessionAffinity = "request" | "operation" | "auth-flow" | "connection";
 export interface ProviderProxyPolicy {
     /**
@@ -658,7 +676,18 @@ export interface ProviderProxyPolicy {
      * certificate verification, and vendor allocator endpoints are SDK-owned.
      */
     mode: ProviderProxyMode;
+    /**
+     * @deprecated Use `providers: [...]` to declare an ordered vendor fallback
+     * chain. A single-element `providers` list is equivalent to this field.
+     */
     provider?: ProviderProxyProvider;
+    /**
+     * Ordered proxy-vendor fallback chain. The SDK tries each vendor in order and
+     * fails over to the next when a vendor lacks credentials or its allocation /
+     * transport is exhausted. When omitted, `provider` (or the platform default)
+     * is used as a single-vendor chain.
+     */
+    providers?: ProviderProxyProvider[];
     geo?: {
         /** ISO 3166-1 alpha-2 country code, for example KR or US. */
         country?: Iso3166Alpha2CountryCode;
@@ -1418,6 +1447,19 @@ export interface OperationContractMetadata {
     deprecation?: OperationDeprecationMetadata;
 }
 export interface OperationDefinition<TInput extends SchemaLike = SchemaLike, TOutput extends SchemaLike = SchemaLike> {
+    /**
+     * Short English display title for the operation. The SDK passes it through
+     * verbatim; the APIFuse registry derives the operation's en locale title
+     * baseline from it (`docs.titleKey` remains available as an explicit key
+     * override).
+     */
+    title?: string;
+    /**
+     * Raw English operation description. The SDK passes it through verbatim;
+     * keyed descriptions via `descriptionKey` remain the primary flow, and
+     * provider lint rules for raw prose descriptions still apply.
+     */
+    description?: string;
     descriptionKey?: ProviderLocaleKeyInput;
     docs?: OperationDocMeta;
     whenToUseKeys?: readonly ProviderLocaleKeyInput[];
@@ -1447,10 +1489,54 @@ export interface OperationDefinition<TInput extends SchemaLike = SchemaLike, TOu
     healthCheck?: HealthCheckSuite<InferSchemaOutput<TInput>, InferSchemaOutput<TOutput>>;
     healthCheckUnsupported?: HealthCheckUnsupported;
 }
+/**
+ * Author-declared deployment overrides accepted as the optional top-level
+ * `deployment` key on `defineProvider()`.
+ *
+ * The SDK passes this object through VERBATIM onto the returned provider
+ * definition — it is typed here but deliberately not deep-validated: the
+ * APIFuse registry builder owns deployment validation and resolves omitted
+ * fields against the runtime deployment profiles. The shape mirrors the
+ * registry's `ProviderDeploymentOverrides` contract; every field is
+ * optional. Note that the deployment `runtime` axis
+ * (`shared`/`dedicated`/`browser`) is distinct from the provider execution
+ * `runtime` (`standard`/`shared`/`browser`).
+ */
+export interface ProviderDeploymentOverrides {
+    runtime?: "shared" | "dedicated" | "browser";
+    language?: "typescript" | "python";
+    replicas?: number;
+    hpa?: {
+        enabled: boolean;
+        minReplicas?: number;
+        maxReplicas?: number;
+        targetCPUUtilizationPercentage?: number;
+    };
+    resources?: {
+        cpu: string;
+        memory: string;
+    };
+    cache?: {
+        redis?: {
+            enabled: boolean;
+            url?: string;
+        };
+    };
+    network?: {
+        additionalTcpPorts?: number[];
+    };
+    buildContext?: string;
+}
 export interface ProviderDefinition {
     id: string;
     version: string;
     runtime: "standard" | "shared" | "browser";
+    /**
+     * Optional deployment overrides, passed through verbatim from
+     * `defineProvider({ deployment })`. Validation and profile resolution are
+     * owned by the APIFuse registry builder, not the SDK.
+     */
+    deployment?: ProviderDeploymentOverrides;
     allowedHosts?: string[];
     stealth?: {
         profile: string;

package/dist/user-input.d.ts

@@ -0,0 +1,30 @@
+export declare const NEEDS_INPUT_STATUS: "needs_input";
+export interface ProviderSelectionOption {
+    readonly selection_value: string;
+    readonly label: string;
+    readonly [extra: string]: unknown;
+}
+export interface ProviderRequiredSelection {
+    readonly selection_key: string;
+    readonly label: string;
+    readonly required: boolean;
+    readonly selection_type?: string;
+    readonly valid_options: readonly ProviderSelectionOption[];
+    readonly [extra: string]: unknown;
+}
+export interface ProviderSelectedOption {
+    readonly selection_key: string;
+    readonly selection_value: string;
+    /** Free-text answer for text-kind selections. */
+    readonly text?: string;
+    /** Quantity for quantity-kind selections. */
+    readonly quantity?: number;
+}
+export interface ProviderNeedsInputPayload {
+    readonly status: typeof NEEDS_INPUT_STATUS;
+    readonly required_selections: readonly ProviderRequiredSelection[];
+    readonly selected_options?: readonly ProviderSelectedOption[];
+    /** Provider-specific fresh state token(s), e.g. `reservation_state`. */
+    readonly [extra: string]: unknown;
+}
+export declare function isProviderNeedsInputPayload(value: unknown): value is ProviderNeedsInputPayload;

package/dist/user-input.js

@@ -0,0 +1,66 @@
+// Official cross-provider contract for user-input round-trips.
+//
+// Doctrine (born from the 2026-07-20 CatchTable reserve incident): an
+// operation MUST NOT dead-end on a problem the end user can resolve by
+// choosing among live options. Instead of throwing, the provider returns a
+// SUCCESSFUL payload with `status: "needs_input"` that carries everything a
+// consumer-side agent needs to relay the choice verbatim and retry:
+//
+// - `required_selections`: only the still-pending questions, each with
+//   human-readable `label`s and `valid_options` the agent shows the user
+//   as-is. The agent never chooses on the user's behalf.
+// - `selected_options`: selections already settled, echoed so the follow-up
+//   call keeps them without the agent reconstructing anything.
+// - a fresh provider-specific state token (e.g. `reservation_state`) minted
+//   at response time, so the retry never races an expired token.
+//
+// Keeping this success-shaped (instead of error `details`) is deliberate:
+// consumer error-shaping layers routinely strip error metadata, and a model
+// that only sees "error" narrates failure to the user. Complex recovery
+// logic belongs to the system, not the model.
+//
+// Deliberately ABSENT: retry templates, next-action routing, or any other
+// agent choreography. Provider payloads carry upstream-backed data only; how
+// to phrase the ask and shape the retry call is the consumer's contract
+// (apifuse#1030). The retry is fully determined by data: copy the echoed
+// selected_options, add the user's new answers, resend with the fresh state.
+export const NEEDS_INPUT_STATUS = "needs_input";
+function isRecord(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function isSelectionOption(value) {
+    return (isRecord(value) &&
+        typeof value.selection_value === "string" &&
+        typeof value.label === "string");
+}
+function isRequiredSelection(value) {
+    return (isRecord(value) &&
+        typeof value.selection_key === "string" &&
+        typeof value.label === "string" &&
+        typeof value.required === "boolean" &&
+        Array.isArray(value.valid_options) &&
+        value.valid_options.every(isSelectionOption));
+}
+function isSelectedOption(value) {
+    return (isRecord(value) &&
+        typeof value.selection_key === "string" &&
+        typeof value.selection_value === "string");
+}
+export function isProviderNeedsInputPayload(value) {
+    if (!isRecord(value)) {
+        return false;
+    }
+    if (value.status !== NEEDS_INPUT_STATUS ||
+        !Array.isArray(value.required_selections) ||
+        !value.required_selections.every(isRequiredSelection)) {
+        return false;
+    }
+    // A needs_input with nothing to ask AND nothing settled to echo is a
+    // no-op dead end — reject it so providers cannot ship it accidentally.
+    if (value.required_selections.length > 0) {
+        return true;
+    }
+    return (Array.isArray(value.selected_options) &&
+        value.selected_options.length > 0 &&
+        value.selected_options.every(isSelectedOption));
+}

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "2.2.0-beta.1",
+	"version": "2.2.0-beta.10",
 	"name": "@apifuse/provider-sdk",
 	"private": false,
 	"type": "module",
@@ -75,24 +75,28 @@
 	"scripts": {
 		"lint": "biome lint .",
 		"lint:fix": "biome lint --write",
+		"lint:deprecated": "bun run scripts/lint-deprecated-usage.ts",
 		"format": "biome format --write",
-		"type-check": "tsgo --noEmit",
+		"type-check": "tsc --noEmit",
 		"test": "bun test",
-		"check": "bun run lint && bun run type-check && bun run build",
+		"check": "bun run lint && bun run type-check && bun run lint:deprecated && bun run build",
 		"pack:check": "bun run build && bun bin/apifuse-pack-check.ts",
 		"pack:smoke": "bun run build && bun bin/apifuse-pack-smoke.ts",
+		"pack:types": "bun run build && bun bin/apifuse-pack-types.ts",
 		"release:guard": "bun scripts/guard-release-pr.ts",
 		"format:check": "biome format .",
-		"build": "tsgo -p tsconfig.build.json && rm -rf dist/cli/templates && cp -R src/cli/templates dist/cli/templates && rm -rf dist/auth-turn/fixtures && cp -R src/auth-turn/fixtures dist/auth-turn/fixtures && cp src/auth-turn/auth-turn.v1.schema.json dist/auth-turn/auth-turn.v1.schema.json"
+		"build": "tsc -p tsconfig.build.json && rm -rf dist/cli/templates && cp -R src/cli/templates dist/cli/templates && rm -rf dist/auth-turn/fixtures && cp -R src/auth-turn/fixtures dist/auth-turn/fixtures && cp src/auth-turn/auth-turn.v1.schema.json dist/auth-turn/auth-turn.v1.schema.json"
 	},
 	"devDependencies": {
+		"@arethetypeswrong/cli": "^0.18.5",
 		"@biomejs/biome": "^2.5.0",
 		"@types/bun": "latest",
 		"@types/node": "^25.9.3",
-		"@typescript/native-preview": "7.0.0-dev.20260419.1"
+		"typescript": "6.0.3"
 	},
 	"dependencies": {
 		"@clack/prompts": "^1.5.1",
+		"@rgrove/parse-xml": "4.2.2",
 		"@types/ms": "^2.1.0",
 		"acorn": "^8.17.0",
 		"ajv": "^8.17",

package/src/auth-turn/index.ts

@@ -1,4 +1,4 @@
-import type { AuthTurn } from "../types";
+import type { AuthTurn } from "../types.js";
 
 export type { AuthTurn };
 

package/src/auth.ts

@@ -1,4 +1,4 @@
-import { AuthError, ProviderError } from "./errors";
+import { AuthError, ProviderError } from "./errors.js";
 import type {
 	AuthAbortData,
 	AuthConfig,
@@ -10,7 +10,7 @@ import type {
 	CredentialDeclaration,
 	FlowContext,
 	ProviderLocaleKeyInput,
-} from "./types";
+} from "./types.js";
 
 const CREDENTIALS_AUTH_CHALLENGE_CONTEXT_KEY = "__credentialsAuthChallenge";
 const DEFAULT_COMPLETE_TURN_ID = "auth.complete";
@@ -33,11 +33,7 @@ function isSensitiveAuthDataKey(key: string): boolean {
 	return SENSITIVE_ABORT_DATA_KEY_PATTERN.test(normalizedAuthDataKey(key));
 }
 
-export type CredentialsAuthFieldType =
-	| "string"
-	| "email"
-	| "password"
-	| "otp";
+export type CredentialsAuthFieldType = "string" | "email" | "password" | "otp";
 
 export interface CredentialsAuthField {
 	type?: CredentialsAuthFieldType;
@@ -138,10 +134,9 @@ function abortData(options: {
 	};
 }
 
-export function createAuthFlowHelpers(options: {
-	readonly signal?: AbortSignal;
-	readonly deadline?: string;
-} = {}): AuthFlowTerminalContext {
+export function createAuthFlowHelpers(
+	options: { readonly signal?: AbortSignal; readonly deadline?: string } = {},
+): AuthFlowTerminalContext {
 	return {
 		...(options.signal ? { signal: options.signal } : {}),
 		...(options.deadline ? { deadline: options.deadline } : {}),
@@ -156,16 +151,7 @@ export function createAuthFlowHelpers(options: {
 				},
 			};
 		},
-		abort({
-			code,
-			message,
-			retry,
-			actionHint,
-			fieldErrors,
-			data,
-			turnId,
-			expiresAt,
-		}) {
+		abort({ code, message, retry, actionHint, fieldErrors, data, turnId, expiresAt }) {
 			return {
 				kind: "abort",
 				...authTurnBase({ turnId, defaultTurnId: DEFAULT_ABORT_TURN_ID, expiresAt }),
@@ -190,8 +176,7 @@ export function createAuthFlowHelpers(options: {
 				...(options.hintKey ? { hintKey: options.hintKey } : {}),
 				...(options.timing ? { timing: options.timing } : {}),
 				...(options.data ? { data: options.data } : {}),
-				expectedInput:
-					options.expectedInput ?? expectedInputFromFields(options.fields ?? {}),
+				expectedInput: options.expectedInput ?? expectedInputFromFields(options.fields ?? {}),
 			};
 		},
 		nextPoll(options = {}) {
@@ -223,9 +208,7 @@ export class AuthAbortError extends AuthError {
 	}
 }
 
-export interface CredentialsAuthCompleteResult<
-	TCredentialKeys extends readonly string[],
-> {
+export interface CredentialsAuthCompleteResult<TCredentialKeys extends readonly string[]> {
 	credential: CredentialsAuthCredential<TCredentialKeys>;
 	/** Additional non-credential auth-flow data to return alongside credential. */
 	data?: Record<string, unknown>;
@@ -247,9 +230,7 @@ export interface CredentialsAuthChallengeRequest<TChallengeId extends string = s
 export type CredentialsAuthLoginResult<
 	TCredentialKeys extends readonly string[],
 	TChallengeId extends string = string,
-> =
-	| CredentialsAuthCompleteResult<TCredentialKeys>
-	| CredentialsAuthChallengeRequest<TChallengeId>;
+> = CredentialsAuthCompleteResult<TCredentialKeys> | CredentialsAuthChallengeRequest<TChallengeId>;
 
 export interface CredentialsAuthChallengeDefinition<
 	TFields extends CredentialsAuthFields,
@@ -351,12 +332,8 @@ function expectedInputFromFields(fields: CredentialsAuthFields): Record<string,
 					...(field.type === "password" ? { format: "password" } : {}),
 					...(field.type === "otp" ? { format: "otp" } : {}),
 					...(field.labelKey ? { nameKey: field.labelKey } : {}),
-					...(field.descriptionKey
-						? { descriptionKey: field.descriptionKey }
-						: {}),
-					...(field.placeholderKey
-						? { placeholderKey: field.placeholderKey }
-						: {}),
+					...(field.descriptionKey ? { descriptionKey: field.descriptionKey } : {}),
+					...(field.placeholderKey ? { placeholderKey: field.placeholderKey } : {}),
 					...(field.sensitive || field.type === "password" || field.type === "otp"
 						? { sensitive: true }
 						: {}),
@@ -437,10 +414,7 @@ function getPendingChallenge(ctx: FlowContext): PendingCredentialsAuthChallenge
 	};
 }
 
-function setPendingChallenge(
-	ctx: FlowContext,
-	challenge: PendingCredentialsAuthChallenge,
-): void {
+function setPendingChallenge(ctx: FlowContext, challenge: PendingCredentialsAuthChallenge): void {
 	ctx.context.set(CREDENTIALS_AUTH_CHALLENGE_CONTEXT_KEY, challenge);
 }
 
@@ -473,9 +447,7 @@ function retryTurn(
 		turnId: retryTurnId,
 		expectedInput,
 		data: {
-			fieldErrors: Object.fromEntries(
-				missing.map((name) => [name, "Required"]),
-			),
+			fieldErrors: Object.fromEntries(missing.map((name) => [name, "Required"])),
 			fieldErrorKeys: Object.fromEntries(
 				missing.map((name) => [name, "auth.credentials.fieldRequired"]),
 			),
@@ -499,18 +471,12 @@ function completeTurn<TCredentialKeys extends readonly string[]>(
 		typeof result.credential !== "object" ||
 		Array.isArray(result.credential)
 	) {
-		throw new ProviderError(
-			"Credentials auth login completed without a credential object",
-			{
-				code: "credentials_auth_missing_credential",
-				fix: "Return { credential: { ... } } from defineCredentialsAuth handlers. Gateway persists only auth.flow complete data.credential into the connection.",
-			},
-		);
+		throw new ProviderError("Credentials auth login completed without a credential object", {
+			code: "credentials_auth_missing_credential",
+			fix: "Return { credential: { ... } } from defineCredentialsAuth handlers. Gateway persists only auth.flow complete data.credential into the connection.",
+		});
 	}
-	assertCredentialKeys(
-		credentialKeys,
-		result.credential as Record<string, unknown>,
-	);
+	assertCredentialKeys(credentialKeys, result.credential as Record<string, unknown>);
 	return {
 		kind: "complete",
 		turnId: result.turnId ?? defaultTurnId,
@@ -523,24 +489,18 @@ function completeTurn<TCredentialKeys extends readonly string[]>(
 }
 
 function challengeTurn(
-	definition: CredentialsAuthChallengeDefinition<
-		CredentialsAuthFields,
-		readonly string[],
-		string
-	>,
+	definition: CredentialsAuthChallengeDefinition<CredentialsAuthFields, readonly string[], string>,
 	request: CredentialsAuthChallengeRequest<string>,
 ): AuthTurn {
-	const expectedInput = definition.fields
-		? expectedInputFromFields(definition.fields)
-		: undefined;
+	const expectedInput = definition.fields ? expectedInputFromFields(definition.fields) : undefined;
 	return {
 		kind: expectedInput ? "form" : "pending",
 		turnId: request.turnId ?? definition.turnId ?? `credentials.${request.challengeId}`,
 		...(request.expiresAt ? { expiresAt: request.expiresAt } : {}),
-		...(request.hintKey ?? definition.hintKey
+		...((request.hintKey ?? definition.hintKey)
 			? { hintKey: request.hintKey ?? definition.hintKey }
 			: {}),
-		...(request.timing ?? definition.timing
+		...((request.timing ?? definition.timing)
 			? { timing: request.timing ?? definition.timing }
 			: {}),
 		...(expectedInput ? { expectedInput } : {}),
@@ -630,13 +590,7 @@ async function continuePendingChallenge<TCredentialKeys extends readonly string[
 		normalizeInput(definition.fields, rawInput),
 		pending.state,
 	);
-	return await resolveAuthResult(
-		ctx,
-		credentialKeys,
-		challenges,
-		result,
-		completeTurnId,
-	);
+	return await resolveAuthResult(ctx, credentialKeys, challenges, result, completeTurnId);
 }
 
 async function pollPendingChallenge<TCredentialKeys extends readonly string[]>(
@@ -669,13 +623,7 @@ async function pollPendingChallenge<TCredentialKeys extends readonly string[]>(
 				`credentials.${pending.challengeId}.pending`,
 		};
 	}
-	return await resolveAuthResult(
-		ctx,
-		credentialKeys,
-		challenges,
-		result,
-		completeTurnId,
-	);
+	return await resolveAuthResult(ctx, credentialKeys, challenges, result, completeTurnId);
 }
 
 export function defineCredentialsAuth<
@@ -697,7 +645,7 @@ export function defineCredentialsAuth<
 ): DefinedCredentialsAuth {
 	if (Object.keys(options.fields).length === 0) {
 		throw new ProviderError("defineCredentialsAuth requires at least one field", {
-			fix: "Pass fields such as { email: { type: \"email\" }, password: { type: \"password\" } }.",
+			fix: 'Pass fields such as { email: { type: "email" }, password: { type: "password" } }.',
 		});
 	}
 
@@ -737,10 +685,7 @@ export function defineCredentialsAuth<
 						return retryTurn(expectedInput, missing, retryTurnId);
 					}
 
-					const result = await options.login(
-						ctx,
-						normalizeInput(options.fields, rawInput),
-					);
+					const result = await options.login(ctx, normalizeInput(options.fields, rawInput));
 					return await resolveAuthResult(
 						ctx,
 						options.credentialKeys,
@@ -776,10 +721,7 @@ export function defineCredentialsAuth<
 		},
 		context: {
 			keys: Array.from(
-				new Set([
-					CREDENTIALS_AUTH_CHALLENGE_CONTEXT_KEY,
-					...(options.contextKeys ?? []),
-				]),
+				new Set([CREDENTIALS_AUTH_CHALLENGE_CONTEXT_KEY, ...(options.contextKeys ?? [])]),
 			),
 		},
 	};