@plusscommunities/pluss-maintenance-aws 2.1.45 → 2.1.46

package/requests/getExternalSync.js

@@ -31,117 +31,117 @@ const { values } = require("../values.config");
  * - 500: Internal server error
  */
 module.exports = async (event, params) => {
-  const data = params || event.queryStringParameters || {};
-  const logId = log("getExternalSync", "Params", data);
+	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" },
-    };
-  }
+	// 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" },
-      };
-    }
+	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" },
-      };
-    }
+		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
-    );
+		// 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
-    );
+		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" },
-        };
-      }
-    }
+		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);
+		log("getExternalSync", "Authorised", true, logId);
 
-    let externalSync = null;
-    const query = await indexQuery("externalentities", {
-      IndexName: "OnlyInternalIdIndex",
-      KeyConditionExpression: "InternalId = :internalId",
-      ExpressionAttributeValues: {
-        ":internalId": request.id,
-      },
-    });
+		let externalSync = null;
+		const query = await indexQuery("externalentities", {
+			IndexName: "OnlyInternalIdIndex",
+			KeyConditionExpression: "InternalId = :internalId",
+			ExpressionAttributeValues: {
+				":internalId": request.id,
+			},
+		});
 
-    log("getExternalSync", "Results", query.Items.length, logId);
+		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 || {},
-      };
+		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);
-    }
+			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" },
-      };
-    }
+		// 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 },
-    };
-  }
+		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/getPropertyRequests.js

@@ -0,0 +1,89 @@
+const { log } = require("@plusscommunities/pluss-core-aws/helper");
+const validateMasterAuth = require("@plusscommunities/pluss-core-aws/helper/auth/validateMasterAuth");
+const validateSiteAccess = require("@plusscommunities/pluss-core-aws/helper/auth/validateSiteAccess");
+const indexQuery = require("@plusscommunities/pluss-core-aws/db/common/indexQuery");
+const { values } = require("../values.config");
+
+/**
+ * Shape a maintenance record into the trimmed request contract the admin consumes.
+ *
+ * @param {object} record - raw maintenance DynamoDB item
+ * @returns {object} the trimmed request
+ */
+function toRequest(record) {
+	return {
+		id: record.id,
+		jobId: record.jobId ?? null,
+		jobNo: typeof record.jobNo === "number" ? record.jobNo : null,
+		title: record.title ?? null,
+		status: record.status ?? null,
+		type: record.type ?? null,
+		// Denormalised property name for linked requests, free-text otherwise.
+		room: record.room ?? null,
+		timeCreated: record.createdTime ?? null,
+		createdUnix:
+			typeof record.createdUnix === "number" ? record.createdUnix : null,
+		webPath: record.id
+			? values.routeEntityPath.replace(":id", record.id)
+			: null,
+	};
+}
+
+/**
+ * List maintenance requests linked to a property, newest first.
+ *
+ * @param {object} event - API Gateway event
+ * @returns {Promise<{status: number, data: {requests: object[]}|{error: string}}>} request list or error payload
+ */
+module.exports = async (event) => {
+	const qParams = event.queryStringParameters || {};
+	const { site, propertyId } = qParams;
+	const logId = log("getPropertyRequests", "Params", qParams);
+
+	if (!site || !propertyId) {
+		return { status: 422, data: { error: "Insufficient input" } };
+	}
+
+	const hasSiteAccess = await validateSiteAccess(event, site);
+	if (!hasSiteAccess) {
+		return { status: 403, data: { error: "Not authorised" } };
+	}
+	const authorised = await validateMasterAuth(
+		event,
+		values.permissionMaintenanceTracking,
+		site,
+	);
+	if (!authorised) {
+		return { status: 403, data: { error: "Not authorised" } };
+	}
+
+	// Paginate fully so results aren't truncated at DynamoDB's 1MB scan boundary.
+	// Paged locally (not indexQueryRecursive) so a query failure rejects into the
+	// router's 500 instead of hanging the request.
+	const items = [];
+	let lastKey;
+	do {
+		const query = {
+			IndexName: "MaintenancePropertyIdIndex",
+			KeyConditionExpression: "propertyId = :propertyId",
+			FilterExpression: "site = :site",
+			ExpressionAttributeValues: {
+				":propertyId": propertyId,
+				":site": site,
+			},
+		};
+		if (lastKey) {
+			query.ExclusiveStartKey = lastKey;
+		}
+		const page = await indexQuery(values.tableNameMaintenance, query);
+		items.push(...(page.Items || []));
+		lastKey = page.LastEvaluatedKey;
+	} while (lastKey);
+	// Newest first.
+	const requests = items
+		.map(toRequest)
+		.sort((a, b) => (b.createdUnix || 0) - (a.createdUnix || 0));
+
+	log("getPropertyRequests", "ResponseLength", requests.length, logId);
+	return { status: 200, data: { requests } };
+};

package/requests/getRequest.js

