@novely/core 0.19.5 → 0.20.0

package/dist/index.d.ts

@@ -25,12 +25,6 @@ type StorageData = {
     data: Data;
     meta: StorageMeta;
 };
-type Stack = {
-    value: Save;
-    back(): void;
-    push(value: Save): void;
-    clear(): void;
-};
 type NovelyScreen = 'mainmenu' | 'game' | 'saves' | 'settings';
 /**
  * @see https://pendletonjones.com/deep-partial
@@ -43,14 +37,14 @@ type CoreData = {
     dataLoaded: boolean;
 };
 
-type ValidAction = ['choice', [number]] | ['clear', [Set<keyof DefaultActionProxyProvider>?, Set<string>?]] | ['condition', [() => boolean, Record<string, ValidAction[]>]] | ['dialog', [string | undefined, Unwrappable<string>, string | undefined]] | ['end', []] | ['showBackground', [string | NonEmptyRecord<BackgroundImage>]] | ['playMusic', [string]] | ['stopMusic', [string]] | ['voice', [string]] | ['stopVoice', []] | ['jump', [string]] | ['showCharacter', [string, keyof Character['emotions'], string?, string?]] | ['hideCharacter', [string, string?, string?, number?]] | ['animateCharacter', [string, number, ...string[]]] | ['wait', [FunctionableValue<number>]] | ['function', [() => Thenable<void>]] | ['input', [string, (meta: ActionInputOnInputMeta) => void, ActionInputSetup?]] | ['custom', [CustomHandler]] | ['vibrate', [...number[]]] | ['next', []] | ['text', [...string[]]] | ['exit', []] | ['preload', [string]] | ['block', [string]] | ValidAction[];
+type ValidAction = ['choice', [number]] | ['clear', [Set<keyof DefaultActionProxyProvider>?, Set<string>?]] | ['condition', [() => boolean, Record<string, ValidAction[]>]] | ['dialog', [string | undefined, Unwrappable<string>, string?]] | ['end', []] | ['showBackground', [string | NonEmptyRecord<BackgroundImage>]] | ['playMusic', [string]] | ['stopMusic', [string]] | ['voice', [string]] | ['stopVoice', []] | ['jump', [string]] | ['showCharacter', [string, keyof Character['emotions'], string?, string?]] | ['hideCharacter', [string, string?, string?, number?]] | ['animateCharacter', [string, number, ...string[]]] | ['wait', [FunctionableValue<number>]] | ['function', [() => Thenable<void>]] | ['input', [string, (meta: ActionInputOnInputMeta) => void, ActionInputSetup?]] | ['custom', [CustomHandler]] | ['vibrate', [...number[]]] | ['next', []] | ['text', [...string[]]] | ['exit', []] | ['preload', [string]] | ['block', [string]] | ValidAction[];
 type Story = Record<string, ValidAction[]>;
 type Unwrappable<L extends string> = string | (() => string) | Record<L, string | (() => string)>;
 type FunctionableValue<T> = T | (() => T);
 type CustomHandlerGetResultDataFunction = {
     (data?: Record<string, unknown>): Record<string, unknown>;
 };
-type CustomHandlerGetResult = {
+type CustomHandlerGetResult<I extends boolean> = {
     delete: () => void;
     /**
      * Данные
@@ -59,7 +53,7 @@ type CustomHandlerGetResult = {
     /**
      * Элемент слоя
      */
-    element: HTMLDivElement | null;
+    element: I extends true ? HTMLDivElement : null;
     /**
      * Корневой элемент Novely
      */
@@ -69,12 +63,13 @@ type CustomHandlerGetResult = {
      */
     clear: (fn: () => void) => void;
 };
