@novely/core 0.36.0 → 0.37.0

package/dist/index.d.ts

@@ -198,8 +198,15 @@ type Renderer = {
     getContext: (context: string) => Context;
     removeContext: (context: string) => void;
 };
+type RendererInitPreviewReturn = {
+    /**
+     * Assets that was used in game preview
+     */
+    assets: string[];
+};
 type RendererInit<$Language extends Lang, $Characters extends Record<string, Character<$Language>>> = {
     characters: $Characters;
+    characterAssetSizes: CharacterAssetSizes<$Characters>;
     set: (save: Save<State>) => Promise<void>;
     restore: (save?: Save<State>) => Promise<void>;
     save: (type: Save<State>[2][1]) => void;
@@ -223,7 +230,7 @@ type RendererInit<$Language extends Lang, $Characters extends Record<string, Cha
      * There is different context, and the main one which is used for game
      */
     mainContextKey: string;
-    preview: (save: Save<State>, name: string) => Promise<void>;
+    preview: (save: Save<State>, name: string) => Promise<RendererInitPreviewReturn>;
     removeContext: (name: string) => void;
     getStateFunction: (context: string) => StateFunction<State>;
     clearCustomAction: (ctx: Context, customAction: CustomHandler) => void;
@@ -233,7 +240,6 @@ type RendererInit<$Language extends Lang, $Characters extends Record<string, Cha
 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>;
@@ -302,6 +308,12 @@ type TranslationDescription = {
 type DefaultEmotions<$Characters extends Record<string, Character<Lang>>> = {
     [Character in keyof $Characters]?: (keyof $Characters[Character]['emotions'] & string);
 };
+type CharacterAssetSizes<$Characters extends Record<string, Character<Lang>>> = {
+    [Character in keyof $Characters]?: {
+        width: number;
+        height: number;
+    };
+};
 interface NovelyInit<$Language extends Lang, $Characters extends Record<string, Character<NoInfer<$Language>>>, $State extends State, $Data extends Data, $Actions extends Record<string, (...args: any[]) => ValidAction>> {
     /**
      * An object containing the characters in the game.
@@ -350,6 +362,32 @@ interface NovelyInit<$Language extends Lang, $Characters extends Record<string,
      * ```
      */
     defaultEmotions?: DefaultEmotions<NoInfer<$Characters>>;
+    /**
+     * Character asset sizes. We need width-height pair to render character, but we get it only after the assets are loaded. However, using that option we can use width-height before load.
+     * @example
+     * ```
+     * import peter_the_great from './assets/peter_the_great.png?width=800&height=1200';
+     *
+     * const engine = novely({
+     *   characters: {
+     *     Peter: {
+     *       name: 'Peter',
+     *       color: '#c04931',
+     *       emotions: {
+     *         normal: peter_the_great
+     *       }
+     *     }
+     *   },
+     *   characterAssetSizes: {
+     *     Peter: {
+     *       width: 800,
+     *       height: 1200
+     *     }
+     *   }
+     * })
+     * ```
+     */
+    characterAssetSizes?: CharacterAssetSizes<NoInfer<$Characters>>;
     /**
      * An object that provides access to the game's storage system.
      * @default localStorage // at key `novely-game-storage`
@@ -735,7 +773,7 @@ type ChoiceParams<T> = T extends TypeEssentials<infer $Lang, infer $State, any,
 type FunctionParams<T> = T extends TypeEssentials<infer $Lang, infer $State, any, any> ? FunctionActionProps<$Lang, $State> : never;
 type InputHandler<T> = T extends TypeEssentials<infer $Lang, infer $State, any, any> ? ActionInputOnInputMeta<$Lang, $State> : never;
 
-declare const novely: <$Language extends string, $Characters extends Record<string, Character<$Language>>, $State extends State, $Data extends Data, $Actions extends Record<string, (...args: any[]) => ValidAction>>({ characters, defaultEmotions, storage, storageDelay, renderer: createRenderer, initialScreen, translation, state: defaultState, data: defaultData, autosaves, migrations, throttleTimeout, getLanguage, overrideLanguage, askBeforeExit, preloadAssets, parallelAssetsDownloadLimit, fetch: request, saveOnUnload, startKey }: NovelyInit<$Language, $Characters, $State, $Data, $Actions>) => {
+declare const novely: <$Language extends string, $Characters extends Record<string, Character<$Language>>, $State extends State, $Data extends Data, $Actions extends Record<string, (...args: any[]) => ValidAction>>({ characters, characterAssetSizes, defaultEmotions, storage, storageDelay, renderer: createRenderer, initialScreen, translation, state: defaultState, data: defaultData, autosaves, migrations, throttleTimeout, getLanguage, overrideLanguage, askBeforeExit, preloadAssets, parallelAssetsDownloadLimit, fetch: request, saveOnUnload, startKey }: NovelyInit<$Language, $Characters, $State, $Data, $Actions>) => {
     /**
      * Function to set game script
      *
@@ -857,4 +895,4 @@ declare const novely: <$Language extends string, $Characters extends Record<stri
  */
 declare const extendAction: <Part0 extends Record<string, (...args: any[]) => ValidAction>, Part1 extends Record<string, (...args: any[]) => ValidAction>>(base: Part0, extension: Part1) => Readonly<Assign<Part0, Part1>>;
 
-export { type ActionInputOnInputMeta, type ActionInputSetup, type ActionInputSetupCleanup, type ActionProxy, type AllowedContent, type AudioHandle, type BackgroundImage, type BaseTranslationStrings, type Character, type CharacterHandle, type ChoiceParams, type ConditionParams, type Context, type CoreData, type CustomActionHandle, type CustomHandler, type CustomHandlerFunctionGetFn, type CustomHandlerFunctionParameters, type CustomHandlerGetResult, type CustomHandlerGetResultDataFunction, type Data, type DeepPartial, type DefaultActionProxy, EN, type Emotions, type FunctionParams, type FunctionableValue, type GetActionParameters, type InputHandler, 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 TypeEssentials, type TypewriterSpeed, type ValidAction, extendAction, localStorageStorage, novely };
+export { type ActionInputOnInputMeta, type ActionInputSetup, type ActionInputSetupCleanup, type ActionProxy, type AllowedContent, type AudioHandle, type BackgroundImage, type BaseTranslationStrings, type Character, type CharacterHandle, type ChoiceParams, type ConditionParams, type Context, type CoreData, type CustomActionHandle, type CustomHandler, type CustomHandlerFunctionGetFn, type CustomHandlerFunctionParameters, type CustomHandlerGetResult, type CustomHandlerGetResultDataFunction, type Data, type DeepPartial, type DefaultActionProxy, EN, type Emotions, type FunctionParams, type FunctionableValue, type GetActionParameters, type InputHandler, JP, KK, type Lang, type NovelyInit, type NovelyScreen, type Path, type PluralType, type Pluralization, RU, type Renderer, type RendererInit, type RendererInitPreviewReturn, 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 TypeEssentials, type TypewriterSpeed, type ValidAction, extendAction, localStorageStorage, novely };

package/dist/index.global.js

@@ -212,6 +212,7 @@ var Novely = (() => {
   var STACK_MAP = /* @__PURE__ */ new Map();
   var CUSTOM_ACTION_MAP = /* @__PURE__ */ new Map();
   var PRELOADED_ASSETS = /* @__PURE__ */ new Set();
+  var RESOURCE_TYPE_CACHE = /* @__PURE__ */ new Map();
 
   // ../../node_modules/.pnpm/esm-env@1.0.0/node_modules/esm-env/prod-ssr.js
   var DEV = false;
@@ -663,24 +664,31 @@ var Novely = (() => {
     }
   };
   var getResourseType = async (request, url) => {
+    if (RESOURCE_TYPE_CACHE.has(url)) {
+      return RESOURCE_TYPE_CACHE.get(url);
+    }
+    const encache = (value) => {
+      RESOURCE_TYPE_CACHE.set(url, value);
+      return value;
+    };
     if (!isCSSImage(url)) {
-      return "other";
+      return encache("other");
     }
     const extension = getUrlFileExtension(url);
     if (HOWLER_SUPPORTED_FILE_FORMATS.has(extension)) {
-      return "audio";
+      return encache("audio");
     }
     if (SUPPORTED_IMAGE_FILE_FORMATS.has(extension)) {
-      return "image";
+      return encache("image");
     }
     const contentType = await fetchContentType(request, url);
     if (contentType.includes("audio")) {
-      return "audio";
+      return encache("audio");
     }
     if (contentType.includes("image")) {
-      return "image";
+      return encache("image");
     }
-    return "other";
+    return encache("other");
   };
   var capitalize = (str2) => {
     return str2[0].toUpperCase() + str2.slice(1);
@@ -1128,6 +1136,7 @@ var Novely = (() => {
   var import_p_limit = __toESM(require_p_limit(), 1);
   var novely = ({
     characters,
+    characterAssetSizes = {},
     defaultEmotions = {},
     storage = localStorageStorage({ key: "novely-game-storage" }),
     storageDelay = Promise.resolve(),
@@ -1214,38 +1223,38 @@ var Novely = (() => {
     const script = (part) => {
       return limitScript(() => scriptBase(part));
     };
-    const checkAndAddToPreloadingList = (action2, props) => {
+    const assetPreloadingCheck = (action2, props, doAction = assetsToPreloadAdd) => {
       if (action2 === "showBackground") {
         if (isImageAsset(props[0])) {
-          assetsToPreloadAdd(props[0]);
+          doAction(props[0]);
         }
         if (props[0] && typeof props[0] === "object") {
           for (const value of Object.values(props[0])) {
             if (!isImageAsset(value))
               continue;
-            assetsToPreloadAdd(value);
+            doAction(value);
           }
         }
         return;
       }
       if (isAudioAction(action2) && isString(props[0])) {
-        assetsToPreloadAdd(props[0]);
+        doAction(props[0]);
         return;
       }
       if (action2 === "showCharacter" && isString(props[0]) && isString(props[1])) {
         const images = characters[props[0]].emotions[props[1]];
         if (Array.isArray(images)) {
           for (const asset of images) {
-            assetsToPreloadAdd(asset);
+            doAction(asset);
           }
         } else {
-          assetsToPreloadAdd(images);
+          doAction(images);
         }
         return;
       }
       if (action2 === "custom" && props[0].assets && props[0].assets.length > 0) {
         for (const asset of props[0].assets) {
-          assetsToPreloadAdd(asset);
+          doAction(asset);
         }
       }
     };
@@ -1256,7 +1265,7 @@ var Novely = (() => {
         }
         return (...props) => {
           if (preloadAssets === "blocking") {
-            checkAndAddToPreloadingList(action2, props);
+            assetPreloadingCheck(action2, props);
           }
           return [action2, ...props];
         };
@@ -1507,8 +1516,11 @@ var Novely = (() => {
       return translation[lang].internal[key];
     };
     const preview = async (save2, name) => {
-      if (isEmpty(story))
-        return;
+      if (isEmpty(story)) {
+        return Promise.resolve({
+          assets: []
+        });
+      }
       const [path, data2] = save2;
       const { queue } = getActionsFromPath(story, path, true);
       const ctx = renderer.getContext(name);
@@ -1518,6 +1530,7 @@ var Novely = (() => {
         skip: EMPTY_SET
       });
       useStack(ctx).push(klona(save2));
+      const assets = [];
       await processor.run(([action2, ...props]) => {
         if (isAudioAction(action2))
           return;
@@ -1525,11 +1538,15 @@ var Novely = (() => {
           return;
         if (action2 === "end")
           return;
+        assetPreloadingCheck(action2, props, assets.push.bind(assets));
         return match(action2, props, {
           ctx,
           data: data2
         });
       });
+      return {
+        assets
+      };
     };
     const removeContext = (name) => {
       STACK_MAP.delete(name);
@@ -1564,6 +1581,7 @@ var Novely = (() => {
     const renderer = createRenderer({
       mainContextKey: MAIN_CONTEXT_KEY,
       characters,
+      characterAssetSizes,
       set,
       restore,
       save,
@@ -1625,7 +1643,7 @@ var Novely = (() => {
             refer
           });
           for (const [action3, ...props2] of collection) {
-            checkAndAddToPreloadingList(action3, props2);
+            assetPreloadingCheck(action3, props2);
           }
           const { preloadAudioBlocking, preloadImageBlocking } = renderer.misc;
           ASSETS_TO_PRELOAD.forEach(async (asset) => {