@sapiom/tools 0.1.3 → 0.3.0

package/dist/esm/file-storage/index.d.ts

@@ -0,0 +1,116 @@
+/**
+ * `fileStorage` capability — tenant-scoped object storage on presigned GCS URLs.
+ *
+ * The control plane only: `upload` hands back a presigned URL you PUT the bytes to
+ * yourself (so you own streaming / progress / resumable uploads), and
+ * `getDownloadUrl` hands back a presigned URL you GET. `list`, `setVisibility`, and
+ * `delete` round out the lifecycle.
+ *
+ *   import { fileStorage } from "@sapiom/tools";              // ambient auth
+ *   const { uploadUrl, requiredHeaders } = await fileStorage.upload({
+ *     contentType: "image/png",
+ *     fileName: "photo.png",
+ *   });
+ *   await fetch(uploadUrl, { method: "PUT", headers: requiredHeaders, body: bytes });
+ *
+ * Or via an explicit client: `createClient({ apiKey }).fileStorage.upload(...)`.
+ *
+ * Wire fields are snake_case; this module maps them to the camelCase SDK surface.
+ * Byte counts are int64 — the gateway serializes them as strings (precision-safe),
+ * so `expectedFileSize` / `actualFileSize` on returned metadata are `string | null`.
+ */
+import { Transport } from "../_client/index.js";
+import { FileStorageHttpError } from "./errors.js";
+export { FileStorageHttpError };
+export interface UploadInput {
+    /** MIME content type of the file (e.g. "image/png", "application/pdf"). */
+    contentType: string;
+    /** Original file name for display purposes. */
+    fileName?: string;
+    /**
+     * File visibility.
+     * - "private" — download requires authentication (default).
+     * - "public"  — download URL is unauthenticated.
+     */
+    visibility?: "private" | "public";
+    /** Expected file size in bytes. Used to pre-allocate storage. */
+    expectedFileSize?: number;
+}
+export interface UploadResponse {
+    /** Unique file identifier. Use this in subsequent calls. */
+    fileId: string;
+    /** GCS presigned upload URL. PUT the file bytes here directly. Expires at `expiresAt`. */
+    uploadUrl: string;
+    /** ISO-8601 timestamp when the upload URL expires. */
+    expiresAt: string;
+    /** Headers that must be sent when PUTting bytes to `uploadUrl` (e.g. Content-Type). */
+    requiredHeaders: Record<string, string>;
+}
+export interface DownloadUrlResponse {
+    /** Presigned GCS download URL. Expires at `expiresAt`. */
+    downloadUrl: string;
+    /** ISO-8601 timestamp when the download URL expires. */
+    expiresAt: string;
+}
+export interface FileMetadata {
+    /** Unique file identifier. */
+    fileId: string;
+    /** Original file name, if provided at upload time. */
+    fileName?: string;
+    /** MIME content type. */
+    contentType: string;
+    /** File visibility ("private" or "public"). */
+    visibility: "private" | "public";
+    /** Upload lifecycle status (e.g. "pending_upload", "uploaded", "deleted"). */
+    status: string;
+    /**
+     * Expected (client-declared) size in bytes — a string (int64, precision-safe),
+     * `null` when not declared.
+     */
+    expectedFileSize?: string | null;
+    /** Actual size in bytes after upload (string; `null` until the verify sweep records it). */
+    actualFileSize?: string | null;
+    /** ISO-8601 timestamp when the record was created. */
+    createdAt: string;
+    /** ISO-8601 timestamp when the bytes were uploaded. */
+    uploadedAt?: string;
+    /** ISO-8601 timestamp when the file was soft-deleted. */
+    deletedAt?: string;
+    /** Number of times a download URL was generated for this file. */
+    downloadRequestCount: number;
+}
+export interface ListOptions {
+    /** Maximum number of files to return. */
+    limit?: number;
+    /** Number of files to skip (pagination). */
+    offset?: number;
+}
+export interface ListResponse {
+    /** Files on the current page. */
+    files: FileMetadata[];
+    /** Page size used. */
+    limit: number;
+    /** Offset used. */
+    offset: number;
+    /** Whether more files exist beyond this page. */
+    hasMore: boolean;
+}
+/**
+ * Initiate an upload. Returns a presigned GCS URL; PUT the bytes to `uploadUrl`
+ * with `requiredHeaders` yourself (this capability owns only the control plane).
+ */
+export declare function upload(input: UploadInput, transport?: Transport, baseUrl?: string): Promise<UploadResponse>;
+/** Generate a presigned download URL for a file. */
+export declare function getDownloadUrl(fileId: string, transport?: Transport, baseUrl?: string): Promise<DownloadUrlResponse>;
+/** List files owned by the authenticated tenant. */
+export declare function list(opts?: ListOptions, transport?: Transport, baseUrl?: string): Promise<ListResponse>;
+/** Update a file's visibility. */
+export declare function setVisibility(fileId: string, visibility: "private" | "public", transport?: Transport, baseUrl?: string): Promise<FileMetadata>;
+/**
+ * Delete a file. Idempotent on the gateway (deleting an already-deleted file is a
+ * no-op success). Exported as `delete`:
+ * `import { fileStorage } from "@sapiom/tools"; await fileStorage.delete(id)`.
+ */
+declare function deleteFile(fileId: string, transport?: Transport, baseUrl?: string): Promise<void>;
+export { deleteFile as delete };
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/file-storage/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/file-storage/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,EAAE,SAAS,EAAoB,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAY,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAE7D,OAAO,EAAE,oBAAoB,EAAE,CAAC;AAShC,MAAM,WAAW,WAAW;IAC1B,2EAA2E;IAC3E,WAAW,EAAE,MAAM,CAAC;IACpB,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,UAAU,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAClC,iEAAiE;IACjE,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,cAAc;IAC7B,4DAA4D;IAC5D,MAAM,EAAE,MAAM,CAAC;IACf,0FAA0F;IAC1F,SAAS,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAC;IAClB,uFAAuF;IACvF,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACzC;AAED,MAAM,WAAW,mBAAmB;IAClC,0DAA0D;IAC1D,WAAW,EAAE,MAAM,CAAC;IACpB,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B,8BAA8B;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yBAAyB;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,+CAA+C;IAC/C,UAAU,EAAE,SAAS,GAAG,QAAQ,CAAC;IACjC,8EAA8E;IAC9E,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,4FAA4F;IAC5F,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAC;IAClB,uDAAuD;IACvD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kEAAkE;IAClE,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,WAAW;IAC1B,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4CAA4C;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,iCAAiC;IACjC,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,sBAAsB;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,mBAAmB;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,iDAAiD;IACjD,OAAO,EAAE,OAAO,CAAC;CAClB;AA4DD;;;GAGG;AACH,wBAAsB,MAAM,CAC1B,KAAK,EAAE,WAAW,EAClB,SAAS,GAAE,SAA8B,EACzC,OAAO,SAAmB,GACzB,OAAO,CAAC,cAAc,CAAC,CAuBzB;AAED,oDAAoD;AACpD,wBAAsB,cAAc,CAClC,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,SAA8B,EACzC,OAAO,SAAmB,GACzB,OAAO,CAAC,mBAAmB,CAAC,CAO9B;AAED,oDAAoD;AACpD,wBAAsB,IAAI,CACxB,IAAI,CAAC,EAAE,WAAW,EAClB,SAAS,GAAE,SAA8B,EACzC,OAAO,SAAmB,GACzB,OAAO,CAAC,YAAY,CAAC,CAmBvB;AAED,kCAAkC;AAClC,wBAAsB,aAAa,CACjC,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,SAAS,GAAG,QAAQ,EAChC,SAAS,GAAE,SAA8B,EACzC,OAAO,SAAmB,GACzB,OAAO,CAAC,YAAY,CAAC,CAWvB;AAED;;;;GAIG;AACH,iBAAe,UAAU,CACvB,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,SAA8B,EACzC,OAAO,SAAmB,GACzB,OAAO,CAAC,IAAI,CAAC,CAoBf;AAED,OAAO,EAAE,UAAU,IAAI,MAAM,EAAE,CAAC"}

