@routevn/creator-model 1.0.4 → 1.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routevn/creator-model",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "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 = [
@@ -581,10 +554,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`,
       );
     }
 
@@ -3493,7 +3466,6 @@ const validateFileReference = ({
   state,
   fileId,
   path,
-  allowedTypes,
   details = {},
   errorFactory = createPreconditionValidationError,
 }) => {
@@ -3501,36 +3473,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 +3605,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 +3618,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 +3637,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 +3653,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 +3672,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 +3685,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 +3703,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 +3723,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 +3742,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,
       });
@@ -5060,10 +4997,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 +5055,6 @@ const validateReferencedFilesInData = ({
   state,
   data,
   fields,
-  fieldTypes = {},
   nullableFields = [],
   details = {},
   errorFactory = createPreconditionValidationError,
@@ -5138,7 +5074,6 @@ const validateReferencedFilesInData = ({
       state,
       fileId,
       path: `payload.data.${field}`,
-      allowedTypes: fieldTypes[field],
       details: {
         ...details,
         field,
@@ -7198,7 +7133,6 @@ const COMMAND_DEFINITIONS = [
           }
         : {
             id: payload.fileId,
-            type: payload.data.type,
             mimeType: payload.data.mimeType,
             size: payload.data.size,
             sha256: payload.data.sha256,
@@ -8548,7 +8482,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId", "thumbnailFileId"],
-          fieldTypes: IMAGE_FILE_REFERENCE_TYPES,
           details: {
             imageId: payload.imageId,
           },
@@ -8661,7 +8594,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId", "thumbnailFileId"],
-          fieldTypes: IMAGE_FILE_REFERENCE_TYPES,
           details: {
             imageId: payload.imageId,
           },
@@ -8974,7 +8906,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId", "waveformDataFileId"],
-          fieldTypes: SOUND_FILE_REFERENCE_TYPES,
           nullableFields: ["waveformDataFileId"],
           details: {
             soundId: payload.soundId,
@@ -9084,7 +9015,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId", "waveformDataFileId"],
-          fieldTypes: SOUND_FILE_REFERENCE_TYPES,
           nullableFields: ["waveformDataFileId"],
           details: {
             soundId: payload.soundId,
@@ -9398,7 +9328,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId", "thumbnailFileId"],
-          fieldTypes: VIDEO_FILE_REFERENCE_TYPES,
           details: {
             videoId: payload.videoId,
           },
@@ -9509,7 +9438,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId", "thumbnailFileId"],
-          fieldTypes: VIDEO_FILE_REFERENCE_TYPES,
           details: {
             videoId: payload.videoId,
           },
@@ -10196,7 +10124,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId"],
-          fieldTypes: FONT_FILE_REFERENCE_TYPES,
           details: {
             fontId: payload.fontId,
           },
@@ -10295,7 +10222,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId"],
-          fieldTypes: FONT_FILE_REFERENCE_TYPES,
           details: {
             fontId: payload.fontId,
           },
@@ -11081,7 +11007,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId"],
-          fieldTypes: CHARACTER_FILE_REFERENCE_TYPES,
           details: {
             characterId: payload.characterId,
           },
@@ -11102,7 +11027,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 +11053,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId"],
-          fieldTypes: CHARACTER_FILE_REFERENCE_TYPES,
           details: {
             characterId: payload.characterId,
           },
@@ -11314,7 +11237,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId"],
-          fieldTypes: CHARACTER_FILE_REFERENCE_TYPES,
           details: {
             characterId: payload.characterId,
             spriteId: payload.spriteId,
@@ -11418,7 +11340,6 @@ const COMMAND_DEFINITIONS = [
           state,
           data: payload.data,
           fields: ["fileId"],
-          fieldTypes: CHARACTER_FILE_REFERENCE_TYPES,
           details: {
             characterId: payload.characterId,
             spriteId: payload.spriteId,