bkper-js 2.23.1 → 2.25.0

package/CHANGELOG.md

@@ -12,8 +12,10 @@ See what's new and what has changed in bkper-js
 - Added `Config.agentIdProvider`
 - Added `Billing`
 - Added `Billing.getAdminEmail`
+- Added `Billing.getCounts`
 - Added `Billing.getDaysLeftInTrial`
 - Added `Billing.getPlan`
+- Added `Billing.getPortalUrl`
 - Added `Billing.getTotalTransactionsThisMonth`
 - Added `Billing.getTotalTransactionsThisYear`
 - Added `Billing.hasStartedTrial`
@@ -23,6 +25,7 @@ See what's new and what has changed in bkper-js
 - Added `User.getUsername`
 - Removed `App.setUserEmails` from `App`. Use `App.setUsers` instead
 - Removed `App.setDeveloperEmail` from `App`. Use `App.setDevelopers` instead
+- Removed `Bkper.getBillingPortalUrl` from `Bkper`. Use `Billing.getPortalUrl` instead
 - Removed `User.getDaysLeftInTrial` from `User`. Use `Billing.getDaysLeftInTrial` instead
 - Removed `User.getPlan` from `User`. Use `Billing.getPlan` instead
 - Removed `User.hasBillingEnabled` from `User`. Use `Billing.isEnabled` instead

package/README.md

