@pdtf/schemas 3.6.0-43 → 3.6.0-44

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdtf/schemas",
-  "version": "3.6.0-43",
+  "version": "3.6.0-44",
   "description": "Property Data Trust Framework Schemas and Utilities",
   "main": "index.js",
   "directories": {

package/src/schemas/v3/overlays/extensions/ac.json

@@ -11,6 +11,9 @@
                   "type": "string"
                 }
               },
+              "discriminator": {
+                "propertyName": "yesNo"
+              },
               "oneOf": [
                 null,
                 {
@@ -27,6 +30,9 @@
                           "type": "string"
                         }
                       },
+                      "discriminator": {
+                        "propertyName": "yesNo"
+                      },
                       "required": [
                         "yesNo"
                       ],
@@ -39,6 +45,9 @@
                           "type": "string"
                         }
                       },
+                      "discriminator": {
+                        "propertyName": "yesNo"
+                      },
                       "required": [
                         "yesNo"
                       ],
@@ -64,6 +73,9 @@
                   "type": "string"
                 }
               },
+              "discriminator": {
+                "propertyName": "yesNo"
+              },
               "oneOf": [
                 null,
                 {
@@ -80,6 +92,9 @@
                           "type": "string"
                         }
                       },
+                      "discriminator": {
+                        "propertyName": "yesNo"
+                      },
                       "required": [
                         "yesNo"
                       ],
@@ -92,6 +107,9 @@
                           "type": "string"
                         }
                       },
+                      "discriminator": {
+                        "propertyName": "yesNo"
+                      },
                       "required": [
                         "yesNo"
                       ],
@@ -117,6 +135,9 @@
                   "type": "string"
                 }
               },
+              "discriminator": {
+                "propertyName": "yesNo"
+              },
               "oneOf": [
                 null,
                 {
@@ -133,6 +154,9 @@
                           "type": "string"
                         }
                       },
+                      "discriminator": {
+                        "propertyName": "yesNo"
+                      },
                       "required": [
                         "yesNo"
                       ],
@@ -145,6 +169,9 @@
                           "type": "string"
                         }
                       },
+                      "discriminator": {
+                        "propertyName": "yesNo"
+                      },
                       "required": [
                         "yesNo"
                       ],
@@ -170,6 +197,9 @@
                   "type": "string"
                 }
               },
+              "discriminator": {
+                "propertyName": "yesNo"
+              },
               "oneOf": [
                 null,
                 {
@@ -186,6 +216,9 @@
                           "type": "string"
                         }
                       },
+                      "discriminator": {
+                        "propertyName": "yesNo"
+                      },
                       "required": [
                         "yesNo"
                       ],
@@ -198,6 +231,9 @@
                           "type": "string"
                         }
                       },
+                      "discriminator": {
+                        "propertyName": "yesNo"
+                      },
                       "required": [
                         "yesNo"
                       ],
@@ -223,6 +259,9 @@
                   "type": "string"
                 }
               },
+              "discriminator": {
+                "propertyName": "yesNo"
+              },
               "oneOf": [
                 null,
                 {
@@ -239,6 +278,9 @@
                           "type": "string"
                         }
                       },
+                      "discriminator": {
+                        "propertyName": "yesNo"
+                      },
                       "required": [
                         "yesNo"
                       ],
@@ -251,6 +293,9 @@
                           "type": "string"
                         }
                       },
+                      "discriminator": {
+                        "propertyName": "yesNo"
+                      },
                       "required": [
                         "yesNo"
                       ],

package/src/tests/v3/extensionOverlays.test.js

