@org-quicko/silo-client 1.0.0

package/dist/instance/health-report.d.cts

@@ -0,0 +1,5 @@
+/** What `GET /api/health` answers — never authenticated. */
+export interface HealthReport {
+    readonly status: string;
+    readonly version: string;
+}

package/dist/instance/health-report.d.ts

@@ -0,0 +1,5 @@
+/** What `GET /api/health` answers — never authenticated. */
+export interface HealthReport {
+    readonly status: string;
+    readonly version: string;
+}

package/dist/media/media-asset-mapper.d.cts

@@ -0,0 +1,31 @@
+import type { MediaAssetRecord } from "./media-asset.cjs";
+import type { MediaAssetPayload } from "./media-asset-payload.cjs";
+import type { MediaUsage } from "./media-usage.cjs";
+/** `MediaAssetMapper.toUsagePage`'s output — one page of an asset's
+ *  referrers, mapped. */
+export interface MediaUsagePageFields {
+    items: MediaUsage[];
+    total: number;
+    visible: number;
+    visibleCapped: boolean;
+}
+/**
+ * The explicit per-type mapper for media: renames only the known wire
+ * fields — `size`, `content_type`, `blob_key`, `usage_count`, `env`,
+ * `visible_capped` and the two timestamps — and leaves `filename` and `tags`
+ * untouched. The one place that maps the wire, reused by every media class
+ * and by `MediaInUseError` for its `referrers`.
+ */
+export declare class MediaAssetMapper {
+    static toRecord(payload: MediaAssetPayload): MediaAssetRecord;
+    /** Reads defensively: this also backs `MediaInUseError`'s referrers, which
+     *  arrive inside an error body rather than a route this client trusts to
+     *  shape exactly right. */
+    static toUsage(payload: Record<string, unknown>): MediaUsage;
+    static toUsagePage(body: {
+        items: unknown[];
+        total: number;
+        visible: number;
+        visible_capped: boolean;
+    }): MediaUsagePageFields;
+}

package/dist/media/media-asset-mapper.d.ts

@@ -0,0 +1,31 @@
+import type { MediaAssetRecord } from "./media-asset.js";
+import type { MediaAssetPayload } from "./media-asset-payload.js";
+import type { MediaUsage } from "./media-usage.js";
+/** `MediaAssetMapper.toUsagePage`'s output — one page of an asset's
+ *  referrers, mapped. */
+export interface MediaUsagePageFields {
+    items: MediaUsage[];
+    total: number;
+    visible: number;
+    visibleCapped: boolean;
+}
+/**
+ * The explicit per-type mapper for media: renames only the known wire
+ * fields — `size`, `content_type`, `blob_key`, `usage_count`, `env`,
+ * `visible_capped` and the two timestamps — and leaves `filename` and `tags`
+ * untouched. The one place that maps the wire, reused by every media class
+ * and by `MediaInUseError` for its `referrers`.
+ */
+export declare class MediaAssetMapper {
+    static toRecord(payload: MediaAssetPayload): MediaAssetRecord;
+    /** Reads defensively: this also backs `MediaInUseError`'s referrers, which
+     *  arrive inside an error body rather than a route this client trusts to
+     *  shape exactly right. */
+    static toUsage(payload: Record<string, unknown>): MediaUsage;
+    static toUsagePage(body: {
+        items: unknown[];
+        total: number;
+        visible: number;
+        visible_capped: boolean;
+    }): MediaUsagePageFields;
+}

package/dist/media/media-asset-payload.d.cts

@@ -0,0 +1,20 @@
+/**
+ * A catalogued media asset exactly as the wire answers it — the body
+ * `GET/POST/PATCH /api/media[/…]` sends for one asset, and `MediaAssetMapper`
+ *'s input.
+ */
+export interface MediaAssetPayload {
+    id: string;
+    filename: string;
+    folder: string;
+    blob_key: string;
+    size: number;
+    content_type: string;
+    hash: string;
+    state: "active" | "deleting";
+    tags: string[];
+    url: string;
+    created_at: string;
+    updated_at: string;
+    usage_count?: number;
+}

