@kravc/schema 2.1.0 → 2.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kravc/schema",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "description": "Advanced JSON schema manipulation and validation library.",
   "keywords": [
     "JSON",
@@ -34,15 +34,15 @@
     "lodash.pick": "^4.4.0",
     "lodash.uniq": "^4.5.0",
     "security-context": "^4.0.0",
-    "validator": "^12.2.0",
-    "z-schema": "^5.0.0"
+    "validator": "^13.7.0",
+    "z-schema": "^5.0.2"
   },
   "devDependencies": {
-    "chai": "^4.2.0",
-    "eslint": "^7.12.1",
-    "js-yaml": "^3.13.1",
-    "jsonld": "^3.2.0",
-    "mocha": "^8.2.1",
+    "chai": "^4.3.4",
+    "eslint": "^8.6.0",
+    "js-yaml": "^4.1.0",
+    "jsonld": "^5.2.0",
+    "mocha": "^9.1.3",
     "nyc": "^15.0.1"
   },
   "nyc": {

package/src/CredentialFactory.js

@@ -29,13 +29,24 @@ class CredentialFactory {
     }
   }
 
+  get credentialType() {
+    const [ credentialType ] = this._uri.split('/').reverse()
+
+    return credentialType
+  }
+
+  get context() {
+    return {
+      [this.credentialType]: { '@id': this._uri },
+      ...this._context
+    }
+  }
+
   createCredential(id, holder, subject = {}) {
     validateId('id', id)
     validateId('holder', holder)
 
-    const [ credentialType ] = this._uri.split('/').reverse()
-
-    const type = [ 'VerifiableCredential', credentialType ]
+    const type = [ 'VerifiableCredential', this.credentialType ]
 
     const [ rootType ]      = this._types
     const credentialSubject = this._validator.validate(subject, rootType.id)
@@ -43,10 +54,7 @@ class CredentialFactory {
     return {
       '@context': [
         CREDENTIALS_CONTEXT_V1_URL,
-        {
-          [credentialType]: { '@id': this._uri },
-          ...this._context
-        }
+        this.context
       ],
       id,
       type,

package/src/Schema.spec.js

@@ -1,13 +1,13 @@
 'use strict'
 
+const { load }         = require('js-yaml')
 const { Schema }       = require('src')
 const { expect }       = require('chai')
-const { safeLoad }     = require('js-yaml')
 const { readFileSync } = require('fs')
 
 const loadSync = (yamlPath) => {
   const id     = yamlPath.split('.')[0].split('/').reverse()[0]
-  const source = safeLoad(readFileSync(yamlPath))
+  const source = load(readFileSync(yamlPath))
 
   return new Schema(source, id)
 }

package/src/Validator.js

@@ -1,9 +1,10 @@
 'use strict'
 
 const keyBy               = require('lodash.keyby')
+const groupBy             = require('lodash.groupby')
 const ZSchema             = require('z-schema')
+const getReferenceIds     = require('./helpers/getReferenceIds')
 const ValidationError     = require('./ValidationError')
-const verifyReferences    = require('./helpers/verifyReferences')
 const cleanupAttributes   = require('./helpers/cleanupAttributes')
 const normalizeAttributes = require('./helpers/normalizeAttributes')
 
@@ -13,6 +14,17 @@ class Validator {
       throw new Error('No schemas provided')
     }
 
+    const groupsById = groupBy(schemas, 'id')
+
+    for (const id in groupsById) {
+      const schemas       = groupsById[id]
+      const hasDuplicates = schemas.length > 1
+
+      if (hasDuplicates) {
+        throw new Error(`Multiple "${id}" schemas provided`)
+      }
+    }
+
     this._engine = new ZSchema({ ignoreUnknownFormats: true })
 
     const jsonSchemas = schemas.map(({ jsonSchema }) => jsonSchema)
@@ -23,8 +35,6 @@ class Validator {
       throw new Error(`Schemas validation failed:\n${json}`)
     }
 
-    verifyReferences(schemas)
-
     this._schemasMap     = keyBy(schemas, 'id')
     this._jsonSchemasMap = keyBy(jsonSchemas, 'id')
   }
@@ -66,6 +76,11 @@ class Validator {
   get schemasMap() {
     return this._schemasMap
   }
+
+  getReferenceIds(schemaId) {
+    const schema = this._schemasMap[schemaId]
+    return getReferenceIds(schema, this._schemasMap)
+  }
 }
 
 module.exports = Validator

package/src/Validator.spec.js

@@ -1,13 +1,13 @@
 'use strict'
 
+const { load }         = require('js-yaml')
 const { expect }       = require('chai')
-const { safeLoad }     = require('js-yaml')
 const { readFileSync } = require('fs')
 const { Schema, Validator } = require('src')
 
 const loadSync = (yamlPath) => {
   const id     = yamlPath.split('.')[0].split('/').reverse()[0]
-  const source = safeLoad(readFileSync(yamlPath))
+  const source = load(readFileSync(yamlPath))
 
   return new Schema(source, id)
 }
@@ -174,6 +174,19 @@ describe('Validator', () => {
         () => validator.validate({}, 'Account')
       ).to.throw('Schema "Account" not found')
     })
+
+    it('throws error if multiple schemas with same id', async () => {
+      const exampleSchema1 = new Schema({
+        number: { required: true }
+      }, 'Example')
+
+      const exampleSchema2 = new Schema({
+        id: {}
+      }, 'Example')
+
+      expect(() => new Validator([ exampleSchema1, exampleSchema2 ]))
+        .to.throw('Multiple "Example" schemas provided')
+    })
   })
 
   describe('.normalize(object, schemaId)', () => {
@@ -204,4 +217,13 @@ describe('Validator', () => {
       expect(validator.schemasMap).to.exist
     })
   })
