@routevn/creator-model 1.2.4 → 1.2.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routevn/creator-model",
-  "version": "1.2.4",
+  "version": "1.2.6",
   "private": false,
   "type": "module",
   "license": "MIT",

package/src/model.js

@@ -123,11 +123,11 @@ const ANIMATION_EASING_KEYS = [
 const VARIABLE_SCOPE_KEYS = ["context", "device", "account"];
 const VARIABLE_TYPE_KEYS = ["string", "number", "boolean"];
 const LAYOUT_TYPE_KEYS = [
-  "normal",
+  "general",
   "save-load",
   "confirmDialog",
-  "dialogue",
-  "nvl",
+  "dialogue-adv",
+  "dialogue-nvl",
   "choice",
   "history",
 ];
@@ -1506,13 +1506,6 @@ const validateTweenDefinition = ({
     return invalidFromErrorFactory(errorFactory, `${path} must be an object`);
   }
 
-  if (Object.keys(tween).length === 0) {
-    return invalidFromErrorFactory(
-      errorFactory,
-      `${path} must include at least one tween property`,
-    );
-  }
-
   for (const [propertyName, config] of Object.entries(tween)) {
     const propertyPath = `${path}.${propertyName}`;
 
@@ -1866,17 +1859,6 @@ const validateAnimationDefinition = ({ animation, path, errorFactory }) => {
     );
   }
 
-  if (
-    animation.prev === undefined &&
-    animation.next === undefined &&
-    animation.mask === undefined
-  ) {
-    return invalidFromErrorFactory(
-      errorFactory,
-      `${path} must define at least one of prev, next, or mask when ${path}.type is 'transition'`,
-    );
-  }
-
   for (const side of ["prev", "next"]) {
     if (animation[side] === undefined) {
       continue;
@@ -3674,6 +3656,21 @@ const validateKeyboardMap = ({ value, path, errorFactory }) => {
   return VALID_RESULT;
 };
 
+const validatePreviewObject = ({ value, path, errorFactory }) => {
+  if (value === undefined) {
+    return VALID_RESULT;
+  }
+
+  if (!isPlainObject(value)) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      `${path} must be an object when provided`,
+    );
+  }
+
+  return VALID_RESULT;
+};
+
 const validateLayoutItems = ({ items, path, errorFactory }) => {
   for (const [itemId, item] of Object.entries(items)) {
     const itemPath = `${path}.${itemId}`;
@@ -3699,6 +3696,7 @@ const validateLayoutItems = ({ items, path, errorFactory }) => {
                 "layoutType",
                 "isFragment",
                 "thumbnailFileId",
+                "preview",
                 "elements",
               ],
         path: itemPath,
@@ -3747,11 +3745,22 @@ const validateLayoutItems = ({ items, path, errorFactory }) => {
       );
     }
 
+    {
+      const result = validatePreviewObject({
+        value: item.preview,
+        path: `${itemPath}.preview`,
+        errorFactory,
+      });
+      if (result?.valid === false) {
+        return result;
+      }
+    }
+
     if (item.type === "layout") {
       if (!LAYOUT_TYPE_KEYS.includes(item.layoutType)) {
         return invalidFromErrorFactory(
           errorFactory,
-          `${itemPath}.layoutType must be 'normal', 'save-load', 'confirmDialog', 'dialogue', 'nvl', 'choice', or 'history'`,
+          `${itemPath}.layoutType must be 'general', 'save-load', 'confirmDialog', 'dialogue-adv', 'dialogue-nvl', 'choice', or 'history'`,
         );
       }
 
@@ -3804,6 +3813,7 @@ const validateControlItems = ({ items, path, errorFactory }) => {
                 "name",
                 "description",
                 "thumbnailFileId",
+                "preview",
                 "elements",
                 "keyboard",
               ],
@@ -3853,6 +3863,17 @@ const validateControlItems = ({ items, path, errorFactory }) => {
       );
     }
 
+    {
+      const result = validatePreviewObject({
+        value: item.preview,
+        path: `${itemPath}.preview`,
+        errorFactory,
+      });
+      if (result?.valid === false) {
+        return result;
+      }
+    }
+
     if (item.type === "control") {
       {
         const result = validateNestedCollection({
@@ -8184,6 +8205,7 @@ const validateLayoutCreateData = ({ data, errorFactory }) => {
               "layoutType",
               "isFragment",
               "thumbnailFileId",
+              "preview",
               "elements",
             ],
       path: "payload.data",
@@ -8218,11 +8240,22 @@ const validateLayoutCreateData = ({ data, errorFactory }) => {
     );
   }
 
+  {
+    const result = validatePreviewObject({
+      value: data.preview,
+      path: "payload.data.preview",
+      errorFactory,
+    });
+    if (result?.valid === false) {
+      return result;
+    }
+  }
+
   if (data.type === "layout") {
     if (!LAYOUT_TYPE_KEYS.includes(data.layoutType)) {
       return invalidFromErrorFactory(
         errorFactory,
-        "payload.data.layoutType must be 'normal', 'save-load', 'confirmDialog', 'dialogue', 'nvl', 'choice', or 'history'",
+        "payload.data.layoutType must be 'general', 'save-load', 'confirmDialog', 'dialogue-adv', 'dialogue-nvl', 'choice', or 'history'",
       );
     }
 
@@ -8258,6 +8291,7 @@ const validateLayoutUpdateData = ({ data, errorFactory }) => {
         "layoutType",
         "isFragment",
         "thumbnailFileId",
+        "preview",
       ],
       path: "payload.data",
       errorFactory,
@@ -8298,13 +8332,24 @@ const validateLayoutUpdateData = ({ data, errorFactory }) => {
     );
   }
 
+  {
+    const result = validatePreviewObject({
+      value: data.preview,
+      path: "payload.data.preview",
+      errorFactory,
+    });
+    if (result?.valid === false) {
+      return result;
+    }
+  }
+
   if (
     data.layoutType !== undefined &&
     !LAYOUT_TYPE_KEYS.includes(data.layoutType)
   ) {
     return invalidFromErrorFactory(
       errorFactory,
-      "payload.data.layoutType must be 'normal', 'save-load', 'confirmDialog', 'dialogue', 'nvl', 'choice', or 'history' when provided",
+      "payload.data.layoutType must be 'general', 'save-load', 'confirmDialog', 'dialogue-adv', 'dialogue-nvl', 'choice', or 'history' when provided",
     );
   }
 
@@ -8342,6 +8387,7 @@ const validateControlCreateData = ({ data, errorFactory }) => {
               "name",
               "description",
               "thumbnailFileId",
+              "preview",
               "elements",
               "keyboard",
             ],
@@ -8377,6 +8423,17 @@ const validateControlCreateData = ({ data, errorFactory }) => {
     );
   }
 
+  {
+    const result = validatePreviewObject({
+      value: data.preview,
+      path: "payload.data.preview",
+      errorFactory,
+    });
+    if (result?.valid === false) {
+      return result;
+    }
+  }
+
   if (data.type === "control") {
     {
       const result = validateNestedCollection({
@@ -8408,7 +8465,13 @@ const validateControlUpdateData = ({ data, errorFactory }) => {
   {
     const result = validateAllowedKeys({
       value: data,
-      allowedKeys: ["name", "description", "keyboard", "thumbnailFileId"],
+      allowedKeys: [
+        "name",
+        "description",
+        "keyboard",
+        "thumbnailFileId",
+        "preview",
+      ],
       path: "payload.data",
       errorFactory,
     });
@@ -8448,6 +8511,17 @@ const validateControlUpdateData = ({ data, errorFactory }) => {
     );
   }
 
+  {
+    const result = validatePreviewObject({
+      value: data.preview,
+      path: "payload.data.preview",
+      errorFactory,
+    });
+    if (result?.valid === false) {
+      return result;
+    }
+  }
+
   {
     const result = validateKeyboardMap({
       value: data.keyboard,
@@ -13758,6 +13832,11 @@ const COMMAND_DEFINITIONS = [
                   thumbnailFileId: payload.data.thumbnailFileId,
                 }
               : {}),
+            ...(payload.data.preview !== undefined
+              ? {
+                  preview: structuredClone(payload.data.preview),
+                }
+              : {}),
             elements: structuredClone(payload.data.elements),
           }
         : {}),
@@ -13823,6 +13902,11 @@ const COMMAND_DEFINITIONS = [
                   thumbnailFileId: payload.data.thumbnailFileId,
                 }
               : {}),
+            ...(payload.data.preview !== undefined
+              ? {
+                  preview: structuredClone(payload.data.preview),
+                }
+              : {}),
             elements: structuredClone(payload.data.elements),
             ...(payload.data.keyboard !== undefined
               ? {