@firebase/storage 0.9.10 → 0.9.11-20221010190246

package/dist/node-esm/src/implementation/backoff.d.ts

@@ -21,12 +21,18 @@
 declare type id = (p1: boolean) => void;
 export { id };
 /**
- * @param f May be invoked
- *     before the function returns.
- * @param callback Get all the arguments passed to the function
- *     passed to f, including the initial boolean.
+ * Accepts a callback for an action to perform (`doRequest`),
+ * and then a callback for when the backoff has completed (`backoffCompleteCb`).
+ * The callback sent to start requires an argument to call (`onRequestComplete`).
+ * When `start` calls `doRequest`, it passes a callback for when the request has
+ * completed, `onRequestComplete`. Based on this, the backoff continues, with
+ * another call to `doRequest` and the above loop continues until the timeout
+ * is hit, or a successful response occurs.
+ * @description
+ * @param doRequest Callback to perform request
+ * @param backoffCompleteCb Callback to call when backoff has been completed
  */
-export declare function start(f: (p1: (success: boolean) => void, canceled: boolean) => void, callback: (...args: any[]) => unknown, timeout: number): id;
+export declare function start(doRequest: (onRequestComplete: (success: boolean) => void, canceled: boolean) => void, backoffCompleteCb: (...args: any[]) => unknown, timeout: number): id;
 /**
  * Stops the retry loop from repeating.
  * If the function is currently "in between" retries, it is invoked immediately

package/dist/node-esm/src/implementation/constants.d.ts

@@ -37,6 +37,10 @@ export declare const DEFAULT_MAX_OPERATION_RETRY_TIME: number;
  * The timeout for upload.
  */
 export declare const DEFAULT_MAX_UPLOAD_RETRY_TIME: number;
