@routevn/creator-model 1.1.5 → 1.1.6

package/package.json

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

package/src/model.js

@@ -116,6 +116,7 @@ const LAYOUT_TYPE_KEYS = [
   "dialogue",
   "nvl",
   "choice",
+  "history",
 ];
 const LAYOUT_ELEMENT_TEXT_STYLE_ALIGN_KEYS = ["left", "center", "right"];
 const LAYOUT_TEXT_REVEAL_EFFECT_KEYS = ["typewriter", "softWipe", "none"];
@@ -133,11 +134,14 @@ const LAYOUT_ELEMENT_BASE_TYPES = [
   "text-ref-save-load-slot-date",
   "text-ref-dialogue-line-character-name",
   "text-ref-dialogue-line-content",
+  "text-ref-history-line-character-name",
+  "text-ref-history-line-content",
   "sprite-ref-save-load-slot-image",
   "fragment-ref",
   "container-ref-choice-item",
   "container-ref-save-load-slot",
   "container-ref-dialogue-line",
+  "container-ref-history-line",
   "container-ref-confirm-dialog-ok",
   "container-ref-confirm-dialog-cancel",
 ];
@@ -148,6 +152,7 @@ const LAYOUT_CONTAINER_ELEMENT_TYPES = [
   "container-ref-choice-item",
   "container-ref-save-load-slot",
   "container-ref-dialogue-line",
+  "container-ref-history-line",
   "container-ref-confirm-dialog-ok",
   "container-ref-confirm-dialog-cancel",
 ];
@@ -3043,6 +3048,7 @@ const validateLayoutItems = ({ items, path, errorFactory }) => {
                 "description",
                 "layoutType",
                 "isFragment",
+                "thumbnailFileId",
                 "elements",
               ],
         path: itemPath,
@@ -3081,11 +3087,21 @@ const validateLayoutItems = ({ items, path, errorFactory }) => {
       );
     }
 
+    if (
+      item.thumbnailFileId !== undefined &&
+      !isNonEmptyString(item.thumbnailFileId)
+    ) {
+      return invalidFromErrorFactory(
+        errorFactory,
+        `${itemPath}.thumbnailFileId must be a non-empty string when provided`,
+      );
+    }
+
     if (item.type === "layout") {
       if (!LAYOUT_TYPE_KEYS.includes(item.layoutType)) {
         return invalidFromErrorFactory(
           errorFactory,
-          `${itemPath}.layoutType must be 'normal', 'save-load', 'confirmDialog', 'dialogue', 'nvl', or 'choice'`,
+          `${itemPath}.layoutType must be 'normal', 'save-load', 'confirmDialog', 'dialogue', 'nvl', 'choice', or 'history'`,
         );
       }
 
@@ -3132,7 +3148,7 @@ const validateControlItems = ({ items, path, errorFactory }) => {
         allowedKeys:
           item.type === "folder"
             ? ["id", "type", "name"]
-            : ["id", "type", "name", "elements", "keyboard"],
+            : ["id", "type", "name", "thumbnailFileId", "elements", "keyboard"],
         path: itemPath,
         errorFactory,
       });
@@ -3162,6 +3178,16 @@ const validateControlItems = ({ items, path, errorFactory }) => {
       );
     }
 
