@bedrockio/yada 1.11.0 → 1.11.1

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.11.1
+
+- Better handling of tuple schemas in `toOpenAi`.
+
 ## 1.11.0
 
 - Moved `openai` as `toJSONSchema` option to own method `toOpenAi`.

package/dist/cjs/openai.js

@@ -15,6 +15,15 @@ function toOpenAi(schema) {
   } = schema.meta;
   if (type === 'object') {
     return schema.required();
+  } else if (type === 'array') {
+    const {
+      schemas
+    } = schema.meta;
+    if (schemas) {
+      return schema.toArray().required();
+    } else {
+      return schema.required();
+    }
   }
 
   // All fields in OpenAI flavor JSON schema must be required,

package/dist/cjs/tuple.js

@@ -4,7 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = _default;
+var _lodash = require("lodash");
 var _Schema = _interopRequireDefault(require("./Schema"));
+var _array = _interopRequireDefault(require("./array"));
 var _errors = require("./errors");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 class TupleSchema extends _Schema.default {
@@ -77,6 +79,17 @@ class TupleSchema extends _Schema.default {
       loose: true
     });
   }
+  toArray() {
+    const {
+      schemas
+    } = this.meta;
+    const unique = (0, _lodash.uniqBy)(schemas, s => s.meta.type);
+    if (unique.length > 1) {
+      return (0, _array.default)(new _Schema.default().allow(unique));
+    } else {
+      return (0, _array.default)(unique[0]);
+    }
+  }
   toString() {
     return 'tuple';
   }
@@ -86,6 +99,7 @@ class TupleSchema extends _Schema.default {
     } = this.meta;
     return {
       ...super.toJsonSchema(options),
+      items: false,
       prefixItems: schemas.map(schema => {
         return schema.toJsonSchema(options);
       })

package/package.json

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

package/src/openai.js

@@ -16,6 +16,13 @@ export function toOpenAi(schema) {
 
   if (type === 'object') {
     return schema.required();
+  } else if (type === 'array') {
+    const { schemas } = schema.meta;
+    if (schemas) {
+      return schema.toArray().required();
+    } else {
+      return schema.required();
+    }
   }
 
   // All fields in OpenAI flavor JSON schema must be required,

package/src/tuple.js

@@ -1,4 +1,7 @@
+import { uniqBy } from 'lodash';
+
 import Schema from './Schema';
+import array from './array';
 import { ArrayError, ElementError, LocalizedError } from './errors';
 
 class TupleSchema extends Schema {
@@ -65,6 +68,16 @@ class TupleSchema extends Schema {
     return this.clone({ loose: true });
   }
 
+  toArray() {
+    const { schemas } = this.meta;
+    const unique = uniqBy(schemas, (s) => s.meta.type);
+    if (unique.length > 1) {
+      return array(new Schema().allow(unique));
+    } else {
+      return array(unique[0]);
+    }
+  }
+
   toString() {
     return 'tuple';
   }
@@ -73,6 +86,7 @@ class TupleSchema extends Schema {
     const { schemas } = this.meta;
     return {
       ...super.toJsonSchema(options),
+      items: false,
       prefixItems: schemas.map((schema) => {
         return schema.toJsonSchema(options);
       }),

package/types/openai.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"openai.d.ts","sourceRoot":"","sources":["../src/openai.js"],"names":[],"mappings":"AAaA,2CA0BC"}
+{"version":3,"file":"openai.d.ts","sourceRoot":"","sources":["../src/openai.js"],"names":[],"mappings":"AAaA,2CAiCC"}

package/types/tuple.d.ts

@@ -11,6 +11,60 @@ declare class TupleSchema extends Schema {
     constructor(schemas: any);
     setup(): void;
     loose(): this;
+    toArray(): {
+        setup(): void;
+        length(length: any): /*elided*/ any;
+        min(length: any): /*elided*/ any;
+        max(length: any): /*elided*/ any;
+        latlng(): /*elided*/ any;
+        transform(fn: Function, root?: boolean): /*elided*/ any;
+        set(path: string | Array<string>, fn: Function): /*elided*/ any;
+        toString(): string;
+        toJsonSchema(options: any): any;
+        format(name: any, fn: any): /*elided*/ any;
+        assertions: any[];
+        meta: {};
+        required(allow?: boolean): /*elided*/ any;
+        default(arg: any): /*elided*/ any;
+        custom(fn: Function): /*elided*/ any;
+        missing(fn: Function): /*elided*/ any;
+        strip(strip: any): /*elided*/ any;
+        allow(...set: any[]): /*elided*/ any;
+        reject(...set: any[]): /*elided*/ any;
+        nullable(allow?: boolean): /*elided*/ any;
+        message(message: any): /*elided*/ any;
+        tag(tags: any): /*elided*/ any;
+        description(description: any): /*elided*/ any;
+        options(options: any): /*elided*/ any;
+        validate(value: any, options?: {}): Promise<any>;
+        clone(meta: any): /*elided*/ any;
+        append(schema: any): Schema;
+        toOpenApi(options: any): any;
+        toOpenAi(): /*elided*/ any;
+        toJSON(): any;
+        getType(): {
+            type: any;
+        };
+        getFormat(): {
+            format: any;
+        };
+        getDefault(): {
+            default?: undefined;
+        } | {
+            default: any;
+        };
+        getEnum(options: any): any;
+        getTags(options?: {}): any;
+        inspect(): string;
+        get(): void;
+        assertEnum(set: any, allow: any): /*elided*/ any;
+        assert(type: any, fn: any): /*elided*/ any;
+        pushAssertion(assertion: any): void;
+        canSkipAssertion(value: any, assertion: any, options: any): any;
+        transformValue(fn: any): /*elided*/ any;
+        getSortIndex(type: any): number;
+        runAssertion(value: any, assertion: any, options?: {}): Promise<any>;
+    };
     toJsonSchema(options: any): any;
 }
 export {};

package/types/tuple.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tuple.d.ts","sourceRoot":"","sources":["../src/tuple.js"],"names":[],"mappings":"AAkFA;;;;;;GAMG;AACH,6CAJc,MAAM,EAAA,eASnB;mBA9FkB,UAAU;AAG7B;IACE,0BAGC;IAED,cAoDC;IAED,cAEC;IAMD,gCAQC;CACF"}
+{"version":3,"file":"tuple.d.ts","sourceRoot":"","sources":["../src/tuple.js"],"names":[],"mappings":"AAgGA;;;;;;GAMG;AACH,6CAJc,MAAM,EAAA,eASnB;mBA1GkB,UAAU;AAI7B;IACE,0BAGC;IAED,cAoDC;IAED,cAEC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAQC;IAMD,gCASC;CACF"}