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

package/dist/{manifest.json → .vite/manifest.json}

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

package/dist/index.d.mts

@@ -67,21 +67,21 @@ export declare interface Contact {
 }
 
 export declare interface Core {
-    id: number;
-    account: string;
-    effective: string;
-    facility: string;
+    id?: number;
+    account?: string;
+    effective?: string;
+    facility?: string;
     contact: string;
     contactEmail: string;
     systemId: number;
     enabled: boolean;
     deleted: string | null;
-    coreEmail: string;
+    coreEmail?: string | null;
     corePhone: string | null;
     coreAddress: string | null;
     from_email: string | null;
     invoice_email: string | null;
-    systemPart: SystemPart;
+    systemPart?: SystemPart;
     system_part?: string;
     system_name?: string;
     system_abbrev?: string;
@@ -90,17 +90,19 @@ export declare interface Core {
 }
 
 export declare interface CoreAccount {
-    id: number;
-    account: string;
+    id?: number;
+    account?: string;
     coreId: number;
-    effective: Date;
-    active: boolean | null;
+    coreAccountId?: number;
+    coreAccountActive?: boolean | null;
+    effective?: Date | null;
+    active?: boolean | null;
 }
 
 export declare interface CoreAccountEmail {
-    uid: string;
-    core_id: number;
-    account_number: string;
+    uid?: string;
+    core_id?: number;
+    account_number?: string;
     email: string;
     created?: Date | null;
     deleted?: Date | null;
@@ -113,8 +115,9 @@ export declare interface CorePayload {
 
 export declare interface CoreUser {
     id?: number;
-    userId: string;
+    userId?: string;
     coreId: number;
+    coreUserId?: number;
     email?: boolean | null;
 }
 
@@ -279,7 +282,14 @@ declare class FAMISDb {
     private db;
     private people;
     constructor(config: any, people: any);
-    init(config: any, people: any): void;
+    /**
+     * Initializes the database connection and sets up the Knex instance for interacting with PostgreSQL database.
+     *
+     * @param {any} config - The configuration object that includes details about how to connect to a PostgreSQL database. This should include properties such as `host`, `user`, `password`, etc.
+     * @param {any} people - The data related to the 'people' entity. It could be an array of person objects or any other format depending on your application requirements.
+     * @param {boolean} debug - A flag indicating whether to enable debugging for Knex queries. Defaults to `false`. If set to `true`, it will log all SQL queries that are executed against the database in the console.
+     */
+    init(config: any, people?: any, debug?: boolean): void;
     /**
      *
      * Extract customer account and po number
@@ -673,7 +683,7 @@ declare class FAMISDb {
      * @returns {Promise<Core>} core object
      * @memberof FAMISDb
      */
-    updateCore(core: Core): Promise<Core>;
+    updateCore(core: Core): Promise<Core | undefined>;
     /**
      *
      * Add core
@@ -698,6 +708,14 @@ declare class FAMISDb {
      * @memberof FAMISDb
      */
     addCoreAccount(account: CoreAccount): Promise<CoreAccount>;
+    /**
+     *
+     * Delete core account
+     * @param {coreAccountId} string core account id
+     * @returns {Promise<CoreAccount>} core account object
+     * @memberof FAMISDb
+     */
+    deleteCoreAccount(coreAccountId: string): Promise<CoreAccount>;
     /**
      *
      * Get system part by ID
@@ -749,15 +767,21 @@ declare class FAMISDb {
      * @memberof FAMISDb
      */
     updateCoreUser(user: CoreUser): Promise<CoreUser>;
+    /**
+     * 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>;
     /**
      *
-     * Add core user
-     * @param {CoreUser} coreUser core user object
-     * @param {User} user user object
+     * Delete core user
+     * @param {coreUserId} string core user object
      * @returns {Promise<CoreUser>} core user object
      * @memberof FAMISDb
      */
-    addCoreUser(coreUser: CoreUser, user?: User): Promise<CoreUser>;
+    deleteCoreUser(coreUserId: string): Promise<CoreUser>;
     /**
      *
      * Get a user's cores they manage
@@ -901,6 +925,13 @@ declare class FAMISDb {
       * @property {date} created - created date
       * @property {date} deleted - deleted date
       */
+     /**
+      * Create an invoice comment file.
+      * @param {InvoiceCommentFile} file - JSON object representing the comment file
+      * @returns {Promise<InvoiceCommentFile>} - Promise that resolves to the comment file object
+      * @memberof FAMISDb
+      */
+     saveCommentFile(file: InvoiceCommentFile): Promise<InvoiceCommentFile | null>;
      /**
       * Get invoice comment files.
       * @param {string} commentUid - Comment UID
@@ -948,21 +979,28 @@ declare class FAMISDb {
       */
      getCoreAccountAdditionalEmailsByAccount(accountNumber: string): Promise<CoreAccountEmail[] | []>;
      /**
-      * Add an additional delivery email to an expense account for a core
-      * @param {string} accountNumber - 13 digit famis account or customernumber
+      * Get additional delivery emails to expense accounts for a core by core id
+      * and account number
       * @param {number} coreId - Core ID
-      * @param {string} email - email address
+      * @param {string} account - account number
+      * @returns {Promise<CoreAccountEmail[]|[]>} - Promise that resolves to an account object
+      * @memberof FAMISDb
+      */
+     getCoreAccountAdditionalEmailsByCoreIdAccount(coreId: number, account: string): Promise<CoreAccountEmail[] | []>;
+     /**
+      * Add an additional delivery email to an expense account for a core
+      * @param {CoreAccountEmail} record - core account email delivery record
       * @returns {Promise<CoreAccountEmail>} - Promise that resolves to an account object
       * @memberof FAMISDb
       */
-     addCoreAccountAdditionalEmails(accountNumber: string, coreId: number, email: string): Promise<CoreAccountEmail | null>;
+     addCoreAccountAdditionalEmail(record: CoreAccountEmail): Promise<CoreAccountEmail | null>;
      /**
       * Remove an additional delivery email to an expense account for a core
       * @param {string} uid - uid for core account email record
       * @returns {Promise<CoreAccountEmail>} - Promise that resolves to an account object
       * @memberof FAMISDb
       */
-     removeCoreAccountAdditionalEmails(uid: string): Promise<CoreAccountEmail | null>;
+     removeCoreAccountAdditionalEmail(uid: string): Promise<CoreAccountEmail | null>;
     }
     export default FAMISDb;
 
@@ -1022,9 +1060,9 @@ declare class FAMISDb {
 
     export declare interface InvoiceComment {
         id?: number;
-        uid: string;
+        uid?: string;
         invoice_id: string;
-        user_id: string;
+        user_id?: string | null;
         comment: string | null;
         type: string | null;
         created: string | null;
@@ -1032,7 +1070,7 @@ declare class FAMISDb {
     }
 
     export declare type InvoiceCommentFile = {
-        id: number;
+        id?: number;
         uid: string;
         invoice_id: string;
         comment_id: string;
@@ -1102,9 +1140,9 @@ declare class FAMISDb {
         fein: string;
         agency: string;
         checkAddress: string;
-        credit: boolean;
-        creditUrl: string;
-        creditFee: string;
+        credit?: boolean | null;
+        creditUrl?: string | null;
+        creditFee?: string | null;
         part: string;
         abbrev: string;
         aggiebuy: string;
@@ -1133,6 +1171,7 @@ declare class FAMISDb {
         usersSystemId?: number | null;
         systemId?: number | null;
         coreId?: number | null;
+        coreUserId?: number | null;
         cores?: CorePayload | null;
         systems?: SystemPart[] | [] | null;
         deleted?: Date | null;

package/dist/index.d.ts

@@ -67,21 +67,21 @@ export declare interface Contact {
 }
 
 export declare interface Core {
-    id: number;
-    account: string;
-    effective: string;
-    facility: string;
+    id?: number;
+    account?: string;
+    effective?: string;
+    facility?: string;
     contact: string;
     contactEmail: string;
     systemId: number;
     enabled: boolean;
     deleted: string | null;
-    coreEmail: string;
+    coreEmail?: string | null;
     corePhone: string | null;
     coreAddress: string | null;
     from_email: string | null;
     invoice_email: string | null;
-    systemPart: SystemPart;
+    systemPart?: SystemPart;
     system_part?: string;
     system_name?: string;
     system_abbrev?: string;
@@ -90,17 +90,19 @@ export declare interface Core {
 }
 
 export declare interface CoreAccount {
-    id: number;
-    account: string;
+    id?: number;
+    account?: string;
     coreId: number;
-    effective: Date;
-    active: boolean | null;
+    coreAccountId?: number;
+    coreAccountActive?: boolean | null;
+    effective?: Date | null;
+    active?: boolean | null;
 }
 
 export declare interface CoreAccountEmail {
-    uid: string;
-    core_id: number;
-    account_number: string;
+    uid?: string;
+    core_id?: number;
+    account_number?: string;
     email: string;
     created?: Date | null;
     deleted?: Date | null;
@@ -113,8 +115,9 @@ export declare interface CorePayload {
 
 export declare interface CoreUser {
     id?: number;
-    userId: string;
+    userId?: string;
     coreId: number;
+    coreUserId?: number;
     email?: boolean | null;
 }
 
@@ -279,7 +282,14 @@ declare class FAMISDb {
     private db;
     private people;
     constructor(config: any, people: any);
-    init(config: any, people: any): void;
+    /**
+     * Initializes the database connection and sets up the Knex instance for interacting with PostgreSQL database.
+     *
+     * @param {any} config - The configuration object that includes details about how to connect to a PostgreSQL database. This should include properties such as `host`, `user`, `password`, etc.
+     * @param {any} people - The data related to the 'people' entity. It could be an array of person objects or any other format depending on your application requirements.
+     * @param {boolean} debug - A flag indicating whether to enable debugging for Knex queries. Defaults to `false`. If set to `true`, it will log all SQL queries that are executed against the database in the console.
+     */
+    init(config: any, people?: any, debug?: boolean): void;
     /**
      *
      * Extract customer account and po number
@@ -673,7 +683,7 @@ declare class FAMISDb {
      * @returns {Promise<Core>} core object
      * @memberof FAMISDb
      */
-    updateCore(core: Core): Promise<Core>;
+    updateCore(core: Core): Promise<Core | undefined>;
     /**
      *
      * Add core
@@ -698,6 +708,14 @@ declare class FAMISDb {
      * @memberof FAMISDb
      */
     addCoreAccount(account: CoreAccount): Promise<CoreAccount>;
+    /**
+     *
+     * Delete core account
+     * @param {coreAccountId} string core account id
+     * @returns {Promise<CoreAccount>} core account object
+     * @memberof FAMISDb
+     */
+    deleteCoreAccount(coreAccountId: string): Promise<CoreAccount>;
     /**
      *
      * Get system part by ID
@@ -749,15 +767,21 @@ declare class FAMISDb {
      * @memberof FAMISDb
      */
     updateCoreUser(user: CoreUser): Promise<CoreUser>;
+    /**
+     * 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>;
     /**
      *
-     * Add core user
-     * @param {CoreUser} coreUser core user object
-     * @param {User} user user object
+     * Delete core user
+     * @param {coreUserId} string core user object
      * @returns {Promise<CoreUser>} core user object
      * @memberof FAMISDb
      */
-    addCoreUser(coreUser: CoreUser, user?: User): Promise<CoreUser>;
+    deleteCoreUser(coreUserId: string): Promise<CoreUser>;
     /**
      *
      * Get a user's cores they manage
@@ -901,6 +925,13 @@ declare class FAMISDb {
       * @property {date} created - created date
       * @property {date} deleted - deleted date
       */
+     /**
+      * Create an invoice comment file.
+      * @param {InvoiceCommentFile} file - JSON object representing the comment file
+      * @returns {Promise<InvoiceCommentFile>} - Promise that resolves to the comment file object
+      * @memberof FAMISDb
+      */
+     saveCommentFile(file: InvoiceCommentFile): Promise<InvoiceCommentFile | null>;
      /**
       * Get invoice comment files.
       * @param {string} commentUid - Comment UID
@@ -948,21 +979,28 @@ declare class FAMISDb {
       */
      getCoreAccountAdditionalEmailsByAccount(accountNumber: string): Promise<CoreAccountEmail[] | []>;
      /**
-      * Add an additional delivery email to an expense account for a core
-      * @param {string} accountNumber - 13 digit famis account or customernumber
+      * Get additional delivery emails to expense accounts for a core by core id
+      * and account number
       * @param {number} coreId - Core ID
-      * @param {string} email - email address
+      * @param {string} account - account number
+      * @returns {Promise<CoreAccountEmail[]|[]>} - Promise that resolves to an account object
+      * @memberof FAMISDb
+      */
+     getCoreAccountAdditionalEmailsByCoreIdAccount(coreId: number, account: string): Promise<CoreAccountEmail[] | []>;
+     /**
+      * Add an additional delivery email to an expense account for a core
+      * @param {CoreAccountEmail} record - core account email delivery record
       * @returns {Promise<CoreAccountEmail>} - Promise that resolves to an account object
       * @memberof FAMISDb
       */
-     addCoreAccountAdditionalEmails(accountNumber: string, coreId: number, email: string): Promise<CoreAccountEmail | null>;
+     addCoreAccountAdditionalEmail(record: CoreAccountEmail): Promise<CoreAccountEmail | null>;
      /**
       * Remove an additional delivery email to an expense account for a core
       * @param {string} uid - uid for core account email record
       * @returns {Promise<CoreAccountEmail>} - Promise that resolves to an account object
       * @memberof FAMISDb
       */
-     removeCoreAccountAdditionalEmails(uid: string): Promise<CoreAccountEmail | null>;
+     removeCoreAccountAdditionalEmail(uid: string): Promise<CoreAccountEmail | null>;
     }
     export default FAMISDb;
 
@@ -1022,9 +1060,9 @@ declare class FAMISDb {
 
     export declare interface InvoiceComment {
         id?: number;
-        uid: string;
+        uid?: string;
         invoice_id: string;
-        user_id: string;
+        user_id?: string | null;
         comment: string | null;
         type: string | null;
         created: string | null;
@@ -1032,7 +1070,7 @@ declare class FAMISDb {
     }
 
     export declare type InvoiceCommentFile = {
-        id: number;
+        id?: number;
         uid: string;
         invoice_id: string;
         comment_id: string;
@@ -1102,9 +1140,9 @@ declare class FAMISDb {
         fein: string;
         agency: string;
         checkAddress: string;
-        credit: boolean;
-        creditUrl: string;
-        creditFee: string;
+        credit?: boolean | null;
+        creditUrl?: string | null;
+        creditFee?: string | null;
         part: string;
         abbrev: string;
         aggiebuy: string;
@@ -1133,6 +1171,7 @@ declare class FAMISDb {
         usersSystemId?: number | null;
         systemId?: number | null;
         coreId?: number | null;
+        coreUserId?: number | null;
         cores?: CorePayload | null;
         systems?: SystemPart[] | [] | null;
         deleted?: Date | null;