add createStockTransactionBatch()

eslint.config.js

@@ -3,7 +3,7 @@ import tseslint from 'typescript-eslint';
 export const config = tseslint.config(...configCityssm, {
     rules: {
         '@typescript-eslint/no-unsafe-argument': 'warn',
-        '@typescript-eslint/no-unsafe-assignment': 'warn',
+        '@typescript-eslint/no-unsafe-assignment': 'off',
         '@typescript-eslint/no-unsafe-call': 'warn',
         '@typescript-eslint/no-unsafe-member-access': 'warn',
         '@typescript-eslint/no-unsafe-return': 'warn',

eslint.config.ts

@@ -4,7 +4,7 @@ import tseslint from 'typescript-eslint'
 export const config = tseslint.config(...configCityssm, {
   rules: {
     '@typescript-eslint/no-unsafe-argument': 'warn',
-    '@typescript-eslint/no-unsafe-assignment': 'warn',
+    '@typescript-eslint/no-unsafe-assignment': 'off',
     '@typescript-eslint/no-unsafe-call': 'warn',
     '@typescript-eslint/no-unsafe-member-access': 'warn',
     '@typescript-eslint/no-unsafe-return': 'warn',

helpers/getAccountNumber.d.ts

@@ -1,4 +1,4 @@
-import type { mssqlTypes } from '@cityssm/mssql-multi-pool';
+import type { mssql } from '@cityssm/mssql-multi-pool';
 export interface AccountNumberSource {
     accountNumber: string;
     accountNumberSource: // eslint-disable-next-line no-secrets/no-secrets
@@ -11,4 +11,4 @@ export interface AccountNumberSource {
  * @param optionalObjectCode - An optional object code.
  * @returns - The account number and its source, if available.
  */
-export declare function getAccountNumberByWorkOrderNumberAndObjectCode(mssqlConfig: mssqlTypes.config, workOrderNumber: string, optionalObjectCode?: string): Promise<AccountNumberSource | undefined>;
+export declare function getAccountNumberByWorkOrderNumberAndObjectCode(mssqlConfig: mssql.config, workOrderNumber: string, optionalObjectCode?: string): Promise<AccountNumberSource | undefined>;

helpers/getAccountNumber.ts

@@ -1,4 +1,4 @@
-import type { mssqlTypes } from '@cityssm/mssql-multi-pool'
+import type { mssql } from '@cityssm/mssql-multi-pool'
 
 import { accountSegmentSeparator } from '../apiConfig.js'
 import { getJobActivityObjectCodeByKeys } from '../queries/jobs/getJobActivityObjectCodes.js'
@@ -23,7 +23,7 @@ export interface AccountNumberSource {
  * @returns - The account number and its source, if available.
  */
 export async function getAccountNumberByWorkOrderNumberAndObjectCode(
-  mssqlConfig: mssqlTypes.config,
+  mssqlConfig: mssql.config,
   workOrderNumber: string,
   optionalObjectCode?: string
 ): Promise<AccountNumberSource | undefined> {

index.d.ts

@@ -1,9 +1,10 @@
-import type { mssqlTypes } from '@cityssm/mssql-multi-pool';
+import type { mssql } from '@cityssm/mssql-multi-pool';
 import type { DateString } from '@cityssm/utils-datetime';
 import { type AccountNumberSource } from './helpers/getAccountNumber.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';
+import { type CreateStockTransactionBatch } from './queries/items/createStockTransactionBatch.js';
 import type { ResourceItem } from './queries/items/types.js';
 import type { Activity, Job, JobActivityObjectCode, JobAssignedObjectCode, ObjectCode } from './queries/jobs/types.js';
 import type { BigIntString } from './queries/types.js';
@@ -18,7 +19,7 @@ export declare class WorkTechAPI {
     /**
      * @param mssqlConfig - SQL Server configuration.
      */
-    constructor(mssqlConfig: mssqlTypes.config);
+    constructor(mssqlConfig: mssql.config);
     /**
      * Retrieves a piece of equipment.
      * @param equipmentId - The equipment id.
@@ -33,6 +34,12 @@ export declare class WorkTechAPI {
      */
     getItemByItemId(itemId: string): Promise<ResourceItem | undefined>;
     addResourceItem(resourceItem: AddResourceItem): Promise<BigIntString>;
+    /**
+     * Creates a new stock transaction batch.
+     * @param batch - The batch details
+     * @returns - The batch id.
+     */
+    createStockTransactionBatch(batch: CreateStockTransactionBatch): Promise<number>;
     /**
      * Retrieves a work order.
      * @param workOrderNumber - The work order number.
@@ -150,6 +157,7 @@ export { getEquipmentByEquipmentId } from './queries/equipment/getEquipment.js';
 export { addEquipment } from './queries/equipment/addEquipment.js';
 export { getItemByItemId } from './queries/items/getItems.js';
 export { type AddResourceItem, addResourceItem } from './queries/items/addResourceItem.js';
+export { type CreateStockTransactionBatch, type CreateStockTransactionBatchEntry, createStockTransactionBatch } from './queries/items/createStockTransactionBatch.js';
 export { getActivityByActivityId, getActivitiesAssignedToJobByFiscalYear } from './queries/jobs/getActivities.js';
 export { getJobByJobId } from './queries/jobs/getJobs.js';
 export { getObjectCodeByObjectCode, getObjectCodesAssignedToJobByFiscalYear, getObjectCodeAssignedToJobByObjectCodeAndFiscalYear } from './queries/jobs/getObjectCodes.js';

index.js

@@ -2,6 +2,7 @@ import { getAccountNumberByWorkOrderNumberAndObjectCode } from './helpers/getAcc
 import { addEquipment } from './queries/equipment/addEquipment.js';
 import { getEquipmentByEquipmentId } from './queries/equipment/getEquipment.js';
 import { addResourceItem } from './queries/items/addResourceItem.js';
+import { createStockTransactionBatch } from './queries/items/createStockTransactionBatch.js';
 import { getItemByItemId } from './queries/items/getItems.js';
 import { getActivitiesAssignedToJobByFiscalYear, getActivityByActivityId } from './queries/jobs/getActivities.js';
 import { getJobActivityObjectCodeByKeys } from './queries/jobs/getJobActivityObjectCodes.js';
@@ -45,6 +46,14 @@ export class WorkTechAPI {
     async addResourceItem(resourceItem) {
         return await addResourceItem(this.#mssqlConfig, resourceItem);
     }
+    /**
+     * Creates a new stock transaction batch.
+     * @param batch - The batch details
+     * @returns - The batch id.
+     */
+    async createStockTransactionBatch(batch) {
+        return await createStockTransactionBatch(this.#mssqlConfig, batch);
+    }
     /**
      * Retrieves a work order.
      * @param workOrderNumber - The work order number.
@@ -187,6 +196,7 @@ export { getEquipmentByEquipmentId } from './queries/equipment/getEquipment.js';
 export { addEquipment } from './queries/equipment/addEquipment.js';
 export { getItemByItemId } from './queries/items/getItems.js';
 export { addResourceItem } from './queries/items/addResourceItem.js';
+export { createStockTransactionBatch } from './queries/items/createStockTransactionBatch.js';
 export { getActivityByActivityId, getActivitiesAssignedToJobByFiscalYear } from './queries/jobs/getActivities.js';
 export { getJobByJobId } from './queries/jobs/getJobs.js';
 export { getObjectCodeByObjectCode, getObjectCodesAssignedToJobByFiscalYear, getObjectCodeAssignedToJobByObjectCodeAndFiscalYear } from './queries/jobs/getObjectCodes.js';

index.ts

@@ -1,4 +1,4 @@
-import type { mssqlTypes } from '@cityssm/mssql-multi-pool'
+import type { mssql } from '@cityssm/mssql-multi-pool'
 import type { DateString } from '@cityssm/utils-datetime'
 
 import {
@@ -15,6 +15,10 @@ import {
   type AddResourceItem,
   addResourceItem
 } from './queries/items/addResourceItem.js'
+import {
+  type CreateStockTransactionBatch,
+  createStockTransactionBatch
+} from './queries/items/createStockTransactionBatch.js'
 import { getItemByItemId } from './queries/items/getItems.js'
 import type { ResourceItem } from './queries/items/types.js'
 import {
@@ -60,12 +64,12 @@ import {
  * WorkTech API
  */
 export class WorkTechAPI {
-  readonly #mssqlConfig: mssqlTypes.config
+  readonly #mssqlConfig: mssql.config
 
   /**
    * @param mssqlConfig - SQL Server configuration.
    */
-  constructor(mssqlConfig: mssqlTypes.config) {
+  constructor(mssqlConfig: mssql.config) {
     this.#mssqlConfig = mssqlConfig
   }
 
@@ -97,6 +101,17 @@ export class WorkTechAPI {
     return await addResourceItem(this.#mssqlConfig, resourceItem)
   }
 
+  /**
+   * Creates a new stock transaction batch.
+   * @param batch - The batch details
+   * @returns - The batch id.
+   */
+  async createStockTransactionBatch(
+    batch: CreateStockTransactionBatch
+  ): Promise<number> {
+    return await createStockTransactionBatch(this.#mssqlConfig, batch)
+  }
+
   /**
    * Retrieves a work order.
    * @param workOrderNumber - The work order number.
@@ -330,6 +345,12 @@ export {
   addResourceItem
 } from './queries/items/addResourceItem.js'
 
+export {
+  type CreateStockTransactionBatch,
+  type CreateStockTransactionBatchEntry,
+  createStockTransactionBatch
+} from './queries/items/createStockTransactionBatch.js'
+
 export {
   getActivityByActivityId,
   getActivitiesAssignedToJobByFiscalYear

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cityssm/worktech-api",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Integrations with the WorkTech work order management system.",
   "type": "module",
   "exports": "./index.js",
@@ -31,7 +31,7 @@
     "prettier-config-cityssm": "^1.0.0"
   },
   "dependencies": {
-    "@cityssm/mssql-multi-pool": "^4.0.0",
+    "@cityssm/mssql-multi-pool": "^4.1.0",
     "@cityssm/utils-datetime": "^1.3.0",
     "node-cache": "^5.1.2"
   }

queries/equipment/addEquipment.d.ts

@@ -1,9 +1,9 @@
-import type { mssqlTypes } from '@cityssm/mssql-multi-pool';
+import type { mssql } from '@cityssm/mssql-multi-pool';
 import type { BigIntString } from '../types.js';
 import type { EquipmentItem } from './types.js';
 export interface AddEquipment extends Partial<EquipmentItem> {
     equipmentId: string;
     equipmentClass: string;
     equipmentDescription: string;
 }
-export declare function addEquipment(mssqlConfig: mssqlTypes.config, equipment: AddEquipment): Promise<BigIntString>;
+export declare function addEquipment(mssqlConfig: mssql.config, equipment: AddEquipment): Promise<BigIntString>;

queries/equipment/addEquipment.ts

@@ -1,4 +1,4 @@
-import type { mssqlTypes } from '@cityssm/mssql-multi-pool'
+import type { mssql } from '@cityssm/mssql-multi-pool'
 
 import { addResourceItem } from '../items/addResourceItem.js'
 import type { BigIntString } from '../types.js'
@@ -12,7 +12,7 @@ export interface AddEquipment extends Partial<EquipmentItem> {
 }
 
 export async function addEquipment(
-  mssqlConfig: mssqlTypes.config,
+  mssqlConfig: mssql.config,
   equipment: AddEquipment
 ): Promise<BigIntString> {
   return await addResourceItem(mssqlConfig, {

queries/equipment/getEquipment.d.ts

@@ -1,9 +1,9 @@
-import { type mssqlTypes } from '@cityssm/mssql-multi-pool';
+import { type mssql } from '@cityssm/mssql-multi-pool';
 import type { EquipmentItem } from './types.js';
 /**
  * Retrieves a piece of equipment.
  * @param mssqlConfig - SQL Server configuration.
  * @param equipmentId - The equipment id.
  * @returns - The equipment record, if available.
  */
-export declare function getEquipmentByEquipmentId(mssqlConfig: mssqlTypes.config, equipmentId: string): Promise<EquipmentItem | undefined>;
+export declare function getEquipmentByEquipmentId(mssqlConfig: mssql.config, equipmentId: string): Promise<EquipmentItem | undefined>;

queries/equipment/getEquipment.ts

@@ -1,6 +1,6 @@
 import {
   connect,
-  type mssqlTypes
+  type mssql
 } from '@cityssm/mssql-multi-pool'
 import NodeCache from 'node-cache'
 
@@ -53,7 +53,7 @@ const cache = new NodeCache({
  * @returns - The equipment record, if available.
  */
 export async function getEquipmentByEquipmentId(
-  mssqlConfig: mssqlTypes.config,
+  mssqlConfig: mssql.config,
   equipmentId: string
 ): Promise<EquipmentItem | undefined> {
   let equipment: EquipmentItem | undefined = cache.get(equipmentId)
@@ -67,7 +67,7 @@ export async function getEquipmentByEquipmentId(
   const equipmentResult = (await pool
     .request()
     .input('equipmentId', equipmentId)
-    .query(`${sql} and Item_ID = @equipmentId`)) as mssqlTypes.IResult<EquipmentItem>
+    .query(`${sql} and Item_ID = @equipmentId`)) as mssql.IResult<EquipmentItem>
 
   if (equipmentResult.recordset.length === 0) {
     return undefined

queries/items/addResourceItem.d.ts

@@ -1,4 +1,4 @@
-import { type mssqlTypes } from '@cityssm/mssql-multi-pool';
+import { type mssql } from '@cityssm/mssql-multi-pool';
 import type { BigIntString } from '../types.js';
 import type { ResourceItem } from './types.js';
 export interface AddResourceItem extends Partial<ResourceItem> {
@@ -13,4 +13,4 @@ export interface AddResourceItem extends Partial<ResourceItem> {
  * @param resourceItem - The resource item fields.
  * @returns - The system id for the new resource item.
  */
-export declare function addResourceItem(mssqlConfig: mssqlTypes.config, resourceItem: AddResourceItem): Promise<BigIntString>;
+export declare function addResourceItem(mssqlConfig: mssql.config, resourceItem: AddResourceItem): Promise<BigIntString>;

queries/items/addResourceItem.ts

@@ -1,4 +1,4 @@
-import { connect, type mssqlTypes } from '@cityssm/mssql-multi-pool'
+import { connect, type mssql } from '@cityssm/mssql-multi-pool'
 
 import { getLastSystemId, incrementLastSystemId } from '../systemId.js'
 import type { BigIntString } from '../types.js'
@@ -20,7 +20,7 @@ export interface AddResourceItem extends Partial<ResourceItem> {
  * @returns - The system id for the new resource item.
  */
 export async function addResourceItem(
-  mssqlConfig: mssqlTypes.config,
+  mssqlConfig: mssql.config,
   resourceItem: AddResourceItem
 ): Promise<BigIntString> {
   if (resourceItem.itemId.length > 15) {

queries/items/createStockTransactionBatch.d.ts

@@ -0,0 +1,25 @@
+import { type mssql } from '@cityssm/mssql-multi-pool';
+import { type DateString } from '@cityssm/utils-datetime';
+export interface CreateStockTransactionBatch {
+    batchDescription?: string;
+    batchDate?: DateString;
+    userId?: string;
+    entries: CreateStockTransactionBatchEntry[];
+}
+export interface CreateStockTransactionBatchEntry {
+    entryDate?: DateString;
+    workOrderNumber: string;
+    jobId?: string;
+    activityId?: string;
+    objectCode?: string;
+    itemNumber: string;
+    locationCode?: string;
+    quantity: number;
+}
+/**
+ * Creates a new stock transaction batch.
+ * @param mssqlConfig - SQL Server configuration.
+ * @param batch - The batch details
+ * @returns - The batch id.
+ */
+export declare function createStockTransactionBatch(mssqlConfig: mssql.config, batch: CreateStockTransactionBatch): Promise<number>;