@ondc/automation-mock-runner 1.3.6 → 1.3.8

package/dist/lib/MockRunner.d.ts

@@ -39,6 +39,7 @@ export declare class MockRunner {
                     id?: string | undefined;
                     jsonSchema?: any;
                 };
+                formHtml?: string | undefined;
             };
             repeatCount?: number | null | undefined;
         }[];
@@ -60,7 +61,7 @@ export declare class MockRunner {
     runValidatePayloadWithSession(actionId: string, targetPayload: any, sessionData: any): Promise<ExecutionResult>;
     runMeetRequirements(actionId: string): Promise<ExecutionResult>;
     runMeetRequirementsWithSession(actionId: string, sessionData: any): Promise<ExecutionResult>;
-    getDefaultStep(api: string, actionId: string): MockPlaygroundConfigType["steps"][0];
+    getDefaultStep(api: string, actionId: string, formType?: "dynamic_form" | "html_form"): MockPlaygroundConfigType["steps"][0];
     generateContext(actionId: string, action: string, sessionData?: any): any;
     getSessionDataUpToStep(index: number): Promise<Record<string, any>>;
     static runGetSave(payload: any, expression: string): Promise<ExecutionResult>;

package/dist/lib/MockRunner.js

@@ -283,7 +283,29 @@ class MockRunner {
             };
         }
     }
