@koolbase/core 12.14.0 → 12.16.0

package/dist/cjs/storage-files.d.ts

@@ -0,0 +1,53 @@
+/** What a listing is ordered by. */
+export type KoolbaseFileSort = 'path' | 'createdAt' | 'updatedAt' | 'size';
+export interface ListFilesOptions {
+    bucket: string;
+    /** Only files whose path starts with this, taken literally. */
+    prefix?: string;
+    /** Files per page: 50 unless set, at most 100. */
+    limit?: number;
+    /** A page's `nextCursor`, for the page after it. */
+    cursor?: string;
+    /** By path unless set. */
+    sort?: KoolbaseFileSort;
+    /** Z to A, newest first, largest first. */
+    descending?: boolean;
+}
+/** One file. */
+export interface KoolbaseFileInfo {
+    /** Its path in the bucket: what a record stores to point at it. */
+    path: string;
+    /** The last part of its path. */
+    name: string;
+    size: number;
+    contentType: string | null;
+    etag: string | null;
+    metadata: Record<string, string>;
+    versionId: string | null;
+    /** Who uploaded it: a project user's id; null when the project did. */
+    uploadedBy: string | null;
+    /** ISO 8601. */
+    createdAt: string;
+    /** ISO 8601. */
+    updatedAt: string;
+    /**
+     * Its permanent link, while its bucket is public; null otherwise -- ask
+     * for a download link instead.
+     */
+    publicUrl: string | null;
+}
+/** One page of a listing. */
+export interface KoolbaseFilePage {
+    files: KoolbaseFileInfo[];
+    /**
+     * Pass to the next call for the page after this one; null at the end. A
+     * page can hold fewer files than asked for -- the server passes over
+     * files you may not view -- and still have a next one.
+     */
+    nextCursor: string | null;
+    hasMore: boolean;
+}
+/** The query string for a listing. */
+export declare function listFilesQuery(o: ListFilesOptions): string;
+export declare function fileInfoFromJson(j: Record<string, unknown>): KoolbaseFileInfo;
+export declare function filePageFromJson(j: Record<string, unknown>): KoolbaseFilePage;

package/dist/cjs/storage-files.js

@@ -0,0 +1,61 @@
+"use strict";
+// A bucket's files, as an app sees them (S1).
+//
+// The server applies the bucket's view rule to every file: a listing holds
+// only files the signed-in person may view, and says nothing of the rest.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listFilesQuery = listFilesQuery;
+exports.fileInfoFromJson = fileInfoFromJson;
+exports.filePageFromJson = filePageFromJson;
+const sortWire = {
+    path: 'path',
+    createdAt: 'created_at',
+    updatedAt: 'updated_at',
+    size: 'size',
+};
+/** The query string for a listing. */
+function listFilesQuery(o) {
+    const q = new URLSearchParams();
+    q.set('bucket', o.bucket);
+    if (o.prefix)
+        q.set('prefix', o.prefix);
+    if (o.limit != null)
+        q.set('limit', String(o.limit));
+    if (o.cursor)
+        q.set('cursor', o.cursor);
+    q.set('sort', sortWire[o.sort ?? 'path'] ?? 'path');
+    q.set('order', o.descending ? 'desc' : 'asc');
+    return q.toString();
+}
+const str = (v) => (typeof v === 'string' && v !== '' ? v : null);
+function fileInfoFromJson(j) {
+    const path = String(j.path ?? '');
+    const metadata = {};
+    if (j.metadata && typeof j.metadata === 'object') {
+        for (const [k, v] of Object.entries(j.metadata)) {
+            metadata[k] = typeof v === 'string' ? v : String(v);
+        }
+    }
+    return {
+        path,
+        name: path.split('/').pop() ?? path,
+        size: Number(j.size ?? 0),
+        contentType: str(j.content_type),
+        etag: str(j.etag),
+        metadata,
+        versionId: str(j.version_id),
+        uploadedBy: str(j.uploaded_by),
+        createdAt: String(j.created_at ?? ''),
+        updatedAt: String(j.updated_at ?? ''),
+        publicUrl: str(j.public_url),
+    };
+}
+function filePageFromJson(j) {
+    const files = Array.isArray(j.files) ? j.files : [];
+    const nextCursor = str(j.next_cursor);
+    return {
+        files: files.map((f) => fileInfoFromJson(f)),
+        nextCursor,
+        hasMore: nextCursor !== null,
+    };
+}

package/dist/cjs/storage-transfer.d.ts

