@plusscommunities/pluss-maintenance-aws-forms 2.1.20 → 2.1.21-auth.0

package/integration/index.js

@@ -1,6 +1,7 @@
 const getString = require("@plusscommunities/pluss-core-aws/db/strings/getString");
 const { getRowId, log } = require("@plusscommunities/pluss-core-aws/helper");
 const ArchibusStrategy = require("./archibus/ArchibusStrategy");
+const SeeStuffStrategy = require("./seestuff/SeeStuffStrategy");
 const IntegrationStrategy = require("./IntegrationStrategy");
 const { values } = require("../values.config");
 
@@ -16,6 +17,8 @@ exports.getStrategy = async (site) => {
     switch (importConfig.Strategy) {
       case "Archibus":
         return new ArchibusStrategy(importConfig);
+      case "SeeStuff":
+        return new SeeStuffStrategy(importConfig);
       default:
         return new IntegrationStrategy();
     }

package/integration/seestuff/SeeStuffStrategy.js

@@ -0,0 +1,298 @@
+const axios = require("axios");
+const moment = require("moment");
+const _ = require("lodash");
+const IntegrationStrategy = require("../IntegrationStrategy");
+const { log, getRowId } = require("@plusscommunities/pluss-core-aws/helper");
+const editRef = require("@plusscommunities/pluss-core-aws/db/common/editRef");
+const updateRef = require("@plusscommunities/pluss-core-aws/db/common/updateRef");
+const getRef = require("@plusscommunities/pluss-core-aws/db/common/getRef");
+const indexQuery = require("@plusscommunities/pluss-core-aws/db/common/indexQuery");
+const { values } = require("../../values.config");
+
+class SeeStuffStrategy extends IntegrationStrategy {
+	constructor(config) {
+		super();
+		this.baseUrl = config.BaseUrl; // base URL for the API
+		this.apiKeyHeader = config.APIKeyHeader; // header to use for API key
+		this.apiKey = config.APIKey; // API key
+
+		const url = new URL(this.baseUrl);
+		this.host = url.host;
+
+		this.siteMap = config.SiteMap ?? {};
+	}
+
+	/**
+	 * Gets the entity type for the integration
+	 *
+	 * @returns {String} The entity type for the integration
+	 */
+	getEntityType = () => {
+		return `${values.serviceKey}_SeeStuff`;
+	};
+
+	/**
+	 * Validates the integration
+	 *
+	 * @returns {Boolean} Whether the integration is valid
+	 */
+	isValidIntegration = () => {
+		return true;
+	};
+
+	/**
+	 * Gets the refresh interval for the SeeStuff system
+	 *
+	 * @returns {Number} The refresh interval in milliseconds
+	 */
+	getRefreshInterval = () => {
+		return Number.MAX_SAFE_INTEGER; // should never refresh
+	};
+
+	/**
+	 * Creates a request in the SeeStuff system
+	 *
+	 * @param {Object} request - Request definition on Pluss
+	 * @param {Object} mockResponse - Mock response from SeeStuff to simulate response
+	 * @returns {Boolean} Whether the request was created on SeeStuff
+	 */
+	createRequest = async (request, mockResponse = null) => {
+		const logId = log("SeeStuff:CreateRequest", "Start", request);
+
+		try {
+			// Get user details for room/address and CRMID
+			let userRoom = request.room || "";
+			let crmResidentId = "";
+
+			// Map site to location code if available
+			const location = this.siteMap[request.site];
+			if (!location) {
+				log("SeeStuff:CreateRequest", "LocationNotFound", request.site, logId);
+				return false;
+			}
+
+			if (request.userID) {
+				try {
+					// Look up user from users table
+					const user = await getRef("users", "Id", request.userID);
+					log("SeeStuff:CreateRequest", "User", user, logId);
+
+					if (user) {
+						// Get user's address/room
+						if (user.unit) {
+							userRoom = user.unit;
+						}
+
+						// Get CRMID from user fields
+						try {
+							const crmIdField = await getRef(
+								"userfields",
+								"RowId",
+								getRowId(request.userID, "CRMID"),
+							);
+							if (crmIdField && crmIdField.Value) {
+								crmResidentId = crmIdField.Value;
+							}
+							log("SeeStuff:CreateRequest", "CRMID", crmResidentId, logId);
+						} catch (fieldError) {
+							log(
+								"SeeStuff:CreateRequest",
+								"CRMIDLookupError",
+								fieldError,
+								logId,
+							);
+						}
+					}
+				} catch (userError) {
+					log("SeeStuff:CreateRequest", "UserLookupError", userError, logId);
+				}
+			}
+
+			if (_.isEmpty(crmResidentId)) {
+				// log an issue in the history
+				throw new Error("NoCRMResidentId");
+			}
+
+			// Format description similar to Archibus
+			const description = `${request.title}${
+				_.isEmpty(request.description) ? "" : `\n\n${request.description}`
+			}${_.isEmpty(request.room) ? "" : `\n\nLocation: ${request.room}`}${
+				_.isEmpty(request.userName) ? "" : `\n\nJob Type: ${request.type}`
+			}${
+				_.isEmpty(request.images)
+					? ""
+					: `\n\nImages: ${request.images.join("\n")}`
+			}`;
+
+			// Format date_reported
+			const dateReported = moment().format("YYYY-MM-DD HH:mm:ss");
+
+			// Build payload
+			const data = {
+				externalId: request.id,
+				description: description,
+				priority: "P3",
+				location: location,
+				room: userRoom,
+				date_reported: dateReported,
+				crmResidentId: crmResidentId,
+			};
+
+			log("SeeStuff:CreateRequest", "Request", data, logId);
+
+			const response =
+				mockResponse ??
+				(await axios({
+					method: "POST",
+					url: `${this.baseUrl}/assetmgmt/servicerequests`,
+					timeout: 30000,
+					headers: {
+						[this.apiKeyHeader]: this.apiKey,
+						"Content-Type": "application/json",
+						Host: this.host,
+					},
+					data,
+				}));
+
+			log("SeeStuff:CreateRequest", "Response", response.data, logId);
+
+			return true;
+		} catch (e) {
+			log("SeeStuff:CreateRequest", "Error", e, logId);
+
+			// Add history entry for failed integration
+			try {
+				const failedJob = await getRef(
+					values.tableNameMaintenance,
+					"id",
+					request.id,
+				);
+				if (!failedJob.history) failedJob.history = [];
+				failedJob.history.push({
+					timestamp: moment.utc().valueOf(),
+					EntryType: "ExternalIDSetFailed",
+					user: {
+						displayName: "SeeStuff Integration",
+						id: "system",
+					},
+					systemType: "SeeStuff",
+					error: e.message === "NoCRMResidentId" ? "No CRM ID found" : null,
+				});
+
+				await editRef(values.tableNameMaintenance, "id", request.id, {
+					history: failedJob.history,
+				});
+			} catch (historyError) {
+				log("SeeStuff:CreateRequest", "HistoryError", historyError, logId);
+			}
+		}
+		return false;
+	};
+
+	/**
+	 * Fetches a request from the SeeStuff system
+	 * Not implemented yet
+	 *
+	 * @param {String} externalId - Id of the request on SeeStuff
+	 * @returns {Object} The request as it exists on SeeStuff
+	 */
+	getRequest = async (externalId) => {
+		return null;
+	};
+
+	/**
+	 * Refreshes a request from the SeeStuff system
+	 * Not implemented yet
+	 *
+	 * @param {String} requestId - Id of the request on Pluss
+	 * @param {String} externalId - Id of the request on SeeStuff
+	 * @param {Object} trackedData - The set of fields tracked
+	 * @returns {Boolean} Whether the request had any changes on SeeStuff
+	 */
+	refreshFromSource = async (requestId, externalId, trackedData) => {
+		return false;
+	};
+
+	/**
+	 * Get SeeStuff Id of the request
+	 * Queries externalentities table to find the external ID
+	 *
+	 * @param {Object} request - Request definition on Pluss
+	 * @returns {String} Id of the request on SeeStuff
+	 */
+	getExternalId = async (request) => {
+		const logId = log("SeeStuff:GetExternalId", "Start", { Id: request.id });
+
+		// get external id
+		const externalEntityQuery = await indexQuery("externalentities", {
+			IndexName: "InternalIdIndex",
+			KeyConditionExpression:
+				"EntityType = :entityType AND InternalId = :internalId",
+			ExpressionAttributeValues: {
+				":entityType": this.getEntityType(),
+				":internalId": request.id,
+			},
+		});
+
+		log(
+			"SeeStuff:GetExternalId",
+			"ExternalLength",
+			externalEntityQuery.Items.length,
+			logId,
+		);
+		if (_.isEmpty(externalEntityQuery.Items)) {
+			return null;
+		}
+
+		const externalId = externalEntityQuery.Items[0].ExternalId;
+		log("SeeStuff:GetExternalId", "ExternalId", externalId, logId);
+
+		return externalId;
+	};
+
+	/**
+	 * Perform actions when a task's status has changed
+	 * Not implemented yet
+	 *
+	 * @param {Object} request - Request definition on Pluss
+	 * @returns {Boolean} Represents whether the actions were successful
+	 */
+	onStatusChanged = async (request) => {
+		return true;
+	};
+
+	/**
+	 * Perform actions when a comment has been added to a task
+	 * Not implemented yet
+	 *
+	 * @param {Object} request - Request definition on Pluss
+	 * @returns {Boolean} Represents whether the actions were successful
+	 */
+	onCommentAdded = async (request) => {
+		return true;
+	};
+
+	/**
+	 * Perform actions when a note has been added to a task
+	 * Not implemented yet
+	 *
+	 * @param {Object} request - Request definition on Pluss
+	 * @returns {Boolean} Represents whether the actions were successful
+	 */
+	onNotesAdded = async (request) => {
+		return true;
+	};
+
+	/**
+	 * Perform completion actions when a task is completed
+	 * Not implemented yet
+	 *
+	 * @param {Object} request - Request definition on Pluss
+	 * @returns {Boolean} Represents whether the actions were successful
+	 */
+	onCompleteRequest = async (request) => {
+		return true;
+	};
+}
+
+module.exports = SeeStuffStrategy;

package/jobChanged.js

@@ -43,7 +43,7 @@ const onNotesAdded = async (request) => {
 const checkIntegrationActions = async (request, prevRequest) => {
   if (
     request.ExtCreateRetry &&
-    request.ExtCreateRetry !== prevRequest.ExtCreateRetry
+    request.ExtCreateRetry > prevRequest.ExtCreateRetry
   ) {
     log("checkIntegrationActions", "Retrying", true);
     await pushRequestToIntegration(request);

package/jobTypesChanged.js

@@ -0,0 +1,55 @@
+/**
+ * DynamoDB Stream Handler for JobTypes changes
+ *
+ * Republishes any templates using this site as source.
+ * Only notifies siteConfigs for variants with enableSiteConfigsPropagation: true
+ * (maintenance and maintenanceForms). Other variants (feedback, enquiry) are excluded.
+ */
+
+const { Marshaller } = require("@aws/dynamodb-auto-marshaller");
+const marshaller = new Marshaller();
+const { log } = require("@plusscommunities/pluss-core-aws/helper");
+const notifySiteConfigs = require("@plusscommunities/pluss-core-aws/helper/notifySiteConfigs");
+const { values } = require("./values.config");
+
+module.exports.jobTypesChanged = async (event, context, callback) => {
+  const logId = log("jobTypesChanged", "Start", { recordCount: event.Records.length, serviceKey: values.serviceKey });
+
+  // Check if this variant supports siteConfigs propagation
+  if (!values.enableSiteConfigsPropagation) {
+    log("jobTypesChanged", "SkipPropagation", { serviceKey: values.serviceKey }, logId);
+    return;
+  }
+
+  const promises = [];
+
+  event.Records.forEach((record) => {
+    log("jobTypesChanged", "Record", { eventName: record.eventName }, logId);
+
+    if (record.eventName === "INSERT") {
+      const data = marshaller.unmarshallItem(record.dynamodb.NewImage);
+      log("jobTypesChanged", "Insert", { id: data.id, site: data.site }, logId);
+
+      if (data.site) {
+        promises.push(notifySiteConfigs(data.site, logId));
+      }
+    } else if (record.eventName === "MODIFY") {
+      const data = marshaller.unmarshallItem(record.dynamodb.NewImage);
+      log("jobTypesChanged", "Modify", { id: data.id, site: data.site }, logId);
+
+      if (data.site) {
+        promises.push(notifySiteConfigs(data.site, logId));
+      }
+    } else if (record.eventName === "REMOVE") {
+      const previousData = marshaller.unmarshallItem(record.dynamodb.OldImage);
+      log("jobTypesChanged", "Remove", { id: previousData.id, site: previousData.site }, logId);
+
+      if (previousData.site) {
+        promises.push(notifySiteConfigs(previousData.site, logId));
+      }
+    }
+  });
+
+  await Promise.all(promises);
+  log("jobTypesChanged", "Complete", { promiseCount: promises.length }, logId);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plusscommunities/pluss-maintenance-aws-forms",
-  "version": "2.1.20",
+  "version": "2.1.21-auth.0",
   "description": "Extension package to enable maintenance on Pluss Communities Platform",
   "scripts": {
     "gc": "node ../../tools/gc ./",
@@ -10,6 +10,9 @@
     "deploy": "npm run gc && npm run gs && serverless deploy",
     "betaupload": "rm -rf .serverless && npm i && npm publish --access public --tag beta",
     "betaupload:p": "npm run betapatch && npm run betaupload",
+    "authpatch": "npm version prepatch --preid=auth",
+    "authupload": "npm i && npm i && npm publish --access public --tag auth",
+    "authupload:p": "npm run authpatch && npm run authupload",
     "upload": "rm -rf .serverless && npm i && npm publish --access public",
     "upload:p": "npm run patch && npm run upload",
     "copy:add": "run(){ ext=${1:-default}; test -f values.config.$ext.js || cp values.config.default.js values.config.$ext.js; }; run",
@@ -17,6 +20,7 @@
     "copy:set": "run(){ target='\\@plusscommunities\\/pluss-maintenance-aws'; ext=${1:-default}; [ $ext == 'default' ] && replace=$target || replace=$target'-'$ext; echo 'Setting target to '$replace; test -f values.config.$ext.js && cp -f values.config.$ext.js values.config.js; sed -i '' -e 's/'$target'.*\"/'$replace'\"/g' package.json; }; run",
     "copy:deploy": "for file in `ls ./values.config.*.js`; do dup=`echo $file | sed 's/.*values\\.config\\.\\(.*\\)\\.js/\\1/'`; npm run copy:set $dup; npm run deploy; done; npm run copy:set; npm run gs;",
     "copy:betaupload": "npm run betapatch; for file in `ls ./values.config.*.js`; do dup=`echo $file | sed 's/.*values\\.config\\.\\(.*\\)\\.js/\\1/'`; npm run copy:set $dup; npm run betaupload; done; npm run copy:set;",
+    "copy:authupload": "npm run authpatch; for file in `ls ./values.config.*.js`; do dup=`echo $file | sed 's/.*values\\.config\\.\\(.*\\)\\.js/\\1/'`; npm run copy:set $dup; npm run authupload; done; npm run copy:set;",
     "copy:upload": "npm run patch; for file in `ls ./values.config.*.js`; do dup=`echo $file | sed 's/.*values\\.config\\.\\(.*\\)\\.js/\\1/'`; npm run copy:set $dup; npm run upload; done; npm run copy:set;",
     "test": "jest tests -i"
   },
@@ -24,7 +28,7 @@
   "license": "ISC",
   "dependencies": {
     "@aws/dynamodb-auto-marshaller": "^0.7.1",
-    "@plusscommunities/pluss-core-aws": "2.0.23",
+    "@plusscommunities/pluss-core-aws": "2.0.26-auth.0",
     "amazon-cognito-identity-js": "^2.0.19",
     "aws-sdk": "^2.1591.0",
     "axios": "^1.6.8",

package/requests/getExternalSync.js

@@ -0,0 +1,147 @@
+const getRef = require("@plusscommunities/pluss-core-aws/db/common/getRef");
+const indexQuery = require("@plusscommunities/pluss-core-aws/db/common/indexQuery");
+const validateMasterAuth = require("@plusscommunities/pluss-core-aws/helper/auth/validateMasterAuth");
+const isValidAssignee = require("./helper/isValidAssignee");
+const getSessionUserFromReqAuthKey = require("@plusscommunities/pluss-core-aws/helper/auth/getSessionUserFromReqAuthKey");
+const { log } = require("@plusscommunities/pluss-core-aws/helper");
+const { values } = require("../values.config");
+
+/**
+ * Retrieves external system sync information for a maintenance request
+ *
+ * Checks both SeeStuff and Archibus external entity tables to find
+ * if the request has been synced to an external system.
+ *
+ * @param {Object} event - Lambda event object
+ * @param {Object} params - Query parameters (optional, uses event.queryStringParameters if not provided)
+ * @returns {Object} Response object with status and data
+ *
+ * Response format (200):
+ * {
+ *   externalSystem: "SeeStuff" | "Archibus",
+ *   externalId: string,
+ *   syncedAt: number (Unix timestamp),
+ *   trackedData: object
+ * }
+ *
+ * Error responses:
+ * - 422: Missing required field (id)
+ * - 404: Request not found OR no external sync exists
+ * - 403: Not authorized (user doesn't have permission to view request)
+ * - 500: Internal server error
+ */
+module.exports = async (event, params) => {
+  const data = params || event.queryStringParameters || {};
+  const logId = log("getExternalSync", "Params", data);
+
+  // Validate input
+  if (!data.id) {
+    log("getExternalSync", "MissingId", true, logId);
+    return {
+      status: 422,
+      data: { error: "Missing required field: id" },
+    };
+  }
+
+  try {
+    // Get the request to verify it exists and get site for permission check
+    let request;
+    try {
+      request = await getRef(values.tableNameMaintenance, "id", data.id);
+    } catch (error) {
+      log("getExternalSync", "RequestNotFound", { id: data.id }, logId);
+      return {
+        status: 404,
+        data: { error: "Request not found" },
+      };
+    }
+
+    if (!request) {
+      log("getExternalSync", "RequestNotFound", { id: data.id }, logId);
+      return {
+        status: 404,
+        data: { error: "Request not found" },
+      };
+    }
+
+    // Check permissions (same pattern as getRequest.js)
+    // Three levels of access:
+    // 1. Full admin with maintenance tracking permission
+    // 2. User assigned to the request
+    // 3. User who created the request
+    const authorised = await validateMasterAuth(
+      event,
+      values.permissionMaintenanceTracking,
+      request.site
+    );
+
+    const assignAuthorised = await isValidAssignee(
+      event,
+      request.site,
+      request.AssigneeId
+    );
+
+    if (!authorised && !assignAuthorised) {
+      // Check if user is the request owner
+      const userId = await getSessionUserFromReqAuthKey(event);
+      if (userId !== request.userID) {
+        log(
+          "getExternalSync",
+          "NotAuthorised",
+          { userId, requestOwner: request.userID },
+          logId
+        );
+        return {
+          status: 403,
+          data: { error: "Not authorised" },
+        };
+      }
+    }
+
+    log("getExternalSync", "Authorised", true, logId);
+
+    let externalSync = null;
+    const query = await indexQuery("externalentities", {
+      IndexName: "OnlyInternalIdIndex",
+      KeyConditionExpression: "InternalId = :internalId",
+      ExpressionAttributeValues: {
+        ":internalId": request.id,
+      },
+    });
+
+    log("getExternalSync", "Results", query.Items.length, logId);
+
+    if (query.Items && query.Items.length > 0) {
+      const item = query.Items[0];
+      externalSync = {
+        systemType: item.SystemType,
+        externalId: item.ExternalId,
+        syncedAt: item.LastUpdated,
+        trackedData: item.TrackedData || {},
+      };
+
+      log("getExternalSync", "FoundSync", externalSync, logId);
+    }
+
+    // If no external sync found, return 404
+    if (!externalSync) {
+      log("getExternalSync", "NoSyncFound", { id: data.id }, logId);
+      return {
+        status: 404,
+        data: { error: "No external sync found" },
+      };
+    }
+
+    log("getExternalSync", "Success", externalSync, logId);
+    return {
+      status: 200,
+      data: externalSync,
+    };
+  } catch (error) {
+    log("getExternalSync", "InternalError", error.toString(), logId);
+    return {
+      status: 500,
+      data: { error: "Internal error", message: error.message },
+    };
+  }
+};

package/requests/getRequests.js

@@ -93,6 +93,12 @@ module.exports = async (event) => {
     log("getRequests", "FilteredOnType", jobs.length, logId);
   }
 
+  // filter on assignee (for users with tracking permission)
+  if (qParams.assignee) {
+    jobs = jobs.filter((j) => j.AssigneeId === qParams.assignee);
+    log("getRequests", "FilteredOnAssigneeFilter", jobs.length, logId);
+  }
+
   // filter to assigned jobs
   if (!authorised && assigneeTracking) {
     jobs = jobs.filter((j) => j.AssigneeId === userId || j.userID === userId);