bkper-js 2.29.0 → 2.29.2

package/lib/index.d.ts

@@ -125,6 +125,10 @@ export declare class Account extends ResourceProperty<bkper.Account> {
     /**
      * Gets the [[Groups]] of this Account.
      *
+     * When groups are already embedded in the account payload (e.g. from
+     * {@link Bkper.getBook} with includeGroups), resolves them from the
+     * book's cache instead of making API calls.
+     *
      * @returns Promise with the [[Groups]] of this Account
      */
     getGroups(): Promise<Group[]>;

package/lib/model/Account.js

@@ -7,11 +7,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import * as AccountService from "../service/account-service.js";
-import * as GroupService from "../service/group-service.js";
-import { Group } from "./Group.js";
-import { normalizeText } from "../utils.js";
-import { ResourceProperty } from "./ResourceProperty.js";
+import * as AccountService from '../service/account-service.js';
+import { Group } from './Group.js';
+import { normalizeText } from '../utils.js';
+import { ResourceProperty } from './ResourceProperty.js';
 /**
  * This class defines an [Account](https://en.wikipedia.org/wiki/Account_(bookkeeping)) of a [[Book]].
  *
@@ -168,6 +167,10 @@ export class Account extends ResourceProperty {
     /**
      * Gets the [[Groups]] of this Account.
      *
+     * When groups are already embedded in the account payload (e.g. from
+     * {@link Bkper.getBook} with includeGroups), resolves them from the
+     * book's cache instead of making API calls.
+     *
      * @returns Promise with the [[Groups]] of this Account
      */
     getGroups() {
@@ -176,9 +179,20 @@ export class Account extends ResourceProperty {
             if (!id) {
                 return [];
             }
-            let groups = yield GroupService.getGroupsByAccountId(this.book.getId(), id, this.getConfig());
-            let groupsObj = groups.map((group) => new Group(this.book, group));
-            return groupsObj;
+            //Ensure groups are pre-loaded in the book cache to avoid multiple API calls when resolving groups from the payload
+            yield this.book.getGroups();
+            // resolve them from the book's group cache to get properly tree-linked Group objects
+            if (this.payload.groups != null) {
+                const groups = [];
+                for (const groupPayload of this.payload.groups) {
+                    const group = yield this.book.getGroup(groupPayload.id);
+                    if (group) {
+                        groups.push(group);
+                    }
+                }
+                return groups;
+            }
+            return [];
         });
     }
     /**
@@ -191,7 +205,7 @@ export class Account extends ResourceProperty {
     setGroups(groups) {
         this.payload.groups = undefined;
         if (groups != null) {
-            groups.forEach((group) => this.addGroup(group));
+            groups.forEach(group => this.addGroup(group));
         }
         return this;
     }
@@ -228,7 +242,7 @@ export class Account extends ResourceProperty {
                 if (group instanceof Group) {
                     groupObject = group;
                 }
-                else if (typeof group == "string") {
+                else if (typeof group == 'string') {
                     groupObject = yield this.book.getGroup(group);
                 }
                 if (groupObject) {

package/lib/model/App.js

@@ -261,7 +261,7 @@ export class App extends Resource {
      * @returns The readme text
      */
     getReadme() {
-        return this.payload.readme;
+        return this.payload.readmeMd || this.payload.readme;
     }
     /**
      * Sets the readme.md file as text.
@@ -271,7 +271,7 @@ export class App extends Resource {
      * @returns This App, for chaining
      */
     setReadme(readme) {
-        this.payload.readme = readme;
+        this.payload.readmeMd = readme;
         return this;
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "2.29.0",
+  "version": "2.29.2",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",
@@ -35,7 +35,7 @@
     "postversion": "git push --tags && yarn publish --new-version $npm_package_version && git push && echo \"Successfully released version $npm_package_version!\""
   },
   "dependencies": {
-    "@bkper/bkper-api-types": "^5.35.0",
+    "@bkper/bkper-api-types": "^5.36.0",
     "big.js": "^6.0.3",
     "dayjs": "^1.10.3",
     "luxon": "^1.25.0",