jg-bignumber 1.0.1 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 1.1.0
+
+A fresh start: breaking changes in a minor version, once, because nothing depended on 1.0.x.
+
+### Added
+
+- `API.md`, the full API reference, generated from the TSDoc of the version it ships with, so it can be read from `node_modules` without a browser.
+
+### Changed
+
+- Errors are `Exception`s from `jg-exception` 1.1.0: the code, the data, and the cause each have their own field, nothing is encoded into the message, and `toJSON()` and `toString()` follow `jg-exception`.
+- `prettifyValue` passes an `Exception` from the processing step through unchanged, and wraps any other error in `INVALID_BIGNUMBER_FORMAT`.
+- Error messages say what failed at that step and keep the error underneath as `cause`, instead of repeating its message, so `extractMessage` prints each layer of the chain once.
+
 ## 1.0.1
 
 ### Changed
@@ -8,17 +22,11 @@
 
 ## 1.0.0
 
-The first release of `jg-bignumber`, which replaces `bignumber-utils` 1.1.0.
+The first release.
 
 ### Added
 
-- `BigNumber`, the package's own bignumber.js constructor.
-- `ERRORS`, the codes of every error the package throws.
-
-### Changed
-
-- `decimalPlaces` applies to every rounding mode, including `*_CEIL` and `*_FLOOR`.
-- `NaN` and `±Infinity` are rejected as `INVALID_VALUE`.
-- `calculateWeightedEntry` returns 0 when the amounts add up to 0.
-- The package no longer changes the global bignumber.js configuration, and it uses bignumber.js 11.
-- Errors are `Exception`s from `jg-exception`.
+- `processValue`, `prettifyValue`, and `getBigNumber`, which round, format, and convert decimal values with bignumber.js 11, with `decimalPlaces` applied to every rounding mode.
+- Calculations, such as `calculateSum`, `calculateMean`, `calculatePercentageChange`, and `calculateWeightedEntry`, which returns 0 when the amounts add up to 0.
+- `BigNumber`, the package's own bignumber.js constructor, so the global bignumber.js configuration is left alone.
+- `ERRORS`, the codes of every error the package throws. `NaN` and `±Infinity` are rejected as `INVALID_VALUE`.

package/README.md

