@novely/core 0.10.0 → 0.12.0

package/dist/index.d.ts

@@ -14,17 +14,17 @@ type Character<LanguageKeys extends string = string> = {
 };
 
 type Thenable<T> = T | Promise<T>;
-type PathItem = [null, number | string] | ['choice' & Record<never, never>, number] | ['condition' & Record<never, never>, string] | ['exit' & Record<never, never>];
+type PathItem = [null, number | 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>;
 type SaveDate = number;
 type SaveType = 'manual' | 'auto';
-type SaveMeta = [SaveDate, SaveType];
-type Save = [Path, State, SaveMeta];
+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, TypewriterSpeed];
+type StorageMeta = [lang: Lang, typewriter_speed: TypewriterSpeed];
 type Migration = (save: unknown) => unknown;
 type StorageData = {
     saves: Save[];
@@ -44,8 +44,12 @@ type NovelyScreen = 'mainmenu' | 'game' | 'saves' | 'settings';
 type DeepPartial<T> = unknown extends T ? T : T extends object ? {
     [P in keyof T]?: T[P] extends Array<infer U> ? Array<DeepPartial<U>> : T[P] extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : DeepPartial<T[P]>;
 } : T;
+type NonEmptyRecord<T extends Record<PropertyKey, unknown>> = keyof T extends never ? never : T;
+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]] | ['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]] | ValidAction[];
+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 Story = Record<string, ValidAction[]>;
 type Unwrappable = string | ((lang: string, obj: Record<string, unknown>) => string) | Record<string, string | (() => string)>;
 type FunctionableValue<T> = T | (() => T);
@@ -100,6 +104,7 @@ interface ActionInputOnInputMeta {
     value: string;
 }
 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>> = {
     choice: {
         (...choices: ([Unwrappable, ValidAction[]] | [Unwrappable, ValidAction[], () => boolean])[]): ValidAction;
@@ -114,19 +119,15 @@ type ActionProxyProvider<Characters extends Record<string, Character>> = {
         (person: string, content: Unwrappable, emotion?: undefined): ValidAction;
     };
     end: () => ValidAction;
-    showBackground: (background: string) => ValidAction;
+    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;
     jump: (scene: string) => ValidAction;
     showCharacter: {
         <C extends keyof Characters>(character: C, emotion: keyof Characters[C]['emotions'], className?: string, style?: string): ValidAction;
     };
-    hideCharacter: {
-        <C extends keyof Characters>(character: C, className?: string, style?: string, duration?: number): ValidAction;
-    };
-    animateCharacter: {
-        <C extends keyof Characters>(character: C, timeout: number, ...classes: string[]): ValidAction;
-    };
+    hideCharacter: (character: keyof Characters, className?: string, style?: string, duration?: number) => ValidAction;
+    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;
@@ -135,6 +136,7 @@ type ActionProxyProvider<Characters extends Record<string, Character>> = {
     next: () => ValidAction;
     text: (...text: Unwrappable[]) => ValidAction;
     preload: (source: string) => ValidAction;
+    block: (scene: string) => ValidAction;
 };
 type DefaultActionProxyProvider = ActionProxyProvider<Record<string, Character>>;
 type GetActionParameters<T extends Capitalize<keyof DefaultActionProxyProvider>> = Parameters<DefaultActionProxyProvider[Uncapitalize<T>]>;
@@ -165,7 +167,7 @@ interface RendererStore {
 }
 type Renderer = {
     character: (character: string) => CharacterHandle;
-    background: (background: string) => void;
+    background: (background: string | BackgroundImage) => void;
     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;
@@ -176,13 +178,22 @@ type Renderer = {
     store: RendererStore;
     ui: {
         /**
-         * Показывает экран, скрывает другие
+         * Shows the screen
          */
         showScreen(name: 'mainmenu' | 'game' | 'saves' | 'settings' | 'loading'): void;
         /**
          * Shows prompt to exit
          */
         showExitPrompt(): void;
+        /**
+         * Render the game
+         */
+        start(): {
+            /**
+             * Unmount
+             */
+            unmount(): void;
+        };
     };
 };
 type RendererInit = {
@@ -203,6 +214,10 @@ type RendererInit = {
      * Store that tracks data updates
      */
     $: Stored<StorageData>;
+    /**
+     * Store that used to communicate between renderer and core
+     */
+    $$: Stored<CoreData>;
 };
 
 interface LocalStorageStorageSettings {
@@ -328,4 +343,4 @@ declare const novely: <Languages extends string, Characters extends Record<strin
     t: Inter["t"];
 };
 
-export { ActionProxyProvider, AudioHandle, Character, CharacterHandle, 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 { 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 };

package/dist/index.global.js

@@ -141,6 +141,13 @@ var Novely = (() => {
     novely: () => novely
   });
 
+  // src/constants.ts
+  var SKIPPED_DURING_RESTORE = /* @__PURE__ */ new Set(["dialog", "choice", "input", "vibrate", "text"]);
+  var BLOCK_EXIT_STATEMENTS = /* @__PURE__ */ new Set(["choice:exit", "condition:exit", "block:exit"]);
+  var BLOCK_STATEMENTS = /* @__PURE__ */ new Set(["choice", "condition", "block"]);
+  var EMPTY_SET = /* @__PURE__ */ new Set();
+  var DEFAULT_TYPEWRITER_SPEED = "Medium";
+
   // src/utils.ts
   var matchAction = (values) => {
     return (action, props) => {
@@ -213,8 +220,8 @@ var Novely = (() => {
     }
   };
   var findLastIndex = (array, fn) => {
-    for (let i = array.length - 1; i > 0; i--) {
-      if (fn(array[i])) {
+    for (let i = array.length - 1; i >= 0; i--) {
+      if (fn(array[i], array[i + 1])) {
         return i;
       }
     }
@@ -242,6 +249,24 @@ var Novely = (() => {
     });
     return { resolve, reject, promise };
   };
+  var findLastPathItemBeforeItemOfType = (path, name) => {
+    const index = findLastIndex(path, ([_name, _value], next) => {
+      return isNull(_name) && isNumber(_value) && next != null && next[0] === name;
+    });
+    return path[index];
+  };
+  var isBlockStatement = (statement) => {
+    return BLOCK_STATEMENTS.has(statement);
+  };
+  var isBlockExitStatement = (statement) => {
+    return BLOCK_EXIT_STATEMENTS.has(statement);
+  };
+  var isSkippedDurigRestore = (item) => {
+    return SKIPPED_DURING_RESTORE.has(item);
+  };
+  var isAction = (element) => {
+    return Array.isArray(element) && isString(element[0]);
+  };
 
   // src/global.ts
   var PRELOADED_ASSETS = /* @__PURE__ */ new Set();
@@ -298,11 +323,6 @@ var Novely = (() => {
     return val;
   }
 
-  // src/constants.ts
-  var SKIPPED_DURING_RESTORE = /* @__PURE__ */ new Set(["dialog", "choice", "input", "vibrate", "text"]);
-  var EMPTY_SET = /* @__PURE__ */ new Set();
-  var DEFAULT_TYPEWRITER_SPEED = "Medium";
-
   // ../t9n/dist/index.js
   var g = (e, r) => {
     let o = [];
@@ -447,41 +467,43 @@ var Novely = (() => {
       data: klona(defaultData),
       meta: [getLanguageWithoutParameters(), DEFAULT_TYPEWRITER_SPEED]
     };
+    const coreData = {
+      dataLoaded: false
+    };
     const $ = store(initialData);
-    let initialDataLoaded = false;
+    const $$ = store(coreData);
     const onStorageDataChange = (value) => {
-      if (initialDataLoaded)
+      if ($$.get().dataLoaded)
         storage.set(value);
     };
     const throttledOnStorageDataChange = throttle(onStorageDataChange, throttleTimeout);
     $.subscribe(throttledOnStorageDataChange);
-    const getStoredData = () => {
-      storage.get().then((stored) => {
-        for (const migration of migrations) {
-          stored = migration(stored);
-        }
-        stored.meta[1] ||= DEFAULT_TYPEWRITER_SPEED;
-        if (overrideLanguage) {
-          stored.meta[0] = getLanguageWithoutParameters();
-        } else {
-          stored.meta[0] ||= getLanguageWithoutParameters();
-        }
-        if (isEmpty(stored.data)) {
-          stored.data = defaultData;
-        }
-        initialDataLoaded = true;
-        $.update(() => stored);
-        if (initialScreen === "game")
-          assetsLoaded.promise.then(() => {
-            restore();
-          });
-      });
+    const getStoredData = async () => {
+      let stored = await storage.get();
+      for (const migration of migrations) {
+        stored = migration(stored);
+      }
+      stored.meta[1] ||= DEFAULT_TYPEWRITER_SPEED;
+      if (overrideLanguage) {
+        stored.meta[0] = getLanguageWithoutParameters();
+      } else {
+        stored.meta[0] ||= getLanguageWithoutParameters();
+      }
+      if (isEmpty(stored.data)) {
+        stored.data = defaultData;
+      }
+      $$.update((prev) => (prev.dataLoaded = true, prev));
+      $.update(() => stored);
+      if (initialScreen === "game") {
+        await assetsLoaded.promise;
+        restore();
+      }
     };
     storageDelay.then(getStoredData);
     const initial = getDefaultSave(klona(defaultState));
     const stack = createStack(initial);
     const save = (override = false, type = override ? "auto" : "manual") => {
-      if (!initialDataLoaded)
+      if (!$$.get().dataLoaded)
         return;
       if (!autosaves && type === "auto")
         return;
@@ -504,7 +526,7 @@ var Novely = (() => {
       });
     };
     const newGame = () => {
-      if (!initialDataLoaded)
+      if (!$$.get().dataLoaded)
         return;
       const save2 = getDefaultSave(klona(defaultState));
       if (autosaves) {
@@ -522,7 +544,7 @@ var Novely = (() => {
     let goingBack = false;
     let interacted = 0;
     const restore = async (save2) => {
-      if (!initialDataLoaded)
+      if (!$$.get().dataLoaded)
         return;
       let latest = save2 || $.get().saves.at(-1);
       if (!latest) {
@@ -534,31 +556,46 @@ var Novely = (() => {
         latest = klona(initial);
       }
       restoring = true, stack.value = latest;
+      const path = stack.value[0];
       let current = story;
+      let precurrent;
+      let ignoreNested = false;
       let index = 0;
       const max = stack.value[0].reduce((acc, [type, val]) => {
-        if (isNull(type) && isNumber(val))
+        if (isNull(type) && isNumber(val)) {
           return acc + 1;
+        }
         return acc;
       }, 0);
       const queue = [];
       const keep = /* @__PURE__ */ new Set();
       const characters2 = /* @__PURE__ */ new Set();
-      for (const [type, val] of stack.value[0]) {
+      const blocks = [];
+      for (const [type, val] of path) {
         if (type === null) {
-          if (isString(val)) {
-            current = current[val];
-          } else if (isNumber(val)) {
+          precurrent = current;
+          if (isNumber(val)) {
             index++;
-            for (let i = 0; i <= val; i++) {
-              const [action2, ...meta] = current[i];
+            let startIndex = 0;
+            if (ignoreNested) {
+              const prev = findLastPathItemBeforeItemOfType(path.slice(0, index), "block");
+              if (prev) {
+                startIndex = prev[1];
+                ignoreNested = false;
+              }
+            }
+            for (let i = startIndex; i <= val; i++) {
+              const item = current[i];
+              if (!isAction(item))
+                continue;
+              const [action2, ...meta] = item;
               const push2 = () => {
                 keep.add(action2);
                 queue.push([action2, meta]);
               };
               if (action2 === "showCharacter")
                 characters2.add(meta[0]);
-              if (SKIPPED_DURING_RESTORE.has(action2) || isUserRequiredAction(action2, meta)) {
+              if (isSkippedDurigRestore(action2) || isUserRequiredAction(action2, meta)) {
                 if (index === max && i === val) {
                   push2();
                 } else {
@@ -567,12 +604,20 @@ var Novely = (() => {
               }
               push2();
             }
-            current = current[val];
           }
+          current = current[val];
         } else if (type === "choice") {
+          blocks.push(precurrent = current);
           current = current[val + 1][1];
         } else if (type === "condition") {
+          blocks.push(precurrent = current);
           current = current[2][val];
+        } else if (type === "block") {
+          blocks.push(precurrent);
+          current = story[val];
+        } else if (type === "block:exit" || type === "choice:exit" || type === "condition:exit") {
+          current = blocks.pop();
+          ignoreNested = true;
         }
       }
       renderer.ui.showScreen("game");
@@ -587,7 +632,8 @@ var Novely = (() => {
               const c0 = _meta[0];
               const c1 = meta[0];
               const isIdenticalID = c0.id && c1.id && c0.id === c1.id;
-              return isIdenticalID || str(c0) === str(c1);
+              const isIdenticalByReference = c0 === c1;
+              return isIdenticalID || isIdenticalByReference || str(c0) === str(c1);
             });
             if (notLatest)
               continue;
@@ -618,15 +664,25 @@ var Novely = (() => {
       }
       restoring = goingBack = false, render();
     };
-    const refer = () => {
+    const refer = (path = stack.value[0]) => {
       let current = story;
-      for (const [type, val] of stack.value[0]) {
+      let precurrent = story;
+      const blocks = [];
+      for (const [type, val] of path) {
         if (type === null) {
+          precurrent = current;
           current = current[val];
         } else if (type === "choice") {
+          blocks.push(precurrent = current);
           current = current[val + 1][1];
         } else if (type === "condition") {
+          blocks.push(precurrent = current);
           current = current[2][val];
+        } else if (type === "block") {
+          blocks.push(precurrent);
+          current = story[val];
+        } else if (type === "block:exit" || type === "choice:exit" || type === "condition:exit") {
+          current = blocks.pop();
         }
       }
       return current;
@@ -663,8 +719,10 @@ var Novely = (() => {
       stack,
       languages,
       t: t9n.i,
-      $
+      $,
+      $$
     });
+    renderer.ui.start();
     const match = matchAction({
       wait([time]) {
         if (!restoring)
@@ -749,9 +807,13 @@ var Novely = (() => {
         renderer.clear(goingBack, keep || EMPTY_SET, characters2 || EMPTY_SET)(push);
       },
       condition([condition]) {
-        const value = condition();
-        if (!restoring)
-          stack.value[0].push(["condition", String(value)], [null, 0]), render();
+        if (!restoring) {
+          stack.value[0].push(
+            ["condition", String(condition())],
+            [null, 0]
+          );
+          render();
+        }
       },
       end() {
         match("clear", []);
@@ -803,24 +865,55 @@ var Novely = (() => {
         renderer.text(text.map((content) => unwrap(content)).join(" "), forward, goingBack);
       },
       exit() {
+        if (restoring)
+          return;
         const path = stack.value[0];
-        let exited = false;
+        const last = path.at(-1);
+        const ignore = [];
+        if (!isAction(refer(path))) {
+          if (last && isNull(last[0]) && isNumber(last[1])) {
+            last[1]--;
+          } else {
+            path.pop();
+          }
+        }
         for (let i = path.length - 1; i > 0; i--) {
-          if (path[i][0] !== "choice" && path[i][0] !== "condition")
+          const [name] = path[i];
+          if (isBlockExitStatement(name)) {
+            ignore.push(name);
+          }
+          if (!isBlockStatement(name))
+            continue;
+          if (ignore.at(-1)?.startsWith(name)) {
+            ignore.pop();
+            continue;
+          }
+          path.push([`${name}:exit`]);
+          const prev = findLastPathItemBeforeItemOfType(path.slice(0, i + 1), name);
+          if (prev)
+            path.push([null, prev[1] + 1]);
+          if (!isAction(refer(path))) {
+            path.pop();
             continue;
-          exited = true;
-          stack.value[0] = path.slice(0, i);
-          next();
+          }
           break;
         }
-        if (exited)
-          render();
+        render();
       },
       preload([source]) {
         if (!PRELOADED_ASSETS.has(source) && !goingBack && !restoring) {
           PRELOADED_ASSETS.add(document.createElement("img").src = source);
         }
         push();
+      },
+      block([scene]) {
+        if (!restoring) {
+          stack.value[0].push(
+            ["block", scene],
+            [null, 0]
+          );
+          render();
+        }
       }
     });
     const enmemory = () => {
@@ -834,13 +927,11 @@ var Novely = (() => {
     const next = () => {
       const path = stack.value[0];
       const last = path.at(-1);
-      if (!last)
-        return;
-      if (isNull(last[0]) && isNumber(last[1])) {
-        last[1] = last[1] + 1;
-        return;
+      if (last && isNull(last[0]) && isNumber(last[1])) {
+        last[1]++;
+      } else {
+        path.push([null, 0]);
       }
-      path.push([null, 0]);
     };
     const render = () => {
       const referred = refer();