@firebase/storage 0.13.3 → 0.13.4

package/dist/src/implementation/requestinfo.d.ts

@@ -1,73 +1,73 @@
-/**
- * @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.
- */
-import { StorageError } from './error';
-import { Headers, Connection, ConnectionType } from './connection';
-/**
- * Type for url params stored in RequestInfo.
- */
-export interface UrlParams {
-    [name: string]: string | number;
-}
-/**
- * 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.
- */
-export declare type RequestHandler<I extends ConnectionType, O> = (connection: Connection<I>, response: I) => O;
-/** A function to handle an error. */
-export declare type ErrorHandler = (connection: Connection<ConnectionType>, response: StorageError) => StorageError;
-/**
- * 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.
- */
-export declare class RequestInfo<I extends ConnectionType, O> {
-    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<I, O>;
-    timeout: number;
-    urlParams: UrlParams;
-    headers: Headers;
-    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<I, O>, timeout: number);
-}
+/**
+ * @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.
+ */
+import { StorageError } from './error';
+import { Headers, Connection, ConnectionType } from './connection';
+/**
+ * Type for url params stored in RequestInfo.
+ */
+export interface UrlParams {
+    [name: string]: string | number;
+}
+/**
+ * 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.
+ */
+export type RequestHandler<I extends ConnectionType, O> = (connection: Connection<I>, response: I) => O;
+/** A function to handle an error. */
+export type ErrorHandler = (connection: Connection<ConnectionType>, response: StorageError) => StorageError;
+/**
+ * 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.
+ */
+export declare class RequestInfo<I extends ConnectionType, O> {
+    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<I, O>;
+    timeout: number;
+    urlParams: UrlParams;
+    headers: Headers;
+    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<I, O>, timeout: number);
+}

package/dist/src/implementation/requests.d.ts

