@routevn/creator-model 1.0.4 → 1.1.0

package/package.json

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

package/src/model.js

@@ -52,33 +52,6 @@ const normalizeStateCollections = (state) => {
   };
 };
 const isString = (value) => typeof value === "string";
-const FILE_ITEM_TYPES = [
-  "image",
-  "image-thumbnail",
-  "audio",
-  "audio-waveform",
-  "video",
-  "video-thumbnail",
-  "font",
-];
-const IMAGE_FILE_REFERENCE_TYPES = {
-  fileId: ["image"],
-  thumbnailFileId: ["image-thumbnail"],
-};
-const SOUND_FILE_REFERENCE_TYPES = {
-  fileId: ["audio"],
-  waveformDataFileId: ["audio-waveform"],
-};
-const VIDEO_FILE_REFERENCE_TYPES = {
-  fileId: ["video"],
-  thumbnailFileId: ["video-thumbnail"],
-};
-const FONT_FILE_REFERENCE_TYPES = {
-  fileId: ["font"],
-};
-const CHARACTER_FILE_REFERENCE_TYPES = {
-  fileId: ["image"],
-};
 const isHexColor = (value) =>
   typeof value === "string" && /^#[0-9a-fA-F]{6}$/.test(value);
 const LIVE_TWEEN_PROPERTY_KEYS = [
@@ -139,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",
@@ -414,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,
       });
@@ -452,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,
@@ -581,10 +562,10 @@ const validateFileItems = ({ items, path, errorFactory }) => {
   for (const [itemId, item] of Object.entries(items)) {
     const itemPath = `${path}.${itemId}`;
 
-    if (item?.type !== "folder" && !FILE_ITEM_TYPES.includes(item?.type)) {
+    if (item?.type !== undefined && !isNonEmptyString(item.type)) {
       return invalidFromErrorFactory(
         errorFactory,
-        `${itemPath}.type must be 'folder' or a supported file type`,
+        `${itemPath}.type must be a non-empty string when provided`,
       );
     }
 
@@ -2148,6 +2129,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,
@@ -2171,6 +2193,8 @@ const validateLayoutElementData = ({
     "scaleY",
     "rotation",
     "opacity",
+    "fill",
+    "border",
     "text",
     "style",
     "displaySpeed",
@@ -2300,6 +2324,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" &&
@@ -2341,6 +2372,26 @@ const validateLayoutElementData = ({
     }
   }
 
+  if (data.border !== undefined) {
+    if (!isPlainObject(data.border)) {
+      return invalidFromErrorFactory(
+        errorFactory,
+        `${path}.border must be an object when provided`,
+      );
+    }
+
+    {
+      const result = validateLayoutElementBorder({
+        border: data.border,
+        path: `${path}.border`,
+        errorFactory,
+      });
+      if (result?.valid === false) {
+        return result;
+      }
+    }
+  }
+
   if (data.click !== undefined && !isPlainObject(data.click)) {
     return invalidFromErrorFactory(
       errorFactory,
@@ -2384,6 +2435,8 @@ const validateLayoutElementItems = ({ items, path, errorFactory }) => {
           "scaleY",
           "rotation",
           "opacity",
+          "fill",
+          "border",
           "text",
           "style",
           "displaySpeed",
@@ -2657,7 +2710,6 @@ const validateLayoutItems = ({ items, path, errorFactory }) => {
           return result;
         }
       }
-
     }
   }
 };
@@ -3493,7 +3545,6 @@ const validateFileReference = ({
   state,
   fileId,
   path,
-  allowedTypes,
   details = {},
   errorFactory = createPreconditionValidationError,
 }) => {
@@ -3501,36 +3552,10 @@ const validateFileReference = ({
     return VALID_RESULT;
   }
 
-  const expectedTypeMessage =
-    Array.isArray(allowedTypes) && allowedTypes.length > 0
-      ? `${path} must reference an existing non-folder file with type ${allowedTypes
-          .map((type) => `'${type}'`)
-          .join(" or ")}`
-      : `${path} must reference an existing non-folder file`;
+  const expectedTypeMessage = `${path} must reference an existing non-folder file`;
   const file = state.files?.items?.[fileId];
   if (!isPlainObject(file) || file.type === "folder") {
-    return invalidFromErrorFactory(
-      errorFactory,
-      expectedTypeMessage,
-      Array.isArray(allowedTypes) && allowedTypes.length > 0
-        ? {
-            ...details,
-            expectedFileTypes: [...allowedTypes],
-          }
-        : details,
-    );
-  }
-
-  if (
-    Array.isArray(allowedTypes) &&
-    allowedTypes.length > 0 &&
-    !allowedTypes.includes(file.type)
-  ) {
-    return invalidFromErrorFactory(errorFactory, expectedTypeMessage, {
-      ...details,
-      expectedFileTypes: [...allowedTypes],
-      actualFileType: file.type,
-    });
+    return invalidFromErrorFactory(errorFactory, expectedTypeMessage, details);
   }
 
   return VALID_RESULT;
@@ -3659,7 +3684,6 @@ export const assertInvariants = ({ state }) => {
         state,
         fileId: image.fileId,
         path: "image.fileId",
-        allowedTypes: IMAGE_FILE_REFERENCE_TYPES.fileId,
         details: { imageId, fileId: image.fileId },
         errorFactory: createInvariantValidationError,
       });
@@ -3673,7 +3697,6 @@ export const assertInvariants = ({ state }) => {
         state,
         fileId: image.thumbnailFileId,
         path: "image.thumbnailFileId",
-        allowedTypes: IMAGE_FILE_REFERENCE_TYPES.thumbnailFileId,
         details: { imageId, thumbnailFileId: image.thumbnailFileId },
         errorFactory: createInvariantValidationError,
       });
@@ -3693,7 +3716,6 @@ export const assertInvariants = ({ state }) => {
         state,
         fileId: sound.fileId,
         path: "sound.fileId",
-        allowedTypes: SOUND_FILE_REFERENCE_TYPES.fileId,
         details: { soundId, fileId: sound.fileId },
         errorFactory: createInvariantValidationError,
       });
@@ -3710,7 +3732,6 @@ export const assertInvariants = ({ state }) => {
         state,
         fileId: sound.waveformDataFileId,
         path: "sound.waveformDataFileId",
-        allowedTypes: SOUND_FILE_REFERENCE_TYPES.waveformDataFileId,
         details: { soundId, waveformDataFileId: sound.waveformDataFileId },
         errorFactory: createInvariantValidationError,
       });
@@ -3730,7 +3751,6 @@ export const assertInvariants = ({ state }) => {
         state,
         fileId: video.fileId,
         path: "video.fileId",
-        allowedTypes: VIDEO_FILE_REFERENCE_TYPES.fileId,
         details: { videoId, fileId: video.fileId },
         errorFactory: createInvariantValidationError,
       });
@@ -3744,7 +3764,6 @@ export const assertInvariants = ({ state }) => {
         state,
         fileId: video.thumbnailFileId,
         path: "video.thumbnailFileId",
-        allowedTypes: VIDEO_FILE_REFERENCE_TYPES.thumbnailFileId,
         details: { videoId, thumbnailFileId: video.thumbnailFileId },
         errorFactory: createInvariantValidationError,
       });