package/dist/esm/file-storage/index.js

@@ -0,0 +1,129 @@
+/**
+ * `fileStorage` capability — tenant-scoped object storage on presigned GCS URLs.
+ *
+ * The control plane only: `upload` hands back a presigned URL you PUT the bytes to
+ * yourself (so you own streaming / progress / resumable uploads), and
+ * `getDownloadUrl` hands back a presigned URL you GET. `list`, `setVisibility`, and
+ * `delete` round out the lifecycle.
+ *
+ *   import { fileStorage } from "@sapiom/tools";              // ambient auth
+ *   const { uploadUrl, requiredHeaders } = await fileStorage.upload({
+ *     contentType: "image/png",
+ *     fileName: "photo.png",
+ *   });
+ *   await fetch(uploadUrl, { method: "PUT", headers: requiredHeaders, body: bytes });
+ *
+ * Or via an explicit client: `createClient({ apiKey }).fileStorage.upload(...)`.
+ *
+ * Wire fields are snake_case; this module maps them to the camelCase SDK surface.
+ * Byte counts are int64 — the gateway serializes them as strings (precision-safe),
+ * so `expectedFileSize` / `actualFileSize` on returned metadata are `string | null`.
+ */
+import { defaultTransport } from "../_client/index.js";
+import { ensureOk, FileStorageHttpError } from "./errors.js";
+export { FileStorageHttpError };
+/** Object storage service. Host routing is an internal detail — override via SAPIOM_FILE_STORAGE_URL. */
+const DEFAULT_BASE_URL = process.env.SAPIOM_FILE_STORAGE_URL ||
+    "https://file-storage.services.sapiom.ai";
+function mapFileMetadata(raw) {
+    return {
+        fileId: raw.file_id,
+        ...(raw.file_name !== undefined && { fileName: raw.file_name }),
+        contentType: raw.content_type,
+        visibility: raw.visibility,
+        status: raw.status,
+        ...(raw.expected_file_size !== undefined && {
+            expectedFileSize: raw.expected_file_size,
+        }),
+        ...(raw.actual_file_size !== undefined && {
+            actualFileSize: raw.actual_file_size,
+        }),
+        createdAt: raw.created_at,
+        ...(raw.uploaded_at !== undefined && { uploadedAt: raw.uploaded_at }),
+        ...(raw.deleted_at !== undefined && { deletedAt: raw.deleted_at }),
+        downloadRequestCount: raw.download_request_count,
+    };
+}
+// ----- capability operations -----
+/**
+ * Initiate an upload. Returns a presigned GCS URL; PUT the bytes to `uploadUrl`
+ * with `requiredHeaders` yourself (this capability owns only the control plane).
+ */
+export async function upload(input, transport = defaultTransport(), baseUrl = DEFAULT_BASE_URL) {
+    const body = { content_type: input.contentType };
+    if (input.fileName !== undefined)
+        body.file_name = input.fileName;
+    if (input.visibility !== undefined)
+        body.visibility = input.visibility;
+    if (input.expectedFileSize !== undefined) {
+        body.expected_file_size = input.expectedFileSize;
+    }
+    const res = await ensureOk(await transport.fetch(`${baseUrl}/upload`, {
+        method: "POST",
+        headers: { "content-type": "application/json" },
+        body: JSON.stringify(body),
+    }), "Failed to initiate file upload");
+    const raw = (await res.json());
+    return {
+        fileId: raw.file_id,
+        uploadUrl: raw.upload_url,
+        expiresAt: raw.expires_at,
+        requiredHeaders: raw.required_headers,
+    };
+}
+/** Generate a presigned download URL for a file. */
+export async function getDownloadUrl(fileId, transport = defaultTransport(), baseUrl = DEFAULT_BASE_URL) {
+    const res = await ensureOk(await transport.fetch(`${baseUrl}/download/${encodeURIComponent(fileId)}`), `Failed to get download URL for file '${fileId}'`);
+    const raw = (await res.json());
+    return { downloadUrl: raw.download_url, expiresAt: raw.expires_at };
+}
+/** List files owned by the authenticated tenant. */
+export async function list(opts, transport = defaultTransport(), baseUrl = DEFAULT_BASE_URL) {
+    const url = new URL(`${baseUrl}/files`);
+    if (opts?.limit !== undefined) {
+        url.searchParams.set("limit", String(opts.limit));
+    }
+    if (opts?.offset !== undefined) {
+        url.searchParams.set("offset", String(opts.offset));
+    }
+    const res = await ensureOk(await transport.fetch(url.toString()), "Failed to list files");
+    const raw = (await res.json());
+    return {
+        files: raw.files.map(mapFileMetadata),
+        limit: raw.limit,
+        offset: raw.offset,
+        hasMore: raw.has_more,
+    };
+}
+/** Update a file's visibility. */
+export async function setVisibility(fileId, visibility, transport = defaultTransport(), baseUrl = DEFAULT_BASE_URL) {
+    const res = await ensureOk(await transport.fetch(`${baseUrl}/${encodeURIComponent(fileId)}`, {
+        method: "PATCH",
+        headers: { "content-type": "application/json" },
+        body: JSON.stringify({ visibility }),
+    }), `Failed to set visibility for file '${fileId}'`);
+    const raw = (await res.json());
+    return mapFileMetadata(raw);
+}
+/**
+ * Delete a file. Idempotent on the gateway (deleting an already-deleted file is a
+ * no-op success). Exported as `delete`:
+ * `import { fileStorage } from "@sapiom/tools"; await fileStorage.delete(id)`.
+ */
+async function deleteFile(fileId, transport = defaultTransport(), baseUrl = DEFAULT_BASE_URL) {
+    const res = await transport.fetch(`${baseUrl}/${encodeURIComponent(fileId)}`, { method: "DELETE" });
+    if (!res.ok) {
+        const text = await res.text().catch(() => "");
+        let parsed;
+        try {
+            parsed = JSON.parse(text);
+        }
+        catch {
+            parsed = text;
+        }
+        throw new FileStorageHttpError(`Failed to delete file '${fileId}': ${res.status} ${text}`, res.status, parsed);
+    }
+    // 204 No Content — nothing to parse.
+}
+export { deleteFile as delete };
+//# sourceMappingURL=index.js.map

