hume 0.15.2 → 0.15.3-beta.2

package/dist/core/schemas/builders/undiscriminated-union/types.d.ts

@@ -0,0 +1,4 @@
+import { Schema, inferParsed, inferRaw } from "../../Schema";
+export type UndiscriminatedUnionSchema<Schemas extends [...Schema[]]> = Schema<inferRawUnidiscriminatedUnionSchema<Schemas>, inferParsedUnidiscriminatedUnionSchema<Schemas>>;
+export type inferRawUnidiscriminatedUnionSchema<Schemas extends [...Schema[]]> = inferRaw<Schemas[number]>;
+export type inferParsedUnidiscriminatedUnionSchema<Schemas extends [...Schema[]]> = inferParsed<Schemas[number]>;

package/dist/core/schemas/builders/undiscriminated-union/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.d.ts

@@ -0,0 +1,3 @@
+import { Schema } from "../../Schema";
+import { inferParsedUnidiscriminatedUnionSchema, inferRawUnidiscriminatedUnionSchema } from "./types";
+export declare function undiscriminatedUnion<Schemas extends [Schema<any, any>, ...Schema<any, any>[]]>(schemas: Schemas): Schema<inferRawUnidiscriminatedUnionSchema<Schemas>, inferParsedUnidiscriminatedUnionSchema<Schemas>>;

package/dist/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.undiscriminatedUnion = undiscriminatedUnion;
+const Schema_js_1 = require("../../Schema.js");
+const maybeSkipValidation_js_1 = require("../../utils/maybeSkipValidation.js");
+const index_js_1 = require("../schema-utils/index.js");
+function undiscriminatedUnion(schemas) {
+    const baseSchema = {
+        parse: (raw, opts) => {
+            return validateAndTransformUndiscriminatedUnion((schema, opts) => schema.parse(raw, opts), schemas, opts);
+        },
+        json: (parsed, opts) => {
+            return validateAndTransformUndiscriminatedUnion((schema, opts) => schema.json(parsed, opts), schemas, opts);
+        },
+        getType: () => Schema_js_1.SchemaType.UNDISCRIMINATED_UNION,
+    };
+    return Object.assign(Object.assign({}, (0, maybeSkipValidation_js_1.maybeSkipValidation)(baseSchema)), (0, index_js_1.getSchemaUtils)(baseSchema));
+}
+function validateAndTransformUndiscriminatedUnion(transform, schemas, opts) {
+    const errors = [];
+    for (const [index, schema] of schemas.entries()) {
+        const transformed = transform(schema, Object.assign(Object.assign({}, opts), { skipValidation: false }));
+        if (transformed.ok) {
+            return transformed;
+        }
+        else {
+            for (const error of transformed.errors) {
+                errors.push({
+                    path: error.path,
+                    message: `[Variant ${index}] ${error.message}`,
+                });
+            }
+        }
+    }
+    return {
+        ok: false,
+        errors,
+    };
+}

package/dist/core/schemas/builders/union/discriminant.d.ts

@@ -0,0 +1,5 @@
+export declare function discriminant<RawDiscriminant extends string, ParsedDiscriminant extends string>(parsedDiscriminant: ParsedDiscriminant, rawDiscriminant: RawDiscriminant): Discriminant<RawDiscriminant, ParsedDiscriminant>;
+export interface Discriminant<RawDiscriminant extends string, ParsedDiscriminant extends string> {
+    parsedDiscriminant: ParsedDiscriminant;
+    rawDiscriminant: RawDiscriminant;
+}

package/dist/core/schemas/builders/union/discriminant.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.discriminant = discriminant;
+function discriminant(parsedDiscriminant, rawDiscriminant) {
+    return {
+        parsedDiscriminant,
+        rawDiscriminant,
+    };
+}

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

@@ -0,0 +1,4 @@
+export { discriminant } from "./discriminant";
+export type { Discriminant } from "./discriminant";
+export type { inferParsedDiscriminant, inferParsedUnion, inferRawDiscriminant, inferRawUnion, UnionSubtypes, } from "./types";
+export { union } from "./union";

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

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.union = exports.discriminant = void 0;
+var discriminant_js_1 = require("./discriminant.js");
+Object.defineProperty(exports, "discriminant", { enumerable: true, get: function () { return discriminant_js_1.discriminant; } });
+var union_js_1 = require("./union.js");
+Object.defineProperty(exports, "union", { enumerable: true, get: function () { return union_js_1.union; } });

