@compose-market/sdk 0.1.1 → 0.3.0

package/dist/resources/inference.d.ts

@@ -0,0 +1,175 @@
+import type { HttpClient } from "../http.js";
+import type { AudioSpeechCreateParams, AudioTranscriptionCreateParams, AudioTranscriptionResponse, ChatCompletion, ChatCompletionChunk, ChatCompletionsCreateParams, ComposeReceipt, EmbeddingsCreateParams, EmbeddingsResponse, ImagesGenerateParams, ImagesResponse, ResponseObject, ResponseStreamEvent, ResponsesCreateParams, SessionBudgetSnapshot, SessionInvalidReason, VideoGenerateParams, VideoJobStatus, VideoStatusStreamEvent } from "../types/index.js";
+import { type InferenceContext } from "./instrumentation.js";
+export type { InferenceContext } from "./instrumentation.js";
+export interface ComposeCallOptions {
+    signal?: AbortSignal;
+    timeoutMs?: number;
+    idempotencyKey?: string;
+    composeRunId?: string;
+    x402MaxAmountWei?: string;
+    paymentSignature?: string;
+    /** Override the Compose Key for this call. Passing `null` forces the raw x402 path. */
+    composeKey?: string | null;
+    /** Override the end-user wallet address for this call. */
+    userAddress?: string;
+    /** Override the chain id for this call. */
+    chainId?: number;
+}
+/**
+ * Typed wrapper returned by every billable, non-streaming inference call.
+ *
+ * `data`               — the parsed JSON body.
+ * `receipt`            — the settlement receipt decoded from `X-Compose-Receipt`
+ *                        (or mirrored from the `compose_receipt` body field).
+ * `requestId`          — the server-issued `X-Request-Id` for tracing.
+ * `response`           — the raw `Response` (still-readable if the caller asked
+ *                        for `.asResponse()` directly; consumed here).
+ * `budget`             — live `x-session-budget-*` snapshot parsed from
+ *                        response headers, or `null` if the endpoint did not
+ *                        emit budget headers.
+ * `sessionInvalidReason` — truthy `x-compose-session-invalid` value when the
+ *                        session must be torn down as a side effect of this
+ *                        call (budget depleted, revoked, etc).
+ */
+export interface ComposeCompletion<T> {
+    data: T;
+    receipt: ComposeReceipt | null;
+    requestId: string | null;
+    response: Response;
+    budget: SessionBudgetSnapshot | null;
+    sessionInvalidReason: SessionInvalidReason | null;
+}
+export interface ChatCompletionFinalResult {
+    chatCompletion: ChatCompletion;
+    receipt: ComposeReceipt | null;
+    requestId: string | null;
+    budget: SessionBudgetSnapshot | null;
+    sessionInvalidReason: SessionInvalidReason | null;
+}
+export interface ResponsesStreamFinalResult {
+    response: ResponseObject | null;
+    receipt: ComposeReceipt | null;
+    requestId: string | null;
+    budget: SessionBudgetSnapshot | null;
+    sessionInvalidReason: SessionInvalidReason | null;
+}
+/**
+ * Async iterable returned by `inference.chat.completions.stream(...)` and
+ * `inference.responses.stream(...)`. Exposes `.final()` for consumers that
+ * want the reassembled final object + receipt without iterating manually.
+ *
+ * `for await (const chunk of stream) { ... }` consumes chunks; the generator's
+ * return value is captured internally so a subsequent `await stream.final()`
+ * resolves to the typed final object even when the caller drove iteration.
+ */
+export declare class ComposeStreamIterator<Chunk, Final> implements AsyncIterable<Chunk> {
+    private readonly iterator;
+    private finalResult;
+    private finalSettled;
+    private finalPromise;
+    constructor(iterator: AsyncGenerator<Chunk, Final, void>);
+    [Symbol.asyncIterator](): AsyncIterator<Chunk, void, void>;
+    final(): Promise<Final>;
+}
+declare class ChatCompletionsNamespace {
+    private readonly client;
+    private readonly ctx;
+    constructor(client: HttpClient, ctx: InferenceContext);
+    create(params: ChatCompletionsCreateParams, options?: ComposeCallOptions): Promise<ComposeCompletion<ChatCompletion>>;
+    stream(params: ChatCompletionsCreateParams, options?: ComposeCallOptions): ComposeStreamIterator<ChatCompletionChunk, ChatCompletionFinalResult>;
+}
+declare class ResponsesNamespace {
+    private readonly client;
+    private readonly ctx;
+    constructor(client: HttpClient, ctx: InferenceContext);
+    create(params: ResponsesCreateParams, options?: ComposeCallOptions): Promise<ComposeCompletion<ResponseObject>>;
+    stream(params: ResponsesCreateParams, options?: ComposeCallOptions): ComposeStreamIterator<ResponseStreamEvent, ResponsesStreamFinalResult>;
+    get(responseId: string, options?: ComposeCallOptions): Promise<ResponseObject>;
+    inputItems(responseId: string, options?: ComposeCallOptions): Promise<{
+        object: "list";
+        data: Record<string, unknown>[];
+    }>;
+    cancel(responseId: string, options?: ComposeCallOptions): Promise<ResponseObject>;
+}
+declare class EmbeddingsNamespace {
+    private readonly client;
+    private readonly ctx;
+    constructor(client: HttpClient, ctx: InferenceContext);
+    create(params: EmbeddingsCreateParams, options?: ComposeCallOptions): Promise<ComposeCompletion<EmbeddingsResponse>>;
+}
+declare class ImagesNamespace {
+    private readonly client;
+    private readonly ctx;
+    constructor(client: HttpClient, ctx: InferenceContext);
+    generate(params: ImagesGenerateParams, options?: ComposeCallOptions): Promise<ComposeCompletion<ImagesResponse>>;
+    edit(params: ImagesGenerateParams & {
+        image?: string;
+    }, options?: ComposeCallOptions): Promise<ComposeCompletion<ImagesResponse>>;
+}
+declare class AudioNamespace {
+    private readonly client;
+    private readonly ctx;
+    constructor(client: HttpClient, ctx: InferenceContext);
+    /**
+     * Text-to-speech. Returns the raw audio `Response` (stream the body via
+     * `response.body` or `await response.arrayBuffer()`), plus any receipt
+     * extracted from response headers, plus the live budget snapshot.
+     */
+    speech(params: AudioSpeechCreateParams, options?: ComposeCallOptions): Promise<{
+        response: Response;
+        receipt: ComposeReceipt | null;
+        requestId: string | null;
+        budget: SessionBudgetSnapshot | null;
+        sessionInvalidReason: SessionInvalidReason | null;
+    }>;
+    /**
+     * Speech-to-text. Supports both multipart/form-data (preferred, OpenAI-
+     * compatible) when `file` is a `Blob`/`File`/`Uint8Array`, and base64-in-
+     * JSON (Compose legacy) when `file` is a string.
+     */
+    transcriptions(params: AudioTranscriptionCreateParams, options?: ComposeCallOptions): Promise<ComposeCompletion<AudioTranscriptionResponse>>;
+}
+declare class VideosNamespace {
+    private readonly client;
+    private readonly ctx;
+    constructor(client: HttpClient, ctx: InferenceContext);
+    generate(params: VideoGenerateParams, options?: ComposeCallOptions): Promise<ComposeCompletion<{
+        job_id?: string;
+        id?: string;
+    } & Record<string, unknown>>>;
+    get(videoId: string, options?: ComposeCallOptions): Promise<VideoJobStatus>;
+    /**
+     * Server-driven polling via SSE. Subscribes to `/v1/videos/:id/stream`
+     * and yields each status update as it arrives, terminating on the
+     * `completed` or `failed` state.
+     */
+    stream(videoId: string, opts?: ComposeCallOptions & {
+        pollIntervalMs?: number;
+        timeoutMs?: number;
+    }): ComposeStreamIterator<VideoStatusStreamEvent, {
+        final: VideoJobStatus | null;
+        requestId: string | null;
+    }>;
+    /**
+     * Convenience helper: resolves once the video job hits a terminal state,
+     * driven by the server-side SSE poller. Aborts after `timeoutMs` elapses.
+     */
+    waitUntilDone(videoId: string, opts?: ComposeCallOptions & {
+        pollIntervalMs?: number;
+        timeoutMs?: number;
+        onStatus?: (status: VideoStatusStreamEvent) => void;
+    }): Promise<VideoJobStatus | null>;
+}
+export declare class InferenceResource {
+    readonly chat: {
+        completions: ChatCompletionsNamespace;
+    };
+    readonly responses: ResponsesNamespace;
+    readonly embeddings: EmbeddingsNamespace;
+    readonly images: ImagesNamespace;
+    readonly audio: AudioNamespace;
+    readonly videos: VideosNamespace;
+    constructor(client: HttpClient, ctx: InferenceContext);
+}
+//# sourceMappingURL=inference.d.ts.map

