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

package/index.js

@@ -18,7 +18,7 @@ const cacheStats = {
   hits: 0,
   misses: 0,
   totalQueries: 0,
-  cacheStartTime: Date.now()
+  cacheStartTime: Date.now(),
 };
 
 const verifiedClaimsSchema = require("./src/schemas/verifiedClaims/pdtf-verified-claims.json");
@@ -52,6 +52,24 @@ const extensionOverlays = {
 
   // Transaction Extensions
   oc: require("./src/schemas/v3/overlays/extensions/oc.json"),
+
+  // SEF25 Extensions
+  sc: require("./src/schemas/v3/overlays/extensions/sc.json"),
+  pc: require("./src/schemas/v3/overlays/extensions/pc.json"),
+  ph: require("./src/schemas/v3/overlays/extensions/ph.json"),
+  dk: require("./src/schemas/v3/overlays/extensions/dk.json"),
+  rw: require("./src/schemas/v3/overlays/extensions/rw.json"),
+  sd: require("./src/schemas/v3/overlays/extensions/sd.json"),
+  lc: require("./src/schemas/v3/overlays/extensions/lc.json"),
+  wg: require("./src/schemas/v3/overlays/extensions/wg.json"),
+  ic: require("./src/schemas/v3/overlays/extensions/ic.json"),
+  nd: require("./src/schemas/v3/overlays/extensions/nd.json"),
+  mi: require("./src/schemas/v3/overlays/extensions/mi.json"),
+  tr: require("./src/schemas/v3/overlays/extensions/tr.json"),
+  ac: require("./src/schemas/v3/overlays/extensions/ac.json"),
+
+  // Compatibility Extensions
+  ta: require("./src/schemas/v3/overlays/extensions/ta.json"),
 };
 
 const overlaysMap = {
@@ -75,7 +93,9 @@ const overlaysMap = {
     baspiV4: require("./src/schemas/v3/overlays/baspi4.json"),
     baspiV5: require("./src/schemas/v3/overlays/baspi5.json"),
     ta6ed4: require("./src/schemas/v3/overlays/ta6.json"),
+    ta6ed6: require("./src/schemas/v3/overlays/ta6ed6.json"),
     ta7ed3: require("./src/schemas/v3/overlays/ta7.json"),
+    ta7ed5: require("./src/schemas/v3/overlays/ta7ed5.json"),
     ta10ed3: require("./src/schemas/v3/overlays/ta10.json"),
     lpe1ed4: require("./src/schemas/v3/overlays/lpe1.json"),
     fme1ed2: require("./src/schemas/v3/overlays/fme1.json"),
@@ -117,21 +137,27 @@ const arrayMerge = (target, source, options) => {
     // Detect if this is a required array by checking the parent key
     // Required arrays are property names (camelCase, no spaces)
     // Enum arrays are values (can contain spaces, capitals, etc.)
-    const isRequiredArray = target.every(
-      (item) =>
-        typeof item === "string" &&
-        item.length > 0 &&
-        // Required field names are typically camelCase without spaces
-        !item.includes(" ") &&
-        // First character is usually lowercase for field names
-        (item[0] === item[0].toLowerCase() || item.startsWith("is") || item.startsWith("has"))
-    ) && source.every(
-      (item) =>
-        typeof item === "string" &&
-        item.length > 0 &&
-        !item.includes(" ") &&
-        (item[0] === item[0].toLowerCase() || item.startsWith("is") || item.startsWith("has"))
-    );
+    const isRequiredArray =
+      target.every(
+        (item) =>
+          typeof item === "string" &&
+          item.length > 0 &&
+          // Required field names are typically camelCase without spaces
+          !item.includes(" ") &&
+          // First character is usually lowercase for field names
+          (item[0] === item[0].toLowerCase() ||
+            item.startsWith("is") ||
+            item.startsWith("has")),
+      ) &&
+      source.every(
+        (item) =>
+          typeof item === "string" &&
+          item.length > 0 &&
+          !item.includes(" ") &&
+          (item[0] === item[0].toLowerCase() ||
+            item.startsWith("is") ||
+            item.startsWith("has")),
+      );
 
     if (isRequiredArray) {
       // Combine required arrays
@@ -176,7 +202,7 @@ const arrayMerge = (target, source, options) => {
 
 const getTransactionSchema = (
   schemaId = "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
-  overlays
+  overlays,
 ) => {
   const sourceSchema = transactionSchemas[schemaId];
   if (!overlays || overlays.length < 1) return sourceSchema;
@@ -184,7 +210,7 @@ const getTransactionSchema = (
   let mergedSchema = JSON.parse(JSON.stringify(sourceSchema)); // Deep copy
   overlays.forEach((overlay) => {
     const overlaySchema = JSON.parse(
-      JSON.stringify(overlaysMap[schemaId][overlay] || {})
+      JSON.stringify(overlaysMap[schemaId][overlay] || {}),
     ); // Deep copy
     mergedSchema = merge(mergedSchema, overlaySchema, { arrayMerge });
   });
@@ -211,7 +237,7 @@ const getCachedSchemaData = (path, schemaId, overlays) => {
     const sourceSchema = getTransactionSchema(schemaId, overlays);
     const pathArray = path.split("/").slice(1);
     let subSchema = sourceSchema;
-    
+
     if (pathArray.length >= 1) {
       subSchema = pathArray.reduce((schema, pathElement) => {
         if (!schema) return undefined;
@@ -233,33 +259,52 @@ const getCachedSchemaData = (path, schemaId, overlays) => {
               }
             } catch (e) {
               // Invalid regex pattern in schema - skip it
-              console.warn(`Invalid regex pattern in patternProperties: ${pattern}`, e);
+              console.warn(
+                `Invalid regex pattern in patternProperties: ${pattern}`,
+                e,
+              );
             }
           }
         }
 
-        // Check oneOf discriminators
+        // Check oneOf discriminators (recursively for nested oneOf)
         if (oneOf) {
-          let matchingProperty;
-          oneOf.forEach((aOneOf) => {
-            if (aOneOf.type === "array" && !Number.isNaN(pathElement)) {
-              matchingProperty = aOneOf.items;
-            } else if (aOneOf.properties?.[pathElement]) {
-              matchingProperty = aOneOf.properties?.[pathElement];
-            } else if (aOneOf.patternProperties) {
-              for (const pattern in aOneOf.patternProperties) {
-                try {
-                  const regex = new RegExp(pattern);
-                  if (regex.test(pathElement)) {
-                    matchingProperty = aOneOf.patternProperties[pattern];
-                    break;
+          const findInOneOf = (branches) => {
+            let arrayFallback;
+            for (const branch of branches) {
+              if (!branch) continue;
+              // Track array matches as fallback (prefer property matches)
+              if (
+                branch.type === "array" &&
+                !Number.isNaN(pathElement) &&
+                !arrayFallback
+              ) {
+                arrayFallback = branch.items;
+              }
+              if (branch.properties?.[pathElement]) {
+                return branch.properties[pathElement];
+              }
+              if (branch.patternProperties) {
+                for (const pattern in branch.patternProperties) {
+                  try {
+                    const regex = new RegExp(pattern);
+                    if (regex.test(pathElement)) {
+                      return branch.patternProperties[pattern];
+                    }
+                  } catch (e) {
+                    // Invalid regex pattern - skip
                   }
-                } catch (e) {
-                  // Invalid regex pattern - skip
                 }
               }
+              // Recurse into nested oneOf branches
+              if (branch.oneOf) {
+                const nested = findInOneOf(branch.oneOf);
+                if (nested) return nested;
+              }
             }
-          });
+            return arrayFallback;
+          };
+          const matchingProperty = findInOneOf(oneOf);
           if (matchingProperty) return matchingProperty;
         }
 
@@ -270,7 +315,7 @@ const getCachedSchemaData = (path, schemaId, overlays) => {
     // Add schema to AJV and get validator
     // Only add valid schemas to AJV
     let validator;
-    if (subSchema && typeof subSchema === 'object') {
+    if (subSchema && typeof subSchema === "object") {
       // Check if schema already exists in AJV to avoid duplicates
       validator = ajv.getSchema(cacheKey);
       if (!validator) {
@@ -287,7 +332,7 @@ const getCachedSchemaData = (path, schemaId, overlays) => {
       subSchema,
       validator,
       cacheKey,
-      createdAt: Date.now()
+      createdAt: Date.now(),
     };
     schemaCache.set(cacheKey, cached);
   } else {
@@ -353,13 +398,13 @@ const getTitleAtPath = (schema, path, rootPath = path) => {
   if (oneOfs) {
     // only single dependency discriminator, oneOf keyword is supported
     const matchingOneOf = oneOfs.find(
-      (oneOf) => oneOf["properties"][propertyName]
+      (oneOf) => oneOf["properties"][propertyName],
     );
     if (matchingOneOf)
       return getTitleAtPath(
         matchingOneOf["properties"][propertyName],
         subPath,
-        rootPath
+        rootPath,
       );
   }
 };
@@ -392,7 +437,7 @@ const validateVerifiedClaims = (verifiedClaims, schemaId, overlays) => {
         }
       } else {
         validationErrorsArr.push(
-          `Path ${path} is not a valid PDTF schema path`
+          `Path ${path} is not a valid PDTF schema path`,
         );
       }
     }
@@ -404,8 +449,11 @@ const validateVerifiedClaims = (verifiedClaims, schemaId, overlays) => {
 // Cache management functions
 const getCacheStats = () => {
   const runtime = Date.now() - cacheStats.cacheStartTime;
-  const hitRate = cacheStats.totalQueries > 0 ? (cacheStats.hits / cacheStats.totalQueries * 100) : 0;
-  
+  const hitRate =
+    cacheStats.totalQueries > 0
+      ? (cacheStats.hits / cacheStats.totalQueries) * 100
+      : 0;
+
   return {
     totalEntries: schemaCache.size,
     hits: cacheStats.hits,
@@ -417,8 +465,8 @@ const getCacheStats = () => {
     memoryUsage: {
       entriesCount: schemaCache.size,
       // Rough estimate of memory usage per entry
-      estimatedSizeKB: Math.round((schemaCache.size * 2) / 1024 * 100) / 100 // Rough estimate
-    }
+      estimatedSizeKB: Math.round(((schemaCache.size * 2) / 1024) * 100) / 100, // Rough estimate
+    },
   };
 };
 
@@ -428,15 +476,17 @@ const getDetailedCacheStats = () => {
     key,
     createdAt: value.createdAt,
     age: Date.now() - value.createdAt,
-    hasValidator: typeof value.validator === 'function',
-    hasSubSchema: value.subSchema !== undefined
+    hasValidator: typeof value.validator === "function",
+    hasSubSchema: value.subSchema !== undefined,
   }));
 
   return {
     ...baseStats,
     entries: entries.sort((a, b) => b.createdAt - a.createdAt), // Most recent first
-    oldestEntry: entries.length > 0 ? Math.max(...entries.map(e => e.age)) : 0,
-    newestEntry: entries.length > 0 ? Math.min(...entries.map(e => e.age)) : 0
+    oldestEntry:
+      entries.length > 0 ? Math.max(...entries.map((e) => e.age)) : 0,
+    newestEntry:
+      entries.length > 0 ? Math.min(...entries.map((e) => e.age)) : 0,
   };
 };
 
@@ -449,17 +499,17 @@ const clearSchemaCache = (pattern) => {
         keysToDelete.push(key);
       }
     });
-    keysToDelete.forEach(key => schemaCache.delete(key));
-    
+    keysToDelete.forEach((key) => schemaCache.delete(key));
+
     // Also remove matching schemas from AJV
-    keysToDelete.forEach(key => {
+    keysToDelete.forEach((key) => {
       try {
         ajv.removeSchema(key);
       } catch (e) {
         // Schema might not exist in AJV, ignore
       }
     });
-    
+
     return keysToDelete.length;
   } else {
     // Clear all cache
@@ -470,20 +520,24 @@ const clearSchemaCache = (pattern) => {
     cacheStats.misses = 0;
     cacheStats.totalQueries = 0;
     cacheStats.cacheStartTime = Date.now();
-    
+
     // Also clear AJV's internal cache to prevent duplicates
     ajv.removeSchema();
-    
+
     return entriesCleared;
   }
 };
 
-const warmupCache = (paths, schemaId = "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json", overlaysList = []) => {
+const warmupCache = (
+  paths,
+  schemaId = "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
+  overlaysList = [],
+) => {
   const warmupStats = {
     totalAttempted: 0,
     successful: 0,
     failed: 0,
-    errors: []
+    errors: [],
   };
 
   // Default common paths if none provided
@@ -495,7 +549,7 @@ const warmupCache = (paths, schemaId = "https://trust.propdata.org.uk/schemas/v3
     "/propertyPack/valuations",
     "/propertyPack/waterAndDrainage",
     "/propertyPack/ownership",
-    "/propertyPack/notices"
+    "/propertyPack/notices",
   ];
 
   // Default common overlays if none provided
@@ -504,14 +558,15 @@ const warmupCache = (paths, schemaId = "https://trust.propdata.org.uk/schemas/v3
     ["baspiV5"],
     ["ta6ed4"],
     ["nts2023"],
-    ["baspiV5", "ta6ed4"]
+    ["baspiV5", "ta6ed4"],
   ];
 
   const pathsToWarm = paths || defaultPaths;
-  const overlaysToWarm = overlaysList.length > 0 ? overlaysList : defaultOverlays;
+  const overlaysToWarm =
+    overlaysList.length > 0 ? overlaysList : defaultOverlays;
 
-  pathsToWarm.forEach(path => {
-    overlaysToWarm.forEach(overlays => {
+  pathsToWarm.forEach((path) => {
+    overlaysToWarm.forEach((overlays) => {
       warmupStats.totalAttempted++;
       try {
         // This will populate the cache
@@ -523,7 +578,7 @@ const warmupCache = (paths, schemaId = "https://trust.propdata.org.uk/schemas/v3
         warmupStats.errors.push({
           path,
           overlays,
-          error: error.message
+          error: error.message,
         });
       }
     });
@@ -535,14 +590,14 @@ const warmupCache = (paths, schemaId = "https://trust.propdata.org.uk/schemas/v3
 const pruneCacheByAge = (maxAgeMs) => {
   const now = Date.now();
   const keysToDelete = [];
-  
+
   schemaCache.forEach((value, key) => {
     if (now - value.createdAt > maxAgeMs) {
       keysToDelete.push(key);
     }
   });
-  
-  keysToDelete.forEach(key => {
+
+  keysToDelete.forEach((key) => {
     schemaCache.delete(key);
     try {
       ajv.removeSchema(key);
@@ -550,21 +605,22 @@ const pruneCacheByAge = (maxAgeMs) => {
       // Schema might not exist in AJV, ignore
     }
   });
-  
+
   return keysToDelete.length;
 };
 
 const setCacheMaxSize = (maxSize) => {
   if (schemaCache.size <= maxSize) return 0;
-  
+
   // Get entries sorted by creation time (oldest first)
-  const entries = Array.from(schemaCache.entries())
-    .sort((a, b) => a[1].createdAt - b[1].createdAt);
-  
+  const entries = Array.from(schemaCache.entries()).sort(
+    (a, b) => a[1].createdAt - b[1].createdAt,
+  );
+
   const toRemove = schemaCache.size - maxSize;
   const keysToDelete = entries.slice(0, toRemove).map(([key]) => key);
-  
-  keysToDelete.forEach(key => {
+
+  keysToDelete.forEach((key) => {
     schemaCache.delete(key);
     try {
       ajv.removeSchema(key);
@@ -572,7 +628,7 @@ const setCacheMaxSize = (maxSize) => {
       // Schema might not exist in AJV, ignore
     }
   });
-  
+
   return keysToDelete.length;
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdtf/schemas",
-  "version": "3.6.0-9",
+  "version": "3.6.0-dev.3",
   "description": "Property Data Trust Framework Schemas and Utilities",
   "main": "index.js",
   "directories": {
@@ -9,7 +9,11 @@
   "scripts": {
     "test": "jest",
     "test:watch": "jest --watch",
-    "extract-overlays": "cd src/utils && node extractOverlay.js"
+    "extract-overlays": "cd src/utils && node extractOverlay.js",
+    "extract-extension-overlays": "cd src/utils && node extractExtensionOverlays.js",
+    "publish:dev": "npm publish --tag dev",
+    "publish:next": "npm publish --tag next",
+    "publish:latest": "npm publish --tag latest"
   },
   "repository": {
     "type": "git",

package/pensive-tesla-d0d355/CLAUDE.md

@@ -0,0 +1,101 @@
+# CLAUDE.md
+
+This file provides guidance for AI coding agents when working with code in this repository.
+
+## Overview
+
+This repository contains the Property Data Trust Framework (PDTF) schemas - JSON Schema-based definitions for digital residential property data exchange in England and Wales. The framework enables frictionless exchange of property data between software products and services.
+
+## Commands
+
+### Testing
+```bash
+npm test          # Run all tests
+npm run test:watch # Run tests in watch mode
+```
+
+### Development
+```bash
+npm install                       # Install dependencies
+npm run extract-overlays          # Regenerate v3 schemas and overlays from combined.json
+npm run extract-extension-overlays # Regenerate v3 extension overlays from combined.json
+npm run publish:dev               # Publish the dev branch package to npm tag dev
+npm run publish:next              # Publish the next branch package to npm tag next
+npm run publish:latest            # Publish the main branch package to npm tag latest
+```
+
+**Important**: `src/schemas/v3/combined.json` is the source of truth for v3 schema changes. Never edit generated schema artifacts directly; there are no exceptions. Utility/source files may be edited normally. After changing `combined.json`, always run both overlay extraction commands so derived files stay in sync.
+
+## Architecture
+
+### Schema System
+The PDTF uses a flexible overlay system where a base transaction schema can be extended with form-specific overlays:
+
+- **Base Schema**: Core transaction schema at `/src/schemas/v3/pdtf-transaction.json`
+- **Overlays**: Form-specific extensions in `/src/schemas/v3/overlays/` (e.g., baspi5.json, ta6.json)
+- **Merging**: Overlays are merged with the base schema using deepmerge with custom merge strategies
+- **Generated Files**: `pdtf-transaction.json`, `skeleton.json`, `compactSkeleton.txt`, `src/schemas/v3/overlays/*.json`, and `src/schemas/v3/overlays/extensions/*.json` are generated from `combined.json`
+
+### Key Components
+
+1. **index.js**: Main module exposing schema utilities
+   - `getTransactionSchema(schemaId, overlays)`: Merges base schema with overlays
+   - `getValidator(schemaId, overlays)`: Returns AJV validator for schema
+   - `validateVerifiedClaims()`: Validates verified claims structure
+
+2. **Schema Versions**: Currently on v3, with v2 still supported
+   - Use `https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json` for v3
+
+3. **Overlay System**: Supports multiple UK property forms
+   - BASPI (v4 and v5)
+   - Law Society TA forms (TA6, TA7, TA10)
+   - NTS forms (2023 and 2025 versions)
+   - CON29R, PIQ, RDS, and others
+
+### Testing Approach
+Tests in `/src/tests/` validate:
+- Schema structure with different overlay combinations
+- Path validation for nested properties
+- Custom overlay merging
+- Verified claims validation
+
+Use existing test patterns when adding new tests.
+
+## Branch And Release Workflow
+
+This repository publishes `@pdtf/schemas` through three branches and npm
+dist-tags:
+
+- `main` -> npm `latest`: stable PDTF releases for broad industry use.
+- `next` -> npm `next`: tested capabilities proposed for the next managed PDTF
+  point release.
+- `dev` -> npm `dev`: the unstable coal face for faster-moving integration work
+  and early adopters.
+
+PRs may be merged into `dev` to prove out work before it is ready for the managed
+release path. Once a `dev` PR has been tested and is suitable for standards
+review, promote the same change into `next` via a focused PR. Do not treat `dev`
+as the standard, and do not publish `dev` or `next` builds to npm `latest`.
+
+Promotion is automatic by default: after a PR is merged into `dev`,
+`.github/workflows/promote-dev-to-next.yml` creates a matching PR into `next` by
+cherry-picking the merged dev PR. Add the `no-promote-next` label before merging
+a dev PR only when it should stay out of the `next` review queue. Reviewers
+should still inspect the promotion PR, resolve conflicts, and adjust
+release/version metadata if needed before merging to `next`.
+
+Each npm publish needs a unique semver version. Use `-dev.N` versions on `dev`,
+prerelease versions on `next`, and normal release versions on `main`.
+
+Consumer-specific compatibility profiles belong in the consuming application or
+service unless the capability becomes generic PDTF package functionality.
+Consumers should pin/hash supplied schemas and use their own target-profile
+configuration for API calls and webhooks.
+
+See `docs/branch-release-workflow.md` for the full workflow.
+
+## Important Notes
+
+- All schemas use JSON Schema Draft 07
+- The repository publishes to npm as `@pdtf/schemas`
+- Overlays may contain fields from licensed forms (BASPI, PIQ, Law Society) - ensure compliance when rendering data

package/pensive-tesla-d0d355/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Property Data Trust Framework
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.