-type CustomHandlerFunction = (get: (id: string, insert?: boolean) => CustomHandlerGetResult, goingBack: boolean, resolve: () => void) => Thenable<void>;
+type CustomHandlerFunction = (get: <I extends boolean>(insert?: I) => CustomHandlerGetResult<I>, goingBack: boolean, preview: boolean) => Thenable<void>;
 type CustomHandler = CustomHandlerFunction & {
     callOnlyLatest?: boolean;
     requireUserAction?: boolean;
     skipClearOnGoingBack?: boolean;
     id?: string | symbol;
+    key: string;
 };
 interface ActionInputOnInputMeta {
     /**
@@ -104,7 +99,10 @@ type ActionProxyProvider<Characters extends Record<string, Character>, Languages
         (...choices: ([Unwrappable<Languages>, ValidAction[]] | [Unwrappable<Languages>, ValidAction[], () => boolean])[]): ValidAction;
         (question: Unwrappable<Languages>, ...choices: ([Unwrappable<Languages>, ValidAction[]] | [Unwrappable<Languages>, ValidAction[], () => boolean])[]): ValidAction;
     };
-    clear: (keep?: Set<keyof DefaultActionProxyProvider>, keepCharacters?: Set<string>) => ValidAction;
+    clear: (keep?: Set<keyof DefaultActionProxyProvider>, keepCharacters?: Set<string>, keepAudio?: {
+        music: Set<string>;
+        sounds: Set<string>;
+    }) => ValidAction;
     condition: <T extends string | true | false>(condition: () => T, variants: Record<T extends true ? 'true' : T extends false ? 'false' : T, ValidAction[]>) => ValidAction;
     exit: () => ValidAction;
     dialog: {
@@ -133,7 +131,7 @@ type ActionProxyProvider<Characters extends Record<string, Character>, Languages
     hideCharacter: (character: keyof Characters, className?: string, style?: string, duration?: number) => ValidAction;
     animateCharacter: (character: keyof Characters, timeout: number, ...classes: string[]) => ValidAction;
     wait: (time: FunctionableValue<number>) => ValidAction;
-    function: (fn: (restoring: boolean, goingBack: boolean) => Thenable<void>) => ValidAction;
+    function: (fn: (restoring: boolean, goingBack: boolean, preview: boolean) => Thenable<void>) => ValidAction;
     input: (question: Unwrappable<Languages>, onInput: (meta: ActionInputOnInputMeta) => void, setup?: ActionInputSetup) => ValidAction;
     custom: (handler: CustomHandler) => ValidAction;
     vibrate: (...pattern: number[]) => ValidAction;
@@ -195,15 +193,16 @@ declare const JP: Record<BaseTranslationStrings, string>;
 type Stored<T> = {
     subscribe: (cb: (value: T) => void) => () => void;
     update: (fn: (prev: T) => T) => void;
+    set: (val: T) => void;
     get: () => T;
 };
 
 interface CharacterHandle {
     canvas: HTMLCanvasElement;
     ctx: CanvasRenderingContext2D;
-    withEmotion: (emotion: string) => () => void;
+    emotion: (emotion: string, render: boolean) => void;
     append: (className?: string, style?: string, restoring?: boolean) => void;
-    remove: (className?: string, style?: string, duration?: number) => (resolve: () => void, restoring: boolean) => void;
+    remove: (className?: string, style?: string, duration?: number, restoring?: boolean) => Promise<void>;
     emotions: Record<string, HTMLImageElement[]>;
 }
 type AudioHandle = {
@@ -211,37 +210,7 @@ type AudioHandle = {
     pause: () => void;
     play: () => void;
 };
-interface RendererStore {
-    characters: Record<string, CharacterHandle>;
-}
 type Renderer = {
-    character: (character: string) => CharacterHandle;
-    background: (background: string | BackgroundImage) => void;
-    dialog: (content: string, name: string, character?: string, emotion?: string) => (resolve: () => void, goingBack: boolean) => void;
-    choices: (question: string, choices: ([string, ValidAction[]] | [string, ValidAction[], () => boolean])[]) => (resolve: (selected: number) => void) => void;
-    input: (question: string, onInput: Parameters<DefaultActionProxyProvider['input']>[1], setup?: Parameters<DefaultActionProxyProvider['input']>[2]) => (resolve: () => void) => void;
-    audio: {
-        voice: (source: string) => void;
-        voiceStop: () => void;
-        music: (source: string, method: 'music' | 'sound', loop?: boolean) => AudioHandle;
-        /**
-         * Stop all sounds
-         */
-        clear: () => void;
-        /**
-         * Destroy
-         */
-        destroy: () => void;
-        /**
-         * Start
-         * @todo: more descriptive
-         */
-        start: () => void;
-    };
-    clear: (goingBack: boolean, keep: Set<keyof DefaultActionProxyProvider>, keepCharacters: Set<string>) => (resolve: () => void) => void;
-    custom: (fn: Parameters<DefaultActionProxyProvider['custom']>[0], goingBack: boolean, push: () => void) => Thenable<void>;
-    text: (str: string, resolve: () => void, goingBack: boolean) => void;
-    vibrate: (pattern: VibratePattern) => void;
     misc: {
         /**
          * Function to preload images async and await for all images to load or fail
@@ -261,7 +230,6 @@ type Renderer = {
          */
         preloadAudioBlocking: (type: 'music', source: string) => Promise<void>;
     };