+    if (
+      item.thumbnailFileId !== undefined &&
+      !isNonEmptyString(item.thumbnailFileId)
+    ) {
+      return invalidFromErrorFactory(
+        errorFactory,
+        `${itemPath}.thumbnailFileId must be a non-empty string when provided`,
+      );
+    }
+
     if (item.type === "control") {
       {
         const result = validateNestedCollection({
@@ -4231,6 +4257,40 @@ export const assertInvariants = ({ state }) => {
     }
   }
 
+  for (const [layoutId, layout] of Object.entries(state.layouts.items)) {
+    if (layout.type !== "layout" || layout.thumbnailFileId === undefined) {
+      continue;
+    }
+
+    const result = validateFileReference({
+      state,
+      fileId: layout.thumbnailFileId,
+      path: "layout.thumbnailFileId",
+      details: { layoutId, thumbnailFileId: layout.thumbnailFileId },
+      errorFactory: createInvariantValidationError,
+    });
+    if (!result.valid) {
+      return result;
+    }
+  }
+
+  for (const [controlId, control] of Object.entries(state.controls.items)) {
+    if (control.type !== "control" || control.thumbnailFileId === undefined) {
+      continue;
+    }
+
+    const result = validateFileReference({
+      state,
+      fileId: control.thumbnailFileId,
+      path: "control.thumbnailFileId",
+      details: { controlId, thumbnailFileId: control.thumbnailFileId },
+      errorFactory: createInvariantValidationError,
+    });
+    if (!result.valid) {
+      return result;
+    }
+  }
+
   const assertImageReference = ({
     ownerIdField,
     ownerId,
@@ -6603,6 +6663,7 @@ const validateLayoutCreateData = ({ data, errorFactory }) => {
               "description",
               "layoutType",
               "isFragment",
+              "thumbnailFileId",
               "elements",
             ],
       path: "payload.data",
@@ -6627,11 +6688,21 @@ const validateLayoutCreateData = ({ data, errorFactory }) => {
     );
   }
 
+  if (
+    data.thumbnailFileId !== undefined &&
+    !isNonEmptyString(data.thumbnailFileId)
+  ) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      "payload.data.thumbnailFileId must be a non-empty string when provided",
+    );
+  }
+
   if (data.type === "layout") {
     if (!LAYOUT_TYPE_KEYS.includes(data.layoutType)) {
       return invalidFromErrorFactory(
         errorFactory,
-        "payload.data.layoutType must be 'normal', 'save-load', 'confirmDialog', 'dialogue', 'nvl', or 'choice'",
+        "payload.data.layoutType must be 'normal', 'save-load', 'confirmDialog', 'dialogue', 'nvl', 'choice', or 'history'",
       );
     }
 
@@ -6661,7 +6732,13 @@ const validateLayoutUpdateData = ({ data, errorFactory }) => {
   {
     const result = validateAllowedKeys({
       value: data,
-      allowedKeys: ["name", "description", "layoutType", "isFragment"],
+      allowedKeys: [
+        "name",
+        "description",
+        "layoutType",
+        "isFragment",
+        "thumbnailFileId",
+      ],
       path: "payload.data",
       errorFactory,
     });
@@ -6691,13 +6768,23 @@ const validateLayoutUpdateData = ({ data, errorFactory }) => {
     );
   }
 
+  if (
+    data.thumbnailFileId !== undefined &&
+    !isNonEmptyString(data.thumbnailFileId)
+  ) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      "payload.data.thumbnailFileId must be a non-empty string when provided",
+    );
+  }
+
   if (
     data.layoutType !== undefined &&
     !LAYOUT_TYPE_KEYS.includes(data.layoutType)
   ) {
     return invalidFromErrorFactory(
       errorFactory,
-      "payload.data.layoutType must be 'normal', 'save-load', 'confirmDialog', 'dialogue', 'nvl', or 'choice' when provided",
+      "payload.data.layoutType must be 'normal', 'save-load', 'confirmDialog', 'dialogue', 'nvl', 'choice', or 'history' when provided",
     );
   }
 
@@ -6730,7 +6817,7 @@ const validateControlCreateData = ({ data, errorFactory }) => {
       allowedKeys:
         data.type === "folder"
           ? ["type", "name"]
-          : ["type", "name", "elements", "keyboard"],
+          : ["type", "name", "thumbnailFileId", "elements", "keyboard"],
       path: "payload.data",
       errorFactory,
     });
@@ -6746,6 +6833,16 @@ const validateControlCreateData = ({ data, errorFactory }) => {
     );
   }
 
