@catalystcrm/policy-calculator 1.0.0 → 5.24.0-dev.11

package/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

package/README.md

@@ -0,0 +1,9 @@
+# Policy Calculator
+
+A little helper library to be used for calculating various Policy/Contract fields. It have not much dependencies and
+expected to be used both on backend and frontend.
+
+## Dependencies note
+
+Since the library is expected to be used on the frontend as well, it should not have other backend-only dependencies from
+`@catalystcrm` npm organization.

package/dist/field-calculation/calculator-error.d.ts

@@ -0,0 +1,4 @@
+export declare class CalculatorError extends Error {
+    readonly message: string;
+    constructor(message: string);
+}

package/dist/field-calculation/calculator-error.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CalculatorError = void 0;
+class CalculatorError extends Error {
+    message;
+    constructor(message) {
+        super();
+        this.message = message;
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.message = message;
+        this.name = this.constructor.name;
+    }
+}
+exports.CalculatorError = CalculatorError;
+//# sourceMappingURL=calculator-error.js.map

package/dist/field-calculation/calculator-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculator-error.js","sourceRoot":"","sources":["../../src/field-calculation/calculator-error.ts"],"names":[],"mappings":";;;AAAA,MAAa,eAAgB,SAAQ,KAAK;IACnB;IAArB,YAAqB,OAAe;QAClC,KAAK,EAAE,CAAC;QADW,YAAO,GAAP,OAAO,CAAQ;QAGlC,IAAK,KAAa,CAAC,iBAAiB,EAAE;YACnC,KAAa,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;SAC1D;QAED,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAXD,0CAWC"}

package/dist/field-calculation/calculator-service.d.ts

@@ -0,0 +1,42 @@
+export type PolicyFieldCalculatorInput = {
+    amount_full?: string | null;
+    net_discount_amount?: string | null;
+    net_discount_id?: number | null;
+    amount_netto?: string | null;
+    special_discount?: string | null;
+    stamp_duties?: string | null;
+    gross_discount_amount?: string | null;
+    gross_discount_id?: number | null;
+    amount_brutto?: string | null;
+    other_costs?: string | null;
+    has_stamp_duties?: boolean | null;
+};
+export declare const PolicyDiscountTypes: {
+    GROSS: number;
+    NET: number;
+};
+export type PolicyDiscounts = {
+    id: number;
+    name: string;
+    percentage: string;
+    discount_type_id: number;
+};
+export type PolicyCalculationConfig = {
+    discounts: PolicyDiscounts[];
+    STAMP_DUTY_PERCENTAGE: number;
+};
+export type PolicyFieldCalculatorResponse = {
+    stamp_duties: string;
+    amount_netto: string;
+    amount_brutto: string;
+    net_discount_amount: string;
+    gross_discount_amount: string;
+};
+export type FieldCalculationConfig = {
+    policyCalculationConfig: PolicyCalculationConfig;
+};
+export declare class FieldCalculationService {
+    private readonly policyCalculationConfig;
+    constructor(config: FieldCalculationConfig);
+    calculate(input: PolicyFieldCalculatorInput): PolicyFieldCalculatorResponse;
+}

package/dist/field-calculation/calculator-service.js

