@arabig/origin 1.0.0

package/README.md

@@ -0,0 +1,63 @@
+# @arabig Origin
+
+This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.3.0.
+
+## Code scaffolding
+
+Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
+
+```bash
+ng generate component component-name
+```
+
+For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
+
+```bash
+ng generate --help
+```
+
+## Building
+
+To build the library, run:
+
+```bash
+ng build origin
+```
+
+This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
+
+### Publishing the Library
+
+Once the project is built, you can publish your library by following these steps:
+
+1. Navigate to the `dist` directory:
+   ```bash
+   cd dist/origin
+   ```
+
+2. Run the `npm publish` command to publish your library to the npm registry:
+   ```bash
+   npm publish
+   ```
+
+## Running unit tests
+
+To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
+
+```bash
+ng test
+```
+
+## Running end-to-end tests
+
+For end-to-end (e2e) testing, run:
+
+```bash
+ng e2e
+```
+
+Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
+
+## Additional Resources
+
+For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.

package/fesm2022/arabig-origin-functions.mjs

@@ -0,0 +1,137 @@
+/**
+ * @license
+ * Copyright Salar Arab All Rights Reserved.
+ *
+ * @author Salar Arab <salar_arab@outlook.com>
+ */
+/**
+ * Converts the given value to a number based on given options.
+ * @param value The convertible input value.
+ * @param options The options object that handles different cases of numeric conversion.
+ * @returns The resulting number of the conversion
+ *
+ * @example
+ * doToNumber("563.68", {
+ *  infinityAlt: 0,
+ *  NaNAlt: 0
+ * });
+ */
+function aoToNumber(value, options) {
+    const _options = {
+        NaNAlt: options?.NaNAlt ?? 0,
+        infinityAlt: options?.infinityAlt ?? 0,
+    };
+    const _value = Number(value);
+    if (Number.isNaN(_value)) {
+        return _options.NaNAlt;
+    }
+    else if (!Number.isFinite(_value)) {
+        return _options.infinityAlt;
+    }
+    else {
+        return _value;
+    }
+}
+/**
+ * Extracts the decimal part of the given value and returns it as raw string.
+ * @param value The input value whose decimal part is demanded.
+ * @returns The extracted decimal part as numeric string or empty string if no decimal part is found.
+ */
+function aoExtractDecimal(value) {
+    function extract(param) {
+        return param.split(".")[1]?.replace(/0+$/, "") || "";
+    }
+    switch (typeof value) {
+        case "string":
+            const _value = Number(value);
+            if (Number.isNaN(_value) ||
+                Number.isInteger(_value)) {
+                return "";
+            }
+            else {
+                return extract(value) || "";
+            }
+        case "number":
+            if (Number.isNaN(value) ||
+                Number.isInteger(value) ||
+                !Number.isFinite(value)) {
+                return "";
+            }
+            else {
+                return extract(value.toString());
+            }
+        default:
+            return "";
+    }
+}
+/**
+ * Extracts the integer part of the given value and returns it as numeric string.
+ * @param value The input value whose integer part is demanded.
+ * @returns The extracted integer part as numeric string or empty string if no integer part is found.
+ */
+function aoExtractInteger(value) {
+    function extract(param) {
+        return param.split(".")[0]?.replace(/\.+$/, "") || "";
+    }
+    switch (typeof value) {
+        case "string":
+            const _value = Number(value);
+            if (Number.isNaN(_value)) {
+                return "";
+            }
+            else {
+                return extract(value);
+            }
+        case "number":
+            if (Number.isNaN(value) ||
+                !Number.isFinite(value)) {
+                return "";
+            }
+            else {
+                return extract(value.toString());
+            }
+        case "bigint":
+            return extract(value.toString());
+        default:
+            return "";
+    }
+}
+
+/**
+ * @license
+ * Copyright Salar Arab All Rights Reserved.
+ *
+ * @author Salar Arab <salar_arab@outlook.com>
+ */
+/**
+ * Filters the given target object entries based on given condition.
+ * @typeParam `T` The type of the target object to be filtered
+ * @param target The `object` to be filtered
+ * @param predicate The callback that iterates within target entries.
+ * Provides the key and value in form of {@link DoEntryUnion} as parameter and must
+ * return a boolean type determines whether the current key should be remained in the
+ * resulting entries or not
+ * @returns The filtered `object`.
+ * @remarks
+ * Since the structure of the returning `object` is formed during the runtime, the
+ * type inference at the compile time is not possible, so an unbound `object` is considered
+ * as the return type.
+ */
+function aoFilterObject(target, predicate) {
+    const result = {};
+    for (const key in target) {
+        if (!Object.hasOwn(target, key))
+            continue;
+        if (predicate({ key: key, value: target[key] })) {
+            result[key] = target[key];
+        }
+    }
+    return result;
+}
+
+/**
+ * Generated bundle index. Do not edit.
+ */
+
+export { aoExtractDecimal, aoExtractInteger, aoFilterObject, aoToNumber };
+//# sourceMappingURL=arabig-origin-functions.mjs.map

