Package analytics-exp

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

@@ -6,18 +6,31 @@
 
 import { Analytics } from '@firebase/analytics-types-exp';
 import { AnalyticsCallOptions } from '@firebase/analytics-types-exp';
+import { ControlParams } from '@firebase/analytics-types-exp';
 import { CustomParams } from '@firebase/analytics-types-exp';
-import { DynamicConfig } from '@firebase/analytics-types-exp';
+import { DataLayer } from '@firebase/analytics-types-exp';
 import { EventNameString } from '@firebase/analytics-types-exp';
 import { EventParams } from '@firebase/analytics-types-exp';
 import { FirebaseApp } from '@firebase/app-types-exp';
-import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
-import { _FirebaseService } from '@firebase/app-types-exp';
-import { MinimalDynamicConfig } from '@firebase/analytics-types-exp';
+import { Item } from '@firebase/analytics-types-exp';
+import { Promotion } from '@firebase/analytics-types-exp';
 import { SettingsOptions } from '@firebase/analytics-types-exp';
 
+export { Analytics }
+
+export { AnalyticsCallOptions }
+
+export { ControlParams }
+
+// @public
+export type CustomEventName<T> = T extends EventNameString ? never : T;
+
+export { CustomParams }
+
+export { DataLayer }
+
 // @public
-export const enum EventName {
+export enum EventName {
     // (undocumented)
     ADD_PAYMENT_INFO = "add_payment_info",
     // (undocumented)
@@ -74,28 +87,16 @@ export const enum EventName {
     VIEW_SEARCH_RESULTS = "view_search_results"
 }
 
-// Warning: (ae-forgotten-export) The symbol "AnalyticsService" needs to be exported by the entry point index.d.ts
-// Warning: (ae-internal-missing-underscore) The name "factory" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal
-export function factory(app: FirebaseApp, installations: _FirebaseInstallationsInternal): AnalyticsService;
+export { EventParams }
 
 // @public
 export function getAnalytics(app: FirebaseApp): Analytics;
 
-// Warning: (ae-internal-missing-underscore) The name "getGlobalVars" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal
-export function getGlobalVars(): {
-    initializationPromisesMap: {
-        [appId: string]: Promise<string>;
-    };
-    dynamicConfigPromisesList: Array<Promise<DynamicConfig | MinimalDynamicConfig>>;
-};
-
 // @public
 export function isSupported(): Promise<boolean>;
 
+export { Item }
+
 // @public
 export function logEvent(analyticsInstance: Analytics, eventName: 'add_payment_info', eventParams?: {
     coupon?: EventParams['coupon'];
@@ -273,17 +274,12 @@ export function logEvent(analyticsInstance: Analytics, eventName: 'view_item_lis
     [key: string]: any;
 }, options?: AnalyticsCallOptions): void;
 
-// Warning: (ae-forgotten-export) The symbol "CustomEventName" needs to be exported by the entry point index.d.ts
-//
 // @public
 export function logEvent<T extends string>(analyticsInstance: Analytics, eventName: CustomEventName<T>, eventParams?: {
     [key: string]: any;
 }, options?: AnalyticsCallOptions): void;
 
-// Warning: (ae-internal-missing-underscore) The name "resetGlobalVars" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal
-export function resetGlobalVars(newGlobalInitDone?: boolean, newInitializationPromisesMap?: {}, newDynamicPromises?: never[]): void;
+export { Promotion }
 
 // @public
 export function setAnalyticsCollectionEnabled(analyticsInstance: Analytics, enabled: boolean): void;
@@ -294,6 +290,8 @@ export function setCurrentScreen(analyticsInstance: Analytics, screenName: strin
 // @public
 export function settings(options: SettingsOptions): void;
 
+export { SettingsOptions }
+
 // @public
 export function setUserId(analyticsInstance: Analytics, id: string, options?: AnalyticsCallOptions): void;
 

packages-exp/analytics-exp/src/api.ts

@@ -674,4 +674,9 @@ export function logEvent(
   ).catch(e => logger.error(e));
 }
 
-type CustomEventName<T> = T extends EventNameString ? never : T;
+/**
+ * Any custom event name string not in the standard list of recommended
+ * event names.
+ * @public
+ */
+export type CustomEventName<T> = T extends EventNameString ? never : T;

packages-exp/analytics-exp/src/constants.ts

@@ -43,7 +43,7 @@ export const enum GtagCommand {
  *
  * @public
  */
-export const enum EventName {
+export enum EventName {
   ADD_SHIPPING_INFO = 'add_shipping_info',
   ADD_PAYMENT_INFO = 'add_payment_info',
   ADD_TO_CART = 'add_to_cart',

packages-exp/analytics-exp/src/index.test.ts

@@ -18,12 +18,7 @@
 import { expect } from 'chai';
 import { SinonStub, stub, useFakeTimers } from 'sinon';
 import '../testing/setup';
-import {
-  settings,
-  factory as analyticsFactory,
-  resetGlobalVars,
-  getGlobalVars
-} from './index';
+import { settings } from './index';
 import {
   getFakeApp,
   getFakeInstallations
@@ -35,7 +30,12 @@ import { removeGtagScript } from '../testing/gtag-script-util';
 import { Deferred } from '@firebase/util';
 import { AnalyticsError } from './errors';
 import { logEvent } from './api';
-import { AnalyticsService } from './factory';
+import {
+  AnalyticsService,
+  getGlobalVars,
+  resetGlobalVars,
+  factory as analyticsFactory
+} from './factory';
 import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
 
 let analyticsInstance: AnalyticsService = {} as AnalyticsService;

packages-exp/analytics-exp/src/index.ts

@@ -17,7 +17,7 @@
 
 import { registerVersion, _registerComponent } from '@firebase/app-exp';
 import { FirebaseAnalyticsInternal } from '@firebase/analytics-interop-types';
-import { factory, resetGlobalVars, getGlobalVars } from './factory';
+import { factory } from './factory';
 import { ANALYTICS_TYPE } from './constants';
 import {
   Component,
@@ -35,8 +35,6 @@ declare global {
   }
 }
 
-export * from './api';
-
 function registerAnalytics(): void {
   _registerComponent(
     new Component(
@@ -80,6 +78,18 @@ function registerAnalytics(): void {
   }
 }
 
-export { factory, resetGlobalVars, getGlobalVars };
-
 registerAnalytics();
+
+export * from './api';
+
+export {
+  DataLayer,
+  Analytics,
+  AnalyticsCallOptions,
+  SettingsOptions,
+  ControlParams,
+  EventParams,
+  CustomParams,
+  Item,
+  Promotion
+} from '@firebase/analytics-types-exp';

packages-exp/analytics-types-exp/index.d.ts

@@ -17,8 +17,6 @@
 
 import { FirebaseApp } from '@firebase/app-types-exp';
 
-export type GtagCommand = 'event' | 'set' | 'config';
-
 export type DataLayer = Array<IArguments>;
 
 /**

packages-exp/firebase-exp/analytics/index.ts

@@ -0,0 +1,18 @@
+/**
+ * @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.
+ */
+
+export * from '@firebase/analytics-exp';

packages-exp/firebase-exp/analytics/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "firebase-exp/analytics",
+  "main": "dist/index.cjs.js",
+  "browser": "dist/index.esm.js",
+  "module": "dist/index.esm.js",
+  "typings": "dist/analytics/index.d.ts"
+}

packages-exp/firebase-exp/package.json

@@ -60,6 +60,7 @@
     "typescript": "4.0.5"
   },
   "components": [
+    "analytics",
     "app",
     "auth",
     "functions",