@novely/core 0.36.0-beta.2 → 0.36.0

package/dist/index.d.ts

@@ -72,7 +72,7 @@ interface CharacterHandle {
     emotion: (emotion: string, render: boolean) => void;
     append: (className?: string, style?: string, restoring?: boolean) => void;
     remove: (className?: string, style?: string, duration?: number, restoring?: boolean) => Promise<void>;
-    animate: (timeout: number, classes: string[]) => void;
+    animate: (classes: string[]) => void;
     emotions: Record<string, HTMLImageElement[]>;
 }
 type CustomActionHandle = {
@@ -510,7 +510,7 @@ type ValidAction = ['choice', number] | ['clear', Set<keyof DefaultActionProxy>?
 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);
-type CustomHandlerGetResultDataFunction = (data?: Record<string, unknown>) => Record<string, unknown>;
+type CustomHandlerGetResultDataFunction = <T = Record<string, unknown>>(data?: T) => T;
 type CustomHandlerGetResult<I extends boolean> = {
     /**
      * Element for the custom action to be rendered into
@@ -587,6 +587,10 @@ type CustomHandlerCalling = {
     skipOnRestore?: (getNext: () => Exclude<ValidAction, ValidAction[]>[]) => boolean;
 };
 type CustomHandlerInfo = CustomHandlerCalling & {
+    /**
+     * Assets (pictures, audio files) used by action
+     */
+    assets?: string[];
     /**
      * When true interacting with it will be saved in history
      */
@@ -597,10 +601,8 @@ type CustomHandlerInfo = CustomHandlerCalling & {
     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;
+    id: string | symbol;
     /**
      * Key by which we will save the data in the `get` function provided to custom action.
      *
@@ -714,7 +716,7 @@ type ActionProxy<Characters extends Record<string, Character>, Languages extends
     jump: (scene: string) => ValidAction;
     showCharacter: <C extends keyof Characters>(character: C, emotion?: keyof Characters[C]['emotions'], className?: string, style?: string) => ValidAction;
     hideCharacter: (character: keyof Characters, className?: string, style?: string, duration?: number) => ValidAction;
-    animateCharacter: (character: keyof Characters, timeout: number, ...classes: string[]) => ValidAction;
+    animateCharacter: (character: keyof Characters, classes: string) => ValidAction;
     wait: (time: number | ((state: State) => number)) => ValidAction;
     function: (fn: FunctionAction<Languages, S>) => ValidAction;
     input: (question: TextContent<Languages, S>, onInput: (meta: ActionInputOnInputMeta<Languages, S>) => void, setup?: ActionInputSetup) => ValidAction;
@@ -729,6 +731,8 @@ type DefaultActionProxy = ActionProxy<Record<string, Character>, Lang, State>;
 type GetActionParameters<T extends Capitalize<keyof DefaultActionProxy>> = Parameters<DefaultActionProxy[Uncapitalize<T>]>;
 
 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, 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>) => {
@@ -819,6 +823,23 @@ declare const novely: <$Language extends string, $Characters extends Record<stri
      * ```
      */
     getCurrentStorageData: () => StorageData<$Language, $Data> | null;
+    /**
+     * Function to set storage data. Using this function is not recommended.
+     *
+     * @deprecated
+     * @example
+     * ```ts
+     * const currentStorageData = engine.getCurrentStorageData();
+     *
+     * if (currentStorageData) {
+     *   // update music volume
+     *   currentStorageData.meta[2] = 1;
+     *
+     *   setStorageData(currentStorageData)
+     * }
+     * ```
+     */
+    setStorageData: (data: StorageData<$Language, $Data>) => void;
 };
 
 /**
@@ -836,4 +857,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 ActionInputSetupCleanup, type ActionProxy, type AllowedContent, type AudioHandle, type BackgroundImage, type BaseTranslationStrings, type Character, type CharacterHandle, type ConditionParams, type Context, type CoreData, type CustomActionHandle, 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 ChoiceParams, type ConditionParams, type Context, type CoreData, type CustomActionHandle, type CustomHandler, type CustomHandlerFunctionGetFn, type CustomHandlerFunctionParameters, type CustomHandlerGetResult, type CustomHandlerGetResultDataFunction, type Data, type DeepPartial, type DefaultActionProxy, EN, type Emotions, type FunctionParams, 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

@@ -1156,6 +1156,7 @@ var Novely = (() => {
     const ASSETS_TO_PRELOAD = /* @__PURE__ */ new Set();
     const dataLoaded = createControlledPromise();
     let initialScreenWasShown = false;
+    let destroyed = false;
     const intime = (value) => {
       return times.add(value), value;
     };
@@ -1185,6 +1186,8 @@ var Novely = (() => {
       }
     };
     const scriptBase = async (part) => {
+      if (destroyed)
+        return;
       Object.assign(story, flattenStory(part));
       let loadingIsShown = false;
       if (!initialScreenWasShown) {
@@ -1223,9 +1226,11 @@ var Novely = (() => {
             assetsToPreloadAdd(value);
           }
         }
+        return;
       }
       if (isAudioAction(action2) && isString(props[0])) {
         assetsToPreloadAdd(props[0]);
+        return;
       }
       if (action2 === "showCharacter" && isString(props[0]) && isString(props[1])) {
         const images = characters[props[0]].emotions[props[1]];
@@ -1236,6 +1241,12 @@ var Novely = (() => {
         } else {
           assetsToPreloadAdd(images);
         }
+        return;
+      }
+      if (action2 === "custom" && props[0].assets && props[0].assets.length > 0) {
+        for (const asset of props[0].assets) {
+          assetsToPreloadAdd(asset);
+        }
       }
     };
     const action = new Proxy({}, {
@@ -1879,16 +1890,14 @@ var Novely = (() => {
       next({ push }) {
         push();
       },
-      animateCharacter({ ctx, push }, [character, timeout, ...classes]) {
+      animateCharacter({ ctx, push }, [character, className]) {
+        const classes = className.split(" ");
         if (DEV && classes.length === 0) {
           throw new Error("Attempt to use AnimateCharacter without classes. Classes should be provided [https://novely.pages.dev/guide/actions/animateCharacter.html]");
         }
-        if (DEV && (timeout <= 0 || !Number.isFinite(timeout) || Number.isNaN(timeout))) {
-          throw new Error("Attempt to use AnimateCharacter with unacceptable timeout. It should be finite and greater than zero");
-        }
         if (ctx.meta.preview)
           return;
-        ctx.character(character).animate(timeout, classes);
+        ctx.character(character).animate(classes);
         push();
       },
       text({ ctx, data: data2, forward }, text) {
@@ -2002,6 +2011,15 @@ var Novely = (() => {
     const getCurrentStorageData = () => {
       return coreData.get().dataLoaded ? klona(storageData.get()) : null;
     };
+    const setStorageData = (data2) => {
+      if (destroyed) {
+        if (DEV) {
+          throw new Error(`function \`setStorageData\` was called after novely instance was destroyed.`);
+        }
+        return;
+      }
+      storageData.set(data2);
+    };
     return {
       /**
        * Function to set game script
@@ -2086,6 +2104,7 @@ var Novely = (() => {
         dataLoaded.cancel();
         UIInstance.unmount();
         unsubscribeFromBrowserVisibilityChange();
+        destroyed = true;
       },
       /**
        * Funtion to get current storage data
@@ -2095,7 +2114,24 @@ var Novely = (() => {
        * const currentStorageData = engine.getCurrentStorageData();
        * ```
        */
-      getCurrentStorageData
+      getCurrentStorageData,
+      /**
+       * Function to set storage data. Using this function is not recommended.
+       *
+       * @deprecated
+       * @example
+       * ```ts
+       * const currentStorageData = engine.getCurrentStorageData();
+       *
+       * if (currentStorageData) {
+       *   // update music volume
+       *   currentStorageData.meta[2] = 1;
+       *
+       *   setStorageData(currentStorageData)
+       * }
+       * ```
+       */
+      setStorageData
     };
   };