@rulebricks/sdk 1.0.0 → 1.2.0

package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.js

@@ -0,0 +1,229 @@
+"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.UndiciStreamWrapper = void 0;
+class UndiciStreamWrapper {
+    constructor(readableStream) {
+        this.readableStream = readableStream;
+        this.reader = this.readableStream.getReader();
+        this.events = {
+            data: [],
+            end: [],
+            error: [],
+            readable: [],
+            close: [],
+            pause: [],
+            resume: [],
+        };
+        this.paused = false;
+        this.resumeCallback = null;
+        this.encoding = null;
+    }
+    on(event, callback) {
+        var _a;
+        (_a = this.events[event]) === null || _a === void 0 ? void 0 : _a.push(callback);
+    }
+    off(event, callback) {
+        var _a;
+        this.events[event] = (_a = this.events[event]) === null || _a === void 0 ? void 0 : _a.filter((cb) => cb !== callback);
+    }
+    pipe(dest) {
+        this.on("data", (chunk) => {
+            if (dest instanceof UndiciStreamWrapper) {
+                dest._write(chunk);
+            }
+            else {
+                const writer = dest.getWriter();
+                writer.write(chunk).then(() => writer.releaseLock());
+            }
+        });
+        this.on("end", () => {
+            if (dest instanceof UndiciStreamWrapper) {
+                dest._end();
+            }
+            else {
+                const writer = dest.getWriter();
+                writer.close();
+            }
+        });
+        this.on("error", (error) => {
+            if (dest instanceof UndiciStreamWrapper) {
+                dest._error(error);
+            }
+            else {
+                const writer = dest.getWriter();
+                writer.abort(error);
+            }
+        });
+        this._startReading();
+        return dest;
+    }
+    pipeTo(dest) {
+        return this.pipe(dest);
+    }
+    unpipe(dest) {
+        this.off("data", (chunk) => {
+            if (dest instanceof UndiciStreamWrapper) {
+                dest._write(chunk);
+            }
+            else {
+                const writer = dest.getWriter();
+                writer.write(chunk).then(() => writer.releaseLock());
+            }
+        });
+        this.off("end", () => {
+            if (dest instanceof UndiciStreamWrapper) {
+                dest._end();
+            }
+            else {
+                const writer = dest.getWriter();
+                writer.close();
+            }
+        });
+        this.off("error", (error) => {
+            if (dest instanceof UndiciStreamWrapper) {
+                dest._error(error);
+            }
+            else {
+                const writer = dest.getWriter();
+                writer.abort(error);
+            }
+        });
+    }
+    destroy(error) {
+        this.reader
+            .cancel(error)
+            .then(() => {
+            this._emit("close");
+        })
+            .catch((err) => {
+            this._emit("error", err);
+        });
+    }
+    pause() {
+        this.paused = true;
+        this._emit("pause");
+    }
+    resume() {
+        if (this.paused) {
+            this.paused = false;
+            this._emit("resume");
+            if (this.resumeCallback) {
+                this.resumeCallback();
+                this.resumeCallback = null;
+            }
+        }
+    }
+    get isPaused() {
+        return this.paused;
+    }
+    read() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.paused) {
+                yield new Promise((resolve) => {
+                    this.resumeCallback = resolve;
+                });
+            }
+            const { done, value } = yield this.reader.read();
+            if (done) {
+                return undefined;
+            }
+            return value;
+        });
+    }
+    setEncoding(encoding) {
+        this.encoding = encoding;
+    }
+    text() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const chunks = [];
+            while (true) {
+                const { done, value } = yield this.reader.read();
+                if (done) {
+                    break;
+                }
+                if (value) {
+                    chunks.push(value);
+                }
+            }
+            const decoder = new TextDecoder(this.encoding || "utf-8");
+            return decoder.decode(yield new Blob(chunks).arrayBuffer());
+        });
+    }
+    json() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const text = yield this.text();
+            return JSON.parse(text);
+        });
+    }
+    _write(chunk) {
+        this._emit("data", chunk);
+    }
+    _end() {
+        this._emit("end");
+    }
+    _error(error) {
+        this._emit("error", error);
+    }
+    _emit(event, data) {
+        if (this.events[event]) {
+            for (const callback of this.events[event] || []) {
+                callback(data);
+            }
+        }
+    }
+    _startReading() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                this._emit("readable");
+                while (true) {
+                    if (this.paused) {
+                        yield new Promise((resolve) => {
+                            this.resumeCallback = resolve;
+                        });
+                    }
+                    const { done, value } = yield this.reader.read();
+                    if (done) {
+                        this._emit("end");
+                        this._emit("close");
+                        break;
+                    }
+                    if (value) {
+                        this._emit("data", value);
+                    }
+                }
+            }
+            catch (error) {
+                this._emit("error", error);
+            }
+        });
+    }
+    [Symbol.asyncIterator]() {
+        return {
+            next: () => __awaiter(this, void 0, void 0, function* () {
+                if (this.paused) {
+                    yield new Promise((resolve) => {
+                        this.resumeCallback = resolve;
+                    });
+                }
+                const { done, value } = yield this.reader.read();
+                if (done) {
+                    return { done: true, value: undefined };
+                }
+                return { done: false, value };
+            }),
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+        };
+    }
+}
+exports.UndiciStreamWrapper = UndiciStreamWrapper;