@@ -0,0 +1,84 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldCalculationService = exports.PolicyDiscountTypes = void 0;
+const decimal_js_1 = __importDefault(require("decimal.js"));
+const calculator_error_1 = require("./calculator-error");
+exports.PolicyDiscountTypes = {
+    GROSS: 1,
+    NET: 2
+};
+class FieldCalculationService {
+    policyCalculationConfig;
+    constructor(config) {
+        this.policyCalculationConfig = config.policyCalculationConfig;
+    }
+    calculate(input) {
+        const amount_full = input.amount_full ? input.amount_full : '0.00';
+        const special_discount = input.special_discount ? input.special_discount : '0.00';
+        const other_costs = input.other_costs ? input.other_costs : '0.00';
+        // manually casting to number because GQL will serialize ids as string
+        const net_discount_id = input.net_discount_id && Number(input.net_discount_id);
+        const gross_discount_id = input.gross_discount_id && Number(input.gross_discount_id);
+        let net_discount_amount = input.net_discount_amount ? input.net_discount_amount : '0.00';
+        let amount_netto = input.amount_netto ? input.amount_netto : '0.00';
+        let stamp_duties = input.stamp_duties ? input.stamp_duties : '0.00';
+        let gross_discount_amount = input.gross_discount_amount ? input.gross_discount_amount : '0.00';
+        let amount_brutto = input.amount_brutto ? input.amount_brutto : '0.00';
+        // 1. Calculate the net discount if any.
+        if (net_discount_id) {
+            const netDiscounts = this.policyCalculationConfig.discounts.filter(d => d.discount_type_id === exports.PolicyDiscountTypes.NET);
+            const discount = netDiscounts.find(({ id }) => id === net_discount_id);
+            if (!discount) {
+                throw new calculator_error_1.CalculatorError(`Invalid net discount id for calculation: ${net_discount_id}`);
+            }
+            const percentage = new decimal_js_1.default(discount.percentage);
+            const percentageValue = percentage.dividedBy(100).times(amount_full);
+            net_discount_amount = percentageValue.negated().toFixed(2);
+        }
+        // 2. Calculate the net premium
+        const amountNettoDecimal = new decimal_js_1.default(amount_full).add(net_discount_amount);
+        amount_netto = amountNettoDecimal.toFixed(2);
+        // 2.1 Calculate special discount from net premium
+        const specialDiscount = new decimal_js_1.default(special_discount);
+        const specialDiscountDecimal = specialDiscount.dividedBy(100).times(amount_netto);
+        const special_discount_value = specialDiscountDecimal.toFixed(2);
+        // 3. Calculate the gross discount if any
+        if (gross_discount_id) {
+            const grossDiscounts = this.policyCalculationConfig.discounts.filter(d => d.discount_type_id === exports.PolicyDiscountTypes.GROSS);
+            const discount = grossDiscounts.find(({ id }) => id === gross_discount_id);
+            if (!discount) {
+                throw new calculator_error_1.CalculatorError(`Invalid gross discount id for calculation: ${gross_discount_id}`);
+            }
+            const percentage = new decimal_js_1.default(discount.percentage);
+            const percentageValue = percentage.dividedBy(100).times(amount_netto);
+            gross_discount_amount = percentageValue.negated().toFixed(2);
+        }
+        // 4. Calculate the stamp duties if any
+        if (input.has_stamp_duties) {
+            const stampPercentage = new decimal_js_1.default(this.policyCalculationConfig.STAMP_DUTY_PERCENTAGE);
+            const stampDuties = stampPercentage
+                .dividedBy(100)
+                .times(new decimal_js_1.default(amount_netto).minus(special_discount_value));
+            stamp_duties = stampDuties.toFixed(2);
+        }
+        // 5. Calculate the gross premium
+        const amountBruttoDecimal = new decimal_js_1.default(amount_netto)
+            .minus(special_discount_value)
+            .add(stamp_duties)
+            .add(gross_discount_amount)
+            .add(other_costs);
+        amount_brutto = amountBruttoDecimal.toFixed(2);
+        return {
+            stamp_duties,
+            amount_netto,
+            amount_brutto,
+            net_discount_amount,
+            gross_discount_amount
+        };
+    }
+}
+exports.FieldCalculationService = FieldCalculationService;
+//# sourceMappingURL=calculator-service.js.map

