bkper-js 1.8.1 → 1.9.0

package/lib/index.d.ts

@@ -17,12 +17,11 @@
  * @public
  */
 export declare class Account {
+    payload: bkper.Account;
 
-
-    constructor(book: Book, json?: bkper.Account);
+    constructor(book: Book, payload?: bkper.Account);
     /**
-     *
-     * @returns The wrapped plain json object
+     * @returns An immutable copy of the json payload
      */
     json(): bkper.Account;
     /**
@@ -314,8 +313,12 @@ export declare class Amount {
  * @public
  */
 export declare class App {
-
-    constructor(json?: bkper.App);
+    payload: bkper.App;
+    constructor(payload?: bkper.App);
+    /**
+     * @returns The wrapped plain json object
+     */
+    json(): bkper.App;
     /**
      *
      * Sets the webhook url for development.
@@ -366,10 +369,6 @@ export declare class App {
      * Perform update App, applying pending changes.
      */
     update(): Promise<App>;
-    /**
-     * @returns The wrapped plain json object
-     */
-    json(): bkper.App;
 }
 
 /**
@@ -470,13 +469,13 @@ export declare class Bkper {
  * @public
  */
 export declare class Book {
+    payload: bkper.Book;
 
 
 
-
-    constructor(json?: bkper.Book);
+    constructor(payload?: bkper.Book);
     /**
-     * @returns The wrapped plain json object
+     * @returns An immutable copy of the json payload
      */
     json(): bkper.Book;
     /**
@@ -730,56 +729,6 @@ export declare class Book {
      * @returns The updated Integration object
      */
     updateIntegration(integration: bkper.Integration): Promise<Integration>;
-    /**
-     * Instantiate a new [[Transaction]]
-     *
-     * Example:
-     *
-     * ```js
-     * var book = Bkper.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
-     *
-     * book.newTransaction()
-     *  .setDate('2013-01-25')
-     *  .setDescription("Filling tank of my truck")
-     *  .from('Credit Card')
-     *  .to('Gas')
-     *  .setAmount(126.50)
-     *  .create();
-     *
-     * ```
-     *
-     */
-    newTransaction(): Transaction;
-    /**
-     * Instantiate a new [[Account]]
-     *
-     * Example:
-     * ```js
-     * var book = Bkper.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
-     *
-     * book.newAccount()
-     *  .setName('Some New Account')
-     *  .setType('INCOMING')
-     *  .addGroup('Revenue').addGroup('Salary')
-     *  .setProperties({prop_a: 'A', prop_b: 'B'})
-     *  .create();
-     * ```
-     */
-    newAccount(): Account;
-    /**
-     * Instantiate a new [[Group]]
-     *
-     * Example:
-     * ```js
-     * var book = Bkper.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
-     *
-     * book.newGroup()
-     *  .setName('Some New Group')
-     *  .setProperty('key', 'value')
-     *  .create();
-     * ```
-     */
-    newGroup(): Group;
     /**
      * Gets an [[Account]] object
      *
@@ -821,19 +770,6 @@ export declare class Book {
      * Retrieve a transaction by id
      */
     getTransaction(id: string): Promise<Transaction | undefined>;
-    /**
-     * Instantiate a new [[BkperFile]]
-     *
-     * Example:
-     * ```js
-     * var book = Bkper.getBook("agtzfmJrcGVyLWhyZHITCxIGTGVkZ2VyGICAgIDggqALDA");
-     *
-     * book.newFile()
-     *  .setBlob(UrlFetchApp.fetch('https://bkper.com/images/index/integrations4.png').getBlob())
-     *  .create();
-     * ```
-     */
-    newFile(): File;
     /**
      * Retrieve a file by id
      */
@@ -856,8 +792,12 @@ export declare class Book {
  * @public
  */
 export declare class Collection {
-
-
+    payload: bkper.Collection;
+    constructor(payload?: bkper.Collection);
+    /**
+     * @returns The wrapped plain json object
+     */
+    json(): bkper.Collection;
     /**
      * @returns The id of this Collection
      */
@@ -870,10 +810,6 @@ export declare class Collection {
      * @returns All Books of this collection.
      */
     getBooks(): Book[];
-    /**
-     * @returns The wrapped plain json object
-     */
-    json(): bkper.Collection;
 }
 
 /**
@@ -927,12 +863,10 @@ export declare interface Config {
  * @public
  */
 export declare class Connection {
-
-    constructor(json?: bkper.Connection);
+    payload: bkper.Connection;
+    constructor(payload?: bkper.Connection);
     /**
-     * Gets the wrapped plain json object of the Connection.
-     *
-     * @returns The Connection wrapped plain json object
+     * @returns An immutable copy of the json payload
      */
     json(): bkper.Connection;
     /**
@@ -1095,14 +1029,13 @@ export declare enum DecimalSeparator {
  * @public
  */
 export declare class File {
+    payload: bkper.File;
 
-
-    constructor(book: Book, json?: bkper.File);
+    constructor(book: Book, payload?: bkper.File);
     /**
-     *
-     * @returns The wrapped plain json object
+     * @returns An immutable copy of the json payload
      */
-    json(): bkper.Transaction;
+    json(): bkper.File;
     /**
      * Gets the File id
      */
@@ -1164,13 +1097,12 @@ export declare class File {
  * @public
  */
 export declare class Group {
+    payload: bkper.Group;
 
 
-
-    constructor(book: Book, json?: bkper.Group);
+    constructor(book: Book, payload?: bkper.Group);
     /**
-     *
-     * @returns The wrapped plain json object
+     * @returns An immutable copy of the json payload
      */
     json(): bkper.Group;
     /**
@@ -1278,12 +1210,10 @@ export declare class Group {
  * @public
  */
 export declare class Integration {
-
-    constructor(json?: bkper.Integration);
+    payload: bkper.Integration;
+    constructor(payload?: bkper.Integration);
     /**
-     * Gets the wrapped plain json object of the Integration.
-     *
-     * @returns The Integration wrapped plain json object
+     * @returns An immutable copy of the json payload
      */
     json(): bkper.Integration;
     /**
@@ -1451,8 +1381,12 @@ export declare enum Permission {
  * @public
  */
 export declare class Template {
-
+    payload: bkper.Template;
     constructor(json?: bkper.Template);
+    /**
+     * @returns An immutable copy of the json payload
+     */
+    json(): bkper.Template;
     /**
      * Gets the name of the Template.
      *
@@ -1501,12 +1435,6 @@ export declare class Template {
      * @returns The link of the Google Sheets spreadsheet associated with the Template
      */
     getSheetsLink(): string | undefined;
-    /**
-     * Gets the wrapped plain json object of the Template.
-     *
-     * @returns The Template wrapped plain json object
-     */
-    json(): bkper.Template;
 }
 
 /**
@@ -1518,12 +1446,11 @@ export declare class Template {
  * @public
  */
 export declare class Transaction {
+    payload: bkper.Transaction;
 
-
-    constructor(book: Book, json?: bkper.Transaction);
+    constructor(book: Book, payload?: bkper.Transaction);
     /**
-     *
-     * @returns The wrapped plain json object
+     * @returns An immutable copy of the json payload
      */
     json(): bkper.Transaction;
     /**
@@ -1850,9 +1777,9 @@ export declare class Transaction {
  * A list associated with a transaction query.
  */
 export declare class TransactionPage {
-    private book;
-    private wrapped;
-    constructor(book: Book, transactionList: bkper.TransactionList);
+    private payload;
+
+    constructor(book: Book, payload: bkper.TransactionList);
     /**
      * @returns The cursor associated with the query for pagination.
      */
@@ -1886,10 +1813,10 @@ export declare class TransactionPage {
  * @public
  */
 export declare class User {
-
-    constructor(json?: bkper.User);
+    payload: bkper.User;
+    constructor(payload?: bkper.User);
     /**
-     * @returns The wrapped plain json object
+     * @returns An immutable copy of the json payload
      */
     json(): bkper.User;
     /**

package/lib/model/Account.js

@@ -23,28 +23,29 @@ import { Amount } from './Amount.js';
  * @public
  */
 export class Account {
-    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);
     }
     /**
      * Gets the account internal id.
      */
     getId() {
-        return this.wrapped.id;
+        return this.payload.id;
     }
     /**
      * Gets the account name.
      */
     getName() {
-        return this.wrapped.name;
+        return this.payload.name;
     }
     /**
      *
@@ -53,15 +54,15 @@ export class Account {
      * @returns This Account, for chainning.
      */
     setName(name) {
-        this.wrapped.name = name;
+        this.payload.name = name;
         return this;
     }
     /**
      * @returns The name of this account without spaces or special characters.
      */
     getNormalizedName() {
-        if (this.wrapped.normalizedName) {
-            return this.wrapped.normalizedName;
+        if (this.payload.normalizedName) {
+            return this.payload.normalizedName;
         }
         else {
             return normalizeText(this.getName());
@@ -71,7 +72,7 @@ export class Account {
      * @returns The type for of this account.
      */
     getType() {
-        return this.wrapped.type;
+        return this.payload.type;
     }
     /**
      *
@@ -80,14 +81,14 @@ export class Account {
      * @returns This Account, for chainning
      */
     setType(type) {
-        this.wrapped.type = type;
+        this.payload.type = type;
         return this;
     }
     /**
      * Gets the custom properties stored in this Account.
      */
     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 Account
@@ -97,7 +98,7 @@ export class Account {
      * @returns This Account, for chainning.
      */
     setProperties(properties) {
-        this.wrapped.properties = Object.assign({}, properties);
+        this.payload.properties = Object.assign({}, properties);
         return this;
     }
     /**
@@ -108,7 +109,7 @@ export class Account {
     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;
             }
@@ -127,13 +128,13 @@ export class Account {
         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;
     }
     /**
@@ -154,8 +155,8 @@ export class Account {
      */
     getBalance() {
         var balance = new Amount('0');
-        if (this.wrapped.balance != null) {
-            balance = round(this.wrapped.balance, this.book.getFractionDigits());
+        if (this.payload.balance != null) {
+            balance = round(this.payload.balance, this.book.getFractionDigits());
         }
         return balance;
     }
@@ -166,8 +167,8 @@ export class Account {
      */
     getBalanceRaw() {
         var balance = new Amount('0');
-        if (this.wrapped.balance != null) {
-            balance = round(this.wrapped.balance, this.book.getFractionDigits());
+        if (this.payload.balance != null) {
+            balance = round(this.payload.balance, this.book.getFractionDigits());
         }
         return balance;
     }
@@ -175,7 +176,7 @@ export class Account {
      * Tell if this account is archived.
      */
     isArchived() {
-        return this.wrapped.archived;
+        return this.payload.archived;
     }
     /**
      * Set account archived/unarchived.
@@ -183,7 +184,7 @@ export class Account {
      * @returns This Account, for chainning.
      */
     setArchived(archived) {
-        this.wrapped.archived = archived;
+        this.payload.archived = archived;
         return this;
     }
     /**
@@ -192,7 +193,7 @@ export class Account {
      * Accounts with transaction posted, even with zero balance, can only be archived.
      */
     hasTransactionPosted() {
-        return this.wrapped.hasTransactionPosted;
+        return this.payload.hasTransactionPosted;
     }
     /**
      *
@@ -207,7 +208,7 @@ export class Account {
      * @returns True if its a permanent Account
      */
     isPermanent() {
-        return this.wrapped.permanent;
+        return this.payload.permanent;
     }
     /**
      * Tell if the account has a Credit nature or Debit otherwise
@@ -230,7 +231,7 @@ export class Account {
      * As a rule of thumb, and for simple understanding, almost all accounts are Debit nature (NOT credit), except the ones that "offers" amount for the books, like revenue accounts.
      */
     isCredit() {
-        return this.wrapped.credit;
+        return this.payload.credit;
     }
     /**
      * Get the [[Groups]] of this account.
@@ -252,7 +253,7 @@ export class Account {
      * @returns This Account, for chainning.
      */
     setGroups(groups) {
-        this.wrapped.groups = undefined;
+        this.payload.groups = undefined;
         if (groups != null) {
             groups.forEach(group => this.addGroup(group));
         }
@@ -264,14 +265,14 @@ export class Account {
      * @returns This Account, for chainning.
      */
     addGroup(group) {
-        if (!this.wrapped.groups) {
-            this.wrapped.groups = [];
+        if (!this.payload.groups) {
+            this.payload.groups = [];
         }
         if (group instanceof Group) {
-            this.wrapped.groups.push(group.json());
+            this.payload.groups.push(group.json());
         }
         else {
-            this.wrapped.groups.push(group);
+            this.payload.groups.push(group);
         }
         return this;
     }
@@ -280,7 +281,7 @@ export class Account {
      */
     removeGroup(group) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (this.wrapped.groups != null) {
+            if (this.payload.groups != null) {
                 let groupObject = undefined;
                 if (group instanceof Group) {
                     groupObject = group;
@@ -289,10 +290,10 @@ export class Account {
                     groupObject = yield this.book.getGroup(group);
                 }
                 if (groupObject) {
-                    for (let i = 0; i < this.wrapped.groups.length; i++) {
-                        const groupId = this.wrapped.groups[i];
+                    for (let i = 0; i < this.payload.groups.length; i++) {
+                        const groupId = this.payload.groups[i];
                         if (groupId == groupObject.getId()) {
-                            this.wrapped.groups.splice(i, 1);
+                            this.payload.groups.splice(i, 1);
                         }
                     }
                 }
@@ -324,11 +325,11 @@ export class Account {
     }
     /** @internal */
     isInGroupObject_(group) {
-        if (this.wrapped.groups == null) {
+        if (this.payload.groups == null) {
             return false;
         }
-        for (var i = 0; i < this.wrapped.groups.length; i++) {
-            if (this.wrapped.groups[i] == group.getId()) {
+        for (var i = 0; i < this.payload.groups.length; i++) {
+            if (this.payload.groups[i] == group.getId()) {
                 return true;
             }
         }
@@ -339,7 +340,8 @@ export class Account {
      */
     create() {
         return __awaiter(this, void 0, void 0, function* () {
-            this.wrapped = yield AccountService.createAccount(this.book.getId(), this.wrapped);
+            this.payload = yield AccountService.createAccount(this.book.getId(), this.payload);
+            this.book.updateAccountCache(this);
             return this;
         });
     }
@@ -348,7 +350,8 @@ export class Account {
      */
     update() {
         return __awaiter(this, void 0, void 0, function* () {
-            this.wrapped = yield AccountService.updateAccount(this.book.getId(), this.wrapped);
+            this.payload = yield AccountService.updateAccount(this.book.getId(), this.payload);
+            this.book.updateAccountCache(this);
             return this;
         });
     }
@@ -357,7 +360,8 @@ export class Account {
      */
     remove() {
         return __awaiter(this, void 0, void 0, function* () {
-            this.wrapped = yield AccountService.deleteAccount(this.book.getId(), this.wrapped);
+            this.payload = yield AccountService.deleteAccount(this.book.getId(), this.payload);
+            this.book.removeAccountCache(this);
             return this;
         });
     }