@schedulin/sdk 0.1.2 → 0.2.0

package/esm/core/fetcher/redactUrl.mjs

@@ -0,0 +1,84 @@
+export const SENSITIVE_QUERY_PARAMS = new Set([
+    "api_key",
+    "api-key",
+    "apikey",
+    "token",
+    "access_token",
+    "access-token",
+    "auth_token",
+    "auth-token",
+    "password",
+    "passwd",
+    "secret",
+    "api_secret",
+    "api-secret",
+    "apisecret",
+    "key",
+    "session",
+    "session_id",
+    "session-id",
+]);
+export function redactUrl(url) {
+    const protocolIndex = url.indexOf("://");
+    if (protocolIndex === -1)
+        return url;
+    const afterProtocol = protocolIndex + 3;
+    // Find the first delimiter that marks the end of the authority section
+    const pathStart = url.indexOf("/", afterProtocol);
+    let queryStart = url.indexOf("?", afterProtocol);
+    let fragmentStart = url.indexOf("#", afterProtocol);
+    const firstDelimiter = Math.min(pathStart === -1 ? url.length : pathStart, queryStart === -1 ? url.length : queryStart, fragmentStart === -1 ? url.length : fragmentStart);
+    // Find the LAST @ before the delimiter (handles multiple @ in credentials)
+    let atIndex = -1;
+    for (let i = afterProtocol; i < firstDelimiter; i++) {
+        if (url[i] === "@") {
+            atIndex = i;
+        }
+    }
+    if (atIndex !== -1) {
+        url = `${url.slice(0, afterProtocol)}[REDACTED]@${url.slice(atIndex + 1)}`;
+    }
+    // Recalculate queryStart since url might have changed
+    queryStart = url.indexOf("?");
+    if (queryStart === -1)
+        return url;
+    fragmentStart = url.indexOf("#", queryStart);
+    const queryEnd = fragmentStart !== -1 ? fragmentStart : url.length;
+    const queryString = url.slice(queryStart + 1, queryEnd);
+    if (queryString.length === 0)
+        return url;
+    // FAST PATH: Quick check if any sensitive keywords present
+    // Using indexOf is faster than regex for simple substring matching
+    const lower = queryString.toLowerCase();
+    const hasSensitive = lower.includes("token") ||
+        lower.includes("key") ||
+        lower.includes("password") ||
+        lower.includes("passwd") ||
+        lower.includes("secret") ||
+        lower.includes("session") ||
+        lower.includes("auth");
+    if (!hasSensitive) {
+        return url;
+    }
+    // SLOW PATH: Parse and redact
+    const redactedParams = [];
+    const params = queryString.split("&");
+    for (const param of params) {
+        const equalIndex = param.indexOf("=");
+        if (equalIndex === -1) {
+            redactedParams.push(param);
+            continue;
+        }
+        const key = param.slice(0, equalIndex);
+        let shouldRedact = SENSITIVE_QUERY_PARAMS.has(key.toLowerCase());
+        if (!shouldRedact && key.includes("%")) {
+            try {
+                const decodedKey = decodeURIComponent(key);
+                shouldRedact = SENSITIVE_QUERY_PARAMS.has(decodedKey.toLowerCase());
+            }
+            catch (_a) { }
+        }
+        redactedParams.push(shouldRedact ? `${key}=[REDACTED]` : param);
+    }
+    return url.slice(0, queryStart + 1) + redactedParams.join("&") + url.slice(queryEnd);
+}

package/esm/core/file/exports.d.mts

@@ -0,0 +1 @@
+export type { Uploadable } from "./types.mjs";

package/esm/core/file/exports.mjs

@@ -0,0 +1 @@
+export {};

package/esm/core/file/file.d.mts

@@ -0,0 +1,10 @@
+import type { Uploadable } from "./types.mjs";
+export declare function toBinaryUploadRequest(file: Uploadable): Promise<{
+    body: Uploadable.FileLike;
+    headers?: Record<string, string>;
+}>;
+export declare function toMultipartDataPart(file: Uploadable): Promise<{
+    data: Uploadable.FileLike;
+    filename?: string;
+    contentType?: string;
+}>;

package/esm/core/file/file.mjs

