@novely/core 0.4.4 → 0.6.0

package/dist/index.d.ts

@@ -19,11 +19,11 @@ type Path = PathItem[];
 type State = Record<string, any>;
 type Data = Record<string, any>;
 type SaveDate = number;
-type SaveType = "manual" | "auto";
+type SaveType = 'manual' | 'auto';
 type SaveMeta = [SaveDate, SaveType];
 type Save = [Path, State, SaveMeta];
 type Lang = string;
-type TypewriterSpeed = "Slow" | "Medium" | "Fast" | "Auto" | (string & {});
+type TypewriterSpeed = 'Slow' | 'Medium' | 'Fast' | 'Auto' | (string & {});
 type StorageMeta = [Lang, TypewriterSpeed];
 type Migration = (save: unknown) => unknown;
 type StorageData = {
@@ -37,7 +37,7 @@ type Stack = {
     push(value: Save): void;
     clear(): void;
 };
-type NovelyScreen = "mainmenu" | "game" | "saves" | "settings";
+type NovelyScreen = 'mainmenu' | 'game' | 'saves' | 'settings';
 /**
  * @see https://pendletonjones.com/deep-partial
  */
@@ -45,9 +45,9 @@ 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 ValidAction = ['choice', [number]] | ['clear', []] | ['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'] | 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]] | ['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'] | ValidAction[];
 type Story = Record<string, ValidAction[]>;
-type Unwrappable = string | ((lang: string, obj: Record<string, unknown>) => string) | Record<string, string>;
+type Unwrappable = string | ((lang: string, obj: Record<string, unknown>) => string) | Record<string, string | (() => string)>;
 type FunctionableValue<T> = T | (() => T);
 type CustomHandlerGetResultDataFunction = {
     (data?: Record<string, unknown>): Record<string, unknown>;
@@ -76,6 +76,7 @@ type CustomHandler = CustomHandlerFunction & {
     callOnlyLatest?: boolean;
     requireUserAction?: boolean;
     skipClearOnGoingBack?: boolean;
+    id?: string | symbol;
 };
 interface ActionInputOnInputMeta {
     /**
@@ -104,7 +105,7 @@ type ActionProxyProvider<Characters extends Record<string, Character>> = {
         (...choices: ([Unwrappable, ValidAction[]] | [Unwrappable, ValidAction[], () => boolean])[]): ValidAction;
         (question: Unwrappable, ...choices: ([Unwrappable, ValidAction[]] | [Unwrappable, ValidAction[], () => boolean])[]): ValidAction;
     };
-    clear: () => 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: {
@@ -149,7 +150,7 @@ interface CharacterHandle {
     withEmotion: (emotion: string) => () => void;
     append: (className?: string, style?: string, restoring?: boolean) => void;
     remove: (className?: string, style?: string, duration?: number) => (resolve: () => void, restoring: boolean) => void;
-    emotions: Record<string, HTMLImageElement | Record<"head" | "left" | "right", HTMLImageElement>>;
+    emotions: Record<string, HTMLImageElement | Record<'head' | 'left' | 'right', HTMLImageElement>>;
 }
 interface AudioHandle {
     element: HTMLAudioElement;
@@ -159,7 +160,7 @@ interface AudioHandle {
 }
 interface RendererStore {
     characters: Record<string, CharacterHandle>;
-    audio: Partial<Record<"music", AudioHandle>>;
+    audio: Partial<Record<'music', AudioHandle>>;
 }
 type Renderer = {
     character: (character: string) => CharacterHandle;
@@ -168,7 +169,7 @@ type Renderer = {
     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;
-    clear: (goingBack: boolean) => (resolve: () => void) => 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) => void;
     store: RendererStore;
@@ -176,7 +177,7 @@ type Renderer = {
         /**
          * Показывает экран, скрывает другие
          */
-        showScreen(name: "mainmenu" | "game" | "saves" | "settings" | 'loading'): void;
+        showScreen(name: 'mainmenu' | 'game' | 'saves' | 'settings' | 'loading'): void;
     };
 };
 type RendererInit = {
@@ -254,8 +255,25 @@ interface NovelyInit<Languages extends string, Characters extends Record<string,
      * Migration from old saves to newer
      */
     migrations?: Migration[];
+    /**
+     * For saves Novely uses `throttle` function. This might be needed if you want to control frequency of saves to the storage
+     * @default 799
+     */
+    throttleTimeout?: number;
+    /**
+     * Custom language detector
+     * @param languages Supported languages aka `languages: []` in the config
+     * @example ```ts
+     * novely({
+     * 		getLanguage(languages) {
+     * 				return sdk.environment.i18n.lang // i.e. custom language from some sdk
+     * 		}
+     * })
+     * ```
+     */
+    getLanguage?: (languages: string[]) => string;
 }
