inventory validation retrieval

Author: dangowans

data/config.defaultValues.d.ts

@@ -13,6 +13,10 @@ export declare const configDefaultValues: {
     'modules.integrityChecker.nhtsaVehicles.isEnabled': boolean;
     'modules.integrityChecker.worktechEquipment.isEnabled': boolean;
     'modules.integrityChecker.worktechEquipment.mappingFunctions': import("../modules/integrityChecker/config/types.js").ConfigModuleIntegrityCheckerMappingFunctions;
+    'modules.integrityChecker.fasterInventory.isEnabled': boolean;
+    'modules.integrityChecker.fasterInventory.validation.source': string;
+    'modules.integrityChecker.fasterInventory.validation.gpLocationCodesToFasterStorerooms': Record<string, string>;
+    'modules.integrityChecker.fasterInventory.validation.gpItemFilter': ((item: import("@cityssm/dynamics-gp").GPItemWithQuantity) => boolean) | undefined;
     'modules.inventoryScanner.isEnabled': boolean;
     'modules.inventoryScanner.scannerIpAddressRegex': RegExp;
     'modules.inventoryScanner.fasterSync.integrationId': number | undefined;

helpers/tasks.helpers.js

@@ -3,9 +3,15 @@
 import { minutesToMillis } from '@cityssm/to-millis';
 const scheduledTaskMinutes = {
     5: ['inventoryScanner_workOrderValidation_fasterApi'],
-    10: ['inventoryScanner_workOrderValidation_worktech'],
+    10: [
+        'inventoryScanner_workOrderValidation_worktech',
+        'integrityChecker_fasterInventory'
+    ],
     15: ['inventoryScanner_itemValidation_dynamicsGp'],
-    35: ['inventoryScanner_workOrderValidation_fasterApi'],
+    35: [
+        'inventoryScanner_workOrderValidation_fasterApi',
+        'integrityChecker_dynamicsGpInventory'
+    ],
     40: ['inventoryScanner_workOrderValidation_worktech'],
     50: ['integrityChecker_fasterAssets'],
     53: ['integrityChecker_worktechEquipment'],

helpers/tasks.helpers.ts

@@ -7,9 +7,15 @@ import type { TaskName } from '../types/tasks.types.js'
 
 const scheduledTaskMinutes: Record<`${number}`, TaskName[]> = {
   5: ['inventoryScanner_workOrderValidation_fasterApi'],
-  10: ['inventoryScanner_workOrderValidation_worktech'],
+  10: [
+    'inventoryScanner_workOrderValidation_worktech',
+    'integrityChecker_fasterInventory'
+  ],
   15: ['inventoryScanner_itemValidation_dynamicsGp'],
-  35: ['inventoryScanner_workOrderValidation_fasterApi'],
+  35: [
+    'inventoryScanner_workOrderValidation_fasterApi',
+    'integrityChecker_dynamicsGpInventory'
+  ],
   40: ['inventoryScanner_workOrderValidation_worktech'],
   50: ['integrityChecker_fasterAssets'],
   53: ['integrityChecker_worktechEquipment'],

modules/integrityChecker/README.md

@@ -1,11 +1,19 @@
 # Integrity Checker
 
+🧑‍💻 **Under development**
+
 Performs various integrity checks on data in FASTER Web.
 
+## Asset Checks
+
 - Reports on assets with invalid VIN numbers.
 - Reports on assets in FASTER Web that have no complimentary record in WorkTech,
   and vice versa.
 
+## Item Checks
+
+**Under development**
+
 ## General Requirements
 
 - 🔗 **SQL Server access** to the WorkTech database.

modules/integrityChecker/config/defaultValues.d.ts

@@ -1,9 +1,15 @@
+import type { GPItemWithQuantity } from '@cityssm/dynamics-gp';
 import type { ConfigModuleIntegrityCheckerMappingFunctions } from './types.js';
+type GpItemFilterFunction = (item: GPItemWithQuantity) => boolean;
 declare const _default: {
     'modules.integrityChecker.isEnabled': boolean;
     'modules.integrityChecker.fasterAssets.isEnabled': boolean;
     'modules.integrityChecker.nhtsaVehicles.isEnabled': boolean;
     'modules.integrityChecker.worktechEquipment.isEnabled': boolean;
     'modules.integrityChecker.worktechEquipment.mappingFunctions': ConfigModuleIntegrityCheckerMappingFunctions;
+    'modules.integrityChecker.fasterInventory.isEnabled': boolean;
+    'modules.integrityChecker.fasterInventory.validation.source': string;
+    'modules.integrityChecker.fasterInventory.validation.gpLocationCodesToFasterStorerooms': Record<string, string>;
+    'modules.integrityChecker.fasterInventory.validation.gpItemFilter': GpItemFilterFunction | undefined;
 };
 export default _default;

modules/integrityChecker/config/defaultValues.js

@@ -5,5 +5,9 @@ export default {
     'modules.integrityChecker.fasterAssets.isEnabled': true,
     'modules.integrityChecker.nhtsaVehicles.isEnabled': true,
     'modules.integrityChecker.worktechEquipment.isEnabled': false,
-    'modules.integrityChecker.worktechEquipment.mappingFunctions': {}
+    'modules.integrityChecker.worktechEquipment.mappingFunctions': {},
+    'modules.integrityChecker.fasterInventory.isEnabled': true,
+    'modules.integrityChecker.fasterInventory.validation.source': '',
+    'modules.integrityChecker.fasterInventory.validation.gpLocationCodesToFasterStorerooms': {},
+    'modules.integrityChecker.fasterInventory.validation.gpItemFilter': undefined
 };

modules/integrityChecker/config/defaultValues.ts

@@ -1,8 +1,12 @@
 // eslint-disable-next-line @eslint-community/eslint-comments/disable-enable-pair
 /* eslint-disable no-secrets/no-secrets */
 
+import type { GPItemWithQuantity } from '@cityssm/dynamics-gp'
+
 import type { ConfigModuleIntegrityCheckerMappingFunctions } from './types.js'
 
+type GpItemFilterFunction = (item: GPItemWithQuantity) => boolean
+
 export default {
   'modules.integrityChecker.isEnabled': false,
 
@@ -13,5 +17,15 @@ export default {
   'modules.integrityChecker.worktechEquipment.isEnabled': false,
 
   'modules.integrityChecker.worktechEquipment.mappingFunctions':
-    {} as unknown as ConfigModuleIntegrityCheckerMappingFunctions
+    {} as unknown as ConfigModuleIntegrityCheckerMappingFunctions,
+
+  'modules.integrityChecker.fasterInventory.isEnabled': true,
+
+  'modules.integrityChecker.fasterInventory.validation.source': '',
+
+  'modules.integrityChecker.fasterInventory.validation.gpLocationCodesToFasterStorerooms':
+    {} as unknown as Record<string, string>,
+
+  'modules.integrityChecker.fasterInventory.validation.gpItemFilter':
+    undefined as unknown as GpItemFilterFunction | undefined
 } satisfies Record<`modules.integrityChecker.${string}`, unknown>

modules/integrityChecker/config/types.d.ts

@@ -1,7 +1,13 @@
+import type { GPItemWithQuantity } from '@cityssm/dynamics-gp';
 import type { AssetResult } from '@cityssm/faster-api';
 export type FasterAssetMappingFunction = (fasterAsset: AssetResult) => string | undefined;
 type FasterAssetMappingFunctionName = 'fasterAssetToEquipmentId' | 'fasterAssetToEquipmentClass' | 'fasterAssetToEquipmentDescription' | 'fasterAssetToDepartment';
 export type ConfigModuleIntegrityCheckerMappingFunctions = Partial<Record<FasterAssetMappingFunctionName, FasterAssetMappingFunction>>;
+export interface ConfigItemValidationDynamicsGP {
+    source: 'dynamicsGP';
+    gpLocationCodesToFasterStorerooms: Record<string, string>;
+    gpItemFilter?: (item: GPItemWithQuantity) => boolean;
+}
 export interface ConfigModuleIntegrityChecker {
     fasterAssets?: {
         isEnabled?: boolean;
@@ -10,5 +16,12 @@ export interface ConfigModuleIntegrityChecker {
         isEnabled?: boolean;
         mappingFunctions?: ConfigModuleIntegrityCheckerMappingFunctions;
     };
+    nhtsaVehicles?: {
+        isEnabled?: boolean;
+    };
+    fasterInventory?: {
+        isEnabled?: boolean;
+        validation?: ConfigItemValidationDynamicsGP;
+    };
 }
 export {};

modules/integrityChecker/config/types.ts

@@ -1,3 +1,4 @@
+import type { GPItemWithQuantity } from '@cityssm/dynamics-gp'
 import type { AssetResult } from '@cityssm/faster-api'
 
 export type FasterAssetMappingFunction = (
@@ -14,6 +15,13 @@ export type ConfigModuleIntegrityCheckerMappingFunctions = Partial<
   Record<FasterAssetMappingFunctionName, FasterAssetMappingFunction>
 >
 
+export interface ConfigItemValidationDynamicsGP {
+  source: 'dynamicsGP'
+  gpLocationCodesToFasterStorerooms: Record<string, string>
+  gpItemFilter?: (item: GPItemWithQuantity) => boolean
+}
+
+
 export interface ConfigModuleIntegrityChecker {
   fasterAssets?: {
     isEnabled?: boolean
@@ -22,4 +30,14 @@ export interface ConfigModuleIntegrityChecker {
     isEnabled?: boolean
     mappingFunctions?: ConfigModuleIntegrityCheckerMappingFunctions
   }
+
+  nhtsaVehicles?: {
+    isEnabled?: boolean
+  }
+
+  fasterInventory?: {
+    isEnabled?: boolean
+    validation?: ConfigItemValidationDynamicsGP
+  }
+
 }

modules/integrityChecker/database/createOrUpdateDynamicsGpInventoryItem.d.ts

@@ -0,0 +1,3 @@
+import type sqlite from 'better-sqlite3';
+import type { IntegrityDynamicsGpInventoryItem } from '../types.js';
+export declare function createOrUpdateDynamicsGpInventoryItem(gpInventoryItem: IntegrityDynamicsGpInventoryItem, connectedDatabase: sqlite.Database): boolean;

modules/integrityChecker/database/createOrUpdateDynamicsGpInventoryItem.js

@@ -0,0 +1,16 @@
+export function createOrUpdateDynamicsGpInventoryItem(gpInventoryItem, connectedDatabase) {
+    const sql = `insert or replace into DynamicsGpInventoryItems (
+      itemNumber, locationCode, fasterStoreroom,
+      itemDescription,
+      itemShortName,
+      itemType,
+      binNumber,
+      currentCost,
+      quantityOnHand,
+      recordUpdate_timeMillis
+    ) 
+    values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)`;
+    const statement = connectedDatabase.prepare(sql);
+    const success = statement.run(gpInventoryItem.itemNumber, gpInventoryItem.locationCode, gpInventoryItem.fasterStoreroom, gpInventoryItem.itemDescription, gpInventoryItem.itemShortName, gpInventoryItem.itemType, gpInventoryItem.binNumber, gpInventoryItem.currentCost, gpInventoryItem.quantityOnHand, gpInventoryItem.recordUpdate_timeMillis);
+    return success.changes > 0;
+}

modules/integrityChecker/database/createOrUpdateDynamicsGpInventoryItem.ts

@@ -0,0 +1,37 @@
+import type sqlite from 'better-sqlite3'
+
+import type { IntegrityDynamicsGpInventoryItem } from '../types.js'
+
+export function createOrUpdateDynamicsGpInventoryItem(
+  gpInventoryItem: IntegrityDynamicsGpInventoryItem,
+  connectedDatabase: sqlite.Database
+): boolean {
+  const sql = `insert or replace into DynamicsGpInventoryItems (
+      itemNumber, locationCode, fasterStoreroom,
+      itemDescription,
+      itemShortName,
+      itemType,
+      binNumber,
+      currentCost,
+      quantityOnHand,
+      recordUpdate_timeMillis
+    ) 
+    values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)`
+
+  const statement = connectedDatabase.prepare(sql)
+
+  const success = statement.run(
+    gpInventoryItem.itemNumber,
+    gpInventoryItem.locationCode,
+    gpInventoryItem.fasterStoreroom,
+    gpInventoryItem.itemDescription,
+    gpInventoryItem.itemShortName,
+    gpInventoryItem.itemType,
+    gpInventoryItem.binNumber,
+    gpInventoryItem.currentCost,
+    gpInventoryItem.quantityOnHand,
+    gpInventoryItem.recordUpdate_timeMillis
+  )
+
+  return success.changes > 0
+}

modules/integrityChecker/database/createOrUpdateFasterInventoryItem.d.ts

@@ -0,0 +1,3 @@
+import type sqlite from 'better-sqlite3';
+import type { IntegrityFasterInventoryItem } from '../types.js';
+export declare function createOrUpdateFasterInventoryItem(fasterInventoryItem: IntegrityFasterInventoryItem, connectedDatabase: sqlite.Database): boolean;

modules/integrityChecker/database/createOrUpdateFasterInventoryItem.js

@@ -0,0 +1,14 @@
+export function createOrUpdateFasterInventoryItem(fasterInventoryItem, connectedDatabase) {
+    const sql = `insert or replace into FasterInventoryItems (
+      itemNumber, storeroom,
+      itemName,
+      binLocation,
+      averageTrueCost,
+      quantityInStock,
+      recordUpdate_timeMillis
+    ) 
+    values (?, ?, ?, ?, ?, ?, ?)`;
+    const statement = connectedDatabase.prepare(sql);
+    const success = statement.run(fasterInventoryItem.itemNumber, fasterInventoryItem.storeroom, fasterInventoryItem.itemName, fasterInventoryItem.binLocation, fasterInventoryItem.averageTrueCost, fasterInventoryItem.quantityInStock, fasterInventoryItem.recordUpdate_timeMillis);
+    return success.changes > 0;
+}

modules/integrityChecker/database/createOrUpdateFasterInventoryItem.ts

@@ -0,0 +1,32 @@
+import type sqlite from 'better-sqlite3'
+
+import type { IntegrityFasterInventoryItem } from '../types.js'
+
+export function createOrUpdateFasterInventoryItem(
+  fasterInventoryItem: IntegrityFasterInventoryItem,
+  connectedDatabase: sqlite.Database
+): boolean {
+  const sql = `insert or replace into FasterInventoryItems (
+      itemNumber, storeroom,
+      itemName,
+      binLocation,
+      averageTrueCost,
+      quantityInStock,
+      recordUpdate_timeMillis
+    ) 
+    values (?, ?, ?, ?, ?, ?, ?)`
+
+  const statement = connectedDatabase.prepare(sql)
+
+  const success = statement.run(
+    fasterInventoryItem.itemNumber,
+    fasterInventoryItem.storeroom,
+    fasterInventoryItem.itemName,
+    fasterInventoryItem.binLocation,
+    fasterInventoryItem.averageTrueCost,
+    fasterInventoryItem.quantityInStock,
+    fasterInventoryItem.recordUpdate_timeMillis
+  )
+
+  return success.changes > 0
+}

modules/integrityChecker/database/deleteExpiredRecords.d.ts

@@ -1,4 +1,4 @@
 import type sqlite from 'better-sqlite3';
-type RecordTable = 'FasterAssets' | 'WorktechEquipment';
+type RecordTable = 'FasterAssets' | 'WorktechEquipment' | 'FasterInventoryItems' | 'DynamicsGpInventoryItems';
 export declare function deleteExpiredRecords(recordTable: RecordTable, recordUpdateTimeMillis: number, connectedDatabase: sqlite.Database): number;
 export {};

modules/integrityChecker/database/deleteExpiredRecords.ts

@@ -1,6 +1,10 @@
 import type sqlite from 'better-sqlite3'
 
-type RecordTable = 'FasterAssets' | 'WorktechEquipment'
+type RecordTable =
+  | 'FasterAssets'
+  | 'WorktechEquipment'
+  | 'FasterInventoryItems'
+  | 'DynamicsGpInventoryItems'
 
 export function deleteExpiredRecords(
   recordTable: RecordTable,

modules/integrityChecker/database/getMaxDynamicsGpInventoryItemUpdateMillis.d.ts

@@ -0,0 +1 @@
+export default function getMaxDynamicsGpInventoryItemUpdateMillis(): number;

modules/integrityChecker/database/getMaxDynamicsGpInventoryItemUpdateMillis.js

@@ -0,0 +1,12 @@
+import sqlite from 'better-sqlite3';
+import { databasePath } from './helpers.database.js';
+export default function getMaxDynamicsGpInventoryItemUpdateMillis() {
+    const database = sqlite(databasePath);
+    const result = database
+        .prepare(`select max(recordUpdate_timeMillis)
+        from DynamicsGpInventoryItems`)
+        .pluck()
+        .get();
+    database.close();
+    return result ?? 0;
+}

modules/integrityChecker/database/getMaxDynamicsGpInventoryItemUpdateMillis.ts

@@ -0,0 +1,19 @@
+import sqlite from 'better-sqlite3'
+
+import { databasePath } from './helpers.database.js'
+
+export default function getMaxDynamicsGpInventoryItemUpdateMillis(): number {
+  const database = sqlite(databasePath)
+
+  const result = database
+    .prepare(
+      `select max(recordUpdate_timeMillis)
+        from DynamicsGpInventoryItems`
+    )
+    .pluck()
+    .get() as number | undefined
+
+  database.close()
+
+  return result ?? 0
+}

modules/integrityChecker/database/getMaxFasterInventoryItemUpdateMillis.d.ts

@@ -0,0 +1 @@
+export default function getMaxFasterInventoryItemUpdateMillis(): number;

modules/integrityChecker/database/getMaxFasterInventoryItemUpdateMillis.js

@@ -0,0 +1,12 @@
+import sqlite from 'better-sqlite3';
+import { databasePath } from './helpers.database.js';
+export default function getMaxFasterInventoryItemUpdateMillis() {
+    const database = sqlite(databasePath);
+    const result = database
+        .prepare(`select max(recordUpdate_timeMillis)
+        from FasterInventoryItems`)
+        .pluck()
+        .get();
+    database.close();
+    return result ?? 0;
+}

modules/integrityChecker/database/getMaxFasterInventoryItemUpdateMillis.ts

@@ -0,0 +1,19 @@
+import sqlite from 'better-sqlite3'
+
+import { databasePath } from './helpers.database.js'
+
+export default function getMaxFasterInventoryItemUpdateMillis(): number {
+  const database = sqlite(databasePath)
+
+  const result = database
+    .prepare(
+      `select max(recordUpdate_timeMillis)
+        from FasterInventoryItems`
+    )
+    .pluck()
+    .get() as number | undefined
+
+  database.close()
+
+  return result ?? 0
+}

modules/integrityChecker/database/helpers.database.d.ts

@@ -1,2 +1,3 @@
 export declare const databasePath = "data/integrityChecker.db";
+export declare const timeoutMillis: number;
 export declare function initializeIntegrityCheckerDatabase(): boolean;