@@ -1,84 +1,84 @@
-/**
- * @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.
- */
-/**
- * @fileoverview Defines methods for interacting with the network.
- */
-import { Metadata } from '../metadata';
-import { ListResult } from '../list';
-import { FbsBlob } from './blob';
-import { StorageError } from './error';
-import { Location } from './location';
-import { Mappings } from './metadata';
-import { RequestInfo } from './requestinfo';
-import { Connection, ConnectionType } from './connection';
-import { FirebaseStorageImpl } from '../service';
-/**
- * Throws the UNKNOWN StorageError if cndn is false.
- */
-export declare function handlerCheck(cndn: boolean): void;
-export declare function metadataHandler(service: FirebaseStorageImpl, mappings: Mappings): (p1: Connection<string>, p2: string) => Metadata;
-export declare function listHandler(service: FirebaseStorageImpl, bucket: string): (p1: Connection<string>, p2: string) => ListResult;
-export declare function downloadUrlHandler(service: FirebaseStorageImpl, mappings: Mappings): (p1: Connection<string>, p2: string) => string | null;
-export declare function sharedErrorHandler(location: Location): (p1: Connection<ConnectionType>, p2: StorageError) => StorageError;
-export declare function objectErrorHandler(location: Location): (p1: Connection<ConnectionType>, p2: StorageError) => StorageError;
-export declare function getMetadata(service: FirebaseStorageImpl, location: Location, mappings: Mappings): RequestInfo<string, Metadata>;
-export declare function list(service: FirebaseStorageImpl, location: Location, delimiter?: string, pageToken?: string | null, maxResults?: number | null): RequestInfo<string, ListResult>;
-export declare function getBytes<I extends ConnectionType>(service: FirebaseStorageImpl, location: Location, maxDownloadSizeBytes?: number): RequestInfo<I, I>;
-export declare function getDownloadUrl(service: FirebaseStorageImpl, location: Location, mappings: Mappings): RequestInfo<string, string | null>;
-export declare function updateMetadata(service: FirebaseStorageImpl, location: Location, metadata: Partial<Metadata>, mappings: Mappings): RequestInfo<string, Metadata>;
-export declare function deleteObject(service: FirebaseStorageImpl, location: Location): RequestInfo<string, void>;
-export declare function determineContentType_(metadata: Metadata | null, blob: FbsBlob | null): string;
-export declare function metadataForUpload_(location: Location, blob: FbsBlob, metadata?: Metadata | null): Metadata;
-/**
- * Prepare RequestInfo for uploads as Content-Type: multipart.
- */
-export declare function multipartUpload(service: FirebaseStorageImpl, location: Location, mappings: Mappings, blob: FbsBlob, metadata?: Metadata | null): RequestInfo<string, Metadata>;
-/**
- * @param current The number of bytes that have been uploaded so far.
- * @param total The total number of bytes in the upload.
- * @param opt_finalized True if the server has finished the upload.
- * @param opt_metadata The upload metadata, should
- *     only be passed if opt_finalized is true.
- */
-export declare class ResumableUploadStatus {
-    current: number;
-    total: number;
-    finalized: boolean;
-    metadata: Metadata | null;
-    constructor(current: number, total: number, finalized?: boolean, metadata?: Metadata | null);
-}
-export declare function checkResumeHeader_(xhr: Connection<string>, allowed?: string[]): string;
-export declare function createResumableUpload(service: FirebaseStorageImpl, location: Location, mappings: Mappings, blob: FbsBlob, metadata?: Metadata | null): RequestInfo<string, string>;
-/**
- * @param url From a call to fbs.requests.createResumableUpload.
- */
-export declare function getResumableUploadStatus(service: FirebaseStorageImpl, location: Location, url: string, blob: FbsBlob): RequestInfo<string, ResumableUploadStatus>;
-/**
- * Any uploads via the resumable upload API must transfer a number of bytes
- * that is a multiple of this number.
- */
-export declare const RESUMABLE_UPLOAD_CHUNK_SIZE: number;
-/**
- * @param url From a call to fbs.requests.createResumableUpload.
- * @param chunkSize Number of bytes to upload.
- * @param status The previous status.
- *     If not passed or null, we start from the beginning.
- * @throws fbs.Error If the upload is already complete, the passed in status
- *     has a final size inconsistent with the blob, or the blob cannot be sliced
- *     for upload.
- */
-export declare function continueResumableUpload(location: Location, service: FirebaseStorageImpl, url: string, blob: FbsBlob, chunkSize: number, mappings: Mappings, status?: ResumableUploadStatus | null, progressCallback?: ((p1: number, p2: number) => void) | null): RequestInfo<string, ResumableUploadStatus>;
+/**
+ * @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.
+ */
+/**
+ * @fileoverview Defines methods for interacting with the network.
+ */
+import { Metadata } from '../metadata';
+import { ListResult } from '../list';
+import { FbsBlob } from './blob';
+import { StorageError } from './error';
+import { Location } from './location';
+import { Mappings } from './metadata';
+import { RequestInfo } from './requestinfo';
+import { Connection, ConnectionType } from './connection';
+import { FirebaseStorageImpl } from '../service';
+/**
+ * Throws the UNKNOWN StorageError if cndn is false.
+ */
+export declare function handlerCheck(cndn: boolean): void;
+export declare function metadataHandler(service: FirebaseStorageImpl, mappings: Mappings): (p1: Connection<string>, p2: string) => Metadata;
+export declare function listHandler(service: FirebaseStorageImpl, bucket: string): (p1: Connection<string>, p2: string) => ListResult;
+export declare function downloadUrlHandler(service: FirebaseStorageImpl, mappings: Mappings): (p1: Connection<string>, p2: string) => string | null;
+export declare function sharedErrorHandler(location: Location): (p1: Connection<ConnectionType>, p2: StorageError) => StorageError;
+export declare function objectErrorHandler(location: Location): (p1: Connection<ConnectionType>, p2: StorageError) => StorageError;
+export declare function getMetadata(service: FirebaseStorageImpl, location: Location, mappings: Mappings): RequestInfo<string, Metadata>;
+export declare function list(service: FirebaseStorageImpl, location: Location, delimiter?: string, pageToken?: string | null, maxResults?: number | null): RequestInfo<string, ListResult>;
+export declare function getBytes<I extends ConnectionType>(service: FirebaseStorageImpl, location: Location, maxDownloadSizeBytes?: number): RequestInfo<I, I>;
+export declare function getDownloadUrl(service: FirebaseStorageImpl, location: Location, mappings: Mappings): RequestInfo<string, string | null>;
+export declare function updateMetadata(service: FirebaseStorageImpl, location: Location, metadata: Partial<Metadata>, mappings: Mappings): RequestInfo<string, Metadata>;
+export declare function deleteObject(service: FirebaseStorageImpl, location: Location): RequestInfo<string, void>;
+export declare function determineContentType_(metadata: Metadata | null, blob: FbsBlob | null): string;
+export declare function metadataForUpload_(location: Location, blob: FbsBlob, metadata?: Metadata | null): Metadata;
+/**
+ * Prepare RequestInfo for uploads as Content-Type: multipart.
+ */
+export declare function multipartUpload(service: FirebaseStorageImpl, location: Location, mappings: Mappings, blob: FbsBlob, metadata?: Metadata | null): RequestInfo<string, Metadata>;
+/**
+ * @param current The number of bytes that have been uploaded so far.
+ * @param total The total number of bytes in the upload.
+ * @param opt_finalized True if the server has finished the upload.
+ * @param opt_metadata The upload metadata, should
+ *     only be passed if opt_finalized is true.
+ */
+export declare class ResumableUploadStatus {
+    current: number;
+    total: number;
+    finalized: boolean;
+    metadata: Metadata | null;
+    constructor(current: number, total: number, finalized?: boolean, metadata?: Metadata | null);
+}
+export declare function checkResumeHeader_(xhr: Connection<string>, allowed?: string[]): string;
+export declare function createResumableUpload(service: FirebaseStorageImpl, location: Location, mappings: Mappings, blob: FbsBlob, metadata?: Metadata | null): RequestInfo<string, string>;
+/**
+ * @param url From a call to fbs.requests.createResumableUpload.
+ */
+export declare function getResumableUploadStatus(service: FirebaseStorageImpl, location: Location, url: string, blob: FbsBlob): RequestInfo<string, ResumableUploadStatus>;
+/**
+ * Any uploads via the resumable upload API must transfer a number of bytes
+ * that is a multiple of this number.
+ */
+export declare const RESUMABLE_UPLOAD_CHUNK_SIZE: number;
+/**
+ * @param url From a call to fbs.requests.createResumableUpload.
+ * @param chunkSize Number of bytes to upload.
+ * @param status The previous status.
+ *     If not passed or null, we start from the beginning.
+ * @throws fbs.Error If the upload is already complete, the passed in status
+ *     has a final size inconsistent with the blob, or the blob cannot be sliced
+ *     for upload.
+ */
+export declare function continueResumableUpload(location: Location, service: FirebaseStorageImpl, url: string, blob: FbsBlob, chunkSize: number, mappings: Mappings, status?: ResumableUploadStatus | null, progressCallback?: ((p1: number, p2: number) => void) | null): RequestInfo<string, ResumableUploadStatus>;