+
+  describe('.getReferenceIds(schemaId)', () => {
+    it('returns ids of referenced schemas', () => {
+      const validator    = new Validator(SCHEMAS)
+      const referenceIds = validator.getReferenceIds('Profile')
+
+      expect(referenceIds).to.eql([ 'Status', 'FavoriteItem', 'Preferences' ])
+    })
+  })
 })

package/src/helpers/getReferenceIds.js

@@ -5,15 +5,9 @@ const Schema      = require('../Schema')
 const isUndefined = require('lodash.isundefined')
 
 const getReferenceIds = (schema, schemasMap) => {
-  let referenceIds = []
-
-  const getSchema = (id, referrerPath) => {
-    if (!schemasMap[id]) {
-      throw new Error(`Schema "${id}" not found, referenced by "${referrerPath}"`)
-    }
+  const getSchema = id => schemasMap[id]
 
-    return schemasMap[id]
-  }
+  let referenceIds = []
 
   const { jsonSchema } = schema
   const { id, enum: isEnum } = jsonSchema
@@ -67,7 +61,7 @@ const getReferenceIds = (schema, schemasMap) => {
       const itemSchema = new Schema(itemProperties, `${id}.${propertyName}.items.properties`)
       const itemReferenceIds = getReferenceIds(itemSchema, schemasMap)
 
-      referenceIds = [ ...referenceIds, itemReferenceIds ]
+      referenceIds = [ ...referenceIds, ...itemReferenceIds ]
       continue
     }
   }

package/src/index.js

@@ -4,6 +4,5 @@ module.exports = {
   Schema:            require('./Schema'),
   Validator:         require('./Validator'),
   documentLoader:    require('./ld/documentLoader'),
-  getReferenceIds:   require('./helpers/getReferenceIds'),
   CredentialFactory: require('./CredentialFactory')
 }

package/src/helpers/verifyReferences.js

@@ -1,26 +0,0 @@
-'use strict'
-
-const keyBy   = require('lodash.keyby')
-const groupBy = require('lodash.groupby')
-const getReferenceIds = require('./getReferenceIds')
-
-const verifyReferences = schemas => {
-  const groupsById = groupBy(schemas, 'id')
-
-  for (const id in groupsById) {
-    const schemas       = groupsById[id]
-    const hasDuplicates = schemas.length > 1
-
-    if (hasDuplicates) {
-      throw new Error(`Multiple "${id}" schemas defined`)
-    }
-  }
-
-  const schemasMap = keyBy(schemas, 'id')
-
-  for (const schema of schemas) {
-    getReferenceIds(schema, schemasMap)
-  }
-}
-
-module.exports = verifyReferences

package/src/helpers/verifyReferences.spec.js

@@ -1,29 +0,0 @@
-'use strict'
-
-const Schema     = require('../Schema')
-const { expect } = require('chai')
-const verifyReferences = require('./verifyReferences')
-
-describe('verifyReferences(schemas)', () => {
-  it('throws error if multiple schemas with same id', async () => {
-    const exampleSchema1 = new Schema({
-      number: { required: true }
-    }, 'Example')
-
-    const exampleSchema2 = new Schema({
-      id: {}
-    }, 'Example')
-
-    expect(() => verifyReferences([ exampleSchema1, exampleSchema2 ]))
-      .to.throw('Multiple "Example" schemas defined')
-  })
-
-  it('throws error if referenced schema not found', async () => {
-    const exampleSchema = new Schema({
-      document: { $ref: 'Document'}
-    }, 'Example')
-
-    expect(() => verifyReferences([ exampleSchema ]))
-      .to.throw('Schema "Document" not found, referenced by "Example.document.$ref"')
-  })
-})