@konplit-services/common 1.0.360 → 1.0.362

package/build/helper/money.d.ts

@@ -5,6 +5,28 @@ export declare const formatMoneyToString: (money: ReturnType<typeof dinero>) =>
 export declare const formatMoneyToNumber: (money: ReturnType<typeof dinero>) => number;
 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 for percentage-based calculations.
+ * The scale is dynamically calculated based on the number of decimal places in the factor,
+ * plus 2 for the percentage conversion (÷100) and 2 for scaling (*100).
+ *
+ * @param a - The Dinero.js object representing the monetary amount (e.g., in kobo for NGN).
+ * @param factor - The multiplier, typically a percentage rate (e.g., 1.4 for 1.4%).
+ * @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).
+ *
+ * @example
+ * // Calculate 1.4% fee on 7100 kobo (71.00 NGN)
+ * const amount = dinero({ amount: 7100, currency: NGN });
+ * const result = multiplyMoney(amount, 1.4);
+ * // Result: { amount: 994, currency: NGN, scale: 2 } (99.4 kobo)
+ *
+ * @example
+ * // Calculate 0.05% fee on 10000 kobo (100.00 NGN)
+ * const amount = dinero({ amount: 10000, currency: NGN });
+ * const result = multiplyMoney(amount, 0.05);
+ * // Result: { amount: 50, currency: NGN, scale: 2 } (5 kobo)
+ */
 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;

package/build/helper/money.js

@@ -27,10 +27,42 @@ const subtractMoney = (a, b) => {
     return (0, dinero_js_1.subtract)(a, b);
 };
 exports.subtractMoney = subtractMoney;
+/**
+ * Multiplies a Dinero.js monetary amount by a factor, typically for percentage-based calculations.
+ * The scale is dynamically calculated based on the number of decimal places in the factor,
+ * plus 2 for the percentage conversion (÷100) and 2 for scaling (*100).
+ *
+ * @param a - The Dinero.js object representing the monetary amount (e.g., in kobo for NGN).
+ * @param factor - The multiplier, typically a percentage rate (e.g., 1.4 for 1.4%).
+ * @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).
+ *
+ * @example
+ * // Calculate 1.4% fee on 7100 kobo (71.00 NGN)
+ * const amount = dinero({ amount: 7100, currency: NGN });
+ * const result = multiplyMoney(amount, 1.4);
+ * // Result: { amount: 994, currency: NGN, scale: 2 } (99.4 kobo)
+ *
+ * @example
+ * // Calculate 0.05% fee on 10000 kobo (100.00 NGN)
+ * const amount = dinero({ amount: 10000, currency: NGN });
+ * const result = multiplyMoney(amount, 0.05);
+ * // Result: { amount: 50, currency: NGN, scale: 2 } (5 kobo)
+ */
 const multiplyMoney = (a, factor) => {
-    return (0, dinero_js_1.multiply)(a, { amount: factor * 100, scale: 2 }); // Convert decimal to Dinero scale
+    const decimalPlaces = getDecimalPlaces(factor);
+    const scale = decimalPlaces + 2 + 2; // Decimal places + 2 (*100) + 2 (÷100)
+    const multiplierAmount = Math.round(factor * 100); // Ensure integer
+    return (0, dinero_js_1.multiply)(a, { amount: multiplierAmount, scale });
 };
 exports.multiplyMoney = multiplyMoney;
+function getDecimalPlaces(num) {
+    const str = num.toString();
+    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.360",
+  "version": "1.0.362",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",