@@ -0,0 +1,188 @@
+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());
+    });
+};
+export function toBinaryUploadRequest(file) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { data, filename, contentLength, contentType } = yield getFileWithMetadata(file);
+        const request = {
+            body: data,
+            headers: {},
+        };
+        if (filename) {
+            request.headers["Content-Disposition"] = `attachment; filename="${filename}"`;
+        }
+        if (contentType) {
+            request.headers["Content-Type"] = contentType;
+        }
+        if (contentLength != null) {
+            request.headers["Content-Length"] = contentLength.toString();
+        }
+        return request;
+    });
+}
+export function toMultipartDataPart(file) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { data, filename, contentType } = yield getFileWithMetadata(file, {
+            noSniffFileSize: true,
+        });
+        return {
+            data,
+            filename,
+            contentType,
+        };
+    });
+}
+function getFileWithMetadata(file_1) {
+    return __awaiter(this, arguments, void 0, function* (file, { noSniffFileSize } = {}) {
+        var _a, _b, _c, _d, _e;
+        if (file == null) {
+            throw new Error(`Expected file to be a Blob, Buffer, ReadableStream, or an object with a "path" or "data" property, but received ${file === null ? "null" : "undefined"}.`);
+        }
+        if (isFileLike(file)) {
+            return getFileWithMetadata({
+                data: file,
+            }, { noSniffFileSize });
+        }
+        if ("path" in file) {
+            const fs = yield import("fs");
+            if (!(fs === null || fs === void 0 ? void 0 : fs.createReadStream)) {
+                throw new Error("File path uploads are not supported in this environment.");
+            }
+            const data = fs.createReadStream(file.path);
+            const contentLength = (_a = file.contentLength) !== null && _a !== void 0 ? _a : (noSniffFileSize === true ? undefined : yield tryGetFileSizeFromPath(file.path));
+            const filename = (_b = file.filename) !== null && _b !== void 0 ? _b : getNameFromPath(file.path);
+            return {
+                data,
+                filename,
+                contentType: file.contentType,
+                contentLength,
+            };
+        }
+        if ("data" in file) {
+            const data = file.data;
+            const contentLength = (_c = file.contentLength) !== null && _c !== void 0 ? _c : (yield tryGetContentLengthFromFileLike(data, {
+                noSniffFileSize,
+            }));
+            const filename = (_d = file.filename) !== null && _d !== void 0 ? _d : tryGetNameFromFileLike(data);
+            return {
+                data,
+                filename,
+                contentType: (_e = file.contentType) !== null && _e !== void 0 ? _e : tryGetContentTypeFromFileLike(data),
+                contentLength,
+            };
+        }
+        throw new Error(`Invalid FileUpload of type ${typeof file}: ${JSON.stringify(file)}`);
+    });
+}
+function isFileLike(value) {
+    return (isBuffer(value) ||
+        isArrayBufferView(value) ||
+        isArrayBuffer(value) ||
+        isUint8Array(value) ||
+        isBlob(value) ||
+        isFile(value) ||
+        isStreamLike(value) ||
+        isReadableStream(value));
+}
+function tryGetFileSizeFromPath(path) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        try {
+            const fs = yield import("fs");
+            if (!((_a = fs === null || fs === void 0 ? void 0 : fs.promises) === null || _a === void 0 ? void 0 : _a.stat)) {
+                return undefined;
+            }
+            const fileStat = yield fs.promises.stat(path);
+            return fileStat.size;
+        }
+        catch (_fallbackError) {
+            return undefined;
+        }
+    });
+}
+function tryGetNameFromFileLike(data) {
+    if (isNamedValue(data)) {
+        return data.name;
+    }
+    if (isPathedValue(data)) {
+        return getNameFromPath(data.path.toString());
+    }
+    return undefined;
+}
+function tryGetContentLengthFromFileLike(data_1) {
+    return __awaiter(this, arguments, void 0, function* (data, { noSniffFileSize } = {}) {
+        if (isBuffer(data)) {
+            return data.length;
+        }
+        if (isArrayBufferView(data)) {
+            return data.byteLength;
+        }
+        if (isArrayBuffer(data)) {
+            return data.byteLength;
+        }
+        if (isBlob(data)) {
+            return data.size;
+        }
+        if (isFile(data)) {
+            return data.size;
+        }
+        if (noSniffFileSize === true) {
+            return undefined;
+        }
+        if (isPathedValue(data)) {
+            return yield tryGetFileSizeFromPath(data.path.toString());
+        }
+        return undefined;
+    });
+}
+function tryGetContentTypeFromFileLike(data) {
+    if (isBlob(data)) {
+        return data.type;
+    }
+    if (isFile(data)) {
+        return data.type;
+    }
+    return undefined;
+}
+function getNameFromPath(path) {
+    const lastForwardSlash = path.lastIndexOf("/");
+    const lastBackSlash = path.lastIndexOf("\\");
+    const lastSlashIndex = Math.max(lastForwardSlash, lastBackSlash);
+    return lastSlashIndex >= 0 ? path.substring(lastSlashIndex + 1) : path;
+}
+function isNamedValue(value) {
+    return typeof value === "object" && value != null && "name" in value;
+}
+function isPathedValue(value) {
+    return typeof value === "object" && value != null && "path" in value;
+}
+function isStreamLike(value) {
+    return typeof value === "object" && value != null && ("read" in value || "pipe" in value);
+}
+function isReadableStream(value) {
+    return typeof value === "object" && value != null && "getReader" in value;
+}
+function isBuffer(value) {
+    return typeof Buffer !== "undefined" && Buffer.isBuffer && Buffer.isBuffer(value);
+}
+function isArrayBufferView(value) {
+    return typeof ArrayBuffer !== "undefined" && ArrayBuffer.isView(value);
+}
+function isArrayBuffer(value) {
+    return typeof ArrayBuffer !== "undefined" && value instanceof ArrayBuffer;
+}
+function isUint8Array(value) {
+    return typeof Uint8Array !== "undefined" && value instanceof Uint8Array;
+}
+function isBlob(value) {
+    return typeof Blob !== "undefined" && value instanceof Blob;
+}
+function isFile(value) {
+    return typeof File !== "undefined" && value instanceof File;
+}

