@react-native-firebase/storage 24.1.1 → 25.0.0

package/dist/typescript/lib/StorageReference.d.ts

@@ -0,0 +1,87 @@
+import { ReferenceBase } from '@react-native-firebase/app/dist/module/common';
+import StorageListResult from './StorageListResult';
+import { StringFormat } from './StorageStatics';
+import type { StorageReference, SettableMetadata, UploadMetadata, ListOptions, FullMetadata, Task, FirebaseStorage } from './types/storage';
+import type { StorageInternal } from './types/internal';
+export default class Reference extends ReferenceBase implements StorageReference {
+    _storage: StorageInternal;
+    constructor(storage: StorageInternal, path: string);
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#bucket
+     */
+    get bucket(): string;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#fullPath
+     */
+    get fullPath(): string;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#name
+     */
+    get name(): string;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#parent
+     */
+    get parent(): StorageReference | null;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#root
+     */
+    get root(): StorageReference;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#storage
+     */
+    get storage(): FirebaseStorage;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#child
+     */
+    child(path: string): StorageReference;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#delete
+     */
+    delete(): Promise<void>;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#getDownloadURL
+     */
+    getDownloadURL(): Promise<string>;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#getMetadata
+     */
+    getMetadata(): Promise<FullMetadata>;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#list
+     */
+    list(options?: ListOptions): Promise<StorageListResult>;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#listAll
+     */
+    listAll(): Promise<StorageListResult>;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#put
+     */
+    put(data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Task;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#putString
+     */
+    putString(string: string, format?: (typeof StringFormat)[keyof typeof StringFormat], metadata?: UploadMetadata): Task;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#fullPath
+     */
+    toString(): string;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference#updateMetadata
+     */
+    updateMetadata(metadata: SettableMetadata): Promise<FullMetadata>;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference
+     */
+    writeToFile(filePath: string): Task;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.Reference
+     */
+    putFile(filePath: string, metadata?: UploadMetadata): Task;
+    _updateString(string: string, format: (typeof StringFormat)[keyof typeof StringFormat], metadata: UploadMetadata | undefined, update?: boolean): {
+        _string: string;
+        _format: string;
+        _metadata: UploadMetadata | undefined;
+    };
+}
+//# sourceMappingURL=StorageReference.d.ts.map

package/dist/typescript/lib/StorageReference.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageReference.d.ts","sourceRoot":"","sources":["../../../lib/StorageReference.ts"],"names":[],"mappings":"AAiBA,OAAO,EAYL,aAAa,EAGd,MAAM,+CAA+C,CAAC;AAEvD,OAAO,iBAAmD,MAAM,qBAAqB,CAAC;AACtF,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAGhD,OAAO,KAAK,EACV,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,IAAI,EACJ,eAAe,EAChB,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAsB,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAE5E,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,aAAc,YAAW,gBAAgB;IAC9E,QAAQ,EAAE,eAAe,CAAC;gBAEd,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM;IAKlD;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,gBAAgB,GAAG,IAAI,CAMpC;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,gBAAgB,CAE3B;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,eAAe,CAE7B;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB;IAKrC;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAIvB;;OAEG;IACH,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;IAIjC;;OAEG;IACH,WAAW,IAAI,OAAO,CAAC,YAAY,CAAC;IAIpC;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA0DvD;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAMrC;;OAEG;IACH,GAAG,CAAC,IAAI,EAAE,IAAI,GAAG,UAAU,GAAG,WAAW,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,IAAI;IAsB3E;;OAEG;IACH,SAAS,CACP,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAoB,EAC3E,QAAQ,CAAC,EAAE,cAAc,GACxB,IAAI;IAQP;;OAEG;IACH,QAAQ,IAAI,MAAM;IAQlB;;OAEG;IACH,cAAc,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,CAAC;IASjE;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAYnC;;OAEG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,IAAI;IAmB1D,aAAa,CACX,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,EACxD,QAAQ,EAAE,cAAc,GAAG,SAAS,EACpC,MAAM,UAAQ,GACb;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,cAAc,GAAG,SAAS,CAAA;KAAE;CA6C/E"}

package/dist/typescript/lib/StorageStatics.d.ts

@@ -0,0 +1,2 @@
+export { StringFormat, TaskEvent, TaskState } from './types/storage';
+//# sourceMappingURL=StorageStatics.d.ts.map

package/dist/typescript/lib/StorageStatics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageStatics.d.ts","sourceRoot":"","sources":["../../../lib/StorageStatics.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/typescript/lib/StorageTask.d.ts

@@ -0,0 +1,43 @@
+import { TaskEvent } from './StorageStatics';
+import type { ReactNativeFirebase } from '@react-native-firebase/app';
+import type { StorageObserver, StorageReference, Subscribe, TaskSnapshot, Unsubscribe } from './types/storage';
+import type { StorageInternal } from './types/internal';
+type TaskEventType = (typeof TaskEvent)[keyof typeof TaskEvent];
+export default class StorageTask {
+    _type: string;
+    _id: number;
+    _promise: Promise<TaskSnapshot> | null;
+    _ref: StorageReference;
+    _beginTask: (task: StorageTask) => Promise<TaskSnapshot>;
+    _storage: StorageInternal;
+    _snapshot: TaskSnapshot;
+    constructor(type: string, storageRef: StorageReference, beginTaskFn: (task: StorageTask) => Promise<TaskSnapshot>);
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.UploadTask#then
+     */
+    get then(): (onFulfilled?: ((snapshot: TaskSnapshot) => TaskSnapshot) | null, onRejected?: ((error: ReactNativeFirebase.NativeFirebaseError) => any) | null) => Promise<TaskSnapshot>;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.UploadTask#catch
+     */
+    get catch(): (onRejected: (error: ReactNativeFirebase.NativeFirebaseError) => any) => Promise<any>;
+    get snapshot(): TaskSnapshot;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.UploadTask#on
+     */
+    on(event: TaskEventType): Subscribe<TaskSnapshot>;
+    on(event: TaskEventType, nextOrObserver?: StorageObserver<TaskSnapshot> | null | ((snapshot: TaskSnapshot) => unknown), error?: ((error: ReactNativeFirebase.NativeFirebaseError) => unknown) | null, complete?: (() => unknown) | null): Unsubscribe;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.UploadTask#pause
+     */
+    pause(): Promise<boolean>;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.UploadTask#pause
+     */
+    resume(): Promise<boolean>;
+    /**
+     * @url https://firebase.google.com/docs/reference/js/firebase.storage.UploadTask#cancel
+     */
+    cancel(): Promise<boolean>;
+}
+export {};
+//# sourceMappingURL=StorageTask.d.ts.map

package/dist/typescript/lib/StorageTask.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageTask.d.ts","sourceRoot":"","sources":["../../../lib/StorageTask.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,KAAK,EAEV,eAAe,EACf,gBAAgB,EAChB,SAAS,EAET,YAAY,EACZ,WAAW,EACZ,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAA4B,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAIlF,KAAK,aAAa,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,OAAO,SAAS,CAAC,CAAC;AAoJhE,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IACvC,IAAI,EAAE,gBAAgB,CAAC;IACvB,UAAU,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;IACzD,QAAQ,EAAE,eAAe,CAAC;IAC1B,SAAS,EAAE,YAAY,CAAC;gBAGtB,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,gBAAgB,EAC5B,WAAW,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,YAAY,CAAC;IAkB3D;;OAEG;IACH,IAAI,IAAI,IAAI,CACV,WAAW,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE,YAAY,KAAK,YAAY,CAAC,GAAG,IAAI,EAC/D,UAAU,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,mBAAmB,CAAC,mBAAmB,KAAK,GAAG,CAAC,GAAG,IAAI,KAC1E,OAAO,CAAC,YAAY,CAAC,CAmCzB;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,CACX,UAAU,EAAE,CAAC,KAAK,EAAE,mBAAmB,CAAC,mBAAmB,KAAK,GAAG,KAChE,OAAO,CAAC,GAAG,CAAC,CAKhB;IAED,IAAI,QAAQ,IAAI,YAAY,CAE3B;IAWD;;OAEG;IACH,EAAE,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,CAAC,YAAY,CAAC;IACjD,EAAE,CACA,KAAK,EAAE,aAAa,EACpB,cAAc,CAAC,EAAE,eAAe,CAAC,YAAY,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,YAAY,KAAK,OAAO,CAAC,EAC7F,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,mBAAmB,CAAC,mBAAmB,KAAK,OAAO,CAAC,GAAG,IAAI,EAC5E,QAAQ,CAAC,EAAE,CAAC,MAAM,OAAO,CAAC,GAAG,IAAI,GAChC,WAAW;IA0Bd;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC;IAIzB;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAI1B;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;CAG3B"}

package/dist/typescript/lib/StorageUploadTask.d.ts

@@ -0,0 +1,6 @@
+import StorageTask from './StorageTask';
+import type { StorageReference, TaskSnapshot } from './types/storage';
+export default class StorageUploadTask extends StorageTask {
+    constructor(storageRef: StorageReference, beginTaskFn: (task: StorageTask) => Promise<TaskSnapshot>);
+}
+//# sourceMappingURL=StorageUploadTask.d.ts.map

package/dist/typescript/lib/StorageUploadTask.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageUploadTask.d.ts","sourceRoot":"","sources":["../../../lib/StorageUploadTask.ts"],"names":[],"mappings":"AAiBA,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAItE,MAAM,CAAC,OAAO,OAAO,iBAAkB,SAAQ,WAAW;gBAEtD,UAAU,EAAE,gBAAgB,EAC5B,WAAW,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,YAAY,CAAC;CAI5D"}

package/dist/typescript/lib/index.d.ts

@@ -0,0 +1,6 @@
+export type * from './types/storage';
+export * from './modular';
+export type { FirebaseStorageTypes } from './types/namespaced';
+export * from './namespaced';
+export { default } from './namespaced';
+//# sourceMappingURL=index.d.ts.map

package/dist/typescript/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/index.ts"],"names":[],"mappings":"AAkBA,mBAAmB,iBAAiB,CAAC;AAGrC,cAAc,WAAW,CAAC;AAG1B,YAAY,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC"}

package/dist/typescript/lib/modular.d.ts

@@ -0,0 +1,154 @@
+import type { FirebaseApp } from '@react-native-firebase/app';
+import type { FirebaseStorage, StorageReference, FullMetadata, ListResult, ListOptions, TaskResult, Task, SettableMetadata, UploadMetadata, EmulatorMockTokenOptions } from './types/storage';
+/**
+ * Returns a Storage instance for the given app.
+ * @param app - FirebaseApp. Optional.
+ * @param bucketUrl - Storage bucket URL. Optional.
+ * @returns {Storage}
+ */
+export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;
+/**
+ * Modify this Storage instance to communicate with the Firebase Storage emulator.
+ * @param storage - Storage instance.
+ * @param host - emulator host (e.g. - 'localhost')
+ * @param port - emulator port (e.g. -  9199)
+ * @param options - `EmulatorMockTokenOptions` instance. Optional. Web only.
+ * @returns {void}
+ */
+export declare function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: EmulatorMockTokenOptions): void;
+/**
+ * Returns a StorageReference for the given URL or path in the default bucket.
+ * @param storage - FirebaseStorage instance.
+ * @param url - Optional gs:// or https:// URL, or path. If empty, returns root reference.
+ * @returns {StorageReference}
+ */
+export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;
+/**
+ * Returns a StorageReference for the given path, or the same reference if path is omitted.
+ * @param storageRef - StorageReference instance.
+ * @param path - Optional child path. If omitted, returns the same reference.
+ * @returns {StorageReference}
+ */
+export declare function ref(storageRef: StorageReference, path?: string): StorageReference;
+/**
+ * Deletes the object at this reference's location.
+ * @param storageRef - Storage `Reference` instance.
+ * @returns {Promise<void>}
+ */
+export declare function deleteObject(storageRef: StorageReference): Promise<void>;
+/**
+ * Downloads the data at the object's location. Returns an error if the object is not found.
+ * @param _storageRef - Storage `Reference` instance.
+ * @param _maxDownloadSizeBytes - The maximum allowed size in bytes to retrieve. Web only.
+ * @returns {Promise<Blob>}
+ */
+export declare function getBlob(_storageRef: StorageReference, _maxDownloadSizeBytes?: number): Promise<Blob>;
+/**
+ * Downloads the data at the object's location. Returns an error if the object is not found.
+ * @param _storageRef - Storage `Reference` instance.
+ * @param _maxDownloadSizeBytes - The maximum allowed size in bytes to retrieve. Web only.
+ * @returns {Promise<ArrayBuffer>}
+ */
+export declare function getBytes(_storageRef: StorageReference, _maxDownloadSizeBytes?: number): Promise<ArrayBuffer>;
+/**
+ * Deletes the object at this reference's location.
+ * @param storageRef - Storage `Reference` instance.
+ * @returns {Promise<string>}
+ */
+export declare function getDownloadURL(storageRef: StorageReference): Promise<string>;
+/**
+ * Fetches metadata for the object at this location, if one exists.
+ * @param storageRef - Storage `Reference` instance.
+ * @returns {Promise<FullMetadata>}
+ */
+export declare function getMetadata(storageRef: StorageReference): Promise<FullMetadata>;
+/**
+ * Downloads the data at the object's location. This API is only available in Nodejs.
+ * @param _storageRef - Storage `Reference` instance.
+ * @param _maxDownloadSizeBytes - The maximum allowed size in bytes to retrieve. Web only.
+ * @returns {NodeJS.ReadableStream;}
+ */
+export declare function getStream(_storageRef: StorageReference, _maxDownloadSizeBytes?: number): NodeJS.ReadableStream;
+/**
+ * List items (files) and prefixes (folders) under this storage reference
+ * @param storageRef - Storage `Reference` instance.
+ * @param options - Storage `ListOptions` instance. The options list() accepts.
+ * @returns {Promise<ListResult>}
+ */
+export declare function list(storageRef: StorageReference, options?: ListOptions): Promise<ListResult>;
+/**
+ * List all items (files) and prefixes (folders) under this storage reference.
+ * @param storageRef - Storage `Reference` instance.
+ * @returns {Promise<ListResult>}
+ */
+export declare function listAll(storageRef: StorageReference): Promise<ListResult>;
+/**
+ * Updates the metadata for this object.
+ * @param storageRef - Storage `Reference` instance.
+ * @param metadata - A Storage `SettableMetadata` instance to update.
+ * @returns {Promise<FullMetadata>}
+ */
+export declare function updateMetadata(storageRef: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;
+/**
+ * Uploads data to this object's location. The upload is not resumable.
+ * @param _storageRef - Storage `Reference` instance.
+ * @param _data - The data (Blob | Uint8Array | ArrayBuffer) to upload to the storage bucket at the reference location.
+ * @param _metadata - A Storage `UploadMetadata` instance to update. Optional.
+ * @returns {Promise<TaskResult>}
+ */
+export declare function uploadBytes(_storageRef: StorageReference, _data: Blob | Uint8Array | ArrayBuffer, _metadata?: UploadMetadata): Promise<TaskResult>;
+/**
+ * Uploads data to this object's location. The upload is not resumable.
+ * @param storageRef - Storage `Reference` instance.
+ * @param data - The data (Blob | Uint8Array | ArrayBuffer) to upload to the storage bucket at the reference location.
+ * @param metadata - A Storage `UploadMetadata` instance to update. Optional.
+ * @returns {Task}
+ */
+export declare function uploadBytesResumable(storageRef: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Task;
+/**
+ * Uploads data to this object's location. The upload is not resumable.
+ * @param storageRef - Storage `Reference` instance.
+ * @param data - The string to upload.
+ * @param format - The format of the string to upload ('raw' | 'base64' | 'base64url' | 'data_url'). Optional.
+ * @param metadata - A Storage `UploadMetadata` instance to update. Optional.
+ * @returns {Task}
+ */
+export declare function uploadString(storageRef: StorageReference, data: string, format?: 'raw' | 'base64' | 'base64url' | 'data_url', metadata?: UploadMetadata): Task;
+/**
+ * Sets the maximum time in milliseconds to retry a download if a failure occurs.. android & iOS only.
+ * @param storage - Storage instance.
+ * @param time - The new maximum operation retry time in milliseconds.
+ * @returns {Promise<void>}
+ */
+export declare function setMaxOperationRetryTime(storage: FirebaseStorage, time: number): Promise<void>;
+/**
+ * Sets the maximum time in milliseconds to retry an upload if a failure occurs. android & iOS only.
+ * @param storage - Storage instance.
+ * @param time - The new maximum operation retry time in milliseconds.
+ * @returns {Promise<void>}
+ */
+export declare function setMaxUploadRetryTime(storage: FirebaseStorage, time: number): Promise<void>;
+/**
+ * Puts a file from local disk onto the storage bucket.
+ * @param storageRef - Storage Reference instance.
+ * @param filePath The local file path to upload to the bucket at the reference location.
+ * @param metadata Any additional `UploadMetadata` for this task.
+ * @returns {Task}
+ */
+export declare function putFile(storageRef: StorageReference, filePath: string, metadata?: UploadMetadata): Task;
+/**
+ * Downloads a file to the specified local file path on the device.
+ * @param storageRef - Storage Reference instance.
+ * @param filePath The local file path to upload to on the device.
+ * @returns {Task}
+ */
+export declare function writeToFile(storageRef: StorageReference, filePath: string): Task;
+/**
+ * Sets the maximum time in milliseconds to retry a download if a failure occurs.
+ * @param storage - Storage instance.
+ * @param time - The new maximum download retry time in milliseconds.
+ * @returns {Promise<void>}
+ */
+export declare function setMaxDownloadRetryTime(storage: FirebaseStorage, time: number): Promise<void>;
+export { StringFormat, TaskEvent, TaskState } from './StorageStatics';
+//# sourceMappingURL=modular.d.ts.map

package/dist/typescript/lib/modular.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modular.d.ts","sourceRoot":"","sources":["../../../lib/modular.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,KAAK,EACV,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,UAAU,EACV,WAAW,EACX,UAAU,EACV,IAAI,EACJ,gBAAgB,EAChB,cAAc,EACd,wBAAwB,EACzB,MAAM,iBAAiB,CAAC;AAezB;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,CAAC,EAAE,WAAW,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,eAAe,CAcjF;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,eAAe,EACxB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,wBAAwB,GACjC,IAAI,CAMN;AAED;;;;;GAKG;AACH,wBAAgB,GAAG,CAAC,OAAO,EAAE,eAAe,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAC;AAC9E;;;;;GAKG;AACH,wBAAgB,GAAG,CAAC,UAAU,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAC;AA+BnF;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,UAAU,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAMxE;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CACrB,WAAW,EAAE,gBAAgB,EAC7B,qBAAqB,CAAC,EAAE,MAAM,GAC7B,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CACtB,WAAW,EAAE,gBAAgB,EAC7B,qBAAqB,CAAC,EAAE,MAAM,GAC7B,OAAO,CAAC,WAAW,CAAC,CAEtB;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,UAAU,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAM5E;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,UAAU,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,CAAC,CAM/E;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CACvB,WAAW,EAAE,gBAAgB,EAC7B,qBAAqB,CAAC,EAAE,MAAM,GAC7B,MAAM,CAAC,cAAc,CAEvB;AAED;;;;;GAKG;AACH,wBAAsB,IAAI,CACxB,UAAU,EAAE,gBAAgB,EAC5B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,UAAU,CAAC,CAWrB;AAED;;;;GAIG;AACH,wBAAsB,OAAO,CAAC,UAAU,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,CAW/E;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,UAAU,EAAE,gBAAgB,EAC5B,QAAQ,EAAE,gBAAgB,GACzB,OAAO,CAAC,YAAY,CAAC,CAMvB;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAC/B,WAAW,EAAE,gBAAgB,EAC7B,KAAK,EAAE,IAAI,GAAG,UAAU,GAAG,WAAW,EACtC,SAAS,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,UAAU,CAAC,CAErB;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,gBAAgB,EAC5B,IAAI,EAAE,IAAI,GAAG,UAAU,GAAG,WAAW,EACrC,QAAQ,CAAC,EAAE,cAAc,GACxB,IAAI,CAMN;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAC1B,UAAU,EAAE,gBAAgB,EAC5B,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,WAAW,GAAG,UAAU,EACpD,QAAQ,CAAC,EAAE,cAAc,GACxB,IAAI,CAMN;AAID;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAM9F;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAM3F;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CACrB,UAAU,EAAE,gBAAgB,EAC5B,QAAQ,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,cAAc,GACxB,IAAI,CAMN;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,UAAU,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAMhF;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAM7F;AAED,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/typescript/lib/namespaced.d.ts

@@ -0,0 +1,12 @@
+import type { ReactNativeFirebase } from '@react-native-firebase/app';
+import type { FirebaseStorageTypes } from './types/namespaced';
+export declare const SDK_VERSION = "25.0.0";
+type StorageNamespace = ReactNativeFirebase.FirebaseModuleWithStaticsAndApp<FirebaseStorageTypes.Module, FirebaseStorageTypes.Statics> & {
+    storage: ReactNativeFirebase.FirebaseModuleWithStaticsAndApp<FirebaseStorageTypes.Module, FirebaseStorageTypes.Statics>;
+    firebase: ReactNativeFirebase.Module;
+    app(name?: string): ReactNativeFirebase.FirebaseApp;
+};
+declare const _default: StorageNamespace;
+export default _default;
+export declare const firebase: ReactNativeFirebase.FirebaseNamespacedExport<"storage", FirebaseStorageTypes.Module, FirebaseStorageTypes.Statics, true>;
+//# sourceMappingURL=namespaced.d.ts.map

package/dist/typescript/lib/namespaced.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"namespaced.d.ts","sourceRoot":"","sources":["../../../lib/namespaced.ts"],"names":[],"mappings":"AA+BA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAOtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAwL/D,eAAO,MAAM,WAAW,WAAU,CAAC;AAcnC,KAAK,gBAAgB,GAAG,mBAAmB,CAAC,+BAA+B,CACzE,oBAAoB,CAAC,MAAM,EAC3B,oBAAoB,CAAC,OAAO,CAC7B,GAAG;IACF,OAAO,EAAE,mBAAmB,CAAC,+BAA+B,CAC1D,oBAAoB,CAAC,MAAM,EAC3B,oBAAoB,CAAC,OAAO,CAC7B,CAAC;IACF,QAAQ,EAAE,mBAAmB,CAAC,MAAM,CAAC;IACrC,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,mBAAmB,CAAC,WAAW,CAAC;CACrD,CAAC;wBAI4C,gBAAgB;AAA9D,wBAA+D;AAK/D,eAAO,MAAM,QAAQ,EACa,mBAAmB,CAAC,wBAAwB,CAC1E,SAAS,EACT,oBAAoB,CAAC,MAAM,EAC3B,oBAAoB,CAAC,OAAO,EAC5B,IAAI,CACL,CAAC"}

package/dist/typescript/lib/types/internal.d.ts

@@ -0,0 +1,131 @@
+import type { ModuleConfig } from '@react-native-firebase/app/dist/module/types/internal';
+import type { FirebaseStorage, StorageReference, EmulatorMockTokenOptions, SettableMetadata, UploadMetadata, Task, TaskSnapshot, FullMetadata, ListResult, ListOptions } from './storage';
+import type EventEmitter from 'react-native/Libraries/vendor/emitter/EventEmitter';
+/**
+ * Internal Storage type with access to private properties.
+ * Used internally by StorageReference and other internal classes.
+ */
+export type StorageInternal = FirebaseStorage & {
+    native: RNFBStorageModule;
+    _customUrlOrRegion: string | null;
+    emitter: EventEmitter;
+    eventNameForApp: (...args: Array<string | number>) => string;
+    _config: ModuleConfig;
+    /**
+     * Returns a reference to the object at the specified path.
+     *
+     * @param path - An optional string pointing to a location on the storage bucket. If no path
+     * is provided, the returned reference will be the bucket root path.
+     */
+    ref(path?: string): StorageReference;
+    /**
+     * Returns a reference to the object at the specified URL.
+     *
+     * @param url - A storage bucket URL pointing to a single file or location. Must be either a `gs://` url or an `http` url.
+     */
+    refFromURL(url: string): StorageReference;
+    /**
+     * Sets the maximum time in milliseconds to retry operations if a failure occurs.
+     *
+     * @param time - The new maximum operation retry time in milliseconds.
+     */
+    setMaxOperationRetryTime(time: number): Promise<void>;
+    /**
+     * Sets the maximum time in milliseconds to retry an upload if a failure occurs.
+     *
+     * @param time - The new maximum upload retry time in milliseconds.
+     */
+    setMaxUploadRetryTime(time: number): Promise<void>;
+    /**
+     * Sets the maximum time in milliseconds to retry a download if a failure occurs.
+     *
+     * @param time - The new maximum download retry time in milliseconds.
+     */
+    setMaxDownloadRetryTime(time: number): Promise<void>;
+    /**
+     * Changes this instance to point to a Cloud Storage emulator running locally.
+     *
+     * @param host - The host of the emulator, e.g. "localhost" or "10.0.2.2" for Android.
+     * @param port - The port of the emulator, e.g. 9199.
+     * @param options - Optional settings for the emulator connection (web only).
+     * @returns {void} - Undocumented return, just used to unit test android host remapping.
+     */
+    useEmulator(host: string, port: number, options?: EmulatorMockTokenOptions): void;
+};
+/**
+ * Internal Reference type with access to private properties.
+ * Used internally by StorageTask and other internal classes.
+ */
+export type StorageReferenceInternal = StorageReference & {
+    _storage: StorageInternal;
+    child(path: string): StorageReference;
+    delete(): Promise<void>;
+    getDownloadURL(): Promise<string>;
+    getMetadata(): Promise<FullMetadata>;
+    list(options?: ListOptions): Promise<ListResult>;
+    listAll(): Promise<ListResult>;
+    put(data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Task;
+    putString(string: string, format?: 'raw' | 'base64' | 'base64url' | 'data_url', metadata?: UploadMetadata): Task;
+    updateMetadata(metadata: SettableMetadata): Promise<FullMetadata>;
+    writeToFile(filePath: string): Task;
+    putFile(filePath: string, metadata?: UploadMetadata): Task;
+};
+/**
+ * Internal ListResult type with access to private properties.
+ * Used internally by StorageListResult and other internal classes.
+ */
+export type ListResultInternal = {
+    nextPageToken?: string | null;
+    items: string[];
+    prefixes: string[];
+};
+/**
+ * Wrapped native module interface for Storage.
+ *
+ * Note: React Native Firebase internally wraps native methods and auto-prepends the app name
+ * when `hasMultiAppSupport` is enabled. This interface represents the *wrapped* module shape
+ * that is exposed as `this.native` within FirebaseModule subclasses.
+ */
+export interface RNFBStorageModule {
+    /**
+     * Native constants exposed on the module.
+     * These are read during module construction to seed the JS-side values.
+     */
+    maxUploadRetryTime?: number;
+    maxDownloadRetryTime?: number;
+    maxOperationRetryTime?: number;
+    setMaxOperationRetryTime(time: number): Promise<void>;
+    setMaxUploadRetryTime(time: number): Promise<void>;
+    setMaxDownloadRetryTime(time: number): Promise<void>;
+    delete(url: string): Promise<void>;
+    getDownloadURL(url: string): Promise<string>;
+    getMetadata(url: string): Promise<FullMetadata>;
+    updateMetadata(url: string, metadata: SettableMetadata): Promise<FullMetadata>;
+    list(url: string, options: {
+        maxResults: number;
+        pageToken?: string;
+    }): Promise<ListResultInternal>;
+    listAll(url: string): Promise<ListResultInternal>;
+    putString(url: string, data: string, format: string, metadata: UploadMetadata | undefined, taskId: number): Promise<TaskSnapshot>;
+    putFile(url: string, filePath: string, metadata: UploadMetadata | undefined, taskId: number): Promise<TaskSnapshot>;
+    writeToFile(url: string, filePath: string, taskId: number): Promise<TaskSnapshot>;
+    /**
+     * Set a running task status.
+     * - 0: pause
+     * - 1: resume
+     * - 2: cancel
+     */
+    setTaskStatus(taskId: number, status: number): Promise<boolean>;
+    /**
+     * Configure storage emulator.
+     *
+     * iOS does not persist emulator state between calls, so JS sends bucket/customUrlOrRegion through.
+     */
+    useEmulator(host: string, port: number, customUrlOrRegion?: string | null): void;
+}
+declare module '@react-native-firebase/app/dist/module/internal/NativeModules' {
+    interface ReactNativeFirebaseNativeModules {
+        RNFBStorageModule: RNFBStorageModule;
+    }
+}
+//# sourceMappingURL=internal.d.ts.map

package/dist/typescript/lib/types/internal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../../../../lib/types/internal.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uDAAuD,CAAC;AAC1F,OAAO,KAAK,EACV,eAAe,EACf,gBAAgB,EAChB,wBAAwB,EACxB,gBAAgB,EAChB,cAAc,EACd,IAAI,EACJ,YAAY,EACZ,YAAY,EACZ,UAAU,EACV,WAAW,EACZ,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,YAAY,MAAM,oDAAoD,CAAC;AAEnF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG;IAC9C,MAAM,EAAE,iBAAiB,CAAC;IAC1B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,OAAO,EAAE,YAAY,CAAC;IACtB,eAAe,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,MAAM,CAAC;IAC7D,OAAO,EAAE,YAAY,CAAC;IACtB;;;;;OAKG;IACH,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAErC;;;;OAIG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAE1C;;;;OAIG;IACH,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD;;;;OAIG;IACH,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD;;;;OAIG;IACH,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErD;;;;;;;OAOG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;CACnF,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,gBAAgB,GAAG;IACxD,QAAQ,EAAE,eAAe,CAAC;IAC1B,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAAC;IACtC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACxB,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAClC,WAAW,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC;IACrC,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACjD,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/B,GAAG,CAAC,IAAI,EAAE,IAAI,GAAG,UAAU,GAAG,WAAW,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAC5E,SAAS,CACP,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,WAAW,GAAG,UAAU,EACpD,QAAQ,CAAC,EAAE,cAAc,GACxB,IAAI,CAAC;IACR,cAAc,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAClE,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;CAC5D,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtD,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErD,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7C,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAChD,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAE/E,IAAI,CACF,GAAG,EAAE,MAAM,EACX,OAAO,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAClD,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC/B,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAElD,SAAS,CACP,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,cAAc,GAAG,SAAS,EACpC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,YAAY,CAAC,CAAC;IACzB,OAAO,CACL,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,cAAc,GAAG,SAAS,EACpC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,YAAY,CAAC,CAAC;IACzB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAElF;;;;;OAKG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEhE;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC;CAClF;AAED,OAAO,QAAQ,+DAA+D,CAAC;IAC7E,UAAU,gCAAgC;QACxC,iBAAiB,EAAE,iBAAiB,CAAC;KACtC;CACF"}