@bedrockio/yada 1.0.14 → 1.0.15

package/dist/cjs/Schema.js

@@ -21,6 +21,9 @@ class Schema {
 
   // Public
 
+  /**
+   * @returns {this}
+   */
   required() {
     return this.clone({
       required: true
@@ -30,6 +33,11 @@ class Schema {
       }
     });
   }
+
+  /**
+   * Sets the schema default. [Link](https://github.com/bedrockio/yada#default)
+   * @returns {this}
+   */
   default(value) {
     return this.clone({
       default: value
@@ -41,7 +49,9 @@ class Schema {
   }
 
   /**
+   * Validate by a custom function. [Link](https://github.com/bedrockio/yada#custom)
    * @param {CustomSignature} args
+   * @returns {this}
    */
   custom(...args) {
     let type, fn;
@@ -61,22 +71,46 @@ class Schema {
       return await fn(val, options);
     });
   }
+
+  /**
+   * Conditionally exclude fields inside an object schema.
+   * [Link](https://github.com/bedrockio/yada#strip)
+   * @returns {this}
+   */
   strip(strip) {
     return this.clone({
       strip
     });
   }
+
+  /**
+   * Accept values or schemas. [Link](https://github.com/bedrockio/yada#allow)
+   * @returns {this}
+   */
   allow(...set) {
     return this.assertEnum(set, true);
   }
+
+  /**
+   * Reject values or schemas. [Link](https://github.com/bedrockio/yada#reject)
+   * @returns {this}
+   */
   reject(...set) {
     return this.assertEnum(set, false);
   }
+
+  /**
+   * @returns {this}
+   */
   message(message) {
     return this.clone({
       message
     });
   }
+
+  /**
+   * @returns {this}
+   */
   tag(tags) {
     return this.clone({
       tags: {
@@ -85,11 +119,19 @@ class Schema {
       }
     });
   }
+
+  /**
+   * @returns {this}
+   */
   description(description) {
     return this.tag({
       description
     });
   }
+
+  /**
+   * @returns {this}
+   */
   options(options) {
     return this.clone({
       ...options
@@ -146,7 +188,8 @@ class Schema {
   }
 
   /**
-   * @returns {Schema}
+   * Appends another schema. [Link](https://github.com/bedrockio/yada#append)
+   * @returns {this}
    */
   append(schema) {
     const merged = this.clone(schema.meta);
@@ -178,6 +221,9 @@ class Schema {
 
   // Private
 
+  /**
+   * @returns {this}
+   */
   assertEnum(set, allow) {
     if (set.length === 1 && Array.isArray(set[0])) {
       set = set[0];
@@ -211,6 +257,10 @@ class Schema {
       }
     });
   }
+
+  /**
+   * @returns {this}
+   */
   assert(type, fn) {
     this.pushAssertion({
       halt: INITIAL_TYPES.includes(type),
@@ -226,6 +276,10 @@ class Schema {
       return this.getSortIndex(a.type) - this.getSortIndex(b.type);
     });
   }
+
+  /**
+   * @returns {this}
+   */
   transform(fn) {
     this.assert('transform', (val, options) => {
       if (val !== undefined) {

package/dist/cjs/array.js

@@ -3,23 +3,14 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.default = _default;
 var _Schema = _interopRequireDefault(require("./Schema"));
 var _errors = require("./errors");
-var _utils = require("./utils");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 class ArraySchema extends _Schema.default {
-  constructor(...args) {
-    let schemas, meta;
-    if (Array.isArray(args[0])) {
-      schemas = args[0];
-      meta = args[1];
-    } else {
-      schemas = args;
-    }
+  constructor(schemas) {
     super({
       message: 'Array failed validation.',
-      ...meta,
       schemas
     });
     this.setup();
@@ -143,10 +134,16 @@ class ArraySchema extends _Schema.default {
 }
 
 /**
- * @type {{
- *   (...schemas: Schema[]) : ArraySchema;
- *   (schemas: Schema[]) : ArraySchema;
- * }}
+ * Creates an [array schema](https://github.com/bedrockio/yada#array).
+ *
+ * @param {...Schema} [schemas] Optional schemas to validate
+ * the different types of elements allowed in the array. If
+ * no arguments are passed elements may be of any type. Also
+ * accepts a single array argument.
  */
-var _default = (0, _utils.wrapSchema)(ArraySchema);
-exports.default = _default;
+function _default(...schemas) {
+  if (Array.isArray(schemas[0])) {
+    schemas = schemas[0];
+  }
+  return new ArraySchema(schemas);
+}

package/dist/cjs/boolean.js

@@ -3,10 +3,9 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.default = _default;
 var _TypeSchema = _interopRequireDefault(require("./TypeSchema"));
 var _errors = require("./errors");
-var _utils = require("./utils");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 class BooleanSchema extends _TypeSchema.default {
   constructor() {
@@ -29,7 +28,8 @@ class BooleanSchema extends _TypeSchema.default {
 }
 
 /**
- * @type {function(): BooleanSchema}
+ * Creates a [boolean schema](https://github.com/bedrockio/yada#boolean).
  */
-var _default = (0, _utils.wrapSchema)(BooleanSchema);
-exports.default = _default;
+function _default() {
+  return new BooleanSchema();
+}

package/dist/cjs/date.js

@@ -3,9 +3,8 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.default = _default;
 var _validator = _interopRequireDefault(require("validator"));
-var _utils = require("./utils");
 var _errors = require("./errors");
 var _Schema = _interopRequireDefault(require("./Schema"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -154,7 +153,8 @@ class DateSchema extends _Schema.default {
 }
 
 /**
- * @type {() => DateSchema}
+ * Creates a [date schema](https://github.com/bedrockio/yada#date).
  */
-var _default = (0, _utils.wrapSchema)(DateSchema);
-exports.default = _default;
+function _default() {
+  return new DateSchema();
+}

package/dist/cjs/index.js

@@ -85,17 +85,29 @@ var _utils = require("./utils");
 var _localization = require("./localization");
 var _errors = require("./errors");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * Accepts anything.
+ */
 function any() {
   return new _Schema.default();
 }
+
+/**
+ * Accept values or schemas. [Link](https://github.com/bedrockio/yada#allow)
+ */
 function allow(...args) {
   return new _Schema.default().allow(...args);
 }
+
+/**
+ * Reject values or schemas. [Link](https://github.com/bedrockio/yada#reject)
+ */
 function reject(...args) {
   return new _Schema.default().reject(...args);
 }
 
 /**
+ * Validate by a custom function. [Link](https://github.com/bedrockio/yada#custom)
  * @param {import("./Schema").CustomSignature} args
  */
 function custom(...args) {

package/dist/cjs/number.js

@@ -3,10 +3,9 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.default = _default;
 var _TypeSchema = _interopRequireDefault(require("./TypeSchema"));
 var _errors = require("./errors");
-var _utils = require("./utils");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 class NumberSchema extends _TypeSchema.default {
   constructor() {
@@ -99,7 +98,8 @@ class NumberSchema extends _TypeSchema.default {
 }
 
 /**
- * @type {() => NumberSchema}
+ * Creates a [number schema](https://github.com/bedrockio/yada#number).
  */
-var _default = (0, _utils.wrapSchema)(NumberSchema);
-exports.default = _default;
+function _default() {
+  return new NumberSchema();
+}

package/dist/cjs/object.js

@@ -3,13 +3,17 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.default = _default;
 var _TypeSchema = _interopRequireDefault(require("./TypeSchema"));
 var _errors = require("./errors");
-var _utils = require("./utils");
-var _Schema = require("./Schema");
+var _Schema = _interopRequireDefault(require("./Schema"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const BASE_ASSERTIONS = ['type', 'transform', 'field'];
+
+/**
+ * @typedef {{ [key: string]: Schema } | {}} SchemaMap
+ */
+
 class ObjectSchema extends _TypeSchema.default {
   constructor(fields) {
     super(Object, {
@@ -91,14 +95,21 @@ class ObjectSchema extends _TypeSchema.default {
   }
 
   /**
-   * @param {object|ObjectSchema} arg
-   * @returns Schema
+   * @private
+   */
+  getFields() {
+    return this.meta.fields || {};
+  }
+
+  /**
+   * @param {SchemaMap|Schema} arg Object or schema to append.
    */
+  // @ts-ignore
   append(arg) {
     let schema;
     if (arg instanceof ObjectSchema) {
       schema = arg;
-    } else if ((0, _Schema.isSchema)(arg)) {
+    } else if (arg instanceof _Schema.default) {
       // If the schema is of a different type then
       // simply append it and don't merge fields.
       return super.append(arg);
@@ -121,9 +132,6 @@ class ObjectSchema extends _TypeSchema.default {
     }
     return merged;
   }
-  getFields() {
-    return this.meta.fields || {};
-  }
   toOpenApi(extra) {
     const properties = {};
     for (let [key, schema] of Object.entries(this.getFields())) {
@@ -139,7 +147,12 @@ class ObjectSchema extends _TypeSchema.default {
 }
 
 /**
- * @type {(arg: object) => ObjectSchema}
+ * Creates an [object schema](https://github.com/bedrockio/yada#object).
+ *
+ * @param {SchemaMap} [map] An map of keys to schemas.
+ * If not passed any object shape will be allowed. If an
+ * empty object is passed then no keys will be allowed.
  */
-var _default = (0, _utils.wrapSchema)(ObjectSchema);
-exports.default = _default;
+function _default(map) {
+  return new ObjectSchema(map);
+}

package/dist/cjs/string.js

@@ -3,11 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.default = _default;
 var _validator = _interopRequireDefault(require("validator"));
 var _TypeSchema = _interopRequireDefault(require("./TypeSchema"));
 var _errors = require("./errors");
-var _utils = require("./utils");
 var _password = require("./password");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const SLUG_REG = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
@@ -150,7 +149,7 @@ class StringSchema extends _TypeSchema.default {
   }
 
   /**
-   * @param {Object} [options]
+   * @param {object} [options]
    * @param {boolean} [options.urlSafe]
    */
   base64(options) {
@@ -223,7 +222,7 @@ class StringSchema extends _TypeSchema.default {
   }
 
   /**
-   * @param {Object} [options]
+   * @param {object} [options]
    * @param {number} [options.minLength]
    * @param {number} [options.minNumbers]
    * @param {number} [options.minSymbols]
@@ -261,7 +260,7 @@ class StringSchema extends _TypeSchema.default {
   }
 
   /**
-   * @param {Object} [options]
+   * @param {object} [options]
    * @param {boolean} [options.require_protocol]
    * @param {boolean} [options.require_valid_protocol]
    * @param {boolean} [options.require_host]
@@ -281,7 +280,7 @@ class StringSchema extends _TypeSchema.default {
   }
 
   /**
-   * @param {Object} [options]
+   * @param {object} [options]
    * @param {boolean} [options.require_tld=true]
    * @param {boolean} [options.allow_underscores=false]
    * @param {boolean} [options.allow_trailing_dot=false]
@@ -353,7 +352,8 @@ class StringSchema extends _TypeSchema.default {
 }
 
 /**
- * @type {() => StringSchema}
+ * Creates a [string schema](https://github.com/bedrockio/yada#string).
  */
-var _default = (0, _utils.wrapSchema)(StringSchema);
-exports.default = _default;
+function _default() {
+  return new StringSchema();
+}

package/dist/cjs/utils.js

@@ -15,11 +15,5 @@ Object.defineProperty(exports, "isSchemaError", {
     return _errors.isSchemaError;
   }
 });
-exports.wrapSchema = wrapSchema;
 var _Schema = require("./Schema");
-var _errors = require("./errors");
-function wrapSchema(Class) {
-  return (...args) => {
-    return new Class(...args);
-  };
-}
+var _errors = require("./errors");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/yada",
-  "version": "1.0.14",
+  "version": "1.0.15",
   "description": "Validation library inspired by Joi.",
   "scripts": {
     "test": "jest",
@@ -20,9 +20,9 @@
     "validator": "^13.9.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.19.3",
-    "@babel/core": "^7.19.6",
-    "@babel/preset-env": "^7.19.4",
+    "@babel/cli": "^7.20.7",
+    "@babel/core": "^7.20.12",
+    "@babel/preset-env": "^7.20.2",
     "@bedrockio/prettier-config": "^1.0.2",
     "babel-plugin-add-module-exports": "^1.0.4",
     "eslint": "^8.26.0",
@@ -31,12 +31,6 @@
     "prettier": "^2.7.1",
     "typescript": "^4.9.5"
   },
-  "exports": {
-    ".": {
-      "import": "./src/index.js",
-      "require": "./dist/cjs/index.js"
-    }
-  },
   "prettier": "@bedrockio/prettier-config",
   "volta": {
     "node": "18.13.0",

package/src/Schema.js

@@ -21,6 +21,9 @@ export default class Schema {
 
   // Public
 
+  /**
+   * @returns {this}
+   */
   required() {
     return this.clone({ required: true }).assert('required', (val) => {
       if (val === undefined) {
@@ -29,6 +32,10 @@ export default class Schema {
     });
   }
 
+  /**
+   * Sets the schema default. [Link](https://github.com/bedrockio/yada#default)
+   * @returns {this}
+   */
   default(value) {
     return this.clone({ default: value }).assert('default', (val) => {
       if (val === undefined) {
@@ -38,7 +45,9 @@ export default class Schema {
   }
 
   /**
+   * Validate by a custom function. [Link](https://github.com/bedrockio/yada#custom)
    * @param {CustomSignature} args
+   * @returns {this}
    */
   custom(...args) {
     let type, fn;
@@ -59,22 +68,41 @@ export default class Schema {
     });
   }
 
+  /**
+   * Conditionally exclude fields inside an object schema.
+   * [Link](https://github.com/bedrockio/yada#strip)
+   * @returns {this}
+   */
   strip(strip) {
     return this.clone({ strip });
   }
 
+  /**
+   * Accept values or schemas. [Link](https://github.com/bedrockio/yada#allow)
+   * @returns {this}
+   */
   allow(...set) {
     return this.assertEnum(set, true);
   }
 
+  /**
+   * Reject values or schemas. [Link](https://github.com/bedrockio/yada#reject)
+   * @returns {this}
+   */
   reject(...set) {
     return this.assertEnum(set, false);
   }
 
+  /**
+   * @returns {this}
+   */
   message(message) {
     return this.clone({ message });
   }
 
+  /**
+   * @returns {this}
+   */
   tag(tags) {
     return this.clone({
       tags: {
@@ -84,12 +112,18 @@ export default class Schema {
     });
   }
 
+  /**
+   * @returns {this}
+   */
   description(description) {
     return this.tag({
       description,
     });
   }
 
+  /**
+   * @returns {this}
+   */
   options(options) {
     return this.clone({ ...options });
   }
@@ -144,7 +178,8 @@ export default class Schema {
   }
 
   /**
-   * @returns {Schema}
+   * Appends another schema. [Link](https://github.com/bedrockio/yada#append)
+   * @returns {this}
    */
   append(schema) {
     const merged = this.clone(schema.meta);
@@ -172,6 +207,9 @@ export default class Schema {
 
   // Private
 
+  /**
+   * @returns {this}
+   */
   assertEnum(set, allow) {
     if (set.length === 1 && Array.isArray(set[0])) {
       set = set[0];
@@ -204,6 +242,9 @@ export default class Schema {
     });
   }
 
+  /**
+   * @returns {this}
+   */
   assert(type, fn) {
     this.pushAssertion({
       halt: INITIAL_TYPES.includes(type),
@@ -221,6 +262,9 @@ export default class Schema {
     });
   }
 
+  /**
+   * @returns {this}
+   */
   transform(fn) {
     this.assert('transform', (val, options) => {
       if (val !== undefined) {

package/src/array.js

@@ -1,19 +1,9 @@
 import Schema from './Schema';
 import { ArrayError, ElementError, LocalizedError } from './errors';
-import { wrapSchema } from './utils';
 
 class ArraySchema extends Schema {
-  constructor(...args) {
-    let schemas, meta;
-
-    if (Array.isArray(args[0])) {
-      schemas = args[0];
-      meta = args[1];
-    } else {
-      schemas = args;
-    }
-
-    super({ message: 'Array failed validation.', ...meta, schemas });
+  constructor(schemas) {
+    super({ message: 'Array failed validation.', schemas });
     this.setup();
   }
 
@@ -144,9 +134,16 @@ class ArraySchema extends Schema {
 }
 
 /**
- * @type {{
- *   (...schemas: Schema[]) : ArraySchema;
- *   (schemas: Schema[]) : ArraySchema;
- * }}
+ * Creates an [array schema](https://github.com/bedrockio/yada#array).
+ *
+ * @param {...Schema} [schemas] Optional schemas to validate
+ * the different types of elements allowed in the array. If
+ * no arguments are passed elements may be of any type. Also
+ * accepts a single array argument.
  */
-export default wrapSchema(ArraySchema);
+export default function (...schemas) {
+  if (Array.isArray(schemas[0])) {
+    schemas = schemas[0];
+  }
+  return new ArraySchema(schemas);
+}

package/src/boolean.js

@@ -1,6 +1,5 @@
 import TypeSchema from './TypeSchema';
 import { LocalizedError } from './errors';
-import { wrapSchema } from './utils';
 
 class BooleanSchema extends TypeSchema {
   constructor() {
@@ -23,6 +22,8 @@ class BooleanSchema extends TypeSchema {
 }
 
 /**
- * @type {function(): BooleanSchema}
+ * Creates a [boolean schema](https://github.com/bedrockio/yada#boolean).
  */
-export default wrapSchema(BooleanSchema);
+export default function () {
+  return new BooleanSchema();
+}

package/src/date.js

@@ -1,5 +1,4 @@
 import validator from 'validator';
-import { wrapSchema } from './utils';
 import { LocalizedError } from './errors';
 
 import Schema from './Schema';
@@ -147,6 +146,8 @@ class DateSchema extends Schema {
 }
 
 /**
- * @type {() => DateSchema}
+ * Creates a [date schema](https://github.com/bedrockio/yada#date).
  */
-export default wrapSchema(DateSchema);
+export default function () {
+  return new DateSchema();
+}

package/src/index.js

@@ -10,19 +10,29 @@ import { isSchema, isSchemaError } from './utils';
 import { useLocalizer, getLocalizedMessages } from './localization';
 import { LocalizedError } from './errors';
 
+/**
+ * Accepts anything.
+ */
 function any() {
   return new Schema();
 }
 
+/**
+ * Accept values or schemas. [Link](https://github.com/bedrockio/yada#allow)
+ */
 function allow(...args) {
   return new Schema().allow(...args);
 }
 
+/**
+ * Reject values or schemas. [Link](https://github.com/bedrockio/yada#reject)
+ */
 function reject(...args) {
   return new Schema().reject(...args);
 }
 
 /**
+ * Validate by a custom function. [Link](https://github.com/bedrockio/yada#custom)
  * @param {import("./Schema").CustomSignature} args
  */
 function custom(...args) {

package/src/number.js

@@ -1,6 +1,5 @@
 import TypeSchema from './TypeSchema';
 import { LocalizedError } from './errors';
-import { wrapSchema } from './utils';
 
 class NumberSchema extends TypeSchema {
   constructor() {
@@ -88,6 +87,8 @@ class NumberSchema extends TypeSchema {
 }
 
 /**
- * @type {() => NumberSchema}
+ * Creates a [number schema](https://github.com/bedrockio/yada#number).
  */
-export default wrapSchema(NumberSchema);
+export default function () {
+  return new NumberSchema();
+}

package/src/object.js

@@ -1,10 +1,13 @@
 import TypeSchema from './TypeSchema';
 import { FieldError, LocalizedError } from './errors';
-import { wrapSchema } from './utils';
-import { isSchema } from './Schema';
+import Schema from './Schema';
 
 const BASE_ASSERTIONS = ['type', 'transform', 'field'];
 
+/**
+ * @typedef {{ [key: string]: Schema } | {}} SchemaMap
+ */
+
 class ObjectSchema extends TypeSchema {
   constructor(fields) {
     super(Object, { message: 'Object failed validation.', fields });
@@ -80,14 +83,21 @@ class ObjectSchema extends TypeSchema {
   }
 
   /**
-   * @param {object|ObjectSchema} arg
-   * @returns Schema
+   * @private
    */
+  getFields() {
+    return this.meta.fields || {};
+  }
+
+  /**
+   * @param {SchemaMap|Schema} arg Object or schema to append.
+   */
+  // @ts-ignore
   append(arg) {
     let schema;
     if (arg instanceof ObjectSchema) {
       schema = arg;
-    } else if (isSchema(arg)) {
+    } else if (arg instanceof Schema) {
       // If the schema is of a different type then
       // simply append it and don't merge fields.
       return super.append(arg);
@@ -113,10 +123,6 @@ class ObjectSchema extends TypeSchema {
     return merged;
   }
 
-  getFields() {
-    return this.meta.fields || {};
-  }
-
   toOpenApi(extra) {
     const properties = {};
     for (let [key, schema] of Object.entries(this.getFields())) {
@@ -132,6 +138,12 @@ class ObjectSchema extends TypeSchema {
 }
 
 /**
- * @type {(arg: object) => ObjectSchema}
+ * Creates an [object schema](https://github.com/bedrockio/yada#object).
+ *
+ * @param {SchemaMap} [map] An map of keys to schemas.
+ * If not passed any object shape will be allowed. If an
+ * empty object is passed then no keys will be allowed.
  */
-export default wrapSchema(ObjectSchema);
+export default function (map) {
+  return new ObjectSchema(map);
+}

package/src/string.js

@@ -1,7 +1,6 @@
 import validator from 'validator';
 import TypeSchema from './TypeSchema';
 import { LocalizedError } from './errors';
-import { wrapSchema } from './utils';
 import {
   PASSWORD_DEFAULTS,
   validateLength,
@@ -155,7 +154,7 @@ class StringSchema extends TypeSchema {
   }
 
   /**
-   * @param {Object} [options]
+   * @param {object} [options]
    * @param {boolean} [options.urlSafe]
    */
   base64(options) {
@@ -235,7 +234,7 @@ class StringSchema extends TypeSchema {
   }
 
   /**
-   * @param {Object} [options]
+   * @param {object} [options]
    * @param {number} [options.minLength]
    * @param {number} [options.minNumbers]
    * @param {number} [options.minSymbols]
@@ -270,7 +269,7 @@ class StringSchema extends TypeSchema {
   }
 
   /**
-   * @param {Object} [options]
+   * @param {object} [options]
    * @param {boolean} [options.require_protocol]
    * @param {boolean} [options.require_valid_protocol]
    * @param {boolean} [options.require_host]
@@ -290,7 +289,7 @@ class StringSchema extends TypeSchema {
   }
 
   /**
-   * @param {Object} [options]
+   * @param {object} [options]
    * @param {boolean} [options.require_tld=true]
    * @param {boolean} [options.allow_underscores=false]
    * @param {boolean} [options.allow_trailing_dot=false]
@@ -364,6 +363,8 @@ class StringSchema extends TypeSchema {
 }
 
 /**
- * @type {() => StringSchema}
+ * Creates a [string schema](https://github.com/bedrockio/yada#string).
  */
-export default wrapSchema(StringSchema);
+export default function () {
+  return new StringSchema();
+}

package/src/utils.js

@@ -1,8 +1,2 @@
-export function wrapSchema(Class) {
-  return (...args) => {
-    return new Class(...args);
-  };
-}
-
 export { isSchema } from './Schema';
 export { isSchemaError } from './errors';

package/types/Schema.d.ts

@@ -6,33 +6,77 @@ export default class Schema {
     constructor(meta?: {});
     assertions: any[];
     meta: {};
-    required(): Schema;
-    default(value: any): Schema;
     /**
+     * @returns {this}
+     */
+    required(): this;
+    /**
+     * Sets the schema default. [Link](https://github.com/bedrockio/yada#default)
+     * @returns {this}
+     */
+    default(value: any): this;
+    /**
+     * Validate by a custom function. [Link](https://github.com/bedrockio/yada#custom)
      * @param {CustomSignature} args
+     * @returns {this}
+     */
+    custom(...args: CustomSignature): this;
+    /**
+     * Conditionally exclude fields inside an object schema.
+     * [Link](https://github.com/bedrockio/yada#strip)
+     * @returns {this}
+     */
+    strip(strip: any): this;
+    /**
+     * Accept values or schemas. [Link](https://github.com/bedrockio/yada#allow)
+     * @returns {this}
+     */
+    allow(...set: any[]): this;
+    /**
+     * Reject values or schemas. [Link](https://github.com/bedrockio/yada#reject)
+     * @returns {this}
+     */
+    reject(...set: any[]): this;
+    /**
+     * @returns {this}
      */
-    custom(...args: CustomSignature): Schema;
-    strip(strip: any): Schema;
-    allow(...set: any[]): Schema;
-    reject(...set: any[]): Schema;
-    message(message: any): Schema;
-    tag(tags: any): Schema;
-    description(description: any): Schema;
-    options(options: any): Schema;
+    message(message: any): this;
+    /**
+     * @returns {this}
+     */
+    tag(tags: any): this;
+    /**
+     * @returns {this}
+     */
+    description(description: any): this;
+    /**
+     * @returns {this}
+     */
+    options(options: any): this;
     validate(value: any, options?: {}): Promise<any>;
     /**
      * @returns {this}
      */
     clone(meta: any): this;
     /**
-     * @returns {Schema}
+     * Appends another schema. [Link](https://github.com/bedrockio/yada#append)
+     * @returns {this}
      */
-    append(schema: any): Schema;
+    append(schema: any): this;
     toOpenApi(extra: any): any;
-    assertEnum(set: any, allow: any): Schema;
-    assert(type: any, fn: any): Schema;
+    /**
+     * @returns {this}
+     */
+    assertEnum(set: any, allow: any): this;
+    /**
+     * @returns {this}
+     */
+    assert(type: any, fn: any): this;
     pushAssertion(assertion: any): void;
-    transform(fn: any): Schema;
+    /**
+     * @returns {this}
+     */
+    transform(fn: any): this;
     getSortIndex(type: any): number;
     runAssertion(assertion: any, value: any, options?: {}): Promise<any>;
     enumToOpenApi(): {

package/types/Schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AAgSA,4CAEC;AAvRD;;GAEG;AAEH;IACE,uBAGC;IAFC,kBAAoB;IACpB,SAAgB;IAKlB,mBAMC;IAED,4BAMC;IAED;;OAEG;IACH,gBAFW,eAAe,UAmBzB;IAED,0BAEC;IAED,6BAEC;IAED,8BAEC;IAED,8BAEC;IAED,uBAOC;IAED,sCAIC;IAED,8BAEC;IAED,iDAqCC;IAED;;OAEG;IACH,kBAFa,IAAI,CAOhB;IAED;;OAEG;IACH,qBAFa,MAAM,CAMlB;IAED,2BAgBC;IAID,yCA8BC;IAED,mCAQC;IAED,oCAKC;IAED,2BAOC;IAED,gCAGC;IAED,qEAUC;IAED;;;;;;;;MAoCC;CACF;8BAlRY,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,UAAU,CAAC"}
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.js"],"names":[],"mappings":"AA4UA,4CAEC;AAnUD;;GAEG;AAEH;IACE,uBAGC;IAFC,kBAAoB;IACpB,SAAgB;IAKlB;;OAEG;IACH,YAFa,IAAI,CAQhB;IAED;;;OAGG;IACH,qBAFa,IAAI,CAQhB;IAED;;;;OAIG;IACH,gBAHW,eAAe,GACb,IAAI,CAmBhB;IAED;;;;OAIG;IACH,mBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,sBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,uBAFa,IAAI,CAIhB;IAED;;OAEG;IACH,uBAFa,IAAI,CAIhB;IAED;;OAEG;IACH,gBAFa,IAAI,CAShB;IAED;;OAEG;IACH,+BAFa,IAAI,CAMhB;IAED;;OAEG;IACH,uBAFa,IAAI,CAIhB;IAED,iDAqCC;IAED;;OAEG;IACH,kBAFa,IAAI,CAOhB;IAED;;;OAGG;IACH,qBAFa,IAAI,CAMhB;IAED,2BAgBC;IAID;;OAEG;IACH,kCAFa,IAAI,CAgChB;IAED;;OAEG;IACH,4BAFa,IAAI,CAUhB;IAED,oCAKC;IAED;;OAEG;IACH,oBAFa,IAAI,CAShB;IAED,gCAGC;IAED,qEAUC;IAED;;;;;;;;MAoCC;CACF;8BA9TY,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,UAAU,CAAC"}

package/types/array.d.ts

@@ -1,11 +1,15 @@
-declare const _default: {
-    (...schemas: Schema[]): ArraySchema;
-    (schemas: Schema[]): ArraySchema;
-};
-export default _default;
+/**
+ * Creates an [array schema](https://github.com/bedrockio/yada#array).
+ *
+ * @param {...Schema} [schemas] Optional schemas to validate
+ * the different types of elements allowed in the array. If
+ * no arguments are passed elements may be of any type. Also
+ * accepts a single array argument.
+ */
+export default function _default(...schemas?: Schema[]): ArraySchema;
 import Schema from "./Schema";
 declare class ArraySchema extends Schema {
-    constructor(...args: any[]);
+    constructor(schemas: any);
     /**
      * @private
      */
@@ -15,4 +19,5 @@ declare class ArraySchema extends Schema {
     max(length: any): ArraySchema;
     latlng(): ArraySchema;
 }
+export {};
 //# sourceMappingURL=array.d.ts.map

package/types/array.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../src/array.js"],"names":[],"mappings":";iBAmJkB,MAAM,EAAE,GAAI,WAAW;cAC1B,MAAM,EAAE,GAAI,WAAW;;;;AAhJtC;IACE,4BAYC;IAED;;OAEG;IACH,cAwCC;IAED,iCAUC;IAED,8BAUC;IAED,8BAaC;IAED,sBAaC;CA2BF"}
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../src/array.js"],"names":[],"mappings":"AAuIA;;;;;;;GAOG;AACH,8CALc,MAAM,iBAUnB;;AAjJD;IACE,0BAGC;IAED;;OAEG;IACH,cAwCC;IAED,iCAUC;IAED,8BAUC;IAED,8BAaC;IAED,sBAaC;CA2BF"}

package/types/boolean.d.ts

@@ -1,7 +1,10 @@
-declare const _default: () => BooleanSchema;
-export default _default;
+/**
+ * Creates a [boolean schema](https://github.com/bedrockio/yada#boolean).
+ */
+export default function _default(): BooleanSchema;
 declare class BooleanSchema extends TypeSchema {
     constructor();
 }
 import TypeSchema from "./TypeSchema";
+export {};
 //# sourceMappingURL=boolean.d.ts.map

package/types/boolean.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"boolean.d.ts","sourceRoot":"","sources":["../src/boolean.js"],"names":[],"mappings":"8BAyBsB,aAAa;;AArBnC;IACE,cAgBC;CACF"}
+{"version":3,"file":"boolean.d.ts","sourceRoot":"","sources":["../src/boolean.js"],"names":[],"mappings":"AAuBA;;GAEG;AACH,kDAEC;AAzBD;IACE,cAgBC;CACF"}

package/types/date.d.ts

@@ -1,5 +1,7 @@
-declare const _default: () => DateSchema;
-export default _default;
+/**
+ * Creates a [date schema](https://github.com/bedrockio/yada#date).
+ */
+export default function _default(): DateSchema;
 declare class DateSchema extends Schema {
     constructor();
     /**
@@ -28,4 +30,5 @@ declare class DateSchema extends Schema {
     unix(): DateSchema;
 }
 import Schema from "./Schema";
+export {};
 //# sourceMappingURL=date.d.ts.map

package/types/date.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../src/date.js"],"names":[],"mappings":"wBAqJU,MAAM,UAAU;;AA/I1B;IACE,cAUC;IAED;;OAEG;IACH,SAFW,MAAM,GAAC,MAAM,GAAC,IAAI,cAY5B;IAED;;OAEG;IACH,SAFW,MAAM,GAAC,MAAM,GAAC,IAAI,cAY5B;IAED;;OAEG;IACH,YAFW,MAAM,GAAC,MAAM,GAAC,IAAI,cAY5B;IAED;;OAEG;IACH,WAFW,MAAM,GAAC,MAAM,GAAC,IAAI,cAY5B;IAED,mBAOC;IAED,qBAOC;IAED;;OAEG;IACH,aAFW,MAAM,GAAG,WAAW,cAW9B;IAED,wBASC;IAED,mBAWC;CAaF"}
+{"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../src/date.js"],"names":[],"mappings":"AAmJA;;GAEG;AACH,+CAEC;AAnJD;IACE,cAUC;IAED;;OAEG;IACH,SAFW,MAAM,GAAC,MAAM,GAAC,IAAI,cAY5B;IAED;;OAEG;IACH,SAFW,MAAM,GAAC,MAAM,GAAC,IAAI,cAY5B;IAED;;OAEG;IACH,YAFW,MAAM,GAAC,MAAM,GAAC,IAAI,cAY5B;IAED;;OAEG;IACH,WAFW,MAAM,GAAC,MAAM,GAAC,IAAI,cAY5B;IAED,mBAOC;IAED,qBAOC;IAED;;OAEG;IACH,aAFW,MAAM,GAAG,WAAW,cAW9B;IAED,wBASC;IAED,mBAWC;CAaF"}

package/types/index.d.ts

@@ -22,10 +22,20 @@ import date from "./date";
 import number from "./number";
 import object from "./object";
 import string from "./string";
+/**
+ * Accepts anything.
+ */
 export function any(): Schema;
+/**
+ * Accept values or schemas. [Link](https://github.com/bedrockio/yada#allow)
+ */
 export function allow(...args: any[]): Schema;
+/**
+ * Reject values or schemas. [Link](https://github.com/bedrockio/yada#reject)
+ */
 export function reject(...args: any[]): Schema;
 /**
+ * Validate by a custom function. [Link](https://github.com/bedrockio/yada#custom)
  * @param {import("./Schema").CustomSignature} args
  */
 export function custom(...args: import("./Schema").CustomSignature): Schema;

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAYA,8BAEC;AAED,8CAEC;AAED,+CAEC;AAED;;GAEG;AACH,gCAFW,OAAO,UAAU,EAAE,eAAe,UAI5C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAYA;;GAEG;AACH,8BAEC;AAED;;GAEG;AACH,8CAEC;AAED;;GAEG;AACH,+CAEC;AAED;;;GAGG;AACH,gCAFW,OAAO,UAAU,EAAE,eAAe,UAI5C"}

package/types/number.d.ts

@@ -1,5 +1,7 @@
-declare const _default: () => NumberSchema;
-export default _default;
+/**
+ * Creates a [number schema](https://github.com/bedrockio/yada#number).
+ */
+export default function _default(): NumberSchema;
 declare class NumberSchema extends TypeSchema {
     constructor();
     /**
@@ -18,4 +20,5 @@ declare class NumberSchema extends TypeSchema {
     multiple(multiple: any): NumberSchema;
 }
 import TypeSchema from "./TypeSchema";
+export {};
 //# sourceMappingURL=number.d.ts.map

package/types/number.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../src/number.js"],"names":[],"mappings":"wBA0FU,MAAM,YAAY;;AAtF5B;IACE,cAWC;IAED;;;OAGG;IACH,SAHW,MAAM,YACN,MAAM,gBAUhB;IAED;;;OAGG;IACH,SAHW,MAAM,YACN,MAAM,gBAUhB;IAED,yBAEC;IAED,yBAEC;IAED,wBAMC;IAED,sCAQC;CAiBF"}
+{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../src/number.js"],"names":[],"mappings":"AAwFA;;GAEG;AACH,iDAEC;AA1FD;IACE,cAWC;IAED;;;OAGG;IACH,SAHW,MAAM,YACN,MAAM,gBAUhB;IAED;;;OAGG;IACH,SAHW,MAAM,YACN,MAAM,gBAUhB;IAED,yBAEC;IAED,yBAEC;IAED,wBAMC;IAED,sCAQC;CAiBF"}

package/types/object.d.ts

@@ -1,5 +1,17 @@
-declare const _default: (arg: object) => ObjectSchema;
-export default _default;
+/**
+ * Creates an [object schema](https://github.com/bedrockio/yada#object).
+ *
+ * @param {SchemaMap} [map] An map of keys to schemas.
+ * If not passed any object shape will be allowed. If an
+ * empty object is passed then no keys will be allowed.
+ */
+export default function _default(map?: SchemaMap): ObjectSchema;
+export type SchemaMap = {} | {
+    [key: string]: Schema;
+};
+/**
+ * @typedef {{ [key: string]: Schema } | {}} SchemaMap
+ */
 declare class ObjectSchema extends TypeSchema {
     constructor(fields: any);
     /**
@@ -7,11 +19,15 @@ declare class ObjectSchema extends TypeSchema {
      */
     private setup;
     /**
-     * @param {object|ObjectSchema} arg
-     * @returns Schema
+     * @private
+     */
+    private getFields;
+    /**
+     * @param {SchemaMap|Schema} arg Object or schema to append.
      */
-    append(arg: object | ObjectSchema): any;
-    getFields(): any;
+    append(arg: SchemaMap | Schema): ObjectSchema;
 }
+import Schema from "./Schema";
 import TypeSchema from "./TypeSchema";
+export {};
 //# sourceMappingURL=object.d.ts.map

package/types/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"8BAsIgB,MAAM,KAAK,YAAY;;AA/HvC;IACE,yBAGC;IAED;;OAEG;IACH,cA+DC;IAED;;;OAGG;IACH,YAHW,MAAM,GAAC,YAAY,OA+B7B;IAED,iBAEC;CAcF"}
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../src/object.js"],"names":[],"mappings":"AA2IA;;;;;;GAMG;AACH,uCAJW,SAAS,gBAMnB;;;;AA9ID;;GAEG;AAEH;IACE,yBAGC;IAED;;OAEG;IACH,cA+DC;IAED;;OAEG;IACH,kBAEC;IAED;;OAEG;IAEH,YAHW,SAAS,GAAC,MAAM,gBA+B1B;CAcF"}

package/types/string.d.ts

@@ -1,5 +1,7 @@
-declare const _default: () => StringSchema;
-export default _default;
+/**
+ * Creates a [string schema](https://github.com/bedrockio/yada#string).
+ */
+export default function _default(): StringSchema;
 declare class StringSchema extends TypeSchema {
     constructor();
     /**
@@ -30,7 +32,7 @@ declare class StringSchema extends TypeSchema {
     sha1(): StringSchema;
     ascii(): StringSchema;
     /**
-     * @param {Object} [options]
+     * @param {object} [options]
      * @param {boolean} [options.urlSafe]
      */
     base64(options?: {
@@ -48,7 +50,7 @@ declare class StringSchema extends TypeSchema {
      */
     postalCode(locale?: string): StringSchema;
     /**
-     * @param {Object} [options]
+     * @param {object} [options]
      * @param {number} [options.minLength]
      * @param {number} [options.minNumbers]
      * @param {number} [options.minSymbols]
@@ -63,7 +65,7 @@ declare class StringSchema extends TypeSchema {
         minUppercase?: number;
     }): StringSchema;
     /**
-     * @param {Object} [options]
+     * @param {object} [options]
      * @param {boolean} [options.require_protocol]
      * @param {boolean} [options.require_valid_protocol]
      * @param {boolean} [options.require_host]
@@ -86,7 +88,7 @@ declare class StringSchema extends TypeSchema {
         protocols?: string[];
     }): StringSchema;
     /**
-     * @param {Object} [options]
+     * @param {object} [options]
      * @param {boolean} [options.require_tld=true]
      * @param {boolean} [options.allow_underscores=false]
      * @param {boolean} [options.allow_trailing_dot=false]
@@ -112,4 +114,5 @@ declare class StringSchema extends TypeSchema {
     mongo(): StringSchema;
 }
 import TypeSchema from "./TypeSchema";
+export {};
 //# sourceMappingURL=string.d.ts.map

package/types/string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.js"],"names":[],"mappings":"wBA8WU,MAAM,YAAY;;AA9V5B;IACE,cAWC;IAED;;OAEG;IACH,YAFW,MAAM,gBAUhB;IAED;;OAEG;IACH,YAFW,MAAM,gBAUhB;IAED,qBAIC;IAED;;OAEG;IACH,mBAFW,OAAO,gBAYjB;IAED;;OAEG;IACH,mBAFW,OAAO,gBAYjB;IAED;;OAEG;IACH,WAFW,MAAM,gBAahB;IAED,sBAMC;IAED,sBAMC;IAED,oBAMC;IAED,oBAMC;IAED,qBAMC;IAED,sBAMC;IAED;;;OAGG;IACH;QAF6B,OAAO,GAAzB,OAAO;qBAQjB;IAED,2BAMC;IAED,mBAMC;IAED,wBAMC;IAED,uBAMC;IAED,oBAMC;IAED,qBAOC;IAED,uBAMC;IAED;;OAEG;IACH,oBAFW,MAAM,gBAQhB;IAED;;;;;;;OAOG;IACH;QAN4B,SAAS,GAA1B,MAAM;QACW,UAAU,GAA3B,MAAM;QACW,UAAU,GAA3B,MAAM;QACW,YAAY,GAA7B,MAAM;QACW,YAAY,GAA7B,MAAM;qBA2BhB;IAED;;;;;;;;;;;OAWG;IACH;QAV6B,gBAAgB,GAAlC,OAAO;QACW,sBAAsB,GAAxC,OAAO;QACW,YAAY,GAA9B,OAAO;QACW,YAAY,GAA9B,OAAO;QACW,4BAA4B,GAA9C,OAAO;QACW,eAAe,GAAjC,OAAO;QACW,sBAAsB,GAAxC,OAAO;QACW,eAAe,GAAjC,OAAO;QACY,SAAS,GAA5B,MAAM,EAAE;qBAQlB;IAED;;;;;;;;OAQG;IACH;QAP6B,WAAW,GAA7B,OAAO;QACW,iBAAiB,GAAnC,OAAO;QACW,kBAAkB,GAApC,OAAO;QACW,iBAAiB,GAAnC,OAAO;QACW,cAAc,GAAhC,OAAO;QACW,iBAAiB,GAAnC,OAAO;qBAQjB;IAED;;OAEG;IACH,eAFW,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,gBAQ3B;IAED,oBAMC;IAED,oBAMC;IAED,sBAMC;IAED,sBAMC;CAcF"}
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.js"],"names":[],"mappings":"AA4WA;;GAEG;AACH,iDAEC;AAlWD;IACE,cAWC;IAED;;OAEG;IACH,YAFW,MAAM,gBAUhB;IAED;;OAEG;IACH,YAFW,MAAM,gBAUhB;IAED,qBAIC;IAED;;OAEG;IACH,mBAFW,OAAO,gBAYjB;IAED;;OAEG;IACH,mBAFW,OAAO,gBAYjB;IAED;;OAEG;IACH,WAFW,MAAM,gBAahB;IAED,sBAMC;IAED,sBAMC;IAED,oBAMC;IAED,oBAMC;IAED,qBAMC;IAED,sBAMC;IAED;;;OAGG;IACH;QAF6B,OAAO,GAAzB,OAAO;qBAQjB;IAED,2BAMC;IAED,mBAMC;IAED,wBAMC;IAED,uBAMC;IAED,oBAMC;IAED,qBAOC;IAED,uBAMC;IAED;;OAEG;IACH,oBAFW,MAAM,gBAQhB;IAED;;;;;;;OAOG;IACH;QAN4B,SAAS,GAA1B,MAAM;QACW,UAAU,GAA3B,MAAM;QACW,UAAU,GAA3B,MAAM;QACW,YAAY,GAA7B,MAAM;QACW,YAAY,GAA7B,MAAM;qBA2BhB;IAED;;;;;;;;;;;OAWG;IACH;QAV6B,gBAAgB,GAAlC,OAAO;QACW,sBAAsB,GAAxC,OAAO;QACW,YAAY,GAA9B,OAAO;QACW,YAAY,GAA9B,OAAO;QACW,4BAA4B,GAA9C,OAAO;QACW,eAAe,GAAjC,OAAO;QACW,sBAAsB,GAAxC,OAAO;QACW,eAAe,GAAjC,OAAO;QACY,SAAS,GAA5B,MAAM,EAAE;qBAQlB;IAED;;;;;;;;OAQG;IACH;QAP6B,WAAW,GAA7B,OAAO;QACW,iBAAiB,GAAnC,OAAO;QACW,kBAAkB,GAApC,OAAO;QACW,iBAAiB,GAAnC,OAAO;QACW,cAAc,GAAhC,OAAO;QACW,iBAAiB,GAAnC,OAAO;qBAQjB;IAED;;OAEG;IACH,eAFW,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,gBAQ3B;IAED,oBAMC;IAED,oBAMC;IAED,sBAMC;IAED,sBAMC;CAcF"}

package/types/utils.d.ts

@@ -1,4 +1,3 @@
-export function wrapSchema(Class: any): (...args: any[]) => any;
 export { isSchema } from "./Schema";
 export { isSchemaError } from "./errors";
 //# sourceMappingURL=utils.d.ts.map

package/types/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.js"],"names":[],"mappings":"AAAA,gEAIC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.js"],"names":[],"mappings":""}