@firebase/util 1.10.1 → 1.10.2-canary.0755a723d

package/dist/src/deepCopy.d.ts

@@ -1,35 +1,35 @@
-/**
- * @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.
- */
-/**
- * Do a deep-copy of basic JavaScript Objects or Arrays.
- */
-export declare function deepCopy<T>(value: T): T;
-/**
- * Copy properties from source to target (recursively allows extension
- * of Objects and Arrays).  Scalar values in the target are over-written.
- * If target is undefined, an object of the appropriate type will be created
- * (and returned).
- *
- * We recursively copy all child properties of plain Objects in the source- so
- * that namespace- like dictionaries are merged.
- *
- * Note that the target can be a function, in which case the properties in
- * the source Object are copied onto it as static properties of the Function.
- *
- * Note: we don't merge __proto__ to prevent prototype pollution
- */
-export declare function deepExtend(target: unknown, source: unknown): unknown;
+/**
+ * @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.
+ */
+/**
+ * Do a deep-copy of basic JavaScript Objects or Arrays.
+ */
+export declare function deepCopy<T>(value: T): T;
+/**
+ * Copy properties from source to target (recursively allows extension
+ * of Objects and Arrays).  Scalar values in the target are over-written.
+ * If target is undefined, an object of the appropriate type will be created
+ * (and returned).
+ *
+ * We recursively copy all child properties of plain Objects in the source- so
+ * that namespace- like dictionaries are merged.
+ *
+ * Note that the target can be a function, in which case the properties in
+ * the source Object are copied onto it as static properties of the Function.
+ *
+ * Note: we don't merge __proto__ to prevent prototype pollution
+ */
+export declare function deepExtend(target: unknown, source: unknown): unknown;

package/dist/src/defaults.d.ts

