@firebase/util 1.10.1 → 1.10.2

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

@@ -1,47 +1,47 @@
-/**
- * @license
- * Copyright 2021 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 declare type FirebaseSignInProvider = 'custom' | 'email' | 'password' | 'phone' | 'anonymous' | 'google.com' | 'facebook.com' | 'github.com' | 'twitter.com' | 'microsoft.com' | 'apple.com';
-interface FirebaseIdToken {
-    iss: string;
-    aud: string;
-    sub: string;
-    iat: number;
-    exp: number;
-    user_id: string;
-    auth_time: number;
-    provider_id?: 'anonymous';
-    email?: string;
-    email_verified?: boolean;
-    phone_number?: string;
-    name?: string;
-    picture?: string;
-    firebase: {
-        sign_in_provider: FirebaseSignInProvider;
-        identities?: {
-            [provider in FirebaseSignInProvider]?: string[];
-        };
-    };
-    [claim: string]: unknown;
-    uid?: never;
-}
-export declare type EmulatorMockTokenOptions = ({
-    user_id: string;
-} | {
-    sub: string;
-}) & Partial<FirebaseIdToken>;
-export declare function createMockUserToken(token: EmulatorMockTokenOptions, projectId?: string): string;
-export {};
+/**
+ * @license
+ * Copyright 2021 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 type FirebaseSignInProvider = 'custom' | 'email' | 'password' | 'phone' | 'anonymous' | 'google.com' | 'facebook.com' | 'github.com' | 'twitter.com' | 'microsoft.com' | 'apple.com';
+interface FirebaseIdToken {
+    iss: string;
+    aud: string;
+    sub: string;
+    iat: number;
+    exp: number;
+    user_id: string;
+    auth_time: number;
+    provider_id?: 'anonymous';
+    email?: string;
+    email_verified?: boolean;
+    phone_number?: string;
+    name?: string;
+    picture?: string;
+    firebase: {
+        sign_in_provider: FirebaseSignInProvider;
+        identities?: {
+            [provider in FirebaseSignInProvider]?: string[];
+        };
+    };
+    [claim: string]: unknown;
+    uid?: never;
+}
+export type EmulatorMockTokenOptions = ({
+    user_id: string;
+} | {
+    sub: string;
+}) & Partial<FirebaseIdToken>;
+export declare function createMockUserToken(token: EmulatorMockTokenOptions, projectId?: string): string;
+export {};

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

@@ -1,90 +1,90 @@
-/**
- * @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.
- */
-/**
- * Returns navigator.userAgent string or '' if it's not defined.
- * @return user agent string
- */
-export declare function getUA(): string;
-/**
- * Detect Cordova / PhoneGap / Ionic frameworks on a mobile device.
- *
- * Deliberately does not rely on checking `file://` URLs (as this fails PhoneGap
- * in the Ripple emulator) nor Cordova `onDeviceReady`, which would normally
- * wait for a callback.
- */
-export declare function isMobileCordova(): boolean;
-/**
- * Detect Node.js.
- *
- * @return true if Node.js environment is detected or specified.
- */
-export declare function isNode(): boolean;
-/**
- * Detect Browser Environment.
- * Note: This will return true for certain test frameworks that are incompletely
- * mimicking a browser, and should not lead to assuming all browser APIs are
- * available.
- */
-export declare function isBrowser(): boolean;
-/**
- * Detect Web Worker context.
- */
-export declare function isWebWorker(): boolean;
-/**
- * Detect Cloudflare Worker context.
- */
-export declare function isCloudflareWorker(): boolean;
-export declare function isBrowserExtension(): boolean;
-/**
- * Detect React Native.
- *
- * @return true if ReactNative environment is detected.
- */
-export declare function isReactNative(): boolean;
-/** Detects Electron apps. */
-export declare function isElectron(): boolean;
-/** Detects Internet Explorer. */
-export declare function isIE(): boolean;
-/** Detects Universal Windows Platform apps. */
-export declare function isUWP(): boolean;
-/**
- * Detect whether the current SDK build is the Node version.
- *
- * @return true if it's the Node SDK build.
- */
-export declare function isNodeSdk(): boolean;
-/** Returns true if we are running in Safari. */
-export declare function isSafari(): boolean;
-/**
- * This method checks if indexedDB is supported by current browser/service worker context
- * @return true if indexedDB is supported by current browser/service worker context
- */
-export declare function isIndexedDBAvailable(): boolean;
-/**
- * This method validates browser/sw context for indexedDB by opening a dummy indexedDB database and reject
- * if errors occur during the database open operation.
- *
- * @throws exception if current browser/sw context can't run idb.open (ex: Safari iframe, Firefox
- * private browsing)
- */
-export declare function validateIndexedDBOpenable(): Promise<boolean>;
-/**
- *
- * This method checks whether cookie is enabled within current browser
- * @return true if cookie is enabled within current browser
- */
-export declare function areCookiesEnabled(): boolean;
+/**
+ * @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.
+ */
+/**
+ * Returns navigator.userAgent string or '' if it's not defined.
+ * @return user agent string
+ */
+export declare function getUA(): string;
+/**
+ * Detect Cordova / PhoneGap / Ionic frameworks on a mobile device.
+ *
+ * Deliberately does not rely on checking `file://` URLs (as this fails PhoneGap
+ * in the Ripple emulator) nor Cordova `onDeviceReady`, which would normally
+ * wait for a callback.
+ */
+export declare function isMobileCordova(): boolean;
+/**
+ * Detect Node.js.
+ *
+ * @return true if Node.js environment is detected or specified.
+ */
+export declare function isNode(): boolean;
+/**
+ * Detect Browser Environment.
+ * Note: This will return true for certain test frameworks that are incompletely
+ * mimicking a browser, and should not lead to assuming all browser APIs are
+ * available.
+ */
+export declare function isBrowser(): boolean;
+/**
+ * Detect Web Worker context.
+ */
+export declare function isWebWorker(): boolean;
+/**
+ * Detect Cloudflare Worker context.
+ */
+export declare function isCloudflareWorker(): boolean;
+export declare function isBrowserExtension(): boolean;
+/**
+ * Detect React Native.
+ *
+ * @return true if ReactNative environment is detected.
+ */
+export declare function isReactNative(): boolean;
+/** Detects Electron apps. */
+export declare function isElectron(): boolean;
+/** Detects Internet Explorer. */
+export declare function isIE(): boolean;
+/** Detects Universal Windows Platform apps. */
+export declare function isUWP(): boolean;
+/**
+ * Detect whether the current SDK build is the Node version.
+ *
+ * @return true if it's the Node SDK build.
+ */
+export declare function isNodeSdk(): boolean;
+/** Returns true if we are running in Safari. */
+export declare function isSafari(): boolean;
+/**
+ * This method checks if indexedDB is supported by current browser/service worker context
+ * @return true if indexedDB is supported by current browser/service worker context
+ */
+export declare function isIndexedDBAvailable(): boolean;
+/**
+ * This method validates browser/sw context for indexedDB by opening a dummy indexedDB database and reject
+ * if errors occur during the database open operation.
+ *
+ * @throws exception if current browser/sw context can't run idb.open (ex: Safari iframe, Firefox
+ * private browsing)
+ */
+export declare function validateIndexedDBOpenable(): Promise<boolean>;
+/**
+ *
+ * This method checks whether cookie is enabled within current browser
+ * @return true if cookie is enabled within current browser
+ */
+export declare function areCookiesEnabled(): boolean;

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

