@zuzjs/flare 0.2.25 → 0.2.27

package/README.md

@@ -473,6 +473,98 @@ export function RoomMessages({ roomId }: { roomId: string }) {
 }
 ```
 
+#### React Storage Queue Hook (Start/Pause)
+
+```tsx
+import { useMemo } from 'react';
+import { connectApp } from '@zuzjs/flare';
+import { useStorage, Status } from '@zuzjs/flare/react';
+
+const app = connectApp({
+  endpoint: 'http://localhost:8080',
+  appId: 'my-app',
+});
+
+export function StorageUploader() {
+  const storage = useMemo(() => app.storage(), []);
+
+  const upload = useStorage(storage, {
+    onItemComplete: (item, result) => {
+      console.log('uploaded', item.objectKey, result.url);
+    },
+    onItemError: (item, err) => {
+      console.error('upload failed', item.objectKey, err.message);
+    },
+  });
+
+  const onSelect = (event: React.ChangeEvent<HTMLInputElement>) => {
+    const files = Array.from(event.target.files ?? []);
+    if (!files.length) return;
+
+    upload.addToQueue(
+      files.map((file) => ({
+        file,
+        bucket: 'attachments',
+        key: `uploads/${Date.now()}-${file.name}`,
+        contentType: file.type || 'application/octet-stream',
+        access: 'public',
+      })),
+    );
+  };
+
+  return (
+    <div>
+      <input type='file' multiple onChange={onSelect} />
+
+      <div style={{ display: 'flex', gap: 8, marginTop: 12 }}>
+        <button onClick={() => void upload.start()} disabled={!upload.hasPending || upload.running}>
+          Start
+        </button>
+        <button onClick={upload.pause} disabled={!upload.running}>
+          Pause
+        </button>
+      </div>
+
+      <ul>
+        {upload.que.map((item) => (
+          <li key={item.id}>
+            {item.objectKey} - {item.progress}% - {Status[item.status]}
+          </li>
+        ))}
+      </ul>
+    </div>
+  );
+}
+```
+
+`addToQueue(...)` auto-starts uploads by default.
+
+Manual mode example (only upload when `start()` is clicked):
+
+```tsx
+const upload = useStorage(storage, {
+  autoStartOnAdd: false,
+});
+
+upload.addToQueue([
+  {
+    file,
+    bucket: 'attachments',
+    key: `uploads/${Date.now()}-${file.name}`,
+  },
+]);
+
+await upload.start();
+```
+
+Notes:
+
+- Queue items expose `item.objectKey` (not `item.key`) to avoid React prop-name conflicts.
+- `addToQueue(...)` input still uses `key` because it maps directly to `putObject({ key })`.
+- `addToQueue(...)` starts processing immediately unless `autoStartOnAdd: false` or the queue is paused.
+- `pause()` stops scheduling new uploads; it does not cancel an already in-flight request.
+- Call `start()` again to continue with remaining queued items.
+
 #### Next.js Example (Client Component)
 
 ```tsx

package/dist/grpc.d.cts

@@ -1,4 +1,4 @@
-import { F as FlareConfig, aR as StructuredQuery } from './index-18tMqAtM.cjs';
+import { F as FlareConfig, aR as StructuredQuery } from './index-J1xVXysN.cjs';
 import '@zuzjs/auth';
 
 declare function runGrpcQuery<T = Record<string, unknown>>(config: FlareConfig, collection: string, query: StructuredQuery): Promise<T[] | null>;

package/dist/grpc.d.ts

@@ -1,4 +1,4 @@
-import { F as FlareConfig, aR as StructuredQuery } from './index-18tMqAtM.js';
+import { F as FlareConfig, aR as StructuredQuery } from './index-J1xVXysN.js';
 import '@zuzjs/auth';
 
 declare function runGrpcQuery<T = Record<string, unknown>>(config: FlareConfig, collection: string, query: StructuredQuery): Promise<T[] | null>;

package/dist/{index-D53u7tRA.d.cts → index-CnmBBd-u.d.cts}

