@routevn/creator-model 1.1.2 → 1.1.4

package/package.json

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

package/src/index.js

@@ -5,3 +5,9 @@ export {
   validatePayload,
   validateState,
 } from "./model.js";
+export {
+  SYSTEM_VARIABLE_GROUPS,
+  SYSTEM_VARIABLE_IDS,
+  getSystemVariableDefinitions,
+  isSystemVariableId,
+} from "./systemVariables.js";

package/src/model.js

@@ -15,6 +15,7 @@ import {
   isPlainObject,
   removeTreeNode,
 } from "./helpers.js";
+import { isSystemVariableId } from "./systemVariables.js";
 
 const COLLECTION_KEYS = [
   "scenes",
@@ -109,6 +110,7 @@ const VARIABLE_SCOPE_KEYS = ["context", "global-device", "global-account"];
 const VARIABLE_TYPE_KEYS = ["string", "number", "boolean"];
 const LAYOUT_TYPE_KEYS = ["normal", "dialogue", "nvl", "choice"];
 const LAYOUT_ELEMENT_TEXT_STYLE_ALIGN_KEYS = ["left", "center", "right"];
+const LAYOUT_TEXT_REVEAL_EFFECT_KEYS = ["typewriter", "softWipe", "none"];
 const LAYOUT_ELEMENT_BASE_TYPES = [
   "folder",
   "container",
@@ -219,6 +221,15 @@ const invalidInvariant = (message, details = {}) =>
     details,
   });
 
+const isVariableReferenceTarget = (state, variableId) => {
+  if (isSystemVariableId(variableId)) {
+    return true;
+  }
+
+  const variable = state.variables.items[variableId];
+  return isPlainObject(variable) && variable.type !== "folder";
+};
+
 const toDomainErrorDetails = (publicError) => {
   const details = isPlainObject(publicError?.details)
     ? { ...publicError.details }
@@ -2095,11 +2106,7 @@ const validateCharacterSpriteItems = ({ items, path, errorFactory }) => {
   }
 };
 
-const validateLayoutElementTextStyle = ({
-  textStyle,
-  path,
-  errorFactory,
-}) => {
+const validateLayoutElementTextStyle = ({ textStyle, path, errorFactory }) => {
   {
     const result = validateAllowedKeys({
       value: textStyle,
@@ -2202,6 +2209,7 @@ const validateLayoutElementData = ({
     "text",
     "textStyle",
     "displaySpeed",
+    "revealEffect",
     "imageId",
     "hoverImageId",
     "clickImageId",
@@ -2314,6 +2322,7 @@ const validateLayoutElementData = ({
     "clickTextStyleId",
     "containerType",
     "variableId",
+    "revealEffect",
     "thumbImageId",
     "barImageId",
     "hoverThumbImageId",
@@ -2335,6 +2344,16 @@ const validateLayoutElementData = ({
     );
   }
 
+  if (
+    data.revealEffect !== undefined &&
+    !LAYOUT_TEXT_REVEAL_EFFECT_KEYS.includes(data.revealEffect)
+  ) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      `${path}.revealEffect must be one of ${LAYOUT_TEXT_REVEAL_EFFECT_KEYS.join(", ")} when provided`,
+    );
+  }
+
   if (
     data.direction !== undefined &&
     data.direction !== "horizontal" &&
@@ -2444,6 +2463,7 @@ const validateLayoutElementItems = ({ items, path, errorFactory }) => {
           "text",
           "textStyle",
           "displaySpeed",
+          "revealEffect",
           "imageId",
           "hoverImageId",
           "clickImageId",
@@ -3889,8 +3909,7 @@ export const assertInvariants = ({ state }) => {
     elementId,
     targetId,
   }) => {
-    const variable = state.variables.items[targetId];
-    if (!isPlainObject(variable) || variable.type === "folder") {
+    if (!isVariableReferenceTarget(state, targetId)) {
       return invalidInvariant(
         `${ownerLabel} element variableId must reference an existing non-folder variable`,
         {
@@ -6501,8 +6520,7 @@ const validateVisualElementReferenceTargets = ({
   }
 
   if (data.variableId !== undefined) {
-    const variable = state.variables.items[data.variableId];
-    if (!isPlainObject(variable) || variable.type === "folder") {
+    if (!isVariableReferenceTarget(state, data.variableId)) {
       return invalidFromErrorFactory(
         errorFactory,
         `${ownerLabel} element variableId must reference an existing non-folder variable`,

package/src/systemVariables.js

@@ -0,0 +1,42 @@
+export const SYSTEM_VARIABLE_GROUPS = Object.freeze([
+  {
+    id: "routeEngine",
+    name: "Route Engine",
+    variables: Object.freeze([
+      {
+        id: "_skipUnseenText",
+        name: "Skip Unseen Text",
+        scope: "global-device",
+        type: "boolean",
+        default: false,
+        description:
+          "When enabled, skip mode can continue through lines the player has not viewed yet.",
+      },
+      {
+        id: "_dialogueTextSpeed",
+        name: "Dialogue Text Speed",
+        scope: "global-device",
+        type: "number",
+        default: 50,
+        description:
+          "Controls the default dialogue text speed stored for this device.",
+      },
+    ]),
+  },
+]);
+
+export const SYSTEM_VARIABLE_IDS = Object.freeze(
+  SYSTEM_VARIABLE_GROUPS.flatMap((group) =>
+    (group.variables || []).map((variable) => variable.id),
+  ),
+);
+
+const SYSTEM_VARIABLE_ID_SET = new Set(SYSTEM_VARIABLE_IDS);
+
+export const isSystemVariableId = (value) => {
+  return typeof value === "string" && SYSTEM_VARIABLE_ID_SET.has(value);
+};
+
+export const getSystemVariableDefinitions = () => {
+  return SYSTEM_VARIABLE_GROUPS.flatMap((group) => group.variables || []);
+};