package/dist/core/schemas/builders/union/types.d.ts

@@ -0,0 +1,13 @@
+import { ObjectSchema, inferParsedObject, inferRawObject } from "../object";
+import { Discriminant } from "./discriminant";
+export type UnionSubtypes<DiscriminantValues extends string | number | symbol> = {
+    [K in DiscriminantValues]: ObjectSchema<any, any>;
+};
+export type inferRawUnion<D extends string | Discriminant<any, any>, U extends UnionSubtypes<keyof U>> = {
+    [K in keyof U]: Record<inferRawDiscriminant<D>, K> & inferRawObject<U[K]>;
+}[keyof U];
+export type inferParsedUnion<D extends string | Discriminant<any, any>, U extends UnionSubtypes<keyof U>> = {
+    [K in keyof U]: Record<inferParsedDiscriminant<D>, K> & inferParsedObject<U[K]>;
+}[keyof U];
+export type inferRawDiscriminant<D extends string | Discriminant<any, any>> = D extends string ? D : D extends Discriminant<infer Raw, any> ? Raw : never;
+export type inferParsedDiscriminant<D extends string | Discriminant<any, any>> = D extends string ? D : D extends Discriminant<any, infer Parsed> ? Parsed : never;

package/dist/core/schemas/builders/union/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/core/schemas/builders/union/union.d.ts

@@ -0,0 +1,4 @@
+import { ObjectLikeSchema } from "../object-like";
+import { Discriminant } from "./discriminant";
+import { UnionSubtypes, inferParsedUnion, inferRawUnion } from "./types";
+export declare function union<D extends string | Discriminant<any, any>, U extends UnionSubtypes<any>>(discriminant: D, union: U): ObjectLikeSchema<inferRawUnion<D, U>, inferParsedUnion<D, U>>;

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

