bkper-js 1.0.0

package/lib/model/Amount.js

@@ -0,0 +1,295 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Amount = void 0;
+const big_js_1 = __importDefault(require("big.js"));
+/**
+ * This class defines an Amount for arbitrary-precision decimal arithmetic.
+ *
+ * It inherits methods from [big.js](http://mikemcl.github.io/big.js/) library
+ *
+ * @public
+ */
+class Amount {
+    /**
+     * The Amount constructor.
+     */
+    constructor(n) {
+        this.checkNumberNotNull(n);
+        if (typeof n == "string") {
+            this.wrapped = new big_js_1.default(n);
+        }
+        else if (n instanceof Amount) {
+            this.wrapped = new big_js_1.default(n.wrapped);
+        }
+        else if (n.toString) {
+            this.wrapped = new big_js_1.default(n.toString());
+        }
+        else {
+            this.wrapped = new big_js_1.default(+n);
+        }
+    }
+    /**
+     * Returns an absolute Amount.
+     */
+    abs() {
+        let big = this.wrapped.abs();
+        return this.wrap(big);
+    }
+    /**
+     * Compare
+     */
+    cmp(n) {
+        this.checkNumberNotNull(n);
+        if (typeof n == "string") {
+            return this.wrapped.cmp(n);
+        }
+        else if (n instanceof Amount) {
+            return this.wrapped.cmp(n.wrapped);
+        }
+        else if (n.toString) {
+            return this.wrapped.cmp(n.toString());
+        }
+        else {
+            return this.wrapped.cmp(+n);
+        }
+    }
+    /**
+     * Divide by
+     */
+    div(n) {
+        this.checkNumberNotNull(n);
+        let big;
+        if (typeof n == "string") {
+            big = this.wrapped.div(n);
+        }
+        else if (n instanceof Amount) {
+            big = this.wrapped.div(n.wrapped);
+        }
+        else if (n.toString) {
+            big = this.wrapped.div(n.toString());
+        }
+        else {
+            big = this.wrapped.div(+n);
+        }
+        return this.wrap(big);
+    }
+    /**
+     * Equals to
+     */
+    eq(n) {
+        this.checkNumberNotNull(n);
+        if (typeof n == "string") {
+            return this.wrapped.eq(n);
+        }
+        else if (n instanceof Amount) {
+            return this.wrapped.eq(n.wrapped);
+        }
+        else if (n.toString) {
+            return this.wrapped.eq(n.toString());
+        }
+        else {
+            return this.wrapped.eq(+n);
+        }
+    }
+    /**
+     * Greater than
+     */
+    gt(n) {
+        this.checkNumberNotNull(n);
+        if (typeof n == "string") {
+            return this.wrapped.gt(n);
+        }
+        else if (n instanceof Amount) {
+            return this.wrapped.gt(n.wrapped);
+        }
+        else if (n.toString) {
+            return this.wrapped.gt(n.toString());
+        }
+        else {
+            return this.wrapped.gt(+n);
+        }
+    }
+    /**
+     * Greater than or equal
+     */
+    gte(n) {
+        this.checkNumberNotNull(n);
+        if (typeof n == "string") {
+            return this.wrapped.gte(n);
+        }
+        else if (n instanceof Amount) {
+            return this.wrapped.gte(n.wrapped);
+        }
+        else if (n.toString) {
+            return this.wrapped.gte(n.toString());
+        }
+        else {
+            return this.wrapped.gte(+n);
+        }
+    }
+    /**
+     * Less than
+     */
+    lt(n) {
+        this.checkNumberNotNull(n);
+        if (typeof n == "string") {
+            return this.wrapped.lt(n);
+        }
+        else if (n instanceof Amount) {
+            return this.wrapped.lt(n.wrapped);
+        }
+        else if (n.toString) {
+            return this.wrapped.lt(n.toString());
+        }
+        else {
+            return this.wrapped.lt(+n);
+        }
+    }
+    /**
+     * Less than or equal to
+     */
+    lte(n) {
+        this.checkNumberNotNull(n);
+        if (typeof n == "string") {
+            return this.wrapped.lte(n);
+        }
+        else if (n instanceof Amount) {
+            return this.wrapped.lte(n.wrapped);
+        }
+        else if (n.toString) {
+            return this.wrapped.lte(n.toString());
+        }
+        else {
+            return this.wrapped.lte(+n);
+        }
+    }
+    /**
+     * Sum
+     */
+    plus(n) {
+        this.checkNumberNotNull(n);
+        let big;
+        if (typeof n == "string") {
+            big = this.wrapped.plus(n);
+        }
+        else if (n instanceof Amount) {
+            big = this.wrapped.plus(n.wrapped);
+        }
+        else if (n.toString) {
+            big = this.wrapped.plus(n.toString());
+        }
+        else {
+            big = this.wrapped.plus(+n);
+        }
+        return this.wrap(big);
+    }
+    /**
+     * Minus
+     */
+    minus(n) {
+        this.checkNumberNotNull(n);
+        let big;
+        if (typeof n == "string") {
+            big = this.wrapped.minus(n);
+        }
+        else if (n instanceof Amount) {
+            big = this.wrapped.minus(n.wrapped);
+        }
+        else if (n.toString) {
+            big = this.wrapped.minus(n.toString());
+        }
+        else {
+            big = this.wrapped.minus(+n);
+        }
+        return this.wrap(big);
+    }
+    /**
+     * Modulo - the integer remainder of dividing this Amount by n.
+     *
+     * Similar to % operator
+     *
+     */
+    mod(n) {
+        this.checkNumberNotNull(n);
+        let big;
+        if (typeof n == "string") {
+            big = this.wrapped.mod(n);
+        }
+        else if (n instanceof Amount) {
+            big = this.wrapped.mod(n.wrapped);
+        }
+        else if (n.toString) {
+            big = this.wrapped.mod(n.toString());
+        }
+        else {
+            big = this.wrapped.mod(+n);
+        }
+        return this.wrap(big);
+    }
+    /**
+     * Round to a maximum of dp decimal places.
+     */
+    round(dp) {
+        let big = this.wrapped.round(dp);
+        return this.wrap(big);
+    }
+    /**
+     * Multiply
+     */
+    times(n) {
+        this.checkNumberNotNull(n);
+        let big;
+        if (typeof n == "string") {
+            big = this.wrapped.times(n);
+        }
+        else if (n instanceof Amount) {
+            big = this.wrapped.times(n.wrapped);
+        }
+        else if (n.toString) {
+            big = this.wrapped.times(n.toString());
+        }
+        else {
+            big = this.wrapped.times(+n);
+        }
+        return this.wrap(big);
+    }
+    /**
+     * Returns a string representing the value of this Amount in normal notation to a fixed number of decimal places dp.
+     */
+    toFixed(dp) {
+        return this.wrapped.toFixed(dp);
+    }
+    /**
+     * Returns a string representing the value of this Amount.
+     */
+    toString() {
+        return this.wrapped.toString();
+    }
+    /**
+     * Returns a primitive number representing the value of this Amount.
+     */
+    toNumber() {
+        return this.wrapped.toNumber();
+    }
+    /** @internal */
+    checkNumberNotNull(amount) {
+        if (amount == null) {
+            throw new Error(`Invalid number: null`);
+        }
+    }
+    /** @internal */
+    static create() {
+        return Object.create(this.prototype);
+    }
+    /** @internal */
+    wrap(big) {
+        let amount = Amount.create();
+        amount.wrapped = big;
+        return amount;
+    }
+}
+exports.Amount = Amount;
+//# sourceMappingURL=Amount.js.map