package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts

@@ -0,0 +1,18 @@
+export declare type EventCallback = (data?: any) => void;
+export interface StreamWrapper<WritableStream, ReadFormat> {
+    setEncoding(encoding?: string): void;
+    on(event: string, callback: EventCallback): void;
+    off(event: string, callback: EventCallback): void;
+    pipe(dest: WritableStream): WritableStream;
+    pipeTo(dest: WritableStream): WritableStream;
+    unpipe(dest?: WritableStream): void;
+    destroy(error?: Error): void;
+    pause(): void;
+    resume(): void;
+    get isPaused(): boolean;
+    read(): Promise<ReadFormat | undefined>;
+    text(): Promise<string>;
+    json<T>(): Promise<T>;
+    [Symbol.asyncIterator](): AsyncIterableIterator<ReadFormat>;
+}
+export declare function chooseStreamWrapper(responseBody: any): Promise<Promise<StreamWrapper<any, any>>>;

package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.js

@@ -0,0 +1,50 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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.chooseStreamWrapper = void 0;
+const runtime_1 = require("../../runtime");
+function chooseStreamWrapper(responseBody) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (runtime_1.RUNTIME.type === "node" && runtime_1.RUNTIME.parsedVersion != null && runtime_1.RUNTIME.parsedVersion >= 18) {
+            return new (yield Promise.resolve().then(() => __importStar(require("./Node18UniversalStreamWrapper")))).Node18UniversalStreamWrapper(responseBody);
+        }
+        else if (runtime_1.RUNTIME.type !== "node" && typeof fetch === "function") {
+            return new (yield Promise.resolve().then(() => __importStar(require("./UndiciStreamWrapper")))).UndiciStreamWrapper(responseBody);
+        }
+        else {
+            return new (yield Promise.resolve().then(() => __importStar(require("./NodePre18StreamWrapper")))).NodePre18StreamWrapper(responseBody);
+        }
+    });
+}
+exports.chooseStreamWrapper = chooseStreamWrapper;

package/dist/core/index.d.ts

@@ -1,2 +1,3 @@
-export var __esModule: boolean;
-export var serialization: any;
+export * from "./fetcher";
+export * from "./runtime";
+export * as serialization from "./schemas";

package/dist/core/index.js

@@ -1,39 +1,32 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function (o, m, k, k2) {
-    if (k2 === undefined)
-        k2 = k;
+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]; } };
+      desc = { enumerable: true, get: function() { return m[k]; } };
     }
     Object.defineProperty(o, k2, desc);
