@higher.archi/boe 1.0.0

package/dist/engines/utility/types.d.ts

@@ -0,0 +1,176 @@
+/**
+ * Utility/MCDM Engine Types
+ *
+ * Multi-Criteria Decision Making engine for comparing alternatives
+ * across weighted criteria. Unlike Scoring (which evaluates one item),
+ * MCDM explicitly models trade-offs between multiple options.
+ */
+import { BaseRule, BaseRuleSet, CompiledBaseRule, CompiledBaseRuleSet, CompiledCondition, Expression } from '../../core';
+/**
+ * Semantic priority levels for expressing criterion importance in human-readable terms.
+ * The compiler converts these to numeric weights and auto-normalizes.
+ *
+ * @example
+ * ```typescript
+ * {
+ *   id: 'low-fees',
+ *   name: 'Low Agency Fees',
+ *   weight: 'critical',  // Instead of 0.25
+ *   direction: 'maximize'
+ * }
+ * ```
+ */
+export type SemanticPriority = 'critical' | 'high' | 'medium' | 'low' | 'not-important';
+/**
+ * Base numeric values for semantic priorities (before normalization).
+ * These are relative weights that get normalized to sum to 1.0.
+ *
+ * - critical: 5 (highest priority)
+ * - high: 3
+ * - medium: 2
+ * - low: 1
+ * - not-important: 0 (excluded from calculation)
+ */
+export declare const SEMANTIC_PRIORITY_VALUES: Record<SemanticPriority, number>;
+/**
+ * Check if a value is a semantic priority string
+ */
+export declare function isSemanticPriority(value: unknown): value is SemanticPriority;
+/**
+ * A criterion (dimension) for evaluating alternatives.
+ *
+ * Weight can be specified as:
+ * - A number (0-1): Traditional numeric weight, all weights should sum to 1
+ * - A SemanticPriority: Human-readable priority that gets auto-normalized
+ *
+ * @example Numeric weight
+ * ```typescript
+ * {
+ *   id: 'compensation',
+ *   name: 'Total Compensation',
+ *   weight: 0.30,
+ *   direction: 'maximize'
+ * }
+ * ```
+ *
+ * @example Semantic weight (auto-normalized)
+ * ```typescript
+ * {
+ *   id: 'low-fees',
+ *   name: 'Low Agency Fees',
+ *   weight: 'critical',
+ *   direction: 'maximize'
+ * }
+ * ```
+ */
+export type UtilityCriterion = {
+    id: string;
+    name?: string;
+    weight: number | SemanticPriority;
+    direction: 'maximize' | 'minimize';
+};
+/**
+ * Compiled criterion with validated weight
+ */
+export type CompiledUtilityCriterion = {
+    id: string;
+    name?: string;
+    weight: number;
+    direction: 'maximize' | 'minimize';
+};
+/**
+ * Utility rule - computes a criterion value for an alternative
+ *
+ * @example
+ * ```typescript
+ * {
+ *   id: 'calc-compensation',
+ *   criterion: 'compensation',
+ *   inputs: [{ name: 'offer', type: 'JobOffer' }],
+ *   compute: ['add', '$offer.baseSalary', '$offer.bonus']
+ * }
+ * ```
+ */
+export type UtilityRule = BaseRule & {
+    criterion: string;
+    compute: Expression;
+};
+/**
+ * Utility ruleset configuration
+ */
+export type UtilityConfig = {
+    mode: 'utility';
+    normalization: 'min-max' | 'z-score' | 'none';
+    aggregation: 'weighted-sum' | 'weighted-product';
+};
+/**
+ * Utility ruleset
+ */
+export type UtilityRuleSet = BaseRuleSet & {
+    mode: 'utility';
+    criteria: UtilityCriterion[];
+    rules: UtilityRule[];
+    config?: Partial<Omit<UtilityConfig, 'mode'>>;
+};
+/**
+ * Compiled utility rule
+ */
+export type CompiledUtilityRule = CompiledBaseRule & {
+    criterion: string;
+    compute: CompiledCondition;
+};
+/**
+ * Compiled utility ruleset
+ */
+export type CompiledUtilityRuleSet = CompiledBaseRuleSet & {
+    mode: 'utility';
+    criteria: CompiledUtilityCriterion[];
+    rules: CompiledUtilityRule[];
+    config: UtilityConfig;
+};
+/**
+ * Result for a single alternative
+ */
+export type AlternativeResult = {
+    id: string;
+    name: string;
+    rawScores: Record<string, number>;
+    normalizedScores: Record<string, number>;
+    weightedScores: Record<string, number>;
+    utilityScore: number;
+};
+/**
+ * Sensitivity analysis for a criterion
+ */
+export type SensitivityInfo = {
+    currentTop: string;
+    topChangeAt?: number;
+    wouldBecome?: string;
+};
+/**
+ * Runtime options for utility execution
+ */
+export type UtilityOptions = {
+    /** Callback when evaluating a criterion for an alternative */
+    onEvaluate?: (alternativeId: string, criterion: string, rawValue: number) => void;
+    /** Callback when an alternative is fully scored */
+    onScore?: (alternative: AlternativeResult) => void;
+    /** Whether to compute sensitivity analysis (default: false) */
+    computeSensitivity?: boolean;
+};
+/**
+ * Execution result
+ */
+export type UtilityResult = {
+    /** All alternatives with their scores */
+    alternatives: AlternativeResult[];
+    /** Alternatives sorted by utility score (descending) */
+    ranking: AlternativeResult[];
+    /** Winner (highest utility) */
+    winner: AlternativeResult | null;
+    /** Sensitivity analysis per criterion (if requested) */
+    sensitivity?: Record<string, SensitivityInfo>;
+    /** Processing time in milliseconds */
+    executionTimeMs: number;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/engines/utility/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/engines/utility/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EACL,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,UAAU,EACX,MAAM,YAAY,CAAC;AAMpB;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,eAAe,CAAC;AAExF;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB,EAAE,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAMrE,CAAC;AAEF;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,gBAAgB,CAE5E;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAClC,SAAS,EAAE,UAAU,GAAG,UAAU,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,UAAU,GAAG,UAAU,CAAC;CACpC,CAAC;AAMF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,UAAU,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,SAAS,CAAC;IAChB,aAAa,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IAC9C,WAAW,EAAE,cAAc,GAAG,kBAAkB,CAAC;CAClD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG;IACzC,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,EAAE,gBAAgB,EAAE,CAAC;IAC7B,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC;CAC/C,CAAC;AAMF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,gBAAgB,GAAG;IACnD,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,iBAAiB,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,mBAAmB,GAAG;IACzD,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,EAAE,wBAAwB,EAAE,CAAC;IACrC,KAAK,EAAE,mBAAmB,EAAE,CAAC;IAC7B,MAAM,EAAE,aAAa,CAAC;CACvB,CAAC;AAMF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,8DAA8D;IAC9D,UAAU,CAAC,EAAE,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IAClF,mDAAmD;IACnD,OAAO,CAAC,EAAE,CAAC,WAAW,EAAE,iBAAiB,KAAK,IAAI,CAAC;IACnD,+DAA+D;IAC/D,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,yCAAyC;IACzC,YAAY,EAAE,iBAAiB,EAAE,CAAC;IAClC,wDAAwD;IACxD,OAAO,EAAE,iBAAiB,EAAE,CAAC;IAC7B,+BAA+B;IAC/B,MAAM,EAAE,iBAAiB,GAAG,IAAI,CAAC;IACjC,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC9C,sCAAsC;IACtC,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC"}

package/dist/engines/utility/types.js

@@ -0,0 +1,35 @@
+"use strict";
+/**
+ * Utility/MCDM Engine Types
+ *
+ * Multi-Criteria Decision Making engine for comparing alternatives
+ * across weighted criteria. Unlike Scoring (which evaluates one item),
+ * MCDM explicitly models trade-offs between multiple options.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SEMANTIC_PRIORITY_VALUES = void 0;
+exports.isSemanticPriority = isSemanticPriority;
+/**
+ * Base numeric values for semantic priorities (before normalization).
+ * These are relative weights that get normalized to sum to 1.0.
+ *
+ * - critical: 5 (highest priority)
+ * - high: 3
+ * - medium: 2
+ * - low: 1
+ * - not-important: 0 (excluded from calculation)
+ */
+exports.SEMANTIC_PRIORITY_VALUES = {
+    'critical': 5,
+    'high': 3,
+    'medium': 2,
+    'low': 1,
+    'not-important': 0
+};
+/**
+ * Check if a value is a semantic priority string
+ */
+function isSemanticPriority(value) {
+    return typeof value === 'string' && value in exports.SEMANTIC_PRIORITY_VALUES;
+}
+//# sourceMappingURL=types.js.map

package/dist/engines/utility/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/engines/utility/types.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAoDH,gDAEC;AAvBD;;;;;;;;;GASG;AACU,QAAA,wBAAwB,GAAqC;IACxE,UAAU,EAAE,CAAC;IACb,MAAM,EAAE,CAAC;IACT,QAAQ,EAAE,CAAC;IACX,KAAK,EAAE,CAAC;IACR,eAAe,EAAE,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,SAAgB,kBAAkB,CAAC,KAAc;IAC/C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,IAAI,gCAAwB,CAAC;AACxE,CAAC"}

package/dist/functions/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Niche Functions for Rule Engine
+ *
+ * Collection of specialized functions for use in rule expressions.
+ * Organized by category for easy discovery and maintenance.
+ */
+export * from './similarity';
+export * from './phonetic';
+//# sourceMappingURL=index.d.ts.map

package/dist/functions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/functions/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,cAAc,cAAc,CAAC;AAG7B,cAAc,YAAY,CAAC"}

package/dist/functions/index.js

@@ -0,0 +1,27 @@
+"use strict";
+/**
+ * Niche Functions for Rule Engine
+ *
+ * Collection of specialized functions for use in rule expressions.
+ * Organized by category for easy discovery and maintenance.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Text Similarity Functions
+__exportStar(require("./similarity"), exports);
+// Phonetic Encoding Functions
+__exportStar(require("./phonetic"), exports);
+//# sourceMappingURL=index.js.map

package/dist/functions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/functions/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;;AAEH,4BAA4B;AAC5B,+CAA6B;AAE7B,8BAA8B;AAC9B,6CAA2B"}

package/dist/functions/phonetic/caverphone2.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Caverphone 2.0 Phonetic Algorithm
+ *
+ * Developed by the Caversham Project at the University of Otago, New Zealand.
+ * Designed specifically for matching names in databases, particularly for
+ * New Zealand and Australian accents.
+ *
+ * Returns a 10-character phonetic code. More complex than Soundex or NYSIIS,
+ * with 12 transformation steps.
+ *
+ * @param name - Name to encode
+ * @returns 10-character Caverphone2 code
+ *
+ * @example
+ * caverphone2('Thompson')  // Returns "TMPSN11111"
+ * caverphone2('Thomson')   // Returns "TMPSN11111" (same encoding)
+ * caverphone2('Smith')     // Returns "SMT1111111"
+ * caverphone2('Smythe')    // Returns "SMT1111111" (same encoding)
+ * caverphone2('Peter')     // Returns "PTA1111111"
+ * caverphone2('Peadar')    // Returns "PTA1111111" (same encoding)
+ */
+export declare function caverphone2(name: string): string;
+/**
+ * Compare two names using Caverphone2 encoding
+ *
+ * @param name1 - First name to compare
+ * @param name2 - Second name to compare
+ * @returns true if names sound similar (same Caverphone2 code)
+ *
+ * @example
+ * caverphone2Match('Thompson', 'Thomson')  // Returns true
+ * caverphone2Match('Smith', 'Smythe')      // Returns true
+ * caverphone2Match('Peter', 'Peadar')      // Returns true
+ */
+export declare function caverphone2Match(name1: string, name2: string): boolean;
+//# sourceMappingURL=caverphone2.d.ts.map

package/dist/functions/phonetic/caverphone2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"caverphone2.d.ts","sourceRoot":"","sources":["../../../src/functions/phonetic/caverphone2.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAsIhD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAEtE"}

package/dist/functions/phonetic/caverphone2.js

@@ -0,0 +1,151 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.caverphone2 = caverphone2;
+exports.caverphone2Match = caverphone2Match;
+/**
+ * Caverphone 2.0 Phonetic Algorithm
+ *
+ * Developed by the Caversham Project at the University of Otago, New Zealand.
+ * Designed specifically for matching names in databases, particularly for
+ * New Zealand and Australian accents.
+ *
+ * Returns a 10-character phonetic code. More complex than Soundex or NYSIIS,
+ * with 12 transformation steps.
+ *
+ * @param name - Name to encode
+ * @returns 10-character Caverphone2 code
+ *
+ * @example
+ * caverphone2('Thompson')  // Returns "TMPSN11111"
+ * caverphone2('Thomson')   // Returns "TMPSN11111" (same encoding)
+ * caverphone2('Smith')     // Returns "SMT1111111"
+ * caverphone2('Smythe')    // Returns "SMT1111111" (same encoding)
+ * caverphone2('Peter')     // Returns "PTA1111111"
+ * caverphone2('Peadar')    // Returns "PTA1111111" (same encoding)
+ */
+function caverphone2(name) {
+    if (!name || name.length === 0) {
+        return '1111111111';
+    }
+    // Convert to lowercase for processing
+    let code = name.toLowerCase().replace(/[^a-z]/g, '');
+    if (code.length === 0) {
+        return '1111111111';
+    }
+    // Step 1: Remove final e
+    if (code.endsWith('e')) {
+        code = code.slice(0, -1);
+    }
+    // Step 2: Handle special patterns at the start
+    // If starts with cough, rough, tough, enough → replace with gof, ruf, tuf, enuf
+    if (code.startsWith('cough')) {
+        code = 'gof' + code.slice(5);
+    }
+    if (code.startsWith('rough')) {
+        code = 'ruf' + code.slice(5);
+    }
+    if (code.startsWith('tough')) {
+        code = 'tuf' + code.slice(5);
+    }
+    if (code.startsWith('enough')) {
+        code = 'enuf' + code.slice(6);
+    }
+    // If starts with gn, replace with 2n
+    if (code.startsWith('gn')) {
+        code = '2n' + code.slice(2);
+    }
+    // Step 3: Replace mb at end with m2
+    if (code.endsWith('mb')) {
+        code = code.slice(0, -2) + 'm2';
+    }
+    // Step 4: Series of replacements
+    code = code.replace(/cq/g, '2q');
+    code = code.replace(/ci/g, 'si');
+    code = code.replace(/ce/g, 'se');
+    code = code.replace(/cy/g, 'sy');
+    code = code.replace(/tch/g, '2ch');
+    code = code.replace(/c/g, 'k');
+    code = code.replace(/q/g, 'k');
+    code = code.replace(/x/g, 'k');
+    code = code.replace(/v/g, 'f');
+    code = code.replace(/dg/g, '2g');
+    code = code.replace(/tio/g, 'sio');
+    code = code.replace(/tia/g, 'sia');
+    code = code.replace(/d/g, 't');
+    code = code.replace(/ph/g, 'fh');
+    code = code.replace(/b/g, 'p');
+    code = code.replace(/sh/g, 's2');
+    code = code.replace(/z/g, 's');
+    // Step 5: Replace initial vowel patterns
+    if (code.match(/^[aeiou]/)) {
+        code = 'A' + code.slice(1);
+    }
+    // Step 6: Replace all other vowels with 3
+    code = code.replace(/[aeiou]/g, '3');
+    // Step 7: Replace j with y
+    code = code.replace(/j/g, 'y');
+    // Step 8: Replace initial y3 with Y3, initial y with A
+    if (code.startsWith('y3')) {
+        code = 'Y3' + code.slice(2);
+    }
+    else if (code.startsWith('y')) {
+        code = 'A' + code.slice(1);
+    }
+    // Step 9: Replace y with 3
+    code = code.replace(/y/g, '3');
+    // Step 10: Replace 3gh3 with 3kh3
+    code = code.replace(/3gh3/g, '3kh3');
+    // Step 11: Replace gh with 22
+    code = code.replace(/gh/g, '22');
+    // Step 12: Replace g with k
+    code = code.replace(/g/g, 'k');
+    // Step 13: Collapse groups of s, t, p, k, f, m, n
+    code = code.replace(/s+/g, 'S');
+    code = code.replace(/t+/g, 'T');
+    code = code.replace(/p+/g, 'P');
+    code = code.replace(/k+/g, 'K');
+    code = code.replace(/f+/g, 'F');
+    code = code.replace(/m+/g, 'M');
+    code = code.replace(/n+/g, 'N');
+    // Step 14: Convert back to lowercase
+    code = code.toLowerCase();
+    // Step 15: Remove all 2s, 3s, and h's
+    code = code.replace(/[23h]/g, '');
+    // Step 16: Replace r at end with 1
+    if (code.endsWith('r')) {
+        code = code.slice(0, -1) + '1';
+    }
+    // Step 17: Replace r with blank (remove)
+    code = code.replace(/r/g, '');
+    // Step 18: Replace l at end with 1
+    if (code.endsWith('l')) {
+        code = code.slice(0, -1) + '1';
+    }
+    // Step 19: Replace l with blank (remove)
+    code = code.replace(/l/g, '');
+    // Step 20: Replace w at end with 1
+    if (code.endsWith('w')) {
+        code = code.slice(0, -1) + '1';
+    }
+    // Step 21: Replace w with blank (remove)
+    code = code.replace(/w/g, '');
+    // Step 22: Pad with 1s or truncate to 10 characters
+    code = code.padEnd(10, '1').slice(0, 10);
+    return code.toUpperCase();
+}
+/**
+ * Compare two names using Caverphone2 encoding
+ *
+ * @param name1 - First name to compare
+ * @param name2 - Second name to compare
+ * @returns true if names sound similar (same Caverphone2 code)
+ *
+ * @example
+ * caverphone2Match('Thompson', 'Thomson')  // Returns true
+ * caverphone2Match('Smith', 'Smythe')      // Returns true
+ * caverphone2Match('Peter', 'Peadar')      // Returns true
+ */
+function caverphone2Match(name1, name2) {
+    return caverphone2(name1) === caverphone2(name2);
+}
+//# sourceMappingURL=caverphone2.js.map

package/dist/functions/phonetic/caverphone2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"caverphone2.js","sourceRoot":"","sources":["../../../src/functions/phonetic/caverphone2.ts"],"names":[],"mappings":";;AAqBA,kCAsIC;AAcD,4CAEC;AA3KD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,WAAW,CAAC,IAAY;IACtC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,sCAAsC;IACtC,IAAI,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAErD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,yBAAyB;IACzB,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACvB,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;IAED,+CAA+C;IAC/C,gFAAgF;IAChF,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7B,IAAI,GAAG,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC;IACD,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7B,IAAI,GAAG,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC;IACD,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7B,IAAI,GAAG,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC;IACD,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9B,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAChC,CAAC;IAED,qCAAqC;IACrC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC9B,CAAC;IAED,oCAAoC;IACpC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAClC,CAAC;IAED,iCAAiC;IACjC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACjC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACjC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACjC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACjC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACnC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC/B,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC/B,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC/B,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC/B,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACjC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACnC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACnC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC/B,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACjC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC/B,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACjC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAE/B,yCAAyC;IACzC,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QAC3B,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC;IAED,0CAA0C;IAC1C,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;IAErC,2BAA2B;IAC3B,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAE/B,uDAAuD;IACvD,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC9B,CAAC;SAAM,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAChC,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC;IAED,2BAA2B;IAC3B,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAE/B,kCAAkC;IAClC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAErC,8BAA8B;IAC9B,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAEjC,4BAA4B;IAC5B,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAE/B,kDAAkD;IAClD,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAChC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAChC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAChC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAChC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAChC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAChC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAEhC,qCAAqC;IACrC,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAE1B,sCAAsC;IACtC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAElC,mCAAmC;IACnC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACvB,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;IACjC,CAAC;IAED,yCAAyC;IACzC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAE9B,mCAAmC;IACnC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACvB,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;IACjC,CAAC;IAED,yCAAyC;IACzC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAE9B,mCAAmC;IACnC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACvB,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;IACjC,CAAC;IAED,yCAAyC;IACzC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAE9B,oDAAoD;IACpD,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAEzC,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,gBAAgB,CAAC,KAAa,EAAE,KAAa;IAC3D,OAAO,WAAW,CAAC,KAAK,CAAC,KAAK,WAAW,CAAC,KAAK,CAAC,CAAC;AACnD,CAAC"}