package/dist/field-calculation/calculator-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculator-service.js","sourceRoot":"","sources":["../../src/field-calculation/calculator-service.ts"],"names":[],"mappings":";;;;;;AAAA,4DAAiC;AAEjC,yDAAqD;AAoBxC,QAAA,mBAAmB,GAAG;IACjC,KAAK,EAAE,CAAC;IACR,GAAG,EAAE,CAAC;CACP,CAAC;AA0BF,MAAa,uBAAuB;IACjB,uBAAuB,CAA0B;IAClE,YAAY,MAA8B;QACxC,IAAI,CAAC,uBAAuB,GAAG,MAAM,CAAC,uBAAuB,CAAC;IAChE,CAAC;IACD,SAAS,CAAC,KAAiC;QACzC,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC;QACnE,MAAM,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC;QAClF,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC;QAEnE,sEAAsE;QACtE,MAAM,eAAe,GAAG,KAAK,CAAC,eAAe,IAAI,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAC/E,MAAM,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,IAAI,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAErF,IAAI,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,CAAC;QACzF,IAAI,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC;QACpE,IAAI,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC;QACpE,IAAI,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,MAAM,CAAC;QAC/F,IAAI,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC;QAEvE,wCAAwC;QACxC,IAAI,eAAe,EAAE;YACnB,MAAM,YAAY,GAAG,IAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,MAAM,CAChE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,KAAK,2BAAmB,CAAC,GAAG,CACpD,CAAC;YACF,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,eAAe,CAAC,CAAC;YACvE,IAAI,CAAC,QAAQ,EAAE;gBACb,MAAM,IAAI,kCAAe,CAAC,4CAA4C,eAAe,EAAE,CAAC,CAAC;aAC1F;YACD,MAAM,UAAU,GAAG,IAAI,oBAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YACpD,MAAM,eAAe,GAAG,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YACrE,mBAAmB,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;SAC5D;QAED,+BAA+B;QAC/B,MAAM,kBAAkB,GAAG,IAAI,oBAAO,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QAC7E,YAAY,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAE7C,kDAAkD;QAClD,MAAM,eAAe,GAAG,IAAI,oBAAO,CAAC,gBAAgB,CAAC,CAAC;QACtD,MAAM,sBAAsB,GAAG,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAClF,MAAM,sBAAsB,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAEjE,yCAAyC;QACzC,IAAI,iBAAiB,EAAE;YACrB,MAAM,cAAc,GAAG,IAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,MAAM,CAClE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,KAAK,2BAAmB,CAAC,KAAK,CACtD,CAAC;YACF,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,iBAAiB,CAAC,CAAC;YAC3E,IAAI,CAAC,QAAQ,EAAE;gBACb,MAAM,IAAI,kCAAe,CACvB,8CAA8C,iBAAiB,EAAE,CAClE,CAAC;aACH;YACD,MAAM,UAAU,GAAG,IAAI,oBAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YACpD,MAAM,eAAe,GAAG,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YACtE,qBAAqB,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;SAC9D;QAED,uCAAuC;QACvC,IAAI,KAAK,CAAC,gBAAgB,EAAE;YAC1B,MAAM,eAAe,GAAG,IAAI,oBAAO,CAAC,IAAI,CAAC,uBAAuB,CAAC,qBAAqB,CAAC,CAAC;YACxF,MAAM,WAAW,GAAG,eAAe;iBAChC,SAAS,CAAC,GAAG,CAAC;iBACd,KAAK,CAAC,IAAI,oBAAO,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC;YAClE,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;SACvC;QAED,iCAAiC;QACjC,MAAM,mBAAmB,GAAG,IAAI,oBAAO,CAAC,YAAY,CAAC;aAClD,KAAK,CAAC,sBAAsB,CAAC;aAC7B,GAAG,CAAC,YAAY,CAAC;aACjB,GAAG,CAAC,qBAAqB,CAAC;aAC1B,GAAG,CAAC,WAAW,CAAC,CAAC;QAEpB,aAAa,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAE/C,OAAO;YACL,YAAY;YACZ,YAAY;YACZ,aAAa;YACb,mBAAmB;YACnB,qBAAqB;SACtB,CAAC;IACJ,CAAC;CACF;AArFD,0DAqFC"}

package/dist/field-calculation/formula-calculator.d.ts

@@ -0,0 +1,49 @@
+export type CalculatorInput = {
+    formula: string | null;
+    start_date?: Date | string | null;
+    end_date?: Date | string | null;
+    amount_netto?: string | null;
+    amount_brutto?: string | null;
+    sum_insured?: string | null;
+    partner_commission?: string | null;
+};
+/**
+ * @param calculatePrecision number of significant digits during calculation
+ * @param outputScale number of decimal digits only at the output result
+ */
+export type FormulaCalculatorConfig = {
+    calculatePrecision: number;
+    outputScale: number;
+};
+export declare class FormulaCalculator {
+    private readonly outputScale;
+    private readonly mathjs;
+    constructor(config: FormulaCalculatorConfig);
+    private validateNumeric;
+    /**
+     * Calculates LZ param value exactly the way Brokerstar does
+     */
+    private getLZValue;
+    /**
+     * Function to calculate number of point from given data.
+     *
+     * The combinvest sales system is based on points, in order to simplify the complex commission
+     * distribution. It means sales forces/leads don't get a certain amount of money per product
+     * sale, they get points. Also personal, team and company goals are set in points.
+     * A point is then equivalent to a certain amount of money, which is different depending
+     * on the persons career level.
+     *
+     * Input data usually is collected from premium (amounts and sums) and policy (start and end dates).
+     *
+     * Implemented right after Brokerstar's method `Premium.calcFomula` (not a typo here :) )
+     * Does not fully support following values: [LS-AHV], [LS-UVG], [LS-BVG]
+     */
+    calculate(input: CalculatorInput): string;
+    /**
+     * This method below is here because it uses the same logic as method calculate and the same configs.
+     * @param a is string containing decimal
+     * @param b is string containing decimal
+     * @returns sum of two decimal strings
+     */
+    sum(a: string, b: string): string;
+}

