@routevn/creator-model 1.1.0 → 1.1.2

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.0",
+  "version": "1.1.2",
   "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",
@@ -1325,14 +1325,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 +1340,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 +1370,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 +1381,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 +1405,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,10 +2095,14 @@ const validateCharacterSpriteItems = ({ items, path, errorFactory }) => {
   }
 };
 
-const validateLayoutElementStyle = ({ style, path, errorFactory }) => {
+const validateLayoutElementTextStyle = ({
+  textStyle,
+  path,
+  errorFactory,
+}) => {
   {
     const result = validateAllowedKeys({
-      value: style,
+      value: textStyle,
       allowedKeys: ["align", "wordWrapWidth"],
       path,
       errorFactory,
@@ -2109,8 +2113,8 @@ const validateLayoutElementStyle = ({ style, path, errorFactory }) => {
   }
 
   if (
-    style.align !== undefined &&
-    !LAYOUT_ELEMENT_TEXT_STYLE_ALIGN_KEYS.includes(style.align)
+    textStyle.align !== undefined &&
+    !LAYOUT_ELEMENT_TEXT_STYLE_ALIGN_KEYS.includes(textStyle.align)
   ) {
     return invalidFromErrorFactory(
       errorFactory,
@@ -2119,8 +2123,8 @@ const validateLayoutElementStyle = ({ style, path, errorFactory }) => {
   }
 
   if (
-    style.wordWrapWidth !== undefined &&
-    !isFiniteNumber(style.wordWrapWidth)
+    textStyle.wordWrapWidth !== undefined &&
+    !isFiniteNumber(textStyle.wordWrapWidth)
   ) {
     return invalidFromErrorFactory(
       errorFactory,
@@ -2196,7 +2200,7 @@ const validateLayoutElementData = ({
     "fill",
     "border",
     "text",
-    "style",
+    "textStyle",
     "displaySpeed",
     "imageId",
     "hoverImageId",
@@ -2359,11 +2363,11 @@ const validateLayoutElementData = ({
     );
   }
 
-  if (data.style !== undefined) {
+  if (data.textStyle !== undefined) {
     {
-      const result = validateLayoutElementStyle({
-        style: data.style,
-        path: `${path}.style`,
+      const result = validateLayoutElementTextStyle({
+        textStyle: data.textStyle,
+        path: `${path}.textStyle`,
         errorFactory,
       });
       if (result?.valid === false) {
@@ -2438,7 +2442,7 @@ const validateLayoutElementItems = ({ items, path, errorFactory }) => {
           "fill",
           "border",
           "text",
-          "style",
+          "textStyle",
           "displaySpeed",
           "imageId",
           "hoverImageId",