@novely/core 0.47.1 → 0.48.0

package/dist/index.js

@@ -2,7 +2,7 @@
 import { dequal } from "dequal/lite";
 import { throttle } from "es-toolkit/function";
 import { merge as deepmerge } from "es-toolkit/object";
-import { DEV as DEV3 } from "esm-env";
+import { DEV as DEV4 } from "esm-env";
 
 // ../../node_modules/.pnpm/klona@2.0.6/node_modules/klona/full/index.mjs
 function set(obj, key, val) {
@@ -148,7 +148,7 @@ var isAsset = (suspect) => {
 // src/utilities/match-action.ts
 var matchAction = (callbacks, values) => {
   const { getContext, onBeforeActionCall, push, forward } = callbacks;
-  return (action, props, { ctx, data }) => {
+  const match = (action, props, { ctx, data }) => {
     const context = typeof ctx === "string" ? getContext(ctx) : ctx;
     onBeforeActionCall({
       action,
@@ -171,6 +171,10 @@ var matchAction = (callbacks, values) => {
       props
     );
   };
+  return {
+    match,
+    nativeActions: Object.keys(values)
+  };
 };
 
 // src/utilities/ungrupped.ts
@@ -490,7 +494,7 @@ var createQueueProcessor = (queue, options) => {
   const characters = /* @__PURE__ */ new Set();
   const audio2 = {
     music: /* @__PURE__ */ new Set(),
-    sound: /* @__PURE__ */ new Set()
+    sounds: /* @__PURE__ */ new Set()
   };
   const next = (i) => queue.slice(i + 1);
   for (const [i, item] of queue.entries()) {
@@ -503,39 +507,50 @@ var createQueueProcessor = (queue, options) => {
       if (action === "custom") {
         const fn = params[0];
         if ("callOnlyLatest" in fn && fn.callOnlyLatest) {
-          const notLatest = next(i).some(([, func]) => {
-            if (!isFunction(func)) return false;
-            const c0 = func;
-            const c1 = fn;
-            const isIdenticalID = Boolean(c0.id && c1.id && c0.id === c1.id);
-            const isIdenticalByReference = c0 === c1;
-            return isIdenticalID || isIdenticalByReference || String(c0) === String(c1);
+          const notLatest = next(i).some(([name, func]) => {
+            if (name !== "custom") return;
+            const isIdenticalId = Boolean(func.id && fn.id && func.id === fn.id);
+            const isIdenticalByReference = func === fn;
+            const isIdenticalByCode = String(func) === String(fn);
+            return isIdenticalId || isIdenticalByReference || isIdenticalByCode;
           });
           if (notLatest) continue;
         } else if ("skipOnRestore" in fn && fn.skipOnRestore) {
-          if (fn.skipOnRestore(() => next(i))) {
+          if (fn.skipOnRestore(next(i))) {
             continue;
           }
         }
       }
       processedQueue.push(item);
-    } else if (action === "showCharacter" || action === "playSound" || action === "playMusic" || action === "voice") {
+    } else if (action === "playSound") {
+      const closing = getOppositeAction(action);
+      const skip = next(i).some((item2) => {
+        if (isUserRequiredAction(item2) || isSkippedDuringRestore(item2[0])) {
+          return true;
+        }
+        const [_action, target] = item2;
+        if (target !== params[0]) {
+          return false;
+        }
+        return _action === closing || _action === action;
+      });
+      if (skip) continue;
+      audio2.sounds.add(unwrapAsset(params[0]));
+      processedQueue.push(item);
+    } else if (action === "showCharacter" || action === "playMusic" || action === "voice") {
       const closing = getOppositeAction(action);
       const skip = next(i).some(([_action, target]) => {
         if (target !== params[0] && action !== "voice") {
           return false;
         }
-        const musicGonnaBePaused = action === "playMusic" && _action === "pauseMusic";
-        const soundGonnaBePaused = action === "playSound" && _action === "pauseSound";
-        return musicGonnaBePaused || soundGonnaBePaused || _action === closing || _action === action;
+        const musicWillBePaused = action === "playMusic" && _action === "pauseMusic";
+        return musicWillBePaused || _action === closing || _action === action;
       });
       if (skip) continue;
       if (action === "showCharacter") {
         characters.add(params[0]);
       } else if (action === "playMusic") {
         audio2.music.add(unwrapAsset(params[0]));
-      } else if (action === "playSound") {
-        audio2.sound.add(unwrapAsset(params[0]));
       }
       processedQueue.push(item);
     } else if (action === "showBackground" || action === "preload") {
@@ -550,7 +565,8 @@ var createQueueProcessor = (queue, options) => {
         const next2 = array.slice(j);
         const characterWillAnimate = next2.some(([__action, __character]) => action === __action);
         const hasBlockingActions = next2.some((item2) => options.skip.has(item2));
-        return characterWillAnimate && hasBlockingActions;
+        const differentCharacterWillAnimate = !hasBlockingActions && next2.some(([__action, __character]) => __action === action && __character !== params[0]);
+        return characterWillAnimate && hasBlockingActions || differentCharacterWillAnimate;
       });
       if (skip) continue;
       processedQueue.push(item);
@@ -1014,6 +1030,70 @@ var replace = (input, data, pluralization, actions, pr) => {
   });
 };
 
+// src/utilities/actions.ts
+import { DEV as DEV3 } from "esm-env";
+var VIRTUAL_ACTIONS = ["say"];
+var buildActionObject = ({
+  rendererActions,
+  nativeActions,
+  characters,
+  preloadAssets,
+  storageData
+}) => {
+  const allActions = [...nativeActions, ...VIRTUAL_ACTIONS];
+  const object = { ...rendererActions };
+  for (let action of allActions) {
+    object[action] = (...props) => {
+      if (action === "say") {
+        action = "dialog";
+        const [character] = props;
+        if (DEV3 && !characters[character]) {
+          throw new Error(`Attempt to call Say action with unknown character "${character}"`);
+        }
+      } else if (action === "choice") {
+        if (props.slice(1).every((choice) => !Array.isArray(choice))) {
+          for (let i = 1; i < props.length; i++) {
+            const choice = props[i];
+            props[i] = [
+              choice.title,
+              flatActions(choice.children),
+              choice.active,
+              choice.visible,
+              choice.onSelect,
+              choice.image
+            ];
+          }
+        } else {
+          for (let i = 1; i < props.length; i++) {
+            const choice = props[i];
+            if (Array.isArray(choice)) {
+              choice[1] = flatActions(choice[1]);
+            }
+          }
+        }
+      } else if (action === "condition") {
+        const actions = props[1];
+        for (const key in actions) {
+          actions[key] = flatActions(actions[key]);
+        }
+      }
+      if (preloadAssets === "blocking") {
+        huntAssets({
+          action,
+          props,
+          mode: preloadAssets,
+          characters,
+          lang: getLanguageFromStore(storageData),
+          volume: getVolumeFromStore(storageData),
+          handle: enqueueAssetForPreloading
+        });
+      }
+      return [action, ...props];
+    };
+  }
+  return object;
+};
+
 // src/novely.ts
 var novely = ({
   characters,
@@ -1037,7 +1117,8 @@ var novely = ({
   fetch: request = fetch,
   cloneFunction: clone = klona,
   saveOnUnload = true,
-  startKey = "start"
+  startKey = "start",
+  defaultTypewriterSpeed = DEFAULT_TYPEWRITER_SPEED
 }) => {
   const languages = Object.keys(translation);
   const limitScript = pLimit(1);
@@ -1082,61 +1163,6 @@ var novely = ({
   const script = (part) => {
     return limitScript(() => scriptBase(part));
   };
-  const action = new Proxy({}, {
-    get(_, action2) {
-      if (action2 in renderer.actions) {
-        return renderer.actions[action2];
-      }
-      return (...props) => {
-        if (action2 === "say") {
-          action2 = "dialog";
-          const [character] = props;
-          if (DEV3 && !characters[character]) {
-            throw new Error(`Attempt to call Say action with unknown character "${character}"`);
-          }
-        } else if (action2 === "choice") {
-          const actions = props.slice(1);
-          if (actions.every((choice) => !Array.isArray(choice))) {
-            for (let i = 1; i < props.length; i++) {
-              const choice = props[i];
-              props[i] = [
-                choice.title,
-                flatActions(choice.children),
-                choice.active,
-                choice.visible,
-                choice.onSelect,
-                choice.image
-              ];
-            }
-          } else {
-            for (let i = 1; i < props.length; i++) {
-              const choice = props[i];
-              if (Array.isArray(choice)) {
-                choice[1] = flatActions(choice[1]);
-              }
-            }
-          }
-        } else if (action2 === "condition") {
-          const actions = props[1];
-          for (const key in actions) {
-            actions[key] = flatActions(actions[key]);
-          }
-        }
-        if (preloadAssets === "blocking") {
-          huntAssets({
-            action: action2,
-            props,
-            mode: preloadAssets,
-            characters,
-            lang: getLanguageFromStore(storageData),
-            volume: getVolumeFromStore(storageData),
-            handle: enqueueAssetForPreloading
-          });
-        }
-        return [action2, ...props];
-      };
-    }
-  });
   const getDefaultSave = (state) => {
     return [
       [
@@ -1153,7 +1179,7 @@ var novely = ({
     if (languages.includes(language)) {
       return language;
     }
-    if (DEV3) {
+    if (DEV4) {
       throw new Error(
         `Attempt to use unsupported language "${language}". Supported languages: ${languages.join(", ")}.`
       );
@@ -1190,7 +1216,7 @@ var novely = ({
   };
   const throttledOnStorageDataChange = throttle(onStorageDataChange, throttleTimeout);
   const throttledEmergencyOnStorageDataChange = throttle(() => {
-    if (saveOnUnload === true || saveOnUnload === "prod" && !DEV3) {
+    if (saveOnUnload === true || saveOnUnload === "prod" && !DEV4) {
       onStorageDataChange(storageData.get());
     }
   }, 10);
@@ -1199,14 +1225,14 @@ var novely = ({
     let stored = await storage.get();
     for (const migration of migrations) {
       stored = migration(stored);
-      if (DEV3 && !stored) {
+      if (DEV4 && !stored) {
         throw new Error("Migrations should return a value.");
       }
     }
     if (overrideLanguage || !stored.meta[0]) {
       stored.meta[0] = getLanguageWithoutParameters();
     }
-    stored.meta[1] ||= DEFAULT_TYPEWRITER_SPEED;
+    stored.meta[1] ||= defaultTypewriterSpeed;
     stored.meta[2] ??= 1;
     stored.meta[3] ??= 1;
     stored.meta[4] ??= 1;
@@ -1277,7 +1303,7 @@ var novely = ({
   let interacted = 0;
   const restore = async (save2) => {
     if (isEmpty(story)) {
-      if (DEV3) {
+      if (DEV4) {
         throw new Error(
           "Story is empty. You should call an `enine.script` function [https://novely.pages.dev/guide/story.html]"
         );
@@ -1450,7 +1476,7 @@ var novely = ({
   };
   const getLanguageDisplayName = (lang) => {
     const language = translation[lang];
-    if (DEV3 && !language) {
+    if (DEV4 && !language) {
       throw new Error(
         `Attempt to use unsupported language "${language}". Supported languages: ${languages.join(", ")}.`
       );
@@ -1614,7 +1640,7 @@ var novely = ({
       }
     }
   };
-  const match = matchAction(matchActionOptions, {
+  const { match, nativeActions } = matchAction(matchActionOptions, {
     wait({ ctx, data: data2, push }, [time]) {
       if (ctx.meta.restoring) return;
       setTimeout(push, isFunction(time) ? time(data2) : time);
@@ -1671,11 +1697,11 @@ var novely = ({
     },
     showCharacter({ ctx, push }, [character, emotion, className, style]) {
       emotion ??= defaultEmotions[character];
-      if (DEV3 && !emotion) {
+      if (DEV4 && !emotion) {
         throw new Error(`Attemp to show character "${character}" without emotion provided.`);
       }
       if (!emotion) return;
-      if (DEV3 && !characters[character].emotions[emotion]) {
+      if (DEV4 && !characters[character].emotions[emotion]) {
         throw new Error(`Attempt to show character "${character}" with unknown emotion "${emotion}"`);
       }
       const handle = ctx.character(character);
@@ -1742,7 +1768,7 @@ var novely = ({
         const imageValue = image ? handleImageAsset(image) : "";
         return [templateReplace(content, data2), active$, visible$, onSelectWrapped, imageValue];
       });
-      if (DEV3 && transformedChoices.length === 0) {
+      if (DEV4 && transformedChoices.length === 0) {
         throw new Error(
           `Running choice without variants to choose from, look at how to use Choice action properly [https://novely.pages.dev/guide/actions/choice#usage]`
         );
@@ -1754,7 +1780,7 @@ var novely = ({
         }
         const stack = useStack(ctx);
         const offset = isWithoutQuestion ? 0 : 1;
-        if (DEV3 && !transformedChoices[selected]) {
+        if (DEV4 && !transformedChoices[selected]) {
           throw new Error("Choice children is empty, either add content there or make item not selectable");
         }
         stack.value[0].push(["choice", selected + offset], [null, 0]);
@@ -1763,10 +1789,10 @@ var novely = ({
       });
     },
     jump({ ctx, data: data2 }, [scene]) {
-      if (DEV3 && !story[scene]) {
+      if (DEV4 && !story[scene]) {
         throw new Error(`Attempt to jump to unknown scene "${scene}"`);
       }
-      if (DEV3 && story[scene].length === 0) {
+      if (DEV4 && story[scene].length === 0) {
         throw new Error(`Attempt to jump to empty scene "${scene}"`);
       }
       const stack = useStack(ctx);
@@ -1790,15 +1816,15 @@ var novely = ({
       );
     },
     condition({ ctx, data: data2 }, [condition, variants]) {
-      if (DEV3 && Object.values(variants).length === 0) {
+      if (DEV4 && Object.values(variants).length === 0) {
         throw new Error(`Attempt to use Condition action with empty variants object`);
       }
       if (!ctx.meta.restoring) {
         const val = String(condition(data2));
-        if (DEV3 && !variants[val]) {
+        if (DEV4 && !variants[val]) {
           throw new Error(`Attempt to go to unknown variant "${val}"`);
         }
-        if (DEV3 && variants[val].length === 0) {
+        if (DEV4 && variants[val].length === 0) {
           throw new Error(`Attempt to go to empty variant "${val}"`);
         }
         const stack = useStack(ctx);
@@ -1852,7 +1878,7 @@ var novely = ({
     },
     animateCharacter({ ctx, push }, [character, className]) {
       const classes = className.split(" ");
-      if (DEV3 && classes.length === 0) {
+      if (DEV4 && classes.length === 0) {
         throw new Error(
           "Attempt to use AnimateCharacter without classes. Classes should be provided [https://novely.pages.dev/guide/actions/animateCharacter.html]"
         );
@@ -1863,7 +1889,7 @@ var novely = ({
     },
     text({ ctx, data: data2, forward }, text) {
       const string = text.map((content) => templateReplace(content, data2)).join(" ");
-      if (DEV3 && string.length === 0) {
+      if (DEV4 && string.length === 0) {
         throw new Error(`Action Text was called with empty string or array`);
       }
       ctx.clearBlockingActions("text");
@@ -1888,7 +1914,7 @@ var novely = ({
       render(ctx);
     },
     preload({ ctx, push }, [source]) {
-      if (DEV3 && preloadAssets !== "lazy") {
+      if (DEV4 && preloadAssets !== "lazy") {
         console.error(
           `You do not need a preload action becase "preloadAssets" strategy was set to "${preloadAssets}"`
         );
@@ -1899,10 +1925,10 @@ var novely = ({
       push();
     },
     block({ ctx }, [scene]) {
-      if (DEV3 && !story[scene]) {
+      if (DEV4 && !story[scene]) {
         throw new Error(`Attempt to call Block action with unknown scene "${scene}"`);
       }
-      if (DEV3 && story[scene].length === 0) {
+      if (DEV4 && story[scene].length === 0) {
         throw new Error(`Attempt to call Block action with empty scene "${scene}"`);
       }
       if (!ctx.meta.restoring) {
@@ -1912,6 +1938,13 @@ var novely = ({
       }
     }
   });
+  const action = buildActionObject({
+    rendererActions: renderer.actions,
+    nativeActions,
+    characters,
+    preloadAssets,
+    storageData
+  });
   const render = (ctx) => {
     const stack = useStack(ctx);
     const [path, state] = stack.value;
@@ -1969,7 +2002,7 @@ var novely = ({
   };
   const setStorageData = (data2) => {
     if (destroyed) {
-      if (DEV3) {
+      if (DEV4) {
         throw new Error(
           `function \`setStorageData\` was called after novely instance was destroyed. Data is not updater nor synced after destroy.`
         );
@@ -2006,7 +2039,8 @@ var novely = ({
      */
     action,
     /**
-     * @deprecated Will be removed BUT replaced with state passed into actions as a parameter
+     * State bound to `$MAIN` game context
+     * @deprecated Use `state` function provided from action arguments
      */
     state: getStateFunction(MAIN_CONTEXT_KEY),
     /**
@@ -2101,11 +2135,10 @@ var novely = ({
 
 // src/extend-actions.ts
 var extendAction = (base, extension) => {
-  return new Proxy({}, {
-    get(_, key, receiver) {
-      return Reflect.get(key in extension ? extension : base, key, receiver);
-    }
-  });
+  return {
+    ...extension,
+    ...base
+  };
 };
 
 // src/translations.ts
@@ -2264,7 +2297,7 @@ var JP = {
 
 // src/asset.ts
 import { memoize as memoize4, once } from "es-toolkit/function";
-import { DEV as DEV4 } from "esm-env";
+import { DEV as DEV5 } from "esm-env";
 
 // src/audio-codecs.ts
 var cut = (str) => str.replace(/^no$/, "");
@@ -2347,7 +2380,7 @@ var SUPPORT_MAPS = {
 };
 var assetPrivate = memoize4(
   (variants) => {
-    if (DEV4 && variants.length === 0) {
+    if (DEV5 && variants.length === 0) {
       throw new Error(`Attempt to use "asset" function without arguments`);
     }
     const map = {};
@@ -2369,7 +2402,7 @@ var assetPrivate = memoize4(
           return map[extension];
         }
       }
-      if (DEV4) {
+      if (DEV5) {
         throw new Error(`No matching asset was found for ${variants.map((v) => `"${v}"`).join(", ")}`);
       }
       return "";