feat: sorting columns.

server/src/models/SaleInvoice.js

@@ -1,23 +1,23 @@
-import { Model, raw } from 'objection';
-import moment from 'moment';
-import TenantModel from 'models/TenantModel';
-import { defaultToTransform } from 'utils';
-import { QueryBuilder } from 'knex';
-import { query } from 'winston';
+import { Model, raw } from "objection";
+import moment from "moment";
+import TenantModel from "models/TenantModel";
+import { defaultToTransform } from "utils";
+import { QueryBuilder } from "knex";
+import { query } from "winston";
 
 export default class SaleInvoice extends TenantModel {
   /**
    * Table name
    */
   static get tableName() {
-    return 'sales_invoices';
+    return "sales_invoices";
   }
 
   /**
    * Timestamps columns.
    */
   get timestamps() {
-    return ['created_at', 'updated_at'];
+    return ["created_at", "updated_at"];
   }
 
   /**
@@ -25,14 +25,14 @@ export default class SaleInvoice extends TenantModel {
    */
   static get virtualAttributes() {
     return [
-      'dueAmount',
-      'isDelivered',
-      'isOverdue',
-      'isPartiallyPaid',
-      'isFullyPaid',
-      'isPaid',
-      'remainingDays',
-      'overdueDays',
+      "dueAmount",
+      "isDelivered",
+      "isOverdue",
+      "isPartiallyPaid",
+      "isFullyPaid",
+      "isPaid",
+      "remainingDays",
+      "overdueDays",
     ];
   }
 
@@ -91,12 +91,14 @@ export default class SaleInvoice extends TenantModel {
    */
   get remainingDays() {
     // Can't continue in case due date not defined.
-    if (!this.dueDate) { return null; }
+    if (!this.dueDate) {
+      return null;
+    }
 
     const date = moment();
     const dueDate = moment(this.dueDate);
 
-    return Math.max(dueDate.diff(date, 'days'), 0);
+    return Math.max(dueDate.diff(date, "days"), 0);
   }
 
   /**
@@ -112,17 +114,19 @@ export default class SaleInvoice extends TenantModel {
   }
 
   /**
-   * 
-   * @param {*} asDate 
+   *
+   * @param {*} asDate
    */
-  getOverdueDays(asDate = moment().format('YYYY-MM-DD')) {
+  getOverdueDays(asDate = moment().format("YYYY-MM-DD")) {
     // Can't continue in case due date not defined.
-    if (!this.dueDate) { return null; }
+    if (!this.dueDate) {
+      return null;
+    }
 
     const date = moment(asDate);
     const dueDate = moment(this.dueDate);
 
-    return Math.max(date.diff(dueDate, 'days'), 0);
+    return Math.max(date.diff(dueDate, "days"), 0);
   }
 
   /**
@@ -134,71 +138,71 @@ export default class SaleInvoice extends TenantModel {
        * Filters the due invoices.
        */
       dueInvoices(query) {
-        query.where(raw('BALANCE - PAYMENT_AMOUNT > 0'));
+        query.where(raw("BALANCE - PAYMENT_AMOUNT > 0"));
       },
       /**
        * Filters the invoices between the given date range.
        */
-      filterDateRange(query, startDate, endDate, type = 'day') {
-        const dateFormat = 'YYYY-MM-DD HH:mm:ss';
+      filterDateRange(query, startDate, endDate, type = "day") {
+        const dateFormat = "YYYY-MM-DD HH:mm:ss";
         const fromDate = moment(startDate).startOf(type).format(dateFormat);
         const toDate = moment(endDate).endOf(type).format(dateFormat);
 
         if (startDate) {
-          query.where('invoice_date', '>=', fromDate);
+          query.where("invoice_date", ">=", fromDate);
         }
         if (endDate) {
-          query.where('invoice_date', '<=', toDate);
+          query.where("invoice_date", "<=", toDate);
         }
       },
       /**
        * Filters the invoices in draft status.
        */
       draft(query) {
-        query.where('delivered_at', null);
+        query.where("delivered_at", null);
       },
       /**
        * Filters the delivered invoices.
        */
       delivered(query) {
-        query.whereNot('delivered_at', null);
+        query.whereNot("delivered_at", null);
       },
       /**
        * Filters the unpaid invoices.
        */
       unpaid(query) {
-        query.where(raw('PAYMENT_AMOUNT = 0'));
+        query.where(raw("PAYMENT_AMOUNT = 0"));
       },
       /**
        * Filters the overdue invoices.
        */
-      overdue(query, asDate = moment().format('YYYY-MM-DD')) {
-        query.where('due_date', '<', asDate);
+      overdue(query, asDate = moment().format("YYYY-MM-DD")) {
+        query.where("due_date", "<", asDate);
       },
       /**
        * Filters the not overdue invoices.
        */
-      notOverdue(query, asDate = moment().format('YYYY-MM-DD')) {
-        query.where('due_date', '>=', asDate);
+      notOverdue(query, asDate = moment().format("YYYY-MM-DD")) {
+        query.where("due_date", ">=", asDate);
       },
       /**
        * Filters the partially invoices.
        */
       partiallyPaid(query) {
-        query.whereNot('payment_amount', 0);
-        query.whereNot(raw('`PAYMENT_AMOUNT` = `BALANCE`'));
+        query.whereNot("payment_amount", 0);
+        query.whereNot(raw("`PAYMENT_AMOUNT` = `BALANCE`"));
       },
       /**
        * Filters the paid invoices.
        */
       paid(query) {
-        query.where(raw('PAYMENT_AMOUNT = BALANCE'));
+        query.where(raw("PAYMENT_AMOUNT = BALANCE"));
       },
       /**
        * Filters the sale invoices from the given date.
        */
       fromDate(query, fromDate) {
-        query.where('invoice_date', '<=', fromDate)
+        query.where("invoice_date", "<=", fromDate);
       },
       /**
        * Sort the sale invoices by full-payment invoices.
@@ -210,8 +214,8 @@ export default class SaleInvoice extends TenantModel {
        * Sort the sale invoices by the due amount.
        */
       sortByDueAmount(query, order) {
-        query.orderByRaw(`BALANCE - PAYMENT_AMOUNT ${order}`)
-      }
+        query.orderByRaw(`BALANCE - PAYMENT_AMOUNT ${order}`);
+      },
     };
   }
 
@@ -219,22 +223,22 @@ export default class SaleInvoice extends TenantModel {
    * Relationship mapping.
    */
   static get relationMappings() {
-    const AccountTransaction = require('models/AccountTransaction');
-    const ItemEntry = require('models/ItemEntry');
-    const Contact = require('models/Contact');
-    const InventoryCostLotTracker = require('models/InventoryCostLotTracker');
-    const PaymentReceiveEntry = require('models/PaymentReceiveEntry');
+    const AccountTransaction = require("models/AccountTransaction");
+    const ItemEntry = require("models/ItemEntry");
+    const Contact = require("models/Contact");
+    const InventoryCostLotTracker = require("models/InventoryCostLotTracker");
+    const PaymentReceiveEntry = require("models/PaymentReceiveEntry");
 
     return {
       entries: {
         relation: Model.HasManyRelation,
         modelClass: ItemEntry.default,
         join: {
-          from: 'sales_invoices.id',
-          to: 'items_entries.referenceId',
+          from: "sales_invoices.id",
+          to: "items_entries.referenceId",
         },
         filter(builder) {
-          builder.where('reference_type', 'SaleInvoice');
+          builder.where("reference_type", "SaleInvoice");
         },
       },
 
@@ -242,23 +246,23 @@ export default class SaleInvoice extends TenantModel {
         relation: Model.BelongsToOneRelation,
         modelClass: Contact.default,
         join: {
-          from: 'sales_invoices.customerId',
-          to: 'contacts.id',
+          from: "sales_invoices.customerId",
+          to: "contacts.id",
         },
         filter(query) {
-          query.where('contact_service', 'Customer');
-        }
+          query.where("contact_service", "Customer");
+        },
       },
 
       transactions: {
         relation: Model.HasManyRelation,
         modelClass: AccountTransaction.default,
         join: {
-          from: 'sales_invoices.id',
-          to: 'accounts_transactions.referenceId'
+          from: "sales_invoices.id",
+          to: "accounts_transactions.referenceId",
         },
         filter(builder) {
-          builder.where('reference_type', 'SaleInvoice');
+          builder.where("reference_type", "SaleInvoice");
         },
       },
 
@@ -266,11 +270,11 @@ export default class SaleInvoice extends TenantModel {
         relation: Model.HasManyRelation,
         modelClass: InventoryCostLotTracker.default,
         join: {
-          from: 'sales_invoices.id',
-          to: 'inventory_cost_lot_tracker.transactionId'
+          from: "sales_invoices.id",
+          to: "inventory_cost_lot_tracker.transactionId",
         },
         filter(builder) {
-          builder.where('transaction_type', 'SaleInvoice');
+          builder.where("transaction_type", "SaleInvoice");
         },
       },
 
@@ -278,8 +282,8 @@ export default class SaleInvoice extends TenantModel {
         relation: Model.HasManyRelation,
         modelClass: PaymentReceiveEntry.default,
         join: {
-          from: 'sales_invoices.id',
-          to: 'payment_receives_entries.invoice_id',
+          from: "sales_invoices.id",
+          to: "payment_receives_entries.invoice_id",
         },
       },
     };
@@ -287,15 +291,15 @@ export default class SaleInvoice extends TenantModel {
 
   /**
    * Change payment amount.
-   * @param {Integer} invoiceId 
-   * @param {Numeric} amount 
+   * @param {Integer} invoiceId
+   * @param {Numeric} amount
    */
   static async changePaymentAmount(invoiceId, amount) {
-    const changeMethod = amount > 0 ? 'increment' : 'decrement';
+    const changeMethod = amount > 0 ? "increment" : "decrement";
 
     await this.query()
-      .where('id', invoiceId)
-      [changeMethod]('payment_amount', Math.abs(amount));      
+      .where("id", invoiceId)
+      [changeMethod]("payment_amount", Math.abs(amount));
   }
 
   /**
@@ -304,114 +308,120 @@ export default class SaleInvoice extends TenantModel {
   static get fields() {
     return {
       customer: {
-        label: 'Customer',
-        column: 'customer_id',
-        relation: 'contacts.id',
-        relationColumn: 'contacts.displayName',
+        label: "Customer",
+        column: "customer_id",
+        relation: "contacts.id",
+        relationColumn: "contacts.displayName",
 
-        fieldType: 'options',
-        optionsResource: 'customers',
-        optionsKey: 'id',
-        optionsLable: 'displayName',
+        fieldType: "options",
+        optionsResource: "customers",
+        optionsKey: "id",
+        optionsLable: "displayName",
       },
       invoice_date: {
-        label: 'Invoice date',
-        column: 'invoice_date',
-        columnType: 'date',
-        fieldType: 'date',
+        label: "Invoice date",
+        column: "invoice_date",
+        columnType: "date",
+        fieldType: "date",
       },
       due_date: {
-        label: 'Due date',
-        column: 'due_date',
-        columnType: 'date',
-        fieldType: 'date',
+        label: "Due date",
+        column: "due_date",
+        columnType: "date",
+        fieldType: "date",
       },
       invoice_no: {
-        label: 'Invoice No.',
-        column: 'invoice_no',
-        columnType: 'number',
-        fieldType: 'number',
+        label: "Invoice No.",
+        column: "invoice_no",
+        columnType: "number",
+        fieldType: "number",
       },
-      refernece_no: {
-        label: 'Reference No.',
-        column: 'reference_no',
-        columnType: 'number',
-        fieldType: 'number',
+      reference_no: {
+        label: "Reference No.",
+        column: "reference_no",
+        columnType: "number",
+        fieldType: "number",
       },
       invoice_message: {
-        label: 'Invoice message',
-        column: 'invoice_message',
-        columnType: 'text',
-        fieldType: 'text',
+        label: "Invoice message",
+        column: "invoice_message",
+        columnType: "text",
+        fieldType: "text",
       },
       terms_conditions: {
-        label: 'Terms & conditions',
-        column: 'terms_conditions',
-        columnType: 'text',
-        fieldType: 'text',
+        label: "Terms & conditions",
+        column: "terms_conditions",
+        columnType: "text",
+        fieldType: "text",
       },
       invoice_amount: {
-        label: 'Invoice amount',
-        column: 'invoice_amount',
-        columnType: 'number',
-        fieldType: 'number',
+        label: "Invoice amount",
+        column: "invoice_amount",
+        columnType: "number",
+        fieldType: "number",
       },
       payment_amount: {
-        label: 'Payment amount',
-        column: 'payment_amount',
-        columnType: 'number',
-        fieldType: 'number',
+        label: "Payment amount",
+        column: "payment_amount",
+        columnType: "number",
+        fieldType: "number",
+      },
+      balance: {
+        label: "Balance",
+        column: "balance",
+        columnType: "number",
+        fieldType: "number",
       },
       due_amount: {
-        label: 'Due amount',
-        column: 'due_amount',
-        columnType: 'number',
-        fieldType: 'number',
+        label: "Due amount",
+        column: "due_amount",
+        columnType: "number",
+        fieldType: "number",
         sortQuery(query, role) {
-          query.modify('sortByDueAmount', role.order);
-        }
+          query.modify("sortByDueAmount", role.order);
+        },
       },
       created_at: {
-        label: 'Created at',
-        column: 'created_at',
-        columnType: 'date',
+        label: "Created at",
+        column: "created_at",
+        columnType: "date",
       },
       status: {
-        label: 'Status',
+        label: "Status",
         options: [
-          { key: 'draft', label: 'Draft', },
-          { key: 'delivered', label: 'Delivered' },
-          { key: 'unpaid', label: 'Unpaid' },
-          { key: 'overdue', label: 'Overdue' },
-          { key: 'partially-paid', label: 'Partially paid' },
-          { key: 'paid', label: 'Paid' },
+          { key: "draft", label: "Draft" },
+          { key: "delivered", label: "Delivered" },
+          { key: "unpaid", label: "Unpaid" },
+          { key: "overdue", label: "Overdue" },
+          { key: "partially-paid", label: "Partially paid" },
+          { key: "paid", label: "Paid" },
         ],
         query: (query, role) => {
-          switch(role.value) {
-            case 'draft':
-              query.modify('draft');
+          switch (role.value) {
+            case "draft":
+              query.modify("draft");
               break;
-            case 'delivered':
-              query.modify('delivered');
+            case "delivered":
+              query.modify("delivered");
               break;
-            case 'unpaid':
-              query.modify('unpaid');
+            case "unpaid":
+              query.modify("unpaid");
               break;
-            case 'overdue':
-              query.modify('overdue');
+            case "overdue":
+              query.modify("overdue");
               break;
-            case 'partially-paid':
-              query.modify('partiallyPaid');
+            case "partially-paid":
+              query.modify("partiallyPaid");
               break;
-            case 'paid':
-              query.modify('paid');
+            case "paid":
+              query.modify("paid");
               break;
           }
         },
         sortQuery(query, role) {
-          query.modify('sortByStatus', role.order);
-        }
-      }
+          query.modify("sortByStatus", role.order);
+        },
+      },
     };
   }
 }