package/esm/core/file/index.d.mts

@@ -0,0 +1,2 @@
+export * from "./file.mjs";
+export * from "./types.mjs";

package/esm/core/file/index.mjs

@@ -0,0 +1,2 @@
+export * from "./file.mjs";
+export * from "./types.mjs";

package/esm/core/file/types.d.mts

@@ -0,0 +1,66 @@
+/**
+ * A file that can be uploaded. Can be a file-like object (stream, buffer, blob, etc.),
+ * a path to a file, or an object with a file-like object and metadata.
+ */
+export type Uploadable = Uploadable.FileLike | Uploadable.FromPath | Uploadable.WithMetadata;
+export declare namespace Uploadable {
+    /**
+     * Various file-like objects that can be used to upload a file.
+     */
+    type FileLike = ArrayBuffer | ArrayBufferLike | ArrayBufferView | Uint8Array | import("buffer").Buffer | import("buffer").Blob | import("buffer").File | import("stream").Readable | import("stream/web").ReadableStream | globalThis.Blob | globalThis.File | ReadableStream;
+    /**
+     * A file path with optional metadata, used for uploading a file from the file system.
+     */
+    type FromPath = {
+        /** The path to the file to upload */
+        path: string;
+        /**
+         * Optional override for the file name (defaults to basename of path).
+         * This is used to set the `Content-Disposition` header in upload requests.
+         */
+        filename?: string;
+        /**
+         * Optional MIME type of the file (e.g., 'image/jpeg', 'text/plain').
+         * This is used to set the `Content-Type` header in upload requests.
+         */
+        contentType?: string;
+        /**
+         * Optional file size in bytes.
+         * If not provided, the file size will be determined from the file system.
+         * The content length is used to set the `Content-Length` header in upload requests.
+         */
+        contentLength?: number;
+    };
+    /**
+     * A file-like object with metadata, used for uploading files.
+     */
+    type WithMetadata = {
+        /** The file data */
+        data: FileLike;
+        /**
+         * Optional override for the file name (defaults to basename of path).
+         * This is used to set the `Content-Disposition` header in upload requests.
+         */
+        filename?: string;
+        /**
+         * Optional MIME type of the file (e.g., 'image/jpeg', 'text/plain').
+         * This is used to set the `Content-Type` header in upload requests.
+         *
+         * If not provided, the content type may be determined from the data itself.
+         * * If the data is a `File`, `Blob`, or similar, the content type will be determined from the file itself, if the type is set.
+         * * Any other data type will not have a content type set, and the upload request will use `Content-Type: application/octet-stream` instead.
+         */
+        contentType?: string;
+        /**
+         * Optional file size in bytes.
+         * The content length is used to set the `Content-Length` header in upload requests.
+         * If the content length is not provided and cannot be determined, the upload request will not include the `Content-Length` header, but will use `Transfer-Encoding: chunked` instead.
+         *
+         * If not provided, the file size will be determined depending on the data type.
+         * * If the data is of type `fs.ReadStream` (`createReadStream`), the size will be determined from the file system.
+         * * If the data is a `Buffer`, `ArrayBuffer`, `Uint8Array`, `Blob`, `File`, or similar, the size will be determined from the data itself.
+         * * If the data is a `Readable` or `ReadableStream`, the size will not be determined.
+         */
+        contentLength?: number;
+    };
+}