@@ -1,87 +1,87 @@
-/**
- * @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 Standardized Firebase Error.
- *
- * Usage:
- *
- *   // TypeScript string literals for type-safe codes
- *   type Err =
- *     'unknown' |
- *     'object-not-found'
- *     ;
- *
- *   // Closure enum for type-safe error codes
- *   // at-enum {string}
- *   var Err = {
- *     UNKNOWN: 'unknown',
- *     OBJECT_NOT_FOUND: 'object-not-found',
- *   }
- *
- *   let errors: Map<Err, string> = {
- *     'generic-error': "Unknown error",
- *     'file-not-found': "Could not find file: {$file}",
- *   };
- *
- *   // Type-safe function - must pass a valid error code as param.
- *   let error = new ErrorFactory<Err>('service', 'Service', errors);
- *
- *   ...
- *   throw error.create(Err.GENERIC);
- *   ...
- *   throw error.create(Err.FILE_NOT_FOUND, {'file': fileName});
- *   ...
- *   // Service: Could not file file: foo.txt (service/file-not-found).
- *
- *   catch (e) {
- *     assert(e.message === "Could not find file: foo.txt.");
- *     if ((e as FirebaseError)?.code === 'service/file-not-found') {
- *       console.log("Could not read file: " + e['file']);
- *     }
- *   }
- */
-export declare type ErrorMap<ErrorCode extends string> = {
-    readonly [K in ErrorCode]: string;
-};
-export interface StringLike {
-    toString(): string;
-}
-export interface ErrorData {
-    [key: string]: unknown;
-}
-export declare class FirebaseError extends Error {
-    /** The error code for this error. */
-    readonly code: string;
-    /** Custom data for this error. */
-    customData?: Record<string, unknown> | undefined;
-    /** The custom name for all FirebaseErrors. */
-    readonly name: string;
-    constructor(
-    /** The error code for this error. */
-    code: string, message: string, 
-    /** Custom data for this error. */
-    customData?: Record<string, unknown> | undefined);
-}
-export declare class ErrorFactory<ErrorCode extends string, ErrorParams extends {
-    readonly [K in ErrorCode]?: ErrorData;
-} = {}> {
-    private readonly service;
-    private readonly serviceName;
-    private readonly errors;
-    constructor(service: string, serviceName: string, errors: ErrorMap<ErrorCode>);
-    create<K extends ErrorCode>(code: K, ...data: K extends keyof ErrorParams ? [ErrorParams[K]] : []): FirebaseError;
-}
+/**
+ * @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 Standardized Firebase Error.
+ *
+ * Usage:
+ *
+ *   // TypeScript string literals for type-safe codes
+ *   type Err =
+ *     'unknown' |
+ *     'object-not-found'
+ *     ;
+ *
+ *   // Closure enum for type-safe error codes
+ *   // at-enum {string}
+ *   var Err = {
+ *     UNKNOWN: 'unknown',
+ *     OBJECT_NOT_FOUND: 'object-not-found',
+ *   }
+ *
+ *   let errors: Map<Err, string> = {
+ *     'generic-error': "Unknown error",
+ *     'file-not-found': "Could not find file: {$file}",
+ *   };
+ *
+ *   // Type-safe function - must pass a valid error code as param.
+ *   let error = new ErrorFactory<Err>('service', 'Service', errors);
+ *
+ *   ...
+ *   throw error.create(Err.GENERIC);
+ *   ...
+ *   throw error.create(Err.FILE_NOT_FOUND, {'file': fileName});
+ *   ...
+ *   // Service: Could not file file: foo.txt (service/file-not-found).
+ *
+ *   catch (e) {
+ *     assert(e.message === "Could not find file: foo.txt.");
+ *     if ((e as FirebaseError)?.code === 'service/file-not-found') {
+ *       console.log("Could not read file: " + e['file']);
+ *     }
+ *   }
+ */
+export type ErrorMap<ErrorCode extends string> = {
+    readonly [K in ErrorCode]: string;
+};
+export interface StringLike {
+    toString(): string;
+}
+export interface ErrorData {
+    [key: string]: unknown;
+}
+export declare class FirebaseError extends Error {
+    /** The error code for this error. */
+    readonly code: string;
+    /** Custom data for this error. */
+    customData?: Record<string, unknown> | undefined;
+    /** The custom name for all FirebaseErrors. */
+    readonly name: string;
+    constructor(
+    /** The error code for this error. */
+    code: string, message: string, 
+    /** Custom data for this error. */
+    customData?: Record<string, unknown> | undefined);
+}
+export declare class ErrorFactory<ErrorCode extends string, ErrorParams extends {
+    readonly [K in ErrorCode]?: ErrorData;
+} = {}> {
+    private readonly service;
+    private readonly serviceName;
+    private readonly errors;
+    constructor(service: string, serviceName: string, errors: ErrorMap<ErrorCode>);
+    create<K extends ErrorCode>(code: K, ...data: K extends keyof ErrorParams ? [ErrorParams[K]] : []): FirebaseError;
+}

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