package/dist/functions/phonetic/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Phonetic Encoding Functions
+ *
+ * Functions for encoding names into phonetic codes for matching similar-sounding names.
+ */
+export { soundex, soundexMatch } from './soundex';
+export { nysiis, nysiisMatch } from './nysiis';
+export { caverphone2, caverphone2Match } from './caverphone2';
+//# sourceMappingURL=index.d.ts.map

package/dist/functions/phonetic/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/functions/phonetic/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC"}

package/dist/functions/phonetic/index.js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * Phonetic Encoding Functions
+ *
+ * Functions for encoding names into phonetic codes for matching similar-sounding names.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.caverphone2Match = exports.caverphone2 = exports.nysiisMatch = exports.nysiis = exports.soundexMatch = exports.soundex = void 0;
+var soundex_1 = require("./soundex");
+Object.defineProperty(exports, "soundex", { enumerable: true, get: function () { return soundex_1.soundex; } });
+Object.defineProperty(exports, "soundexMatch", { enumerable: true, get: function () { return soundex_1.soundexMatch; } });
+var nysiis_1 = require("./nysiis");
+Object.defineProperty(exports, "nysiis", { enumerable: true, get: function () { return nysiis_1.nysiis; } });
+Object.defineProperty(exports, "nysiisMatch", { enumerable: true, get: function () { return nysiis_1.nysiisMatch; } });
+var caverphone2_1 = require("./caverphone2");
+Object.defineProperty(exports, "caverphone2", { enumerable: true, get: function () { return caverphone2_1.caverphone2; } });
+Object.defineProperty(exports, "caverphone2Match", { enumerable: true, get: function () { return caverphone2_1.caverphone2Match; } });
+//# sourceMappingURL=index.js.map

