bkper-js 1.14.1 → 1.16.0

package/lib/index.d.ts

@@ -755,6 +755,7 @@ export declare class Book {
 
 
 
+
     /**
      * Gets a [[Group]] object
      *
@@ -1630,6 +1631,10 @@ export declare class Transaction {
      * @returns True if transaction is in trash.
      */
     isTrashed(): boolean | undefined;
+    /**
+     * @returns True if a transaction is locked by the book lock/closing date
+     */
+    isLocked(): boolean;
     /**
      * @returns All #hashtags used on the transaction.
      */
@@ -1773,6 +1778,10 @@ export declare class Transaction {
      * @returns The amount of the transaction.
      */
     getAmount(): Amount | undefined;
+    /**
+     * @returns The amount of the transaction, formatted according to the Book format.
+     */
+    getAmountFormatted(): string | undefined;
     /**
      *
      * Sets the amount of the Transaction.

package/lib/model/Book.js

@@ -510,6 +510,26 @@ export class Book {
             this.idAccountMap.delete(account.getId() || '');
         }
     }
+    /** @internal */
+    getMostRecentLockDate_() {
+        const closingDate = this.getClosingDate();
+        const lockDate = this.getLockDate();
+        if (!closingDate && !lockDate) {
+            return null;
+        }
+        if (!closingDate && lockDate) {
+            return lockDate;
+        }
+        if (closingDate && !lockDate) {
+            return closingDate;
+        }
+        if (Utils.getIsoDateValue(closingDate) > Utils.getIsoDateValue(lockDate)) {
+            return closingDate;
+        }
+        else {
+            return lockDate;
+        }
+    }
     /**
      * Gets a [[Group]] object
      *

package/lib/model/Transaction.js

@@ -104,6 +104,14 @@ export class Transaction {
     isTrashed() {
         return this.payload.trashed;
     }
+    /**
+     * @returns True if a transaction is locked by the book lock/closing date
+     */
+    isLocked() {
+        const date = this.getDate() || Utils.formatDateISO(new Date(), this.book.getTimeZone());
+        const lockOrClosingDate = this.book.getMostRecentLockDate_();
+        return lockOrClosingDate != null && (Utils.getIsoDateValue(lockOrClosingDate) >= Utils.getIsoDateValue(date));
+    }
     /**
      * @returns All #hashtags used on the transaction.
      */
@@ -393,6 +401,16 @@ export class Transaction {
     getAmount() {
         return this.payload.amount != null && this.payload.amount.trim() != '' ? new Amount(this.payload.amount) : undefined;
     }
+    /**
+     * @returns The amount of the transaction, formatted according to the Book format.
+     */
+    getAmountFormatted() {
+        const amount = this.getAmount();
+        if (amount) {
+            return this.book.formatValue(amount);
+        }
+        return undefined;
+    }
     /**
      *
      * Sets the amount of the Transaction.

package/lib/utils.js

@@ -36,7 +36,7 @@ export function formatValue(value, decimalSeparator, fractionDigits) {
     if (value == null) {
         return "";
     }
-    if (!fractionDigits) {
+    if (fractionDigits == null) {
         fractionDigits = 2;
     }
     var formattedValue = (value.toFixed(fractionDigits)) + "";
@@ -119,6 +119,9 @@ export function formatDateISO(date, timeZone) {
     var formatedDate = DateTime.fromJSDate(date, { zone: timeZone }).toISODate();
     return formatedDate;
 }
+export function getIsoDateValue(date) {
+    return +(date.replace(/-/g, ''));
+}
 export function parseDate(date, pattern, timeZone) {
     if (!pattern) {
         pattern = 'yyyy-MM-dd';

package/package.json

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