@@ -0,0 +1,88 @@
+import type { UploadResult } from './types.js';
+/** Where an upload is. */
+export type KoolbaseUploadState = 
+/** Not started: asking the server for an upload link. */
+'pending'
+/** Sending the file's bytes; see `bytesSent`. */
+ | 'uploading'
+/** The bytes have arrived; the server is checking them and putting the file in place. It can no longer be cancelled. */
+ | 'verifying'
+/** Done: the file is in the bucket. */
+ | 'completed'
+/** It failed; `error` says why. */
+ | 'failed'
+/** Cancelled before the server began checking it. Nothing was stored. */
+ | 'cancelled';
+/** One moment of an upload. */
+export interface KoolbaseUploadProgress {
+    state: KoolbaseUploadState;
+    /** Bytes sent so far. */
+    bytesSent: number;
+    bytesTotal: number;
+    /** 0 to 1: the share of bytes sent; 1 once verifying. */
+    fraction: number;
+    /** Whether the upload has ended, one way or another. */
+    isDone: boolean;
+    /** Why it failed, when `state` is `'failed'`. */
+    error?: Error;
+}
+/** A running upload: watch it with `onProgress`, `cancel` it, await `result`. */
+export declare class KoolbaseUploadTask {
+    private _current;
+    private listeners;
+    private cancelRequested;
+    private abortTransfer;
+    private total;
+    /**
+     * The uploaded file. Rejects with `KoolbaseUploadCancelledError` if it was
+     * cancelled, or the error that made it fail.
+     */
+    readonly result: Promise<UploadResult>;
+    private resolve;
+    private reject;
+    /** @internal */
+    constructor();
+    /** Where the upload is now. */
+    get current(): KoolbaseUploadProgress;
+    /**
+     * Calls `listener` on every change of state and every chunk sent, starting
+     * with where the upload is now. Returns a function that stops it.
+     */
+    onProgress(listener: (p: KoolbaseUploadProgress) => void): () => void;
+    /**
+     * Stops the upload, if the server has not begun checking it yet. Returns
+     * whether it was stopped: false once verifying (the file will land, or
+     * fail on its own) or done.
+     */
+    cancel(): boolean;
+    /** @internal */
+    get cancelled(): boolean;
+    /** @internal Throws if the upload was cancelled, between steps. */
+    checkCancelled(): void;
+    /** @internal */
+    setTotal(total: number): void;
+    /** @internal */
+    setAbort(abort: (() => void) | null): void;
+    /** @internal */
+    emit(state: KoolbaseUploadState, sent?: number, error?: Error): void;
+    /** @internal Marks the bytes sent: from here the upload cannot be cancelled. */
+    verifying(): void;
+    /** @internal */
+    finish(result: UploadResult): void;
+    /** @internal */
+    fail(error: unknown): void;
+}
+/** Runs `body` as the task's upload, starting on the next turn so a caller can listen to every event. */
+export declare function runUploadTask(body: (task: KoolbaseUploadTask) => Promise<UploadResult>): KoolbaseUploadTask;
+interface PutResult {
+    status: number;
+    etag: string;
+}
+/**
+ * Sends `body` to a presigned `url` with PUT, reporting bytes as they are
+ * sent. XMLHttpRequest where the host has it (browsers and React Native,
+ * both report upload progress); fetch elsewhere, where progress jumps from
+ * 0 to the total. A cancel aborts it.
+ */
+export declare function putWithProgress(task: KoolbaseUploadTask, url: string, body: Blob, contentType: string): Promise<PutResult>;
+export {};

package/dist/cjs/storage-transfer.js

