@jaredwray/fumanchu 4.5.1 → 4.6.1

package/dist/index.d.cts

@@ -1,65 +1,68 @@
-import HandlebarsLib from 'handlebars';
+import { CacheableMemory, CacheableMemoryOptions } from "@cacheable/memory";
+import HandlebarsLib from "handlebars";
 
+//#region src/helper-registry.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);
+  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);
 };
 type HelperFilter = {
-    names?: string[];
-    categories?: string[];
-    compatibility?: string[];
+  names?: string[];
+  categories?: string[];
+  compatibility?: string[];
 };
 declare class HelperRegistry {
-    private readonly _helpers;
-    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().
-     */
-    init(): void;
-    /**
-     * Register a helper.
-     * @param {Helper} helper The helper to register.
-     * @returns True if the helper was registered, false otherwise.
-     */
-    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: any): void;
+  private readonly _helpers;
+  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().
+   */
+  init(): void;
+  /**
+   * Register a helper.
+   * @param {Helper} helper The helper to register.
+   * @returns True if the helper was registered, false otherwise.
+   */
+  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: any): void;
 }
-
+//#endregion
+//#region src/index.d.ts
 /**
  * Handlebars library not initiated with helpers
  * @type {Handlebars}
@@ -74,8 +77,8 @@ declare const handlebars: typeof HandlebarsLib;
  * Fumanchu Handlebars helpers
  */
 type HelpersOptions = {
-    handlebars?: typeof HandlebarsLib;
-    hbs?: typeof HandlebarsLib;
+  handlebars?: typeof HandlebarsLib;
+  hbs?: typeof HandlebarsLib;
 };
 /**
  * Register Handlebars helpers
@@ -88,25 +91,10 @@ declare function helpers(options: HelpersOptions): void;
  * @deprecated Will be deprecated in future versions, use `fumanchu()` instead.
  */
 declare function createHandlebars(): Promise<typeof HandlebarsLib>;
-/**
- * @typedef {Object} FumanchuCachingOptions
- * @property {number|string} [ttl] - Time to Live - If you set a number it is miliseconds, if you set a string it is a human-readable
- * format such as `1s` for 1 second or `1h` for 1 hour. Setting undefined means that it will use the default time-to-live. If both are
- * undefined then it will not have a time-to-live.
- * @property {boolean} [useClone] - If true, it will clone the value before returning it. If false, it will return the value directly. Default is true.
- * @property {number} [lruSize] - The size of the LRU cache. If set to 0, it will not use LRU cache. Default is 0.
- * @property {number} [checkInterval] - The interval to check for expired items. If set to 0, it will not check for expired items. Default is 0.
- */
-type FumanchuCachingOptions = {
-    ttl?: number | string;
-    useClone?: boolean;
-    lruSize?: number;
-    checkInterval?: number;
-};
 type FumanchuOptions = {
-    handlebars?: typeof HandlebarsLib;
-    filter?: HelperFilter;
-    caching?: boolean | FumanchuCachingOptions;
+  handlebars?: typeof HandlebarsLib;
+  filter?: HelperFilter;
+  caching?: boolean | CacheableMemory | CacheableMemoryOptions;
 };
 /**
  * Will return a Handlebars instance with Fumanchu helpers (experimental)
@@ -114,5 +102,5 @@ type FumanchuOptions = {
  * @returns {Handlebars} Handlebars instance with helpers
  */
 declare function fumanchu(options?: FumanchuOptions): typeof HandlebarsLib;
-
-export { type FumanchuCachingOptions, type FumanchuOptions, Handlebars, type HelperFilter, HelperRegistry, type HelpersOptions, createHandlebars, fumanchu, handlebars, helpers };
+//#endregion
+export { CacheableMemory, type CacheableMemoryOptions, FumanchuOptions, Handlebars, type HelperFilter, HelperRegistry, HelpersOptions, createHandlebars, fumanchu, handlebars, helpers };

package/dist/index.d.mts

@@ -0,0 +1,106 @@
+import { CacheableMemory, CacheableMemoryOptions } from "@cacheable/memory";
+import HandlebarsLib from "handlebars";
+
+//#region src/helper-registry.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);
+};
+type HelperFilter = {
+  names?: string[];
+  categories?: string[];
+  compatibility?: string[];
+};
+declare class HelperRegistry {
+  private readonly _helpers;
+  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().
+   */
+  init(): void;
+  /**
+   * Register a helper.
+   * @param {Helper} helper The helper to register.
+   * @returns True if the helper was registered, false otherwise.
+   */
+  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: any): void;
+}
+//#endregion
+//#region src/index.d.ts
+/**
+ * Handlebars library not initiated with helpers
+ * @type {Handlebars}
+ */
+declare const Handlebars: typeof HandlebarsLib;
+/**
+ * Fumanchu Handlebars instance not initiated with helpers
+ * @type {Handlebars}
+ */
+declare const handlebars: typeof HandlebarsLib;
+/**
+ * Fumanchu Handlebars helpers
+ */
+type HelpersOptions = {
+  handlebars?: typeof HandlebarsLib;
+  hbs?: typeof HandlebarsLib;
+};
+/**
+ * Register Handlebars helpers
+ * @param {HelpersOptions} options - Options for Fumanchu helpers
+ */
+declare function helpers(options: HelpersOptions): void;
+/**
+ * Create a new Handlebars instance with Fumanchu helpers
+ * @returns {Promise<Handlebars>}
+ * @deprecated Will be deprecated in future versions, use `fumanchu()` instead.
+ */
+declare function createHandlebars(): Promise<typeof HandlebarsLib>;
+type FumanchuOptions = {
+  handlebars?: typeof HandlebarsLib;
+  filter?: HelperFilter;
+  caching?: boolean | CacheableMemory | CacheableMemoryOptions;
+};
+/**
+ * Will return a Handlebars instance with Fumanchu helpers (experimental)
+ * @param {FumanchuOptions} [options] - Options for Fumanchu
+ * @returns {Handlebars} Handlebars instance with helpers
+ */
+declare function fumanchu(options?: FumanchuOptions): typeof HandlebarsLib;
+//#endregion
+export { CacheableMemory, type CacheableMemoryOptions, FumanchuOptions, Handlebars, type HelperFilter, HelperRegistry, HelpersOptions, createHandlebars, fumanchu, handlebars, helpers };