bkper-js 1.16.1 → 1.18.0

package/lib/index.d.ts

@@ -756,6 +756,7 @@ export declare class Book {
 
 
 
+
     /**
      * Gets a [[Group]] object
      *
@@ -788,6 +789,19 @@ export declare class Book {
      * @returns A TransactionPage object containing the list of transactions
      */
     listTransactions(query?: string, limit?: number, cursor?: string): Promise<TransactionList>;
+    /**
+     * Lists events in the Book based on the provided parameters.
+     *
+     * @param afterDate - The start date (inclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format. Can be null.
+     * @param beforeDate - The end date (exclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format. Can be null.
+     * @param onError - True to search only for events on error.
+     * @param resourceId - The ID of the event's resource (Transaction, Account, or Group). Can be null.
+     * @param limit - The maximum number of events to return.
+     * @param cursor - The cursor for pagination. Can be null.
+     *
+     * @returns An EventList object containing the list of events.
+     */
+    listEvents(afterDate: string | null, beforeDate: string | null, onError: boolean, resourceId: string | null, limit: number, cursor?: string): Promise<EventList>;
     /**
      * Retrieve a transaction by id
      */
@@ -1116,6 +1130,50 @@ export declare enum DecimalSeparator {
     DOT = "DOT"
 }
 
+/**
+ * Represents an Event in the system.
+ *
+ * @public
+ */
+export declare class Event {
+    payload: bkper.Event;
+    constructor(payload?: bkper.Event);
+    /**
+     * @returns The wrapped plain json object
+     */
+    json(): bkper.Event;
+}
+
+/**
+ * A list associated with an event query.
+ */
+export declare class EventList {
+    private payload;
+
+    constructor(book: Book, payload: bkper.EventList);
+    /**
+     * @returns The cursor associated with the query for pagination.
+     */
+    getCursor(): string | undefined;
+    /**
+     * @returns The first Event in the list.
+     */
+    getFirst(): Event | undefined;
+    /**
+     *
+     * Get the total number of events in the list.
+     *
+     * @returns The total number of events.
+     */
+    size(): number;
+    /**
+     * Get the events in the list.
+     *
+     * @returns An array of Event objects.
+     */
+    getItems(): Event[];
+}
+
 /**
  *
  * This class defines a File uploaded to a [[Book]].
@@ -1194,6 +1252,10 @@ export declare class File {
  */
 export declare class Group {
     payload: bkper.Group;
+    private parent?;
+    private depth?;
+    private root?;
+    private children;
 
 
     constructor(book: Book, payload?: bkper.Group);
@@ -1205,16 +1267,6 @@ export declare class Group {
      * @returns The id of this Group
      */
     getId(): string | undefined;
-    /**
-     * @returns The parent Group
-     */
-    getParent(): Promise<Group | undefined>;
-    /**
-     * Sets the parent Group.
-     *
-     * @returns This Group, for chainning.
-     */
-    setParent(group: Group | null | undefined): Group;
     /**
      * @returns The name of this Group
      */
@@ -1233,10 +1285,6 @@ export declare class Group {
      * @returns All Accounts of this group.
      */
     getAccounts(): Promise<Account[]>;
-    /**
-     * @returns True if this group has any account in it
-     */
-    hasAccounts(): boolean | undefined;
     /**
      * @returns The type for of the accounts of this group. Null if mixed
      */
@@ -1286,6 +1334,87 @@ export declare class Group {
      *  Hide/Show group on main menu.
      */
     setHidden(hidden: boolean): Group;
+    /**
+     * Tell if the Group is permanent
+     */
+    isPermanent(): boolean | undefined;
+    /**
+     * @returns The parent Group
+     */
+    getParent(): Group | undefined;
+    /**
+     * Sets the parent Group.
+     *
+     * @returns This Group, for chainning.
+     */
+    setParent(group: Group | null | undefined): Group;
+    /**
+     * Checks if the Group has a parent.
+     *
+     * @returns True if the Group has a parent, otherwise false.
+     */
+    hasParent(): boolean;
+    /**
+     * Retrieves the children of the Group.
+     *
+     * @returns An array of child Groups.
+     */
+    getChildren(): Group[];
+    /**
+     * Retrieves all descendant Groups of the current Group.
+     *
+     * @returns A set of descendant Groups.
+     */
+    getDescendants(): Set<Group>;
+    /**
+     * Retrieves the IDs of all descendant Groups in a tree structure.
+     *
+     * @returns A set of descendant Group IDs.
+     */
+    getDescendantTreeIds(): Set<string>;
+    /**
+     * Checks if the Group has any children.
+     *
+     * @returns True if the Group has children, otherwise false.
+     */
+    hasChildren(): boolean;
+    /**
+     * Checks if the Group is a leaf node (i.e., has no children).
+     *
+     * @returns True if the Group is a leaf, otherwise false.
+     */
+    isLeaf(): boolean;
+    /**
+     * Checks if the Group is a root node (i.e., has no parent).
+     *
+     * @returns True if the Group is a root, otherwise false.
+     */
+    isRoot(): boolean;
+    /**
+     * Retrieves the depth of the Group in the hierarchy.
+     *
+     * @returns The depth of the Group.
+     */
+    getDepth(): number;
+    /**
+     * Retrieves the root Group of the current Group.
+     *
+     * @returns The root Group.
+     */
+    getRoot(): Group;
+    /**
+     * Retrieves the name of the root Group.
+     *
+     * @returns The name of the root Group.
+     */
+    getRootName(): string;
+
+
+
+    /**
+     * @returns True if this group has any account in it
+     */
+    hasAccounts(): boolean | undefined;
     /**
      * Perform create new group.
      */

package/lib/index.js

@@ -18,6 +18,8 @@ export { Integration } from './model/Integration.js';
 export { Template } from './model/Template.js';
 export { Transaction } from './model/Transaction.js';
 export { TransactionList } from './model/TransactionList.js';
+export { Event } from './model/Event.js';
+export { EventList } from './model/EventList.js';
 export { User } from './model/User.js';
 export { Periodicity, DecimalSeparator, Permission, Visibility, AccountType, Period, Month } from './model/Enums.js';
 //# sourceMappingURL=index.js.map

package/lib/model/Book.js

@@ -13,9 +13,11 @@ import * as FileService from '../service/file-service.js';
 import * as GroupService from '../service/group-service.js';
 import * as IntegrationService from '../service/integration-service.js';
 import * as TransactionService from '../service/transaction-service.js';
+import * as EventService from '../service/event-service.js';
 import * as Utils from '../utils.js';
 import { Account } from './Account.js';
 import { Collection } from './Collection.js';
+import { EventList } from './EventList.js';
 import { File } from './File.js';
 import { Group } from './Group.js';
 import { Integration } from './Integration.js';
@@ -502,6 +504,19 @@ export class Book {
             if (id) {
                 this.idAccountMap.set(id, account);
             }
+            this.linkAccountsAndGroups(account);
+        }
+    }
+    /** @internal */
+    linkAccountsAndGroups(account) {
+        var _a;
+        const groupPayloads = account.payload.groups || [];
+        for (const groupPayload of groupPayloads) {
+            const group = (_a = this.idGroupMap) === null || _a === void 0 ? void 0 : _a.get(groupPayload.id || "");
+            if (group != null) {
+                group.addAccount(account);
+                //TODO add known group to account
+            }
         }
     }
     /** @internal */
@@ -581,6 +596,9 @@ export class Book {
         for (const group of groupsObj) {
             this.updateGroupCache(group);
         }
+        for (const group of groupsObj) {
+            group.buildGroupTree(this.idGroupMap);
+        }
         return groupsObj;
     }
     /**
@@ -623,6 +641,24 @@ export class Book {
             return new TransactionList(this, transactionsList);
         });
     }
+    /**
+     * Lists events in the Book based on the provided parameters.
+     *
+     * @param afterDate - The start date (inclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format. Can be null.
+     * @param beforeDate - The end date (exclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format. Can be null.
+     * @param onError - True to search only for events on error.
+     * @param resourceId - The ID of the event's resource (Transaction, Account, or Group). Can be null.
+     * @param limit - The maximum number of events to return.
+     * @param cursor - The cursor for pagination. Can be null.
+     *
+     * @returns An EventList object containing the list of events.
+     */
+    listEvents(afterDate, beforeDate, onError, resourceId, limit, cursor) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const eventsList = yield EventService.listEvents(this, afterDate, beforeDate, onError, resourceId, limit, cursor);
+            return new EventList(this, eventsList);
+        });
+    }
     /**
      * Retrieve a transaction by id
      */

package/lib/model/Event.js

@@ -0,0 +1,17 @@
+/**
+ * Represents an Event in the system.
+ *
+ * @public
+ */
+export class Event {
+    constructor(payload) {
+        this.payload = payload || {};
+    }
+    /**
+     * @returns The wrapped plain json object
+     */
+    json() {
+        return Object.assign({}, this.payload);
+    }
+}
+//# sourceMappingURL=Event.js.map

package/lib/model/EventList.js

@@ -0,0 +1,43 @@
+import { Event } from "./Event.js";
+/**
+ * A list associated with an event query.
+ */
+export class EventList {
+    constructor(book, payload) {
+        this.book = book;
+        this.payload = payload || {};
+    }
+    /**
+     * @returns The cursor associated with the query for pagination.
+     */
+    getCursor() {
+        return this.payload.cursor;
+    }
+    /**
+     * @returns The first Event in the list.
+     */
+    getFirst() {
+        const events = this.getItems();
+        return events.length > 0 ? events[0] : undefined;
+    }
+    /**
+     *
+     * Get the total number of events in the list.
+     *
+     * @returns The total number of events.
+     */
+    size() {
+        var _a;
+        return ((_a = this.payload.items) === null || _a === void 0 ? void 0 : _a.length) || 0;
+    }
+    /**
+     * Get the events in the list.
+     *
+     * @returns An array of Event objects.
+     */
+    getItems() {
+        var _a;
+        return ((_a = this.payload.items) === null || _a === void 0 ? void 0 : _a.map(event => new Event(event))) || [];
+    }
+}
+//# sourceMappingURL=EventList.js.map

package/lib/model/Group.js

@@ -21,6 +21,7 @@ import { Account } from './Account.js';
  */
 export class Group {
     constructor(book, payload) {
+        this.children = [];
         this.book = book;
         this.payload = payload || {
             createdAt: `${Date.now()}`
@@ -38,33 +39,6 @@ export class Group {
     getId() {
         return this.payload.id;
     }
-    /**
-     * @returns The parent Group
-     */
-    getParent() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.payload.parent) {
-                return yield this.book.getGroup(this.payload.parent.id);
-            }
-            else {
-                return undefined;
-            }
-        });
-    }
-    /**
-     * Sets the parent Group.
-     *
-     * @returns This Group, for chainning.
-     */
-    setParent(group) {
-        if (group) {
-            this.payload.parent = { id: group.getId(), name: group.getName(), normalizedName: group.getNormalizedName() };
-        }
-        else {
-            this.payload.parent = undefined;
-        }
-        return this;
-    }
     /**
      * @returns The name of this Group
      */
@@ -96,6 +70,9 @@ export class Group {
      */
     getAccounts() {
         return __awaiter(this, void 0, void 0, function* () {
+            if (this.accounts) {
+                return Array.from(this.accounts);
+            }
             let accountsPlain = yield GroupService.getAccounts(this.book.getId(), this.getId());
             if (!accountsPlain) {
                 return [];
@@ -104,12 +81,6 @@ export class Group {
             return accounts;
         });
     }
-    /**
-     * @returns True if this group has any account in it
-     */
-    hasAccounts() {
-        return this.payload.hasAccounts;
-    }
     /**
      * @returns The type for of the accounts of this group. Null if mixed
      */
@@ -191,6 +162,173 @@ export class Group {
         this.payload.hidden = hidden;
         return this;
     }
+    /**
+     * Tell if the Group is permanent
+     */
+    isPermanent() {
+        return this.payload.permanent;
+    }
+    /**
+     * @returns The parent Group
+     */
+    getParent() {
+        return this.parent;
+    }
+    /**
+     * Sets the parent Group.
+     *
+     * @returns This Group, for chainning.
+     */
+    setParent(group) {
+        if (group) {
+            this.payload.parent = { id: group.getId(), name: group.getName(), normalizedName: group.getNormalizedName() };
+        }
+        else {
+            this.payload.parent = undefined;
+        }
+        return this;
+    }
+    /**
+     * Checks if the Group has a parent.
+     *
+     * @returns True if the Group has a parent, otherwise false.
+     */
+    hasParent() {
+        return this.payload.parent != null;
+    }
+    /**
+     * Retrieves the children of the Group.
+     *
+     * @returns An array of child Groups.
+     */
+    getChildren() {
+        return this.children || [];
+    }
+    /**
+     * Retrieves all descendant Groups of the current Group.
+     *
+     * @returns A set of descendant Groups.
+     */
+    getDescendants() {
+        const descendants = new Set();
+        this.traverseDescendants(this, descendants);
+        return descendants;
+    }
+    /**
+     * Retrieves the IDs of all descendant Groups in a tree structure.
+     *
+     * @returns A set of descendant Group IDs.
+     */
+    getDescendantTreeIds() {
+        return new Set(Array.from(this.getDescendants()).map(g => g.getId() || ""));
+    }
+    /**
+     * Checks if the Group has any children.
+     *
+     * @returns True if the Group has children, otherwise false.
+     */
+    hasChildren() {
+        return this.getChildren().length > 0;
+    }
+    /**
+     * Checks if the Group is a leaf node (i.e., has no children).
+     *
+     * @returns True if the Group is a leaf, otherwise false.
+     */
+    isLeaf() {
+        return this.getChildren().length === 0;
+    }
+    /**
+     * Checks if the Group is a root node (i.e., has no parent).
+     *
+     * @returns True if the Group is a root, otherwise false.
+     */
+    isRoot() {
+        return this.getParent() == undefined;
+    }
+    /**
+     * Retrieves the depth of the Group in the hierarchy.
+     *
+     * @returns The depth of the Group.
+     */
+    getDepth() {
+        if (this.depth == undefined) {
+            if (this.parent) {
+                this.depth = this.parent.getDepth() + 1;
+            }
+            else {
+                this.depth = 0;
+            }
+        }
+        return this.depth;
+    }
+    /**
+     * Retrieves the root Group of the current Group.
+     *
+     * @returns The root Group.
+     */
+    getRoot() {
+        if (this.root == undefined) {
+            if (this.parent != undefined) {
+                this.root = this.parent.getRoot();
+            }
+            else {
+                this.root = this;
+            }
+        }
+        return this.root;
+    }
+    /**
+     * Retrieves the name of the root Group.
+     *
+     * @returns The name of the root Group.
+     */
+    getRootName() {
+        const root = this.getRoot();
+        if (root != null) {
+            return root.getName() || "";
+        }
+        return "";
+    }
+    /** @internal */
+    traverseDescendants(group, descendants) {
+        descendants.add(group);
+        const children = group.getChildren();
+        if (children.length > 0) {
+            for (const child of children) {
+                this.traverseDescendants(child, descendants);
+            }
+        }
+    }
+    /** @internal */
+    buildGroupTree(groupsMap) {
+        this.parent = undefined;
+        this.depth = undefined;
+        this.root = undefined;
+        if (this.payload.parent) {
+            const parentGroup = groupsMap.get(this.payload.parent.id || "");
+            if (parentGroup) {
+                this.parent = parentGroup;
+                parentGroup.getChildren().push(this);
+            }
+        }
+    }
+    /** @internal */
+    addAccount(account) {
+        if (account == null) {
+            return;
+        }
+        if (!this.accounts) {
+            this.accounts = new Set();
+        }
+        this.accounts.add(account);
+    }
+    /**
+     * @returns True if this group has any account in it
+     */
+    hasAccounts() {
+        return this.payload.hasAccounts;
+    }
     /**
      * Perform create new group.
      */

package/lib/service/event-service.js

@@ -0,0 +1,26 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { HttpBooksApiV5Request } from "./http-api-request.js";
+export function listEvents(book, afterDate, beforeDate, onError, resourceId, limit, cursor) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let request = new HttpBooksApiV5Request(`${book.getId()}/events`);
+        request.addParam('after', afterDate);
+        request.addParam('before', beforeDate);
+        request.addParam('error', onError);
+        request.addParam('resoureId', resourceId);
+        request.addParam('limit', limit);
+        if (cursor != null) {
+            request.setHeader('cursor', cursor);
+        }
+        var response = yield request.fetch();
+        return response.data;
+    });
+}
+//# sourceMappingURL=event-service.js.map

package/package.json

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