@zuzjs/flare 0.2.16 → 0.2.18

package/dist/{index-BAvE1URE.d.ts → index-Y0Mq_6P9.d.ts}

@@ -62,6 +62,39 @@ interface FlareConfig {
      * - join aliases (`join(..., { as: "team" })` => "team")
      */
     dataMapper?: DataMapperRegistry;
+    /**
+     * Optional storage auto-provisioning config for bucket/server defaults.
+     */
+    storage?: boolean | FlareStorageAutoConfig;
+}
+/**
+ * Options for storage auto-provisioning via `storage` in `FlareConfig`.
+ */
+interface FlareStorageAutoConfig {
+    /** Human-readable label for the auto-provisioned server. Defaults to `"default"`. */
+    name?: string;
+    /**
+     * Bucket name. Defaults to `"<appId>-storage"`.
+     * Must be unique per app per backend kind (embedded vs S3).
+     */
+    bucket?: string;
+    /** Optional key prefix applied to all objects inside the bucket. */
+    prefix?: string;
+    /**
+     * Built-in transfer manager settings.
+     *
+     * By default uploads/downloads are queued with concurrency 1 each so
+     * calling putObject/getObject without await remains safe.
+     */
+    transferManager?: FlareStorageTransferManagerConfig;
+}
+interface FlareStorageTransferManagerConfig {
+    /** Enable built-in storage transfer queue. Defaults to true. */
+    enabled?: boolean;
+    /** Max concurrent uploads (putObject). Defaults to 1. */
+    uploadConcurrency?: number;
+    /** Max concurrent downloads (getObject). Defaults to 1. */
+    downloadConcurrency?: number;
 }
 type DataMapperFn<TRow = any, TMapped = any> = (row: TRow) => TMapped;
 type DataMapperRegistry = Record<string, DataMapperFn<any, any>>;
@@ -169,6 +202,327 @@ interface PushSendResult {
     invalidatedTokenCount: number;
     dryRun: boolean;
 }
