@novely/core 0.40.3 → 0.42.0

package/dist/index.d.ts

@@ -101,7 +101,7 @@ type Context = {
     character: (character: string) => CharacterHandle;
     background: (background: Record<string, string>) => void;
     dialog: (content: string, name: string, character: string | undefined, emotion: string | undefined, resolve: () => void) => void;
-    choices: (question: string, choices: [name: string, active: boolean][], resolve: (selected: number) => void) => void;
+    choices: (question: string, choices: [name: string, active: boolean, visible: boolean, image: string][], resolve: (selected: number) => void) => void;
     input: (question: string, onInput: (meta: ActionInputOnInputMeta<Lang, State>) => void, setup: ActionInputSetup, resolve: () => void) => void;
     clear: (keep: Set<keyof DefaultActionProxy>, keepCharacters: Set<string>, keepAudio: {
         music: Set<string>;
@@ -328,6 +328,7 @@ type CharactersData<$Characters extends Record<string, Character<Lang>>> = {
     };
 };
 type AssetsPreloading = 'lazy' | 'blocking' | 'automatic';
+type CloneFN = <T>(value: T) => T;
 interface NovelyInit<$Language extends Lang, $Characters extends Record<string, Character<NoInfer<$Language>>>, $State extends State, $Data extends Data, $Actions extends Record<string, (...args: any[]) => ValidAction>> {
     /**
      * An object containing the characters in the game.
@@ -509,6 +510,10 @@ interface NovelyInit<$Language extends Lang, $Characters extends Record<string,
      * Fetching function
      */
     fetch?: typeof fetch;
+    /**
+     * Function for clonning operations
+     */
+    cloneFunction?: CloneFN;
     /**
      * When page is going to be unloaded will call `storage.set` method
      * If 'prod' is passed enable only in production env.
@@ -555,10 +560,10 @@ type Character<$Lang extends Lang = string> = {
     emotions: Emotions;
 };
 
-type ValidAction = ['choice', number] | ['clear', Set<keyof DefaultActionProxy>?, Set<string>?, {
+type ValidAction = ['choice', string | undefined, ...[string, unknown[], (() => boolean)?, (() => boolean)?, string?][]] | ['clear', Set<keyof DefaultActionProxy>?, Set<string>?, {
     music: Set<string>;
     sounds: Set<string>;
-}?] | ['condition', (state: State) => boolean, Record<string, ValidAction[]>] | ['dialog', string | undefined, TextContent<string, State>, string | undefined] | ['say', string, TextContent<string, State>] | ['end'] | ['showBackground', string | NovelyAsset | BackgroundImage] | ['playMusic', string | NovelyAsset] | ['stopMusic', string | NovelyAsset] | ['pauseMusic', string | NovelyAsset] | ['playSound', audio: string | NovelyAsset, loop?: boolean] | ['pauseSound', string | NovelyAsset] | ['stopSound', string | NovelyAsset] | ['voice', string | NovelyAsset | Record<string, string | NovelyAsset>] | ['stopVoice'] | ['jump', string] | ['showCharacter', string, keyof Character['emotions'], string?, string?] | ['hideCharacter', string, string?, string?, number?] | ['animateCharacter', string, number, ...string[]] | ['wait', (number | ((state: State) => number))] | ['function', FunctionAction<string, State>] | ['input', string, (meta: ActionInputOnInputMeta<string, State>) => void, ActionInputSetup?] | ['custom', CustomHandler<string, State>] | ['vibrate', ...number[]] | ['next'] | ['text', ...TextContent<string, State>[]] | ['exit'] | ['preload', string] | ['block', string] | ValidAction[];
+}?] | ['condition', (state: State) => boolean, Record<string, ValidAction[]>] | ['dialog', string | undefined, TextContent<string, State>, string | undefined] | ['end'] | ['showBackground', string | NovelyAsset | BackgroundImage] | ['playMusic', string | NovelyAsset] | ['stopMusic', string | NovelyAsset] | ['pauseMusic', string | NovelyAsset] | ['playSound', audio: string | NovelyAsset, loop?: boolean] | ['pauseSound', string | NovelyAsset] | ['stopSound', string | NovelyAsset] | ['voice', string | NovelyAsset | Record<string, string | NovelyAsset>] | ['stopVoice'] | ['jump', string] | ['showCharacter', string, keyof Character['emotions'], string?, string?] | ['hideCharacter', string, string?, string?, number?] | ['animateCharacter', string, number, ...string[]] | ['wait', (number | ((state: State) => number))] | ['function', FunctionAction<string, State>] | ['input', string, (meta: ActionInputOnInputMeta<string, State>) => void, ActionInputSetup?] | ['custom', CustomHandler<string, State>] | ['vibrate', ...number[]] | ['next'] | ['text', ...TextContent<string, State>[]] | ['exit'] | ['preload', string] | ['block', string] | ValidAction[];
 type Story = Record<string, ValidAction[]>;
 type TextContent<L extends string, S extends State> = string | ((state: S) => string) | Record<L, string | ((state: S) => string)>;
 type FunctionableValue<T> = T | (() => T);
@@ -728,10 +733,24 @@ type ActionInputSetupCleanup = () => void;
 type ActionInputSetup = (input: HTMLInputElement) => ActionInputSetupCleanup | void;
 type BackgroundImage = Record<string, string | NovelyAsset>;
 type VoiceAction<L extends Lang> = (params: string | NovelyAsset | Partial<Record<L, string | NovelyAsset>>) => ValidAction;
+type ActionChoiceExtendedChoice<Languages extends Lang, S extends State> = {
+    title: TextContent<Languages, S>;
+    children: ValidAction[];
+    active?: ChoiceCheckFunction<Languages, S>;
+    visible?: ChoiceCheckFunction<Languages, S>;
+    image?: string | NovelyAsset;
+};
+type ActionChoiceChoice<Languages extends Lang, S extends State> = [
+    title: TextContent<Languages, S>,
+    actions: ValidAction[],
+    active?: ChoiceCheckFunction<Languages, S>,
+    visible?: ChoiceCheckFunction<Languages, S>,
+    image?: string | NovelyAsset
+];
 type ActionProxy<Characters extends Record<string, Character>, Languages extends Lang, S extends State> = {
     choice: {
-        (...choices: [name: TextContent<Languages, S>, actions: ValidAction[], active?: ChoiceCheckFunction<Languages, S>][]): ValidAction;
-        (question: TextContent<Languages, S>, ...choices: [name: TextContent<Languages, S>, actions: ValidAction[], active?: ChoiceCheckFunction<Languages, S>][]): ValidAction;
+        (...choices: ActionChoiceChoice<Languages, S>[]): ValidAction;
+        (question: TextContent<Languages, S>, ...choices: ActionChoiceChoice<Languages, S>[]): ValidAction;
     };
     clear: (keep?: Set<keyof DefaultActionProxy>, keepCharacters?: Set<string>, keepAudio?: {
         music: Set<string>;
@@ -744,7 +763,6 @@ type ActionProxy<Characters extends Record<string, Character>, Languages extends
         (character: undefined, content: TextContent<Languages, S>, emotion?: undefined): ValidAction;
         (character: string, content: TextContent<Languages, S>, emotion?: undefined): ValidAction;
     };
-    say: (character: keyof Characters, content: TextContent<Languages, S>) => ValidAction;
     end: () => ValidAction;
     showBackground: {
         (background: string | NovelyAsset): ValidAction;
@@ -790,13 +808,17 @@ type ActionProxy<Characters extends Record<string, Character>, Languages extends
 };
 type DefaultActionProxy = ActionProxy<Record<string, Character>, Lang, State>;
 type GetActionParameters<T extends Capitalize<keyof DefaultActionProxy>> = Parameters<DefaultActionProxy[Uncapitalize<T>]>;
+type VirtualActions<Characters extends Record<string, Character>, Languages extends Lang, S extends State> = {
+    choiceExtended: (question: TextContent<Languages, S>, choices: ActionChoiceExtendedChoice<Languages, State>[]) => ValidAction;
+    say: (character: keyof Characters, content: TextContent<Languages, S>) => ValidAction;
+};
 
 type ConditionParams<T> = T extends TypeEssentials<any, infer $State, any, any> ? $State : never;
 type ChoiceParams<T> = T extends TypeEssentials<infer $Lang, infer $State, any, any> ? ChoiceCheckFunctionProps<$Lang, $State> : never;
 type FunctionParams<T> = T extends TypeEssentials<infer $Lang, infer $State, any, any> ? FunctionActionProps<$Lang, $State> : never;
 type InputHandler<T> = T extends TypeEssentials<infer $Lang, infer $State, any, any> ? ActionInputOnInputMeta<$Lang, $State> : never;
 
-declare const novely: <$Language extends string, $Characters extends Record<string, Character<$Language>>, $State extends State, $Data extends Data, $Actions extends Record<string, (...args: any[]) => ValidAction>>({ characters, characterAssetSizes, defaultEmotions, storage, storageDelay, renderer: createRenderer, initialScreen, translation, state: defaultState, data: defaultData, autosaves, migrations, throttleTimeout, getLanguage, overrideLanguage, askBeforeExit, preloadAssets, parallelAssetsDownloadLimit, fetch: request, saveOnUnload, startKey }: NovelyInit<$Language, $Characters, $State, $Data, $Actions>) => {
+declare const novely: <$Language extends string, $Characters extends Record<string, Character<$Language>>, $State extends State, $Data extends Data, $Actions extends Record<string, (...args: any[]) => ValidAction>>({ characters, characterAssetSizes, defaultEmotions, storage, storageDelay, renderer: createRenderer, initialScreen, translation, state: defaultState, data: defaultData, autosaves, migrations, throttleTimeout, getLanguage, overrideLanguage, askBeforeExit, preloadAssets, parallelAssetsDownloadLimit, fetch: request, cloneFunction: clone, saveOnUnload, startKey, }: NovelyInit<$Language, $Characters, $State, $Data, $Actions>) => {
     /**
      * Function to set game script
      *
@@ -822,7 +844,7 @@ declare const novely: <$Language extends string, $Characters extends Record<stri
      * })
      * ```
      */
-    action: $Actions & ActionProxy<$Characters, $Language, $State>;
+    action: $Actions & ActionProxy<$Characters, $Language, $State> & VirtualActions<$Characters, $Language, $State>;
     /**
      * @deprecated Will be removed BUT replaced with state passed into actions as a parameter
      */

package/dist/index.global.js

@@ -32,9 +32,10 @@ var Novely = (() => {
   });
 
   // src/constants.ts
-  var SKIPPED_DURING_RESTORE = /* @__PURE__ */ new Set(["dialog", "say", "choice", "input", "vibrate", "text"]);
+  var SKIPPED_DURING_RESTORE = /* @__PURE__ */ new Set(["dialog", "choice", "input", "vibrate", "text"]);
   var BLOCK_EXIT_STATEMENTS = /* @__PURE__ */ new Set(["choice:exit", "condition:exit", "block:exit"]);
   var BLOCK_STATEMENTS = /* @__PURE__ */ new Set(["choice", "condition", "block"]);
+  var VIRTUAL_ACTIONS = /* @__PURE__ */ new Set(["say", "choiceExtended"]);
   var AUDIO_ACTIONS = /* @__PURE__ */ new Set([
     "playMusic",
     "stopMusic",
@@ -87,53 +88,6 @@ var Novely = (() => {
   // ../../node_modules/.pnpm/esm-env@1.0.0/node_modules/esm-env/prod-ssr.js
   var DEV = false;
 
-  // ../../node_modules/.pnpm/klona@2.0.6/node_modules/klona/full/index.mjs
-  function set(obj, key, val) {
-    if (typeof val.value === "object") val.value = klona(val.value);
-    if (!val.enumerable || val.get || val.set || !val.configurable || !val.writable || key === "__proto__") {
-      Object.defineProperty(obj, key, val);
-    } else obj[key] = val.value;
-  }
-  function klona(x) {
-    if (typeof x !== "object") return x;
-    var i = 0, k, list, tmp, str2 = Object.prototype.toString.call(x);
-    if (str2 === "[object Object]") {
-      tmp = Object.create(x.__proto__ || null);
-    } else if (str2 === "[object Array]") {
-      tmp = Array(x.length);
-    } else if (str2 === "[object Set]") {
-      tmp = /* @__PURE__ */ new Set();
-      x.forEach(function(val) {
-        tmp.add(klona(val));
-      });
-    } else if (str2 === "[object Map]") {
-      tmp = /* @__PURE__ */ new Map();
-      x.forEach(function(val, key) {
-        tmp.set(klona(key), klona(val));
-      });
-    } else if (str2 === "[object Date]") {
-      tmp = /* @__PURE__ */ new Date(+x);
-    } else if (str2 === "[object RegExp]") {
-      tmp = new RegExp(x.source, x.flags);
-    } else if (str2 === "[object DataView]") {
-      tmp = new x.constructor(klona(x.buffer));
-    } else if (str2 === "[object ArrayBuffer]") {
-      tmp = x.slice(0);
-    } else if (str2.slice(-6) === "Array]") {
-      tmp = new x.constructor(x);
-    }
-    if (tmp) {
-      for (list = Object.getOwnPropertySymbols(x); i < list.length; i++) {
-        set(tmp, list[i], Object.getOwnPropertyDescriptor(x, list[i]));
-      }
-      for (i = 0, list = Object.getOwnPropertyNames(x); i < list.length; i++) {
-        if (Object.hasOwnProperty.call(tmp, k = list[i]) && tmp[k] === x[k]) continue;
-        set(tmp, k, Object.getOwnPropertyDescriptor(x, k));
-      }
-    }
-    return tmp || x;
-  }
-
   // ../../node_modules/.pnpm/es-toolkit@1.16.0/node_modules/es-toolkit/dist/function/once.mjs
   function once(func) {
     let called = false;
@@ -309,13 +263,11 @@ var Novely = (() => {
   var matchAction = ({ getContext, onBeforeActionCall, push, forward }, values) => {
     return (action, props, { ctx, data }) => {
       const context = typeof ctx === "string" ? getContext(ctx) : ctx;
-      if (action !== "say") {
-        onBeforeActionCall({
-          action,
-          props,
-          ctx: context
-        });
-      }
+      onBeforeActionCall({
+        action,
+        props,
+        ctx: context
+      });
       return values[action]({
         ctx: context,
         data,
@@ -803,7 +755,7 @@ var Novely = (() => {
   var isBlockingAction = (action) => {
     return isUserRequiredAction(action) || isSkippedDuringRestore(action[0]) && action[0] !== "vibrate";
   };
-  var collectActionsBeforeBlockingAction = ({ path, refer }) => {
+  var collectActionsBeforeBlockingAction = ({ path, refer, clone }) => {
     const collection = [];
     let action = refer(path);
     while (true) {
@@ -826,11 +778,12 @@ var Novely = (() => {
           for (let i = 0; i < choiceProps.length; i++) {
             const branchContent = choiceProps[i];
             if (!Array.isArray(branchContent)) continue;
-            const virtualPath = klona(path);
+            const virtualPath = clone(path);
             virtualPath.push(["choice", i], [null, 0]);
             const innerActions = collectActionsBeforeBlockingAction({
               path: virtualPath,
-              refer
+              refer,
+              clone
             });
             collection.push(...innerActions);
           }
@@ -838,11 +791,12 @@ var Novely = (() => {
           const conditionProps = props;
           const conditions = Object.keys(conditionProps[1]);
           for (const condition of conditions) {
-            const virtualPath = klona(path);
+            const virtualPath = clone(path);
             virtualPath.push(["condition", condition], [null, 0]);
             const innerActions = collectActionsBeforeBlockingAction({
               path: virtualPath,
-              refer
+              refer,
+              clone
             });
             collection.push(...innerActions);
           }
@@ -968,6 +922,53 @@ var Novely = (() => {
     return { subscribe, update, set: set2, get };
   };
 
+  // ../../node_modules/.pnpm/klona@2.0.6/node_modules/klona/full/index.mjs
+  function set(obj, key, val) {
+    if (typeof val.value === "object") val.value = klona(val.value);
+    if (!val.enumerable || val.get || val.set || !val.configurable || !val.writable || key === "__proto__") {
+      Object.defineProperty(obj, key, val);
+    } else obj[key] = val.value;
+  }
+  function klona(x) {
+    if (typeof x !== "object") return x;
+    var i = 0, k, list, tmp, str2 = Object.prototype.toString.call(x);
+    if (str2 === "[object Object]") {
+      tmp = Object.create(x.__proto__ || null);
+    } else if (str2 === "[object Array]") {
+      tmp = Array(x.length);
+    } else if (str2 === "[object Set]") {
+      tmp = /* @__PURE__ */ new Set();
+      x.forEach(function(val) {
+        tmp.add(klona(val));
+      });
+    } else if (str2 === "[object Map]") {
+      tmp = /* @__PURE__ */ new Map();
+      x.forEach(function(val, key) {
+        tmp.set(klona(key), klona(val));
+      });
+    } else if (str2 === "[object Date]") {
+      tmp = /* @__PURE__ */ new Date(+x);
+    } else if (str2 === "[object RegExp]") {
+      tmp = new RegExp(x.source, x.flags);
+    } else if (str2 === "[object DataView]") {
+      tmp = new x.constructor(klona(x.buffer));
+    } else if (str2 === "[object ArrayBuffer]") {
+      tmp = x.slice(0);
+    } else if (str2.slice(-6) === "Array]") {
+      tmp = new x.constructor(x);
+    }
+    if (tmp) {
+      for (list = Object.getOwnPropertySymbols(x); i < list.length; i++) {
+        set(tmp, list[i], Object.getOwnPropertyDescriptor(x, list[i]));
+      }
+      for (i = 0, list = Object.getOwnPropertyNames(x); i < list.length; i++) {
+        if (Object.hasOwnProperty.call(tmp, k = list[i]) && tmp[k] === x[k]) continue;
+        set(tmp, k, Object.getOwnPropertyDescriptor(x, k));
+      }
+    }
+    return tmp || x;
+  }
+
   // src/translation.ts
   var RGX = /{{(.*?)}}/g;
   var split = (input, delimeters) => {
@@ -1344,6 +1345,14 @@ var Novely = (() => {
       }
       return;
     }
+    if (action === "choice") {
+      for (let i = 1; i < props.length; i++) {
+        const data = props[i];
+        if (Array.isArray(data)) {
+          handle(handleImageAsset(data[4]));
+        }
+      }
+    }
   };
 
   // src/novely.ts
@@ -1367,6 +1376,7 @@ var Novely = (() => {
     preloadAssets = "lazy",
     parallelAssetsDownloadLimit = 15,
     fetch: request = fetch,
+    cloneFunction: clone = klona,
     saveOnUnload = true,
     startKey = "start"
   }) => {
@@ -1419,6 +1429,28 @@ var Novely = (() => {
           return renderer.actions[action2];
         }
         return (...props) => {
+          if (VIRTUAL_ACTIONS.has(action2)) {
+            if (action2 === "say") {
+              action2 = "dialog";
+              const [character] = props;
+              if (DEV && !characters[character]) {
+                throw new Error(`Attempt to call Say action with unknown character "${character}"`);
+              }
+            } else if (action2 === "choiceExtended") {
+              action2 = "choice";
+              const choices = props[1];
+              const mappedChoices = choices.map((choice) => [
+                choice.title,
+                choice.children,
+                choice.active,
+                choice.visible,
+                choice.image
+              ]);
+              for (let i = 0; i < mappedChoices.length; i++) {
+                props[i + 1] = mappedChoices[i];
+              }
+            }
+          }
           if (preloadAssets === "blocking") {
             huntAssets({
               action: action2,
@@ -1434,7 +1466,7 @@ var Novely = (() => {
         };
       }
     });
-    const getDefaultSave = (state = {}) => {
+    const getDefaultSave = (state) => {
       return [
         [
           ["jump", startKey],
@@ -1456,7 +1488,7 @@ var Novely = (() => {
     };
     const initialData = {
       saves: [],
-      data: klona(defaultData),
+      data: clone(defaultData),
       meta: [getLanguageWithoutParameters(), DEFAULT_TYPEWRITER_SPEED, 1, 1, 1]
     };
     const storageData = store(initialData);
@@ -1506,7 +1538,7 @@ var Novely = (() => {
       storageData.set(stored);
     };
     storageDelay.then(getStoredData);
-    const initial = getDefaultSave(klona(defaultState));
+    const initial = getDefaultSave(clone(defaultState));
     const unsubscribeFromBrowserVisibilityChange = setupBrowserVisibilityChangeListeners({
       onChange: throttledEmergencyOnStorageDataChange
     });
@@ -1514,7 +1546,7 @@ var Novely = (() => {
       if (!coreData.get().dataLoaded) return;
       if (!autosaves && type === "auto") return;
       const stack = useStack(MAIN_CONTEXT_KEY);
-      const current = klona(stack.value);
+      const current = clone(stack.value);
       storageData.update((prev) => {
         const replace2 = () => {
           prev.saves[prev.saves.length - 1] = current;
@@ -1544,7 +1576,7 @@ var Novely = (() => {
     };
     const newGame = () => {
       if (!coreData.get().dataLoaded) return;
-      const save2 = getDefaultSave(klona(defaultState));
+      const save2 = getDefaultSave(clone(defaultState));
       if (autosaves) {
         storageData.update((prev) => {
           return prev.saves.push(save2), prev;
@@ -1573,7 +1605,7 @@ var Novely = (() => {
       if (!coreData.get().dataLoaded) return;
       let latest = save2 || storageData.get().saves.at(-1);
       if (!latest) {
-        latest = klona(initial);
+        latest = clone(initial);
         storageData.update((prev) => {
           prev.saves.push(latest);
           return prev;
@@ -1685,7 +1717,7 @@ var Novely = (() => {
       const processor = createQueueProcessor(queue, {
         skip: EMPTY_SET
       });
-      useStack(ctx).push(klona(save2));
+      useStack(ctx).push(clone(save2));
       const assets = [];
       await processor.run(([action2, ...props]) => {
         if (isAudioAction(action2)) return;
@@ -1780,7 +1812,7 @@ var Novely = (() => {
     const enmemory = (ctx) => {
       if (ctx.meta.restoring) return;
       const stack = useStack(ctx);
-      const current = klona(stack.value);
+      const current = clone(stack.value);
       current[2][1] = "auto";
       stack.push(current);
       save("auto");
@@ -1808,8 +1840,9 @@ var Novely = (() => {
         if (!isBlockingAction([action2, ...props])) return;
         try {
           const collection = collectActionsBeforeBlockingAction({
-            path: nextPath(klona(useStack(ctx).value[0])),
-            refer
+            path: nextPath(clone(useStack(ctx).value[0])),
+            refer,
+            clone
           });
           for (const [action3, ...props2] of collection) {
             huntAssets({
@@ -1927,15 +1960,6 @@ var Novely = (() => {
           forward
         );
       },
-      say({ ctx, data: data2 }, [character, content]) {
-        if (DEV && !characters[character]) {
-          throw new Error(`Attempt to call Say action with unknown character "${character}"`);
-        }
-        match("dialog", [character, content], {
-          ctx,
-          data: data2
-        });
-      },
       function({ ctx, push }, [fn]) {
         const { restoring, goingBack, preview: preview2 } = ctx.meta;
         const result = fn({
@@ -1956,15 +1980,20 @@ var Novely = (() => {
           choices.unshift(question);
           question = "";
         }
-        const transformedChoices = choices.map(([content, action2, visible]) => {
-          const shown = !visible || visible({
+        const transformedChoices = choices.map(([content, action2, active, visible, image]) => {
+          const activeValue = !active || active({
+            lang: getLanguageFromStore(storageData),
+            state: getStateAtCtx(ctx)
+          });
+          const visibleValue = !visible || visible({
             lang: getLanguageFromStore(storageData),
             state: getStateAtCtx(ctx)
           });
-          if (DEV && action2.length === 0 && !shown) {
+          const imageValue = image ? handleImageAsset(image) : "";
+          if (DEV && action2.length === 0 && (!activeValue && !visibleValue)) {
             console.warn(`Choice children should not be empty, either add content there or make item not selectable`);
           }
-          return [templateReplace(content, data2), shown];
+          return [templateReplace(content, data2), activeValue, visibleValue, imageValue];
         });
         if (DEV && 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]`);
@@ -2191,7 +2220,7 @@ var Novely = (() => {
       c: null
     };
     const getCurrentStorageData = () => {
-      return coreData.get().dataLoaded ? klona(storageData.get()) : null;
+      return coreData.get().dataLoaded ? clone(storageData.get()) : null;
     };
     const setStorageData = (data2) => {
       if (destroyed) {