@firebase/analytics 0.10.9 → 0.10.10-canary.ffbf5a60a

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

@@ -1,17 +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';
+/**
+ * @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/src/constants.d.ts

@@ -1,32 +1,32 @@
-/**
- * @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",
-    CONSENT = "consent",
-    GET = "get"
-}
+/**
+ * @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",
+    CONSENT = "consent",
+    GET = "get"
+}

package/dist/src/errors.d.ts

@@ -1,57 +1,57 @@
-/**
- * @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",
-    NO_CLIENT_ID = "no-client-id",
-    INVALID_GTAG_RESOURCE = "invalid-gtag-resource"
-}
-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;
-    };
-    [AnalyticsError.INVALID_GTAG_RESOURCE]: {
-        gtagURL: string;
-    };
-}
-export declare const ERROR_FACTORY: ErrorFactory<AnalyticsError, ErrorParams>;
-export {};
+/**
+ * @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",
+    NO_CLIENT_ID = "no-client-id",
+    INVALID_GTAG_RESOURCE = "invalid-gtag-resource"
+}
+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;
+    };
+    [AnalyticsError.INVALID_GTAG_RESOURCE]: {
+        gtagURL: string;
+    };
+}
+export declare const ERROR_FACTORY: ErrorFactory<AnalyticsError, ErrorParams>;
+export {};

package/dist/src/factory.d.ts

@@ -1,74 +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;
+/**
+ * @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/src/functions.d.ts

@@ -1,85 +1,85 @@
-/**
- * @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, ConsentSettings } from './public-types';
-import { Gtag } from './types';
-/**
- * Event parameters to set on 'gtag' during initialization.
- */
-export declare let defaultEventParametersForInit: CustomParams | undefined;
-/**
- * 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.
- *
- * @deprecated Use {@link logEvent} with `eventName` as 'screen_view' and add relevant `eventParams`.
- * See {@link https://firebase.google.com/docs/analytics/screenviews | Track Screenviews}.
- *
- * @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>;
-/**
- * Retrieves a unique Google Analytics identifier for the web client.
- * See {@link https://developers.google.com/analytics/devguides/collection/ga4/reference/config#client_id | client_id}.
- *
- * @param gtagFunction Wrapped gtag function that waits for fid to be set before sending an event
- */
-export declare function internalGetGoogleAnalyticsClientId(gtagFunction: Gtag, initializationPromise: Promise<string>): Promise<string>;
-/**
- * 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>;
-/**
- * Consent parameters to default to during 'gtag' initialization.
- */
-export declare let defaultConsentSettingsForInit: ConsentSettings | undefined;
-/**
- * Sets the variable {@link defaultConsentSettingsForInit} for use in the initialization of
- * analytics.
- *
- * @param consentSettings Maps the applicable end user consent state for gtag.js.
- */
-export declare function _setConsentDefaultForInit(consentSettings?: ConsentSettings): void;
-/**
- * Sets the variable `defaultEventParametersForInit` for use in the initialization of
- * analytics.
- *
- * @param customParams Any custom params the user may pass to gtag.js.
- */
-export declare function _setDefaultEventParametersForInit(customParams?: CustomParams): void;
+/**
+ * @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, ConsentSettings } from './public-types';
+import { Gtag } from './types';
+/**
+ * Event parameters to set on 'gtag' during initialization.
+ */
+export declare let defaultEventParametersForInit: CustomParams | undefined;
+/**
+ * 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.
+ *
+ * @deprecated Use {@link logEvent} with `eventName` as 'screen_view' and add relevant `eventParams`.
+ * See {@link https://firebase.google.com/docs/analytics/screenviews | Track Screenviews}.
+ *
+ * @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>;
+/**
+ * Retrieves a unique Google Analytics identifier for the web client.
+ * See {@link https://developers.google.com/analytics/devguides/collection/ga4/reference/config#client_id | client_id}.
+ *
+ * @param gtagFunction Wrapped gtag function that waits for fid to be set before sending an event
+ */
+export declare function internalGetGoogleAnalyticsClientId(gtagFunction: Gtag, initializationPromise: Promise<string>): Promise<string>;
+/**
+ * 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>;
+/**
+ * Consent parameters to default to during 'gtag' initialization.
+ */
+export declare let defaultConsentSettingsForInit: ConsentSettings | undefined;
+/**
+ * Sets the variable {@link defaultConsentSettingsForInit} for use in the initialization of
+ * analytics.
+ *
+ * @param consentSettings Maps the applicable end user consent state for gtag.js.
+ */
+export declare function _setConsentDefaultForInit(consentSettings?: ConsentSettings): void;
+/**
+ * Sets the variable `defaultEventParametersForInit` for use in the initialization of
+ * analytics.
+ *
+ * @param customParams Any custom params the user may pass to gtag.js.
+ */
+export declare function _setDefaultEventParametersForInit(customParams?: CustomParams): void;

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

@@ -1,17 +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';
+/**
+ * @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';