@rebyteai/agent-sdk 0.2.0

package/internal/types.d.ts

@@ -0,0 +1,75 @@
+export type PromiseOrValue<T> = T | Promise<T>;
+export type HTTPMethod = 'get' | 'post' | 'put' | 'patch' | 'delete';
+export type KeysEnum<T> = {
+    [P in keyof Required<T>]: true;
+};
+export type FinalizedRequestInit = RequestInit & {
+    headers: Headers;
+};
+type NotAny<T> = [0] extends [1 & T] ? never : T;
+/**
+ * Some environments overload the global fetch function, and Parameters<T> only gets the last signature.
+ */
+type OverloadedParameters<T> = T extends {
+    (...args: infer A): unknown;
+    (...args: infer B): unknown;
+    (...args: infer C): unknown;
+    (...args: infer D): unknown;
+} ? A | B | C | D : T extends {
+    (...args: infer A): unknown;
+    (...args: infer B): unknown;
+    (...args: infer C): unknown;
+} ? A | B | C : T extends {
+    (...args: infer A): unknown;
+    (...args: infer B): unknown;
+} ? A | B : T extends (...args: infer A) => unknown ? A : never;
+/**
+ * These imports attempt to get types from a parent package's dependencies.
+ * Unresolved bare specifiers can trigger [automatic type acquisition][1] in some projects, which
+ * would cause typescript to show types not present at runtime. To avoid this, we import
+ * directly from parent node_modules folders.
+ *
+ * We need to check multiple levels because we don't know what directory structure we'll be in.
+ * For example, pnpm generates directories like this:
+ * ```
+ * node_modules
+ * ├── .pnpm
+ * │   └── pkg@1.0.0
+ * │       └── node_modules
+ * │           └── pkg
+ * │               └── internal
+ * │                   └── types.d.ts
+ * ├── pkg -> .pnpm/pkg@1.0.0/node_modules/pkg
+ * └── undici
+ * ```
+ *
+ * [1]: https://www.typescriptlang.org/tsconfig/#typeAcquisition
+ */
+// @ts-ignore For users with \@types/node
+type UndiciTypesRequestInit = NotAny<import('../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit>;
+// @ts-ignore For users with undici
+type UndiciRequestInit = NotAny<import('../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici/index.d.ts').RequestInit>;
+// @ts-ignore For users with \@types/bun
+type BunRequestInit = globalThis.FetchRequestInit;
+// @ts-ignore For users with node-fetch@2
+type NodeFetch2RequestInit = NotAny<import('../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit>;
+// @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts
+type NodeFetch3RequestInit = NotAny<import("../node_modules/node-fetch.js").RequestInit> | NotAny<import("../../node_modules/node-fetch.js").RequestInit> | NotAny<import("../../../node_modules/node-fetch.js").RequestInit> | NotAny<import("../../../../node_modules/node-fetch.js").RequestInit> | NotAny<import("../../../../../node_modules/node-fetch.js").RequestInit> | NotAny<import("../../../../../../node_modules/node-fetch.js").RequestInit> | NotAny<import("../../../../../../../node_modules/node-fetch.js").RequestInit> | NotAny<import("../../../../../../../../node_modules/node-fetch.js").RequestInit> | NotAny<import("../../../../../../../../../node_modules/node-fetch.js").RequestInit> | NotAny<import("../../../../../../../../../../node_modules/node-fetch.js").RequestInit>;
+// @ts-ignore For users who use Deno
+type FetchRequestInit = NonNullable<OverloadedParameters<typeof fetch>[1]>;
+type RequestInits = NotAny<UndiciTypesRequestInit> | NotAny<UndiciRequestInit> | NotAny<BunRequestInit> | NotAny<NodeFetch2RequestInit> | NotAny<NodeFetch3RequestInit> | NotAny<RequestInit> | NotAny<FetchRequestInit>;
+type RuntimeFetchOptions = {
+    dispatcher?: unknown;
+    agent?: unknown;
+    client?: unknown;
+    proxy?: unknown;
+};
+/**
+ * This type contains `RequestInit` options that may be available on the current runtime,
+ * including per-platform extensions like `dispatcher`, `agent`, `client`, etc.
+ */
+export type MergedRequestInit = RequestInits & RuntimeFetchOptions & 
+/** We don't include these in the types as they'll be overridden for every request. */
+Partial<Record<'body' | 'headers' | 'method' | 'signal', never>>;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/internal/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/internal/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAC/C,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAErE,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI;CAAE,CAAC;AAE7D,MAAM,MAAM,oBAAoB,GAAG,WAAW,GAAG;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC;AAEtE,KAAK,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;AAEjD;;GAEG;AACH,KAAK,oBAAoB,CAAC,CAAC,IAAI,CAAC,SAAS;IACvC,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC;IAC5B,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC;IAC5B,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC;IAC5B,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC;CAC7B,GACG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GACb,CAAC,SAAS;IACN,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC;IAC5B,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC;IAC5B,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC;CAC7B,GACD,CAAC,GAAG,CAAC,GAAG,CAAC,GACT,CAAC,SAAS;IACN,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC;IAC5B,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC;CAC7B,GACD,CAAC,GAAG,CAAC,GACL,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,OAAO,GACrC,CAAC,GACD,KAAK,CAAC;AAEhB;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,6CAA6C,CAC7C,KAAK,sBAAsB,GAAG,MAAM,CAAC,OAAO,yCAAyC,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,4CAA4C,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,+CAA+C,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,kDAAkD,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,qDAAqD,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,wDAAwD,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,2DAA2D,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,8DAA8D,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,iEAAiE,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,oEAAoE,EAAE,WAAW,CAAC,CAAC;AACn3B,uCAAuC,CACvC,KAAK,iBAAiB,GAAG,MAAM,CAAC,OAAO,mCAAmC,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,sCAAsC,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,yCAAyC,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,4CAA4C,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,+CAA+C,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,kDAAkD,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,qDAAqD,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,wDAAwD,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,2DAA2D,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,8DAA8D,EAAE,WAAW,CAAC,CAAC;AAClzB,4CAA4C,CAC5C,KAAK,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;AAClD,6CAA6C,CAC7C,KAAK,qBAAqB,GAAG,MAAM,CAAC,OAAO,8CAA8C,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,iDAAiD,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,oDAAoD,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,uDAAuD,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,0DAA0D,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,6DAA6D,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,gEAAgE,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,mEAAmE,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,sEAAsE,EAAE,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,yEAAyE,EAAE,WAAW,CAAC,CAAC;AACp6B,mHAAmH,CACnH,KAAK,qBAAqB,GAAI,MAAM,CAAC,wCAAqC,WAAW,CAAC,GAAG,MAAM,CAAC,2CAAwC,WAAW,CAAC,GAAG,MAAM,CAAC,8CAA2C,WAAW,CAAC,GAAG,MAAM,CAAC,iDAA8C,WAAW,CAAC,GAAG,MAAM,CAAC,oDAAiD,WAAW,CAAC,GAAG,MAAM,CAAC,uDAAoD,WAAW,CAAC,GAAG,MAAM,CAAC,0DAAuD,WAAW,CAAC,GAAG,MAAM,CAAC,6DAA0D,WAAW,CAAC,GAAG,MAAM,CAAC,gEAA6D,WAAW,CAAC,GAAG,MAAM,CAAC,mEAAgE,WAAW,CAAC,CAAC;AACjvB,wCAAwC,CACxC,KAAK,gBAAgB,GAAG,WAAW,CAAC,oBAAoB,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE3E,KAAK,YAAY,GACb,MAAM,CAAC,sBAAsB,CAAC,GAC9B,MAAM,CAAC,iBAAiB,CAAC,GACzB,MAAM,CAAC,cAAc,CAAC,GACtB,MAAM,CAAC,qBAAqB,CAAC,GAC7B,MAAM,CAAC,qBAAqB,CAAC,GAC7B,MAAM,CAAC,WAAW,CAAC,GACnB,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAE7B,KAAK,mBAAmB,GAAG;IACzB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,YAAY,GAC1C,mBAAmB;AACnB,sFAAsF;AACtF,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC"}

package/internal/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/internal/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/internal/types.ts"],"names":[],"mappings":""}

package/internal/types.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.mjs.map

package/internal/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/internal/types.ts"],"names":[],"mappings":""}

package/internal/uploads.d.mts

@@ -0,0 +1,139 @@
+import type { RequestOptions } from "./request-options.mjs";
+import type { FilePropertyBag, Fetch } from "./builtin-types.mjs";
+import type { OpenAI } from "../client.mjs";
+import type { ReadableStream } from "./shim-types.mjs";
+/** Text, binary data, or a blob that can contribute bytes to an uploaded file. */
+export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | DataView;
+/** Node.js-compatible byte stream carrying the source path used to infer a filename. */
+type FsReadStream = AsyncIterable<Uint8Array> & {
+    /** Source filesystem path, represented as a string or path-like object. */
+    path: string | {
+        /** Converts the path-like value into its filesystem path. */
+        toString(): string;
+    };
+};
+/** Asynchronous chunks consumed lazily while encoding a streaming multipart upload. */
+export type StreamingFileInput = AsyncIterable<BlobPart> | ReadableStream<BlobPart>;
+declare const brand_privateStreamingFile: unique symbol;
+/**
+ * A file whose contents are read lazily while the multipart request is sent.
+ * Create one with {@link toStreamingFile} when buffering an upload into a `File` is undesirable.
+ */
+export interface StreamingFile {
+    /** Ensures streaming files are created with a filename through {@link toStreamingFile}. */
+    readonly [brand_privateStreamingFile]: true;
+    /** Source chunks read incrementally as the multipart request body is transmitted. */
+    readonly data: StreamingFileInput;
+    /**
+     * Logical source filename; ordinary uploads send its basename, while Skills can preserve
+     * a validated relative directory path.
+     */
+    readonly name: string;
+    /** Optional MIME type; defaults to `application/octet-stream` when omitted. */
+    readonly type?: string | undefined;
+}
+/**
+ * Wrap a stream as an uploadable file without reading it into memory.
+ *
+ * Unlike {@link toFile}, this helper does not create a web `File`, because the `File` constructor
+ * must consume all of its contents up front. The stream is instead encoded lazily as multipart
+ * form data when the request is sent.
+ *
+ * @param data Async-iterable or readable-stream chunks containing text, binary data, or blobs.
+ * @param name Non-empty logical/source filename. Ordinary uploads send only its basename; Skills
+ * uploads may preserve a validated relative path with normalized forward slashes.
+ * @param options Optional MIME type for the streaming file.
+ * @throws {TypeError} If `name` is empty or the content type contains control characters.
+ */
+export declare function toStreamingFile(data: StreamingFileInput, name: string, options?: Pick<FilePropertyBag, 'type'>): StreamingFile;
+/**
+ * Bun file compatibility shape for file objects whose names are optional in their types.
+ *
+ * @see https://github.com/oven-sh/bun/issues/5980
+ */
+interface BunFile extends Blob {
+    /** Filename exposed by Bun when one is available. */
+    readonly name?: string | undefined;
+}
+/** Blob-compatible upload value that exposes a filename at runtime. */
+type NamedBlob = Blob & {
+    /** Filename supplied by a native `File` or another named Blob implementation. */
+    readonly name?: string | undefined;
+};
+/**
+ * Verifies that the current runtime exposes the global `File` constructor.
+ *
+ * @throws {Error} If `File` is unavailable; older Node.js runtimes receive an
+ * additional upgrade or `node:buffer` compatibility suggestion.
+ */
+export declare const checkFileSupport: () => void;
+/**
+ * Values accepted by SDK methods that upload multipart files.
+ *
+ * Supports native files, fetch responses, blobs, Node.js filesystem read
+ * streams, async byte sources, web readable streams, and files created with
+ * {@link toStreamingFile}. Use {@link toFile} to materialize compatible content
+ * as a native `File` when buffering the complete upload is acceptable.
+ */
+export type Uploadable = File | Response | FsReadStream | BunFile | NamedBlob | AsyncIterable<BlobPart> | ReadableStream<BlobPart> | StreamingFile;
+/**
+ * Construct a `File` instance. This is used to ensure a helpful error is thrown
+ * for environments that don't define a global `File` yet.
+ *
+ * A missing filename becomes `unknown_file`.
+ */
+export declare function makeFile(fileBits: BlobPart[], fileName: string | undefined, options?: FilePropertyBag): File;
+/**
+ * Infers a filename from an object's `name`, `url`, `filename`, or `path` value.
+ *
+ * Directory components separated by either `/` or `\\` are discarded unless an
+ * explicitly supplied `name` or `filename` opts into preserving its path. Preserved
+ * paths must be safe and relative, and use forward slashes. Paths inferred from URLs and filesystem streams
+ * discard their directories.
+ */
+export declare function getName(value: any, options?: {
+    stripFilename?: boolean | undefined;
+}): string | undefined;
+/** Recognizes native ArrayBuffers across realms without trusting their prototype or string tag. */
+export declare function isArrayBuffer(value: unknown): value is ArrayBuffer;
+/** Identifies objects that expose a callable `Symbol.asyncIterator` method. */
+export declare const isAsyncIterable: (value: any) => value is AsyncIterable<any>;
+/**
+ * Converts a request to multipart form data when its body contains an upload.
+ *
+ * Uploads include files, blobs, responses, async iterables, readable
+ * streams, and {@link StreamingFile} values anywhere in a nested body. Bodies
+ * containing streaming values are encoded lazily; other uploads use `FormData`.
+ * Requests without uploads are returned unchanged.
+ */
+export declare const maybeMultipartFormRequestOptions: (opts: RequestOptions, fetch: OpenAI | Fetch, formOptions?: CreateFormOptions) => Promise<RequestOptions>;
+/** Request options whose body must be encoded as multipart form data. */
+type MultipartFormRequestOptions = Omit<RequestOptions, 'body'> & {
+    /** Nested fields and upload values to encode into the multipart request body. */
+    body: unknown;
+};
+/**
+ * Encodes a request body as multipart form data even when no file is present.
+ *
+ * Streaming uploads produce a lazy multipart `ReadableStream` and an explicit
+ * boundary header; other values are materialized into platform `FormData`.
+ */
+export declare const multipartFormRequestOptions: (opts: MultipartFormRequestOptions, fetch: OpenAI | Fetch, formOptions?: CreateFormOptions) => Promise<RequestOptions>;
+/** Controls whether explicitly supplied multipart filenames retain directory components. */
+export type CreateFormOptions = {
+    /** Keep directories in explicit filenames when false; inferred paths remain basename-only. */
+    stripFilenames?: boolean;
+};
+/**
+ * Materializes an object into platform `FormData` after verifying fetch support.
+ *
+ * Strings, numbers, and booleans become text fields; responses, blobs,
+ * and async byte sources become file fields. Arrays and nested objects use
+ * bracketed field names, while `undefined` values are omitted.
+ *
+ * @throws {TypeError} If the fetch implementation cannot encode global
+ * `FormData`, a field is `null`, or a field has an unsupported value.
+ */
+export declare const createForm: <T = Record<string, unknown>>(body: T | undefined, fetch: OpenAI | Fetch, options?: CreateFormOptions) => Promise<FormData>;
+export {};
+//# sourceMappingURL=uploads.d.mts.map

package/internal/uploads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["../src/internal/uploads.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA0B;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,4BAAwB;AAC9D,OAAO,KAAK,EAAE,MAAM,EAAE,sBAAkB;AAGxC,OAAO,KAAK,EAAE,cAAc,EAAE,yBAAqB;AAGnD,kFAAkF;AAClF,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,eAAe,GAAG,IAAI,GAAG,QAAQ,CAAC;AAEhF,wFAAwF;AACxF,KAAK,YAAY,GAAG,aAAa,CAAC,UAAU,CAAC,GAAG;IAC9C,2EAA2E;IAC3E,IAAI,EACA,MAAM,GACN;QACE,6DAA6D;QAC7D,QAAQ,IAAI,MAAM,CAAC;KACpB,CAAC;CACP,CAAC;AAEF,uFAAuF;AACvF,MAAM,MAAM,kBAAkB,GAAG,aAAa,CAAC,QAAQ,CAAC,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;AAEpF,QAAA,MAAM,0BAA0B,eAAuD,CAAC;AAExF;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,2FAA2F;IAC3F,QAAQ,CAAC,CAAC,0BAA0B,CAAC,EAAE,IAAI,CAAC;IAE5C,qFAAqF;IACrF,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAElC;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,+EAA+E;IAC/E,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,kBAAkB,EACxB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,GACtC,aAAa,CAgBf;AAED;;;;GAIG;AACH,UAAU,OAAQ,SAAQ,IAAI;IAC5B,qDAAqD;IACrD,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC;AAED,uEAAuE;AACvE,KAAK,SAAS,GAAG,IAAI,GAAG;IACtB,iFAAiF;IACjF,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,YAa5B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,UAAU,GAClB,IAAI,GACJ,QAAQ,GACR,YAAY,GACZ,OAAO,GACP,SAAS,GACT,aAAa,CAAC,QAAQ,CAAC,GACvB,cAAc,CAAC,QAAQ,CAAC,GACxB,aAAa,CAAC;AAElB;;;;;GAKG;AACH,wBAAgB,QAAQ,CACtB,QAAQ,EAAE,QAAQ,EAAE,EACpB,QAAQ,EAAE,MAAM,GAAG,SAAS,EAC5B,OAAO,CAAC,EAAE,eAAe,GACxB,IAAI,CAGN;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE;IAAE,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAAE,GAAG,MAAM,GAAG,SAAS,CAuBzG;AAgBD,mGAAmG;AACnG,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAMlE;AAED,+EAA+E;AAC/E,eAAO,MAAM,eAAe,GAAI,OAAO,GAAG,KAAG,KAAK,IAAI,aAAa,CAAC,GAAG,CAC0B,CAAC;AAElG;;;;;;;GAOG;AACH,eAAO,MAAM,gCAAgC,GAC3C,MAAM,cAAc,EACpB,OAAO,MAAM,GAAG,KAAK,EACrB,cAAc,iBAAiB,KAC9B,OAAO,CAAC,cAAc,CAUxB,CAAC;AAEF,yEAAyE;AACzE,KAAK,2BAA2B,GAAG,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,GAAG;IAChE,iFAAiF;IACjF,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,2BAA2B,GACtC,MAAM,2BAA2B,EACjC,OAAO,MAAM,GAAG,KAAK,EACrB,cAAc,iBAAiB,KAC9B,OAAO,CAAC,cAAc,CAMxB,CAAC;AAwCF,4FAA4F;AAC5F,MAAM,MAAM,iBAAiB,GAAG;IAC9B,8FAA8F;IAC9F,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,GAAU,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1D,MAAM,CAAC,GAAG,SAAS,EACnB,OAAO,MAAM,GAAG,KAAK,EACrB,UAAS,iBAAsB,KAC9B,OAAO,CAAC,QAAQ,CAWlB,CAAC"}

package/internal/uploads.d.ts

@@ -0,0 +1,139 @@
+import type { RequestOptions } from "./request-options.js";
+import type { FilePropertyBag, Fetch } from "./builtin-types.js";
+import type { OpenAI } from "../client.js";
+import type { ReadableStream } from "./shim-types.js";
+/** Text, binary data, or a blob that can contribute bytes to an uploaded file. */
+export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | DataView;
+/** Node.js-compatible byte stream carrying the source path used to infer a filename. */
+type FsReadStream = AsyncIterable<Uint8Array> & {
+    /** Source filesystem path, represented as a string or path-like object. */
+    path: string | {
+        /** Converts the path-like value into its filesystem path. */
+        toString(): string;
+    };
+};
+/** Asynchronous chunks consumed lazily while encoding a streaming multipart upload. */
+export type StreamingFileInput = AsyncIterable<BlobPart> | ReadableStream<BlobPart>;
+declare const brand_privateStreamingFile: unique symbol;
+/**
+ * A file whose contents are read lazily while the multipart request is sent.
+ * Create one with {@link toStreamingFile} when buffering an upload into a `File` is undesirable.
+ */
+export interface StreamingFile {
+    /** Ensures streaming files are created with a filename through {@link toStreamingFile}. */
+    readonly [brand_privateStreamingFile]: true;
+    /** Source chunks read incrementally as the multipart request body is transmitted. */
+    readonly data: StreamingFileInput;
+    /**
+     * Logical source filename; ordinary uploads send its basename, while Skills can preserve
+     * a validated relative directory path.
+     */
+    readonly name: string;
+    /** Optional MIME type; defaults to `application/octet-stream` when omitted. */
+    readonly type?: string | undefined;
+}
+/**
+ * Wrap a stream as an uploadable file without reading it into memory.
+ *
+ * Unlike {@link toFile}, this helper does not create a web `File`, because the `File` constructor
+ * must consume all of its contents up front. The stream is instead encoded lazily as multipart
+ * form data when the request is sent.
+ *
+ * @param data Async-iterable or readable-stream chunks containing text, binary data, or blobs.
+ * @param name Non-empty logical/source filename. Ordinary uploads send only its basename; Skills
+ * uploads may preserve a validated relative path with normalized forward slashes.
+ * @param options Optional MIME type for the streaming file.
+ * @throws {TypeError} If `name` is empty or the content type contains control characters.
+ */
+export declare function toStreamingFile(data: StreamingFileInput, name: string, options?: Pick<FilePropertyBag, 'type'>): StreamingFile;
+/**
+ * Bun file compatibility shape for file objects whose names are optional in their types.
+ *
+ * @see https://github.com/oven-sh/bun/issues/5980
+ */
+interface BunFile extends Blob {
+    /** Filename exposed by Bun when one is available. */
+    readonly name?: string | undefined;
+}
+/** Blob-compatible upload value that exposes a filename at runtime. */
+type NamedBlob = Blob & {
+    /** Filename supplied by a native `File` or another named Blob implementation. */
+    readonly name?: string | undefined;
+};
+/**
+ * Verifies that the current runtime exposes the global `File` constructor.
+ *
+ * @throws {Error} If `File` is unavailable; older Node.js runtimes receive an
+ * additional upgrade or `node:buffer` compatibility suggestion.
+ */
+export declare const checkFileSupport: () => void;
+/**
+ * Values accepted by SDK methods that upload multipart files.
+ *
+ * Supports native files, fetch responses, blobs, Node.js filesystem read
+ * streams, async byte sources, web readable streams, and files created with
+ * {@link toStreamingFile}. Use {@link toFile} to materialize compatible content
+ * as a native `File` when buffering the complete upload is acceptable.
+ */
+export type Uploadable = File | Response | FsReadStream | BunFile | NamedBlob | AsyncIterable<BlobPart> | ReadableStream<BlobPart> | StreamingFile;
+/**
+ * Construct a `File` instance. This is used to ensure a helpful error is thrown
+ * for environments that don't define a global `File` yet.
+ *
+ * A missing filename becomes `unknown_file`.
+ */
+export declare function makeFile(fileBits: BlobPart[], fileName: string | undefined, options?: FilePropertyBag): File;
+/**
+ * Infers a filename from an object's `name`, `url`, `filename`, or `path` value.
+ *
+ * Directory components separated by either `/` or `\\` are discarded unless an
+ * explicitly supplied `name` or `filename` opts into preserving its path. Preserved
+ * paths must be safe and relative, and use forward slashes. Paths inferred from URLs and filesystem streams
+ * discard their directories.
+ */
+export declare function getName(value: any, options?: {
+    stripFilename?: boolean | undefined;
+}): string | undefined;
+/** Recognizes native ArrayBuffers across realms without trusting their prototype or string tag. */
+export declare function isArrayBuffer(value: unknown): value is ArrayBuffer;
+/** Identifies objects that expose a callable `Symbol.asyncIterator` method. */
+export declare const isAsyncIterable: (value: any) => value is AsyncIterable<any>;
+/**
+ * Converts a request to multipart form data when its body contains an upload.
+ *
+ * Uploads include files, blobs, responses, async iterables, readable
+ * streams, and {@link StreamingFile} values anywhere in a nested body. Bodies
+ * containing streaming values are encoded lazily; other uploads use `FormData`.
+ * Requests without uploads are returned unchanged.
+ */
+export declare const maybeMultipartFormRequestOptions: (opts: RequestOptions, fetch: OpenAI | Fetch, formOptions?: CreateFormOptions) => Promise<RequestOptions>;
+/** Request options whose body must be encoded as multipart form data. */
+type MultipartFormRequestOptions = Omit<RequestOptions, 'body'> & {
+    /** Nested fields and upload values to encode into the multipart request body. */
+    body: unknown;
+};
+/**
+ * Encodes a request body as multipart form data even when no file is present.
+ *
+ * Streaming uploads produce a lazy multipart `ReadableStream` and an explicit
+ * boundary header; other values are materialized into platform `FormData`.
+ */
+export declare const multipartFormRequestOptions: (opts: MultipartFormRequestOptions, fetch: OpenAI | Fetch, formOptions?: CreateFormOptions) => Promise<RequestOptions>;
+/** Controls whether explicitly supplied multipart filenames retain directory components. */
+export type CreateFormOptions = {
+    /** Keep directories in explicit filenames when false; inferred paths remain basename-only. */
+    stripFilenames?: boolean;
+};
+/**
+ * Materializes an object into platform `FormData` after verifying fetch support.
+ *
+ * Strings, numbers, and booleans become text fields; responses, blobs,
+ * and async byte sources become file fields. Arrays and nested objects use
+ * bracketed field names, while `undefined` values are omitted.
+ *
+ * @throws {TypeError} If the fetch implementation cannot encode global
+ * `FormData`, a field is `null`, or a field has an unsupported value.
+ */
+export declare const createForm: <T = Record<string, unknown>>(body: T | undefined, fetch: OpenAI | Fetch, options?: CreateFormOptions) => Promise<FormData>;
+export {};
+//# sourceMappingURL=uploads.d.ts.map

package/internal/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["../src/internal/uploads.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,6BAA0B;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,2BAAwB;AAC9D,OAAO,KAAK,EAAE,MAAM,EAAE,qBAAkB;AAGxC,OAAO,KAAK,EAAE,cAAc,EAAE,wBAAqB;AAGnD,kFAAkF;AAClF,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,eAAe,GAAG,IAAI,GAAG,QAAQ,CAAC;AAEhF,wFAAwF;AACxF,KAAK,YAAY,GAAG,aAAa,CAAC,UAAU,CAAC,GAAG;IAC9C,2EAA2E;IAC3E,IAAI,EACA,MAAM,GACN;QACE,6DAA6D;QAC7D,QAAQ,IAAI,MAAM,CAAC;KACpB,CAAC;CACP,CAAC;AAEF,uFAAuF;AACvF,MAAM,MAAM,kBAAkB,GAAG,aAAa,CAAC,QAAQ,CAAC,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;AAEpF,QAAA,MAAM,0BAA0B,eAAuD,CAAC;AAExF;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,2FAA2F;IAC3F,QAAQ,CAAC,CAAC,0BAA0B,CAAC,EAAE,IAAI,CAAC;IAE5C,qFAAqF;IACrF,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAElC;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,+EAA+E;IAC/E,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,kBAAkB,EACxB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,GACtC,aAAa,CAgBf;AAED;;;;GAIG;AACH,UAAU,OAAQ,SAAQ,IAAI;IAC5B,qDAAqD;IACrD,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC;AAED,uEAAuE;AACvE,KAAK,SAAS,GAAG,IAAI,GAAG;IACtB,iFAAiF;IACjF,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,YAa5B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,UAAU,GAClB,IAAI,GACJ,QAAQ,GACR,YAAY,GACZ,OAAO,GACP,SAAS,GACT,aAAa,CAAC,QAAQ,CAAC,GACvB,cAAc,CAAC,QAAQ,CAAC,GACxB,aAAa,CAAC;AAElB;;;;;GAKG;AACH,wBAAgB,QAAQ,CACtB,QAAQ,EAAE,QAAQ,EAAE,EACpB,QAAQ,EAAE,MAAM,GAAG,SAAS,EAC5B,OAAO,CAAC,EAAE,eAAe,GACxB,IAAI,CAGN;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE;IAAE,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAAE,GAAG,MAAM,GAAG,SAAS,CAuBzG;AAgBD,mGAAmG;AACnG,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAMlE;AAED,+EAA+E;AAC/E,eAAO,MAAM,eAAe,GAAI,OAAO,GAAG,KAAG,KAAK,IAAI,aAAa,CAAC,GAAG,CAC0B,CAAC;AAElG;;;;;;;GAOG;AACH,eAAO,MAAM,gCAAgC,GAC3C,MAAM,cAAc,EACpB,OAAO,MAAM,GAAG,KAAK,EACrB,cAAc,iBAAiB,KAC9B,OAAO,CAAC,cAAc,CAUxB,CAAC;AAEF,yEAAyE;AACzE,KAAK,2BAA2B,GAAG,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,GAAG;IAChE,iFAAiF;IACjF,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,2BAA2B,GACtC,MAAM,2BAA2B,EACjC,OAAO,MAAM,GAAG,KAAK,EACrB,cAAc,iBAAiB,KAC9B,OAAO,CAAC,cAAc,CAMxB,CAAC;AAwCF,4FAA4F;AAC5F,MAAM,MAAM,iBAAiB,GAAG;IAC9B,8FAA8F;IAC9F,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,GAAU,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1D,MAAM,CAAC,GAAG,SAAS,EACnB,OAAO,MAAM,GAAG,KAAK,EACrB,UAAS,iBAAsB,KAC9B,OAAO,CAAC,QAAQ,CAWlB,CAAC"}