@pdtf/schemas 3.6.0-dev.3 → 3.6.0-dev.4

package/keen-dewdney-6ae15b/src/utils/pathSkeleton.js

@@ -0,0 +1,181 @@
+const fs = require("fs");
+const traverse = require("traverse");
+
+const combinedSchema = require("../schemas/v3/combined.json");
+
+// Extract fields that have overlay-specific properties
+const extractFields = [
+  "baspi4", "baspi5", "nts", "nts2", "ntsl", "ntsl2",
+  "ta6", "ta7", "ta10", "lpe1", "fme1", "piq",
+  "con29R", "con29DW", "llc1", "rds", "oc1", "sr24",
+];
+
+// Delete properties we don't want in the skeleton
+const deleteProperties = (sourceSchema, propertyNames) => {
+  traverse(sourceSchema).forEach(function (element) {
+    if (propertyNames.includes(this.key)) {
+      this.delete(true);
+    }
+  });
+  return sourceSchema;
+};
+
+// Collect all paths in path notation
+const collectPaths = (schema, currentPath = "") => {
+  const paths = [];
+  
+  if (!schema || typeof schema !== 'object') {
+    return paths;
+  }
+  
+  // Handle arrays
+  if (schema.type === "array" && schema.items) {
+    const arrayPath = currentPath + "[]";
+    paths.push(arrayPath);
+    // Continue with items
+    const itemPaths = collectPaths(schema.items, arrayPath);
+    paths.push(...itemPaths);
+    return paths;
+  }
+  
+  // Handle primitives - add type suffix
+  if (schema.type && !schema.properties && !schema.oneOf && !schema.items) {
+    let typeChar = "";
+    switch(schema.type) {
+      case "string": typeChar = ":s"; break;
+      case "number": typeChar = ":n"; break;
+      case "integer": typeChar = ":i"; break;
+      case "boolean": typeChar = ":b"; break;
+      default: typeChar = "";
+    }
+    if (currentPath) {
+      paths.push(currentPath + typeChar);
+    }
+    return paths;
+  }
+  
+  // Handle objects with properties
+  if (schema.properties) {
+    // If this is an object without a path yet, don't add it
+    if (currentPath && !schema.type?.includes("array")) {
+      paths.push(currentPath);
+    }
+    
+    Object.keys(schema.properties).forEach((propName) => {
+      const newPath = currentPath ? `${currentPath}.${propName}` : propName;
+      const propPaths = collectPaths(schema.properties[propName], newPath);
+      paths.push(...propPaths);
+    });
+  }
+  
+  // Handle oneOf - collect all possible properties
+  if (schema.oneOf) {
+    const variantProps = new Set();
+    schema.oneOf.forEach((oneOfSchema) => {
+      if (oneOfSchema.properties) {
+        Object.keys(oneOfSchema.properties).forEach((propName) => {
+          variantProps.add(propName);
+        });
+      }
+    });
+    
+    // Process each unique property
+    variantProps.forEach((propName) => {
+      const newPath = currentPath ? `${currentPath}.${propName}` : propName;
+      // Check if all variants have the same type
+      let commonType = null;
+      let isVariant = false;
+      
+      schema.oneOf.forEach((oneOfSchema) => {
+        if (oneOfSchema.properties && oneOfSchema.properties[propName]) {
+          const propType = oneOfSchema.properties[propName].type;
+          if (commonType === null) {
+            commonType = propType;
+          } else if (commonType !== propType) {
+            isVariant = true;
+          }
+        }
+      });
+      
+      if (isVariant || !commonType) {
+        paths.push(newPath + ":v"); // variant
+      } else {
+        // Process the first variant's version of this property
+        for (const oneOfSchema of schema.oneOf) {
+          if (oneOfSchema.properties && oneOfSchema.properties[propName]) {
+            const propPaths = collectPaths(oneOfSchema.properties[propName], newPath);
+            paths.push(...propPaths);
+            break;
+          }
+        }
+      }
+    });
+  }
+  
+  // Empty objects
+  if (currentPath && !schema.properties && !schema.oneOf && !schema.items && !schema.type) {
+    paths.push(currentPath);
+  }
+  
+  return paths;
+};
+
+// Remove duplicates
+const deduplicatePaths = (paths) => {
+  return [...new Set(paths)];
+};
+
+// Sort paths for readability
+const sortPaths = (paths) => {
+  return paths.sort((a, b) => {
+    // Sort by depth first (fewer dots = higher up)
+    const depthA = (a.match(/\./g) || []).length;
+    const depthB = (b.match(/\./g) || []).length;
+    if (depthA !== depthB) return depthA - depthB;
+    
+    // Then alphabetically
+    return a.localeCompare(b);
+  });
+};
+
+// Create clean schema
+const coreSchema = deleteProperties(JSON.parse(JSON.stringify(combinedSchema)), [
+  "discriminator",
+  ...extractFields.map((item) => `${item}Ref`),
+  ...extractFields.map((item) => `${item}Required`),
+  ...extractFields.map((item) => `${item}Title`),
+  ...extractFields.map((item) => `${item}Description`),
+  ...extractFields.map((item) => `${item}Enum`),
+]);
+
+// Remove metadata
+const skeletonSchema = deleteProperties(coreSchema, [
+  "$schema", "$id", "title", "description", "required",
+  "enum", "minItems", "minLength", "format", "minimum", "maximum",
+]);
+
+// Collect paths
+const allPaths = collectPaths(skeletonSchema);
+const uniquePaths = deduplicatePaths(allPaths);
+const sortedPaths = sortPaths(uniquePaths);
+
+// Write as text file
+const pathContent = sortedPaths.join('\n');
+fs.writeFileSync("../schemas/v3/pathSkeleton.txt", pathContent);
+
+// Also create a JSON version for comparison
+fs.writeFileSync("../schemas/v3/pathSkeleton.json", JSON.stringify(sortedPaths, null, 2));
+
+console.log(`Path skeleton written to ../schemas/v3/pathSkeleton.txt`);
+console.log(`Total paths: ${sortedPaths.length}`);
+console.log(`Text size: ${pathContent.length} bytes`);
+
+// Count tokens
+try {
+  const GPT3Encoder = require('gpt-3-encoder');
+  const encoded = GPT3Encoder.encode(pathContent);
+  console.log(`Tokens (GPT-3): ${encoded.length}`);
+  console.log(`Reduction: ${((1 - encoded.length / 78734) * 100).toFixed(1)}% fewer tokens than JSON skeleton`);
+} catch (e) {
+  console.log(`Estimated tokens: ~${Math.ceil(pathContent.length / 4)}`);
+}