-}) : (function (o, m, k, k2) {
-    if (k2 === undefined)
-        k2 = k;
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function (o, v) {
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
     Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function (o, v) {
+}) : function(o, v) {
     o["default"] = v;
 });
-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);
+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);
 };
 var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule)
-        return mod;
+    if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null)
-        for (var k in mod)
-            if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
-                __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.serialization = void 0;
 __exportStar(require("./fetcher"), exports);
+__exportStar(require("./runtime"), exports);
 exports.serialization = __importStar(require("./schemas"));

package/dist/core/json.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Serialize a value to JSON
+ * @param value A JavaScript value, usually an object or array, to be converted.
+ * @param replacer A function that transforms the results.
+ * @param space Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
+ * @returns JSON string
+ */
+export declare const toJson: (value: unknown, replacer?: ((this: unknown, key: string, value: unknown) => unknown) | undefined, space?: string | number | undefined) => string;
+/**
+ * Parse JSON string to object, array, or other type
+ * @param text A valid JSON string.
+ * @param reviver A function that transforms the results. This function is called for each member of the object. If a member contains nested objects, the nested objects are transformed before the parent object is.
+ * @returns Parsed object, array, or other type
+ */
+export declare function fromJson<T = unknown>(text: string, reviver?: (this: unknown, key: string, value: unknown) => unknown): T;

package/dist/core/json.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fromJson = exports.toJson = void 0;
+/**
+ * Serialize a value to JSON
+ * @param value A JavaScript value, usually an object or array, to be converted.
+ * @param replacer A function that transforms the results.
+ * @param space Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
+ * @returns JSON string
+ */
+const toJson = (value, replacer, space) => {
+    return JSON.stringify(value, replacer, space);
+};
+exports.toJson = toJson;
+/**
+ * Parse JSON string to object, array, or other type
+ * @param text A valid JSON string.
+ * @param reviver A function that transforms the results. This function is called for each member of the object. If a member contains nested objects, the nested objects are transformed before the parent object is.
+ * @returns Parsed object, array, or other type
+ */
+function fromJson(text, reviver) {
+    return JSON.parse(text, reviver);
+}
+exports.fromJson = fromJson;

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

@@ -0,0 +1 @@
+export { RUNTIME } from "./runtime";

package/dist/core/runtime/index.js

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

package/dist/core/runtime/runtime.d.ts

@@ -0,0 +1,9 @@
+/**
+ * A constant that indicates which environment and version the SDK is running in.
+ */
+export declare const RUNTIME: Runtime;
+export interface Runtime {
+    type: "browser" | "web-worker" | "deno" | "bun" | "node" | "react-native" | "unknown" | "workerd" | "edge-runtime";
+    version?: string;
+    parsedVersion?: number;
+}