@@ -0,0 +1,214 @@
+"use strict";
+// An upload's lifecycle, as an app watches it (S1).
+//
+// pending -> uploading (bytes sent of total) -> verifying -> completed, or
+// failed / cancelled. Verifying is its own phase: the bytes have arrived and
+// the server is checking them (size, type, the bucket's rules and cap) and
+// putting them in place. Only completed means the file can be referenced
+// from a record.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KoolbaseUploadTask = void 0;
+exports.runUploadTask = runUploadTask;
+exports.putWithProgress = putWithProgress;
+const network_js_1 = require("./network.js");
+const storage_errors_js_1 = require("./storage-errors.js");
+function progressOf(state, bytesSent, bytesTotal, error) {
+    let fraction;
+    if (state === 'verifying' || state === 'completed')
+        fraction = 1;
+    else if (bytesTotal <= 0)
+        fraction = 0;
+    else
+        fraction = Math.min(1, Math.max(0, bytesSent / bytesTotal));
+    return {
+        state,
+        bytesSent,
+        bytesTotal,
+        fraction,
+        isDone: state === 'completed' || state === 'failed' || state === 'cancelled',
+        ...(error ? { error } : {}),
+    };
+}
+/** A running upload: watch it with `onProgress`, `cancel` it, await `result`. */
+class KoolbaseUploadTask {
+    /** @internal */
+    constructor() {
+        this.listeners = new Set();
+        this.cancelRequested = false;
+        this.abortTransfer = null;
+        this.total = 0;
+        this._current = progressOf('pending', 0, 0);
+        this.result = new Promise((res, rej) => {
+            this.resolve = res;
+            this.reject = rej;
+        });
+        // An app that only listens to progress is not left with an unhandled
+        // rejection; awaiting `result` still sees the error.
+        this.result.catch(() => undefined);
+    }
+    /** Where the upload is now. */
+    get current() {
+        return this._current;
+    }
+    /**
+     * Calls `listener` on every change of state and every chunk sent, starting
+     * with where the upload is now. Returns a function that stops it.
+     */
+    onProgress(listener) {
+        this.listeners.add(listener);
+        listener(this._current);
+        return () => {
+            this.listeners.delete(listener);
+        };
+    }
+    /**
+     * Stops the upload, if the server has not begun checking it yet. Returns
+     * whether it was stopped: false once verifying (the file will land, or
+     * fail on its own) or done.
+     */
+    cancel() {
+        if (this._current.isDone || this._current.state === 'verifying')
+            return false;
+        this.cancelRequested = true;
+        this.abortTransfer?.();
+        return true;
+    }
+    /** @internal */
+    get cancelled() {
+        return this.cancelRequested;
+    }
+    /** @internal Throws if the upload was cancelled, between steps. */
+    checkCancelled() {
+        if (this.cancelRequested)
+            throw new storage_errors_js_1.KoolbaseUploadCancelledError();
+    }
+    /** @internal */
+    setTotal(total) {
+        this.total = total;
+    }
+    /** @internal */
+    setAbort(abort) {
+        this.abortTransfer = abort;
+    }
+    /** @internal */
+    emit(state, sent, error) {
+        if (this._current.isDone)
+            return;
+        this._current = progressOf(state, sent ?? this._current.bytesSent, this.total, error);
+        for (const l of [...this.listeners]) {
+            try {
+                l(this._current);
+            }
+            catch {
+                // A listener's own failure is not the upload's.
+            }
+        }
+    }
+    /** @internal Marks the bytes sent: from here the upload cannot be cancelled. */
+    verifying() {
+        this.checkCancelled();
+        this.emit('verifying', this.total);
+    }
+    /** @internal */
+    finish(result) {
+        this.emit('completed', this.total);
+        this.listeners.clear();
+        this.resolve(result);
+    }
+    /** @internal */
+    fail(error) {
+        if (this.cancelRequested) {
+            const e = new storage_errors_js_1.KoolbaseUploadCancelledError();
+            this.emit('cancelled');
+            this.reject(e);
+        }
+        else {
+            const e = error instanceof Error ? error : new storage_errors_js_1.KoolbaseStorageError(String(error));
+            this.emit('failed', undefined, e);
+            this.reject(e);
+        }
+        this.listeners.clear();
+    }
+}
+exports.KoolbaseUploadTask = KoolbaseUploadTask;
+/** Runs `body` as the task's upload, starting on the next turn so a caller can listen to every event. */
+function runUploadTask(body) {
+    const task = new KoolbaseUploadTask();
+    Promise.resolve().then(async () => {
+        try {
+            task.finish(await body(task));
+        }
+        catch (e) {
+            task.fail(e);
+        }
+    });
+    return task;
+}
+/**
+ * Sends `body` to a presigned `url` with PUT, reporting bytes as they are
+ * sent. XMLHttpRequest where the host has it (browsers and React Native,
+ * both report upload progress); fetch elsewhere, where progress jumps from
+ * 0 to the total. A cancel aborts it.
+ */
+function putWithProgress(task, url, body, contentType) {
+    task.checkCancelled();
+    const total = body.size;
+    const report = (sent) => {
+        if (!task.cancelled)
+            task.emit('uploading', Math.min(sent, total));
+    };
+    report(0);
+    const XHR = globalThis.XMLHttpRequest;
+    if (XHR) {
+        return new Promise((resolve, reject) => {
+            const xhr = new XHR();
+            let settled = false;
+            const done = (fn) => {
+                if (settled)
+                    return;
+                settled = true;
+                task.setAbort(null);
+                fn();
+            };
+            xhr.open('PUT', url);
+            xhr.setRequestHeader('Content-Type', contentType);
+            if (xhr.upload) {
+                xhr.upload.onprogress = (ev) => report(ev.loaded);
+            }
+            xhr.onload = () => done(() => {
+                if (task.cancelled)
+                    return reject(new storage_errors_js_1.KoolbaseUploadCancelledError());
+                resolve({ status: xhr.status, etag: xhr.getResponseHeader('etag') ?? '' });
+            });
+            xhr.onerror = () => done(() => reject(task.cancelled ? new storage_errors_js_1.KoolbaseUploadCancelledError() : new network_js_1.KoolbaseNetworkError(url, new Error('the upload did not complete'))));
+            xhr.onabort = () => done(() => reject(new storage_errors_js_1.KoolbaseUploadCancelledError()));
+            task.setAbort(() => {
+                xhr.abort();
+                // Some hosts do not fire onabort for an aborted send.
+                done(() => reject(new storage_errors_js_1.KoolbaseUploadCancelledError()));
+            });
+            xhr.send(body);
+        });
+    }
+    const controller = typeof AbortController !== 'undefined' ? new AbortController() : null;
+    task.setAbort(() => controller?.abort());
+    return fetch(url, {
+        method: 'PUT',
+        headers: { 'Content-Type': contentType },
+        body,
+        signal: controller?.signal,
+    })
+        .then((res) => {
+        task.checkCancelled();
+        return { status: res.status, etag: res.headers.get('etag') ?? '' };
+    })
+        .catch((e) => {
+        if (task.cancelled || e?.name === 'AbortError') {
+            throw new storage_errors_js_1.KoolbaseUploadCancelledError();
+        }
+        if (e instanceof storage_errors_js_1.KoolbaseStorageError)
+            throw e;
+        throw new network_js_1.KoolbaseNetworkError(url, e);
+    })
+        .finally(() => task.setAbort(null));
+}

