@konplit-services/common 1.0.362 → 1.0.363

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,26 +6,39 @@ export declare const formatMoneyToNumber: (money: ReturnType<typeof dinero>) =>
6
6
  export declare const sumMoney: (a: ReturnType<typeof dinero>, b: ReturnType<typeof dinero>) => import("dinero.js").Dinero<number>;
7
7
  export declare const subtractMoney: (a: ReturnType<typeof dinero>, b: ReturnType<typeof dinero>) => import("dinero.js").Dinero<number>;
8
8
  /**
9
- * Multiplies a Dinero.js monetary amount by a factor, typically for percentage-based calculations.
10
- * The scale is dynamically calculated based on the number of decimal places in the factor,
11
- * plus 2 for the percentage conversion (÷100) and 2 for scaling (*100).
9
+ * Multiplies a Dinero.js monetary amount by a given factor, typically used for percentage-based calculations.
12
10
  *
13
- * @param a - The Dinero.js object representing the monetary amount (e.g., in kobo for NGN).
14
- * @param factor - The multiplier, typically a percentage rate (e.g., 1.4 for 1.4%).
15
- * @returns A new Dinero.js object representing the result of the multiplication.
16
- * @throws Error if the resulting amount is invalid (e.g., exceeds Number.MAX_SAFE_INTEGER).
11
+ * This function dynamically calculates the multiplication scale based on the number of decimal places
12
+ * in the factor to maintain precision, then adjusts for percentage scaling by adding 2 to the scale
13
+ * (because factor is a percentage, i.e., factor% = factor/100).
14
+ *
15
+ * The input amount is expected to be in the smallest currency unit (e.g., kobo for NGN, cents for USD).
16
+ *
17
+ * @param a - The Dinero.js monetary amount object, representing money in minor units.
18
+ * @param factor - The multiplier factor, typically a percentage (e.g., 1.4 means 1.4%).
19
+ * Can be any positive decimal number, including those with many decimal places (e.g., 1.00054).
20
+ *
21
+ * @returns A new Dinero.js object representing the result of the multiplication (e.g., the fee or adjusted amount).
22
+ *
23
+ * @throws Error if the calculation results in an invalid amount (e.g., exceeding Number.MAX_SAFE_INTEGER).
17
24
  *
18
25
  * @example
19
- * // Calculate 1.4% fee on 7100 kobo (71.00 NGN)
26
+ * // Calculate a 1.4% fee on 71.00 (7100 kobo)
20
27
  * const amount = dinero({ amount: 7100, currency: NGN });
21
28
  * const result = multiplyMoney(amount, 1.4);
22
- * // Result: { amount: 994, currency: NGN, scale: 2 } (99.4 kobo)
29
+ * // result.amount = 994 (kobo) which is ₦9.94
23
30
  *
24
31
  * @example
25
- * // Calculate 0.05% fee on 10000 kobo (100.00 NGN)
32
+ * // Calculate a 0.05% fee on 100.00 (10000 kobo)
26
33
  * const amount = dinero({ amount: 10000, currency: NGN });
27
34
  * const result = multiplyMoney(amount, 0.05);
28
- * // Result: { amount: 50, currency: NGN, scale: 2 } (5 kobo)
35
+ * // result.amount = 5 (kobo) which is ₦0.05
36
+ *
37
+ * @example
38
+ * // Calculate a 1.00054% fee on ₦2500.00 (250000 kobo)
39
+ * const amount = dinero({ amount: 250000, currency: NGN });
40
+ * const result = multiplyMoney(amount, 1.00054);
41
+ * // result.amount ≈ 2501 (kobo) which is approximately ₦25.01
29
42
  */
30
43
  export declare const multiplyMoney: (a: ReturnType<typeof dinero>, factor: number) => import("dinero.js").Dinero<number>;
31
44
  export declare const divideMoney: (money: ReturnType<typeof dinero>, divisor: number) => import("dinero.js").Dinero<number>;
@@ -28,36 +28,54 @@ const subtractMoney = (a, b) => {
28
28
  };
29
29
  exports.subtractMoney = subtractMoney;
