@bedrockio/yada 1.9.0 → 1.10.0

package/CHANGELOG.md

@@ -1,10 +1,12 @@
-## 1.8.2
-
-- Fixed array schemas not passing through `requireAllWithin`.
+## 1.10.0
 
-## 1.8.1
-
-- Fixed bug with tagging in `toOpenApi`.
+- Added `style` option to `toJsonSchema` to control disallowed formats for
+  OpenAI.
+- Now using `integer` as the type for integers in JSON schema.
+- Allow stripping out JSON schema extensions by option.
+- More strictly following JSON schema for nullable.
+- Allow flags to flip off required and nullable.
+- Moved `requireAllWithin` to `transform`.
 
 ## 1.9.0
 
@@ -14,6 +16,14 @@
 
 - Fixed issue with incorrect JSON schema when nested.
 
+## 1.8.2
+
+- Fixed array schemas not passing through `requireAllWithin`.
+
+## 1.8.1
+
+- Fixed bug with tagging in `toOpenApi`.
+
 ## 1.8.0
 
 - Removed undefined `format` field.

package/dist/cjs/Schema.js

@@ -7,6 +7,7 @@ exports.default = void 0;
 exports.isSchema = isSchema;
 var _lodash = require("lodash");
 var _errors = require("./errors");
+var _formats = require("./formats");
 var _utils = require("./utils");
 const INITIAL_TYPES = ['default', 'required', 'type', 'transform', 'empty'];
 const REQUIRED_TYPES = ['default', 'required', 'missing'];
