@ibanzajoe/uploader 0.3.0 → 1.2.1

package/dist/transform-ybCOCWBG.d.cts

@@ -1,225 +0,0 @@
-/**
- * SDK-level option and result types for UploaderClient.
- *
- * The upload-contract types below are VENDORED from @uploader/shared so that
- * @uploader/react is self-contained for consumers outside this monorepo — one
- * install, no @uploader/* or zod transitive deps. They mirror the API contract
- * exactly; `contract.conformance.ts` asserts at typecheck time that they stay
- * structurally identical to the shared definitions, failing the build on drift.
- */
-/** A stored file result returned by the upload API and SDK. Mirrors Filestack's FileResult. */
-type FileResult = {
-    handle: string;
-    url: string;
-    filename: string;
-    mimetype: string;
-    size: number;
-    status: 'Stored';
-    uploadId?: string;
-};
-/** Response from the picker overlay / upload batch. */
-type PickerResponse = {
-    filesUploaded: FileResult[];
-    filesFailed: FileResult[];
-};
-/** JSON payload that is base64-encoded and HMAC-signed as a security policy. */
-type PolicySpec = {
-    /** Unix epoch seconds when the policy expires. */
-    expiry: number;
-    /** Allowed API calls, e.g. ["store", "read", "remove"]. */
-    call: string[];
-    /** Restrict to a specific file handle (read/remove). */
-    handle?: string;
-    /** Maximum file size in bytes (store). */
-    maxSize?: number;
-    /** Minimum file size in bytes (store). */
-    minSize?: number;
-    /** Restrict store destination path prefix. */
-    path?: string;
-};
-/** Options passed to UploaderClient constructor. */
-type UploaderClientOptions = {
-    /** Public API key (pk_...). */
-    apikey: string;
-    /** Base URL of the upload API. Defaults to the hosted endpoint. */
-    apiUrl?: string;
-    /** Optional signed security policy. */
-    security?: {
-        policy: string;
-        signature: string;
-    };
-};
-/** Per-file upload options. */
-type UploadOptions = {
-    /** Progress callback, value 0–100. */
-    onProgress?: (percent: number) => void;
-    /** Storage path prefix. */
-    path?: string;
-    /** Override the file's stored name. */
-    filename?: string;
-    /** AbortSignal to cancel the upload. */
-    signal?: AbortSignal;
-    /**
-     * Chunk size in bytes for multipart uploads.
-     * Defaults to ~5 MB; files larger than this threshold use multipart.
-     */
-    chunkSize?: number;
-};
-/** Options for uploadAll — extends per-file options with concurrency control. */
-type UploadAllOptions = UploadOptions & {
-    /** Maximum concurrent uploads. Defaults to 3. */
-    concurrency?: number;
-};
-
-/**
- * UploaderClient — headless upload client.
- *
- * Chooses single-shot (POST /api/store, multipart/form-data) vs multipart
- * (start/part/complete) based on file size relative to MULTIPART_THRESHOLD
- * (5 MB). Parts are retried individually with exponential backoff. Progress
- * is emitted as a 0–100 integer. AbortSignal cancels in-flight work.
- */
-
-declare class UploaderClient {
-    #private;
-    readonly apikey: string;
-    readonly apiUrl: string;
-    readonly security: UploaderClientOptions['security'];
-    constructor(options: UploaderClientOptions);
-    /**
-     * Upload a single file.
-     *
-     * Automatically selects single-shot vs multipart upload based on file size.
-     * Emits progress via `opts.onProgress` (0–100). Respects `opts.signal` for
-     * cancellation. Retries network errors and 5xx responses up to 3 times with
-     * exponential backoff; 4xx errors are surfaced immediately.
-     *
-     * @throws {UploaderError} with code ABORTED | NETWORK_ERROR | SERVER_ERROR |
-     *   CLIENT_ERROR | INVALID_RESPONSE
-     */
-    upload(file: File | Blob, opts?: UploadOptions): Promise<FileResult>;
-    /**
-     * Upload multiple files with concurrency limiting.
-     *
-     * Resolves once all uploads settle (fulfilled or rejected). The returned
-     * array preserves input order. `opts.concurrency` caps simultaneous
-     * in-flight uploads (default 3). Each file shares the same opts
-     * (including onProgress — the callback fires per-file, not aggregate).
-     *
-     * @returns Array of PromiseSettledResult in input order.
-     */
-    uploadAll(files: Array<File | Blob>, opts?: UploadAllOptions): Promise<PromiseSettledResult<FileResult>[]>;
-}
-
-/**
- * Delivery / transform URL builder.
- *
- * The API serves transformed derivatives at `GET /<chain>/<handle>`, where
- * <chain> is a slash-joined list of ops (e.g. `resize=w:200,h:200,fit:crop`).
- * These op builders + `transformUrl()` construct that URL from an uploaded file
- * handle, so consumers render an image at any size/format/quality without
- * hand-assembling URL strings.
- *
- * The op/param types and serialization mirror @uploader/shared EXACTLY — the
- * API's `parseTransformChain` is the other half of this contract, and
- * `contract.conformance.ts` asserts at typecheck time that they stay in sync.
- */
-type TransformOpName = 'resize' | 'crop' | 'rotate' | 'flip' | 'flop' | 'quality' | 'output';
-/** Parameters for the resize operation. */
-type ResizeParams = {
-    w?: number;
-    h?: number;
-    fit?: 'cover' | 'contain' | 'fill' | 'inside' | 'outside' | 'crop';
-};
-/** Parameters for the crop operation. */
-type CropParams = {
-    /** "x,y,w,h" notation. */
-    dim: string;
-    x?: number;
-    y?: number;
-    w?: number;
-    h?: number;
-};
-/** Parameters for the rotate operation. */
-type RotateParams = {
-    deg: number;
-};
-/** Parameters for the quality operation. */
-type QualityParams = {
-    n: number;
-};
-/** Parameters for the output operation. */
-type OutputParams = {
-    format: string;
-};
-/** A single transform operation with its typed params. */
-type TransformOp = {
-    name: 'resize';
-    params: ResizeParams;
-} | {
-    name: 'crop';
-    params: CropParams;
-} | {
-    name: 'rotate';
-    params: RotateParams;
-} | {
-    name: 'flip';
-    params: Record<string, never>;
-} | {
-    name: 'flop';
-    params: Record<string, never>;
-} | {
-    name: 'quality';
-    params: QualityParams;
-} | {
-    name: 'output';
-    params: OutputParams;
-};
-/** An ordered list of transform operations. */
-type TransformChain = {
-    ops: TransformOp[];
-};
-/** Resize to a width and/or height with an optional fit mode. */
-declare const resize: (params: ResizeParams) => TransformOp;
-/** Crop a rectangular region: origin (x, y) and size w×h, in source pixels. */
-declare const crop: (rect: {
-    x: number;
-    y: number;
-    w: number;
-    h: number;
-}) => TransformOp;
-/** Rotate clockwise by `deg` degrees. */
-declare const rotate: (params: RotateParams) => TransformOp;
-/** Flip vertically (mirror top↔bottom). */
-declare const flip: () => TransformOp;
-/** Flop horizontally (mirror left↔right). */
-declare const flop: () => TransformOp;
-/** Set output quality 1–100 (ignored by lossless formats). */
-declare const quality: (params: QualityParams) => TransformOp;
-/** Convert the output format, e.g. `{ format: 'webp' }`. */
-declare const output: (params: OutputParams) => TransformOp;
-type TransformUrlOptions = {
-    /** File handle from an upload (`FileResult.handle`). */
-    handle: string;
-    /** Ordered transform ops to apply. Must contain at least one op. */
-    ops: TransformOp[];
-    /**
-     * Base API URL. Defaults to '' so the URL is relative — `/<chain>/<handle>` —
-     * and resolves same-origin (e.g. proxied to the API). Pass an absolute URL to
-     * point at a remote API directly.
-     */
-    apiUrl?: string;
-};
-/**
- * Build a delivery URL that applies `ops` to the file identified by `handle`.
- *
- * @example
- * transformUrl({
- *   handle: file.handle,
- *   ops: [resize({ w: 200, h: 200, fit: 'crop' }), output({ format: 'webp' })],
- * })
- * // => "/resize=w:200,h:200,fit:crop/output=format:webp/<handle>"
- */
-declare function transformUrl({ handle, ops, apiUrl }: TransformUrlOptions): string;
-
-export { type CropParams as C, type FileResult as F, type OutputParams as O, type PickerResponse as P, type QualityParams as Q, type ResizeParams as R, type TransformChain as T, type UploadAllOptions as U, type PolicySpec as a, type RotateParams as b, type TransformOp as c, type TransformOpName as d, type TransformUrlOptions as e, type UploadOptions as f, UploaderClient as g, type UploaderClientOptions as h, crop as i, flip as j, flop as k, rotate as l, output as o, quality as q, resize as r, transformUrl as t };