+/**
+ * 1 second
+ */
+export declare const DEFAULT_MIN_SLEEP_TIME_MILLIS = 1000;
 /**
  * This is the value of Number.MIN_SAFE_INTEGER, which is not well supported
  * enough for us to use it directly.

package/dist/node-esm/src/implementation/error.d.ts

@@ -20,6 +20,7 @@ import { FirebaseError } from '@firebase/util';
  * @public
  */
 export declare class StorageError extends FirebaseError {
+    private status_;
     private readonly _baseMessage;
     /**
      * Stores custom error data unque to StorageError.
@@ -31,8 +32,11 @@ export declare class StorageError extends FirebaseError {
      * @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);
+    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.
      */

package/dist/node-esm/src/implementation/request.d.ts

@@ -44,4 +44,4 @@ export declare function addAuthHeader_(headers: Headers, authToken: string | nul
 export declare function addVersionHeader_(headers: Headers, firebaseVersion?: string): void;
 export declare function addGmpidHeader_(headers: Headers, appId: string | null): void;
 export declare function addAppCheckHeader_(headers: Headers, appCheckToken: string | null): void;
-export declare function makeRequest<I extends ConnectionType, O>(requestInfo: RequestInfo<I, O>, appId: string | null, authToken: string | null, appCheckToken: string | null, requestFactory: () => Connection<I>, firebaseVersion?: string): Request<O>;
+export declare function makeRequest<I extends ConnectionType, O>(requestInfo: RequestInfo<I, O>, appId: string | null, authToken: string | null, appCheckToken: string | null, requestFactory: () => Connection<I>, firebaseVersion?: string, retry?: boolean): Request<O>;

package/dist/node-esm/src/implementation/utils.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @license
+ * Copyright 2022 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.
+ */
+/**
+ * Checks the status code to see if the action should be retried.
+ *
+ * @param status Current HTTP status code returned by server.
+ * @param additionalRetryCodes additional retry codes to check against
+ */
+export declare function isRetryStatusCode(status: number, additionalRetryCodes: number[]): boolean;

package/dist/node-esm/src/service.d.ts

@@ -125,6 +125,6 @@ export declare class FirebaseStorageImpl implements FirebaseStorage {
      * @param requestInfo - HTTP RequestInfo object
      * @param authToken - Firebase auth token
      */
-    _makeRequest<I extends ConnectionType, O>(requestInfo: RequestInfo<I, O>, requestFactory: () => Connection<I>, authToken: string | null, appCheckToken: string | null): Request<O>;
+    _makeRequest<I extends ConnectionType, O>(requestInfo: RequestInfo<I, O>, requestFactory: () => Connection<I>, authToken: string | null, appCheckToken: string | null, retry?: boolean): Request<O>;
     makeRequestWithTokens<I extends ConnectionType, O>(requestInfo: RequestInfo<I, O>, requestFactory: () => Connection<I>): Promise<O>;
 }

package/dist/node-esm/src/task.d.ts

@@ -24,6 +24,7 @@ import { Metadata } from './metadata';
 import { Subscribe, Unsubscribe } from './implementation/observer';
 import { UploadTaskSnapshot, StorageObserver } from './public-types';
 import { Reference } from './reference';
+import { CompleteFn } from '@firebase/util';
 /**
  * Represents a blob being uploaded. Can be used to pause/resume/cancel the
  * upload and manage callbacks for various events.
@@ -61,6 +62,9 @@ export declare class UploadTask {
     private _resolve?;
     private _reject?;
     private _promise;
+    private sleepTime;
+    private maxSleepTime;
+    isExponentialBackoffExpired(): boolean;
     /**
      * @param ref - The firebaseStorage.Reference object this task came
      *     from, untyped to avoid cyclic dependencies.
@@ -101,7 +105,7 @@ export declare class UploadTask {
      *     argument is passed, returns a function you can call to unregister the
      *     callbacks.
      */
-    on(type: TaskEvent, nextOrObserver?: StorageObserver<UploadTaskSnapshot> | null | ((snapshot: UploadTaskSnapshot) => unknown), error?: ((a: StorageError) => unknown) | null, completed?: Unsubscribe | null): Unsubscribe | Subscribe<UploadTaskSnapshot>;
+    on(type: TaskEvent, nextOrObserver?: StorageObserver<UploadTaskSnapshot> | null | ((snapshot: UploadTaskSnapshot) => unknown), error?: ((a: StorageError) => unknown) | null, completed?: CompleteFn | null): Unsubscribe | Subscribe<UploadTaskSnapshot>;
     /**
      * This object behaves like a Promise, and resolves with its snapshot data
      * when the upload completes.

package/dist/node-esm/test/unit/testshared.d.ts

@@ -41,7 +41,20 @@ interface Response {
     body: string;
     headers: Headers;
 }
-declare type RequestHandler = (url: string, method: string, body?: ArrayBufferView | Blob | string | null, headers?: Headers) => Response;
+export declare type RequestHandler = (url: string, method: string, body?: ArrayBufferView | Blob | string | null, headers?: Headers) => Response;
 export declare function storageServiceWithHandler(handler: RequestHandler): FirebaseStorageImpl;
 export declare function fakeServerHandler(fakeMetadata?: Partial<Metadata>): RequestHandler;
+/**
+ * Responds with a 503 for finalize.
+ * @param fakeMetadata metadata to respond with for query
+ * @returns a handler for requests
+ */
+export declare function fake503ForFinalizeServerHandler(fakeMetadata?: Partial<Metadata>): RequestHandler;
+/**
+ * Responds with a 503 for upload.
+ * @param fakeMetadata metadata to respond with for query
+ * @returns a handler for requests
+ */
+export declare function fake503ForUploadServerHandler(fakeMetadata?: Partial<Metadata>): RequestHandler;
+export declare function fakeOneShot503ServerHandler(fakeMetadata?: Partial<Metadata>): RequestHandler;
 export {};

package/dist/node-esm/test/unit/utils.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2022 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.
+ */
+export {};

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

@@ -21,12 +21,18 @@
 declare type id = (p1: boolean) => void;
 export { id };
 /**
- * @param f May be invoked
- *     before the function returns.
- * @param callback Get all the arguments passed to the function
- *     passed to f, including the initial boolean.
+ * Accepts a callback for an action to perform (`doRequest`),
+ * and then a callback for when the backoff has completed (`backoffCompleteCb`).
+ * The callback sent to start requires an argument to call (`onRequestComplete`).
+ * When `start` calls `doRequest`, it passes a callback for when the request has
+ * completed, `onRequestComplete`. Based on this, the backoff continues, with
+ * another call to `doRequest` and the above loop continues until the timeout
+ * is hit, or a successful response occurs.
+ * @description
+ * @param doRequest Callback to perform request
+ * @param backoffCompleteCb Callback to call when backoff has been completed
  */
-export declare function start(f: (p1: (success: boolean) => void, canceled: boolean) => void, callback: (...args: any[]) => unknown, timeout: number): id;
+export declare function start(doRequest: (onRequestComplete: (success: boolean) => void, canceled: boolean) => void, backoffCompleteCb: (...args: any[]) => unknown, timeout: number): id;
 /**
  * Stops the retry loop from repeating.
  * If the function is currently "in between" retries, it is invoked immediately

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

@@ -37,6 +37,10 @@ export declare const DEFAULT_MAX_OPERATION_RETRY_TIME: number;
  * The timeout for upload.
  */
 export declare const DEFAULT_MAX_UPLOAD_RETRY_TIME: number;
+/**
+ * 1 second
+ */
+export declare const DEFAULT_MIN_SLEEP_TIME_MILLIS = 1000;
 /**
  * This is the value of Number.MIN_SAFE_INTEGER, which is not well supported
  * enough for us to use it directly.

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

@@ -20,6 +20,7 @@ import { FirebaseError } from '@firebase/util';
  * @public
  */
 export declare class StorageError extends FirebaseError {
+    private status_;
     private readonly _baseMessage;
     /**
      * Stores custom error data unque to StorageError.
@@ -31,8 +32,11 @@ export declare class StorageError extends FirebaseError {
      * @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);
+    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.
      */

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

@@ -44,4 +44,4 @@ export declare function addAuthHeader_(headers: Headers, authToken: string | nul
 export declare function addVersionHeader_(headers: Headers, firebaseVersion?: string): void;
 export declare function addGmpidHeader_(headers: Headers, appId: string | null): void;
 export declare function addAppCheckHeader_(headers: Headers, appCheckToken: string | null): void;
-export declare function makeRequest<I extends ConnectionType, O>(requestInfo: RequestInfo<I, O>, appId: string | null, authToken: string | null, appCheckToken: string | null, requestFactory: () => Connection<I>, firebaseVersion?: string): Request<O>;
+export declare function makeRequest<I extends ConnectionType, O>(requestInfo: RequestInfo<I, O>, appId: string | null, authToken: string | null, appCheckToken: string | null, requestFactory: () => Connection<I>, firebaseVersion?: string, retry?: boolean): Request<O>;

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

@@ -0,0 +1,23 @@
+/**
+ * @license
+ * Copyright 2022 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.
+ */
+/**
+ * Checks the status code to see if the action should be retried.
+ *
+ * @param status Current HTTP status code returned by server.
+ * @param additionalRetryCodes additional retry codes to check against
+ */
+export declare function isRetryStatusCode(status: number, additionalRetryCodes: number[]): boolean;

package/dist/src/service.d.ts

@@ -125,6 +125,6 @@ export declare class FirebaseStorageImpl implements FirebaseStorage {
      * @param requestInfo - HTTP RequestInfo object
      * @param authToken - Firebase auth token
      */
-    _makeRequest<I extends ConnectionType, O>(requestInfo: RequestInfo<I, O>, requestFactory: () => Connection<I>, authToken: string | null, appCheckToken: string | null): Request<O>;
+    _makeRequest<I extends ConnectionType, O>(requestInfo: RequestInfo<I, O>, requestFactory: () => Connection<I>, authToken: string | null, appCheckToken: string | null, retry?: boolean): Request<O>;
     makeRequestWithTokens<I extends ConnectionType, O>(requestInfo: RequestInfo<I, O>, requestFactory: () => Connection<I>): Promise<O>;
 }

package/dist/src/task.d.ts

@@ -24,6 +24,7 @@ import { Metadata } from './metadata';
 import { Subscribe, Unsubscribe } from './implementation/observer';
 import { UploadTaskSnapshot, StorageObserver } from './public-types';
 import { Reference } from './reference';
+import { CompleteFn } from '@firebase/util';
 /**
  * Represents a blob being uploaded. Can be used to pause/resume/cancel the
  * upload and manage callbacks for various events.
@@ -61,6 +62,9 @@ export declare class UploadTask {
     private _resolve?;
     private _reject?;
     private _promise;
+    private sleepTime;
+    private maxSleepTime;
+    isExponentialBackoffExpired(): boolean;
     /**
      * @param ref - The firebaseStorage.Reference object this task came
      *     from, untyped to avoid cyclic dependencies.
@@ -101,7 +105,7 @@ export declare class UploadTask {
      *     argument is passed, returns a function you can call to unregister the
      *     callbacks.
      */
-    on(type: TaskEvent, nextOrObserver?: StorageObserver<UploadTaskSnapshot> | null | ((snapshot: UploadTaskSnapshot) => unknown), error?: ((a: StorageError) => unknown) | null, completed?: Unsubscribe | null): Unsubscribe | Subscribe<UploadTaskSnapshot>;
+    on(type: TaskEvent, nextOrObserver?: StorageObserver<UploadTaskSnapshot> | null | ((snapshot: UploadTaskSnapshot) => unknown), error?: ((a: StorageError) => unknown) | null, completed?: CompleteFn | null): Unsubscribe | Subscribe<UploadTaskSnapshot>;
     /**
      * This object behaves like a Promise, and resolves with its snapshot data
      * when the upload completes.

package/dist/storage.d.ts

@@ -235,7 +235,7 @@ export declare class _FirebaseStorageImpl implements FirebaseStorage {
      * @param requestInfo - HTTP RequestInfo object
      * @param authToken - Firebase auth token
      */
-    _makeRequest<I extends ConnectionType, O>(requestInfo: RequestInfo_2<I, O>, requestFactory: () => Connection<I>, authToken: string | null, appCheckToken: string | null): Request_2<O>;
+    _makeRequest<I extends ConnectionType, O>(requestInfo: RequestInfo_2<I, O>, requestFactory: () => Connection<I>, authToken: string | null, appCheckToken: string | null, retry?: boolean): Request_2<O>;
     makeRequestWithTokens<I extends ConnectionType, O>(requestInfo: RequestInfo_2<I, O>, requestFactory: () => Connection<I>): Promise<O>;
 }
 
@@ -733,6 +733,7 @@ export declare interface StorageError extends FirebaseError {
  * @public
  */
 declare class StorageError_2 extends FirebaseError {
+    private status_;
     private readonly _baseMessage;
     /**
      * Stores custom error data unque to StorageError.
@@ -744,8 +745,11 @@ declare class StorageError_2 extends FirebaseError {
      * @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);
+    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.
      */
@@ -1272,6 +1276,9 @@ export declare class _UploadTask {
     private _resolve?;
     private _reject?;
     private _promise;
+    private sleepTime;
+    private maxSleepTime;
+    isExponentialBackoffExpired(): boolean;
     /**
      * @param ref - The firebaseStorage.Reference object this task came
      *     from, untyped to avoid cyclic dependencies.
@@ -1312,7 +1319,7 @@ export declare class _UploadTask {
      *     argument is passed, returns a function you can call to unregister the
      *     callbacks.
      */
-    on(type: _TaskEvent, nextOrObserver?: StorageObserver<UploadTaskSnapshot> | null | ((snapshot: UploadTaskSnapshot) => unknown), error?: ((a: StorageError_2) => unknown) | null, completed?: Unsubscribe_2 | null): Unsubscribe_2 | Subscribe_2<UploadTaskSnapshot>;
+    on(type: _TaskEvent, nextOrObserver?: StorageObserver<UploadTaskSnapshot> | null | ((snapshot: UploadTaskSnapshot) => unknown), error?: ((a: StorageError_2) => unknown) | null, completed?: CompleteFn | null): Unsubscribe_2 | Subscribe_2<UploadTaskSnapshot>;
     /**
      * This object behaves like a Promise, and resolves with its snapshot data
      * when the upload completes.

package/dist/test/unit/testshared.d.ts

@@ -41,7 +41,20 @@ interface Response {
     body: string;
     headers: Headers;
 }
-declare type RequestHandler = (url: string, method: string, body?: ArrayBufferView | Blob | string | null, headers?: Headers) => Response;
+export declare type RequestHandler = (url: string, method: string, body?: ArrayBufferView | Blob | string | null, headers?: Headers) => Response;
 export declare function storageServiceWithHandler(handler: RequestHandler): FirebaseStorageImpl;
 export declare function fakeServerHandler(fakeMetadata?: Partial<Metadata>): RequestHandler;
+/**
+ * Responds with a 503 for finalize.
+ * @param fakeMetadata metadata to respond with for query
+ * @returns a handler for requests
+ */
+export declare function fake503ForFinalizeServerHandler(fakeMetadata?: Partial<Metadata>): RequestHandler;
+/**
+ * Responds with a 503 for upload.
+ * @param fakeMetadata metadata to respond with for query
+ * @returns a handler for requests
+ */
+export declare function fake503ForUploadServerHandler(fakeMetadata?: Partial<Metadata>): RequestHandler;
+export declare function fakeOneShot503ServerHandler(fakeMetadata?: Partial<Metadata>): RequestHandler;
 export {};

package/dist/test/unit/utils.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2022 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.
+ */
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/storage",
-  "version": "0.9.10",
+  "version": "0.9.11-20221010190246",
   "description": "",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "main": "dist/index.node.cjs.js",
@@ -42,17 +42,17 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@firebase/util": "1.7.0",
-    "@firebase/component": "0.5.18",
+    "@firebase/util": "1.7.1-20221010190246",
+    "@firebase/component": "0.5.19-20221010190246",
     "node-fetch": "2.6.7",
     "tslib": "^2.1.0"
   },
   "peerDependencies": {
-    "@firebase/app": "0.x"
+    "@firebase/app": "0.8.1-20221010190246"
   },
   "devDependencies": {
-    "@firebase/app": "0.8.0",
-    "@firebase/auth": "0.20.8",
+    "@firebase/app": "0.8.1-20221010190246",
+    "@firebase/auth": "0.20.9-20221010190246",
     "rollup": "2.72.1",
     "@rollup/plugin-alias": "3.1.9",
     "@rollup/plugin-json": "4.1.0",