@tamu-dor/famis-db 3.0.0-beta.4 → 3.0.2

package/dist/index.d.mts

@@ -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
@@ -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

@@ -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
@@ -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;