@novely/core 0.33.3 → 0.34.0

package/dist/index.d.ts

@@ -532,13 +532,46 @@ type CustomHandlerFunctionParameters<L extends string, S extends State> = {
     lang: L;
 };
 type CustomHandlerFunction<L extends string, S extends State> = (parameters: CustomHandlerFunctionParameters<L, S>) => Thenable<void>;
-type CustomHandler<L extends string = string, S extends State = State> = CustomHandlerFunction<L, S> & {
+type CustomHandlerCalling = {
+    /**
+     * Call only the last custom action of this type or not. Does not affect other custom actions
+     * @example
+     * ```ts
+     * ['custom', customSomething1]
+     * ['custom', customSomething1]
+     * ['custom', customSomething1] <-- Run only that
+     * ```
+     */
     callOnlyLatest?: boolean;
+    /**
+     * Manually check should be skipped or not during restore
+     * @param getNext Function which will return next actions in queue
+     */
+    skipOnRestore?: (getNext: () => Exclude<ValidAction, ValidAction[]>[]) => boolean;
+};
+type CustomHandlerInfo = CustomHandlerCalling & {
+    /**
+     * When true interacting with it will be saved in history
+     */
     requireUserAction?: boolean;
+    /**
+     * When player is going back we clear every custom action. But we can ignore clearing that.
+     */
     skipClearOnGoingBack?: boolean;
+    /**
+     * Id by which we will determine what action is which
+     *
+     * It IS recommended to pass this property as it will speed up that check and make it more reliable
+     */
     id?: string | symbol;
+    /**
+     * Key by which we will save the data in the `get` function provided to custom action.
+     *
+     * It can be a name of action or more specific thing. In example for custom `showCharacter` it may be `show-character-${character}
+     */
     key: string;
 };
+type CustomHandler<L extends string = string, S extends State = State> = CustomHandlerFunction<L, S> & CustomHandlerInfo;
 interface ActionInputOnInputMeta<L extends string, S extends State> {
     /**
      * Input Element itself
@@ -594,7 +627,8 @@ type ChoiceCheckFunctionProps<L extends string, S extends State> = {
 type ChoiceCheckFunction<L extends string, S extends State> = (props: ChoiceCheckFunctionProps<L, S>) => boolean;
 type ConditionCheckFunction<S extends State, R extends string | true | false> = (state: S) => R;
 type FunctionAction<L extends string, S extends State> = (props: FunctionActionProps<L, S>) => Thenable<void>;
-type ActionInputSetup = (input: HTMLInputElement, cleanup: (cb: () => void) => void) => void;
+type ActionInputSetupCleanup = () => void;
+type ActionInputSetup = (input: HTMLInputElement) => ActionInputSetupCleanup | void;
 type BackgroundImage = Partial<Record<'portrait' | 'landscape' | 'all', string>> & Record<string, string>;
 type VoiceAction<L extends Lang> = (params: string | Partial<Record<L, string>>) => ValidAction;
 type ActionProxy<Characters extends Record<string, Character>, Languages extends Lang, S extends State> = {
@@ -765,4 +799,4 @@ declare const novely: <$Language extends string, $Characters extends Record<stri
  */
 declare const extendAction: <Part0 extends Record<string, (...args: any[]) => ValidAction>, Part1 extends Record<string, (...args: any[]) => ValidAction>>(base: Part0, extension: Part1) => Readonly<Assign<Part0, Part1>>;
 
-export { type ActionInputOnInputMeta, type ActionInputSetup, type ActionProxy, type AllowedContent, type AudioHandle, type BackgroundImage, type BaseTranslationStrings, type Character, type CharacterHandle, type ConditionParams, type Context, type CoreData, type CustomHandler, type CustomHandlerFunctionGetFn, type CustomHandlerFunctionParameters, type CustomHandlerGetResult, type CustomHandlerGetResultDataFunction, type Data, type DeepPartial, type DefaultActionProxy, EN, type Emotions, type FunctionableValue, type GetActionParameters, type InputHandler, JP, KK, type Lang, type NovelyInit, type NovelyScreen, type Path, type PluralType, type Pluralization, RU, type Renderer, type RendererInit, type Save, type Stack, type StackHolder, type State, type StateFunction, type Storage, type StorageData, type StorageMeta, type Stored, type Story, type TextContent, type Thenable, type TranslationActions, type TypeEssentials, type TypewriterSpeed, type ValidAction, extendAction, localStorageStorage, novely };
+export { type ActionInputOnInputMeta, type ActionInputSetup, type ActionInputSetupCleanup, type ActionProxy, type AllowedContent, type AudioHandle, type BackgroundImage, type BaseTranslationStrings, type Character, type CharacterHandle, type ConditionParams, type Context, type CoreData, type CustomHandler, type CustomHandlerFunctionGetFn, type CustomHandlerFunctionParameters, type CustomHandlerGetResult, type CustomHandlerGetResultDataFunction, type Data, type DeepPartial, type DefaultActionProxy, EN, type Emotions, type FunctionableValue, type GetActionParameters, type InputHandler, JP, KK, type Lang, type NovelyInit, type NovelyScreen, type Path, type PluralType, type Pluralization, RU, type Renderer, type RendererInit, type Save, type Stack, type StackHolder, type State, type StateFunction, type Storage, type StorageData, type StorageMeta, type Stored, type Story, type TextContent, type Thenable, type TranslationActions, type TypeEssentials, type TypewriterSpeed, type ValidAction, extendAction, localStorageStorage, novely };

package/dist/index.global.js

@@ -496,18 +496,31 @@ var Novely = (() => {
       }
       keep.add(action);
       if (action === "function" || action === "custom") {
-        if (action === "custom" && params[0].callOnlyLatest) {
-          const notLatest = next(i).some(([, func]) => {
-            if (!isFunction(func))
-              return false;
-            const c0 = func;
-            const c1 = params[0];
-            const isIdenticalID = Boolean(c0.id && c1.id && c0.id === c1.id);
-            const isIdenticalByReference = c0 === c1;
-            return isIdenticalID || isIdenticalByReference || str(c0) === str(c1);
-          });
-          if (notLatest)
-            continue;
+        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 || str(c0) === str(c1);
+            });
+            if (notLatest)
+              continue;
+          } else if ("skipOnRestore" in fn && fn.skipOnRestore) {
+            let getNext = () => {
+              const nextActions = next(i);
+              getNext = () => {
+                return nextActions;
+              };
+              return nextActions;
+            };
+            if (fn.skipOnRestore(getNext))
+              continue;
+          }
         }
         processedQueue.push(item);
       } else if (action === "showCharacter" || action === "playSound" || action === "playMusic" || action === "voice") {