@prmichaelsen/firebase-admin-sdk-v8 2.0.21 → 2.1.0

package/dist/index.d.mts

@@ -195,6 +195,7 @@ interface BatchWriteResult {
 interface SDKConfig {
     serviceAccount?: ServiceAccount | string;
     projectId?: string;
+    apiKey?: string;
 }
 /**
  * Initialize the Firebase Admin SDK with configuration
@@ -250,6 +251,21 @@ declare function getProjectId(): string;
  * ID token verification supporting both Firebase v9 and v10 token formats
  */
 
+/**
+ * Custom claims for custom tokens
+ */
+interface CustomClaims {
+    [key: string]: any;
+}
+/**
+ * Response from signInWithCustomToken
+ */
+interface CustomTokenSignInResponse {
+    idToken: string;
+    refreshToken: string;
+    expiresIn: string;
+    localId: string;
+}
 /**
  * Verify a Firebase ID token
  * Supports both Firebase v9 (securetoken) and v10 (session) token formats
@@ -280,6 +296,45 @@ declare function verifyIdToken(idToken: string): Promise<DecodedIdToken>;
  * ```
  */
 declare function getUserFromToken(idToken: string): Promise<UserInfo>;
+/**
+ * Create a custom token for a user
+ *
+ * @param uid - User ID
+ * @param customClaims - Optional custom claims to include in token
+ * @returns Custom JWT token
+ *
+ * @example
+ * ```typescript
+ * // Create token with custom claims
+ * const token = await createCustomToken('user123', {
+ *   role: 'admin',
+ *   premium: true,
+ * });
+ *
+ * // Use token on client to sign in
+ * await signInWithCustomToken(auth, token);
+ * ```
+ */
+declare function createCustomToken(uid: string, customClaims?: CustomClaims): Promise<string>;
+/**
+ * Exchange a custom token for an ID token and refresh token
+ *
+ * @param customToken - Custom JWT token created with createCustomToken
+ * @returns User credentials (idToken, refreshToken, expiresIn, localId)
+ *
+ * @example
+ * ```typescript
+ * // Server-side: Create custom token
+ * const customToken = await createCustomToken('user123', { role: 'admin' });
+ *
+ * // Exchange for ID token
+ * const credentials = await signInWithCustomToken(customToken);
+ *
+ * // Use ID token for authenticated requests
+ * const user = await verifyIdToken(credentials.idToken);
+ * ```
+ */
+declare function signInWithCustomToken(customToken: string): Promise<CustomTokenSignInResponse>;
 /**
  * Get Auth instance (for compatibility, but not used in new implementation)
  * @deprecated Use verifyIdToken directly
@@ -425,6 +480,189 @@ declare function queryDocuments(collectionPath: string, options?: QueryOptions):
  */
 declare function batchWrite(operations: BatchWrite[]): Promise<BatchWriteResult>;
 
+/**
+ * Firebase Storage client using Google Cloud Storage REST API
+ * Compatible with edge runtimes (Cloudflare Workers, Vercel Edge, etc.)
+ */
+/**
+ * Options for uploading files
+ */
+interface UploadOptions {
+    contentType?: string;
+    metadata?: Record<string, string>;
+    public?: boolean;
+}
+/**
+ * Options for downloading files
+ */
+interface DownloadOptions {
+    responseType?: 'arraybuffer' | 'blob';
+}
+/**
+ * Options for listing files
+ */
+interface ListOptions {
+    prefix?: string;
+    delimiter?: string;
+    maxResults?: number;
+    pageToken?: string;
+}
+/**
+ * File metadata returned by Storage API
+ */
+interface FileMetadata {
+    name: string;
+    bucket: string;
+    size: string;
+    contentType: string;
+    timeCreated: string;
+    updated: string;
+    md5Hash: string;
+    metadata?: Record<string, string>;
+}
+/**
+ * Result of listing files
+ */
+interface ListFilesResult {
+    files: FileMetadata[];
+    nextPageToken?: string;
+}
+/**
+ * Upload a file to Firebase Storage
+ *
+ * @param path - File path in storage (e.g., 'images/photo.jpg')
+ * @param data - File data as ArrayBuffer, Uint8Array, or Blob
+ * @param options - Upload options (contentType, metadata, public)
+ * @returns File metadata
+ *
+ * @example
+ * ```typescript
+ * const data = new TextEncoder().encode('Hello, Storage!');
+ * const metadata = await uploadFile('files/hello.txt', data, {
+ *   contentType: 'text/plain',
+ *   metadata: { userId: '123' },
+ * });
+ * ```
+ */
+declare function uploadFile(path: string, data: ArrayBuffer | Uint8Array | Blob, options?: UploadOptions): Promise<FileMetadata>;
+/**
+ * Download a file from Firebase Storage
+ *
+ * @param path - File path in storage
+ * @param options - Download options
+ * @returns File data as ArrayBuffer
+ *
+ * @example
+ * ```typescript
+ * const data = await downloadFile('files/hello.txt');
+ * const text = new TextDecoder().decode(data);
+ * console.log(text); // "Hello, Storage!"
+ * ```
+ */
+declare function downloadFile(path: string, _options?: DownloadOptions): Promise<ArrayBuffer>;
+/**
+ * Delete a file from Firebase Storage
+ *
+ * @param path - File path in storage
+ *
+ * @example
+ * ```typescript
+ * await deleteFile('files/hello.txt');
+ * ```
+ */
+declare function deleteFile(path: string): Promise<void>;
+/**
+ * Get file metadata from Firebase Storage
+ *
+ * @param path - File path in storage
+ * @returns File metadata
+ *
+ * @example
+ * ```typescript
+ * const metadata = await getFileMetadata('files/hello.txt');
+ * console.log(metadata.size, metadata.contentType);
+ * ```
+ */
+declare function getFileMetadata(path: string): Promise<FileMetadata>;
+/**
+ * List files in Firebase Storage
+ *
+ * @param options - List options (prefix, delimiter, maxResults, pageToken)
+ * @returns List of files and optional next page token
+ *
+ * @example
+ * ```typescript
+ * // List all files with prefix
+ * const { files } = await listFiles({ prefix: 'images/' });
+ *
+ * // List with pagination
+ * const { files, nextPageToken } = await listFiles({ maxResults: 10 });
+ * if (nextPageToken) {
+ *   const nextPage = await listFiles({ pageToken: nextPageToken });
+ * }
+ * ```
+ */
+declare function listFiles(options?: ListOptions): Promise<ListFilesResult>;
+/**
+ * Check if a file exists in Firebase Storage
+ *
+ * @param path - File path in storage
+ * @returns True if file exists, false otherwise
+ *
+ * @example
+ * ```typescript
+ * if (await fileExists('files/hello.txt')) {
+ *   console.log('File exists!');
+ * }
+ * ```
+ */
+declare function fileExists(path: string): Promise<boolean>;
+
+/**
+ * Generate signed URLs for temporary access to Firebase Storage files
+ * Uses Google Cloud Storage V4 signing process
+ */
+/**
+ * Options for generating signed URLs
+ */
+interface SignedUrlOptions {
+    action: 'read' | 'write' | 'delete';
+    expires: Date | number;
+    contentType?: string;
+    responseDisposition?: string;
+    responseType?: string;
+}
+/**
+ * Generate a signed URL for temporary access to a Storage file
+ *
+ * Uses Google Cloud Storage V4 signing process
+ *
+ * @param path - File path in storage (e.g., 'images/photo.jpg')
+ * @param options - Signed URL options
+ * @returns Signed URL that can be used without authentication
+ *
+ * @example
+ * ```typescript
+ * // Generate read URL valid for 1 hour
+ * const url = await generateSignedUrl('files/hello.txt', {
+ *   action: 'read',
+ *   expires: 3600,
+ * });
+ *
+ * // Generate write URL with content type
+ * const uploadUrl = await generateSignedUrl('files/upload.jpg', {
+ *   action: 'write',
+ *   expires: 1800, // 30 minutes
+ *   contentType: 'image/jpeg',
+ * });
+ *
+ * // Use the URL (no auth needed)
+ * const response = await fetch(url);
+ * const data = await response.arrayBuffer();
+ * ```
+ */
+declare function generateSignedUrl(path: string, options: SignedUrlOptions): Promise<string>;
+
 /**
  * Firebase Admin SDK v8 - Field Value Helpers
  * Special field values for Firestore operations
@@ -522,4 +760,4 @@ declare function getAdminAccessToken(): Promise<string>;
  */
 declare function clearTokenCache(): void;
 
-export { type BatchWrite, type BatchWriteResult, type DataObject, type DecodedIdToken, type DocumentReference, FieldValue, type FieldValue$1 as FieldValueSentinel, FieldValueType, type FirestoreDocument, type FirestoreValue, type QueryFilter, type QueryOptions, type QueryOrder, type ServiceAccount, type SetOptions, type TokenResponse, type UpdateOptions, type UserInfo, type WhereFilterOp, addDocument, batchWrite, clearConfig, clearTokenCache, deleteDocument, getAdminAccessToken, getAuth, getConfig, getDocument, getProjectId, getServiceAccount, getUserFromToken, initializeApp, queryDocuments, setDocument, updateDocument, verifyIdToken };
+export { type BatchWrite, type BatchWriteResult, type CustomClaims, type CustomTokenSignInResponse, type DataObject, type DecodedIdToken, type DocumentReference, type DownloadOptions, FieldValue, type FieldValue$1 as FieldValueSentinel, FieldValueType, type FileMetadata, type FirestoreDocument, type FirestoreValue, type ListFilesResult, type ListOptions, type QueryFilter, type QueryOptions, type QueryOrder, type ServiceAccount, type SetOptions, type SignedUrlOptions, type TokenResponse, type UpdateOptions, type UploadOptions, type UserInfo, type WhereFilterOp, addDocument, batchWrite, clearConfig, clearTokenCache, createCustomToken, deleteDocument, deleteFile, downloadFile, fileExists, generateSignedUrl, getAdminAccessToken, getAuth, getConfig, getDocument, getFileMetadata, getProjectId, getServiceAccount, getUserFromToken, initializeApp, listFiles, queryDocuments, setDocument, signInWithCustomToken, updateDocument, uploadFile, verifyIdToken };

package/dist/index.d.ts

@@ -195,6 +195,7 @@ interface BatchWriteResult {
 interface SDKConfig {
     serviceAccount?: ServiceAccount | string;
     projectId?: string;
+    apiKey?: string;
 }
 /**
  * Initialize the Firebase Admin SDK with configuration
@@ -250,6 +251,21 @@ declare function getProjectId(): string;
  * ID token verification supporting both Firebase v9 and v10 token formats
  */
 
+/**
+ * Custom claims for custom tokens
+ */
+interface CustomClaims {
+    [key: string]: any;
+}
+/**
+ * Response from signInWithCustomToken
+ */
+interface CustomTokenSignInResponse {
+    idToken: string;
+    refreshToken: string;
+    expiresIn: string;
+    localId: string;
+}
 /**
  * Verify a Firebase ID token
  * Supports both Firebase v9 (securetoken) and v10 (session) token formats
@@ -280,6 +296,45 @@ declare function verifyIdToken(idToken: string): Promise<DecodedIdToken>;
  * ```
  */
 declare function getUserFromToken(idToken: string): Promise<UserInfo>;
+/**
+ * Create a custom token for a user
+ *
+ * @param uid - User ID
+ * @param customClaims - Optional custom claims to include in token
+ * @returns Custom JWT token
+ *
+ * @example
+ * ```typescript
+ * // Create token with custom claims
+ * const token = await createCustomToken('user123', {
+ *   role: 'admin',
+ *   premium: true,
+ * });
+ *
+ * // Use token on client to sign in
+ * await signInWithCustomToken(auth, token);
+ * ```
+ */
+declare function createCustomToken(uid: string, customClaims?: CustomClaims): Promise<string>;
+/**
+ * Exchange a custom token for an ID token and refresh token
+ *
+ * @param customToken - Custom JWT token created with createCustomToken
+ * @returns User credentials (idToken, refreshToken, expiresIn, localId)
+ *
+ * @example
+ * ```typescript
+ * // Server-side: Create custom token
+ * const customToken = await createCustomToken('user123', { role: 'admin' });
+ *
+ * // Exchange for ID token
+ * const credentials = await signInWithCustomToken(customToken);
+ *
+ * // Use ID token for authenticated requests
+ * const user = await verifyIdToken(credentials.idToken);
+ * ```
+ */
+declare function signInWithCustomToken(customToken: string): Promise<CustomTokenSignInResponse>;
 /**
  * Get Auth instance (for compatibility, but not used in new implementation)
  * @deprecated Use verifyIdToken directly
@@ -425,6 +480,189 @@ declare function queryDocuments(collectionPath: string, options?: QueryOptions):
  */
 declare function batchWrite(operations: BatchWrite[]): Promise<BatchWriteResult>;
 
+/**
+ * Firebase Storage client using Google Cloud Storage REST API
+ * Compatible with edge runtimes (Cloudflare Workers, Vercel Edge, etc.)
+ */
+/**
+ * Options for uploading files
+ */
+interface UploadOptions {
+    contentType?: string;
+    metadata?: Record<string, string>;
+    public?: boolean;
+}
+/**
+ * Options for downloading files
+ */
+interface DownloadOptions {
+    responseType?: 'arraybuffer' | 'blob';
+}
+/**
+ * Options for listing files
+ */
+interface ListOptions {
+    prefix?: string;
+    delimiter?: string;
+    maxResults?: number;
+    pageToken?: string;
+}
+/**
+ * File metadata returned by Storage API
+ */
+interface FileMetadata {
+    name: string;
+    bucket: string;
+    size: string;
+    contentType: string;
+    timeCreated: string;
+    updated: string;
+    md5Hash: string;
+    metadata?: Record<string, string>;
+}
+/**
+ * Result of listing files
+ */
+interface ListFilesResult {
+    files: FileMetadata[];
+    nextPageToken?: string;
+}
+/**
+ * Upload a file to Firebase Storage
+ *
+ * @param path - File path in storage (e.g., 'images/photo.jpg')
+ * @param data - File data as ArrayBuffer, Uint8Array, or Blob
+ * @param options - Upload options (contentType, metadata, public)
+ * @returns File metadata
+ *
+ * @example
+ * ```typescript
+ * const data = new TextEncoder().encode('Hello, Storage!');
+ * const metadata = await uploadFile('files/hello.txt', data, {
+ *   contentType: 'text/plain',
+ *   metadata: { userId: '123' },
+ * });
+ * ```
+ */
+declare function uploadFile(path: string, data: ArrayBuffer | Uint8Array | Blob, options?: UploadOptions): Promise<FileMetadata>;
+/**
+ * Download a file from Firebase Storage
+ *
+ * @param path - File path in storage
+ * @param options - Download options
+ * @returns File data as ArrayBuffer
+ *
+ * @example
+ * ```typescript
+ * const data = await downloadFile('files/hello.txt');
+ * const text = new TextDecoder().decode(data);
+ * console.log(text); // "Hello, Storage!"
+ * ```
+ */
+declare function downloadFile(path: string, _options?: DownloadOptions): Promise<ArrayBuffer>;
+/**
+ * Delete a file from Firebase Storage
+ *
+ * @param path - File path in storage
+ *
+ * @example
+ * ```typescript
+ * await deleteFile('files/hello.txt');
+ * ```
+ */
+declare function deleteFile(path: string): Promise<void>;
+/**
+ * Get file metadata from Firebase Storage
+ *
+ * @param path - File path in storage
+ * @returns File metadata
+ *
+ * @example
+ * ```typescript
+ * const metadata = await getFileMetadata('files/hello.txt');
+ * console.log(metadata.size, metadata.contentType);
+ * ```
+ */
+declare function getFileMetadata(path: string): Promise<FileMetadata>;
+/**
+ * List files in Firebase Storage
+ *
+ * @param options - List options (prefix, delimiter, maxResults, pageToken)
+ * @returns List of files and optional next page token
+ *
+ * @example
+ * ```typescript
+ * // List all files with prefix
+ * const { files } = await listFiles({ prefix: 'images/' });
+ *
+ * // List with pagination
+ * const { files, nextPageToken } = await listFiles({ maxResults: 10 });
+ * if (nextPageToken) {
+ *   const nextPage = await listFiles({ pageToken: nextPageToken });
+ * }
+ * ```
+ */
+declare function listFiles(options?: ListOptions): Promise<ListFilesResult>;
+/**
+ * Check if a file exists in Firebase Storage
+ *
+ * @param path - File path in storage
+ * @returns True if file exists, false otherwise
+ *
+ * @example
+ * ```typescript
+ * if (await fileExists('files/hello.txt')) {
+ *   console.log('File exists!');
+ * }
+ * ```
+ */
+declare function fileExists(path: string): Promise<boolean>;
+
+/**
+ * Generate signed URLs for temporary access to Firebase Storage files
+ * Uses Google Cloud Storage V4 signing process
+ */
+/**
+ * Options for generating signed URLs
+ */
+interface SignedUrlOptions {
+    action: 'read' | 'write' | 'delete';
+    expires: Date | number;
+    contentType?: string;
+    responseDisposition?: string;
+    responseType?: string;
+}
+/**
+ * Generate a signed URL for temporary access to a Storage file
+ *
+ * Uses Google Cloud Storage V4 signing process
+ *
+ * @param path - File path in storage (e.g., 'images/photo.jpg')
+ * @param options - Signed URL options
+ * @returns Signed URL that can be used without authentication
+ *
+ * @example
+ * ```typescript
+ * // Generate read URL valid for 1 hour
+ * const url = await generateSignedUrl('files/hello.txt', {
+ *   action: 'read',
+ *   expires: 3600,
+ * });
+ *
+ * // Generate write URL with content type
+ * const uploadUrl = await generateSignedUrl('files/upload.jpg', {
+ *   action: 'write',
+ *   expires: 1800, // 30 minutes
+ *   contentType: 'image/jpeg',
+ * });
+ *
+ * // Use the URL (no auth needed)
+ * const response = await fetch(url);
+ * const data = await response.arrayBuffer();
+ * ```
+ */
+declare function generateSignedUrl(path: string, options: SignedUrlOptions): Promise<string>;
+
 /**
  * Firebase Admin SDK v8 - Field Value Helpers
  * Special field values for Firestore operations
@@ -522,4 +760,4 @@ declare function getAdminAccessToken(): Promise<string>;
  */
 declare function clearTokenCache(): void;
 
-export { type BatchWrite, type BatchWriteResult, type DataObject, type DecodedIdToken, type DocumentReference, FieldValue, type FieldValue$1 as FieldValueSentinel, FieldValueType, type FirestoreDocument, type FirestoreValue, type QueryFilter, type QueryOptions, type QueryOrder, type ServiceAccount, type SetOptions, type TokenResponse, type UpdateOptions, type UserInfo, type WhereFilterOp, addDocument, batchWrite, clearConfig, clearTokenCache, deleteDocument, getAdminAccessToken, getAuth, getConfig, getDocument, getProjectId, getServiceAccount, getUserFromToken, initializeApp, queryDocuments, setDocument, updateDocument, verifyIdToken };
+export { type BatchWrite, type BatchWriteResult, type CustomClaims, type CustomTokenSignInResponse, type DataObject, type DecodedIdToken, type DocumentReference, type DownloadOptions, FieldValue, type FieldValue$1 as FieldValueSentinel, FieldValueType, type FileMetadata, type FirestoreDocument, type FirestoreValue, type ListFilesResult, type ListOptions, type QueryFilter, type QueryOptions, type QueryOrder, type ServiceAccount, type SetOptions, type SignedUrlOptions, type TokenResponse, type UpdateOptions, type UploadOptions, type UserInfo, type WhereFilterOp, addDocument, batchWrite, clearConfig, clearTokenCache, createCustomToken, deleteDocument, deleteFile, downloadFile, fileExists, generateSignedUrl, getAdminAccessToken, getAuth, getConfig, getDocument, getFileMetadata, getProjectId, getServiceAccount, getUserFromToken, initializeApp, listFiles, queryDocuments, setDocument, signInWithCustomToken, updateDocument, uploadFile, verifyIdToken };