bkper-js 2.41.1 → 2.42.0

package/lib/index.d.ts

@@ -1419,6 +1419,14 @@ export declare class Bkper {
      * @returns The retrieved list of Books
      */
     getBooks(query?: string): Promise<Book[]>;
+    /**
+     * Requests access to a Book the current user cannot access.
+     *
+     * @param bookId - The universal Book id
+     * @param permission - The permission requested in the Book
+     * @param message - An optional message to the Book owner
+     */
+    requestBookAccess(bookId: string, permission: Permission, message?: string): Promise<void>;
     /**
      * Gets all [[Collections]] the user has access to.
      *
@@ -2133,6 +2141,16 @@ export declare class Book extends ResourceProperty<bkper.Book> {
      * @returns The saved queries from this book
      */
     getSavedQueries(): Promise<Query[]>;
+    /**
+     * Resolves an access request for this Book.
+     *
+     * Resolving the request does not grant access. Call Collaborator.create
+     * on the returned Collaborator to grant access to the Book.
+     *
+     * @param accessRequestId - The access request id
+     * @returns The matching [[Collaborator]] object
+     */
+    resolveAccessRequest(accessRequestId: string): Promise<Collaborator>;
     /**
      * Gets all collaborators of this Book.
      *

package/lib/model/Bkper.js

@@ -12,6 +12,7 @@ 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 CollaboratorService from '../service/collaborator-service.js';
 import * as UserService from '../service/user-service.js';
 import * as TemplateService from '../service/template-service.js';
 import { User } from './User.js';
@@ -83,6 +84,19 @@ export class Bkper {
             return books.map(book => new Book(book, this.config));
         });
     }
+    /**
+     * Requests access to a Book the current user cannot access.
+     *
+     * @param bookId - The universal Book id
+     * @param permission - The permission requested in the Book
+     * @param message - An optional message to the Book owner
+     */
+    requestBookAccess(bookId, permission, message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const trimmedMessage = message === null || message === void 0 ? void 0 : message.trim();
+            yield CollaboratorService.requestBookAccess(bookId, permission, trimmedMessage || undefined, this.config);
+        });
+    }
     /**
      * Gets all [[Collections]] the user has access to.
      *

package/lib/model/Book.js

@@ -1330,6 +1330,21 @@ export class Book extends ResourceProperty {
             return this.queries;
         });
     }
+    /**
+     * Resolves an access request for this Book.
+     *
+     * Resolving the request does not grant access. Call Collaborator.create
+     * on the returned Collaborator to grant access to the Book.
+     *
+     * @param accessRequestId - The access request id
+     * @returns The matching [[Collaborator]] object
+     */
+    resolveAccessRequest(accessRequestId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const payload = yield CollaboratorService.resolveBookAccessRequest(this.getId(), accessRequestId, this.getConfig());
+            return new Collaborator(this, payload);
+        });
+    }
     /**
      * Gets all collaborators of this Book.
      *

package/lib/service/collaborator-service.js

@@ -8,16 +8,39 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { HttpBooksApiV5Request } from './http-api-request.js';
+export function requestBookAccess(bookId, permission, message, config) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let request = new HttpBooksApiV5Request(`${bookId}/collaborators/request`, config)
+            .setMethod('POST')
+            .addParam('permission', permission);
+        if (message) {
+            request = request.addParam('message', message);
+        }
+        yield request.fetch();
+    });
+}
+export function resolveBookAccessRequest(bookId, accessRequestId, config) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield new HttpBooksApiV5Request(`${bookId}/collaborators/request/${encodeURIComponent(accessRequestId)}`, config)
+            .setMethod('GET')
+            .fetch();
+        return response.data;
+    });
+}
 export function listCollaborators(bookId, config) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a;
-        const response = yield new HttpBooksApiV5Request(`${bookId}/collaborators`, config).setMethod('GET').fetch();
+        const response = yield new HttpBooksApiV5Request(`${bookId}/collaborators`, config)
+            .setMethod('GET')
+            .fetch();
         return ((_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.items) || [];
     });
 }
 export function addOrUpdateCollaborator(bookId, collaborator, message, config) {
     return __awaiter(this, void 0, void 0, function* () {
-        let request = new HttpBooksApiV5Request(`${bookId}/collaborators`, config).setMethod('POST').setPayload(collaborator);
+        let request = new HttpBooksApiV5Request(`${bookId}/collaborators`, config)
+            .setMethod('POST')
+            .setPayload(collaborator);
         if (message) {
             request = request.addParam('message', message);
         }
@@ -27,7 +50,9 @@ export function addOrUpdateCollaborator(bookId, collaborator, message, config) {
 }
 export function removeCollaborator(bookId, email, config) {
     return __awaiter(this, void 0, void 0, function* () {
-        const response = yield new HttpBooksApiV5Request(`${bookId}/collaborators/${email}`, config).setMethod('DELETE').fetch();
+        const response = yield new HttpBooksApiV5Request(`${bookId}/collaborators/${email}`, config)
+            .setMethod('DELETE')
+            .fetch();
         return response.data;
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bkper-js",
-    "version": "2.41.1",
+    "version": "2.42.0",
     "description": "Javascript client for Bkper REST API",
     "main": "./lib/index.js",
     "module": "./lib/index.js",
@@ -38,7 +38,7 @@
         "release:major": "npm version major -m \"chore(release): v%s\""
     },
     "dependencies": {
-        "@bkper/bkper-api-types": "^5.43.1",
+        "@bkper/bkper-api-types": "^5.44.0",
         "big.js": "^6.0.3",
         "dayjs": "^1.10.3",
         "luxon": "^1.25.0",