package/esm/core/file/types.mjs

@@ -0,0 +1 @@
+export {};

package/esm/core/form-data-utils/FormDataWrapper.d.mts

@@ -0,0 +1,15 @@
+import { type Uploadable } from "../../core/file/index.mjs";
+interface FormDataRequest<Body> {
+    body: Body;
+    headers: Record<string, string>;
+    duplex?: "half";
+}
+export declare function newFormData(): Promise<FormDataWrapper>;
+export declare class FormDataWrapper {
+    private fd;
+    setup(): Promise<void>;
+    append(key: string, value: unknown): void;
+    appendFile(key: string, value: Uploadable): Promise<void>;
+    getRequest(): FormDataRequest<FormData>;
+}
+export {};

package/esm/core/form-data-utils/FormDataWrapper.mjs

@@ -0,0 +1,150 @@
+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());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+import { toMultipartDataPart } from "../../core/file/index.mjs";
+import { toJson } from "../../core/json.mjs";
+import { RUNTIME } from "../runtime/index.mjs";
+export function newFormData() {
+    return __awaiter(this, void 0, void 0, function* () {
+        return new FormDataWrapper();
+    });
+}
+export class FormDataWrapper {
+    constructor() {
+        this.fd = new FormData();
+    }
+    setup() {
+        return __awaiter(this, void 0, void 0, function* () {
+            // noop
+        });
+    }
+    append(key, value) {
+        this.fd.append(key, String(value));
+    }
+    appendFile(key, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (value == null) {
+                throw new Error(`File upload for "${key}" received ${value === null ? "null" : "undefined"}. The generated code should not call appendFile with null/undefined — check that optional file fields are guarded before this call.`);
+            }
+            const { data, filename, contentType } = yield toMultipartDataPart(value);
+            const blob = yield convertToBlob(data, contentType);
+            if (filename) {
+                this.fd.append(key, blob, filename);
+            }
+            else {
+                this.fd.append(key, blob);
+            }
+        });
+    }
+    getRequest() {
+        return {
+            body: this.fd,
+            headers: {},
+            duplex: "half",
+        };
+    }
+}
+function isStreamLike(value) {
+    return typeof value === "object" && value != null && ("read" in value || "pipe" in value);
+}
+function isReadableStream(value) {
+    return typeof value === "object" && value != null && "getReader" in value;
+}
+function isBuffer(value) {
+    return typeof Buffer !== "undefined" && Buffer.isBuffer && Buffer.isBuffer(value);
+}
+function isArrayBufferView(value) {
+    return ArrayBuffer.isView(value);
+}
+function streamToBuffer(stream) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, stream_1, stream_1_1;
+        var _b, e_1, _c, _d;
+        if (RUNTIME.type === "node") {
+            const { Readable } = yield import("stream");
+            if (stream instanceof Readable) {
+                const chunks = [];
+                try {
+                    for (_a = true, stream_1 = __asyncValues(stream); stream_1_1 = yield stream_1.next(), _b = stream_1_1.done, !_b; _a = true) {
+                        _d = stream_1_1.value;
+                        _a = false;
+                        const chunk = _d;
+                        chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
+                    }
+                }
+                catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                finally {
+                    try {
+                        if (!_a && !_b && (_c = stream_1.return)) yield _c.call(stream_1);
+                    }
+                    finally { if (e_1) throw e_1.error; }
+                }
+                return Buffer.concat(chunks);
+            }
+        }
+        if (isReadableStream(stream)) {
+            const reader = stream.getReader();
+            const chunks = [];
+            try {
+                while (true) {
+                    const { done, value } = yield reader.read();
+                    if (done)
+                        break;
+                    chunks.push(value);
+                }
+            }
+            finally {
+                reader.releaseLock();
+            }
+            const totalLength = chunks.reduce((sum, chunk) => sum + chunk.length, 0);
+            const result = new Uint8Array(totalLength);
+            let offset = 0;
+            for (const chunk of chunks) {
+                result.set(chunk, offset);
+                offset += chunk.length;
+            }
+            return Buffer.from(result);
+        }
+        throw new Error(`Unsupported stream type: ${typeof stream}. Expected Node.js Readable stream or Web ReadableStream.`);
+    });
+}
+function convertToBlob(value, contentType) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (isStreamLike(value) || isReadableStream(value)) {
+            const buffer = yield streamToBuffer(value);
+            return new Blob([buffer], { type: contentType });
+        }
+        if (value instanceof Blob) {
+            return value;
+        }
+        if (isBuffer(value)) {
+            return new Blob([value], { type: contentType });
+        }
+        if (value instanceof ArrayBuffer) {
+            return new Blob([value], { type: contentType });
+        }
+        if (isArrayBufferView(value)) {
+            return new Blob([value], { type: contentType });
+        }
+        if (typeof value === "string") {
+            return new Blob([value], { type: contentType });
+        }
+        if (typeof value === "object" && value !== null) {
+            return new Blob([toJson(value)], { type: contentType !== null && contentType !== void 0 ? contentType : "application/json" });
+        }
+        return new Blob([String(value)], { type: contentType });
+    });
+}