package/dist/esm/file-storage/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/file-storage/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,EAAa,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAE7D,OAAO,EAAE,oBAAoB,EAAE,CAAC;AAEhC,yGAAyG;AACzG,MAAM,gBAAgB,GACpB,OAAO,CAAC,GAAG,CAAC,uBAAuB;IACnC,yCAAyC,CAAC;AAuH5C,SAAS,eAAe,CAAC,GAAwB;IAC/C,OAAO;QACL,MAAM,EAAE,GAAG,CAAC,OAAO;QACnB,GAAG,CAAC,GAAG,CAAC,SAAS,KAAK,SAAS,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC;QAC/D,WAAW,EAAE,GAAG,CAAC,YAAY;QAC7B,UAAU,EAAE,GAAG,CAAC,UAAU;QAC1B,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,GAAG,CAAC,GAAG,CAAC,kBAAkB,KAAK,SAAS,IAAI;YAC1C,gBAAgB,EAAE,GAAG,CAAC,kBAAkB;SACzC,CAAC;QACF,GAAG,CAAC,GAAG,CAAC,gBAAgB,KAAK,SAAS,IAAI;YACxC,cAAc,EAAE,GAAG,CAAC,gBAAgB;SACrC,CAAC;QACF,SAAS,EAAE,GAAG,CAAC,UAAU;QACzB,GAAG,CAAC,GAAG,CAAC,WAAW,KAAK,SAAS,IAAI,EAAE,UAAU,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC;QACrE,GAAG,CAAC,GAAG,CAAC,UAAU,KAAK,SAAS,IAAI,EAAE,SAAS,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC;QAClE,oBAAoB,EAAE,GAAG,CAAC,sBAAsB;KACjD,CAAC;AACJ,CAAC;AAED,oCAAoC;AAEpC;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,KAAkB,EAClB,YAAuB,gBAAgB,EAAE,EACzC,OAAO,GAAG,gBAAgB;IAE1B,MAAM,IAAI,GAA4B,EAAE,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC;IAC1E,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS;QAAE,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;IAClE,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS;QAAE,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;IACvE,IAAI,KAAK,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACzC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,gBAAgB,CAAC;IACnD,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,QAAQ,CACxB,MAAM,SAAS,CAAC,KAAK,CAAC,GAAG,OAAO,SAAS,EAAE;QACzC,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;QAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;KAC3B,CAAC,EACF,gCAAgC,CACjC,CAAC;IACF,MAAM,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAA0B,CAAC;IACxD,OAAO;QACL,MAAM,EAAE,GAAG,CAAC,OAAO;QACnB,SAAS,EAAE,GAAG,CAAC,UAAU;QACzB,SAAS,EAAE,GAAG,CAAC,UAAU;QACzB,eAAe,EAAE,GAAG,CAAC,gBAAgB;KACtC,CAAC;AACJ,CAAC;AAED,oDAAoD;AACpD,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAAc,EACd,YAAuB,gBAAgB,EAAE,EACzC,OAAO,GAAG,gBAAgB;IAE1B,MAAM,GAAG,GAAG,MAAM,QAAQ,CACxB,MAAM,SAAS,CAAC,KAAK,CAAC,GAAG,OAAO,aAAa,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC,EAC1E,wCAAwC,MAAM,GAAG,CAClD,CAAC;IACF,MAAM,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAA4B,CAAC;IAC1D,OAAO,EAAE,WAAW,EAAE,GAAG,CAAC,YAAY,EAAE,SAAS,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC;AACtE,CAAC;AAED,oDAAoD;AACpD,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,IAAkB,EAClB,YAAuB,gBAAgB,EAAE,EACzC,OAAO,GAAG,gBAAgB;IAE1B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,OAAO,QAAQ,CAAC,CAAC;IACxC,IAAI,IAAI,EAAE,KAAK,KAAK,SAAS,EAAE,CAAC;QAC9B,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC;IACD,IAAI,IAAI,EAAE,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/B,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACtD,CAAC;IACD,MAAM,GAAG,GAAG,MAAM,QAAQ,CACxB,MAAM,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,EACrC,sBAAsB,CACvB,CAAC;IACF,MAAM,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAwB,CAAC;IACtD,OAAO;QACL,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC;QACrC,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,OAAO,EAAE,GAAG,CAAC,QAAQ;KACtB,CAAC;AACJ,CAAC;AAED,kCAAkC;AAClC,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAc,EACd,UAAgC,EAChC,YAAuB,gBAAgB,EAAE,EACzC,OAAO,GAAG,gBAAgB;IAE1B,MAAM,GAAG,GAAG,MAAM,QAAQ,CACxB,MAAM,SAAS,CAAC,KAAK,CAAC,GAAG,OAAO,IAAI,kBAAkB,CAAC,MAAM,CAAC,EAAE,EAAE;QAChE,MAAM,EAAE,OAAO;QACf,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;QAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,CAAC;KACrC,CAAC,EACF,sCAAsC,MAAM,GAAG,CAChD,CAAC;IACF,MAAM,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAwB,CAAC;IACtD,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC;AAC9B,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,UAAU,CACvB,MAAc,EACd,YAAuB,gBAAgB,EAAE,EACzC,OAAO,GAAG,gBAAgB;IAE1B,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,KAAK,CAC/B,GAAG,OAAO,IAAI,kBAAkB,CAAC,MAAM,CAAC,EAAE,EAC1C,EAAE,MAAM,EAAE,QAAQ,EAAE,CACrB,CAAC;IACF,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;QAC9C,IAAI,MAAe,CAAC;QACpB,IAAI,CAAC;YACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,GAAG,IAAI,CAAC;QAChB,CAAC;QACD,MAAM,IAAI,oBAAoB,CAC5B,0BAA0B,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,IAAI,EAAE,EAC1D,GAAG,CAAC,MAAM,EACV,MAAM,CACP,CAAC;IACJ,CAAC;IACD,qCAAqC;AACvC,CAAC;AAED,OAAO,EAAE,UAAU,IAAI,MAAM,EAAE,CAAC"}

