@apifuse/provider-sdk 2.2.0-beta.37 → 2.2.0-beta.38

package/dist/server/types.d.ts

@@ -1,7 +1,7 @@
 import { z } from "zod";
 export declare const ConnectionModeSchema: z.ZodEnum<{
-    none: "none";
     credentials: "credentials";
+    none: "none";
     oauth2: "oauth2";
     "platform-managed": "platform-managed";
     oauth2_proxied: "oauth2_proxied";
@@ -9,8 +9,8 @@ export declare const ConnectionModeSchema: z.ZodEnum<{
 export declare const OperationConnectionSchema: z.ZodObject<{
     id: z.ZodString;
     mode: z.ZodEnum<{
-        none: "none";
         credentials: "credentials";
+        none: "none";
         oauth2: "oauth2";
         "platform-managed": "platform-managed";
         oauth2_proxied: "oauth2_proxied";
@@ -27,8 +27,8 @@ export declare const OperationRequestSchema: z.ZodObject<{
     connection: z.ZodOptional<z.ZodObject<{
         id: z.ZodString;
         mode: z.ZodEnum<{
-            none: "none";
             credentials: "credentials";
+            none: "none";
             oauth2: "oauth2";
             "platform-managed": "platform-managed";
             oauth2_proxied: "oauth2_proxied";
@@ -118,8 +118,8 @@ export declare const AuthFlowRequestSchema: z.ZodObject<{
     connection: z.ZodOptional<z.ZodObject<{
         id: z.ZodString;
         mode: z.ZodEnum<{
-            none: "none";
             credentials: "credentials";
+            none: "none";
             oauth2: "oauth2";
             "platform-managed": "platform-managed";
             oauth2_proxied: "oauth2_proxied";

package/dist/types.d.ts

@@ -1,4 +1,5 @@
 import type ms from "ms";
+import type { HealthScenario } from "./health-scenario.js";
 import type { SerializedCookieJar } from "tough-cookie";
 import type { infer as ZodInfer, ZodType } from "zod";
 /** Minimal Standard Schema v1 shape accepted by provider operations. */
@@ -549,7 +550,7 @@ export interface HealthJourneyRunResult {
     label?: string;
     metadata?: Record<string, unknown>;
 }
-export interface HealthJourneyDefinition {
+interface HealthJourneyDefinitionBase {
     id: string;
     title?: string;
     description?: string;
@@ -561,14 +562,14 @@ export interface HealthJourneyDefinition {
     requiredSecrets?: readonly string[];
     manualTrigger?: HealthJourneyManualTriggerPolicy;
     steps: readonly [HealthJourneyStep, ...HealthJourneyStep[]];
-    /**
-     * Required: a journey always declares `coversOperations`, and the health
-     * monitor reports a run-less journey as `journey_run_missing`. Declaration
-     * validation rejects a missing `run` (`health-journey-executable`), so this
-     * is typed required to fail at compile time rather than at boot.
-     */
-    run: (ctx: HealthJourneyRunContext) => Promise<HealthJourneyRunResult | undefined>;
 }
+export type HealthJourneyDefinition = HealthJourneyDefinitionBase & ({
+    run: (ctx: HealthJourneyRunContext) => Promise<HealthJourneyRunResult | undefined>;
+    scenario?: never;
+} | {
+    scenario: HealthScenario;
+    run?: never;
+});
 /**
  * Health-check authoring surface owned by `@apifuse/provider-sdk`.
  *
@@ -2051,3 +2052,4 @@ export interface ProviderDefinition {
     healthProbe?: ProviderHealthProbeConfig;
     healthJourneys?: readonly HealthJourneyDefinition[];
 }
+export {};

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "2.2.0-beta.37",
+	"version": "2.2.0-beta.38",
 	"name": "@apifuse/provider-sdk",
 	"private": false,
 	"type": "module",

package/src/declaration-validation.ts

@@ -1,5 +1,6 @@
 import { describeSchema } from "./contract-serialization.js";
 import { ProviderError } from "./errors.js";
+import { HealthScenarioSchema } from "./health-scenario.js";
 import type {
 	HealthJourneyDefinition,
 	ProviderDefinition,
@@ -12,6 +13,8 @@ export const DECLARATION_INVALID_CODE = "DECLARATION_INVALID";
 export const DECLARATION_RULE_IDS = {
 	challengeShape: "credentials-challenge-shape",
 	journeyExecutable: "health-journey-executable",
+	journeyRunScenarioExclusive: "health-journey-run-scenario-exclusive",
+	journeyScenarioValid: "health-journey-scenario-valid",
 	schemaSerializable: "operation-schema-serializable",
 	proxyExplicitPolicy: "proxy-explicit-policy",
 	proxyVendorExclusive: "proxy-vendor-fields-exclusive",
@@ -62,15 +65,39 @@ function validateHealthDeclaration(
 ): void {
 	for (const [index, journey] of (provider.healthJourneys ?? []).entries()) {
 		if (!journey || typeof journey !== "object") continue;
-		if (typeof journey.run !== "function") {
+		const hasRun = journey.run !== undefined;
+		const hasScenario = journey.scenario !== undefined;
+		if (hasRun && hasScenario) {
+			const journeyPath = healthJourneyPath(journey, index);
+			violations.push({
+				ruleId: DECLARATION_RULE_IDS.journeyRunScenarioExclusive,
+				path: journeyPath,
+				message: "A health journey must declare exactly one of run or scenario, not both.",
+				fix: `Remove either ${journeyPath}.run or ${journeyPath}.scenario.`,
+			});
+		}
+		if (!hasRun && !hasScenario) {
 			const journeyPath = healthJourneyPath(journey, index);
 			violations.push({
 				ruleId: DECLARATION_RULE_IDS.journeyExecutable,
 				path: `${journeyPath}.run`,
-				message: "coversOperations cannot provide health coverage without executable run logic.",
-				fix: `Add an async run(ctx) implementation to ${journeyPath}.`,
+				message:
+					"coversOperations cannot provide health coverage without run or a declarative scenario.",
+				fix: `Add an async run(ctx) implementation or a valid scenario to ${journeyPath}.`,
 			});
 		}
+		if (hasScenario) {
+			const parsed = HealthScenarioSchema.safeParse(journey.scenario);
+			if (!parsed.success) {
+				const journeyPath = healthJourneyPath(journey, index);
+				violations.push({
+					ruleId: DECLARATION_RULE_IDS.journeyScenarioValid,
+					path: `${journeyPath}.scenario`,
+					message: "scenario must conform to HealthScenario.",
+					fix: "Build the scenario with defineHealthScenario().",
+				});
+			}
+		}
 	}
 
 	// NOTE: healthCheck.cases[].enabled is intentionally NOT validated here.

package/src/define.ts

@@ -2132,6 +2132,7 @@ const HEALTH_JOURNEY_FIELDS = new Set([
 	"manualTrigger",
 	"steps",
 	"run",
+	"scenario",
 ]);
 const HEALTH_JOURNEY_SCHEDULE_FIELDS = new Set(["kind", "interval", "jitter", "randomize"]);
 const HEALTH_JOURNEY_STEP_FIELDS = new Set([
@@ -2667,6 +2668,14 @@ function validateHealthJourneys(
 		}
 		if (journey.manualTrigger !== undefined)
 			validateHealthJourneyManualTrigger(providerId, journey.id, journey.manualTrigger);
+		if (journey.scenario !== undefined && journey.smsMatchers !== undefined)
+			throw new ValidationError(
+				`Provider "${providerId}" healthJourneys.${journey.id}.smsMatchers is not allowed on declarative scenarios.`,
+			);
+		if (journey.scenario !== undefined && journey.requiredSecrets !== undefined)
+			throw new ValidationError(
+				`Provider "${providerId}" healthJourneys.${journey.id}.requiredSecrets is not allowed on declarative scenarios.`,
+			);
 		if (journey.timeout !== undefined)
 			assertIsoDuration(
 				journey.timeout,