package/fesm2022/arabig-origin-functions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"arabig-origin-functions.mjs","sources":["../../../projects/origin/functions/number.function.ts","../../../projects/origin/functions/object.function.ts","../../../projects/origin/functions/arabig-origin-functions.ts"],"sourcesContent":["/**\r\n * @license\r\n * Copyright Salar Arab All Rights Reserved.\r\n * \r\n * @author Salar Arab <salar_arab@outlook.com>\r\n */\r\n\r\n/**\r\n * Converts the given value to a number based on given options.\r\n * @param value The convertible input value.\r\n * @param options The options object that handles different cases of numeric conversion.\r\n * @returns The resulting number of the conversion\r\n * \r\n * @example\r\n * doToNumber(\"563.68\", {\r\n *  infinityAlt: 0,\r\n *  NaNAlt: 0\r\n * });\r\n */\r\nexport function aoToNumber(\r\n  value?: unknown,\r\n  options?: {\r\n    /**\r\n    * Determines the alternative value, if the conversion results in {@link NaN}.\r\n    * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NaN | NaN}\r\n    * \r\n    * @default 0\r\n    */\r\n    NaNAlt?: number,\r\n\r\n    /**\r\n    * Determines the alternative value, if the conversion leads to {@link Infinity}.\r\n    * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Infinity | Infinity}\r\n    * \r\n    * @default 0\r\n    */\r\n    infinityAlt?: number,\r\n  },\r\n): number {\r\n  const _options = {\r\n    NaNAlt: options?.NaNAlt ?? 0,\r\n    infinityAlt: options?.infinityAlt ?? 0,\r\n  };\r\n  const _value = Number(value);\r\n\r\n  if (Number.isNaN(_value)) {\r\n    return _options.NaNAlt;\r\n  }\r\n  else if (!Number.isFinite(_value)) {\r\n    return _options.infinityAlt;\r\n  }\r\n  else {\r\n    return _value;\r\n  }\r\n}\r\n\r\n/**\r\n * Extracts the decimal part of the given value and returns it as raw string.\r\n * @param value The input value whose decimal part is demanded.\r\n * @returns The extracted decimal part as numeric string or empty string if no decimal part is found.\r\n */\r\nexport function aoExtractDecimal(value: unknown): `${number}` | \"\" {\r\n  function extract(param: string): string {\r\n    return param.split(\".\")[1]?.replace(/0+$/, \"\") || \"\";\r\n  }\r\n\r\n  switch (typeof value) {\r\n    case \"string\": \r\n      const _value = Number(value);\r\n\r\n      if (\r\n        Number.isNaN(_value) ||\r\n        Number.isInteger(_value)\r\n      ) {\r\n        return \"\";\r\n      }\r\n      else {\r\n        return extract(value) as `${number}` || \"\";\r\n      }\r\n    case \"number\":\r\n      if (\r\n        Number.isNaN(value) ||\r\n        Number.isInteger(value) ||\r\n        !Number.isFinite(value)\r\n      ) {\r\n        return \"\";\r\n      }\r\n      else {\r\n        return extract(value.toString()) as `${number}`;\r\n      }\r\n    default:\r\n      return \"\";\r\n  }\r\n}\r\n\r\n/**\r\n * Extracts the integer part of the given value and returns it as numeric string.\r\n * @param value The input value whose integer part is demanded.\r\n * @returns The extracted integer part as numeric string or empty string if no integer part is found.\r\n */\r\nexport function aoExtractInteger(value: unknown): `${number}` | \"\" {\r\n  function extract(param: string): string {\r\n    return param.split(\".\")[0]?.replace(/\\.+$/, \"\") || \"\";\r\n  }\r\n\r\n  switch (typeof value) {\r\n    case \"string\": \r\n      const _value = Number(value);\r\n\r\n      if (Number.isNaN(_value)) {\r\n        return \"\";\r\n      }\r\n      else {\r\n        return extract(value) as `${number}`;\r\n      }\r\n    case \"number\":\r\n      if (\r\n        Number.isNaN(value) ||\r\n        !Number.isFinite(value)\r\n      ) {\r\n        return \"\";\r\n      }\r\n      else {\r\n        return extract(value.toString()) as `${number}`;\r\n      }\r\n    case \"bigint\":\r\n      return extract(value.toString()) as `${number}`;\r\n    default:\r\n      return \"\";\r\n  }\r\n}","/**\r\n * @license\r\n * Copyright Salar Arab All Rights Reserved.\r\n * \r\n * @author Salar Arab <salar_arab@outlook.com>\r\n */\r\n\r\nimport { AoEntryUnion, AoObject } from \"@arabig/origin/types\";\r\n\r\n/**\r\n * Filters the given target object entries based on given condition.\r\n * @typeParam `T` The type of the target object to be filtered\r\n * @param target The `object` to be filtered\r\n * @param predicate The callback that iterates within target entries.\r\n * Provides the key and value in form of {@link DoEntryUnion} as parameter and must\r\n * return a boolean type determines whether the current key should be remained in the\r\n * resulting entries or not\r\n * @returns The filtered `object`.\r\n * @remarks\r\n * Since the structure of the returning `object` is formed during the runtime, the\r\n * type inference at the compile time is not possible, so an unbound `object` is considered\r\n * as the return type.\r\n */\r\nexport function aoFilterObject<T extends AoObject>(\r\n  target: T,\r\n  predicate: (entry: AoEntryUnion<T>) => boolean\r\n): AoObject {\r\n  const result: AoObject = {};\r\n\r\n  for (const key in target) {\r\n    if (!Object.hasOwn(target, key)) continue;\r\n\r\n    if (predicate({ key: key, value: target[key] })) {\r\n      result[key] = target[key];\r\n    }\r\n  }\r\n\r\n  return result;\r\n}","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public-api';\n"],"names":[],"mappings":"AAAA;;;;;AAKG;AAEH;;;;;;;;;;;AAWG;AACG,SAAU,UAAU,CACxB,KAAe,EACf,OAgBC,EAAA;AAED,IAAA,MAAM,QAAQ,GAAG;AACf,QAAA,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAC5B,QAAA,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,CAAC;KACvC;AACD,IAAA,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;AAE5B,IAAA,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;QACxB,OAAO,QAAQ,CAAC,MAAM;IACxB;SACK,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QACjC,OAAO,QAAQ,CAAC,WAAW;IAC7B;SACK;AACH,QAAA,OAAO,MAAM;IACf;AACF;AAEA;;;;AAIG;AACG,SAAU,gBAAgB,CAAC,KAAc,EAAA;IAC7C,SAAS,OAAO,CAAC,KAAa,EAAA;AAC5B,QAAA,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,EAAE;IACtD;IAEA,QAAQ,OAAO,KAAK;AAClB,QAAA,KAAK,QAAQ;AACX,YAAA,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;AAE5B,YAAA,IACE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;AACpB,gBAAA,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EACxB;AACA,gBAAA,OAAO,EAAE;YACX;iBACK;AACH,gBAAA,OAAO,OAAO,CAAC,KAAK,CAAgB,IAAI,EAAE;YAC5C;AACF,QAAA,KAAK,QAAQ;AACX,YAAA,IACE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;AACnB,gBAAA,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC;AACvB,gBAAA,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EACvB;AACA,gBAAA,OAAO,EAAE;YACX;iBACK;AACH,gBAAA,OAAO,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAgB;YACjD;AACF,QAAA;AACE,YAAA,OAAO,EAAE;;AAEf;AAEA;;;;AAIG;AACG,SAAU,gBAAgB,CAAC,KAAc,EAAA;IAC7C,SAAS,OAAO,CAAC,KAAa,EAAA;AAC5B,QAAA,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,EAAE;IACvD;IAEA,QAAQ,OAAO,KAAK;AAClB,QAAA,KAAK,QAAQ;AACX,YAAA,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;AAE5B,YAAA,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;AACxB,gBAAA,OAAO,EAAE;YACX;iBACK;AACH,gBAAA,OAAO,OAAO,CAAC,KAAK,CAAgB;YACtC;AACF,QAAA,KAAK,QAAQ;AACX,YAAA,IACE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;AACnB,gBAAA,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EACvB;AACA,gBAAA,OAAO,EAAE;YACX;iBACK;AACH,gBAAA,OAAO,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAgB;YACjD;AACF,QAAA,KAAK,QAAQ;AACX,YAAA,OAAO,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAgB;AACjD,QAAA;AACE,YAAA,OAAO,EAAE;;AAEf;;AClIA;;;;;AAKG;AAIH;;;;;;;;;;;;;AAaG;AACG,SAAU,cAAc,CAC5B,MAAS,EACT,SAA8C,EAAA;IAE9C,MAAM,MAAM,GAAa,EAAE;AAE3B,IAAA,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;QACxB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;YAAE;AAEjC,QAAA,IAAI,SAAS,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;YAC/C,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC;QAC3B;IACF;AAEA,IAAA,OAAO,MAAM;AACf;;ACtCA;;AAEG;;;;"}