package/dist/media/media-asset-payload.d.ts

@@ -0,0 +1,20 @@
+/**
+ * A catalogued media asset exactly as the wire answers it — the body
+ * `GET/POST/PATCH /api/media[/…]` sends for one asset, and `MediaAssetMapper`
+ *'s input.
+ */
+export interface MediaAssetPayload {
+    id: string;
+    filename: string;
+    folder: string;
+    blob_key: string;
+    size: number;
+    content_type: string;
+    hash: string;
+    state: "active" | "deleting";
+    tags: string[];
+    url: string;
+    created_at: string;
+    updated_at: string;
+    usage_count?: number;
+}

package/dist/media/media-asset.d.cts

@@ -0,0 +1,63 @@
+import type { RequestOptions } from "../request-options.cjs";
+import type { Transport } from "../transport/transport.cjs";
+import type { MediaDeleteOptions } from "./media-delete-options.cjs";
+import type { MediaUsageQuery } from "./media-usage-page.cjs";
+import { MediaUsagePage } from "./media-usage-page.cjs";
+/** `MediaAsset`'s mapped state — `MediaAssetMapper.toRecord`'s output. */
+export interface MediaAssetRecord {
+    id: string;
+    filename: string;
+    folder: string;
+    blobKey: string;
+    sizeInBytes: number;
+    contentType: string;
+    hash: string;
+    state: "active" | "deleting";
+    tags: string[];
+    url: string;
+    usageCount: number;
+    createdAt: Date;
+    updatedAt: Date;
+}
+/**
+ * A catalogued media asset, live: the mapped record plus the operations on
+ * it (symmetrical with `Entry`). A mutating call adopts the server's answer
+ * in place and returns `this`.
+ *
+ * `reference` (`silo://media/<id>`) is what an entry field should hold;
+ * `url` is only where to fetch today's bytes. A rename or move keeps the
+ * same `reference` but can change `url` — storing `url` in an entry is the
+ * mistake a later rename silently breaks.
+ */
+export declare class MediaAsset {
+    private readonly transport;
+    private record;
+    constructor(transport: Transport, record: MediaAssetRecord);
+    get id(): string;
+    get filename(): string;
+    get folder(): string;
+    get sizeInBytes(): number;
+    get contentType(): string;
+    get hash(): string;
+    get state(): "active" | "deleting";
+    get tags(): readonly string[];
+    get url(): string;
+    get usageCount(): number;
+    get createdAt(): Date;
+    get updatedAt(): Date;
+    get blobKey(): string;
+    /** `silo://media/<id>` — store THIS in an entry field, never `url` (see
+     * the class doc). */
+    get reference(): string;
+    rename(filename: string, options?: RequestOptions): Promise<this>;
+    moveTo(folder: string, options?: RequestOptions): Promise<this>;
+    /** REPLACES the tag list — `PATCH` replaces, it does not append. */
+    setTags(tags: readonly string[], options?: RequestOptions): Promise<this>;
+    /** Refused while an entry references it; `{ force: true }` also needs
+     * `entries:update` on every scope this asset reaches. */
+    delete(options?: MediaDeleteOptions): Promise<void>;
+    usages(query?: MediaUsageQuery, options?: RequestOptions): Promise<MediaUsagePage>;
+    refresh(options?: RequestOptions): Promise<this>;
+    toJSON(): MediaAssetRecord;
+    private patch;
+}

package/dist/media/media-asset.d.ts