package/lib/model/App.js

@@ -0,0 +1,114 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.App = void 0;
+const app_service_1 = require("../service/app-service");
+/**
+ * Defines an App on Bkper.
+ *
+ * Apps can be installed on Books by users.
+ *
+ * @public
+ */
+class App {
+    constructor(json) {
+        this.wrapped = json;
+    }
+    /**
+     *
+     * Sets the webhook url for development.
+     *
+     * @returns This App, for chainning.
+     */
+    setWebhookUrlDev(webhookUrlDev) {
+        if (webhookUrlDev) {
+            this.wrapped.webhookUrlDev = webhookUrlDev;
+        }
+        else {
+            this.wrapped.webhookUrlDev = 'null';
+        }
+        return this;
+    }
+    /**
+     *
+     * @returns The App universal identifier
+     */
+    getId() {
+        return this.wrapped.id;
+    }
+    /**
+     * Sets the whitelabeled user emails
+     *
+     * @returns This App for chaining
+     */
+    setUserEmails(emails) {
+        this.wrapped.userEmails = emails;
+        return this;
+    }
+    /**
+     * Sets the developer email
+     *
+     * @returns This App for chaining
+     */
+    setDeveloperEmail(email) {
+        this.wrapped.developerEmail = email;
+        return this;
+    }
+    /**
+     * Sets the client secret
+     *
+     * @returns This App for chaining
+     */
+    setClientSecret(clientSecret) {
+        this.wrapped.clientSecret = clientSecret;
+        return this;
+    }
+    /**
+     * Sets the readme text
+     *
+     * @returns This App for chaining
+     */
+    setReadme(readme) {
+        this.wrapped.readme = readme;
+        return this;
+    }
+    /**
+     * Performs the app creation, applying pending changes.
+     *
+     * The App id MUST be unique. If another app is already existing, an error will be thrown.
+     */
+    create() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield (0, app_service_1.createApp)(this.wrapped);
+            return this;
+        });
+    }
+    /**
+     * Partially update an App, applying pending changes.
+     */
+    patch() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield (0, app_service_1.patchApp)(this.wrapped);
+            return this;
+        });
+    }
+    /**
+     * Perform update App, applying pending changes.
+     */
+    update() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield (0, app_service_1.updateApp)(this.wrapped);
+            return this;
+        });
+    }
+}
+exports.App = App;
+//# sourceMappingURL=App.js.map

