@bedrock/validation 6.0.0

package/schemas/linkedDataSignature2018.js

@@ -0,0 +1,58 @@
+/*!
+ * Copyright (c) 2012-2022 Digital Bazaar, Inc. All rights reserved.
+ */
+import identifier from './identifier.js';
+import w3cDateTime from './w3cDateTime.js';
+
+const baseSignature = {
+  title: 'Linked Data Signature',
+  description: 'A Linked Data digital signature.',
+  // NOTE: id is not required
+  required: ['type', 'created', 'jws'],
+  type: 'object',
+  properties: {
+    id: identifier(),
+    type: {
+      title: 'Linked Data Signature Type',
+      type: 'string',
+      enum: ['Ed25519Signature2018', 'RsaSignature2018']
+    },
+    creator: identifier(),
+    created: w3cDateTime(),
+    jws: {
+      title: 'Digital Signature Value',
+      description: 'The Base64 encoding of the result of the signature ' +
+        'algorithm.',
+      type: 'string'
+    },
+    verificationMethod: identifier(),
+  },
+};
+
+const signature = {
+  allOf: [
+    baseSignature, {
+      // only one of `creator` or `verificationMethod`
+      anyOf: [{
+        required: ['creator'],
+        not: {required: ['verificationMethod']},
+      }, {
+        required: ['verificationMethod'],
+        not: {required: ['creator']},
+      }]
+    }
+  ]
+};
+
+const schema = {
+  title: 'Linked Data Signatures',
+  oneOf: [{
+    type: 'array',
+    items: signature,
+    minItems: 1,
+  }, signature]
+};
+
+export default function() {
+  return schema;
+}

package/schemas/linkedDataSignature2020.js

@@ -0,0 +1,42 @@
+/*!
+ * Copyright (c) 2021-2022 Digital Bazaar, Inc. All rights reserved.
+ */
+import identifier from './identifier.js';
+import w3cDateTime from './w3cDateTime.js';
+
+const signature = {
+  title: 'Ed25519Signature2020',
+  description: 'An Ed25519 Linked Data Signature (2020 cryptosuite).',
+  // NOTE: id is not required
+  required: ['type', 'created', 'verificationMethod', 'proofValue'],
+  type: 'object',
+  properties: {
+    id: identifier(),
+    type: {
+      title: 'Ed25519 Signature Type for 2020 Cryptosuite',
+      type: 'string',
+      enum: ['Ed25519Signature2020']
+    },
+    created: w3cDateTime(),
+    proofValue: {
+      title: 'Digital Signature Value',
+      description: 'The multibase base58-btc encoding of the result of ' +
+        'the signature algorithm.',
+      type: 'string'
+    },
+    verificationMethod: identifier(),
+  },
+};
+
+const schema = {
+  title: 'One or more Ed25519 signatures (2020 cryptosuite)',
+  oneOf: [{
+    type: 'array',
+    items: signature,
+    minItems: 1,
+  }, signature]
+};
+
+export default function() {
+  return schema;
+}

package/schemas/nonce.js

@@ -0,0 +1,25 @@
+/*!
+ * Copyright (c) 2012-2022 Digital Bazaar, Inc. All rights reserved.
+ */
+import * as bedrock from '@bedrock/core';
+
+const schema = {
+  title: 'Nonce',
+  description: 'A single use secure unique string.',
+  type: 'string',
+  pattern: '^[-a-zA-Z0-9~!$%^&*\\(\\)_=+\\. ]*$',
+  minLength: 8,
+  maxLength: 64,
+  errors: {
+    invalid: 'The nonce contains invalid characters or is not between ' +
+      '8 and 64 characters in length.',
+    missing: 'Please enter a nonce.'
+  }
+};
+
+export default function(extend) {
+  if(extend) {
+    return bedrock.util.extend(true, bedrock.util.clone(schema), extend);
+  }
+  return schema;
+}

package/schemas/personName.js

@@ -0,0 +1,25 @@
+/*!
+ * Copyright (c) 2012-2022 Digital Bazaar, Inc. All rights reserved.
+ */
+import * as bedrock from '@bedrock/core';
+
+const schema = {
+  title: 'Person Name',
+  description: 'The name of a person.',
+  type: 'string',
+  pattern: '^\\S$|^\\S.*\\S$',
+  minLength: 1,
+  maxLength: 100,
+  errors: {
+    invalid: 'The name must not start or end with whitespace and must ' +
+      'be between 1 and 100 characters in length.',
+    missing: 'Please enter a name.'
+  }
+};
+
+export default function(extend) {
+  if(extend) {
+    return bedrock.util.extend(true, bedrock.util.clone(schema), extend);
+  }
+  return schema;
+}

package/schemas/privateKeyPem.js

@@ -0,0 +1,23 @@
+/*!
+ * Copyright (c) 2012-2022 Digital Bazaar, Inc. All rights reserved.
+ */
+import * as bedrock from '@bedrock/core';
+
+const schema = {
+  title: 'Private Key PEM',
+  description: 'A cryptographic Private Key in PEM format.',
+  type: 'string',
+  // eslint-disable-next-line max-len
+  pattern: '^\\s*-----BEGIN RSA PRIVATE KEY-----[a-zA-Z0-9/+=\\s]*-----END RSA PRIVATE KEY-----\\s*$',
+  errors: {
+    invalid: 'The private key is not formatted correctly.',
+    missing: 'The private key is missing.'
+  }
+};
+
+export default function(extend) {
+  if(extend) {
+    return bedrock.util.extend(true, bedrock.util.clone(schema), extend);
+  }
+  return schema;
+}

package/schemas/publicKeyPem.js

