bkper-js 2.33.0 → 2.34.0

package/lib/index.d.ts

@@ -580,15 +580,31 @@ export declare class App extends Resource<bkper.App> {
      * @returns The menu text of this App
      */
     getMenuText(): string | undefined;
+    /**
+     * Gets how the app menu opens.
+     *
+     * @returns The configured app menu open mode, defaults to SIDEBAR
+     */
+    getMenuOpenMode(): MenuOpenMode;
+    /**
+     * Sets how the app menu opens.
+     *
+     * @param menuOpenMode - The app menu open mode to set
+     *
+     * @returns This App, for chaining
+     */
+    setMenuOpenMode(menuOpenMode?: MenuOpenMode): App;
     /**
      * Gets the menu popup width of this App.
      *
+     * @deprecated Use getMenuOpenMode() to decide how the app should open.
      * @returns The menu popup width of this App
      */
     getMenuPopupWidth(): string | undefined;
     /**
      * Gets the menu popup height of this App.
      *
+     * @deprecated Use getMenuOpenMode() to decide how the app should open.
      * @returns The menu popup height of this App
      */
     getMenuPopupHeight(): string | undefined;
@@ -1354,31 +1370,6 @@ export declare class Billing extends Resource<bkper.Billing> {
 /**
  * This is the main entry point of the [bkper-js](https://www.npmjs.com/package/bkper-js) library.
  *
- * You can configure the library in two ways:
- *
- * 1. Using static configuration (traditional approach):
- *
- * ```typescript
- * Bkper.setConfig({
- *   apiKeyProvider: () => process.env.BKPER_API_KEY,
- *   oauthTokenProvider: () => process.env.BKPER_OAUTH_TOKEN
- * });
- *
- * const bkper = new Bkper();
- * const book = await bkper.getBook('bookId');
- * ```
- *
- * 2. Using per-instance configuration (recommended for Cloudflare Workers):
- *
- * ```typescript
- * const bkper = new Bkper({
- *   apiKeyProvider: () => process.env.BKPER_API_KEY,
- *   oauthTokenProvider: () => process.env.BKPER_OAUTH_TOKEN
- * });
- *
- * const book = await bkper.getBook('bookId');
- * ```
- *
  * @public
  */
 export declare class Bkper {
@@ -3206,6 +3197,26 @@ export declare class Integration extends ResourceProperty<bkper.Integration> {
     remove(): Promise<Integration>;
 }
 
+/**
+ * Enum that represents how an App menu opens.
+ *
+ * @public
+ */
+export declare enum MenuOpenMode {
+    /**
+     * Open inside the sidebar panel.
+     */
+    SIDEBAR = "SIDEBAR",
+    /**
+     * Open expanded inside the app panel.
+     */
+    EXPANDED = "EXPANDED",
+    /**
+     * Open in a new browser tab.
+     */
+    NEW_TAB = "NEW_TAB"
+}
+
 /**
  * Enum that represents a Month.
  *

package/lib/index.js

@@ -34,6 +34,6 @@ 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, BalanceType, Period, Month, EventType, BotResponseType, TransactionStatus, } from './model/Enums.js';
+export { Periodicity, DecimalSeparator, Permission, Visibility, AccountType, BalanceType, Period, Month, EventType, BotResponseType, TransactionStatus, MenuOpenMode, } from './model/Enums.js';
 export { BkperError } from './model/BkperError.js';
 //# sourceMappingURL=index.js.map

package/lib/model/App.js

@@ -8,6 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as AppService from "../service/app-service.js";
+import { MenuOpenMode } from "./Enums.js";
 import { Resource } from "./Resource.js";
 import { Bkper } from "./Bkper.js";
 /**
@@ -153,9 +154,29 @@ export class App extends Resource {
     getMenuText() {
         return this.payload.menuText;
     }
+    /**
+     * Gets how the app menu opens.
+     *
+     * @returns The configured app menu open mode, defaults to SIDEBAR
+     */
+    getMenuOpenMode() {
+        return this.payload.menuOpenMode || MenuOpenMode.SIDEBAR;
+    }
+    /**
+     * Sets how the app menu opens.
+     *
+     * @param menuOpenMode - The app menu open mode to set
+     *
+     * @returns This App, for chaining
+     */
+    setMenuOpenMode(menuOpenMode) {
+        this.payload.menuOpenMode = menuOpenMode;
+        return this;
+    }
     /**
      * Gets the menu popup width of this App.
      *
+     * @deprecated Use getMenuOpenMode() to decide how the app should open.
      * @returns The menu popup width of this App
      */
     getMenuPopupWidth() {
@@ -164,6 +185,7 @@ export class App extends Resource {
     /**
      * Gets the menu popup height of this App.
      *
+     * @deprecated Use getMenuOpenMode() to decide how the app should open.
      * @returns The menu popup height of this App
      */
     getMenuPopupHeight() {

package/lib/model/Bkper.js

@@ -7,44 +7,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { Book } from "./Book.js";
-import { App } from "./App.js";
-import * as AppService from "../service/app-service.js";
-import * as BookService from "../service/book-service.js";
-import * as CollectionService from "../service/collection-service.js";
-import * as UserService from "../service/user-service.js";
-import * as TemplateService from "../service/template-service.js";
-import { User } from "./User.js";
-import { Template } from "./Template.js";
-import { Collection } from "./Collection.js";
+import { Book } from './Book.js';
+import { App } from './App.js';
+import * as AppService from '../service/app-service.js';
+import * as BookService from '../service/book-service.js';
+import * as CollectionService from '../service/collection-service.js';
+import * as UserService from '../service/user-service.js';
+import * as TemplateService from '../service/template-service.js';
+import { User } from './User.js';
+import { Template } from './Template.js';
+import { Collection } from './Collection.js';
 /**
  * This is the main entry point of the [bkper-js](https://www.npmjs.com/package/bkper-js) library.
  *
- * You can configure the library in two ways:
- *
- * 1. Using static configuration (traditional approach):
- *
- * ```typescript
- * Bkper.setConfig({
- *   apiKeyProvider: () => process.env.BKPER_API_KEY,
- *   oauthTokenProvider: () => process.env.BKPER_OAUTH_TOKEN
- * });
- *
- * const bkper = new Bkper();
- * const book = await bkper.getBook('bookId');
- * ```
- *
- * 2. Using per-instance configuration (recommended for Cloudflare Workers):
- *
- * ```typescript
- * const bkper = new Bkper({
- *   apiKeyProvider: () => process.env.BKPER_API_KEY,
- *   oauthTokenProvider: () => process.env.BKPER_OAUTH_TOKEN
- * });
- *
- * const book = await bkper.getBook('bookId');
- * ```
- *
  * @public
  */
 export class Bkper {
@@ -105,7 +80,7 @@ export class Bkper {
     getBooks(query) {
         return __awaiter(this, void 0, void 0, function* () {
             let books = yield BookService.loadBooks(query, this.config);
-            return books.map((book) => new Book(book, this.config));
+            return books.map(book => new Book(book, this.config));
         });
     }
     /**
@@ -116,7 +91,7 @@ export class Bkper {
     getCollections() {
         return __awaiter(this, void 0, void 0, function* () {
             let collections = yield CollectionService.loadCollections(this.config);
-            return collections.map((collection) => new Collection(collection, this.config));
+            return collections.map(collection => new Collection(collection, this.config));
         });
     }
     /**
@@ -127,7 +102,7 @@ export class Bkper {
     getApps() {
         return __awaiter(this, void 0, void 0, function* () {
             let apps = yield AppService.getApps(this.config);
-            return apps.map((app) => new App(app, this.config));
+            return apps.map(app => new App(app, this.config));
         });
     }
     /**
@@ -151,7 +126,7 @@ export class Bkper {
     getTemplates() {
         return __awaiter(this, void 0, void 0, function* () {
             let templates = yield TemplateService.getTemplates(this.config);
-            return templates.map((template) => new Template(template, this.config));
+            return templates.map(template => new Template(template, this.config));
         });
     }
     /**

package/lib/model/Enums.js

@@ -190,6 +190,26 @@ export var TransactionStatus;
      */
     TransactionStatus["CHECKED"] = "CHECKED";
 })(TransactionStatus || (TransactionStatus = {}));
+/**
+ * Enum that represents how an App menu opens.
+ *
+ * @public
+ */
+export var MenuOpenMode;
+(function (MenuOpenMode) {
+    /**
+     * Open inside the sidebar panel.
+     */
+    MenuOpenMode["SIDEBAR"] = "SIDEBAR";
+    /**
+     * Open expanded inside the app panel.
+     */
+    MenuOpenMode["EXPANDED"] = "EXPANDED";
+    /**
+     * Open in a new browser tab.
+     */
+    MenuOpenMode["NEW_TAB"] = "NEW_TAB";
+})(MenuOpenMode || (MenuOpenMode = {}));
 /**
  * Enum that represents the type of a Bot Response
  *

package/lib/service/http-api-request.js

@@ -103,7 +103,10 @@ export class HttpApiRequest extends HttpRequest {
         });
     }
     shouldRetry(status) {
-        return status == 408 || status == 429 || (status != null && status >= 500);
+        // 401/403 are included so consumers can refresh the OAuth token via
+        // requestRetryHandler and have the request re-issued. The retry cap
+        // (this.retry < 3) prevents loops on permanent auth failures.
+        return status == 401 || status == 403 || status == 408 || status == 429 || (status != null && status >= 500);
     }
     isNetworkError(error) {
         return error instanceof TypeError && error.message.toLowerCase().includes("fetch");

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bkper-js",
-    "version": "2.33.0",
+    "version": "2.34.0",
     "description": "Javascript client for Bkper REST API",
     "main": "./lib/index.js",
     "module": "./lib/index.js",
@@ -32,10 +32,13 @@
         "build:clean-dist": "rimraf dist",
         "build:bundle": "esbuild lib/index.js --bundle --format=iife --global-name=bkperjs --minify --sourcemap --target=es2015 --platform=browser --outfile=dist/bkper.min.js",
         "dev": "tsc -w",
-        "upgrade:api": "bun update @bkper/bkper-api-types --latest"
+        "upgrade:api": "bun update @bkper/bkper-api-types --latest",
+        "release:patch": "npm version patch -m \"chore(release): v%s\"",
+        "release:minor": "npm version minor -m \"chore(release): v%s\"",
+        "release:major": "npm version major -m \"chore(release): v%s\""
     },
     "dependencies": {
-        "@bkper/bkper-api-types": "^5.40.0",
+        "@bkper/bkper-api-types": "^5.40.2",
         "big.js": "^6.0.3",
         "dayjs": "^1.10.3",
         "luxon": "^1.25.0",