@tamu-dor/famis-db 3.0.3 → 3.0.5

package/dist/index.d.mts

@@ -313,10 +313,11 @@ declare class FAMISDb {
      * Process an invoice to have all necessary relationships
      * @param {object} invoice - the invoice object sent by iLab
      * @param {boolean} [historical=false] - if true use historical accounts too
+     * @param {string[]} excludeFields - fields to exclude from results
      * @returns {Promise<object>} invoice object
      * @memberof FAMISDb
      */
-    processInvoice(invoice: any, historical?: boolean): Promise<any>;
+    processInvoice(invoice: any, historical?: boolean, excludeFields?: string[]): Promise<any>;
     /**
      *
      * Get invoice by uid
@@ -461,10 +462,11 @@ declare class FAMISDb {
      * @param {string} [sortDirection='desc']
      * @param {integer} page - page of results to return
      * @param {integer} perPage - number of results per page to return
+     * @param {string[]} excludeFields - fields to exclude from results
      * @returns {Promise<InvoicePayload>} invoice objects
      * @memberof FAMISDb
      */
-    queryInvoices(query: string, sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number): Promise<InvoicePayload>;
+    queryInvoices(query: string, sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number, excludeFields?: string[]): Promise<InvoicePayload>;
     /**
      *
      * Adds an invoice
@@ -657,10 +659,11 @@ declare class FAMISDb {
      * @param {string} type
      * @param {string} operator
      * @param {string} search
+     * @param {string[]} excludeFields - fields to exclude from results
      * @returns {Promise<Core>} core object
      * @memberof FAMISDb
      */
-    getCore(type: string, operator: string | undefined, search: string): Promise<Core>;
+    getCore(type: string, operator: string | undefined, search: string, excludeFields?: string[]): Promise<Core>;
     /**
      *
      * Get core by id
@@ -674,9 +677,10 @@ declare class FAMISDb {
      * Get core by account number
      * @param {string} account
      * @returns {Promise<Core>} core object
+     * @param {string[]} excludeFields - fields to exclude from results
      * @memberof FAMISDb
      */
-    getCoreByAccount(account: string): Promise<Core>;
+    getCoreByAccount(account: string, excludeFields?: string[]): Promise<Core>;
     /**
      *
      * Update core
@@ -721,10 +725,11 @@ declare class FAMISDb {
      *
      * Get system part by ID
      * @param {number} id
+     * @param {string[]} excludeFields - fields to exclude from results
      * @returns {Promise<SystemPart>} system part object
      * @memberof FAMISDb
      */
-    getSystemById(id: number): Promise<SystemPart>;
+    getSystemById(id: number, excludeFields?: string[]): Promise<SystemPart>;
     /**
      *
      * Get system part by two-digit part number

package/dist/index.d.ts

@@ -313,10 +313,11 @@ declare class FAMISDb {
      * Process an invoice to have all necessary relationships
      * @param {object} invoice - the invoice object sent by iLab
      * @param {boolean} [historical=false] - if true use historical accounts too
+     * @param {string[]} excludeFields - fields to exclude from results
      * @returns {Promise<object>} invoice object
      * @memberof FAMISDb
      */
-    processInvoice(invoice: any, historical?: boolean): Promise<any>;
+    processInvoice(invoice: any, historical?: boolean, excludeFields?: string[]): Promise<any>;
     /**
      *
      * Get invoice by uid
@@ -461,10 +462,11 @@ declare class FAMISDb {
      * @param {string} [sortDirection='desc']
      * @param {integer} page - page of results to return
      * @param {integer} perPage - number of results per page to return
+     * @param {string[]} excludeFields - fields to exclude from results
      * @returns {Promise<InvoicePayload>} invoice objects
      * @memberof FAMISDb
      */
-    queryInvoices(query: string, sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number): Promise<InvoicePayload>;
+    queryInvoices(query: string, sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number, excludeFields?: string[]): Promise<InvoicePayload>;
     /**
      *
      * Adds an invoice
@@ -657,10 +659,11 @@ declare class FAMISDb {
      * @param {string} type
      * @param {string} operator
      * @param {string} search
+     * @param {string[]} excludeFields - fields to exclude from results
      * @returns {Promise<Core>} core object
      * @memberof FAMISDb
      */
-    getCore(type: string, operator: string | undefined, search: string): Promise<Core>;
+    getCore(type: string, operator: string | undefined, search: string, excludeFields?: string[]): Promise<Core>;
     /**
      *
      * Get core by id
@@ -674,9 +677,10 @@ declare class FAMISDb {
      * Get core by account number
      * @param {string} account
      * @returns {Promise<Core>} core object
+     * @param {string[]} excludeFields - fields to exclude from results
      * @memberof FAMISDb
      */
-    getCoreByAccount(account: string): Promise<Core>;
+    getCoreByAccount(account: string, excludeFields?: string[]): Promise<Core>;
     /**
      *
      * Update core
@@ -721,10 +725,11 @@ declare class FAMISDb {
      *
      * Get system part by ID
      * @param {number} id
+     * @param {string[]} excludeFields - fields to exclude from results
      * @returns {Promise<SystemPart>} system part object
      * @memberof FAMISDb
      */
-    getSystemById(id: number): Promise<SystemPart>;
+    getSystemById(id: number, excludeFields?: string[]): Promise<SystemPart>;
     /**
      *
      * Get system part by two-digit part number

package/dist/main.cjs

@@ -252,16 +252,18 @@ class FAMISDb {
    * Process an invoice to have all necessary relationships
    * @param {object} invoice - the invoice object sent by iLab
    * @param {boolean} [historical=false] - if true use historical accounts too
+   * @param {string[]} excludeFields - fields to exclude from results
    * @returns {Promise<object>} invoice object
    * @memberof FAMISDb
    */
-  async processInvoice(invoice, historical = false) {
+  async processInvoice(invoice, historical = false, excludeFields = []) {
     try {
       const account = getCoreAccountNumber(invoice.data.details[0].famis);
-      invoice.core = await this.getCoreByAccount(account);
+      invoice.core = await this.getCoreByAccount(account, excludeFields);
       if (invoice.core) {
         invoice.core.systemPart = await this.getSystemById(
-          invoice.core.systemId
+          invoice.core.systemId,
+          excludeFields
         );
       } else {
         const e = Error(
@@ -632,10 +634,11 @@ class FAMISDb {
    * @param {string} [sortDirection='desc']
    * @param {integer} page - page of results to return
    * @param {integer} perPage - number of results per page to return
+   * @param {string[]} excludeFields - fields to exclude from results
    * @returns {Promise<InvoicePayload>} invoice objects
    * @memberof FAMISDb
    */
-  async queryInvoices(query, sortColumn = "date", sortDirection = "desc", page = 1, perPage = 50) {
+  async queryInvoices(query, sortColumn = "date", sortDirection = "desc", page = 1, perPage = 50, excludeFields = []) {
     const self = this;
     let rows;
     const invFields = invoiceFields.map((f) => `invoices.${f}`);
@@ -662,6 +665,14 @@ class FAMISDb {
       ...revenueAccountDeptFields,
       ...expenseAccountBalFields
     ];
+    if (excludeFields.length) {
+      excludeFields.forEach((f) => {
+        const idx = fields.findIndex((field) => field.includes(f));
+        if (idx > -1) {
+          fields.splice(idx, 1);
+        }
+      });
+    }
     try {
       rows = await this.db.from("invoices").leftJoin(
         "accounts as expenseAccount",
@@ -713,7 +724,7 @@ class FAMISDb {
       ).where(this.db.raw(query)).whereNull("revenueAccountDepartment.sub").orderBy(sortColumn, sortDirection).select(fields).paginate({ perPage, currentPage: page, isLengthAware: true });
       rows.data = await Promise.all(
         rows.data.map(async (row) => {
-          const rec = await self.processInvoice(row);
+          const rec = await self.processInvoice(row, false, excludeFields);
           return rec;
         })
       );
@@ -1485,10 +1496,11 @@ class FAMISDb {
    * @param {string} type
    * @param {string} operator
    * @param {string} search
+   * @param {string[]} excludeFields - fields to exclude from results
    * @returns {Promise<Core>} core object
    * @memberof FAMISDb
    */
-  async getCore(type, operator = "=", search) {
+  async getCore(type, operator = "=", search, excludeFields = []) {
     let records;
     let retVal;
     try {
@@ -1505,6 +1517,14 @@ class FAMISDb {
         ...expenseAccountBalFields,
         */
       ];
+      if (excludeFields.length) {
+        excludeFields.forEach((f) => {
+          const idx = fields.findIndex((field) => field.includes(f));
+          if (idx > -1) {
+            fields.splice(idx, 1);
+          }
+        });
+      }
       records = await this.db.with("coreaccounts", (qb) => {
         qb.select(
           "accounts.*",
@@ -1608,15 +1628,17 @@ class FAMISDb {
    * Get core by account number
    * @param {string} account
    * @returns {Promise<Core>} core object
+   * @param {string[]} excludeFields - fields to exclude from results
    * @memberof FAMISDb
    */
-  async getCoreByAccount(account) {
+  async getCoreByAccount(account, excludeFields) {
     let retVal;
     try {
       retVal = await this.getCore(
         "core_accounts.accounts",
         "@>",
-        `[{"account_number": "${account}"}]`
+        `[{"account_number": "${account}"}]`,
+        excludeFields
       );
     } catch (e) {
       throw e;
@@ -1749,14 +1771,24 @@ class FAMISDb {
    *
    * Get system part by ID
    * @param {number} id
+   * @param {string[]} excludeFields - fields to exclude from results
    * @returns {Promise<SystemPart>} system part object
    * @memberof FAMISDb
    */
-  async getSystemById(id) {
+  async getSystemById(id, excludeFields = []) {
     let records;
     let retVal;
+    const fields = systemPartFields.map((f) => `system.${f}`);
+    if (excludeFields.length) {
+      excludeFields.forEach((f) => {
+        const idx = fields.findIndex((field) => field.includes(f));
+        if (idx > -1) {
+          fields.splice(idx, 1);
+        }
+      });
+    }
     try {
-      records = await this.db("system").where("id", id).orderBy("id", "desc");
+      records = await this.db("system").select(fields).where("id", id).orderBy("id", "desc");
       if (records.length) {
         retVal = records[0];
       }