@cityssm/worktech-api/queries/equipment/getEquipmentByEquipmentId.ts

Integrations with the WorkTech (Pearl) work order management system.

import { NodeCache } from '@cacheable/node-cache'
import type { mssql } from '@cityssm/mssql-multi-pool'

import { cacheTimeToLiveSeconds } from '../../apiConfig.js'

import { getEquipment } from './getEquipment.js'
import type { EquipmentItem } from './types.js'

const cache = new NodeCache<EquipmentItem>({
  stdTTL: cacheTimeToLiveSeconds
})

/**
 * Retrieves a piece of equipment.
 * @param mssqlConfig - SQL Server configuration.
 * @param equipmentId - The equipment id.
 * @param bypassCache - Whether to bypass the cache
 * @returns - The equipment record, if available.
 */
export async function getEquipmentByEquipmentId(
  mssqlConfig: mssql.config,
  equipmentId: string,
  bypassCache = false
): Promise<EquipmentItem | undefined> {
  let equipment = bypassCache ? undefined : cache.get(equipmentId)

  if (equipment !== undefined) {
    return equipment
  }

  const equipmentList = await getEquipment(mssqlConfig, {
    equipmentIds: [equipmentId]
  })

  if (equipmentList.length === 0) {
    return undefined
  }

  equipment = equipmentList[0]

  cache.set(equipmentId, equipment)

  return equipment
}

/**
 * Clears the equipment cache.
 */
export function clearEquipmentCache(): void {
  cache.flushAll()
}