package/package.json

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

package/src/schemas/v3/combined.json

@@ -8647,7 +8647,7 @@
                                               "assessmentsCarriedOut": {
                                                 "enum": [
                                                   "Fire risk assessment",
-                                                  "External Wall fire risk assessment",
+                                                  "External wall fire risk assessment",
                                                   "Both"
                                                 ]
                                               },
@@ -11254,7 +11254,7 @@
                 {
                   "properties": {
                     "yesNo": {
-                      "enum": ["No"],
+                      "enum": ["No", "Not applicable", "Not known"],
                       "ta7Enum": ["No", "Not applicable"],
                       "ta7ed5Enum": ["No", "Not known"]
                     }
@@ -18220,13 +18220,6 @@
                             "ta10Required": ["fittedOrFreestanding"]
                           }
                         }
-                      },
-                      {
-                        "properties": {
-                          "isIncludedOrExcluded": {
-                            "enum": ["None"]
-                          }
-                        }
                       }
                     ]
                   }
@@ -24716,7 +24709,7 @@
                             {
                               "properties": {
                                 "yesNo": {
-                                  "enum": ["No"]
+                                  "enum": ["No", "Not known"]
                                 }
                               }
                             },
@@ -24797,7 +24790,7 @@
                             {
                               "properties": {
                                 "yesNo": {
-                                  "enum": ["Yes"]
+                                  "enum": ["Yes", "Not known"]
                                 }
                               }
                             },
