@novely/core 0.12.5 → 0.14.0

package/README.md

@@ -1,3 +1,5 @@
 # @novely/core
 
-Novely - движок визуальных новелл для создания интерактивных историй и игр.
+Novely - Novel Engine for creating interactive stories
+
+See more on [website](https://novely.pages.dev)

package/dist/index.d.ts

@@ -1,7 +1,3 @@
-import * as _novely_t9n from '@novely/t9n';
-import { BaseTranslationStrings, SetupT9N } from '@novely/t9n';
-export { BaseTranslationStrings } from '@novely/t9n';
-
 type Name<Keys extends string = string> = string | Record<Keys, string>;
 type Emotions<Keys extends string = string> = Record<Keys, string | {
     body: Record<'left' | 'right', string>;
@@ -14,7 +10,7 @@ type Character<LanguageKeys extends string = string> = {
 };
 
 type Thenable<T> = T | Promise<T>;
-type PathItem = [null, number | string] | ['choice', number] | ['choice:exit'] | ['condition', string] | ['condition:exit'] | ['exit'] | ['block', string] | ['block:exit'];
+type PathItem = [null, number | string] | ['jump', string] | ['choice', number] | ['choice:exit'] | ['condition', string] | ['condition:exit'] | ['exit'] | ['block', string] | ['block:exit'];
 type Path = PathItem[];
 type State = Record<string, any>;
 type Data = Record<string, any>;
@@ -49,9 +45,9 @@ type CoreData = {
     dataLoaded: boolean;
 };
 
-type ValidAction = ['choice', [number]] | ['clear', [Set<keyof DefaultActionProxyProvider>?, Set<string>?]] | ['condition', [() => boolean, Record<string, ValidAction[]>]] | ['dialog', [string | undefined, Unwrappable, string | undefined]] | ['end', []] | ['showBackground', [string | NonEmptyRecord<BackgroundImage>]] | ['playMusic', [string]] | ['stopMusic', [string]] | ['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 | undefined]] | ['end', []] | ['showBackground', [string | NonEmptyRecord<BackgroundImage>]] | ['playMusic', [string]] | ['stopMusic', [string]] | ['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 = string | ((lang: string, obj: Record<string, unknown>) => string) | Record<string, string | (() => string)>;
+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>;
@@ -105,18 +101,18 @@ interface ActionInputOnInputMeta {
 }
 type ActionInputSetup = (input: HTMLInputElement, cleanup: (cb: () => void) => void) => void;
 type BackgroundImage = Partial<Record<"portrait" | "landscape" | "all", string>> & Record<(string), string>;
-type ActionProxyProvider<Characters extends Record<string, Character>> = {
+type ActionProxyProvider<Characters extends Record<string, Character>, Languages extends string> = {
     choice: {
-        (...choices: ([Unwrappable, ValidAction[]] | [Unwrappable, ValidAction[], () => boolean])[]): ValidAction;
-        (question: Unwrappable, ...choices: ([Unwrappable, ValidAction[]] | [Unwrappable, ValidAction[], () => boolean])[]): ValidAction;
+        (...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;
     condition: <T extends string | true | false>(condition: () => T, variants: Record<T extends true ? 'true' : T extends false ? 'false' : T, ValidAction[]>) => ValidAction;
     exit: () => ValidAction;
     dialog: {
-        <C extends keyof Characters>(person: C, content: Unwrappable, emotion?: keyof Characters[C]['emotions']): ValidAction;
-        (person: undefined, content: Unwrappable, emotion?: undefined): ValidAction;
-        (person: string, content: Unwrappable, emotion?: undefined): ValidAction;
+        <C extends keyof Characters>(person: C, content: Unwrappable<Languages>, emotion?: keyof Characters[C]['emotions']): ValidAction;
+        (person: undefined, content: Unwrappable<Languages>, emotion?: undefined): ValidAction;
+        (person: string, content: Unwrappable<Languages>, emotion?: undefined): ValidAction;
     };
     end: () => ValidAction;
     showBackground: <T extends string | BackgroundImage>(background: T extends string ? T : T extends Record<PropertyKey, unknown> ? NonEmptyRecord<T> : never) => ValidAction;
@@ -130,17 +126,61 @@ type ActionProxyProvider<Characters extends Record<string, Character>> = {
     animateCharacter: (character: keyof Characters, timeout: number, ...classes: string[]) => ValidAction;
     wait: (time: FunctionableValue<number>) => ValidAction;
     function: (fn: (restoring: boolean, goingBack: boolean) => Thenable<void>) => ValidAction;
-    input: (question: Unwrappable, onInput: (meta: ActionInputOnInputMeta) => void, setup?: ActionInputSetup) => ValidAction;
+    input: (question: Unwrappable<Languages>, onInput: (meta: ActionInputOnInputMeta) => void, setup?: ActionInputSetup) => ValidAction;
     custom: (handler: CustomHandler) => ValidAction;
     vibrate: (...pattern: number[]) => ValidAction;
     next: () => ValidAction;
-    text: (...text: Unwrappable[]) => ValidAction;
+    text: (...text: Unwrappable<Languages>[]) => ValidAction;
     preload: (source: string) => ValidAction;
     block: (scene: string) => ValidAction;
 };
-type DefaultActionProxyProvider = ActionProxyProvider<Record<string, Character>>;
+type DefaultActionProxyProvider = ActionProxyProvider<Record<string, Character>, string>;
 type GetActionParameters<T extends Capitalize<keyof DefaultActionProxyProvider>> = Parameters<DefaultActionProxyProvider[Uncapitalize<T>]>;
 
+declare const RU: {
+    NewGame: string;
+    HomeScreen: string;
+    ToTheGame: string;
+    Language: string;
+    NoSaves: string;
+    LoadSave: string;
+    Saves: string;
+    Settings: string;
+    Sumbit: string;
+    GoBack: string;
+    DoSave: string;
+    Auto: string;
+    Stop: string;
+    Exit: string;
+    Automatic: string;
+    Manual: string;
+    Remove: string;
+    LoadASaveFrom: string;
+    DeleteASaveFrom: string;
+    TextSpeed: string;
+    TextSpeedSlow: string;
+    TextSpeedMedium: string;
+    TextSpeedFast: string;
+    TextSpeedAuto: string;
+    CompleteText: string;
+    GoForward: string;
+    ExitDialogWarning: string;
+    ExitDialogExit: string;
+    ExitDialogBack: string;
+    OpenMenu: string;
+    CloseMenu: string;
+};
+type BaseTranslationStrings = keyof typeof RU;
+declare const EN: Record<BaseTranslationStrings, string>;
+/**
+ * Translated automatically
+ */
+declare const KK: Record<BaseTranslationStrings, string>;
+/**
+ * Translated automatically
+ */
+declare const JP: Record<BaseTranslationStrings, string>;
+
 type Stored<T> = {
     subscribe: (cb: (value: T) => void) => () => void;
     update: (fn: (prev: T) => T) => void;
@@ -194,7 +234,11 @@ type Renderer = {
         /**
          * Shows the screen
          */
-        showScreen(name: 'mainmenu' | 'game' | 'saves' | 'settings' | 'loading'): void;
+        showScreen(name: NovelyScreen | 'loading'): void;
+        /**
+         * Returns current screen
+         */
+        getScreen(): NovelyScreen | 'loading' | (string & Record<never, never>);
         /**
          * Shows prompt to exit
          */
@@ -243,9 +287,14 @@ interface Storage {
 }
 declare const localStorageStorage: (options: LocalStorageStorageSettings) => Storage;
 
+type PluralType = Intl.LDMLPluralRule;
+type Pluralization = Partial<Record<PluralType, string>>;
+type AllowedContent = string | (() => string | string[]) | string[] | (string | (() => string | string[]))[];
+type TranslationActions = Partial<Record<string, (str: string) => string>>;
+
 declare const getLanguage: (languages: string[]) => string;
 
-interface NovelyInit<Languages extends string, Characters extends Record<string, Character<Languages>>, Inter extends ReturnType<SetupT9N<Languages>>, StateScheme extends State, DataScheme extends Data> {
+interface NovelyInit<Languages extends string, Characters extends Record<string, Character<Languages>>, StateScheme extends State, DataScheme extends Data> {
     /**
      * An array of languages supported by the game.
      */
@@ -256,8 +305,9 @@ interface NovelyInit<Languages extends string, Characters extends Record<string,
     characters: Characters;
     /**
      * An object that provides access to the game's storage system.
+     * @default localStorage // at key `novely-game-storage`
      */
-    storage: Storage;
+    storage?: Storage;
     /**
      * Delay loading data until Promise is resolved
      */
@@ -273,7 +323,15 @@ interface NovelyInit<Languages extends string, Characters extends Record<string,
     /**
      * An object containing the translation functions used in the game
      */
-    t9n: Inter;
+    translation: Record<Languages, {
+        internal: Record<BaseTranslationStrings, string>;
+        /**
+         * IETF BCP 47 language tag
+         */
+        tag?: string;
+        plural?: Record<string, Pluralization>;
+        actions?: TranslationActions;
+    }>;
     /**
      * Initial state value
      */
@@ -324,15 +382,15 @@ interface NovelyInit<Languages extends string, Characters extends Record<string,
      */
     preloadAssets?: "lazy" | "blocking";
 }
-declare const novely: <Languages extends string, Characters extends Record<string, Character<Languages>>, Inter extends _novely_t9n.T9N<Languages, string>, StateScheme extends State, DataScheme extends Data>({ characters, storage, storageDelay, renderer: createRenderer, initialScreen, t9n, languages, state: defaultState, data: defaultData, autosaves, migrations, throttleTimeout, getLanguage, overrideLanguage, askBeforeExit, preloadAssets }: NovelyInit<Languages, Characters, Inter, StateScheme, DataScheme>) => {
+declare const novely: <Languages extends string, Characters extends Record<string, Character<Languages>>, StateScheme extends State, DataScheme extends Data>({ characters, storage, storageDelay, renderer: createRenderer, initialScreen, translation, languages, state: defaultState, data: defaultData, autosaves, migrations, throttleTimeout, getLanguage, overrideLanguage, askBeforeExit, preloadAssets }: NovelyInit<Languages, Characters, StateScheme, DataScheme>) => {
     /**
      * Function to set story
      */
-    withStory: (s: Story) => Promise<void>;
+    withStory: (story: Story) => Promise<void>;
     /**
      * Function to get actions
      */
-    action: ActionProxyProvider<Characters>;
+    action: ActionProxyProvider<Characters, Languages>;
     /**
      * State that belongs to games
      */
@@ -350,11 +408,7 @@ declare const novely: <Languages extends string, Characters extends Record<strin
     /**
      * Unwraps translatable content to a string value
      */
-    unwrap(content: Unwrappable | Record<Languages, string>): string;
-    /**
-     * Function that is used for translation
-     */
-    t: Inter["t"];
+    unwrap(content: string | (() => string) | Record<Languages, string> | Exclude<Record<Languages, string | (() => string)>, Record<string, string>>): string;
 };
 
-export { ActionProxyProvider, AudioHandle, Character, CharacterHandle, CoreData, CustomHandler, CustomHandlerGetResult, CustomHandlerGetResultDataFunction, DefaultActionProxyProvider, Emotions, FunctionableValue, GetActionParameters, Lang, NovelyScreen, Path, Renderer, RendererInit, RendererStore, Storage, StorageData, StorageMeta, Stored, Story, Thenable, TypewriterSpeed, Unwrappable, ValidAction, localStorageStorage, novely };
+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 };