firebase-storage-kit

firebase-storage-kit

Storage manager for Firebase Storage with uploads, progress tracking, batch uploads, and file query helpers.

Install

With npm:

npm install firebase-storage-kit

Or with Yarn, pnpm, or Bun:

yarn add firebase-storage-kit
pnpm add firebase-storage-kit
bun add firebase-storage-kit

Quick start

import { getStorage } from "firebase/storage";
import { StorageManager } from "firebase-storage-kit";

const storage = getStorage(app);
const manager = new StorageManager(storage);

const handle = manager.uploadFile(file, { path: `uploads/${file.name}` });

handle.on("progress", (upload) => {
  console.log(upload.progress);
});

handle.on("success", (upload) => {
  console.log(upload.downloadURL);
});

Batch uploads

const batch = manager.uploadFiles(
  files,
  (file) => ({ path: `uploads/${file.name}` }),
  { concurrency: 3, continueOnError: true },
);

batch.on("success", (snapshot) => {
  console.log(snapshot.completedCount, snapshot.failedCount);
});

Subscriptions (manager state)

const unsubscribe = manager.subscribe((state) => {
  console.log(state.uploads, state.batches);
});

Custom metadata

Attach app-specific metadata when uploading. Read it back later with getMetadata:

const handle = manager.uploadFile(file, {
  path: `uploads/${file.name}`,
  customMetadata: {
    owner: "user-123",
    source: "mobile-app",
  },
});

const meta = await manager.getMetadata(`uploads/${file.name}`);
console.log(meta.customMetadata?.owner);

Works with batch uploads too — use customMetadata in the UploadOptions for each file.

Caveats

• String values only. Keys and values must both be strings (Record<string, string>).
• Reserved keys. Client apps cannot set internal keys such as firebaseStorageDownloadTokens; Firebase rejects those with a 400 error.
• Small data only. Custom metadata is for lightweight, file-specific tags. For richer or queryable data, use Firestore or Realtime Database instead.
• Security rules. Who can read or write metadata is controlled by your Firebase Storage security rules — configure them if metadata is sensitive.

Upload retries

Uploads retry transient failures automatically (3 retries by default, exponential backoff with jitter). Pass retry: false to disable, or customize:

const handle = manager.uploadFile(file, {
  path: `uploads/${file.name}`,
  retry: { maxRetries: 5, initialDelayMs: 700 },
});

handle.on("retry", ({ attempt, maxAttempts, delayMs, error }) => {
  console.log(`Retry ${attempt}/${maxAttempts} in ${delayMs}ms`, error.message);
});

Querying files

const exists = await manager.exists("uploads/photo.jpg");

if (exists) {
  const meta = await manager.getMetadata("uploads/photo.jpg");
  const url = await manager.getDownloadURL("uploads/photo.jpg");
  console.log(meta.size, url);
}

await manager.delete("uploads/old.jpg");

exists returns false only when the object is not found. Permission and network errors are thrown.

License

MIT