package/dist/resources/inference.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inference.d.ts","sourceRoot":"","sources":["../../src/resources/inference.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,KAAK,EACR,uBAAuB,EACvB,8BAA8B,EAC9B,0BAA0B,EAC1B,cAAc,EACd,mBAAmB,EACnB,2BAA2B,EAC3B,cAAc,EACd,sBAAsB,EACtB,kBAAkB,EAClB,oBAAoB,EACpB,cAAc,EACd,cAAc,EACd,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,mBAAmB,EACnB,cAAc,EACd,sBAAsB,EACzB,MAAM,mBAAmB,CAAC;AAI3B,OAAO,EAEH,KAAK,gBAAgB,EACxB,MAAM,sBAAsB,CAAC;AAE9B,YAAY,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D,MAAM,WAAW,kBAAkB;IAC/B,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,uFAAuF;IACvF,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,0DAA0D;IAC1D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC;IAChC,IAAI,EAAE,CAAC,CAAC;IACR,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;IAC/B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,qBAAqB,GAAG,IAAI,CAAC;IACrC,oBAAoB,EAAE,oBAAoB,GAAG,IAAI,CAAC;CACrD;AAED,MAAM,WAAW,yBAAyB;IACtC,cAAc,EAAE,cAAc,CAAC;IAC/B,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;IAC/B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,MAAM,EAAE,qBAAqB,GAAG,IAAI,CAAC;IACrC,oBAAoB,EAAE,oBAAoB,GAAG,IAAI,CAAC;CACrD;AAED,MAAM,WAAW,0BAA0B;IACvC,QAAQ,EAAE,cAAc,GAAG,IAAI,CAAC;IAChC,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;IAC/B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,MAAM,EAAE,qBAAqB,GAAG,IAAI,CAAC;IACrC,oBAAoB,EAAE,oBAAoB,GAAG,IAAI,CAAC;CACrD;AA+FD;;;;;;;;GAQG;AACH,qBAAa,qBAAqB,CAAC,KAAK,EAAE,KAAK,CAAE,YAAW,aAAa,CAAC,KAAK,CAAC;IAC5E,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAqC;IAC9D,OAAO,CAAC,WAAW,CAAsB;IACzC,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,YAAY,CAA+B;gBAEvC,QAAQ,EAAE,cAAc,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC;IAIxD,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC;IAuBpD,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC;CAgBhC;AAMD,cAAM,wBAAwB;IAEtB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,GAAG;gBADH,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,gBAAgB;IAGpC,MAAM,CACR,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,kBAAkB,GAC7B,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAkB7C,MAAM,CACF,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,kBAAkB,GAC7B,qBAAqB,CAAC,mBAAmB,EAAE,yBAAyB,CAAC;CAI3E;AAsJD,cAAM,kBAAkB;IAEhB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,GAAG;gBADH,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,gBAAgB;IAGpC,MAAM,CACR,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,kBAAkB,GAC7B,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAiB7C,MAAM,CACF,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,kBAAkB,GAC7B,qBAAqB,CAAC,mBAAmB,EAAE,0BAA0B,CAAC;IAKnE,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,cAAc,CAAC;IAU9E,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAA;KAAE,CAAC;IAU1H,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,cAAc,CAAC;CAS1F;AAqGD,cAAM,mBAAmB;IAEjB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,GAAG;gBADH,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,gBAAgB;IAGpC,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;CAW7H;AAMD,cAAM,eAAe;IAEb,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,GAAG;gBADH,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,gBAAgB;IAGpC,QAAQ,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAYhH,IAAI,CAAC,MAAM,EAAE,oBAAoB,GAAG;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;CAW1I;AAMD,cAAM,cAAc;IAEZ,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,GAAG;gBADH,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,gBAAgB;IAG1C;;;;OAIG;IACG,MAAM,CAAC,MAAM,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC;QACjF,QAAQ,EAAE,QAAQ,CAAC;QACnB,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;QAC/B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,MAAM,EAAE,qBAAqB,GAAG,IAAI,CAAC;QACrC,oBAAoB,EAAE,oBAAoB,GAAG,IAAI,CAAC;KACrD,CAAC;IAsBF;;;;OAIG;IACG,cAAc,CAAC,MAAM,EAAE,8BAA8B,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,0BAA0B,CAAC,CAAC;CAiDrJ;AAMD,cAAM,eAAe;IAEb,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,GAAG;gBADH,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,gBAAgB;IAGpC,QAAQ,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,EAAE,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAYjK,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,cAAc,CAAC;IAU3E;;;;OAIG;IACH,MAAM,CACF,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,kBAAkB,GAAG;QAAE,cAAc,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GAChF,qBAAqB,CAAC,sBAAsB,EAAE;QAAE,KAAK,EAAE,cAAc,GAAG,IAAI,CAAC;QAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAK5G;;;OAGG;IACG,aAAa,CACf,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,kBAAkB,GAAG;QACvB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,sBAAsB,KAAK,IAAI,CAAC;KAClD,GACP,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;CAQpC;AA6ED,qBAAa,iBAAiB;IAC1B,QAAQ,CAAC,IAAI,EAAE;QAAE,WAAW,EAAE,wBAAwB,CAAA;KAAE,CAAC;IACzD,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC;IACvC,QAAQ,CAAC,UAAU,EAAE,mBAAmB,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;IACjC,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;gBAG7B,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,gBAAgB;CAS5B"}