@bedrock/validation 7.0.0 → 7.1.1

package/.eslintrc.cjs

@@ -1,12 +1,15 @@
 module.exports = {
   root: true,
-  parserOptions: {
-    // this is required for dynamic import()
-    ecmaVersion: 2020
-  },
   env: {
     node: true
   },
-  extends: ['digitalbazaar', 'digitalbazaar/jsdoc'],
-  ignorePatterns: ['node_modules/']
+  extends: [
+    'digitalbazaar',
+    'digitalbazaar/jsdoc',
+    'digitalbazaar/module'
+  ],
+  ignorePatterns: ['node_modules/'],
+  rules: {
+    'unicorn/prefer-node-protocol': 'error'
+  }
 };

package/.github/workflows/main.yml

@@ -8,11 +8,11 @@ jobs:
     timeout-minutes: 10
     strategy:
       matrix:
-        node-version: [18.x]
+        node-version: [22.x]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm install
@@ -24,11 +24,11 @@ jobs:
     timeout-minutes: 10
     strategy:
       matrix:
-        node-version: [14.x, 16.x, 18.x]
+        node-version: [18.x, 20.x, 22.x]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
     - run: |
@@ -45,11 +45,11 @@ jobs:
     timeout-minutes: 10
     strategy:
       matrix:
-        node-version: [18.x]
+        node-version: [22.x]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
     - run: |
@@ -61,7 +61,8 @@ jobs:
         cd test
         npm run coverage-ci
     - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v2
+      uses: codecov/codecov-action@v4
       with:
         file: ./test/coverage/lcov.info
         fail_ci_if_error: true
+        token: ${{ secrets.CODECOV_TOKEN }}

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # bedrock-validation ChangeLog
 
+## 7.1.1 - 2024-11-14
+
+### Changed
+- Test and support Node.js 18, 20, 22.
+- Update dependencies:
+  - `ajv@6.12.6`
+  - `klona@2.0.6`
+- Update dev dependencies.
+- Fix lint issues.
+
+### Fixed
+- Errors now use the spelling `occurred` vs the typo `occured`.
+  - **NOTE**: This typo is known to be present in many tests of error message
+    and will require similar typo fixes.
+
+## 7.1.0 - 2022-10-16
+
+### Added
+- Added a validator for `VerifiablePresentation`
+- Added a validator for `VerifiableCredential`.
+
+### Changed
+- The `credential` and `presentation` schemas are now deprecated and
+  will be removed in a future major release.
+
 ## 7.0.0 - 2022-04-28
 
 ### Changed

package/README.md