@@ -7,83 +7,83 @@ const getSessionUserFromReqAuthKey = require("@plusscommunities/pluss-core-aws/h
 const { values } = require("../values.config");
 
 module.exports = async (event, params) => {
-  const data = params || event.queryStringParameters;
-  const logId = log("getRequest", "Params", data);
-  if (!data.id && (!data.site || !data.jobId)) {
-    return {
-      status: 422,
-      data: {
-        error: "Insufficient input",
-      },
-    };
-  }
+	const data = params || event.queryStringParameters;
+	const logId = log("getRequest", "Params", data);
+	if (!data.id && (!data.site || !data.jobId)) {
+		return {
+			status: 422,
+			data: {
+				error: "Insufficient input",
+			},
+		};
+	}
 
-  try {
-    let result = null;
-    if (data.jobId) {
-      const query = {
-        IndexName: "MaintenanceSiteJobIdIndex",
-        KeyConditionExpression: "site = :site and jobId = :jobId",
-        ExpressionAttributeValues: {
-          ":site": data.site,
-          ":jobId": data.jobId,
-        },
-      };
-      const { Items } = await indexQuery(values.tableNameMaintenance, query);
-      result = Items[0];
-    }
-    if (!result) {
-      result = await getRef(
-        values.tableNameMaintenance,
-        "id",
-        data.id || data.jobId
-      );
-    }
+	try {
+		let result = null;
+		if (data.jobId) {
+			const query = {
+				IndexName: "MaintenanceSiteJobIdIndex",
+				KeyConditionExpression: "site = :site and jobId = :jobId",
+				ExpressionAttributeValues: {
+					":site": data.site,
+					":jobId": data.jobId,
+				},
+			};
+			const { Items } = await indexQuery(values.tableNameMaintenance, query);
+			result = Items[0];
+		}
+		if (!result) {
+			result = await getRef(
+				values.tableNameMaintenance,
+				"id",
+				data.id || data.jobId,
+			);
+		}
 
-    const authorised = await validateMasterAuth(
-      event,
-      values.permissionMaintenanceTracking,
-      result.site
-    );
-    const assignAuthorised = await isValidAssignee(
-      event,
-      result.site,
-      result.AssigneeId
-    );
-    if (!authorised && !assignAuthorised) {
-      // Check if the job belongs to the user
-      const userId = await getSessionUserFromReqAuthKey(event);
-      if (userId !== result.userID) {
-        return {
-          status: 403,
-          data: {
-            error: "Not authorised",
-          },
-        };
-      }
-    }
-    if (data.includeComments) {
-      const commentsQuery = {
-        IndexName: "CommentsEntityIdIndex",
-        KeyConditionExpression: "EntityId = :groupId",
-        ExpressionAttributeValues: {
-          ":groupId": getRowId(result.id, values.entityKey),
-        },
-      };
-      const commentsData = await indexQuery("comments", commentsQuery);
-      result.Comments = commentsData.Items;
-    }
-    return {
-      status: 200,
-      data: result,
-    };
-  } catch (error) {
-    log("getRequest", "Error", error.toString(), logId);
-  }
-  return {
-    status: 500,
-    data: {
-      error: "Internal error",
-    },
-  };
+		const authorised = await validateMasterAuth(
+			event,
+			values.permissionMaintenanceTracking,
+			result.site,
+		);
+		const assignAuthorised = await isValidAssignee(
+			event,
+			result.site,
+			result.AssigneeId,
+		);
+		if (!authorised && !assignAuthorised) {
+			// Check if the job belongs to the user
+			const userId = await getSessionUserFromReqAuthKey(event);
+			if (userId !== result.userID) {
+				return {
+					status: 403,
+					data: {
+						error: "Not authorised",
+					},
+				};
+			}
+		}
+		if (data.includeComments) {
+			const commentsQuery = {
+				IndexName: "CommentsEntityIdIndex",
+				KeyConditionExpression: "EntityId = :groupId",
+				ExpressionAttributeValues: {
+					":groupId": getRowId(result.id, values.entityKey),
+				},
+			};
+			const commentsData = await indexQuery("comments", commentsQuery);
+			result.Comments = commentsData.Items;
+		}
+		return {
+			status: 200,
+			data: result,
+		};
+	} catch (error) {
+		log("getRequest", "Error", error.toString(), logId);
+	}
+	return {
+		status: 500,
+		data: {
+			error: "Internal error",
+		},
+	};
 };

package/requests/helper/hasRequestPermission.js

@@ -10,16 +10,16 @@ const isValidAssignee = require("./isValidAssignee");
 const { values } = require("../../values.config");
 
 module.exports = async (event, job) => {
-  const valid = await validateMasterAuth(
-    event,
-    values.permissionMaintenanceTracking,
-    job.site
-  );
-  if (valid) {
-    return true;
-  }
-  if (!job.AssigneeId) {
-    return false;
-  }
-  return await isValidAssignee(event, job.site, job.AssigneeId);
+	const valid = await validateMasterAuth(
+		event,
+		values.permissionMaintenanceTracking,
+		job.site,
+	);
+	if (valid) {
+		return true;
+	}
+	if (!job.AssigneeId) {
+		return false;
+	}
+	return await isValidAssignee(event, job.site, job.AssigneeId);
 };

package/requests/helper/isValidAssignee.js

@@ -10,14 +10,14 @@ const { values } = require("../../values.config");
  * @returns {Boolean} true if valid
  */
 module.exports = async (event, site, userId) => {
-  const valid = await validateMasterAuth(
-    event,
-    values.permissionMaintenanceAssignment,
-    site
-  );
-  if (!valid) {
-    return false;
-  }
-  const loggedInUser = await getSessionUserFromReqAuthKey(event);
-  return loggedInUser === userId;
+	const valid = await validateMasterAuth(
+		event,
+		values.permissionMaintenanceAssignment,
+		site,
+	);
+	if (!valid) {
+		return false;
+	}
+	const loggedInUser = await getSessionUserFromReqAuthKey(event);
+	return loggedInUser === userId;
 };