package/dist/esm/index.d.ts

@@ -2,8 +2,8 @@
  * `@sapiom/tools` — the typed Sapiom capability client.
  *
  * The same catalog your agents call over MCP, callable from code. Capabilities are
- * namespaces (`sandboxes`, `repositories`, `agent`, … ), importable from the barrel
- * or a subpath:
+ * namespaces (`sandboxes`, `repositories`, `agent`, `fileStorage`, … ), importable
+ * from the barrel or a subpath:
  *
  *   import { sandboxes } from "@sapiom/tools";
  *   import { sandboxes } from "@sapiom/tools/sandboxes";
@@ -21,4 +21,7 @@ export * as repositories from "./repositories/index.js";
 export { Repository } from "./repositories/index.js";
 export * as agent from "./agent/index.js";
 export { CODING_RESULT_SIGNAL } from "./agent/index.js";
+export type { CodingResultPayload } from "./agent/index.js";
+export * as fileStorage from "./file-storage/index.js";
+export { FileStorageHttpError } from "./file-storage/index.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAChE,YAAY,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAIvE,YAAY,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAEpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C,OAAO,KAAK,YAAY,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAChE,YAAY,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAIvE,YAAY,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAEpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C,OAAO,KAAK,YAAY,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAGxD,YAAY,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAE5D,OAAO,KAAK,WAAW,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC"}