@@ -22,13 +23,14 @@ class Schema {
   // Public
 
   /**
+   * @param {boolean} [allow=true]
    * @returns {this}
    */
-  required() {
+  required(allow = true) {
     return this.clone({
-      required: true
-    }).assert('required', val => {
-      if (val === undefined) {
+      required: allow
+    }).assert('required', (val, options) => {
+      if (val === undefined && options.required) {
         throw new _errors.LocalizedError('Value is required.');
       }
     });
@@ -106,11 +108,12 @@ class Schema {
 
   /**
    * Allow null. [Link](https://github.com/bedrockio/yada#nullable)
+   * @param {boolean} [allow=true]
    * @returns {this}
    */
-  nullable() {
+  nullable(allow = true) {
     return this.clone({
-      nullable: true
+      nullable: allow
     });
   }
 
@@ -217,22 +220,22 @@ class Schema {
 
   /**
    * Exports the schema in [JSON Schema](https://json-schema.org/) format.
-   * Note that this may not represent the schema in its enitrety. Specifically,
+   * Note that this may not represent the schema in its entirety. Specifically,
    * custom (code-based) assertions will not be output.
-   * @param {Object} [extra]
+   * @param {Object} [options]
+   * @param {Function} [options.tag] - Allows adding additional custom tags.
+   * @param {'openai'} [options.style] - Constrains schema output. Currently only
+   *   supports OpenAI which will ensure the resulting schema works with the Structured
+   *   Outputs API.
+   * @param {boolean} [options.stripExtensions] - Strips out JSON schema extensions.
    */
-  toJsonSchema(extra) {
-    const {
-      tags
-    } = this.meta;
+  toJsonSchema(options) {
     return {
-      ...tags,
-      ...this.getAnyType(),
+      ...this.getType(),
       ...this.getDefault(),
-      ...this.getNullable(),
-      ...this.getFormat(),
-      ...this.getEnum(),
-      ...this.expandExtra(extra)
+      ...this.getEnum(options),
+      ...this.getTags(options),
+      ...this.getFormat(options)
     };
   }
 
@@ -240,8 +243,8 @@ class Schema {
    * Exports the schema in [JSON Schema](https://json-schema.org/) format.
    * @alias toJsonSchema.
    */
-  toOpenApi(...extra) {
-    return this.toJsonSchema(...extra);
+  toOpenApi(options) {
+    return this.toJsonSchema(options);
   }
 
   /**
@@ -250,22 +253,26 @@ class Schema {
   toJSON() {
     return this.toJsonSchema();
   }
-  getAnyType() {
+  getType() {
     const {
       type,
-      enum: set
+      nullable
     } = this.meta;
-    if (!type && !set) {
+    if (type && nullable) {
+      return {
+        type: [type, 'null']
+      };
+    } else if (type) {
       return {
-        type: ['object', 'array', 'string', 'number', 'boolean', 'null']
+        type
       };
     }
   }
-  getFormat() {
+  getFormat(options) {
     const {
       format
     } = this.meta;
-    if (format) {
+    if ((0, _formats.isAllowedFormat)(format, options)) {
       return {
         format
       };
@@ -283,17 +290,7 @@ class Schema {
       };
     }
   }
-  getNullable() {
-    const {
-      nullable
-    } = this.meta;
-    if (nullable) {
-      return {
-        nullable: true
-      };
-    }
-  }
-  getEnum() {
+  getEnum(options) {
     const {
       enum: allowed
     } = this.meta;
@@ -318,7 +315,7 @@ class Schema {
         const anyOf = [];
         for (let entry of allowed) {
           if (isSchema(entry)) {
-            anyOf.push(entry.toJsonSchema());
+            anyOf.push(entry.toJsonSchema(options));
           } else if (entry === null) {
             anyOf.push({
               type: 'null'
@@ -346,40 +343,55 @@ class Schema {
       }
     }
   }
+  getTags(options = {}) {
+    const {
+      tag,
+      stripExtensions
+    } = options;
+    const tags = {
+      ...this.meta.tags
+    };
+
+    // Allows custom tags by options.
+    if (typeof tag === 'function') {
+      Object.assign(tags, tag(this.meta));
+    }
+
+    // Strip custom extensions by option.
+    if (stripExtensions) {
+      for (let key of Object.keys(tags)) {
+        if (key.startsWith('x-')) {
+          delete tags[key];
+        }
+      }
+    }
+    return tags;
+  }
 
   /**
-   * Augments the schema to make all fields required
-   * including fields in all nested schemas.
+   * Transforms any nested schemas.
+   * @param {Function} fn - Transform function that accepts an instance
+   *   of the schema.
    * @returns {this}
    */
-  requireAllWithin() {
+  transform(fn, root) {
     let {
       enum: allowed
     } = this.meta;
     if (allowed) {
       allowed = allowed.map(el => {
-        if (el?.requireAllWithin) {
-          return el.requireAllWithin();
+        if (el?.transform) {
+          return el.transform(fn, root);
         } else {
           return el;
         }
       });
-      return this.clone({
+      return fn(this.clone({
         enum: allowed
-      }).required();
+      }));
     } else {
-      return this.required();
-    }
-  }
-  expandExtra(extra = {}) {
-    const {
-      tag,
-      ...rest
-    } = extra;
-    if (typeof extra?.tag === 'function') {
-      Object.assign(rest, extra.tag(this.meta));
+      return fn(this) || this;
     }
-    return rest;
   }
   inspect() {
     return JSON.stringify(this, null, 2);
@@ -474,7 +486,7 @@ class Schema {
   /**
    * @returns {this}
    */
-  transform(fn) {
+  transformValue(fn) {
     this.assert('transform', (val, options) => {
       if (val !== undefined) {
         return fn(val, options);

package/dist/cjs/TypeSchema.js

@@ -22,11 +22,5 @@ class TypeSchema extends _Schema.default {
   toString() {
     return this.meta.type;
   }
-  toJsonSchema(extra) {
-    return {
-      ...super.toJsonSchema(extra),
-      type: this.meta.type
-    };
-  }
 }
 exports.default = TypeSchema;

package/dist/cjs/array.js

@@ -108,20 +108,26 @@ class ArraySchema extends _TypeSchema.default {
   }
 
   /**
-   * Augments the array schema to make all nested fields required.
+   * Recursively transforms all fields in the array schema.
+   * @param {Function} fn - Transform function that accepts an instance
+   *   of the schema.
    * @returns {this}
    */
-  requireAllWithin() {
+  transform(fn, root = true) {
     const {
       schemas,
       ...rest
     } = this.meta;
     const newSchemas = schemas.map(schema => {
-      return schema.requireAllWithin();
+      return schema.transform(fn, false);
     });
-
-    // @ts-ignore
-    return new ArraySchema(newSchemas, rest).required();
+    const transformed = new ArraySchema(newSchemas, rest);
+    if (root) {
+      // @ts-ignore
+      return transformed;
+    } else {
+      return super.transform.call(transformed, fn);
+    }
   }
 
   // Private
@@ -129,7 +135,7 @@ class ArraySchema extends _TypeSchema.default {
   toString() {
     return 'array';
   }
-  toJsonSchema(extra) {
+  toJsonSchema(options) {
     let other;
     const {
       schemas
@@ -137,18 +143,17 @@ class ArraySchema extends _TypeSchema.default {
     if (schemas.length > 1) {
       other = {
         anyOf: schemas.map(schema => {
-          return schema.toJsonSchema();
+          return schema.toJsonSchema(options);
         })
       };
     } else if (schemas.length === 1) {
       other = {
-        items: schemas[0].toJsonSchema()
+        items: schemas[0].toJsonSchema(options)
       };
     }
     return {
-      ...super.toJsonSchema(extra),
-      ...other,
-      type: 'array'
+      ...super.toJsonSchema(options),
+      ...other
     };
   }
 }

package/dist/cjs/date.js

@@ -113,8 +113,9 @@ class DateSchema extends _Schema.default {
   }
   timestamp() {
     return this.clone({
-      format: 'timestamp'
-    }).assert('format', (date, options) => {
+      type: 'integer',
+      format: null
+    }).custom((arg, options) => {
       const {
         original
       } = options;
@@ -125,8 +126,9 @@ class DateSchema extends _Schema.default {
   }
   unix() {
     return this.clone({
-      format: 'unix timestamp'
-    }).assert('format', (date, options) => {
+      type: 'integer',
+      format: null
+    }).custom((arg, options) => {
       const {
         original
       } = options;
@@ -142,15 +144,6 @@ class DateSchema extends _Schema.default {
   toString() {
     return 'date';
   }
-  toJsonSchema(extra) {
-    const {
-      format
-    } = this.meta;
-    return {
-      ...super.toJsonSchema(extra),
-      type: format.includes('timestamp') ? 'number' : 'string'
-    };
-  }
   getDefault() {
     const {
       default: defaultValue

package/dist/cjs/formats.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isAllowedFormat = isAllowedFormat;
+exports.isOpenAiAllowedFormat = isOpenAiAllowedFormat;
+// Confirmed working as of: 2025-11-11
+// Tested with gpt-5-nano-2025-08-07
+const OPENAI_ALLOWED_FORMATS = ['date-time', 'date', 'time', 'email', 'hostname', 'ipv4', 'ipv6', 'uuid'];
+function isAllowedFormat(format, options = {}) {
+  const {
+    style
+  } = options;
+  if (style === 'openai') {
+    // OpenAI schema inputs will fail on unknown formats.
+    // However these formats also offer useful guides for
+    // the LLM so we want to keep them as much as possible.
+    return isOpenAiAllowedFormat(format);
+  } else if (format) {
+    // JSON Schema has pre-defined types but also allows
+    // custom formats so by default allow any format.
+    return true;
+  }
+}
+function isOpenAiAllowedFormat(format) {
+  return OPENAI_ALLOWED_FORMATS.includes(format);
+}

package/dist/cjs/number.js

@@ -59,7 +59,9 @@ class NumberSchema extends _TypeSchema.default {
     return this.min(0, 'Must be positive.');
   }
   integer() {
-    return this.clone().assert('integer', num => {
+    return this.clone({
+      type: 'integer'
+    }).assert('integer', num => {
       if (!Number.isInteger(num)) {
         throw new _errors.LocalizedError('Must be an integer.');
       }
@@ -79,14 +81,14 @@ class NumberSchema extends _TypeSchema.default {
 
   // Private
 
-  toJsonSchema(extra) {
+  toJsonSchema(options) {
     const {
       min,
       max,
       multiple
     } = this.meta;
     return {
-      ...super.toJsonSchema(extra),
+      ...super.toJsonSchema(options),
       ...(min != null && {
         minimum: min
       }),

package/dist/cjs/object.js

@@ -29,7 +29,7 @@ class ObjectSchema extends _TypeSchema.default {
         throw new _errors.LocalizedError('Must be an object.');
       }
     });
-    this.transform((obj, options) => {
+    this.transformValue((obj, options) => {
       const {
         stripUnknown,
         stripEmpty
@@ -219,18 +219,24 @@ class ObjectSchema extends _TypeSchema.default {
   }
 
   /**
-   * Augments the object schema to make all fields required
-   * including fields in all nested schemas.
+   * Recursively transforms all fields including those in
+   * nested schemas.
+   * @param {Function} fn - Transform function that accepts an instance
+   *   of the schema.
    * @returns {this}
    */
-  requireAllWithin() {
+  transform(fn, root = true) {
     const update = {};
-    for (let field of Object.keys(this.meta.fields)) {
-      (0, _lodash.set)(update, field, this.get(field).requireAllWithin());
+    for (let field of Object.keys(this.meta.fields || {})) {
+      (0, _lodash.set)(update, field, this.get(field).transform(fn, false));
+    }
+    const transformed = this.append(update);
+    if (root) {
+      // @ts-ignore
+      return transformed;
+    } else {
+      return super.transform.call(transformed, fn);
     }
-
-    // @ts-ignore
-    return this.append(update).required();
   }
 
   /**
@@ -300,20 +306,20 @@ class ObjectSchema extends _TypeSchema.default {
 
   // Private
 
-  toJsonSchema(extra) {
+  toJsonSchema(options) {
     const {
       stripUnknown = false
     } = this.meta;
     const required = [];
     const properties = {};
     for (let [key, schema] of Object.entries(this.export())) {
-      properties[key] = schema.toJsonSchema(extra);
+      properties[key] = schema.toJsonSchema(options);
       if (schema.meta.required) {
         required.push(key);
       }
     }
     return {
-      ...super.toJsonSchema(extra),
+      ...super.toJsonSchema(options),
       ...(Object.keys(properties).length > 0 && {
         properties,
         required,

package/dist/cjs/string.js

@@ -41,19 +41,6 @@ class StringSchema extends _TypeSchema.default {
     });
   }
 
-  /**
-   * @returns {this}
-   */
-  required() {
-    return this.clone({
-      required: true
-    }).assert('required', val => {
-      if (val == null) {
-        throw new _errors.LocalizedError('Value is required.');
-      }
-    });
-  }
-
   /**
    * @param {number} length
    */
@@ -99,7 +86,7 @@ class StringSchema extends _TypeSchema.default {
     });
   }
   trim() {
-    return this.clone().transform(str => {
+    return this.clone().transformValue(str => {
       return str.trim();
     });
   }
@@ -108,7 +95,7 @@ class StringSchema extends _TypeSchema.default {
    * @param {boolean} [assert] Throws an error if not lowercase. Default: `false`.
    */
   lowercase(assert = false) {
-    return this.clone().transform(str => {
+    return this.clone().transformValue(str => {
       const lower = str.toLowerCase();
       if (lower !== str) {
         if (assert) {
@@ -123,7 +110,7 @@ class StringSchema extends _TypeSchema.default {
    * @param {boolean} [assert] Throws an error if not uppercase. Default: `false`.
    */
   uppercase(assert = false) {
-    return this.clone().transform(str => {
+    return this.clone().transformValue(str => {
       const upper = str.toUpperCase();
       if (upper !== str) {
         if (assert) {
@@ -432,13 +419,13 @@ class StringSchema extends _TypeSchema.default {
 
   // Private
 
-  toJsonSchema(extra) {
+  toJsonSchema(options) {
     const {
       min,
       max
     } = this.meta;
     return {
-      ...super.toJsonSchema(extra),
+      ...super.toJsonSchema(options),
       ...(min && {
         minLength: min
       }),

package/dist/cjs/tuple.js

@@ -10,7 +10,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 class TupleSchema extends _Schema.default {
   constructor(schemas) {
     super({
-      schemas
+      schemas,
+      type: 'array'
     });
     this.setup();
   }
@@ -79,15 +80,14 @@ class TupleSchema extends _Schema.default {
   toString() {
     return 'tuple';
   }
-  toJsonSchema(extra) {
+  toJsonSchema(options) {
     const {
       schemas
     } = this.meta;
     return {
-      ...super.toJsonSchema(extra),
-      type: 'array',
+      ...super.toJsonSchema(options),
       prefixItems: schemas.map(schema => {
-        return schema.toJsonSchema();
+        return schema.toJsonSchema(options);
       })
     };
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/yada",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "Validation library inspired by Joi.",
   "scripts": {
     "test": "jest",