@@ -0,0 +1,63 @@
+import type { RequestOptions } from "../request-options.js";
+import type { Transport } from "../transport/transport.js";
+import type { MediaDeleteOptions } from "./media-delete-options.js";
+import type { MediaUsageQuery } from "./media-usage-page.js";
+import { MediaUsagePage } from "./media-usage-page.js";
+/** `MediaAsset`'s mapped state — `MediaAssetMapper.toRecord`'s output. */
+export interface MediaAssetRecord {
+    id: string;
+    filename: string;
+    folder: string;
+    blobKey: string;
+    sizeInBytes: number;
+    contentType: string;
+    hash: string;
+    state: "active" | "deleting";
+    tags: string[];
+    url: string;
+    usageCount: number;
+    createdAt: Date;
+    updatedAt: Date;
+}
+/**
+ * A catalogued media asset, live: the mapped record plus the operations on
+ * it (symmetrical with `Entry`). A mutating call adopts the server's answer
+ * in place and returns `this`.
+ *
+ * `reference` (`silo://media/<id>`) is what an entry field should hold;
+ * `url` is only where to fetch today's bytes. A rename or move keeps the
+ * same `reference` but can change `url` — storing `url` in an entry is the
+ * mistake a later rename silently breaks.
+ */
+export declare class MediaAsset {
+    private readonly transport;
+    private record;
+    constructor(transport: Transport, record: MediaAssetRecord);
+    get id(): string;
+    get filename(): string;
+    get folder(): string;
+    get sizeInBytes(): number;
+    get contentType(): string;
+    get hash(): string;
+    get state(): "active" | "deleting";
+    get tags(): readonly string[];
+    get url(): string;
+    get usageCount(): number;
+    get createdAt(): Date;
+    get updatedAt(): Date;
+    get blobKey(): string;
+    /** `silo://media/<id>` — store THIS in an entry field, never `url` (see
+     * the class doc). */
+    get reference(): string;
+    rename(filename: string, options?: RequestOptions): Promise<this>;
+    moveTo(folder: string, options?: RequestOptions): Promise<this>;
+    /** REPLACES the tag list — `PATCH` replaces, it does not append. */
+    setTags(tags: readonly string[], options?: RequestOptions): Promise<this>;
+    /** Refused while an entry references it; `{ force: true }` also needs
+     * `entries:update` on every scope this asset reaches. */
+    delete(options?: MediaDeleteOptions): Promise<void>;
+    usages(query?: MediaUsageQuery, options?: RequestOptions): Promise<MediaUsagePage>;
+    refresh(options?: RequestOptions): Promise<this>;
+    toJSON(): MediaAssetRecord;
+    private patch;
+}

package/dist/media/media-delete-failure.d.cts

@@ -0,0 +1,16 @@
+import type { MediaUsage } from "./media-usage.cjs";
+/**
+ * One id's outcome in a bulk delete that could not remove it. `usageCount`,
+ * `visibleCount`, `visibleCapped` and `referrers` are present only for the
+ * `"media_in_use"` code — `"not_found"`, `"media_delete_stalled"` and
+ * `"invalid_id"` carry just `id`, `code` and `message`.
+ */
+export interface MediaDeleteFailure {
+    id: string;
+    code: string;
+    message: string;
+    usageCount?: number;
+    visibleCount?: number;
+    visibleCapped?: boolean;
+    referrers?: MediaUsage[];
+}

package/dist/media/media-delete-failure.d.ts

@@ -0,0 +1,16 @@
+import type { MediaUsage } from "./media-usage.js";
+/**
+ * One id's outcome in a bulk delete that could not remove it. `usageCount`,
+ * `visibleCount`, `visibleCapped` and `referrers` are present only for the
+ * `"media_in_use"` code — `"not_found"`, `"media_delete_stalled"` and
+ * `"invalid_id"` carry just `id`, `code` and `message`.
+ */
+export interface MediaDeleteFailure {
+    id: string;
+    code: string;
+    message: string;
+    usageCount?: number;
+    visibleCount?: number;
+    visibleCapped?: boolean;
+    referrers?: MediaUsage[];
+}

package/dist/media/media-delete-options.d.cts

@@ -0,0 +1,9 @@
+import type { RequestOptions } from "../request-options.cjs";
+/**
+ * `MediaAsset.delete()` and `Media.deleteMany()`'s options. `force` skips the
+ * usage check and deletes over a live reference — it also needs
+ * `entries:update` on every scope the asset actually reaches.
+ */
+export interface MediaDeleteOptions extends RequestOptions {
+    force?: boolean;
+}

package/dist/media/media-delete-options.d.ts

