@ondc/automation-mock-runner 1.3.21 → 1.3.23

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

@@ -373,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: {
@@ -253,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,13 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 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");
+const ajv_1 = __importDefault(require("ajv"));
 function validateConfigWithErrors(config) {
     const result = mock_config_1.MockPlaygroundConfigSchema.safeParse(config);
     if (result.success) {
@@ -14,3 +20,52 @@ 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
+    // Also validate sampleData against jsonSchema when both are present
+    const ajv = new ajv_1.default();
+    config.steps.forEach((step, index) => {
+        const { id, sampleData, jsonSchema } = step.mock.inputs;
+        if (step.mock.inputs !== undefined) {
+            if (id === undefined || id === null) {
+                errors.push(`steps[${index}] (action_id: "${step.action_id}"): inputs.id is required when inputs is defined`);
+            }
+        }
+        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`);
+            }
+        }
+        if (sampleData !== undefined &&
+            sampleData !== null &&
+            jsonSchema !== undefined &&
+            jsonSchema !== null) {
+            const validate = ajv.compile(jsonSchema);
+            const valid = validate(sampleData);
+            if (!valid && validate.errors) {
+                validate.errors.forEach((e) => {
+                    errors.push(`steps[${index}] (action_id: "${step.action_id}"): inputs.sampleData${e.dataPath} ${e.message}`);
+                });
+            }
+        }
+    });
+    // 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/package.json

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