@@ -18,7 +18,8 @@ npm install @bedrock/validation
 
 ```js
 import * as bedrock from '@bedrock/core';
-import {validate} from '@bedrock/validation';
+import {postBarValidator, postBarQueryValidator} from '../schemas/my-schemas.js';
+import {createValidateMiddleware as validate} from '@bedrock/validation';
 
 // load schemas from '/foo'
 bedrock.config.validation.schema.paths.push('/foo');
@@ -28,7 +29,7 @@ bedrock.events.on('bedrock-express.configure.routes', function(app) {
   app.post('/bar',
     // validate the query using the 'postBarQueryValidator'
     // validate the response body using the 'postBarValidator'
-    validate({query: 'postBarQueryValidator', body: 'postBarValidator'}),
+    validate({querySchema: postBarQueryValidator, bodySchema: postBarValidator}),
     function(req, res) {
       // do something
     });
@@ -50,23 +51,12 @@ For more documentation on configuration, see [config.js](./lib/config.js).
 
 ## API
 
-### validate(name, [data])
+### createValidateMiddleware({querySchema: schema, bodySchema: schema})
 
-This method may be called with either one or two parameters.
+This method may be called with either `query` or `body` defined.
 
-If only one parameter is given:
-
-* The method returns express middleware that will be used to validate a request
-  using the schema associated with the given name.
-* If a string is provided for the first parameter, then it will be used as the
-  schema name for validating the request body.
-* If an object is provided for the first parameter, then the object can contain
-  `body` and `query` schema names as properties of the object.
-
-If two parameters are given:
-
-* The first parameter must be a string and the second parameter must be the
-  data to validate. The return value will contain the result of the validation.
+The method returns express middleware that will be used to validate a request
+using the schema associated with either `query` or `body`.
 
 ### getSchema(name)
 

package/lib/index.js

@@ -241,8 +241,8 @@ function _createError({schema, instance}) {
   }
 
   const msg = schema.title ?
-    'A validation error occured in the \'' + schema.title + '\' validator.' :
-    'A validation error occured in an unnamed validator.';
+    'A validation error occurred in the \'' + schema.title + '\' validator.' :
+    'A validation error occurred in an unnamed validator.';
   const error = new BedrockError(
     msg, 'ValidationError', {public: true, errors, httpStatusCode: 400});
 

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@bedrock/validation",
-  "version": "7.0.0",
+  "version": "7.1.1",
   "type": "module",
   "description": "Bedrock validation",
   "main": "./lib/index.js",
   "scripts": {
-    "lint": "eslint ."
+    "lint": "eslint --ext .cjs,.js ."
   },
   "repository": {
     "type": "git",
@@ -24,19 +24,19 @@
   },
   "homepage": "https://github.com/digitalbazaar/bedrock-validation",
   "dependencies": {
-    "ajv": "^6.12.0",
-    "klona": "^2.0.5"
+    "ajv": "^6.12.6",
+    "klona": "^2.0.6"
   },
   "peerDependencies": {
-    "@bedrock/core": "^6.0.0"
+    "@bedrock/core": "^6.2.0"
   },
   "directories": {
     "lib": "./lib"
   },
   "devDependencies": {
-    "eslint": "^7.32.0",
-    "eslint-config-digitalbazaar": "^2.8.0",
-    "eslint-plugin-jsdoc": "^37.9.7",
-    "jsdoc-to-markdown": "^7.1.1"
+    "eslint": "^8.57.1",
+    "eslint-config-digitalbazaar": "^5.2.0",
+    "eslint-plugin-jsdoc": "^50.5.0",
+    "eslint-plugin-unicorn": "^56.0.0"
   }
 }

package/schemas/helpers/idOrObjectWithId.js

@@ -0,0 +1,26 @@
+/*!
+ * Copyright (c) 2012-2022 Digital Bazaar, Inc. All rights reserved.
+ */
+import {extend as _extend} from '../../lib/helpers.js';
+import identifier from '../identifier.js';
+import {klona} from 'klona';
+
+const schema = {
+  title: 'identifier or an object with an id',
+  anyOf: [
+    identifier(),
+    {
+      type: 'object',
+      additionalProperties: true,
+      properties: {id: identifier()},
+      required: ['id']
+    }
+  ]
+};
+
+export default function(extend) {
+  if(extend) {
+    return _extend(true, klona(schema), extend);
+  }
+  return schema;
+}

package/schemas/proof.js

@@ -0,0 +1,21 @@
+/*!
+ * Copyright (c) 2012-2022 Digital Bazaar, Inc. All rights reserved.
+ */
+import {extend as _extend} from '../lib/helpers.js';
+import {klona} from 'klona';
+
+// schema for a proof on a VerifiableCredential or Presentation
+const schema = {
+  title: 'Proof',
+  anyOf: [
+    {type: 'object'},
+    {type: 'array', minItems: 1, items: {type: 'object'}}
+  ]
+};
+
+export default function(extend) {
+  if(extend) {
+    return _extend(true, klona(schema), extend);
+  }
+  return schema;
+}

package/schemas/verifiableCredential.js

@@ -0,0 +1,67 @@
+/*!
+ * Copyright (c) 2012-2022 Digital Bazaar, Inc. All rights reserved.
+ */
+import {extend as _extend} from '../lib/helpers.js';
+import idOrObjectWithId from './helpers/idOrObjectWithId.js';
+import {klona} from 'klona';
+import proof from './proof.js';
+import w3cDateTime from './w3cDateTime.js';
+
+// https://www.w3.org/TR/vc-data-model/
+// Based off of the VC Data Model 1.1
+const schema = {
+  type: 'object',
+  title: 'Verifiable Credential',
+  additionalProperties: true,
+  properties: {
+    '@context': {
+      type: 'array',
+      minItems: 1,
+      // the first context must be the VC context
+      items: [{
+        type: 'string',
+        const: 'https://www.w3.org/2018/credentials/v1'
+      }],
+      // additional contexts maybe strings or objects
+      additionalItems: {
+        anyOf: [{type: 'string'}, {type: 'object'}]
+      }
+    },
+    credentialSubject: {
+      anyOf: [
+        {type: 'object'},
+        {type: 'array', minItems: 1, items: {type: 'object'}}
+      ]
+    },
+    id: idOrObjectWithId(),
+    issuer: idOrObjectWithId(),
+    issuanceDate: w3cDateTime(),
+    proof: proof(),
+    type: {
+      type: 'array',
+      minItems: 1,
+      // this first type must be VerifiableCredential
+      items: [
+        {type: 'string', const: 'VerifiableCredential'},
+      ],
+      // additional types must be strings
+      additionalItems: {
+        type: 'string'
+      }
+    }
+  },
+  required: [
+    '@context',
+    'credentialSubject',
+    'issuer',
+    'issuanceDate',
+    'type'
+  ]
+};
+
+export default function(extend) {
+  if(extend) {
+    return _extend(true, klona(schema), extend);
+  }
+  return schema;
+}

package/schemas/verifiablePresentation.js

@@ -0,0 +1,58 @@
+/*!
+ * Copyright (c) 2012-2022 Digital Bazaar, Inc. All rights reserved.
+ */
+import {extend as _extend} from '../lib/helpers.js';
+import idOrObjectWithId from './helpers/idOrObjectWithId.js';
+import {klona} from 'klona';
+import proof from './proof.js';
+import verifiableCredential from './verifiableCredential.js';
+
+const schema = {
+  title: 'Verifiable Presentation',
+  type: 'object',
+  additionalProperties: true,
+  properties: {
+    '@context': {
+      type: 'array',
+      minItems: 1,
+      // the first context must be the VC context
+      items: [{
+        type: 'string',
+        const: 'https://www.w3.org/2018/credentials/v1'
+      }],
+      // additional contexts maybe strings or objects
+      additionalItems: {
+        anyOf: [{type: 'string'}, {type: 'object'}]
+      }
+    },
+    id: idOrObjectWithId(),
+    type: {
+      type: 'array',
+      minItems: 1,
+      // this first type must be VerifiablePresentation
+      items: [
+        {type: 'string', const: 'VerifiablePresentation'},
+      ],
+      // additional types must be strings
+      additionalItems: {
+        type: 'string'
+      }
+    },
+    verifiableCredential: {
+      anyOf: [
+        verifiableCredential(),
+        {type: 'array', minItems: 1, items: verifiableCredential()}
+      ]
+    },
+    holder: idOrObjectWithId(),
+    proof: proof()
+  },
+  required: ['@context', 'type']
+};
+
+export default function(extend) {
+  if(extend) {
+    return _extend(true, klona(schema), extend);
+  }
+  return schema;
+}

package/test/mocha/001-schemas.js

@@ -986,36 +986,49 @@ describe('bedrock-validation', function() {
     });
   });
 
-  describe('credential', function() {
-    const schema = validation.getSchema({name: 'credential'});
+  describe('verifiableCredential', function() {
+    const schema = validation.getSchema({name: 'verifiableCredential'});
     it('should be an Object', function() {
       schema.should.be.an.instanceof(Object);
     });
     it('should validate a credential', function() {
-      const credential = {
-        issuer: 'test',
-        issued: '1997-07-16T19:20:30',
-        claim: {
-          id: '1234'
-        }
-      };
+      const credential = {...mock.credentials.valid};
       const result = validateInstance({instance: credential, schema});
       result.valid.should.be.true;
     });
     it('should validate a credential with an extend', function() {
-      const credential = {
-        issuer: 'test',
-        issued: '2016-01-01T01:00:00Z',
-        claim: {
-          id: '1234'
-        }
-      };
+      const credential = {...mock.credentials.valid};
       const extend = {name: 'test'};
-      const schema = validation.schemas.credential(extend);
+      const schema = validation.schemas.verifiableCredential(extend);
       const result = validateInstance({instance: credential, schema});
       schema.name.should.equal('test');
       result.valid.should.be.true;
     });
+    it('should not validate a credential with an invalid @context', function() {
+      const credential = {...mock.credentials.invalid.invalidContext};
+      const result = validateInstance({instance: credential, schema});
+      result.valid.should.be.false;
+    });
+  });
+
+  describe('verifiablePresentation', function() {
+    const schema = validation.getSchema({name: 'verifiablePresentation'});
+    it('should be an Object', function() {
+      schema.should.be.an.instanceof(Object);
+    });
+    it('should validate a presentation', function() {
+      const presentation = {...mock.presentations.valid};
+      const result = validateInstance({instance: presentation, schema});
+      result.valid.should.be.true;
+    });
+    it('should validate a presentation with an extend', function() {
+      const presentation = {...mock.presentations.valid};
+      const extend = {name: 'test'};
+      const schema = validation.schemas.verifiablePresentation(extend);
+      const result = validateInstance({instance: presentation, schema});
+      schema.name.should.equal('test');
+      result.valid.should.be.true;
+    });
   });
 
   describe('jsonPatch', function() {

package/test/mocha/mock.data.js

@@ -43,3 +43,33 @@ keys.alpha = {
     '42EADs/ajTEckTxULdirbEk2rINRwQC5kWMde3fcwAnn6xt3wvOyuwg=\n' +
     '-----END RSA PRIVATE KEY-----'
 };
+
+const credentialsContext = 'https://www.w3.org/2018/credentials/v1';
+const credentials = mock.credentials = {};
+
+credentials.valid = {
+  '@context': [credentialsContext, 'https://www.schema.org'],
+  id: 'urn:uuid:test-vc',
+  issuer: 'test',
+  issuanceDate: '1997-07-16T19:20:30',
+  type: ['VerifiableCredential', 'TestCredential'],
+  credentialSubject: {
+    id: '1234'
+  }
+};
+
+credentials.invalid = {
+  invalidContext: {
+    ...credentials.valid,
+    '@context': ['https://www.schema.org']
+  }
+};
+
+const presentations = mock.presentations = {};
+
+presentations.valid = {
+  '@context': [credentialsContext],
+  type: ['VerifiablePresentation'],
+  id: 'urn:uuid:test-vc',
+  verifiableCredential: [{...credentials.valid}]
+};