@hotmeshio/hotmesh 0.14.1 → 0.14.3

package/build/services/pipe/functions/json.d.ts

@@ -1,5 +1,47 @@
+/**
+ * Provides JSON serialization and deserialization functions for use
+ * in HotMesh mapping rules. Although inspired by JavaScript, they
+ * have been adapted to follow a functional approach. Each transformation
+ * is a function that expects one or more input parameters from the
+ * prior row in the `@pipe` structure.
+ *
+ * @remarks
+ * Invoked in mapping rules using `{@json.<method>}` syntax.
+ */
 declare class JsonHandler {
+    /**
+     * Converts a JavaScript object or value to a JSON string.
+     * Wraps `JSON.stringify` with support for optional replacer
+     * and space parameters for pretty-printing.
+     *
+     * @param {any} value - The value to convert to a JSON string
+     * @param {Function | Array | null} [replacer] - A function that alters the behavior of the stringification process, or an array of strings and numbers to filter properties
+     * @param {string | number} [space] - A string or number used to insert whitespace for readability
+     * @returns {string} The JSON string representation of the value
+     * @example
+     * ```yaml
+     * json_string:
+     *   "@pipe":
+     *     - ["{a}", null, 2]
+     *     - ["{@json.stringify}"]
+     * ```
+     */
     stringify(value: any, replacer?: (this: any, key: string, value: any) => any | (number | string)[] | null, space?: string | number): string;
+    /**
+     * Parses a JSON string and returns the resulting JavaScript object.
+     * Wraps `JSON.parse` with support for an optional reviver function.
+     *
+     * @param {string} text - The JSON string to parse
+     * @param {Function} [reviver] - A function that transforms the results, called for each key-value pair
+     * @returns {any} The JavaScript value parsed from the JSON string
+     * @example
+     * ```yaml
+     * js_object:
+     *   "@pipe":
+     *     - ["{a}"]
+     *     - ["{@json.parse}"]
+     * ```
+     */
     parse(text: string, reviver?: (this: any, key: string, value: any) => any): any;
 }
 export { JsonHandler };

package/build/services/pipe/functions/json.js

@@ -1,10 +1,52 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JsonHandler = void 0;
+/**
+ * Provides JSON serialization and deserialization functions for use
+ * in HotMesh mapping rules. Although inspired by JavaScript, they
+ * have been adapted to follow a functional approach. Each transformation
+ * is a function that expects one or more input parameters from the
+ * prior row in the `@pipe` structure.
+ *
+ * @remarks
+ * Invoked in mapping rules using `{@json.<method>}` syntax.
+ */
 class JsonHandler {
+    /**
+     * Converts a JavaScript object or value to a JSON string.
+     * Wraps `JSON.stringify` with support for optional replacer
+     * and space parameters for pretty-printing.
+     *
+     * @param {any} value - The value to convert to a JSON string
+     * @param {Function | Array | null} [replacer] - A function that alters the behavior of the stringification process, or an array of strings and numbers to filter properties
+     * @param {string | number} [space] - A string or number used to insert whitespace for readability
+     * @returns {string} The JSON string representation of the value
+     * @example
+     * ```yaml
+     * json_string:
+     *   "@pipe":
+     *     - ["{a}", null, 2]
+     *     - ["{@json.stringify}"]
+     * ```
+     */
     stringify(value, replacer, space) {
         return JSON.stringify(value, replacer, space);
     }
+    /**
+     * Parses a JSON string and returns the resulting JavaScript object.
+     * Wraps `JSON.parse` with support for an optional reviver function.
+     *
+     * @param {string} text - The JSON string to parse
+     * @param {Function} [reviver] - A function that transforms the results, called for each key-value pair
+     * @returns {any} The JavaScript value parsed from the JSON string
+     * @example
+     * ```yaml
+     * js_object:
+     *   "@pipe":
+     *     - ["{a}"]
+     *     - ["{@json.parse}"]
+     * ```
+     */
     parse(text, reviver) {
         return JSON.parse(text, reviver);
     }

package/build/services/pipe/functions/logical.d.ts

@@ -1,5 +1,43 @@
+/**
+ * Provides logical operator functions for combining multiple boolean
+ * expressions and returning a single boolean value. These operators
+ * are available for use in HotMesh mapping rules.
+ *
+ * @remarks
+ * Invoked in mapping rules using `{@logical.<method>}` syntax.
+ */
 declare class LogicalHandler {
+    /**
+     * Returns `true` if both boolean expressions evaluate to `true`.
+     * Performs a logical AND operation.
+     *
+     * @param {boolean} firstValue - The first boolean expression
+     * @param {boolean} secondValue - The second boolean expression
+     * @returns {boolean} `true` if both values are truthy, `false` otherwise
+     * @example
+     * ```yaml
+     * is_active_and_paid:
+     *   "@pipe":
+     *     - ["{a.user.isActive}", "{a.user.hasPaid}"]
+     *     - ["{@logical.and}"]
+     * ```
+     */
     and(firstValue: boolean, secondValue: boolean): boolean;
+    /**
+     * Returns `true` if at least one of the boolean expressions
+     * evaluates to `true`. Performs a logical OR operation.
+     *
+     * @param {boolean} firstValue - The first boolean expression
+     * @param {boolean} secondValue - The second boolean expression
+     * @returns {boolean} `true` if either value is truthy, `false` otherwise
+     * @example
+     * ```yaml
+     * has_trial_or_subscription:
+     *   "@pipe":
+     *     - ["{b.user.hasTrial}", "{b.user.hasSubscription}"]
+     *     - ["{@logical.or}"]
+     * ```
+     */
     or(firstValue: boolean, secondValue: boolean): boolean;
 }
 export { LogicalHandler };

package/build/services/pipe/functions/logical.js

@@ -1,10 +1,48 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LogicalHandler = void 0;
+/**
+ * Provides logical operator functions for combining multiple boolean
+ * expressions and returning a single boolean value. These operators
+ * are available for use in HotMesh mapping rules.
+ *
+ * @remarks
+ * Invoked in mapping rules using `{@logical.<method>}` syntax.
+ */
 class LogicalHandler {
+    /**
+     * Returns `true` if both boolean expressions evaluate to `true`.
+     * Performs a logical AND operation.
+     *
+     * @param {boolean} firstValue - The first boolean expression
+     * @param {boolean} secondValue - The second boolean expression
+     * @returns {boolean} `true` if both values are truthy, `false` otherwise
+     * @example
+     * ```yaml
+     * is_active_and_paid:
+     *   "@pipe":
+     *     - ["{a.user.isActive}", "{a.user.hasPaid}"]
+     *     - ["{@logical.and}"]
+     * ```
+     */
     and(firstValue, secondValue) {
         return firstValue && secondValue;
     }
+    /**
+     * Returns `true` if at least one of the boolean expressions
+     * evaluates to `true`. Performs a logical OR operation.
+     *
+     * @param {boolean} firstValue - The first boolean expression
+     * @param {boolean} secondValue - The second boolean expression
+     * @returns {boolean} `true` if either value is truthy, `false` otherwise
+     * @example
+     * ```yaml
+     * has_trial_or_subscription:
+     *   "@pipe":
+     *     - ["{b.user.hasTrial}", "{b.user.hasSubscription}"]
+     *     - ["{@logical.or}"]
+     * ```
+     */
     or(firstValue, secondValue) {
         return firstValue || secondValue;
     }