@valentinkolb/filegate 2.4.0 → 2.5.3

package/dist/uploads.d.ts

@@ -0,0 +1,246 @@
+import { ClientCore, type FetchImpl } from "./core.js";
+import type { DirectUploadURLRequest, DirectUploadURLResponse, Node, UploadSegmentResponse, UploadSessionBatchCreateRequest, UploadSessionBatchCreateResponse, UploadSessionCommitResponse, UploadSessionCreateRequest, UploadSessionDirect, UploadSessionResponse } from "./types.js";
+export interface UploadSessionStatusRequest {
+    sessionId: string;
+}
+export interface UploadSessionPutSegmentRequest {
+    sessionId: string;
+    index: number;
+    body: BodyInit;
+    checksum?: string;
+    contentType?: string;
+}
+export interface UploadSessionCommitRequest {
+    sessionId: string;
+}
+export interface UploadSessionAbortRequest {
+    sessionId: string;
+}
+export declare class UploadSessionsClient {
+    private readonly core;
+    readonly segments: {
+        readonly put: (req: UploadSessionPutSegmentRequest) => Promise<UploadSegmentResponse>;
+        readonly putRaw: (req: UploadSessionPutSegmentRequest) => Promise<Response>;
+    };
+    constructor(core: ClientCore);
+    /** Create one resumable upload session for one file. */
+    create(req: UploadSessionCreateRequest): Promise<UploadSessionResponse>;
+    /** Create independent upload sessions in one request. */
+    createBatch(req: UploadSessionBatchCreateRequest): Promise<UploadSessionBatchCreateResponse>;
+    /** Get current session status. */
+    status(req: UploadSessionStatusRequest): Promise<UploadSessionResponse>;
+    /** Upload one segment and throw on non-2xx responses. */
+    private putSegment;
+    /** Upload one segment and return the raw Response for relay/proxy handlers. */
+    private putSegmentRaw;
+    /** Commit a complete session and return the created/updated node. */
+    commit(req: UploadSessionCommitRequest): Promise<UploadSessionCommitResponse>;
+    /** Abort an in-progress session. */
+    abort(req: UploadSessionAbortRequest): Promise<void>;
+}
+export declare class UploadsClient {
+    private readonly core;
+    readonly sessions: UploadSessionsClient;
+    constructor(core: ClientCore);
+    /** Mint a short-lived direct PUT URL for a browser/client upload. */
+    createDirectUploadURL(req: DirectUploadURLRequest): Promise<DirectUploadURLResponse>;
+}
+export interface DirectUploadResult {
+    node: Node;
+    nodeId: string;
+    createdId: string;
+    statusCode: number;
+    headers: Headers;
+}
+export type DirectUploadFinish = {
+    ok: true;
+    result: DirectUploadResult;
+} | {
+    ok: false;
+    error: unknown;
+};
+export interface DirectUploadOptions {
+    fetchImpl?: FetchImpl;
+    contentType?: string;
+    signal?: AbortSignal;
+    onSuccess?: (result: DirectUploadResult) => void | Promise<void>;
+    onError?: (error: unknown) => void | Promise<void>;
+    onFinish?: (outcome: DirectUploadFinish) => void | Promise<void>;
+}
+export interface DirectUploadSessionRequest {
+    direct: UploadSessionDirect;
+}
+export interface DirectUploadSegmentRequest extends DirectUploadSessionRequest {
+    index: number;
+    body: BodyInit;
+    checksum?: string;
+    contentType?: string;
+    fetchImpl?: FetchImpl;
+    signal?: AbortSignal;
+}
+declare function putDirectSegment(req: DirectUploadSegmentRequest): Promise<UploadSegmentResponse>;
+declare function status(req: DirectUploadSessionRequest & {
+    fetchImpl?: FetchImpl;
+    signal?: AbortSignal;
+}): Promise<UploadSessionResponse>;
+declare function commit(req: DirectUploadSessionRequest & {
+    fetchImpl?: FetchImpl;
+    signal?: AbortSignal;
+}): Promise<UploadSessionCommitResponse>;
+declare function abort(req: DirectUploadSessionRequest & {
+    fetchImpl?: FetchImpl;
+    signal?: AbortSignal;
+}): Promise<void>;
+export declare const directUploads: {
+    readonly segments: {
+        readonly put: typeof putDirectSegment;
+    };
+    readonly status: typeof status;
+    readonly commit: typeof commit;
+    readonly abort: typeof abort;
+};
+export interface BrowserUploadFile {
+    name: string;
+    size: number;
+    type?: string;
+    webkitRelativePath?: string;
+    slice(start?: number, end?: number): Blob;
+}
+export interface BrowserUploadSegment {
+    index: number;
+    offset: number;
+    size: number;
+    checksum: string;
+}
+export interface BrowserUploadAllowItem {
+    id: string;
+    kind: "direct" | "session";
+    path: string;
+    name: string;
+    size: number;
+    checksum?: string;
+    segmentSize?: number;
+    contentType?: string;
+    segments?: BrowserUploadSegment[];
+}
+export type BrowserUploadDirective = {
+    kind: "direct";
+    direct: DirectUploadURLResponse;
+} | {
+    kind: "session";
+    session: UploadSessionResponse;
+};
+export type BrowserUploadConflictMode = "skip-existing" | "skip-identical" | "error" | "overwrite" | "rename";
+export type BrowserUploadAllowResult = {
+    id: string;
+    ok: true;
+    upload?: BrowserUploadDirective;
+    session?: UploadSessionResponse;
+    node?: Node;
+} | {
+    id: string;
+    ok: false;
+    error: string;
+    code?: string;
+    skipped?: boolean;
+    node?: Node;
+};
+export interface BrowserUploadAllowRequest {
+    uploads: BrowserUploadAllowItem[];
+    onConflict: BrowserUploadConflictMode;
+}
+export interface BrowserUploadAllowResponse {
+    uploads: BrowserUploadAllowResult[];
+}
+export interface BrowserUploadConfig {
+    segmentSize?: number;
+    chunkSize?: number;
+    directThresholdBytes?: number;
+    onConflict?: BrowserUploadConflictMode;
+    concurrency?: {
+        hash?: number;
+        files?: number;
+        segments?: number;
+    };
+    batch?: {
+        size: number;
+        flushMs: number;
+    };
+}
+export type BrowserUploadEvent = {
+    type: "start";
+    files: number;
+    bytes: number;
+} | {
+    type: "file:hashing";
+    id: string;
+    path: string;
+    loaded: number;
+    total: number;
+} | {
+    type: "file:allowed";
+    id: string;
+    path: string;
+} | {
+    type: "file:skipped";
+    id: string;
+    path: string;
+    reason: string;
+    code?: string;
+    node?: Node;
+} | {
+    type: "file:rejected";
+    id: string;
+    path: string;
+    error: string;
+    code?: string;
+} | {
+    type: "file:uploading";
+    id: string;
+    path: string;
+    loaded: number;
+    total: number;
+} | {
+    type: "file:committing";
+    id: string;
+    path: string;
+} | {
+    type: "file:done";
+    id: string;
+    path: string;
+    node?: Node;
+} | {
+    type: "file:error";
+    id: string;
+    path: string;
+    error: unknown;
+} | {
+    type: "stats";
+    transferred: number;
+    total: number;
+    elapsedMs: number;
+    bytesPerSecond: number;
+    remainingMs?: number;
+};
+export interface BrowserUploadRequest {
+    files: Iterable<BrowserUploadFile>;
+    path: string;
+    allow(req: BrowserUploadAllowRequest): Promise<BrowserUploadAllowResponse>;
+    config?: BrowserUploadConfig;
+    fetchImpl?: FetchImpl;
+    signal?: AbortSignal;
+    onEvent?: (event: BrowserUploadEvent) => void;
+}
+export interface BrowserUploadResult {
+    total: number;
+    done: number;
+    failed: number;
+    rejected: number;
+    skipped: number;
+}
+/** Upload browser files through Filegate direct upload sessions. */
+export declare function upload(req: BrowserUploadRequest): Promise<BrowserUploadResult>;
+/** Upload to a presigned Filegate direct-upload URL without a REST bearer token. */
+export declare function uploadDirect(uploadUrl: string, data: BodyInit, opts?: DirectUploadOptions): Promise<DirectUploadResult>;
+export {};
+//# sourceMappingURL=uploads.d.ts.map