package/dist/field-calculation/formula-calculator.js

@@ -0,0 +1,140 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FormulaCalculator = void 0;
+const decimal_js_1 = require("decimal.js");
+const mathjs_1 = require("mathjs");
+const moment_1 = __importDefault(require("moment"));
+const neverthrow_1 = require("neverthrow");
+const string_1 = require("../utils/string");
+const DAYS_IN_YEAR = 365;
+const MAX_LZ = 100; // Max LZn value used by Brokerstar points calculator
+class FormulaCalculator {
+    outputScale;
+    mathjs;
+    constructor(config) {
+        this.outputScale = config.outputScale;
+        this.mathjs = (0, mathjs_1.create)(mathjs_1.all);
+        this.mathjs.config({ number: 'BigNumber', precision: config.calculatePrecision });
+        this.mathjs.import({
+            divide(a, b) {
+                const result = decimal_js_1.Decimal.div(a, b);
+                return result.toString() === 'Infinity' || result.toString() === '-Infinity' ? 0 : result;
+            }
+        }, { override: true });
+    }
+    validateNumeric(input) {
+        const n = Number(input);
+        return !input || Number.isNaN(n) ? (0, neverthrow_1.err)(`"${input}" is not valid number`) : (0, neverthrow_1.ok)(input);
+    }
+    /**
+     * Calculates LZ param value exactly the way Brokerstar does
+     */
+    getLZValue(start_date, end_date) {
+        let LZ = '1';
+        if (start_date && end_date && (0, moment_1.default)(start_date).isValid() && (0, moment_1.default)(end_date).isValid()) {
+            // getting number of days between start and end
+            const daysNumber = new decimal_js_1.Decimal((0, moment_1.default)(end_date).diff((0, moment_1.default)(start_date), 'days'));
+            const daysNumberModulo = decimal_js_1.Decimal.abs(daysNumber);
+            const yearsNumber = decimal_js_1.Decimal.round(daysNumberModulo.dividedBy(DAYS_IN_YEAR));
+            LZ = yearsNumber.valueOf();
+        }
+        return LZ;
+    }
+    /**
+     * Function to calculate number of point from given data.
+     *
+     * The combinvest sales system is based on points, in order to simplify the complex commission
+     * distribution. It means sales forces/leads don't get a certain amount of money per product
+     * sale, they get points. Also personal, team and company goals are set in points.
+     * A point is then equivalent to a certain amount of money, which is different depending
+     * on the persons career level.
+     *
+     * Input data usually is collected from premium (amounts and sums) and policy (start and end dates).
+     *
+     * Implemented right after Brokerstar's method `Premium.calcFomula` (not a typo here :) )
+     * Does not fully support following values: [LS-AHV], [LS-UVG], [LS-BVG]
+     */
+    calculate(input) {
+        if (!input.formula) {
+            return new decimal_js_1.Decimal('0').toFixed(this.outputScale);
+        }
+        const numericFormulaProvisionUnitResult = this.validateNumeric(input.formula);
+        // if it is just stringified number - returning it
+        if (numericFormulaProvisionUnitResult.isOk()) {
+            return new decimal_js_1.Decimal(numericFormulaProvisionUnitResult.value).toFixed(this.outputScale);
+        }
+        const numericAmountNettoResult = this.validateNumeric(input.amount_netto);
+        // if this is stringified number of percents
+        if (input.formula.includes('%') && numericAmountNettoResult.isOk()) {
+            const percentString = input.formula.replace('%', '');
+            const multiplier = percentString;
+            const points = new decimal_js_1.Decimal(numericAmountNettoResult.value).dividedBy('100').times(multiplier);
+            return points.toFixed(this.outputScale);
+        }
+        // otherwise this is full-featured arithmetic formula like `[BP]*[LZ] - [NP]/8`
+        const numericAmountBruttoResult = this.validateNumeric(input.amount_brutto);
+        const numericSumInsuredResult = this.validateNumeric(input.sum_insured);
+        const numericPartnerCommissionResult = this.validateNumeric(input.partner_commission);
+        // calculating numeric replacement values
+        const NP = numericAmountNettoResult.unwrapOr('0');
+        const BP = numericAmountBruttoResult.unwrapOr('0');
+        const VS = numericSumInsuredResult.unwrapOr('0');
+        const PC = numericPartnerCommissionResult.unwrapOr('0');
+        const LZ = this.getLZValue(input.start_date, input.end_date);
+        // These fields are currently not being used, they are tied to BS contact wages.
+        // We don't have contact wages on Combinvest
+        // and as of 24.10.2022 contact wages is empty on BS production
+        // we decided to go with BS default values which is 0
+        const LSAHV = '0';
+        const LSUVG = '0';
+        const LSBVG = '0';
+        const replacements = {
+            '[NP]': NP,
+            '[BP]': BP,
+            '[LZ]': LZ,
+            '[VS]': VS,
+            '[PC]': PC,
+            '[LS-AHV]': LSAHV,
+            '[LS-UVG]': LSUVG,
+            '[LS-BVG]': LSBVG
+        };
+        // .. and all the LZ1, LZ2...LZ99 replacements too
+        for (let i = 1; i < MAX_LZ; i++) {
+            const replacement = Number(LZ) < i ? LZ : i.toString();
+            replacements[`[LZ${i}]`] = replacement;
+        }
+        // substituting letter variables with their values. This way substitutedFormulaString is
+        // straight arithmetic expression. something like this:
+        // '21/9 + 100' or '34' or '9*1-2'
+        let substitutedFormulaString = input.formula;
+        for (const [key, replacement] of Object.entries(replacements)) {
+            substitutedFormulaString = (0, string_1.replaceAll)(substitutedFormulaString, key, `${replacement}`);
+        }
+        // We want to default to 0 if we can't successfully parse the formula
+        const defaultPoints = '0';
+        try {
+            const value = this.mathjs.evaluate(substitutedFormulaString);
+            // checks if the calculated value is actually NaN, then defaults to defaultsPoints(0)
+            return Number.isNaN(parseFloat(value))
+                ? new decimal_js_1.Decimal(defaultPoints).toFixed(this.outputScale)
+                : new decimal_js_1.Decimal(value).toFixed(this.outputScale);
+        }
+        catch (error) {
+            return new decimal_js_1.Decimal(defaultPoints).toFixed(this.outputScale);
+        }
+    }
+    /**
+     * This method below is here because it uses the same logic as method calculate and the same configs.
+     * @param a is string containing decimal
+     * @param b is string containing decimal
+     * @returns sum of two decimal strings
+     */
+    sum(a, b) {
+        return new decimal_js_1.Decimal(this.mathjs.evaluate(`${a} + ${b}`)).toFixed(this.outputScale);
+    }
+}
+exports.FormulaCalculator = FormulaCalculator;
+//# sourceMappingURL=formula-calculator.js.map

