/**
* Cloud Storage for Firebase
*
* @packageDocumentation
*/
///
import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
import { CompleteFn } from '@firebase/util';
import { EmulatorMockTokenOptions } from '@firebase/util';
import { FirebaseApp } from '@firebase/app';
import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
import { FirebaseError } from '@firebase/util';
import { _FirebaseService } from '@firebase/app';
import { NextFn } from '@firebase/util';
import { Provider } from '@firebase/component';
import { Subscribe } from '@firebase/util';
import { Unsubscribe } from '@firebase/util';
/**
* A function that is called if the event stream ends normally.
*/
declare type CompleteFn_2 = () => void;
/**
* A lightweight wrapper around XMLHttpRequest with a
* goog.net.XhrIo-like interface.
*
* You can create a new connection by invoking `newTextConnection()`,
* `newBytesConnection()` or `newStreamConnection()`.
*/
declare interface Connection {
/**
* Sends a request to the provided URL.
*
* This method never rejects its promise. In case of encountering an error,
* it sets an error code internally which can be accessed by calling
* getErrorCode() by callers.
*/
send(url: string, method: string, body?: ArrayBufferView | Blob | string | null, headers?: Headers_2): Promise;
getErrorCode(): ErrorCode;
getStatus(): number;
getResponse(): T;
getErrorText(): string;
/**
* Abort the request.
*/
abort(): void;
getResponseHeader(header: string): string | null;
addUploadProgressListener(listener: (p1: ProgressEvent) => void): void;
removeUploadProgressListener(listener: (p1: ProgressEvent) => void): void;
}
/** Response type exposed by the networking APIs. */
declare type ConnectionType = string | ArrayBuffer | Blob | NodeJS.ReadableStream;
/**
* Modify this {@link FirebaseStorage} instance to communicate with the Cloud Storage emulator.
*
* @param storage - The {@link FirebaseStorage} instance
* @param host - The emulator host (ex: localhost)
* @param port - The emulator port (ex: 5001)
* @param options - Emulator options. `options.mockUserToken` is the mock auth
* token to use for unit testing Security Rules.
* @public
*/
export declare function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
mockUserToken?: EmulatorMockTokenOptions | string;
}): void;
/**
* @internal
*/
export declare function _dataFromString(format: StringFormat, stringData: string): StringData;
/**
* Deletes the object at this location.
* @public
* @param ref - {@link StorageReference} for object to delete.
* @returns A `Promise` that resolves if the deletion succeeds.
*/
export declare function deleteObject(ref: StorageReference): Promise;
export { EmulatorMockTokenOptions }
/**
* Error codes for requests made by the the XhrIo wrapper.
*/
declare enum ErrorCode {
NO_ERROR = 0,
NETWORK_ERROR = 1,
ABORT = 2
}
/**
* A function that is called with a `StorageError`
* if the event stream ends due to an error.
*/
declare type ErrorFn = (error: StorageError_2) => void;
/** A function to handle an error. */
declare type ErrorHandler = (connection: Connection, response: StorageError_2) => StorageError_2;
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @param opt_elideCopy - If true, doesn't copy mutable input data
* (e.g. Uint8Arrays). Pass true only if you know the objects will not be
* modified after this blob's construction.
*
* @internal
*/
export declare class _FbsBlob {
private data_;
private size_;
private type_;
constructor(data: Blob | Uint8Array | ArrayBuffer, elideCopy?: boolean);
size(): number;
type(): string;
slice(startByte: number, endByte: number): _FbsBlob | null;
static getBlob(...args: Array): _FbsBlob | null;
uploadData(): Blob | Uint8Array;
}
/**
* A Firebase Storage instance.
* @public
*/
export declare interface FirebaseStorage extends _FirebaseService {
/**
* The {@link @firebase/app#FirebaseApp} associated with this `FirebaseStorage` instance.
*/
readonly app: FirebaseApp;
/**
* The maximum time to retry uploads in milliseconds.
*/
maxUploadRetryTime: number;
/**
* The maximum time to retry operations other than uploads or downloads in
* milliseconds.
*/
maxOperationRetryTime: number;
}
/**
* A service that provides Firebase Storage Reference instances.
* @param opt_url - gs:// url to a custom Storage Bucket
*
* @internal
*/
export declare class _FirebaseStorageImpl implements FirebaseStorage {
/**
* FirebaseApp associated with this StorageService instance.
*/
readonly app: FirebaseApp;
readonly _authProvider: Provider;
/**
* @internal
*/
readonly _appCheckProvider: Provider;
/**
* @internal
*/
readonly _url?: string | undefined;
readonly _firebaseVersion?: string | undefined;
_bucket: _Location | null;
/**
* This string can be in the formats:
* - host
* - host:port
*/
private _host;
_protocol: string;
protected readonly _appId: string | null;
private readonly _requests;
private _deleted;
private _maxOperationRetryTime;
private _maxUploadRetryTime;
_overrideAuthToken?: string;
constructor(
/**
* FirebaseApp associated with this StorageService instance.
*/
app: FirebaseApp, _authProvider: Provider,
/**
* @internal
*/
_appCheckProvider: Provider,
/**
* @internal
*/
_url?: string | undefined, _firebaseVersion?: string | undefined);
/**
* The host string for this service, in the form of `host` or
* `host:port`.
*/
get host(): string;
set host(host: string);
/**
* The maximum time to retry uploads in milliseconds.
*/
get maxUploadRetryTime(): number;
set maxUploadRetryTime(time: number);
/**
* The maximum time to retry operations other than uploads or downloads in
* milliseconds.
*/
get maxOperationRetryTime(): number;
set maxOperationRetryTime(time: number);
_getAuthToken(): Promise;
_getAppCheckToken(): Promise;
/**
* Stop running requests and prevent more from being created.
*/
_delete(): Promise;
/**
* Returns a new firebaseStorage.Reference object referencing this StorageService
* at the given Location.
*/
_makeStorageReference(loc: _Location): _Reference;
/**
* @param requestInfo - HTTP RequestInfo object
* @param authToken - Firebase auth token
*/
_makeRequest(requestInfo: RequestInfo_2, requestFactory: () => Connection, authToken: string | null, appCheckToken: string | null, retry?: boolean): Request_2;
makeRequestWithTokens(requestInfo: RequestInfo_2, requestFactory: () => Connection): Promise;
}
/**
* The full set of object metadata, including read-only properties.
* @public
*/
export declare interface FullMetadata extends UploadMetadata {
/**
* The bucket this object is contained in.
*/
bucket: string;
/**
* The full path of this object.
*/
fullPath: string;
/**
* The object's generation.
* {@link https://cloud.google.com/storage/docs/metadata#generation-number}
*/
generation: string;
/**
* The object's metageneration.
* {@link https://cloud.google.com/storage/docs/metadata#generation-number}
*/
metageneration: string;
/**
* The short name of this object, which is the last component of the full path.
* For example, if fullPath is 'full/path/image.png', name is 'image.png'.
*/
name: string;
/**
* The size of this object, in bytes.
*/
size: number;
/**
* A date string representing when this object was created.
*/
timeCreated: string;
/**
* A date string representing when this object was last updated.
*/
updated: string;
/**
* Tokens to allow access to the downloatd URL.
*/
downloadTokens: string[] | undefined;
/**
* `StorageReference` associated with this upload.
*/
ref?: StorageReference | undefined;
}
/**
* Downloads the data at the object's location. Returns an error if the object
* is not found.
*
* To use this functionality, you have to whitelist your app's origin in your
* Cloud Storage bucket. See also
* https://cloud.google.com/storage/docs/configuring-cors
*
* This API is not available in Node.
*
* @public
* @param ref - StorageReference where data should be downloaded.
* @param maxDownloadSizeBytes - If set, the maximum allowed size in bytes to
* retrieve.
* @returns A Promise that resolves with a Blob containing the object's bytes
*/
export declare function getBlob(ref: StorageReference, maxDownloadSizeBytes?: number): Promise;
/**
* Downloads the data at the object's location. Returns an error if the object
* is not found.
*
* To use this functionality, you have to whitelist your app's origin in your
* Cloud Storage bucket. See also
* https://cloud.google.com/storage/docs/configuring-cors
*
* @public
* @param ref - StorageReference where data should be downloaded.
* @param maxDownloadSizeBytes - If set, the maximum allowed size in bytes to
* retrieve.
* @returns A Promise containing the object's bytes
*/
export declare function getBytes(ref: StorageReference, maxDownloadSizeBytes?: number): Promise;
/**
* @internal
*/
export declare function _getChild(ref: StorageReference, childPath: string): _Reference;
/**
* Returns the download URL for the given {@link StorageReference}.
* @public
* @param ref - {@link StorageReference} to get the download URL for.
* @returns A `Promise` that resolves with the download
* URL for this object.
*/
export declare function getDownloadURL(ref: StorageReference): Promise;
/**
* A `Promise` that resolves with the metadata for this object. If this
* object doesn't exist or metadata cannot be retreived, the promise is
* rejected.
* @public
* @param ref - {@link StorageReference} to get metadata from.
*/
export declare function getMetadata(ref: StorageReference): Promise;
/**
* Gets a {@link FirebaseStorage} instance for the given Firebase app.
* @public
* @param app - Firebase app to get {@link FirebaseStorage} instance for.
* @param bucketUrl - The gs:// url to your Firebase Storage Bucket.
* If not passed, uses the app's default Storage Bucket.
* @returns A {@link FirebaseStorage} instance.
*/
export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;
/**
* Downloads the data at the object's location. Raises an error event if the
* object is not found.
*
* This API is only available in Node.
*
* @public
* @param ref - StorageReference where data should be downloaded.
* @param maxDownloadSizeBytes - If set, the maximum allowed size in bytes to
* retrieve.
* @returns A stream with the object's data as bytes
*/
export declare function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): NodeJS.ReadableStream;
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
///
/** Network headers */
declare type Headers_2 = Record;
/**
* Internal enum for task state.
*/
declare const enum InternalTaskState {
RUNNING = "running",
PAUSING = "pausing",
PAUSED = "paused",
SUCCESS = "success",
CANCELING = "canceling",
CANCELED = "canceled",
ERROR = "error"
}
/**
* @internal
*/
export declare function _invalidArgument(message: string): StorageError_2;
/**
* @param name - The name of the operation that was invalid.
*
* @internal
*/
export declare function _invalidRootOperation(name: string): StorageError_2;
/**
* List items (files) and prefixes (folders) under this storage reference.
*
* List API is only available for Firebase Rules Version 2.
*
* GCS is a key-blob store. Firebase Storage imposes the semantic of '/'
* delimited folder structure.
* Refer to GCS's List API if you want to learn more.
*
* To adhere to Firebase Rules's Semantics, Firebase Storage does not
* support objects whose paths end with "/" or contain two consecutive
* "/"s. Firebase Storage List API will filter these unsupported objects.
* list() may fail if there are too many unsupported objects in the bucket.
* @public
*
* @param ref - {@link StorageReference} to get list from.
* @param options - See {@link ListOptions} for details.
* @returns A `Promise` that resolves with the items and prefixes.
* `prefixes` contains references to sub-folders and `items`
* contains references to objects in this folder. `nextPageToken`
* can be used to get the rest of the results.
*/
export declare function list(ref: StorageReference, options?: ListOptions): Promise;
/**
* List all items (files) and prefixes (folders) under this storage reference.
*
* This is a helper method for calling list() repeatedly until there are
* no more results. The default pagination size is 1000.
*
* Note: The results may not be consistent if objects are changed while this
* operation is running.
*
* Warning: `listAll` may potentially consume too many resources if there are
* too many results.
* @public
* @param ref - {@link StorageReference} to get list from.
*
* @returns A `Promise` that resolves with all the items and prefixes under
* the current storage reference. `prefixes` contains references to
* sub-directories and `items` contains references to objects in this
* folder. `nextPageToken` is never returned.
*/
export declare function listAll(ref: StorageReference): Promise;
/**
* The options `list()` accepts.
* @public
*/
export declare interface ListOptions {
/**
* If set, limits the total number of `prefixes` and `items` to return.
* The default and maximum maxResults is 1000.
*/
maxResults?: number | null;
/**
* The `nextPageToken` from a previous call to `list()`. If provided,
* listing is resumed from the previous position.
*/
pageToken?: string | null;
}
/**
* Result returned by list().
* @public
*/
export declare interface ListResult {
/**
* References to prefixes (sub-folders). You can call list() on them to
* get its contents.
*
* Folders are implicit based on '/' in the object paths.
* For example, if a bucket has two objects '/a/b/1' and '/a/b/2', list('/a')
* will return '/a/b' as a prefix.
*/
prefixes: StorageReference[];
/**
* Objects in this directory.
* You can call getMetadata() and getDownloadUrl() on them.
*/
items: StorageReference[];
/**
* If set, there might be more results for this list. Use this token to resume the list.
*/
nextPageToken?: string;
}
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Firebase Storage location data.
*
* @internal
*/
export declare class _Location {
readonly bucket: string;
private path_;
constructor(bucket: string, path: string);
get path(): string;
get isRoot(): boolean;
fullServerUrl(): string;
bucketOnlyServerUrl(): string;
static makeFromBucketSpec(bucketString: string, host: string): _Location;
static makeFromUrl(url: string, host: string): _Location;
}
/**
* @fileoverview Documentation for the metadata format.
*/
/**
* The full set of object metadata, including read-only properties.
*/
declare interface Metadata extends FullMetadata {
[prop: string]: unknown;
}
/**
* Function that is called once for each value in a stream of values.
*/
declare type NextFn_2 = (value: T) => void;
/**
* Returns a {@link StorageReference} for the given url.
* @param storage - {@link FirebaseStorage} instance.
* @param url - URL. If empty, returns root reference.
* @public
*/
export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;
/**
* Returns a {@link StorageReference} for the given path in the
* default bucket.
* @param storageOrRef - {@link FirebaseStorage} or {@link StorageReference}.
* @param pathOrUrlStorage - path. If empty, returns root reference (if {@link FirebaseStorage}
* instance provided) or returns same reference (if {@link StorageReference} provided).
* @public
*/
export declare function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): StorageReference;
/**
* Provides methods to interact with a bucket in the Firebase Storage service.
* @internal
* @param _location - An fbs.location, or the URL at
* which to base this object, in one of the following forms:
* gs:///
* http[s]://firebasestorage.googleapis.com/
* /b//o/
* Any query or fragment strings will be ignored in the http[s]
* format. If no value is passed, the storage object will use a URL based on
* the project ID of the base firebase.App instance.
*/
export declare class _Reference {
private _service;
_location: _Location;
constructor(_service: _FirebaseStorageImpl, location: string | _Location);
/**
* Returns the URL for the bucket and path this object references,
* in the form gs:///
* @override
*/
toString(): string;
protected _newRef(service: _FirebaseStorageImpl, location: _Location): _Reference;
/**
* A reference to the root of this object's bucket.
*/
get root(): _Reference;
/**
* The name of the bucket containing this reference's object.
*/
get bucket(): string;
/**
* The full path of this object.
*/
get fullPath(): string;
/**
* The short name of this object, which is the last component of the full path.
* For example, if fullPath is 'full/path/image.png', name is 'image.png'.
*/
get name(): string;
/**
* The `StorageService` instance this `StorageReference` is associated with.
*/
get storage(): _FirebaseStorageImpl;
/**
* A `StorageReference` pointing to the parent location of this `StorageReference`, or null if
* this reference is the root.
*/
get parent(): _Reference | null;
/**
* Utility function to throw an error in methods that do not accept a root reference.
*/
_throwIfRoot(name: string): void;
}
declare interface Request_2 {
getPromise(): Promise;
/**
* Cancels the request. IMPORTANT: the promise may still be resolved with an
* appropriate value (if the request is finished before you call this method,
* but the promise has not yet been resolved), so don't just assume it will be
* rejected if you call this function.
* @param appDelete - True if the cancelation came from the app being deleted.
*/
cancel(appDelete?: boolean): void;
}
/**
* A function that converts a server response to the API type expected by the
* SDK.
*
* @param I - the type of the backend's network response
* @param O - the output response type used by the rest of the SDK.
*/
declare type RequestHandler = (connection: Connection, response: I) => O;
/**
* Contains a fully specified request.
*
* @param I - the type of the backend's network response.
* @param O - the output response type used by the rest of the SDK.
*/
declare class RequestInfo_2 {
url: string;
method: string;
/**
* Returns the value with which to resolve the request's promise. Only called
* if the request is successful. Throw from this function to reject the
* returned Request's promise with the thrown error.
* Note: The XhrIo passed to this function may be reused after this callback
* returns. Do not keep a reference to it in any way.
*/
handler: RequestHandler;
timeout: number;
urlParams: UrlParams;
headers: Headers_2;
body: Blob | string | Uint8Array | null;
errorHandler: ErrorHandler | null;
/**
* Called with the current number of bytes uploaded and total size (-1 if not
* computable) of the request body (i.e. used to report upload progress).
*/
progressCallback: ((p1: number, p2: number) => void) | null;
successCodes: number[];
additionalRetryCodes: number[];
constructor(url: string, method: string,
/**
* Returns the value with which to resolve the request's promise. Only called
* if the request is successful. Throw from this function to reject the
* returned Request's promise with the thrown error.
* Note: The XhrIo passed to this function may be reused after this callback
* returns. Do not keep a reference to it in any way.
*/
handler: RequestHandler, timeout: number);
}
/**
* Object metadata that can be set at any time.
* @public
*/
export declare interface SettableMetadata {
/**
* Served as the 'Cache-Control' header on object download.
*/
cacheControl?: string | undefined;
/**
* Served as the 'Content-Disposition' header on object download.
*/
contentDisposition?: string | undefined;
/**
* Served as the 'Content-Encoding' header on object download.
*/
contentEncoding?: string | undefined;
/**
* Served as the 'Content-Language' header on object download.
*/
contentLanguage?: string | undefined;
/**
* Served as the 'Content-Type' header on object download.
*/
contentType?: string | undefined;
/**
* Additional user-defined custom metadata.
*/
customMetadata?: {
[key: string]: string;
} | undefined;
}
/**
* An error returned by the Firebase Storage SDK.
* @public
*/
export declare interface StorageError extends FirebaseError {
/**
* A server response message for the error, if applicable.
*/
serverResponse: string | null;
}
/**
* An error returned by the Firebase Storage SDK.
* @public
*/
declare class StorageError_2 extends FirebaseError {
private status_;
private readonly _baseMessage;
/**
* Stores custom error data unque to StorageError.
*/
customData: {
serverResponse: string | null;
};
/**
* @param code - A StorageErrorCode string to be prefixed with 'storage/' and
* added to the end of the message.
* @param message - Error message.
* @param status_ - Corresponding HTTP Status Code
*/
constructor(code: StorageErrorCode, message: string, status_?: number);
get status(): number;
set status(status: number);
/**
* Compares a StorageErrorCode against this error's code, filtering out the prefix.
*/
_codeEquals(code: StorageErrorCode): boolean;
/**
* Optional response message that was added by the server.
*/
get serverResponse(): null | string;
set serverResponse(serverResponse: string | null);
}
/**
* @public
* Error codes that can be attached to `StorageError`s.
*/
declare const enum StorageErrorCode {
UNKNOWN = "unknown",
OBJECT_NOT_FOUND = "object-not-found",
BUCKET_NOT_FOUND = "bucket-not-found",
PROJECT_NOT_FOUND = "project-not-found",
QUOTA_EXCEEDED = "quota-exceeded",
UNAUTHENTICATED = "unauthenticated",
UNAUTHORIZED = "unauthorized",
UNAUTHORIZED_APP = "unauthorized-app",
RETRY_LIMIT_EXCEEDED = "retry-limit-exceeded",
INVALID_CHECKSUM = "invalid-checksum",
CANCELED = "canceled",
INVALID_EVENT_NAME = "invalid-event-name",
INVALID_URL = "invalid-url",
INVALID_DEFAULT_BUCKET = "invalid-default-bucket",
NO_DEFAULT_BUCKET = "no-default-bucket",
CANNOT_SLICE_BLOB = "cannot-slice-blob",
SERVER_FILE_WRONG_SIZE = "server-file-wrong-size",
NO_DOWNLOAD_URL = "no-download-url",
INVALID_ARGUMENT = "invalid-argument",
INVALID_ARGUMENT_COUNT = "invalid-argument-count",
APP_DELETED = "app-deleted",
INVALID_ROOT_OPERATION = "invalid-root-operation",
INVALID_FORMAT = "invalid-format",
INTERNAL_ERROR = "internal-error",
UNSUPPORTED_ENVIRONMENT = "unsupported-environment"
}
/**
* A stream observer for Firebase Storage.
* @public
*/
export declare interface StorageObserver {
next?: NextFn | null;
error?: (error: StorageError) => void | null;
complete?: CompleteFn | null;
}
/**
* An observer identical to the `Observer` defined in packages/util except the
* error passed into the ErrorFn is specifically a `StorageError`.
*/
declare interface StorageObserver_2 {
/**
* Function that is called once for each value in the event stream.
*/
next?: NextFn_2;
/**
* A function that is called with a `StorageError`
* if the event stream ends due to an error.
*/
error?: ErrorFn;
/**
* A function that is called if the event stream ends normally.
*/
complete?: CompleteFn_2;
}
/**
* Represents a reference to a Google Cloud Storage object. Developers can
* upload, download, and delete objects, as well as get/set object metadata.
* @public
*/
export declare interface StorageReference {
/**
* Returns a gs:// URL for this object in the form
* `gs://///