adapt-schemas 1.0.0

package/test.js

@@ -0,0 +1,289 @@
+/**
+ * Test script for the Adapt Schema Library
+ */
+import Schemas from './index.js'
+import path from 'path'
+import { fileURLToPath } from 'url'
+import fs from 'fs/promises'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const hasSpecifiedPath = Boolean(process.argv[2])
+
+async function setupTestSchemas() {
+  if (hasSpecifiedPath) return
+  // Create test schema directory
+  const testSchemaDir = path.join(__dirname, 'test-schemas')
+  await fs.mkdir(testSchemaDir, { recursive: true })
+
+  // Create a course schema with _globals
+  const courseSchema = {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$anchor": "course",
+    "$merge": {
+      "source": { "$ref": "base" },
+      "with": {
+        "properties": {
+          "title": {
+            "type": "string",
+            "description": "Course title",
+            "default": "Untitled Course"
+          },
+          "description": {
+            "type": "string",
+            "description": "Course description",
+            "default": ""
+          },
+          "_globals": {
+            "type": "object",
+            "description": "Global settings",
+            "properties": {
+              "_accessibility": {
+                "type": "object",
+                "properties": {
+                  "_isEnabled": {
+                    "type": "boolean",
+                    "default": true
+                  },
+                  "skipNavigationText": {
+                    "type": "string",
+                    "default": "Skip navigation"
+                  }
+                },
+                "required": [
+                  "skipNavigationText"
+                ]
+              },
+              "_extensions": {
+                "type": "object",
+                "properties": {
+                  "_trickle": {
+                    "type": "object",
+                    "properties": {
+                      "incompleteContent": {
+                        "type": "string",
+                        "default": "There is incomplete content above"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "required": ["title"]
+      }
+    }
+  }
+
+  // Create a content schema
+  const contentSchema = {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$anchor": "content",
+    "$merge": {
+      "source": { "$ref": "base" },
+      "with": {
+        "properties": {
+          "_type": {
+            "type": "string",
+            "description": "Content type"
+          },
+          "body": {
+            "type": "string",
+            "description": "Content body",
+            "default": ""
+          },
+          "_isOptional": {
+            "type": "boolean",
+            "default": false
+          }
+        }
+      }
+    }
+  }
+
+  // Create a component schema that extends content
+  const componentSchema = {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$anchor": "component",
+    "$merge": {
+      "source": { "$ref": "content" },
+      "with": {
+        "properties": {
+          "_component": {
+            "type": "string",
+            "description": "Component type"
+          }
+        },
+        "required": ["_component"]
+      }
+    }
+  }
+
+  // Create a patch schema that extends course
+  const coursePatchSchema = {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$anchor": "course-extension",
+    "$patch": {
+      "source": { "$ref": "course" },
+      "with": {
+        "properties": {
+          "_globals": {
+            "type": "object",
+            "properties": {
+              "_myPlugin": {
+                "type": "object",
+                "properties": {
+                  "buttonLabel": {
+                    "type": "string",
+                    "default": "Click me"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+
+  await fs.writeFile(
+    path.join(testSchemaDir, 'course.schema.json'),
+    JSON.stringify(courseSchema, null, 2)
+  )
+  await fs.writeFile(
+    path.join(testSchemaDir, 'content.schema.json'),
+    JSON.stringify(contentSchema, null, 2)
+  )
+  await fs.writeFile(
+    path.join(testSchemaDir, 'component.schema.json'),
+    JSON.stringify(componentSchema, null, 2)
+  )
+  await fs.writeFile(
+    path.join(testSchemaDir, 'course-extension.schema.json'),
+    JSON.stringify(coursePatchSchema, null, 2)
+  )
+
+  return testSchemaDir
+}
+
+async function runTests() {
+  console.log('=== Adapt Schema Library Tests ===\n')
+
+  const testSchemaDir =  hasSpecifiedPath
+    ? path.join(__dirname, process.argv[2])
+    : await setupTestSchemas()
+
+  try {
+    // Test 1: Initialize library
+    console.log('Test 1: Initialize library')
+    const library = new Schemas({
+      enableCache: true,
+      directoryReplacements: {
+        '$ROOT': process.cwd()
+      }
+    })
+    await library.init()
+    console.log('  ✓ Library initialized\n')
+
+    // Test 2: Load schemas with glob
+    console.log('Test 2: Load schemas with glob patterns')
+    await library.loadSchemas('**/*.schema.json', {
+      cwd: testSchemaDir,
+      ignore: ['**/excluded/**']
+    })
+    const schemaNames = library.getSchemaNames()
+    console.log(`  ✓ Loaded schemas: ${schemaNames.join(', ')}\n`)
+
+    // Test 3: Get schema
+    console.log('Test 3: Get built schema')
+    const courseBuilt = await library.getBuiltSchema('course')
+    console.log(`  ✓ Course schema has properties: ${Object.keys(courseBuilt.properties).join(', ')}\n`)
+
+    // Test 4: Get defaults
+    console.log('Test 4: Get schema defaults')
+    const courseDefaults = await library.getSchemaDefaults('course')
+    console.log(`  ✓ Course defaults:`, JSON.stringify(courseDefaults, null, 4).split('\n').map(l => '    ' + l).join('\n'), '\n')
+
+    // Test 5: Get _globals defaults
+    console.log('Test 5: Get _globals defaults')
+    const globalsDefaults = await library.getGlobalsDefaults('course')
+    console.log(`  ✓ _globals defaults:`, JSON.stringify(globalsDefaults, null, 4).split('\n').map(l => '    ' + l).join('\n'), '\n')
+
+    // Test 6: Validate data
+    console.log('Test 6: Validate data')
+    const validData = await library.validate('course', {
+      title: 'My Course'
+    })
+    console.log(`  ✓ Validated data has title: "${validData.title}"`)
+    console.log(`  ✓ Default description applied: "${validData.description}"\n`)
+
+    // Test 7: Validate with error (missing required field without defaults)
+    console.log('Test 7: Validation error handling')
+    try {
+      await library.validate('course', {
+        // Missing required title - disable defaults to trigger required error
+        _globals: { _accessibility: {} }
+      }, { useDefaults: false, ignoreRequired: false })
+      console.log('  ✗ Should have thrown validation error\n')
+    } catch (e) {
+      console.log(`  ✓ Caught validation error: ${e.code}`)
+      console.log(`  ✓ Error message: ${e.message}\n`)
+    }
+
+    // Test 7b: Validate with type error
+    console.log('Test 7b: Type validation error')
+    try {
+      await library.validate('course', {
+        title: 12345  // Should be string, not number
+      })
+      console.log('  ✗ Should have thrown validation error\n')
+    } catch (e) {
+      console.log(`  ✓ Caught type validation error: ${e.code}\n`)
+    }
+
+    // Test 8: Schema inheritance
+    console.log('Test 8: Schema inheritance')
+    const componentBuilt = await library.getBuiltSchema('component')
+    const hasInheritedBody = componentBuilt.properties.body !== undefined
+    const hasOwnComponent = componentBuilt.properties._component !== undefined
+    console.log(`  ✓ Component has inherited 'body' property: ${hasInheritedBody}`)
+    console.log(`  ✓ Component has own '_component' property: ${hasOwnComponent}\n`)
+
+    // Test 9: Schema info
+    console.log('Test 9: Schema info')
+    const info = library.getSchemaInfo()
+    console.log('  ✓ Schema info:')
+    Object.entries(info).forEach(([name, details]) => {
+      console.log(`    - ${name}: extensions=[${details.extensions.join(', ')}], isPatch=${details.isPatch}`)
+    })
+    console.log('')
+
+    // Test 10: Events
+    console.log('Test 10: Event handling')
+    library.on('schemaRegistered', (name) => {
+      console.log(`  ✓ Event received: schemaRegistered (${name})`)
+    })
+
+    // Create another test schema to trigger the event
+    const newSchemaPath = path.join(testSchemaDir, 'test-event.schema.json')
+    await fs.writeFile(newSchemaPath, JSON.stringify({
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "$anchor": "test-event",
+      "$merge": {
+        "source": { "$ref": "base" },
+        "with": { "properties": { "test": { "type": "string" } } }
+      }
+    }))
+    await library.registerSchema(newSchemaPath)
+    console.log('')
+
+    console.log('=== All tests passed! ===')
+
+  } finally {
+    if (hasSpecifiedPath) return
+    // Cleanup
+    await fs.rm(testSchemaDir, { recursive: true, force: true })
+  }
+}
+
+runTests().catch(console.error)