@routevn/creator-model 1.4.1 → 1.5.1

package/README.md

@@ -293,6 +293,7 @@ Currently implemented command types:
 - `layout.update`
 - `layout.delete`
 - `layout.move`
+- `layout.schema.upgrade`
 - `character.sprite.create`
 - `character.sprite.update`
 - `character.sprite.delete`

package/package.json

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

package/src/model.js

@@ -40,7 +40,12 @@ const LINE_UPDATE_ACTIONS_PRESERVE_PATHS = ["dialogue.content"];
 const LINE_UPDATE_ACTIONS_PRESERVE_PATHS_SET = new Set(
   LINE_UPDATE_ACTIONS_PRESERVE_PATHS,
 );
+const CURRENT_LAYOUT_SCHEMA_VERSION = 2;
 const isPositiveFiniteNumber = (value) => isFiniteNumber(value) && value > 0;
+const normalizeLayoutSchemaVersion = (value) =>
+  Number.isInteger(value) && value >= 1 ? value : 1;
+const isSupportedLayoutSchemaVersion = (value) =>
+  value === CURRENT_LAYOUT_SCHEMA_VERSION;
 const createEmptyCollectionState = () => ({
   items: {},
   tree: [],
@@ -376,7 +381,7 @@ const LAYOUT_ELEMENT_BASE_TYPES = [
   "container-ref-confirm-dialog-ok",
   "container-ref-confirm-dialog-cancel",
 ];
-export const SCHEMA_VERSION = 4;
+export const SCHEMA_VERSION = 5;
 const LAYOUT_CONTAINER_ELEMENT_TYPES = [
   "folder",
   "container",
@@ -3392,6 +3397,8 @@ const validateLayoutElementData = ({
     "hover",
     "click",
     "rightClick",
+    "scrollUp",
+    "scrollDown",
     "anchorToBottom",
     "thumbImageId",
     "barImageId",
@@ -3841,6 +3848,32 @@ const validateLayoutElementData = ({
     }
   }
 
+  if (data.scrollUp !== undefined) {
+    {
+      const result = validateLayoutElementInteraction({
+        interaction: data.scrollUp,
+        path: `${path}.scrollUp`,
+        errorFactory,
+      });
+      if (result?.valid === false) {
+        return result;
+      }
+    }
+  }
+
+  if (data.scrollDown !== undefined) {
+    {
+      const result = validateLayoutElementInteraction({
+        interaction: data.scrollDown,
+        path: `${path}.scrollDown`,
+        errorFactory,
+      });
+      if (result?.valid === false) {
+        return result;
+      }
+    }
+  }
+
   if (
     data.anchorToBottom !== undefined &&
     typeof data.anchorToBottom !== "boolean"
@@ -3940,6 +3973,8 @@ const validateLayoutElementItems = ({ items, path, errorFactory }) => {
           "hover",
           "click",
           "rightClick",
+          "scrollUp",
+          "scrollDown",
           "anchorToBottom",
           "thumbImageId",
           "barImageId",
@@ -4967,6 +5002,7 @@ const validateLayoutItems = ({ items, path, errorFactory }) => {
                 "description",
                 "tagIds",
                 "layoutType",
+                "layoutSchemaVersion",
                 "isFragment",
                 "thumbnailFileId",
                 "preview",
@@ -5049,6 +5085,16 @@ const validateLayoutItems = ({ items, path, errorFactory }) => {
         );
       }
 
+      if (
+        item.layoutSchemaVersion !== undefined &&
+        !isSupportedLayoutSchemaVersion(item.layoutSchemaVersion)
+      ) {
+        return invalidFromErrorFactory(
+          errorFactory,
+          `${itemPath}.layoutSchemaVersion must be ${CURRENT_LAYOUT_SCHEMA_VERSION} when provided`,
+        );
+      }
+
       if (
         item.isFragment !== undefined &&
         typeof item.isFragment !== "boolean"
@@ -10490,6 +10536,7 @@ const validateLayoutCreateData = ({ data, errorFactory }) => {
               "description",
               "tagIds",
               "layoutType",
+              "layoutSchemaVersion",
               "isFragment",
               "thumbnailFileId",
               "preview",
@@ -10557,6 +10604,16 @@ const validateLayoutCreateData = ({ data, errorFactory }) => {
       );
     }
 
+    if (
+      data.layoutSchemaVersion !== undefined &&
+      !isSupportedLayoutSchemaVersion(data.layoutSchemaVersion)
+    ) {
+      return invalidFromErrorFactory(
+        errorFactory,
+        `payload.data.layoutSchemaVersion must be ${CURRENT_LAYOUT_SCHEMA_VERSION} when provided`,
+      );
+    }
+
     if (data.isFragment !== undefined && typeof data.isFragment !== "boolean") {
       return invalidFromErrorFactory(
         errorFactory,
@@ -11363,6 +11420,32 @@ const createEmptyNestedCollection = () => ({
   tree: [],
 });
 
+const isDirectedLayoutContainer = (item) =>
+  item?.direction === "horizontal" || item?.direction === "vertical";
+
+const upgradeLayoutTreeOrder = ({ nodes, items, parentItem } = {}) => {
+  const sourceNodes = Array.isArray(nodes) ? nodes : [];
+  const orderedNodes = isDirectedLayoutContainer(parentItem)
+    ? sourceNodes
+    : [...sourceNodes].reverse();
+
+  return orderedNodes.map((node) => {
+    const nextNode = {
+      ...node,
+    };
+
+    if (Array.isArray(node?.children) && node.children.length > 0) {
+      nextNode.children = upgradeLayoutTreeOrder({
+        nodes: node.children,
+        items,
+        parentItem: items?.[node.id],
+      });
+    }
+
+    return nextNode;
+  });
+};
+
 const findSectionLocation = ({ state, sectionId }) => {
   for (const [sceneId, scene] of Object.entries(state.scenes.items)) {
     if (scene?.type !== "scene") {
@@ -16836,6 +16919,11 @@ const COMMAND_DEFINITIONS = [
                 }
               : {}),
             layoutType: payload.data.layoutType,
+            ...(payload.data.layoutSchemaVersion !== undefined
+              ? {
+                  layoutSchemaVersion: payload.data.layoutSchemaVersion,
+                }
+              : {}),
             isFragment: payload.data.isFragment,
             ...(payload.data.thumbnailFileId !== undefined
               ? {
@@ -16924,6 +17012,75 @@ const COMMAND_DEFINITIONS = [
       }
     },
   }),
+  {
+    type: "layout.schema.upgrade",
+    validatePayload: ({ payload }) => {
+      {
+        const result = validateExactKeys({
+          value: payload,
+          expectedKeys: ["layoutIds", "targetSchemaVersion"],
+          path: "payload",
+          errorFactory: createPayloadValidationError,
+        });
+        if (result?.valid === false) {
+          return result;
+        }
+      }
+
+      {
+        const result = validateRequiredUniqueIdArray({
+          value: payload.layoutIds,
+          path: "payload.layoutIds",
+          errorFactory: createPayloadValidationError,
+        });
+        if (result?.valid === false) {
+          return result;
+        }
+      }
+
+      if (payload.targetSchemaVersion !== CURRENT_LAYOUT_SCHEMA_VERSION) {
+        return invalidPayload(
+          `payload.targetSchemaVersion must be ${CURRENT_LAYOUT_SCHEMA_VERSION}`,
+        );
+      }
+
+      return VALID_RESULT;
+    },
+    validateAgainstState: ({ state, payload }) => {
+      for (const layoutId of payload.layoutIds) {
+        const layout = state.layouts.items[layoutId];
+        if (!isPlainObject(layout) || layout.type !== "layout") {
+          return invalidPrecondition(
+            "payload.layoutIds must reference existing layouts",
+            {
+              layoutId,
+            },
+          );
+        }
+      }
+
+      return VALID_RESULT;
+    },
+    reduce: ({ state, payload }) => {
+      for (const layoutId of payload.layoutIds) {
+        const layout = state.layouts.items[layoutId];
+        if (
+          normalizeLayoutSchemaVersion(layout.layoutSchemaVersion) >=
+          payload.targetSchemaVersion
+        ) {
+          continue;
+        }
+
+        layout.elements.tree = upgradeLayoutTreeOrder({
+          nodes: layout.elements.tree,
+          items: layout.elements.items,
+        });
+        layout.layoutSchemaVersion = payload.targetSchemaVersion;
+      }
+
+      return state;
+    },
+  },
   ...createFolderedCollectionCommandDefinitions({
     familyName: "control",
     collectionKey: "controls",