@wise/dynamic-flow-client 1.2.2 → 1.3.0

package/build/main.js

@@ -767,12 +767,24 @@ function inlineFormSchema({
   formComponent,
   schemas
 }) {
-  if (isReference(formComponent.schema) && formComponent.schema.$ref) {
-    return __spreadProps(__spreadValues({}, formComponent), {
+  if (formComponent.schemaId) {
+    return {
+      type: "form",
+      margin: formComponent.margin,
+      schema: getSchemaById(schemas, formComponent.schemaId)
+    };
+  }
+  if (formComponent.schema && isReference(formComponent.schema) && formComponent.schema.$ref) {
+    return {
+      type: "form",
+      margin: formComponent.margin,
       schema: getSchemaById(schemas, formComponent.schema.$ref)
-    });
+    };
+  }
+  if (formComponent.schema && !isReference(formComponent.schema)) {
+    return __spreadValues({}, formComponent);
   }
-  return __spreadValues({}, formComponent);
+  throw new Error('Invalid form layout component. Missing "schema" or "schemaId" properties.');
 }
 function inlineDecisionActions({
   decisionComponent,
@@ -5874,13 +5886,6 @@ function useDebouncedRefresh(fetchRefresh) {
 
 // src/dynamicFlow/utils/useDynamicFlowState.ts
 var import_react35 = require("react");
-
-// src/dynamicFlow/DynamicFlowTypes.ts
-function isSchema(schema2) {
-  return Object.prototype.hasOwnProperty.call(schema2, "$ref") === false;
-}
-
-// src/dynamicFlow/utils/useDynamicFlowState.ts
 var useDynamicFlowState = (initialStep) => {
   var _a, _b;
   const [formErrors, setFormErrors] = (0, import_react35.useState)((_a = initialStep == null ? void 0 : initialStep.errors) == null ? void 0 : _a.validation);
@@ -5950,7 +5955,7 @@ var getAllSchemasInLayout = (components) => components.flatMap((component) => {
     case "box":
       return getAllSchemasInLayout(component.components);
     case "form":
-      return isSchema(component.schema) ? [component.schema] : [];
+      return isInlineSchema(component.schema) ? [component.schema] : [];
     default:
       return [];
   }
@@ -5963,6 +5968,9 @@ var areModelsValid = (formModels, schemas = []) => {
     return !isValidSchema(formModels[schema2.$id || ""] || {}, schema2);
   }));
 };
+var isInlineSchema = (schema2) => {
+  return schema2 !== void 0 && typeof schema2 === "object" && Object.prototype.hasOwnProperty.call(schema2, "$ref") === false;
+};
 
 // src/dynamicFlow/utils/useLoader.tsx
 var import_components24 = require("@transferwise/components");
@@ -6122,7 +6130,7 @@ var parseErrorResponse = async (response) => {
   if (!isObject(jsonBody)) {
     throw new Error("Incorrect response body in error response. Expected an object.");
   }
-  if (!jsonBody.refreshFormUrl && !jsonBody.validation && !jsonBody.error) {
+  if (!jsonBody.refreshFormUrl && !jsonBody.refreshUrl && !jsonBody.validation && !jsonBody.error) {
     throw jsonBody;
   }
   return jsonBody;
@@ -6302,8 +6310,9 @@ var DynamicFlowComponent = ({
     }
   };
   const updateAfterError = async (errorBody) => {
-    if (errorBody.refreshFormUrl) {
-      await performRefresh(errorBody.refreshFormUrl, combineModels2(models), etag);
+    const refreshUrl = errorBody.refreshUrl || errorBody.refreshFormUrl;
+    if (refreshUrl) {
+      await performRefresh(refreshUrl, combineModels2(models), etag);
     }
     if (errorBody.validation) {
       setFormErrors(errorBody.validation);
@@ -6340,9 +6349,11 @@ var DynamicFlowComponent = ({
   const refreshOnChangeIfNeeded = (props, updatedModels) => {
     const { triggerSchema } = props;
     if (shouldTriggerRefresh(props)) {
-      const url = triggerSchema.refreshFormUrl || (step35 == null ? void 0 : step35.refreshFormUrl);
-      if (url) {
-        debouncedRefresh(url, combineModels2(updatedModels), etag, triggerSchema);
+      const triggerSchemaRefreshUrl = triggerSchema.refreshUrl || triggerSchema.refreshFormUrl;
+      const stepRefreshUrl = (step35 == null ? void 0 : step35.refreshUrl) || (step35 == null ? void 0 : step35.refreshFormUrl);
+      const refreshUrl = triggerSchemaRefreshUrl || stepRefreshUrl;
+      if (refreshUrl) {
+        debouncedRefresh(refreshUrl, combineModels2(updatedModels), etag, triggerSchema);
       }
     }
   };
@@ -6396,7 +6407,8 @@ var shouldTriggerRefresh = (props) => {
   const { type, triggerSchema, triggerModel, lastTriggerModel = null } = props;
   const isValid = () => isValidSchema(triggerModel, triggerSchema);
   const wasValid = () => isValidSchema(lastTriggerModel, triggerSchema);
-  return type !== "init" && (triggerSchema == null ? void 0 : triggerSchema.refreshFormOnChange) && (isValid() || wasValid());
+  const hasRefreshOnChange = (triggerSchema == null ? void 0 : triggerSchema.refreshStepOnChange) || (triggerSchema == null ? void 0 : triggerSchema.refreshFormOnChange);
+  return type !== "init" && hasRefreshOnChange && (isValid() || wasValid());
 };
 
 // src/fixtures/components/index.ts
@@ -6512,7 +6524,7 @@ var step3 = {
         },
         {
           type: "form",
-          schema: { $ref: "#schema" }
+          schemaId: "#schema"
         },
         ...buttons,
         {
@@ -6932,7 +6944,7 @@ var step16 = {
     {
       properties: {
         frontSideFile: {
-          refreshFormOnChange: false,
+          refreshStepOnChange: false,
           format: "base64url",
           $id: "frontSideFile",
           title: "Passport photo page",
@@ -6950,77 +6962,24 @@ var step16 = {
       },
       required: ["frontSideFile"],
       displayOrder: ["frontSideFile"],
-      $id: "ee2501a9-2566-459b-a42e-f9f0932be0e6",
-      type: "object"
-    },
-    {
-      properties: {
-        type: {
-          refreshFormOnChange: false,
-          $id: "9200f887-bfdd-46ad-8386-e76f455a7cc8",
-          const: "ID_DOCUMENT_WITH_LIVENESS",
-          hidden: true,
-          type: "string"
-        }
-      },
-      required: ["type"],
-      displayOrder: ["type"],
-      $id: "c59a2881-a2e0-4108-b42e-0d30fc95bd7f",
-      type: "object"
-    },
-    {
-      properties: {
-        profileId: {
-          refreshFormOnChange: false,
-          $id: "75d888dc-208a-4d7d-a2a7-aeca0dd1b533",
-          const: 14551053,
-          hidden: true,
-          type: "integer"
-        }
-      },
-      required: ["profileId"],
-      displayOrder: ["profileId"],
-      $id: "3eec6add-2d0e-41d7-8317-49542c841484",
-      type: "object"
-    },
-    {
-      properties: {
-        sessionId: {
-          refreshFormOnChange: false,
-          $id: "df82adf3-8a66-46b5-bef8-72f59be2188d",
-          const: "62dfe7d026c6da1ac0db1ee4",
-          hidden: true,
-          type: "string"
-        }
-      },
-      required: ["sessionId"],
-      displayOrder: ["sessionId"],
-      $id: "e1a8fb67-9af2-47e8-97c1-f2a88e5d5f3a",
+      $id: "#the-schema",
       type: "object"
     }
   ],
-  actions: [
-    {
-      url: "/v3/kyc-checks/87785/flow?actionId=SINGLE_PAGE_REVIEW&sessionId=62dfe7d026c6da1ac0db1ee4&",
-      type: "primary",
-      method: "POST",
-      disabled: false,
-      $id: "6789eac5-7bbe-49d8-9da8-6edb8e7ef165",
-      title: ""
-    }
-  ],
   layout: [
     {
       type: "form",
-      schema: {
-        $ref: "ee2501a9-2566-459b-a42e-f9f0932be0e6"
-      }
+      schemaId: "#the-schema"
     },
     {
       components: [
         {
           action: {
-            $ref: "6789eac5-7bbe-49d8-9da8-6edb8e7ef165"
+            url: "/submit",
+            type: "primary",
+            method: "POST",
+            disabled: false,
+            title: ""
           },
           margin: "lg",
           size: "md",
@@ -7032,17 +6991,8 @@ var step16 = {
       type: "box"
     }
   ],
-  model: {
-    profileId: 14551053,
-    sessionId: "62dfe7d026c6da1ac0db1ee4",
-    issuingCountry: "HU",
-    documentType: "PASSPORT",
-    type: "ID_DOCUMENT_WITH_LIVENESS",
-    key: {
-      value: "ID_DOCUMENT_WITH_LIVENESS14551053"
-    }
-  },
-  refreshFormUrl: "/"
+  model: {},
+  refreshUrl: "/"
 };
 var camera_capture_default = step16;
 
@@ -7110,7 +7060,7 @@ var step17 = {
                 required: "Please enter currency."
               },
               default: "EUR",
-              refreshFormOnChange: true
+              refreshStepOnChange: true
             },
             legalEntityType: {
               title: "Select recipient type",
@@ -7131,7 +7081,7 @@ var step17 = {
               validationMessages: {
                 required: "Please specify the type of recipient."
               },
-              refreshFormOnChange: true
+              refreshStepOnChange: true
             },
             email: {
               title: "Their email",
@@ -7142,10 +7092,10 @@ var step17 = {
                 maxLength: "The email you have entered is too long.",
                 pattern: "The email address is invalid."
               },
-              refreshFormOnChange: true,
+              refreshStepOnChange: true,
               autofillProvider: "contact",
               autofillKey: "contact.email",
-              refreshFormUrl: "/steps/recipient",
+              refreshUrl: "/steps/recipient",
               pattern: "\\s*[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+\\s*",
               maxLength: 255
             }
@@ -7222,7 +7172,7 @@ var step17 = {
                         pattern: "Please specify a valid IBAN.",
                         required: "Please specify an IBAN."
                       },
-                      refreshFormOnChange: true,
+                      refreshStepOnChange: true,
                       pattern: "^[a-zA-Z]{2}[a-zA-Z0-9 ]{12,40}$",
                       minLength: 14,
                       maxLength: 42
@@ -7334,13 +7284,11 @@ var step17 = {
       ]
     }
   ],
-  refreshFormUrl: "/steps/recipient",
+  refreshUrl: "/steps/recipient",
   layout: [
     {
       type: "form",
-      schema: {
-        $ref: "#new-recipient"
-      }
+      schemaId: "#new-recipient"
     },
     {
       type: "button",
@@ -7365,7 +7313,7 @@ var step18 = {
   title: "Edit recipient",
   schemas: [
     {
-      $id: "form",
+      $id: "#form",
       allOf: [
         {
           type: "object",
@@ -7556,7 +7504,7 @@ var step18 = {
       }
     }
   },
-  refreshFormUrl: "/steps/recipientUpdate/?refresh",
+  refreshUrl: "/steps/recipientUpdate/?refresh",
   model: {
     country: "GB",
     ownedByCustomer: false,
@@ -7586,10 +7534,8 @@ var step18 = {
   },
   layout: [
     {
-      schema: {
-        $ref: "form"
-      },
-      type: "form"
+      type: "form",
+      schemaId: "#form"
     },
     {
       type: "button",
@@ -7616,7 +7562,7 @@ var step19 = {
       displayOrder: ["frontSide"],
       properties: {
         frontSide: {
-          refreshFormOnChange: false,
+          refreshStepOnChange: false,
           $id: "frontSide",
           persistAsync: {
             url: "/single-file-upload-url",
@@ -7645,7 +7591,7 @@ var step19 = {
       displayOrder: ["frontSide"],
       properties: {
         frontSide: {
-          refreshFormOnChange: false,
+          refreshStepOnChange: false,
           $id: "backSide",
           persistAsync: {
             url: "/single-file-upload-url-fail",
@@ -7676,7 +7622,7 @@ var step19 = {
     },
     {
       type: "form",
-      schema: { $ref: "#schema-1" }
+      schemaId: "#schema-1"
     },
     {
       type: "paragraph",
@@ -7684,7 +7630,7 @@ var step19 = {
     },
     {
       type: "form",
-      schema: { $ref: "#schema-2" }
+      schemaId: "#schema-2"
     },
     {
       type: "button",
@@ -7717,7 +7663,7 @@ var step20 = {
   layout: [
     {
       type: "form",
-      schema: { $ref: "#the-schema" }
+      schemaId: "#the-schema"
     }
   ],
   schemas: [
@@ -7856,7 +7802,7 @@ var step23 = {
   title: "Persist Async Feature",
   schemas: [
     {
-      $id: "the-schema",
+      $id: "#the-schema",
       type: "object",
       title: "Some Object",
       displayOrder: ["nameToken"],
@@ -7881,7 +7827,7 @@ var step23 = {
   layout: [
     {
       type: "form",
-      schema: { $ref: "the-schema" }
+      schemaId: "#the-schema"
     }
   ]
 };
@@ -7948,14 +7894,10 @@ var step25 = {
   layout: [
     {
       type: "form",
-      schema: {
-        $ref: "#the-schema"
-      }
+      schemaId: "#the-schema"
     }
   ],
-  model: {
-    // name: 'Colin Robinson',
-  }
+  model: {}
 };
 var validation_async_default = step25;
 
@@ -8646,7 +8588,7 @@ var step29 = {
   layout: [
     {
       type: "form",
-      schema: { $ref: "#the-schema" }
+      schemaId: "#the-schema"
     },
     {
       type: "button",
@@ -8687,7 +8629,7 @@ var step30 = {
   layout: [
     {
       type: "form",
-      schema: { $ref: "#the-schema" }
+      schemaId: "#the-schema"
     },
     {
       type: "button",
@@ -8908,7 +8850,7 @@ var step31 = {
   layout: [
     {
       type: "form",
-      schema: { $ref: "#the-schema" }
+      schemaId: "#the-schema"
     },
     {
       type: "button",
@@ -8967,7 +8909,7 @@ var step32 = {
   layout: [
     {
       type: "form",
-      schema: { $ref: "#the-schema" }
+      schemaId: "#the-schema"
     },
     {
       type: "button",
@@ -9007,7 +8949,7 @@ var step33 = {
   layout: [
     {
       type: "form",
-      schema: { $ref: "#schema-1" }
+      schemaId: "#schema-1"
     },
     {
       type: "button",
@@ -9092,7 +9034,7 @@ var step34 = {
   layout: [
     {
       type: "form",
-      schema: { $ref: "#the-schema" }
+      schemaId: "#the-schema"
     },
     {
       type: "button",