adding getEmployees()

Author: dangowans

eslint.config.js

@@ -17,9 +17,18 @@ export const config = defineConfig(configCityssm, {
                         // Column name abbreviations
                         'accomp',
                         'actv',
+                        'bankot',
+                        'birthd',
+                        'datein',
                         'defaul',
+                        'defveh',
                         'enddatetime',
                         'extcode',
+                        'hrsperpp',
+                        'itemclass',
+                        'itmsysid',
+                        'payot',
+                        'phonedesc',
                         'sched',
                         'scheddatetime',
                         'srisysid',

eslint.config.ts

@@ -22,9 +22,18 @@ export const config = defineConfig(configCityssm, {
             // Column name abbreviations
             'accomp',
             'actv',
+            'bankot',
+            'birthd',
+            'datein',
             'defaul',
+            'defveh',
             'enddatetime',
             'extcode',
+            'hrsperpp',
+            'itemclass',
+            'itmsysid',
+            'payot',
+            'phonedesc',
             'sched',
             'scheddatetime',
             'srisysid',

index.d.ts

@@ -1,8 +1,9 @@
 import type { mssql } from '@cityssm/mssql-multi-pool';
 import type { DateString } from '@cityssm/utils-datetime';
 import { type AccountNumberSource } from './helpers/getAccountNumber.js';
+import { type GetEmployeesFilters } from './queries/employees/getEmployees.js';
 import { type GetTimesheetBatchEntriesFilters } from './queries/employees/getTimesheetBatchEntries.js';
-import type { EmployeePayCode, TimeCode, TimesheetBatchEntry } from './queries/employees/types.js';
+import type { Employee, EmployeePayCode, TimeCode, TimesheetBatchEntry } from './queries/employees/types.js';
 import { type AddEquipment } from './queries/equipment/addEquipment.js';
 import type { EquipmentItem } from './queries/equipment/types.js';
 import { type AddResourceItem } from './queries/items/addResourceItem.js';
@@ -159,6 +160,18 @@ export declare class WorkTechAPI {
      * @returns - The account number and its source, if available.
      */
     getAccountNumberByWorkOrderNumberAndObjectCode(workOrderNumber: string, optionalObjectCode?: string): Promise<AccountNumberSource | undefined>;
+    /**
+     * Retrieves employees.
+     * @param employeeFilters - The employee filters.
+     * @returns The employees.
+     */
+    getEmployees(employeeFilters: GetEmployeesFilters): Promise<Employee[]>;
+    /**
+     * Retrieves an employee.
+     * @param employeeNumber - The employee number
+     * @returns The employee, if available.
+     */
+    getEmployeeByEmployeeNumber(employeeNumber: string): Promise<Employee | undefined>;
     /**
      * Retrieves employee pay codes.
      * @param employeeNumber - The employee number.
@@ -182,6 +195,7 @@ export declare class WorkTechAPI {
 }
 export { getAccountNumberByWorkOrderNumberAndObjectCode } from './helpers/getAccountNumber.js';
 export { getEmployeePayCodes } from './queries/employees/getEmployeePayCodes.js';
+export { type GetEmployeesFilters, getEmployees } from './queries/employees/getEmployees.js';
 export { getEmployeeTimeCodes } from './queries/employees/getEmployeeTimeCodes.js';
 export { getTimeCodes } from './queries/employees/getTimeCodes.js';
 export { type GetTimesheetBatchEntriesFilters, getTimesheetBatchEntries } from './queries/employees/getTimesheetBatchEntries.js';
@@ -200,7 +214,7 @@ export { addWorkOrderResource } from './queries/workOrders/addWorkOrderResource.
 export { deleteWorkOrderResource } from './queries/workOrders/deleteWorkOrderResource.js';
 export { getWorkOrderResourcesByStartDate, getWorkOrderResourcesByStartDateTimeRange, getWorkOrderResourcesByWorkOrderNumber } from './queries/workOrders/getWorkOrderResources.js';
 export { updateWorkOrderResource } from './queries/workOrders/updateWorkOrderResource.js';
-export type { EmployeePayCode, TimeCode, TimesheetBatchEntry } from './queries/employees/types.js';
+export type { Employee, EmployeePayCode, TimeCode, TimesheetBatchEntry } from './queries/employees/types.js';
 export type { EquipmentItem } from './queries/equipment/types.js';
 export type { ResourceItem } from './queries/items/types.js';
 export type { Activity, Job, JobActivityObjectCode, ObjectCode } from './queries/jobs/types.js';

index.js

@@ -1,6 +1,7 @@
 import { minutesToMillis } from '@cityssm/to-millis';
 import { getAccountNumberByWorkOrderNumberAndObjectCode } from './helpers/getAccountNumber.js';
 import { getEmployeePayCodes } from './queries/employees/getEmployeePayCodes.js';
+import { getEmployees } from './queries/employees/getEmployees.js';
 import { getEmployeeTimeCodes } from './queries/employees/getEmployeeTimeCodes.js';
 import { getTimeCodes } from './queries/employees/getTimeCodes.js';
 import { getTimesheetBatchEntries } from './queries/employees/getTimesheetBatchEntries.js';
@@ -208,6 +209,28 @@ export class WorkTechAPI {
     async getAccountNumberByWorkOrderNumberAndObjectCode(workOrderNumber, optionalObjectCode) {
         return await getAccountNumberByWorkOrderNumberAndObjectCode(this.#mssqlConfig, workOrderNumber, optionalObjectCode);
     }
+    /**
+     * Retrieves employees.
+     * @param employeeFilters - The employee filters.
+     * @returns The employees.
+     */
+    async getEmployees(employeeFilters) {
+        return await getEmployees(this.#mssqlConfig, employeeFilters);
+    }
+    /**
+     * Retrieves an employee.
+     * @param employeeNumber - The employee number
+     * @returns The employee, if available.
+     */
+    async getEmployeeByEmployeeNumber(employeeNumber) {
+        const employees = await getEmployees(this.#mssqlConfig, {
+            employeeNumbers: [employeeNumber]
+        });
+        if (employees.length === 0) {
+            return undefined;
+        }
+        return employees[0];
+    }
     /**
      * Retrieves employee pay codes.
      * @param employeeNumber - The employee number.
@@ -241,6 +264,7 @@ export class WorkTechAPI {
 }
 export { getAccountNumberByWorkOrderNumberAndObjectCode } from './helpers/getAccountNumber.js';
 export { getEmployeePayCodes } from './queries/employees/getEmployeePayCodes.js';
+export { getEmployees } from './queries/employees/getEmployees.js';
 export { getEmployeeTimeCodes } from './queries/employees/getEmployeeTimeCodes.js';
 export { getTimeCodes } from './queries/employees/getTimeCodes.js';
 export { getTimesheetBatchEntries } from './queries/employees/getTimesheetBatchEntries.js';

index.ts

@@ -7,13 +7,18 @@ import {
   getAccountNumberByWorkOrderNumberAndObjectCode
 } from './helpers/getAccountNumber.js'
 import { getEmployeePayCodes } from './queries/employees/getEmployeePayCodes.js'
+import {
+  type GetEmployeesFilters,
+  getEmployees
+} from './queries/employees/getEmployees.js'
 import { getEmployeeTimeCodes } from './queries/employees/getEmployeeTimeCodes.js'
 import { getTimeCodes } from './queries/employees/getTimeCodes.js'
 import {
   type GetTimesheetBatchEntriesFilters,
   getTimesheetBatchEntries
 } from './queries/employees/getTimesheetBatchEntries.js'
 import type {
+  Employee,
   EmployeePayCode,
   TimeCode,
   TimesheetBatchEntry
@@ -377,6 +382,36 @@ export class WorkTechAPI {
     )
   }
 
+  /**
+   * Retrieves employees.
+   * @param employeeFilters - The employee filters.
+   * @returns The employees.
+   */
+  async getEmployees(
+    employeeFilters: GetEmployeesFilters
+  ): Promise<Employee[]> {
+    return await getEmployees(this.#mssqlConfig, employeeFilters)
+  }
+
+  /**
+   * Retrieves an employee.
+   * @param employeeNumber - The employee number
+   * @returns The employee, if available.
+   */
+  async getEmployeeByEmployeeNumber(
+    employeeNumber: string
+  ): Promise<Employee | undefined> {
+    const employees = await getEmployees(this.#mssqlConfig, {
+      employeeNumbers: [employeeNumber]
+    })
+
+    if (employees.length === 0) {
+      return undefined
+    }
+
+    return employees[0]
+  }
+
   /**
    * Retrieves employee pay codes.
    * @param employeeNumber - The employee number.
@@ -433,6 +468,10 @@ export class WorkTechAPI {
 export { getAccountNumberByWorkOrderNumberAndObjectCode } from './helpers/getAccountNumber.js'
 
 export { getEmployeePayCodes } from './queries/employees/getEmployeePayCodes.js'
+export {
+  type GetEmployeesFilters,
+  getEmployees
+} from './queries/employees/getEmployees.js'
 export { getEmployeeTimeCodes } from './queries/employees/getEmployeeTimeCodes.js'
 export { getTimeCodes } from './queries/employees/getTimeCodes.js'
 export {
@@ -487,6 +526,7 @@ export { updateWorkOrderResource } from './queries/workOrders/updateWorkOrderRes
  */
 
 export type {
+  Employee,
   EmployeePayCode,
   TimeCode,
   TimesheetBatchEntry