-    getDefaultStep(api, actionId) {
+    getDefaultStep(api, actionId, formType) {
+        if (formType === "html_form") {
+            throw new Error("HTML form generation is not implemented yet");
+        }
+        if (formType === "dynamic_form") {
+            return {
+                api: api,
+                action_id: actionId,
+                owner: "BPP",
+                responseFor: null,
+                unsolicited: false,
+                description: "please add relevant description",
+                mock: {
+                    generate: MockRunner.encodeBase64((0, function_registry_1.getFunctionSchema)("generate").template((0, function_registry_1.getFunctionSchema)("generate").defaultBody)),
+                    validate: MockRunner.encodeBase64((0, function_registry_1.getFunctionSchema)("validate").template((0, function_registry_1.getFunctionSchema)("validate").defaultBody)),
+                    requirements: MockRunner.encodeBase64((0, function_registry_1.getFunctionSchema)("meetsRequirements").template((0, function_registry_1.getFunctionSchema)("meetsRequirements").defaultBody)),
+                    defaultPayload: {},
+                    saveData: {},
+                    inputs: {},
+                    formHtml: MockRunner.encodeBase64((0, function_registry_1.getDefaultForm)()),
+                },
+            };
+        }
         return {
             api: api,
             action_id: actionId,

package/dist/lib/configHelper.d.ts

@@ -67,6 +67,7 @@ export declare function generatePlaygroundConfigFromFlowConfig(payloads: Payload
                 id?: string | undefined;
                 jsonSchema?: any;
             };
+            formHtml?: string | undefined;
         };
         repeatCount?: number | null | undefined;
     }[];

package/dist/lib/configHelper.js

@@ -76,16 +76,40 @@ function convertToFlowConfig(config) {
     for (const step of config.steps) {
         const pair = config.steps.find((s) => s.responseFor === step.action_id)?.action_id ||
             null;
-        const flowStep = {
-            key: step.action_id,
-            type: step.api,
-            owner: step.owner,
-            description: step.description || "",
-            expect: index === 0 ? true : false,
-            unsolicited: step.unsolicited,
-            pair: pair,
-            repeat: step.repeatCount || 1,
-        };
+        let flowStep = {};
+        if (step.api === "dynamic_form") {
+            flowStep = {
+                key: step.action_id,
+                type: "DYNAMIC_FORM",
+                owner: step.owner,
+                description: step.description || "",
+                label: step.description || "FORM",
+                unsolicited: step.unsolicited,
+                pair: pair,
+                repeat: step.repeatCount || 1,
+                input: [
+                    {
+                        name: "form_submission_id",
+                        label: "Enter form submission ID",
+                        type: "DYNAMIC_FORM",
+                        payloadField: "form_submission_id",
+                        reference: `$.reference_data.${step.action_id}`,
+                    },
+                ],
+            };
+        }
+        else {
+            flowStep = {
+                key: step.action_id,
+                type: step.api,
+                owner: step.owner,
+                description: step.description || "",
+                expect: index === 0 ? true : false,
+                unsolicited: step.unsolicited,
+                pair: pair,
+                repeat: step.repeatCount || 1,
+            };
+        }
         if (step.mock.inputs !== undefined &&
             step.mock.inputs !== null &&
             Object.keys(step.mock.inputs).length > 0) {

package/dist/lib/constants/function-registry.d.ts

@@ -24,3 +24,4 @@ export interface FunctionSchema {
 }
 export declare const FUNCTION_REGISTRY: Record<string, FunctionSchema>;
 export declare function getFunctionSchema(property: FunctionNamesType): FunctionSchema;
+export declare function getDefaultForm(): string;

package/dist/lib/constants/function-registry.js

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FUNCTION_REGISTRY = void 0;
 exports.getFunctionSchema = getFunctionSchema;
+exports.getDefaultForm = getDefaultForm;
 exports.FUNCTION_REGISTRY = {
     generate: {
         name: "generate",
@@ -149,3 +150,55 @@ function getFunctionSchema(property) {
     }
     return item;
 }
+function getDefaultForm() {
+    return `<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>Additional Details</title>
+</head>
+
+<body>
+  <form id="additionalDetailsForm" method="POST" action="<%= actionUrl %>">
+    <label for="name">Name</label>
+    <input type="text" id="name" name="name" />
+
+    <label for="country">Country</label>
+    <input type="text" id="country" name="country" />
+
+    <label for="countryCode">Country Code</label>
+    <input type="text" id="countryCode" name="countryCode" />
+
+    <label for="age">Age</label>
+    <input type="text" id="age" name="age" />
+
+    <label for="email">Email ID</label>
+    <input type="text" id="email" name="email" />
+
+    <label for="gender">Gender</label>
+    <select name="gender" id="gender">
+      <option value="male">Male</option>
+      <option value="female">Female</option>
+      <option value="transgender">Transgender</option>
+    </select>
+
+    <label for="phoneNumber">Phone number</label>
+    <input type="text" id="phoneNumber" name="phoneNumber" />
+
+    <label for="idProof">ID Proof</label>
+    <select name="idProof" id="idProof">
+      <option value="passport">Passport</option>
+    </select>
+
+    <label for="passportNumber">Passport Number</label>
+    <input type="text" id="passportNumber" name="passportNumber" />
+    <input type="hidden" id="formId" name="formId" value="FO1">
+    <input type="hidden" id="transactionId" name="transactionId" value="cf7bb367-c820-4bc9-9be8-f548e0bbf222">
+    <input type="submit" value="Submit">
+  </form>
+</body>
+
+</html>`;
+}

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

@@ -26,6 +26,7 @@ export declare const MockConfigSchema: z.ZodObject<{
         id: z.ZodOptional<z.ZodString>;
         jsonSchema: z.ZodOptional<z.ZodAny>;
     }, z.core.$strip>;
+    formHtml: z.ZodOptional<z.ZodBase64>;
 }, z.core.$strip>;
 export declare const PlaygroundActionStepSchema: z.ZodObject<{
     api: z.ZodString;
@@ -48,6 +49,7 @@ export declare const PlaygroundActionStepSchema: z.ZodObject<{
             id: z.ZodOptional<z.ZodString>;
             jsonSchema: z.ZodOptional<z.ZodAny>;
         }, z.core.$strip>;
+        formHtml: z.ZodOptional<z.ZodBase64>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 export declare const TransactionHistoryItemSchema: z.ZodObject<{
@@ -90,6 +92,7 @@ export declare const MockPlaygroundConfigSchema: z.ZodObject<{
                 id: z.ZodOptional<z.ZodString>;
                 jsonSchema: z.ZodOptional<z.ZodAny>;
             }, z.core.$strip>;
+            formHtml: z.ZodOptional<z.ZodBase64>;
         }, z.core.$strip>;
     }, z.core.$strip>>;
     transaction_history: z.ZodArray<z.ZodObject<{

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

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

package/package.json

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