@@ -1493,10 +1493,25 @@ describe("Extension Overlays", () => {
         alterationFields.forEach((field) => {
           const fieldSchema = alterations.properties?.[field];
           const yesBranch = fieldSchema?.oneOf?.[1];
+          const planningPermission =
+            yesBranch?.properties?.planningPermission;
+          const buildingRegApproval =
+            yesBranch?.properties?.buildingRegApproval;
+          const overlayFieldSchema = acOverlayAlterations.properties?.[field];
           const overlayYesBranch =
-            acOverlayAlterations.properties?.[field]?.oneOf?.[1];
+            overlayFieldSchema?.oneOf?.[1];
+          const overlayPlanningPermission =
+            overlayYesBranch?.properties?.planningPermission;
+          const overlayBuildingRegApproval =
+            overlayYesBranch?.properties?.buildingRegApproval;
 
           expect(fieldSchema?.required).toContain("yesNo");
+          expect(fieldSchema?.discriminator).toEqual({
+            propertyName: "yesNo",
+          });
+          expect(overlayFieldSchema?.discriminator).toEqual({
+            propertyName: "yesNo",
+          });
           expect(fieldSchema?.properties?.yesNo?.ntsRef).toMatch(/^A1\./);
           expect(yesBranch?.required).toEqual(
             expect.arrayContaining([
@@ -1510,6 +1525,18 @@ describe("Extension Overlays", () => {
             "details",
             "planningPermission",
           ]);
+          expect(planningPermission?.discriminator).toEqual({
+            propertyName: "yesNo",
+          });
+          expect(buildingRegApproval?.discriminator).toEqual({
+            propertyName: "yesNo",
+          });
+          expect(overlayPlanningPermission?.discriminator).toEqual({
+            propertyName: "yesNo",
+          });
+          expect(overlayBuildingRegApproval?.discriminator).toEqual({
+            propertyName: "yesNo",
+          });
           expect(yesBranch?.properties?.workCompleted?.ntsRef).toBeUndefined();
           expect(yesBranch?.properties?.documents?.ntsRef).toBeUndefined();
           expect(yesBranch?.properties?.yearCompleted?.ntsRef).toBeUndefined();
@@ -1519,22 +1546,24 @@ describe("Extension Overlays", () => {
       });
 
       test("should require details and consent yesNo fields for Yes answers", () => {
-        const validator = getSubschemaValidator(
-          "/propertyPack/alterationsAndChanges/extension",
-          schemaId,
-          ["ac"]
-        );
+        alterationFields.forEach((field) => {
+          const validator = getSubschemaValidator(
+            `/propertyPack/alterationsAndChanges/${field}`,
+            schemaId,
+            ["ac"]
+          );
 
-        expect(validator({ yesNo: "No" })).toBe(true);
-        expect(validator({ yesNo: "Yes" })).toBe(false);
-        expect(
-          validator({
-            yesNo: "Yes",
-            details: "Single-storey rear extension in 2018",
-            planningPermission: { yesNo: "Not required" },
-            buildingRegApproval: { yesNo: "Yes" },
-          })
-        ).toBe(true);
+          expect(validator({ yesNo: "No" })).toBe(true);
+          expect(validator({ yesNo: "Yes" })).toBe(false);
+          expect(
+            validator({
+              yesNo: "Yes",
+              details: `${field} details`,
+              planningPermission: { yesNo: "Not required" },
+              buildingRegApproval: { yesNo: "Yes" },
+            })
+          ).toBe(true);
+        });
       });
     });
 

package/src/utils/extractExtensionOverlays.js

@@ -313,6 +313,7 @@ const extensionMappings = {
     name: "alterationsAndChanges",
     description: "Selected alterations and changes fields for SEF25",
     refType: "sef25Ref",
+    preserveDiscriminators: true,
     paths: [
       "/properties/propertyPack/properties/alterationsAndChanges/properties/extension/properties/yesNo",
       "/properties/propertyPack/properties/alterationsAndChanges/properties/extension/oneOf/1/properties/details",
@@ -353,7 +354,12 @@ const extensionMappings = {
 };
 
 // Function to extract properties at specific paths with given ref type
-function extractPathsWithRef(schema, paths, refConfig) {
+function extractPathsWithRef(
+  schema,
+  paths,
+  refConfig,
+  preserveDiscriminators = false
+) {
   const result = {};
 
   paths.forEach((path) => {
@@ -362,6 +368,9 @@ function extractPathsWithRef(schema, paths, refConfig) {
       if (value && hasRef(value, refConfig)) {
         // Set the value at the same path in result
         jp.set(result, path, extractRefProperties(value, refConfig));
+        if (preserveDiscriminators) {
+          addAncestorDiscriminators(result, schema, path);
+        }
       }
     } catch (err) {
       console.warn(`Path not found: ${path}`);
@@ -371,6 +380,26 @@ function extractPathsWithRef(schema, paths, refConfig) {
   return result;
 }
 
+function addAncestorDiscriminators(result, schema, path) {
+  const parts = path.split("/").filter(Boolean);
+
+  for (let index = 1; index <= parts.length; index += 1) {
+    const ancestorPath = `/${parts.slice(0, index).join("/")}`;
+
+    try {
+      const schemaNode = jp.get(schema, ancestorPath);
+      if (!schemaNode?.discriminator) continue;
+
+      const resultNode = jp.get(result, ancestorPath);
+      if (resultNode && typeof resultNode === "object") {
+        resultNode.discriminator = schemaNode.discriminator;
+      }
+    } catch (err) {
+      // Ancestor was not materialised by this selected path.
+    }
+  }
+}
+
 // Check if an object or its descendants have the specified ref
 function hasRef(obj, refConfig) {
   let found = false;
@@ -565,7 +594,12 @@ Object.entries(extensionMappings).forEach(([code, config]) => {
   console.log(`\nGenerating extension overlay: ${code} (${config.name}) [${refType}]`);
 
   // Extract the specific paths
-  let overlay = extractPathsWithRef(combinedSchema, config.paths, refConfig);
+  let overlay = extractPathsWithRef(
+    combinedSchema,
+    config.paths,
+    refConfig,
+    config.preserveDiscriminators
+  );
 
   // Add required arrays where needed
   overlay = addRequiredArrays(overlay, combinedSchema, refConfig);