@novely/core 0.16.0 → 0.18.0

package/dist/index.d.ts

@@ -17,7 +17,8 @@ type SaveMeta = [date: SaveDate, type: SaveType];
 type Save = [path: Path, state: State, meta: SaveMeta];
 type Lang = string;
 type TypewriterSpeed = 'Slow' | 'Medium' | 'Fast' | 'Auto' | (string & Record<never, never>);
-type StorageMeta = [lang: Lang, typewriter_speed: TypewriterSpeed];
+type SoundVolume = number;
+type StorageMeta = [lang: Lang, typewriter_speed: TypewriterSpeed, music_volume: SoundVolume, sound_volume: SoundVolume, voice_volume: SoundVolume];
 type Migration = (save: unknown) => unknown;
 type StorageData = {
     saves: Save[];
@@ -42,7 +43,7 @@ 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]] | ['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]] | ['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);
@@ -115,6 +116,16 @@ type ActionProxyProvider<Characters extends Record<string, Character>, Languages
     showBackground: <T extends string | BackgroundImage>(background: T extends string ? T : T extends Record<PropertyKey, unknown> ? NonEmptyRecord<T> : never) => ValidAction;
     playMusic: (audio: string) => ValidAction;
     stopMusic: (audio: string) => ValidAction;
+    playSound: (audio: string, loop?: boolean) => ValidAction;
+    stopSound: (audio: string) => ValidAction;
+    /**
+     * Plays voice
+     */
+    voice: (voice: string) => ValidAction;
+    /**
+     * Stops currently playing voice
+     */
+    stopVoice: () => ValidAction;
     jump: (scene: string) => ValidAction;
     showCharacter: {
         <C extends keyof Characters>(character: C, emotion: keyof Characters[C]['emotions'], className?: string, style?: string): ValidAction;
@@ -166,6 +177,9 @@ declare const RU: {
     ExitDialogBack: string;
     OpenMenu: string;
     CloseMenu: string;
+    MusicVolume: string;
+    SoundVolume: string;
+    VoiceVolume: string;
 };
 type BaseTranslationStrings = keyof typeof RU;
 declare const EN: Record<BaseTranslationStrings, string>;
@@ -192,15 +206,13 @@ interface CharacterHandle {
     remove: (className?: string, style?: string, duration?: number) => (resolve: () => void, restoring: boolean) => void;
     emotions: Record<string, HTMLImageElement[]>;
 }
-interface AudioHandle {
-    element: HTMLAudioElement;
+type AudioHandle = {
     stop: () => void;
     pause: () => void;
     play: () => void;
-}
+};
 interface RendererStore {
     characters: Record<string, CharacterHandle>;
-    audio: Partial<Record<'music', AudioHandle>>;
 }
 type Renderer = {
     character: (character: string) => CharacterHandle;
@@ -208,7 +220,24 @@ type Renderer = {
     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;
-    music: (source: string, method: keyof RendererStore['audio']) => AudioHandle;
+    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;
@@ -225,6 +254,12 @@ type Renderer = {
          * @returns Image URL
          */
         preloadImage: <T extends string>(image: T) => T;
+        /**
+         * Function to preload audio
+         * @param type kind of audio
+         * @param source <url> pointing to the audio
+         */
+        preloadAudioBlocking: (type: 'music', source: string) => Promise<void>;
     };
     store: RendererStore;
     ui: {

package/dist/index.global.js

@@ -610,7 +610,7 @@ var Novely = (() => {
     const initialData = {
       saves: [],
       data: klona(defaultData),
-      meta: [getLanguageWithoutParameters(), DEFAULT_TYPEWRITER_SPEED]
+      meta: [getLanguageWithoutParameters(), DEFAULT_TYPEWRITER_SPEED, 1, 1, 1]
     };
     const coreData = {
       dataLoaded: false
@@ -637,6 +637,9 @@ var Novely = (() => {
       } else {
         stored.meta[0] ||= getLanguageWithoutParameters();
       }
+      stored.meta[2] ??= 1;
+      stored.meta[3] ??= 1;
+      stored.meta[4] ??= 1;
       if (isEmpty(stored.data)) {
         stored.data = defaultData;
       }
@@ -702,7 +705,7 @@ var Novely = (() => {
         $.update(() => ({
           saves: [initial],
           data: klona(defaultData),
-          meta: [getLanguageWithoutParameters(), DEFAULT_TYPEWRITER_SPEED]
+          meta: [getLanguageWithoutParameters(), DEFAULT_TYPEWRITER_SPEED, 1, 1, 1]
         }));
         latest = klona(initial);
       }
@@ -852,6 +855,7 @@ var Novely = (() => {
       const current = stack.value;
       stack.clear();
       renderer.ui.showScreen("mainmenu");
+      renderer.audio.destroy();
       const [time, type] = current[2];
       if (type === "auto" && interacted <= 1 && times.has(time)) {
         $.update((prev) => {
@@ -893,11 +897,25 @@ var Novely = (() => {
         push();
       },
       playMusic([source]) {
-        renderer.music(source, "music").play();
+        renderer.audio.music(source, "music", true).play();
         push();
       },
       stopMusic([source]) {
-        renderer.music(source, "music").stop();
+        renderer.audio.music(source, "music").stop();
+        push();
+      },
+      playSound([source, loop]) {
+        renderer.audio.music(source, "sound", loop || false).play();
+      },
+      stopSound([source]) {
+        renderer.audio.music(source, "sound").stop();
+      },
+      voice([source]) {
+        renderer.audio.voice(source);
+        push();
+      },
+      stopVoice() {
+        renderer.audio.voiceStop();
         push();
       },
       showCharacter([character, emotion, className, style]) {
@@ -980,6 +998,7 @@ var Novely = (() => {
       clear([keep, characters2]) {
         renderer.vibrate(0);
         renderer.clear(goingBack, keep || EMPTY_SET, characters2 || EMPTY_SET)(push);
+        renderer.audio.clear();
       },
       condition([condition, variants]) {
         if (DEV && Object.values(variants).length === 0) {
@@ -1235,7 +1254,10 @@ var Novely = (() => {
     ExitDialogExit: "\u0412\u044B\u0439\u0442\u0438",
     ExitDialogBack: "\u0412\u0435\u0440\u043D\u0443\u0442\u044C\u0441\u044F \u0432 \u0438\u0433\u0440\u0443",
     OpenMenu: "\u041E\u0442\u043A\u0440\u044B\u0442\u044C \u043C\u0435\u043D\u044E",
-    CloseMenu: "\u0417\u0430\u043A\u0440\u044B\u0442\u044C \u043C\u0435\u043D\u044E"
+    CloseMenu: "\u0417\u0430\u043A\u0440\u044B\u0442\u044C \u043C\u0435\u043D\u044E",
+    MusicVolume: "\u0413\u0440\u043E\u043C\u043A\u043E\u0441\u0442\u044C \u043C\u0443\u0437\u044B\u043A\u0438",
+    SoundVolume: "\u0413\u0440\u043E\u043C\u043A\u043E\u0441\u0442\u044C \u0437\u0432\u0443\u043A\u043E\u0432",
+    VoiceVolume: "\u0413\u0440\u043E\u043C\u043A\u043E\u0441\u0442\u044C \u0440\u0435\u0447\u0438"
   };
   var EN = {
     NewGame: "New Game",
@@ -1268,7 +1290,10 @@ var Novely = (() => {
     ExitDialogExit: "Exit",
     ExitDialogBack: "Return to game",
     OpenMenu: "Open menu",
-    CloseMenu: "Close menu"
+    CloseMenu: "Close menu",
+    MusicVolume: "Music volume",
+    SoundVolume: "Sound volume",
+    VoiceVolume: "Voice volume"
   };
   var KK = {
     NewGame: "\u0416\u0430\u04A3\u0430 \u043E\u0439\u044B\u043D",
@@ -1301,7 +1326,10 @@ var Novely = (() => {
     ExitDialogExit: "\u0428\u044B\u0493\u0443",
     ExitDialogBack: "\u041E\u0439\u044B\u043D\u0493\u0430 \u043E\u0440\u0430\u043B\u0443",
     OpenMenu: "\u041C\u04D9\u0437\u0456\u0440\u0434\u0456 \u0430\u0448\u044B\u04A3\u044B\u0437",
-    CloseMenu: "\u041C\u04D9\u0437\u0456\u0440\u0434\u0456 \u0436\u0430\u0431\u0443"
+    CloseMenu: "\u041C\u04D9\u0437\u0456\u0440\u0434\u0456 \u0436\u0430\u0431\u0443",
+    MusicVolume: "\u041C\u0443\u0437\u044B\u043A\u0430\u043D\u044B\u04A3 \u043A\u04E9\u043B\u0435\u043C\u0456",
+    SoundVolume: "\u0414\u044B\u0431\u044B\u0441\u0442\u0430\u0440\u0434\u044B\u04A3 \u043A\u04E9\u043B\u0435\u043C\u0456",
+    VoiceVolume: "\u0421\u04E9\u0439\u043B\u0435\u0443 \u043A\u04E9\u043B\u0435\u043C\u0456"
   };
   var JP = {
     NewGame: "\u300C\u65B0\u3057\u3044\u30B2\u30FC\u30E0\u300D",
@@ -1334,7 +1362,10 @@ var Novely = (() => {
     ExitDialogExit: "\u7D42\u4E86",
     ExitDialogBack: "\u30B2\u30FC\u30E0\u306B\u623B\u308B",
     OpenMenu: "\u30E1\u30CB\u30E5\u30FC\u3092\u958B\u304F",
-    CloseMenu: "\u30E1\u30CB\u30E5\u30FC\u3092\u9589\u3058\u308B"
+    CloseMenu: "\u30E1\u30CB\u30E5\u30FC\u3092\u9589\u3058\u308B",
+    MusicVolume: "\u97F3\u697D\u306E\u30DC\u30EA\u30E5\u30FC\u30E0",
+    SoundVolume: "\u97F3\u91CF",
+    VoiceVolume: "\u30B9\u30D4\u30FC\u30C1\u306E\u91CF"
   };
   return __toCommonJS(src_exports);
 })();