package/dist/src/implementation/string.d.ts

@@ -1,73 +1,73 @@
-/**
- * @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.
- */
-/**
- * An enumeration of the possible string formats for upload.
- * @public
- */
-export declare type StringFormat = (typeof StringFormat)[keyof typeof StringFormat];
-/**
- * An enumeration of the possible string formats for upload.
- * @public
- */
-export declare const StringFormat: {
-    /**
-     * Indicates the string should be interpreted "raw", that is, as normal text.
-     * The string will be interpreted as UTF-16, then uploaded as a UTF-8 byte
-     * sequence.
-     * Example: The string 'Hello! \\ud83d\\ude0a' becomes the byte sequence
-     * 48 65 6c 6c 6f 21 20 f0 9f 98 8a
-     */
-    readonly RAW: "raw";
-    /**
-     * Indicates the string should be interpreted as base64-encoded data.
-     * Padding characters (trailing '='s) are optional.
-     * Example: The string 'rWmO++E6t7/rlw==' becomes the byte sequence
-     * ad 69 8e fb e1 3a b7 bf eb 97
-     */
-    readonly BASE64: "base64";
-    /**
-     * Indicates the string should be interpreted as base64url-encoded data.
-     * Padding characters (trailing '='s) are optional.
-     * Example: The string 'rWmO--E6t7_rlw==' becomes the byte sequence
-     * ad 69 8e fb e1 3a b7 bf eb 97
-     */
-    readonly BASE64URL: "base64url";
-    /**
-     * Indicates the string is a data URL, such as one obtained from
-     * canvas.toDataURL().
-     * Example: the string 'data:application/octet-stream;base64,aaaa'
-     * becomes the byte sequence
-     * 69 a6 9a
-     * (the content-type "application/octet-stream" is also applied, but can
-     * be overridden in the metadata object).
-     */
-    readonly DATA_URL: "data_url";
-};
-export declare class StringData {
-    data: Uint8Array;
-    contentType: string | null;
-    constructor(data: Uint8Array, contentType?: string | null);
-}
-/**
- * @internal
- */
-export declare function dataFromString(format: StringFormat, stringData: string): StringData;
-export declare function utf8Bytes_(value: string): Uint8Array;
-export declare function percentEncodedBytes_(value: string): Uint8Array;
-export declare function base64Bytes_(format: StringFormat, value: string): Uint8Array;
-export declare function dataURLBytes_(dataUrl: string): Uint8Array;
-export declare function dataURLContentType_(dataUrl: string): string | null;
+/**
+ * @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.
+ */
+/**
+ * An enumeration of the possible string formats for upload.
+ * @public
+ */
+export type StringFormat = (typeof StringFormat)[keyof typeof StringFormat];
+/**
+ * An enumeration of the possible string formats for upload.
+ * @public
+ */
+export declare const StringFormat: {
+    /**
+     * Indicates the string should be interpreted "raw", that is, as normal text.
+     * The string will be interpreted as UTF-16, then uploaded as a UTF-8 byte
+     * sequence.
+     * Example: The string 'Hello! \\ud83d\\ude0a' becomes the byte sequence
+     * 48 65 6c 6c 6f 21 20 f0 9f 98 8a
+     */
+    readonly RAW: "raw";
+    /**
+     * Indicates the string should be interpreted as base64-encoded data.
+     * Padding characters (trailing '='s) are optional.
+     * Example: The string 'rWmO++E6t7/rlw==' becomes the byte sequence
+     * ad 69 8e fb e1 3a b7 bf eb 97
+     */
+    readonly BASE64: "base64";
+    /**
+     * Indicates the string should be interpreted as base64url-encoded data.
+     * Padding characters (trailing '='s) are optional.
+     * Example: The string 'rWmO--E6t7_rlw==' becomes the byte sequence
+     * ad 69 8e fb e1 3a b7 bf eb 97
+     */
+    readonly BASE64URL: "base64url";
+    /**
+     * Indicates the string is a data URL, such as one obtained from
+     * canvas.toDataURL().
+     * Example: the string 'data:application/octet-stream;base64,aaaa'
+     * becomes the byte sequence
+     * 69 a6 9a
+     * (the content-type "application/octet-stream" is also applied, but can
+     * be overridden in the metadata object).
+     */
+    readonly DATA_URL: "data_url";
+};
+export declare class StringData {
+    data: Uint8Array;
+    contentType: string | null;
+    constructor(data: Uint8Array, contentType?: string | null);
+}
+/**
+ * @internal
+ */
+export declare function dataFromString(format: StringFormat, stringData: string): StringData;
+export declare function utf8Bytes_(value: string): Uint8Array;
+export declare function percentEncodedBytes_(value: string): Uint8Array;
+export declare function base64Bytes_(format: StringFormat, value: string): Uint8Array;
+export declare function dataURLBytes_(dataUrl: string): Uint8Array;
+export declare function dataURLContentType_(dataUrl: string): string | null;