+interface FlareStorageServer {
+    id: string;
+    name: string;
+    kind: string;
+    endpoint: string;
+    bucket: string;
+    region: string;
+    prefix?: string;
+    dataDir?: string;
+    forcePathStyle?: boolean;
+    frozen?: boolean;
+    readOnly?: boolean;
+    createdAt?: unknown;
+    updatedAt?: unknown;
+}
+interface FlareStorageServerInput {
+    name: string;
+    kind?: string;
+    endpoint?: string;
+    bucket: string;
+    region?: string;
+    accessKey?: string;
+    secretKey?: string;
+    prefix?: string;
+    dataDir?: string;
+    forcePathStyle?: boolean;
+    frozen?: boolean;
+    readOnly?: boolean;
+}
+interface FlareStorageServerPatchInput {
+    name?: string;
+    endpoint?: string;
+    bucket?: string;
+    region?: string;
+    accessKey?: string;
+    secretKey?: string;
+    prefix?: string;
+    dataDir?: string;
+    forcePathStyle?: boolean;
+    frozen?: boolean;
+    readOnly?: boolean;
+}
+interface FlareStorageUploadInput {
+    serverId: string;
+    path: string;
+    contentBase64: string;
+    contentType?: string;
+    encrypt?: boolean;
+}
+interface FlareStorageDownloadInput {
+    serverId: string;
+    path: string;
+    decrypt?: boolean;
+}
+interface FlareStorageDeleteInput {
+    serverId: string;
+    path: string;
+}
+interface FlareStorageObjectResult {
+    ok: boolean;
+    path: string;
+    key: string;
+    encrypted?: boolean;
+    size?: number;
+    contentBase64?: string;
+    contentType?: string;
+}
+declare enum FlareStorageSignedAction {
+    Upload = "upload",
+    Download = "download",
+    Delete = "delete",
+    Edit = "edit"
+}
+interface FlareStorageSignedUrlInput {
+    serverId: string;
+    path: string;
+    action: FlareStorageSignedAction;
+    expiresInSeconds?: number;
+    sizeBytes?: number;
+    contentType?: string;
+    encrypt?: boolean;
+    decrypt?: boolean;
+    forceDownload?: boolean;
+    allowedOrigins?: string[];
+    embedOnly?: boolean;
+}
+interface FlareStorageSignedUrlResult {
+    ok: boolean;
+    action: FlareStorageSignedAction;
+    method: "PUT" | "PATCH" | "GET" | "DELETE";
+    token: string;
+    urlPath: string;
+    url: string;
+    expiresInSeconds?: number;
+    expiresAt: number;
+    forceDownload?: boolean;
+    allowedOrigins?: string[];
+    embedOnly?: boolean;
+}
+interface FlareStorageAwsConfig {
+    kind: string;
+    endpoint: string;
+    region: string;
+    bucket: string;
+    prefix?: string;
+    dataDir?: string;
+    forcePathStyle?: boolean;
+    accessKeyId: string;
+    secretAccessKey: string;
+}
+interface FlareStorageRulesPolicy {
+    maxEntries?: number;
+    maxAgeDays?: number;
+}
+interface FlareStorageRulesHistoryResult {
+    history: unknown[];
+    policy: FlareStorageRulesPolicy;
+    restoreEvents: unknown[];
+}
+/** Upload progress snapshot. */
+interface StorageProgress {
+    /** Bytes sent so far. */
+    loaded: number;
+    /** Total bytes to send. */
+    total: number;
+    /** 0–100. */
+    percent: number;
+}
+/** A bucket (backed by a flare storage server). */
+interface StorageBucket {
+    /** Internal flare server ID. */
+    id: string;
+    /** Human-readable label. */
+    name: string;
+    /** Bucket name used on the backend (s3 bucket / embedded dir name). */
+    bucket: string;
+    /** Backend kind: "embedded" | "s3" | "managed". */
+    kind: string;
+    region?: string;
+    endpoint?: string;
+    prefix?: string;
+    frozen?: boolean;
+    readOnly?: boolean;
+    createdAt?: unknown;
+    updatedAt?: unknown;
+}
+/** Options for createBucket(). */
+interface StorageBucketInput {
+    /**
+     * Backend kind. Defaults to "managed".
+     * "managed" lets flare-node choose embedded or s3-proxy based on server config.
+     */
+    kind?: string;
+    prefix?: string;
+    region?: string;
+    /** Advanced: explicit s3 endpoint (only needed for kind="s3"). */
+    endpoint?: string;
+    accessKey?: string;
+    secretKey?: string;
+    dataDir?: string;
+    forcePathStyle?: boolean;
+}
+/** Object metadata without content. */
+interface StorageObjectMeta {
+    key: string;
+    bucket: string;
+    size: number;
+    contentType: string;
+    encrypted: boolean;
+    createdAt?: unknown;
+    updatedAt?: unknown;
+}
+/** Upload an object to a bucket. */
+interface PutObjectInput {
+    bucket: string;
+    /** Object key (path inside the bucket). */
+    key: string;
+    /**
+     * Object body. Accepted forms:
+     * - `string` — UTF-8 text
+     * - `Uint8Array` / `ArrayBuffer` — raw bytes
+     * - `Blob` — browser File / Blob
+     * - `contentBase64` field on the object — pre-encoded base64 string
+     */
+    body?: string | Uint8Array | ArrayBuffer | Blob;
+    /** Pre-encoded base64 body. Mutually exclusive with `body`. */
+    contentBase64?: string;
+    /**
+     * Prefer legacy base64 upload path.
+     *
+     * Default is `false` (raw signed URL upload).
+     * If true and payload size exceeds `base64MaxBytes`, SDK auto-falls back to raw upload.
+     */
+    base64?: boolean;
+    /**
+     * Max payload bytes allowed for base64 path before auto-fallback to raw upload.
+     * Default: 4 MiB.
+     */
+    base64MaxBytes?: number;
+    contentType?: string;
+    /** Encrypt at rest with AES-256-GCM. Defaults to true. */
+    encrypt?: boolean;
+    /** Upload progress callback. Only fires in browser environments. */
+    onProgress?: (progress: StorageProgress) => void;
+}
+interface PutObjectResult {
+    ok: boolean;
+    bucket: string;
+    key: string;
+    size: number;
+    encrypted: boolean;
+}
+interface GetObjectInput {
+    bucket: string;
+    key: string;
+    /** Decrypt on download. Defaults to true. */
+    decrypt?: boolean;
+}
+interface GetObjectResult {
+    ok: boolean;
+    bucket: string;
+    key: string;
+    /** Base64-encoded content. */
+    contentBase64: string;
+    contentType: string;
+    size: number;
+    encrypted: boolean;
+}
+interface GetObjectUrlInput {
+    bucket: string;
+    key: string;
+    /** Decrypt on download. Defaults to true. */
+    decrypt?: boolean;
+    /** Signed URL ttl in seconds. Defaults to server policy. */
+    expiresInSeconds?: number;
+    /** Force attachment response for browser-displayable media. */
+    forceDownload?: boolean;
+    /** Allowed request origins for accessing the signed file. Defaults to ["*"]. */
+    allowedOrigins?: string[];
+    /** Restrict access to embedded media contexts (<img>, <video>, <audio>). */
+    embedOnly?: boolean;
+}
+interface DownloadObjectInput extends GetObjectUrlInput {
+    /** Suggested filename for browser downloads. Defaults to key basename. */
+    filename?: string;
+    /** Open in a new tab instead of forcing attachment download. */
+    openInNewTab?: boolean;
+}
+interface DownloadObjectResult {
+    ok: boolean;
+    url: string;
+    filename: string;
+    /** True when browser click dispatch occurred. */
+    triggered: boolean;
+}
+interface HeadObjectInput {
+    bucket: string;
+    key: string;
+}
+interface HeadObjectsInput {
+    bucket: string;
+    keys: string[];
+}
+interface ListObjectsInput {
+    bucket: string;
+    /** Key prefix filter. */
+    prefix?: string;
+    limit?: number;
+    /** Continuation token from a previous ListObjectsResult. */
+    cursor?: string;
+}
+interface ListObjectsResult {
+    bucket: string;
+    objects: StorageObjectMeta[];
+    count: number;
+    hasMore: boolean;
+    /** Pass to the next listObjects() call to get the next page. */
+    cursor?: string;
+}
+interface CopyObjectInput {
+    sourceBucket: string;
+    sourceKey: string;
+    destBucket: string;
+    destKey: string;
+}
+interface DeleteObjectInput {
+    bucket: string;
+    key: string;
+}
+interface DeleteObjectsInput {
+    bucket: string;
+    keys: string[];
+}
+/** Signed URL input using bucket/key names instead of serverId. */
+interface StorageSignedUrlInput {
+    bucket: string;
+    key: string;
+    action: FlareStorageSignedAction;
+    expiresInSeconds?: number;
+    sizeBytes?: number;
+    contentType?: string;
+    encrypt?: boolean;
+    decrypt?: boolean;
+    forceDownload?: boolean;
+    allowedOrigins?: string[];
+    embedOnly?: boolean;
+}
+/** Bucket-level security rules. Maps to flare storage rules DSL. */
+interface BucketPolicyInput {
+    rulesDsl?: string;
+    rules?: Record<string, unknown>;
+    rulesHistoryPolicy?: FlareStorageRulesPolicy;
+}
+/** CORS rule for a bucket. */
+interface BucketCorsRule {
+    allowedOrigins: string[];
+    allowedMethods: ("GET" | "PUT" | "POST" | "DELETE" | "HEAD")[];
+    allowedHeaders?: string[];
+    exposeHeaders?: string[];
+    maxAgeSeconds?: number;
+}
 interface SendEmailInput {
     to: string | string[];
     tag: string;
@@ -508,4 +862,4 @@ type SecurityRulesMap = Record<string, SecurityRuleEntry>;
 declare const flareRulesToSecurityMap: (rules: FlareRule[]) => SecurityRulesMap;
 declare const securityMapToFlareRules: (rules: SecurityRulesMap) => FlareRule[];
 
-export { type QueryPresetMap as $, type AggregateFunction as A, type BrowserPushRegistrationOptions as B, type ChangeEvent as C, type DataMapperFn as D, type EmailLinkVerifyResult as E, type FlareConfig as F, type FlareAuthHydrationOptions as G, type FlareAuthProviderId as H, type FlareAuthProviderPublicConfig as I, type FlareAuthSession as J, type FlareAuthUser as K, type FlareRule as L, type GroupByClause as M, type HavingClause as N, type JoinClause as O, type JoinQueryPattern as P, type NestedJoinClause as Q, type OfflineOperation as R, type OrFilter as S, type OrderByClause as T, type PresenceCallback as U, type PresenceJoinCallback as V, type PresenceLeaveCallback as W, type PresenceMember as X, type PushSendResult as Y, type QueryConfig as Z, type QueryOperator as _, type AggregateSpec as a, type QueryPresetParams as a0, type QueryPresetRow as a1, type QueryPresetSpec as a2, type QuerySnapshot as a3, type RegisterPushTokenInput as a4, type RulePermission as a5, type SecurityRuleEntry as a6, type SecurityRulesMap as a7, type SendEmailInput as a8, type SendPushNotificationInput as a9, type SnapshotEvent as aa, type StreamFlushReason as ab, type StructuredJoinClause as ac, type StructuredQuery as ad, type SubscribeOptions as ae, type SubscriptionCallback as af, type SubscriptionData as ag, type SubscriptionError as ah, type SubscriptionErrorCallback as ai, type SubscriptionHandle as aj, type VectorFieldConfig as ak, type VectorSearchClause as al, type VerifyEmailLinkInput as am, type WhereCondition as an, flareRulesToSecurityMap as ao, securityMapToFlareRules as ap, type AndFilter as b, type AnyFilter as c, type AuthConfigListener as d, type AuthResult as e, type AuthStateListener as f, type AuthWithPendingVerificationResult as g, type AuthWithTokenResult as h, type BrowserPushTokenOptions as i, type ChangeOperation as j, type CollectionExternalStore as k, type CollectionStream as l, type CollectionStreamListener as m, type CollectionStreamMeta as n, type CollectionStreamOptions as o, type ConnectionState as p, type CursorValue as q, type DataMapperRegistry as r, type DocAddedCallback as s, type DocChangedCallback as t, type DocDeletedCallback as u, type DocUpdatedCallback as v, type DocumentSnapshot as w, type EmailSendResult as x, type FlareAuthConfig as y, type FlareAuthHydrationInput as z };
+export { type FlareStorageServerInput as $, type AggregateFunction as A, type BrowserPushRegistrationOptions as B, type ChangeEvent as C, type DataMapperFn as D, type DocUpdatedCallback as E, type FlareConfig as F, type DocumentSnapshot as G, type DownloadObjectInput as H, type DownloadObjectResult as I, type EmailLinkVerifyResult as J, type EmailSendResult as K, type FlareAuthConfig as L, type FlareAuthHydrationInput as M, type FlareAuthHydrationOptions as N, type FlareAuthProviderId as O, type FlareAuthProviderPublicConfig as P, type FlareAuthSession as Q, type FlareAuthUser as R, type FlareRule as S, type FlareStorageAutoConfig as T, type FlareStorageAwsConfig as U, type FlareStorageDeleteInput as V, type FlareStorageDownloadInput as W, type FlareStorageObjectResult as X, type FlareStorageRulesHistoryResult as Y, type FlareStorageRulesPolicy as Z, type FlareStorageServer as _, type AggregateSpec as a, type FlareStorageServerPatchInput as a0, FlareStorageSignedAction as a1, type FlareStorageSignedUrlInput as a2, type FlareStorageSignedUrlResult as a3, type FlareStorageTransferManagerConfig as a4, type FlareStorageUploadInput as a5, type GetObjectInput as a6, type GetObjectResult as a7, type GetObjectUrlInput as a8, type GroupByClause as a9, type RulePermission as aA, type SecurityRuleEntry as aB, type SecurityRulesMap as aC, type SendEmailInput as aD, type SendPushNotificationInput as aE, type SnapshotEvent as aF, type StorageBucket as aG, type StorageBucketInput as aH, type StorageObjectMeta as aI, type StorageProgress as aJ, type StorageSignedUrlInput as aK, type StreamFlushReason as aL, type StructuredJoinClause as aM, type StructuredQuery as aN, type SubscribeOptions as aO, type SubscriptionCallback as aP, type SubscriptionData as aQ, type SubscriptionError as aR, type SubscriptionErrorCallback as aS, type SubscriptionHandle as aT, type VectorFieldConfig as aU, type VectorSearchClause as aV, type VerifyEmailLinkInput as aW, type WhereCondition as aX, flareRulesToSecurityMap as aY, securityMapToFlareRules as aZ, type HavingClause as aa, type HeadObjectInput as ab, type HeadObjectsInput as ac, type JoinClause as ad, type JoinQueryPattern as ae, type ListObjectsInput as af, type ListObjectsResult as ag, type NestedJoinClause as ah, type OfflineOperation as ai, type OrFilter as aj, type OrderByClause as ak, type PresenceCallback as al, type PresenceJoinCallback as am, type PresenceLeaveCallback as an, type PresenceMember as ao, type PushSendResult as ap, type PutObjectInput as aq, type PutObjectResult as ar, type QueryConfig as as, type QueryOperator as at, type QueryPresetMap as au, type QueryPresetParams as av, type QueryPresetRow as aw, type QueryPresetSpec as ax, type QuerySnapshot as ay, type RegisterPushTokenInput as az, type AndFilter as b, type AnyFilter as c, type AuthConfigListener as d, type AuthResult as e, type AuthStateListener as f, type AuthWithPendingVerificationResult as g, type AuthWithTokenResult as h, type BrowserPushTokenOptions as i, type BucketCorsRule as j, type BucketPolicyInput as k, type ChangeOperation as l, type CollectionExternalStore as m, type CollectionStream as n, type CollectionStreamListener as o, type CollectionStreamMeta as p, type CollectionStreamOptions as q, type ConnectionState as r, type CopyObjectInput as s, type CursorValue as t, type DataMapperRegistry as u, type DeleteObjectInput as v, type DeleteObjectsInput as w, type DocAddedCallback as x, type DocChangedCallback as y, type DocDeletedCallback as z };