30
30
  /**
31
- * Multiplies a Dinero.js monetary amount by a factor, typically for percentage-based calculations.
32
- * The scale is dynamically calculated based on the number of decimal places in the factor,
33
- * plus 2 for the percentage conversion (÷100) and 2 for scaling (*100).
31
+ * Multiplies a Dinero.js monetary amount by a given factor, typically used for percentage-based calculations.
34
32
  *
35
- * @param a - The Dinero.js object representing the monetary amount (e.g., in kobo for NGN).
36
- * @param factor - The multiplier, typically a percentage rate (e.g., 1.4 for 1.4%).
37
- * @returns A new Dinero.js object representing the result of the multiplication.
38
- * @throws Error if the resulting amount is invalid (e.g., exceeds Number.MAX_SAFE_INTEGER).
33
+ * This function dynamically calculates the multiplication scale based on the number of decimal places
34
+ * in the factor to maintain precision, then adjusts for percentage scaling by adding 2 to the scale
35
+ * (because factor is a percentage, i.e., factor% = factor/100).
36
+ *
37
+ * The input amount is expected to be in the smallest currency unit (e.g., kobo for NGN, cents for USD).
38
+ *
39
+ * @param a - The Dinero.js monetary amount object, representing money in minor units.
40
+ * @param factor - The multiplier factor, typically a percentage (e.g., 1.4 means 1.4%).
41
+ * Can be any positive decimal number, including those with many decimal places (e.g., 1.00054).
42
+ *
43
+ * @returns A new Dinero.js object representing the result of the multiplication (e.g., the fee or adjusted amount).
44
+ *
45
+ * @throws Error if the calculation results in an invalid amount (e.g., exceeding Number.MAX_SAFE_INTEGER).
39
46
  *
40
47
  * @example
41
- * // Calculate 1.4% fee on 7100 kobo (71.00 NGN)
48
+ * // Calculate a 1.4% fee on 71.00 (7100 kobo)
42
49
  * const amount = dinero({ amount: 7100, currency: NGN });
43
50
  * const result = multiplyMoney(amount, 1.4);
44
- * // Result: { amount: 994, currency: NGN, scale: 2 } (99.4 kobo)
51
+ * // result.amount = 994 (kobo) which is ₦9.94
45
52
  *
46
53
  * @example
47
- * // Calculate 0.05% fee on 10000 kobo (100.00 NGN)
54
+ * // Calculate a 0.05% fee on 100.00 (10000 kobo)
48
55
  * const amount = dinero({ amount: 10000, currency: NGN });
49
56
  * const result = multiplyMoney(amount, 0.05);
50
- * // Result: { amount: 50, currency: NGN, scale: 2 } (5 kobo)
57
+ * // result.amount = 5 (kobo) which is ₦0.05
58
+ *
59
+ * @example
60
+ * // Calculate a 1.00054% fee on ₦2500.00 (250000 kobo)
61
+ * const amount = dinero({ amount: 250000, currency: NGN });
62
+ * const result = multiplyMoney(amount, 1.00054);
63
+ * // result.amount ≈ 2501 (kobo) which is approximately ₦25.01
51
64
  */
52
65
  const multiplyMoney = (a, factor) => {
53
66
  const decimalPlaces = getDecimalPlaces(factor);
54
- const scale = decimalPlaces + 2 + 2; // Decimal places + 2 (*100) + 2 (÷100)
55
- const multiplierAmount = Math.round(factor * 100); // Ensure integer
56
- return (0, dinero_js_1.multiply)(a, { amount: multiplierAmount, scale });
67
+ const scale = decimalPlaces;
68
+ const multiplierAmount = Math.round(factor * Math.pow(10, scale));
69
+ return (0, dinero_js_1.multiply)(a, { amount: multiplierAmount, scale: scale + 2 });
57
70
  };
58
71
  exports.multiplyMoney = multiplyMoney;
59
72
  function getDecimalPlaces(num) {
60
73
  const str = num.toString();
74
+ // Handle exponential notation (e.g., 1e-7)
75
+ if (str.includes("e-")) {
76
+ const [, exp] = str.split("e-");
77
+ return parseInt(exp, 10);
78
+ }
61
79
  const decimalIndex = str.indexOf(".");
62
80
  if (decimalIndex === -1)
63
81
  return 0;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@konplit-services/common",
3
- "version": "1.0.362",
3
+ "version": "1.0.363",
4
4
  "description": "",
5
5
  "main": "./build/index.js",
6
6
  "types": "./build/index.d.ts",