package/lib/model/Bkper.js

@@ -0,0 +1,105 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Bkper = void 0;
+const Book_1 = require("./Book");
+const App_1 = require("./App");
+const BookService = __importStar(require("../service/book-service"));
+const UserService = __importStar(require("../service/user-service"));
+const http_api_request_1 = require("../service/http-api-request");
+const User_1 = require("./User");
+/**
+ * This is the main Entry Point of the [bkper-node](https://www.npmjs.com/package/bkper) library.
+ *
+ * @public
+ */
+class Bkper {
+    /**
+     * Gets the [[Book]] with the specified bookId from url param.
+     *
+     * @param id - The universal book id - The same bookId param of URL you access at app.bkper.com
+     *
+     * @returns The retrieved Book, for chaining
+     */
+    static getBook(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let book = yield BookService.loadBook(id);
+            return new Book_1.Book(book);
+        });
+    }
+    /**
+     * Gets the current logged [[User]].
+     *
+     * @returns The retrieved User, for chaining
+     */
+    static getUser() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let user = yield UserService.getUser();
+            return new User_1.User(user);
+        });
+    }
+    /**
+     * Sets the API [[Config]] object.
+     *
+     * @param config - The Config object
+     */
+    static setConfig(config) {
+        http_api_request_1.HttpApiRequest.config = config;
+    }
+    /**
+     * Sets the API key to identify the agent.
+     *
+     * @param key - The API key
+     *
+     * @returns The defined [[App]] object
+     *
+     * @deprecated Use `setConfig()` instead
+     */
+    static setApiKey(key) {
+        http_api_request_1.HttpApiRequest.config.apiKeyProvider = () => __awaiter(this, void 0, void 0, function* () { return key; });
+        return new App_1.App({});
+    }
+    /**
+     * Sets the provider of the valid OAuth2 access token
+     *
+     * @deprecated Use `setConfig()` instead
+     */
+    static setOAuthTokenProvider(oauthTokenProvider) {
+        return __awaiter(this, void 0, void 0, function* () {
+            http_api_request_1.HttpApiRequest.config.oauthTokenProvider = oauthTokenProvider;
+        });
+    }
+}
+exports.Bkper = Bkper;
+//# sourceMappingURL=Bkper.js.map