@@ -0,0 +1,9 @@
+import type { RequestOptions } from "../request-options.js";
+/**
+ * `MediaAsset.delete()` and `Media.deleteMany()`'s options. `force` skips the
+ * usage check and deletes over a live reference — it also needs
+ * `entries:update` on every scope the asset actually reaches.
+ */
+export interface MediaDeleteOptions extends RequestOptions {
+    force?: boolean;
+}

package/dist/media/media-delete-report.d.cts

@@ -0,0 +1,13 @@
+import type { MediaDeleteFailure } from "./media-delete-failure.cjs";
+/** `POST /api/media/delete`'s always-`200` body: every id's outcome,
+ * never a partial result the caller has to infer from a thrown error. */
+export declare class MediaDeleteReport {
+    readonly deleted: readonly string[];
+    readonly failed: readonly MediaDeleteFailure[];
+    private constructor();
+    static fromWireBody(body: {
+        deleted: string[];
+        failed: Record<string, unknown>[];
+    }): MediaDeleteReport;
+    private static toFailure;
+}

package/dist/media/media-delete-report.d.ts

@@ -0,0 +1,13 @@
+import type { MediaDeleteFailure } from "./media-delete-failure.js";
+/** `POST /api/media/delete`'s always-`200` body: every id's outcome,
+ * never a partial result the caller has to infer from a thrown error. */
+export declare class MediaDeleteReport {
+    readonly deleted: readonly string[];
+    readonly failed: readonly MediaDeleteFailure[];
+    private constructor();
+    static fromWireBody(body: {
+        deleted: string[];
+        failed: Record<string, unknown>[];
+    }): MediaDeleteReport;
+    private static toFailure;
+}

package/dist/media/media-folder-delete.d.cts

@@ -0,0 +1,10 @@
+import type { RequestOptions } from "../request-options.cjs";
+/**
+ * `MediaFolders.delete()`'s options. `recursive` takes everything inside the
+ * folder with it; `force` (only meaningful with `recursive`) opts past a live
+ * reference among those assets.
+ */
+export interface MediaFolderDeleteOptions extends RequestOptions {
+    recursive?: boolean;
+    force?: boolean;
+}

package/dist/media/media-folder-delete.d.ts

@@ -0,0 +1,10 @@
+import type { RequestOptions } from "../request-options.js";
+/**
+ * `MediaFolders.delete()`'s options. `recursive` takes everything inside the
+ * folder with it; `force` (only meaningful with `recursive`) opts past a live
+ * reference among those assets.
+ */
+export interface MediaFolderDeleteOptions extends RequestOptions {
+    recursive?: boolean;
+    force?: boolean;
+}

package/dist/media/media-folder-move.d.cts

@@ -0,0 +1,9 @@
+import type { RequestOptions } from "../request-options.cjs";
+/**
+ * `MediaFolders.rename()`'s options. `merge` opts into joining an existing
+ * destination instead of refusing on collision — the same authority that
+ * already governs where a folder sits.
+ */
+export interface MediaFolderMoveOptions extends RequestOptions {
+    merge?: boolean;
+}

package/dist/media/media-folder-move.d.ts

@@ -0,0 +1,9 @@
+import type { RequestOptions } from "../request-options.js";
+/**
+ * `MediaFolders.rename()`'s options. `merge` opts into joining an existing
+ * destination instead of refusing on collision — the same authority that
+ * already governs where a folder sits.
+ */
+export interface MediaFolderMoveOptions extends RequestOptions {
+    merge?: boolean;
+}

package/dist/media/media-folders.d.cts

@@ -0,0 +1,22 @@
+import type { RequestOptions } from "../request-options.cjs";
+import type { Transport } from "../transport/transport.cjs";
+import type { MediaFolderDeleteOptions } from "./media-folder-delete.cjs";
+import type { MediaFolderMoveOptions } from "./media-folder-move.cjs";
+/** The media library's folder tree: `list`, `create`, `rename`/move,
+ * `delete`. A folder is an explicit record, so one can exist before
+ * anything is filed into it. */
+export declare class MediaFolders {
+    private readonly transport;
+    constructor(transport: Transport);
+    list(options?: RequestOptions): Promise<string[]>;
+    /** Answers the path the server settled on. */
+    create(path: string, options?: RequestOptions): Promise<string>;
+    rename(from: string, to: string, options?: MediaFolderMoveOptions): Promise<{
+        from: string;
+        to: string;
+    }>;
+    /** The folder path is carried as `?path=`, not a path segment — it
+     * contains "/". `force` needs `recursive`: without it nothing here
+     * deletes anything, so there is nothing to force. */
+    delete(path: string, options?: MediaFolderDeleteOptions): Promise<void>;
+}