@@ -3763,7 +3782,6 @@ export const assertInvariants = ({ state }) => {
       state,
       fileId: font.fileId,
       path: "font.fileId",
-      allowedTypes: FONT_FILE_REFERENCE_TYPES.fileId,
       details: { fontId, fileId: font.fileId },
       errorFactory: createInvariantValidationError,
     });
@@ -3784,7 +3802,6 @@ export const assertInvariants = ({ state }) => {
         state,
         fileId: character.fileId,
         path: "character.fileId",
-        allowedTypes: CHARACTER_FILE_REFERENCE_TYPES.fileId,
         details: { characterId, fileId: character.fileId },
         errorFactory: createInvariantValidationError,
       });
@@ -3804,7 +3821,6 @@ export const assertInvariants = ({ state }) => {
         state,
         fileId: sprite.fileId,
         path: "character.sprite.fileId",
-        allowedTypes: CHARACTER_FILE_REFERENCE_TYPES.fileId,
         details: { characterId, spriteId, fileId: sprite.fileId },
         errorFactory: createInvariantValidationError,
       });
@@ -4148,7 +4164,7 @@ const validateSceneCreateData = ({ data, errorFactory }) => {
   {
     const result = validateAllowedKeys({
       value: data,
-      allowedKeys: ["name", "type", "position"],
+      allowedKeys: ["name", "description", "type", "position"],
       path: "payload.data",
       errorFactory,
     });
@@ -4164,6 +4180,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" &&
@@ -4191,7 +4214,7 @@ const validateSceneUpdateData = ({ data, errorFactory }) => {
   {
     const result = validateAllowedKeys({
       value: data,
-      allowedKeys: ["name", "position"],
+      allowedKeys: ["name", "description", "position"],
       path: "payload.data",
       errorFactory,
     });
@@ -4201,9 +4224,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",
@@ -4217,6 +4241,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({
@@ -5060,10 +5091,10 @@ const validateFileCreateData = ({ data, errorFactory }) => {
     );
   }
 
-  if (data.type !== "folder" && !FILE_ITEM_TYPES.includes(data.type)) {
+  if (data.type !== undefined && !isNonEmptyString(data.type)) {
     return invalidFromErrorFactory(
       errorFactory,
-      "payload.data.type must be 'folder' or a supported file type",
+      "payload.data.type must be a non-empty string when provided",
     );
   }
 
@@ -5118,7 +5149,6 @@ const validateReferencedFilesInData = ({
   state,
   data,
   fields,
-  fieldTypes = {},
   nullableFields = [],
   details = {},
   errorFactory = createPreconditionValidationError,
@@ -5138,7 +5168,6 @@ const validateReferencedFilesInData = ({
       state,
       fileId,
       path: `payload.data.${field}`,
-      allowedTypes: fieldTypes[field],
       details: {
         ...details,
         field,
@@ -6120,7 +6149,6 @@ const validateLayoutCreateData = ({ data, errorFactory }) => {
         return result;
       }
     }
-
   }
 };
 
@@ -6160,7 +6188,6 @@ const validateLayoutUpdateData = ({ data, errorFactory }) => {
       "payload.data.layoutType must be 'normal', 'dialogue', 'nvl', or 'choice' when provided",
     );
   }
-
 };
 
 const validateControlCreateData = ({ data, errorFactory }) => {
@@ -7198,7 +7225,6 @@ const COMMAND_DEFINITIONS = [
           }
         : {
             id: payload.fileId,
-            type: payload.data.type,
             mimeType: payload.data.mimeType,
             size: payload.data.size,
             sha256: payload.data.sha256,
@@ -7392,6 +7418,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();
       }
@@ -7461,6 +7491,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 : {}),
@@ -8548,7 +8582,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId", "thumbnailFileId"],
-          fieldTypes: IMAGE_FILE_REFERENCE_TYPES,
           details: {
             imageId: payload.imageId,
           },
@@ -8661,7 +8694,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId", "thumbnailFileId"],
-          fieldTypes: IMAGE_FILE_REFERENCE_TYPES,
           details: {
             imageId: payload.imageId,
           },
@@ -8974,7 +9006,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId", "waveformDataFileId"],
-          fieldTypes: SOUND_FILE_REFERENCE_TYPES,
           nullableFields: ["waveformDataFileId"],
           details: {
             soundId: payload.soundId,
@@ -9084,7 +9115,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId", "waveformDataFileId"],
-          fieldTypes: SOUND_FILE_REFERENCE_TYPES,
           nullableFields: ["waveformDataFileId"],
           details: {
             soundId: payload.soundId,
@@ -9398,7 +9428,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId", "thumbnailFileId"],
-          fieldTypes: VIDEO_FILE_REFERENCE_TYPES,
           details: {
             videoId: payload.videoId,
           },
@@ -9509,7 +9538,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId", "thumbnailFileId"],
-          fieldTypes: VIDEO_FILE_REFERENCE_TYPES,
           details: {
             videoId: payload.videoId,
           },
@@ -10196,7 +10224,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId"],
-          fieldTypes: FONT_FILE_REFERENCE_TYPES,
           details: {
             fontId: payload.fontId,
           },
@@ -10295,7 +10322,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId"],
-          fieldTypes: FONT_FILE_REFERENCE_TYPES,
           details: {
             fontId: payload.fontId,
           },
@@ -11081,7 +11107,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId"],
-          fieldTypes: CHARACTER_FILE_REFERENCE_TYPES,
           details: {
             characterId: payload.characterId,
           },
@@ -11102,7 +11127,6 @@ const COMMAND_DEFINITIONS = [
           state,
           fileId: sprite.fileId,
           path: "payload.data.sprites.items.*.fileId",
-          allowedTypes: CHARACTER_FILE_REFERENCE_TYPES.fileId,
           details: {
             characterId: payload.characterId,
             spriteId,
@@ -11129,7 +11153,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId"],
-          fieldTypes: CHARACTER_FILE_REFERENCE_TYPES,
           details: {
             characterId: payload.characterId,
           },
@@ -11314,7 +11337,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId"],
-          fieldTypes: CHARACTER_FILE_REFERENCE_TYPES,
           details: {
             characterId: payload.characterId,
             spriteId: payload.spriteId,
@@ -11418,7 +11440,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId"],
-          fieldTypes: CHARACTER_FILE_REFERENCE_TYPES,
           details: {
             characterId: payload.characterId,
             spriteId: payload.spriteId,