@@ -0,0 +1,129 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.union = union;
+const Schema_js_1 = require("../../Schema.js");
+const getErrorMessageForIncorrectType_js_1 = require("../../utils/getErrorMessageForIncorrectType.js");
+const isPlainObject_js_1 = require("../../utils/isPlainObject.js");
+const keys_js_1 = require("../../utils/keys.js");
+const maybeSkipValidation_js_1 = require("../../utils/maybeSkipValidation.js");
+const index_js_1 = require("../enum/index.js");
+const index_js_2 = require("../object-like/index.js");
+const index_js_3 = require("../schema-utils/index.js");
+function union(discriminant, union) {
+    const rawDiscriminant = typeof discriminant === "string" ? discriminant : discriminant.rawDiscriminant;
+    const parsedDiscriminant = typeof discriminant === "string"
+        ? discriminant
+        : discriminant.parsedDiscriminant;
+    const discriminantValueSchema = (0, index_js_1.enum_)((0, keys_js_1.keys)(union));
+    const baseSchema = {
+        parse: (raw, opts) => {
+            return transformAndValidateUnion({
+                value: raw,
+                discriminant: rawDiscriminant,
+                transformedDiscriminant: parsedDiscriminant,
+                transformDiscriminantValue: (discriminantValue) => {
+                    var _a;
+                    return discriminantValueSchema.parse(discriminantValue, {
+                        allowUnrecognizedEnumValues: opts === null || opts === void 0 ? void 0 : opts.allowUnrecognizedUnionMembers,
+                        breadcrumbsPrefix: [...((_a = opts === null || opts === void 0 ? void 0 : opts.breadcrumbsPrefix) !== null && _a !== void 0 ? _a : []), rawDiscriminant],
+                    });
+                },
+                getAdditionalPropertiesSchema: (discriminantValue) => union[discriminantValue],
+                allowUnrecognizedUnionMembers: opts === null || opts === void 0 ? void 0 : opts.allowUnrecognizedUnionMembers,
+                transformAdditionalProperties: (additionalProperties, additionalPropertiesSchema) => additionalPropertiesSchema.parse(additionalProperties, opts),
+                breadcrumbsPrefix: opts === null || opts === void 0 ? void 0 : opts.breadcrumbsPrefix,
+            });
+        },
+        json: (parsed, opts) => {
+            return transformAndValidateUnion({
+                value: parsed,
+                discriminant: parsedDiscriminant,
+                transformedDiscriminant: rawDiscriminant,
+                transformDiscriminantValue: (discriminantValue) => {
+                    var _a;
+                    return discriminantValueSchema.json(discriminantValue, {
+                        allowUnrecognizedEnumValues: opts === null || opts === void 0 ? void 0 : opts.allowUnrecognizedUnionMembers,
+                        breadcrumbsPrefix: [...((_a = opts === null || opts === void 0 ? void 0 : opts.breadcrumbsPrefix) !== null && _a !== void 0 ? _a : []), parsedDiscriminant],
+                    });
+                },
+                getAdditionalPropertiesSchema: (discriminantValue) => union[discriminantValue],
+                allowUnrecognizedUnionMembers: opts === null || opts === void 0 ? void 0 : opts.allowUnrecognizedUnionMembers,
+                transformAdditionalProperties: (additionalProperties, additionalPropertiesSchema) => additionalPropertiesSchema.json(additionalProperties, opts),
+                breadcrumbsPrefix: opts === null || opts === void 0 ? void 0 : opts.breadcrumbsPrefix,
+            });
+        },
+        getType: () => Schema_js_1.SchemaType.UNION,
+    };
+    return Object.assign(Object.assign(Object.assign({}, (0, maybeSkipValidation_js_1.maybeSkipValidation)(baseSchema)), (0, index_js_3.getSchemaUtils)(baseSchema)), (0, index_js_2.getObjectLikeUtils)(baseSchema));
+}
+function transformAndValidateUnion({ value, discriminant, transformedDiscriminant, transformDiscriminantValue, getAdditionalPropertiesSchema, allowUnrecognizedUnionMembers = false, transformAdditionalProperties, breadcrumbsPrefix = [], }) {
+    if (!(0, isPlainObject_js_1.isPlainObject)(value)) {
+        return {
+            ok: false,
+            errors: [
+                {
+                    path: breadcrumbsPrefix,
+                    message: (0, getErrorMessageForIncorrectType_js_1.getErrorMessageForIncorrectType)(value, "object"),
+                },
+            ],
+        };
+    }
+    const _a = value, _b = discriminant, discriminantValue = _a[_b], additionalProperties = __rest(_a, [typeof _b === "symbol" ? _b : _b + ""]);
+    if (discriminantValue == null) {
+        return {
+            ok: false,
+            errors: [
+                {
+                    path: breadcrumbsPrefix,
+                    message: `Missing discriminant ("${discriminant}")`,
+                },
+            ],
+        };
+    }
+    const transformedDiscriminantValue = transformDiscriminantValue(discriminantValue);
+    if (!transformedDiscriminantValue.ok) {
+        return {
+            ok: false,
+            errors: transformedDiscriminantValue.errors,
+        };
+    }
+    const additionalPropertiesSchema = getAdditionalPropertiesSchema(transformedDiscriminantValue.value);
+    if (additionalPropertiesSchema == null) {
+        if (allowUnrecognizedUnionMembers) {
+            return {
+                ok: true,
+                value: Object.assign({ [transformedDiscriminant]: transformedDiscriminantValue.value }, additionalProperties),
+            };
+        }
+        else {
+            return {
+                ok: false,
+                errors: [
+                    {
+                        path: [...breadcrumbsPrefix, discriminant],
+                        message: "Unexpected discriminant value",
+                    },
+                ],
+            };
+        }
+    }
+    const transformedAdditionalProperties = transformAdditionalProperties(additionalProperties, additionalPropertiesSchema);
+    if (!transformedAdditionalProperties.ok) {
+        return transformedAdditionalProperties;
+    }
+    return {
+        ok: true,
+        value: Object.assign({ [transformedDiscriminant]: discriminantValue }, transformedAdditionalProperties.value),
+    };
+}

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

@@ -0,0 +1,2 @@
+export * from "./builders";
+export type { inferParsed, inferRaw, Schema, SchemaOptions } from "./Schema";

