@novely/core 0.25.0 → 0.26.0

package/dist/index.d.ts

@@ -88,6 +88,49 @@ type AudioHandle = {
     pause: () => void;
     play: () => void;
 };
+type Context = {
+    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 | undefined, emotion: string | undefined, resolve: () => void) => void;
+    choices: (question: string, choices: [name: string, active: boolean][], 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>;
+        sounds: Set<string>;
+    }, resolve: () => void) => void;
+    custom: (fn: CustomHandler<Lang, State>, push: () => void) => Thenable<void>;
+    clearCustom: (fn: CustomHandler<Lang, State>) => 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);
+    };
+};
 type Renderer = {
     misc: {
         /**
@@ -112,11 +155,11 @@ type Renderer = {
         /**
          * Shows the screen
          */
-        showScreen(name: NovelyScreen | 'loading'): void;
+        showScreen(name: NovelyScreen): void;
         /**
          * Returns current screen
          */
-        getScreen(): NovelyScreen | 'loading' | (string & Record<never, never>);
+        getScreen(): NovelyScreen | (string & Record<never, never>);
         /**
          * Shows prompt to exit
          */
@@ -131,80 +174,35 @@ 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 | undefined, emotion: string | undefined, resolve: () => void) => void;
-        choices: (question: string, choices: [name: string, actions: ValidAction[], active?: boolean][], resolve: (selected: number) => void) => void;
-        input: (question: string, onInput: (meta: ActionInputOnInputMeta<string, State>) => void, setup: ActionInputSetup, resolve: () => void) => void;
-        clear: (keep: Set<keyof DefaultActionProxy>, keepCharacters: Set<string>, keepAudio: {
-            music: Set<string>;
-            sounds: Set<string>;
-        }, resolve: () => void) => void;
-        custom: (fn: Parameters<DefaultActionProxy['custom']>[0], push: () => void) => Thenable<void>;
-        clearCustom: (fn: Parameters<DefaultActionProxy['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;
-    };
+    getContext: (context: string) => Context;
     removeContext: (context: string) => void;
 };
-type Context = ReturnType<Renderer['getContext']>;
 type RendererInit = {
-    characters: Record<string, Character>;
-    set: (save: Save) => Promise<void>;
-    restore: (save?: Save) => Promise<void>;
-    save: (override?: boolean, type?: Save[2][1]) => void;
+    characters: Record<string, Character<Lang>>;
+    set: (save: Save<State>) => Promise<void>;
+    restore: (save?: Save<State>) => Promise<void>;
+    save: (override?: boolean, type?: Save<State>[2][1]) => void;
     newGame: () => void;
     exit: (force?: boolean) => void;
     back: () => Promise<void>;
-    languages: string[];
+    languages: Lang[];
     /**
      * Translation function
      */
-    t: (key: BaseTranslationStrings, lang: string) => string;
+    t: (key: BaseTranslationStrings, lang: Lang) => string;
     /**
      * Store that tracks data updates
      */
-    $: Stored<StorageData>;
+    storageData: Stored<StorageData<Lang, Data>>;
     /**
      * Store that used to communicate between renderer and core
      */
-    $$: Stored<CoreData>;
+    coreData: Stored<CoreData>;
     /**
      * There is different context, and the main one which is used for game
      */
     mainContextKey: string;
-    preview: (save: Save, name: string) => Promise<void>;
+    preview: (save: Save<State>, name: string) => Promise<void>;
     removeContext: (name: string) => void;
     getStateFunction: (context: string) => StateFunction<State>;
 };
@@ -212,6 +210,7 @@ type RendererInit = {
 declare const getLanguage: (languages: string[]) => string;
 
 type Thenable<T> = T | Promise<T>;
+type NoInfer<T> = [T][T extends any ? 0 : never];
 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>;
@@ -225,7 +224,7 @@ type Save<S extends State = State> = [
     meta: SaveMeta
 ];
 type Lang = string;
-type TypewriterSpeed = 'Slow' | 'Medium' | 'Fast' | 'Auto' | (string & Record<never, never>);
+type TypewriterSpeed = 'Slow' | 'Medium' | 'Fast' | 'Auto';
 type SoundVolume = number;
 type StorageMeta<L extends string = string> = [
     lang: L,
@@ -246,7 +245,7 @@ type Stack = {
     push(value: Save): void;
     clear(): void;
 };
-type NovelyScreen = 'mainmenu' | 'game' | 'saves' | 'settings';
+type NovelyScreen = 'mainmenu' | 'game' | 'saves' | 'settings' | 'loading';
 /**
  * @see https://pendletonjones.com/deep-partial
  */
@@ -269,7 +268,7 @@ type TranslationDescription = {
     plural?: Record<string, Pluralization>;
     actions?: TranslationActions;
 };
-interface NovelyInit<Languages extends string, Characters extends Record<string, Character<Languages>>, StateScheme extends State, DataScheme extends Data> {
+interface NovelyInit<$Language extends Lang, Characters extends Record<string, Character<NoInfer<$Language>>>, StateScheme extends State, DataScheme extends Data> {
     /**
      * An object containing the characters in the game.
      * @example
@@ -301,7 +300,7 @@ interface NovelyInit<Languages extends string, Characters extends Record<string,
     /**
      * A function that returns a Renderer object used to display the game's content
      */
-    renderer: (characters: RendererInit) => Renderer;
+    renderer: (initializationData: RendererInit) => Renderer;
     /**
      * An optional property that specifies the initial screen to display when the game starts
      */
@@ -328,7 +327,7 @@ interface NovelyInit<Languages extends string, Characters extends Record<string,
      * })
      * ```
      */
-    translation: Record<Languages, TranslationDescription>;
+    translation: Record<$Language, TranslationDescription>;
     /**
      * Initial state value
      *
@@ -375,7 +374,7 @@ interface NovelyInit<Languages extends string, Characters extends Record<string,
      * })
      * ```
      */
-    getLanguage?: (languages: string[], original: typeof getLanguage) => string;
+    getLanguage?: (languages: NoInfer<$Language>[], original: typeof getLanguage) => $Language | (string & Record<never, never>);
     /**
      * Ignores saved language, and uses `getLanguage` to get it on every engine start
      * @default false
@@ -631,4 +630,4 @@ declare const novely: <Languages extends string, Characters extends Record<strin
     destroy(): void;
 };
 
-export { type ActionProxy, type AllowedContent, type AudioHandle, type BaseTranslationStrings, type Character, type CharacterHandle, type Context, type CoreData, type CustomHandler, type CustomHandlerFunctionGetFn, type CustomHandlerFunctionParameters, type CustomHandlerGetResult, type CustomHandlerGetResultDataFunction, type DefaultActionProxy, EN, type Emotions, type FunctionableValue, type GetActionParameters, 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 Storage, type StorageData, type StorageMeta, type Stored, type Story, type TextContent, type Thenable, type TranslationActions, type TypewriterSpeed, type ValidAction, localStorageStorage, novely };
+export { type ActionInputOnInputMeta, type ActionInputSetup, type ActionProxy, type AllowedContent, type AudioHandle, type BackgroundImage, type BaseTranslationStrings, type Character, type CharacterHandle, type Context, type CoreData, type CustomHandler, type CustomHandlerFunctionGetFn, type CustomHandlerFunctionParameters, type CustomHandlerGetResult, type CustomHandlerGetResultDataFunction, type Data, type DeepPartial, type DefaultActionProxy, EN, type Emotions, type FunctionableValue, type GetActionParameters, 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 TypewriterSpeed, type ValidAction, localStorageStorage, novely };

package/dist/index.global.js

@@ -953,7 +953,7 @@ var Novely = (() => {
       data: klona(defaultData),
       meta: [getLanguageWithoutParameters(), DEFAULT_TYPEWRITER_SPEED, 1, 1, 1]
     };
-    const $ = store(initialData);
+    const storageData = store(initialData);
     const coreData = store({
       dataLoaded: false
     });
@@ -975,10 +975,10 @@ var Novely = (() => {
     const throttledOnStorageDataChange = throttle(onStorageDataChange, throttleTimeout);
     const throttledEmergencyOnStorageDataChange = throttle(() => {
       if (saveOnUnload === true || saveOnUnload === "prod" && !DEV) {
-        onStorageDataChange($.get());
+        onStorageDataChange(storageData.get());
       }
     }, 10);
-    $.subscribe(throttledOnStorageDataChange);
+    storageData.subscribe(throttledOnStorageDataChange);
     const getStoredData = async () => {
       let stored = await storage.get();
       for (const migration of migrations) {
@@ -995,7 +995,7 @@ var Novely = (() => {
         stored.data = defaultData;
       }
       dataLoaded.resolve();
-      $.set(stored);
+      storageData.set(stored);
     };
     storageDelay.then(getStoredData);
     const initial = getDefaultSave(klona(defaultState));
@@ -1013,7 +1013,7 @@ var Novely = (() => {
         return;
       const stack = useStack(MAIN_CONTEXT_KEY);
       const current = klona(stack.value);
-      $.update((prev) => {
+      storageData.update((prev) => {
         const isLatest = findLastIndex(prev.saves, (value) => times.has(value[2][0])) === prev.saves.length - 1;
         current[2][0] = intime(Date.now());
         current[2][1] = type;
@@ -1035,7 +1035,7 @@ var Novely = (() => {
         return;
       const save2 = getDefaultSave(klona(defaultState));
       if (autosaves) {
-        $.update((prev) => {
+        storageData.update((prev) => {
           return prev.saves.push(save2), prev;
         });
       }
@@ -1050,10 +1050,10 @@ var Novely = (() => {
     const restore = async (save2) => {
       if (!coreData.get().dataLoaded)
         return;
-      let latest = save2 || $.get().saves.at(-1);
+      let latest = save2 || storageData.get().saves.at(-1);
       if (!latest) {
         latest = klona(initial);
-        $.update((prev) => {
+        storageData.update((prev) => {
           prev.saves.push(latest);
           return prev;
         });
@@ -1137,7 +1137,7 @@ var Novely = (() => {
       ctx.audio.destroy();
       const [time, type] = current[2];
       if (type === "auto" && interacted <= 1 && times.has(time)) {
-        $.update((prev) => {
+        storageData.update((prev) => {
           prev.saves = prev.saves.filter((save2) => save2 !== current);
           return prev;
         });
@@ -1208,8 +1208,8 @@ var Novely = (() => {
       removeContext,
       getStateFunction,
       languages,
-      $,
-      $$: coreData
+      storageData,
+      coreData
     });
     const useStack = createUseStackFunction(renderer);
     useStack(MAIN_CONTEXT_KEY).push(initial);
@@ -1303,7 +1303,7 @@ var Novely = (() => {
         const name = (() => {
           const c = character;
           const cs = characters;
-          const [lang] = $.get().meta;
+          const [lang] = storageData.get().meta;
           if (c && c in cs) {
             const block = cs[c].name;
             if (typeof block === "string") {
@@ -1335,7 +1335,7 @@ var Novely = (() => {
       function({ ctx, push }, [fn]) {
         const { restoring, goingBack, preview: preview2 } = ctx.meta;
         const result = fn({
-          lang: $.get().meta[0],
+          lang: storageData.get().meta[0],
           goingBack,
           restoring,
           preview: preview2,
@@ -1354,13 +1354,13 @@ var Novely = (() => {
         }
         const transformedChoices = choices.map(([content, action2, visible]) => {
           const shown = !visible || visible({
-            lang: $.get().meta[0],
+            lang: storageData.get().meta[0],
             state: getStateAtCtx(ctx)
           });
           if (DEV && action2.length === 0 && !shown) {
             console.warn(`Choice children should not be empty, either add content there or make item not selectable`);
           }
-          return [templateReplace(content, data2), action2, shown];
+          return [templateReplace(content, data2), shown];
         });
         if (DEV && transformedChoices.length === 0) {
           throw new Error(`Running choice without variants to choose from, look at how to use Choice action properly [https://novely.pages.dev/guide/actions/choice#usage]`);
@@ -1567,7 +1567,7 @@ var Novely = (() => {
       const {
         data: data2,
         meta: [lang]
-      } = $.get();
+      } = storageData.get();
       const obj = values || data2;
       const cnt = isFunction(content) ? content(obj) : typeof content === "string" ? content : content[lang];
       const str2 = flattenAllowedContent(
@@ -1585,11 +1585,11 @@ var Novely = (() => {
       );
     };
     const data = (value) => {
-      const _data = $.get().data;
+      const _data = storageData.get().data;
       if (!value)
         return _data;
       const val = isFunction(value) ? value(_data) : deepmerge(_data, value);
-      $.update((prev) => {
+      storageData.update((prev) => {
         prev.data = val;
         return prev;
       });