adapt-schemas 1.0.3 → 1.2.0

package/.github/workflows/releases.yml

@@ -15,11 +15,11 @@ jobs:
       id-token: write # to enable use of OIDC for trusted publishing and npm provenance
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 'lts/*'
       - name: Update npm

package/lib/Schema.js

@@ -373,6 +373,33 @@ class Schema extends EventEmitter {
         : s.default
     })
   }
+
+  /**
+   * Walks the built schema alongside data, returning fields matching a predicate.
+   * @param {Object} data - The data object to walk
+   * @param {Function} predicate - `(schemaField) => boolean`
+   * @param {Object} [schema] - Internal: schema properties to walk (defaults to built.properties)
+   * @param {string} [parentPath=''] - Internal: the slash-delimited path accumulated so far
+   * @returns {Array<Object>} Array of `{ path, key, data, value }` matches
+   */
+  walk (data, predicate, schema, parentPath = '') {
+    schema = schema ?? this.built.properties
+    const matches = []
+    for (const [key, val] of Object.entries(schema)) {
+      if (data[key] === undefined) continue
+      const currentPath = parentPath ? `${parentPath}/${key}` : key
+      if (val.properties) {
+        matches.push(...this.walk(data[key], predicate, val.properties, currentPath))
+      } else if (val?.items?.properties) {
+        data[key].forEach((item, i) => {
+          matches.push(...this.walk(item, predicate, val.items.properties, `${currentPath}/${i}`))
+        })
+      } else if (predicate(val)) {
+        matches.push({ path: currentPath, key, data, value: data[key] })
+      }
+    }
+    return matches
+  }
 }
 
 export default Schema

package/package.json

@@ -1,6 +1,10 @@
 {
   "name": "adapt-schemas",
-  "version": "1.0.3",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cgkineo/adapt-schemas"
+  },
+  "version": "1.2.0",
   "description": "Standalone JSON Schema library for the Adapt framework",
   "type": "module",
   "main": "index.js",

package/test.js

@@ -274,6 +274,27 @@ async function runTests () {
     await library.registerSchema(newSchemaPath)
     console.log('')
 
+    // Test 11: Schema.walk
+    console.log('Test 11: Schema.walk')
+    const courseSchema = await library.getSchema('course')
+    const walkData = {
+      title: 'Test',
+      description: 'A course',
+      _globals: {
+        _accessibility: {
+          _isEnabled: true,
+          skipNavigationText: 'Skip'
+        }
+      }
+    }
+    const stringFields = courseSchema.walk(walkData, val => val.type === 'string')
+    const paths = stringFields.map(r => r.path)
+    console.log(`  ✓ Found ${stringFields.length} string fields: ${paths.join(', ')}`)
+    const hasTitle = paths.includes('title')
+    const hasNested = paths.includes('_globals/_accessibility/skipNavigationText')
+    console.log(`  ✓ Includes top-level field: ${hasTitle}`)
+    console.log(`  ✓ Includes nested field: ${hasNested}\n`)
+
     console.log('=== All tests passed! ===')
   } finally {
     if (!hasSpecifiedPath) {