package/dist/field-calculation/formula-calculator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formula-calculator.js","sourceRoot":"","sources":["../../src/field-calculation/formula-calculator.ts"],"names":[],"mappings":";;;;;;AAAA,2CAAqC;AACrC,mCAAmD;AACnD,oDAA4B;AAC5B,2CAA6C;AAE7C,4CAA6C;AAE7C,MAAM,YAAY,GAAG,GAAG,CAAC;AACzB,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,qDAAqD;AAqBzE,MAAa,iBAAiB;IACX,WAAW,CAAS;IACpB,MAAM,CAAe;IACtC,YAAY,MAA+B;QACzC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,IAAA,eAAM,EAAC,YAAG,CAAC,CAAC;QAC1B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC,kBAAkB,EAAE,CAAC,CAAC;QAClF,IAAI,CAAC,MAAM,CAAC,MAAM,CAChB;YACE,MAAM,CAAC,CAAC,EAAE,CAAC;gBACT,MAAM,MAAM,GAAG,oBAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBACjC,OAAO,MAAM,CAAC,QAAQ,EAAE,KAAK,UAAU,IAAI,MAAM,CAAC,QAAQ,EAAE,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;YAC5F,CAAC;SACF,EACD,EAAE,QAAQ,EAAE,IAAI,EAAE,CACnB,CAAC;IACJ,CAAC;IAEO,eAAe,CAAC,KAAgC;QACtD,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAA,gBAAG,EAAC,IAAI,KAAK,uBAAuB,CAAC,CAAC,CAAC,CAAC,IAAA,eAAE,EAAC,KAAK,CAAC,CAAC;IACvF,CAAC;IAED;;OAEG;IACK,UAAU,CAAC,UAAiC,EAAE,QAA+B;QACnF,IAAI,EAAE,GAAG,GAAG,CAAC;QACb,IAAI,UAAU,IAAI,QAAQ,IAAI,IAAA,gBAAM,EAAC,UAAU,CAAC,CAAC,OAAO,EAAE,IAAI,IAAA,gBAAM,EAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,EAAE;YACxF,+CAA+C;YAC/C,MAAM,UAAU,GAAG,IAAI,oBAAO,CAAC,IAAA,gBAAM,EAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAA,gBAAM,EAAC,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;YAClF,MAAM,gBAAgB,GAAG,oBAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACjD,MAAM,WAAW,GAAG,oBAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;YAC5E,EAAE,GAAG,WAAW,CAAC,OAAO,EAAE,CAAC;SAC5B;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,KAAsB;QAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;YAClB,OAAO,IAAI,oBAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SACnD;QAED,MAAM,iCAAiC,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC9E,kDAAkD;QAClD,IAAI,iCAAiC,CAAC,IAAI,EAAE,EAAE;YAC5C,OAAO,IAAI,oBAAO,CAAC,iCAAiC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SACvF;QAED,MAAM,wBAAwB,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC1E,4CAA4C;QAC5C,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,wBAAwB,CAAC,IAAI,EAAE,EAAE;YAClE,MAAM,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACrD,MAAM,UAAU,GAAG,aAAa,CAAC;YACjC,MAAM,MAAM,GAAG,IAAI,oBAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YAC9F,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SACzC;QAED,+EAA+E;QAE/E,MAAM,yBAAyB,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAC5E,MAAM,uBAAuB,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACxE,MAAM,8BAA8B,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtF,yCAAyC;QACzC,MAAM,EAAE,GAAG,wBAAwB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAClD,MAAM,EAAE,GAAG,yBAAyB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACnD,MAAM,EAAE,GAAG,uBAAuB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACjD,MAAM,EAAE,GAAG,8BAA8B,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACxD,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;QAE7D,gFAAgF;QAChF,4CAA4C;QAC5C,+DAA+D;QAC/D,qDAAqD;QACrD,MAAM,KAAK,GAAG,GAAG,CAAC;QAClB,MAAM,KAAK,GAAG,GAAG,CAAC;QAClB,MAAM,KAAK,GAAG,GAAG,CAAC;QAElB,MAAM,YAAY,GAA2B;YAC3C,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,EAAE;YACV,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,KAAK;SAClB,CAAC;QAEF,kDAAkD;QAClD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE;YAC/B,MAAM,WAAW,GAAG,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;YACvD,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC;SACxC;QAED,wFAAwF;QACxF,uDAAuD;QACvD,kCAAkC;QAClC,IAAI,wBAAwB,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7C,KAAK,MAAM,CAAC,GAAG,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;YAC7D,wBAAwB,GAAG,IAAA,mBAAU,EAAC,wBAAwB,EAAE,GAAG,EAAE,GAAG,WAAW,EAAE,CAAC,CAAC;SACxF;QAED,qEAAqE;QACrE,MAAM,aAAa,GAAG,GAAG,CAAC;QAC1B,IAAI;YACF,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC;YAC7D,qFAAqF;YACrF,OAAO,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBACpC,CAAC,CAAC,IAAI,oBAAO,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC;gBACtD,CAAC,CAAC,IAAI,oBAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SAClD;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,IAAI,oBAAO,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SAC7D;IACH,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,CAAS,EAAE,CAAS;QACtB,OAAO,IAAI,oBAAO,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACpF,CAAC;CACF;AA3ID,8CA2IC"}

