Add explorer to inspect information about the schema

Author: bkeepers

lib/explorer.js

@@ -0,0 +1,42 @@
+import pointer from 'json-pointer'
+
+export class Explorer {
+  constructor (schemas, baseURI) {
+    this.schemas = schemas
+    this.baseURI = baseURI
+  }
+
+  // Get a ref from the schema
+  get (ref, baseURI = this.baseURI) {
+    const uri = new URL(ref, baseURI).href
+    const [$id, path] = uri.split('#')
+    const schema = this.schemas[$id]
+    return this.proxy(path ? pointer.get(schema, path) : schema, uri)
+  }
+
+  // Returns a proxy to the schema that resolves $refs
+  proxy (schema, uri) {
+    const self = this
+    return new Proxy(schema, {
+      get (target, property, receiver) {
+        const value = target[property]
+
+        if (value !== null && typeof value === 'object') {
+          // Schema returns an object for this property, proxy it as well
+          return new Proxy(value, this)
+        } else if (value !== undefined) {
+          // Schema returns a value for this property, return it
+          return value
+        } else if (target.$ref) {
+          // Schema includes a ref, so delegate to it
+          return self.get(target.$ref, uri)[property]
+        }
+      }
+    })
+  }
+
+  // Returns a list of the functions defined in the schema
+  get functions () {
+    return this.get('#/definitions/function/properties')
+  }
+}

lib/index.js

@@ -1,3 +1,7 @@
-export { default as schemas } from '../schemas'
-export { default as validate } from './validate'
+import schemas, { BaseURI } from '../schemas'
+import { Explorer } from './explorer'
+
+export const explorer = new Explorer(schemas, BaseURI)
+export { schemas }
 export { default as examples } from '../examples'
+export { default as validate } from './validate'

lib/validate.js

@@ -1,6 +1,6 @@
 import Ajv from 'ajv'
 import addFormats from 'ajv-formats'
-import schemas from '../schemas'
+import schemas, { BaseURI } from '../schemas'
 
 const ajv = new Ajv({
   schemas: Object.values(schemas),
@@ -9,7 +9,7 @@ const ajv = new Ajv({
   strict: true
 })
 addFormats(ajv)
-const validator = ajv.getSchema(schemas.default.$id)
+const validator = ajv.getSchema(BaseURI)
 
 function coerceArgsToArray (object) {
   if (object && typeof object === 'object') {

package.json

@@ -20,7 +20,8 @@
   "license": "MIT",
   "dependencies": {
     "ajv": "^8.12.0",
-    "ajv-formats": "^2.1.1"
+    "ajv-formats": "^2.1.1",
+    "json-pointer": "^0.6.2"
   },
   "devDependencies": {
     "standard": "^17.0.0",

schemas/index.js

@@ -1,7 +1,7 @@
 const modules = import.meta.glob('./*.json', { eager: true, import: 'default' })
-const schemas = Object.fromEntries(Object.entries(modules).map(([path, module]) => {
-  const name = path.split('/').pop().split('.').shift()
-  return [name === 'schema' ? 'default' : name, module]
+const schemas = Object.fromEntries(Object.values(modules).map(module => {
+  return [module.$id, module]
 }))
 
+export const BaseURI = modules['./schema.json'].$id
 export default schemas

test/explorer.test.js

@@ -0,0 +1,18 @@
+import { describe, test, expect } from 'vitest'
+import { explorer } from '../lib'
+
+describe('explorer', () => {
+  test('resolves refs', () => {
+    const schema = explorer.get('#')
+    expect(schema.anyOf).not.toBeUndefined()
+  })
+
+  describe('functions', () => {
+    test('returns all functions with their schemas', () => {
+      expect(Object.keys(explorer.functions)).toEqual(expect.arrayContaining([
+        'All', 'Any', 'Boolean', 'Time'
+      ]))
+      expect(explorer.functions.All.title).toEqual('All')
+    })
+  })
+})

yarn.lock

@@ -916,6 +916,11 @@ for-each@^0.3.3:
   dependencies:
     is-callable "^1.1.3"
 
+foreach@^2.0.4:
+  version "2.0.6"
+  resolved "https://registry.yarnpkg.com/foreach/-/foreach-2.0.6.tgz#87bcc8a1a0e74000ff2bf9802110708cfb02eb6e"
+  integrity sha512-k6GAGDyqLe9JaebCsFCoudPPWfihKu8pylYXRlqP1J7ms39iPoTtk2fviNglIeQEwdh0bQeKJ01ZPyuyQvKzwg==
+
 fs.realpath@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f"
@@ -1260,6 +1265,13 @@ json-parse-better-errors@^1.0.1:
   resolved "https://registry.yarnpkg.com/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz#bb867cfb3450e69107c131d1c514bab3dc8bcaa9"
   integrity sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==
 
+json-pointer@^0.6.2:
+  version "0.6.2"
+  resolved "https://registry.yarnpkg.com/json-pointer/-/json-pointer-0.6.2.tgz#f97bd7550be5e9ea901f8c9264c9d436a22a93cd"
+  integrity sha512-vLWcKbOaXlO+jvRy4qNd+TI1QUPZzfJj1tpJ3vAXDych5XJf93ftpUKe5pKCrzyIIwgBJcOcCVRUfqQP25afBw==
+  dependencies:
+    foreach "^2.0.4"
+
 json-schema-traverse@^0.4.1:
   version "0.4.1"
   resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz#69f6a87d9513ab8bb8fe63bdb0979c448e684660"