@@ -43,25 +43,9 @@ calculateWeightedEntry([
 
 `BigNumber` is the package's own bignumber.js constructor, so creating values with it never changes the global bignumber.js configuration.
 
-## Coming from `bignumber-utils`
-
-| `bignumber-utils`                                                         | `jg-bignumber`                             |
-| ------------------------------------------------------------------------- | ------------------------------------------ |
-| `import … from 'bignumber-utils'`                                         | `import … from 'jg-bignumber'`             |
-| `import { BigNumber } from 'bignumber.js'` for values the package accepts | `import { BigNumber } from 'jg-bignumber'` |
-
-Changed behavior:
-
-- `decimalPlaces` applies to every rounding mode. The `*_CEIL` and `*_FLOOR` modes used to force 0 decimal places; pass `decimalPlaces: 0` for that.
-- `NaN` and `±Infinity` are rejected: `getBigNumber`, `processValue`, and the calculations throw `INVALID_VALUE`, and `isNumber` returns `false`.
-- Importing the package no longer changes the global bignumber.js configuration.
-- `calculateWeightedEntry` returns 0 when the amounts add up to 0, instead of failing.
-- Errors are `Exception`s from `jg-exception`, with the same codes, exported as `ERRORS`.
-- The package uses bignumber.js 11, whose `IBigNumberFormat` adds `negativeSign` and `positiveSign`.
-
 ## Documentation
 
-The full API reference is at https://jg-packages.jesusgraterol.dev/packages/jg-bignumber/.
+The full API reference ships in the package as `API.md`, generated from its TSDoc for the installed version, and is at https://jg-packages.jesusgraterol.dev/packages/jg-bignumber/.
 
 ## License
 

package/dist/calculations/calculations.d.ts

@@ -5,8 +5,10 @@ import type { IBigNumberValue, IConfig, IOutput } from '../shared/types.js';
  * @param config How the result is processed.
  * @returns The sum.
  * @example
- * calculateSum([0.1, '0.2', 0.3]); // 0.6
- * calculateSum([0.1, 0.2], { type: 'string' }); // '0.3'
+ * import { calculateSum } from 'jg-bignumber';
+ *
+ * calculateSum([0.1, '0.2', 0.3]); // => 0.6
+ * calculateSum([0.1, 0.2], { type: 'string' }); // => '0.3'
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -21,7 +23,9 @@ export declare const calculateSum: <T extends Partial<IConfig>>(values: IBigNumb
  * @param config How the result is processed.
  * @returns The smallest value.
  * @example
- * calculateMin([3, '1.5', 2]); // 1.5
+ * import { calculateMin } from 'jg-bignumber';
+ *
+ * calculateMin([3, '1.5', 2]); // => 1.5
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -36,7 +40,9 @@ export declare const calculateMin: <T extends Partial<IConfig>>(values: IBigNumb
  * @param config How the result is processed.
  * @returns The largest value.
  * @example
- * calculateMax([3, '1.5', 2]); // 3
+ * import { calculateMax } from 'jg-bignumber';
+ *
+ * calculateMax([3, '1.5', 2]); // => 3
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -51,7 +57,9 @@ export declare const calculateMax: <T extends Partial<IConfig>>(values: IBigNumb
  * @param config How the result is processed.
  * @returns The mean.
  * @example
- * calculateMean([1, 2, 4]); // 2.33
+ * import { calculateMean } from 'jg-bignumber';
+ *
+ * calculateMean([1, 2, 4]); // => 2.33
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -67,8 +75,10 @@ export declare const calculateMean: <T extends Partial<IConfig>>(values: IBigNum
  * @param config How the result is processed.
  * @returns The median.
  * @example
- * calculateMedian([5, 1, 3]); // 3
- * calculateMedian([4, 1, 3, 2]); // 2.5
+ * import { calculateMedian } from 'jg-bignumber';
+ *
+ * calculateMedian([5, 1, 3]); // => 3
+ * calculateMedian([4, 1, 3, 2]); // => 2.5
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -86,9 +96,11 @@ export declare const calculateMedian: <T extends Partial<IConfig>>(values: IBigN
  * @param config How the result is processed.
  * @returns The percentage change.
  * @example
- * calculatePercentageChange(100, 125); // 25
- * calculatePercentageChange(100, 80); // -20
- * calculatePercentageChange(100, 0); // -100
+ * import { calculatePercentageChange } from 'jg-bignumber';
+ *
+ * calculatePercentageChange(100, 125); // => 25
+ * calculatePercentageChange(100, 80); // => -20
+ * calculatePercentageChange(100, 0); // => -100
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -105,8 +117,10 @@ export declare const calculatePercentageChange: <T extends Partial<IConfig>>(old
  * @param config How the result is processed.
  * @returns The changed value.
  * @example
- * adjustByPercentage(100, 25); // 125
- * adjustByPercentage(100, -10); // 90
+ * import { adjustByPercentage } from 'jg-bignumber';
+ *
+ * adjustByPercentage(100, 25); // => 125
+ * adjustByPercentage(100, -10); // => 90
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -122,7 +136,9 @@ export declare const adjustByPercentage: <T extends Partial<IConfig>>(value: IBi
  * @param config How the result is processed.
  * @returns The percentage.
  * @example
- * calculatePercentageRepresentation(25, 200); // 12.5
+ * import { calculatePercentageRepresentation } from 'jg-bignumber';
+ *
+ * calculatePercentageRepresentation(25, 200); // => 12.5
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -139,7 +155,9 @@ export declare const calculatePercentageRepresentation: <T extends Partial<IConf
  * @param config How the result is processed.
  * @returns The amount received.
  * @example
- * calculateExchange(100, 65000, { decimalPlaces: 8 }); // 0.00153846
+ * import { calculateExchange } from 'jg-bignumber';
+ *
+ * calculateExchange(100, 65000, { decimalPlaces: 8 }); // => 0.00153846
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -155,7 +173,9 @@ export declare const calculateExchange: <T extends Partial<IConfig>>(value: IBig
  * @param config How the result is processed.
  * @returns The fee.
  * @example
- * calculateExchangeFee(1000, 0.1); // 1
+ * import { calculateExchangeFee } from 'jg-bignumber';
+ *
+ * calculateExchangeFee(1000, 0.1); // => 1
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -171,8 +191,10 @@ export declare const calculateExchangeFee: <T extends Partial<IConfig>>(value: I
  * @param config How the result is processed.
  * @returns The weighted average price.
  * @example
- * calculateWeightedEntry([[100, 2], [130, 1]]); // 110
- * calculateWeightedEntry([]); // 0
+ * import { calculateWeightedEntry } from 'jg-bignumber';
+ *
+ * calculateWeightedEntry([[100, 2], [130, 1]]); // => 110
+ * calculateWeightedEntry([]); // => 0
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason

package/dist/calculations/calculations.js

@@ -11,8 +11,10 @@ import { validatePositiveValue, validateValuesArray } from '../validations/valid
  * @param config How the result is processed.
  * @returns The sum.
  * @example
- * calculateSum([0.1, '0.2', 0.3]); // 0.6
- * calculateSum([0.1, 0.2], { type: 'string' }); // '0.3'
+ * import { calculateSum } from 'jg-bignumber';
+ *
+ * calculateSum([0.1, '0.2', 0.3]); // => 0.6
+ * calculateSum([0.1, 0.2], { type: 'string' }); // => '0.3'
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -30,7 +32,9 @@ export const calculateSum = (values, config) => {
  * @param config How the result is processed.
  * @returns The smallest value.
  * @example
- * calculateMin([3, '1.5', 2]); // 1.5
+ * import { calculateMin } from 'jg-bignumber';
+ *
+ * calculateMin([3, '1.5', 2]); // => 1.5
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -48,7 +52,9 @@ export const calculateMin = (values, config) => {
  * @param config How the result is processed.
  * @returns The largest value.
  * @example
- * calculateMax([3, '1.5', 2]); // 3
+ * import { calculateMax } from 'jg-bignumber';
+ *
+ * calculateMax([3, '1.5', 2]); // => 3
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -66,7 +72,9 @@ export const calculateMax = (values, config) => {
  * @param config How the result is processed.
  * @returns The mean.
  * @example
- * calculateMean([1, 2, 4]); // 2.33
+ * import { calculateMean } from 'jg-bignumber';
+ *
+ * calculateMean([1, 2, 4]); // => 2.33
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -88,8 +96,10 @@ export const calculateMean = (values, config) => {
  * @param config How the result is processed.
  * @returns The median.
  * @example
- * calculateMedian([5, 1, 3]); // 3
- * calculateMedian([4, 1, 3, 2]); // 2.5
+ * import { calculateMedian } from 'jg-bignumber';
+ *
+ * calculateMedian([5, 1, 3]); // => 3
+ * calculateMedian([4, 1, 3, 2]); // => 2.5
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -120,9 +130,11 @@ export const calculateMedian = (values, config) => {
  * @param config How the result is processed.
  * @returns The percentage change.
  * @example
- * calculatePercentageChange(100, 125); // 25
- * calculatePercentageChange(100, 80); // -20
- * calculatePercentageChange(100, 0); // -100
+ * import { calculatePercentageChange } from 'jg-bignumber';
+ *
+ * calculatePercentageChange(100, 125); // => 25
+ * calculatePercentageChange(100, 80); // => -20
+ * calculatePercentageChange(100, 0); // => -100
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -156,8 +168,10 @@ export const calculatePercentageChange = (oldValue, newValue, config) => {
  * @param config How the result is processed.
  * @returns The changed value.
  * @example
- * adjustByPercentage(100, 25); // 125
- * adjustByPercentage(100, -10); // 90
+ * import { adjustByPercentage } from 'jg-bignumber';
+ *
+ * adjustByPercentage(100, 25); // => 125
+ * adjustByPercentage(100, -10); // => 90
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -190,7 +204,9 @@ export const adjustByPercentage = (value, percentage, config) => {
  * @param config How the result is processed.
  * @returns The percentage.
  * @example
- * calculatePercentageRepresentation(25, 200); // 12.5
+ * import { calculatePercentageRepresentation } from 'jg-bignumber';
+ *
+ * calculatePercentageRepresentation(25, 200); // => 12.5
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -216,7 +232,9 @@ export const calculatePercentageRepresentation = (value, total, config) => {
  * @param config How the result is processed.
  * @returns The amount received.
  * @example
- * calculateExchange(100, 65000, { decimalPlaces: 8 }); // 0.00153846
+ * import { calculateExchange } from 'jg-bignumber';
+ *
+ * calculateExchange(100, 65000, { decimalPlaces: 8 }); // => 0.00153846
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -238,7 +256,9 @@ export const calculateExchange = (value, rate, config) => {
  * @param config How the result is processed.
  * @returns The fee.
  * @example
- * calculateExchangeFee(1000, 0.1); // 1
+ * import { calculateExchangeFee } from 'jg-bignumber';
+ *
+ * calculateExchangeFee(1000, 0.1); // => 1
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -260,8 +280,10 @@ export const calculateExchangeFee = (value, feePercentage, config) => {
  * @param config How the result is processed.
  * @returns The weighted average price.
  * @example
- * calculateWeightedEntry([[100, 2], [130, 1]]); // 110
- * calculateWeightedEntry([]); // 0
+ * import { calculateWeightedEntry } from 'jg-bignumber';
+ *
+ * calculateWeightedEntry([[100, 2], [130, 1]]); // => 110
+ * calculateWeightedEntry([]); // => 0
  * @throws
  * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason

package/dist/calculations/calculations.js.map

@@ -1 +1 @@
-{"version":3,"file":"calculations.js","sourceRoot":"","sources":["../../src/calculations/calculations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAEnD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AACzE,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAE3F;;GAEG;AAEH;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,MAAyB,EACzB,MAAU,EACE,EAAE;IACd,mBAAmB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC5C,OAAO,YAAY,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAChF,CAAC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,MAAyB,EACzB,MAAU,EACE,EAAE;IACd,mBAAmB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC5C,OAAO,YAAY,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAChF,CAAC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,MAAyB,EACzB,MAAU,EACE,EAAE;IACd,mBAAmB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC5C,OAAO,YAAY,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAChF,CAAC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,MAAyB,EACzB,MAAU,EACE,EAAE;IACd,mBAAmB,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC7C,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;IACjF,CAAC;IACD,OAAO,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AACjC,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,MAAyB,EACzB,MAAU,EACE,EAAE;IACd,mBAAmB,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC/C,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACjC,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC3C,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpE,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAe,CAAC;IAC1C,MAAM,MAAM,GACV,MAAM,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAE,MAAM,CAAC,IAAI,GAAG,CAAC,CAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAChG,OAAO,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF;;GAEG;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACvC,QAAyB,EACzB,QAAyB,EACzB,MAAU,EACE,EAAE;IACd,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;IAC1C,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;IAC1C,qBAAqB,CAAC,UAAU,CAAC,CAAC;IAElC,IAAI,MAAkB,CAAC;IACvB,IAAI,UAAU,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;QACzC,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACzE,CAAC;SAAM,IAAI,UAAU,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;QAChD,MAAM,GAAG,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;YAClC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE;YACzE,CAAC,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;IACD,OAAO,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,KAAsB,EACtB,UAA2B,EAC3B,MAAU,EACE,EAAE;IACd,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACpC,MAAM,YAAY,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;IAC9C,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAE/B,IAAI,QAAoB,CAAC;IACzB,IAAI,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;QAClC,QAAQ,GAAG,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAChE,CAAC;SAAM,IAAI,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QACtC,QAAQ,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC;YACzC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACzE,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACtB,CAAC;SAAM,CAAC;QACN,QAAQ,GAAG,OAAO,CAAC;IACrB,CAAC;IACD,OAAO,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AACxC,CAAC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAC/C,KAAsB,EACtB,KAAsB,EACtB,MAAU,EACE,EAAE;IACd,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACpC,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACpC,qBAAqB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACrC,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAC/B,OAAO,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;AACrE,CAAC,CAAC;AAEF;;GAEG;AAEH;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,KAAsB,EACtB,IAAqB,EACrB,MAAU,EACE,EAAE;IACd,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACpC,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAClC,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAC/B,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAC9B,OAAO,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,KAAsB,EACtB,aAA8B,EAC9B,MAAU,EACE,EAAE;IACd,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACpC,MAAM,eAAe,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC;IACpD,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAC/B,qBAAqB,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IAC7C,OAAO,YAAY,CAAC,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;AAC7E,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,MAA4C,EAC5C,MAAU,EACE,EAAE;IACd,mBAAmB,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IACtD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,gBAAgB,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;IACvC,IAAI,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;IAClC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE;QACjC,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;QACtC,gBAAgB,GAAG,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC9E,WAAW,GAAG,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IACH,IAAI,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC;QACzB,OAAO,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,YAAY,CAAC,gBAAgB,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC;AACvE,CAAC,CAAC","sourcesContent":["import { BigNumber } from '../shared/constants.js';\nimport type { IBigNumber, IBigNumberValue, IConfig, IOutput } from '../shared/types.js';\nimport { getBigNumber, processValue } from '../processing/processing.js';\nimport { sortBigNumbers } from '../utils/utils.js';\nimport { validatePositiveValue, validateValuesArray } from '../validations/validations.js';\n\n/*\n * Essential calculations\n */\n\n/**\n * Adds up a list of values. An empty list sums to 0.\n * @param values The values.\n * @param config How the result is processed.\n * @returns The sum.\n * @example\n * calculateSum([0.1, '0.2', 0.3]); // 0.6\n * calculateSum([0.1, 0.2], { type: 'string' }); // '0.3'\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - INVALID_VALUES_ARRAY: if the provided values arg is not a valid array\n */\nexport const calculateSum = <T extends Partial<IConfig>>(\n  values: IBigNumberValue[],\n  config?: T,\n): IOutput<T> => {\n  validateValuesArray(values, 'calculateSum');\n  return processValue(values.length > 0 ? BigNumber.sum(...values) : 0, config);\n};\n\n/**\n * Finds the smallest value in a list. An empty list returns 0.\n * @param values The values.\n * @param config How the result is processed.\n * @returns The smallest value.\n * @example\n * calculateMin([3, '1.5', 2]); // 1.5\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - INVALID_VALUES_ARRAY: if the provided values arg is not a valid array\n */\nexport const calculateMin = <T extends Partial<IConfig>>(\n  values: IBigNumberValue[],\n  config?: T,\n): IOutput<T> => {\n  validateValuesArray(values, 'calculateMin');\n  return processValue(values.length > 0 ? BigNumber.min(...values) : 0, config);\n};\n\n/**\n * Finds the largest value in a list. An empty list returns 0.\n * @param values The values.\n * @param config How the result is processed.\n * @returns The largest value.\n * @example\n * calculateMax([3, '1.5', 2]); // 3\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - INVALID_VALUES_ARRAY: if the provided values arg is not a valid array\n */\nexport const calculateMax = <T extends Partial<IConfig>>(\n  values: IBigNumberValue[],\n  config?: T,\n): IOutput<T> => {\n  validateValuesArray(values, 'calculateMax');\n  return processValue(values.length > 0 ? BigNumber.max(...values) : 0, config);\n};\n\n/**\n * Calculates the mean of a list of values. An empty list returns 0.\n * @param values The values.\n * @param config How the result is processed.\n * @returns The mean.\n * @example\n * calculateMean([1, 2, 4]); // 2.33\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - INVALID_VALUES_ARRAY: if the provided values arg is not a valid array\n */\nexport const calculateMean = <T extends Partial<IConfig>>(\n  values: IBigNumberValue[],\n  config?: T,\n): IOutput<T> => {\n  validateValuesArray(values, 'calculateMean');\n  if (values.length > 0) {\n    return processValue(BigNumber.sum(...values).dividedBy(values.length), config);\n  }\n  return processValue(0, config);\n};\n\n/**\n * Calculates the median of a list of values: the middle value, or the mean of the two middle\n * values when the list has an even length. An empty list returns 0.\n * @param values The values.\n * @param config How the result is processed.\n * @returns The median.\n * @example\n * calculateMedian([5, 1, 3]); // 3\n * calculateMedian([4, 1, 3, 2]); // 2.5\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - INVALID_VALUES_ARRAY: if the provided values arg is not a valid array\n */\nexport const calculateMedian = <T extends Partial<IConfig>>(\n  values: IBigNumberValue[],\n  config?: T,\n): IOutput<T> => {\n  validateValuesArray(values, 'calculateMedian');\n  if (values.length === 0) {\n    return processValue(0, config);\n  }\n  const half = Math.floor(values.length / 2);\n  const sorted = values.map(getBigNumber).sort(sortBigNumbers('asc'));\n  const middle = sorted[half] as IBigNumber;\n  const median =\n    values.length % 2 === 1 ? middle : (sorted[half - 1] as IBigNumber).plus(middle).dividedBy(2);\n  return processValue(median, config);\n};\n\n/*\n * Percentage calculations\n */\n\n/**\n * Calculates the percentage a value changed by: positive when it increased, negative when it\n * decreased, and 0 when it didn't change. The largest decrease is -100%, returned whenever the new\n * value is 0 or less.\n * @param oldValue The value before the change.\n * @param newValue The value after the change.\n * @param config How the result is processed.\n * @returns The percentage change.\n * @example\n * calculatePercentageChange(100, 125); // 25\n * calculatePercentageChange(100, 80); // -20\n * calculatePercentageChange(100, 0); // -100\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - NEGATIVE_VALUE_NOT_ALLOWED: if the oldValue is not positive\n */\nexport const calculatePercentageChange = <T extends Partial<IConfig>>(\n  oldValue: IBigNumberValue,\n  newValue: IBigNumberValue,\n  config?: T,\n): IOutput<T> => {\n  const oldValueBN = getBigNumber(oldValue);\n  const newValueBN = getBigNumber(newValue);\n  validatePositiveValue(oldValueBN);\n\n  let change: IBigNumber;\n  if (newValueBN.isGreaterThan(oldValueBN)) {\n    change = newValueBN.minus(oldValueBN).dividedBy(oldValueBN).times(100);\n  } else if (oldValueBN.isGreaterThan(newValueBN)) {\n    change = newValueBN.isGreaterThan(0)\n      ? oldValueBN.minus(newValueBN).dividedBy(oldValueBN).times(100).negated()\n      : getBigNumber(-100);\n  } else {\n    change = getBigNumber(0);\n  }\n  return processValue(change, config);\n};\n\n/**\n * Changes a value by a percentage: a positive percentage increases it, and a negative one\n * decreases it, to 0 at most.\n * @param value The value to change.\n * @param percentage The percentage to change it by.\n * @param config How the result is processed.\n * @returns The changed value.\n * @example\n * adjustByPercentage(100, 25); // 125\n * adjustByPercentage(100, -10); // 90\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - NEGATIVE_VALUE_NOT_ALLOWED: if the value is not positive\n */\nexport const adjustByPercentage = <T extends Partial<IConfig>>(\n  value: IBigNumberValue,\n  percentage: IBigNumberValue,\n  config?: T,\n): IOutput<T> => {\n  const valueBN = getBigNumber(value);\n  const percentageBN = getBigNumber(percentage);\n  validatePositiveValue(valueBN);\n\n  let adjusted: IBigNumber;\n  if (percentageBN.isGreaterThan(0)) {\n    adjusted = percentageBN.dividedBy(100).plus(1).times(valueBN);\n  } else if (percentageBN.isLessThan(0)) {\n    adjusted = percentageBN.isGreaterThan(-100)\n      ? percentageBN.times(-1).dividedBy(100).minus(1).times(valueBN).times(-1)\n      : getBigNumber(0);\n  } else {\n    adjusted = valueBN;\n  }\n  return processValue(adjusted, config);\n};\n\n/**\n * Calculates what percentage of a total a value represents.\n * @param value The part.\n * @param total The total.\n * @param config How the result is processed.\n * @returns The percentage.\n * @example\n * calculatePercentageRepresentation(25, 200); // 12.5\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - NEGATIVE_VALUE_NOT_ALLOWED: if the value or total are not positive\n */\nexport const calculatePercentageRepresentation = <T extends Partial<IConfig>>(\n  value: IBigNumberValue,\n  total: IBigNumberValue,\n  config?: T,\n): IOutput<T> => {\n  const valueBN = getBigNumber(value);\n  const totalBN = getBigNumber(total);\n  validatePositiveValue(valueBN, true);\n  validatePositiveValue(totalBN);\n  return processValue(valueBN.times(100).dividedBy(totalBN), config);\n};\n\n/*\n * Financial calculations\n */\n\n/**\n * Calculates the amount of an asset an exchange gives for a value at a rate, such as how much\n * BTC 100 USDT buys at 65,000 USDT per BTC.\n * @param value The amount being exchanged.\n * @param rate The price of one unit of the asset received.\n * @param config How the result is processed.\n * @returns The amount received.\n * @example\n * calculateExchange(100, 65000, { decimalPlaces: 8 }); // 0.00153846\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - NEGATIVE_VALUE_NOT_ALLOWED: if the value or rate are not positive\n */\nexport const calculateExchange = <T extends Partial<IConfig>>(\n  value: IBigNumberValue,\n  rate: IBigNumberValue,\n  config?: T,\n): IOutput<T> => {\n  const valueBN = getBigNumber(value);\n  const rateBN = getBigNumber(rate);\n  validatePositiveValue(valueBN);\n  validatePositiveValue(rateBN);\n  return processValue(valueBN.dividedBy(rateBN), config);\n};\n\n/**\n * Calculates the fee charged for an exchange, as a percentage of the value exchanged.\n * @param value The amount being exchanged.\n * @param feePercentage The fee, as a percentage.\n * @param config How the result is processed.\n * @returns The fee.\n * @example\n * calculateExchangeFee(1000, 0.1); // 1\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - NEGATIVE_VALUE_NOT_ALLOWED: if the value or feePercentage are not positive\n */\nexport const calculateExchangeFee = <T extends Partial<IConfig>>(\n  value: IBigNumberValue,\n  feePercentage: IBigNumberValue,\n  config?: T,\n): IOutput<T> => {\n  const valueBN = getBigNumber(value);\n  const feePercentageBN = getBigNumber(feePercentage);\n  validatePositiveValue(valueBN);\n  validatePositiveValue(feePercentageBN, true);\n  return processValue(feePercentageBN.times(valueBN).dividedBy(100), config);\n};\n\n/**\n * Calculates the average entry price of a position bought in several trades, weighting each price\n * by the amount bought. An empty list, or one whose amounts add up to 0, returns 0.\n * @param trades The trades, each as a `[price, amount]` tuple.\n * @param config How the result is processed.\n * @returns The weighted average price.\n * @example\n * calculateWeightedEntry([[100, 2], [130, 1]]); // 110\n * calculateWeightedEntry([]); // 0\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - INVALID_VALUES_ARRAY: if the provided values arg is not a valid array\n */\nexport const calculateWeightedEntry = <T extends Partial<IConfig>>(\n  trades: [IBigNumberValue, IBigNumberValue][],\n  config?: T,\n): IOutput<T> => {\n  validateValuesArray(trades, 'calculateWeightedEntry');\n  if (trades.length === 0) {\n    return processValue(0, config);\n  }\n  let priceTimesShares = getBigNumber(0);\n  let totalShares = getBigNumber(0);\n  trades.forEach(([price, amount]) => {\n    const amountBN = getBigNumber(amount);\n    priceTimesShares = priceTimesShares.plus(getBigNumber(price).times(amountBN));\n    totalShares = totalShares.plus(amountBN);\n  });\n  if (totalShares.isZero()) {\n    return processValue(0, config);\n  }\n  return processValue(priceTimesShares.dividedBy(totalShares), config);\n};\n"]}
+{"version":3,"file":"calculations.js","sourceRoot":"","sources":["../../src/calculations/calculations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAEnD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AACzE,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAE3F;;GAEG;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,MAAyB,EACzB,MAAU,EACE,EAAE;IACd,mBAAmB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC5C,OAAO,YAAY,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAChF,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,MAAyB,EACzB,MAAU,EACE,EAAE;IACd,mBAAmB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC5C,OAAO,YAAY,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAChF,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,MAAyB,EACzB,MAAU,EACE,EAAE;IACd,mBAAmB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC5C,OAAO,YAAY,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAChF,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,MAAyB,EACzB,MAAU,EACE,EAAE;IACd,mBAAmB,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC7C,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;IACjF,CAAC;IACD,OAAO,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AACjC,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,MAAyB,EACzB,MAAU,EACE,EAAE;IACd,mBAAmB,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC/C,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACjC,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC3C,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpE,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAe,CAAC;IAC1C,MAAM,MAAM,GACV,MAAM,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAE,MAAM,CAAC,IAAI,GAAG,CAAC,CAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAChG,OAAO,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF;;GAEG;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACvC,QAAyB,EACzB,QAAyB,EACzB,MAAU,EACE,EAAE;IACd,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;IAC1C,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;IAC1C,qBAAqB,CAAC,UAAU,CAAC,CAAC;IAElC,IAAI,MAAkB,CAAC;IACvB,IAAI,UAAU,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;QACzC,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACzE,CAAC;SAAM,IAAI,UAAU,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;QAChD,MAAM,GAAG,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;YAClC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE;YACzE,CAAC,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;IACD,OAAO,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,KAAsB,EACtB,UAA2B,EAC3B,MAAU,EACE,EAAE;IACd,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACpC,MAAM,YAAY,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;IAC9C,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAE/B,IAAI,QAAoB,CAAC;IACzB,IAAI,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;QAClC,QAAQ,GAAG,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAChE,CAAC;SAAM,IAAI,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QACtC,QAAQ,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC;YACzC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACzE,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACtB,CAAC;SAAM,CAAC;QACN,QAAQ,GAAG,OAAO,CAAC;IACrB,CAAC;IACD,OAAO,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AACxC,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAC/C,KAAsB,EACtB,KAAsB,EACtB,MAAU,EACE,EAAE;IACd,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACpC,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACpC,qBAAqB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACrC,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAC/B,OAAO,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;AACrE,CAAC,CAAC;AAEF;;GAEG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,KAAsB,EACtB,IAAqB,EACrB,MAAU,EACE,EAAE;IACd,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACpC,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAClC,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAC/B,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAC9B,OAAO,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,KAAsB,EACtB,aAA8B,EAC9B,MAAU,EACE,EAAE;IACd,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACpC,MAAM,eAAe,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC;IACpD,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAC/B,qBAAqB,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IAC7C,OAAO,YAAY,CAAC,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;AAC7E,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,MAA4C,EAC5C,MAAU,EACE,EAAE;IACd,mBAAmB,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IACtD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,gBAAgB,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;IACvC,IAAI,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;IAClC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE;QACjC,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;QACtC,gBAAgB,GAAG,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC9E,WAAW,GAAG,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IACH,IAAI,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC;QACzB,OAAO,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,YAAY,CAAC,gBAAgB,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC;AACvE,CAAC,CAAC","sourcesContent":["import { BigNumber } from '../shared/constants.js';\nimport type { IBigNumber, IBigNumberValue, IConfig, IOutput } from '../shared/types.js';\nimport { getBigNumber, processValue } from '../processing/processing.js';\nimport { sortBigNumbers } from '../utils/utils.js';\nimport { validatePositiveValue, validateValuesArray } from '../validations/validations.js';\n\n/*\n * Essential calculations\n */\n\n/**\n * Adds up a list of values. An empty list sums to 0.\n * @param values The values.\n * @param config How the result is processed.\n * @returns The sum.\n * @example\n * import { calculateSum } from 'jg-bignumber';\n *\n * calculateSum([0.1, '0.2', 0.3]); // => 0.6\n * calculateSum([0.1, 0.2], { type: 'string' }); // => '0.3'\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - INVALID_VALUES_ARRAY: if the provided values arg is not a valid array\n */\nexport const calculateSum = <T extends Partial<IConfig>>(\n  values: IBigNumberValue[],\n  config?: T,\n): IOutput<T> => {\n  validateValuesArray(values, 'calculateSum');\n  return processValue(values.length > 0 ? BigNumber.sum(...values) : 0, config);\n};\n\n/**\n * Finds the smallest value in a list. An empty list returns 0.\n * @param values The values.\n * @param config How the result is processed.\n * @returns The smallest value.\n * @example\n * import { calculateMin } from 'jg-bignumber';\n *\n * calculateMin([3, '1.5', 2]); // => 1.5\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - INVALID_VALUES_ARRAY: if the provided values arg is not a valid array\n */\nexport const calculateMin = <T extends Partial<IConfig>>(\n  values: IBigNumberValue[],\n  config?: T,\n): IOutput<T> => {\n  validateValuesArray(values, 'calculateMin');\n  return processValue(values.length > 0 ? BigNumber.min(...values) : 0, config);\n};\n\n/**\n * Finds the largest value in a list. An empty list returns 0.\n * @param values The values.\n * @param config How the result is processed.\n * @returns The largest value.\n * @example\n * import { calculateMax } from 'jg-bignumber';\n *\n * calculateMax([3, '1.5', 2]); // => 3\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - INVALID_VALUES_ARRAY: if the provided values arg is not a valid array\n */\nexport const calculateMax = <T extends Partial<IConfig>>(\n  values: IBigNumberValue[],\n  config?: T,\n): IOutput<T> => {\n  validateValuesArray(values, 'calculateMax');\n  return processValue(values.length > 0 ? BigNumber.max(...values) : 0, config);\n};\n\n/**\n * Calculates the mean of a list of values. An empty list returns 0.\n * @param values The values.\n * @param config How the result is processed.\n * @returns The mean.\n * @example\n * import { calculateMean } from 'jg-bignumber';\n *\n * calculateMean([1, 2, 4]); // => 2.33\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - INVALID_VALUES_ARRAY: if the provided values arg is not a valid array\n */\nexport const calculateMean = <T extends Partial<IConfig>>(\n  values: IBigNumberValue[],\n  config?: T,\n): IOutput<T> => {\n  validateValuesArray(values, 'calculateMean');\n  if (values.length > 0) {\n    return processValue(BigNumber.sum(...values).dividedBy(values.length), config);\n  }\n  return processValue(0, config);\n};\n\n/**\n * Calculates the median of a list of values: the middle value, or the mean of the two middle\n * values when the list has an even length. An empty list returns 0.\n * @param values The values.\n * @param config How the result is processed.\n * @returns The median.\n * @example\n * import { calculateMedian } from 'jg-bignumber';\n *\n * calculateMedian([5, 1, 3]); // => 3\n * calculateMedian([4, 1, 3, 2]); // => 2.5\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - INVALID_VALUES_ARRAY: if the provided values arg is not a valid array\n */\nexport const calculateMedian = <T extends Partial<IConfig>>(\n  values: IBigNumberValue[],\n  config?: T,\n): IOutput<T> => {\n  validateValuesArray(values, 'calculateMedian');\n  if (values.length === 0) {\n    return processValue(0, config);\n  }\n  const half = Math.floor(values.length / 2);\n  const sorted = values.map(getBigNumber).sort(sortBigNumbers('asc'));\n  const middle = sorted[half] as IBigNumber;\n  const median =\n    values.length % 2 === 1 ? middle : (sorted[half - 1] as IBigNumber).plus(middle).dividedBy(2);\n  return processValue(median, config);\n};\n\n/*\n * Percentage calculations\n */\n\n/**\n * Calculates the percentage a value changed by: positive when it increased, negative when it\n * decreased, and 0 when it didn't change. The largest decrease is -100%, returned whenever the new\n * value is 0 or less.\n * @param oldValue The value before the change.\n * @param newValue The value after the change.\n * @param config How the result is processed.\n * @returns The percentage change.\n * @example\n * import { calculatePercentageChange } from 'jg-bignumber';\n *\n * calculatePercentageChange(100, 125); // => 25\n * calculatePercentageChange(100, 80); // => -20\n * calculatePercentageChange(100, 0); // => -100\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - NEGATIVE_VALUE_NOT_ALLOWED: if the oldValue is not positive\n */\nexport const calculatePercentageChange = <T extends Partial<IConfig>>(\n  oldValue: IBigNumberValue,\n  newValue: IBigNumberValue,\n  config?: T,\n): IOutput<T> => {\n  const oldValueBN = getBigNumber(oldValue);\n  const newValueBN = getBigNumber(newValue);\n  validatePositiveValue(oldValueBN);\n\n  let change: IBigNumber;\n  if (newValueBN.isGreaterThan(oldValueBN)) {\n    change = newValueBN.minus(oldValueBN).dividedBy(oldValueBN).times(100);\n  } else if (oldValueBN.isGreaterThan(newValueBN)) {\n    change = newValueBN.isGreaterThan(0)\n      ? oldValueBN.minus(newValueBN).dividedBy(oldValueBN).times(100).negated()\n      : getBigNumber(-100);\n  } else {\n    change = getBigNumber(0);\n  }\n  return processValue(change, config);\n};\n\n/**\n * Changes a value by a percentage: a positive percentage increases it, and a negative one\n * decreases it, to 0 at most.\n * @param value The value to change.\n * @param percentage The percentage to change it by.\n * @param config How the result is processed.\n * @returns The changed value.\n * @example\n * import { adjustByPercentage } from 'jg-bignumber';\n *\n * adjustByPercentage(100, 25); // => 125\n * adjustByPercentage(100, -10); // => 90\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - NEGATIVE_VALUE_NOT_ALLOWED: if the value is not positive\n */\nexport const adjustByPercentage = <T extends Partial<IConfig>>(\n  value: IBigNumberValue,\n  percentage: IBigNumberValue,\n  config?: T,\n): IOutput<T> => {\n  const valueBN = getBigNumber(value);\n  const percentageBN = getBigNumber(percentage);\n  validatePositiveValue(valueBN);\n\n  let adjusted: IBigNumber;\n  if (percentageBN.isGreaterThan(0)) {\n    adjusted = percentageBN.dividedBy(100).plus(1).times(valueBN);\n  } else if (percentageBN.isLessThan(0)) {\n    adjusted = percentageBN.isGreaterThan(-100)\n      ? percentageBN.times(-1).dividedBy(100).minus(1).times(valueBN).times(-1)\n      : getBigNumber(0);\n  } else {\n    adjusted = valueBN;\n  }\n  return processValue(adjusted, config);\n};\n\n/**\n * Calculates what percentage of a total a value represents.\n * @param value The part.\n * @param total The total.\n * @param config How the result is processed.\n * @returns The percentage.\n * @example\n * import { calculatePercentageRepresentation } from 'jg-bignumber';\n *\n * calculatePercentageRepresentation(25, 200); // => 12.5\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - NEGATIVE_VALUE_NOT_ALLOWED: if the value or total are not positive\n */\nexport const calculatePercentageRepresentation = <T extends Partial<IConfig>>(\n  value: IBigNumberValue,\n  total: IBigNumberValue,\n  config?: T,\n): IOutput<T> => {\n  const valueBN = getBigNumber(value);\n  const totalBN = getBigNumber(total);\n  validatePositiveValue(valueBN, true);\n  validatePositiveValue(totalBN);\n  return processValue(valueBN.times(100).dividedBy(totalBN), config);\n};\n\n/*\n * Financial calculations\n */\n\n/**\n * Calculates the amount of an asset an exchange gives for a value at a rate, such as how much\n * BTC 100 USDT buys at 65,000 USDT per BTC.\n * @param value The amount being exchanged.\n * @param rate The price of one unit of the asset received.\n * @param config How the result is processed.\n * @returns The amount received.\n * @example\n * import { calculateExchange } from 'jg-bignumber';\n *\n * calculateExchange(100, 65000, { decimalPlaces: 8 }); // => 0.00153846\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - NEGATIVE_VALUE_NOT_ALLOWED: if the value or rate are not positive\n */\nexport const calculateExchange = <T extends Partial<IConfig>>(\n  value: IBigNumberValue,\n  rate: IBigNumberValue,\n  config?: T,\n): IOutput<T> => {\n  const valueBN = getBigNumber(value);\n  const rateBN = getBigNumber(rate);\n  validatePositiveValue(valueBN);\n  validatePositiveValue(rateBN);\n  return processValue(valueBN.dividedBy(rateBN), config);\n};\n\n/**\n * Calculates the fee charged for an exchange, as a percentage of the value exchanged.\n * @param value The amount being exchanged.\n * @param feePercentage The fee, as a percentage.\n * @param config How the result is processed.\n * @returns The fee.\n * @example\n * import { calculateExchangeFee } from 'jg-bignumber';\n *\n * calculateExchangeFee(1000, 0.1); // => 1\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - NEGATIVE_VALUE_NOT_ALLOWED: if the value or feePercentage are not positive\n */\nexport const calculateExchangeFee = <T extends Partial<IConfig>>(\n  value: IBigNumberValue,\n  feePercentage: IBigNumberValue,\n  config?: T,\n): IOutput<T> => {\n  const valueBN = getBigNumber(value);\n  const feePercentageBN = getBigNumber(feePercentage);\n  validatePositiveValue(valueBN);\n  validatePositiveValue(feePercentageBN, true);\n  return processValue(feePercentageBN.times(valueBN).dividedBy(100), config);\n};\n\n/**\n * Calculates the average entry price of a position bought in several trades, weighting each price\n * by the amount bought. An empty list, or one whose amounts add up to 0, returns 0.\n * @param trades The trades, each as a `[price, amount]` tuple.\n * @param config How the result is processed.\n * @returns The weighted average price.\n * @example\n * import { calculateWeightedEntry } from 'jg-bignumber';\n *\n * calculateWeightedEntry([[100, 2], [130, 1]]); // => 110\n * calculateWeightedEntry([]); // => 0\n * @throws\n * - INVALID_VALUE: if any of the given values isn't a finite number or BigNumber throws an error\n * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason\n * - INVALID_ROUNDING_MODE: if the rounding mode name is not supported\n * - INVALID_TYPE: if the processing type is not supported\n * - INVALID_VALUES_ARRAY: if the provided values arg is not a valid array\n */\nexport const calculateWeightedEntry = <T extends Partial<IConfig>>(\n  trades: [IBigNumberValue, IBigNumberValue][],\n  config?: T,\n): IOutput<T> => {\n  validateValuesArray(trades, 'calculateWeightedEntry');\n  if (trades.length === 0) {\n    return processValue(0, config);\n  }\n  let priceTimesShares = getBigNumber(0);\n  let totalShares = getBigNumber(0);\n  trades.forEach(([price, amount]) => {\n    const amountBN = getBigNumber(amount);\n    priceTimesShares = priceTimesShares.plus(getBigNumber(price).times(amountBN));\n    totalShares = totalShares.plus(amountBN);\n  });\n  if (totalShares.isZero()) {\n    return processValue(0, config);\n  }\n  return processValue(priceTimesShares.dividedBy(totalShares), config);\n};\n"]}

package/dist/processing/processing.d.ts

@@ -5,8 +5,9 @@ import type { IBigNumber, IBigNumberFormat, IBigNumberValue, IConfig, IOutput }
  * @param value The value.
  * @returns The BigNumber.
  * @example
- * getBigNumber('0.1').plus('0.2').toString(); // '0.3'
- * getBigNumber(Infinity); // throws INVALID_VALUE
+ * import { getBigNumber } from 'jg-bignumber';
+ *
+ * getBigNumber('0.1').plus('0.2').toString(); // => '0.3'
  * @throws
  * - INVALID_VALUE: if the value isn't a finite number or BigNumber throws an error
  */
@@ -18,9 +19,11 @@ export declare const getBigNumber: (value: IBigNumberValue) => IBigNumber;
  * @param configuration The decimal places, rounding mode, and output type.
  * @returns The processed value.
  * @example
- * processValue(512.155); // 512.16
- * processValue(512.155, { decimalPlaces: 1, roundingMode: 'ROUND_FLOOR' }); // 512.1
- * processValue('0.000001', { decimalPlaces: 6, type: 'string' }); // '0.000001'
+ * import { processValue } from 'jg-bignumber';
+ *
+ * processValue(512.155); // => 512.16
+ * processValue(512.155, { decimalPlaces: 1, roundingMode: 'ROUND_FLOOR' }); // => 512.1
+ * processValue('0.000001', { decimalPlaces: 6, type: 'string' }); // => '0.000001'
  * @throws
  * - INVALID_VALUE: if the value isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -34,8 +37,10 @@ export declare const processValue: <T extends Partial<IConfig>>(value: IBigNumbe
  * @param config How the value is processed and formatted.
  * @returns The formatted value.
  * @example
- * prettifyValue(1234567.891); // '1,234,567.89'
- * prettifyValue(1234.5, { processing: { decimalPlaces: 2 }, format: { prefix: '$' } }); // '$1,234.5'
+ * import { prettifyValue } from 'jg-bignumber';
+ *
+ * prettifyValue(1234567.891); // => '1,234,567.89'
+ * prettifyValue(1234.5, { processing: { decimalPlaces: 2 }, format: { prefix: '$' } }); // => '$1,234.5'
  * @throws
  * - INVALID_VALUE: if the value isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -53,8 +58,10 @@ export declare const prettifyValue: (value: IBigNumberValue, config?: {
  * @param value The value.
  * @returns Whether it's a BigNumber.
  * @example
- * isBigNumber(getBigNumber(1)); // true
- * isBigNumber(1); // false
+ * import { getBigNumber, isBigNumber } from 'jg-bignumber';
+ *
+ * isBigNumber(getBigNumber(1)); // => true
+ * isBigNumber(1); // => false
  */
 export declare const isBigNumber: (value: unknown) => value is IBigNumber;
 /**
@@ -62,9 +69,11 @@ export declare const isBigNumber: (value: unknown) => value is IBigNumber;
  * @param value The value.
  * @returns Whether it's a finite number.
  * @example
- * isNumber('12.5'); // true
- * isNumber(Infinity); // false
- * isNumber('abc'); // false
+ * import { isNumber } from 'jg-bignumber';
+ *
+ * isNumber('12.5'); // => true
+ * isNumber(Infinity); // => false
+ * isNumber('abc'); // => false
  */
 export declare const isNumber: (value: unknown) => boolean;
 /**
@@ -72,8 +81,10 @@ export declare const isNumber: (value: unknown) => boolean;
  * @param value The value.
  * @returns Whether it's an integer.
  * @example
- * isInteger('12'); // true
- * isInteger(12.5); // false
+ * import { isInteger } from 'jg-bignumber';
+ *
+ * isInteger('12'); // => true
+ * isInteger(12.5); // => false
  */
 export declare const isInteger: (value: unknown) => boolean;
 /**
@@ -81,7 +92,9 @@ export declare const isInteger: (value: unknown) => boolean;
  * @param value The value.
  * @returns Whether it's a float.
  * @example
- * isFloat(12.5); // true
- * isFloat('12'); // false
+ * import { isFloat } from 'jg-bignumber';
+ *
+ * isFloat(12.5); // => true
+ * isFloat('12'); // => false
  */
 export declare const isFloat: (value: unknown) => boolean;

package/dist/processing/processing.js

@@ -1,4 +1,4 @@
-import { Exception, extractMessage, isEncodedError } from 'jg-exception';
+import { Exception, isException } from 'jg-exception';
 import { BigNumber } from '../shared/constants.js';
 import { ERRORS } from '../shared/errors.js';
 import { buildConfig, buildFormatConfig, buildInvalidValueException, convertBigNumberToType, roundBigNumber, } from '../utils/utils.js';
@@ -8,8 +8,9 @@ import { buildConfig, buildFormatConfig, buildInvalidValueException, convertBigN
  * @param value The value.
  * @returns The BigNumber.
  * @example
- * getBigNumber('0.1').plus('0.2').toString(); // '0.3'
- * getBigNumber(Infinity); // throws INVALID_VALUE
+ * import { getBigNumber } from 'jg-bignumber';
+ *
+ * getBigNumber('0.1').plus('0.2').toString(); // => '0.3'
  * @throws
  * - INVALID_VALUE: if the value isn't a finite number or BigNumber throws an error
  */
@@ -33,9 +34,11 @@ export const getBigNumber = (value) => {
  * @param configuration The decimal places, rounding mode, and output type.
  * @returns The processed value.
  * @example
- * processValue(512.155); // 512.16
- * processValue(512.155, { decimalPlaces: 1, roundingMode: 'ROUND_FLOOR' }); // 512.1
- * processValue('0.000001', { decimalPlaces: 6, type: 'string' }); // '0.000001'
+ * import { processValue } from 'jg-bignumber';
+ *
+ * processValue(512.155); // => 512.16
+ * processValue(512.155, { decimalPlaces: 1, roundingMode: 'ROUND_FLOOR' }); // => 512.1
+ * processValue('0.000001', { decimalPlaces: 6, type: 'string' }); // => '0.000001'
  * @throws
  * - INVALID_VALUE: if the value isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -53,8 +56,10 @@ export const processValue = (value, configuration) => {
  * @param config How the value is processed and formatted.
  * @returns The formatted value.
  * @example
- * prettifyValue(1234567.891); // '1,234,567.89'
- * prettifyValue(1234.5, { processing: { decimalPlaces: 2 }, format: { prefix: '$' } }); // '$1,234.5'
+ * import { prettifyValue } from 'jg-bignumber';
+ *
+ * prettifyValue(1234567.891); // => '1,234,567.89'
+ * prettifyValue(1234.5, { processing: { decimalPlaces: 2 }, format: { prefix: '$' } }); // => '$1,234.5'
  * @throws
  * - INVALID_VALUE: if the value isn't a finite number or BigNumber throws an error
  * - INVALID_DECIMAL_PLACES: if the number of decimal places is invalid for any reason
@@ -70,10 +75,13 @@ export const prettifyValue = (value, config = {}) => {
         }).toFormat(buildFormatConfig(config.format));
     }
     catch (error) {
-        if (isEncodedError(error)) {
+        if (isException(error)) {
             throw error;
         }
-        throw new Exception(`The value could not be formatted: ${extractMessage(error)}`, ERRORS.INVALID_BIGNUMBER_FORMAT);
+        throw new Exception('The value could not be formatted.', {
+            code: ERRORS.INVALID_BIGNUMBER_FORMAT,
+            cause: error,
+        });
     }
 };
 /**
@@ -82,8 +90,10 @@ export const prettifyValue = (value, config = {}) => {
  * @param value The value.
  * @returns Whether it's a BigNumber.
  * @example
- * isBigNumber(getBigNumber(1)); // true
- * isBigNumber(1); // false
+ * import { getBigNumber, isBigNumber } from 'jg-bignumber';
+ *
+ * isBigNumber(getBigNumber(1)); // => true
+ * isBigNumber(1); // => false
  */
 export const isBigNumber = (value) => BigNumber.isBigNumber(value);
 /**
@@ -91,9 +101,11 @@ export const isBigNumber = (value) => BigNumber.isBigNumber(value);
  * @param value The value.
  * @returns Whether it's a finite number.
  * @example
- * isNumber('12.5'); // true
- * isNumber(Infinity); // false
- * isNumber('abc'); // false
+ * import { isNumber } from 'jg-bignumber';
+ *
+ * isNumber('12.5'); // => true
+ * isNumber(Infinity); // => false
+ * isNumber('abc'); // => false
  */
 export const isNumber = (value) => {
     try {
@@ -109,8 +121,10 @@ export const isNumber = (value) => {
  * @param value The value.
  * @returns Whether it's an integer.
  * @example
- * isInteger('12'); // true
- * isInteger(12.5); // false
+ * import { isInteger } from 'jg-bignumber';
+ *
+ * isInteger('12'); // => true
+ * isInteger(12.5); // => false
  */
 export const isInteger = (value) => {
     try {
@@ -125,8 +139,10 @@ export const isInteger = (value) => {
  * @param value The value.
  * @returns Whether it's a float.
  * @example
- * isFloat(12.5); // true
- * isFloat('12'); // false
+ * import { isFloat } from 'jg-bignumber';
+ *
+ * isFloat(12.5); // => true
+ * isFloat('12'); // => false
  */
 export const isFloat = (value) => {
     try {