-    store: RendererStore;
     ui: {
         /**
          * Shows the screen
@@ -285,7 +253,55 @@ type Renderer = {
             unmount(): void;
         };
     };
+    getContext: (context: string) => {
+        id: string;
+        get root(): HTMLElement;
+        set root(value: HTMLElement);
+        character: (character: string) => CharacterHandle;
+        background: (background: string | BackgroundImage) => void;
+        dialog: (content: string, name: string, character?: string, emotion?: string) => (resolve: () => void) => void;
+        choices: (question: string, choices: ([string, ValidAction[]] | [string, ValidAction[], () => boolean])[]) => (resolve: (selected: number) => void) => void;
+        input: (question: string, onInput: Parameters<DefaultActionProxyProvider['input']>[1], setup?: Parameters<DefaultActionProxyProvider['input']>[2]) => (resolve: () => void) => void;
+        clear: (keep: Set<keyof DefaultActionProxyProvider>, keepCharacters: Set<string>, keepAudio: {
+            music: Set<string>;
+            sounds: Set<string>;
+        }) => (resolve: () => void) => void;
+        custom: (fn: Parameters<DefaultActionProxyProvider['custom']>[0], push: () => void) => Thenable<void>;
+        clearCustom: (fn: Parameters<DefaultActionProxyProvider['custom']>[0]) => void;
+        text: (str: string, resolve: () => void) => void;
+        vibrate: (pattern: VibratePattern) => void;
+        audio: {
+            voice: (source: string) => void;
+            voiceStop: () => void;
+            music: (source: string, method: 'music' | 'sound', loop?: boolean) => AudioHandle;
+            /**
+             * Stop all sounds
+             */
+            clear: () => void;
+            /**
+             * Destroy
+             */
+            destroy: () => void;
+            /**
+             * Initialize audio service, attach events, etc
+             */
+            start: () => void;
+        };
+        meta: {
+            get restoring(): boolean;
+            set restoring(value: boolean);
+            get preview(): boolean;
+            set preview(value: boolean);
+            get goingBack(): boolean;
+            set goingBack(value: boolean);
+        };
+        store: unknown;
+        setStore: unknown;
+        getCharacter: (character: string) => CharacterHandle | undefined;
+    };
+    removeContext: (context: string) => void;
 };
+type Context = ReturnType<Renderer['getContext']>;
 type RendererInit = {
     characters: Record<string, Character>;
     set: (save: Save) => Promise<void>;
@@ -294,7 +310,6 @@ type RendererInit = {
     newGame: () => void;
     exit: (force?: boolean) => void;
     back: () => Promise<void>;
-    stack: Stack;
     languages: string[];
     /**
      * Translation function
@@ -308,6 +323,12 @@ type RendererInit = {
      * Store that used to communicate between renderer and core
      */
     $$: Stored<CoreData>;
+    /**
+     * There is different context, and the main one which is used for game
+     */
+    mainContextKey: string;
+    preview: (save: Save, name: string) => Promise<void>;
+    removeContext: (name: string) => void;
 };
 
 interface LocalStorageStorageSettings {
@@ -443,4 +464,4 @@ declare const novely: <Languages extends string, Characters extends Record<strin
     unwrap(content: string | (() => string) | Record<Languages, string> | Exclude<Record<Languages, string | (() => string)>, Record<string, string>>): string;
 };
 
-export { type ActionProxyProvider, type AllowedContent, type AudioHandle, type BaseTranslationStrings, type Character, type CharacterHandle, type CoreData, type CustomHandler, type CustomHandlerGetResult, type CustomHandlerGetResultDataFunction, type DefaultActionProxyProvider, EN, type Emotions, type FunctionableValue, type GetActionParameters, JP, KK, type Lang, type NovelyScreen, type Path, type PluralType, type Pluralization, RU, type Renderer, type RendererInit, type RendererStore, type Storage, type StorageData, type StorageMeta, type Stored, type Story, type Thenable, type TranslationActions, type TypewriterSpeed, type Unwrappable, type ValidAction, localStorageStorage, novely };
+export { type ActionProxyProvider, type AllowedContent, type AudioHandle, type BaseTranslationStrings, type Character, type CharacterHandle, type Context, type CoreData, type CustomHandler, type CustomHandlerGetResult, type CustomHandlerGetResultDataFunction, type DefaultActionProxyProvider, EN, type Emotions, type FunctionableValue, type GetActionParameters, JP, KK, type Lang, type NovelyScreen, type Path, type PluralType, type Pluralization, RU, type Renderer, type RendererInit, type Save, type Storage, type StorageData, type StorageMeta, type Stored, type Story, type Thenable, type TranslationActions, type TypewriterSpeed, type Unwrappable, type ValidAction, localStorageStorage, novely };