@firebase/util 1.8.0 → 1.9.0

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

@@ -34,11 +34,24 @@ export interface FirebaseDefaults {
     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.

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

@@ -30,7 +30,7 @@ export declare function isMobileCordova(): boolean;
 /**
  * Detect Node.js.
  *
- * @return true if Node.js environment is detected.
+ * @return true if Node.js environment is detected or specified.
  */
 export declare function isNode(): boolean;
 /**
@@ -77,8 +77,3 @@ export declare function validateIndexedDBOpenable(): Promise<boolean>;
  * @return true if cookie is enabled within current browser
  */
 export declare function areCookiesEnabled(): boolean;
-/**
- * Polyfill for `globalThis` object.
- * @returns the `globalThis` object for the given environment.
- */
-export declare function getGlobal(): typeof globalThis;

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

@@ -0,0 +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;

package/dist/node-esm/test/environments.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/defaults.d.ts

@@ -34,11 +34,24 @@ export interface FirebaseDefaults {
     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.

package/dist/src/environment.d.ts

@@ -30,7 +30,7 @@ export declare function isMobileCordova(): boolean;
 /**
  * Detect Node.js.
  *
- * @return true if Node.js environment is detected.
+ * @return true if Node.js environment is detected or specified.
  */
 export declare function isNode(): boolean;
 /**
@@ -77,8 +77,3 @@ export declare function validateIndexedDBOpenable(): Promise<boolean>;
  * @return true if cookie is enabled within current browser
  */
 export declare function areCookiesEnabled(): boolean;
-/**
- * Polyfill for `globalThis` object.
- * @returns the `globalThis` object for the given environment.
- */
-export declare function getGlobal(): typeof globalThis;

package/dist/src/global.d.ts

@@ -0,0 +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;

package/dist/test/environments.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/util-public.d.ts

@@ -409,6 +409,11 @@ export declare interface FirebaseDefaults {
     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;
 }
 
@@ -490,6 +495,15 @@ export declare const getDefaultEmulatorHost: (productName: string) => string | u
  */
 export declare const getDefaultEmulatorHostnameAndPort: (productName: string) => [hostname: string, port: number] | 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 an experimental setting on the __FIREBASE_DEFAULTS__ object (properties
  * prefixed by "_")
@@ -497,9 +511,26 @@ export declare const getDefaultEmulatorHostnameAndPort: (productName: string) =>
  */
 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.
+ */
 /**
  * Polyfill for `globalThis` object.
  * @returns the `globalThis` object for the given environment.
+ * @public
  */
 export declare function getGlobal(): typeof globalThis;
 
@@ -569,7 +600,7 @@ export declare function isMobileCordova(): boolean;
 /**
  * Detect Node.js.
  *
- * @return true if Node.js environment is detected.
+ * @return true if Node.js environment is detected or specified.
  */
 export declare function isNode(): boolean;
 

package/dist/util.d.ts

@@ -409,6 +409,11 @@ export declare interface FirebaseDefaults {
     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;
 }
 
@@ -490,6 +495,15 @@ export declare const getDefaultEmulatorHost: (productName: string) => string | u
  */
 export declare const getDefaultEmulatorHostnameAndPort: (productName: string) => [hostname: string, port: number] | 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 an experimental setting on the __FIREBASE_DEFAULTS__ object (properties
  * prefixed by "_")
@@ -497,9 +511,26 @@ export declare const getDefaultEmulatorHostnameAndPort: (productName: string) =>
  */
 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.
+ */
 /**
  * Polyfill for `globalThis` object.
  * @returns the `globalThis` object for the given environment.
+ * @public
  */
 export declare function getGlobal(): typeof globalThis;
 
@@ -569,7 +600,7 @@ export declare function isMobileCordova(): boolean;
 /**
  * Detect Node.js.
  *
- * @return true if Node.js environment is detected.
+ * @return true if Node.js environment is detected or specified.
  */
 export declare function isNode(): boolean;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/util",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "main": "dist/index.node.cjs.js",