@@ -1,79 +1,79 @@
-/**
- * @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.
- */
-/**
- * Keys for experimental properties on the `FirebaseDefaults` object.
- * @public
- */
-export declare type ExperimentalKey = 'authTokenSyncURL' | 'authIdTokenMaxAge';
-/**
- * An object that can be injected into the environment as __FIREBASE_DEFAULTS__,
- * either as a property of globalThis, a shell environment variable, or a
- * cookie.
- *
- * This object can be used to automatically configure and initialize
- * a Firebase app as well as any emulators.
- *
- * @public
- */
-export interface FirebaseDefaults {
-    config?: Record<string, string>;
-    emulatorHosts?: Record<string, string>;
-    _authTokenSyncURL?: string;
-    _authIdTokenMaxAge?: number;
-    /**
-     * Override Firebase's runtime environment detection and
-     * force the SDK to act as if it were in the specified environment.
-     */
-    forceEnvironment?: 'browser' | 'node';
-    [key: string]: unknown;
-}
-declare global {
-    var __FIREBASE_DEFAULTS__: FirebaseDefaults | undefined;
-}
-/**
- * Get the __FIREBASE_DEFAULTS__ object. It checks in order:
- * (1) if such an object exists as a property of `globalThis`
- * (2) if such an object was provided on a shell environment variable
- * (3) if such an object exists in a cookie
- * @public
- */
-export declare const getDefaults: () => FirebaseDefaults | undefined;
-/**
- * Returns emulator host stored in the __FIREBASE_DEFAULTS__ object
- * for the given product.
- * @returns a URL host formatted like `127.0.0.1:9999` or `[::1]:4000` if available
- * @public
- */
-export declare const getDefaultEmulatorHost: (productName: string) => string | undefined;
-/**
- * Returns emulator hostname and port stored in the __FIREBASE_DEFAULTS__ object
- * for the given product.
- * @returns a pair of hostname and port like `["::1", 4000]` if available
- * @public
- */
-export declare const getDefaultEmulatorHostnameAndPort: (productName: string) => [hostname: string, port: number] | undefined;
-/**
- * Returns Firebase app config stored in the __FIREBASE_DEFAULTS__ object.
- * @public
- */
-export declare const getDefaultAppConfig: () => Record<string, string> | undefined;
-/**
- * Returns an experimental setting on the __FIREBASE_DEFAULTS__ object (properties
- * prefixed by "_")
- * @public
- */
-export declare const getExperimentalSetting: <T extends ExperimentalKey>(name: T) => FirebaseDefaults[`_${T}`];
+/**
+ * @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.
+ */
+/**
+ * Keys for experimental properties on the `FirebaseDefaults` object.
+ * @public
+ */
+export type ExperimentalKey = 'authTokenSyncURL' | 'authIdTokenMaxAge';
+/**
+ * An object that can be injected into the environment as __FIREBASE_DEFAULTS__,
+ * either as a property of globalThis, a shell environment variable, or a
+ * cookie.
+ *
+ * This object can be used to automatically configure and initialize
+ * a Firebase app as well as any emulators.
+ *
+ * @public
+ */
+export interface FirebaseDefaults {
+    config?: Record<string, string>;
+    emulatorHosts?: Record<string, string>;
+    _authTokenSyncURL?: string;
+    _authIdTokenMaxAge?: number;
+    /**
+     * Override Firebase's runtime environment detection and
+     * force the SDK to act as if it were in the specified environment.
+     */
+    forceEnvironment?: 'browser' | 'node';
+    [key: string]: unknown;
+}
+declare global {
+    var __FIREBASE_DEFAULTS__: FirebaseDefaults | undefined;
+}
+/**
+ * Get the __FIREBASE_DEFAULTS__ object. It checks in order:
+ * (1) if such an object exists as a property of `globalThis`
+ * (2) if such an object was provided on a shell environment variable
+ * (3) if such an object exists in a cookie
+ * @public
+ */
+export declare const getDefaults: () => FirebaseDefaults | undefined;
+/**
+ * Returns emulator host stored in the __FIREBASE_DEFAULTS__ object
+ * for the given product.
+ * @returns a URL host formatted like `127.0.0.1:9999` or `[::1]:4000` if available
+ * @public
+ */
+export declare const getDefaultEmulatorHost: (productName: string) => string | undefined;
+/**
+ * Returns emulator hostname and port stored in the __FIREBASE_DEFAULTS__ object
+ * for the given product.
+ * @returns a pair of hostname and port like `["::1", 4000]` if available
+ * @public
+ */
+export declare const getDefaultEmulatorHostnameAndPort: (productName: string) => [hostname: string, port: number] | undefined;
+/**
+ * Returns Firebase app config stored in the __FIREBASE_DEFAULTS__ object.
+ * @public
+ */
+export declare const getDefaultAppConfig: () => Record<string, string> | undefined;
+/**
+ * Returns an experimental setting on the __FIREBASE_DEFAULTS__ object (properties
+ * prefixed by "_")
+ * @public
+ */
+export declare const getExperimentalSetting: <T extends ExperimentalKey>(name: T) => FirebaseDefaults[`_${T}`];

package/dist/src/deferred.d.ts

@@ -1,28 +1,28 @@
-/**
- * @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.
- */
-export declare class Deferred<R> {
-    promise: Promise<R>;
-    reject: (value?: unknown) => void;
-    resolve: (value?: unknown) => void;
-    constructor();
-    /**
-     * Our API internals are not promisified and cannot because our callback APIs have subtle expectations around
-     * invoking promises inline, which Promises are forbidden to do. This method accepts an optional node-style callback
-     * and returns a node-style callback which will resolve or reject the Deferred's promise.
-     */
-    wrapCallback(callback?: (error?: unknown, value?: unknown) => void): (error: unknown, value?: unknown) => void;
-}
+/**
+ * @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.
+ */
+export declare class Deferred<R> {
+    promise: Promise<R>;
+    reject: (value?: unknown) => void;
+    resolve: (value?: unknown) => void;
+    constructor();
+    /**
+     * Our API internals are not promisified and cannot because our callback APIs have subtle expectations around
+     * invoking promises inline, which Promises are forbidden to do. This method accepts an optional node-style callback
+     * and returns a node-style callback which will resolve or reject the Deferred's promise.
+     */
+    wrapCallback(callback?: (error?: unknown, value?: unknown) => void): (error: unknown, value?: unknown) => void;
+}

package/dist/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/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;