@worknice/js-sdk 0.0.4 → 0.0.6

package/dist/helpers/handleTriggerIntegrationSyncWebhook.js

@@ -1,11 +1,16 @@
+import isInstantAfter from "@worknice/utils/temporal/isInstantAfter";
+import isValidInstant from "@worknice/utils/temporal/isValidInstant";
 import { Temporal } from "temporal-polyfill";
 import { ConnectionStatus } from "../api/_types.js";
 import comparePersonDataTransferLines from "../employee-records/comparePersonDataTransferLines.js";
 import mergePersonDataTransferLines from "../employee-records/mergePersonDataTransferLines.js";
 import validatePersonDataTransferLineBankAccounts from "../employee-records/validatePersonDataTransferLineBankAccounts.js";
-import validatePersonDataTransferLinePersonalDetails from "../employee-records/validatePersonDataTransferLinePersonalDetails.js";
+import validatePersonDataTransferLineDateOfBirth from "../employee-records/validatePersonDataTransferLineDateOfBirth.js";
+import validatePersonDataTransferLineFullName from "../employee-records/validatePersonDataTransferLineFullName.js";
+import validatePersonDataTransferLineGender from "../employee-records/validatePersonDataTransferLineGender.js";
+import validatePersonDataTransferLinePersonalEmail from "../employee-records/validatePersonDataTransferLinePersonalEmail.js";
+import validatePersonDataTransferLinePersonalPhone from "../employee-records/validatePersonDataTransferLinePersonalPhone.js";
 import validatePersonDataTransferLineResidentialAddress from "../employee-records/validatePersonDataTransferLineResidentialAddress.js";
