@routevn/creator-model 1.0.5 → 1.1.1

package/package.json

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

package/src/model.js

@@ -112,6 +112,7 @@ const LAYOUT_ELEMENT_TEXT_STYLE_ALIGN_KEYS = ["left", "center", "right"];
 const LAYOUT_ELEMENT_BASE_TYPES = [
   "folder",
   "container",
+  "rect",
   "sprite",
   "text",
   "text-revealing",
@@ -387,8 +388,8 @@ const validateSceneItems = ({ items, path, errorFactory }) => {
         value: item,
         allowedKeys:
           item?.type === "scene"
-            ? ["id", "type", "name", "position", "sections"]
-            : ["id", "type", "name", "position"],
+            ? ["id", "type", "name", "description", "position", "sections"]
+            : ["id", "type", "name", "description", "position"],
         path: itemPath,
         errorFactory,
       });
@@ -425,6 +426,13 @@ const validateSceneItems = ({ items, path, errorFactory }) => {
       );
     }
 
+    if (item.description !== undefined && !isString(item.description)) {
+      return invalidFromErrorFactory(
+        errorFactory,
+        `${itemPath}.description must be a string when provided`,
+      );
+    }
+
     {
       const result = validateOptionalPosition({
         value: item.position,
@@ -2087,10 +2095,14 @@ const validateCharacterSpriteItems = ({ items, path, errorFactory }) => {
   }
 };
 
-const validateLayoutElementStyle = ({ style, path, errorFactory }) => {
+const validateLayoutElementTextStyle = ({
+  textStyle,
+  path,
+  errorFactory,
+}) => {
   {
     const result = validateAllowedKeys({
-      value: style,
+      value: textStyle,
       allowedKeys: ["align", "wordWrapWidth"],
       path,
       errorFactory,
@@ -2101,8 +2113,8 @@ const validateLayoutElementStyle = ({ style, path, errorFactory }) => {
   }
 
   if (
-    style.align !== undefined &&
-    !LAYOUT_ELEMENT_TEXT_STYLE_ALIGN_KEYS.includes(style.align)
+    textStyle.align !== undefined &&
+    !LAYOUT_ELEMENT_TEXT_STYLE_ALIGN_KEYS.includes(textStyle.align)
   ) {
     return invalidFromErrorFactory(
       errorFactory,
@@ -2111,8 +2123,8 @@ const validateLayoutElementStyle = ({ style, path, errorFactory }) => {
   }
 
   if (
-    style.wordWrapWidth !== undefined &&
-    !isFiniteNumber(style.wordWrapWidth)
+    textStyle.wordWrapWidth !== undefined &&
+    !isFiniteNumber(textStyle.wordWrapWidth)
   ) {
     return invalidFromErrorFactory(
       errorFactory,
@@ -2121,6 +2133,47 @@ const validateLayoutElementStyle = ({ style, path, errorFactory }) => {
   }
 };
 
+const validateLayoutElementBorder = ({ border, path, errorFactory }) => {
+  {
+    const result = validateAllowedKeys({
+      value: border,
+      allowedKeys: ["color", "alpha", "width"],
+      path,
+      errorFactory,
+    });
+    if (result?.valid === false) {
+      return result;
+    }
+  }
+
+  if (border.color !== undefined && !isString(border.color)) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      `${path}.color must be a string when provided`,
+    );
+  }
+
+  if (
+    border.alpha !== undefined &&
+    (!isFiniteNumber(border.alpha) || border.alpha < 0 || border.alpha > 1)
+  ) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      `${path}.alpha must be a finite number between 0 and 1 when provided`,
+    );
+  }
+
+  if (
+    border.width !== undefined &&
+    (!isFiniteNumber(border.width) || border.width < 0)
+  ) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      `${path}.width must be a finite number greater than or equal to 0 when provided`,
+    );
+  }
+};
+
 const validateLayoutElementData = ({
   data,
   path,
@@ -2144,8 +2197,10 @@ const validateLayoutElementData = ({
     "scaleY",
     "rotation",
     "opacity",
+    "fill",
+    "border",
     "text",
-    "style",
+    "textStyle",
     "displaySpeed",
     "imageId",
     "hoverImageId",
@@ -2273,6 +2328,13 @@ const validateLayoutElementData = ({
     }
   }
 
+  if (data.fill !== undefined && !isString(data.fill)) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      `${path}.fill must be a string when provided`,
+    );
+  }
+
   if (
     data.direction !== undefined &&
     data.direction !== "horizontal" &&
@@ -2301,11 +2363,31 @@ const validateLayoutElementData = ({
     );
   }
 
-  if (data.style !== undefined) {
+  if (data.textStyle !== undefined) {
+    {
+      const result = validateLayoutElementTextStyle({
+        textStyle: data.textStyle,
+        path: `${path}.textStyle`,
+        errorFactory,
+      });
+      if (result?.valid === false) {
+        return result;
+      }
+    }
+  }
+
+  if (data.border !== undefined) {
+    if (!isPlainObject(data.border)) {
+      return invalidFromErrorFactory(
+        errorFactory,
+        `${path}.border must be an object when provided`,
+      );
+    }
+
     {
-      const result = validateLayoutElementStyle({
-        style: data.style,
-        path: `${path}.style`,
+      const result = validateLayoutElementBorder({
+        border: data.border,
+        path: `${path}.border`,
         errorFactory,
       });
       if (result?.valid === false) {
@@ -2357,8 +2439,10 @@ const validateLayoutElementItems = ({ items, path, errorFactory }) => {
           "scaleY",
           "rotation",
           "opacity",
+          "fill",
+          "border",
           "text",
-          "style",
+          "textStyle",
           "displaySpeed",
           "imageId",
           "hoverImageId",
@@ -2630,7 +2714,6 @@ const validateLayoutItems = ({ items, path, errorFactory }) => {
           return result;
         }
       }
-
     }
   }
 };
@@ -4085,7 +4168,7 @@ const validateSceneCreateData = ({ data, errorFactory }) => {
   {
     const result = validateAllowedKeys({
       value: data,
-      allowedKeys: ["name", "type", "position"],
+      allowedKeys: ["name", "description", "type", "position"],
       path: "payload.data",
       errorFactory,
     });
@@ -4101,6 +4184,13 @@ const validateSceneCreateData = ({ data, errorFactory }) => {
     );
   }
 
+  if (data.description !== undefined && !isString(data.description)) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      "payload.data.description must be a string when provided",
+    );
+  }
+
   if (
     data.type !== undefined &&
     data.type !== "scene" &&
@@ -4128,7 +4218,7 @@ const validateSceneUpdateData = ({ data, errorFactory }) => {
   {
     const result = validateAllowedKeys({
       value: data,
-      allowedKeys: ["name", "position"],
+      allowedKeys: ["name", "description", "position"],
       path: "payload.data",
       errorFactory,
     });
@@ -4138,9 +4228,10 @@ const validateSceneUpdateData = ({ data, errorFactory }) => {
   }
 
   const hasName = data.name !== undefined;
+  const hasDescription = data.description !== undefined;
   const hasPosition = data.position !== undefined;
 
-  if (!hasName && !hasPosition) {
+  if (!hasName && !hasDescription && !hasPosition) {
     return invalidFromErrorFactory(
       errorFactory,
       "payload.data must include at least one updatable field",
@@ -4154,6 +4245,13 @@ const validateSceneUpdateData = ({ data, errorFactory }) => {
     );
   }
 
+  if (hasDescription && !isString(data.description)) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      "payload.data.description must be a string when provided",
+    );
+  }
+
   if (hasPosition) {
     {
       const result = validateOptionalPosition({
@@ -6055,7 +6153,6 @@ const validateLayoutCreateData = ({ data, errorFactory }) => {
         return result;
       }
     }
-
   }
 };
 
@@ -6095,7 +6192,6 @@ const validateLayoutUpdateData = ({ data, errorFactory }) => {
       "payload.data.layoutType must be 'normal', 'dialogue', 'nvl', or 'choice' when provided",
     );
   }
-
 };
 
 const validateControlCreateData = ({ data, errorFactory }) => {
@@ -7326,6 +7422,10 @@ const COMMAND_DEFINITIONS = [
         name: payload.data.name,
       };
 
+      if (payload.data.description !== undefined) {
+        nextScene.description = payload.data.description;
+      }
+
       if (nextScene.type === "scene") {
         nextScene.sections = createEmptyNestedCollection();
       }
@@ -7395,6 +7495,10 @@ const COMMAND_DEFINITIONS = [
         nextScene.name = payload.data.name;
       }
 
+      if (payload.data.description !== undefined) {
+        nextScene.description = payload.data.description;
+      }
+
       if (payload.data.position !== undefined) {
         nextScene.position = {
           ...(isPlainObject(nextScene.position) ? nextScene.position : {}),