@novely/core 0.48.0 → 0.49.0

package/dist/index.js

@@ -1,8 +1,8 @@
 // src/novely.ts
 import { dequal } from "dequal/lite";
-import { throttle } from "es-toolkit/function";
+import { memoize as memoize4, throttle } from "es-toolkit/function";
 import { merge as deepmerge } from "es-toolkit/object";
-import { DEV as DEV4 } from "esm-env";
+import { DEV as DEV5 } from "esm-env";
 
 // ../../node_modules/.pnpm/klona@2.0.6/node_modules/klona/full/index.mjs
 function set(obj, key, val) {
@@ -245,6 +245,7 @@ var getVolumeFromStore = (store2) => {
 };
 
 // src/utilities/actions-processing.ts
+import { DEV as DEV2 } from "esm-env";
 var isExitImpossible = (path) => {
   const blockStatements = path.filter(([item]) => isBlockStatement(item));
   const blockExitStatements = path.filter(([item]) => isBlockExitStatement(item));
@@ -256,40 +257,66 @@ var isExitImpossible = (path) => {
   }
   return !blockExitStatements.every(([name], i) => name && name.startsWith(blockStatements[i][0]));
 };
-var createReferFunction = (story) => {
-  const refer = (path) => {
+var createReferFunction = ({ story, onUnknownSceneHit }) => {
+  const refer = async (path) => {
+    const { promise: ready, resolve: setReady } = Promise.withResolvers();
     let current = story;
     let precurrent = story;
     const blocks = [];
-    for (const [type, val] of path) {
-      if (type === "jump") {
-        precurrent = story;
-        current = current[val];
-      } else if (type === null) {
-        precurrent = current;
-        current = current[val];
-      } else if (type === "choice") {
-        blocks.push(precurrent);
-        current = current[val + 1][1];
-      } else if (type === "condition") {
-        blocks.push(precurrent);
-        current = current[2][val];
-      } else if (type === "block") {
-        blocks.push(precurrent);
-        current = story[val];
-      } else if (type === "block:exit" || type === "choice:exit" || type === "condition:exit") {
-        current = blocks.pop();
+    const refer2 = async () => {
+      for (const [type, val] of path) {
+        if (type === "jump") {
+          if (!current[val]) {
+            setReady(true);
+            await onUnknownSceneHit(val);
+          }
+          if (DEV2 && !story[val]) {
+            throw new Error(`Attempt to jump to unknown scene "${val}"`);
+          }
+          if (DEV2 && story[val].length === 0) {
+            throw new Error(`Attempt to jump to empty scene "${val}"`);
+          }
+          precurrent = story;
+          current = current[val];
+        } else if (type === null) {
+          precurrent = current;
+          current = current[val];
+        } else if (type === "choice") {
+          blocks.push(precurrent);
+          current = current[val + 1][1];
+        } else if (type === "condition") {
+          blocks.push(precurrent);
+          current = current[2][val];
+        } else if (type === "block") {
+          blocks.push(precurrent);
+          current = story[val];
+        } else if (type === "block:exit" || type === "choice:exit" || type === "condition:exit") {
+          current = blocks.pop();
+        }
       }
-    }
-    return current;
+      setReady(false);
+      return current;
+    };
+    const value = refer2();
+    const found = await ready;
+    return {
+      found,
+      value
+    };
+  };
+  const referGuarded = async (path) => {
+    return await (await refer(path)).value;
+  };
+  return {
+    refer,
+    referGuarded
   };
-  return refer;
 };
-var exitPath = ({ path, refer, onExitImpossible }) => {
+var exitPath = async ({ path, refer, onExitImpossible }) => {
   const last = path.at(-1);
   const ignore = [];
   let wasExitImpossible = false;
-  if (!isAction(refer(path))) {
+  if (!isAction(await refer(path))) {
     if (last && isNull(last[0]) && isNumber(last[1])) {
       last[1]--;
     } else {
@@ -297,7 +324,7 @@ var exitPath = ({ path, refer, onExitImpossible }) => {
     }
   }
   if (isExitImpossible(path)) {
-    const referred = refer(path);
+    const referred = await refer(path);
     if (isAction(referred) && isSkippedDuringRestore(referred[0])) {
       onExitImpossible?.();
     }
@@ -319,7 +346,7 @@ var exitPath = ({ path, refer, onExitImpossible }) => {
     path.push([`${name}:exit`]);
     const prev = findLastPathItemBeforeItemOfType(path.slice(0, i + 1), name);
     if (prev) path.push([null, prev[1] + 1]);
-    if (!isAction(refer(path))) {
+    if (!isAction(await refer(path))) {
       path.pop();
       continue;
     }
@@ -338,12 +365,16 @@ var nextPath = (path) => {
   }
   return path;
 };
-var collectActionsBeforeBlockingAction = ({ path, refer, clone }) => {
+var collectActionsBeforeBlockingAction = async ({
+  path,
+  refer,
+  clone
+}) => {
   const collection = [];
-  let action = refer(path);
+  let action = await refer(path);
   while (true) {
     if (action == void 0) {
-      const { exitImpossible } = exitPath({
+      const { exitImpossible } = await exitPath({
         path,
         refer
       });
@@ -363,7 +394,7 @@ var collectActionsBeforeBlockingAction = ({ path, refer, clone }) => {
           if (!Array.isArray(branchContent)) continue;
           const virtualPath = clone(path);
           virtualPath.push(["choice", i], [null, 0]);
-          const innerActions = collectActionsBeforeBlockingAction({
+          const innerActions = await collectActionsBeforeBlockingAction({
             path: virtualPath,
             refer,
             clone
@@ -376,7 +407,7 @@ var collectActionsBeforeBlockingAction = ({ path, refer, clone }) => {
         for (const condition of conditions) {
           const virtualPath = clone(path);
           virtualPath.push(["condition", condition], [null, 0]);
-          const innerActions = collectActionsBeforeBlockingAction({
+          const innerActions = await collectActionsBeforeBlockingAction({
             path: virtualPath,
             refer,
             clone
@@ -397,7 +428,7 @@ var collectActionsBeforeBlockingAction = ({ path, refer, clone }) => {
     } else {
       nextPath(path);
     }
-    action = refer(path);
+    action = await refer(path);
   }
   return collection;
 };
@@ -417,7 +448,7 @@ var getOppositeAction = (action) => {
   };
   return MAP[action];
 };
-var getActionsFromPath = (story, path, filter) => {
+var getActionsFromPath = async ({ story, path, filter, referGuarded }) => {
   let current = story;
   let precurrent;
   let ignoreNestedBefore = null;
@@ -432,6 +463,7 @@ var getActionsFromPath = (story, path, filter) => {
   }, 0);
   const queue = [];
   const blocks = [];
+  await referGuarded(path);
   for (const [type, val] of path) {
     if (type === "jump") {
       precurrent = story;
@@ -575,7 +607,7 @@ var createQueueProcessor = (queue, options) => {
     }
   }
   const run = async (match) => {
-    for await (const item of processedQueue) {
+    for (const item of processedQueue) {
       const result = match(item);
       if (isPromise(result)) {
         await result;
@@ -619,13 +651,13 @@ var createControlledPromise = () => {
 
 // src/utilities/resources.ts
 import { memoize as memoize2 } from "es-toolkit/function";
-import { DEV as DEV2 } from "esm-env";
+import { DEV as DEV3 } from "esm-env";
 var getUrlFileExtension = (address) => {
   try {
     const { pathname } = new URL(address, location.href);
     return pathname.split(".").at(-1).split("!")[0].split(":")[0];
   } catch (error) {
-    if (DEV2) {
+    if (DEV3) {
       console.error(new Error(`Could not construct URL "${address}".`, { cause: error }));
     }
     return "";
@@ -638,7 +670,7 @@ var fetchContentType = async (url, request) => {
     });
     return response.headers.get("Content-Type") || "";
   } catch (error) {
-    if (DEV2) {
+    if (DEV3) {
       console.error(new Error(`Failed to fetch file at "${url}"`, { cause: error }));
     }
     return "";
@@ -1031,7 +1063,7 @@ var replace = (input, data, pluralization, actions, pr) => {
 };
 
 // src/utilities/actions.ts
-import { DEV as DEV3 } from "esm-env";
+import { DEV as DEV4 } from "esm-env";
 var VIRTUAL_ACTIONS = ["say"];
 var buildActionObject = ({
   rendererActions,
@@ -1047,7 +1079,7 @@ var buildActionObject = ({
       if (action === "say") {
         action = "dialog";
         const [character] = props;
-        if (DEV3 && !characters[character]) {
+        if (DEV4 && !characters[character]) {
           throw new Error(`Attempt to call Say action with unknown character "${character}"`);
         }
       } else if (action === "choice") {
@@ -1118,7 +1150,8 @@ var novely = ({
   cloneFunction: clone = klona,
   saveOnUnload = true,
   startKey = "start",
-  defaultTypewriterSpeed = DEFAULT_TYPEWRITER_SPEED
+  defaultTypewriterSpeed = DEFAULT_TYPEWRITER_SPEED,
+  storyOptions = { mode: "static" }
 }) => {
   const languages = Object.keys(translation);
   const limitScript = pLimit(1);
@@ -1128,21 +1161,27 @@ var novely = ({
   const dataLoaded = createControlledPromise();
   let initialScreenWasShown = false;
   let destroyed = false;
+  if (storyOptions.mode === "dynamic") {
+    storyOptions.preloadSaves ??= 4;
+  }
+  const storyLoad = storyOptions.mode === "static" ? noop : storyOptions.load;
+  const onUnknownSceneHit = memoize4(async (scene) => {
+    const part = await storyLoad(scene);
+    if (part) {
+      await script(part);
+    }
+  });
   const intime = (value) => {
     return times.add(value), value;
   };
   const scriptBase = async (part) => {
     if (destroyed) return;
     Object.assign(story, flatStory(part));
-    let loadingIsShown = false;
     if (!initialScreenWasShown) {
       renderer.ui.showLoading();
-      loadingIsShown = true;
     }
     if (preloadAssets === "blocking" && ASSETS_TO_PRELOAD.size > 0) {
-      if (!loadingIsShown) {
-        renderer.ui.showLoading();
-      }
+      renderer.ui.showLoading();
       await handleAssetsPreloading({
         ...renderer.misc,
         limiter: limitAssetsDownload,
@@ -1179,7 +1218,7 @@ var novely = ({
     if (languages.includes(language)) {
       return language;
     }
-    if (DEV4) {
+    if (DEV5) {
       throw new Error(
         `Attempt to use unsupported language "${language}". Supported languages: ${languages.join(", ")}.`
       );
@@ -1195,11 +1234,23 @@ var novely = ({
   const coreData = store({
     dataLoaded: false
   });
-  const onDataLoadedPromise = ({ cancelled }) => {
+  const onDataLoadedPromise = async ({ cancelled }) => {
     if (cancelled) {
       dataLoaded.promise.then(onDataLoadedPromise);
       return;
     }
+    const preload = () => {
+      const saves = [...storageData.get().saves].reverse();
+      const sliced = saves.slice(0, storyOptions.mode === "dynamic" ? storyOptions.preloadSaves : 0);
+      for (const [path] of sliced) {
+        referGuarded(path);
+      }
+    };
+    if (preloadAssets === "blocking") {
+      await preload();
+    } else {
+      void preload();
+    }
     coreData.update((data2) => {
       data2.dataLoaded = true;
       return data2;
@@ -1216,7 +1267,7 @@ var novely = ({
   };
   const throttledOnStorageDataChange = throttle(onStorageDataChange, throttleTimeout);
   const throttledEmergencyOnStorageDataChange = throttle(() => {
-    if (saveOnUnload === true || saveOnUnload === "prod" && !DEV4) {
+    if (saveOnUnload === true || saveOnUnload === "prod" && !DEV5) {
       onStorageDataChange(storageData.get());
     }
   }, 10);
@@ -1225,7 +1276,7 @@ var novely = ({
     let stored = await storage.get();
     for (const migration of migrations) {
       stored = migration(stored);
-      if (DEV4 && !stored) {
+      if (DEV5 && !stored) {
         throw new Error("Migrations should return a value.");
       }
     }
@@ -1303,7 +1354,7 @@ var novely = ({
   let interacted = 0;
   const restore = async (save2) => {
     if (isEmpty(story)) {
-      if (DEV4) {
+      if (DEV5) {
         throw new Error(
           "Story is empty. You should call an `enine.script` function [https://novely.pages.dev/guide/story.html]"
         );
@@ -1325,7 +1376,14 @@ var novely = ({
     const previous = stack.previous;
     const [path] = stack.value = latest;
     renderer.ui.showScreen("game");
-    const { queue, skip, skipPreserve } = getActionsFromPath(story, path, false);
+    const { found } = await refer(path);
+    if (found) context.loading(true);
+    const { queue, skip, skipPreserve } = await getActionsFromPath({
+      story,
+      path,
+      filter: false,
+      referGuarded
+    });
     const {
       run,
       keep: { keep, characters: characters2, audio: audio2 }
@@ -1334,7 +1392,12 @@ var novely = ({
       skipPreserve
     });
     if (previous) {
-      const { queue: prevQueue } = getActionsFromPath(story, previous[0], false);
+      const { queue: prevQueue } = await getActionsFromPath({
+        story,
+        path: previous[0],
+        filter: false,
+        referGuarded
+      });
       for (let i = prevQueue.length - 1; i > queue.length - 1; i--) {
         const element = prevQueue[i];
         if (!isAction(element)) {
@@ -1352,6 +1415,7 @@ var novely = ({
         data: latest[1]
       });
     }
+    context.loading(false);
     const lastQueueItem = queue.at(-1);
     const lastQueueItemRequiresUserAction = lastQueueItem && isBlockingAction(lastQueueItem);
     await run((item) => {
@@ -1368,10 +1432,13 @@ var novely = ({
     if (!context.meta.goingBack) {
       context.meta.restoring = false;
     }
-    render(context);
+    await render(context);
     context.meta.restoring = context.meta.goingBack = false;
   };
-  const refer = createReferFunction(story);
+  const { refer, referGuarded } = createReferFunction({
+    story,
+    onUnknownSceneHit
+  });
   const exit = (force = false, saving = true) => {
     const ctx = renderer.getContext(MAIN_CONTEXT_KEY);
     const stack = useStack(ctx);
@@ -1423,8 +1490,16 @@ var novely = ({
       });
     }
     const [path, data2] = save2;
-    const { queue } = getActionsFromPath(story, path, true);
     const ctx = renderer.getContext(name);
+    const { found } = await refer(path);
+    if (found) ctx.loading(true);
+    const { queue } = await getActionsFromPath({
+      story,
+      path,
+      filter: true,
+      referGuarded
+    });
+    ctx.loading(false);
     ctx.meta.restoring = true;
     ctx.meta.preview = true;
     const processor = createQueueProcessor(queue, {
@@ -1476,7 +1551,7 @@ var novely = ({
   };
   const getLanguageDisplayName = (lang) => {
     const language = translation[lang];
-    if (DEV4 && !language) {
+    if (DEV5 && !language) {
       throw new Error(
         `Attempt to use unsupported language "${language}". Supported languages: ${languages.join(", ")}.`
       );
@@ -1513,21 +1588,26 @@ var novely = ({
     }
     return String(c) || "";
   };
-  const getDialogOverview = () => {
+  const getDialogOverview = async () => {
     const { value: save2 } = useStack(MAIN_CONTEXT_KEY);
     const stateSnapshots = save2[3];
     if (stateSnapshots.length == 0) {
       return [];
     }
-    const { queue } = getActionsFromPath(story, save2[0], false);
+    const { queue } = await getActionsFromPath({
+      story,
+      path: save2[0],
+      filter: false,
+      referGuarded
+    });
     const [lang] = storageData.get().meta;
     const dialogItems = [];
-    for (let p = 0, a = stateSnapshots.length, i = queue.length - 1; a > 0; i--) {
+    for (let p = 0, a = stateSnapshots.length, i = queue.length - 1; a > 0 && i > 0; i--) {
       const action2 = queue[i];
       if (action2[0] === "dialog") {
         const [_, name, text] = action2;
         let voice = void 0;
-        for (let j = i - 1; j > p; j--) {
+        for (let j = i - 1; j > p && j > 0; j--) {
           const action3 = queue[j];
           if (isUserRequiredAction(action3) || isSkippedDuringRestore(action3[0])) break;
           if (action3[0] === "stopVoice") break;
@@ -1609,14 +1689,14 @@ var novely = ({
       matchActionOptions.push(ctx);
       if (!ctx.meta.preview) interactivity(true);
     },
-    onBeforeActionCall({ action: action2, props, ctx }) {
+    async onBeforeActionCall({ action: action2, props, ctx }) {
       if (preloadAssets !== "automatic") return;
       if (ctx.meta.preview || ctx.meta.restoring) return;
       if (!isBlockingAction([action2, ...props])) return;
       try {
-        const collection = collectActionsBeforeBlockingAction({
+        const collection = await collectActionsBeforeBlockingAction({
           path: nextPath(clone(useStack(ctx).value[0])),
-          refer,
+          refer: referGuarded,
           clone
         });
         for (const [action3, ...props2] of collection) {
@@ -1697,11 +1777,11 @@ var novely = ({
     },
     showCharacter({ ctx, push }, [character, emotion, className, style]) {
       emotion ??= defaultEmotions[character];
-      if (DEV4 && !emotion) {
+      if (DEV5 && !emotion) {
         throw new Error(`Attemp to show character "${character}" without emotion provided.`);
       }
       if (!emotion) return;
-      if (DEV4 && !characters[character].emotions[emotion]) {
+      if (DEV5 && !characters[character].emotions[emotion]) {
         throw new Error(`Attempt to show character "${character}" with unknown emotion "${emotion}"`);
       }
       const handle = ctx.character(character);
@@ -1768,7 +1848,7 @@ var novely = ({
         const imageValue = image ? handleImageAsset(image) : "";
         return [templateReplace(content, data2), active$, visible$, onSelectWrapped, imageValue];
       });
-      if (DEV4 && transformedChoices.length === 0) {
+      if (DEV5 && 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]`
         );
@@ -1780,7 +1860,7 @@ var novely = ({
         }
         const stack = useStack(ctx);
         const offset = isWithoutQuestion ? 0 : 1;
-        if (DEV4 && !transformedChoices[selected]) {
+        if (DEV5 && !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]);
@@ -1789,12 +1869,6 @@ var novely = ({
       });
     },
     jump({ ctx, data: data2 }, [scene]) {
-      if (DEV4 && !story[scene]) {
-        throw new Error(`Attempt to jump to unknown scene "${scene}"`);
-      }
-      if (DEV4 && story[scene].length === 0) {
-        throw new Error(`Attempt to jump to empty scene "${scene}"`);
-      }
       const stack = useStack(ctx);
       stack.value[0] = [
         ["jump", scene],
@@ -1816,15 +1890,15 @@ var novely = ({
       );
     },
     condition({ ctx, data: data2 }, [condition, variants]) {
-      if (DEV4 && Object.values(variants).length === 0) {
+      if (DEV5 && 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 (DEV4 && !variants[val]) {
+        if (DEV5 && !variants[val]) {
           throw new Error(`Attempt to go to unknown variant "${val}"`);
         }
-        if (DEV4 && variants[val].length === 0) {
+        if (DEV5 && variants[val].length === 0) {
           throw new Error(`Attempt to go to empty variant "${val}"`);
         }
         const stack = useStack(ctx);
@@ -1878,7 +1952,7 @@ var novely = ({
     },
     animateCharacter({ ctx, push }, [character, className]) {
       const classes = className.split(" ");
-      if (DEV4 && classes.length === 0) {
+      if (DEV5 && classes.length === 0) {
         throw new Error(
           "Attempt to use AnimateCharacter without classes. Classes should be provided [https://novely.pages.dev/guide/actions/animateCharacter.html]"
         );
@@ -1889,17 +1963,17 @@ var novely = ({
     },
     text({ ctx, data: data2, forward }, text) {
       const string = text.map((content) => templateReplace(content, data2)).join(" ");
-      if (DEV4 && string.length === 0) {
+      if (DEV5 && string.length === 0) {
         throw new Error(`Action Text was called with empty string or array`);
       }
       ctx.clearBlockingActions("text");
       ctx.text(string, forward);
     },
-    exit({ ctx, data: data2 }) {
+    async exit({ ctx, data: data2 }) {
       if (ctx.meta.restoring) return;
-      const { exitImpossible } = exitPath({
+      const { exitImpossible } = await exitPath({
         path: useStack(ctx).value[0],
-        refer,
+        refer: referGuarded,
         onExitImpossible: () => {
           match("end", [], {
             ctx,
@@ -1914,7 +1988,7 @@ var novely = ({
       render(ctx);
     },
     preload({ ctx, push }, [source]) {
-      if (DEV4 && preloadAssets !== "lazy") {
+      if (DEV5 && preloadAssets !== "lazy") {
         console.error(
           `You do not need a preload action becase "preloadAssets" strategy was set to "${preloadAssets}"`
         );
@@ -1925,10 +1999,10 @@ var novely = ({
       push();
     },
     block({ ctx }, [scene]) {
-      if (DEV4 && !story[scene]) {
+      if (DEV5 && !story[scene]) {
         throw new Error(`Attempt to call Block action with unknown scene "${scene}"`);
       }
-      if (DEV4 && story[scene].length === 0) {
+      if (DEV5 && story[scene].length === 0) {
         throw new Error(`Attempt to call Block action with empty scene "${scene}"`);
       }
       if (!ctx.meta.restoring) {
@@ -1945,10 +2019,17 @@ var novely = ({
     preloadAssets,
     storageData
   });
-  const render = (ctx) => {
+  const render = async (ctx) => {
     const stack = useStack(ctx);
     const [path, state] = stack.value;
-    const referred = refer(path);
+    const { found, value } = await refer(path);
+    if (found) {
+      ctx.loading(true);
+    }
+    const referred = await value;
+    if (found) {
+      ctx.loading(false);
+    }
     if (isAction(referred)) {
       const [action2, ...props] = referred;
       match(action2, props, {
@@ -2002,7 +2083,7 @@ var novely = ({
   };
   const setStorageData = (data2) => {
     if (destroyed) {
-      if (DEV4) {
+      if (DEV5) {
         throw new Error(
           `function \`setStorageData\` was called after novely instance was destroyed. Data is not updater nor synced after destroy.`
         );
@@ -2296,8 +2377,8 @@ var JP = {
 };
 
 // src/asset.ts
-import { memoize as memoize4, once } from "es-toolkit/function";
-import { DEV as DEV5 } from "esm-env";
+import { memoize as memoize5, once } from "es-toolkit/function";
+import { DEV as DEV6 } from "esm-env";
 
 // src/audio-codecs.ts
 var cut = (str) => str.replace(/^no$/, "");
@@ -2360,7 +2441,7 @@ loadImageFormatsSupport();
 
 // src/asset.ts
 var generateRandomId = () => Math.random().toString(36);
-var getType = memoize4(
+var getType = memoize5(
   (extensions) => {
     if (extensions.every((extension) => HOWLER_SUPPORTED_FILE_FORMATS.has(extension))) {
       return "audio";
@@ -2378,9 +2459,9 @@ var SUPPORT_MAPS = {
   image: supportsMap2,
   audio: supportsMap
 };
-var assetPrivate = memoize4(
+var assetPrivate = memoize5(
   (variants) => {
-    if (DEV5 && variants.length === 0) {
+    if (DEV6 && variants.length === 0) {
       throw new Error(`Attempt to use "asset" function without arguments`);
     }
     const map = {};
@@ -2402,7 +2483,7 @@ var assetPrivate = memoize4(
           return map[extension];
         }
       }
-      if (DEV5) {
+      if (DEV6) {
         throw new Error(`No matching asset was found for ${variants.map((v) => `"${v}"`).join(", ")}`);
       }
       return "";