@tamu-dor/famis-db 3.0.0-beta.3 → 3.0.0

package/dist/.vite/manifest.json

@@ -1,6 +1,7 @@
 {
   "src/index.ts": {
     "file": "main.cjs",
+    "name": "index",
     "src": "src/index.ts",
     "isEntry": true
   }

package/dist/index.d.mts

@@ -51,19 +51,19 @@ export declare interface AccountPayload {
 }
 
 export declare interface Contact {
-    fax: string | null;
-    city: string | null;
-    name: string;
-    email: string | null;
-    phone: string | null;
-    state: string | null;
-    country: string | null;
-    address1: string | null;
-    address2: string | null;
-    mailstop: string | null;
-    department: string | null;
-    postalCode: string | null;
-    institution: string | null;
+    fax?: string | null;
+    city?: string | null;
+    name?: string;
+    email?: string | null;
+    phone?: string | null;
+    state?: string | null;
+    country?: string | null;
+    address1?: string | null;
+    address2?: string | null;
+    mailstop?: string | null;
+    department?: string | null;
+    postalCode?: string | null;
+    institution?: string | null;
 }
 
 export declare interface Core {
@@ -281,7 +281,7 @@ export declare interface Edge {
 declare class FAMISDb {
     private db;
     private people;
-    constructor(config: any, people: any);
+    constructor(config: any, people: any, debug: boolean);
     /**
      * Initializes the database connection and sets up the Knex instance for interacting with PostgreSQL database.
      *
@@ -479,11 +479,11 @@ declare class FAMISDb {
      *
      * Updates an invoice
      * @param {string} uid
-     * @param {object} invoice
-     * @returns {Promise<object>} invoice object
+     * @param {Invoice} invoice
+     * @returns {Promise<Invoice>} invoice object
      * @memberof FAMISDb
      */
-    updateInvoice(uid: string, invoice: any): Promise<any>;
+    updateInvoice(uid: string, invoice: Invoice): Promise<InvoicePayload>;
     /**
      *
      * Toggles an invoice as paid
@@ -646,10 +646,11 @@ declare class FAMISDb {
      * @param {string} [sortDirection='asc']
      * @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<CorePayload>} core objects
      * @memberof FAMISDb
      */
-    queryCores(query: string, sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number): Promise<CorePayload>;
+    queryCores(query: string, sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number, excludeFields?: string[]): Promise<CorePayload>;
     /**
      *
      * Get core by specified attribute and search term
@@ -770,10 +771,9 @@ declare class FAMISDb {
     /**
      * This function adds a new CoreUser to the database. If the user already exists, it updates the existing record.
      * @param {CoreUser} coreUser - The CoreUser object containing details about the user.
-     * @param {User} [user] - An optional User object that could contain additional details.
      * @return {Promise<CoreUser>} A Promise that resolves to the newly added or updated CoreUser, if successfully added and returned from the database; otherwise it rejects with an error.
      */
-    addCoreUser(coreUser: CoreUser, user?: User): Promise<CoreUser>;
+    addCoreUser(coreUser: CoreUser): Promise<CoreUser>;
     /**
      *
      * Delete core user
@@ -1033,11 +1033,11 @@ declare class FAMISDb {
     }
 
     export declare interface Invoice {
-        uid: string;
-        number: string;
-        lab: string;
-        totalAmount: string;
-        date: string;
+        uid?: string | null;
+        number?: string | null;
+        lab?: string | null;
+        totalAmount?: string;
+        date?: string;
         data: TransactionData;
         invoiced: boolean;
         type: string;
@@ -1048,14 +1048,14 @@ declare class FAMISDb {
         postedDate: string | null;
         emailed: boolean;
         replace_data?: object | null;
-        fingerprint: string;
-        core: Core;
-        customerAccountInfo: CustomerAccountInfo;
-        isIdt: boolean;
-        poNumber: string | null;
-        pi: PI;
-        highRiskInfo: HighRiskInfo;
-        comments: InvoiceComment[];
+        fingerprint?: string | null;
+        core?: Core | null;
+        customerAccountInfo?: CustomerAccountInfo | null;
+        isIdt?: boolean | null;
+        poNumber?: string | null;
+        pi?: PI | null;
+        highRiskInfo?: HighRiskInfo | null;
+        comments?: InvoiceComment[] | null;
     }
 
     export declare interface InvoiceComment {
@@ -1131,7 +1131,7 @@ declare class FAMISDb {
         tamuManualAddRDN: string | null;
     }
 
-    export declare type SortDirection = 'asc' | 'desc';
+    export declare type SortDirection = "asc" | "desc";
 
     export declare interface SystemPart {
         id: number;

package/dist/index.d.ts

@@ -51,19 +51,19 @@ export declare interface AccountPayload {
 }
 
 export declare interface Contact {
-    fax: string | null;
-    city: string | null;
-    name: string;
-    email: string | null;
-    phone: string | null;
-    state: string | null;
-    country: string | null;
-    address1: string | null;
-    address2: string | null;
-    mailstop: string | null;
-    department: string | null;
-    postalCode: string | null;
-    institution: string | null;
+    fax?: string | null;
+    city?: string | null;
+    name?: string;
+    email?: string | null;
+    phone?: string | null;
+    state?: string | null;
+    country?: string | null;
+    address1?: string | null;
+    address2?: string | null;
+    mailstop?: string | null;
+    department?: string | null;
+    postalCode?: string | null;
+    institution?: string | null;
 }
 
 export declare interface Core {
@@ -281,7 +281,7 @@ export declare interface Edge {
 declare class FAMISDb {
     private db;
     private people;
-    constructor(config: any, people: any);
+    constructor(config: any, people: any, debug: boolean);
     /**
      * Initializes the database connection and sets up the Knex instance for interacting with PostgreSQL database.
      *
@@ -479,11 +479,11 @@ declare class FAMISDb {
      *
      * Updates an invoice
      * @param {string} uid
-     * @param {object} invoice
-     * @returns {Promise<object>} invoice object
+     * @param {Invoice} invoice
+     * @returns {Promise<Invoice>} invoice object
      * @memberof FAMISDb
      */
-    updateInvoice(uid: string, invoice: any): Promise<any>;
+    updateInvoice(uid: string, invoice: Invoice): Promise<InvoicePayload>;
     /**
      *
      * Toggles an invoice as paid
@@ -646,10 +646,11 @@ declare class FAMISDb {
      * @param {string} [sortDirection='asc']
      * @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<CorePayload>} core objects
      * @memberof FAMISDb
      */
-    queryCores(query: string, sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number): Promise<CorePayload>;
+    queryCores(query: string, sortColumn?: string, sortDirection?: SortDirection | string, page?: number, perPage?: number, excludeFields?: string[]): Promise<CorePayload>;
     /**
      *
      * Get core by specified attribute and search term
@@ -770,10 +771,9 @@ declare class FAMISDb {
     /**
      * This function adds a new CoreUser to the database. If the user already exists, it updates the existing record.
      * @param {CoreUser} coreUser - The CoreUser object containing details about the user.
-     * @param {User} [user] - An optional User object that could contain additional details.
      * @return {Promise<CoreUser>} A Promise that resolves to the newly added or updated CoreUser, if successfully added and returned from the database; otherwise it rejects with an error.
      */
-    addCoreUser(coreUser: CoreUser, user?: User): Promise<CoreUser>;
+    addCoreUser(coreUser: CoreUser): Promise<CoreUser>;
     /**
      *
      * Delete core user
@@ -1033,11 +1033,11 @@ declare class FAMISDb {
     }
 
     export declare interface Invoice {
-        uid: string;
-        number: string;
-        lab: string;
-        totalAmount: string;
-        date: string;
+        uid?: string | null;
+        number?: string | null;
+        lab?: string | null;
+        totalAmount?: string;
+        date?: string;
         data: TransactionData;
         invoiced: boolean;
         type: string;
@@ -1048,14 +1048,14 @@ declare class FAMISDb {
         postedDate: string | null;
         emailed: boolean;
         replace_data?: object | null;
-        fingerprint: string;
-        core: Core;
-        customerAccountInfo: CustomerAccountInfo;
-        isIdt: boolean;
-        poNumber: string | null;
-        pi: PI;
-        highRiskInfo: HighRiskInfo;
-        comments: InvoiceComment[];
+        fingerprint?: string | null;
+        core?: Core | null;
+        customerAccountInfo?: CustomerAccountInfo | null;
+        isIdt?: boolean | null;
+        poNumber?: string | null;
+        pi?: PI | null;
+        highRiskInfo?: HighRiskInfo | null;
+        comments?: InvoiceComment[] | null;
     }
 
     export declare interface InvoiceComment {
@@ -1131,7 +1131,7 @@ declare class FAMISDb {
         tamuManualAddRDN: string | null;
     }
 
-    export declare type SortDirection = 'asc' | 'desc';
+    export declare type SortDirection = "asc" | "desc";
 
     export declare interface SystemPart {
         id: number;