@ondc/automation-mock-runner 1.3.22 → 1.3.25

package/dist/lib/MockRunner.d.ts

@@ -15,6 +15,9 @@ export declare class MockRunner {
             version: string;
             flowId: string;
             config_version?: string | undefined;
+            description?: string | undefined;
+            use_case_id?: string | undefined;
+            flowName?: string | undefined;
         };
         transaction_data: {
             transaction_id: string;
@@ -45,6 +48,12 @@ export declare class MockRunner {
                 formHtml?: string | undefined;
             };
             repeatCount?: number | null | undefined;
+            examples?: {
+                name: string;
+                payload: any;
+                type: "request" | "response";
+                description?: string | undefined;
+            }[] | undefined;
         }[];
         transaction_history: {
             action_id: string;

package/dist/lib/configHelper.d.ts

@@ -42,6 +42,9 @@ export declare function generatePlaygroundConfigFromFlowConfig(payloads: Payload
         version: string;
         flowId: string;
         config_version?: string | undefined;
+        description?: string | undefined;
+        use_case_id?: string | undefined;
+        flowName?: string | undefined;
     };
     transaction_data: {
         transaction_id: string;
@@ -72,6 +75,12 @@ export declare function generatePlaygroundConfigFromFlowConfig(payloads: Payload
             formHtml?: string | undefined;
         };
         repeatCount?: number | null | undefined;
+        examples?: {
+            name: string;
+            payload: any;
+            type: "request" | "response";
+            description?: string | undefined;
+        }[] | undefined;
     }[];
     transaction_history: {
         action_id: string;

package/dist/lib/configHelper.js

@@ -16,6 +16,9 @@ function createInitialMockConfig(domain, version, flowId) {
             domain,
             version,
             flowId,
+            config_version: "0.0.0001",
+            description: "",
+            use_case_id: "",
         },
         transaction_data: {
             transaction_id: (0, uuid_1.v4)(),

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

@@ -8,6 +8,9 @@ export declare const MetaSchema: z.ZodObject<{
     version: z.ZodString;
     flowId: z.ZodString;
     config_version: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    use_case_id: z.ZodOptional<z.ZodString>;
+    flowName: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export declare const TransactionDataSchema: z.ZodObject<{
     transaction_id: z.ZodString;
@@ -54,6 +57,15 @@ export declare const PlaygroundActionStepSchema: z.ZodObject<{
         }, z.core.$strip>;
         formHtml: z.ZodOptional<z.ZodBase64>;
     }, z.core.$strip>;
+    examples: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        payload: z.ZodAny;
+        type: z.ZodEnum<{
+            request: "request";
+            response: "response";
+        }>;
+    }, z.core.$strip>>>;
 }, z.core.$strip>;
 export declare const TransactionHistoryItemSchema: z.ZodObject<{
     action_id: z.ZodString;
@@ -67,6 +79,9 @@ export declare const MockPlaygroundConfigSchema: z.ZodObject<{
         version: z.ZodString;
         flowId: z.ZodString;
         config_version: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        use_case_id: z.ZodOptional<z.ZodString>;
+        flowName: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>;
     transaction_data: z.ZodObject<{
         transaction_id: z.ZodString;
@@ -100,6 +115,15 @@ export declare const MockPlaygroundConfigSchema: z.ZodObject<{
             }, z.core.$strip>;
             formHtml: z.ZodOptional<z.ZodBase64>;
         }, z.core.$strip>;
+        examples: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            description: z.ZodOptional<z.ZodString>;
+            payload: z.ZodAny;
+            type: z.ZodEnum<{
+                request: "request";
+                response: "response";
+            }>;
+        }, z.core.$strip>>>;
     }, z.core.$strip>>;
     transaction_history: z.ZodArray<z.ZodObject<{
         action_id: z.ZodString;

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

@@ -9,6 +9,9 @@ exports.MetaSchema = zod_1.z.object({
     version: zod_1.z.string().min(1, "Version is required"),
     flowId: zod_1.z.string().min(1, "Flow ID is required"),
     config_version: zod_1.z.string().optional(),
+    description: zod_1.z.string().optional(),
+    use_case_id: zod_1.z.string().optional(),
+    flowName: zod_1.z.string().optional(),
 });
 exports.TransactionDataSchema = zod_1.z.object({
     transaction_id: zod_1.z.string().min(1, "Transaction ID is required"),
@@ -44,6 +47,14 @@ exports.PlaygroundActionStepSchema = zod_1.z.object({
         .optional()
         .nullable(),
     mock: exports.MockConfigSchema,
+    examples: zod_1.z
+        .array(zod_1.z.object({
+        name: zod_1.z.string().min(1, "Example name is required"),
+        description: zod_1.z.string().optional(),
+        payload: zod_1.z.any(),
+        type: zod_1.z.enum(["request", "response"]),
+    }))
+        .optional(),
 });
 exports.TransactionHistoryItemSchema = zod_1.z.object({
     action_id: zod_1.z.string().min(1, "Action ID is required"),

package/dist/lib/utils/validateConfig.js

@@ -1,9 +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) {
@@ -25,8 +29,15 @@ function validateGoodConfig(config) {
     }
     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`);
@@ -35,6 +46,18 @@ function validateGoodConfig(config) {
                 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) {

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

@@ -438,6 +438,9 @@ describe("configHelper", () => {
                 domain: "ONDC:TRV14",
                 version: "2.0.0",
                 flowId: "test-flow",
+                config_version: "0.0.0001",
+                description: "",
+                use_case_id: "",
             });
         });
         it("should generate a UUID for transaction_id", () => {

package/package.json

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