@@ -0,0 +1,23 @@
+/*!
+ * Copyright (c) 2012-2022 Digital Bazaar, Inc. All rights reserved.
+ */
+import * as bedrock from '@bedrock/core';
+
+const schema = {
+  title: 'Public Key PEM',
+  description: 'A cryptographic Public Key in PEM format.',
+  type: 'string',
+  // eslint-disable-next-line max-len
+  pattern: '^\\s*-----BEGIN (RSA\\s)?PUBLIC KEY-----[a-zA-Z0-9/+=\\s]*-----END (RSA\\s)?PUBLIC KEY-----\\s*$',
+  errors: {
+    invalid: 'The public key is not formatted correctly.',
+    missing: 'The public key is missing.'
+  }
+};
+
+export default function(extend) {
+  if(extend) {
+    return bedrock.util.extend(true, bedrock.util.clone(schema), extend);
+  }
+  return schema;
+}

package/schemas/sequencedPatch.js

@@ -0,0 +1,31 @@
+/*!
+ * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
+ */
+import * as bedrock from '@bedrock/core';
+import jsonPatch from './jsonPatch.js';
+
+const schema = {
+  required: ['patch', 'sequence', 'target'],
+  title: 'Sequence-based JSON Patch',
+  type: 'object',
+  properties: {
+    target: {
+      type: 'string',
+    },
+    // FIXME: also support `frame` property later
+    patch: jsonPatch(),
+    sequence: {
+      type: 'integer',
+      minimum: 0,
+      maximum: Number.MAX_SAFE_INTEGER
+    }
+  },
+  additionalProperties: false
+};
+
+export default function(extend) {
+  if(extend) {
+    return bedrock.util.extend(true, bedrock.util.clone(schema), extend);
+  }
+  return schema;
+}

package/schemas/slug.js

@@ -0,0 +1,27 @@
+/*!
+ * Copyright (c) 2012-2022 Digital Bazaar, Inc. All rights reserved.
+ */
+import * as bedrock from '@bedrock/core';
+
+const schema = {
+  title: 'Slug',
+  description: 'A short identifier within a URL.',
+  type: 'string',
+  pattern: '^[a-z0-9][-a-z0-9~_\\.]*$',
+  minLength: 3,
+  maxLength: 40,
+  errors: {
+    invalid:
+      'The slug must start with a letter or number, contain only lowercase ' +
+      'letters, numbers, hyphens, periods, underscores, and tildes. It must ' +
+      'between 3 and 40 characters in length.',
+    missing: 'Please enter a slug.'
+  }
+};
+
+export default function(extend) {
+  if(extend) {
+    return bedrock.util.extend(true, bedrock.util.clone(schema), extend);
+  }
+  return schema;
+}

package/schemas/title.js

@@ -0,0 +1,25 @@
+/*!
+ * Copyright (c) 2012-2022 Digital Bazaar, Inc. All rights reserved.
+ */
+import * as bedrock from '@bedrock/core';
+
+const schema = {
+  title: 'Title',
+  description: 'A descriptive title.',
+  type: 'string',
+  pattern: '^[-a-zA-Z0-9~`!@#$%^&*\\(\\)\\[\\]{}<>_=+\\\\|:;\'"\\.,/? ]*$',
+  minLength: 1,
+  maxLength: 200,
+  errors: {
+    invalid: 'The title contains invalid characters or is not between ' +
+      '1 and 200 characters in length.',
+    missing: 'Please enter a title.'
+  }
+};
+
+export default function(extend) {
+  if(extend) {
+    return bedrock.util.extend(true, bedrock.util.clone(schema), extend);
+  }
+  return schema;
+}

package/schemas/url.js

@@ -0,0 +1,22 @@
+/*!
+ * Copyright (c) 2012-2022 Digital Bazaar, Inc. All rights reserved.
+ */
+import * as bedrock from '@bedrock/core';
+
+const schema = {
+  title: 'URL',
+  description: 'A universal resource location.',
+  type: 'string',
+  minLength: 1,
+  errors: {
+    invalid: 'Please enter a valid URL.',
+    missing: 'Please enter a URL.'
+  }
+};
+
+export default function(extend) {
+  if(extend) {
+    return bedrock.util.extend(true, bedrock.util.clone(schema), extend);
+  }
+  return schema;
+}

package/schemas/w3cDateTime.js

@@ -0,0 +1,24 @@
+/*!
+ * Copyright (c) 2012-2022 Digital Bazaar, Inc. All rights reserved.
+ */
+import * as bedrock from '@bedrock/core';
+
+const schema = {
+  title: 'W3C Date/Time',
+  description: 'A W3C-formatted date and time combination.',
+  type: 'string',
+  // eslint-disable-next-line max-len
+  pattern: '^[1-9][0-9]{3}-(0[1-9]|1[0-2])-([0-2][0-9]|3[0-1])T([0-1][0-9]|2[0-3]):([0-5][0-9]):(([0-5][0-9])|60)(\\.[0-9]+)?(Z|((\\+|-)([0-1][0-9]|2[0-3]):([0-5][0-9])))?$',
+  errors: {
+    // eslint-disable-next-line max-len
+    invalid: 'The date/time must be of the W3C date/time format "YYYY-MM-DD( |T)HH:MM:SS.s(Z|(+|-)TZOFFSET)".',
+    missing: 'Please enter a date/time.'
+  }
+};
+
+export default function(extend) {
+  if(extend) {
+    return bedrock.util.extend(true, bedrock.util.clone(schema), extend);
+  }
+  return schema;
+}

package/test/mocha/.eslintrc

@@ -0,0 +1,9 @@
+{
+  "env": {
+    "mocha": true
+  },
+  "globals": {
+    "assertNoError": true,
+    "should": true
+  }
+}