package/dist/transform-ybCOCWBG.d.ts

@@ -1,225 +0,0 @@
-/**
- * SDK-level option and result types for UploaderClient.
- *
- * The upload-contract types below are VENDORED from @uploader/shared so that
- * @uploader/react is self-contained for consumers outside this monorepo — one
- * install, no @uploader/* or zod transitive deps. They mirror the API contract
- * exactly; `contract.conformance.ts` asserts at typecheck time that they stay
- * structurally identical to the shared definitions, failing the build on drift.
- */
-/** A stored file result returned by the upload API and SDK. Mirrors Filestack's FileResult. */
-type FileResult = {
-    handle: string;
-    url: string;
-    filename: string;
-    mimetype: string;
-    size: number;
-    status: 'Stored';
-    uploadId?: string;
-};
-/** Response from the picker overlay / upload batch. */
-type PickerResponse = {
-    filesUploaded: FileResult[];
-    filesFailed: FileResult[];
-};
-/** JSON payload that is base64-encoded and HMAC-signed as a security policy. */
-type PolicySpec = {
-    /** Unix epoch seconds when the policy expires. */
-    expiry: number;
-    /** Allowed API calls, e.g. ["store", "read", "remove"]. */
-    call: string[];
-    /** Restrict to a specific file handle (read/remove). */
-    handle?: string;
-    /** Maximum file size in bytes (store). */
-    maxSize?: number;
-    /** Minimum file size in bytes (store). */
-    minSize?: number;
-    /** Restrict store destination path prefix. */
-    path?: string;
-};
-/** Options passed to UploaderClient constructor. */
-type UploaderClientOptions = {
-    /** Public API key (pk_...). */
-    apikey: string;
-    /** Base URL of the upload API. Defaults to the hosted endpoint. */
-    apiUrl?: string;
-    /** Optional signed security policy. */
-    security?: {
-        policy: string;
-        signature: string;
-    };
-};
-/** Per-file upload options. */
-type UploadOptions = {
-    /** Progress callback, value 0–100. */
-    onProgress?: (percent: number) => void;
-    /** Storage path prefix. */
-    path?: string;
-    /** Override the file's stored name. */
-    filename?: string;
-    /** AbortSignal to cancel the upload. */
-    signal?: AbortSignal;
-    /**
-     * Chunk size in bytes for multipart uploads.
-     * Defaults to ~5 MB; files larger than this threshold use multipart.
-     */
-    chunkSize?: number;
-};
-/** Options for uploadAll — extends per-file options with concurrency control. */
-type UploadAllOptions = UploadOptions & {
-    /** Maximum concurrent uploads. Defaults to 3. */
-    concurrency?: number;
-};
-
-/**
- * UploaderClient — headless upload client.
- *
- * Chooses single-shot (POST /api/store, multipart/form-data) vs multipart
- * (start/part/complete) based on file size relative to MULTIPART_THRESHOLD
- * (5 MB). Parts are retried individually with exponential backoff. Progress
- * is emitted as a 0–100 integer. AbortSignal cancels in-flight work.
- */
-
-declare class UploaderClient {
-    #private;
-    readonly apikey: string;
-    readonly apiUrl: string;
-    readonly security: UploaderClientOptions['security'];
-    constructor(options: UploaderClientOptions);
-    /**
-     * Upload a single file.
-     *
-     * Automatically selects single-shot vs multipart upload based on file size.
-     * Emits progress via `opts.onProgress` (0–100). Respects `opts.signal` for
-     * cancellation. Retries network errors and 5xx responses up to 3 times with
-     * exponential backoff; 4xx errors are surfaced immediately.
-     *
-     * @throws {UploaderError} with code ABORTED | NETWORK_ERROR | SERVER_ERROR |
-     *   CLIENT_ERROR | INVALID_RESPONSE
-     */
-    upload(file: File | Blob, opts?: UploadOptions): Promise<FileResult>;
-    /**
-     * Upload multiple files with concurrency limiting.
-     *
-     * Resolves once all uploads settle (fulfilled or rejected). The returned
-     * array preserves input order. `opts.concurrency` caps simultaneous
-     * in-flight uploads (default 3). Each file shares the same opts
-     * (including onProgress — the callback fires per-file, not aggregate).
-     *
-     * @returns Array of PromiseSettledResult in input order.
-     */
-    uploadAll(files: Array<File | Blob>, opts?: UploadAllOptions): Promise<PromiseSettledResult<FileResult>[]>;
-}
-
-/**
- * Delivery / transform URL builder.
- *
- * The API serves transformed derivatives at `GET /<chain>/<handle>`, where
- * <chain> is a slash-joined list of ops (e.g. `resize=w:200,h:200,fit:crop`).
- * These op builders + `transformUrl()` construct that URL from an uploaded file
- * handle, so consumers render an image at any size/format/quality without
- * hand-assembling URL strings.
- *
- * The op/param types and serialization mirror @uploader/shared EXACTLY — the
- * API's `parseTransformChain` is the other half of this contract, and
- * `contract.conformance.ts` asserts at typecheck time that they stay in sync.
- */
-type TransformOpName = 'resize' | 'crop' | 'rotate' | 'flip' | 'flop' | 'quality' | 'output';
-/** Parameters for the resize operation. */
-type ResizeParams = {
-    w?: number;
-    h?: number;
-    fit?: 'cover' | 'contain' | 'fill' | 'inside' | 'outside' | 'crop';
-};
-/** Parameters for the crop operation. */
-type CropParams = {
-    /** "x,y,w,h" notation. */
-    dim: string;
-    x?: number;
-    y?: number;
-    w?: number;
-    h?: number;
-};
-/** Parameters for the rotate operation. */
-type RotateParams = {
-    deg: number;
-};
-/** Parameters for the quality operation. */
-type QualityParams = {
-    n: number;
-};
-/** Parameters for the output operation. */
-type OutputParams = {
-    format: string;
-};
-/** A single transform operation with its typed params. */
-type TransformOp = {
-    name: 'resize';
-    params: ResizeParams;
-} | {
-    name: 'crop';
-    params: CropParams;
-} | {
-    name: 'rotate';
-    params: RotateParams;
-} | {
-    name: 'flip';
-    params: Record<string, never>;
-} | {
-    name: 'flop';
-    params: Record<string, never>;
-} | {
-    name: 'quality';
-    params: QualityParams;
-} | {
-    name: 'output';
-    params: OutputParams;
-};
-/** An ordered list of transform operations. */
-type TransformChain = {
-    ops: TransformOp[];
-};
-/** Resize to a width and/or height with an optional fit mode. */
-declare const resize: (params: ResizeParams) => TransformOp;
-/** Crop a rectangular region: origin (x, y) and size w×h, in source pixels. */
-declare const crop: (rect: {
-    x: number;
-    y: number;
-    w: number;
-    h: number;
-}) => TransformOp;
-/** Rotate clockwise by `deg` degrees. */
-declare const rotate: (params: RotateParams) => TransformOp;
-/** Flip vertically (mirror top↔bottom). */
-declare const flip: () => TransformOp;
-/** Flop horizontally (mirror left↔right). */
-declare const flop: () => TransformOp;
-/** Set output quality 1–100 (ignored by lossless formats). */
-declare const quality: (params: QualityParams) => TransformOp;
-/** Convert the output format, e.g. `{ format: 'webp' }`. */
-declare const output: (params: OutputParams) => TransformOp;
-type TransformUrlOptions = {
-    /** File handle from an upload (`FileResult.handle`). */
-    handle: string;
-    /** Ordered transform ops to apply. Must contain at least one op. */
-    ops: TransformOp[];
-    /**
-     * Base API URL. Defaults to '' so the URL is relative — `/<chain>/<handle>` —
-     * and resolves same-origin (e.g. proxied to the API). Pass an absolute URL to
-     * point at a remote API directly.
-     */
-    apiUrl?: string;
-};
-/**
- * Build a delivery URL that applies `ops` to the file identified by `handle`.
- *
- * @example
- * transformUrl({
- *   handle: file.handle,
- *   ops: [resize({ w: 200, h: 200, fit: 'crop' }), output({ format: 'webp' })],
- * })
- * // => "/resize=w:200,h:200,fit:crop/output=format:webp/<handle>"
- */
-declare function transformUrl({ handle, ops, apiUrl }: TransformUrlOptions): string;
-
-export { type CropParams as C, type FileResult as F, type OutputParams as O, type PickerResponse as P, type QualityParams as Q, type ResizeParams as R, type TransformChain as T, type UploadAllOptions as U, type PolicySpec as a, type RotateParams as b, type TransformOp as c, type TransformOpName as d, type TransformUrlOptions as e, type UploadOptions as f, UploaderClient as g, type UploaderClientOptions as h, crop as i, flip as j, flop as k, rotate as l, output as o, quality as q, resize as r, transformUrl as t };