package/dist/src/implementation/taskenums.d.ts

@@ -1,77 +1,77 @@
-/**
- * @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.
- */
-/**
- * @fileoverview Enumerations used for upload tasks.
- */
-/**
- * An event that is triggered on a task.
- * @internal
- */
-export declare type TaskEvent = string;
-/**
- * An event that is triggered on a task.
- * @internal
- */
-export declare const TaskEvent: {
-    /**
-     * For this event,
-     * <ul>
-     *   <li>The `next` function is triggered on progress updates and when the
-     *       task is paused/resumed with an `UploadTaskSnapshot` as the first
-     *       argument.</li>
-     *   <li>The `error` function is triggered if the upload is canceled or fails
-     *       for another reason.</li>
-     *   <li>The `complete` function is triggered if the upload completes
-     *       successfully.</li>
-     * </ul>
-     */
-    STATE_CHANGED: string;
-};
-/**
- * Internal enum for task state.
- */
-export declare const enum InternalTaskState {
-    RUNNING = "running",
-    PAUSING = "pausing",
-    PAUSED = "paused",
-    SUCCESS = "success",
-    CANCELING = "canceling",
-    CANCELED = "canceled",
-    ERROR = "error"
-}
-/**
- * Represents the current state of a running upload.
- * @internal
- */
-export declare type TaskState = (typeof TaskState)[keyof typeof TaskState];
-/**
- * Represents the current state of a running upload.
- * @internal
- */
-export declare const TaskState: {
-    /** The task is currently transferring data. */
-    readonly RUNNING: "running";
-    /** The task was paused by the user. */
-    readonly PAUSED: "paused";
-    /** The task completed successfully. */
-    readonly SUCCESS: "success";
-    /** The task was canceled. */
-    readonly CANCELED: "canceled";
-    /** The task failed with an error. */
-    readonly ERROR: "error";
-};
-export declare function taskStateFromInternalTaskState(state: InternalTaskState): TaskState;
+/**
+ * @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.
+ */
+/**
+ * @fileoverview Enumerations used for upload tasks.
+ */
+/**
+ * An event that is triggered on a task.
+ * @internal
+ */
+export type TaskEvent = string;
+/**
+ * An event that is triggered on a task.
+ * @internal
+ */
+export declare const TaskEvent: {
+    /**
+     * For this event,
+     * <ul>
+     *   <li>The `next` function is triggered on progress updates and when the
+     *       task is paused/resumed with an `UploadTaskSnapshot` as the first
+     *       argument.</li>
+     *   <li>The `error` function is triggered if the upload is canceled or fails
+     *       for another reason.</li>
+     *   <li>The `complete` function is triggered if the upload completes
+     *       successfully.</li>
+     * </ul>
+     */
+    STATE_CHANGED: string;
+};
+/**
+ * Internal enum for task state.
+ */
+export declare const enum InternalTaskState {
+    RUNNING = "running",
+    PAUSING = "pausing",
+    PAUSED = "paused",
+    SUCCESS = "success",
+    CANCELING = "canceling",
+    CANCELED = "canceled",
+    ERROR = "error"
+}
+/**
+ * Represents the current state of a running upload.
+ * @internal
+ */
+export type TaskState = (typeof TaskState)[keyof typeof TaskState];
+/**
+ * Represents the current state of a running upload.
+ * @internal
+ */
+export declare const TaskState: {
+    /** The task is currently transferring data. */
+    readonly RUNNING: "running";
+    /** The task was paused by the user. */
+    readonly PAUSED: "paused";
+    /** The task completed successfully. */
+    readonly SUCCESS: "success";
+    /** The task was canceled. */
+    readonly CANCELED: "canceled";
+    /** The task failed with an error. */
+    readonly ERROR: "error";
+};
+export declare function taskStateFromInternalTaskState(state: InternalTaskState): TaskState;