package/dist/field-calculation/index.d.ts

@@ -0,0 +1,3 @@
+export { CalculatorError } from './calculator-error';
+export { PolicyFieldCalculatorInput, PolicyCalculationConfig, PolicyFieldCalculatorResponse, FieldCalculationConfig, FieldCalculationService } from './calculator-service';
+export { FormulaCalculator } from './formula-calculator';

package/dist/field-calculation/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FormulaCalculator = exports.FieldCalculationService = exports.CalculatorError = void 0;
+var calculator_error_1 = require("./calculator-error");
+Object.defineProperty(exports, "CalculatorError", { enumerable: true, get: function () { return calculator_error_1.CalculatorError; } });
+var calculator_service_1 = require("./calculator-service");
+Object.defineProperty(exports, "FieldCalculationService", { enumerable: true, get: function () { return calculator_service_1.FieldCalculationService; } });
+var formula_calculator_1 = require("./formula-calculator");
+Object.defineProperty(exports, "FormulaCalculator", { enumerable: true, get: function () { return formula_calculator_1.FormulaCalculator; } });
+//# sourceMappingURL=index.js.map

package/dist/field-calculation/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/field-calculation/index.ts"],"names":[],"mappings":";;;AAAA,uDAAqD;AAA5C,mHAAA,eAAe,OAAA;AACxB,2DAM8B;AAD5B,6HAAA,uBAAuB,OAAA;AAEzB,2DAAyD;AAAhD,uHAAA,iBAAiB,OAAA"}

