bkper-js 1.10.0 → 1.12.0

package/lib/index.d.ts

@@ -418,6 +418,12 @@ export declare class Bkper {
      * @returns The retrieved list of Books
      */
     static getBooks(): Promise<Book[]>;
+    /**
+     * Gets all [[Collections]] the user has access to.
+     *
+     * @returns The retrieved list of Collections
+     */
+    static getCollections(): Promise<Collection[]>;
     /**
      * Gets all [[Apps]] available for the user.
      *
@@ -821,10 +827,64 @@ export declare class Collection {
      * @returns The name of this Collection
      */
     getName(): string | undefined;
+    /**
+     * Sets the name of the Collection.
+     *
+     * @returns This Collection, for chainning.
+     */
+    setName(name: string): Collection;
+    /**
+     * Gets the username of the owner of this Collection
+     *
+     * @returns The Collection's owner username
+     */
+    getOwnerUsername(): string | undefined;
+    /**
+     * Gets the user permission for this Collection
+     *
+     * @returns The permission for the current user
+     */
+    getPermission(): Permission | undefined;
     /**
      * @returns All Books of this collection.
      */
     getBooks(): Book[];
+    /**
+     * Adds Books to this Collection.
+     *
+     * @returns The added Book objects
+     */
+    addBooks(books: Book[]): Promise<Book[]>;
+    /**
+     * Removes Books from this Collection.
+     *
+     * @returns The removed Book objects
+     */
+    removeBooks(books: Book[]): Promise<Book[]>;
+    /**
+     * Gets the last update date of this Collection
+     *
+     * @returns The Collection's last update timestamp, in milliseconds
+     */
+    getUpdatedAt(): string | undefined;
+    /**
+     * Performs create new Collection.
+     *
+     * @returns The created Collection object
+     */
+    create(): Promise<Collection>;
+    /**
+     * Performs update Collection, applying pending changes.
+     *
+     * @returns The updated Collection object
+     */
+    update(): Promise<Collection>;
+    /**
+     * Performs delete Collection.
+     *
+     * @returns The list of Books the user has access to that were affected by the deletion of this Collection
+     */
+    remove(): Promise<Book[]>;
 }
 
 /**

package/lib/model/Bkper.js

@@ -11,11 +11,13 @@ 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 { HttpApiRequest } from '../service/http-api-request.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.
  *
@@ -75,6 +77,17 @@ export class Bkper {
             return books.map(book => new Book(book));
         });
     }
+    /**
+     * Gets all [[Collections]] the user has access to.
+     *
+     * @returns The retrieved list of Collections
+     */
+    static getCollections() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let collections = yield CollectionService.loadCollections();
+            return collections.map(collection => new Collection(collection));
+        });
+    }
     /**
      * Gets all [[Apps]] available for the user.
      *

package/lib/model/Collection.js

@@ -1,4 +1,14 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 import { Book } from "./Book.js";
+import * as CollectionService from '../service/collection-service.js';
 /**
  * This class defines a Collection of [[Books]].
  *
@@ -26,6 +36,31 @@ export class Collection {
     getName() {
         return this.payload.name;
     }
+    /**
+     * Sets the name of the Collection.
+     *
+     * @returns This Collection, for chainning.
+     */
+    setName(name) {
+        this.payload.name = name;
+        return this;
+    }
+    /**
+     * Gets the username of the owner of this Collection
+     *
+     * @returns The Collection's owner username
+     */
+    getOwnerUsername() {
+        return this.payload.ownerUsername;
+    }
+    /**
+     * Gets the user permission for this Collection
+     *
+     * @returns The permission for the current user
+     */
+    getPermission() {
+        return this.payload.permission ? this.payload.permission : undefined;
+    }
     /**
      * @returns All Books of this collection.
      */
@@ -40,5 +75,78 @@ export class Collection {
         }
         return books;
     }
+    /**
+     * Adds Books to this Collection.
+     *
+     * @returns The added Book objects
+     */
+    addBooks(books) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const collectionId = this.getId();
+            if (collectionId && books.length > 0) {
+                const bookList = { items: books.map(b => b.json()) };
+                let addedBooks = yield CollectionService.addBooksToCollection(collectionId, bookList);
+                return addedBooks.map(book => new Book(book));
+            }
+            return [];
+        });
+    }
+    /**
+     * Removes Books from this Collection.
+     *
+     * @returns The removed Book objects
+     */
+    removeBooks(books) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const collectionId = this.getId();
+            if (collectionId && books.length > 0) {
+                const bookList = { items: books.map(b => b.json()) };
+                let removedBooks = yield CollectionService.removeBooksFromCollection(collectionId, bookList);
+                return removedBooks.map(book => new Book(book));
+            }
+            return [];
+        });
+    }
+    /**
+     * Gets the last update date of this Collection
+     *
+     * @returns The Collection's last update timestamp, in milliseconds
+     */
+    getUpdatedAt() {
+        return this.payload.updatedAt;
+    }
+    /**
+     * Performs create new Collection.
+     *
+     * @returns The created Collection object
+     */
+    create() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.payload = yield CollectionService.createCollection(this.payload);
+            return this;
+        });
+    }
+    /**
+     * Performs update Collection, applying pending changes.
+     *
+     * @returns The updated Collection object
+     */
+    update() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.payload = yield CollectionService.updateCollection(this.payload);
+            return this;
+        });
+    }
+    /**
+     * Performs delete Collection.
+     *
+     * @returns The list of Books the user has access to that were affected by the deletion of this Collection
+     */
+    remove() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let books = yield CollectionService.deleteCollection(this.payload);
+            return books.map(book => new Book(book));
+        });
+    }
 }
 //# sourceMappingURL=Collection.js.map

package/lib/service/collection-service.js

@@ -0,0 +1,51 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { HttpApiV5Request } from "./http-api-request.js";
+export function loadCollections() {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        let response = yield new HttpApiV5Request('collections').fetch();
+        return ((_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.items) || [];
+    });
+}
+export function createCollection(payload) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let response = yield new HttpApiV5Request('collections').setMethod('POST').setPayload(payload).fetch();
+        return response.data;
+    });
+}
+export function updateCollection(payload) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let response = yield new HttpApiV5Request('collections').setMethod('PUT').setPayload(payload).fetch();
+        return response.data;
+    });
+}
+export function deleteCollection(payload) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        let response = yield new HttpApiV5Request(`collections/${payload.id}`).setMethod('DELETE').fetch();
+        return ((_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.items) || [];
+    });
+}
+export function addBooksToCollection(collectionId, payload) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        let response = yield new HttpApiV5Request(`collections/${collectionId}/books/add`).setMethod('PATCH').setPayload(payload).fetch();
+        return ((_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.items) || [];
+    });
+}
+export function removeBooksFromCollection(collectionId, payload) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        let response = yield new HttpApiV5Request(`collections/${collectionId}/books/remove`).setMethod('PATCH').setPayload(payload).fetch();
+        return ((_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.items) || [];
+    });
+}
+//# sourceMappingURL=collection-service.js.map

package/package.json

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