package/dist/esm/index.js

@@ -2,8 +2,8 @@
  * `@sapiom/tools` — the typed Sapiom capability client.
  *
  * The same catalog your agents call over MCP, callable from code. Capabilities are
- * namespaces (`sandboxes`, `repositories`, `agent`, … ), importable from the barrel
- * or a subpath:
+ * namespaces (`sandboxes`, `repositories`, `agent`, `fileStorage`, … ), importable
+ * from the barrel or a subpath:
  *
  *   import { sandboxes } from "@sapiom/tools";
  *   import { sandboxes } from "@sapiom/tools/sandboxes";
@@ -19,4 +19,6 @@ export { Repository } from "./repositories/index.js";
 export * as agent from "./agent/index.js";
 // Surfaced top-level for the static `pause: { signal }` decl on a workflow step.
 export { CODING_RESULT_SIGNAL } from "./agent/index.js";
+export * as fileStorage from "./file-storage/index.js";
+export { FileStorageHttpError } from "./file-storage/index.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAQhE,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C,OAAO,KAAK,YAAY,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAC1C,iFAAiF;AACjF,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAQhE,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C,OAAO,KAAK,YAAY,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAC1C,iFAAiF;AACjF,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAKxD,OAAO,KAAK,WAAW,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC"}

package/dist/esm/stub/index.d.ts