@@ -25977,7 +25970,7 @@
                   "properties": {
                     "yesNo": {
                       "ta6ed6CompatRef": "TA6ED6-COMPAT.9.2.1.no",
-                      "enum": ["No"],
+                      "enum": ["No", "Not applicable"],
                       "ta6ed6Enum": ["No", "Not applicable"],
                       "ta6ed6CompatEnum": ["No", "Not applicable"]
                     }
@@ -26185,7 +26178,7 @@
                   "properties": {
                     "yesNo": {
                       "ta6ed6CompatRef": "TA6ED6-COMPAT.9.3.1.no",
-                      "enum": ["No"],
+                      "enum": ["No", "Not known"],
                       "ta6ed6Enum": ["No", "Not known"],
                       "ta6ed6CompatEnum": ["No", "Not known"]
                     }
@@ -28556,7 +28549,7 @@
                 {
                   "properties": {
                     "riskIndicator": {
-                      "enum": ["No", "Not known"]
+                      "enum": ["No"]
                     }
                   }
                 },
@@ -29738,7 +29731,7 @@
                   "properties": {
                     "yesNo": {
                       "ta6ed6CompatRef": "TA6ED6-COMPAT.2.4.1.no",
-                      "enum": ["No", "Not applicable"],
+                      "enum": ["No", "Not applicable", "Not known"],
                       "ta6ed6Enum": ["No", "Not known"],
                       "ta6ed6CompatEnum": ["No", "Not known"]
                     }

package/src/schemas/v3/overlays/baspi4.json

@@ -1458,7 +1458,9 @@
                   "properties": {
                     "yesNo": {
                       "enum": [
-                        "No"
+                        "No",
+                        "Not applicable",
+                        "Not known"
                       ]
                     }
                   }
@@ -4736,7 +4738,8 @@
                               "properties": {
                                 "yesNo": {
                                   "enum": [
-                                    "Yes"
+                                    "Yes",
+                                    "Not known"
                                   ]
                                 }
                               }
@@ -5266,7 +5269,8 @@
                   "properties": {
                     "yesNo": {
                       "enum": [
-                        "No"
+                        "No",
+                        "Not applicable"
                       ]
                     }
                   }
@@ -5350,7 +5354,8 @@
                   "properties": {
                     "yesNo": {
                       "enum": [
-                        "No"
+                        "No",
+                        "Not known"
                       ]
                     }
                   }
@@ -5865,8 +5870,7 @@
                   "properties": {
                     "riskIndicator": {
                       "enum": [
-                        "No",
-                        "Not known"
+                        "No"
                       ]
                     }
                   }
@@ -6638,7 +6642,8 @@
                     "yesNo": {
                       "enum": [
                         "No",
-                        "Not applicable"
+                        "Not applicable",
+                        "Not known"
                       ]
                     }
                   }

package/src/schemas/v3/overlays/baspi5.json

@@ -1606,7 +1606,9 @@
                   "properties": {
                     "yesNo": {
                       "enum": [
-                        "No"
+                        "No",
+                        "Not applicable",
+                        "Not known"
                       ]
                     }
                   }
@@ -4887,7 +4889,8 @@
                               "properties": {
                                 "yesNo": {
                                   "enum": [
-                                    "Yes"
+                                    "Yes",
+                                    "Not known"
                                   ]
                                 }
                               }
@@ -5417,7 +5420,8 @@
                   "properties": {
                     "yesNo": {
                       "enum": [
-                        "No"
+                        "No",
+                        "Not applicable"
                       ]
                     }
                   }
@@ -5501,7 +5505,8 @@
                   "properties": {
                     "yesNo": {
                       "enum": [
-                        "No"
+                        "No",
+                        "Not known"
                       ]
                     }
                   }
@@ -6046,8 +6051,7 @@
                   "properties": {
                     "riskIndicator": {
                       "enum": [
-                        "No",
-                        "Not known"
+                        "No"
                       ]
                     }
                   }
@@ -6788,7 +6792,8 @@
                     "yesNo": {
                       "enum": [
                         "No",
-                        "Not applicable"
+                        "Not applicable",
+                        "Not known"
                       ]
                     }
                   }

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

@@ -324,7 +324,8 @@
           ],
           "ntsRef": "A1"
         }
-      }
+      },
+      "ntsRef": "0"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",

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