-import isAfter from "../utils/isAfter.js";
 import handleRequestWithWorknice from "./handleRequestWithWorknice.js";
 const handleTriggerIntegrationSyncWebhook = async (request, {
   createRemotePerson,
@@ -18,9 +23,17 @@ const handleTriggerIntegrationSyncWebhook = async (request, {
   request,
   {
     getApiToken,
-    getEnv,
     handleRequest: async (context) => {
       const { logger, payload, worknice } = context;
+      let cachedDataImport;
+      const getDataImport = async () => {
+        if (!cachedDataImport) {
+          cachedDataImport = await worknice.createDataImport({
+            integrationId: payload.integrationId
+          });
+        }
+        return cachedDataImport;
+      };
       try {
         logger.connect(worknice, payload.integrationId);
         logger.indent("Retrieving Worknice data\u2026");
@@ -115,7 +128,7 @@ const handleTriggerIntegrationSyncWebhook = async (request, {
                   );
                 }
                 const matchingWorknicePerson = people.find(
-                  (person) => person.employeeCode !== null && person.employeeCode === remotePerson.metadata.employeeCode || person.personalEmail !== null && person.personalEmail === remotePerson.personalDetails?.personalEmail || person.profileEmail !== null && person.profileEmail === remotePerson.profile?.profileEmail
+                  (person) => person.id === remotePerson.metadata.targetId || person.employeeCode !== null && person.employeeCode === remotePerson.metadata.employeeCode || person.personalEmail !== null && person.personalEmail === remotePerson.personalEmail?.personalEmail || person.profileEmail !== null && person.profileEmail === remotePerson.profile?.profileEmail
                 ) ?? null;
                 if (config.automaticMatching === true && matchingWorknicePerson) {
                   const personConnection = personConnections.find(
@@ -222,18 +235,13 @@ const handleTriggerIntegrationSyncWebhook = async (request, {
             }
           } catch (error) {
             logger.info(
-              `Unable to update person connection for person "${remotePersonName}" in ${config.appName} because of the following error:
-
-${error instanceof Error ? error.message : error}
-`
+              `Unable to update person connection for person "${remotePersonName}" in ${config.appName} because of the following error:`
             );
+            logger.error(error);
           }
         }
         logger.dedent("Finished updating person connections.");
         if (config.mode === "one-way" || config.mode === "two-way") {
-          const dataImport = await worknice.createDataImport({
-            integrationId: payload.integrationId
-          });
           logger.indent("Updating people with connections marked as merged\u2026");
           const mergedConnections = personConnections.filter(
             (personConnection) => personConnection.status === ConnectionStatus.Merged
@@ -270,17 +278,25 @@ ${error instanceof Error ? error.message : error}
                 profileEmail: worknicePerson.profileEmail ?? null
               }
             };
-            const myobPersonDataTransferLine = remotePerson;
+            const remotePersonDataTransferLine = remotePerson;
             const comparison = comparePersonDataTransferLines(
               worknicePersonDataTransferLine,
-              myobPersonDataTransferLine
+              remotePersonDataTransferLine
             );
-            if (comparison.hasDifferences && (comparison.sections.bankAccounts.hasDifferences || comparison.sections.personalDetails.hasDifferences || comparison.sections.residentialAddress.hasDifferences)) {
+            if (comparison.hasDifferences && (config.syncFields?.bankAccounts && comparison.sections.bankAccounts.hasDifferences || config.syncFields?.dateOfBirth && comparison.sections.dateOfBirth.hasDifferences || config.syncFields?.fullName && comparison.sections.fullName.hasDifferences || config.syncFields?.gender && comparison.sections.gender.hasDifferences || config.syncFields?.personalEmail && comparison.sections.personalEmail.hasDifferences || config.syncFields?.personalPhone && comparison.sections.personalPhone.hasDifferences || config.syncFields?.residentialAddress && comparison.sections.residentialAddress.hasDifferences)) {
               const worknicePersonUpdatedAt = Temporal.Instant.from(worknicePerson.updatedAt);
-              const myobEmployeeUpdatedAt = Temporal.PlainDateTime.from(
+              if (!isValidInstant(remotePerson.metadata.updatedAt)) {
+                throw Error(
+                  `Invalid updatedAt value for ${config.appName} person "${remotePersonName}". Must be in ISO 8601 format, including a date, a time, and a time zone offset.`,
+                  {
+                    cause: Error(`Unable to parse: ${remotePerson.metadata.updatedAt}`)
+                  }
+                );
+              }
+              const remotePersonUpdatedAt = Temporal.Instant.from(
                 remotePerson.metadata.updatedAt
-              ).toZonedDateTime(Temporal.TimeZone.from("UTC")).toInstant();
-              if (isAfter(worknicePersonUpdatedAt, myobEmployeeUpdatedAt)) {
+              );
+              if (isInstantAfter(worknicePersonUpdatedAt, remotePersonUpdatedAt)) {
                 if (config.mode === "two-way") {
                   if (!updateRemotePerson) {
                     throw Error(
@@ -295,31 +311,46 @@ ${error instanceof Error ? error.message : error}
                     logger.info(`Updated person "${remotePersonName}" in ${config.appName}.`);
                   } catch (error) {
                     logger.info(
-                      `Unable to update person "${remotePersonName}" in ${config.appName} because of the following error:
-
-${error instanceof Error ? error.message : error}
-`
+                      `Unable to update person "${remotePersonName}" in ${config.appName} because of the following error:`
                     );
+                    logger.error(error);
                   }
                 }
               } else {
                 try {
-                  const personalDetails = validatePersonDataTransferLinePersonalDetails(
-                    myobPersonDataTransferLine.personalDetails
-                  );
                   const bankAccounts = validatePersonDataTransferLineBankAccounts(
-                    myobPersonDataTransferLine.bankAccounts
+                    remotePersonDataTransferLine.bankAccounts
+                  );
+                  const dateOfBirth = validatePersonDataTransferLineDateOfBirth(
+                    remotePersonDataTransferLine.dateOfBirth
+                  );
+                  const fullName = validatePersonDataTransferLineFullName(
+                    remotePersonDataTransferLine.fullName
+                  );
+                  const gender = validatePersonDataTransferLineGender(
+                    remotePersonDataTransferLine.gender
+                  );
+                  const personalEmail = validatePersonDataTransferLinePersonalEmail(
+                    remotePersonDataTransferLine.personalEmail
+                  );
+                  const personalPhone = validatePersonDataTransferLinePersonalPhone(
+                    remotePersonDataTransferLine.personalPhone
                   );
                   const residentialAddress = validatePersonDataTransferLineResidentialAddress(
-                    myobPersonDataTransferLine.residentialAddress
+                    remotePersonDataTransferLine.residentialAddress
                   );
+                  const dataImport = await getDataImport();
                   await worknice.createPersonDataImportLine({
                     bankAccounts,
                     config: {
                       bankAccounts: config.syncFields?.bankAccounts ?? false,
+                      dateOfBirth: config.syncFields?.dateOfBirth ?? false,
                       emergencyContacts: config.syncFields?.emergencyContacts ?? false,
-                      personalDetails: config.syncFields?.personalDetails ?? false,
-                      postalAddress: config.syncFields?.personalDetails ?? false,
+                      fullName: config.syncFields?.fullName ?? false,
+                      gender: config.syncFields?.gender ?? false,
+                      personalEmail: config.syncFields?.personalEmail ?? false,
+                      personalPhone: config.syncFields?.personalPhone ?? false,
+                      postalAddress: config.syncFields?.postalAddress ?? false,
                       profile: config.syncFields?.profile ?? false,
                       remuneration: config.syncFields?.remuneration ?? false,
                       residentialAddress: config.syncFields?.residentialAddress ?? false,
@@ -328,8 +359,12 @@ ${error instanceof Error ? error.message : error}
                       tenure: config.syncFields?.tenure ?? false
                     },
                     dataImportId: dataImport.id,
+                    dateOfBirth,
                     emergencyContacts: null,
-                    personalDetails,
+                    fullName,
+                    gender,
+                    personalEmail,
+                    personalPhone,
                     personId: worknicePerson.id,
                     postalAddress: null,
                     residentialAddress,
@@ -343,70 +378,93 @@ ${error instanceof Error ? error.message : error}
                   logger.info(`Updated person "${worknicePerson.displayName}" in Worknice.`);
                 } catch (error) {
                   logger.info(
-                    `Unable to update person "${worknicePerson.displayName}" in Worknice because of the following error:
-
-${error instanceof Error ? error.message : error}
-`
+                    `Unable to update person "${worknicePerson.displayName}" in Worknice because of the following error:`
                   );
+                  logger.error(error);
                 }
               }
             }
           }
           logger.dedent("Finished updating people with connections marked as merged.");
-          logger.indent("Merging unmerged connections\u2026");
-          const connectedConnections = personConnections.filter(
-            (personConnection) => personConnection.status === ConnectionStatus.Connected
+        }
+        logger.indent("Merging unmerged connections\u2026");
+        const connectedConnections = personConnections.filter(
+          (personConnection) => personConnection.status === ConnectionStatus.Connected
+        );
+        for (const personConnection of connectedConnections) {
+          const worknicePerson = people.find(
+            (person) => person.id === personConnection.person.id
           );
-          for (const personConnection of connectedConnections) {
-            const worknicePerson = people.find(
-              (person) => person.id === personConnection.person.id
-            );
-            const remotePerson = remotePeople.find(
-              (person) => person.metadata.sourceId === personConnection.remote.id
+          const remotePerson = remotePeople.find(
+            (person) => person.metadata.sourceId === personConnection.remote.id
+          );
+          if (!worknicePerson) {
+            throw Error(
+              `Unable to find person in Worknice with the ID "${personConnection.person.id}".`
             );
-            if (!worknicePerson) {
-              throw Error(
-                `Unable to find person in Worknice with the ID "${personConnection.person.id}".`
-              );
-            }
-            if (!remotePerson) {
-              throw Error(
-                `Unable to find person in ${config.appName} with the ID "${personConnection.remote.id}".`
-              );
-            }
-            const remotePersonName = personToName(remotePerson);
-            logger.indent(
-              `Merging Worknice person "${worknicePerson.displayName}" with ${config.appName} person "${remotePersonName}"\u2026`
+          }
+          if (!remotePerson) {
+            throw Error(
+              `Unable to find person in ${config.appName} with the ID "${personConnection.remote.id}".`
             );
-            try {
+          }
+          const remotePersonName = personToName(remotePerson);
+          logger.indent(
+            `Merging Worknice person "${worknicePerson.displayName}" with ${config.appName} person "${remotePersonName}"\u2026`
+          );
+          try {
+            if (config.mode === "one-way" || config.mode === "two-way") {
               const worknicePersonUpdatedAt = Temporal.Instant.from(worknicePerson.updatedAt);
-              const myobEmployeeUpdatedAt = Temporal.PlainDateTime.from(
+              if (!isValidInstant(remotePerson.metadata.updatedAt)) {
+                throw Error(
+                  `Invalid updatedAt value for ${config.appName} person "${remotePersonName}". Must be in ISO 8601 format, including a date, a time, and a time zone offset.`,
+                  {
+                    cause: Error(`Unable to parse: ${remotePerson.metadata.updatedAt}`)
+                  }
+                );
+              }
+              const remotePersonUpdatedAt = Temporal.Instant.from(
                 remotePerson.metadata.updatedAt
-              ).toZonedDateTime(Temporal.TimeZone.from("UTC")).toInstant();
-              const [primaryDataTransferLine, secondaryDataTransferLine] = isAfter(
+              );
+              const [primaryDataTransferLine, secondaryDataTransferLine] = isInstantAfter(
                 worknicePersonUpdatedAt,
-                myobEmployeeUpdatedAt
+                remotePersonUpdatedAt
               ) ? [worknicePersonToPersonDataTransferLine(worknicePerson), remotePerson] : [remotePerson, worknicePersonToPersonDataTransferLine(worknicePerson)];
               const mergedDataTransferLine = mergePersonDataTransferLines(
                 primaryDataTransferLine,
                 secondaryDataTransferLine
               );
-              const personalDetails = validatePersonDataTransferLinePersonalDetails(
-                mergedDataTransferLine.personalDetails
-              );
               const bankAccounts = validatePersonDataTransferLineBankAccounts(
                 mergedDataTransferLine.bankAccounts
               );
+              const dateOfBirth = validatePersonDataTransferLineDateOfBirth(
+                mergedDataTransferLine.dateOfBirth
+              );
+              const fullName = validatePersonDataTransferLineFullName(
+                mergedDataTransferLine.fullName
+              );
+              const gender = validatePersonDataTransferLineGender(mergedDataTransferLine.gender);
+              const personalEmail = validatePersonDataTransferLinePersonalEmail(
+                mergedDataTransferLine.personalEmail
+              );
+              const personalPhone = validatePersonDataTransferLinePersonalPhone(
+                mergedDataTransferLine.personalPhone
+              );
               const residentialAddress = validatePersonDataTransferLineResidentialAddress(
                 mergedDataTransferLine.residentialAddress
               );
+              const dataImport = await getDataImport();
               await worknice.createPersonDataImportLine({
                 bankAccounts,
                 config: {
                   bankAccounts: config.syncFields?.bankAccounts ?? false,
+                  dateOfBirth: config.syncFields?.dateOfBirth ?? false,
                   emergencyContacts: config.syncFields?.emergencyContacts ?? false,
-                  personalDetails: config.syncFields?.personalDetails ?? false,
-                  postalAddress: config.syncFields?.personalDetails ?? false,
+                  fullName: config.syncFields?.fullName ?? false,
+                  gender: config.syncFields?.gender ?? false,
+                  personalEmail: config.syncFields?.personalEmail ?? false,
+                  personalPhone: config.syncFields?.personalPhone ?? false,
+                  postalAddress: config.syncFields?.postalAddress ?? false,
                   profile: config.syncFields?.profile ?? false,
                   remuneration: config.syncFields?.remuneration ?? false,
                   residentialAddress: config.syncFields?.residentialAddress ?? false,
@@ -415,8 +473,12 @@ ${error instanceof Error ? error.message : error}
                   tenure: config.syncFields?.tenure ?? false
                 },
                 dataImportId: dataImport.id,
+                dateOfBirth,
                 emergencyContacts: null,
-                personalDetails,
+                fullName,
+                gender,
+                personalEmail,
+                personalPhone,
                 personId: worknicePerson.id,
                 postalAddress: null,
                 residentialAddress,
@@ -453,82 +515,83 @@ ${error instanceof Error ? error.message : error}
                 );
                 logger.info(`Updated person "${remotePersonName}" in ${config.appName}.`);
               }
-              await worknice.updatePersonConnection({
-                personConnectionId: personConnection.id,
-                personId: personConnection.person.id,
-                remote: {
-                  id: remotePerson.metadata.sourceId,
-                  name: remotePersonName
-                },
-                status: ConnectionStatus.Merged
-              });
-              logger.dedent(`Finished merging.`);
-            } catch (error) {
-              logger.info(
-                `Unable to merge ${config.appName} person "${remotePersonName}" and Worknice person "${worknicePerson.displayName}" because of the following error:
-
-${error instanceof Error ? error.message : error}
-`
-              );
-              logger.dedent();
             }
+            await worknice.updatePersonConnection({
+              personConnectionId: personConnection.id,
+              personId: personConnection.person.id,
+              remote: {
+                id: remotePerson.metadata.sourceId,
+                name: remotePersonName
+              },
+              status: ConnectionStatus.Merged
+            });
+            logger.dedent(`Finished merging.`);
+          } catch (error) {
+            logger.info(
+              `Unable to merge ${config.appName} person "${remotePersonName}" and Worknice person "${worknicePerson.displayName}" because of the following error:`
+            );
+            logger.error(error);
+            logger.dedent();
           }
-          logger.dedent("Finished merging unmerged connections.");
-          if (config.mode === "two-way") {
-            logger.indent(`Adding new people to ${config.appName}\u2026`);
-            const localOnlyConnections = personConnections.filter(
-              (personConnection) => personConnection.status === ConnectionStatus.LocalOnly
+        }
+        logger.dedent("Finished merging unmerged connections.");
+        if (config.mode === "two-way") {
+          logger.indent(`Adding new people to ${config.appName}\u2026`);
+          const localOnlyConnections = personConnections.filter(
+            (personConnection) => personConnection.status === ConnectionStatus.LocalOnly
+          );
+          for (const personConnection of localOnlyConnections) {
+            const worknicePerson = people.find(
+              (person) => person.id === personConnection.person.id
             );
-            for (const personConnection of localOnlyConnections) {
-              const worknicePerson = people.find(
-                (person) => person.id === personConnection.person.id
+            if (!worknicePerson) {
+              throw Error(
+                `Unable to find person in Worknice with the ID "${personConnection.person.id}".`
               );
-              if (!worknicePerson) {
+            }
+            try {
+              if (!createRemotePerson) {
                 throw Error(
-                  `Unable to find person in Worknice with the ID "${personConnection.person.id}".`
+                  "No createRemotePerson function supplied to handleTriggerIntegrationSyncWebhook."
                 );
               }
-              try {
-                if (!createRemotePerson) {
-                  throw Error(
-                    "No createRemotePerson function supplied to handleTriggerIntegrationSyncWebhook."
-                  );
-                }
-                const remote = await createRemotePerson(
-                  {
-                    ...worknicePersonToPersonDataTransferLine(worknicePerson),
-                    metadata: {
-                      deleted: false,
-                      employeeCode: worknicePerson.employeeCode ?? null,
-                      sourceId: worknicePerson.id,
-                      targetId: null,
-                      updatedAt: worknicePerson.updatedAt
-                    },
-                    profile: {
-                      displayName: worknicePerson.displayName,
-                      profileEmail: worknicePerson.profileEmail ?? null
-                    }
+              const remote = await createRemotePerson(
+                {
+                  ...worknicePersonToPersonDataTransferLine(worknicePerson),
+                  metadata: {
+                    deleted: false,
+                    employeeCode: worknicePerson.employeeCode ?? null,
+                    sourceId: worknicePerson.id,
+                    targetId: null,
+                    updatedAt: worknicePerson.updatedAt
                   },
-                  contextWithIntegration
-                );
-                await worknice.updatePersonConnection({
-                  personConnectionId: personConnection.id,
-                  personId: personConnection.person.id,
-                  remote,
-                  status: ConnectionStatus.Merged
-                });
-                logger.info(`Added new person "${remote.name}" to ${config.appName}.`);
-              } catch (error) {
-                logger.info(
-                  `Unable to add person "${worknicePerson.displayName}" in Worknice to ${config.appName} because of the following error:
-
-${error instanceof Error ? error.message : error}
-`
+                  profile: {
+                    displayName: worknicePerson.displayName,
+                    profileEmail: worknicePerson.profileEmail ?? null
+                  }
+                },
+                contextWithIntegration
+              );
+              if (personConnections.some((connection) => connection.remote?.id === remote.id)) {
+                throw Error(
+                  `A connection already exists for the ${config.appName} person "${remote.name}".`
                 );
               }
+              await worknice.updatePersonConnection({
+                personConnectionId: personConnection.id,
+                personId: personConnection.person.id,
+                remote,
+                status: ConnectionStatus.Merged
+              });
+              logger.info(`Added new person "${remote.name}" to ${config.appName}.`);
+            } catch (error) {
+              logger.info(
+                `Unable to add person "${worknicePerson.displayName}" in Worknice to ${config.appName} because of the following error:`
+              );
+              logger.error(error);
             }
-            logger.dedent(`Finished adding new people to ${config.appName}.`);
           }
+          logger.dedent(`Finished adding new people to ${config.appName}.`);
         }
         await worknice.completeSync({ integrationId: payload.integrationId });
         logger.info("Sync completed.");
@@ -537,13 +600,19 @@ ${error instanceof Error ? error.message : error}
         throw error;
       }
     },
-    parsePayload: async ({ request: request2 }) => request2.json()
+    parseRequest: async (context) => {
+      const payload = await context.request.json();
+      return {
+        env: await getEnv({ ...context, payload }),
+        payload
+      };
+    }
   },
   options
 );
 const personToName = (person) => {
-  if ((person.personalDetails?.givenName ?? "").trim() !== "" && (person.personalDetails?.familyName ?? "").trim() !== "") {
-    return `${person.personalDetails?.givenName} ${person.personalDetails?.familyName}`;
+  if ((person.fullName?.givenName ?? "").trim() !== "" && (person.fullName?.familyName ?? "").trim() !== "") {
+    return `${person.fullName?.givenName} ${person.fullName?.familyName}`;
   }
   if ((person.profile?.displayName ?? "").trim() !== "") {
     return `${person.profile?.displayName}`;
@@ -578,15 +647,21 @@ const worknicePersonToPersonDataTransferLine = (worknicePerson) => ({
     bankAccount5Name: worknicePerson.bankAccount5Name ?? null,
     bankAccount5Number: worknicePerson.bankAccount5Number ?? null
   } : null,
+  dateOfBirth: worknicePerson.dateOfBirth ? { dateOfBirth: worknicePerson.dateOfBirth } : null,
   emergencyContacts: null,
-  personalDetails: worknicePerson.givenName ? {
-    dateOfBirth: worknicePerson.dateOfBirth ?? null,
+  fullName: worknicePerson.givenName ? {
     familyName: worknicePerson.familyName ?? null,
-    gender: worknicePerson.gender ?? null,
     givenName: worknicePerson.givenName ?? null,
-    otherGivenNames: worknicePerson.otherGivenNames ?? null,
-    personalEmail: worknicePerson.personalEmail ?? null,
-    personalPhone: worknicePerson.personalPhone ?? null
+    otherGivenNames: worknicePerson.otherGivenNames ?? null
+  } : null,
+  gender: worknicePerson.gender ? {
+    gender: worknicePerson.gender
+  } : null,
+  personalEmail: worknicePerson.personalEmail ? {
+    personalEmail: worknicePerson.personalEmail
+  } : null,
+  personalPhone: worknicePerson.personalPhone ? {
+    personalPhone: worknicePerson.personalPhone
   } : null,
   postalAddress: null,
   residentialAddress: worknicePerson.residentialAddressLine1 ? {