package/fesm2022/arabig-origin-operand.mjs

@@ -0,0 +1,286 @@
+import { aoExtractDecimal, aoExtractInteger } from '@arabig/origin/functions';
+
+/**
+ * @license
+ * Copyright Salar Arab All Rights Reserved
+ *
+ * @author Salar Arab <salar_arab@outlook.com>
+ */
+/**
+ * Utilizes performing precise arithmetic operations
+ * such as addition, subtraction, multiplication, and division in the form of pipeline.
+ *
+ * This class is designed to handle extremely large or small numeric values
+ * without resulting in {@link Infinity} or {@link NaN}, ensuring safe and predictable
+ * calculations across a wide range of inputs.
+ *
+ * All operations are performed using numeric strings to maintain precision,
+ * especially for decimal values, avoiding floating-point inaccuracies common
+ * in native JavaScript number handling.
+ *
+ * @example
+ * ```ts
+ * const operand = new AoOperand(0.005).add(1.05).add(0.005);
+ *
+ * console.log(operand.currentValue) //expecting "1.06";
+ * ```
+ *
+ * @remarks
+ * This class is ideal for financial, scientific, or any domain where
+ * precision and scale are critical. It does not rely on native number
+ * arithmetic and instead uses string-based computation to preserve accuracy.
+ */
+class AoOperand {
+    _initialValue;
+    _previousValue;
+    _currentValue;
+    //declaration
+    constructor(param) {
+        if (param instanceof AoOperand) {
+            this._initialValue = param.toString("initial");
+            this._currentValue = param.toString("current");
+            this._previousValue = param.toString("previous");
+        }
+        else {
+            this._initialValue = this.refine(param).value;
+            this._currentValue = this._initialValue;
+            this._previousValue = "0";
+        }
+    }
+    /**
+     * Converts and outputs the {@link AoOperand}'s value as number base on given state.
+     * @param state The state that determines temporal state of the value. Default is "current"
+     * @returns A number
+     */
+    toNumber(state = "current") {
+        return Number(this[`_${state}Value`]);
+    }
+    /**
+     * Converts and outputs the {@link AoOperand}'s value as bigint base on given state.
+     * @param state The state that determines temporal state of the value. Default is "current"
+     * @returns A bigint
+     */
+    toBigInt(state = "current") {
+        return BigInt(this[`_${state}Value`]);
+    }
+    /**
+     * Converts and outputs the {@link AoOperand}'s value as numeric string base on given state.
+     * @param state The state that determines temporal state of the value. Default is "current"
+     * @returns A numeric string
+     */
+    toString(state = "current") {
+        return this[`_${state}Value`];
+    }
+    /**
+     * Executes the Executes the {@link https://en.wikipedia.org/wiki/Addition | addition}
+     * operation for the given value.
+     * @param input The adding operand
+     * @returns A new instance of {@link AoOperand} that holds the operation latest result
+     */
+    add(input) {
+        //Step 1: prerequisites refinement
+        const inputRefined = this.refine(input);
+        const currentRefined = this.refine(this._currentValue);
+        const int1 = currentRefined.integer;
+        const dec1 = currentRefined.decimal;
+        const int2 = inputRefined.integer;
+        const dec2 = inputRefined.decimal;
+        //Step 2: decimals normalization
+        const mantissa = Math.max(dec1.length, dec2.length);
+        const dec1Norm = dec1.padEnd(mantissa, "0");
+        const dec2Norm = dec2.padEnd(mantissa, "0");
+        //Step 3: restraining resulting integer
+        const intFinal = this.restrain(() => {
+            const intSum = Number(int1) + Number(int2);
+            const decSum = Number(dec1Norm) + Number(dec2Norm);
+            const spillover = Math.floor(decSum / (mantissa ** 10));
+            return intSum + spillover;
+        }, () => {
+            const intSum = BigInt(int1) + BigInt(int2);
+            const decSum = BigInt(dec1Norm) + BigInt(dec2Norm);
+            const spillover = decSum / (BigInt(mantissa) ** 10n);
+            return intSum + spillover;
+        });
+        //Step 4: restraining resulting decimal
+        const decResult = this.restrain(() => {
+            const decSum = Number(dec1Norm) + Number(dec2Norm);
+            return decSum % (10 ** mantissa);
+        }, () => {
+            const decSum = BigInt(dec1Norm) + BigInt(dec2Norm);
+            return decSum % (10n ** BigInt(mantissa));
+        });
+        const decFinal = decResult.padStart(mantissa, "0");
+        //Step 5: taking snapshot and returning the new instance with the new value.
+        this.assign(this.normalize(intFinal, decFinal));
+        return this.clone();
+    }
+    /**
+     * Executes the {@link https://en.wikipedia.org/wiki/Subtraction | subtraction}
+     * operation for the given value.
+     * @param input The subtracting operand
+     * @returns A new instance of {@link AoOperand} that holds the operation latest result
+     */
+    subtract(input) {
+        //Step 1: prerequisites refinement
+        const inputRefined = this.refine(input);
+        const currentRefined = this.refine(this._currentValue);
+        const int1 = currentRefined.integer;
+        const dec1 = currentRefined.decimal;
+        const int2 = inputRefined.integer;
+        const dec2 = inputRefined.decimal;
+        //Step 2: decimals normalization
+        const mantissa = Math.max(dec1.length, dec2.length);
+        const dec1Norm = dec1.padEnd(mantissa, "0");
+        const dec2Norm = dec2.padEnd(mantissa, "0");
+        //Step 3: restraining resulting integer
+        const intFinal = this.restrain(() => {
+            const decSub = Number(dec1Norm) - Number(dec2Norm);
+            let intSub = Number(int1) - Number(int2);
+            return decSub < 0 ? intSub -= 1 : intSub;
+        }, () => {
+            const decSub = BigInt(dec1Norm) - BigInt(dec2Norm);
+            let intSub = BigInt(int1) - BigInt(int2);
+            return decSub < 0n ? intSub -= 1n : intSub;
+        });
+        //Step 4: restraining resulting decimal
+        const decResult = this.restrain(() => {
+            let sub = Number(dec1Norm) - Number(dec2Norm);
+            return sub < 0 ? sub += (Number(mantissa) ** 10) : sub;
+        }, () => {
+            let sub = BigInt(dec1Norm) - BigInt(dec2Norm);
+            return sub < 0n ? sub += (BigInt(mantissa) ** 10n) : sub;
+        });
+        const decFinal = decResult.padStart(mantissa, "0");
+        //Step 5: taking snapshot and returning the new instance with the new value.
+        this.assign(this.normalize(intFinal, decFinal));
+        return this.clone();
+    }
+    /**
+     * Executes the {@link https://en.wikipedia.org/wiki/Multiplication | multiplication}
+     * operation for the given value.
+     * @param input The multiplying operand
+     * @returns A new instance of {@link AoOperand} that holds the operation latest result
+     */
+    multiply(input) {
+        //Step 1: prerequisites refinement
+        const inputRefined = this.refine(input);
+        const currentRefined = this.refine(this._currentValue);
+        const int1 = currentRefined.integer;
+        const dec1 = currentRefined.decimal;
+        const int2 = inputRefined.integer;
+        const dec2 = inputRefined.decimal;
+        const totalDecLen = dec1.length + dec2.length;
+        //Step 2: product calculation
+        const product = this.restrain(() => Number(int1 + dec1) * Number(int2 + dec2), () => BigInt(int1 + dec1) * BigInt(int2 + dec2)).padStart(totalDecLen + 1, "0");
+        //Step 3: slicing numeric parts
+        const intFinal = product.slice(0, -totalDecLen);
+        const decFinal = product.slice(-totalDecLen);
+        //Step 4: taking snapshot and returning the new instance with the new value.
+        this.assign(this.normalize(intFinal, decFinal));
+        return this.clone();
+    }
+    /**
+   * Executes the {@link https://en.wikipedia.org/wiki/Division_(mathematics) | division}
+   * operation for the given value.
+   * @param input The dividing operand
+   * @param options The option object that determines calculation behavior.
+   * @returns A new instance of {@link AoOperand} that holds the operation latest result
+   */
+    divide(input, options) {
+        //Step 1: prerequisites refinement
+        const _options = {
+            precision: options?.precision ?? 10,
+            divideByZeroAlt: this.refine(options?.divideByZeroAlt).value,
+        };
+        const inputRefined = this.refine(input);
+        const currentRefined = this.refine(this._currentValue);
+        const int1 = currentRefined.integer;
+        const dec1 = currentRefined.decimal;
+        const int2 = inputRefined.integer;
+        const dec2 = inputRefined.decimal;
+        const whole1 = BigInt(int1 + dec1);
+        const whole2 = BigInt(int2 + dec2);
+        //Step 2: check divide by zero case
+        if (whole2 === 0n) {
+            this.assign(_options.divideByZeroAlt);
+            return this.clone();
+        }
+        //Step 3: adjust scale to preserve precision
+        const scale = BigInt(10 ** (_options.precision + dec2.length - dec1.length));
+        const numerator = whole1 * scale;
+        const quotient = numerator / whole2;
+        //Step 4: convert to string and insert decimal point
+        const quotientDigits = quotient.toString().padStart(_options.precision + 1, "0");
+        const intFinal = quotientDigits.slice(0, -_options.precision);
+        const decFinal = quotientDigits.slice(-_options.precision);
+        //Step 5: taking snapshot and returning the new instance with the new value.
+        this.assign(this.normalize(intFinal, decFinal));
+        return this.clone();
+    }
+    /**
+     * Creates a new instance based on current instance.
+     * @returns A new {@link AoOperand} instance
+     */
+    clone() {
+        return new AoOperand(this);
+    }
+    /**
+     * Takes snapshot from the current value then assigns the given value to it.
+     * @param value the input value that updates the current value
+     */
+    assign(value) {
+        this._previousValue = this._currentValue;
+        this._currentValue = value;
+    }
+    /**
+     * Restrains the given number operation by switching to its bigint alternative
+     * if it leads to {@link Infinity}.
+     * @param finiteOperator The callback that returns number
+     * @param infiniteOperator The callback that returns bigint
+     * @returns A numeric string
+     */
+    restrain(finiteOperator, infiniteOperator) {
+        const _finiteOperator = finiteOperator();
+        return Number.isFinite(_finiteOperator)
+            ? _finiteOperator.toString()
+            : infiniteOperator().toString();
+    }
+    /**
+     * Creates an info object from raw input that provides refined number parts for calculation.
+     * @param input The raw input needed for refinement.
+     * @returns An object info providing refined data for calculation
+     */
+    refine(input) {
+        const _decimal = aoExtractDecimal(input);
+        const _integer = aoExtractInteger(input) || "0";
+        const _value = _decimal
+            ? `${_integer}.${_decimal}`
+            : _integer;
+        return {
+            decimal: _decimal || "0",
+            integer: _integer,
+            value: _value,
+        };
+    }
+    /**
+     * Normalizes the decimal part if all of its digits are "0" and removes trailing zeros.
+     * @param integer The integer part of the value
+     * @param decimal The decimal part of the value
+     * @returns The normalized numeric string
+     */
+    normalize(integer, decimal) {
+        function unTrailZeros(value) {
+            return value.replace(/0+$/, '');
+        }
+        return /^0*$/.test(decimal)
+            ? integer
+            : `${integer}.${unTrailZeros(decimal)}`;
+    }
+}
+
+/**
+ * Generated bundle index. Do not edit.
+ */
+
+export { AoOperand };
+//# sourceMappingURL=arabig-origin-operand.mjs.map

