@novely/core 0.45.1 → 0.46.0-next.0

package/dist/index.d.ts

@@ -1,16 +1,9 @@
-type LocalStorageStorageSettings = {
-    key: string;
-};
-type NovelyStorage = {
-    get: () => Promise<StorageData>;
-    set: (data: StorageData) => Promise<void>;
+type Stored<T> = {
+    subscribe: (cb: (value: T) => void) => () => void;
+    update: (fn: (prev: T) => T) => void;
+    set: (val: T) => void;
+    get: () => T;
 };
-declare const localStorageStorage: (options: LocalStorageStorageSettings) => NovelyStorage;
-
-type PluralType = Intl.LDMLPluralRule;
-type Pluralization = Partial<Record<PluralType, string>>;
-type AllowedContent = string | ((state: State | Data) => string | string[]) | string[] | (string | ((state: State | Data) => string | string[]))[];
-type TranslationActions = Partial<Record<string, (str: string) => string>>;
 
 declare const RU: {
     NewGame: string;
@@ -47,6 +40,8 @@ declare const RU: {
     MusicVolume: string;
     SoundVolume: string;
     VoiceVolume: string;
+    Close: string;
+    DialogOverview: string;
 };
 type BaseTranslationStrings = keyof typeof RU;
 declare const EN: Record<BaseTranslationStrings, string>;
@@ -59,14 +54,7 @@ declare const KK: Record<BaseTranslationStrings, string>;
  */
 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 {
+type CharacterHandle = {
     canvas: HTMLCanvasElement;
     ctx: CanvasRenderingContext2D;
     emotion: (emotion: string, render: boolean) => void;
@@ -74,7 +62,7 @@ interface CharacterHandle {
     remove: (className?: string, style?: string, duration?: number, restoring?: boolean) => Promise<void>;
     animate: (classes: string[]) => void;
     emotions: Record<string, HTMLImageElement[]>;
-}
+};
 type CustomActionHandle = {
     /**
      * Function to remove custom action from screen (and from your state if any completely)
@@ -101,7 +89,13 @@ 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: Stored<boolean>, visible: Stored<boolean>, onselect: () => void, image: string][], resolve: (selected: number) => void) => void;
+    choices: (question: string, choices: [
+        name: string,
+        active: Stored<boolean>,
+        visible: Stored<boolean>,
+        onselect: () => void,
+        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>;
@@ -237,14 +231,29 @@ type RendererInit<$Language extends Lang, $Characters extends Record<string, Cha
     getLanguageDisplayName: (lang: Lang) => string;
     getCharacterColor: (character: string) => string;
     getCharacterAssets: (character: string, emotion: string) => string[];
-    getResourseType: (url: string) => Promise<"image" | "audio" | "other">;
+    getResourseType: (url: string) => Promise<'image' | 'audio' | 'other'>;
+    getDialogOverview: () => DialogOverview;
 };
 
+type LocalStorageStorageSettings = {
+    key: string;
+};
+type NovelyStorage = {
+    get: () => Promise<StorageData>;
+    set: (data: StorageData) => Promise<void>;
+};
+declare const localStorageStorage: (options: LocalStorageStorageSettings) => NovelyStorage;
+
+type PluralType = Intl.LDMLPluralRule;
+type Pluralization = Partial<Record<PluralType, string>>;
+type AllowedContent = string | ((state: State | Data) => string | string[]) | string[] | (string | ((state: State | Data) => string | string[]))[];
+type TranslationActions = Partial<Record<string, (str: string) => string>>;
+
 declare const getLanguage: (languages: string[]) => string;
 
 type NovelyAsset = {
     readonly source: string;
-    readonly type: "audio" | "image";
+    readonly type: 'audio' | 'image';
 };
 type Thenable<T> = T | Promise<T>;
 type PathItem = [null, number | string] | ['jump', string] | ['choice', number] | ['choice:exit'] | ['condition', string] | ['condition:exit'] | ['exit'] | ['block', string] | ['block:exit'];
@@ -254,11 +263,7 @@ type Data = Record<string, any>;
 type SaveDate = number;
 type SaveType = 'manual' | 'auto';
 type SaveMeta = [date: SaveDate, type: SaveType];
-type Save<S extends State = State> = [
-    path: Path,
-    state: S,
-    meta: SaveMeta
-];
+type Save<S extends State = State> = [path: Path, state: S, meta: SaveMeta, state_snapshots: S[]];
 type Lang = string;
 type TypewriterSpeed = 'Slow' | 'Medium' | 'Fast' | 'Auto';
 type SoundVolume = number;
@@ -313,7 +318,7 @@ type TranslationDescription = {
     actions?: TranslationActions;
 };
 type DefaultEmotions<$Characters extends Record<string, Character<Lang>>> = {
-    [Character in keyof $Characters]?: (keyof $Characters[Character]['emotions'] & string);
+    [Character in keyof $Characters]?: keyof $Characters[Character]['emotions'] & string;
 };
 type CharacterAssetSizes<$Characters extends Record<string, Character<Lang>>> = {
     [Character in keyof $Characters]?: {
@@ -551,6 +556,21 @@ type TypeEssentials<$Lang extends Lang, $State extends State, $Data extends Data
     readonly d: $Data | null;
     readonly c: $Characters | null;
 };
+type DialogOverviewEntry = {
+    /**
+     * Link to character voice
+     */
+    voice: string | undefined;
+    /**
+     * Character name
+     */
+    name: string;
+    /**
+     * Text that character says
+     */
+    text: string;
+};
+type DialogOverview = DialogOverviewEntry[];
 
 type Name<$Lang extends Lang> = string | Record<$Lang, string>;
 type Emotions<Emotion extends string = string> = Record<Emotion, string | NovelyAsset | (string | NovelyAsset)[]>;
@@ -563,7 +583,7 @@ type Character<$Lang extends Lang = 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] | ['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);
@@ -657,7 +677,7 @@ type CustomHandlerInfo = CustomHandlerCalling & {
     /**
      * Assets (pictures, audio files) used by action
      */
-    assets?: string[];
+    assets?: (NovelyAsset | string)[];
     /**
      * When true interacting with it will be saved in history
      */
@@ -885,7 +905,7 @@ declare const novely: <$Language extends string, $Characters extends Record<stri
      * @example
      * ```ts
      * import type { ConditionParams, StateFunction } from '@novely/core';
- *
+     *
      * const conditionCheck = (state: StateFunction<ConditionParams<typeof engine.typeEssintials>>) => {
      *   return state.age >= 18;
      * }