-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 }: NovelyInit<Languages, Characters, Inter, StateScheme, DataScheme>) => {
+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 }: NovelyInit<Languages, Characters, Inter, StateScheme, DataScheme>) => {
     /**
      * Function to set story
      */
@@ -281,7 +299,7 @@ declare const novely: <Languages extends string, Characters extends Record<strin
     /**
      * Unwraps translatable content to a string value
      */
-    unwrap(content: string | ((lang: string, obj: Record<string, unknown>) => string) | Record<Languages, string>): string;
+    unwrap(content: Unwrappable | Record<Languages, string>): string;
     /**
      * Function that is used for translation
      */

package/dist/index.global.js

@@ -159,6 +159,9 @@ var Novely = (() => {
   var isFunction = (val) => {
     return typeof val === "function";
   };
+  var isPromise = (val) => {
+    return Boolean(val) && (typeof val === "object" || isFunction(val)) && isFunction(val.then);
+  };
   var isEmpty = (val) => {
     return typeof val === "object" && !isNull(val) && Object.keys(val).length === 0;
   };
@@ -270,34 +273,30 @@ var Novely = (() => {
   }
 
   // src/constants.ts
-  var SKIPPED_DURING_RESTORE = /* @__PURE__ */ new Set([
-    "dialog",
-    "choice",
-    "input",
-    "vibrate",
-    "text"
-  ]);
+  var SKIPPED_DURING_RESTORE = /* @__PURE__ */ new Set(["dialog", "choice", "input", "vibrate", "text"]);
+  var EMPTY_SET = /* @__PURE__ */ new Set();
 
   // ../t9n/dist/index.js
-  var p = (t, i) => {
+  var d = (e, o) => {
     let r = [];
-    for (let a of i) {
-      if (!t)
+    for (let a of o) {
+      if (!e)
         break;
-      let [e, s] = t.split(a, 2);
-      r.push(e), t = s;
+      let [t, i] = e.split(a, 2);
+      r.push(t), e = i;
     }
-    return r.push(t), r;
+    return r.push(e), r;
   };
-  var T = /{{(.*?)}}/g;
-  var c = (t, i, r, a, e) => t.replace(T, (s, o, n) => {
-    s = 0, n = i;
-    let [d, g, l] = p(o.trim(), ["@", "%"]), u = d.split(".");
-    for (; n && s < u.length; )
-      n = n[u[s++]];
-    g && r && n && e && (n = r[g][e.select(n)]);
-    let S = a && l && a[l];
-    return S && (n = S(n)), n ?? "";
+  var m = /{{(.*?)}}/g;
+  var l = (e) => Array.isArray(e) ? e.map((o) => l(o)).join("<br>") : typeof e == "function" ? l(e()) : e;
+  var T = (e, o, r, a, t) => l(e).replace(m, (i, s, n) => {
+    i = 0, n = o;
+    let [c, g, u] = d(s.trim(), ["@", "%"]), S = c.split(".");
+    for (; n && i < S.length; )
+      n = n[S[i++]];
+    g && r && n && t && (n = r[g][t.select(n)]);
+    let p = a && u && a[u];
+    return p && (n = p(n)), n ?? "";
   });
 
   // src/novely.ts
@@ -312,7 +311,9 @@ var Novely = (() => {
     state: defaultState,
     data: defaultData,
     autosaves = true,
-    migrations = []
+    migrations = [],
+    throttleTimeout = 799,
+    getLanguage: getLanguage2 = getLanguage
   }) => {
     let story;
     let times = /* @__PURE__ */ new Set();
@@ -322,17 +323,19 @@ var Novely = (() => {
       return times.add(value), value;
     };
     const withStory = (s) => {
-      story = Object.fromEntries(Object.entries(s).map(([name, items]) => {
-        const flat = (item) => {
-          return item.flatMap((data2) => {
-            const type = data2[0];
-            if (Array.isArray(type))
-              return flat(data2);
-            return [data2];
-          });
-        };
-        return [name, flat(items)];
-      }));
+      story = Object.fromEntries(
+        Object.entries(s).map(([name, items]) => {
+          const flat = (item) => {
+            return item.flatMap((data2) => {
+              const type = data2[0];
+              if (Array.isArray(type))
+                return flat(data2);
+              return [data2];
+            });
+          };
+          return [name, flat(items)];
+        })
+      );
       if (initialScreen !== "game")
         renderer.ui.showScreen(initialScreen);
     };
@@ -351,7 +354,14 @@ var Novely = (() => {
       stack.value[1] = val;
     }
     const getDefaultSave = (state2 = {}) => {
-      return [[[null, "start"], [null, 0]], state2, [intime(Date.now()), "auto"]];
+      return [
+        [
+          [null, "start"],
+          [null, 0]
+        ],
+        state2,
+        [intime(Date.now()), "auto"]
+      ];
     };
     const createStack = (current, stack2 = [current]) => {
       return {
@@ -376,7 +386,7 @@ var Novely = (() => {
     const initialData = {
       saves: [],
       data: klona(defaultData),
-      meta: [getLanguage(languages), getTypewriterSpeed()]
+      meta: [getLanguage2(languages), getTypewriterSpeed()]
     };
     const $ = store(initialData);
     let initialDataLoaded = false;
@@ -384,14 +394,14 @@ var Novely = (() => {
       if (initialDataLoaded)
         storage.set(value);
     };
-    const throttledOnStorageDataChange = throttle(onStorageDataChange, 120);
+    const throttledOnStorageDataChange = throttle(onStorageDataChange, throttleTimeout);
     $.subscribe(throttledOnStorageDataChange);
     const getStoredData = () => {
       storage.get().then((stored) => {
         for (const migration of migrations) {
           stored = migration(stored);
         }
-        stored.meta[0] ||= getLanguage(languages);
+        stored.meta[0] ||= getLanguage2(languages);
         stored.meta[1] ||= getTypewriterSpeed();
         if (isEmpty(stored.data)) {
           stored.data = defaultData;
@@ -451,12 +461,14 @@ var Novely = (() => {
         return;
       let latest = save2 ? save2 : $.get().saves.at(-1);
       if (!latest) {
-        $.update(() => ({ saves: [initial], data: klona(defaultData), meta: [getLanguage(languages), getTypewriterSpeed()] }));
+        $.update(() => ({
+          saves: [initial],
+          data: klona(defaultData),
+          meta: [getLanguage2(languages), getTypewriterSpeed()]
+        }));
         latest = klona(initial);
       }
       restoring = true, stack.value = latest;
-      renderer.ui.showScreen("game");
-      match("clear", [goingBack]);
       let current = story;
       let index = 0;
       const max = stack.value[0].reduce((acc, [type, val]) => {
@@ -465,22 +477,30 @@ var Novely = (() => {
         return acc;
       }, 0);
       const queue = [];
+      const keep = /* @__PURE__ */ new Set();
+      const characters2 = /* @__PURE__ */ new Set();
       for (const [type, val] of stack.value[0]) {
         if (type === null) {
           if (isString(val)) {
             current = current[val];
           } else if (isNumber(val)) {
             index++;
-            for (let i = 0; i < val; i++) {
+            for (let i = 0; i <= val; i++) {
               const [action2, ...meta] = current[i];
+              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 (index === max && i === val) {
-                  queue.push([action2, meta]);
+                  push2();
                 } else {
                   continue;
                 }
               }
-              queue.push([action2, meta]);
+              push2();
             }
             current = current[val];
           }
@@ -490,21 +510,33 @@ var Novely = (() => {
           current = current[2][val];
         }
       }
-      const indexedQueue = queue.map((value, index2) => value.concat(index2));
+      queue.forEach((value, index2) => {
+        value.push(index2);
+      });
+      const indexedQueue = queue;
+      renderer.ui.showScreen("game");
+      match("clear", [keep, characters2]);
+      const next2 = (i) => indexedQueue.slice(i + 1);
       for await (const [action2, meta, i] of indexedQueue) {
         if (action2 === "function" || action2 === "custom") {
           if (action2 === "custom" && meta[0].callOnlyLatest) {
-            const next2 = indexedQueue.slice(i + 1);
-            const notLatest = next2.some(([_action, _meta]) => _meta && meta && str(_meta[0]) === str(meta[0]));
+            const notLatest = next2(i).some(([_action, _meta]) => {
+              if (!_meta || !meta)
+                return false;
+              const c0 = _meta[0];
+              const c1 = meta[0];
+              const isIdenticalID = c0.id && c1.id && c0.id === c1.id;
+              return isIdenticalID || str(c0) === str(c1);
+            });
             if (notLatest)
               continue;
           }
           const result = match(action2, meta);
-          if (result && "then" in result)
+          if (isPromise(result)) {
             await result;
+          }
         } else if (action2 === "showCharacter") {
-          const next2 = indexedQueue.slice(i + 1);
-          const skip = next2.some(([_action, _meta]) => {
+          const skip = next2(i).some(([_action, _meta]) => {
             if (!_meta || !meta)
               return false;
             const hidden = _action === "hideCharacter" && _meta[0] === meta[0];
@@ -514,9 +546,8 @@ var Novely = (() => {
           if (skip)
             continue;
           match(action2, meta);
-        } else if (action2 === "showBackground") {
-          const next2 = indexedQueue.slice(i + 1);
-          const notLatest = next2.some(([_action]) => action2 === _action);
+        } else if (action2 === "showBackground" || action2 === "animateCharacter") {
+          const notLatest = next2(i).some(([_action]) => action2 === _action);
           if (notLatest)
             continue;
           match(action2, meta);
@@ -599,9 +630,9 @@ var Novely = (() => {
       },
       dialog([character, content, emotion]) {
         const name = (() => {
-          const c2 = character, cs = characters;
+          const c = character, cs = characters;
           const lang = $.get().meta[0];
-          return c2 ? c2 in cs ? typeof cs[c2].name === "string" ? cs[c2].name : cs[c2].name[lang] : c2 : "";
+          return c ? c in cs ? typeof cs[c].name === "string" ? cs[c].name : cs[c].name[lang] : c : "";
         })();
         renderer.dialog(unwrap(content), unwrap(name), character, emotion)(forward);
       },
@@ -620,18 +651,27 @@ var Novely = (() => {
         const unwrapped = choices.map(([content, action2, visible]) => {
           return [unwrap(content), action2, visible];
         });
-        renderer.choices(unwrap(question), unwrapped)((selected) => {
+        renderer.choices(
+          unwrap(question),
+          unwrapped
+        )((selected) => {
           enmemory();
-          stack.value[0].push(["choice", isWithoutQuestion ? selected : selected + 1], [null, 0]), render(), interactivity(true);
+          const offset = isWithoutQuestion ? 0 : 1;
+          stack.value[0].push(["choice", selected + offset], [null, 0]);
+          render();
+          interactivity(true);
         });
       },
       jump([scene]) {
-        stack.value[0] = [[null, scene], [null, -1]];
+        stack.value[0] = [
+          [null, scene],
+          [null, -1]
+        ];
         match("clear", []);
       },
-      clear() {
+      clear([keep, characters2]) {
         vibrate(0);
-        renderer.clear(goingBack)(push);
+        renderer.clear(goingBack, keep || EMPTY_SET, characters2 || EMPTY_SET)(push);
       },
       condition([condition]) {
         const value = condition();
@@ -682,9 +722,7 @@ var Novely = (() => {
             clearTimeout(timeoutId);
           });
         };
-        handler.callOnlyLatest = true;
-        return renderer.custom(handler, goingBack, () => {
-        }), push();
+        match("custom", [handler]);
       },
       text(text) {
         renderer.text(text.map((content) => unwrap(content)).join(" "), forward);
@@ -738,10 +776,14 @@ var Novely = (() => {
       interacted = value;
     };
     const unwrap = (content, global = false) => {
-      const { data: data2, meta: [lang] } = $.get();
+      const {
+        data: data2,
+        meta: [lang]
+      } = $.get();
       const obj = global ? data2 : state();
-      const str2 = isFunction(content) ? content(lang, obj) : typeof content === "object" ? content[lang] : content;
-      return c(str2, obj);
+      const cnt = isFunction(content) ? content(lang, obj) : typeof content === "string" ? content : content[lang];
+      const str2 = isFunction(cnt) ? cnt() : cnt;
+      return T(str2, obj);
     };
     function data(value) {
       if (!value)