@konplit-services/common 1.0.361 → 1.0.363

package/build/helper/money.d.ts

@@ -6,40 +6,41 @@ export declare const formatMoneyToNumber: (money: ReturnType<typeof dinero>) =>
 export declare const sumMoney: (a: ReturnType<typeof dinero>, b: ReturnType<typeof dinero>) => import("dinero.js").Dinero<number>;
 export declare const subtractMoney: (a: ReturnType<typeof dinero>, b: ReturnType<typeof dinero>) => import("dinero.js").Dinero<number>;
 /**
- * Multiplies a Dinero.js monetary amount by a factor, typically used for percentage-based calculations.
- * The factor is scaled to an integer-based multiplier to ensure precision in Dinero.js.
- * For example, a factor of 1.4 (representing 1.4%) is converted to { amount: 140, scale: 4 } to represent 0.014.
+ * Multiplies a Dinero.js monetary amount by a given factor, typically used for percentage-based calculations.
  *
- * @param a - The Dinero.js object representing the monetary amount (e.g., in the currency's smallest unit like kobo for NGN).
- * @param factor - The multiplier, typically a percentage rate (e.g., 1.4 for 1.4%).
- * @param scale - The scale for the multiplier, determining the decimal precision (default: 2).
- *                For percentages, use scale = 4 for one decimal (e.g., 1.4%) or scale = 5 for two decimals (e.g., 1.45%).
- * @returns A new Dinero.js object representing the result of the multiplication.
- * @throws Error if the resulting amount is invalid (e.g., exceeds Number.MAX_SAFE_INTEGER or is non-integer).
+ * This function dynamically calculates the multiplication scale based on the number of decimal places
+ * in the factor to maintain precision, then adjusts for percentage scaling by adding 2 to the scale
+ * (because factor is a percentage, i.e., factor% = factor/100).
+ *
+ * The input amount is expected to be in the smallest currency unit (e.g., kobo for NGN, cents for USD).
+ *
+ * @param a - The Dinero.js monetary amount object, representing money in minor units.
+ * @param factor - The multiplier factor, typically a percentage (e.g., 1.4 means 1.4%).
+ *                 Can be any positive decimal number, including those with many decimal places (e.g., 1.00054).
+ *
+ * @returns A new Dinero.js object representing the result of the multiplication (e.g., the fee or adjusted amount).
+ *
+ * @throws Error if the calculation results in an invalid amount (e.g., exceeding Number.MAX_SAFE_INTEGER).
  *
  * @example
- * // Example 1: Calculate 1.4% fee on 7100 kobo (71.00 NGN)
- * import { dinero, USD } from 'dinero.js';
- * const amount = dinero({ amount: 7100, currency: USD }); // 71.00 USD (assuming USD for simplicity)
- * const result = multiplyMoney(amount, 1.4, 4);
- * // Result: Dinero object with amount ≈ 994 (99.4 cents, or 0.994 USD)
- * console.log(result.toJSON()); // { amount: 994, currency: USD, scale: 2 }
+ * // Calculate a 1.4% fee on ₦71.00 (7100 kobo)
+ * const amount = dinero({ amount: 7100, currency: NGN });
+ * const result = multiplyMoney(amount, 1.4);
+ * // result.amount = 994 (kobo) which is ₦9.94
  *
  * @example
- * // Example 2: Calculate 0.05% fee on 10000 kobo (100.00 NGN) with higher precision
- * const amount = dinero({ amount: 10000, currency: USD });
- * const result = multiplyMoney(amount, 0.05, 5);
- * // Result: Dinero object with amount ≈ 50 (5 cents, or 0.05 USD)
- * console.log(result.toJSON()); // { amount: 50, currency: USD, scale: 2 }
+ * // Calculate a 0.05% fee on ₦100.00 (10000 kobo)
+ * const amount = dinero({ amount: 10000, currency: NGN });
+ * const result = multiplyMoney(amount, 0.05);
+ * // result.amount = 5 (kobo) which is ₦0.05
  *
  * @example
- * // Example 3: Using default scale (2) for a simple multiplier
- * const amount = dinero({ amount: 500, currency: USD }); // 5.00 USD
- * const result = multiplyMoney(amount, 2); // Multiply by 2 (200%)
- * // Result: Dinero object with amount = 1000 (10.00 USD)
- * console.log(result.toJSON()); // { amount: 1000, currency: USD, scale: 2 }
+ * // Calculate a 1.00054% fee on ₦2500.00 (250000 kobo)
+ * const amount = dinero({ amount: 250000, currency: NGN });
+ * const result = multiplyMoney(amount, 1.00054);
+ * // result.amount ≈ 2501 (kobo) which is approximately ₦25.01
  */
-export declare const multiplyMoney: (a: ReturnType<typeof dinero>, factor: number, scale?: number) => import("dinero.js").Dinero<number>;
+export declare const multiplyMoney: (a: ReturnType<typeof dinero>, factor: number) => import("dinero.js").Dinero<number>;
 export declare const divideMoney: (money: ReturnType<typeof dinero>, divisor: number) => import("dinero.js").Dinero<number>;
 export declare const toSmalletUnit: (naira: number | string) => number;
 export {};

package/build/helper/money.js

