Merge branch 'master' into fei-remove-ref-exp

Author: Feiyang1

.changeset/blue-hairs-scream.md

@@ -16,6 +16,7 @@
     "firebase-compat-interop-test",
     "firebase-compat-typings-test",
     "@firebase/app-exp",
+    "@firebase/app-check-exp",
     "@firebase/analytics-compat",
     "@firebase/analytics-exp",
     "@firebase/auth-exp",

.changeset/config.json

@@ -24,6 +24,9 @@ jobs:
       - name: Install Dependencies
         run: yarn
 
+      - name: Add a changeset for @firebase/app
+        run: yarn ts-node-script scripts/add_changeset.ts
+
       - name: Create Release Pull Request
         uses: changesets/action@master
         env:

.changeset/fuzzy-teachers-guess.md

@@ -16,6 +16,11 @@ export interface AnalyticsCallOptions {
     global: boolean;
 }
 
+// @public
+export interface AnalyticsOptions {
+    config?: GtagConfigParams | EventParams;
+}
+
 // @public
 export interface ControlParams {
     // (undocumented)
@@ -45,6 +50,8 @@ export type EventNameString = 'add_payment_info' | 'add_shipping_info' | 'add_to
 
 // @public
 export interface EventParams {
+    // (undocumented)
+    [key: string]: unknown;
     // (undocumented)
     affiliation?: string;
     // (undocumented)
@@ -110,6 +117,31 @@ export interface EventParams {
 // @public
 export function getAnalytics(app?: FirebaseApp): Analytics;
 
+// @public
+export interface GtagConfigParams {
+    'allow_google_signals?': boolean;
+    // (undocumented)
+    [key: string]: unknown;
+    'allow_ad_personalization_signals'?: boolean;
+    'anonymize_ip'?: boolean;
+    'cookie_domain'?: string;
+    'cookie_expires'?: number;
+    'cookie_flags'?: string;
+    'cookie_prefix'?: string;
+    'cookie_update'?: boolean;
+    'custom_map'?: {
+        [key: string]: unknown;
+    };
+    'link_attribution'?: boolean;
+    'page_location'?: string;
+    'page_path'?: string;
+    'page_title'?: string;
+    'send_page_view'?: boolean;
+}
+
+// @public
+export function initializeAnalytics(app: FirebaseApp, options?: AnalyticsOptions): Analytics;
+
 // @public
 export function isSupported(): Promise<boolean>;
 

.changeset/rotten-wombats-shop.md

@@ -0,0 +1,69 @@
+## API Report File for "@firebase/app-check-exp"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { FirebaseApp } from '@firebase/app-exp';
+
+// @public
+export interface AppCheck {
+    app: FirebaseApp;
+}
+
+// @internal (undocumented)
+export type _AppCheckComponentName = 'app-check-exp';
+
+// @internal (undocumented)
+export type _AppCheckInternalComponentName = 'app-check-internal';
+
+// @public
+export interface AppCheckOptions {
+    isTokenAutoRefreshEnabled?: boolean;
+    provider: CustomProvider | ReCaptchaV3Provider;
+}
+
+// @public
+export interface AppCheckToken {
+    readonly expireTimeMillis: number;
+    // (undocumented)
+    readonly token: string;
+}
+
+// Warning: (ae-forgotten-export) The symbol "AppCheckProvider" needs to be exported by the entry point index.d.ts
+//
+// @public
+export class CustomProvider implements AppCheckProvider {
+    constructor(_customProviderOptions: CustomProviderOptions);
+    // Warning: (ae-forgotten-export) The symbol "AppCheckTokenInternal" needs to be exported by the entry point index.d.ts
+    //
+    // @internal (undocumented)
+    getToken(): Promise<AppCheckTokenInternal>;
+    // @internal (undocumented)
+    initialize(app: FirebaseApp): void;
+}
+
+// @public
+export interface CustomProviderOptions {
+    getToken: () => Promise<AppCheckToken>;
+}
+
+// @public
+export function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
+
+// @public
+export class ReCaptchaV3Provider implements AppCheckProvider {
+    constructor(_siteKey: string);
+    // @internal
+    getToken(): Promise<AppCheckTokenInternal>;
+    // @internal (undocumented)
+    initialize(app: FirebaseApp): void;
+    }
+
+// @public
+export function setTokenAutoRefreshEnabled(app: FirebaseApp, isTokenAutoRefreshEnabled: boolean): void;
+
+
+// (No @packageDocumentation comment for this package)
+
+```

.changeset/twenty-scissors-exist.md

@@ -1,29 +1,29 @@
 {
-    "name": "firebase-compat-interop-test",
-    "private": true,
-    "version": "0.1.0",
-    "scripts": {
-        "test": "karma start --single-run",
-        "test:ci": "node ../../scripts/run_tests_in_ci.js -s test",
-        "test:debug": "karma start --browsers Chrome --auto-watch"
-    },
-    "dependencies": {
-      "@firebase/app-exp": "0.0.900",
-      "@firebase/app-compat": "0.0.900",
-      "@firebase/analytics-exp": "0.0.900",
-      "@firebase/analytics-compat": "0.0.900",
-      "@firebase/auth-exp": "0.0.900",
-      "@firebase/auth-compat": "0.0.900",
-      "@firebase/functions-exp": "0.0.900",
-      "@firebase/functions-compat": "0.0.900",
-      "@firebase/messaging-exp": "0.0.900",
-      "@firebase/messaging-compat": "0.0.900",
-      "@firebase/performance-exp": "0.0.900",
-      "@firebase/performance-compat": "0.0.900",
-      "@firebase/remote-config-exp": "0.0.900",
-      "@firebase/remote-config-compat": "0.0.900"
-    },
-    "devDependencies": {
-      "typescript": "4.2.2"
-    }
-  }
+  "name": "firebase-compat-interop-test",
+  "private": true,
+  "version": "0.1.0",
+  "scripts": {
+    "test": "karma start --single-run",
+    "test:ci": "node ../../scripts/run_tests_in_ci.js -s test",
+    "test:debug": "karma start --browsers Chrome --auto-watch"
+  },
+  "dependencies": {
+    "@firebase/app-exp": "0.0.900",
+    "@firebase/app-compat": "0.0.900",
+    "@firebase/analytics-exp": "0.0.900",
+    "@firebase/analytics-compat": "0.0.900",
+    "@firebase/auth-exp": "0.0.900",
+    "@firebase/auth-compat": "0.0.900",
+    "@firebase/functions-exp": "0.0.900",
+    "@firebase/functions-compat": "0.0.900",
+    "@firebase/messaging-exp": "0.0.900",
+    "@firebase/messaging-compat": "0.0.900",
+    "@firebase/performance-exp": "0.0.900",
+    "@firebase/performance-compat": "0.0.900",
+    "@firebase/remote-config-exp": "0.0.900",
+    "@firebase/remote-config-compat": "0.0.900"
+  },
+  "devDependencies": {
+    "typescript": "4.2.2"
+  }
+}

.github/workflows/release.yml

@@ -7,7 +7,7 @@
     "test:ci": "node ../../scripts/run_tests_in_ci.js -s test"
   },
   "devDependencies": {
-    "firebase": "8.6.2",
+    "firebase": "8.6.8",
     "@types/chai": "4.2.14",
     "@types/mocha": "7.0.2",
     "chai": "4.2.0",

common/api-review/analytics-exp.api.md

@@ -14,8 +14,8 @@
     "test:memory:debug": "yarn build:memory; karma start --auto-watch --browsers Chrome"
   },
   "devDependencies": {
-    "@firebase/app": "0.6.22",
-    "@firebase/firestore": "2.3.1",
+    "@firebase/app": "0.6.27",
+    "@firebase/firestore": "2.3.7",
     "@types/mocha": "7.0.2",
     "gulp": "4.0.2",
     "gulp-filter": "6.0.0",

common/api-review/app-check-exp.api.md

@@ -9,9 +9,9 @@
     "test:manual": "mocha --exit"
   },
   "devDependencies": {
-    "firebase": "8.6.2",
+    "firebase": "8.6.8",
     "chai": "4.2.0",
-    "chromedriver": "89.0.0",
+    "chromedriver": "91.0.0",
     "express": "4.17.1",
     "geckodriver": "1.21.1",
     "mocha": "7.2.0",

integration/compat-interop/package.json

@@ -44,7 +44,7 @@
   },
   "typings": "dist/src/index.d.ts",
   "dependencies": {
-    "@firebase/component": "0.5.0",
+    "@firebase/component": "0.5.3",
     "@firebase/analytics-exp": "0.0.900",
     "@firebase/analytics-types": "0.4.0",
     "@firebase/util": "1.1.0",

integration/firebase/package.json

@@ -35,7 +35,7 @@
     "@firebase/installations-exp": "0.0.900",
     "@firebase/logger": "0.2.6",
     "@firebase/util": "1.1.0",
-    "@firebase/component": "0.5.0",
+    "@firebase/component": "0.5.3",
     "tslib": "^2.1.0"
   },
   "license": "Apache-2.0",

integration/firestore/package.json

@@ -21,6 +21,7 @@ import { _getProvider, FirebaseApp, getApp } from '@firebase/app-exp';
 import {
   Analytics,
   AnalyticsCallOptions,
+  AnalyticsOptions,
   CustomParams,
   EventNameString,
   EventParams
@@ -47,6 +48,7 @@ import {
   setUserProperties as internalSetUserProperties,
   setAnalyticsCollectionEnabled as internalSetAnalyticsCollectionEnabled
 } from './functions';
+import { ERROR_FACTORY, AnalyticsError } from './errors';
 
 export { settings } from './factory';
 
@@ -70,7 +72,34 @@ export function getAnalytics(app: FirebaseApp = getApp()): Analytics {
     app,
     ANALYTICS_TYPE
   );
-  const analyticsInstance = analyticsProvider.getImmediate();
+
+  if (analyticsProvider.isInitialized()) {
+    return analyticsProvider.getImmediate();
+  }
+
+  return initializeAnalytics(app);
+}
+
+/**
+ * Returns a Firebase Analytics instance for the given app.
+ *
+ * @public
+ *
+ * @param app - The FirebaseApp to use.
+ */
+export function initializeAnalytics(
+  app: FirebaseApp,
+  options: AnalyticsOptions = {}
+): Analytics {
+  // Dependencies
+  const analyticsProvider: Provider<'analytics-exp'> = _getProvider(
+    app,
+    ANALYTICS_TYPE
+  );
+  if (analyticsProvider.isInitialized()) {
+    throw ERROR_FACTORY.create(AnalyticsError.ALREADY_INITIALIZED);
+  }
+  const analyticsInstance = analyticsProvider.initialize({ options });
   return analyticsInstance;
 }
 

integration/messaging/package.json

@@ -20,6 +20,7 @@ import { ErrorFactory, ErrorMap } from '@firebase/util';
 export const enum AnalyticsError {
   ALREADY_EXISTS = 'already-exists',
   ALREADY_INITIALIZED = 'already-initialized',
+  ALREADY_INITIALIZED_SETTINGS = 'already-initialized-settings',
   INTEROP_COMPONENT_REG_FAILED = 'interop-component-reg-failed',
   INVALID_ANALYTICS_CONTEXT = 'invalid-analytics-context',
   INDEXEDDB_UNAVAILABLE = 'indexeddb-unavailable',
@@ -35,6 +36,10 @@ const ERRORS: ErrorMap<AnalyticsError> = {
     ' already exists. ' +
     'Only one Firebase Analytics instance can be created for each appId.',
   [AnalyticsError.ALREADY_INITIALIZED]:
+    'Firebase Analytics has already been initialized. ' +
+    'initializeAnalytics() must only be called once. getAnalytics() can be used ' +
+    'to get a reference to the already-intialized instance.',
+  [AnalyticsError.ALREADY_INITIALIZED_SETTINGS]:
     'Firebase Analytics has already been initialized.' +
     'settings() must be called before initializing any Analytics instance' +
     'or it will have no effect.',

packages-exp/analytics-compat/package.json

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { SettingsOptions, Analytics } from './public-types';
+import { SettingsOptions, Analytics, AnalyticsOptions } from './public-types';
 import { Gtag, DynamicConfig, MinimalDynamicConfig } from './types';
 import { getOrCreateDataLayer, wrapOrCreateGtag } from './helpers';
 import { AnalyticsError, ERROR_FACTORY } from './errors';
@@ -176,7 +176,8 @@ function warnOnBrowserContextMismatch(): void {
  */
 export function factory(
   app: FirebaseApp,
-  installations: _FirebaseInstallationsInternal
+  installations: _FirebaseInstallationsInternal,
+  options?: AnalyticsOptions
 ): AnalyticsService {
   warnOnBrowserContextMismatch();
   const appId = app.options.appId;
@@ -226,7 +227,8 @@ export function factory(
     measurementIdToAppId,
     installations,
     gtagCoreFunction,
-    dataLayerName
+    dataLayerName,
+    options
   );
 
   const analyticsInstance: AnalyticsService = new AnalyticsService(app);