package/dist/core/schemas/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./builders/index.js"), exports);

package/dist/core/schemas/utils/MaybePromise.d.ts

@@ -0,0 +1 @@
+export type MaybePromise<T> = T | Promise<T>;

package/dist/core/schemas/utils/MaybePromise.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/core/schemas/utils/addQuestionMarksToNullableProperties.d.ts

@@ -0,0 +1,7 @@
+export type addQuestionMarksToNullableProperties<T> = {
+    [K in OptionalKeys<T>]?: T[K];
+} & Pick<T, RequiredKeys<T>>;
+export type OptionalKeys<T> = {
+    [K in keyof T]-?: undefined extends T[K] ? K : never;
+}[keyof T];
+export type RequiredKeys<T> = Exclude<keyof T, OptionalKeys<T>>;

package/dist/core/schemas/utils/addQuestionMarksToNullableProperties.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/core/schemas/utils/createIdentitySchemaCreator.d.ts

@@ -0,0 +1,2 @@
+import { MaybeValid, Schema, SchemaOptions, SchemaType } from "../Schema";
+export declare function createIdentitySchemaCreator<T>(schemaType: SchemaType, validate: (value: unknown, opts?: SchemaOptions) => MaybeValid<T>): () => Schema<T, T>;

package/dist/core/schemas/utils/createIdentitySchemaCreator.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createIdentitySchemaCreator = createIdentitySchemaCreator;
+const index_js_1 = require("../builders/schema-utils/index.js");
+const maybeSkipValidation_js_1 = require("./maybeSkipValidation.js");
+function createIdentitySchemaCreator(schemaType, validate) {
+    return () => {
+        const baseSchema = {
+            parse: validate,
+            json: validate,
+            getType: () => schemaType,
+        };
+        return Object.assign(Object.assign({}, (0, maybeSkipValidation_js_1.maybeSkipValidation)(baseSchema)), (0, index_js_1.getSchemaUtils)(baseSchema));
+    };
+}

package/dist/core/schemas/utils/entries.d.ts

@@ -0,0 +1 @@
+export declare function entries<T extends object>(object: T): [keyof T, T[keyof T]][];

package/dist/core/schemas/utils/entries.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.entries = entries;
+function entries(object) {
+    return Object.entries(object);
+}

package/dist/core/schemas/utils/filterObject.d.ts

@@ -0,0 +1 @@
+export declare function filterObject<T extends object, K extends keyof T>(obj: T, keysToInclude: K[]): Pick<T, K>;

package/dist/core/schemas/utils/filterObject.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterObject = filterObject;
+function filterObject(obj, keysToInclude) {
+    const keysToIncludeSet = new Set(keysToInclude);
+    return Object.entries(obj).reduce((acc, [key, value]) => {
+        if (keysToIncludeSet.has(key)) {
+            acc[key] = value;
+        }
+        return acc;
+        // eslint-disable-next-line @typescript-eslint/prefer-reduce-type-parameter
+    }, {});
+}

package/dist/core/schemas/utils/getErrorMessageForIncorrectType.d.ts

@@ -0,0 +1 @@
+export declare function getErrorMessageForIncorrectType(value: unknown, expectedType: string): string;

package/dist/core/schemas/utils/getErrorMessageForIncorrectType.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getErrorMessageForIncorrectType = getErrorMessageForIncorrectType;
+function getErrorMessageForIncorrectType(value, expectedType) {
+    return `Expected ${expectedType}. Received ${getTypeAsString(value)}.`;
+}
+function getTypeAsString(value) {
+    if (Array.isArray(value)) {
+        return "list";
+    }
+    if (value === null) {
+        return "null";
+    }
+    if (value instanceof BigInt) {
+        return "BigInt";
+    }
+    switch (typeof value) {
+        case "string":
+            return `"${value}"`;
+        case "bigint":
+        case "number":
+        case "boolean":
+        case "undefined":
+            return `${value}`;
+    }
+    return typeof value;
+}

package/dist/core/schemas/utils/isPlainObject.d.ts

@@ -0,0 +1 @@
+export declare function isPlainObject(value: unknown): value is Record<string, unknown>;

