@novely/core 0.41.0 → 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>;
@@ -560,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);
@@ -733,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>;
@@ -749,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;
@@ -795,6 +808,10 @@ 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;
@@ -827,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",
@@ -262,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,
@@ -1346,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
@@ -1422,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,
@@ -1931,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({
@@ -1960,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]`);