@predictorsdk/client 0.1.1 → 0.2.0

package/README.md

@@ -16,7 +16,7 @@ import { PredictorSDKClient } from "@predictorsdk/client";
 const client = new PredictorSDKClient({ token: "your-api-key" });
 
 const { markets } = await client.getSportsMatchingMarkets({
-  kalshi_event_ticker: "KXMLB-25-NYM-COL-2025-04-03",
+  kalshiEventTicker: "KXMLB-25-NYM-COL-2025-04-03",
 });
 ```
 

package/dist/Client.d.ts

@@ -27,6 +27,26 @@ export declare class PredictorSDKClient {
      */
     getSportsMatchingMarkets(request?: PredictorSDK.GetSportsMatchingMarketsRequest, requestOptions?: PredictorSDKClient.RequestOptions): core.HttpResponsePromise<PredictorSDK.SportsMatchingResponse>;
     private __getSportsMatchingMarkets;
+    /**
+     * Returns per-second price data for a Binance trading pair. When called without a time range, returns the latest price. With `start_time` and `end_time`, returns historical per-second prices in newest-first order. Supports cursor-based pagination for large result sets. Unknown or invalid symbols return `200` with `{"prices":[]}` and omit `total`.
+     *
+     * @param {PredictorSDK.GetBinanceCryptoPricesRequest} request
+     * @param {PredictorSDKClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PredictorSDK.BadRequestError}
+     * @throws {@link PredictorSDK.UnauthorizedError}
+     * @throws {@link PredictorSDK.ForbiddenError}
+     * @throws {@link PredictorSDK.TooManyRequestsError}
+     * @throws {@link PredictorSDK.BadGatewayError}
+     * @throws {@link PredictorSDK.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.getBinanceCryptoPrices({
+     *         currency: "btcusdt"
+     *     })
+     */
+    getBinanceCryptoPrices(request: PredictorSDK.GetBinanceCryptoPricesRequest, requestOptions?: PredictorSDKClient.RequestOptions): core.HttpResponsePromise<PredictorSDK.CryptoPricesResponse>;
+    private __getBinanceCryptoPrices;
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.
      * This is useful for making requests to endpoints not yet supported in the SDK.

package/dist/Client.js

@@ -6,6 +6,7 @@ import * as core from "./core/index.js";
 import * as environments from "./environments.js";
 import { handleNonStatusCodeError } from "./errors/handleNonStatusCodeError.js";
 import * as errors from "./errors/index.js";
+import * as serializers from "./serialization/index.js";
 export class PredictorSDKClient {
     _options;
     constructor(options) {
@@ -30,7 +31,7 @@ export class PredictorSDKClient {
         return core.HttpResponsePromise.fromPromise(this.__getSportsMatchingMarkets(request, requestOptions));
     }
     async __getSportsMatchingMarkets(request = {}, requestOptions) {
-        const { kalshi_event_ticker: kalshiEventTicker, polymarket_market_slug: polymarketMarketSlug, predict_market_id: predictMarketId, sxbet_market_id: sxbetMarketId, } = request;
+        const { kalshiEventTicker, polymarketMarketSlug, predictMarketId, sxbetMarketId } = request;
         const _queryParams = {
             kalshi_event_ticker: kalshiEventTicker,
             polymarket_market_slug: polymarketMarketSlug,
@@ -53,20 +54,59 @@ export class PredictorSDKClient {
             logging: this._options.logging,
         });
         if (_response.ok) {
-            return { data: _response.body, rawResponse: _response.rawResponse };
+            return {
+                data: serializers.SportsMatchingResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    skipValidation: true,
+                    breadcrumbsPrefix: ["response"],
+                }),
+                rawResponse: _response.rawResponse,
+            };
         }
         if (_response.error.reason === "status-code") {
             switch (_response.error.statusCode) {
                 case 400:
-                    throw new PredictorSDK.BadRequestError(_response.error.body, _response.rawResponse);
+                    throw new PredictorSDK.BadRequestError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }), _response.rawResponse);
                 case 401:
-                    throw new PredictorSDK.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    throw new PredictorSDK.UnauthorizedError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }), _response.rawResponse);
                 case 403:
-                    throw new PredictorSDK.ForbiddenError(_response.error.body, _response.rawResponse);
+                    throw new PredictorSDK.ForbiddenError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }), _response.rawResponse);
                 case 429:
-                    throw new PredictorSDK.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    throw new PredictorSDK.TooManyRequestsError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }), _response.rawResponse);
                 case 503:
-                    throw new PredictorSDK.ServiceUnavailableError(_response.error.body, _response.rawResponse);
+                    throw new PredictorSDK.ServiceUnavailableError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }), _response.rawResponse);
                 default:
                     throw new errors.PredictorSDKError({
                         statusCode: _response.error.statusCode,
@@ -77,6 +117,123 @@ export class PredictorSDKClient {
         }
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/matching-markets/sports");
     }
+    /**
+     * Returns per-second price data for a Binance trading pair. When called without a time range, returns the latest price. With `start_time` and `end_time`, returns historical per-second prices in newest-first order. Supports cursor-based pagination for large result sets. Unknown or invalid symbols return `200` with `{"prices":[]}` and omit `total`.
+     *
+     * @param {PredictorSDK.GetBinanceCryptoPricesRequest} request
+     * @param {PredictorSDKClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PredictorSDK.BadRequestError}
+     * @throws {@link PredictorSDK.UnauthorizedError}
+     * @throws {@link PredictorSDK.ForbiddenError}
+     * @throws {@link PredictorSDK.TooManyRequestsError}
+     * @throws {@link PredictorSDK.BadGatewayError}
+     * @throws {@link PredictorSDK.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.getBinanceCryptoPrices({
+     *         currency: "btcusdt"
+     *     })
+     */
+    getBinanceCryptoPrices(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getBinanceCryptoPrices(request, requestOptions));
+    }
+    async __getBinanceCryptoPrices(request, requestOptions) {
+        const { currency, startTime, endTime, limit, paginationKey } = request;
+        const _queryParams = {
+            currency,
+            start_time: startTime,
+            end_time: endTime,
+            limit,
+            pagination_key: paginationKey,
+        };
+        const _authRequest = await this._options.authProvider.getAuthRequest();
+        const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _response = await core.fetcher({
+            url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
+                (await core.Supplier.get(this._options.environment)) ??
+                environments.PredictorSDKEnvironment.Production, "v1/crypto-prices/binance"),
+            method: "GET",
+            headers: _headers,
+            queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return {
+                data: serializers.CryptoPricesResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    skipValidation: true,
+                    breadcrumbsPrefix: ["response"],
+                }),
+                rawResponse: _response.rawResponse,
+            };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 400:
+                    throw new PredictorSDK.BadRequestError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }), _response.rawResponse);
+                case 401:
+                    throw new PredictorSDK.UnauthorizedError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }), _response.rawResponse);
+                case 403:
+                    throw new PredictorSDK.ForbiddenError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }), _response.rawResponse);
+                case 429:
+                    throw new PredictorSDK.TooManyRequestsError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }), _response.rawResponse);
+                case 502:
+                    throw new PredictorSDK.BadGatewayError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }), _response.rawResponse);
+                case 503:
+                    throw new PredictorSDK.ServiceUnavailableError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }), _response.rawResponse);
+                default:
+                    throw new errors.PredictorSDKError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/crypto-prices/binance");
+    }
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.
      * This is useful for making requests to endpoints not yet supported in the SDK.

package/dist/api/client/requests/GetBinanceCryptoPricesRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @example
+ *     {
+ *         currency: "btcusdt"
+ *     }
+ */
+export interface GetBinanceCryptoPricesRequest {
+    /** Binance trading pair (e.g. `btcusdt`, `ethusdt`, `solusdt`). Must contain only alphanumeric characters (no hyphens, underscores, or other separators). Uppercase is accepted and automatically lowercased (e.g. `BTCUSDT` → `btcusdt`). Must be a valid Binance symbol; unknown symbols return `200` with an empty `prices` array. */
+    currency: string;
+    /** Start of the time range as a Unix timestamp in milliseconds (inclusive). Negative values are clamped to 0. */
+    startTime?: number;
+    /** End of the time range as a Unix timestamp in milliseconds (inclusive). Negative values are clamped to 0. */
+    endTime?: number;
+    /** Maximum number of prices to return. Defaults to 100 when a time range is present. Values above 100 are silently clamped to 100. Without a time range, this parameter is ignored — the endpoint always returns the single latest price. */
+    limit?: number;
+    /** Base64-encoded cursor from a previous response to fetch the next page of results. */
+    paginationKey?: string;
+}

package/dist/api/client/requests/GetBinanceCryptoPricesRequest.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/client/requests/GetSportsMatchingMarketsRequest.d.ts

@@ -4,11 +4,11 @@
  */
 export interface GetSportsMatchingMarketsRequest {
     /** Kalshi event ticker(s) to find matching markets for (e.g. `KXNFLGAME-25AUG16ARIDEN`). Provide the parameter multiple times for multiple tickers. Only one filter type may be used per request. */
-    kalshi_event_ticker?: string | string[];
+    kalshiEventTicker?: string | string[];
     /** Polymarket market slug(s) to find matching markets for (e.g. `nfl-ari-den-2025-08-16`). Provide the parameter multiple times for multiple slugs. Only one filter type may be used per request. */
-    polymarket_market_slug?: string | string[];
+    polymarketMarketSlug?: string | string[];
     /** Predict market ID(s) to find matching markets for (e.g. `110629`). Provide the parameter multiple times for multiple IDs. Only one filter type may be used per request. */
-    predict_market_id?: string | string[];
+    predictMarketId?: string | string[];
     /** SX Bet market ID(s) to find matching markets for (e.g. `0x4c000abdbf197ef32ecdf15561b1d636f1e5b02629f466678757fd83e2ec3599`). Provide the parameter multiple times for multiple IDs. Only one filter type may be used per request. */
-    sxbet_market_id?: string | string[];
+    sxbetMarketId?: string | string[];
 }

package/dist/api/client/requests/index.d.ts

@@ -1 +1,2 @@
+export type { GetBinanceCryptoPricesRequest } from "./GetBinanceCryptoPricesRequest.js";
 export type { GetSportsMatchingMarketsRequest } from "./GetSportsMatchingMarketsRequest.js";

package/dist/api/errors/BadGatewayError.d.ts

@@ -0,0 +1,6 @@
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as PredictorSDK from "../index.js";
+export declare class BadGatewayError extends errors.PredictorSDKError {
+    constructor(body: PredictorSDK.ErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/api/errors/BadGatewayError.js

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../errors/index.js";
+export class BadGatewayError extends errors.PredictorSDKError {
+    constructor(body, rawResponse) {
+        super({
+            message: "BadGatewayError",
+            statusCode: 502,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
+    }
+}

package/dist/api/errors/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./BadGatewayError.js";
 export * from "./BadRequestError.js";
 export * from "./ForbiddenError.js";
 export * from "./ServiceUnavailableError.js";

package/dist/api/errors/index.js

@@ -1,3 +1,4 @@
+export * from "./BadGatewayError.js";
 export * from "./BadRequestError.js";
 export * from "./ForbiddenError.js";
 export * from "./ServiceUnavailableError.js";

package/dist/api/types/CryptoPriceItem.d.ts

@@ -0,0 +1,8 @@
+export interface CryptoPriceItem {
+    /** Trading pair in lowercase (e.g. `btcusdt`). */
+    symbol: string;
+    /** Close price for the 1-second interval. */
+    value: number;
+    /** Unix timestamp in milliseconds for the start of the 1-second interval. */
+    timestamp: number;
+}

package/dist/api/types/CryptoPriceItem.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/types/CryptoPricesResponse.d.ts

@@ -0,0 +1,8 @@
+import type * as PredictorSDK from "../index.js";
+export interface CryptoPricesResponse {
+    prices: PredictorSDK.CryptoPriceItem[];
+    /** Base64-encoded cursor for fetching the next page. Absent when there are no more results. */
+    paginationKey?: string;
+    /** Number of prices in this response page. Omitted on empty responses for unknown symbols. */
+    total?: number;
+}

package/dist/api/types/CryptoPricesResponse.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/types/ErrorResponse.d.ts

@@ -1,4 +1,6 @@
 export interface ErrorResponse {
     error: string;
-    status_code: number;
+    /** Additional detail about the error. May be present, including on some validation errors. */
+    message?: string;
+    statusCode: number;
 }

package/dist/api/types/PlatformMarket.d.ts

@@ -1,24 +1,16 @@
+import type * as PredictorSDK from "../index.js";
 export interface PlatformMarket {
-    platform: PlatformMarket.Platform;
+    platform: PredictorSDK.PlatformMarketPlatform;
     /** Kalshi event ticker. Present when platform is KALSHI. */
-    event_ticker?: string | undefined;
+    eventTicker?: string;
     /** Kalshi market tickers. Present when platform is KALSHI. */
-    market_tickers?: string[] | undefined;
+    marketTickers?: string[];
     /** Polymarket market slug. Present when platform is POLYMARKET. */
-    market_slug?: string | undefined;
+    marketSlug?: string;
     /** Polymarket token IDs. Present when platform is POLYMARKET. */
-    token_ids?: string[] | undefined;
+    tokenIds?: string[];
     /** Source market ID. Present for platforms other than Kalshi and Polymarket. */
-    market_id?: string | undefined;
+    marketId?: string;
     /** Source outcome IDs. Present for platforms that use outcome IDs. */
-    outcome_ids?: string[] | undefined;
-}
-export declare namespace PlatformMarket {
-    const Platform: {
-        readonly Kalshi: "KALSHI";
-        readonly Polymarket: "POLYMARKET";
-        readonly Predict: "PREDICT";
-        readonly Sxbet: "SXBET";
-    };
-    type Platform = (typeof Platform)[keyof typeof Platform];
+    outcomeIds?: string[];
 }

package/dist/api/types/PlatformMarket.js

@@ -1,10 +1,2 @@
 // This file was auto-generated by Fern from our API Definition.
-export var PlatformMarket;
-(function (PlatformMarket) {
-    PlatformMarket.Platform = {
-        Kalshi: "KALSHI",
-        Polymarket: "POLYMARKET",
-        Predict: "PREDICT",
-        Sxbet: "SXBET",
-    };
-})(PlatformMarket || (PlatformMarket = {}));
+export {};

package/dist/api/types/PlatformMarketPlatform.d.ts

@@ -0,0 +1,7 @@
+export declare const PlatformMarketPlatform: {
+    readonly Kalshi: "KALSHI";
+    readonly Polymarket: "POLYMARKET";
+    readonly Predict: "PREDICT";
+    readonly Sxbet: "SXBET";
+};
+export type PlatformMarketPlatform = (typeof PlatformMarketPlatform)[keyof typeof PlatformMarketPlatform];

package/dist/api/types/PlatformMarketPlatform.js

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+export const PlatformMarketPlatform = {
+    Kalshi: "KALSHI",
+    Polymarket: "POLYMARKET",
+    Predict: "PREDICT",
+    Sxbet: "SXBET",
+};

package/dist/api/types/index.d.ts

@@ -1,3 +1,6 @@
+export * from "./CryptoPriceItem.js";
+export * from "./CryptoPricesResponse.js";
 export * from "./ErrorResponse.js";
 export * from "./PlatformMarket.js";
+export * from "./PlatformMarketPlatform.js";
 export * from "./SportsMatchingResponse.js";

package/dist/api/types/index.js

@@ -1,3 +1,6 @@
+export * from "./CryptoPriceItem.js";
+export * from "./CryptoPricesResponse.js";
 export * from "./ErrorResponse.js";
 export * from "./PlatformMarket.js";
+export * from "./PlatformMarketPlatform.js";
 export * from "./SportsMatchingResponse.js";

package/dist/core/auth/BasicAuth.d.ts

@@ -1,6 +1,6 @@
 export interface BasicAuth {
-    username: string;
-    password: string;
+    username?: string;
+    password?: string;
 }
 export declare const BasicAuth: {
     toAuthorizationHeader: (basicAuth: BasicAuth | undefined) => string | undefined;

package/dist/core/auth/BasicAuth.js

@@ -5,7 +5,12 @@ export const BasicAuth = {
         if (basicAuth == null) {
             return undefined;
         }
-        const token = base64Encode(`${basicAuth.username}:${basicAuth.password}`);
+        const username = basicAuth.username ?? "";
+        const password = basicAuth.password ?? "";
+        if (username === "" && password === "") {
+            return undefined;
+        }
+        const token = base64Encode(`${username}:${password}`);
         return `Basic ${token}`;
     },
     fromAuthorizationHeader: (header) => {

package/dist/core/index.d.ts

@@ -3,4 +3,5 @@ export * from "./base64.js";
 export * from "./fetcher/index.js";
 export * as logging from "./logging/index.js";
 export * from "./runtime/index.js";
+export * as serialization from "./schemas/index.js";
 export * as url from "./url/index.js";

package/dist/core/index.js

@@ -3,4 +3,5 @@ export * from "./base64.js";
 export * from "./fetcher/index.js";
 export * as logging from "./logging/index.js";
 export * from "./runtime/index.js";
+export * as serialization from "./schemas/index.js";
 export * as url from "./url/index.js";

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

@@ -0,0 +1,88 @@
+import type { SchemaUtils } from "./builders/index.js";
+export type Schema<Raw = unknown, Parsed = unknown> = BaseSchema<Raw, Parsed> & SchemaUtils<Raw, Parsed>;
+export type inferRaw<S extends Schema> = S extends Schema<infer Raw, any> ? Raw : never;
+export type inferParsed<S extends Schema> = S extends Schema<any, infer Parsed> ? Parsed : never;
+export interface BaseSchema<Raw, Parsed> {
+    parse: (raw: unknown, opts?: SchemaOptions) => MaybeValid<Parsed>;
+    json: (parsed: unknown, opts?: SchemaOptions) => MaybeValid<Raw>;
+    getType: () => SchemaType | SchemaType;
+}
+export declare const SchemaType: {
+    readonly BIGINT: "bigint";
+    readonly DATE: "date";
+    readonly ENUM: "enum";
+    readonly LIST: "list";
+    readonly STRING_LITERAL: "stringLiteral";
+    readonly BOOLEAN_LITERAL: "booleanLiteral";
+    readonly OBJECT: "object";
+    readonly ANY: "any";
+    readonly BOOLEAN: "boolean";
+    readonly NUMBER: "number";
+    readonly STRING: "string";
+    readonly UNKNOWN: "unknown";
+    readonly NEVER: "never";
+    readonly RECORD: "record";
+    readonly SET: "set";
+    readonly UNION: "union";
+    readonly UNDISCRIMINATED_UNION: "undiscriminatedUnion";
+    readonly NULLABLE: "nullable";
+    readonly OPTIONAL: "optional";
+    readonly OPTIONAL_NULLABLE: "optionalNullable";
+};
+export type SchemaType = (typeof SchemaType)[keyof typeof SchemaType];
+export type MaybeValid<T> = Valid<T> | Invalid;
+export interface Valid<T> {
+    ok: true;
+    value: T;
+}
+export interface Invalid {
+    ok: false;
+    errors: ValidationError[];
+}
+export interface ValidationError {
+    path: string[];
+    message: string;
+}
+export interface SchemaOptions {
+    /**
+     * how to handle unrecognized keys in objects
+     *
+     * @default "fail"
+     */
+    unrecognizedObjectKeys?: "fail" | "passthrough" | "strip";
+    /**
+     * whether to fail when an unrecognized discriminant value is
+     * encountered in a union
+     *
+     * @default false
+     */
+    allowUnrecognizedUnionMembers?: boolean;
+    /**
+     * whether to fail when an unrecognized enum value is encountered
+     *
+     * @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[];
+    /**
+     * whether to send 'null' for optional properties explicitly set to 'undefined'.
+     */
+    omitUndefined?: boolean;
+}

package/dist/core/schemas/Schema.js

@@ -0,0 +1,22 @@
+export const SchemaType = {
+    BIGINT: "bigint",
+    DATE: "date",
+    ENUM: "enum",
+    LIST: "list",
+    STRING_LITERAL: "stringLiteral",
+    BOOLEAN_LITERAL: "booleanLiteral",
+    OBJECT: "object",
+    ANY: "any",
+    BOOLEAN: "boolean",
+    NUMBER: "number",
+    STRING: "string",
+    UNKNOWN: "unknown",
+    NEVER: "never",
+    RECORD: "record",
+    SET: "set",
+    UNION: "union",
+    UNDISCRIMINATED_UNION: "undiscriminatedUnion",
+    NULLABLE: "nullable",
+    OPTIONAL: "optional",
+    OPTIONAL_NULLABLE: "optionalNullable",
+};

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

@@ -0,0 +1,2 @@
+import { type Schema } from "../../Schema.js";
+export declare function bigint(): Schema<bigint | number, bigint>;