add getEquipment()

- rename `Employee` type to `EmployeeItem`
- version bump

Author: dangowans

index.d.ts

@@ -3,8 +3,9 @@ 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 { Employee, EmployeePayCode, TimeCode, TimesheetBatchEntry } from './queries/employees/types.js';
+import type { EmployeeItem, EmployeePayCode, TimeCode, TimesheetBatchEntry } from './queries/employees/types.js';
 import { type AddEquipment } from './queries/equipment/addEquipment.js';
+import { type GetEquipmentFilters } from './queries/equipment/getEquipment.js';
 import type { EquipmentItem } from './queries/equipment/types.js';
 import { type AddResourceItem } from './queries/items/addResourceItem.js';
 import { type CreateStockTransactionBatch } from './queries/items/createStockTransactionBatch.js';
@@ -23,6 +24,12 @@ export declare class WorkTechAPI {
      * @param mssqlConfig - SQL Server configuration.
      */
     constructor(mssqlConfig: mssql.config);
+    /**
+     * Retrieves equipment based on filters.
+     * @param filters - The equipment filters.
+     * @returns The equipment list.
+     */
+    getEquipment(filters: GetEquipmentFilters): Promise<EquipmentItem[]>;
     /**
      * Retrieves a piece of equipment.
      * @param equipmentId - The equipment id.
@@ -165,13 +172,13 @@ export declare class WorkTechAPI {
      * @param employeeFilters - The employee filters.
      * @returns The employees.
      */
-    getEmployees(employeeFilters: GetEmployeesFilters): Promise<Employee[]>;
+    getEmployees(employeeFilters: GetEmployeesFilters): Promise<EmployeeItem[]>;
     /**
      * Retrieves an employee.
      * @param employeeNumber - The employee number
      * @returns The employee, if available.
      */
-    getEmployeeByEmployeeNumber(employeeNumber: string): Promise<Employee | undefined>;
+    getEmployeeByEmployeeNumber(employeeNumber: string): Promise<EmployeeItem | undefined>;
     /**
      * Retrieves employee pay codes.
      * @param employeeNumber - The employee number.
@@ -200,7 +207,8 @@ export { getEmployeeTimeCodes } from './queries/employees/getEmployeeTimeCodes.j
 export { getTimeCodes } from './queries/employees/getTimeCodes.js';
 export { type GetTimesheetBatchEntriesFilters, getTimesheetBatchEntries } from './queries/employees/getTimesheetBatchEntries.js';
 export { addEquipment } from './queries/equipment/addEquipment.js';
-export { getEquipmentByEquipmentId } from './queries/equipment/getEquipment.js';
+export { type GetEquipmentFilters, getEquipment } from './queries/equipment/getEquipment.js';
+export { getEquipmentByEquipmentId } from './queries/equipment/getEquipmentByEquipmentId.js';
 export { type UpdateEquipmentFields, updateEquipmentFields } from './queries/equipment/updateEquipment.js';
 export { type AddResourceItem, addResourceItem } from './queries/items/addResourceItem.js';
 export { getItemByItemId } from './queries/items/getItems.js';
@@ -214,7 +222,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 { Employee, EmployeePayCode, TimeCode, TimesheetBatchEntry } from './queries/employees/types.js';
+export type { EmployeeItem, 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

@@ -6,7 +6,8 @@ import { getEmployeeTimeCodes } from './queries/employees/getEmployeeTimeCodes.j
 import { getTimeCodes } from './queries/employees/getTimeCodes.js';
 import { getTimesheetBatchEntries } from './queries/employees/getTimesheetBatchEntries.js';
 import { addEquipment } from './queries/equipment/addEquipment.js';
-import { getEquipmentByEquipmentId } from './queries/equipment/getEquipment.js';
+import { getEquipment } from './queries/equipment/getEquipment.js';
+import { getEquipmentByEquipmentId } from './queries/equipment/getEquipmentByEquipmentId.js';
 import { updateEquipmentFields } from './queries/equipment/updateEquipment.js';
 import { addResourceItem } from './queries/items/addResourceItem.js';
 import { createStockTransactionBatch } from './queries/items/createStockTransactionBatch.js';
@@ -35,6 +36,14 @@ export class WorkTechAPI {
         this.#mssqlConfig.connectionTimeout = Math.max(this.#mssqlConfig.connectionTimeout ?? 0, timeoutMillis);
         this.#mssqlConfig.requestTimeout = Math.max(this.#mssqlConfig.requestTimeout ?? 0, timeoutMillis);
     }
+    /**
+     * Retrieves equipment based on filters.
+     * @param filters - The equipment filters.
+     * @returns The equipment list.
+     */
+    async getEquipment(filters) {
+        return await getEquipment(this.#mssqlConfig, filters);
+    }
     /**
      * Retrieves a piece of equipment.
      * @param equipmentId - The equipment id.
@@ -269,7 +278,8 @@ export { getEmployeeTimeCodes } from './queries/employees/getEmployeeTimeCodes.j
 export { getTimeCodes } from './queries/employees/getTimeCodes.js';
 export { getTimesheetBatchEntries } from './queries/employees/getTimesheetBatchEntries.js';
 export { addEquipment } from './queries/equipment/addEquipment.js';
-export { getEquipmentByEquipmentId } from './queries/equipment/getEquipment.js';
+export { getEquipment } from './queries/equipment/getEquipment.js';
+export { getEquipmentByEquipmentId } from './queries/equipment/getEquipmentByEquipmentId.js';
 export { updateEquipmentFields } from './queries/equipment/updateEquipment.js';
 export { addResourceItem } from './queries/items/addResourceItem.js';
 export { getItemByItemId } from './queries/items/getItems.js';

index.ts

@@ -18,7 +18,7 @@ import {
   getTimesheetBatchEntries
 } from './queries/employees/getTimesheetBatchEntries.js'
 import type {
-  Employee,
+  EmployeeItem,
   EmployeePayCode,
   TimeCode,
   TimesheetBatchEntry
@@ -27,7 +27,11 @@ import {
   type AddEquipment,
   addEquipment
 } from './queries/equipment/addEquipment.js'
-import { getEquipmentByEquipmentId } from './queries/equipment/getEquipment.js'
+import {
+  type GetEquipmentFilters,
+  getEquipment
+} from './queries/equipment/getEquipment.js'
+import { getEquipmentByEquipmentId } from './queries/equipment/getEquipmentByEquipmentId.js'
 import type { EquipmentItem } from './queries/equipment/types.js'
 import { updateEquipmentFields } from './queries/equipment/updateEquipment.js'
 import {
@@ -105,6 +109,15 @@ export class WorkTechAPI {
     )
   }
 
+  /**
+   * Retrieves equipment based on filters.
+   * @param filters - The equipment filters.
+   * @returns The equipment list.
+   */
+  async getEquipment(filters: GetEquipmentFilters): Promise<EquipmentItem[]> {
+    return await getEquipment(this.#mssqlConfig, filters)
+  }
+
   /**
    * Retrieves a piece of equipment.
    * @param equipmentId - The equipment id.
@@ -389,7 +402,7 @@ export class WorkTechAPI {
    */
   async getEmployees(
     employeeFilters: GetEmployeesFilters
-  ): Promise<Employee[]> {
+  ): Promise<EmployeeItem[]> {
     return await getEmployees(this.#mssqlConfig, employeeFilters)
   }
 
@@ -400,7 +413,7 @@ export class WorkTechAPI {
    */
   async getEmployeeByEmployeeNumber(
     employeeNumber: string
-  ): Promise<Employee | undefined> {
+  ): Promise<EmployeeItem | undefined> {
     const employees = await getEmployees(this.#mssqlConfig, {
       employeeNumbers: [employeeNumber]
     })
@@ -480,7 +493,11 @@ export {
 } from './queries/employees/getTimesheetBatchEntries.js'
 
 export { addEquipment } from './queries/equipment/addEquipment.js'
-export { getEquipmentByEquipmentId } from './queries/equipment/getEquipment.js'
+export {
+  type GetEquipmentFilters,
+  getEquipment
+} from './queries/equipment/getEquipment.js'
+export { getEquipmentByEquipmentId } from './queries/equipment/getEquipmentByEquipmentId.js'
 export {
   type UpdateEquipmentFields,
   updateEquipmentFields
@@ -526,7 +543,7 @@ export { updateWorkOrderResource } from './queries/workOrders/updateWorkOrderRes
  */
 
 export type {
-  Employee,
+  EmployeeItem,
   EmployeePayCode,
   TimeCode,
   TimesheetBatchEntry

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@cityssm/worktech-api",
-  "version": "0.16.0",
-  "description": "Integrations with the WorkTech work order management system.",
+  "version": "0.17.0",
+  "description": "Integrations with the WorkTech (Pearl) work order management system.",
   "keywords": [
     "worktech",
     "work-manager",

package.json

@@ -1,5 +1,5 @@
 import { type mssql } from '@cityssm/mssql-multi-pool';
-import type { Employee } from './types.js';
+import type { EmployeeItem } from './types.js';
 export interface GetEmployeesFilters {
     employeeIsActive?: boolean;
     departments?: string[];
@@ -15,4 +15,4 @@ export interface GetEmployeesFilters {
  * @param filters - Filters to apply to the employee query.
  * @returns The employees.
  */
-export declare function getEmployees(mssqlConfig: mssql.config, filters?: GetEmployeesFilters): Promise<Employee[]>;
+export declare function getEmployees(mssqlConfig: mssql.config, filters?: GetEmployeesFilters): Promise<EmployeeItem[]>;

queries/employees/getEmployees.d.ts

@@ -36,7 +36,7 @@ export async function getEmployees(mssqlConfig, filters = {}) {
       coalesce(ITM.DEFVEH_ID, '') as defaultEquipmentId,
       ITM.PATROL as patrol
 
-      FROM dbo.WMITM ITM 
+      FROM dbo.WMITM ITM WITH (NOLOCK)
 
       WHERE ( TYPE = 'Employee' AND Status <> 'EstOnly' )
     `;

queries/employees/getEmployees.js

@@ -1,6 +1,6 @@
 import { type mssql, connect } from '@cityssm/mssql-multi-pool'
 
-import type { Employee } from './types.js'
+import type { EmployeeItem } from './types.js'
 
 export interface GetEmployeesFilters {
   employeeIsActive?: boolean
@@ -25,7 +25,7 @@ export interface GetEmployeesFilters {
 export async function getEmployees(
   mssqlConfig: mssql.config,
   filters: GetEmployeesFilters = {}
-): Promise<Employee[]> {
+): Promise<EmployeeItem[]> {
   const pool = await connect(mssqlConfig)
 
   let request = pool.request()
@@ -57,7 +57,7 @@ export async function getEmployees(
       coalesce(ITM.DEFVEH_ID, '') as defaultEquipmentId,
       ITM.PATROL as patrol
 
-      FROM dbo.WMITM ITM 
+      FROM dbo.WMITM ITM WITH (NOLOCK)
 
       WHERE ( TYPE = 'Employee' AND Status <> 'EstOnly' )
     `
@@ -144,7 +144,7 @@ export async function getEmployees(
     sql += ' ) '
   }
 
-  const result = (await request.query(sql)) as mssql.IResult<Employee>
+  const result = (await request.query(sql)) as mssql.IResult<EmployeeItem>
 
   return result.recordset
 }

queries/employees/getEmployees.ts

@@ -1,5 +1,5 @@
 import type { BigIntString } from '../types.js';
-export interface Employee {
+export interface EmployeeItem {
     itemSystemId: BigIntString | number;
     employeeNumber: string;
     employeeName: string;

queries/employees/types.d.ts

@@ -1,6 +1,6 @@
 import type { BigIntString } from '../types.js'
 
-export interface Employee {
+export interface EmployeeItem {
   itemSystemId: BigIntString | number
 
   employeeNumber: string
@@ -19,7 +19,7 @@ export interface Employee {
 
   phoneNumber1: string
   phoneNumberType1: string
-  
+
   emailAddress: string
   positionId: string
   hoursPerPayPeriod: number