+  if (
+    data.thumbnailFileId !== undefined &&
+    !isNonEmptyString(data.thumbnailFileId)
+  ) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      "payload.data.thumbnailFileId must be a non-empty string when provided",
+    );
+  }
+
   if (data.type === "control") {
     {
       const result = validateNestedCollection({
@@ -6777,7 +6874,7 @@ const validateControlUpdateData = ({ data, errorFactory }) => {
   {
     const result = validateAllowedKeys({
       value: data,
-      allowedKeys: ["name", "keyboard"],
+      allowedKeys: ["name", "keyboard", "thumbnailFileId"],
       path: "payload.data",
       errorFactory,
     });
@@ -6800,6 +6897,16 @@ const validateControlUpdateData = ({ data, errorFactory }) => {
     );
   }
 
+  if (
+    data.thumbnailFileId !== undefined &&
+    !isNonEmptyString(data.thumbnailFileId)
+  ) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      "payload.data.thumbnailFileId must be a non-empty string when provided",
+    );
+  }
+
   {
     const result = validateKeyboardMap({
       value: data.keyboard,
@@ -11779,11 +11886,30 @@ const COMMAND_DEFINITIONS = [
             description: payload.data.description,
             layoutType: payload.data.layoutType,
             isFragment: payload.data.isFragment,
+            ...(payload.data.thumbnailFileId !== undefined
+              ? {
+                  thumbnailFileId: payload.data.thumbnailFileId,
+                }
+              : {}),
             elements: structuredClone(payload.data.elements),
           }
         : {}),
     }),
-    validateUpdateState: ({ payload, currentItem }) => {
+    validateCreateState: ({ state, payload }) => {
+      if (payload.data.type !== "layout") {
+        return;
+      }
+
+      return validateReferencedFilesInData({
+        state,
+        data: payload.data,
+        fields: ["thumbnailFileId"],
+        details: {
+          layoutId: payload.layoutId,
+        },
+      });
+    },
+    validateUpdateState: ({ state, payload, currentItem }) => {
       if (
         currentItem.type === "folder" &&
         Object.keys(payload.data).some((key) => key !== "name")
@@ -11792,6 +11918,17 @@ const COMMAND_DEFINITIONS = [
           "folder layout items cannot update layout fields",
         );
       }
+
+      if (currentItem.type === "layout") {
+        return validateReferencedFilesInData({
+          state,
+          data: payload.data,
+          fields: ["thumbnailFileId"],
+          details: {
+            layoutId: payload.layoutId,
+          },
+        });
+      }
     },
   }),
   ...createFolderedCollectionCommandDefinitions({
@@ -11807,6 +11944,11 @@ const COMMAND_DEFINITIONS = [
       name: payload.data.name,
       ...(payload.data.type === "control"
         ? {
+            ...(payload.data.thumbnailFileId !== undefined
+              ? {
+                  thumbnailFileId: payload.data.thumbnailFileId,
+                }
+              : {}),
             elements: structuredClone(payload.data.elements),
             ...(payload.data.keyboard !== undefined
               ? {
@@ -11816,7 +11958,21 @@ const COMMAND_DEFINITIONS = [
           }
         : {}),
     }),
-    validateUpdateState: ({ payload, currentItem }) => {
+    validateCreateState: ({ state, payload }) => {
+      if (payload.data.type !== "control") {
+        return;
+      }
+
+      return validateReferencedFilesInData({
+        state,
+        data: payload.data,
+        fields: ["thumbnailFileId"],
+        details: {
+          controlId: payload.controlId,
+        },
+      });
+    },
+    validateUpdateState: ({ state, payload, currentItem }) => {
       if (
         currentItem.type === "folder" &&
         Object.keys(payload.data).some((key) => key !== "name")
@@ -11825,6 +11981,17 @@ const COMMAND_DEFINITIONS = [
           "folder control items cannot update control fields",
         );
       }
+
+      if (currentItem.type === "control") {
+        return validateReferencedFilesInData({
+          state,
+          data: payload.data,
+          fields: ["thumbnailFileId"],
+          details: {
+            controlId: payload.controlId,
+          },
+        });
+      }
     },
   }),
   {

package/src/systemVariables.js

@@ -24,12 +24,30 @@ export const SYSTEM_VARIABLE_GROUPS = Object.freeze([
       {
         id: "_currentSaveLoadPagination",
         name: "Current Save/Load Pagination",
-        scope: "runtime-screen",
+        scope: "context",
         type: "number",
         default: 0,
         description:
           "The current save/load pagination index. Resolves to 0, 1, 2, 3, and so on for the active save/load page.",
       },
+      {
+        id: "_currentMenuPage",
+        name: "Current Menu Page",
+        scope: "context",
+        type: "string",
+        default: "",
+        description:
+          "The current menu page id for the active UI flow. Typical values include options, save, load, and history.",
+      },
+      {
+        id: "_menuEntryPoint",
+        name: "Menu Entry Point",
+        scope: "context",
+        type: "string",
+        default: "",
+        description:
+          "Indicates how the current menu flow was opened. Typical values include title and read.",
+      },
     ]),
   },
 ]);