package/esm/core/form-data-utils/encodeAsFormParameter.d.mts

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

package/esm/core/form-data-utils/encodeAsFormParameter.mjs

@@ -0,0 +1,9 @@
+import { toQueryString } from "../url/qs.mjs";
+export function encodeAsFormParameter(value) {
+    const stringified = toQueryString(value, { encode: false });
+    const keyValuePairs = stringified.split("&").map((pair) => {
+        const [key, value] = pair.split("=");
+        return [key, value];
+    });
+    return Object.fromEntries(keyValuePairs);
+}

package/esm/core/form-data-utils/index.d.mts

@@ -0,0 +1,2 @@
+export { encodeAsFormParameter } from "./encodeAsFormParameter.mjs";
+export * from "./FormDataWrapper.mjs";

package/esm/core/form-data-utils/index.mjs

@@ -0,0 +1,2 @@
+export { encodeAsFormParameter } from "./encodeAsFormParameter.mjs";
+export * from "./FormDataWrapper.mjs";

package/esm/core/index.d.mts

@@ -1,6 +1,8 @@
 export * from "./auth/index.mjs";
 export * from "./base64.mjs";
 export * from "./fetcher/index.mjs";
+export * as file from "./file/index.mjs";
+export * from "./form-data-utils/index.mjs";
 export * as logging from "./logging/index.mjs";
 export * from "./runtime/index.mjs";
 export * as url from "./url/index.mjs";

package/esm/core/index.mjs

@@ -1,6 +1,8 @@
 export * from "./auth/index.mjs";
 export * from "./base64.mjs";
 export * from "./fetcher/index.mjs";
+export * as file from "./file/index.mjs";
+export * from "./form-data-utils/index.mjs";
 export * as logging from "./logging/index.mjs";
 export * from "./runtime/index.mjs";
 export * as url from "./url/index.mjs";

package/esm/core/requestBody.d.mts

@@ -0,0 +1,12 @@
+/**
+ * Spreads caller-supplied `additionalBodyParameters` (from `requestOptions.additionalBodyParameters`)
+ * on top of the request body. Caller-supplied properties win over the endpoint body. When no
+ * additional body parameters are provided, the original body is returned unchanged so serialization
+ * is unaffected.
+ *
+ * The merge only applies to plain-object (JSON object) bodies. When the body is `null`/`undefined`
+ * the additional parameters become the body; when the body is an array or a primitive JSON value it
+ * is returned unchanged, since object properties cannot be spread into it. This mirrors the Python
+ * SDK, which only merges additional body parameters into mapping bodies.
+ */
+export declare function mergeAdditionalBodyParameters(body: unknown, additionalBodyParameters: Record<string, unknown> | undefined): unknown;

package/esm/core/requestBody.mjs

@@ -0,0 +1,23 @@
+/**
+ * Spreads caller-supplied `additionalBodyParameters` (from `requestOptions.additionalBodyParameters`)
+ * on top of the request body. Caller-supplied properties win over the endpoint body. When no
+ * additional body parameters are provided, the original body is returned unchanged so serialization
+ * is unaffected.
+ *
+ * The merge only applies to plain-object (JSON object) bodies. When the body is `null`/`undefined`
+ * the additional parameters become the body; when the body is an array or a primitive JSON value it
+ * is returned unchanged, since object properties cannot be spread into it. This mirrors the Python
+ * SDK, which only merges additional body parameters into mapping bodies.
+ */
+export function mergeAdditionalBodyParameters(body, additionalBodyParameters) {
+    if (additionalBodyParameters == null) {
+        return body;
+    }
+    if (body == null) {
+        return Object.assign({}, additionalBodyParameters);
+    }
+    if (typeof body === "object" && !Array.isArray(body)) {
+        return Object.assign(Object.assign({}, body), additionalBodyParameters);
+    }
+    return body;
+}

package/esm/core/runtime/index.d.mts

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

package/esm/core/runtime/index.mjs

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

package/esm/core/runtime/runtime.d.mts

@@ -6,4 +6,23 @@ 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;