@ondc/automation-mock-runner 1.3.20 → 1.3.22

package/dist/lib/MockRunner.d.ts

@@ -40,6 +40,7 @@ export declare class MockRunner {
                 inputs: {
                     id?: string | undefined;
                     jsonSchema?: any;
+                    sampleData?: any;
                 };
                 formHtml?: string | undefined;
             };

package/dist/lib/MockRunner.js

@@ -290,10 +290,7 @@ class MockRunner {
         }
     }
     getDefaultStep(api, actionId, formType) {
-        if (formType === "html_form") {
-            throw new Error("HTML form generation is not implemented yet");
-        }
-        if (formType === "dynamic_form") {
+        if (formType === "dynamic_form" || formType === "html_form") {
             return {
                 api: api,
                 action_id: actionId,
@@ -376,6 +373,13 @@ class MockRunner {
                         required: ["email", "password"],
                         additionalProperties: false,
                     },
+                    sampleData: {
+                        email: "john.doe@example.com",
+                        age: 28,
+                        password: "SecurePass1",
+                        website: "https://example.com",
+                        country: "US",
+                    },
                 },
             },
         };

package/dist/lib/configHelper.d.ts

@@ -67,6 +67,7 @@ export declare function generatePlaygroundConfigFromFlowConfig(payloads: Payload
             inputs: {
                 id?: string | undefined;
                 jsonSchema?: any;
+                sampleData?: any;
             };
             formHtml?: string | undefined;
         };
@@ -81,4 +82,5 @@ export declare function generatePlaygroundConfigFromFlowConfig(payloads: Payload
     validationLib: string;
     helperLib: string;
 }>;
+export declare function validateConfigForDeployment(config: MockPlaygroundConfigType): void;
 export {};

package/dist/lib/configHelper.js

@@ -5,9 +5,11 @@ exports.convertToFlowConfig = convertToFlowConfig;
 exports.createOptimizedMockConfig = createOptimizedMockConfig;
 exports.getMinifiedCode = getMinifiedCode;
 exports.generatePlaygroundConfigFromFlowConfig = generatePlaygroundConfigFromFlowConfig;
+exports.validateConfigForDeployment = validateConfigForDeployment;
 const MockRunner_1 = require("./MockRunner");
 const uuid_1 = require("uuid");
 const terser_1 = require("terser");
+const validateConfig_1 = require("./utils/validateConfig");
 function createInitialMockConfig(domain, version, flowId) {
     return {
         meta: {
@@ -197,7 +199,6 @@ async function getMinifiedCode(base64Code) {
  */
 async function generatePlaygroundConfigFromFlowConfig(payloads, flowConfig) {
     flowConfig = JSON.parse(JSON.stringify(flowConfig));
-    flowConfig.sequence = flowConfig.sequence.filter((step) => step.type !== "HTML_FORM" && step.type !== "DYNAMIC_FORM");
     payloads = payloads.sort((a, b) => new Date(a.context.timestamp).getTime() -
         new Date(b.context.timestamp).getTime());
     const domain = payloads[0].context.domain;
@@ -206,33 +207,37 @@ async function generatePlaygroundConfigFromFlowConfig(payloads, flowConfig) {
     const mockRunner = new MockRunner_1.MockRunner(config);
     let index = 0;
     for (const step of flowConfig.sequence) {
-        if (step.type === "HTML_FORM" ||
+        const isFormStep = step.type === "HTML_FORM" ||
             step.type === "DYNAMIC_FORM" ||
-            step.type === "FORM") {
-            continue;
+            step.type === "FORM";
+        let stepConfig;
+        if (isFormStep) {
+            // HTML_FORM is not yet fully implemented — fall back to dynamic_form default
+            stepConfig = mockRunner.getDefaultStep(step.type, step.key, "dynamic_form");
         }
-        let stepPayload = payloads.findIndex((p) => p.context.action === step.type);
-        const payload = stepPayload === -1 ? {} : payloads[stepPayload];
-        if (stepPayload !== -1) {
-            payloads.splice(stepPayload, 1); // remove used payload
-        }
-        const stepConfig = mockRunner.getDefaultStep(step.type, step.key);
-        if (index === 0) {
-            stepConfig.mock.generate = MockRunner_1.MockRunner.encodeBase64(`async function generate(defaultPayload, sessionData) {
+        else {
+            stepConfig = mockRunner.getDefaultStep(step.type, step.key);
+            if (index === 0) {
+                stepConfig.mock.generate = MockRunner_1.MockRunner.encodeBase64(`async function generate(defaultPayload, sessionData) {
   	setCityFromInputs(defaultPayload, sessionData.user_inputs);
   return defaultPayload;
   }`);
-            stepConfig.mock.inputs = cityInputs;
-        }
-        else {
-            stepConfig.mock.inputs = {};
+                stepConfig.mock.inputs = cityInputs;
+            }
+            else {
+                stepConfig.mock.inputs = {};
+            }
+            const stepPayloadIndex = payloads.findIndex((p) => p.context.action === step.type);
+            if (stepPayloadIndex !== -1) {
+                stepConfig.mock.defaultPayload = payloads[stepPayloadIndex];
+                payloads.splice(stepPayloadIndex, 1); // remove used payload
+            }
+            index++;
         }
-        stepConfig.mock.defaultPayload = payload;
         const findResponseFor = flowConfig.sequence.find((s) => s.pair === step.key);
         stepConfig.responseFor = findResponseFor ? findResponseFor.key : null;
         stepConfig.unsolicited = step.unsolicited;
         config.steps.push(stepConfig);
-        index++;
     }
     return config;
 }
@@ -250,3 +255,6 @@ const cityInputs = {
         required: ["city_code"],
     },
 };
+function validateConfigForDeployment(config) {
+    (0, validateConfig_1.validateGoodConfig)(config);
+}

package/dist/lib/types/mock-config.d.ts

@@ -26,6 +26,7 @@ export declare const MockConfigSchema: z.ZodObject<{
     inputs: z.ZodObject<{
         id: z.ZodOptional<z.ZodString>;
         jsonSchema: z.ZodOptional<z.ZodAny>;
+        sampleData: z.ZodOptional<z.ZodAny>;
     }, z.core.$strip>;
     formHtml: z.ZodOptional<z.ZodBase64>;
 }, z.core.$strip>;
@@ -49,6 +50,7 @@ export declare const PlaygroundActionStepSchema: z.ZodObject<{
         inputs: z.ZodObject<{
             id: z.ZodOptional<z.ZodString>;
             jsonSchema: z.ZodOptional<z.ZodAny>;
+            sampleData: z.ZodOptional<z.ZodAny>;
         }, z.core.$strip>;
         formHtml: z.ZodOptional<z.ZodBase64>;
     }, z.core.$strip>;
@@ -94,6 +96,7 @@ export declare const MockPlaygroundConfigSchema: z.ZodObject<{
             inputs: z.ZodObject<{
                 id: z.ZodOptional<z.ZodString>;
                 jsonSchema: z.ZodOptional<z.ZodAny>;
+                sampleData: z.ZodOptional<z.ZodAny>;
             }, z.core.$strip>;
             formHtml: z.ZodOptional<z.ZodBase64>;
         }, z.core.$strip>;

package/dist/lib/types/mock-config.js

@@ -27,6 +27,7 @@ exports.MockConfigSchema = zod_1.z.object({
     inputs: zod_1.z.object({
         id: zod_1.z.string().min(1, "Input ID is required").optional(),
         jsonSchema: zod_1.z.any().optional(),
+        sampleData: zod_1.z.any().optional(),
     }),
     formHtml: zod_1.z.base64().optional(),
 });

package/dist/lib/utils/validateConfig.d.ts

@@ -4,3 +4,4 @@ export declare function validateConfigWithErrors(config: MockPlaygroundConfigTyp
     success: boolean;
     errors?: z.core.$ZodIssue[];
 };
+export declare function validateGoodConfig(config: MockPlaygroundConfigType): void;

package/dist/lib/utils/validateConfig.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateConfigWithErrors = validateConfigWithErrors;
+exports.validateGoodConfig = validateGoodConfig;
 const mock_config_1 = require("../types/mock-config");
+const errors_1 = require("./errors");
 function validateConfigWithErrors(config) {
     const result = mock_config_1.MockPlaygroundConfigSchema.safeParse(config);
     if (result.success) {
@@ -14,3 +16,33 @@ function validateConfigWithErrors(config) {
         };
     }
 }
+function validateGoodConfig(config) {
+    // 1. Validate base schema
+    const baseResult = validateConfigWithErrors(config);
+    if (!baseResult.success && baseResult.errors) {
+        const messages = baseResult.errors.map((e) => `[${e.path.join(".") || "root"}] ${e.message}`);
+        throw new errors_1.ValidationError(`Config schema validation failed with ${messages.length} error(s)`, messages, { flowId: config?.meta?.flowId });
+    }
+    const errors = [];
+    // 2. If inputs.id is present, both sampleData and jsonSchema must also be present
+    config.steps.forEach((step, index) => {
+        const { id, sampleData, jsonSchema } = step.mock.inputs;
+        if (id !== undefined) {
+            if (sampleData === undefined || sampleData === null) {
+                errors.push(`steps[${index}] (action_id: "${step.action_id}"): inputs.sampleData is required when inputs.id is set`);
+            }
+            if (jsonSchema === undefined || jsonSchema === null) {
+                errors.push(`steps[${index}] (action_id: "${step.action_id}"): inputs.jsonSchema is required when inputs.id is set`);
+            }
+        }
+    });
+    // 3. Length of steps must equal length of transaction_history
+    // if (config.steps.length !== config.transaction_history.length) {
+    // 	errors.push(
+    // 		`steps length (${config.steps.length}) must equal transaction_history length (${config.transaction_history.length})`,
+    // 	);
+    // }
+    if (errors.length > 0) {
+        throw new errors_1.ValidationError(`Config validation failed with ${errors.length} error(s)`, errors, { flowId: config.meta.flowId });
+    }
+}

package/dist/test/helper-config.test.js

@@ -686,71 +686,6 @@ describe("configHelper", () => {
             expect(onSearchStepConfig.unsolicited).toBe(false);
             expect(onSearchStepConfig.mock.defaultPayload).toBe(onSearchPayload);
         });
-        it("should ignore HTML_FORM and DYNAMIC_FORM steps and preserve unsolicited flag", async () => {
-            const payloads = [
-                {
-                    context: {
-                        action: "search",
-                        timestamp: "2025-01-01T09:00:00.000Z",
-                        domain: "ONDC:RET10",
-                        version: "2.0.0",
-                    },
-                },
-                {
-                    context: {
-                        action: "on_status",
-                        timestamp: "2025-01-01T10:00:00.000Z",
-                        domain: "ONDC:RET10",
-                        version: "2.0.0",
-                    },
-                },
-            ];
-            const flowConfig = {
-                id: "flow_with_forms",
-                sequence: [
-                    {
-                        key: "search_step",
-                        type: "search",
-                        unsolicited: false,
-                        description: "Search step",
-                        pair: null,
-                        owner: "BAP",
-                    },
-                    {
-                        key: "html_form_step",
-                        type: "HTML_FORM",
-                        unsolicited: false,
-                        description: "HTML form step",
-                        pair: null,
-                        owner: "BAP",
-                    },
-                    {
-                        key: "dynamic_form_step",
-                        type: "DYNAMIC_FORM",
-                        unsolicited: false,
-                        description: "Dynamic form step",
-                        pair: null,
-                        owner: "BAP",
-                    },
-                    {
-                        key: "on_status_step",
-                        type: "on_status",
-                        unsolicited: true,
-                        description: "Unsolicited status",
-                        pair: null,
-                        owner: "BPP",
-                    },
-                ],
-            };
-            const config = await (0, configHelper_1.generatePlaygroundConfigFromFlowConfig)(payloads, flowConfig);
-            // Only non-form steps should be present
-            expect(config.steps.map((s) => s.action_id)).toEqual([
-                "search_step",
-                "on_status_step",
-            ]);
-            const onStatusStep = config.steps.find((s) => s.action_id === "on_status_step");
-            expect(onStatusStep?.unsolicited).toBe(true);
-        });
         it("should derive version from core_version when version is missing", async () => {
             const payloads = [
                 {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ondc/automation-mock-runner",
-	"version": "1.3.20",
+	"version": "1.3.22",
 	"description": "A TypeScript library for ONDC automation mock runner",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",