bkper-js 1.8.1 → 1.9.0

package/lib/model/Transaction.js

@@ -21,18 +21,17 @@ import { Amount } from './Amount.js';
  * @public
  */
 export class Transaction {
-    constructor(book, json) {
+    constructor(book, payload) {
         this.book = book;
-        this.wrapped = json || {
+        this.payload = payload || {
             createdAt: `${Date.now()}`
         };
     }
     /**
-     *
-     * @returns The wrapped plain json object
+     * @returns An immutable copy of the json payload
      */
     json() {
-        return this.wrapped;
+        return Object.assign({}, this.payload);
     }
     /**
      * @returns The book of the Transaction.
@@ -44,13 +43,13 @@ export class Transaction {
      * @returns The id of the Transaction.
      */
     getId() {
-        return this.wrapped.id;
+        return this.payload.id;
     }
     /**
      * @returns The id of the agent that created this transaction
      */
     getAgentId() {
-        return this.wrapped.agentId;
+        return this.payload.agentId;
     }
     /**
      * Remote ids are used to avoid duplication.
@@ -58,7 +57,7 @@ export class Transaction {
      * @returns The remote ids of the Transaction.
      */
     getRemoteIds() {
-        return this.wrapped.remoteIds || [];
+        return this.payload.remoteIds || [];
     }
     /**
      * Add a remote id to the Transaction.
@@ -68,11 +67,11 @@ export class Transaction {
      * @returns This Transaction, for chainning.
      */
     addRemoteId(remoteId) {
-        if (this.wrapped.remoteIds == null) {
-            this.wrapped.remoteIds = [];
+        if (this.payload.remoteIds == null) {
+            this.payload.remoteIds = [];
         }
         if (remoteId) {
-            this.wrapped.remoteIds.push(remoteId);
+            this.payload.remoteIds.push(remoteId);
         }
         return this;
     }
@@ -80,13 +79,13 @@ export class Transaction {
      * @returns True if transaction was already posted to the accounts. False if is still a Draft.
      */
     isPosted() {
-        return this.wrapped.posted;
+        return this.payload.posted;
     }
     /**
      * @returns True if transaction is checked.
      */
     isChecked() {
-        return this.wrapped.checked;
+        return this.payload.checked;
     }
     /**
       * Set the check state of the Transaction.
@@ -96,26 +95,26 @@ export class Transaction {
       * @returns This Transaction, for chainning.
     */
     setChecked(checked) {
-        this.wrapped.checked = checked;
+        this.payload.checked = checked;
         return this;
     }
     /**
      * @returns True if transaction is in trash.
      */
     isTrashed() {
-        return this.wrapped.trashed;
+        return this.payload.trashed;
     }
     /**
      * @returns All #hashtags used on the transaction.
      */
     getTags() {
-        return this.wrapped.tags || [];
+        return this.payload.tags || [];
     }
     /**
      * @returns All urls of the transaction.
      */
     getUrls() {
-        return this.wrapped.urls || [];
+        return this.payload.urls || [];
     }
     /**
      * Sets the Transaction urls. Url starts with https://
@@ -125,7 +124,7 @@ export class Transaction {
      * @returns This Transaction, for chainning.
      */
     setUrls(urls) {
-        this.wrapped.urls = undefined;
+        this.payload.urls = undefined;
         if (urls) {
             urls.forEach(url => {
                 this.addUrl(url);
@@ -141,11 +140,11 @@ export class Transaction {
      * @returns This Transaction, for chainning.
      */
     addUrl(url) {
-        if (this.wrapped.urls == null) {
-            this.wrapped.urls = [];
+        if (this.payload.urls == null) {
+            this.payload.urls = [];
         }
         if (url) {
-            this.wrapped.urls.push(url);
+            this.payload.urls.push(url);
         }
         return this;
     }
@@ -153,8 +152,8 @@ export class Transaction {
      * @returns The files attached to the transaction.
      */
     getFiles() {
-        if (this.wrapped.files && this.wrapped.files.length > 0) {
-            const files = this.wrapped.files.map(file => new File(this.book, file));
+        if (this.payload.files && this.payload.files.length > 0) {
+            const files = this.payload.files.map(file => new File(this.book, file));
             return files;
         }
         else {
@@ -173,14 +172,14 @@ export class Transaction {
      */
     addFile(file) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (this.wrapped.files == null) {
-                this.wrapped.files = [];
+            if (this.payload.files == null) {
+                this.payload.files = [];
             }
             //Make sure file is already created
             if (file.getId() == null) {
                 file = yield file.create();
             }
-            this.wrapped.files.push(file.json());
+            this.payload.files.push(file.json());
             return this;
         });
     }
@@ -200,7 +199,7 @@ export class Transaction {
      * Gets the custom properties stored in this Transaction.
      */
     getProperties() {
-        return this.wrapped.properties != null ? Object.assign({}, this.wrapped.properties) : {};
+        return this.payload.properties != null ? Object.assign({}, this.payload.properties) : {};
     }
     /**
      * Sets the custom properties of the Transaction
@@ -210,7 +209,7 @@ export class Transaction {
      * @returns This Transaction, for chainning.
      */
     setProperties(properties) {
-        this.wrapped.properties = Object.assign({}, properties);
+        this.payload.properties = Object.assign({}, properties);
         return this;
     }
     /**
@@ -221,7 +220,7 @@ export class Transaction {
     getProperty(...keys) {
         for (let index = 0; index < keys.length; index++) {
             const key = keys[index];
-            let value = this.wrapped.properties != null ? this.wrapped.properties[key] : null;
+            let value = this.payload.properties != null ? this.payload.properties[key] : null;
             if (value != null && value.trim() != '') {
                 return value;
             }
@@ -256,13 +255,13 @@ export class Transaction {
         if (key == null || key.trim() == '') {
             return this;
         }
-        if (this.wrapped.properties == null) {
-            this.wrapped.properties = {};
+        if (this.payload.properties == null) {
+            this.payload.properties = {};
         }
         if (!value) {
             value = '';
         }
-        this.wrapped.properties[key] = value;
+        this.payload.properties[key] = value;
         return this;
     }
     /**
@@ -282,10 +281,10 @@ export class Transaction {
      */
     getCreditAccount() {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!this.wrapped.creditAccount) {
+            if (!this.payload.creditAccount) {
                 return undefined;
             }
-            return yield this.book.getAccount(this.wrapped.creditAccount.id);
+            return yield this.book.getAccount(this.payload.creditAccount.id);
         });
     }
     /**
@@ -313,12 +312,12 @@ export class Transaction {
     setCreditAccount(account) {
         if (account instanceof Account) {
             if (account != null && account.getId() != null) {
-                this.wrapped.creditAccount = account.json();
+                this.payload.creditAccount = account.json();
             }
         }
         else {
             if (account != null && account.id != null) {
-                this.wrapped.creditAccount = account;
+                this.payload.creditAccount = account;
             }
         }
         return this;
@@ -341,10 +340,10 @@ export class Transaction {
      */
     getDebitAccount() {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!this.wrapped.debitAccount) {
+            if (!this.payload.debitAccount) {
                 return undefined;
             }
-            return yield this.book.getAccount(this.wrapped.debitAccount.id);
+            return yield this.book.getAccount(this.payload.debitAccount.id);
         });
     }
     /**
@@ -372,12 +371,12 @@ export class Transaction {
     setDebitAccount(account) {
         if (account instanceof Account) {
             if (account != null && account.getId() != null) {
-                this.wrapped.debitAccount = account.json();
+                this.payload.debitAccount = account.json();
             }
         }
         else {
             if (account != null && account.id != null) {
-                this.wrapped.debitAccount = account;
+                this.payload.debitAccount = account;
             }
         }
         return this;
@@ -398,7 +397,7 @@ export class Transaction {
      * @returns The amount of the transaction.
      */
     getAmount() {
-        return this.wrapped.amount != null && this.wrapped.amount.trim() != '' ? new Amount(this.wrapped.amount) : undefined;
+        return this.payload.amount != null && this.payload.amount.trim() != '' ? new Amount(this.payload.amount) : undefined;
     }
     /**
      *
@@ -409,15 +408,15 @@ export class Transaction {
     setAmount(amount) {
         if (typeof amount == "string") {
             amount = Utils.parseValue(amount, this.book.getDecimalSeparator()) + '';
-            this.wrapped.amount = amount.toString();
+            this.payload.amount = amount.toString();
             return this;
         }
         amount = new Amount(amount);
         if (amount.eq(0)) {
-            this.wrapped.amount = undefined;
+            this.payload.amount = undefined;
             return this;
         }
-        this.wrapped.amount = amount.abs().toString();
+        this.payload.amount = amount.abs().toString();
         return this;
     }
     /**
@@ -520,10 +519,10 @@ export class Transaction {
      * @returns The description of this transaction.
      */
     getDescription() {
-        if (this.wrapped.description == null) {
+        if (this.payload.description == null) {
             return "";
         }
-        return this.wrapped.description;
+        return this.payload.description;
     }
     /**
      *
@@ -532,7 +531,7 @@ export class Transaction {
      * @returns This Transaction, for chainning.
      */
     setDescription(description) {
-        this.wrapped.description = description;
+        this.payload.description = description;
         return this;
     }
     //DATE
@@ -540,7 +539,7 @@ export class Transaction {
      * @returns The Transaction date, in ISO format yyyy-MM-dd.
      */
     getDate() {
-        return this.wrapped.date;
+        return this.payload.date;
     }
     /**
      *
@@ -552,14 +551,14 @@ export class Transaction {
         if (typeof date == "string") {
             if (date.indexOf('/') > 0) {
                 let dateObject = Utils.parseDate(date, this.book.getDatePattern(), this.book.getTimeZone());
-                this.wrapped.date = Utils.formatDateISO(dateObject, this.book.getTimeZone());
+                this.payload.date = Utils.formatDateISO(dateObject, this.book.getTimeZone());
             }
             else if (date.indexOf('-')) {
-                this.wrapped.date = date;
+                this.payload.date = date;
             }
         }
         else if (Object.prototype.toString.call(date) === '[object Date]') {
-            this.wrapped.date = Utils.formatDateISO(date, this.book.getTimeZone());
+            this.payload.date = Utils.formatDateISO(date, this.book.getTimeZone());
         }
         return this;
     }
@@ -573,19 +572,19 @@ export class Transaction {
      * @returns The Transaction date number, in format YYYYMMDD.
      */
     getDateValue() {
-        return this.wrapped.dateValue;
+        return this.payload.dateValue;
     }
     /**
      * @returns The Transaction date, formatted on the date pattern of the [[Book]].
      */
     getDateFormatted() {
-        return this.wrapped.dateFormatted;
+        return this.payload.dateFormatted;
     }
     /**
      * @returns The date the transaction was created.
      */
     getCreatedAt() {
-        return new Date(new Number(this.wrapped.createdAt).valueOf());
+        return new Date(new Number(this.payload.createdAt).valueOf());
     }
     /**
      * @returns The date the transaction was created, formatted according to the date pattern of [[Book]].
@@ -596,11 +595,11 @@ export class Transaction {
     //EVOLVED BALANCES
     /** @internal */
     getCaEvolvedBalance_() {
-        return this.wrapped.creditAccount != null && this.wrapped.creditAccount.balance != null ? new Amount(this.wrapped.creditAccount.balance) : undefined;
+        return this.payload.creditAccount != null && this.payload.creditAccount.balance != null ? new Amount(this.payload.creditAccount.balance) : undefined;
     }
     /** @internal */
     getDaEvolvedBalance_() {
-        return this.wrapped.debitAccount != null && this.wrapped.debitAccount.balance != null ? new Amount(this.wrapped.debitAccount.balance) : undefined;
+        return this.payload.debitAccount != null && this.payload.debitAccount.balance != null ? new Amount(this.payload.debitAccount.balance) : undefined;
     }
     /**
      * Gets the balance that the [[Account]] has at that day, when listing transactions of that Account.
@@ -636,8 +635,8 @@ export class Transaction {
      */
     create() {
         return __awaiter(this, void 0, void 0, function* () {
-            let operation = yield TransactionService.createTransaction(this.book.getId(), this.wrapped);
-            this.wrapped = operation.transaction || {};
+            let operation = yield TransactionService.createTransaction(this.book.getId(), this.payload);
+            this.payload = operation.transaction || {};
             return this;
         });
     }
@@ -646,8 +645,8 @@ export class Transaction {
      */
     update() {
         return __awaiter(this, void 0, void 0, function* () {
-            let operation = yield TransactionService.updateTransaction(this.book.getId(), this.wrapped);
-            this.wrapped = operation.transaction || {};
+            let operation = yield TransactionService.updateTransaction(this.book.getId(), this.payload);
+            this.payload = operation.transaction || {};
             return this;
         });
     }
@@ -657,8 +656,8 @@ export class Transaction {
     check() {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
-            let operation = yield TransactionService.checkTransaction(this.book.getId(), this.wrapped);
-            this.wrapped.checked = (_a = operation.transaction) === null || _a === void 0 ? void 0 : _a.checked;
+            let operation = yield TransactionService.checkTransaction(this.book.getId(), this.payload);
+            this.payload.checked = (_a = operation.transaction) === null || _a === void 0 ? void 0 : _a.checked;
             return this;
         });
     }
@@ -668,8 +667,8 @@ export class Transaction {
     uncheck() {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
-            let operation = yield TransactionService.uncheckTransaction(this.book.getId(), this.wrapped);
-            this.wrapped.checked = (_a = operation.transaction) === null || _a === void 0 ? void 0 : _a.checked;
+            let operation = yield TransactionService.uncheckTransaction(this.book.getId(), this.payload);
+            this.payload.checked = (_a = operation.transaction) === null || _a === void 0 ? void 0 : _a.checked;
             return this;
         });
     }
@@ -678,8 +677,8 @@ export class Transaction {
      */
     post() {
         return __awaiter(this, void 0, void 0, function* () {
-            let operation = yield TransactionService.postTransaction(this.book.getId(), this.wrapped);
-            this.wrapped = operation.transaction || {};
+            let operation = yield TransactionService.postTransaction(this.book.getId(), this.payload);
+            this.payload = operation.transaction || {};
             return this;
         });
     }
@@ -689,8 +688,8 @@ export class Transaction {
     remove() {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
-            let operation = yield TransactionService.trashTransaction(this.book.getId(), this.wrapped);
-            this.wrapped.trashed = (_a = operation.transaction) === null || _a === void 0 ? void 0 : _a.trashed;
+            let operation = yield TransactionService.trashTransaction(this.book.getId(), this.payload);
+            this.payload.trashed = (_a = operation.transaction) === null || _a === void 0 ? void 0 : _a.trashed;
             return this;
         });
     }
@@ -700,8 +699,8 @@ export class Transaction {
     restore() {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
-            let operation = yield TransactionService.restoreTransaction(this.book.getId(), this.wrapped);
-            this.wrapped.trashed = (_a = operation.transaction) === null || _a === void 0 ? void 0 : _a.trashed;
+            let operation = yield TransactionService.restoreTransaction(this.book.getId(), this.payload);
+            this.payload.trashed = (_a = operation.transaction) === null || _a === void 0 ? void 0 : _a.trashed;
             return this;
         });
     }

package/lib/model/TransactionList.js

@@ -12,25 +12,25 @@ import { Transaction } from "./Transaction.js";
  * A list associated with a transaction query.
  */
 export class TransactionList {
-    constructor(book, transactionList) {
+    constructor(book, payload) {
         this.book = book;
-        this.wrapped = transactionList;
+        this.payload = payload;
     }
     /**
      * @returns The cursor associated with the query for pagination.
      */
     getCursor() {
-        return this.wrapped.cursor;
+        return this.payload.cursor;
     }
     /**
      * Retrieves the account associated with the query, when filtering by account.
      */
     getAccount() {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!this.wrapped.account) {
+            if (!this.payload.account) {
                 return undefined;
             }
-            return yield this.book.getAccount(this.wrapped.account);
+            return yield this.book.getAccount(this.payload.account);
         });
     }
     /**
@@ -48,7 +48,7 @@ export class TransactionList {
      */
     size() {
         var _a;
-        return ((_a = this.wrapped.items) === null || _a === void 0 ? void 0 : _a.length) || 0;
+        return ((_a = this.payload.items) === null || _a === void 0 ? void 0 : _a.length) || 0;
     }
     /**
      * Get the transactions in the list.
@@ -58,7 +58,7 @@ export class TransactionList {
     getItems() {
         var _a;
         let transactions = [];
-        for (let transaction of (_a = this.wrapped.items) !== null && _a !== void 0 ? _a : []) {
+        for (let transaction of (_a = this.payload.items) !== null && _a !== void 0 ? _a : []) {
             transactions.push(new Transaction(this.book, transaction));
         }
         return transactions;

package/lib/model/User.js

@@ -15,16 +15,15 @@ import * as ConnectionService from '../service/connection-service.js';
  * @public
  */
 export class User {
-    constructor(json) {
-        /** @internal */
-        this.wrapped = {};
-        this.wrapped = json || {};
+    constructor(payload) {
+        this.payload = {};
+        this.payload = payload || {};
     }
     /**
-     * @returns The wrapped plain json object
+     * @returns An immutable copy of the json payload
      */
     json() {
-        return this.wrapped;
+        return Object.assign({}, this.payload);
     }
     /**
      * Gets the id of the User.
@@ -32,7 +31,7 @@ export class User {
      * @returns The User's id
      */
     getId() {
-        return this.wrapped.id;
+        return this.payload.id;
     }
     /**
      * Gets the name of the User.
@@ -40,7 +39,7 @@ export class User {
      * @returns The User's name
      */
     getName() {
-        return this.wrapped.name;
+        return this.payload.name;
     }
     /**
      * Gets the full name of the User.
@@ -48,7 +47,7 @@ export class User {
      * @returns The User's full name
      */
     getFullName() {
-        return this.wrapped.fullName;
+        return this.payload.fullName;
     }
     /**
      * Gets the email of the User.
@@ -56,7 +55,7 @@ export class User {
      * @returns The User's email
      */
     getEmail() {
-        return this.wrapped.email;
+        return this.payload.email;
     }
     /**
      * Gets the hosted domain of the User.
@@ -64,7 +63,7 @@ export class User {
      * @returns The User's hosted domain
      */
     getHostedDomain() {
-        return this.wrapped.hostedDomain;
+        return this.payload.hostedDomain;
     }
     /**
      * Tells if the User is in the free plan.
@@ -72,7 +71,7 @@ export class User {
      * @returns True if the User is in the free plan
      */
     isFree() {
-        return this.wrapped.free;
+        return this.payload.free;
     }
     /**
      * Tells if the User has started the trial.
@@ -80,7 +79,7 @@ export class User {
      * @returns True if the User has started the trial
      */
     hasStartedTrial() {
-        return this.wrapped.startedTrial;
+        return this.payload.startedTrial;
     }
     /**
      * Gets the days left in User's trial.
@@ -88,7 +87,7 @@ export class User {
      * @returns The User's days left in trial
      */
     getDaysLeftInTrial() {
-        return this.wrapped.daysLeftInTrial;
+        return this.payload.daysLeftInTrial;
     }
     /**
      * Tells if the User has already used [[Connections]].
@@ -96,7 +95,7 @@ export class User {
      * @returns True if the User has already used Connections
      */
     hasUsedConnections() {
-        return this.wrapped.bankConnections;
+        return this.payload.bankConnections;
     }
     /**
      * Gets the [[Connections]] of the User.

package/package.json

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