@@ -1,37 +1,37 @@
-/**
- * @license
- * Copyright 2019 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.
- */
-/**
- * The maximum milliseconds to increase to.
- *
- * <p>Visible for testing
- */
-export declare const MAX_VALUE_MILLIS: number;
-/**
- * The percentage of backoff time to randomize by.
- * See
- * http://go/safe-client-behavior#step-1-determine-the-appropriate-retry-interval-to-handle-spike-traffic
- * for context.
- *
- * <p>Visible for testing
- */
-export declare const RANDOM_FACTOR = 0.5;
-/**
- * Based on the backoff method from
- * https://github.com/google/closure-library/blob/master/closure/goog/math/exponentialbackoff.js.
- * Extracted here so we don't need to pass metadata and a stateful ExponentialBackoff object around.
- */
-export declare function calculateBackoffMillis(backoffCount: number, intervalMillis?: number, backoffFactor?: number): number;
+/**
+ * @license
+ * Copyright 2019 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.
+ */
+/**
+ * The maximum milliseconds to increase to.
+ *
+ * <p>Visible for testing
+ */
+export declare const MAX_VALUE_MILLIS: number;
+/**
+ * The percentage of backoff time to randomize by.
+ * See
+ * http://go/safe-client-behavior#step-1-determine-the-appropriate-retry-interval-to-handle-spike-traffic
+ * for context.
+ *
+ * <p>Visible for testing
+ */
+export declare const RANDOM_FACTOR = 0.5;
+/**
+ * Based on the backoff method from
+ * https://github.com/google/closure-library/blob/master/closure/goog/math/exponentialbackoff.js.
+ * Extracted here so we don't need to pass metadata and a stateful ExponentialBackoff object around.
+ */
+export declare function calculateBackoffMillis(backoffCount: number, intervalMillis?: number, backoffFactor?: number): number;

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

@@ -1,20 +1,20 @@
-/**
- * @license
- * Copyright 2020 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.
- */
-/**
- * Provide English ordinal letters after a number
- */
-export declare function ordinal(i: number): string;
+/**
+ * @license
+ * Copyright 2020 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.
+ */
+/**
+ * Provide English ordinal letters after a number
+ */
+export declare function ordinal(i: number): string;

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

@@ -1,22 +1,22 @@
-/**
- * @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.
- */
-/**
- * Polyfill for `globalThis` object.
- * @returns the `globalThis` object for the given environment.
- * @public
- */
-export declare function getGlobal(): typeof globalThis;
+/**
+ * @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.
+ */
+/**
+ * Polyfill for `globalThis` object.
+ * @returns the `globalThis` object for the given environment.
+ * @public
+ */
+export declare function getGlobal(): typeof globalThis;