@firebase/analytics 0.7.2 → 0.7.3-2021102231614

package/dist/esm/src/api.d.ts

@@ -0,0 +1,423 @@
+/**
+ * @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.
+ */
+import { FirebaseApp } from '@firebase/app';
+import { Analytics, AnalyticsCallOptions, AnalyticsSettings, CustomParams, EventNameString, EventParams } from './public-types';
+import { ANALYTICS_TYPE } from './constants';
+import { AnalyticsService } from './factory';
+export { settings } from './factory';
+declare module '@firebase/component' {
+    interface NameServiceMapping {
+        [ANALYTICS_TYPE]: AnalyticsService;
+    }
+}
+/**
+ * Returns an {@link Analytics} instance for the given app.
+ *
+ * @public
+ *
+ * @param app - The {@link @firebase/app#FirebaseApp} to use.
+ */
+export declare function getAnalytics(app?: FirebaseApp): Analytics;
+/**
+ * Returns an {@link Analytics} instance for the given app.
+ *
+ * @public
+ *
+ * @param app - The {@link @firebase/app#FirebaseApp} to use.
+ */
+export declare function initializeAnalytics(app: FirebaseApp, options?: AnalyticsSettings): Analytics;
+/**
+ * This is a public static method provided to users that wraps four different checks:
+ *
+ * 1. Check if it's not a browser extension environment.
+ * 2. Check if cookies are enabled in current browser.
+ * 3. Check if IndexedDB is supported by the browser environment.
+ * 4. Check if the current browser context is valid for using `IndexedDB.open()`.
+ *
+ * @public
+ *
+ */
+export declare function isSupported(): Promise<boolean>;
+/**
+ * Use gtag `config` command to set `screen_name`.
+ *
+ * @public
+ *
+ * @param analyticsInstance - The {@link Analytics} instance.
+ * @param screenName - Screen name to set.
+ */
+export declare function setCurrentScreen(analyticsInstance: Analytics, screenName: string, options?: AnalyticsCallOptions): void;
+/**
+ * Use gtag `config` command to set `user_id`.
+ *
+ * @public
+ *
+ * @param analyticsInstance - The {@link Analytics} instance.
+ * @param id - User ID to set.
+ */
+export declare function setUserId(analyticsInstance: Analytics, id: string, options?: AnalyticsCallOptions): void;
+/**
+ * Use gtag `config` command to set all params specified.
+ *
+ * @public
+ */
+export declare function setUserProperties(analyticsInstance: Analytics, properties: CustomParams, options?: AnalyticsCallOptions): void;
+/**
+ * Sets whether Google Analytics collection is enabled for this app on this device.
+ * Sets global `window['ga-disable-analyticsId'] = true;`
+ *
+ * @public
+ *
+ * @param analyticsInstance - The {@link Analytics} instance.
+ * @param enabled - If true, enables collection, if false, disables it.
+ */
+export declare function setAnalyticsCollectionEnabled(analyticsInstance: Analytics, enabled: boolean): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'add_payment_info', eventParams?: {
+    coupon?: EventParams['coupon'];
+    currency?: EventParams['currency'];
+    items?: EventParams['items'];
+    payment_type?: EventParams['payment_type'];
+    value?: EventParams['value'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'add_shipping_info', eventParams?: {
+    coupon?: EventParams['coupon'];
+    currency?: EventParams['currency'];
+    items?: EventParams['items'];
+    shipping_tier?: EventParams['shipping_tier'];
+    value?: EventParams['value'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'add_to_cart' | 'add_to_wishlist' | 'remove_from_cart', eventParams?: {
+    currency?: EventParams['currency'];
+    value?: EventParams['value'];
+    items?: EventParams['items'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'begin_checkout', eventParams?: {
+    currency?: EventParams['currency'];
+    coupon?: EventParams['coupon'];
+    value?: EventParams['value'];
+    items?: EventParams['items'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'checkout_progress', eventParams?: {
+    currency?: EventParams['currency'];
+    coupon?: EventParams['coupon'];
+    value?: EventParams['value'];
+    items?: EventParams['items'];
+    checkout_step?: EventParams['checkout_step'];
+    checkout_option?: EventParams['checkout_option'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * See
+ * {@link https://developers.google.com/analytics/devguides/collection/ga4/exceptions
+ * | Measure exceptions}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'exception', eventParams?: {
+    description?: EventParams['description'];
+    fatal?: EventParams['fatal'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'generate_lead', eventParams?: {
+    value?: EventParams['value'];
+    currency?: EventParams['currency'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'login', eventParams?: {
+    method?: EventParams['method'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * See
+ * {@link https://developers.google.com/analytics/devguides/collection/ga4/page-view
+ * | Page views}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'page_view', eventParams?: {
+    page_title?: string;
+    page_location?: string;
+    page_path?: string;
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'purchase' | 'refund', eventParams?: {
+    value?: EventParams['value'];
+    currency?: EventParams['currency'];
+    transaction_id: EventParams['transaction_id'];
+    tax?: EventParams['tax'];
+    shipping?: EventParams['shipping'];
+    items?: EventParams['items'];
+    coupon?: EventParams['coupon'];
+    affiliation?: EventParams['affiliation'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * See {@link https://firebase.google.com/docs/analytics/screenviews
+ * | Track Screenviews}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'screen_view', eventParams?: {
+    firebase_screen: EventParams['firebase_screen'];
+    firebase_screen_class: EventParams['firebase_screen_class'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'search' | 'view_search_results', eventParams?: {
+    search_term?: EventParams['search_term'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'select_content', eventParams?: {
+    content_type?: EventParams['content_type'];
+    item_id?: EventParams['item_id'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'select_item', eventParams?: {
+    items?: EventParams['items'];
+    item_list_name?: EventParams['item_list_name'];
+    item_list_id?: EventParams['item_list_id'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'select_promotion' | 'view_promotion', eventParams?: {
+    items?: EventParams['items'];
+    promotion_id?: EventParams['promotion_id'];
+    promotion_name?: EventParams['promotion_name'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'set_checkout_option', eventParams?: {
+    checkout_step?: EventParams['checkout_step'];
+    checkout_option?: EventParams['checkout_option'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'share', eventParams?: {
+    method?: EventParams['method'];
+    content_type?: EventParams['content_type'];
+    item_id?: EventParams['item_id'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'sign_up', eventParams?: {
+    method?: EventParams['method'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'timing_complete', eventParams?: {
+    name: string;
+    value: number;
+    event_category?: string;
+    event_label?: string;
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'view_cart' | 'view_item', eventParams?: {
+    currency?: EventParams['currency'];
+    items?: EventParams['items'];
+    value?: EventParams['value'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent(analyticsInstance: Analytics, eventName: 'view_item_list', eventParams?: {
+    items?: EventParams['items'];
+    item_list_name?: EventParams['item_list_name'];
+    item_list_id?: EventParams['item_list_id'];
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Sends a Google Analytics event with given `eventParams`. This method
+ * automatically associates this logged event with this Firebase web
+ * app instance on this device.
+ * @public
+ * List of recommended event parameters can be found in
+ * {@link https://developers.google.com/gtagjs/reference/ga4-events
+ * | the GA4 reference documentation}.
+ */
+export declare function logEvent<T extends string>(analyticsInstance: Analytics, eventName: CustomEventName<T>, eventParams?: {
+    [key: string]: any;
+}, options?: AnalyticsCallOptions): void;
+/**
+ * Any custom event name string not in the standard list of recommended
+ * event names.
+ * @public
+ */
+export declare type CustomEventName<T> = T extends EventNameString ? never : T;

package/dist/esm/src/api.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2019 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.
+ */
+import '../testing/setup';

package/dist/esm/src/constants.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @license
+ * Copyright 2019 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.
+ */
+/**
+ * Type constant for Firebase Analytics.
+ */
+export declare const ANALYTICS_TYPE = "analytics";
+export declare const GA_FID_KEY = "firebase_id";
+export declare const ORIGIN_KEY = "origin";
+export declare const FETCH_TIMEOUT_MILLIS: number;
+export declare const DYNAMIC_CONFIG_URL = "https://firebase.googleapis.com/v1alpha/projects/-/apps/{app-id}/webConfig";
+export declare const GTAG_URL = "https://www.googletagmanager.com/gtag/js";
+export declare const enum GtagCommand {
+    EVENT = "event",
+    SET = "set",
+    CONFIG = "config"
+}

package/dist/esm/src/errors.d.ts

@@ -0,0 +1,52 @@
+/**
+ * @license
+ * Copyright 2019 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.
+ */
+import { ErrorFactory } from '@firebase/util';
+export declare 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",
+    FETCH_THROTTLE = "fetch-throttle",
+    CONFIG_FETCH_FAILED = "config-fetch-failed",
+    NO_API_KEY = "no-api-key",
+    NO_APP_ID = "no-app-id"
+}
+interface ErrorParams {
+    [AnalyticsError.ALREADY_EXISTS]: {
+        id: string;
+    };
+    [AnalyticsError.INTEROP_COMPONENT_REG_FAILED]: {
+        reason: Error;
+    };
+    [AnalyticsError.FETCH_THROTTLE]: {
+        throttleEndTimeMillis: number;
+    };
+    [AnalyticsError.CONFIG_FETCH_FAILED]: {
+        httpStatus: number;
+        responseMessage: string;
+    };
+    [AnalyticsError.INVALID_ANALYTICS_CONTEXT]: {
+        errorInfo: string;
+    };
+    [AnalyticsError.INDEXEDDB_UNAVAILABLE]: {
+        errorInfo: string;
+    };
+}
+export declare const ERROR_FACTORY: ErrorFactory<AnalyticsError, ErrorParams>;
+export {};

package/dist/esm/src/factory.d.ts

@@ -0,0 +1,74 @@
+/**
+ * @license
+ * Copyright 2019 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.
+ */
+import { SettingsOptions, Analytics, AnalyticsSettings } from './public-types';
+import { Gtag, DynamicConfig, MinimalDynamicConfig } from './types';
+import { _FirebaseInstallationsInternal } from '@firebase/installations';
+import { FirebaseApp, _FirebaseService } from '@firebase/app';
+/**
+ * Analytics Service class.
+ */
+export declare class AnalyticsService implements Analytics, _FirebaseService {
+    app: FirebaseApp;
+    constructor(app: FirebaseApp);
+    _delete(): Promise<void>;
+}
+/**
+ * Maps appId to full initialization promise. Wrapped gtag calls must wait on
+ * all or some of these, depending on the call's `send_to` param and the status
+ * of the dynamic config fetches (see below).
+ */
+export declare let initializationPromisesMap: {
+    [appId: string]: Promise<string>;
+};
+/**
+ * Wrapper around gtag function that ensures FID is sent with all
+ * relevant event and config calls.
+ */
+export declare let wrappedGtagFunction: Gtag;
+/**
+ * For testing
+ * @internal
+ */
+export declare function resetGlobalVars(newGlobalInitDone?: boolean, newInitializationPromisesMap?: {}, newDynamicPromises?: never[]): void;
+/**
+ * For testing
+ * @internal
+ */
+export declare function getGlobalVars(): {
+    initializationPromisesMap: {
+        [appId: string]: Promise<string>;
+    };
+    dynamicConfigPromisesList: Array<Promise<DynamicConfig | MinimalDynamicConfig>>;
+};
+/**
+ * Configures Firebase Analytics to use custom `gtag` or `dataLayer` names.
+ * Intended to be used if `gtag.js` script has been installed on
+ * this page independently of Firebase Analytics, and is using non-default
+ * names for either the `gtag` function or for `dataLayer`.
+ * Must be called before calling `getAnalytics()` or it won't
+ * have any effect.
+ *
+ * @public
+ *
+ * @param options - Custom gtag and dataLayer names.
+ */
+export declare function settings(options: SettingsOptions): void;
+/**
+ * Analytics instance factory.
+ * @internal
+ */
+export declare function factory(app: FirebaseApp, installations: _FirebaseInstallationsInternal, options?: AnalyticsSettings): AnalyticsService;

package/dist/esm/src/functions.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @license
+ * Copyright 2019 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.
+ */
+import { AnalyticsCallOptions, CustomParams, EventParams } from './public-types';
+import { Gtag } from './types';
+/**
+ * Logs an analytics event through the Firebase SDK.
+ *
+ * @param gtagFunction Wrapped gtag function that waits for fid to be set before sending an event
+ * @param eventName Google Analytics event name, choose from standard list or use a custom string.
+ * @param eventParams Analytics event parameters.
+ */
+export declare function logEvent(gtagFunction: Gtag, initializationPromise: Promise<string>, eventName: string, eventParams?: EventParams, options?: AnalyticsCallOptions): Promise<void>;
+/**
+ * Set screen_name parameter for this Google Analytics ID.
+ *
+ * @param gtagFunction Wrapped gtag function that waits for fid to be set before sending an event
+ * @param screenName Screen name string to set.
+ */
+export declare function setCurrentScreen(gtagFunction: Gtag, initializationPromise: Promise<string>, screenName: string | null, options?: AnalyticsCallOptions): Promise<void>;
+/**
+ * Set user_id parameter for this Google Analytics ID.
+ *
+ * @param gtagFunction Wrapped gtag function that waits for fid to be set before sending an event
+ * @param id User ID string to set
+ */
+export declare function setUserId(gtagFunction: Gtag, initializationPromise: Promise<string>, id: string | null, options?: AnalyticsCallOptions): Promise<void>;
+/**
+ * Set all other user properties other than user_id and screen_name.
+ *
+ * @param gtagFunction Wrapped gtag function that waits for fid to be set before sending an event
+ * @param properties Map of user properties to set
+ */
+export declare function setUserProperties(gtagFunction: Gtag, initializationPromise: Promise<string>, properties: CustomParams, options?: AnalyticsCallOptions): Promise<void>;
+/**
+ * Set whether collection is enabled for this ID.
+ *
+ * @param enabled If true, collection is enabled for this ID.
+ */
+export declare function setAnalyticsCollectionEnabled(initializationPromise: Promise<string>, enabled: boolean): Promise<void>;

package/dist/esm/src/functions.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2019 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.
+ */
+import '../testing/setup';