@novely/core 0.45.0 → 0.45.2

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;
@@ -59,13 +52,6 @@ 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 {
     canvas: HTMLCanvasElement;
     ctx: CanvasRenderingContext2D;
@@ -101,7 +87,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: ChoiceOnSelectFunction, 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 +229,28 @@ 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'>;
+};
+
+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 +260,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];
 type Lang = string;
 type TypewriterSpeed = 'Slow' | 'Medium' | 'Fast' | 'Auto';
 type SoundVolume = number;
@@ -313,7 +315,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]?: {
@@ -563,7 +565,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 +659,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
      */
@@ -730,8 +732,14 @@ type ChoiceCheckFunctionProps<L extends Lang, S extends State> = {
      */
     state: S;
 };
+type ChoiceOnSelectFunctionProps = {
+    /**
+     * Triggers `active` and `visible` properties computation
+     */
+    recompute: () => void;
+};
 type ChoiceCheckFunction<L extends Lang, S extends State> = (props: ChoiceCheckFunctionProps<L, S>) => boolean;
-type ChoiceOnSelectFunction = () => Thenable<void>;
+type ChoiceOnSelectFunction = (props: ChoiceOnSelectFunctionProps) => void;
 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 ActionInputSetupCleanup = () => void;
@@ -879,7 +887,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;
      * }
@@ -977,4 +985,4 @@ declare const extendAction: <Part0 extends Record<string, (...args: any[]) => Va
  */
 declare const asset: (...variants: string[]) => NovelyAsset;
 
-export { type ActionChoiceChoice, type ActionChoiceChoiceObject, type ActionInputOnInputMeta, type ActionInputSetup, type ActionInputSetupCleanup, type ActionProxy, type AllowedContent, type AudioHandle, type BackgroundImage, type BaseTranslationStrings, type Character, type CharacterAssetSizes, type CharacterHandle, type CharactersData, type ChoiceCheckFunction, type ChoiceCheckFunctionProps, type ChoiceOnSelectFunction, type ChoiceParams, type ConditionCheckFunction, type ConditionParams, type Context, type CoreData, type CustomActionHandle, type CustomHandler, type CustomHandlerFunction, type CustomHandlerFunctionGetFn, type CustomHandlerFunctionParameters, type CustomHandlerGetResult, type CustomHandlerGetResultDataFunction, type CustomHandlerInfo, 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 NovelyStorage, type Path, type PluralType, type Pluralization, RU, type Renderer, type RendererInit, type RendererInitPreviewReturn, type Save, type Stack, type StackHolder, type State, type StateFunction, type StorageData, type StorageMeta, type Stored, type Story, type TextContent, type Thenable, type TranslationActions, type TypeEssentials, type TypewriterSpeed, type ValidAction, asset, extendAction, localStorageStorage, novely };
+export { type ActionChoiceChoice, type ActionChoiceChoiceObject, type ActionInputOnInputMeta, type ActionInputSetup, type ActionInputSetupCleanup, type ActionProxy, type AllowedContent, type AudioHandle, type BackgroundImage, type BaseTranslationStrings, type Character, type CharacterAssetSizes, type CharacterHandle, type CharactersData, type ChoiceCheckFunction, type ChoiceCheckFunctionProps, type ChoiceOnSelectFunction, type ChoiceOnSelectFunctionProps, type ChoiceParams, type ConditionCheckFunction, type ConditionParams, type Context, type CoreData, type CustomActionHandle, type CustomHandler, type CustomHandlerFunction, type CustomHandlerFunctionGetFn, type CustomHandlerFunctionParameters, type CustomHandlerGetResult, type CustomHandlerGetResultDataFunction, type CustomHandlerInfo, 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 NovelyStorage, type Path, type PluralType, type Pluralization, RU, type Renderer, type RendererInit, type RendererInitPreviewReturn, type Save, type Stack, type StackHolder, type State, type StateFunction, type StorageData, type StorageMeta, type Stored, type Story, type TextContent, type Thenable, type TranslationActions, type TypeEssentials, type TypewriterSpeed, type ValidAction, asset, extendAction, localStorageStorage, novely };