@novely/core 0.30.3 → 0.31.0

package/dist/index.d.ts

@@ -176,18 +176,19 @@ type Renderer = {
             unmount(): void;
         };
     };
+    actions: Record<string, (...args: any[]) => ValidAction>;
     getContext: (context: string) => Context;
     removeContext: (context: string) => void;
 };
-type RendererInit = {
-    characters: Record<string, Character<Lang>>;
+type RendererInit<$Language extends Lang, $Characters extends Record<string, Character<$Language>>> = {
+    characters: $Characters;
     set: (save: Save<State>) => Promise<void>;
     restore: (save?: Save<State>) => Promise<void>;
     save: (type: Save<State>[2][1]) => void;
     newGame: () => void;
     exit: (force?: boolean) => void;
     back: () => Promise<void>;
-    languages: Lang[];
+    languages: $Language[];
     /**
      * Translation function
      */
@@ -275,7 +276,7 @@ type TranslationDescription = {
     plural?: Record<string, Pluralization>;
     actions?: TranslationActions;
 };
-interface NovelyInit<$Language extends Lang, Characters extends Record<string, Character<NoInfer<$Language>>>, StateScheme extends State, DataScheme extends Data> {
+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.
      * @example
@@ -294,7 +295,7 @@ interface NovelyInit<$Language extends Lang, Characters extends Record<string, C
      * })
      * ```
      */
-    characters: Characters;
+    characters: $Characters;
     /**
      * Define default emotions for characters
      * @example
@@ -323,7 +324,7 @@ interface NovelyInit<$Language extends Lang, Characters extends Record<string, C
      * ```
      */
     defaultEmotions?: {
-        [Character in keyof NoInfer<Characters>]?: (keyof NoInfer<Characters>[Character]['emotions'] & string);
+        [Character in keyof NoInfer<$Characters>]?: (keyof NoInfer<$Characters>[Character]['emotions'] & string);
     };
     /**
      * An object that provides access to the game's storage system.
@@ -337,7 +338,9 @@ interface NovelyInit<$Language extends Lang, Characters extends Record<string, C
     /**
      * A function that returns a Renderer object used to display the game's content
      */
-    renderer: (initializationData: RendererInit) => Renderer;
+    renderer: (initializationData: RendererInit<NoInfer<$Language>, NoInfer<$Characters>>) => Renderer & {
+        actions: $Actions;
+    };
     /**
      * An optional property that specifies the initial screen to display when the game starts
      */
@@ -370,13 +373,13 @@ interface NovelyInit<$Language extends Lang, Characters extends Record<string, C
      *
      * State is a local value bound to one save
      */
-    state?: StateScheme;
+    state?: $State;
     /**
      * Initial data value
      *
      * Data is a global value shared between saves
      */
-    data?: DataScheme;
+    data?: $Data;
     /**
      * Enable autosaves or disable
      * @default true
@@ -461,6 +464,12 @@ type StateFunction<S extends State> = {
     (value: DeepPartial<S> | ((prev: S) => S)): void;
     (): S;
 };
+type TypeEssentials<$Lang extends Lang, $State extends State, $Data extends Data, $Characters extends Record<string, Character<$Lang>>> = {
+    readonly l: $Lang | null;
+    readonly s: $State | null;
+    readonly d: $Data | null;
+    readonly c: $Characters | null;
+};
 
 type Name<$Lang extends Lang> = string | Record<$Lang, string>;
 type Emotions<Emotion extends string = string> = Record<Emotion, string | string[]>;
@@ -479,7 +488,10 @@ type TextContent<L extends string, S extends State> = string | ((state: S) => st
 type FunctionableValue<T> = T | (() => T);
 type CustomHandlerGetResultDataFunction = (data?: Record<string, unknown>) => Record<string, unknown>;
 type CustomHandlerGetResult<I extends boolean> = {
-    delete: () => void;
+    /**
+     * Remove's custom handler instance
+     */
+    remove: () => void;
     /**
      * Данные
      */
@@ -496,6 +508,9 @@ type CustomHandlerGetResult<I extends boolean> = {
      * Устанавливает обработчик очистки
      */
     clear: (fn: () => void) => void;
+    __internals: {
+        ctx: Context;
+    };
 };
 type CustomHandlerFunctionGetFn = <I extends boolean = true>(insert?: I) => CustomHandlerGetResult<I>;
 type CustomHandlerFunctionParameters<L extends string, S extends State> = {
@@ -621,9 +636,9 @@ type ActionProxy<Characters extends Record<string, Character>, Languages extends
 type DefaultActionProxy = ActionProxy<Record<string, Character>, Lang, State>;
 type GetActionParameters<T extends Capitalize<keyof DefaultActionProxy>> = Parameters<DefaultActionProxy[Uncapitalize<T>]>;
 
-type ConditionParams<T> = T extends ActionProxy<Record<string, Character>, Lang, infer $State> ? Parameters<ConditionCheckFunction<$State, string | boolean>>[0] : never;
+type ConditionParams<T> = T extends TypeEssentials<any, infer $State, any, any> ? $State : never;
 
-declare const novely: <$Language extends string, Characters extends Record<string, Character<$Language>>, StateScheme extends State, DataScheme extends Data>({ 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, StateScheme, DataScheme>) => {
+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>) => {
     /**
      * Function to set game script
      *
@@ -649,7 +664,7 @@ declare const novely: <$Language extends string, Characters extends Record<strin
      * })
      * ```
      */
-    action: ActionProxy<Characters, $Language, StateScheme>;
+    action: $Actions & ActionProxy<$Characters, $Language, $State>;
     /**
      * @deprecated Will be removed BUT replaced with state passed into actions as a parameter
      */
@@ -670,11 +685,24 @@ declare const novely: <$Language extends string, Characters extends Record<strin
      * })
      * ```
      */
-    data: StateFunction<DataScheme>;
+    data: StateFunction<$Data>;
+    /**
+     * Used in combination with type utilities
+     *
+     * @example
+     * ```ts
+     * import type { ConditionParams, StateFunction } from '@novely/core';
+ *
+     * const conditionCheck = (state: StateFunction<ConditionParams<typeof engine.typeEssintials>>) => {
+     *   return state.age >= 18;
+     * }
+     * ```
+     */
+    typeEssentials: TypeEssentials<$Language, $State, $Data, $Characters>;
     /**
      * @deprecated Renamed into `templateReplace`
      */
-    unwrap(content: TextContent<$Language, DataScheme>): string;
+    unwrap(content: TextContent<$Language, $Data>): string;
     /**
      * Replaces content inside {{braces}} with using global data
      * @example
@@ -687,7 +715,7 @@ declare const novely: <$Language extends string, Characters extends Record<strin
      * })
      * ```
      */
-    templateReplace(content: TextContent<$Language, DataScheme>): string;
+    templateReplace(content: TextContent<$Language, $Data>): string;
     /**
      * Cancel data loading, hide UI, ignore page change events
      * Data updates still will work in case Novely already was loaded

package/dist/index.global.js

@@ -699,7 +699,7 @@ var Novely = (() => {
     return { subscribe, update, set, get };
   };
 
-  // ../../node_modules/.pnpm/@novely+deepmerge@0.0.0/node_modules/@novely/deepmerge/dist/index.js
+  // ../deepmerge/dist/index.js
   var { isArray } = Array;
   var { hasOwnProperty, propertyIsEnumerable, getOwnPropertySymbols } = Object;
   var propertyIsOnObject = (object, property) => {
@@ -710,7 +710,9 @@ var Novely = (() => {
     }
   };
   var propertyIsUnsafe = (target, key) => {
-    return propertyIsOnObject(target, key) && !(hasOwnProperty.call(target, key) && propertyIsEnumerable.call(target, key));
+    return propertyIsOnObject(target, key) && // Properties are safe to merge if they don't exist in the target yet,
+    !(hasOwnProperty.call(target, key) && // unsafe if they exist up the prototype chain,
+    propertyIsEnumerable.call(target, key));
   };
   var getEnumerableOwnPropertySymbols = (target) => {
     if (!getOwnPropertySymbols)
@@ -962,6 +964,9 @@ var Novely = (() => {
     };
     const action = new Proxy({}, {
       get(_, action2) {
+        if (action2 in renderer.actions) {
+          return renderer.actions[action2];
+        }
         return (...props) => {
           if (preloadAssets === "blocking") {
             if (action2 === "showBackground") {
@@ -1711,6 +1716,12 @@ var Novely = (() => {
       });
       return void 0;
     };
+    const typeEssentials = {
+      l: null,
+      s: null,
+      d: null,
+      c: null
+    };
     return {
       /**
        * Function to set game script
@@ -1759,6 +1770,19 @@ var Novely = (() => {
        * ```
        */
       data,
+      /**
+       * Used in combination with type utilities
+       *
+       * @example
+       * ```ts
+       * import type { ConditionParams, StateFunction } from '@novely/core';
+         *
+       * const conditionCheck = (state: StateFunction<ConditionParams<typeof engine.typeEssintials>>) => {
+       *   return state.age >= 18;
+       * }
+       * ```
+       */
+      typeEssentials,
       /**
        * @deprecated Renamed into `templateReplace`
        */