@routevn/creator-model 1.10.0 → 1.10.2

package/package.json

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

package/src/model.js

@@ -353,6 +353,7 @@ const LAYOUT_TYPE_KEYS = [
 ];
 const LAYOUT_ELEMENT_TEXT_STYLE_ALIGN_KEYS = ["left", "center", "right"];
 const LAYOUT_TEXT_REVEAL_EFFECT_KEYS = ["typewriter", "softWipe", "none"];
+const LAYOUT_TEXT_REVEAL_SOUND_STOP_TIMING_KEYS = ["loopEnd", "immediate"];
 const LAYOUT_ELEMENT_BLUR_KERNEL_SIZE_OPTIONS = [5, 7, 9, 11, 13, 15];
 const CONTROL_KEYBOARD_KEYS = [
   "enter",
@@ -3066,6 +3067,60 @@ const validateVariableItems = ({ items, path, errorFactory }) => {
   }
 };
 
+const validateTextStyleShadow = ({ shadow, path, errorFactory }) => {
+  if (!isPlainObject(shadow)) {
+    return invalidFromErrorFactory(errorFactory, `${path} must be an object`);
+  }
+
+  {
+    const result = validateAllowedKeys({
+      value: shadow,
+      allowedKeys: ["colorId", "alpha", "blur", "offsetX", "offsetY"],
+      path,
+      errorFactory,
+    });
+    if (result?.valid === false) {
+      return result;
+    }
+  }
+
+  if (!isNonEmptyString(shadow.colorId)) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      `${path}.colorId must be a non-empty string`,
+    );
+  }
+
+  if (
+    shadow.alpha !== undefined &&
+    (!isFiniteNumber(shadow.alpha) || shadow.alpha < 0 || shadow.alpha > 1)
+  ) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      `${path}.alpha must be a finite number between 0 and 1 when provided`,
+    );
+  }
+
+  if (
+    shadow.blur !== undefined &&
+    (!isFiniteNumber(shadow.blur) || shadow.blur < 0)
+  ) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      `${path}.blur must be a non-negative finite number when provided`,
+    );
+  }
+
+  for (const key of ["offsetX", "offsetY"]) {
+    if (shadow[key] !== undefined && !isFiniteNumber(shadow[key])) {
+      return invalidFromErrorFactory(
+        errorFactory,
+        `${path}.${key} must be a finite number when provided`,
+      );
+    }
+  }
+};
+
 const validateTextStyleItems = ({ items, path, errorFactory }) => {
   for (const [itemId, item] of Object.entries(items)) {
     const itemPath = `${path}.${itemId}`;
@@ -3103,6 +3158,7 @@ const validateTextStyleItems = ({ items, path, errorFactory }) => {
                 "strokeColorId",
                 "strokeAlpha",
                 "strokeWidth",
+                "shadow",
               ],
         path: itemPath,
         errorFactory,
@@ -3262,6 +3318,17 @@ const validateTextStyleItems = ({ items, path, errorFactory }) => {
           `${itemPath}.strokeWidth must be a finite number when provided`,
         );
       }
+
+      if (item.shadow !== undefined) {
+        const result = validateTextStyleShadow({
+          shadow: item.shadow,
+          path: `${itemPath}.shadow`,
+          errorFactory,
+        });
+        if (result?.valid === false) {
+          return result;
+        }
+      }
     }
   }
 };
