vellum-ai 0.0.45 → 0.1.1

package/dist/core/schemas/Schema.d.ts

@@ -13,6 +13,7 @@ export declare const SchemaType: {
     readonly ENUM: "enum";
     readonly LIST: "list";
     readonly STRING_LITERAL: "stringLiteral";
+    readonly BOOLEAN_LITERAL: "booleanLiteral";
     readonly OBJECT: "object";
     readonly ANY: "any";
     readonly BOOLEAN: "boolean";
@@ -59,4 +60,22 @@ export interface SchemaOptions {
      * @default false
      */
     allowUnrecognizedEnumValues?: boolean;
+    /**
+     * whether to allow data that doesn't conform to the schema.
+     * invalid data is passed through without transformation.
+     *
+     * when this is enabled, .parse() and .json() will always
+     * return `ok: true`. `.parseOrThrow()` and `.jsonOrThrow()`
+     * will never fail.
+     *
+     * @default false
+     */
+    skipValidation?: boolean;
+    /**
+     * each validation failure contains a "path" property, which is
+     * the breadcrumbs to the offending node in the JSON. you can supply
+     * a prefix that is prepended to all the errors' paths. this can be
+     * helpful for zurg's internal debug logging.
+     */
+    breadcrumbsPrefix?: string[];
 }

package/dist/core/schemas/Schema.js

@@ -6,6 +6,7 @@ exports.SchemaType = {
     ENUM: "enum",
     LIST: "list",
     STRING_LITERAL: "stringLiteral",
+    BOOLEAN_LITERAL: "booleanLiteral",
     OBJECT: "object",
     ANY: "any",
     BOOLEAN: "boolean",

package/dist/core/schemas/builders/date/date.js

@@ -2,31 +2,42 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.date = void 0;
 const Schema_1 = require("../../Schema");
+const getErrorMessageForIncorrectType_1 = require("../../utils/getErrorMessageForIncorrectType");
+const maybeSkipValidation_1 = require("../../utils/maybeSkipValidation");
 const schema_utils_1 = require("../schema-utils");
 // https://stackoverflow.com/questions/12756159/regex-and-iso8601-formatted-datetime
 const ISO_8601_REGEX = /^([+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24:?00)([.,]\d+(?!:))?)?(\17[0-5]\d([.,]\d+)?)?([zZ]|([+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$/;
 function date() {
     const baseSchema = {
-        parse: (raw) => {
-            if (typeof raw === "string" && ISO_8601_REGEX.test(raw)) {
+        parse: (raw, { breadcrumbsPrefix = [] } = {}) => {
+            if (typeof raw !== "string") {
                 return {
-                    ok: true,
-                    value: new Date(raw),
+                    ok: false,
+                    errors: [
+                        {
+                            path: breadcrumbsPrefix,
+                            message: (0, getErrorMessageForIncorrectType_1.getErrorMessageForIncorrectType)(raw, "string"),
+                        },
+                    ],
                 };
             }
-            else {
+            if (!ISO_8601_REGEX.test(raw)) {
                 return {
                     ok: false,
                     errors: [
                         {
-                            path: [],
-                            message: "Not an ISO 8601 date string",
+                            path: breadcrumbsPrefix,
+                            message: (0, getErrorMessageForIncorrectType_1.getErrorMessageForIncorrectType)(raw, "ISO 8601 date string"),
                         },
                     ],
                 };
             }
+            return {
+                ok: true,
+                value: new Date(raw),
+            };
         },
-        json: (date) => {
+        json: (date, { breadcrumbsPrefix = [] } = {}) => {
             if (date instanceof Date) {
                 return {
                     ok: true,
@@ -38,8 +49,8 @@ function date() {
                     ok: false,
                     errors: [
                         {
-                            path: [],
-                            message: "Not a Date object",
+                            path: breadcrumbsPrefix,
+                            message: (0, getErrorMessageForIncorrectType_1.getErrorMessageForIncorrectType)(date, "Date object"),
                         },
                     ],
                 };
@@ -47,9 +58,6 @@ function date() {
         },
         getType: () => Schema_1.SchemaType.DATE,
     };
-    return {
-        ...baseSchema,
-        ...(0, schema_utils_1.getSchemaUtils)(baseSchema),
-    };
+    return Object.assign(Object.assign({}, (0, maybeSkipValidation_1.maybeSkipValidation)(baseSchema)), (0, schema_utils_1.getSchemaUtils)(baseSchema));
 }
 exports.date = date;

package/dist/core/schemas/builders/enum/enum.js

@@ -3,26 +3,36 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.enum_ = void 0;
 const Schema_1 = require("../../Schema");
 const createIdentitySchemaCreator_1 = require("../../utils/createIdentitySchemaCreator");
+const getErrorMessageForIncorrectType_1 = require("../../utils/getErrorMessageForIncorrectType");
 function enum_(values) {
     const validValues = new Set(values);
-    const schemaCreator = (0, createIdentitySchemaCreator_1.createIdentitySchemaCreator)(Schema_1.SchemaType.ENUM, (value, { allowUnrecognizedEnumValues } = {}) => {
-        if (typeof value === "string" && (validValues.has(value) || allowUnrecognizedEnumValues)) {
+    const schemaCreator = (0, createIdentitySchemaCreator_1.createIdentitySchemaCreator)(Schema_1.SchemaType.ENUM, (value, { allowUnrecognizedEnumValues, breadcrumbsPrefix = [] } = {}) => {
+        if (typeof value !== "string") {
             return {
-                ok: true,
-                value: value,
+                ok: false,
+                errors: [
+                    {
+                        path: breadcrumbsPrefix,
+                        message: (0, getErrorMessageForIncorrectType_1.getErrorMessageForIncorrectType)(value, "string"),
+                    },
+                ],
             };
         }
-        else {
+        if (!validValues.has(value) && !allowUnrecognizedEnumValues) {
             return {
                 ok: false,
                 errors: [
                     {
-                        path: [],
-                        message: "Not one of the allowed values",
+                        path: breadcrumbsPrefix,
+                        message: (0, getErrorMessageForIncorrectType_1.getErrorMessageForIncorrectType)(value, "enum"),
                     },
                 ],
             };
         }
+        return {
+            ok: true,
+            value: value,
+        };
     });
     return schemaCreator();
 }

package/dist/core/schemas/builders/lazy/index.d.ts

@@ -1,2 +1,3 @@
-export { lazy, type SchemaGetter } from "./lazy";
+export { lazy } from "./lazy";
+export type { SchemaGetter } from "./lazy";
 export { lazyObject } from "./lazyObject";

package/dist/core/schemas/builders/lazy/lazy.js

@@ -1,28 +1,36 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getMemoizedSchema = exports.constructLazyBaseSchema = exports.lazy = void 0;
 const schema_utils_1 = require("../schema-utils");
 function lazy(getter) {
     const baseSchema = constructLazyBaseSchema(getter);
-    return {
-        ...baseSchema,
-        ...(0, schema_utils_1.getSchemaUtils)(baseSchema),
-    };
+    return Object.assign(Object.assign({}, baseSchema), (0, schema_utils_1.getSchemaUtils)(baseSchema));
 }
 exports.lazy = lazy;
 function constructLazyBaseSchema(getter) {
     return {
-        parse: async (raw, opts) => (await getMemoizedSchema(getter)).parse(raw, opts),
-        json: async (parsed, opts) => (await getMemoizedSchema(getter)).json(parsed, opts),
-        getType: async () => (await getMemoizedSchema(getter)).getType(),
+        parse: (raw, opts) => __awaiter(this, void 0, void 0, function* () { return (yield getMemoizedSchema(getter)).parse(raw, opts); }),
+        json: (parsed, opts) => __awaiter(this, void 0, void 0, function* () { return (yield getMemoizedSchema(getter)).json(parsed, opts); }),
+        getType: () => __awaiter(this, void 0, void 0, function* () { return (yield getMemoizedSchema(getter)).getType(); }),
     };
 }
 exports.constructLazyBaseSchema = constructLazyBaseSchema;
-async function getMemoizedSchema(getter) {
-    const castedGetter = getter;
-    if (castedGetter.__zurg_memoized == null) {
-        castedGetter.__zurg_memoized = await getter();
-    }
-    return castedGetter.__zurg_memoized;
+function getMemoizedSchema(getter) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const castedGetter = getter;
+        if (castedGetter.__zurg_memoized == null) {
+            castedGetter.__zurg_memoized = yield getter();
+        }
+        return castedGetter.__zurg_memoized;
+    });
 }
 exports.getMemoizedSchema = getMemoizedSchema;

package/dist/core/schemas/builders/lazy/lazyObject.js

@@ -1,4 +1,13 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.lazyObject = void 0;
 const object_1 = require("../object");
@@ -6,16 +15,7 @@ const object_like_1 = require("../object-like");
 const schema_utils_1 = require("../schema-utils");
 const lazy_1 = require("./lazy");
 function lazyObject(getter) {
-    const baseSchema = {
-        ...(0, lazy_1.constructLazyBaseSchema)(getter),
-        _getRawProperties: async () => (await (0, lazy_1.getMemoizedSchema)(getter))._getRawProperties(),
-        _getParsedProperties: async () => (await (0, lazy_1.getMemoizedSchema)(getter))._getParsedProperties(),
-    };
-    return {
-        ...baseSchema,
-        ...(0, schema_utils_1.getSchemaUtils)(baseSchema),
-        ...(0, object_like_1.getObjectLikeUtils)(baseSchema),
-        ...(0, object_1.getObjectUtils)(baseSchema),
-    };
+    const baseSchema = Object.assign(Object.assign({}, (0, lazy_1.constructLazyBaseSchema)(getter)), { _getRawProperties: () => __awaiter(this, void 0, void 0, function* () { return (yield (0, lazy_1.getMemoizedSchema)(getter))._getRawProperties(); }), _getParsedProperties: () => __awaiter(this, void 0, void 0, function* () { return (yield (0, lazy_1.getMemoizedSchema)(getter))._getParsedProperties(); }) });
+    return Object.assign(Object.assign(Object.assign(Object.assign({}, baseSchema), (0, schema_utils_1.getSchemaUtils)(baseSchema)), (0, object_like_1.getObjectLikeUtils)(baseSchema)), (0, object_1.getObjectUtils)(baseSchema));
 }
 exports.lazyObject = lazyObject;

package/dist/core/schemas/builders/list/list.js

@@ -1,53 +1,68 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.list = void 0;
 const Schema_1 = require("../../Schema");
+const getErrorMessageForIncorrectType_1 = require("../../utils/getErrorMessageForIncorrectType");
+const maybeSkipValidation_1 = require("../../utils/maybeSkipValidation");
 const schema_utils_1 = require("../schema-utils");
 function list(schema) {
     const baseSchema = {
-        parse: async (raw, opts) => validateAndTransformArray(raw, (item) => schema.parse(item, opts)),
-        json: (parsed, opts) => validateAndTransformArray(parsed, (item) => schema.json(item, opts)),
+        parse: (raw, opts) => __awaiter(this, void 0, void 0, function* () {
+            return validateAndTransformArray(raw, (item, index) => {
+                var _a;
+                return schema.parse(item, Object.assign(Object.assign({}, opts), { breadcrumbsPrefix: [...((_a = opts === null || opts === void 0 ? void 0 : opts.breadcrumbsPrefix) !== null && _a !== void 0 ? _a : []), `[${index}]`] }));
+            });
+        }),
+        json: (parsed, opts) => validateAndTransformArray(parsed, (item, index) => {
+            var _a;
+            return schema.json(item, Object.assign(Object.assign({}, opts), { breadcrumbsPrefix: [...((_a = opts === null || opts === void 0 ? void 0 : opts.breadcrumbsPrefix) !== null && _a !== void 0 ? _a : []), `[${index}]`] }));
+        }),
         getType: () => Schema_1.SchemaType.LIST,
     };
-    return {
-        ...baseSchema,
-        ...(0, schema_utils_1.getSchemaUtils)(baseSchema),
-    };
+    return Object.assign(Object.assign({}, (0, maybeSkipValidation_1.maybeSkipValidation)(baseSchema)), (0, schema_utils_1.getSchemaUtils)(baseSchema));
 }
 exports.list = list;
-async function validateAndTransformArray(value, transformItem) {
-    if (!Array.isArray(value)) {
-        return {
-            ok: false,
-            errors: [
-                {
-                    message: "Not a list",
-                    path: [],
-                },
-            ],
-        };
-    }
-    const maybeValidItems = await Promise.all(value.map((item) => transformItem(item)));
-    return maybeValidItems.reduce((acc, item, index) => {
-        if (acc.ok && item.ok) {
+function validateAndTransformArray(value, transformItem) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!Array.isArray(value)) {
             return {
-                ok: true,
-                value: [...acc.value, item.value],
+                ok: false,
+                errors: [
+                    {
+                        message: (0, getErrorMessageForIncorrectType_1.getErrorMessageForIncorrectType)(value, "list"),
+                        path: [],
+                    },
+                ],
             };
         }
-        const errors = [];
-        if (!acc.ok) {
-            errors.push(...acc.errors);
-        }
-        if (!item.ok) {
-            errors.push(...item.errors.map((error) => ({
-                path: [`[${index}]`, ...error.path],
-                message: error.message,
-            })));
-        }
-        return {
-            ok: false,
-            errors,
-        };
-    }, { ok: true, value: [] });
+        const maybeValidItems = yield Promise.all(value.map((item, index) => transformItem(item, index)));
+        return maybeValidItems.reduce((acc, item) => {
+            if (acc.ok && item.ok) {
+                return {
+                    ok: true,
+                    value: [...acc.value, item.value],
+                };
+            }
+            const errors = [];
+            if (!acc.ok) {
+                errors.push(...acc.errors);
+            }
+            if (!item.ok) {
+                errors.push(...item.errors);
+            }
+            return {
+                ok: false,
+                errors,
+            };
+        }, { ok: true, value: [] });
+    });
 }

package/dist/core/schemas/builders/literals/booleanLiteral.d.ts

@@ -0,0 +1,2 @@
+import { Schema } from "../../Schema";
+export declare function booleanLiteral<V extends boolean>(literal: V): Schema<V, V>;

package/dist/core/schemas/builders/literals/booleanLiteral.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.booleanLiteral = void 0;
+const Schema_1 = require("../../Schema");
+const createIdentitySchemaCreator_1 = require("../../utils/createIdentitySchemaCreator");
+const getErrorMessageForIncorrectType_1 = require("../../utils/getErrorMessageForIncorrectType");
+function booleanLiteral(literal) {
+    const schemaCreator = (0, createIdentitySchemaCreator_1.createIdentitySchemaCreator)(Schema_1.SchemaType.BOOLEAN_LITERAL, (value, { breadcrumbsPrefix = [] } = {}) => {
+        if (value === literal) {
+            return {
+                ok: true,
+                value: literal,
+            };
+        }
+        else {
+            return {
+                ok: false,
+                errors: [
+                    {
+                        path: breadcrumbsPrefix,
+                        message: (0, getErrorMessageForIncorrectType_1.getErrorMessageForIncorrectType)(value, `${literal.toString()}`),
+                    },
+                ],
+            };
+        }
+    });
+    return schemaCreator();
+}
+exports.booleanLiteral = booleanLiteral;

package/dist/core/schemas/builders/literals/index.d.ts

@@ -1 +1,2 @@
 export { stringLiteral } from "./stringLiteral";
+export { booleanLiteral } from "./booleanLiteral";

package/dist/core/schemas/builders/literals/index.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringLiteral = void 0;
+exports.booleanLiteral = exports.stringLiteral = void 0;
 var stringLiteral_1 = require("./stringLiteral");
 Object.defineProperty(exports, "stringLiteral", { enumerable: true, get: function () { return stringLiteral_1.stringLiteral; } });
+var booleanLiteral_1 = require("./booleanLiteral");
+Object.defineProperty(exports, "booleanLiteral", { enumerable: true, get: function () { return booleanLiteral_1.booleanLiteral; } });

package/dist/core/schemas/builders/literals/stringLiteral.js

@@ -3,8 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.stringLiteral = void 0;
 const Schema_1 = require("../../Schema");
 const createIdentitySchemaCreator_1 = require("../../utils/createIdentitySchemaCreator");
+const getErrorMessageForIncorrectType_1 = require("../../utils/getErrorMessageForIncorrectType");
 function stringLiteral(literal) {
-    const schemaCreator = (0, createIdentitySchemaCreator_1.createIdentitySchemaCreator)(Schema_1.SchemaType.STRING_LITERAL, (value) => {
+    const schemaCreator = (0, createIdentitySchemaCreator_1.createIdentitySchemaCreator)(Schema_1.SchemaType.STRING_LITERAL, (value, { breadcrumbsPrefix = [] } = {}) => {
         if (value === literal) {
             return {
                 ok: true,
@@ -16,8 +17,8 @@ function stringLiteral(literal) {
                 ok: false,
                 errors: [
                     {
-                        path: [],
-                        message: `Not equal to "${literal}"`,
+                        path: breadcrumbsPrefix,
+                        message: (0, getErrorMessageForIncorrectType_1.getErrorMessageForIncorrectType)(value, `"${literal}"`),
                     },
                 ],
             };

package/dist/core/schemas/builders/object/index.d.ts

@@ -1,3 +1,6 @@
 export { getObjectUtils, object } from "./object";
-export { isProperty, property, type Property } from "./property";
-export { type BaseObjectSchema, type inferObjectSchemaFromPropertySchemas, type inferParsedObject, type inferParsedObjectFromPropertySchemas, type inferParsedPropertySchema, type inferRawKey, type inferRawObject, type inferRawObjectFromPropertySchemas, type inferRawPropertySchema, type ObjectSchema, type ObjectUtils, type PropertySchemas, } from "./types";
+export { objectWithoutOptionalProperties } from "./objectWithoutOptionalProperties";
+export type { inferObjectWithoutOptionalPropertiesSchemaFromPropertySchemas, inferParsedObjectWithoutOptionalPropertiesFromPropertySchemas, } from "./objectWithoutOptionalProperties";
+export { isProperty, property } from "./property";
+export type { Property } from "./property";
+export type { BaseObjectSchema, inferObjectSchemaFromPropertySchemas, inferParsedObject, inferParsedObjectFromPropertySchemas, inferParsedPropertySchema, inferRawKey, inferRawObject, inferRawObjectFromPropertySchemas, inferRawPropertySchema, ObjectSchema, ObjectUtils, PropertySchemas, } from "./types";

package/dist/core/schemas/builders/object/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.property = exports.isProperty = exports.object = exports.getObjectUtils = void 0;
+exports.property = exports.isProperty = exports.objectWithoutOptionalProperties = exports.object = exports.getObjectUtils = void 0;
 var object_1 = require("./object");
 Object.defineProperty(exports, "getObjectUtils", { enumerable: true, get: function () { return object_1.getObjectUtils; } });
 Object.defineProperty(exports, "object", { enumerable: true, get: function () { return object_1.object; } });
+var objectWithoutOptionalProperties_1 = require("./objectWithoutOptionalProperties");
+Object.defineProperty(exports, "objectWithoutOptionalProperties", { enumerable: true, get: function () { return objectWithoutOptionalProperties_1.objectWithoutOptionalProperties; } });
 var property_1 = require("./property");
 Object.defineProperty(exports, "isProperty", { enumerable: true, get: function () { return property_1.isProperty; } });
 Object.defineProperty(exports, "property", { enumerable: true, get: function () { return property_1.property; } });