bkper 2.5.8 → 2.6.0

package/lib/cli.js

@@ -17,6 +17,7 @@ const commander_1 = __importDefault(require("commander"));
 const local_auth_service_1 = require("./auth/local-auth-service");
 const Bkper_1 = require("./model/Bkper");
 const utils_1 = require("./utils");
+const App_1 = require("./model/App");
 var fs = require('fs');
 require('dotenv').config();
 process.env.NODE_ENV = utils_1.NODE_ENV_DEV;
@@ -39,8 +40,9 @@ commander_1.default
     .option('-c, --create', 'Create a new App')
     .action((options) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        let app = Bkper_1.Bkper.setApiKey(process.env.BKPER_API_KEY)
-            .setJson(JSON.parse(fs.readFileSync('./bkperapp.json', 'utf8')))
+        Bkper_1.Bkper.setConfig({ apiKeyProvider: () => __awaiter(void 0, void 0, void 0, function* () { return process.env.BKPER_API_KEY; }) });
+        let app = new App_1.App();
+        app.setJson(JSON.parse(fs.readFileSync('./bkperapp.json', 'utf8')))
             .setReadme(fs.readFileSync('./README.md', 'utf8'))
             .setClientSecret(process.env.BKPER_CLIENT_SECRET)
             .setDeveloperEmail(process.env.BKPER_DEVELOPER_EMAIL)

package/lib/index.d.ts

@@ -97,15 +97,13 @@ export declare class Account {
     deleteProperty(key: string): Account;
     /**
      * Gets the balance based on credit nature of this Account.
-     *
-     * @param raw - True to get the raw balance, no matter the credit nature of this Account.
-     *
+     * @deprecated Use `Book.getBalancesReport` instead.
      * @returns The balance of this account.
      */
-    getBalance(raw?: boolean): Amount;
+    getBalance(): Amount;
     /**
      * Gets the raw balance, no matter credit nature of this Account.
-     *
+     * @deprecated Use `Book.getBalancesReport` instead.
      * @returns The balance of this account.
      */
     getBalanceRaw(): Amount;
@@ -354,25 +352,21 @@ export declare class Bkper {
      */
     static getBook(id: string): Promise<Book>;
     /**
-     * Sets the API key to identify the agent.
-     *
-     * 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)
-     *
-     * See how to create your api key [here](https://cloud.google.com/docs/authentication/api-keys).
-     *
-     * @param key - The key from GCP API & Services Credentials console.
-     *
+     * Gets the current logged [[User]].
+     */
+    static getUser(): Promise<User>;
+    /**
+     * Sets the API [[Config]] object.
+     */
+    static setConfig(config: Config): void;
+    /**
+     * @deprecated Use `setConfig()` instead
      */
     static setApiKey(key: string): App;
     /**
-     * Sets the [[OAuthTokenProvider]].
-     *
-     * OAuthTokenProvider issue a valid OAuth token upon calling the Bkper Rest API.
-     *
-     * @param oauthTokenProvider - The [[OAuthTokenProvider]] implementation.
-     *
+     * @deprecated Use `setConfig()` instead
      */
-    static setOAuthTokenProvider(oauthTokenProvider: OAuthTokenProvider): Promise<void>;
+    static setOAuthTokenProvider(oauthTokenProvider: () => Promise<string>): Promise<void>;
 }
 
 /**
@@ -388,11 +382,8 @@ export declare class Book {
     
     
     
-    
-    
     constructor(json: bkper.Book);
     /**
-     *
      * @returns The wrapped plain json object
      */
     json(): bkper.Book;
@@ -584,7 +575,7 @@ export declare class Book {
      *
      * @returns The value formated
      */
-    formatValue(value: Amount | number): string;
+    formatValue(value: Amount | number | null | undefined): string;
     /**
      * Parse a value string according to [[DecimalSeparator]] and fraction digits of the Book.
      */
@@ -601,10 +592,17 @@ export declare class Book {
      * Create [[Transactions]] on the Book, in batch.
      */
     batchCreateTransactions(transactions: Transaction[]): Promise<Transaction[]>;
+    /**
+     * Trash [[Transactions]] on the Book, in batch.
+     */
+    batchTrashTransactions(transactions: Transaction[]): Promise<void>;
     /**
      * Trigger [Balances Audit](https://help.bkper.com/en/articles/4412038-balances-audit) async process.
      */
     audit(): void;
+    getIntegrations(): Promise<Integration[]>;
+    createIntegration(integration: bkper.Integration | Integration): Promise<Integration>;
+    updateIntegration(integration: bkper.Integration): Promise<Integration>;
     /**
      * Resumes a transaction iteration using a continuation token from a previous iterator.
      *
@@ -763,6 +761,141 @@ export declare class Collection {
     getBooks(): Book[];
 }
 
+declare interface Config {
+    /**
+     * The API key to identify the agent.
+     *
+     * 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)
+     *
+     * See how to create your api key [here](https://cloud.google.com/docs/authentication/api-keys).
+     */
+    apiKeyProvider?: () => Promise<string>;
+    oauthTokenProvider?: () => Promise<string>;
+    /**
+     * Provides additional headers to append to the API request
+     */
+    requestHeadersProvider?: () => Promise<{
+        [key: string]: string;
+    }>;
+    requestErrorHandler?: (error: any) => any;
+    /**
+     * Sets the base api url. Default to https://app.bkper.com/_ah/api/bkper
+     */
+    apiBaseUrl?: string;
+}
+
+/**
+ * This class defines a Connection from an User to an external service.
+ *
+ * @public
+ */
+export declare class Connection {
+    
+    constructor(json?: bkper.Connection);
+    /**
+     * @returns The wrapped plain json object
+     */
+    json(): bkper.Connection;
+    /**
+     * @returns The id of this User
+     */
+    getId(): string;
+    /**
+     * @returns The Connection agentId
+     */
+    getAgentId(): string;
+    /**
+     * Sets the Connection agentId
+     *
+     * @returns This Connection, for chainning.
+     */
+    setAgentId(agentId: string): Connection;
+    /**
+     * @returns The name of this Connection
+     */
+    getName(): string;
+    /**
+     * @returns The email of the owner of this Connection
+     */
+    getEmail(): string;
+    /**
+     * Sets the name of the Connection.
+     *
+     * @returns This Connection, for chainning.
+     */
+    setName(name: string): Connection;
+    /**
+     * Sets the universal unique identifier of this connection.
+     *
+     * @returns This Connection, for chainning.
+     */
+    setUUID(uuid: string): Connection;
+    /**
+     * @returns The name of universal unique identifier of the connection
+     */
+    getUUID(): string;
+    /**
+     * @returns The connection type
+     */
+    getType(): "APP" | "BANK";
+    /**
+     * Sets the connection type.
+     *
+     * @returns This Connection, for chainning.
+     */
+    setType(type: "APP" | "BANK"): Connection;
+    /**
+     * Gets the custom properties stored in this Connection
+     */
+    getProperties(): {
+        [key: string]: string;
+    };
+    /**
+     * Sets the custom properties of the Connection
+     *
+     * @param properties - Object with key/value pair properties
+     *
+     * @returns This Connection, for chainning.
+     */
+    setProperties(properties: {
+        [key: string]: string;
+    }): Connection;
+    /**
+     * Gets the property value for given keys. First property found will be retrieved
+     *
+     * @param keys - The property key
+     */
+    getProperty(...keys: string[]): string;
+    /**
+     * Sets a custom property in the Connection.
+     *
+     * @param key - The property key
+     * @param value - The property value
+     */
+    setProperty(key: string, value: string): Connection;
+    /**
+     * Delete a custom property
+     *
+     * @param key - The property key
+     *
+     * @returns This Connection, for chainning.
+     */
+    deleteProperty(key: string): Connection;
+    /**
+     * Clean any token property
+     */
+    clearTokenProperties(): void;
+    /**
+     * Gets the custom properties keys stored in the Connection.
+     */
+    getPropertyKeys(): string[];
+    getIntegrations(): Promise<Integration[]>;
+    /**
+     * Perform create new connection.
+     */
+    create(): Promise<Connection>;
+}
+
 /**
  * Decimal separator of numbers on book
  *
@@ -958,6 +1091,66 @@ export declare class Group {
     remove(): Promise<Group>;
 }
 
+/**
+ * This class defines a Integration from an User to an external service.
+ *
+ * @public
+ */
+export declare class Integration {
+    
+    constructor(json: bkper.Integration);
+    /**
+     * @returns The wrapped plain json object
+     */
+    json(): bkper.Integration;
+    getBookId(): string;
+    /**
+     * @returns The id of this User
+     */
+    getId(): string;
+    /**
+     * @returns The name of this Integration
+     */
+    getName(): string;
+    /**
+     * Gets the custom properties stored in this Integration
+     */
+    getProperties(): {
+        [key: string]: string;
+    };
+    /**
+     * Sets the custom properties of the Integration
+     *
+     * @param properties - Object with key/value pair properties
+     *
+     * @returns This Integration, for chainning.
+     */
+    setProperties(properties: {
+        [key: string]: string;
+    }): Integration;
+    /**
+     * Gets the property value for given keys. First property found will be retrieved
+     *
+     * @param keys - The property key
+     */
+    getProperty(...keys: string[]): string;
+    /**
+     * Sets a custom property in the Integration.
+     *
+     * @param key - The property key
+     * @param value - The property value
+     */
+    setProperty(key: string, value: string): Integration;
+    /**
+     * Delete a custom property
+     *
+     * @param key - The property key
+     *
+     * @returns This Integration, for chainning.
+     */
+    deleteProperty(key: string): Integration;
+}
+
 /**
  * Enum that represents a Month.
  *
@@ -978,18 +1171,6 @@ declare enum Month {
     DECEMBER = "DECEMBER"
 }
 
-/**
- * Interface to provide OAuth2 tokens upon calling the API.
- *
- * @public
- */
-export declare interface OAuthTokenProvider {
-    /**
-     * A valid OAuth2 access token with **https://www.googleapis.com/auth/userinfo.email** scope authorized.
-     */
-    (): Promise<string>;
-}
-
 /**
  * Enum that represents a period slice.
  *
@@ -1237,7 +1418,7 @@ export declare class Transaction {
     getDebitAccountName(): Promise<string>;
     /**
      *
-     * Sets the debit/origin Account of the Transaction. Same as to().
+     * Sets the debit/destination Account of the Transaction. Same as to().
      *
      * @param account - Account id, name or object.
      *
@@ -1246,7 +1427,7 @@ export declare class Transaction {
     setDebitAccount(account: Account | bkper.Account): Transaction;
     /**
      *
-     * Sets the debit/origin Account of the Transaction. Same as setDebitAccount().
+     * Sets the debit/destination Account of the Transaction. Same as setDebitAccount().
      *
      * @param account - Account id, name or object.
      *
@@ -1444,4 +1625,31 @@ export declare class TransactionIterator {
     getAccount(): Promise<Account>;
 }
 
+/**
+ * This class defines a User.
+ *
+ * @public
+ */
+export declare class User {
+    
+    constructor(wrapped: bkper.User);
+    /**
+     * @returns The id of the User
+     */
+    getId(): string;
+    /**
+     * @returns The name of the User
+     */
+    getName(): string;
+    /**
+     * @returns The full name of the User
+     */
+    getFullName(): string;
+    /**
+     * @returns The User connections
+     */
+    getConnections(): Promise<Connection[]>;
+    getConnection(id: string): Promise<Connection>;
+}
+
 export { }

package/lib/index.js

@@ -7,7 +7,7 @@
  * @packageDocumentation
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Permission = exports.DecimalSeparator = exports.AccountType = exports.Periodicity = exports.TransactionIterator = exports.Transaction = exports.Group = exports.File = exports.Collection = exports.Book = exports.Account = exports.Bkper = exports.Amount = exports.App = void 0;
+exports.Permission = exports.DecimalSeparator = exports.AccountType = exports.Periodicity = exports.Connection = exports.Integration = exports.User = exports.TransactionIterator = exports.Transaction = exports.Group = exports.File = exports.Collection = exports.Book = exports.Account = exports.Bkper = exports.Amount = exports.App = void 0;
 var App_1 = require("./model/App");
 Object.defineProperty(exports, "App", { enumerable: true, get: function () { return App_1.App; } });
 var Amount_1 = require("./model/Amount");
@@ -28,6 +28,12 @@ var Transaction_1 = require("./model/Transaction");
 Object.defineProperty(exports, "Transaction", { enumerable: true, get: function () { return Transaction_1.Transaction; } });
 var TransactionIterator_1 = require("./model/TransactionIterator");
 Object.defineProperty(exports, "TransactionIterator", { enumerable: true, get: function () { return TransactionIterator_1.TransactionIterator; } });
+var User_1 = require("./model/User");
+Object.defineProperty(exports, "User", { enumerable: true, get: function () { return User_1.User; } });
+var Integration_1 = require("./model/Integration");
+Object.defineProperty(exports, "Integration", { enumerable: true, get: function () { return Integration_1.Integration; } });
+var Connection_1 = require("./model/Connection");
+Object.defineProperty(exports, "Connection", { enumerable: true, get: function () { return Connection_1.Connection; } });
 var Enums_1 = require("./model/Enums");
 Object.defineProperty(exports, "Periodicity", { enumerable: true, get: function () { return Enums_1.Periodicity; } });
 Object.defineProperty(exports, "AccountType", { enumerable: true, get: function () { return Enums_1.AccountType; } });

package/lib/model/Account.js

@@ -165,26 +165,19 @@ class Account {
     }
     /**
      * Gets the balance based on credit nature of this Account.
-     *
-     * @param raw - True to get the raw balance, no matter the credit nature of this Account.
-     *
+     * @deprecated Use `Book.getBalancesReport` instead.
      * @returns The balance of this account.
      */
-    getBalance(raw) {
+    getBalance() {
         var balance = new Amount_1.Amount('0');
         if (this.wrapped.balance != null) {
             balance = utils_1.round(this.wrapped.balance, this.book.getFractionDigits());
         }
-        if (raw) {
-            return balance;
-        }
-        else {
-            return utils_1.getRepresentativeValue(balance, this.isCredit());
-        }
+        return balance;
     }
     /**
      * Gets the raw balance, no matter credit nature of this Account.
-     *
+     * @deprecated Use `Book.getBalancesReport` instead.
      * @returns The balance of this account.
      */
     getBalanceRaw() {
@@ -290,7 +283,7 @@ class Account {
             this.wrapped.groups = [];
         }
         if (group instanceof Group_1.Group) {
-            this.wrapped.groups.push(group.wrapped);
+            this.wrapped.groups.push(group.json());
         }
         else {
             this.wrapped.groups.push(group);

package/lib/model/Bkper.js

@@ -32,7 +32,9 @@ 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 HttpApiRequest_1 = require("../service/HttpApiRequest");
+const User_1 = require("./User");
 /**
  * This is the main Entry Point of the [bkper-node](https://www.npmjs.com/package/bkper) library.
  *
@@ -52,30 +54,33 @@ class Bkper {
         });
     }
     /**
-     * Sets the API key to identify the agent.
-     *
-     * 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)
-     *
-     * See how to create your api key [here](https://cloud.google.com/docs/authentication/api-keys).
-     *
-     * @param key - The key from GCP API & Services Credentials console.
-     *
+     * Gets the current logged [[User]].
+     */
+    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.
+     */
+    static setConfig(config) {
+        HttpApiRequest_1.HttpApiRequest.config = config;
+    }
+    /**
+     * @deprecated Use `setConfig()` instead
      */
     static setApiKey(key) {
-        HttpApiRequest_1.HttpApiRequest.API_KEY = key;
+        HttpApiRequest_1.HttpApiRequest.config.apiKeyProvider = () => __awaiter(this, void 0, void 0, function* () { return key; });
         return new App_1.App();
     }
     /**
-     * Sets the [[OAuthTokenProvider]].
-     *
-     * OAuthTokenProvider issue a valid OAuth token upon calling the Bkper Rest API.
-     *
-     * @param oauthTokenProvider - The [[OAuthTokenProvider]] implementation.
-     *
+     * @deprecated Use `setConfig()` instead
      */
     static setOAuthTokenProvider(oauthTokenProvider) {
         return __awaiter(this, void 0, void 0, function* () {
-            HttpApiRequest_1.HttpApiRequest.OAUTH_TOKEN_PROVIDER = oauthTokenProvider;
+            HttpApiRequest_1.HttpApiRequest.config.oauthTokenProvider = oauthTokenProvider;
         });
     }
 }

package/lib/model/Book.js

@@ -34,6 +34,7 @@ const GroupService = __importStar(require("../service/group-service"));
 const BookService = __importStar(require("../service/book-service"));
 const FileService = __importStar(require("../service/file-service"));
 const TransactionService = __importStar(require("../service/transaction-service"));
+const IntegrationService = __importStar(require("../service/integration-service"));
 const Utils = __importStar(require("../utils"));
 const utils_1 = require("../utils");
 const Account_1 = require("./Account");
@@ -42,6 +43,7 @@ const File_1 = require("./File");
 const Group_1 = require("./Group");
 const Transaction_1 = require("./Transaction");
 const TransactionIterator_1 = require("./TransactionIterator");
+const Integration_1 = require("./Integration");
 /**
  *
  * A Book represents [General Ledger](https://en.wikipedia.org/wiki/General_ledger) for a company or business, but can also represent a [Ledger](https://en.wikipedia.org/wiki/Ledger) for a project or department
@@ -55,7 +57,6 @@ class Book {
         this.wrapped = json;
     }
     /**
-     *
      * @returns The wrapped plain json object
      */
     json() {
@@ -349,6 +350,9 @@ class Book {
      * @returns The value formated
      */
     formatValue(value) {
+        if (!value) {
+            return '';
+        }
         return Utils.formatValue(value, this.getDecimalSeparator(), this.getFractionDigits());
     }
     /**
@@ -380,12 +384,51 @@ class Book {
             return transactions;
         });
     }
+    /**
+     * Trash [[Transactions]] on the Book, in batch.
+     */
+    batchTrashTransactions(transactions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let transactionPayloads = [];
+            transactions.forEach(tx => transactionPayloads.push(tx.wrapped));
+            yield TransactionService.trashTransactionsBatch(this.getId(), transactionPayloads);
+        });
+    }
     /**
      * Trigger [Balances Audit](https://help.bkper.com/en/articles/4412038-balances-audit) async process.
      */
     audit() {
         BookService.audit(this.getId());
     }
+    getIntegrations() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const integrationsPlain = yield IntegrationService.listIntegrations(this.getId());
+            const integrations = integrationsPlain.map(i => new Integration_1.Integration(i));
+            return integrations;
+        });
+    }
+    createIntegration(integration) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (integration instanceof Integration_1.Integration) {
+                integration = yield IntegrationService.createIntegration(this.getId(), integration.json());
+            }
+            else {
+                integration = yield IntegrationService.createIntegration(this.getId(), integration);
+            }
+            return new Integration_1.Integration(integration);
+        });
+    }
+    updateIntegration(integration) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (integration instanceof Integration_1.Integration) {
+                integration = yield IntegrationService.updateIntegration(this.getId(), integration.json());
+            }
+            else {
+                integration = yield IntegrationService.updateIntegration(this.getId(), integration);
+            }
+            return new Integration_1.Integration(integration);
+        });
+    }
     /**
      * Resumes a transaction iteration using a continuation token from a previous iterator.
      *

package/lib/{auth/OAuthTokenProvider.js → model/Config.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=OAuthTokenProvider.js.map
+//# sourceMappingURL=Config.js.map