package/dist/media/media-folders.d.ts

@@ -0,0 +1,22 @@
+import type { RequestOptions } from "../request-options.js";
+import type { Transport } from "../transport/transport.js";
+import type { MediaFolderDeleteOptions } from "./media-folder-delete.js";
+import type { MediaFolderMoveOptions } from "./media-folder-move.js";
+/** The media library's folder tree: `list`, `create`, `rename`/move,
+ * `delete`. A folder is an explicit record, so one can exist before
+ * anything is filed into it. */
+export declare class MediaFolders {
+    private readonly transport;
+    constructor(transport: Transport);
+    list(options?: RequestOptions): Promise<string[]>;
+    /** Answers the path the server settled on. */
+    create(path: string, options?: RequestOptions): Promise<string>;
+    rename(from: string, to: string, options?: MediaFolderMoveOptions): Promise<{
+        from: string;
+        to: string;
+    }>;
+    /** The folder path is carried as `?path=`, not a path segment — it
+     * contains "/". `force` needs `recursive`: without it nothing here
+     * deletes anything, so there is nothing to force. */
+    delete(path: string, options?: MediaFolderDeleteOptions): Promise<void>;
+}

package/dist/media/media-page-stream.d.cts

@@ -0,0 +1,10 @@
+import type { RequestOptions } from "../request-options.cjs";
+import type { MediaPage } from "./media-page.cjs";
+/** `Media.pages()`'s async-iterable: one whole `MediaPage` at a time,
+ * stopping once a page reports no more. */
+export declare class MediaPageStream implements AsyncIterable<MediaPage> {
+    private readonly first;
+    private readonly options;
+    constructor(first: () => Promise<MediaPage>, options?: RequestOptions);
+    [Symbol.asyncIterator](): AsyncIterator<MediaPage>;
+}

package/dist/media/media-page-stream.d.ts

@@ -0,0 +1,10 @@
+import type { RequestOptions } from "../request-options.js";
+import type { MediaPage } from "./media-page.js";
+/** `Media.pages()`'s async-iterable: one whole `MediaPage` at a time,
+ * stopping once a page reports no more. */
+export declare class MediaPageStream implements AsyncIterable<MediaPage> {
+    private readonly first;
+    private readonly options;
+    constructor(first: () => Promise<MediaPage>, options?: RequestOptions);
+    [Symbol.asyncIterator](): AsyncIterator<MediaPage>;
+}

package/dist/media/media-page.d.cts

@@ -0,0 +1,19 @@
+import { Page } from "../pagination/page.cjs";
+import { PageWindow } from "../pagination/page-window.cjs";
+import type { RequestOptions } from "../request-options.cjs";
+import type { Transport } from "../transport/transport.cjs";
+import type { TransportQueryValue } from "../transport/transport-request.cjs";
+import { MediaAsset } from "./media-asset.cjs";
+/** One page of `Media.list()`: rows named `files`. Navigates by the
+ * window the server ECHOED, never the one requested. */
+export declare class MediaPage extends Page<MediaAsset> {
+    private readonly transport;
+    private readonly wireQuery;
+    private constructor();
+    get files(): readonly MediaAsset[];
+    next(options?: RequestOptions): Promise<MediaPage | null>;
+    previous(options?: RequestOptions): Promise<MediaPage | null>;
+    /** `Media` builds `wireQuery` (already translated onto `q`/`ext`/etc.,
+     * without `limit`/`offset`) once; `next`/`previous` reuse it unchanged. */
+    static loadWindow(transport: Transport, wireQuery: Record<string, TransportQueryValue>, window: PageWindow, options?: RequestOptions): Promise<MediaPage>;
+}