package/fesm2022/arabig-origin-operand.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"arabig-origin-operand.mjs","sources":["../../../projects/origin/operand/operand.ts","../../../projects/origin/operand/arabig-origin-operand.ts"],"sourcesContent":["/**\r\n * @license\r\n * Copyright Salar Arab All Rights Reserved\r\n * \r\n * @author Salar Arab <salar_arab@outlook.com>\r\n */\r\n\r\nimport { aoExtractDecimal, aoExtractInteger } from \"@arabig/origin/functions\";\r\n\r\n/**\r\n * Represents a numeric string\r\n */\r\ntype Digits = `${number}`;\r\n\r\n/**\r\n * The convertible input type used mostly in calculation methods\r\n */\r\ntype RawInput = string | number | bigint | null | undefined;\r\n\r\n/**\r\n * Represents different states of the value\r\n */\r\ntype ValueState = \"current\" | \"previous\" | \"initial\";\r\n\r\n/**\r\n * Utilizes performing precise arithmetic operations\r\n * such as addition, subtraction, multiplication, and division in the form of pipeline.\r\n *\r\n * This class is designed to handle extremely large or small numeric values\r\n * without resulting in {@link Infinity} or {@link NaN}, ensuring safe and predictable\r\n * calculations across a wide range of inputs.\r\n *\r\n * All operations are performed using numeric strings to maintain precision,\r\n * especially for decimal values, avoiding floating-point inaccuracies common\r\n * in native JavaScript number handling.\r\n *\r\n * @example\r\n * ```ts\r\n * const operand = new AoOperand(0.005).add(1.05).add(0.005);\r\n * \r\n * console.log(operand.currentValue) //expecting \"1.06\";\r\n * ```\r\n *\r\n * @remarks\r\n * This class is ideal for financial, scientific, or any domain where\r\n * precision and scale are critical. It does not rely on native number\r\n * arithmetic and instead uses string-based computation to preserve accuracy.\r\n */\r\nexport class AoOperand {\r\n\r\n  private readonly _initialValue: Digits;\r\n\r\n  private _previousValue: Digits;\r\n\r\n  private _currentValue: Digits;\r\n\r\n  /**\r\n   * Creates a new instance based on given instance.\r\n   * @param instance An instance of {@link AoOperand}\r\n   */\r\n  constructor(instance: AoOperand);\r\n  /**\r\n   * Creates a new instance of {@link AoOperand} with provided initial value.\r\n   * @param initialValue\r\n   * The initial value of the calculation. If the value is not provided or not numeric\r\n   * convertible, is assigned to \"0\".\r\n   */\r\n  constructor(initialValue?: RawInput);\r\n  //declaration\r\n  constructor(param?: RawInput | AoOperand) {\r\n    if (param instanceof AoOperand) {\r\n      this._initialValue = param.toString(\"initial\");\r\n      this._currentValue = param.toString(\"current\");\r\n      this._previousValue = param.toString(\"previous\");\r\n    }\r\n    else {\r\n      this._initialValue = this.refine(param).value;\r\n      this._currentValue = this._initialValue;\r\n      this._previousValue = \"0\";\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Converts and outputs the {@link AoOperand}'s value as number base on given state.\r\n   * @param state The state that determines temporal state of the value. Default is \"current\"\r\n   * @returns A number\r\n   */\r\n  public toNumber(state: ValueState = \"current\"): number {\r\n    return Number(this[`_${state}Value`]);\r\n  }\r\n\r\n  /**\r\n   * Converts and outputs the {@link AoOperand}'s value as bigint base on given state.\r\n   * @param state The state that determines temporal state of the value. Default is \"current\"\r\n   * @returns A bigint\r\n   */\r\n  public toBigInt(state: ValueState = \"current\"): bigint {\r\n    return BigInt(this[`_${state}Value`]);\r\n  }\r\n\r\n  /**\r\n   * Converts and outputs the {@link AoOperand}'s value as numeric string base on given state.\r\n   * @param state The state that determines temporal state of the value. Default is \"current\"\r\n   * @returns A numeric string\r\n   */\r\n  public toString(state: ValueState = \"current\"): Digits {\r\n    return this[`_${state}Value`];\r\n  }\r\n\r\n  /**\r\n   * Executes the Executes the {@link https://en.wikipedia.org/wiki/Addition | addition}\r\n   * operation for the given value.\r\n   * @param input The adding operand\r\n   * @returns A new instance of {@link AoOperand} that holds the operation latest result\r\n   */\r\n  public add(input: RawInput): AoOperand {\r\n    //Step 1: prerequisites refinement\r\n    const inputRefined = this.refine(input);\r\n    const currentRefined = this.refine(this._currentValue);\r\n    \r\n    const int1 = currentRefined.integer;\r\n    const dec1 = currentRefined.decimal;\r\n\r\n    const int2 = inputRefined.integer;\r\n    const dec2 = inputRefined.decimal;\r\n    \r\n    //Step 2: decimals normalization\r\n    const mantissa = Math.max(dec1.length, dec2.length);\r\n\r\n    const dec1Norm = dec1.padEnd(mantissa, \"0\") as Digits;\r\n    const dec2Norm = dec2.padEnd(mantissa, \"0\") as Digits;\r\n\r\n    //Step 3: restraining resulting integer\r\n    const intFinal = this.restrain(\r\n      () => {\r\n        const intSum = Number(int1) + Number(int2);\r\n        const decSum = Number(dec1Norm) + Number(dec2Norm);\r\n\r\n        const spillover = Math.floor(decSum / (mantissa ** 10));\r\n\r\n        return intSum + spillover;\r\n      },\r\n      () => {\r\n        const intSum = BigInt(int1) + BigInt(int2);\r\n        const decSum = BigInt(dec1Norm) + BigInt(dec2Norm);\r\n\r\n        const spillover = decSum / (BigInt(mantissa) ** 10n);\r\n\r\n        return intSum + spillover;\r\n      },\r\n    );\r\n\r\n    //Step 4: restraining resulting decimal\r\n    const decResult = this.restrain(\r\n      () => {\r\n        const decSum = Number(dec1Norm) + Number(dec2Norm);\r\n\r\n        return decSum % (10 ** mantissa);\r\n      },\r\n      () => {\r\n        const decSum = BigInt(dec1Norm) + BigInt(dec2Norm);\r\n\r\n        return decSum % (10n ** BigInt(mantissa));\r\n      },\r\n    );\r\n\r\n    const decFinal = decResult.padStart(mantissa, \"0\") as Digits;\r\n\r\n    //Step 5: taking snapshot and returning the new instance with the new value.\r\n    this.assign(this.normalize(intFinal, decFinal));\r\n\r\n    return this.clone();\r\n  }\r\n\r\n  /**\r\n   * Executes the {@link https://en.wikipedia.org/wiki/Subtraction | subtraction} \r\n   * operation for the given value.\r\n   * @param input The subtracting operand\r\n   * @returns A new instance of {@link AoOperand} that holds the operation latest result\r\n   */\r\n  public subtract(input: RawInput): AoOperand {\r\n    //Step 1: prerequisites refinement\r\n    const inputRefined = this.refine(input);\r\n    const currentRefined = this.refine(this._currentValue);\r\n\r\n    const int1 = currentRefined.integer;\r\n    const dec1 = currentRefined.decimal;\r\n    \r\n    const int2 = inputRefined.integer;\r\n    const dec2 = inputRefined.decimal;\r\n\r\n    //Step 2: decimals normalization\r\n    const mantissa = Math.max(dec1.length, dec2.length);\r\n\r\n    const dec1Norm = dec1.padEnd(mantissa, \"0\") as Digits;\r\n    const dec2Norm = dec2.padEnd(mantissa, \"0\") as Digits;\r\n\r\n    //Step 3: restraining resulting integer\r\n    const intFinal = this.restrain(\r\n      () => {\r\n        const decSub = Number(dec1Norm) - Number(dec2Norm);\r\n        let intSub = Number(int1) - Number(int2);\r\n\r\n        return decSub < 0 ? intSub -= 1 : intSub;\r\n      },\r\n      () => {\r\n        const decSub = BigInt(dec1Norm) - BigInt(dec2Norm);\r\n        let intSub = BigInt(int1) - BigInt(int2);\r\n\r\n        return decSub < 0n ? intSub -= 1n : intSub;\r\n      },\r\n    );\r\n\r\n    //Step 4: restraining resulting decimal\r\n    const decResult = this.restrain(\r\n      () => {\r\n        let sub = Number(dec1Norm) - Number(dec2Norm);\r\n\r\n        return sub < 0 ? sub += (Number(mantissa) ** 10): sub;\r\n      },\r\n      () => {\r\n        let sub = BigInt(dec1Norm) - BigInt(dec2Norm);\r\n\r\n        return sub < 0n ? sub += (BigInt(mantissa) ** 10n): sub;\r\n      },\r\n    );\r\n\r\n    const decFinal = decResult.padStart(mantissa, \"0\") as Digits;\r\n\r\n    //Step 5: taking snapshot and returning the new instance with the new value.\r\n    this.assign(this.normalize(intFinal, decFinal));\r\n\r\n    return this.clone();\r\n  }\r\n\r\n  /**\r\n   * Executes the {@link https://en.wikipedia.org/wiki/Multiplication | multiplication} \r\n   * operation for the given value.\r\n   * @param input The multiplying operand\r\n   * @returns A new instance of {@link AoOperand} that holds the operation latest result\r\n   */\r\n  public multiply(input: RawInput): AoOperand {\r\n    //Step 1: prerequisites refinement\r\n    const inputRefined = this.refine(input);\r\n    const currentRefined = this.refine(this._currentValue);\r\n\r\n    const int1 = currentRefined.integer;\r\n    const dec1 = currentRefined.decimal;\r\n    \r\n    const int2 = inputRefined.integer;\r\n    const dec2 = inputRefined.decimal;\r\n\r\n    const totalDecLen = dec1.length + dec2.length;\r\n    //Step 2: product calculation\r\n    const product = this.restrain(\r\n      () => Number(int1 + dec1) * Number(int2 + dec2),\r\n      () => BigInt(int1 + dec1) * BigInt(int2 + dec2),\r\n    ).padStart(totalDecLen + 1, \"0\") as Digits;\r\n\r\n    //Step 3: slicing numeric parts\r\n    const intFinal = product.slice(0, -totalDecLen) as Digits;\r\n    const decFinal = product.slice(-totalDecLen) as Digits;\r\n\r\n    //Step 4: taking snapshot and returning the new instance with the new value.\r\n    this.assign(this.normalize(intFinal, decFinal));\r\n\r\n    return this.clone();\r\n  }\r\n\r\n  /**\r\n * Executes the {@link https://en.wikipedia.org/wiki/Division_(mathematics) | division} \r\n * operation for the given value.\r\n * @param input The dividing operand\r\n * @param options The option object that determines calculation behavior.\r\n * @returns A new instance of {@link AoOperand} that holds the operation latest result\r\n */\r\n  public divide(\r\n    input: RawInput,\r\n    options?: {\r\n      /**\r\n       * The number of decimal places to keep. The default value is 10\r\n       */\r\n      precision?: number,\r\n      /**\r\n       * The alternative value in case of divide by zero\r\n       */\r\n      divideByZeroAlt?: RawInput,\r\n    },\r\n  ): AoOperand {\r\n    //Step 1: prerequisites refinement\r\n    const _options = {\r\n      precision: options?.precision ?? 10,\r\n      divideByZeroAlt: this.refine(options?.divideByZeroAlt).value,\r\n    };\r\n\r\n    const inputRefined = this.refine(input);\r\n    const currentRefined = this.refine(this._currentValue);\r\n\r\n    const int1 = currentRefined.integer;\r\n    const dec1 = currentRefined.decimal;\r\n    \r\n    const int2 = inputRefined.integer;\r\n    const dec2 = inputRefined.decimal;\r\n\r\n    const whole1 = BigInt(int1 + dec1);\r\n    const whole2 = BigInt(int2 + dec2);\r\n\r\n    //Step 2: check divide by zero case\r\n    if (whole2 === 0n) {\r\n      this.assign(_options.divideByZeroAlt);\r\n      return this.clone();\r\n    }\r\n\r\n    //Step 3: adjust scale to preserve precision\r\n    const scale = BigInt(10 ** (_options.precision + dec2.length - dec1.length));\r\n    const numerator = whole1 * scale;\r\n    const quotient = numerator / whole2;\r\n\r\n    //Step 4: convert to string and insert decimal point\r\n    const quotientDigits = quotient.toString().padStart(_options.precision + 1, \"0\") as Digits;\r\n    const intFinal = quotientDigits.slice(0, -_options.precision) as Digits;\r\n    const decFinal = quotientDigits.slice(-_options.precision) as Digits;\r\n\r\n    //Step 5: taking snapshot and returning the new instance with the new value.\r\n    this.assign(this.normalize(intFinal, decFinal));\r\n\r\n    return this.clone();\r\n  }\r\n\r\n  /**\r\n   * Creates a new instance based on current instance.\r\n   * @returns A new {@link AoOperand} instance\r\n   */\r\n  private clone(): AoOperand {\r\n    return new AoOperand(this);\r\n  }\r\n\r\n  /**\r\n   * Takes snapshot from the current value then assigns the given value to it.\r\n   * @param value the input value that updates the current value\r\n   */\r\n  private assign(value: Digits): void {\r\n    this._previousValue = this._currentValue;\r\n    this._currentValue = value;\r\n  }\r\n\r\n  /**\r\n   * Restrains the given number operation by switching to its bigint alternative\r\n   * if it leads to {@link Infinity}.\r\n   * @param finiteOperator The callback that returns number\r\n   * @param infiniteOperator The callback that returns bigint\r\n   * @returns A numeric string\r\n   */\r\n  private restrain(\r\n    finiteOperator: () => number,\r\n    infiniteOperator: () => bigint,\r\n  ): Digits {\r\n    const _finiteOperator = finiteOperator();\r\n\r\n    return Number.isFinite(_finiteOperator)\r\n      ? _finiteOperator.toString() as Digits\r\n      : infiniteOperator().toString() as Digits;\r\n  }\r\n\r\n  /**\r\n   * Creates an info object from raw input that provides refined number parts for calculation.\r\n   * @param input The raw input needed for refinement.\r\n   * @returns An object info providing refined data for calculation\r\n   */\r\n  private refine(input: RawInput): {\r\n    decimal: Digits,\r\n    integer: Digits,\r\n    value: Digits,\r\n  } {\r\n    const _decimal = aoExtractDecimal(input);\r\n    const _integer = aoExtractInteger(input) || \"0\";\r\n    const _value = _decimal\r\n      ? `${_integer}.${_decimal}` as Digits\r\n      : _integer;\r\n    \r\n    return {\r\n      decimal: _decimal || \"0\",\r\n      integer: _integer,\r\n      value: _value,\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Normalizes the decimal part if all of its digits are \"0\" and removes trailing zeros.\r\n   * @param integer The integer part of the value\r\n   * @param decimal The decimal part of the value\r\n   * @returns The normalized numeric string\r\n   */\r\n  private normalize(integer: Digits, decimal: Digits): Digits {\r\n    function unTrailZeros(value: Digits): Digits {\r\n      return value.replace(/0+$/, '') as Digits;\r\n    }\r\n\r\n    return /^0*$/.test(decimal)\r\n      ? integer\r\n      : `${integer}.${unTrailZeros(decimal)}` as Digits;\r\n  }\r\n\r\n}","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public-api';\n"],"names":[],"mappings":";;AAAA;;;;;AAKG;AAmBH;;;;;;;;;;;;;;;;;;;;;;;AAuBG;MACU,SAAS,CAAA;AAEH,IAAA,aAAa;AAEtB,IAAA,cAAc;AAEd,IAAA,aAAa;;AAerB,IAAA,WAAA,CAAY,KAA4B,EAAA;AACtC,QAAA,IAAI,KAAK,YAAY,SAAS,EAAE;YAC9B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC;YAC9C,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC;YAC9C,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC;QAClD;aACK;YACH,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK;AAC7C,YAAA,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa;AACvC,YAAA,IAAI,CAAC,cAAc,GAAG,GAAG;QAC3B;IACF;AAEA;;;;AAIG;IACI,QAAQ,CAAC,QAAoB,SAAS,EAAA;QAC3C,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAA,KAAA,CAAO,CAAC,CAAC;IACvC;AAEA;;;;AAIG;IACI,QAAQ,CAAC,QAAoB,SAAS,EAAA;QAC3C,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAA,KAAA,CAAO,CAAC,CAAC;IACvC;AAEA;;;;AAIG;IACI,QAAQ,CAAC,QAAoB,SAAS,EAAA;AAC3C,QAAA,OAAO,IAAI,CAAC,CAAA,CAAA,EAAI,KAAK,CAAA,KAAA,CAAO,CAAC;IAC/B;AAEA;;;;;AAKG;AACI,IAAA,GAAG,CAAC,KAAe,EAAA;;QAExB,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;QACvC,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;AAEtD,QAAA,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO;AACnC,QAAA,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO;AAEnC,QAAA,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO;AACjC,QAAA,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO;;AAGjC,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;QAEnD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAW;QACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAW;;AAGrD,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAC5B,MAAK;YACH,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC;YAC1C,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC;AAElD,YAAA,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,QAAQ,IAAI,EAAE,CAAC,CAAC;YAEvD,OAAO,MAAM,GAAG,SAAS;QAC3B,CAAC,EACD,MAAK;YACH,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC;YAC1C,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC;AAElD,YAAA,MAAM,SAAS,GAAG,MAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC;YAEpD,OAAO,MAAM,GAAG,SAAS;AAC3B,QAAA,CAAC,CACF;;AAGD,QAAA,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAC7B,MAAK;YACH,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC;AAElD,YAAA,OAAO,MAAM,IAAI,EAAE,IAAI,QAAQ,CAAC;QAClC,CAAC,EACD,MAAK;YACH,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC;YAElD,OAAO,MAAM,IAAI,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAC;AAC3C,QAAA,CAAC,CACF;QAED,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAW;;AAG5D,QAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAE/C,QAAA,OAAO,IAAI,CAAC,KAAK,EAAE;IACrB;AAEA;;;;;AAKG;AACI,IAAA,QAAQ,CAAC,KAAe,EAAA;;QAE7B,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;QACvC,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;AAEtD,QAAA,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO;AACnC,QAAA,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO;AAEnC,QAAA,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO;AACjC,QAAA,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO;;AAGjC,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;QAEnD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAW;QACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAW;;AAGrD,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAC5B,MAAK;YACH,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC;YAClD,IAAI,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC;AAExC,YAAA,OAAO,MAAM,GAAG,CAAC,GAAG,MAAM,IAAI,CAAC,GAAG,MAAM;QAC1C,CAAC,EACD,MAAK;YACH,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC;YAClD,IAAI,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC;AAExC,YAAA,OAAO,MAAM,GAAG,EAAE,GAAG,MAAM,IAAI,EAAE,GAAG,MAAM;AAC5C,QAAA,CAAC,CACF;;AAGD,QAAA,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAC7B,MAAK;YACH,IAAI,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC;YAE7C,OAAO,GAAG,GAAG,CAAC,GAAG,GAAG,KAAK,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,GAAE,GAAG;QACvD,CAAC,EACD,MAAK;YACH,IAAI,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC;YAE7C,OAAO,GAAG,GAAG,EAAE,GAAG,GAAG,KAAK,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,GAAE,GAAG;AACzD,QAAA,CAAC,CACF;QAED,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAW;;AAG5D,QAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAE/C,QAAA,OAAO,IAAI,CAAC,KAAK,EAAE;IACrB;AAEA;;;;;AAKG;AACI,IAAA,QAAQ,CAAC,KAAe,EAAA;;QAE7B,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;QACvC,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;AAEtD,QAAA,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO;AACnC,QAAA,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO;AAEnC,QAAA,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO;AACjC,QAAA,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO;QAEjC,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM;;QAE7C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAC3B,MAAM,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,EAC/C,MAAM,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,CAChD,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,EAAE,GAAG,CAAW;;QAG1C,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,WAAW,CAAW;QACzD,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,WAAW,CAAW;;AAGtD,QAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAE/C,QAAA,OAAO,IAAI,CAAC,KAAK,EAAE;IACrB;AAEA;;;;;;AAMC;IACM,MAAM,CACX,KAAe,EACf,OASC,EAAA;;AAGD,QAAA,MAAM,QAAQ,GAAG;AACf,YAAA,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,EAAE;YACnC,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,KAAK;SAC7D;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;QACvC,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;AAEtD,QAAA,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO;AACnC,QAAA,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO;AAEnC,QAAA,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO;AACjC,QAAA,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO;QAEjC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QAClC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;;AAGlC,QAAA,IAAI,MAAM,KAAK,EAAE,EAAE;AACjB,YAAA,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC;AACrC,YAAA,OAAO,IAAI,CAAC,KAAK,EAAE;QACrB;;QAGA,MAAM,KAAK,GAAG,MAAM,CAAC,EAAE,KAAK,QAAQ,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;AAC5E,QAAA,MAAM,SAAS,GAAG,MAAM,GAAG,KAAK;AAChC,QAAA,MAAM,QAAQ,GAAG,SAAS,GAAG,MAAM;;AAGnC,QAAA,MAAM,cAAc,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,GAAG,CAAC,EAAE,GAAG,CAAW;AAC1F,QAAA,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAW;QACvE,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAW;;AAGpE,QAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAE/C,QAAA,OAAO,IAAI,CAAC,KAAK,EAAE;IACrB;AAEA;;;AAGG;IACK,KAAK,GAAA;AACX,QAAA,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC;IAC5B;AAEA;;;AAGG;AACK,IAAA,MAAM,CAAC,KAAa,EAAA;AAC1B,QAAA,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,aAAa;AACxC,QAAA,IAAI,CAAC,aAAa,GAAG,KAAK;IAC5B;AAEA;;;;;;AAMG;IACK,QAAQ,CACd,cAA4B,EAC5B,gBAA8B,EAAA;AAE9B,QAAA,MAAM,eAAe,GAAG,cAAc,EAAE;AAExC,QAAA,OAAO,MAAM,CAAC,QAAQ,CAAC,eAAe;AACpC,cAAE,eAAe,CAAC,QAAQ;AAC1B,cAAE,gBAAgB,EAAE,CAAC,QAAQ,EAAY;IAC7C;AAEA;;;;AAIG;AACK,IAAA,MAAM,CAAC,KAAe,EAAA;AAK5B,QAAA,MAAM,QAAQ,GAAG,gBAAgB,CAAC,KAAK,CAAC;QACxC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,KAAK,CAAC,IAAI,GAAG;QAC/C,MAAM,MAAM,GAAG;AACb,cAAE,CAAA,EAAG,QAAQ,CAAA,CAAA,EAAI,QAAQ,CAAA;cACvB,QAAQ;QAEZ,OAAO;YACL,OAAO,EAAE,QAAQ,IAAI,GAAG;AACxB,YAAA,OAAO,EAAE,QAAQ;AACjB,YAAA,KAAK,EAAE,MAAM;SACd;IACH;AAEA;;;;;AAKG;IACK,SAAS,CAAC,OAAe,EAAE,OAAe,EAAA;QAChD,SAAS,YAAY,CAAC,KAAa,EAAA;YACjC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAW;QAC3C;AAEA,QAAA,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO;AACxB,cAAE;cACA,GAAG,OAAO,CAAA,CAAA,EAAI,YAAY,CAAC,OAAO,CAAC,CAAA,CAAY;IACrD;AAED;;ACnZD;;AAEG;;;;"}