package/dist/core/schemas/utils/isPlainObject.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPlainObject = isPlainObject;
+// borrowed from https://github.com/lodash/lodash/blob/master/isPlainObject.js
+function isPlainObject(value) {
+    if (typeof value !== "object" || value === null) {
+        return false;
+    }
+    if (Object.getPrototypeOf(value) === null) {
+        return true;
+    }
+    let proto = value;
+    while (Object.getPrototypeOf(proto) !== null) {
+        proto = Object.getPrototypeOf(proto);
+    }
+    return Object.getPrototypeOf(value) === proto;
+}

package/dist/core/schemas/utils/keys.d.ts

@@ -0,0 +1 @@
+export declare function keys<T extends object>(object: T): (keyof T)[];

package/dist/core/schemas/utils/keys.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.keys = keys;
+function keys(object) {
+    return Object.keys(object);
+}

package/dist/core/schemas/utils/maybeSkipValidation.d.ts

@@ -0,0 +1,2 @@
+import { BaseSchema } from "../Schema";
+export declare function maybeSkipValidation<S extends BaseSchema<Raw, Parsed>, Raw, Parsed>(schema: S): S;

package/dist/core/schemas/utils/maybeSkipValidation.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.maybeSkipValidation = maybeSkipValidation;
+function maybeSkipValidation(schema) {
+    return Object.assign(Object.assign({}, schema), { json: transformAndMaybeSkipValidation(schema.json), parse: transformAndMaybeSkipValidation(schema.parse) });
+}
+function transformAndMaybeSkipValidation(transform) {
+    return (value, opts) => {
+        const transformed = transform(value, opts);
+        const { skipValidation = false } = opts !== null && opts !== void 0 ? opts : {};
+        if (!transformed.ok && skipValidation) {
+            // biome-ignore lint/suspicious/noConsole: allow console
+            console.warn([
+                "Failed to validate.",
+                ...transformed.errors.map((error) => "  - " +
+                    (error.path.length > 0 ? `${error.path.join(".")}: ${error.message}` : error.message)),
+            ].join("\n"));
+            return {
+                ok: true,
+                value: value,
+            };
+        }
+        else {
+            return transformed;
+        }
+    };
+}

package/dist/core/schemas/utils/partition.d.ts

@@ -0,0 +1 @@
+export declare function partition<T>(items: readonly T[], predicate: (item: T) => boolean): [T[], T[]];

package/dist/core/schemas/utils/partition.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.partition = partition;
+function partition(items, predicate) {
+    const trueItems = [], falseItems = [];
+    for (const item of items) {
+        if (predicate(item)) {
+            trueItems.push(item);
+        }
+        else {
+            falseItems.push(item);
+        }
+    }
+    return [trueItems, falseItems];
+}

package/dist/core/stream/Stream.d.ts

@@ -0,0 +1,47 @@
+import { Readable } from "stream";
+export declare namespace Stream {
+    interface Args {
+        /**
+         * The HTTP response stream to read from.
+         */
+        stream: Readable | ReadableStream;
+        /**
+         * The event shape to use for parsing the stream data.
+         */
+        eventShape: JsonEvent | SseEvent;
+        /**
+         * An abort signal to stop the stream.
+         */
+        signal?: AbortSignal;
+    }
+    interface JsonEvent {
+        type: "json";
+        messageTerminator: string;
+    }
+    interface SseEvent {
+        type: "sse";
+        streamTerminator?: string;
+    }
+}
+export declare class Stream<T> implements AsyncIterable<T> {
+    private stream;
+    private parse;
+    /**
+     * The prefix to use for each message. For example,
+     * for SSE, the prefix is "data: ".
+     */
+    private prefix;
+    private messageTerminator;
+    private streamTerminator;
+    private controller;
+    constructor({ stream, parse, eventShape, signal }: Stream.Args & {
+        parse: (val: unknown) => Promise<T>;
+    });
+    private iterMessages;
+    [Symbol.asyncIterator](): AsyncIterator<T, void, unknown>;
+    private decodeChunk;
+}
+/**
+ * Browser polyfill for ReadableStream
+ */
+export declare function readableStreamAsyncIterable<T>(stream: any): AsyncIterableIterator<T>;