package/dist/media/media-page.d.ts

@@ -0,0 +1,19 @@
+import { Page } from "../pagination/page.js";
+import { PageWindow } from "../pagination/page-window.js";
+import type { RequestOptions } from "../request-options.js";
+import type { Transport } from "../transport/transport.js";
+import type { TransportQueryValue } from "../transport/transport-request.js";
+import { MediaAsset } from "./media-asset.js";
+/** One page of `Media.list()`: rows named `files`. Navigates by the
+ * window the server ECHOED, never the one requested. */
+export declare class MediaPage extends Page<MediaAsset> {
+    private readonly transport;
+    private readonly wireQuery;
+    private constructor();
+    get files(): readonly MediaAsset[];
+    next(options?: RequestOptions): Promise<MediaPage | null>;
+    previous(options?: RequestOptions): Promise<MediaPage | null>;
+    /** `Media` builds `wireQuery` (already translated onto `q`/`ext`/etc.,
+     * without `limit`/`offset`) once; `next`/`previous` reuse it unchanged. */
+    static loadWindow(transport: Transport, wireQuery: Record<string, TransportQueryValue>, window: PageWindow, options?: RequestOptions): Promise<MediaPage>;
+}

package/dist/media/media-query.d.cts

@@ -0,0 +1,24 @@
+/**
+ * `Media.list()`'s search, in client-facing names. `Media` translates these
+ * onto the wire's `q`, `ext`, `modified_after` and `modified_before` — the
+ * same rule the response mapper follows, applied to a request instead.
+ */
+export interface MediaQuery {
+    /** Substring match on the filename; the wire's `q`. */
+    text?: string;
+    /** Exact folder, or every folder beneath it when `recursive` is set. */
+    folder?: string;
+    recursive?: boolean;
+    /** Substring match on the content type, e.g. "image/" or "pdf". */
+    type?: string;
+    /** Exact file extension, no dot; the wire's `ext`. */
+    extension?: string;
+    tag?: string;
+    /** Inclusive ISO-8601 bounds on `updated_at`. */
+    modifiedAfter?: string;
+    modifiedBefore?: string;
+    limit?: number;
+    offset?: number;
+    /** "-created_at" (default), "created_at", "filename", "-filename", "size", "-size". */
+    sort?: string;
+}

package/dist/media/media-query.d.ts

@@ -0,0 +1,24 @@
+/**
+ * `Media.list()`'s search, in client-facing names. `Media` translates these
+ * onto the wire's `q`, `ext`, `modified_after` and `modified_before` — the
+ * same rule the response mapper follows, applied to a request instead.
+ */
+export interface MediaQuery {
+    /** Substring match on the filename; the wire's `q`. */
+    text?: string;
+    /** Exact folder, or every folder beneath it when `recursive` is set. */
+    folder?: string;
+    recursive?: boolean;
+    /** Substring match on the content type, e.g. "image/" or "pdf". */
+    type?: string;
+    /** Exact file extension, no dot; the wire's `ext`. */
+    extension?: string;
+    tag?: string;
+    /** Inclusive ISO-8601 bounds on `updated_at`. */
+    modifiedAfter?: string;
+    modifiedBefore?: string;
+    limit?: number;
+    offset?: number;
+    /** "-created_at" (default), "created_at", "filename", "-filename", "size", "-size". */
+    sort?: string;
+}

package/dist/media/media-reference.d.cts

@@ -0,0 +1,18 @@
+/**
+ * The `silo://media/<id>` scheme an entry field holds to name a catalogued
+ * asset — the client-side counterpart to `@silo/shared`'s `MediaRef`, not
+ * imported here since this package ships zero runtime dependencies.
+ *
+ * Recognises only the canonical scheme form, deliberately narrower than the
+ * server's `MediaRef`: a client either builds a reference itself or reads one
+ * back verbatim, so accepting `asset.url` would let "I stored the wrong
+ * property" keep working until the first rename.
+ */
+export declare class MediaReference {
+    private static readonly Scheme;
+    /** Builds the reference to store in an entry field: `silo://media/<id>`. */
+    static of(id: string): string;
+    /** The asset id a `silo://media/` reference names, or `null` if `value`
+     * is not one. A trailing fragment, query or path segment is ignored. */
+    static idOf(value: unknown): string | null;
+}