package/fesm2022/arabig-origin-record.mjs

@@ -0,0 +1,112 @@
+import { aoFilterObject } from '@arabig/origin/functions';
+
+/**
+ * @license
+ * Copyright Salar Arab All Rights Reserved.
+ *
+ * @author Salar Arab <salar_arab@outlook.com>
+ */
+/**
+ * Utilizes performing common operations as pipeline on object-like.
+ *
+ * @remarks
+ * {@link AoRecord} provides a fluent and type-safe API for manipulating objects.
+ * It includes methods for filtering, mapping, and transforming key-value pairs—similar to
+ * array utilities but designed for object semantics.
+ *
+ * This class is ideal for scenarios where object-based data structures need to be processed
+ * functionally, such as configuration maps, lookup tables, or DTO transformations.
+ *
+ * @typeParam T - The type of entries contained in the record.
+ *
+ * @example
+ * ```ts
+ * const rec = new AoRecord({
+ * name: "John",
+ * age: 33,
+ * married: false,
+ * }).filter(({ key }) => key !== "age");
+ * ```
+ */
+class AoRecord {
+    _entries;
+    /**
+     *
+     * @param defaultEntries The default structure to initialize {@link AoRecord} entries
+     */
+    constructor(defaultEntries) {
+        this._entries = defaultEntries;
+    }
+    /**
+     * @readonly Gets keys of the current entries.
+     * @returns An array containing keys of the current entries
+     */
+    get keys() {
+        return Object.keys(this._entries);
+    }
+    /**
+     * @readonly Gets values of the current entries.
+     * @returns An array containing values of the current entries
+     */
+    get values() {
+        return Object.values(this._entries);
+    }
+    /**
+     * @readonly Gets the current entries.
+     * @returns An array containing the current entries in form of {@link AoEntryUnion}
+     */
+    get entries() {
+        return Object.entries(this._entries)
+            .map(e => ({ key: e[0], value: e[1] }));
+    }
+    /**
+     * Filters the current entries based on given condition.
+     * @param predicate The callback that iterates within {@link AoRecord} entries and
+     * provides the key and value in form of {@link AoEntryUnion} as parameter and must
+     * return a boolean type determines whether the current key should be remained in the
+     * resulting entries or not
+     * @returns A new instance of {@link AoRecord} containing the {@link Partial} filtered entries.
+     */
+    filter(predicate) {
+        return new AoRecord(aoFilterObject(this._entries, predicate));
+    }
+    /**
+     * Tests the trueness of the given condition for every entry.
+     * @param predicate The callback that iterates within {@link AoRecord} entries and
+     * provides the key and value in form of {@link AoEntryUnion} as parameter and must
+     * return a boolean type determines the condition for current entry
+     * @returns True, if the given conditions is true for every entry otherwise false
+     */
+    every(predicate) {
+        for (const key in this._entries) {
+            if (!Object.hasOwn(this._entries, key))
+                continue;
+            if (!predicate({ key: key, value: this._entries[key] }))
+                return false;
+        }
+        return true;
+    }
+    /**
+     * Tests the trueness of the given condition for atleast one entry.
+     * @param predicate The callback that iterates within {@link AoRecord} entries and
+     * provides the key and value in form of {@link AoEntryUnion} as parameter and must
+     * return a boolean type determines the condition for current entry
+     * @returns True, if the given conditions is true for atleast one entry otherwise false
+     */
+    some(predicate) {
+        for (const key in this._entries) {
+            if (!Object.hasOwn(this._entries, key))
+                continue;
+            if (predicate({ key: key, value: this._entries[key] }))
+                return true;
+        }
+        return false;
+    }
+}
+
+/**
+ * Generated bundle index. Do not edit.
+ */
+
+export { AoRecord };
+//# sourceMappingURL=arabig-origin-record.mjs.map