@routevn/creator-model 1.5.0 → 1.5.2

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.5.0",
+  "version": "1.5.2",
   "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: [],
@@ -2205,7 +2210,7 @@ const validateAnimationItems = ({ items, path, errorFactory }) => {
       }
 
       {
-        const result = validatePreviewObject({
+        const result = validateAnimationPreviewObject({
           value: item.preview,
           path: `${itemPath}.preview`,
           errorFactory,
@@ -4901,6 +4906,102 @@ const validatePreviewObject = ({ value, path, errorFactory }) => {
   return VALID_RESULT;
 };
 
+const validateAnimationPreviewSlot = ({
+  value,
+  path,
+  allowTransform = false,
+  errorFactory,
+}) => {
+  if (value === undefined) {
+    return VALID_RESULT;
+  }
+
+  if (!isPlainObject(value)) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      `${path} must be an object when provided`,
+    );
+  }
+
+  {
+    const result = validateAllowedKeys({
+      value,
+      allowedKeys: allowTransform ? ["imageId", "transformId"] : ["imageId"],
+      path,
+      errorFactory,
+    });
+    if (result?.valid === false) {
+      return result;
+    }
+  }
+
+  if (value.imageId !== undefined && !isNonEmptyString(value.imageId)) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      `${path}.imageId must be a non-empty string when provided`,
+    );
+  }
+
+  if (value.transformId !== undefined && !isNonEmptyString(value.transformId)) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      `${path}.transformId must be a non-empty string when provided`,
+    );
+  }
+
+  return VALID_RESULT;
+};
+
+const validateAnimationPreviewObject = ({ value, path, errorFactory }) => {
+  if (value === undefined) {
+    return VALID_RESULT;
+  }
+
+  if (!isPlainObject(value)) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      `${path} must be an object when provided`,
+    );
+  }
+
+  {
+    const result = validateAllowedKeys({
+      value,
+      allowedKeys: ["background", "target", "outgoing", "incoming"],
+      path,
+      errorFactory,
+    });
+    if (result?.valid === false) {
+      return result;
+    }
+  }
+
+  {
+    const result = validateAnimationPreviewSlot({
+      value: value.background,
+      path: `${path}.background`,
+      errorFactory,
+    });
+    if (result?.valid === false) {
+      return result;
+    }
+  }
+
+  for (const key of ["target", "outgoing", "incoming"]) {
+    const result = validateAnimationPreviewSlot({
+      value: value[key],
+      path: `${path}.${key}`,
+      allowTransform: true,
+      errorFactory,
+    });
+    if (result?.valid === false) {
+      return result;
+    }
+  }
+
+  return VALID_RESULT;
+};
+
 const validateTransformPreviewSlot = ({ value, path, errorFactory }) => {
   if (value === undefined) {
     return VALID_RESULT;
@@ -4997,6 +5098,7 @@ const validateLayoutItems = ({ items, path, errorFactory }) => {
                 "description",
                 "tagIds",
                 "layoutType",
+                "layoutSchemaVersion",
                 "isFragment",
                 "thumbnailFileId",
                 "preview",
@@ -5079,6 +5181,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"
@@ -9148,7 +9260,7 @@ const validateAnimationCreateData = ({ data, errorFactory }) => {
     }
 
     {
-      const result = validatePreviewObject({
+      const result = validateAnimationPreviewObject({
         value: data.preview,
         path: "payload.data.preview",
         errorFactory,
@@ -9234,7 +9346,7 @@ const validateAnimationUpdateData = ({ data, errorFactory }) => {
   }
 
   {
-    const result = validatePreviewObject({
+    const result = validateAnimationPreviewObject({
       value: data.preview,
       path: "payload.data.preview",
       errorFactory,
@@ -10520,6 +10632,7 @@ const validateLayoutCreateData = ({ data, errorFactory }) => {
               "description",
               "tagIds",
               "layoutType",
+              "layoutSchemaVersion",
               "isFragment",
               "thumbnailFileId",
               "preview",
@@ -10587,6 +10700,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,
@@ -11393,6 +11516,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") {
@@ -16866,6 +17015,11 @@ const COMMAND_DEFINITIONS = [
                 }
               : {}),
             layoutType: payload.data.layoutType,
+            ...(payload.data.layoutSchemaVersion !== undefined
+              ? {
+                  layoutSchemaVersion: payload.data.layoutSchemaVersion,
+                }
+              : {}),
             isFragment: payload.data.isFragment,
             ...(payload.data.thumbnailFileId !== undefined
               ? {
@@ -16954,6 +17108,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",