package/dist/media/media-reference.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The `silo://media/<id>` scheme an entry field holds to name a catalogued
+ * asset — the client-side counterpart to `@silo/shared`'s `MediaRef`, not
+ * imported here since this package ships zero runtime dependencies.
+ *
+ * Recognises only the canonical scheme form, deliberately narrower than the
+ * server's `MediaRef`: a client either builds a reference itself or reads one
+ * back verbatim, so accepting `asset.url` would let "I stored the wrong
+ * property" keep working until the first rename.
+ */
+export declare class MediaReference {
+    private static readonly Scheme;
+    /** Builds the reference to store in an entry field: `silo://media/<id>`. */
+    static of(id: string): string;
+    /** The asset id a `silo://media/` reference names, or `null` if `value`
+     * is not one. A trailing fragment, query or path segment is ignored. */
+    static idOf(value: unknown): string | null;
+}

package/dist/media/media-stream.d.cts

@@ -0,0 +1,7 @@
+import { RowStream } from "../pagination/row-stream.cjs";
+import type { MediaAsset } from "./media-asset.cjs";
+/** `Media.all()`'s async-iterable: one `MediaAsset` at a time, paging by the
+ * window the server echoes. No behaviour of its own — the named type
+ * is what `Media.all()` answers. */
+export declare class MediaStream extends RowStream<MediaAsset> {
+}

package/dist/media/media-stream.d.ts

@@ -0,0 +1,7 @@
+import { RowStream } from "../pagination/row-stream.js";
+import type { MediaAsset } from "./media-asset.js";
+/** `Media.all()`'s async-iterable: one `MediaAsset` at a time, paging by the
+ * window the server echoes. No behaviour of its own — the named type
+ * is what `Media.all()` answers. */
+export declare class MediaStream extends RowStream<MediaAsset> {
+}

package/dist/media/media-upload.d.cts

@@ -0,0 +1,18 @@
+import type { RequestOptions } from "../request-options.cjs";
+/** The fully-described upload: everything about the file given explicitly,
+ *  including its name — the only form usable with raw bytes. */
+export interface MediaUploadBytes {
+    bytes: Uint8Array | ArrayBuffer | Blob;
+    filename: string;
+    contentType?: string;
+    folder?: string;
+}
+/** Where a `File`/`Blob` upload lands, and the filename to record when the
+ *  input carries none — a `File` already has `.name`; a bare `Blob` does not. */
+export interface MediaUploadFileOptions extends RequestOptions {
+    folder?: string;
+    filename?: string;
+}
+/** `Media.upload()`'s input: a fully-described upload, or a runtime
+ *  `File`/`Blob`, sent with the runtime's own `FormData` and `Blob`. */
+export type MediaUpload = MediaUploadBytes | File | Blob;

package/dist/media/media-upload.d.ts

@@ -0,0 +1,18 @@
+import type { RequestOptions } from "../request-options.js";
+/** The fully-described upload: everything about the file given explicitly,
+ *  including its name — the only form usable with raw bytes. */
+export interface MediaUploadBytes {
+    bytes: Uint8Array | ArrayBuffer | Blob;
+    filename: string;
+    contentType?: string;
+    folder?: string;
+}
+/** Where a `File`/`Blob` upload lands, and the filename to record when the
+ *  input carries none — a `File` already has `.name`; a bare `Blob` does not. */
+export interface MediaUploadFileOptions extends RequestOptions {
+    folder?: string;
+    filename?: string;
+}
+/** `Media.upload()`'s input: a fully-described upload, or a runtime
+ *  `File`/`Blob`, sent with the runtime's own `FormData` and `Blob`. */
+export type MediaUpload = MediaUploadBytes | File | Blob;