package/dist/cjs/storage.d.ts

@@ -1,4 +1,6 @@
 import { KoolbaseConfig, UploadOptions, UploadResult, KoolbaseObject, KoolbaseObjectVersion, KoolbaseImageTransform } from './types.js';
+import { KoolbaseUploadTask } from './storage-transfer.js';
+import { KoolbaseFileInfo, KoolbaseFilePage, ListFilesOptions } from './storage-files.js';
 /**
  * Koolbase storage client — uploads, downloads, and deletes via presigned
  * Cloudflare R2 URLs.
@@ -53,6 +55,45 @@ export declare class KoolbaseStorage {
      * overwriting silently, pass `overwrite: true` explicitly.
      */
     upload(options: UploadOptions): Promise<UploadResult>;
+    /**
+     * Starts an upload you can follow and cancel: the same upload as
+     * {@link upload}, returned at once as a {@link KoolbaseUploadTask}.
+     *
+     * The task goes pending -> uploading (bytes sent of total) -> verifying
+     * -> completed, or failed / cancelled. `cancel()` stops it until the
+     * server begins checking the bytes (verifying); nothing is stored. Only
+     * completed means the file can be referenced from a record.
+     *
+     * @example
+     * const task = Koolbase.storage.startUpload({ bucket: 'posters', path: 'gig.png', file });
+     * const stop = task.onProgress((p) => setPercent(Math.round(p.fraction * 100)));
+     * cancelButton.onclick = () => task.cancel();
+     * const { object } = await task.result;
+     */
+    startUpload(options: UploadOptions): KoolbaseUploadTask;
+    private runUpload;
+    /**
+     * One page of a bucket's files. The bucket's view rule is applied to every
+     * file: the page holds only files the signed-in person may view. Pass the
+     * page's `nextCursor` back as `cursor` for the next one; a page can hold
+     * fewer files than `limit` and still have a next.
+     *
+     * @example
+     * let cursor: string | undefined;
+     * do {
+     *   const page = await Koolbase.storage.listFiles({ bucket: 'posters', prefix: 'events/', cursor });
+     *   show(page.files);
+     *   cursor = page.nextCursor ?? undefined;
+     * } while (cursor);
+     */
+    listFiles(options: ListFilesOptions): Promise<KoolbaseFilePage>;
+    /**
+     * One file's details -- size, type, metadata, who uploaded it, and its
+     * permanent link while its bucket is public. Throws
+     * `KoolbaseStorageNotFoundError` for a file that is not there or that
+     * the bucket's view rule hides from the caller.
+     */
+    getFileInfo(bucket: string, path: string): Promise<KoolbaseFileInfo>;
     /**
      * Apply a partial metadata update to an existing object. Returns the
      * post-update {@link KoolbaseObject} with the merged metadata.