package/dist/utils/string.d.ts

@@ -0,0 +1 @@
+export declare function replaceAll(sourceStr: string, subStr: string, newSubStr: string): string;

package/dist/utils/string.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.replaceAll = void 0;
+function replaceAll(sourceStr, subStr, newSubStr) {
+    return sourceStr.split(subStr).join(newSubStr);
+}
+exports.replaceAll = replaceAll;
+//# sourceMappingURL=string.js.map

package/dist/utils/string.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.js","sourceRoot":"","sources":["../../src/utils/string.ts"],"names":[],"mappings":";;;AAAA,SAAgB,UAAU,CAAC,SAAiB,EAAE,MAAc,EAAE,SAAiB;IAC7E,OAAO,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACjD,CAAC;AAFD,gCAEC"}

package/package.json

@@ -1,10 +1,44 @@
 {
   "name": "@catalystcrm/policy-calculator",
-  "version": "1.0.0",
-  "description": "Policy calculation module for Catalyst CRM",
-  "main": "index.js",
-  "license": "MIT",
-  "publishConfig": {
-    "access": "public"
+  "version": "5.24.0-dev.11",
+  "description": "Collection of utilities to perform policy and premium related calculations",
+  "scripts": {
+    "test:unit": "mocha --require ts-node/register --exit 'test/unit/**/*.{js,ts}'",
+    "test:unit:xunit": "mocha --require ts-node/register --exit --reporter xunit --reporter-options output=../../test-results/unit/policy-calculator.xml --reporter-options suiteName='policy-calculator:unit' 'test/unit/**/*.{js,ts}'",
+    "test:acceptance": "mocha --require ts-node/register --extensions js,ts 'test/acceptance/**/*.{js,ts}'",
+    "lint": "eslint --report-unused-disable-directives '**/*.{js,ts}'",
+    "lint:write": "eslint --report-unused-disable-directives --fix '**/*.{js,ts}'",
+    "clean": "rm -rf ./dist",
+    "build:release": "npm run clean && tsc -p ./tsconfig.release.json",
+    "build": "npm run clean && tsc -p ./tsconfig.release.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "decimal.js": "10.4.3",
+    "mathjs": "11.8.2",
+    "moment": "2.29.4",
+    "neverthrow": "5.1.0"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.3.1",
+    "@types/chai-subset": "^1.3.3",
+    "@types/mocha": "^9.1.1",
+    "@typescript-eslint/eslint-plugin": "5.59.0",
+    "@typescript-eslint/parser": "5.59.0",
+    "chai": "4.3.7",
+    "chai-subset": "^1.6.0",
+    "eslint": "8.42.0",
+    "eslint-config-airbnb-base": "15.0.0",
+    "eslint-config-airbnb-typescript": "17.0.0",
+    "eslint-config-prettier": "8.8.0",
+    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-no-only-tests": "3.3.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "eslint-plugin-unused-imports": "4.1.4",
+    "lint-staged": "^13.0.1",
+    "mocha": "10.2.0",
+    "prettier": "2.8.8"
   }
 }