package/dist/core/runtime/runtime.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RUNTIME = void 0;
+/**
+ * A constant that indicates which environment and version the SDK is running in.
+ */
+exports.RUNTIME = evaluateRuntime();
+function evaluateRuntime() {
+    var _a, _b, _c, _d, _e;
+    /**
+     * A constant that indicates whether the environment the code is running is a Web Browser.
+     */
+    const isBrowser = typeof window !== "undefined" && typeof window.document !== "undefined";
+    if (isBrowser) {
+        return {
+            type: "browser",
+            version: window.navigator.userAgent,
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is Cloudflare.
+     * https://developers.cloudflare.com/workers/runtime-apis/web-standards/#navigatoruseragent
+     */
+    const isCloudflare = typeof globalThis !== "undefined" && ((_a = globalThis === null || globalThis === void 0 ? void 0 : globalThis.navigator) === null || _a === void 0 ? void 0 : _a.userAgent) === "Cloudflare-Workers";
+    if (isCloudflare) {
+        return {
+            type: "workerd",
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is Edge Runtime.
+     * https://vercel.com/docs/functions/runtimes/edge-runtime#check-if-you're-running-on-the-edge-runtime
+     */
+    const isEdgeRuntime = typeof EdgeRuntime === "string";
+    if (isEdgeRuntime) {
+        return {
+            type: "edge-runtime",
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is a Web Worker.
+     */
+    const isWebWorker = typeof self === "object" &&
+        // @ts-ignore
+        typeof (self === null || self === void 0 ? void 0 : self.importScripts) === "function" &&
+        (((_b = self.constructor) === null || _b === void 0 ? void 0 : _b.name) === "DedicatedWorkerGlobalScope" ||
+            ((_c = self.constructor) === null || _c === void 0 ? void 0 : _c.name) === "ServiceWorkerGlobalScope" ||
+            ((_d = self.constructor) === null || _d === void 0 ? void 0 : _d.name) === "SharedWorkerGlobalScope");
+    if (isWebWorker) {
+        return {
+            type: "web-worker",
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is Deno.
+     * FYI Deno spoofs process.versions.node, see https://deno.land/std@0.177.0/node/process.ts?s=versions
+     */
+    const isDeno = typeof Deno !== "undefined" && typeof Deno.version !== "undefined" && typeof Deno.version.deno !== "undefined";
+    if (isDeno) {
+        return {
+            type: "deno",
+            version: Deno.version.deno,
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is Bun.sh.
+     */
+    const isBun = typeof Bun !== "undefined" && typeof Bun.version !== "undefined";
+    if (isBun) {
+        return {
+            type: "bun",
+            version: Bun.version,
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is Node.JS.
+     */
+    const isNode = typeof process !== "undefined" &&
+        "version" in process &&
+        !!process.version &&
+        "versions" in process &&
+        !!((_e = process.versions) === null || _e === void 0 ? void 0 : _e.node);
+    if (isNode) {
+        return {
+            type: "node",
+            version: process.versions.node,
+            parsedVersion: Number(process.versions.node.split(".")[0]),
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is in React-Native.
+     * https://github.com/facebook/react-native/blob/main/packages/react-native/Libraries/Core/setUpNavigator.js
+     */
+    const isReactNative = typeof navigator !== "undefined" && (navigator === null || navigator === void 0 ? void 0 : navigator.product) === "ReactNative";
+    if (isReactNative) {
+        return {
+            type: "react-native",
+        };
+    }
+    return {
+        type: "unknown",
+    };
+}

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

@@ -1,19 +1,87 @@
-export var __esModule: boolean;
-export namespace SchemaType {
-    const DATE: string;
-    const ENUM: string;
-    const LIST: string;
-    const STRING_LITERAL: string;
-    const BOOLEAN_LITERAL: string;
-    const OBJECT: string;
-    const ANY: string;
-    const BOOLEAN: string;
-    const NUMBER: string;
-    const STRING: string;
-    const UNKNOWN: string;
-    const RECORD: string;
-    const SET: string;
-    const UNION: string;
-    const UNDISCRIMINATED_UNION: string;
-    const OPTIONAL: string;
+import { SchemaUtils } from "./builders";
+export declare type Schema<Raw = unknown, Parsed = unknown> = BaseSchema<Raw, Parsed> & SchemaUtils<Raw, Parsed>;
+export declare type inferRaw<S extends Schema> = S extends Schema<infer Raw, any> ? Raw : never;
+export declare 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 RECORD: "record";
+    readonly SET: "set";
+    readonly UNION: "union";
+    readonly UNDISCRIMINATED_UNION: "undiscriminatedUnion";
+    readonly NULLABLE: "nullable";
+    readonly OPTIONAL: "optional";
+    readonly OPTIONAL_NULLABLE: "optionalNullable";
+};
+export declare type SchemaType = (typeof SchemaType)[keyof typeof SchemaType];
+export declare 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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SchemaType = void 0;
 exports.SchemaType = {
+    BIGINT: "bigint",
     DATE: "date",
     ENUM: "enum",
     LIST: "list",
@@ -17,5 +18,7 @@ exports.SchemaType = {
     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 { Schema } from "../../Schema";
+export declare function bigint(): Schema<bigint | number, bigint>;