@@ -1,4 +1,4 @@
-import { b0 as WhereCondition, aT as SubscriptionCallback, aw as QueryConfig, J as DocUpdatedCallback, I as DocDeletedCallback, H as DocChangedCallback, ay as QueryPresetMap, az as QueryPresetParams, aA as QueryPresetRow, a as AggregateSpec, ae as HavingClause, ah as JoinClause, a_ as VectorSearchClause, aR as StructuredQuery, aX as SubscriptionHandle, u as CollectionStreamOptions, r as CollectionStream, q as CollectionExternalStore, G as DocAddedCallback, m as BulkWriteOptions, o as BulkWriteResult, aY as UpdateManyItem, F as FlareConfig, aS as SubscribeOptions, aW as SubscriptionErrorCallback, aV as SubscriptionError, v as ConnectionState, ap as PresenceCallback, aq as PresenceJoinCallback, ar as PresenceLeaveCallback, aZ as VectorFieldConfig, aB as QueryPresetSpec, a8 as FlareStorageTransferManagerConfig, aN as StorageProgress, aL as StorageBucketInput, aK as StorageBucket, k as BucketPolicyInput, a1 as FlareStorageRulesPolicy, j as BucketCorsRule, a0 as FlareStorageRulesHistoryResult, au as PutObjectInput, av as PutObjectResult, aa as GetObjectInput, ab as GetObjectResult, ac as GetObjectUrlInput, L as DownloadObjectInput, M as DownloadObjectResult, af as HeadObjectInput, aM as StorageObjectMeta, ag as HeadObjectsInput, aj as ListObjectsInput, ak as ListObjectsResult, w as CopyObjectInput, z as DeleteObjectInput, E as DeleteObjectsInput, aO as StorageSignedUrlInput, a7 as FlareStorageSignedUrlResult, P as FlareAuthConfig, f as AuthStateListener, d as AuthConfigListener, U as FlareAuthSession, V as FlareAuthUser, Q as FlareAuthHydrationInput, R as FlareAuthHydrationOptions, i as BrowserPushTokenOptions, B as BrowserPushRegistrationOptions, aD as RegisterPushTokenInput, aI as SendPushNotificationInput, at as PushSendResult, e as AuthResult } from './index-18tMqAtM.cjs';
+import { b0 as WhereCondition, aT as SubscriptionCallback, aw as QueryConfig, J as DocUpdatedCallback, I as DocDeletedCallback, H as DocChangedCallback, ay as QueryPresetMap, az as QueryPresetParams, aA as QueryPresetRow, a as AggregateSpec, ae as HavingClause, ah as JoinClause, a_ as VectorSearchClause, aR as StructuredQuery, aX as SubscriptionHandle, u as CollectionStreamOptions, r as CollectionStream, q as CollectionExternalStore, G as DocAddedCallback, m as BulkWriteOptions, o as BulkWriteResult, aY as UpdateManyItem, F as FlareConfig, aS as SubscribeOptions, aW as SubscriptionErrorCallback, aV as SubscriptionError, v as ConnectionState, ap as PresenceCallback, aq as PresenceJoinCallback, ar as PresenceLeaveCallback, aZ as VectorFieldConfig, aB as QueryPresetSpec, a8 as FlareStorageTransferManagerConfig, aN as StorageProgress, aL as StorageBucketInput, aK as StorageBucket, k as BucketPolicyInput, a1 as FlareStorageRulesPolicy, j as BucketCorsRule, a0 as FlareStorageRulesHistoryResult, au as PutObjectInput, av as PutObjectResult, aa as GetObjectInput, ab as GetObjectResult, ac as GetObjectUrlInput, L as DownloadObjectInput, M as DownloadObjectResult, af as HeadObjectInput, aM as StorageObjectMeta, ag as HeadObjectsInput, aj as ListObjectsInput, ak as ListObjectsResult, w as CopyObjectInput, z as DeleteObjectInput, E as DeleteObjectsInput, aO as StorageSignedUrlInput, a7 as FlareStorageSignedUrlResult, P as FlareAuthConfig, f as AuthStateListener, d as AuthConfigListener, U as FlareAuthSession, V as FlareAuthUser, Q as FlareAuthHydrationInput, R as FlareAuthHydrationOptions, i as BrowserPushTokenOptions, B as BrowserPushRegistrationOptions, aD as RegisterPushTokenInput, aI as SendPushNotificationInput, at as PushSendResult, e as AuthResult } from './index-J1xVXysN.cjs';
 import { AuthGuard, AuthToken, ProviderId } from '@zuzjs/auth';
 
 /**
@@ -554,6 +554,7 @@ declare class FlareBase<TPresetMap extends QueryPresetMap = {}> {
 
 interface FlareStorageTransport {
     readonly appId: string;
+    readonly storageRulesHomeBucket?: string;
     readonly transferManager?: FlareStorageTransferManagerConfig;
     call(topic: string, payload?: Record<string, unknown>): Promise<Record<string, unknown>>;
     subscribe(subId: string, collection: string, docId: string | undefined, query: unknown, callback: (event: any) => void, options?: {
@@ -582,6 +583,10 @@ declare class FlareStorage {
     constructor(transport: FlareStorageTransport);
     private _scheduleUpload;
     private _scheduleDownload;
+    private _normalizeBucketName;
+    private _storageHomeBucket;
+    private _resolveStorageBucketName;
+    private _storageObjectPath;
     private _ensureBuckets;
     private _loadBuckets;
     private _invalidateBucketCache;

package/dist/{index-CXCOH5iN.d.ts → index-DPlKzY-d.d.ts}

@@ -1,4 +1,4 @@
-import { b0 as WhereCondition, aT as SubscriptionCallback, aw as QueryConfig, J as DocUpdatedCallback, I as DocDeletedCallback, H as DocChangedCallback, ay as QueryPresetMap, az as QueryPresetParams, aA as QueryPresetRow, a as AggregateSpec, ae as HavingClause, ah as JoinClause, a_ as VectorSearchClause, aR as StructuredQuery, aX as SubscriptionHandle, u as CollectionStreamOptions, r as CollectionStream, q as CollectionExternalStore, G as DocAddedCallback, m as BulkWriteOptions, o as BulkWriteResult, aY as UpdateManyItem, F as FlareConfig, aS as SubscribeOptions, aW as SubscriptionErrorCallback, aV as SubscriptionError, v as ConnectionState, ap as PresenceCallback, aq as PresenceJoinCallback, ar as PresenceLeaveCallback, aZ as VectorFieldConfig, aB as QueryPresetSpec, a8 as FlareStorageTransferManagerConfig, aN as StorageProgress, aL as StorageBucketInput, aK as StorageBucket, k as BucketPolicyInput, a1 as FlareStorageRulesPolicy, j as BucketCorsRule, a0 as FlareStorageRulesHistoryResult, au as PutObjectInput, av as PutObjectResult, aa as GetObjectInput, ab as GetObjectResult, ac as GetObjectUrlInput, L as DownloadObjectInput, M as DownloadObjectResult, af as HeadObjectInput, aM as StorageObjectMeta, ag as HeadObjectsInput, aj as ListObjectsInput, ak as ListObjectsResult, w as CopyObjectInput, z as DeleteObjectInput, E as DeleteObjectsInput, aO as StorageSignedUrlInput, a7 as FlareStorageSignedUrlResult, P as FlareAuthConfig, f as AuthStateListener, d as AuthConfigListener, U as FlareAuthSession, V as FlareAuthUser, Q as FlareAuthHydrationInput, R as FlareAuthHydrationOptions, i as BrowserPushTokenOptions, B as BrowserPushRegistrationOptions, aD as RegisterPushTokenInput, aI as SendPushNotificationInput, at as PushSendResult, e as AuthResult } from './index-18tMqAtM.js';
+import { b0 as WhereCondition, aT as SubscriptionCallback, aw as QueryConfig, J as DocUpdatedCallback, I as DocDeletedCallback, H as DocChangedCallback, ay as QueryPresetMap, az as QueryPresetParams, aA as QueryPresetRow, a as AggregateSpec, ae as HavingClause, ah as JoinClause, a_ as VectorSearchClause, aR as StructuredQuery, aX as SubscriptionHandle, u as CollectionStreamOptions, r as CollectionStream, q as CollectionExternalStore, G as DocAddedCallback, m as BulkWriteOptions, o as BulkWriteResult, aY as UpdateManyItem, F as FlareConfig, aS as SubscribeOptions, aW as SubscriptionErrorCallback, aV as SubscriptionError, v as ConnectionState, ap as PresenceCallback, aq as PresenceJoinCallback, ar as PresenceLeaveCallback, aZ as VectorFieldConfig, aB as QueryPresetSpec, a8 as FlareStorageTransferManagerConfig, aN as StorageProgress, aL as StorageBucketInput, aK as StorageBucket, k as BucketPolicyInput, a1 as FlareStorageRulesPolicy, j as BucketCorsRule, a0 as FlareStorageRulesHistoryResult, au as PutObjectInput, av as PutObjectResult, aa as GetObjectInput, ab as GetObjectResult, ac as GetObjectUrlInput, L as DownloadObjectInput, M as DownloadObjectResult, af as HeadObjectInput, aM as StorageObjectMeta, ag as HeadObjectsInput, aj as ListObjectsInput, ak as ListObjectsResult, w as CopyObjectInput, z as DeleteObjectInput, E as DeleteObjectsInput, aO as StorageSignedUrlInput, a7 as FlareStorageSignedUrlResult, P as FlareAuthConfig, f as AuthStateListener, d as AuthConfigListener, U as FlareAuthSession, V as FlareAuthUser, Q as FlareAuthHydrationInput, R as FlareAuthHydrationOptions, i as BrowserPushTokenOptions, B as BrowserPushRegistrationOptions, aD as RegisterPushTokenInput, aI as SendPushNotificationInput, at as PushSendResult, e as AuthResult } from './index-J1xVXysN.js';
 import { AuthGuard, AuthToken, ProviderId } from '@zuzjs/auth';
 
 /**
@@ -554,6 +554,7 @@ declare class FlareBase<TPresetMap extends QueryPresetMap = {}> {
 
 interface FlareStorageTransport {
     readonly appId: string;
+    readonly storageRulesHomeBucket?: string;
     readonly transferManager?: FlareStorageTransferManagerConfig;
     call(topic: string, payload?: Record<string, unknown>): Promise<Record<string, unknown>>;
     subscribe(subId: string, collection: string, docId: string | undefined, query: unknown, callback: (event: any) => void, options?: {
@@ -582,6 +583,10 @@ declare class FlareStorage {
     constructor(transport: FlareStorageTransport);
     private _scheduleUpload;
     private _scheduleDownload;
+    private _normalizeBucketName;
+    private _storageHomeBucket;
+    private _resolveStorageBucketName;
+    private _storageObjectPath;
     private _ensureBuckets;
     private _loadBuckets;
     private _invalidateBucketCache;

package/dist/{index-18tMqAtM.d.cts → index-J1xVXysN.d.cts}

@@ -110,6 +110,7 @@ interface FlareAuthConfig {
     needsEmailVerification?: boolean;
     autoSendVerificationEmail?: boolean;
     redirectUri?: string;
+    storageRulesHomeBucket?: string | null;
     csrfToken?: string;
     cookie?: {
         accessTokenName?: string;
@@ -419,6 +420,9 @@ interface PutObjectResult {
     bucket: string;
     key: string;
     access: "public" | "private";
+    /** Alias of contentType for compatibility with legacy callers. */
+    type?: string;
+    contentType?: string;
     url?: string;
     size: number;
     encrypted: boolean;

package/dist/{index-18tMqAtM.d.ts → index-J1xVXysN.d.ts}

@@ -110,6 +110,7 @@ interface FlareAuthConfig {
     needsEmailVerification?: boolean;
     autoSendVerificationEmail?: boolean;
     redirectUri?: string;
+    storageRulesHomeBucket?: string | null;
     csrfToken?: string;
     cookie?: {
         accessTokenName?: string;
@@ -419,6 +420,9 @@ interface PutObjectResult {
     bucket: string;
     key: string;
     access: "public" | "private";
+    /** Alias of contentType for compatibility with legacy callers. */
+    type?: string;
+    contentType?: string;
     url?: string;
     size: number;
     encrypted: boolean;