fluent-cerner-js 1.1.0 → 1.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fluent-cerner-js",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "license": "MIT",
   "type": "module",
   "main": "dist/index.cjs",
@@ -31,7 +31,10 @@
     "test": "vitest run",
     "test:watch": "vitest",
     "lint": "eslint src",
-    "prepare": "npm run build",
+    "format": "prettier --write \"src/**/*.{ts,json}\"",
+    "format:check": "prettier --check \"src/**/*.{ts,json}\"",
+    "typecheck": "tsc --noEmit",
+    "prepare": "husky && npm run build",
     "size": "size-limit",
     "analyze": "size-limit --why",
     "demo": "npx node demo.js"
@@ -42,6 +45,15 @@
     "singleQuote": true,
     "trailingComma": "es5"
   },
+  "lint-staged": {
+    "src/**/*.ts": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "*.{json,md,yml,yaml}": [
+      "prettier --write"
+    ]
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/geekmdtravis/fluent-cerner-js.git"
@@ -53,23 +65,22 @@
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "8.57.0",
     "@typescript-eslint/parser": "8.57.0",
+    "@vitest/coverage-v8": "^4.1.6",
     "eslint": "10.0.3",
+    "husky": "9.1.7",
     "jsdom": "^25.0.0",
+    "lint-staged": "17.0.4",
+    "prettier": "3.8.3",
     "tslib": "^2.8.0",
     "tsup": "^8.3.0",
     "typescript": "^5.7.0",
-    "vitest": "^2.1.0"
+    "vitest": "^4.1.6"
   },
   "dependencies": {
     "fast-xml-parser": "^5.5.6"
   },
   "peerDependencies": {
-    "easy-ccl-request": "^1.1.0"
-  },
-  "overrides": {
-    "vite": {
-      "esbuild": "^0.25.0"
-    }
+    "easy-ccl-request": "^1.1.1"
   },
   "jest": {
     "verbose": true,

package/src/getValidEncountersAsync.ts

@@ -22,7 +22,7 @@ export async function getValidEncountersAsync(
     const response = await dcof.GetValidEncounters(personId);
     const eidStr = response.trim();
     if (eidStr === '') return retData;
-    eidStr.split(',').forEach(e => {
+    eidStr.split(',').forEach((e) => {
       const eid = parseFloat(e);
       if (isNaN(eid)) {
         console.warn(

package/src/launchClinicalNoteAsync.ts

@@ -75,8 +75,10 @@ export const launchClinicalNoteAsync = async (
 
   params.push(`[${eventIds.join('|')}]`);
   params.push(
-    `${windowTitle ||
-      `Clinical Note for patient with PID ${patientId} on encounter with EID ${encounterId}`}`
+    `${
+      windowTitle ||
+      `Clinical Note for patient with PID ${patientId} on encounter with EID ${encounterId}`
+    }`
   );
   params.push(`${calculateViewOptionFlag(_viewOptsFlags)}`);
   params.push(`${viewName || ''}`);
@@ -101,7 +103,7 @@ export const launchClinicalNoteAsync = async (
 
 function calculateViewOptionFlag(viewOptionFlags: Array<ViewOption>): number {
   let total = 0;
-  viewOptionFlags.forEach(flag => {
+  viewOptionFlags.forEach((flag) => {
     if (flag === 'menu') total += 1;
     if (flag === 'buttons') total += 2;
     if (flag === 'toolbar') total += 4;

package/src/openApplicationAsync.spec.ts

@@ -75,7 +75,7 @@ describe('generateOpenApplicationArgumentString', () => {
     ];
 
     const argString = generateOpenApplicationArgumentString(args);
-    expect(argString).toBe('/PERSONID=1 /ENCNTRID=123 /FIRSTTAB=^ORDERS^');
+    expect(argString).toBe('/PERSONID=1 /ENCNTRID=123 /FIRSTTAB=^Orders^');
   });
   it('Generates a correct argument string with quick open', () => {
     const args: Array<OpenApplicationArgument> = [
@@ -95,7 +95,7 @@ describe('generateOpenApplicationArgumentString', () => {
     ];
 
     const argString = generateOpenApplicationArgumentString(args);
-    expect(argString).toBe('/PERSONID=1 /ENCNTRID=123 /FIRSTTAB=^ORDERS+^');
+    expect(argString).toBe('/PERSONID=1 /ENCNTRID=123 /FIRSTTAB=^Orders+^');
   });
   it('Tabs string is surrounded by ^', () => {
     const args: Array<OpenApplicationArgument> = [
@@ -106,7 +106,7 @@ describe('generateOpenApplicationArgumentString', () => {
     ];
 
     const argString = generateOpenApplicationArgumentString(args);
-    expect(argString).toBe('/FIRSTTAB=^ORDERS^');
+    expect(argString).toBe('/FIRSTTAB=^Orders^');
   });
   it('Non-tab string is not surrounded by ^', () => {
     const args: Array<OpenApplicationArgument> = [
@@ -117,6 +117,6 @@ describe('generateOpenApplicationArgumentString', () => {
     ];
 
     const argString = generateOpenApplicationArgumentString(args);
-    expect(argString).toBe('/POWERCHART.EXE=RANDOM');
+    expect(argString).toBe('/POWERCHART.EXE=Random');
   });
 });

package/src/openApplicationAsync.ts

@@ -98,10 +98,9 @@ export function generateOpenApplicationArgumentString(
       const quickOpenStr = quickOpen && isTab && !isOrgLevel ? '+' : '';
       const surroundStr = isTab ? '^' : '';
 
-      return `/${arg}=${surroundStr}${value}${quickOpenStr}${surroundStr}`;
+      return `/${arg.toUpperCase()}=${surroundStr}${value}${quickOpenStr}${surroundStr}`;
     })
-    .join(' ')
-    .toUpperCase();
+    .join(' ');
 }
 
 const modeMap = new Map<OpenApplicationMode, 0 | 1 | 100>();

package/src/openOrganizerTabAsync.spec.ts

@@ -13,20 +13,18 @@ describe('openOrganizerTab', () => {
   });
   test('returns an appropriately formatted eventString', async () => {
     const { eventString } = await openOrganizerTabAsync('Tab Name');
-    expect(eventString).toBe(`/ORGANIZERTAB=^TAB NAME^`);
+    expect(eventString).toBe(`/ORGANIZERTAB=^Tab Name^`);
   });
   test('badInput returns false if response is anything other than null', async () => {
     Object.defineProperty(window, 'APPLINK', {
       writable: true,
-      value: jest
-        .fn()
-        .mockImplementation(async function(
-          a: string,
-          b: string
-        ): Promise<null | ''> {
-          console.debug(`a: ${a}, b: ${b}`);
-          return new Promise(resolve => resolve(''));
-        }),
+      value: jest.fn().mockImplementation(async function (
+        a: string,
+        b: string
+      ): Promise<null | ''> {
+        console.debug(`a: ${a}, b: ${b}`);
+        return new Promise((resolve) => resolve(''));
+      }),
     });
 
     const { badInput } = await openOrganizerTabAsync('Tab Name');
@@ -35,15 +33,13 @@ describe('openOrganizerTab', () => {
   test('badInput returns true if response is null', async () => {
     Object.defineProperty(window, 'APPLINK', {
       writable: true,
-      value: jest
-        .fn()
-        .mockImplementation(async function(
-          a: string,
-          b: string
-        ): Promise<null | ''> {
-          console.debug(`a: ${a}, b: ${b}`);
-          return new Promise(resolve => resolve(null));
-        }),
+      value: jest.fn().mockImplementation(async function (
+        a: string,
+        b: string
+      ): Promise<null | ''> {
+        console.debug(`a: ${a}, b: ${b}`);
+        return new Promise((resolve) => resolve(null));
+      }),
     });
 
     const { badInput } = await openOrganizerTabAsync('Tab Name');
@@ -52,15 +48,13 @@ describe('openOrganizerTab', () => {
   test('throws an error when the error type is not one expected to be generated as an "out-of-powerchart" error.', async () => {
     Object.defineProperty(window, 'APPLINK', {
       writable: true,
-      value: jest
-        .fn()
-        .mockImplementation(async function(
-          a: string,
-          b: string
-        ): Promise<Error> {
-          console.debug(`a: ${a}, b: ${b}`);
-          throw new Error('unexpected error');
-        }),
+      value: jest.fn().mockImplementation(async function (
+        a: string,
+        b: string
+      ): Promise<Error> {
+        console.debug(`a: ${a}, b: ${b}`);
+        throw new Error('unexpected error');
+      }),
     });
 
     await expect(openOrganizerTabAsync('Tab Name')).rejects.toThrow(Error);

package/src/openPatientTabAsync.spec.ts

@@ -14,24 +14,22 @@ describe('openPatientTab', () => {
   });
   test('returns an appropriately formatted eventString without quickadd', async () => {
     const { eventString } = await openPatientTabAsync(0, 1, 'Tab Name');
-    expect(eventString).toBe(`/PERSONID=0 /ENCNTRID=1 /FIRSTTAB=^TAB NAME^`);
+    expect(eventString).toBe(`/PERSONID=0 /ENCNTRID=1 /FIRSTTAB=^Tab Name^`);
   });
   test('returns an appropriately formatted eventString with quickadd', async () => {
     const { eventString } = await openPatientTabAsync(0, 1, 'Tab Name', true);
-    expect(eventString).toBe(`/PERSONID=0 /ENCNTRID=1 /FIRSTTAB=^TAB NAME+^`);
+    expect(eventString).toBe(`/PERSONID=0 /ENCNTRID=1 /FIRSTTAB=^Tab Name+^`);
   });
   test('badInput returns false if response is anything other than null', async () => {
     Object.defineProperty(window, 'APPLINK', {
       writable: true,
-      value: jest
-        .fn()
-        .mockImplementation(async function(
-          a: string,
-          b: string
-        ): Promise<null | ''> {
-          console.debug(`a: ${a}, b: ${b}`);
-          return new Promise(resolve => resolve(''));
-        }),
+      value: jest.fn().mockImplementation(async function (
+        a: string,
+        b: string
+      ): Promise<null | ''> {
+        console.debug(`a: ${a}, b: ${b}`);
+        return new Promise((resolve) => resolve(''));
+      }),
     });
 
     const { badInput } = await openPatientTabAsync(0, 1, 'Tab Name');
@@ -40,15 +38,13 @@ describe('openPatientTab', () => {
   test('badInput returns true if response is null', async () => {
     Object.defineProperty(window, 'APPLINK', {
       writable: true,
-      value: jest
-        .fn()
-        .mockImplementation(async function(
-          a: string,
-          b: string
-        ): Promise<null | ''> {
-          console.debug(`a: ${a}, b: ${b}`);
-          return new Promise(resolve => resolve(null));
-        }),
+      value: jest.fn().mockImplementation(async function (
+        a: string,
+        b: string
+      ): Promise<null | ''> {
+        console.debug(`a: ${a}, b: ${b}`);
+        return new Promise((resolve) => resolve(null));
+      }),
     });
 
     const { badInput } = await openPatientTabAsync(0, 1, 'Tab Name');
@@ -58,15 +54,13 @@ describe('openPatientTab', () => {
     Object.defineProperty(window, 'external', {
       writable: true,
       value: {
-        APPLINK: jest
-          .fn()
-          .mockImplementation(async function(
-            a: string,
-            b: string
-          ): Promise<Error> {
-            console.debug(`a: ${a}, b: ${b}`);
-            return Promise.reject(new Error('unexpected error'));
-          }),
+        APPLINK: jest.fn().mockImplementation(async function (
+          a: string,
+          b: string
+        ): Promise<Error> {
+          console.debug(`a: ${a}, b: ${b}`);
+          return Promise.reject(new Error('unexpected error'));
+        }),
       },
     });
 

package/src/submitOrdersAsync.spec.ts

@@ -152,15 +152,13 @@ describe('submitOrders', () => {
     Object.defineProperty(window, 'external', {
       writable: true,
       value: {
-        MPAGES_EVENT: jest
-          .fn()
-          .mockImplementation(async function(
-            a: string,
-            b: string
-          ): Promise<string> {
-            console.debug(`a: ${a}, b: ${b}`);
-            return new Promise(resolve =>
-              resolve(`<?xml version="1.0"?>
+        MPAGES_EVENT: jest.fn().mockImplementation(async function (
+          a: string,
+          b: string
+        ): Promise<string> {
+          console.debug(`a: ${a}, b: ${b}`);
+          return new Promise((resolve) =>
+            resolve(`<?xml version="1.0"?>
               <?xml-stylesheet type='text/xml' href='dom.xsl'?>
               <Orders>
               <OrderVersion>1</OrderVersion>
@@ -176,8 +174,8 @@ describe('submitOrders', () => {
               <ClinDisplayLine type="string">0.4 mg, Oral, Cap, Daily, Administration Type NA, Automatic Refill, Order Duration: 30 day, First Dose: 07/23/23 07:00 PDT, Stop Date: 08/22/23 06:59 PDT, 07/23/23 07:00 PDT</ClinDisplayLine>
               </Order>
               </Orders>`)
-            );
-          }),
+          );
+        }),
       },
     });
 
@@ -203,15 +201,13 @@ describe('submitOrders', () => {
     Object.defineProperty(window, 'external', {
       writable: true,
       value: {
-        MPAGES_EVENT: jest
-          .fn()
-          .mockImplementation(async function(
-            a: string,
-            b: string
-          ): Promise<string> {
-            console.debug(`a: ${a}, b: ${b}`);
-            return new Promise(resolve =>
-              resolve(`<?xml version="1.0"?>
+        MPAGES_EVENT: jest.fn().mockImplementation(async function (
+          a: string,
+          b: string
+        ): Promise<string> {
+          console.debug(`a: ${a}, b: ${b}`);
+          return new Promise((resolve) =>
+            resolve(`<?xml version="1.0"?>
               <?xml-stylesheet type='text/xml' href='dom.xsl'?>
               <Orders>
               <OrderVersion>1</OrderVersion>
@@ -238,8 +234,8 @@ describe('submitOrders', () => {
               <ClinDisplayLine type="string">0.4 mg, Oral, Cap, Daily, Administration Type NA, Automatic Refill, Order Duration: 30 day, First Dose: 07/23/23 07:00 PDT, Stop Date: 08/22/23 06:59 PDT, 07/23/23 07:00 PDT</ClinDisplayLine>
               </Order>
               </Orders>`)
-            );
-          }),
+          );
+        }),
       },
     });
 
@@ -276,15 +272,13 @@ describe('submitOrders', () => {
     Object.defineProperty(window, 'external', {
       writable: true,
       value: {
-        MPAGE_EVENT: jest
-          .fn()
-          .mockImplementation(async function(
-            a: string,
-            b: string
-          ): Promise<object> {
-            console.debug(`a: ${a}, b: ${b}`);
-            return new Promise(resolve => resolve({}));
-          }),
+        MPAGE_EVENT: jest.fn().mockImplementation(async function (
+          a: string,
+          b: string
+        ): Promise<object> {
+          console.debug(`a: ${a}, b: ${b}`);
+          return new Promise((resolve) => resolve({}));
+        }),
       },
     });
     const { status } = await submitOrdersAsync(1, 2, [order]);
@@ -295,15 +289,13 @@ describe('submitOrders', () => {
     Object.defineProperty(window, 'external', {
       writable: true,
       value: {
-        MPAGES_EVENT: jest
-          .fn()
-          .mockImplementation(async function(
-            a: string,
-            b: string
-          ): Promise<string> {
-            console.debug(`a: ${a}, b: ${b}`);
-            return new Promise(resolve => resolve(''));
-          }),
+        MPAGES_EVENT: jest.fn().mockImplementation(async function (
+          a: string,
+          b: string
+        ): Promise<string> {
+          console.debug(`a: ${a}, b: ${b}`);
+          return new Promise((resolve) => resolve(''));
+        }),
       },
     });
     const { status } = await submitOrdersAsync(1, 2, [order]);
@@ -314,15 +306,13 @@ describe('submitOrders', () => {
     Object.defineProperty(window, 'external', {
       writable: true,
       value: {
-        MPAGES_EVENT: jest
-          .fn()
-          .mockImplementation(async function(
-            a: string,
-            b: string
-          ): Promise<string> {
-            console.debug(`a: ${a}, b: ${b}`);
-            return new Promise(resolve => resolve('<xml>'));
-          }),
+        MPAGES_EVENT: jest.fn().mockImplementation(async function (
+          a: string,
+          b: string
+        ): Promise<string> {
+          console.debug(`a: ${a}, b: ${b}`);
+          return new Promise((resolve) => resolve('<xml>'));
+        }),
       },
     });
     const { status } = await submitOrdersAsync(1, 2, [order]);
@@ -333,15 +323,13 @@ describe('submitOrders', () => {
     Object.defineProperty(window, 'external', {
       writable: true,
       value: {
-        MPAGES_EVENT: jest
-          .fn()
-          .mockImplementation(async function(
-            a: string,
-            b: string
-          ): Promise<null> {
-            console.debug(`a: ${a}, b: ${b}`);
-            return new Promise(resolve => resolve(null));
-          }),
+        MPAGES_EVENT: jest.fn().mockImplementation(async function (
+          a: string,
+          b: string
+        ): Promise<null> {
+          console.debug(`a: ${a}, b: ${b}`);
+          return new Promise((resolve) => resolve(null));
+        }),
       },
     });
     const { status } = await submitOrdersAsync(1, 2, [order]);
@@ -352,15 +340,13 @@ describe('submitOrders', () => {
   test('throws an error when the error type is not one expected to be generated as an "out-of-powerchart" error.', async () => {
     Object.defineProperty(window.external, 'MPAGES_EVENT', {
       writable: true,
-      value: jest
-        .fn()
-        .mockImplementation(async function(
-          a: string,
-          b: string
-        ): Promise<Error> {
-          console.debug(`a: ${a}, b: ${b}`);
-          return Promise.reject(new Error('unexpected error'));
-        }),
+      value: jest.fn().mockImplementation(async function (
+        a: string,
+        b: string
+      ): Promise<Error> {
+        console.debug(`a: ${a}, b: ${b}`);
+        return Promise.reject(new Error('unexpected error'));
+      }),
     });
 
     try {

package/src/submitOrdersAsync.ts

@@ -98,6 +98,7 @@ export type SubmitOrderAsyncReturn = MPageEventReturn & {
   status: SubmitOrdersAsyncStatus;
   response: MpagesEventOrdersReturnXML | null;
   ordersPlaced: Array<{ name: string; oid: number; display: string }> | null;
+  rawResponse: string | null;
 };
 
 export type Order = {
@@ -156,6 +157,7 @@ export const submitOrdersAsync = async (
     status: 'success',
     response: null,
     ordersPlaced: null,
+    rawResponse: null,
   };
 
   if (dryRun) {
@@ -169,6 +171,9 @@ export const submitOrdersAsync = async (
       eventString
     )) as string;
 
+    // Store the raw response on the return value for debugging purposes.
+    retVal.rawResponse = response;
+
     // 'null' must be checked for explicitly, as it is a valid response
     // '!response' will return true for null, undefined, and empty string.
     if (response === null) {

package/src/submitPowerOrdersAsync.spec.ts

@@ -72,7 +72,11 @@ describe('submitPowerOrders()', () => {
       },
     ];
     try {
-      await submitPowerOrdersAsync(1, 1, orderArray);
+      await submitPowerOrdersAsync(
+        1,
+        1,
+        orderArray as unknown as Parameters<typeof submitPowerOrdersAsync>[2]
+      );
     } catch (e) {
       expect(e).toBeInstanceOf(SyntaxError);
       expect(e as SyntaxError).toHaveProperty(

package/src/submitPowerOrdersAsync.ts

@@ -127,11 +127,8 @@ export const submitPowerOrdersAsync = async (
 
   // Get required bitmask values for later use in the CreateMOEW function
   // TODO: determine if this should be moved, and maybe simply integrated directly into the CreateMOEW function
-  const {
-    dwCustomizeFlag,
-    dwTabFlag,
-    dwTabDisplayOptionsFlag,
-  } = calculateMOEWBitmask(targetTab || 'orders tab', moewFlags);
+  const { dwCustomizeFlag, dwTabFlag, dwTabDisplayOptionsFlag } =
+    calculateMOEWBitmask(targetTab || 'orders tab', moewFlags);
 
   let retData: SubmitPowerOrdersReturn = {
     inPowerChart: true,
@@ -148,7 +145,7 @@ export const submitPowerOrdersAsync = async (
   let powerPlanOrders: Array<PowerPlanOrder> = [];
   let standaloneOrders: Array<StandaloneOrder> = [];
 
-  orders.forEach(order => {
+  orders.forEach((order) => {
     if (isPowerPlanOrder(order)) {
       powerPlanOrders.push(order as PowerPlanOrder);
     } else if (isStandaloneOrder(order)) {

package/src/utils/addNewOrdersToScratchPadAsync.ts

@@ -39,7 +39,7 @@ export async function addNewOrdersToScratchpadAsync(
   // Convert the standalone orders provided into the required XML string
   let standaloneOrdersXML: string = '';
 
-  standaloneOrders.forEach(standaloneOrder => {
+  standaloneOrders.forEach((standaloneOrder) => {
     standaloneOrdersXML += `<Order><EOrderOriginationFlag>${
       standaloneOrder.origination === 'inpatient order' ? 0 : 1
     }</EOrderOriginationFlag><SynonymId>${standaloneOrder.synonymId}</SynonymId>

package/src/utils/addPowerPlanWithDetailsAsync.ts

@@ -50,7 +50,7 @@ export async function addPowerPlanWithDetailsAsync(
       }</PersonalizedPlanId><Diagnoses>
     ${
       dids
-        ? dids.map(diagnosisSynonymID => {
+        ? dids.map((diagnosisSynonymID) => {
             return '<DiagnosisId>' + diagnosisSynonymID + '</DiagnosisId>';
           })
         : ''

package/src/utils/calculateMOEWBitmask.ts

@@ -95,7 +95,7 @@ export const calculateMOEWBitmask = (
   }
 
   // Calculate the other two parameters (dwCustomizeFlag and dwTabDisplayOptionsFlag) that are also ultimately needed for CreateMOEW()
-  cernerFlags.forEach(option => {
+  cernerFlags.forEach((option) => {
     switch (option) {
       // Calculate the dwCustomizeFlagParamater
       case 'sign later':

package/src/utils/getOrdersPlacedAsync.ts

@@ -48,7 +48,7 @@ export async function getOrdersPlacedAsync(
       if (!(parsed.Orders.Order instanceof Array)) {
         parsed.Orders.Order = [parsed.Orders.Order];
       }
-      retData.ordersPlaced = parsed.Orders.Order.map(o => ({
+      retData.ordersPlaced = parsed.Orders.Order.map((o) => ({
         name: o.OrderedAsMnemonic,
         oid: o.OrderId,
         display: o.ClinDisplayLine,