package/dist/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["../src/uploads.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,SAAS,EAAE,MAAM,WAAW,CAAC;AAEvD,OAAO,KAAK,EACV,sBAAsB,EACtB,uBAAuB,EACvB,IAAI,EACJ,qBAAqB,EACrB,+BAA+B,EAC/B,gCAAgC,EAChC,2BAA2B,EAC3B,0BAA0B,EAC1B,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,YAAY,CAAC;AAEpB,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,8BAA8B;IAC7C,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,QAAQ,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,qBAAa,oBAAoB;IAQnB,OAAO,CAAC,QAAQ,CAAC,IAAI;IAPjC,QAAQ,CAAC,QAAQ;4BACJ,8BAA8B,KAAG,OAAO,CAAC,qBAAqB,CAAC;+BAE5D,8BAA8B,KAAG,OAAO,CAAC,QAAQ,CAAC;MAEvD;gBAEkB,IAAI,EAAE,UAAU;IAE7C,wDAAwD;IAClD,MAAM,CAAC,GAAG,EAAE,0BAA0B,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAU7E,yDAAyD;IACnD,WAAW,CAAC,GAAG,EAAE,+BAA+B,GAAG,OAAO,CAAC,gCAAgC,CAAC;IAUlG,kCAAkC;IAC5B,MAAM,CAAC,GAAG,EAAE,0BAA0B,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAQ7E,yDAAyD;YAC3C,UAAU;IAOxB,+EAA+E;YACjE,aAAa;IAU3B,qEAAqE;IAC/D,MAAM,CAAC,GAAG,EAAE,0BAA0B,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAQnF,oCAAoC;IAC9B,KAAK,CAAC,GAAG,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;CAK3D;AAED,qBAAa,aAAa;IAGZ,OAAO,CAAC,QAAQ,CAAC,IAAI;IAFjC,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,CAAC;gBAEX,IAAI,EAAE,UAAU;IAI7C,qEAAqE;IAC/D,qBAAqB,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAS3F;AAQD,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,IAAI,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,kBAAkB,GAC1B;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,kBAAkB,CAAA;CAAE,GACxC;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAC;AAElC,MAAM,WAAW,mBAAmB;IAClC,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClE;AAED,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,mBAAmB,CAAC;CAC7B;AAED,MAAM,WAAW,0BAA2B,SAAQ,0BAA0B;IAC5E,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,QAAQ,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AA0BD,iBAAe,gBAAgB,CAAC,GAAG,EAAE,0BAA0B,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAiB/F;AAED,iBAAe,MAAM,CAAC,GAAG,EAAE,0BAA0B,GAAG;IAAE,SAAS,CAAC,EAAE,SAAS,CAAC;IAAC,MAAM,CAAC,EAAE,WAAW,CAAA;CAAE,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAEvI;AAED,iBAAe,MAAM,CAAC,GAAG,EAAE,0BAA0B,GAAG;IAAE,SAAS,CAAC,EAAE,SAAS,CAAC;IAAC,MAAM,CAAC,EAAE,WAAW,CAAA;CAAE,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAE7I;AAED,iBAAe,KAAK,CAAC,GAAG,EAAE,0BAA0B,GAAG;IAAE,SAAS,CAAC,EAAE,SAAS,CAAC;IAAC,MAAM,CAAC,EAAE,WAAW,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAErH;AAED,eAAO,MAAM,aAAa;;;;;;;CAKhB,CAAC;AAEX,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3C;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,oBAAoB,EAAE,CAAC;CACnC;AAED,MAAM,MAAM,sBAAsB,GAC9B;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,uBAAuB,CAAA;CAAE,GACnD;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,OAAO,EAAE,qBAAqB,CAAA;CAAE,CAAC;AAExD,MAAM,MAAM,yBAAyB,GAAG,eAAe,GAAG,gBAAgB,GAAG,OAAO,GAAG,WAAW,GAAG,QAAQ,CAAC;AAE9G,MAAM,MAAM,wBAAwB,GAChC;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,IAAI,CAAC;IAAC,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC;IAAC,IAAI,CAAC,EAAE,IAAI,CAAA;CAAE,GACvG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,IAAI,CAAA;CAAE,CAAC;AAE5F,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,sBAAsB,EAAE,CAAC;IAClC,UAAU,EAAE,yBAAyB,CAAC;CACvC;AAED,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,wBAAwB,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,UAAU,CAAC,EAAE,yBAAyB,CAAC;IACvC,WAAW,CAAC,EAAE;QACZ,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED,MAAM,MAAM,kBAAkB,GAC1B;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC/C;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACjF;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAClD;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,IAAI,CAAA;CAAE,GAC9F;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GACjF;IAAE,IAAI,EAAE,gBAAgB,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACnF;IAAE,IAAI,EAAE,iBAAiB,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACrD;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,IAAI,CAAA;CAAE,GAC5D;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,GAChE;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,WAAW,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,cAAc,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE3H,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,QAAQ,CAAC,iBAAiB,CAAC,CAAC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,GAAG,EAAE,yBAAyB,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;IAC3E,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAC7B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,kBAAkB,KAAK,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAgCD,oEAAoE;AACpE,wBAAsB,MAAM,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAyLpF;AA0ND,oFAAoF;AACpF,wBAAsB,YAAY,CAChC,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,QAAQ,EACd,IAAI,CAAC,EAAE,mBAAmB,GACzB,OAAO,CAAC,kBAAkB,CAAC,CAwC7B"}