@jaredwray/fumanchu 4.6.1 → 4.7.1

package/dist/{index.d.cts → index.node.d.cts}

@@ -1,68 +1,69 @@
 import { CacheableMemory, CacheableMemoryOptions } from "@cacheable/memory";
 import HandlebarsLib from "handlebars";
 
-//#region src/helper-registry.d.ts
+//#region src/helper-registry-base.d.ts
 type Helper = {
   name: string;
   category: string;
   compatibility?: string[];
-  fn: ((...arguments_: any[]) => string) | ((...arguments_: any[]) => number) | ((...arguments_: any[]) => boolean) | ((...arguments_: any[]) => unknown) | ((...arguments_: any[]) => number | string) | ((...arguments_: any[]) => HandlebarsLib.SafeString);
+  fn: (...arguments_: any[]) => any;
 };
 type HelperFilter = {
   names?: string[];
   categories?: string[];
   compatibility?: string[];
 };
-declare class HelperRegistry {
-  private readonly _helpers;
+/**
+ * Base class for helper registries. Holds all state-management logic and
+ * leaves `init()` empty so environment-specific subclasses decide which
+ * helper sets to register. This lets the browser registry avoid importing
+ * any Node-only helper files.
+ */
+declare class HelperRegistryBase {
+  protected readonly _helpers: Helper[];
   constructor();
   /**
    * Get all registered helpers.
-   * @returns {Helper[]} The array of registered helpers.
    */
   get helpers(): Helper[];
   /**
-   * Initialize the helper registry. This is performed during the construction of the registry such as new HelperRegistry().
+   * Initialize the helper registry. Overridden by subclasses.
    */
   init(): void;
   /**
-   * Register a helper.
-   * @param {Helper} helper The helper to register.
-   * @returns True if the helper was registered, false otherwise.
+   * Register a helper. Returns true if the helper was added, false if a
+   * helper with the same name was already present.
    */
   register(helper: Helper): boolean;
   /**
    * Register multiple helpers.
-   * @param {Helper[]} helpers The array of helpers to register.
    */
   registerHelpers(helpers: Helper[]): void;
   /**
    * Check if a helper is registered.
-   * @param name The name of the helper.
-   * @returns True if the helper is registered, false otherwise.
    */
   has(name: string): boolean;
   /**
    * Filter helpers by the given criteria.
-   * @param filter The filter criteria.
-   * @returns The filtered helpers.
    */
   filter(filter: HelperFilter): Helper[];
   /**
    * Load Handlebars helpers.
-   * @param {Handlebars} handlebars The Handlebars instance.
-   * @returns {void}
    */
   load(handlebars: any, filters?: HelperFilter): void;
   /**
-   * Swap Handlebars helpers. This is used when you want to swap out legacy helpers for fumanchu helpers.
-   * @param handlebars The Handlebars instance.
-   * @returns {void}
+   * Swap Handlebars helpers. This is used when you want to swap out legacy
+   * helpers for fumanchu helpers.
    */
   swap(handlebars: any): void;
 }
 //#endregion
-//#region src/index.d.ts
+//#region src/helper-registry.d.ts
+declare class HelperRegistry extends HelperRegistryBase {
+  init(): void;
+}
+//#endregion
+//#region src/index.node.d.ts
 /**
  * Handlebars library not initiated with helpers
  * @type {Handlebars}

package/dist/{index.d.mts → index.node.d.mts}

@@ -1,84 +1,85 @@
 import { CacheableMemory, CacheableMemoryOptions } from "@cacheable/memory";
-import HandlebarsLib from "handlebars";
+import Handlebars$1 from "handlebars";
 
-//#region src/helper-registry.d.ts
+//#region src/helper-registry-base.d.ts
 type Helper = {
   name: string;
   category: string;
   compatibility?: string[];
-  fn: ((...arguments_: any[]) => string) | ((...arguments_: any[]) => number) | ((...arguments_: any[]) => boolean) | ((...arguments_: any[]) => unknown) | ((...arguments_: any[]) => number | string) | ((...arguments_: any[]) => HandlebarsLib.SafeString);
+  fn: (...arguments_: any[]) => any;
 };
 type HelperFilter = {
   names?: string[];
   categories?: string[];
   compatibility?: string[];
 };
-declare class HelperRegistry {
-  private readonly _helpers;
+/**
+ * Base class for helper registries. Holds all state-management logic and
+ * leaves `init()` empty so environment-specific subclasses decide which
+ * helper sets to register. This lets the browser registry avoid importing
+ * any Node-only helper files.
+ */
+declare class HelperRegistryBase {
+  protected readonly _helpers: Helper[];
   constructor();
   /**
    * Get all registered helpers.
-   * @returns {Helper[]} The array of registered helpers.
    */
   get helpers(): Helper[];
   /**
-   * Initialize the helper registry. This is performed during the construction of the registry such as new HelperRegistry().
+   * Initialize the helper registry. Overridden by subclasses.
    */
   init(): void;
   /**
-   * Register a helper.
-   * @param {Helper} helper The helper to register.
-   * @returns True if the helper was registered, false otherwise.
+   * Register a helper. Returns true if the helper was added, false if a
+   * helper with the same name was already present.
    */
   register(helper: Helper): boolean;
   /**
    * Register multiple helpers.
-   * @param {Helper[]} helpers The array of helpers to register.
    */
   registerHelpers(helpers: Helper[]): void;
   /**
    * Check if a helper is registered.
-   * @param name The name of the helper.
-   * @returns True if the helper is registered, false otherwise.
    */
   has(name: string): boolean;
   /**
    * Filter helpers by the given criteria.
-   * @param filter The filter criteria.
-   * @returns The filtered helpers.
    */
   filter(filter: HelperFilter): Helper[];
   /**
    * Load Handlebars helpers.
-   * @param {Handlebars} handlebars The Handlebars instance.
-   * @returns {void}
    */
   load(handlebars: any, filters?: HelperFilter): void;
   /**
-   * Swap Handlebars helpers. This is used when you want to swap out legacy helpers for fumanchu helpers.
-   * @param handlebars The Handlebars instance.
-   * @returns {void}
+   * Swap Handlebars helpers. This is used when you want to swap out legacy
+   * helpers for fumanchu helpers.
    */
   swap(handlebars: any): void;
 }
 //#endregion
-//#region src/index.d.ts
+//#region src/helper-registry.d.ts
+declare class HelperRegistry extends HelperRegistryBase {
+  init(): void;
+}
+//#endregion
+//#region src/index.node.d.ts
 /**
  * Handlebars library not initiated with helpers
  * @type {Handlebars}
  */
-declare const Handlebars: typeof HandlebarsLib;
+declare const Handlebars: typeof Handlebars$1;
 /**
  * Fumanchu Handlebars instance not initiated with helpers
  * @type {Handlebars}
  */
-declare const handlebars: typeof HandlebarsLib;
+declare const handlebars: typeof Handlebars$1;
 /**
  * Fumanchu Handlebars helpers
  */
 type HelpersOptions = {
-  handlebars?: typeof HandlebarsLib;
-  hbs?: typeof HandlebarsLib;
+  handlebars?: typeof Handlebars$1;
+  hbs?: typeof Handlebars$1;
 };
 /**
  * Register Handlebars helpers
@@ -90,9 +91,9 @@ declare function helpers(options: HelpersOptions): void;
  * @returns {Promise<Handlebars>}
  * @deprecated Will be deprecated in future versions, use `fumanchu()` instead.
  */
-declare function createHandlebars(): Promise<typeof HandlebarsLib>;
+declare function createHandlebars(): Promise<typeof Handlebars$1>;
 type FumanchuOptions = {
-  handlebars?: typeof HandlebarsLib;
+  handlebars?: typeof Handlebars$1;
   filter?: HelperFilter;
   caching?: boolean | CacheableMemory | CacheableMemoryOptions;
 };
@@ -101,6 +102,6 @@ type FumanchuOptions = {
  * @param {FumanchuOptions} [options] - Options for Fumanchu
  * @returns {Handlebars} Handlebars instance with helpers
  */
-declare function fumanchu(options?: FumanchuOptions): typeof HandlebarsLib;
+declare function fumanchu(options?: FumanchuOptions): typeof Handlebars$1;
 //#endregion
 export { CacheableMemory, type CacheableMemoryOptions, FumanchuOptions, Handlebars, type HelperFilter, HelperRegistry, HelpersOptions, createHandlebars, fumanchu, handlebars, helpers };