bkper-js 2.2.2 → 2.4.0

package/lib/index.d.ts

@@ -628,8 +628,8 @@ export declare class App {
  *
  * @public
  */
-declare class Balance {
-    json: bkper.Balance;
+export declare class Balance {
+    payload: bkper.Balance;
     private container;
     constructor(container: BalancesContainer, balancePlain: bkper.Balance);
     /**
@@ -651,7 +651,7 @@ declare class Balance {
     /**
      * Date object constructed based on [[Book]] time zone offset. Usefull for
      *
-     * If Month or Day is zero, the date will be constructed with first Month (January) or Day (1).
+     * If Month or Day is zero, the date will be constructed with first Month (January) or Day (1) of the next period.
      */
     getDate(): Date;
     /**
@@ -712,6 +712,7 @@ declare class Balance {
  * @public
  */
 export declare interface BalancesContainer {
+    payload: bkper.AccountBalances | bkper.GroupBalances;
     /**
      * Gets the parent [[BalancesReport]] of the container.
      *
@@ -924,7 +925,7 @@ export declare interface BalancesContainer {
  *
  * @public
  */
-declare class BalancesDataTableBuilder implements BalancesDataTableBuilder {
+export declare class BalancesDataTableBuilder implements BalancesDataTableBuilder {
     private balanceType;
     private balancesContainers;
     private periodicity;
@@ -947,7 +948,7 @@ declare class BalancesDataTableBuilder implements BalancesDataTableBuilder {
     private getRepresentativeBalance;
     private getBalanceText;
     /**
-     * Defines whether the dates should be formatted based on date pattern and periodicity of the [[Book]].
+     * Defines whether the dates should be ISO formatted YYYY-MM-DD. E.g. 2025-01-01
      *
      * @returns This builder with respective formatting option, for chaining.
      */
@@ -985,17 +986,16 @@ declare class BalancesDataTableBuilder implements BalancesDataTableBuilder {
      * For **PERIOD** or **CUMULATIVE** [[BalanceType]], the table will be a time table, and the format looks like:
      *
      * ```
-     *  _____________________________________________
-     *  |            |  Expenses | Income  |    ...   |
-     *  | 15/01/2014 | -2345.23  | 3452.93 |    ...   |
-     *  | 15/02/2014 | -2345.93  | 3456.46 |    ...   |
-     *  | 15/03/2014 | -2456.45  | 3567.87 |    ...   |
-     *  |    ...     |    ...    |   ...   |    ...   |
-     *  |____________|___________|_________|__________|
+     *  _______________________________________________________________
+     *  |            | 15/01/2014 | 15/02/2014 | 15/03/2014 |    ...    |
+     *  |  Expenses  | -2345.23   | -2345.93   | -2456.45   |    ...    |
+     *  |  Income    |  3452.93   |  3456.46   |  3567.87   |    ...    |
+     *  |     ...    |     ...    |     ...    |     ...    |    ...    |
+     *  |____________|____________|____________|____________|___________|
      *
      * ```
      *
-     * First column will be the Date column, and one column for each [[Account]] or [[Group]].
+     * First column will be the [[Account]] or [[Group]] name, and one column for each Date.
      *
      * @returns This builder with respective balance type, for chaining.
      */
@@ -1019,15 +1019,16 @@ declare class BalancesDataTableBuilder implements BalancesDataTableBuilder {
      *
      * ```
      *   _______________________________________________________________
-     *  |            | 15/01/2014 | 15/02/2014 | 15/03/2014 |    ...    |
-     *  |  Expenses  | -2345.23   | -2345.93   | -2456.45   |    ...    |
-     *  |  Income    |  3452.93   |  3456.46   |  3567.87   |    ...    |
+     *  |            | Expenses   | Income     |     ...    |    ...    |
+     *  | 15/01/2014 | -2345.23   |  3452.93   |     ...    |    ...    |
+     *  | 15/02/2014 | -2345.93   |  3456.46   |     ...    |    ...    |
+     *  | 15/03/2014 | -2456.45   |  3567.87   |     ...    |    ...    |
      *  |     ...    |     ...    |     ...    |     ...    |    ...    |
      *  |____________|____________|____________|____________|___________|
      *
      * ```
      *
-     * First column will be each [[Account]] or [[Group]], and one column for each Date.
+     * First column will be each Date, and one column for each [[Account]] or [[Group]].
      *
      * @returns This builder with respective transposed option, for chaining.
      */
@@ -1102,6 +1103,10 @@ export declare class BalancesReport {
      * @returns The [[Book]] that generated the report
      */
     getBook(): Book;
+    /**
+     * Creates a BalancesDataTableBuilder to generate a two-dimensional array with all [[BalancesContainers]].
+     */
+    createDataTable(): BalancesDataTableBuilder;
     /**
      * Gets the [[Periodicity]] of the query used to generate the report.
      *
@@ -1132,7 +1137,7 @@ export declare class BalancesReport {
  *
  * @public
  */
-declare enum BalanceType {
+export declare enum BalanceType {
     /**
      * Total balance
      */
@@ -1185,10 +1190,17 @@ export declare class Bkper {
      *
      * @param id - The universal book id - The same bookId param of URL you access at app.bkper.com
      * @param includeAccounts - Optional parameter to include accounts in the retrieved Book
+     * @param includeGroups - Optional parameter to include groups in the retrieved Book
+     *
+     * If both includeAccounts and includeGroups are false, the Book will be returned with only the basic information.
+     *
+     * If includeAccounts is true, the Book will be returned with the accounts and groups.
+     *
+     * If includeGroups is true, the Book will be returned with the groups.
      *
      * @returns The retrieved Book
      */
-    getBook(id: string, includeAccounts?: boolean): Promise<Book>;
+    getBook(id: string, includeAccounts?: boolean, includeGroups?: boolean): Promise<Book>;
     /**
      * Gets all [[Books]] the user has access to.
      *

package/lib/index.js

@@ -9,6 +9,8 @@ export { Account } from './model/Account.js';
 export { Agent } from './model/Agent.js';
 export { Amount } from "./model/Amount.js";
 export { App } from './model/App.js';
+export { Balance } from './model/Balance.js';
+export { BalancesDataTableBuilder } from './model/BalancesDataTableBuilder.js';
 export { BalancesReport } from './model/BalancesReport.js';
 export { Bkper } from './model/Bkper.js';
 export { Book } from './model/Book.js';
@@ -27,5 +29,5 @@ export { Event } from './model/Event.js';
 export { BotResponse } from './model/BotResponse.js';
 export { EventList } from './model/EventList.js';
 export { User } from './model/User.js';
-export { Periodicity, DecimalSeparator, Permission, Visibility, AccountType, Period, Month, EventType, BotResponseType } from './model/Enums.js';
+export { Periodicity, DecimalSeparator, Permission, Visibility, AccountType, BalanceType, Period, Month, EventType, BotResponseType } from './model/Enums.js';
 //# sourceMappingURL=index.js.map

package/lib/model/Balance.js

@@ -8,7 +8,7 @@ import { Amount } from "./Amount.js";
 export class Balance {
     constructor(container, balancePlain) {
         this.container = container;
-        this.json = balancePlain;
+        this.payload = balancePlain;
     }
     /**
      * The day of the balance. Days starts on 1 to 31.
@@ -16,7 +16,7 @@ export class Balance {
      * Day can be 0 (zero) in case of Monthly or Early [[Periodicity]] of the [[BalancesReport]]
      */
     getDay() {
-        return this.json.day;
+        return this.payload.day;
     }
     /**
      * The month of the balance. Months starts on 1 (January) to 12 (December)
@@ -24,18 +24,18 @@ export class Balance {
      * Month can be 0 (zero) in case of Early [[Periodicity]] of the [[BalancesReport]]
      */
     getMonth() {
-        return this.json.month;
+        return this.payload.month;
     }
     /**
      * The year of the balance
      */
     getYear() {
-        return this.json.year;
+        return this.payload.year;
     }
     /**
      * Date object constructed based on [[Book]] time zone offset. Usefull for
      *
-     * If Month or Day is zero, the date will be constructed with first Month (January) or Day (1).
+     * If Month or Day is zero, the date will be constructed with first Month (January) or Day (1) of the next period.
      */
     getDate() {
         var year = this.getYear();
@@ -66,7 +66,7 @@ export class Balance {
      * **20180000** - 2018 - YEARLY Periodicity
      */
     getFuzzyDate() {
-        return this.json.fuzzyDate;
+        return this.payload.fuzzyDate;
     }
     /**
      * The cumulative balance to the date, based on the credit nature of the container
@@ -78,19 +78,19 @@ export class Balance {
      * The raw cumulative balance to the date.
      */
     getCumulativeBalanceRaw() {
-        return new Amount(this.json.cumulativeBalance);
+        return new Amount(this.payload.cumulativeBalance);
     }
     /**
      * The cumulative credit to the date.
      */
     getCumulativeCredit() {
-        return new Amount(this.json.cumulativeCredit);
+        return new Amount(this.payload.cumulativeCredit);
     }
     /**
      * The cumulative debit to the date.
      */
     getCumulativeDebit() {
-        return new Amount(this.json.cumulativeDebit);
+        return new Amount(this.payload.cumulativeDebit);
     }
     /**
      * The balance on the date period, based on credit nature of the container.
@@ -102,19 +102,19 @@ export class Balance {
      * The raw balance on the date period.
      */
     getPeriodBalanceRaw() {
-        return new Amount(this.json.periodBalance);
+        return new Amount(this.payload.periodBalance);
     }
     /**
      * The credit on the date period.
      */
     getPeriodCredit() {
-        return new Amount(this.json.periodCredit);
+        return new Amount(this.payload.periodCredit);
     }
     /**
      * The debit on the date period.
      */
     getPeriodDebit() {
-        return new Amount(this.json.periodDebit);
+        return new Amount(this.payload.periodDebit);
     }
 }
 //# sourceMappingURL=Balance.js.map

package/lib/model/BalancesDataTableBuilder.js

@@ -42,7 +42,7 @@ export class BalancesDataTableBuilder {
         return this.book.formatValue(this.getRepresentativeBalance(balance, permanent));
     }
     /**
-     * Defines whether the dates should be formatted based on date pattern and periodicity of the [[Book]].
+     * Defines whether the dates should be ISO formatted YYYY-MM-DD. E.g. 2025-01-01
      *
      * @returns This builder with respective formatting option, for chaining.
      */
@@ -101,17 +101,16 @@ export class BalancesDataTableBuilder {
      * For **PERIOD** or **CUMULATIVE** [[BalanceType]], the table will be a time table, and the format looks like:
      *
      * ```
-     *  _____________________________________________
-     *  |            |  Expenses | Income  |    ...   |
-     *  | 15/01/2014 | -2345.23  | 3452.93 |    ...   |
-     *  | 15/02/2014 | -2345.93  | 3456.46 |    ...   |
-     *  | 15/03/2014 | -2456.45  | 3567.87 |    ...   |
-     *  |    ...     |    ...    |   ...   |    ...   |
-     *  |____________|___________|_________|__________|
+     *  _______________________________________________________________
+     *  |            | 15/01/2014 | 15/02/2014 | 15/03/2014 |    ...    |
+     *  |  Expenses  | -2345.23   | -2345.93   | -2456.45   |    ...    |
+     *  |  Income    |  3452.93   |  3456.46   |  3567.87   |    ...    |
+     *  |     ...    |     ...    |     ...    |     ...    |    ...    |
+     *  |____________|____________|____________|____________|___________|
      *
      * ```
      *
-     * First column will be the Date column, and one column for each [[Account]] or [[Group]].
+     * First column will be the [[Account]] or [[Group]] name, and one column for each Date.
      *
      * @returns This builder with respective balance type, for chaining.
      */
@@ -138,15 +137,16 @@ export class BalancesDataTableBuilder {
      *
      * ```
      *   _______________________________________________________________
-     *  |            | 15/01/2014 | 15/02/2014 | 15/03/2014 |    ...    |
-     *  |  Expenses  | -2345.23   | -2345.93   | -2456.45   |    ...    |
-     *  |  Income    |  3452.93   |  3456.46   |  3567.87   |    ...    |
+     *  |            | Expenses   | Income     |     ...    |    ...    |
+     *  | 15/01/2014 | -2345.23   |  3452.93   |     ...    |    ...    |
+     *  | 15/02/2014 | -2345.93   |  3456.46   |     ...    |    ...    |
+     *  | 15/03/2014 | -2456.45   |  3567.87   |     ...    |    ...    |
      *  |     ...    |     ...    |     ...    |     ...    |    ...    |
      *  |____________|____________|____________|____________|___________|
      *
      * ```
      *
-     * First column will be each [[Account]] or [[Group]], and one column for each Date.
+     * First column will be each Date, and one column for each [[Account]] or [[Group]].
      *
      * @returns This builder with respective transposed option, for chaining.
      */
@@ -235,7 +235,7 @@ export class BalancesDataTableBuilder {
                 this.flattenAllAccounts(container, containersFlat, propertyKeys);
                 containersFlat.sort(this.sortContainersFunction);
             }
-            else if (this.expandAllGroups) {
+            else if (container.isFromGroup() && this.expandAllGroups) {
                 this.flattenAllGroups(container, containersFlat, propertyKeys);
             }
             else {
@@ -302,8 +302,7 @@ export class BalancesDataTableBuilder {
         let depth = container.getDepth();
         if (depth <= this.maxDepth) {
             if (!this.skipRoot && !this.shouldTranspose) {
-                //@ts-ignore
-                container.json.name = Utils_.repeatString(" ", depth * 4) + container.json.name;
+                container.payload.name = Utils.repeatString(" ", depth * 4) + container.payload.name;
             }
             if (!this.skipRoot || depth != 0) {
                 containersFlat.push(container);
@@ -324,8 +323,7 @@ export class BalancesDataTableBuilder {
         if (container.isFromGroup()) {
             if (!this.shouldTranspose) {
                 let depth = container.getDepth();
-                //@ts-ignore
-                container.json.name = Utils_.repeatString(" ", depth * 4) + container.json.name;
+                container.payload.name = Utils.repeatString(" ", depth * 4) + container.payload.name;
             }
             containersFlat.push(container);
             if (this.shouldAddProperties) {
@@ -553,12 +551,12 @@ export class BalancesDataTableBuilder {
             table.push(row);
         }
         if (this.shouldFormatDate && table.length > 0) {
-            var pattern = Utils.getDateFormatterPattern(this.book.getDatePattern(), this.periodicity);
+            // var pattern = Utils.getDateFormatterPattern(this.book.getDatePattern(), this.periodicity);
             for (var j = 1; j < table.length; j++) {
                 var row = table[j];
                 if (row.length > 0) {
                     //first column
-                    row[0] = Utils.formatDate(row[0], pattern, this.book.getTimeZone());
+                    row[0] = Utils.formatDateISO(row[0], this.book.getTimeZone());
                 }
             }
         }
@@ -578,7 +576,7 @@ export class BalancesDataTableBuilder {
         if (this.shouldHideDates) {
             table = table.map(row => row.slice(1));
         }
-        if (this.shouldTranspose && table.length > 0) {
+        if (!this.shouldTranspose && table.length > 0) {
             table = table[0].map((col, i) => table.map(row => row[i]));
         }
         return table;

package/lib/model/BalancesReport.js

@@ -1,6 +1,7 @@
 import { normalizeName } from '../utils.js';
 import { AccountBalancesContainer } from "./BalancesContainerAccount.js";
 import { GroupBalancesContainer } from "./BalancesContainerGroup.js";
+import { BalancesDataTableBuilder } from './BalancesDataTableBuilder.js';
 /**
  * Class representing a Balance Report, generated when calling [Book.getBalanceReport](#book_getbalancesreport)
  *
@@ -19,6 +20,12 @@ export class BalancesReport {
     getBook() {
         return this.book;
     }
+    /**
+     * Creates a BalancesDataTableBuilder to generate a two-dimensional array with all [[BalancesContainers]].
+     */
+    createDataTable() {
+        return new BalancesDataTableBuilder(this.book, this.getBalancesContainers(), this.getPeriodicity());
+    }
     /**
      * Gets the [[Periodicity]] of the query used to generate the report.
      *
@@ -35,11 +42,11 @@ export class BalancesReport {
     getBalancesContainers() {
         let containers = [];
         const accountContainers = this.getRootAccountBalancesContainers();
-        if (accountContainers && accountContainers.length > 0) {
+        if (accountContainers != null && accountContainers.length > 0) {
             containers = containers.concat(accountContainers);
         }
         const groupContainers = this.getGroupBalancesContainers();
-        if (groupContainers && groupContainers.length > 0) {
+        if (groupContainers != null && groupContainers.length > 0) {
             containers = containers.concat(groupContainers);
         }
         return containers;

package/lib/model/Bkper.js

@@ -63,12 +63,19 @@ export class Bkper {
      *
      * @param id - The universal book id - The same bookId param of URL you access at app.bkper.com
      * @param includeAccounts - Optional parameter to include accounts in the retrieved Book
+     * @param includeGroups - Optional parameter to include groups in the retrieved Book
+     *
+     * If both includeAccounts and includeGroups are false, the Book will be returned with only the basic information.
+     *
+     * If includeAccounts is true, the Book will be returned with the accounts and groups.
+     *
+     * If includeGroups is true, the Book will be returned with the groups.
      *
      * @returns The retrieved Book
      */
-    getBook(id, includeAccounts) {
+    getBook(id, includeAccounts, includeGroups) {
         return __awaiter(this, void 0, void 0, function* () {
-            let book = yield BookService.loadBook(id, includeAccounts);
+            let book = yield BookService.loadBook(id, includeAccounts, includeGroups);
             return new Book(book);
         });
     }

package/lib/service/book-service.js

@@ -26,13 +26,14 @@ export function loadBooks(query) {
         return booksJson;
     });
 }
-export function loadBook(bookId, loadAccounts) {
+export function loadBook(bookId, loadAccounts, loadGroups) {
     return __awaiter(this, void 0, void 0, function* () {
         if (bookId == null) {
             throw new Error("Book id null!");
         }
         loadAccounts = loadAccounts || false;
-        let response = yield new HttpBooksApiV5Request(bookId).addParam('loadAccounts', loadAccounts).fetch();
+        loadGroups = loadGroups || false;
+        let response = yield new HttpBooksApiV5Request(bookId).addParam('loadAccounts', loadAccounts).addParam('loadGroups', loadGroups).fetch();
         return response.data;
     });
 }

package/lib/utils.js

@@ -10,6 +10,16 @@ export function sleep(ms) {
 export function base64Decode(data) {
     return Buffer.from(data, 'base64');
 }
+export function repeatString(text, times) {
+    if (times <= 0) {
+        return "";
+    }
+    if (times === 1) {
+        return text;
+    }
+    return text + repeatString(text, times - 1);
+    ;
+}
 //SAME AS bkper-app
 var diacriticsMap_ = null;
 export function round(number, fractionDigits) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "2.2.2",
+  "version": "2.4.0",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",