@itsoltech/basal-client 0.3.0 → 0.4.0

package/README.md

@@ -1,6 +1,6 @@
 # @itsoltech/basal-client
 
-TypeScript/JavaScript SDK for the native Basal API (`POST /v1/basal`). ESM and CommonJS, with type declarations.
+TypeScript/JavaScript SDK for the native Basal API (`POST /v1/basal`) and the Batch API. ESM and CommonJS, with type declarations.
 Node.js 22+ or modern browsers with `fetch` and `AbortController`. No runtime dependencies or GPU requirement.
 
 This package is versioned independently. Release tag: `sdk-typescript-vX.Y.Z`.
@@ -75,6 +75,60 @@ validated before the promise resolves. Typed evidence defaults to an empty array
 retains the native JSON without those defaults. The one-argument raw `decide(request, signal)` remains available.
 
 
+## Batch API
+
+Requires a Basal server with the Batch API enabled ([docs/BATCHES.md](https://github.com/itsoltech/basal-rs/blob/main/docs/BATCHES.md)).
+Every Batch and Files route needs `apiKey` set to a batch token `<key_id>.<secret>`, also on loopback; the owner
+of every file and batch comes from that token. Records are native `/v1/basal` requests; the SDK only transfers files and controls batches. It never polls:
+call `getBatch` at an interval your application chooses and stop on `completed`, `failed`, `expired` or `cancelled`.
+
+```typescript
+import { BasalClient, batchInput, buildRequest, choice, parseBatchResults } from "@itsoltech/basal-client";
+
+const client = new BasalClient({ baseUrl: "https://basal.example.com", apiKey: "<key_id>.<secret>" });
+const body = buildRequest("Klient prosi o zwrot.", { department: choice("Dział?", { returns: "Zwroty", support: "Wsparcie" }) }, {});
+const file = await client.uploadFile({ file: batchInput([{ custom_id: "ticket-1", body }]), filename: "tickets.jsonl" });
+const batch = await client.createBatch({ input_file_id: file.id, metadata: { source: "tickets" } }, { idempotencyKey: "tickets-2026-10-20" });
+// Later:
+const current = await client.getBatch(batch.id);
+if (current.status === "completed" && current.output_file_id) {
+  const lines = parseBatchResults(await client.downloadFile(current.output_file_id, { maxBytes: 256 * 1024 * 1024 }));
+}
+```
+
+| Method | Route |
+|---|---|
+| `uploadFile({file, filename, expires_after?}, {signal?, timeoutMs?})` | `POST /v1/files` |
+| `listFiles({after?, limit?, purpose?, signal?})`, `getFile(id)`, `deleteFile(id)` | `/v1/files[/{id}]` |
+| `downloadFile(id, {signal?, timeoutMs?, maxBytes?})` → `Uint8Array` | `GET /v1/files/{id}/content` |
+| `createBatch({input_file_id, metadata?, output_expires_after?}, {idempotencyKey?, signal?})` | `POST /v1/batches` |
+| `listBatches({after?, limit?, signal?})`, `getBatch(id)`, `cancelBatch(id)` | `/v1/batches[/{id}[/cancel]]` |
+
+Uploads accept `Uint8Array`, `ArrayBuffer`, `Blob` (a browser `File`, or Node's `fs.openAsBlob`) or a
+`ReadableStream<Uint8Array>`. They never fetch URLs or read paths. The form sends `expires_after[...]`
+and `purpose=batch` before the file part, as the server requires. Bytes and Blobs are sent with a
+Content-Length; a stream is sent chunked and needs streaming request bodies (`duplex: "half"`): Node.js,
+or Chromium over HTTP/2. Otherwise pass a Blob. The SDK takes ownership of a stream: it is
+consumed and cancelled on abort, timeout or an early server answer (e.g. 413). The filename (1–255 UTF-8 bytes)
+must not contain control characters or backslashes; it is stored by the server as given.
+
+`downloadFile` returns the raw bytes and never parses JSON. It buffers the body in memory and is bounded by
+`maxResponseBytes` (8 MiB by default). For larger result files, raise `maxBytes` for that call, and
+`timeoutMs` if needed, instead of raising the client-wide limit. `parseBatchResults` turns the bytes into result lines; their
+`response.body` is the native answer (`DecisionResponse` for status 200, the native error body otherwise).
+
+`createBatch` fills `endpoint: "/v1/basal"` and `completion_window: "24h"` (the only accepted values).
+`metadata` keeps insertion order, except integer-like keys, which JavaScript enumerates first.
+`idempotencyKey` (1–128 visible ASCII characters) makes a retried create return the same batch while its
+metadata is retained. The SDK does not retry on its own. Resource ids and cursors are URL-encoded;
+the server answers malformed ids like missing resources (404). `cancelBatch` returns the batch in
+`cancelling`; cancellation ends asynchronously.
+
+Errors use the same classes as the online API: `BasalHTTPError` with the
+`{"error": {message, type, param, code}}` body and `retryAfter` (429/503), and
+`BasalResponseTooLargeError` above the byte cap. Resource types preserve unknown fields at runtime, and
+status/code enumerations accept future string values.
+
 [Full documentation and publication setup](https://github.com/itsoltech/basal-rs/blob/main/docs/SDK.md).
 
 

package/dist/cjs/batches.cjs

@@ -0,0 +1,191 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resourcePath = resourcePath;
+exports.listPath = listPath;
+exports.idempotencyHeader = idempotencyHeader;
+exports.createBody = createBody;
+exports.uploadForm = uploadForm;
+exports.batchInput = batchInput;
+exports.parseBatchResults = parseBatchResults;
+const errors_cjs_1 = require("./errors.cjs");
+const encoder = new TextEncoder();
+/** Path segment of a resource id. `.` and `..` would be resolved as dot segments by URL parsing. */
+function resourcePath(prefix, id, suffix = "") {
+    if (typeof id !== "string" || !id || id === "." || id === "..")
+        throw new TypeError("resource id must be a nonempty string");
+    return `${prefix}/${encodeURIComponent(id)}${suffix}`;
+}
+function listPath(path, options) {
+    const query = new URLSearchParams();
+    if (options.after !== undefined) {
+        if (typeof options.after !== "string" || !options.after)
+            throw new TypeError("after must be a nonempty id");
+        query.set("after", options.after);
+    }
+    if (options.limit !== undefined) {
+        if (!Number.isSafeInteger(options.limit) || options.limit < 1)
+            throw new TypeError("limit must be a positive integer");
+        query.set("limit", String(options.limit));
+    }
+    if (options.purpose !== undefined) {
+        if (typeof options.purpose !== "string" || !options.purpose)
+            throw new TypeError("purpose must be a nonempty string");
+        query.set("purpose", options.purpose);
+    }
+    const encoded = query.toString();
+    return encoded ? `${path}?${encoded}` : path;
+}
+function idempotencyHeader(key) {
+    if (key === undefined)
+        return {};
+    if (typeof key !== "string" || !/^[!-~]{1,128}$/.test(key)) {
+        throw new TypeError("idempotencyKey must have 1-128 visible ASCII characters");
+    }
+    return { "Idempotency-Key": key };
+}
+function createBody(request) {
+    if (!request || typeof request !== "object" || typeof request.input_file_id !== "string" || !request.input_file_id) {
+        throw new TypeError("input_file_id must be a nonempty string");
+    }
+    // Extra caller fields are forwarded; the server refuses fields it does not know.
+    return { endpoint: "/v1/basal", completion_window: "24h", ...request };
+}
+function expiresFields(expires) {
+    if (expires === undefined)
+        return [];
+    if (!expires || expires.anchor !== "created_at" || !Number.isSafeInteger(expires.seconds) || expires.seconds < 0) {
+        throw new TypeError("expires_after needs anchor created_at and whole seconds");
+    }
+    return [["expires_after[anchor]", expires.anchor], ["expires_after[seconds]", String(expires.seconds)]];
+}
+/** Multipart form of an upload: `expires_after[...]`, then `purpose`, then the file part last (the server reserves the
+ * upload session at the file part, so expiry fields must precede it).
+ */
+function uploadForm(request) {
+    if (!request || typeof request !== "object")
+        throw new TypeError("upload request must be an object");
+    const { file, filename } = request;
+    if (request.purpose !== undefined && request.purpose !== "batch")
+        throw new TypeError("purpose must be batch");
+    // Control characters (CR/LF) would split the part header; a backslash is ambiguous in a quoted filename.
+    if (typeof filename !== "string" || !filename || encoder.encode(filename).length > 255 || /[\p{Cc}\\]/u.test(filename)) {
+        throw new TypeError("filename must have 1-255 UTF-8 bytes without control characters or backslashes");
+    }
+    const random = new Uint8Array(16);
+    globalThis.crypto.getRandomValues(random);
+    const boundary = `basal-${Array.from(random, b => b.toString(16).padStart(2, "0")).join("")}`;
+    let head = "";
+    for (const [name, value] of [...expiresFields(request.expires_after), ["purpose", "batch"]]) {
+        head += `--${boundary}\r\nContent-Disposition: form-data; name="${name}"\r\n\r\n${value}\r\n`;
+    }
+    head += `--${boundary}\r\nContent-Disposition: form-data; name="file"; filename="${filename.replaceAll('"', '\\"')}"\r\n`
+        + "Content-Type: application/jsonl\r\n\r\n";
+    const prefix = encoder.encode(head);
+    const suffix = encoder.encode(`\r\n--${boundary}--\r\n`);
+    const contentType = `multipart/form-data; boundary=${boundary}`;
+    if (file instanceof ReadableStream) {
+        if (file.locked)
+            throw new TypeError("upload stream is locked");
+        return { contentType, body: signal => framedStream(prefix, file, suffix, signal) };
+    }
+    let content;
+    if (file instanceof Blob || file instanceof ArrayBuffer)
+        content = file;
+    else if (file instanceof Uint8Array)
+        content = file.buffer instanceof ArrayBuffer ? file : new Uint8Array(file);
+    else
+        throw new TypeError("file must be a Uint8Array, ArrayBuffer, Blob or ReadableStream");
+    return { contentType, body: new Blob([prefix, content, suffix]) };
+}
+/** Streams the multipart prefix, the caller's chunks and the suffix without buffering the file.
+ * Fetch implementations may keep pulling a request body after abort, so `signal` cancels the source here.
+ */
+function framedStream(prefix, source, suffix, signal) {
+    let reader;
+    let stage = "prefix";
+    const stop = (reason) => {
+        signal.removeEventListener("abort", onAbort);
+        if (stage === "finished" || stage === "stopped")
+            return Promise.resolve();
+        stage = "stopped";
+        return (reader ? reader.cancel(reason) : source.cancel(reason)).catch(() => { });
+    };
+    const onAbort = () => { void stop(signal.reason); };
+    signal.addEventListener("abort", onAbort, { once: true });
+    if (signal.aborted)
+        onAbort();
+    return new ReadableStream({
+        async pull(controller) {
+            if (stage === "stopped")
+                throw signal.reason ?? new Error("upload stopped");
+            if (stage === "prefix") {
+                stage = "file";
+                controller.enqueue(prefix);
+                return;
+            }
+            if (stage === "finished") {
+                controller.close();
+                return;
+            }
+            reader ??= source.getReader();
+            const { done, value } = await reader.read();
+            // A read cancelled by `stop` ends as done; it must not be framed as a complete file.
+            if (stage !== "file")
+                throw signal.reason ?? new Error("upload stopped");
+            if (!done) {
+                if (!(value instanceof Uint8Array)) {
+                    const error = new TypeError("upload stream chunks must be Uint8Array");
+                    await stop(error);
+                    throw error;
+                }
+                controller.enqueue(value);
+                return;
+            }
+            reader.releaseLock();
+            reader = undefined;
+            stage = "finished";
+            signal.removeEventListener("abort", onAbort);
+            controller.enqueue(suffix);
+        },
+        cancel(reason) { return stop(reason); },
+    });
+}
+/** JSONL input file of native records (`method` POST and `url` /v1/basal are filled in). Never sends anything. */
+function batchInput(lines) {
+    const out = [];
+    for (const line of lines) {
+        if (!line || typeof line.custom_id !== "string" || !line.custom_id || !line.body || typeof line.body !== "object") {
+            throw new TypeError("each batch line needs a custom_id and a native request body");
+        }
+        out.push(JSON.stringify({ custom_id: line.custom_id, method: line.method ?? "POST", url: line.url ?? "/v1/basal", body: line.body }));
+    }
+    if (!out.length)
+        throw new TypeError("a batch input needs at least one line");
+    return encoder.encode(out.join("\n") + "\n");
+}
+/** Parse downloaded result bytes (output or error file) into lines. Never fetches anything. */
+function parseBatchResults(content) {
+    let text;
+    try {
+        text = new TextDecoder("utf-8", { fatal: true }).decode(content);
+    }
+    catch (cause) {
+        throw new errors_cjs_1.BasalProtocolError("Batch result file is not UTF-8", { cause });
+    }
+    const lines = text.split("\n");
+    if (lines[lines.length - 1] === "")
+        lines.pop();
+    return lines.map((line, index) => {
+        let value;
+        try {
+            value = JSON.parse(line);
+        }
+        catch (cause) {
+            throw new errors_cjs_1.BasalProtocolError(`Batch result line ${index + 1} is not JSON`, { cause });
+        }
+        if (value === null || typeof value !== "object" || Array.isArray(value)) {
+            throw new errors_cjs_1.BasalProtocolError(`Batch result line ${index + 1} is not a JSON object`);
+        }
+        return value;
+    });
+}

package/dist/cjs/batches.d.cts

@@ -0,0 +1,166 @@
+import type { DecisionRequest, JsonValue } from "./index.cjs";
+/** Batch and Files wire types (`contracts/batches/openapi.json`). Times are Unix seconds.
+ * Unknown response fields are preserved at runtime; `(string & {})` keeps enums open to future server values.
+ */
+export type FilePurpose = "batch" | "batch_output";
+export interface FileObject {
+    id: string;
+    object: "file";
+    bytes: number;
+    created_at: number;
+    expires_at: number | null;
+    /** As uploaded, or `batch_<id>_output.jsonl` / `batch_<id>_error.jsonl` for results; never a server path. */
+    filename: string;
+    purpose: FilePurpose | (string & {});
+    /** Always `processed` (OpenAI compatibility). */
+    status: "processed" | (string & {});
+    status_details: string | null;
+}
+export interface DeletedFile {
+    id: string;
+    object: "file";
+    deleted: boolean;
+}
+export interface ListPage<T> {
+    object: "list";
+    data: T[];
+    first_id: string | null;
+    last_id: string | null;
+    has_more: boolean;
+}
+export type FileList = ListPage<FileObject>;
+export type BatchList = ListPage<Batch>;
+/** At most 16 pairs, keys of 1–64 and values of up to 512 characters, in insertion order (checked by the server).
+ * JavaScript enumerates integer-like keys first; use textual keys when order matters.
+ */
+export type Metadata = Record<string, string>;
+export interface ExpiresAfter {
+    anchor: "created_at";
+    seconds: number;
+}
+export type BatchStatus = "validating" | "failed" | "in_progress" | "finalizing" | "completed" | "expired" | "cancelling" | "cancelled";
+export type BatchErrorCode = "empty_file" | "empty_line" | "invalid_json_line" | "line_too_large" | "too_many_records" | "invalid_custom_id" | "duplicate_custom_id" | "invalid_method" | "invalid_url" | "stream_unsupported" | "invalid_body" | "model_not_found" | "mixed_models" | "budget_exceeded" | "host_budget_exceeded" | "unbounded_feature" | "input_changed" | "batch_expired" | "errors_truncated";
+export interface RequestCounts {
+    total: number;
+    completed: number;
+    failed: number;
+}
+export interface BatchErrorEntry {
+    code: BatchErrorCode | (string & {});
+    message: string;
+    param: string | null;
+    line: number | null;
+}
+export interface BatchErrors {
+    object: "list";
+    data: BatchErrorEntry[];
+}
+export interface Batch {
+    id: string;
+    object: "batch";
+    endpoint: "/v1/basal" | (string & {});
+    model: string | null;
+    errors: BatchErrors | null;
+    input_file_id: string;
+    completion_window: "24h" | (string & {});
+    status: BatchStatus | (string & {});
+    output_file_id: string | null;
+    error_file_id: string | null;
+    created_at: number;
+    in_progress_at: number | null;
+    /** End of the 24h inference window; export may finish later. */
+    expires_at: number;
+    finalizing_at: number | null;
+    completed_at: number | null;
+    failed_at: number | null;
+    expired_at: number | null;
+    cancelling_at: number | null;
+    cancelled_at: number | null;
+    request_counts: RequestCounts;
+    metadata: Metadata | null;
+}
+/** `POST /v1/batches` body. `endpoint` and `completion_window` default to their only accepted values. */
+export interface CreateBatchRequest {
+    input_file_id: string;
+    endpoint?: "/v1/basal";
+    completion_window?: "24h";
+    metadata?: Metadata | null;
+    /** Lifetime of each result file, anchored at its creation. */
+    output_expires_after?: ExpiresAfter | null;
+}
+/** One line of an input file; `body` is the native `/v1/basal` request (see `buildRequest`). */
+export interface BatchInputLine {
+    custom_id: string;
+    method?: "POST";
+    url?: "/v1/basal";
+    body: DecisionRequest;
+}
+/** One line of a result file. `response.body` is the native answer: a `DecisionResponse` for status 200, otherwise
+ * the native error body. `error` is set when the record has no response (e.g. `batch_expired`, `result_too_large`).
+ */
+export interface BatchResultLine {
+    id: string;
+    custom_id: string;
+    response: {
+        status_code: number;
+        request_id: string;
+        body: {
+            [key: string]: JsonValue;
+        };
+    } | null;
+    error: {
+        code: string;
+        message: string;
+    } | null;
+}
+/** Common options of Batch and Files calls. */
+export interface RequestOptions {
+    signal?: AbortSignal;
+}
+/** Upload and download options; `timeoutMs` replaces the client deadline for this call only. */
+export interface TransferOptions extends RequestOptions {
+    timeoutMs?: number;
+}
+export interface DownloadOptions extends TransferOptions {
+    /** Byte cap of this download; defaults to the client's `maxResponseBytes`. The body is buffered in memory. */
+    maxBytes?: number;
+}
+export interface CreateBatchOptions extends RequestOptions {
+    /** 1–128 visible ASCII characters; a replay with the same request data returns the existing batch. */
+    idempotencyKey?: string;
+}
+export interface ListOptions extends RequestOptions {
+    after?: string;
+    limit?: number;
+}
+export interface ListFilesOptions extends ListOptions {
+    purpose?: FilePurpose;
+}
+/** Caller-owned upload content. The SDK never fetches URLs or reads paths; a stream is consumed and locked. */
+export type UploadContent = Uint8Array | ArrayBuffer | Blob | ReadableStream<Uint8Array>;
+export interface UploadFileRequest {
+    file: UploadContent;
+    /** 1–255 UTF-8 bytes without control characters or backslashes; stored as given, never used as a path. */
+    filename: string;
+    purpose?: "batch";
+    /** File lifetime (server default 30 days). */
+    expires_after?: ExpiresAfter;
+}
+/** Path segment of a resource id. `.` and `..` would be resolved as dot segments by URL parsing. */
+export declare function resourcePath(prefix: string, id: string, suffix?: string): string;
+export declare function listPath(path: string, options: ListFilesOptions): string;
+export declare function idempotencyHeader(key: string | undefined): Record<string, string>;
+export declare function createBody(request: CreateBatchRequest): CreateBatchRequest;
+/** A multipart body; a stream body is created per request and stops its source when `signal` aborts. */
+export interface Multipart {
+    contentType: string;
+    body: Blob | ((signal: AbortSignal) => ReadableStream<Uint8Array>);
+}
+/** Multipart form of an upload: `expires_after[...]`, then `purpose`, then the file part last (the server reserves the
+ * upload session at the file part, so expiry fields must precede it).
+ */
+export declare function uploadForm(request: UploadFileRequest): Multipart;
+/** JSONL input file of native records (`method` POST and `url` /v1/basal are filled in). Never sends anything. */
+export declare function batchInput(lines: Iterable<BatchInputLine>): Uint8Array;
+/** Parse downloaded result bytes (output or error file) into lines. Never fetches anything. */
+export declare function parseBatchResults(content: Uint8Array): BatchResultLine[];

package/dist/cjs/errors.cjs

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BasalResponseTooLargeError = exports.BasalProtocolError = exports.BasalTransportError = exports.BasalHTTPError = exports.BasalError = void 0;
+class BasalError extends Error {
+}
+exports.BasalError = BasalError;
+/** Non-2xx response. Server body and Retry-After are available without logging them. */
+class BasalHTTPError extends BasalError {
+    statusCode;
+    body;
+    retryAfter;
+    constructor(statusCode, body, retryAfter) {
+        super(`Basal HTTP ${statusCode}`);
+        this.statusCode = statusCode;
+        this.body = body;
+        this.retryAfter = retryAfter;
+        this.name = "BasalHTTPError";
+        // Node's default inspection and JSON.stringify must not print reflected state or credentials.
+        Object.defineProperty(this, "body", { enumerable: false });
+    }
+}
+exports.BasalHTTPError = BasalHTTPError;
+class BasalTransportError extends BasalError {
+}
+exports.BasalTransportError = BasalTransportError;
+class BasalProtocolError extends BasalError {
+}
+exports.BasalProtocolError = BasalProtocolError;
+class BasalResponseTooLargeError extends BasalError {
+}
+exports.BasalResponseTooLargeError = BasalResponseTooLargeError;

package/dist/cjs/errors.d.cts

@@ -0,0 +1,15 @@
+export declare class BasalError extends Error {
+}
+/** Non-2xx response. Server body and Retry-After are available without logging them. */
+export declare class BasalHTTPError extends BasalError {
+    readonly statusCode: number;
+    readonly body: unknown;
+    readonly retryAfter: string | null;
+    constructor(statusCode: number, body: unknown, retryAfter: string | null);
+}
+export declare class BasalTransportError extends BasalError {
+}
+export declare class BasalProtocolError extends BasalError {
+}
+export declare class BasalResponseTooLargeError extends BasalError {
+}