@jaredwray/fumanchu 3.1.3 → 4.0.0

package/dist/index.d.cts

@@ -0,0 +1,119 @@
+import * as HandlebarsLib from 'handlebars';
+import HandlebarsLib__default from 'handlebars';
+
+type Helper = {
+    name: string;
+    category: string;
+    compatibility?: string[];
+    fn: ((...arguments_: any[]) => string) | ((...arguments_: any[]) => number) | ((...arguments_: any[]) => number | string) | ((...arguments_: any[]) => HandlebarsLib__default.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;
+}
+
+/**
+ * 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>;
+/**
+ * @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;
+};
+/**
+ * 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;
+
+export { type FumanchuCachingOptions, type FumanchuOptions, Handlebars, type HelperFilter, HelperRegistry, type HelpersOptions, createHandlebars, fumanchu, handlebars, helpers };

package/dist/index.d.ts

@@ -1,31 +1,64 @@
 import * as HandlebarsLib from 'handlebars';
 import HandlebarsLib__default from 'handlebars';
 
-declare enum HelperRegistryCompatibility {
-    NODEJS = "nodejs",
-    BROWSER = "browser"
-}
-type HelperFilter = {
-    name?: string;
-    category?: string;
-    compatibility?: HelperRegistryCompatibility;
-};
 type Helper = {
     name: string;
     category: string;
-    compatibility?: HelperRegistryCompatibility;
-    fn: ((...arguments_: any[]) => string) | ((...arguments_: any[]) => HandlebarsLib__default.SafeString);
+    compatibility?: string[];
+    fn: ((...arguments_: any[]) => string) | ((...arguments_: any[]) => number) | ((...arguments_: any[]) => number | string) | ((...arguments_: any[]) => HandlebarsLib__default.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[];
-    loadHandlebars(handlebars: any): void;
-    swapHelpers(handlebars: any): void;
+    /**
+     * 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;
 }
 
 /**
@@ -41,13 +74,19 @@ declare const handlebars: typeof HandlebarsLib;
 /**
  * Fumanchu Handlebars helpers
  */
-declare const helpers: {
-    (groups: any, options: any): any;
-    utils: any;
+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>;
 /**
@@ -67,10 +106,7 @@ type FumanchuCachingOptions = {
 };
 type FumanchuOptions = {
     handlebars?: typeof HandlebarsLib;
-    helpers?: Record<string, Function>;
-    name?: string | string[];
-    include?: HelperFilter[];
-    exclude?: HelperFilter[];
+    filter?: HelperFilter;
     caching?: boolean | FumanchuCachingOptions;
 };
 /**
@@ -80,4 +116,4 @@ type FumanchuOptions = {
  */
 declare function fumanchu(options?: FumanchuOptions): typeof HandlebarsLib;
 
-export { type FumanchuCachingOptions, type FumanchuOptions, Handlebars, type HelperFilter, HelperRegistry, createHandlebars, fumanchu, handlebars, helpers };
+export { type FumanchuCachingOptions, type FumanchuOptions, Handlebars, type HelperFilter, HelperRegistry, type HelpersOptions, createHandlebars, fumanchu, handlebars, helpers };