@firebase/util 1.6.3 → 1.7.0-canary.03d1fabcb

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

@@ -0,0 +1,66 @@
+/**
+ * @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;
+    [key: string]: unknown;
+}
+declare global {
+    var __FIREBASE_DEFAULTS__: 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/node-esm/test/defaults.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/defaults.d.ts

@@ -0,0 +1,66 @@
+/**
+ * @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;
+    [key: string]: unknown;
+}
+declare global {
+    var __FIREBASE_DEFAULTS__: 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/test/defaults.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/util-public.d.ts

@@ -367,11 +367,51 @@ export declare function errorPrefix(fnName: string, argName: string): string;
 
 export declare type Executor<T> = (observer: Observer<T>) => void;
 
+/**
+ * @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';
+
 /**
  * Extract the query string part of a URL, including the leading question mark (if present).
  */
 export declare function extractQuerystring(url: string): string;
 
+/**
+ * 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 declare interface FirebaseDefaults {
+    config?: Record<string, string>;
+    emulatorHosts?: Record<string, string>;
+    _authTokenSyncURL?: string;
+    _authIdTokenMaxAge?: number;
+    [key: string]: unknown;
+}
+
 export declare class FirebaseError extends Error {
     /** The error code for this error. */
     readonly code: string;
@@ -428,6 +468,35 @@ declare interface FirebaseIdToken {
  */
 export declare type FirebaseSignInProvider = 'custom' | 'email' | 'password' | 'phone' | 'anonymous' | 'google.com' | 'facebook.com' | 'github.com' | 'twitter.com' | 'microsoft.com' | 'apple.com';
 
+/**
+ * Returns Firebase app config stored in the __FIREBASE_DEFAULTS__ object.
+ * @public
+ */
+export declare const getDefaultAppConfig: () => Record<string, string> | 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 an experimental setting on the __FIREBASE_DEFAULTS__ object (properties
+ * prefixed by "_")
+ * @public
+ */
+export declare const getExperimentalSetting: <T extends ExperimentalKey>(name: T) => FirebaseDefaults[`_${T}`];
+
 /**
  * Polyfill for `globalThis` object.
  * @returns the `globalThis` object for the given environment.

package/dist/util.d.ts

@@ -367,11 +367,51 @@ export declare function errorPrefix(fnName: string, argName: string): string;
 
 export declare type Executor<T> = (observer: Observer<T>) => void;
 
+/**
+ * @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';
+
 /**
  * Extract the query string part of a URL, including the leading question mark (if present).
  */
 export declare function extractQuerystring(url: string): string;
 
+/**
+ * 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 declare interface FirebaseDefaults {
+    config?: Record<string, string>;
+    emulatorHosts?: Record<string, string>;
+    _authTokenSyncURL?: string;
+    _authIdTokenMaxAge?: number;
+    [key: string]: unknown;
+}
+
 export declare class FirebaseError extends Error {
     /** The error code for this error. */
     readonly code: string;
@@ -428,6 +468,35 @@ declare interface FirebaseIdToken {
  */
 export declare type FirebaseSignInProvider = 'custom' | 'email' | 'password' | 'phone' | 'anonymous' | 'google.com' | 'facebook.com' | 'github.com' | 'twitter.com' | 'microsoft.com' | 'apple.com';
 
+/**
+ * Returns Firebase app config stored in the __FIREBASE_DEFAULTS__ object.
+ * @public
+ */
+export declare const getDefaultAppConfig: () => Record<string, string> | 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 an experimental setting on the __FIREBASE_DEFAULTS__ object (properties
+ * prefixed by "_")
+ * @public
+ */
+export declare const getExperimentalSetting: <T extends ExperimentalKey>(name: T) => FirebaseDefaults[`_${T}`];
+
 /**
  * Polyfill for `globalThis` object.
  * @returns the `globalThis` object for the given environment.

package/package.json

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