chore: update formatRawProjectTypes to reference schema instead of …

…static database table (#445)

package.json

@@ -47,8 +47,8 @@
   "dependencies": {
     "@emotion/react": "^11.11.4",
     "@emotion/styled": "^11.11.5",
+    "@formatjs/intl-listformat": "^7.5.7",
     "@mui/material": "^5.15.2",
-    "@types/geojson": "^7946.0.14",
     "ajv": "^8.16.0",
     "ajv-formats": "^2.1.1",
     "cheerio": "1.0.0-rc.12",
@@ -69,6 +69,7 @@
     "zod": "^3.23.8"
   },
   "devDependencies": {
+    "@types/geojson": "^7946.0.14",
     "@types/jest": "^29.5.12",
     "@types/lodash": "^4.17.6",
     "@types/node": "^18.16.19",

src/requests/index.ts

@@ -9,7 +9,6 @@ import {
 import { FlowClient } from "./flow";
 import { Auth, getGraphQLClient } from "./graphql";
 import { PaymentRequestClient } from "./payment-request";
-import { formatRawProjectTypes } from "./project-types";
 import { SessionClient } from "./session";
 import { TeamClient } from "./team";
 import { UserClient } from "./user";
@@ -68,15 +67,4 @@ export class CoreDomainClient {
   ): Promise<string[]> {
     return getDocumentTemplateNamesForSession(this.client, sessionId);
   }
-
-  /**
-   * Convert and formats raw project types as a formatted list
-   * @example
-   * const result = formatRawProjectTypes(["swimmingPool.addition", "extension.rear", "window.new"])
-   * console.log(result)
-   * // Logs "Addition of a swimming pool, rear extension, and new window installation"
-   */
-  async formatRawProjectTypes(rawProjectTypes: string[] = []): Promise<string> {
-    return formatRawProjectTypes(this.client, rawProjectTypes);
-  }
 }

src/utils/index.ts

@@ -1,3 +1,4 @@
 export * from "./digitalPlanningSchema";
 export * from "./encryption";
 export * from "./govPayMetadata";
+export * from "./projectTypes";

src/utils/projectTypes.test.ts

@@ -0,0 +1,47 @@
+import {
+  formatHumanReadableProjectTypes,
+  formatRawProjectTypes,
+} from "./projectTypes";
+
+describe("formatRawProjectTypes()", () => {
+  it("correctly displays the schema descriptions for a list of valid raw project types", () => {
+    const result = formatRawProjectTypes([
+      "alter.boundary.add.gate",
+      "alter.equipment.charging",
+      "extend.outbuilding.swimmingPool",
+    ]);
+    expect(result).toEqual(
+      "Add a new gate, install a car charging point, and add an outbuilding - swimming pool",
+    );
+  });
+
+  it("returns 'Unknown' if none of the raw project types are supported by the schema", () => {
+    const result = formatRawProjectTypes(["alter.typo", "new.typo"]);
+    expect(result).toEqual("Unknown");
+  });
+
+  it("skips invalid raw project types and correctly shows descriptions of valid ones", () => {
+    const result = formatRawProjectTypes([
+      "alter.typo",
+      "alter.boundary.add.gate",
+      "alter.equipment.charging",
+    ]);
+    expect(result).toEqual("Add a new gate and install a car charging point");
+  });
+});
+
+describe("formatHumanReadableProjectTypes()", () => {
+  it("returns a correctly formatted string", () => {
+    const result = formatHumanReadableProjectTypes([
+      "first",
+      "second",
+      "third",
+    ]);
+    expect(result).toEqual("First, second, and third");
+  });
+
+  it("returns an empty string if no raw project types are provided", () => {
+    const result = formatHumanReadableProjectTypes([]);
+    expect(result).toEqual("");
+  });
+});

src/utils/projectTypes.ts

@@ -0,0 +1,31 @@
+import "@formatjs/intl-listformat/locale-data/en";
+import "@formatjs/intl-listformat/polyfill";
+
+import { getValidSchemaDictionary } from "./digitalPlanningSchema";
+
+export function formatRawProjectTypes(rawProjectTypes: string[]): string {
+  const schemaProjectTypes = getValidSchemaDictionary("ProjectType");
+  if (schemaProjectTypes) {
+    const matchingDescriptions = Object.entries(schemaProjectTypes)
+      .filter(([key, _description]) => rawProjectTypes.includes(key))
+      .map(([_key, description]) => description.toLocaleLowerCase());
+    if (matchingDescriptions.length === 0) {
+      return "Unknown";
+    }
+    return formatHumanReadableProjectTypes(matchingDescriptions);
+  } else {
+    return "Unknown";
+  }
+}
+
+export function formatHumanReadableProjectTypes(
+  projectTypes: string[],
+): string {
+  // Join in readable format - en-US ensures we use Oxford commas
+  const formatter = new Intl.ListFormat("en-US", { type: "conjunction" });
+  const joinedList = formatter.format(projectTypes);
+  // Convert first character to uppercase
+  const formattedProjectTypes =
+    joinedList.charAt(0).toUpperCase() + joinedList.slice(1);
+  return formattedProjectTypes;
+}