@@ -0,0 +1,34 @@
+import type { Sapiom } from "../client.js";
+/** Per-capability overrides, keyed by capability path (see module docs). */
+export type StubOverrides = Record<string, unknown | ((...args: unknown[]) => unknown)>;
+export interface StubClientOptions {
+    overrides?: StubOverrides;
+    /**
+     * When provided, any dispatch-able capability records `(correlationId →
+     * result)` here (via {@link dispatchable}). A local runner uses it to
+     * auto-resume a `pauseUntilSignal(handle, …)` with the result the handle's
+     * signal would have carried.
+     */
+    signals?: Map<string, unknown>;
+    /**
+     * When provided, every override key that is actually matched by a capability
+     * call is added here. A local runner diffs this against the keys the author
+     * supplied to warn about stub keys that matched nothing (a typo'd path, or the
+     * wrong plural/singular form) — which otherwise fail silently.
+     */
+    usedKeys?: Set<string>;
+    /**
+     * When provided, collects human-readable warnings about stub *values* that are
+     * present but malformed for the capability they override (e.g. a
+     * `repositories.list` stub that isn't an array of repositories). Catches the
+     * silent-wrong-data trap that `usedKeys` can't — a key that matched but carried
+     * the wrong shape.
+     */
+    warnings?: Set<string>;
+}
+/**
+ * Create a stub `Sapiom` client. Runs every capability against built-in defaults;
+ * pass `overrides` to control the results a step branches on.
+ */
+export declare function createStubClient(opts?: StubClientOptions): Sapiom;
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/stub/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/stub/index.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAU3C,4EAA4E;AAC5E,MAAM,MAAM,aAAa,GAAG,MAAM,CAChC,MAAM,EACN,OAAO,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,CAC5C,CAAC;AAEF,MAAM,WAAW,iBAAiB;IAChC,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACvB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CACxB;AA6TD;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,GAAE,iBAAsB,GAAG,MAAM,CAgJrE"}