@@ -21,9 +21,10 @@
           "required": [
             "droppedKerbAccess"
           ],
-          "ntsRef": "K1"
+          "ntsRef": "B4"
         }
-      }
+      },
+      "ntsRef": "0"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",

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

@@ -50,7 +50,8 @@
             }
           ]
         }
-      }
+      },
+      "ntsRef": "0"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",

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

@@ -64,9 +64,10 @@
               ]
             }
           },
-          "ntsRef": "S1"
+          "ntsRef": "B3.1"
         }
-      }
+      },
+      "ntsRef": "0"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",

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

@@ -60,7 +60,8 @@
           ],
           "ntsRef": "M1"
         }
-      }
+      },
+      "ntsRef": "0"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",

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

@@ -32,9 +32,10 @@
               "type": "object"
             }
           },
-          "ntsRef": "N1"
+          "ntsRef": "C4"
         }
-      }
+      },
+      "ntsRef": "0"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",

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

@@ -26,9 +26,10 @@
               ]
             }
           },
-          "ntsRef": "K1"
+          "ntsRef": "B4"
         }
-      }
+      },
+      "ntsRef": "0"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",

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

@@ -185,7 +185,8 @@
           },
           "type": "object"
         }
-      }
+      },
+      "ntsRef": "0"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",

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

@@ -54,12 +54,13 @@
               "required": [
                 "privateRightOfWay"
               ],
-              "ntsRef": "R1"
+              "ntsRef": "C2.2.1"
             }
           },
-          "ntsRef": "R1"
+          "ntsRef": "C2.2"
         }
-      }
+      },
+      "ntsRef": "0"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",

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

@@ -58,7 +58,8 @@
                     }
                   ]
                 }
-              }
+              },
+              "ntsRef": "B3.2"
             },
             "drainage": {
               "properties": {
@@ -116,11 +117,14 @@
                     }
                   ]
                 }
-              }
+              },
+              "ntsRef": "B3.3"
             }
-          }
+          },
+          "ntsRef": "B3.2"
         }
-      }
+      },
+      "ntsRef": "0"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",

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

@@ -52,9 +52,10 @@
           "required": [
             "stormFireFloodDamage"
           ],
-          "ntsRef": "E1"
+          "ntsRef": "C3.1"
         }
-      }
+      },
+      "ntsRef": "0"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",

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

@@ -62,9 +62,10 @@
               }
             }
           },
-          "ntsRef": "T1"
+          "ntsRef": "A3"
         }
-      }
+      },
+      "ntsRef": "0"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",

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

@@ -341,7 +341,8 @@
           ],
           "type": "object"
         }
-      }
+      },
+      "ntsRef": "0"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",

package/src/schemas/v3/overlays/lpe1.json

@@ -1499,7 +1499,7 @@
                                               "assessmentsCarriedOut": {
                                                 "enum": [
                                                   "Fire risk assessment",
-                                                  "External Wall fire risk assessment",
+                                                  "External wall fire risk assessment",
                                                   "Both"
                                                 ]
                                               },

package/src/schemas/v3/overlays/nts.json

@@ -896,7 +896,9 @@
                   "properties": {
                     "yesNo": {
                       "enum": [
-                        "No"
+                        "No",
+                        "Not applicable",
+                        "Not known"
                       ]
                     }
                   }

package/src/schemas/v3/overlays/nts2.json

@@ -1060,7 +1060,9 @@
                   "properties": {
                     "yesNo": {
                       "enum": [
-                        "No"
+                        "No",
+                        "Not applicable",
+                        "Not known"
                       ]
                     }
                   }

package/src/schemas/v3/overlays/ntsl.json

@@ -557,7 +557,9 @@
                   "properties": {
                     "yesNo": {
                       "enum": [
-                        "No"
+                        "No",
+                        "Not applicable",
+                        "Not known"
                       ]
                     }
                   }

package/src/schemas/v3/overlays/ntsl2.json

@@ -586,7 +586,9 @@
                   "properties": {
                     "yesNo": {
                       "enum": [
-                        "No"
+                        "No",
+                        "Not applicable",
+                        "Not known"
                       ]
                     }
                   }