@@ -1,4 +1,4 @@
-[Bkper REST API]: https://bkper.com/docs/#rest-apis
+[Bkper REST API]: https://bkper.com/docs/#rest-api
 
 [![npm](https://img.shields.io/npm/v/bkper-js?color=%235889e4)](https://www.npmjs.com/package/bkper-js)
 
@@ -29,16 +29,20 @@ bun add bkper-js
 
 ## Usage
 
+### Node.js / CLI Scripts
+
+For local scripts and CLI tools, use the [bkper](https://www.npmjs.com/package/bkper) CLI package for authentication:
+
 ```typescript
 import { Bkper } from 'bkper-js';
+import { getOAuthToken } from 'bkper';
 
-// Set global configuration
+// Configure with CLI authentication
 Bkper.setConfig({
-  apiKeyProvider: () => process.env.BKPER_API_KEY,
-  oauthTokenProvider: () => process.env.BKPER_OAUTH_TOKEN
+  oauthTokenProvider: async () => getOAuthToken()
 });
 
-// Create Bkper instance (uses global config)
+// Create Bkper instance
 const bkper = new Bkper();
 
 // Get a book and work with it
@@ -48,10 +52,47 @@ console.log(`Book: ${book.getName()}`);
 // List all books
 const books = await bkper.getBooks();
 console.log(`You have ${books.length} books`);
+```
+
+First, login via CLI: `bkper login`
+
+### Web Applications
+
+For browser-based apps, use the [@bkper/web-auth](https://www.npmjs.com/package/@bkper/web-auth) SDK:
+
+```typescript
+import { Bkper } from 'bkper-js';
+import { BkperAuth } from '@bkper/web-auth';
+
+// Initialize authentication
+const auth = new BkperAuth({
+  onLoginSuccess: () => initializeApp(),
+  onLoginRequired: () => showLoginButton()
+});
+
+// Restore session on app load
+await auth.init();
 
-// Get current user
-const user = await bkper.getUser();
-console.log(`Logged in as: ${user.getName()}`);
+// Configure Bkper with web auth
+Bkper.setConfig({
+  oauthTokenProvider: async () => auth.getAccessToken()
+});
+
+// Create Bkper instance and use it
+const bkper = new Bkper();
+const books = await bkper.getBooks();
 ```
 
+See the [@bkper/web-auth documentation](https://bkper.com/docs/auth-sdk) for more details.
+
+### API Key (Optional)
+
+API keys are optional and only needed for dedicated quota limits. If not provided, requests use a shared managed quota via the Bkper API proxy.
+
+```typescript
+Bkper.setConfig({
+  oauthTokenProvider: async () => getOAuthToken(),
+  apiKeyProvider: async () => process.env.BKPER_API_KEY // Optional - for dedicated quota
+});
+```
 

package/lib/index.d.ts

@@ -595,12 +595,6 @@ export declare class App extends Resource<bkper.App> {
      * @returns This App after creation
      */
     create(): Promise<App>;
-    /**
-     * Partially updates an App, applying pending changes.
-     *
-     * @returns This App after the partial update
-     */
-    patch(): Promise<App>;
     /**
      * Performs a full update of the App, applying pending changes.
      *
@@ -1329,6 +1323,14 @@ export declare class Bkper {
      * @returns The retrieved list of Apps
      */
     getApps(): Promise<App[]>;
+    /**
+     * Gets the [[App]] with the specified id.
+     *
+     * @param id - The App id (agentId)
+     *
+     * @returns The retrieved App
+     */
+    getApp(id: string): Promise<App>;
     /**
      * Gets all [[Templates]] available for the user.
      *
@@ -2202,11 +2204,13 @@ export declare class Collection extends Resource<bkper.Collection> {
  */
 export declare interface Config {
     /**
-     * The API key to identify the agent.
+     * Optional API key for dedicated quota limits.
      *
-     * API keys are intended for agent identification only, not for authentication. [Learn more](https://cloud.google.com/endpoints/docs/frameworks/java/when-why-api-key)
+     * If not provided, requests use a shared managed quota via the Bkper API proxy.
+     * Use your own API key for dedicated quota limits and project-level usage tracking.
      *
-     * See how to create your api key [here](https://cloud.google.com/docs/authentication/api-keys).
+     * API keys are for project identification only, not for authentication or agent attribution.
+     * Agent attribution is handled separately via the `agentIdProvider`.
      */
     apiKeyProvider?: () => Promise<string>;
     /**

package/lib/model/App.js

@@ -287,17 +287,6 @@ export class App extends Resource {
             return this;
         });
     }
-    /**
-     * Partially updates an App, applying pending changes.
-     *
-     * @returns This App after the partial update
-     */
-    patch() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield AppService.patchApp(this.payload, this.getConfig());
-            return this;
-        });
-    }
     /**
      * Performs a full update of the App, applying pending changes.
      *

package/lib/model/Bkper.js

@@ -130,6 +130,19 @@ export class Bkper {
             return apps.map((app) => new App(app, this.config));
         });
     }
+    /**
+     * Gets the [[App]] with the specified id.
+     *
+     * @param id - The App id (agentId)
+     *
+     * @returns The retrieved App
+     */
+    getApp(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let app = yield AppService.getApp(id, this.config);
+            return new App(app, this.config);
+        });
+    }
     /**
      * Gets all [[Templates]] available for the user.
      *

package/lib/service/app-service.js

@@ -22,21 +22,21 @@ export function getApps(config) {
         return appsJson;
     });
 }
-export function createApp(app, config) {
+export function getApp(id, config) {
     return __awaiter(this, void 0, void 0, function* () {
-        var response = yield new HttpApiRequest(`v5/apps`, config).setMethod('POST').setPayload(app).fetch();
+        let response = yield new HttpApiRequest(`v5/apps/${id}`, config).setMethod('GET').fetch();
         return response.data;
     });
 }
-export function updateApp(app, config) {
+export function createApp(app, config) {
     return __awaiter(this, void 0, void 0, function* () {
-        var response = yield new HttpApiRequest(`v5/apps`, config).setMethod('PUT').setPayload(app).fetch();
+        var response = yield new HttpApiRequest(`v5/apps`, config).setMethod('POST').setPayload(app).fetch();
         return response.data;
     });
 }
-export function patchApp(app, config) {
+export function updateApp(app, config) {
     return __awaiter(this, void 0, void 0, function* () {
-        var response = yield new HttpApiRequest(`v5/apps`, config).setMethod('PATCH').setPayload(app).fetch();
+        var response = yield new HttpApiRequest(`v5/apps`, config).setMethod('PUT').setPayload(app).fetch();
         return response.data;
     });
 }

package/package.json

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