bkper-js 1.16.0 → 1.17.0

package/lib/index.d.ts

@@ -756,6 +756,7 @@ export declare class Book {
 
 
 
+
     /**
      * Gets a [[Group]] object
      *
@@ -1194,6 +1195,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 +1210,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 +1228,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 +1277,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/model/Book.js

@@ -502,6 +502,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 +594,9 @@ export class Book {
         for (const group of groupsObj) {
             this.updateGroupCache(group);
         }
+        for (const group of groupsObj) {
+            group.buildGroupTree(this.idGroupMap);
+        }
         return groupsObj;
     }
     /**

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/http-api-request.js

@@ -42,7 +42,7 @@ export class HttpApiRequest extends HttpRequest {
                     if (errorResp.status == 404) {
                         return { data: null };
                     }
-                    else if (this.retry <= 3) {
+                    else if (errorResp.status != 400 && this.retry <= 3) {
                         this.retry++;
                         if (HttpApiRequest.config.requestRetryHandler) {
                             yield HttpApiRequest.config.requestRetryHandler(errorResp.status, errorResp.data, this.retry);

package/package.json

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