@tapra/sdk 0.0.0-stage → 0.1.2

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

@@ -0,0 +1,28 @@
+/**
+ * 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;
+    /**
+     * The operating system the SDK is running on, when it can be determined
+     * (e.g. "linux", "darwin", "win32" on server runtimes). Undefined in
+     * environments where the OS is not observable (e.g. browsers).
+     */
+    os?: string;
+    /**
+     * The CPU architecture the SDK is running on, when it can be determined
+     * (e.g. "x64", "arm64" on server runtimes). Undefined in environments where
+     * the architecture is not observable (e.g. browsers).
+     */
+    arch?: string;
+}
+/**
+ * Builds a structured User-Agent string of the form
+ *   `{sdkName}/{sdkVersion} ({os}; {arch}) {runtime}/{runtimeVersion}`
+ * where the platform group and runtime segment are omitted gracefully when the
+ * underlying values cannot be determined (e.g. in a browser).
+ */
+export declare function getUserAgent(sdkName: string, sdkVersion: string): string;

package/dist/src/core/runtime/runtime.js

@@ -0,0 +1,172 @@
+/**
+ * A constant that indicates which environment and version the SDK is running in.
+ */
+export const RUNTIME = evaluateRuntime();
+function evaluateRuntime() {
+    /**
+     * 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" && globalThis?.navigator?.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" &&
+        typeof self?.importScripts === "function" &&
+        (self.constructor?.name === "DedicatedWorkerGlobalScope" ||
+            self.constructor?.name === "ServiceWorkerGlobalScope" ||
+            self.constructor?.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,
+            os: Deno.build?.os,
+            arch: Deno.build?.arch,
+        };
+    }
+    /**
+     * 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,
+            os: typeof process !== "undefined" ? process.platform : undefined,
+            arch: typeof process !== "undefined" ? process.arch : undefined,
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is in React-Native.
+     * This check should come before Node.js detection since React Native may have a process polyfill.
+     * https://github.com/facebook/react-native/blob/main/packages/react-native/Libraries/Core/setUpNavigator.js
+     */
+    const isReactNative = typeof navigator !== "undefined" && navigator?.product === "ReactNative";
+    if (isReactNative) {
+        return {
+            type: "react-native",
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is Node.JS.
+     *
+     * We assign `process` to a local variable first to avoid being flagged by
+     * bundlers that perform static analysis on `process.versions` (e.g. Next.js
+     * Edge Runtime warns about Node.js APIs even when they are guarded).
+     */
+    const _process = typeof process !== "undefined" ? process : undefined;
+    const isNode = typeof _process !== "undefined" && typeof _process.versions?.node === "string";
+    if (isNode) {
+        return {
+            type: "node",
+            version: _process.versions.node,
+            parsedVersion: Number(_process.versions.node.split(".")[0]),
+            os: _process.platform,
+            arch: _process.arch,
+        };
+    }
+    return {
+        type: "unknown",
+    };
+}
+/**
+ * Display names for the language runtimes whose version is meaningful to encode
+ * in a User-Agent. Environments where a version string is not useful (e.g.
+ * browsers, where `version` is the full navigator UA) are intentionally mapped
+ * to `undefined` so they are omitted from the User-Agent.
+ */
+const RUNTIME_DISPLAY_NAMES = {
+    node: "Node",
+    deno: "Deno",
+    bun: "Bun",
+    browser: undefined,
+    "web-worker": undefined,
+    "react-native": undefined,
+    workerd: undefined,
+    "edge-runtime": undefined,
+    unknown: undefined,
+};
+/**
+ * CPU architecture aliases that all refer to 64-bit x86. They are normalized to
+ * the single canonical token `x86_64` so the User-Agent architecture label is
+ * consistent regardless of which runtime reports it (Node reports `x64`, others
+ * report `amd64` or `x86_64`).
+ */
+const X86_64_ARCH_ALIASES = new Set(["x64", "amd64", "x86_64"]);
+/**
+ * Normalizes a CPU architecture token, collapsing the 64-bit x86 aliases
+ * (`x64`, `amd64`, `x86_64`) to `x86_64`. Other architectures are returned
+ * unchanged.
+ */
+function normalizeArch(arch) {
+    if (arch == null) {
+        return arch;
+    }
+    return X86_64_ARCH_ALIASES.has(arch.toLowerCase()) ? "x86_64" : arch;
+}
+/**
+ * Percent-encodes the `@` and `/` characters in an npm package name so the
+ * User-Agent product token stays within the RFC 7230 token grammar. The
+ * original scoped package name can be recovered by URL-decoding (e.g.
+ * `@dummy/sdk` becomes `%40dummy%2Fsdk`).
+ */
+function encodeProductName(sdkName) {
+    return sdkName.replace(/@/g, "%40").replace(/\//g, "%2F");
+}
+/**
+ * Builds a structured User-Agent string of the form
+ *   `{sdkName}/{sdkVersion} ({os}; {arch}) {runtime}/{runtimeVersion}`
+ * where the platform group and runtime segment are omitted gracefully when the
+ * underlying values cannot be determined (e.g. in a browser).
+ */
+export function getUserAgent(sdkName, sdkVersion) {
+    let userAgent = `${encodeProductName(sdkName)}/${sdkVersion}`;
+    const platform = [RUNTIME.os, normalizeArch(RUNTIME.arch)].filter((part) => part != null && part.length > 0);
+    if (platform.length > 0) {
+        userAgent += ` (${platform.join("; ")})`;
+    }
+    const runtimeName = RUNTIME_DISPLAY_NAMES[RUNTIME.type];
+    if (runtimeName != null) {
+        userAgent += ` ${runtimeName}`;
+        if (RUNTIME.version != null && RUNTIME.version.length > 0) {
+            userAgent += `/${RUNTIME.version}`;
+        }
+    }
+    return userAgent;
+}
+//# sourceMappingURL=runtime.js.map

package/dist/src/core/runtime/runtime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime.js","sourceRoot":"","sources":["../../../../src/core/runtime/runtime.ts"],"names":[],"mappings":"AAqBA;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAY,eAAe,EAAE,CAAC;AAoBlD,SAAS,eAAe;IACpB;;OAEG;IACH,MAAM,SAAS,GAAG,OAAO,MAAM,KAAK,WAAW,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,WAAW,CAAC;IAC1F,IAAI,SAAS,EAAE,CAAC;QACZ,OAAO;YACH,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,SAAS;SACtC,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,MAAM,YAAY,GAAG,OAAO,UAAU,KAAK,WAAW,IAAI,UAAU,EAAE,SAAS,EAAE,SAAS,KAAK,oBAAoB,CAAC;IACpH,IAAI,YAAY,EAAE,CAAC;QACf,OAAO;YACH,IAAI,EAAE,SAAS;SAClB,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,MAAM,aAAa,GAAG,OAAO,WAAW,KAAK,QAAQ,CAAC;IACtD,IAAI,aAAa,EAAE,CAAC;QAChB,OAAO;YACH,IAAI,EAAE,cAAc;SACvB,CAAC;IACN,CAAC;IAED;;OAEG;IACH,MAAM,WAAW,GACb,OAAO,IAAI,KAAK,QAAQ;QACxB,OAAO,IAAI,EAAE,aAAa,KAAK,UAAU;QACzC,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,KAAK,4BAA4B;YACpD,IAAI,CAAC,WAAW,EAAE,IAAI,KAAK,0BAA0B;YACrD,IAAI,CAAC,WAAW,EAAE,IAAI,KAAK,yBAAyB,CAAC,CAAC;IAC9D,IAAI,WAAW,EAAE,CAAC;QACd,OAAO;YACH,IAAI,EAAE,YAAY;SACrB,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,MAAM,MAAM,GACR,OAAO,IAAI,KAAK,WAAW,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,WAAW,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC;IACnH,IAAI,MAAM,EAAE,CAAC;QACT,OAAO;YACH,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;YAC1B,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,EAAE;YAClB,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI;SACzB,CAAC;IACN,CAAC;IAED;;OAEG;IACH,MAAM,KAAK,GAAG,OAAO,GAAG,KAAK,WAAW,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,WAAW,CAAC;IAC/E,IAAI,KAAK,EAAE,CAAC;QACR,OAAO;YACH,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,EAAE,EAAE,OAAO,OAAO,KAAK,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;YACjE,IAAI,EAAE,OAAO,OAAO,KAAK,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;SAClE,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,MAAM,aAAa,GAAG,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,EAAE,OAAO,KAAK,aAAa,CAAC;IAC/F,IAAI,aAAa,EAAE,CAAC;QAChB,OAAO;YACH,IAAI,EAAE,cAAc;SACvB,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACH,MAAM,QAAQ,GAAG,OAAO,OAAO,KAAK,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IACtE,MAAM,MAAM,GAAG,OAAO,QAAQ,KAAK,WAAW,IAAI,OAAO,QAAQ,CAAC,QAAQ,EAAE,IAAI,KAAK,QAAQ,CAAC;IAC9F,IAAI,MAAM,EAAE,CAAC;QACT,OAAO;YACH,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,QAAQ,CAAC,QAAQ,CAAC,IAAI;YAC/B,aAAa,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YAC3D,EAAE,EAAE,QAAQ,CAAC,QAAQ;YACrB,IAAI,EAAE,QAAQ,CAAC,IAAI;SACtB,CAAC;IACN,CAAC;IAED,OAAO;QACH,IAAI,EAAE,SAAS;KAClB,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,MAAM,qBAAqB,GAAgD;IACvE,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,GAAG,EAAE,KAAK;IACV,OAAO,EAAE,SAAS;IAClB,YAAY,EAAE,SAAS;IACvB,cAAc,EAAE,SAAS;IACzB,OAAO,EAAE,SAAS;IAClB,cAAc,EAAE,SAAS;IACzB,OAAO,EAAE,SAAS;CACrB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;AAEhE;;;;GAIG;AACH,SAAS,aAAa,CAAC,IAAwB;IAC3C,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;AACzE,CAAC;AAED;;;;;GAKG;AACH,SAAS,iBAAiB,CAAC,OAAe;IACtC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,OAAe,EAAE,UAAkB;IAC5D,IAAI,SAAS,GAAG,GAAG,iBAAiB,CAAC,OAAO,CAAC,IAAI,UAAU,EAAE,CAAC;IAE9D,MAAM,QAAQ,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAC7D,CAAC,IAAI,EAAkB,EAAE,CAAC,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,CAC5D,CAAC;IACF,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,SAAS,IAAI,KAAK,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IAC7C,CAAC;IAED,MAAM,WAAW,GAAG,qBAAqB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACxD,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;QACtB,SAAS,IAAI,IAAI,WAAW,EAAE,CAAC;QAC/B,IAAI,OAAO,CAAC,OAAO,IAAI,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxD,SAAS,IAAI,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACvC,CAAC;IACL,CAAC;IAED,OAAO,SAAS,CAAC;AACrB,CAAC"}

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

@@ -0,0 +1,100 @@
+export declare namespace Stream {
+    interface Args {
+        /**
+         * The HTTP response stream to read from.
+         */
+        stream: ReadableStream;
+        /**
+         * The event shape to use for parsing the stream data.
+         */
+        eventShape: JsonEvent | SseEvent;
+        /**
+         * An abort signal to stop the stream.
+         */
+        signal?: AbortSignal;
+        /**
+         * Whether transparent mid-stream reconnection is enabled on resumable
+         * SSE endpoints. Defaults to true. Has no effect on non-resumable endpoints.
+         */
+        reconnectionEnabled?: boolean;
+        /**
+         * Maximum number of consecutive failed reconnect attempts on resumable SSE
+         * endpoints before giving up. The counter resets to zero each time a
+         * reconnected stream successfully yields at least one event (i.e. makes
+         * progress). Has no effect on non-resumable endpoints.
+         */
+        maxReconnectionAttempts?: number;
+        /**
+         * A function that re-issues the HTTP request with the Last-Event-ID header
+         * and returns the new response body stream. Required for reconnection to work.
+         */
+        reconnect?: (lastEventId: string) => Promise<ReadableStream>;
+    }
+    interface JsonEvent {
+        type: "json";
+        messageTerminator: string;
+    }
+    interface SseEvent {
+        type: "sse";
+        streamTerminator?: string;
+        eventDiscriminator?: string;
+        resumable?: boolean;
+    }
+}
+export interface ServerSentEvent<T> {
+    data: T;
+    id?: string;
+    retry?: number;
+    event?: 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 eventDiscriminator;
+    private resumable;
+    private reconnectionEnabled;
+    private maxReconnectionAttempts;
+    private reconnect;
+    private controller;
+    private decoder;
+    private externalSignal;
+    private onExternalAbort;
+    constructor({ stream, parse, eventShape, signal, reconnectionEnabled, maxReconnectionAttempts, reconnect, }: Stream.Args & {
+        parse: (val: unknown) => Promise<T>;
+    });
+    private iterMessages;
+    private iterDataMessages;
+    private iterSseEvents;
+    /**
+     * Parses and returns a single SSE event, or returns null if the event is a stream terminator.
+     */
+    private dispatchSseEvent;
+    /**
+     * Determines whether a reconnection attempt should be made.
+     */
+    private shouldReconnect;
+    /**
+     * Delays before reconnecting, using a server-sent retry directive if provided
+     * (clamped to MAX_RECONNECT_DELAY_MS), otherwise falling back to
+     * DEFAULT_RECONNECT_DELAY_MS. The delay is abortable: if the stream's abort
+     * signal fires during the wait, the promise resolves immediately.
+     */
+    private delayReconnect;
+    private createEmptyStream;
+    private removeAbortListener;
+    withMetadata(): AsyncIterable<ServerSentEvent<T>>;
+    private injectDiscriminator;
+    [Symbol.asyncIterator](): AsyncIterator<T, void, unknown>;
+    private decodeChunk;
+}
+/**
+ * Browser polyfill for ReadableStream
+ */
+export declare function readableStreamAsyncIterable<T>(stream: any): AsyncIterableIterator<T>;