@nexim/financial-calculate 1.0.0-alpha.1 → 1.0.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.0.0](https://github.com/the-nexim/nanolib/compare/@nexim/financial-calculate@1.0.0-alpha.2...@nexim/financial-calculate@1.0.0) (2025-04-20)
+
+**Note:** Version bump only for package @nexim/financial-calculate
+
+## [1.0.0-alpha.2](https://github.com/the-nexim/nanolib/compare/@nexim/financial-calculate@1.0.0-alpha.1...@nexim/financial-calculate@1.0.0-alpha.2) (2025-01-11)
+
+### Features
+
+* **financial-calculating:** add `calculateDiscountParentage` method ([#33](https://github.com/the-nexim/nanolib/issues/33)) ([7e61430](https://github.com/the-nexim/nanolib/commit/7e614304c5957aa64489a0159e7e0c7caf4856e6)) by @arashagp
+
 ## [1.0.0-alpha.1](https://github.com/the-nexim/nanolib/compare/@nexim/financial-calculate@1.0.0-alpha.0...@nexim/financial-calculate@1.0.0-alpha.1) (2025-01-09)
 
 **Note:** Version bump only for package @nexim/financial-calculate

package/README.md

@@ -19,20 +19,6 @@ npm install @nexim/financial-calculate
 yarn add @nexim/financial-calculate
 ```
 
-## API
+## Documentation
 
-### calculateDiscountedPrice
-
-Calculate the price after applying a discount.
-
-```ts
-calculateDiscountedPrice(100, 10, 1); // returns 90.0
-```
-
-### calculateDiscountAmount
-
-Calculate the discount amount from the original price.
-
-```ts
-calculateDiscountAmount(100, 10, 1); // returns 10.0
-```
+Read full documentation [here](./docs/README.md).

package/dist/main.cjs

@@ -1,4 +1,4 @@
-/* @nexim/financial-calculate v1.0.0-alpha.1 */
+/* @nexim/financial-calculate v1.0.0 */
 "use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -22,12 +22,14 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var main_exports = {};
 __export(main_exports, {
   calculateDiscountAmount: () => calculateDiscountAmount,
-  calculateDiscountedPrice: () => calculateDiscountedPrice
+  calculateDiscountedPrice: () => calculateDiscountedPrice,
+  calculatePercentageDiscount: () => calculatePercentageDiscount,
+  calculatePercentageProfit: () => calculatePercentageProfit
 });
 module.exports = __toCommonJS(main_exports);
 var import_logger = require("@alwatr/logger");
 var import_package_tracer = require("@alwatr/package-tracer");
-__dev_mode__: import_package_tracer.packageTracer.add("@nexim/financial-calculate", "1.0.0-alpha.1");
+__dev_mode__: import_package_tracer.packageTracer.add("@nexim/financial-calculate", "1.0.0");
 var logger = (0, import_logger.createLogger)("@nexim/financial-calculate");
 function calculateDiscountedPrice(price, discount, decimal = 2) {
   logger.logMethodArgs?.("calculateDiscountedPrice", { price, discount, decimal });
@@ -39,5 +41,14 @@ function calculateDiscountAmount(price, discount, decimal = 2) {
   const discountAmount = price * discount / 100;
   return parseFloat(discountAmount.toFixed(decimal));
 }
-/*! For license information please see main.cjs.LEGAL.txt */
+function calculatePercentageProfit(marketPrice, salePrice, decimal = 2) {
+  logger.logMethodArgs?.("calculatePercentageProfit", { marketPrice, salePrice, decimal });
+  const percentage = (marketPrice - salePrice) / salePrice * 100;
+  return parseFloat(percentage.toFixed(decimal));
+}
+function calculatePercentageDiscount(marketPrice, salePrice, decimal = 2) {
+  logger.logMethodArgs?.("calculatePercentageDiscount", { marketPrice, salePrice, decimal });
+  const percentage = (marketPrice - salePrice) / marketPrice * 100;
+  return parseFloat(percentage.toFixed(decimal));
+}
 //# sourceMappingURL=main.cjs.map

package/dist/main.cjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/main.ts"],
-  "sourcesContent": ["import {createLogger} from '@alwatr/logger';\nimport {packageTracer} from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\nconst logger = createLogger(__package_name__);\n\n/**\n * Calculate the price after applying a discount.\n *\n * @param price - The original price.\n * @param discount - The discount percentage to apply.\n * @param decimal - The number of decimal places to round to (default is 2).\n *\n * @example\n * ```\n * calculateDiscountedPrice(100, 10, 1); // returns 90.0\n * ```\n */\nexport function calculateDiscountedPrice(price: number, discount: number, decimal = 2): number {\n  logger.logMethodArgs?.('calculateDiscountedPrice', {price, discount, decimal});\n\n  const discountedPrice = price * (1 - discount / 100);\n  return parseFloat(discountedPrice.toFixed(decimal));\n}\n\n/**\n * Calculate the discount amount from the original price.\n *\n * @param price - The original price.\n * @param discount - The discount percentage.\n * @param decimal - The number of decimal places to round to (default is 2).\n *\n * @example\n * ```\n * calculateDiscountAmount(100, 10, 1); // returns 10.0\n * ```\n */\nexport function calculateDiscountAmount(price: number, discount: number, decimal = 2): number {\n  logger.logMethodArgs?.('calculateDiscountAmount', {price, discount, decimal});\n\n  const discountAmount = (price * discount) / 100;\n  return parseFloat(discountAmount.toFixed(decimal));\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAA2B;AAC3B,4BAA4B;AAE5B,aAAc,qCAAc,IAAI,8BAAkB,eAAmB;AAErE,IAAM,aAAS,4BAAa,4BAAgB;AAcrC,SAAS,yBAAyB,OAAe,UAAkB,UAAU,GAAW;AAC7F,SAAO,gBAAgB,4BAA4B,EAAC,OAAO,UAAU,QAAO,CAAC;AAE7E,QAAM,kBAAkB,SAAS,IAAI,WAAW;AAChD,SAAO,WAAW,gBAAgB,QAAQ,OAAO,CAAC;AACpD;AAcO,SAAS,wBAAwB,OAAe,UAAkB,UAAU,GAAW;AAC5F,SAAO,gBAAgB,2BAA2B,EAAC,OAAO,UAAU,QAAO,CAAC;AAE5E,QAAM,iBAAkB,QAAQ,WAAY;AAC5C,SAAO,WAAW,eAAe,QAAQ,OAAO,CAAC;AACnD;",
+  "sourcesContent": ["import { createLogger } from '@alwatr/logger';\nimport { packageTracer } from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\nconst logger = createLogger(__package_name__);\n\n/**\n * Calculate the price after applying a discount.\n *\n * @param price - The original price.\n * @param discount - The discount percentage to apply.\n * @param decimal - The number of decimal places to round to (default is 2).\n *\n * @example\n * ```ts\n * calculateDiscountedPrice(100, 10, 1); // returns 90.0\n * ```\n */\nexport function calculateDiscountedPrice(price: number, discount: number, decimal = 2): number {\n  logger.logMethodArgs?.('calculateDiscountedPrice', { price, discount, decimal });\n\n  const discountedPrice = price * (1 - discount / 100);\n  return parseFloat(discountedPrice.toFixed(decimal));\n}\n\n/**\n * Calculate the discount amount from the original price.\n *\n * @param price - The original price.\n * @param discount - The discount percentage.\n * @param decimal - The number of decimal places to round to (default is 2).\n *\n * @example\n * ```ts\n * calculateDiscountAmount(100, 10, 1); // returns 10.0\n * ```\n */\nexport function calculateDiscountAmount(price: number, discount: number, decimal = 2): number {\n  logger.logMethodArgs?.('calculateDiscountAmount', { price, discount, decimal });\n\n  const discountAmount = (price * discount) / 100;\n  return parseFloat(discountAmount.toFixed(decimal));\n}\n\n/**\n * Calculates the discount percentage between the market price and the sale price for profit.\n *\n * @param marketPrice - The original market price of the item.\n * @param salePrice - The sale price of the item.\n * @param decimal - The number of decimal places to round the result to(optional with default value = 2).\n *\n * @example\n * ```ts\n * calculatePercentageProfit(100, 80); // Returns 20.00\n * calculatePercentageProfit(100, 80, 1, false); // Returns 25.0\n * ```\n */\nexport function calculatePercentageProfit(marketPrice: number, salePrice: number, decimal = 2): number {\n  logger.logMethodArgs?.('calculatePercentageProfit', { marketPrice, salePrice, decimal });\n\n  const percentage = ((marketPrice - salePrice) / salePrice) * 100;\n  return parseFloat(percentage.toFixed(decimal));\n}\n\n/**\n * Calculates the discount percentage between the market price and the sale price for discount.\n *\n * @param marketPrice - The original market price of the item.\n * @param salePrice - The sale price of the item.\n * @param decimal - The number of decimal places to round the result to(optional with default value = 2).\n *\n * @example\n * ```ts\n * calculatePercentageDiscount(100, 80); // Returns 20.00\n * calculatePercentageDiscount(100, 80, 1, false); // Returns 25.0\n * ```\n */\nexport function calculatePercentageDiscount(marketPrice: number, salePrice: number, decimal = 2): number {\n  logger.logMethodArgs?.('calculatePercentageDiscount', { marketPrice, salePrice, decimal });\n\n  const percentage = ((marketPrice - salePrice) / marketPrice) * 100;\n  return parseFloat(percentage.toFixed(decimal));\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAA6B;AAC7B,4BAA8B;AAE9B,aAAc,qCAAc,IAAI,8BAAkB,OAAmB;AAErE,IAAM,aAAS,4BAAa,4BAAgB;AAcrC,SAAS,yBAAyB,OAAe,UAAkB,UAAU,GAAW;AAC7F,SAAO,gBAAgB,4BAA4B,EAAE,OAAO,UAAU,QAAQ,CAAC;AAE/E,QAAM,kBAAkB,SAAS,IAAI,WAAW;AAChD,SAAO,WAAW,gBAAgB,QAAQ,OAAO,CAAC;AACpD;AAcO,SAAS,wBAAwB,OAAe,UAAkB,UAAU,GAAW;AAC5F,SAAO,gBAAgB,2BAA2B,EAAE,OAAO,UAAU,QAAQ,CAAC;AAE9E,QAAM,iBAAkB,QAAQ,WAAY;AAC5C,SAAO,WAAW,eAAe,QAAQ,OAAO,CAAC;AACnD;AAeO,SAAS,0BAA0B,aAAqB,WAAmB,UAAU,GAAW;AACrG,SAAO,gBAAgB,6BAA6B,EAAE,aAAa,WAAW,QAAQ,CAAC;AAEvF,QAAM,cAAe,cAAc,aAAa,YAAa;AAC7D,SAAO,WAAW,WAAW,QAAQ,OAAO,CAAC;AAC/C;AAeO,SAAS,4BAA4B,aAAqB,WAAmB,UAAU,GAAW;AACvG,SAAO,gBAAgB,+BAA+B,EAAE,aAAa,WAAW,QAAQ,CAAC;AAEzF,QAAM,cAAe,cAAc,aAAa,cAAe;AAC/D,SAAO,WAAW,WAAW,QAAQ,OAAO,CAAC;AAC/C;",
   "names": []
 }

package/dist/main.d.ts

@@ -6,7 +6,7 @@
  * @param decimal - The number of decimal places to round to (default is 2).
  *
  * @example
- * ```
+ * ```ts
  * calculateDiscountedPrice(100, 10, 1); // returns 90.0
  * ```
  */
@@ -19,9 +19,37 @@ export declare function calculateDiscountedPrice(price: number, discount: number
  * @param decimal - The number of decimal places to round to (default is 2).
  *
  * @example
- * ```
+ * ```ts
  * calculateDiscountAmount(100, 10, 1); // returns 10.0
  * ```
  */
 export declare function calculateDiscountAmount(price: number, discount: number, decimal?: number): number;
+/**
+ * Calculates the discount percentage between the market price and the sale price for profit.
+ *
+ * @param marketPrice - The original market price of the item.
+ * @param salePrice - The sale price of the item.
+ * @param decimal - The number of decimal places to round the result to(optional with default value = 2).
+ *
+ * @example
+ * ```ts
+ * calculatePercentageProfit(100, 80); // Returns 20.00
+ * calculatePercentageProfit(100, 80, 1, false); // Returns 25.0
+ * ```
+ */
+export declare function calculatePercentageProfit(marketPrice: number, salePrice: number, decimal?: number): number;
+/**
+ * Calculates the discount percentage between the market price and the sale price for discount.
+ *
+ * @param marketPrice - The original market price of the item.
+ * @param salePrice - The sale price of the item.
+ * @param decimal - The number of decimal places to round the result to(optional with default value = 2).
+ *
+ * @example
+ * ```ts
+ * calculatePercentageDiscount(100, 80); // Returns 20.00
+ * calculatePercentageDiscount(100, 80, 1, false); // Returns 25.0
+ * ```
+ */
+export declare function calculatePercentageDiscount(marketPrice: number, salePrice: number, decimal?: number): number;
 //# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;GAWG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,SAAI,GAAG,MAAM,CAK7F;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,SAAI,GAAG,MAAM,CAK5F"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;GAWG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,SAAI,GAAG,MAAM,CAK7F;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,SAAI,GAAG,MAAM,CAK5F;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,yBAAyB,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,SAAI,GAAG,MAAM,CAKrG;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,2BAA2B,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,SAAI,GAAG,MAAM,CAKvG"}

package/dist/main.mjs

@@ -1,9 +1,9 @@
-/* @nexim/financial-calculate v1.0.0-alpha.1 */
+/* @nexim/financial-calculate v1.0.0 */
 
 // src/main.ts
 import { createLogger } from "@alwatr/logger";
 import { packageTracer } from "@alwatr/package-tracer";
-__dev_mode__: packageTracer.add("@nexim/financial-calculate", "1.0.0-alpha.1");
+__dev_mode__: packageTracer.add("@nexim/financial-calculate", "1.0.0");
 var logger = createLogger("@nexim/financial-calculate");
 function calculateDiscountedPrice(price, discount, decimal = 2) {
   logger.logMethodArgs?.("calculateDiscountedPrice", { price, discount, decimal });
@@ -15,9 +15,20 @@ function calculateDiscountAmount(price, discount, decimal = 2) {
   const discountAmount = price * discount / 100;
   return parseFloat(discountAmount.toFixed(decimal));
 }
+function calculatePercentageProfit(marketPrice, salePrice, decimal = 2) {
+  logger.logMethodArgs?.("calculatePercentageProfit", { marketPrice, salePrice, decimal });
+  const percentage = (marketPrice - salePrice) / salePrice * 100;
+  return parseFloat(percentage.toFixed(decimal));
+}
+function calculatePercentageDiscount(marketPrice, salePrice, decimal = 2) {
+  logger.logMethodArgs?.("calculatePercentageDiscount", { marketPrice, salePrice, decimal });
+  const percentage = (marketPrice - salePrice) / marketPrice * 100;
+  return parseFloat(percentage.toFixed(decimal));
+}
 export {
   calculateDiscountAmount,
-  calculateDiscountedPrice
+  calculateDiscountedPrice,
+  calculatePercentageDiscount,
+  calculatePercentageProfit
 };
-/*! For license information please see main.mjs.LEGAL.txt */
 //# sourceMappingURL=main.mjs.map

package/dist/main.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/main.ts"],
-  "sourcesContent": ["import {createLogger} from '@alwatr/logger';\nimport {packageTracer} from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\nconst logger = createLogger(__package_name__);\n\n/**\n * Calculate the price after applying a discount.\n *\n * @param price - The original price.\n * @param discount - The discount percentage to apply.\n * @param decimal - The number of decimal places to round to (default is 2).\n *\n * @example\n * ```\n * calculateDiscountedPrice(100, 10, 1); // returns 90.0\n * ```\n */\nexport function calculateDiscountedPrice(price: number, discount: number, decimal = 2): number {\n  logger.logMethodArgs?.('calculateDiscountedPrice', {price, discount, decimal});\n\n  const discountedPrice = price * (1 - discount / 100);\n  return parseFloat(discountedPrice.toFixed(decimal));\n}\n\n/**\n * Calculate the discount amount from the original price.\n *\n * @param price - The original price.\n * @param discount - The discount percentage.\n * @param decimal - The number of decimal places to round to (default is 2).\n *\n * @example\n * ```\n * calculateDiscountAmount(100, 10, 1); // returns 10.0\n * ```\n */\nexport function calculateDiscountAmount(price: number, discount: number, decimal = 2): number {\n  logger.logMethodArgs?.('calculateDiscountAmount', {price, discount, decimal});\n\n  const discountAmount = (price * discount) / 100;\n  return parseFloat(discountAmount.toFixed(decimal));\n}\n"],
-  "mappings": ";;;AAAA,SAAQ,oBAAmB;AAC3B,SAAQ,qBAAoB;AAE5B,aAAc,eAAc,IAAI,8BAAkB,eAAmB;AAErE,IAAM,SAAS,aAAa,4BAAgB;AAcrC,SAAS,yBAAyB,OAAe,UAAkB,UAAU,GAAW;AAC7F,SAAO,gBAAgB,4BAA4B,EAAC,OAAO,UAAU,QAAO,CAAC;AAE7E,QAAM,kBAAkB,SAAS,IAAI,WAAW;AAChD,SAAO,WAAW,gBAAgB,QAAQ,OAAO,CAAC;AACpD;AAcO,SAAS,wBAAwB,OAAe,UAAkB,UAAU,GAAW;AAC5F,SAAO,gBAAgB,2BAA2B,EAAC,OAAO,UAAU,QAAO,CAAC;AAE5E,QAAM,iBAAkB,QAAQ,WAAY;AAC5C,SAAO,WAAW,eAAe,QAAQ,OAAO,CAAC;AACnD;",
+  "sourcesContent": ["import { createLogger } from '@alwatr/logger';\nimport { packageTracer } from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\nconst logger = createLogger(__package_name__);\n\n/**\n * Calculate the price after applying a discount.\n *\n * @param price - The original price.\n * @param discount - The discount percentage to apply.\n * @param decimal - The number of decimal places to round to (default is 2).\n *\n * @example\n * ```ts\n * calculateDiscountedPrice(100, 10, 1); // returns 90.0\n * ```\n */\nexport function calculateDiscountedPrice(price: number, discount: number, decimal = 2): number {\n  logger.logMethodArgs?.('calculateDiscountedPrice', { price, discount, decimal });\n\n  const discountedPrice = price * (1 - discount / 100);\n  return parseFloat(discountedPrice.toFixed(decimal));\n}\n\n/**\n * Calculate the discount amount from the original price.\n *\n * @param price - The original price.\n * @param discount - The discount percentage.\n * @param decimal - The number of decimal places to round to (default is 2).\n *\n * @example\n * ```ts\n * calculateDiscountAmount(100, 10, 1); // returns 10.0\n * ```\n */\nexport function calculateDiscountAmount(price: number, discount: number, decimal = 2): number {\n  logger.logMethodArgs?.('calculateDiscountAmount', { price, discount, decimal });\n\n  const discountAmount = (price * discount) / 100;\n  return parseFloat(discountAmount.toFixed(decimal));\n}\n\n/**\n * Calculates the discount percentage between the market price and the sale price for profit.\n *\n * @param marketPrice - The original market price of the item.\n * @param salePrice - The sale price of the item.\n * @param decimal - The number of decimal places to round the result to(optional with default value = 2).\n *\n * @example\n * ```ts\n * calculatePercentageProfit(100, 80); // Returns 20.00\n * calculatePercentageProfit(100, 80, 1, false); // Returns 25.0\n * ```\n */\nexport function calculatePercentageProfit(marketPrice: number, salePrice: number, decimal = 2): number {\n  logger.logMethodArgs?.('calculatePercentageProfit', { marketPrice, salePrice, decimal });\n\n  const percentage = ((marketPrice - salePrice) / salePrice) * 100;\n  return parseFloat(percentage.toFixed(decimal));\n}\n\n/**\n * Calculates the discount percentage between the market price and the sale price for discount.\n *\n * @param marketPrice - The original market price of the item.\n * @param salePrice - The sale price of the item.\n * @param decimal - The number of decimal places to round the result to(optional with default value = 2).\n *\n * @example\n * ```ts\n * calculatePercentageDiscount(100, 80); // Returns 20.00\n * calculatePercentageDiscount(100, 80, 1, false); // Returns 25.0\n * ```\n */\nexport function calculatePercentageDiscount(marketPrice: number, salePrice: number, decimal = 2): number {\n  logger.logMethodArgs?.('calculatePercentageDiscount', { marketPrice, salePrice, decimal });\n\n  const percentage = ((marketPrice - salePrice) / marketPrice) * 100;\n  return parseFloat(percentage.toFixed(decimal));\n}\n"],
+  "mappings": ";;;AAAA,SAAS,oBAAoB;AAC7B,SAAS,qBAAqB;AAE9B,aAAc,eAAc,IAAI,8BAAkB,OAAmB;AAErE,IAAM,SAAS,aAAa,4BAAgB;AAcrC,SAAS,yBAAyB,OAAe,UAAkB,UAAU,GAAW;AAC7F,SAAO,gBAAgB,4BAA4B,EAAE,OAAO,UAAU,QAAQ,CAAC;AAE/E,QAAM,kBAAkB,SAAS,IAAI,WAAW;AAChD,SAAO,WAAW,gBAAgB,QAAQ,OAAO,CAAC;AACpD;AAcO,SAAS,wBAAwB,OAAe,UAAkB,UAAU,GAAW;AAC5F,SAAO,gBAAgB,2BAA2B,EAAE,OAAO,UAAU,QAAQ,CAAC;AAE9E,QAAM,iBAAkB,QAAQ,WAAY;AAC5C,SAAO,WAAW,eAAe,QAAQ,OAAO,CAAC;AACnD;AAeO,SAAS,0BAA0B,aAAqB,WAAmB,UAAU,GAAW;AACrG,SAAO,gBAAgB,6BAA6B,EAAE,aAAa,WAAW,QAAQ,CAAC;AAEvF,QAAM,cAAe,cAAc,aAAa,YAAa;AAC7D,SAAO,WAAW,WAAW,QAAQ,OAAO,CAAC;AAC/C;AAeO,SAAS,4BAA4B,aAAqB,WAAmB,UAAU,GAAW;AACvG,SAAO,gBAAgB,+BAA+B,EAAE,aAAa,WAAW,QAAQ,CAAC;AAEzF,QAAM,cAAe,cAAc,aAAa,cAAe;AAC/D,SAAO,WAAW,WAAW,QAAQ,OAAO,CAAC;AAC/C;",
   "names": []
 }

package/dist/main.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=main.test.d.ts.map

package/dist/main.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.test.d.ts","sourceRoot":"","sources":["../src/main.test.js"],"names":[],"mappings":""}

package/docs/README.md

@@ -0,0 +1,10 @@
+# @nexim/financial-calculate
+
+## Functions
+
+| Function                                                                | Description                                                                                  |
+| ----------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| [calculateDiscountAmount](functions/calculateDiscountAmount.md)         | Calculate the discount amount from the original price.                                       |
+| [calculateDiscountedPrice](functions/calculateDiscountedPrice.md)       | Calculate the price after applying a discount.                                               |
+| [calculatePercentageDiscount](functions/calculatePercentageDiscount.md) | Calculates the discount percentage between the market price and the sale price for discount. |
+| [calculatePercentageProfit](functions/calculatePercentageProfit.md)     | Calculates the discount percentage between the market price and the sale price for profit.   |

package/docs/functions/calculateDiscountAmount.md

@@ -0,0 +1,25 @@
+[@nexim/financial-calculate](../README.md) / calculateDiscountAmount
+
+# Function: calculateDiscountAmount()
+
+> **calculateDiscountAmount**(`price`: `number`, `discount`: `number`, `decimal`: `number`): `number`
+
+Calculate the discount amount from the original price.
+
+## Parameters
+
+| Parameter  | Type     | Default value | Description                                              |
+| ---------- | -------- | ------------- | -------------------------------------------------------- |
+| `price`    | `number` | `undefined`   | The original price.                                      |
+| `discount` | `number` | `undefined`   | The discount percentage.                                 |
+| `decimal`  | `number` | `2`           | The number of decimal places to round to (default is 2). |
+
+## Returns
+
+`number`
+
+## Example
+
+```ts
+calculateDiscountAmount(100, 10, 1); // returns 10.0
+```

package/docs/functions/calculateDiscountedPrice.md

@@ -0,0 +1,25 @@
+[@nexim/financial-calculate](../README.md) / calculateDiscountedPrice
+
+# Function: calculateDiscountedPrice()
+
+> **calculateDiscountedPrice**(`price`: `number`, `discount`: `number`, `decimal`: `number`): `number`
+
+Calculate the price after applying a discount.
+
+## Parameters
+
+| Parameter  | Type     | Default value | Description                                              |
+| ---------- | -------- | ------------- | -------------------------------------------------------- |
+| `price`    | `number` | `undefined`   | The original price.                                      |
+| `discount` | `number` | `undefined`   | The discount percentage to apply.                        |
+| `decimal`  | `number` | `2`           | The number of decimal places to round to (default is 2). |
+
+## Returns
+
+`number`
+
+## Example
+
+```ts
+calculateDiscountedPrice(100, 10, 1); // returns 90.0
+```

package/docs/functions/calculatePercentageDiscount.md

@@ -0,0 +1,26 @@
+[@nexim/financial-calculate](../README.md) / calculatePercentageDiscount
+
+# Function: calculatePercentageDiscount()
+
+> **calculatePercentageDiscount**(`marketPrice`: `number`, `salePrice`: `number`, `decimal`: `number`): `number`
+
+Calculates the discount percentage between the market price and the sale price for discount.
+
+## Parameters
+
+| Parameter     | Type     | Default value | Description                                                                           |
+| ------------- | -------- | ------------- | ------------------------------------------------------------------------------------- |
+| `marketPrice` | `number` | `undefined`   | The original market price of the item.                                                |
+| `salePrice`   | `number` | `undefined`   | The sale price of the item.                                                           |
+| `decimal`     | `number` | `2`           | The number of decimal places to round the result to(optional with default value = 2). |
+
+## Returns
+
+`number`
+
+## Example
+
+```ts
+calculatePercentageDiscount(100, 80); // Returns 20.00
+calculatePercentageDiscount(100, 80, 1, false); // Returns 25.0
+```

package/docs/functions/calculatePercentageProfit.md

@@ -0,0 +1,26 @@
+[@nexim/financial-calculate](../README.md) / calculatePercentageProfit
+
+# Function: calculatePercentageProfit()
+
+> **calculatePercentageProfit**(`marketPrice`: `number`, `salePrice`: `number`, `decimal`: `number`): `number`
+
+Calculates the discount percentage between the market price and the sale price for profit.
+
+## Parameters
+
+| Parameter     | Type     | Default value | Description                                                                           |
+| ------------- | -------- | ------------- | ------------------------------------------------------------------------------------- |
+| `marketPrice` | `number` | `undefined`   | The original market price of the item.                                                |
+| `salePrice`   | `number` | `undefined`   | The sale price of the item.                                                           |
+| `decimal`     | `number` | `2`           | The number of decimal places to round the result to(optional with default value = 2). |
+
+## Returns
+
+`number`
+
+## Example
+
+```ts
+calculatePercentageProfit(100, 80); // Returns 20.00
+calculatePercentageProfit(100, 80, 1, false); // Returns 25.0
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nexim/financial-calculate",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0",
   "description": "Provides a set of utils to handle common financial operations.",
   "keywords": [
     "financial",
@@ -40,20 +40,24 @@
   ],
   "scripts": {
     "build": "wireit",
+    "doc": "wireit",
     "test": "wireit",
     "watch": "wireit"
   },
   "dependencies": {
-    "@alwatr/logger": "^5.0.0",
-    "@alwatr/package-tracer": "^5.0.0"
+    "@alwatr/logger": "^5.5.2",
+    "@alwatr/package-tracer": "^5.5.2"
   },
   "devDependencies": {
-    "@alwatr/nano-build": "^5.0.0",
-    "@alwatr/type-helper": "^5.0.0",
+    "@alwatr/nano-build": "^5.5.2",
+    "@alwatr/type-helper": "^5.4.0",
     "@nexim/typescript-config": "^2.0.0",
     "ava": "^6.2.0",
-    "typescript": "^5.7.2",
-    "wireit": "^0.14.9"
+    "typedoc": "^0.28.3",
+    "typedoc-plugin-markdown": "^4.6.2",
+    "typedoc-plugin-no-inherit": "^1.6.1",
+    "typescript": "^5.8.3",
+    "wireit": "^0.14.12"
   },
   "publishConfig": {
     "access": "public"
@@ -100,7 +104,10 @@
     "watch:es": {
       "command": "nano-build --preset=module -- --watch",
       "service": true
+    },
+    "doc": {
+      "command": "typedoc"
     }
   },
-  "gitHead": "67de35829cde30ef70d87361d7f104762f6ccfd5"
+  "gitHead": "c70cf0dac578a3386bc942657a89a67d20b56ba8"
 }

package/src/main.test.js

@@ -1,39 +1,33 @@
+import {
+  calculateDiscountAmount,
+  calculateDiscountedPrice,
+  calculatePercentageDiscount,
+  calculatePercentageProfit,
+} from '@nexim/financial-calculate';
 import test from 'ava';
 
-import {calculateDiscountAmount, calculateDiscountedPrice} from '@nexim/financial-calculate';
-
-test('calculate discount from price with: 3, 4 input', (test) => {
+test('calculate discount from price', (test) => {
   test.is(calculateDiscountAmount(3, 4), 0.12);
-});
-
-test('calculateDiscountAmount(100, 10) returns 10.00', (t) => {
-  t.is(calculateDiscountAmount(100, 10), 10);
-});
-
-test('calculate price from discount with: 3, 4 input', (test) => {
-  test.is(calculateDiscountedPrice(3, 4), 2.88);
-});
-
-test('calculate discount from price with: 587, 629 input', (test) => {
+  test.is(calculateDiscountAmount(100, 10), 10);
   test.is(calculateDiscountAmount(587, 629), 3692.23);
-});
-
-test('calculate price from discount with: 587, 629 input', (test) => {
-  test.is(calculateDiscountedPrice(587, 629), -3105.23);
-});
-
-test('calculate discount from price with: 15034, 73 input', (test) => {
   test.is(calculateDiscountAmount(15034, 73), 10974.82);
+  test.is(calculateDiscountAmount(54205, 1332, 5), 722010.6);
 });
 
-test('calculate price from discount with: 15034, 73 input', (test) => {
+test('calculate price from discount', (test) => {
+  test.is(calculateDiscountedPrice(3, 4), 2.88);
+  test.is(calculateDiscountedPrice(100, 10), 90);
   test.is(calculateDiscountedPrice(15034, 73), 4059.18);
+  test.is(calculateDiscountedPrice(587, 629), -3105.23);
+  test.is(calculateDiscountedPrice(54205, 1332, 5), -667805.6);
 });
 
-test('calculate discount from price with: 54205, 1332, 5 input', (test) => {
-  test.is(calculateDiscountAmount(54205, 1332, 5), 722010.6);
+test('calculate discount percentage for profit and discount', (test) => {
+  test.is(calculatePercentageProfit(100, 80), 25);
+  test.is(calculatePercentageProfit(100, 53), 88.68);
 });
 
-test('calculate price from discount with: 54205, 1332, 5 input', (test) => {
-  test.is(calculateDiscountedPrice(54205, 1332, 5), -667805.6);
+test('calculate discount percentage for profit', (test) => {
+  test.is(calculatePercentageDiscount(100, 80, 1), 20);
+  test.is(calculatePercentageDiscount(100, 53), 47);
 });