@routevn/creator-model 1.13.1 → 1.13.3

package/README.md

@@ -354,8 +354,17 @@ Audio effects are foldered resources stored in `audioEffects.items` and
   },
   audioEffect: {
     type: "transition",
-    prev: { fade: { duration: 600, easing: "easeInOutSine" } },
-    next: { fade: { duration: 900, easing: "easeInOutSine" } },
+    prev: {
+      volume: {
+        keyframes: [{ value: 0, duration: 600, easing: "easeInOutSine" }],
+      },
+    },
+    next: {
+      volume: {
+        initialValue: 0,
+        keyframes: [{ value: 100, duration: 900, easing: "easeInOutSine" }],
+      },
+    },
   },
 }
 ```
@@ -365,12 +374,13 @@ transition effect, or a single `target` sound slot for an update effect. Each
 slot is an object containing a `soundId`.
 
 `audioEffect.type` is either `transition` or `update`. Transition effects have
-at least one `prev.fade` or `next.fade`. Update effects tween one or more of
-`volume`, `pan`, and `playbackRate`; each property has non-empty keyframes and
-must finish with an absolute numeric keyframe. That final number becomes the
-persistent BGM property value after the effect finishes. Absolute volume values
-are bounded to `0..100`, pan to `-1..1`, and playback rate to `>= 0`; relative
-keyframes represent unbounded numeric deltas and cannot be final.
+at least one property under `prev` or `next`; update effects place properties
+under `tween`. Both support only `volume`, `pan`, and `playbackRate`. Each
+property has non-empty keyframes and must finish with an absolute numeric
+keyframe. A final `tween` or `next` value becomes the persistent BGM property
+value after the effect finishes. Absolute volume values are bounded to
+`0..100`, pan to `-1..1`, and playback rate to `>= 0`; relative keyframes
+represent unbounded numeric deltas and cannot be final.
 
 ## Current Scope
 

package/package.json

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

package/src/model.js

@@ -344,7 +344,7 @@ const ANIMATION_EASING_KEYS = [
   "easeOutElastic",
   "easeInOutElastic",
 ];
-const AUDIO_EFFECT_TWEEN_PROPERTY_KEYS = ["volume", "pan", "playbackRate"];
+const AUDIO_EFFECT_PROPERTY_KEYS = ["volume", "pan", "playbackRate"];
 const VARIABLE_SCOPE_KEYS = ["context", "device", "account"];
 const VARIABLE_TYPE_KEYS = ["string", "number", "boolean", "object"];
 const LAYOUT_TYPE_KEYS = [
@@ -2493,6 +2493,31 @@ const validateAudioEffectAbsoluteValue = ({
   }
 };
 
+const validateAudioEffectInitialValue = ({
+  value,
+  property,
+  path,
+  errorFactory,
+}) => {
+  if (value === undefined) {
+    return;
+  }
+
+  if (!isFiniteNumber(value)) {
+    return invalidFromErrorFactory(
+      errorFactory,
+      `${path} must be a finite number when provided`,
+    );
+  }
+
+  return validateAudioEffectAbsoluteValue({
+    value,
+    property,
+    path,
+    errorFactory,
+  });
+};
+
 const validateAudioEffectKeyframes = ({
   keyframes,
   property,
@@ -2631,30 +2656,30 @@ const validateAudioEffectKeyframes = ({
   }
 };
 
-const validateAudioEffectTween = ({ tween, path, errorFactory }) => {
-  if (!isPlainObject(tween)) {
+const validateAudioEffectPropertyTracks = ({ tracks, path, errorFactory }) => {
+  if (!isPlainObject(tracks)) {
     return invalidFromErrorFactory(errorFactory, `${path} must be an object`);
   }
 
-  if (Object.keys(tween).length === 0) {
+  if (Object.keys(tracks).length === 0) {
     return invalidFromErrorFactory(
       errorFactory,
-      `${path} must contain at least one tween property`,
+      `${path} must contain at least one audio property`,
     );
   }
 
-  for (const [property, config] of Object.entries(tween)) {
-    if (!AUDIO_EFFECT_TWEEN_PROPERTY_KEYS.includes(property)) {
+  for (const [property, config] of Object.entries(tracks)) {
+    if (!AUDIO_EFFECT_PROPERTY_KEYS.includes(property)) {
       return invalidFromErrorFactory(
         errorFactory,
-        `${path}.${property} is not a supported audio effect tween property`,
+        `${path}.${property} is not a supported audio effect property`,
       );
     }
 
     {
-      const result = validateExactKeys({
+      const result = validateAllowedKeys({
         value: config,
-        expectedKeys: ["keyframes"],
+        allowedKeys: ["initialValue", "keyframes"],
         path: `${path}.${property}`,
         errorFactory,
       });
@@ -2663,31 +2688,18 @@ const validateAudioEffectTween = ({ tween, path, errorFactory }) => {
       }
     }
 
-    {
-      const result = validateAudioEffectKeyframes({
-        keyframes: config.keyframes,
-        property,
-        path: `${path}.${property}.keyframes`,
+    if (!Object.hasOwn(config, "keyframes")) {
+      return invalidFromErrorFactory(
         errorFactory,
-      });
-      if (result?.valid === false) {
-        return result;
-      }
+        `${path}.${property}.keyframes is required`,
+      );
     }
-  }
-};
-
-const validateAudioEffectFade = ({ fade, path, side, errorFactory }) => {
-  if (!isPlainObject(fade)) {
-    return invalidFromErrorFactory(errorFactory, `${path} must be an object`);
-  }
 
-  if (Object.hasOwn(fade, "keyframes")) {
     {
-      const result = validateExactKeys({
-        value: fade,
-        expectedKeys: ["keyframes"],
-        path,
+      const result = validateAudioEffectInitialValue({
+        value: config.initialValue,
+        property,
+        path: `${path}.${property}.initialValue`,
         errorFactory,
       });
       if (result?.valid === false) {
@@ -2697,95 +2709,16 @@ const validateAudioEffectFade = ({ fade, path, side, errorFactory }) => {
 
     {
       const result = validateAudioEffectKeyframes({
-        keyframes: fade.keyframes,
-        property: "volume",
-        path: `${path}.keyframes`,
+        keyframes: config.keyframes,
+        property,
+        path: `${path}.${property}.keyframes`,
         errorFactory,
       });
       if (result?.valid === false) {
         return result;
       }
     }
-
-    for (const [index, keyframe] of fade.keyframes.entries()) {
-      if (keyframe.relative === true) {
-        return invalidFromErrorFactory(
-          errorFactory,
-          `${path}.keyframes[${index}].relative is not supported for transition fades`,
-        );
-      }
-    }
-
-    return;
-  }
-
-  {
-    const result = validateAllowedKeys({
-      value: fade,
-      allowedKeys: ["delay", "duration", "easing"],
-      path,
-      errorFactory,
-    });
-    if (result?.valid === false) {
-      return result;
-    }
-  }
-
-  if (!Object.hasOwn(fade, "duration")) {
-    return invalidFromErrorFactory(
-      errorFactory,
-      `${path}.duration is required`,
-    );
-  }
-
-  if (!isFiniteNumber(fade.duration) || fade.duration < 0) {
-    return invalidFromErrorFactory(
-      errorFactory,
-      `${path}.duration must be a finite number >= 0`,
-    );
-  }
-
-  if (
-    fade.delay !== undefined &&
-    (!isFiniteNumber(fade.delay) || fade.delay < 0)
-  ) {
-    return invalidFromErrorFactory(
-      errorFactory,
-      `${path}.delay must be a finite number >= 0 when provided`,
-    );
   }
-
-  return validateAudioEffectEasing({
-    value: fade.easing,
-    path: `${path}.easing`,
-    errorFactory,
-  });
-};
-
-const validateAudioEffectTransitionSide = ({
-  side,
-  sideName,
-  path,
-  errorFactory,
-}) => {
-  {
-    const result = validateExactKeys({
-      value: side,
-      expectedKeys: ["fade"],
-      path,
-      errorFactory,
-    });
-    if (result?.valid === false) {
-      return result;
-    }
-  }
-
-  return validateAudioEffectFade({
-    fade: side.fade,
-    path: `${path}.fade`,
-    side: sideName,
-    errorFactory,
-  });
 };
 
 const validateAudioEffectDefinition = ({ audioEffect, path, errorFactory }) => {
@@ -2823,8 +2756,8 @@ const validateAudioEffectDefinition = ({ audioEffect, path, errorFactory }) => {
       );
     }
 
-    return validateAudioEffectTween({
-      tween: audioEffect.tween,
+    return validateAudioEffectPropertyTracks({
+      tracks: audioEffect.tween,
       path: `${path}.tween`,
       errorFactory,
     });
@@ -2849,9 +2782,8 @@ const validateAudioEffectDefinition = ({ audioEffect, path, errorFactory }) => {
       continue;
     }
 
-    const result = validateAudioEffectTransitionSide({
-      side: audioEffect[side],
-      sideName: side,
+    const result = validateAudioEffectPropertyTracks({
+      tracks: audioEffect[side],
       path: `${path}.${side}`,
       errorFactory,
     });