@routevn/creator-model 1.1.1 → 1.1.3

package/README.md

@@ -85,6 +85,8 @@ Design rules:
   this package
 - `project` may start empty; fields like `resolution` are optional until the
   model starts owning them
+- random ids across RouteVN should use `nanoid` with the RouteVN base58 variant;
+  deterministic derived tokens such as partition hashes are a separate case
 
 ## File Structure
 

package/package.json

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

package/src/model.js

@@ -54,7 +54,7 @@ const normalizeStateCollections = (state) => {
 const isString = (value) => typeof value === "string";
 const isHexColor = (value) =>
   typeof value === "string" && /^#[0-9a-fA-F]{6}$/.test(value);
-const LIVE_TWEEN_PROPERTY_KEYS = [
+const UPDATE_TWEEN_PROPERTY_KEYS = [
   "alpha",
   "x",
   "y",
@@ -62,7 +62,7 @@ const LIVE_TWEEN_PROPERTY_KEYS = [
   "scaleY",
   "rotation",
 ];
-const REPLACE_TWEEN_PROPERTY_KEYS = [
+const TRANSITION_TWEEN_PROPERTY_KEYS = [
   "translateX",
   "translateY",
   "alpha",
@@ -109,6 +109,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",
@@ -1325,14 +1326,14 @@ const validateAnimationDefinition = ({ animation, path, errorFactory }) => {
     );
   }
 
-  if (animation.type !== "live" && animation.type !== "replace") {
+  if (animation.type !== "update" && animation.type !== "transition") {
     return invalidFromErrorFactory(
       errorFactory,
-      `${path}.type must be 'live' or 'replace'`,
+      `${path}.type must be 'update' or 'transition'`,
     );
   }
 
-  if (animation.type === "live") {
+  if (animation.type === "update") {
     if (
       animation.prev !== undefined ||
       animation.next !== undefined ||
@@ -1340,23 +1341,23 @@ const validateAnimationDefinition = ({ animation, path, errorFactory }) => {
     ) {
       return invalidFromErrorFactory(
         errorFactory,
-        `${path}.live animations cannot define prev, next, or mask`,
+        `${path}.update animations cannot define prev, next, or mask`,
       );
     }
 
     if (animation.tween === undefined) {
       return invalidFromErrorFactory(
         errorFactory,
-        `${path}.tween is required when ${path}.type is 'live'`,
+        `${path}.tween is required when ${path}.type is 'update'`,
       );
     }
 
     {
       const result = validateTweenDefinition({
         tween: animation.tween,
-        allowedProperties: LIVE_TWEEN_PROPERTY_KEYS,
+        allowedProperties: UPDATE_TWEEN_PROPERTY_KEYS,
         path: `${path}.tween`,
-        unsupportedMessage: "is not a supported live tween property",
+        unsupportedMessage: "is not a supported update tween property",
         errorFactory,
       });
       if (result?.valid === false) {
@@ -1370,7 +1371,7 @@ const validateAnimationDefinition = ({ animation, path, errorFactory }) => {
   if (animation.tween !== undefined) {
     return invalidFromErrorFactory(
       errorFactory,
-      `${path}.replace animations cannot define tween`,
+      `${path}.transition animations cannot define tween`,
     );
   }
 
@@ -1381,7 +1382,7 @@ const validateAnimationDefinition = ({ animation, path, errorFactory }) => {
   ) {
     return invalidFromErrorFactory(
       errorFactory,
-      `${path} must define at least one of prev, next, or mask when ${path}.type is 'replace'`,
+      `${path} must define at least one of prev, next, or mask when ${path}.type is 'transition'`,
     );
   }
 
@@ -1405,9 +1406,9 @@ const validateAnimationDefinition = ({ animation, path, errorFactory }) => {
     {
       const result = validateTweenDefinition({
         tween: animation[side].tween,
-        allowedProperties: REPLACE_TWEEN_PROPERTY_KEYS,
+        allowedProperties: TRANSITION_TWEEN_PROPERTY_KEYS,
         path: `${path}.${side}.tween`,
-        unsupportedMessage: "is not a supported replace tween property",
+        unsupportedMessage: "is not a supported transition tween property",
         errorFactory,
       });
       if (result?.valid === false) {
@@ -2095,11 +2096,7 @@ const validateCharacterSpriteItems = ({ items, path, errorFactory }) => {
   }
 };
 
-const validateLayoutElementTextStyle = ({
-  textStyle,
-  path,
-  errorFactory,
-}) => {
+const validateLayoutElementTextStyle = ({ textStyle, path, errorFactory }) => {
   {
     const result = validateAllowedKeys({
       value: textStyle,
@@ -2202,6 +2199,7 @@ const validateLayoutElementData = ({
     "text",
     "textStyle",
     "displaySpeed",
+    "revealEffect",
     "imageId",
     "hoverImageId",
     "clickImageId",
@@ -2314,6 +2312,7 @@ const validateLayoutElementData = ({
     "clickTextStyleId",
     "containerType",
     "variableId",
+    "revealEffect",
     "thumbImageId",
     "barImageId",
     "hoverThumbImageId",
@@ -2335,6 +2334,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 +2453,7 @@ const validateLayoutElementItems = ({ items, path, errorFactory }) => {
           "text",
           "textStyle",
           "displaySpeed",
+          "revealEffect",
           "imageId",
           "hoverImageId",
           "clickImageId",