bkper-js 1.47.2 → 2.0.0

package/lib/model/Account.js

@@ -10,13 +10,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import * as AccountService from '../service/account-service.js';
 import * as GroupService from '../service/group-service.js';
 import { Group } from './Group.js';
-import { normalizeText, round } from '../utils.js';
-import { Amount } from './Amount.js';
+import { normalizeText } from '../utils.js';
 /**
- *
  * This class defines an [Account](https://en.wikipedia.org/wiki/Account_(bookkeeping)) of a [[Book]].
  *
- * It mantains a balance of all amount [credited and debited](http://en.wikipedia.org/wiki/Debits_and_credits) in it by [[Transactions]].
+ * It maintains a balance of all amount [credited and debited](http://en.wikipedia.org/wiki/Debits_and_credits) in it by [[Transactions]].
  *
  * An Account can be grouped by [[Groups]].
  *
@@ -30,35 +28,44 @@ export class Account {
         };
     }
     /**
+     * Gets an immutable copy of the JSON payload.
+     *
      * @returns An immutable copy of the json payload
      */
     json() {
         return Object.assign({}, this.payload);
     }
     /**
-     * Gets the account internal id.
+     * Gets the Account internal id.
+     *
+     * @returns The Account internal id
      */
     getId() {
         return this.payload.id;
     }
     /**
-     * Gets the account name.
+     * Gets the Account name.
+     *
+     * @returns The Account name
      */
     getName() {
         return this.payload.name;
     }
     /**
-     *
      * Sets the name of the Account.
      *
-     * @returns This Account, for chainning.
+     * @param name - The name to set
+     *
+     * @returns This Account, for chaining
      */
     setName(name) {
         this.payload.name = name;
         return this;
     }
     /**
-     * @returns The name of this account without spaces or special characters.
+     * Gets the normalized name of this Account without spaces or special characters.
+     *
+     * @returns The name of this Account without spaces or special characters
      */
     getNormalizedName() {
         if (this.payload.normalizedName) {
@@ -69,16 +76,19 @@ export class Account {
         }
     }
     /**
-     * @returns The type for of this account.
+     * Gets the type of this Account.
+     *
+     * @returns The [[AccountType]] of this Account
      */
     getType() {
         return this.payload.type;
     }
     /**
-     *
      * Sets the type of the Account.
      *
-     * @returns This Account, for chainning
+     * @param type - The [[AccountType]] to set
+     *
+     * @returns This Account, for chaining
      */
     setType(type) {
         this.payload.type = type;
@@ -86,25 +96,29 @@ export class Account {
     }
     /**
      * Gets the custom properties stored in this Account.
+     *
+     * @returns The custom properties object
      */
     getProperties() {
         return this.payload.properties != null ? Object.assign({}, this.payload.properties) : {};
     }
     /**
-     * Sets the custom properties of the Account
+     * Sets the custom properties of the Account.
      *
      * @param properties - Object with key/value pair properties
      *
-     * @returns This Account, for chainning.
+     * @returns This Account, for chaining
      */
     setProperties(properties) {
         this.payload.properties = Object.assign({}, properties);
         return this;
     }
     /**
-     * Gets the property value for given keys. First property found will be retrieved
+     * Gets the property value for given keys. First property found will be retrieved.
      *
      * @param keys - The property key
+     *
+     * @returns The property value or undefined if not found
      */
     getProperty(...keys) {
         for (let index = 0; index < keys.length; index++) {
@@ -122,7 +136,7 @@ export class Account {
      * @param key - The property key
      * @param value - The property value
      *
-     * @returns This Account, for chainning.
+     * @returns This Account, for chaining
      */
     setProperty(key, value) {
         if (key == null || key.trim() == '') {
@@ -138,72 +152,53 @@ export class Account {
         return this;
     }
     /**
-     * Delete a custom property
+     * Deletes a custom property.
      *
      * @param key - The property key
      *
-     * @returns This Account, for chainning.
+     * @returns This Account, for chaining
      */
     deleteProperty(key) {
         this.setProperty(key, null);
         return this;
     }
     /**
-     * Gets the balance based on credit nature of this Account.
-     * @deprecated Use `Book.getBalancesReport` instead.
-     * @returns The balance of this account.
-     */
-    getBalance() {
-        var balance = new Amount('0');
-        if (this.payload.balance != null) {
-            balance = round(this.payload.balance, this.book.getFractionDigits());
-        }
-        return balance;
-    }
-    /**
-     * Gets the raw balance, no matter credit nature of this Account.
-     * @deprecated Use `Book.getBalancesReport` instead.
-     * @returns The balance of this account.
-     */
-    getBalanceRaw() {
-        var balance = new Amount('0');
-        if (this.payload.balance != null) {
-            balance = round(this.payload.balance, this.book.getFractionDigits());
-        }
-        return balance;
-    }
-    /**
-     * Tell if this account is archived.
+     * Tells if this Account is archived.
+     *
+     * @returns True if the Account is archived
      */
     isArchived() {
         return this.payload.archived;
     }
     /**
-     * Set account archived/unarchived.
+     * Sets Account archived/unarchived.
+     *
+     * @param archived - True to archive, false to unarchive
      *
-     * @returns This Account, for chainning.
+     * @returns This Account, for chaining
      */
     setArchived(archived) {
         this.payload.archived = archived;
         return this;
     }
     /**
-     * Tell if the Account has any transaction already posted.
+     * Tells if the Account has any transaction already posted.
      *
      * Accounts with transaction posted, even with zero balance, can only be archived.
+     *
+     * @returns True if the Account has transactions posted
      */
     hasTransactionPosted() {
         return this.payload.hasTransactionPosted;
     }
     /**
-     *
-     * Tell if the account is permanent.
+     * Tells if the Account is permanent.
      *
      * Permanent Accounts are the ones which final balance is relevant and keep its balances over time.
      *
-     * They are also called [Real Accounts](http://en.wikipedia.org/wiki/Account_(accountancy)#Based_on_periodicity_of_flow)
+     * They are also called [Real Accounts](http://en.wikipedia.org/wiki/Account_(Accountancy)#Based_on_periodicity_of_flow)
      *
-     * Usually represents assets or tangibles, capable of being perceived by the senses or the mind, like bank accounts, money, debts and so on.
+     * Usually represents assets or tangibles, capable of being perceived by the senses or the mind, like bank Accounts, money, debts and so on.
      *
      * @returns True if its a permanent Account
      */
@@ -211,30 +206,34 @@ export class Account {
         return this.payload.permanent;
     }
     /**
-     * Tell if the account has a Credit nature or Debit otherwise
+     * Tells if the Account has a Credit nature or Debit otherwise.
      *
-     * Credit accounts are just for representation purposes. It increase or decrease the absolute balance. It doesn't affect the overall balance or the behavior of the system.
+     * Credit Accounts are just for representation purposes. It increase or decrease the absolute balance. It doesn't affect the overall balance or the behavior of the system.
      *
-     * The absolute balance of credit accounts increase when it participate as a credit/origin in a transaction. Its usually for Accounts that increase the balance of the assets, like revenue accounts.
+     * The absolute balance of credit Accounts increase when it participate as a credit/origin in a transaction. Its usually for Accounts that increase the balance of the assets, like revenue Accounts.
      *
      * ```
      *         Crediting a credit
-     *   Thus ---------------------> account increases its absolute balance
+     *   Thus ---------------------> Account increases its absolute balance
      *         Debiting a debit
      *
      *
      *         Debiting a credit
-     *   Thus ---------------------> account decreases its absolute balance
+     *   Thus ---------------------> Account decreases its absolute balance
      *         Crediting a debit
      * ```
      *
-     * As a rule of thumb, and for simple understanding, almost all accounts are Debit nature (NOT credit), except the ones that "offers" amount for the books, like revenue accounts.
+     * As a rule of thumb, and for simple understanding, almost all Accounts are Debit nature (NOT credit), except the ones that "offers" amount for the books, like revenue Accounts.
+     *
+     * @returns True if the Account has credit nature
      */
     isCredit() {
         return this.payload.credit;
     }
     /**
-     * Get the [[Groups]] of this account.
+     * Gets the [[Groups]] of this Account.
+     *
+     * @returns Promise with the [[Groups]] of this Account
      */
     getGroups() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -250,7 +249,9 @@ export class Account {
     /**
      * Sets the groups of the Account.
      *
-     * @returns This Account, for chainning.
+     * @param groups - The groups to set
+     *
+     * @returns This Account, for chaining
      */
     setGroups(groups) {
         this.payload.groups = undefined;
@@ -260,9 +261,11 @@ export class Account {
         return this;
     }
     /**
-     * Add a group to the Account.
+     * Adds a group to the Account.
+     *
+     * @param group - The group to add
      *
-     * @returns This Account, for chainning.
+     * @returns This Account, for chaining
      */
     addGroup(group) {
         if (!this.payload.groups) {
@@ -277,7 +280,11 @@ export class Account {
         return this;
     }
     /**
-     * Remove a group from the Account.
+     * Removes a group from the Account.
+     *
+     * @param group - The group name, id or object to remove
+     *
+     * @returns Promise with this Account, for chaining
      */
     removeGroup(group) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -302,9 +309,11 @@ export class Account {
         });
     }
     /**
-     * Tell if this account is in the [[Group]]
+     * Tells if this Account is in the [[Group]].
      *
-     * @param  group - The Group name, id or object
+     * @param group - The Group name, id or object
+     *
+     * @returns Promise with true if the Account is in the group
      */
     isInGroup(group) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -336,7 +345,9 @@ export class Account {
         return false;
     }
     /**
-     * Perform create new account.
+     * Performs create new Account.
+     *
+     * @returns Promise with this Account after creation
      */
     create() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -346,7 +357,9 @@ export class Account {
         });
     }
     /**
-     * Perform update account, applying pending changes.
+     * Performs update Account, applying pending changes.
+     *
+     * @returns Promise with this Account after update
      */
     update() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -356,7 +369,9 @@ export class Account {
         });
     }
     /**
-     * Perform delete account.
+     * Performs delete Account.
+     *
+     * @returns Promise with this Account after deletion
      */
     remove() {
         return __awaiter(this, void 0, void 0, function* () {

package/lib/model/Agent.js

@@ -10,12 +10,15 @@ export class Agent {
         this.payload = payload || {};
     }
     /**
+     * Gets the wrapped plain JSON object.
+     *
      * @returns The wrapped plain json object
      */
     json() {
         return Object.assign({}, this.payload);
     }
     /**
+     * Gets the Agent universal identifier.
      *
      * @returns The Agent universal identifier
      */
@@ -23,6 +26,7 @@ export class Agent {
         return this.payload.id;
     }
     /**
+     * Gets the Agent name.
      *
      * @returns The Agent name
      */
@@ -30,6 +34,7 @@ export class Agent {
         return this.payload.name;
     }
     /**
+     * Gets the Agent logo URL.
      *
      * @returns The Agent logo url
      */
@@ -37,6 +42,7 @@ export class Agent {
         return this.payload.logo;
     }
     /**
+     * Gets the Agent logo URL in dark mode.
      *
      * @returns The Agent logo url in dark mode
      */

package/lib/model/Amount.js

@@ -9,6 +9,8 @@ import Big from "big.js";
 export class Amount {
     /**
      * The Amount constructor.
+     *
+     * @param n - The number, string, or Amount to initialize with
      */
     constructor(n) {
         this.checkNumberNotNull(n);
@@ -27,13 +29,19 @@ export class Amount {
     }
     /**
      * Returns an absolute Amount.
+     *
+     * @returns The absolute value as a new Amount
      */
     abs() {
         let big = this.big.abs();
         return this.wrap(big);
     }
     /**
-     * Compare
+     * Compares this Amount with another value.
+     *
+     * @param n - The value to compare with
+     *
+     * @returns -1 if less than, 0 if equal, 1 if greater than
      */
     cmp(n) {
         this.checkNumberNotNull(n);
@@ -51,7 +59,11 @@ export class Amount {
         }
     }
     /**
-     * Divide by
+     * Divides this Amount by another value.
+     *
+     * @param n - The divisor value
+     *
+     * @returns The division result as a new Amount
      */
     div(n) {
         this.checkNumberNotNull(n);
@@ -71,7 +83,11 @@ export class Amount {
         return this.wrap(big);
     }
     /**
-     * Equals to
+     * Checks if this Amount equals another value.
+     *
+     * @param n - The value to compare with
+     *
+     * @returns True if equal, false otherwise
      */
     eq(n) {
         this.checkNumberNotNull(n);
@@ -89,7 +105,11 @@ export class Amount {
         }
     }
     /**
-     * Greater than
+     * Checks if this Amount is greater than another value.
+     *
+     * @param n - The value to compare with
+     *
+     * @returns True if greater than, false otherwise
      */
     gt(n) {
         this.checkNumberNotNull(n);
@@ -107,7 +127,11 @@ export class Amount {
         }
     }
     /**
-     * Greater than or equal
+     * Checks if this Amount is greater than or equal to another value.
+     *
+     * @param n - The value to compare with
+     *
+     * @returns True if greater than or equal, false otherwise
      */
     gte(n) {
         this.checkNumberNotNull(n);
@@ -125,7 +149,11 @@ export class Amount {
         }
     }
     /**
-     * Less than
+     * Checks if this Amount is less than another value.
+     *
+     * @param n - The value to compare with
+     *
+     * @returns True if less than, false otherwise
      */
     lt(n) {
         this.checkNumberNotNull(n);
@@ -143,7 +171,11 @@ export class Amount {
         }
     }
     /**
-     * Less than or equal to
+     * Checks if this Amount is less than or equal to another value.
+     *
+     * @param n - The value to compare with
+     *
+     * @returns True if less than or equal, false otherwise
      */
     lte(n) {
         this.checkNumberNotNull(n);
@@ -161,7 +193,11 @@ export class Amount {
         }
     }
     /**
-     * Sum
+     * Adds another value to this Amount.
+     *
+     * @param n - The value to add
+     *
+     * @returns The sum as a new Amount
      */
     plus(n) {
         this.checkNumberNotNull(n);
@@ -181,7 +217,11 @@ export class Amount {
         return this.wrap(big);
     }
     /**
-     * Minus
+     * Subtracts another value from this Amount.
+     *
+     * @param n - The value to subtract
+     *
+     * @returns The difference as a new Amount
      */
     minus(n) {
         this.checkNumberNotNull(n);
@@ -201,10 +241,13 @@ export class Amount {
         return this.wrap(big);
     }
     /**
-     * Modulo - the integer remainder of dividing this Amount by n.
+     * Calculates the modulo (remainder) of dividing this Amount by another value.
      *
      * Similar to % operator
      *
+     * @param n - The divisor value
+     *
+     * @returns The remainder as a new Amount
      */
     mod(n) {
         this.checkNumberNotNull(n);
@@ -224,14 +267,22 @@ export class Amount {
         return this.wrap(big);
     }
     /**
-     * Round to a maximum of dp decimal places.
+     * Rounds this Amount to a maximum of dp decimal places.
+     *
+     * @param dp - The number of decimal places (optional)
+     *
+     * @returns The rounded value as a new Amount
      */
     round(dp) {
         let big = this.big.round(dp);
         return this.wrap(big);
     }
     /**
-     * Multiply
+     * Multiplies this Amount by another value.
+     *
+     * @param n - The value to multiply by
+     *
+     * @returns The product as a new Amount
      */
     times(n) {
         this.checkNumberNotNull(n);
@@ -251,19 +302,27 @@ export class Amount {
         return this.wrap(big);
     }
     /**
-     * Returns a string representing the value of this Amount in normal notation to a fixed number of decimal places dp.
+     * Returns a string representing the value of this Amount in normal notation to a fixed number of decimal places.
+     *
+     * @param dp - The number of decimal places (optional)
+     *
+     * @returns The formatted string representation
      */
     toFixed(dp) {
         return this.big.toFixed(dp);
     }
     /**
      * Returns a string representing the value of this Amount.
+     *
+     * @returns The string representation of this Amount
      */
     toString() {
         return this.big.toString();
     }
     /**
      * Returns a primitive number representing the value of this Amount.
+     *
+     * @returns The numeric value of this Amount
      */
     toNumber() {
         return this.big.toNumber();