package/dist/functions/phonetic/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/functions/phonetic/index.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH,qCAAkD;AAAzC,kGAAA,OAAO,OAAA;AAAE,uGAAA,YAAY,OAAA;AAC9B,mCAA+C;AAAtC,gGAAA,MAAM,OAAA;AAAE,qGAAA,WAAW,OAAA;AAC5B,6CAA8D;AAArD,0GAAA,WAAW,OAAA;AAAE,+GAAA,gBAAgB,OAAA"}

package/dist/functions/phonetic/nysiis.d.ts

@@ -0,0 +1,38 @@
+/**
+ * NYSIIS Phonetic Algorithm
+ *
+ * New York State Identification and Intelligence System (NYSIIS)
+ * Encodes names into a phonetic code for matching names that sound similar.
+ *
+ * Implementation by Kamau Washington based on Wikipedia specification:
+ * https://en.wikipedia.org/wiki/New_York_State_Identification_and_Intelligence_System
+ *
+ * Developed by the New York State Identification and Intelligence System in 1970.
+ * More accurate than Soundex for matching names with different spellings.
+ *
+ * @param input - Name to encode
+ * @returns NYSIIS phonetic code (max 6 characters), or empty string if no input
+ *
+ * @example
+ * nysiis('McDonald')   // Returns "MCDANA"
+ * nysiis('Macdonald')  // Returns "MCDANA" (same encoding)
+ * nysiis('Johnson')    // Returns "JANSAN"
+ * nysiis('Jonson')     // Returns "JANSAN" (same encoding)
+ * nysiis('Schmidt')    // Returns "SNAD"
+ * nysiis('Smith')      // Returns "SNAT" (different - they don't match)
+ */
+export declare function nysiis(input: string): string;
+/**
+ * Compare two names using NYSIIS encoding
+ *
+ * @param name1 - First name to compare
+ * @param name2 - Second name to compare
+ * @returns true if names sound similar (same NYSIIS code)
+ *
+ * @example
+ * nysiisMatch('McDonald', 'Macdonald')  // Returns true
+ * nysiisMatch('Johnson', 'Jonson')      // Returns true
+ * nysiisMatch('Schmidt', 'Smith')       // Returns false (different codes)
+ */
+export declare function nysiisMatch(name1: string, name2: string): boolean;
+//# sourceMappingURL=nysiis.d.ts.map

package/dist/functions/phonetic/nysiis.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nysiis.d.ts","sourceRoot":"","sources":["../../../src/functions/phonetic/nysiis.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CA4H5C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAEjE"}