@@ -3819,6 +3886,7 @@ const validateLayoutElementData = ({
     "hoverSoundId",
     "clickSoundId",
     "revealSoundId",
+    "revealSoundStopTiming",
     "textStyleId",
     "hoverTextStyleId",
     "clickTextStyleId",
@@ -4054,6 +4122,7 @@ const validateLayoutElementData = ({
     "hoverSoundId",
     "clickSoundId",
     "revealSoundId",
+    "revealSoundStopTiming",
     "textStyleId",
     "hoverTextStyleId",
     "clickTextStyleId",
@@ -4332,6 +4401,18 @@ const validateLayoutElementData = ({
     );
   }
 
+  if (
+    data.revealSoundStopTiming !== undefined &&
+    !LAYOUT_TEXT_REVEAL_SOUND_STOP_TIMING_KEYS.includes(
+      data.revealSoundStopTiming,
+    )
+  ) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      `${path}.revealSoundStopTiming must be one of ${LAYOUT_TEXT_REVEAL_SOUND_STOP_TIMING_KEYS.join(", ")} when provided`,
+    );
+  }
+
   if (data.formRole !== undefined && data.formRole !== "submit") {
     return invalidFromErrorFactory(
       errorFactory,
@@ -4574,6 +4655,7 @@ const validateLayoutElementItems = ({ items, path, errorFactory }) => {
           "hoverSoundId",
           "clickSoundId",
           "revealSoundId",
+          "revealSoundStopTiming",
           "textStyleId",
           "hoverTextStyleId",
           "clickTextStyleId",
@@ -5207,6 +5289,22 @@ const applyTagIdsUpdate = ({ currentItem, data }) => {
   return nextItem;
 };
 
+const applyTextStyleUpdate = ({ currentItem, data }) => {
+  const nextData = structuredClone(data);
+  delete nextData.clearShadow;
+
+  const nextItem = applyTagIdsUpdate({
+    currentItem,
+    data: nextData,
+  });
+
+  if (data.clearShadow === true) {
+    delete nextItem.shadow;
+  }
+
+  return nextItem;
+};
+
 const applyCharacterUpdate = ({ currentItem, data }) => {
   const nextItem = applyTagIdsUpdate({
     currentItem,
@@ -7098,6 +7196,19 @@ export const assertInvariants = ({ state }) => {
         );
       }
     }
+
+    if (textStyle.shadow !== undefined) {
+      const shadowColor = state.colors.items[textStyle.shadow.colorId];
+      if (!isPlainObject(shadowColor) || shadowColor.type === "folder") {
+        return invalidInvariant(
+          "textStyle.shadow.colorId must reference an existing non-folder color",
+          {
+            textStyleId,
+            colorId: textStyle.shadow.colorId,
+          },
+        );
+      }
+    }
   }
 
   for (const [imageId, image] of Object.entries(state.images.items)) {
@@ -11023,6 +11134,7 @@ const validateTextStyleCreateData = ({ data, errorFactory }) => {
               "strokeColorId",
               "strokeAlpha",
               "strokeWidth",
+              "shadow",
             ],
       path: "payload.data",
       errorFactory,
@@ -11098,6 +11210,8 @@ const validateTextStyleUpdateData = ({ data, errorFactory }) => {
         "strokeColorId",
         "strokeAlpha",
         "strokeWidth",
+        "shadow",
+        "clearShadow",
       ],
       path: "payload.data",
       errorFactory,
@@ -11166,6 +11280,31 @@ const validateTextStyleUpdateData = ({ data, errorFactory }) => {
     }
   }
 
+  if (data.shadow !== undefined) {
+    const result = validateTextStyleShadow({
+      shadow: data.shadow,
+      path: "payload.data.shadow",
+      errorFactory,
+    });
+    if (result?.valid === false) {
+      return result;
+    }
+  }
+
+  if (data.clearShadow !== undefined && data.clearShadow !== true) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      "payload.data.clearShadow must be true when provided",
+    );
+  }
+
+  if (data.shadow !== undefined && data.clearShadow === true) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      "payload.data.shadow and payload.data.clearShadow cannot both be provided",
+    );
+  }
+
   if (data.breakWords !== undefined && typeof data.breakWords !== "boolean") {
     return invalidFromErrorFactory(
       errorFactory,
@@ -18322,7 +18461,7 @@ const COMMAND_DEFINITIONS = [
       };
     },
     updateItem: ({ currentItem, payload }) =>
-      applyTagIdsUpdate({
+      applyTextStyleUpdate({
         currentItem,
         data: payload.data,
       }),
@@ -18360,6 +18499,15 @@ const COMMAND_DEFINITIONS = [
           );
         }
       }
+
+      if (data.shadow !== undefined) {
+        const shadowColor = state.colors.items[data.shadow.colorId];
+        if (!isPlainObject(shadowColor) || shadowColor.type === "folder") {
+          return invalidPrecondition(
+            "payload.data.shadow.colorId must reference an existing non-folder color",
+          );
+        }
+      }
     },
     validateUpdateState: ({ state, payload, currentItem }) => {
       if (
@@ -18403,6 +18551,15 @@ const COMMAND_DEFINITIONS = [
           );
         }
       }
+
+      if (payload.data.shadow !== undefined) {
+        const shadowColor = state.colors.items[payload.data.shadow.colorId];
+        if (!isPlainObject(shadowColor) || shadowColor.type === "folder") {
+          return invalidPrecondition(
+            "payload.data.shadow.colorId must reference an existing non-folder color",
+          );
+        }
+      }
     },
   }),
   ...createFolderedCollectionCommandDefinitions({