@@ -28,43 +28,59 @@ const subtractMoney = (a, b) => {
 };
 exports.subtractMoney = subtractMoney;
 /**
- * Multiplies a Dinero.js monetary amount by a factor, typically used for percentage-based calculations.
- * The factor is scaled to an integer-based multiplier to ensure precision in Dinero.js.
- * For example, a factor of 1.4 (representing 1.4%) is converted to { amount: 140, scale: 4 } to represent 0.014.
+ * Multiplies a Dinero.js monetary amount by a given factor, typically used for percentage-based calculations.
  *
- * @param a - The Dinero.js object representing the monetary amount (e.g., in the currency's smallest unit like kobo for NGN).
- * @param factor - The multiplier, typically a percentage rate (e.g., 1.4 for 1.4%).
- * @param scale - The scale for the multiplier, determining the decimal precision (default: 2).
- *                For percentages, use scale = 4 for one decimal (e.g., 1.4%) or scale = 5 for two decimals (e.g., 1.45%).
- * @returns A new Dinero.js object representing the result of the multiplication.
- * @throws Error if the resulting amount is invalid (e.g., exceeds Number.MAX_SAFE_INTEGER or is non-integer).
+ * This function dynamically calculates the multiplication scale based on the number of decimal places
+ * in the factor to maintain precision, then adjusts for percentage scaling by adding 2 to the scale
+ * (because factor is a percentage, i.e., factor% = factor/100).
+ *
+ * The input amount is expected to be in the smallest currency unit (e.g., kobo for NGN, cents for USD).
+ *
+ * @param a - The Dinero.js monetary amount object, representing money in minor units.
+ * @param factor - The multiplier factor, typically a percentage (e.g., 1.4 means 1.4%).
+ *                 Can be any positive decimal number, including those with many decimal places (e.g., 1.00054).
+ *
+ * @returns A new Dinero.js object representing the result of the multiplication (e.g., the fee or adjusted amount).
+ *
+ * @throws Error if the calculation results in an invalid amount (e.g., exceeding Number.MAX_SAFE_INTEGER).
  *
  * @example
- * // Example 1: Calculate 1.4% fee on 7100 kobo (71.00 NGN)
- * import { dinero, USD } from 'dinero.js';
- * const amount = dinero({ amount: 7100, currency: USD }); // 71.00 USD (assuming USD for simplicity)
- * const result = multiplyMoney(amount, 1.4, 4);
- * // Result: Dinero object with amount ≈ 994 (99.4 cents, or 0.994 USD)
- * console.log(result.toJSON()); // { amount: 994, currency: USD, scale: 2 }
+ * // Calculate a 1.4% fee on ₦71.00 (7100 kobo)
+ * const amount = dinero({ amount: 7100, currency: NGN });
+ * const result = multiplyMoney(amount, 1.4);
+ * // result.amount = 994 (kobo) which is ₦9.94
  *
  * @example
- * // Example 2: Calculate 0.05% fee on 10000 kobo (100.00 NGN) with higher precision
- * const amount = dinero({ amount: 10000, currency: USD });
- * const result = multiplyMoney(amount, 0.05, 5);
- * // Result: Dinero object with amount ≈ 50 (5 cents, or 0.05 USD)
- * console.log(result.toJSON()); // { amount: 50, currency: USD, scale: 2 }
+ * // Calculate a 0.05% fee on ₦100.00 (10000 kobo)
+ * const amount = dinero({ amount: 10000, currency: NGN });
+ * const result = multiplyMoney(amount, 0.05);
+ * // result.amount = 5 (kobo) which is ₦0.05
  *
  * @example
- * // Example 3: Using default scale (2) for a simple multiplier
- * const amount = dinero({ amount: 500, currency: USD }); // 5.00 USD
- * const result = multiplyMoney(amount, 2); // Multiply by 2 (200%)
- * // Result: Dinero object with amount = 1000 (10.00 USD)
- * console.log(result.toJSON()); // { amount: 1000, currency: USD, scale: 2 }
+ * // Calculate a 1.00054% fee on ₦2500.00 (250000 kobo)
+ * const amount = dinero({ amount: 250000, currency: NGN });
+ * const result = multiplyMoney(amount, 1.00054);
+ * // result.amount ≈ 2501 (kobo) which is approximately ₦25.01
  */
-const multiplyMoney = (a, factor, scale = 2) => {
-    return (0, dinero_js_1.multiply)(a, { amount: factor * 100, scale }); // Convert decimal to Dinero scale
+const multiplyMoney = (a, factor) => {
+    const decimalPlaces = getDecimalPlaces(factor);
+    const scale = decimalPlaces;
+    const multiplierAmount = Math.round(factor * Math.pow(10, scale));
+    return (0, dinero_js_1.multiply)(a, { amount: multiplierAmount, scale: scale + 2 });
 };
 exports.multiplyMoney = multiplyMoney;
+function getDecimalPlaces(num) {
+    const str = num.toString();
+    // Handle exponential notation (e.g., 1e-7)
+    if (str.includes("e-")) {
+        const [, exp] = str.split("e-");
+        return parseInt(exp, 10);
+    }
+    const decimalIndex = str.indexOf(".");
+    if (decimalIndex === -1)
+        return 0;
+    return str.length - decimalIndex - 1;
+}
 const divideMoney = (money, divisor) => {
     const decimal = parseFloat((0, exports.formatMoneyToString)(money));
     const result = Math.round((decimal / divisor) * 100);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@konplit-services/common",
-  "version": "1.0.361",
+  "version": "1.0.363",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",