@firebase/analytics 0.9.4 → 0.9.5-canary.0832dcac2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @firebase/analytics
 
+## 0.9.5
+
+### Patch Changes
+
+- [`3435ba945`](https://github.com/firebase/firebase-js-sdk/commit/3435ba945a9febf5a0aece05517a5656f58b246f) [#7155](https://github.com/firebase/firebase-js-sdk/pull/7155) (fixes [#7048](https://github.com/firebase/firebase-js-sdk/issues/7048)) - Use the Trusted Types API when composing the gtag URL.
+
 ## 0.9.4
 
 ### Patch Changes

package/dist/analytics-public.d.ts

@@ -174,6 +174,16 @@ export declare interface EventParams {
  */
 export declare function getAnalytics(app?: FirebaseApp): Analytics;
 
+/**
+ * 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}.
+ *
+ * @public
+ *
+ * @param app - The {@link @firebase/app#FirebaseApp} to use.
+ */
+export declare function getGoogleAnalyticsClientId(analyticsInstance: Analytics): Promise<string>;
+
 /**
  * A set of common Google Analytics config settings recognized by
  * `gtag.js`.

package/dist/analytics.d.ts

@@ -174,6 +174,16 @@ export declare interface EventParams {
  */
 export declare function getAnalytics(app?: FirebaseApp): Analytics;
 
+/**
+ * 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}.
+ *
+ * @public
+ *
+ * @param app - The {@link @firebase/app#FirebaseApp} to use.
+ */
+export declare function getGoogleAnalyticsClientId(analyticsInstance: Analytics): Promise<string>;
+
 /**
  * A set of common Google Analytics config settings recognized by
  * `gtag.js`.

package/dist/esm/index.esm.js

@@ -1,5 +1,5 @@
 import { getApp, _getProvider, _registerComponent, registerVersion } from '@firebase/app';
-import { __awaiter, __generator, __assign } from 'tslib';
+import { __awaiter, __generator, __spreadArray, __assign } from 'tslib';
 import { Logger } from '@firebase/logger';
 import { ErrorFactory, calculateBackoffMillis, FirebaseError, validateIndexedDBOpenable, isIndexedDBAvailable, isBrowserExtension, areCookiesEnabled, getModularInstance, deepEqual } from '@firebase/util';
 import { Component } from '@firebase/component';
@@ -66,6 +66,66 @@ var logger = new Logger('@firebase/analytics');
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+var _a;
+var ERRORS = (_a = {},
+    _a["already-exists" /* AnalyticsError.ALREADY_EXISTS */] = 'A Firebase Analytics instance with the appId {$id} ' +
+        ' already exists. ' +
+        'Only one Firebase Analytics instance can be created for each appId.',
+    _a["already-initialized" /* AnalyticsError.ALREADY_INITIALIZED */] = 'initializeAnalytics() cannot be called again with different options than those ' +
+        'it was initially called with. It can be called again with the same options to ' +
+        'return the existing instance, or getAnalytics() can be used ' +
+        'to get a reference to the already-intialized instance.',
+    _a["already-initialized-settings" /* 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.',
+    _a["interop-component-reg-failed" /* AnalyticsError.INTEROP_COMPONENT_REG_FAILED */] = 'Firebase Analytics Interop Component failed to instantiate: {$reason}',
+    _a["invalid-analytics-context" /* AnalyticsError.INVALID_ANALYTICS_CONTEXT */] = 'Firebase Analytics is not supported in this environment. ' +
+        'Wrap initialization of analytics in analytics.isSupported() ' +
+        'to prevent initialization in unsupported environments. Details: {$errorInfo}',
+    _a["indexeddb-unavailable" /* AnalyticsError.INDEXEDDB_UNAVAILABLE */] = 'IndexedDB unavailable or restricted in this environment. ' +
+        'Wrap initialization of analytics in analytics.isSupported() ' +
+        'to prevent initialization in unsupported environments. Details: {$errorInfo}',
+    _a["fetch-throttle" /* AnalyticsError.FETCH_THROTTLE */] = 'The config fetch request timed out while in an exponential backoff state.' +
+        ' Unix timestamp in milliseconds when fetch request throttling ends: {$throttleEndTimeMillis}.',
+    _a["config-fetch-failed" /* AnalyticsError.CONFIG_FETCH_FAILED */] = 'Dynamic config fetch failed: [{$httpStatus}] {$responseMessage}',
+    _a["no-api-key" /* AnalyticsError.NO_API_KEY */] = 'The "apiKey" field is empty in the local Firebase config. Firebase Analytics requires this field to' +
+        'contain a valid API key.',
+    _a["no-app-id" /* AnalyticsError.NO_APP_ID */] = 'The "appId" field is empty in the local Firebase config. Firebase Analytics requires this field to' +
+        'contain a valid app ID.',
+    _a["no-client-id" /* AnalyticsError.NO_CLIENT_ID */] = 'The "client_id" field is empty.',
+    _a["invalid-gtag-resource" /* AnalyticsError.INVALID_GTAG_RESOURCE */] = 'Trusted Types detected an invalid gtag resource: {$gtagURL}.',
+    _a);
+var ERROR_FACTORY = new ErrorFactory('analytics', 'Analytics', ERRORS);
+
+/**
+ * @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.
+ */
+/**
+ * Verifies and creates a TrustedScriptURL.
+ */
+function createGtagTrustedTypesScriptURL(url) {
+    if (!url.startsWith(GTAG_URL)) {
+        var err = ERROR_FACTORY.create("invalid-gtag-resource" /* AnalyticsError.INVALID_GTAG_RESOURCE */, {
+            gtagURL: url
+        });
+        logger.warn(err.message);
+        return '';
+    }
+    return url;
+}
 /**
  * Makeshift polyfill for Promise.allSettled(). Resolves when all promises
  * have either resolved or rejected.
@@ -75,15 +135,37 @@ var logger = new Logger('@firebase/analytics');
 function promiseAllSettled(promises) {
     return Promise.all(promises.map(function (promise) { return promise.catch(function (e) { return e; }); }));
 }
+/**
+ * Creates a TrustedTypePolicy object that implements the rules passed as policyOptions.
+ *
+ * @param policyName A string containing the name of the policy
+ * @param policyOptions Object containing implementations of instance methods for TrustedTypesPolicy, see {@link https://developer.mozilla.org/en-US/docs/Web/API/TrustedTypePolicy#instance_methods
+ * | the TrustedTypePolicy reference documentation}.
+ */
+function createTrustedTypesPolicy(policyName, policyOptions) {
+    // Create a TrustedTypes policy that we can use for updating src
+    // properties
+    var trustedTypesPolicy;
+    if (window.trustedTypes) {
+        trustedTypesPolicy = window.trustedTypes.createPolicy(policyName, policyOptions);
+    }
+    return trustedTypesPolicy;
+}
 /**
  * Inserts gtag script tag into the page to asynchronously download gtag.
  * @param dataLayerName Name of datalayer (most often the default, "_dataLayer").
  */
 function insertScriptTag(dataLayerName, measurementId) {
+    var trustedTypesPolicy = createTrustedTypesPolicy('firebase-js-sdk-policy', {
+        createScriptURL: createGtagTrustedTypesScriptURL
+    });
     var script = document.createElement('script');
     // We are not providing an analyticsId in the URL because it would trigger a `page_view`
     // without fid. We will initialize ga-id using gtag (config) command together with fid.
-    script.src = "".concat(GTAG_URL, "?l=").concat(dataLayerName, "&id=").concat(measurementId);
+    var gtagScriptURL = "".concat(GTAG_URL, "?l=").concat(dataLayerName, "&id=").concat(measurementId);
+    script.src = trustedTypesPolicy
+        ? trustedTypesPolicy === null || trustedTypesPolicy === void 0 ? void 0 : trustedTypesPolicy.createScriptURL(gtagScriptURL)
+        : gtagScriptURL;
     script.async = true;
     document.head.appendChild(script);
 }
@@ -254,36 +336,50 @@ measurementIdToAppId) {
      * @param idOrNameOrParams Measurement ID if command is EVENT/CONFIG, params if command is SET.
      * @param gtagParams Params if event is EVENT/CONFIG.
      */
-    function gtagWrapper(command, idOrNameOrParams, gtagParams) {
+    function gtagWrapper(command) {
+        var args = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            args[_i - 1] = arguments[_i];
+        }
         return __awaiter(this, void 0, void 0, function () {
-            var e_3;
+            var measurementId, gtagParams, measurementId, gtagParams, gtagParams, measurementId, fieldName, callback, customParams, e_3;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         _a.trys.push([0, 6, , 7]);
                         if (!(command === "event" /* GtagCommand.EVENT */)) return [3 /*break*/, 2];
+                        measurementId = args[0], gtagParams = args[1];
                         // If EVENT, second arg must be measurementId.
-                        return [4 /*yield*/, gtagOnEvent(gtagCore, initializationPromisesMap, dynamicConfigPromisesList, idOrNameOrParams, gtagParams)];
+                        return [4 /*yield*/, gtagOnEvent(gtagCore, initializationPromisesMap, dynamicConfigPromisesList, measurementId, gtagParams)];
                     case 1:
                         // If EVENT, second arg must be measurementId.
                         _a.sent();
                         return [3 /*break*/, 5];
                     case 2:
                         if (!(command === "config" /* GtagCommand.CONFIG */)) return [3 /*break*/, 4];
+                        measurementId = args[0], gtagParams = args[1];
                         // If CONFIG, second arg must be measurementId.
-                        return [4 /*yield*/, gtagOnConfig(gtagCore, initializationPromisesMap, dynamicConfigPromisesList, measurementIdToAppId, idOrNameOrParams, gtagParams)];
+                        return [4 /*yield*/, gtagOnConfig(gtagCore, initializationPromisesMap, dynamicConfigPromisesList, measurementIdToAppId, measurementId, gtagParams)];
                     case 3:
                         // If CONFIG, second arg must be measurementId.
                         _a.sent();
                         return [3 /*break*/, 5];
                     case 4:
                         if (command === "consent" /* GtagCommand.CONSENT */) {
-                            // If CONFIG, second arg must be measurementId.
+                            gtagParams = args[0];
                             gtagCore("consent" /* GtagCommand.CONSENT */, 'update', gtagParams);
                         }
-                        else {
+                        else if (command === "get" /* GtagCommand.GET */) {
+                            measurementId = args[0], fieldName = args[1], callback = args[2];
+                            gtagCore("get" /* GtagCommand.GET */, measurementId, fieldName, callback);
+                        }
+                        else if (command === "set" /* GtagCommand.SET */) {
+                            customParams = args[0];
                             // If SET, second arg must be params.
-                            gtagCore("set" /* GtagCommand.SET */, idOrNameOrParams);
+                            gtagCore("set" /* GtagCommand.SET */, customParams);
+                        }
+                        else {
+                            gtagCore.apply(void 0, __spreadArray([command], args, false));
                         }
                         _a.label = 5;
                     case 5: return [3 /*break*/, 7];
@@ -344,51 +440,6 @@ function findGtagScriptOnPage(dataLayerName) {
     return null;
 }
 
-/**
- * @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.
- */
-var _a;
-var ERRORS = (_a = {},
-    _a["already-exists" /* AnalyticsError.ALREADY_EXISTS */] = 'A Firebase Analytics instance with the appId {$id} ' +
-        ' already exists. ' +
-        'Only one Firebase Analytics instance can be created for each appId.',
-    _a["already-initialized" /* AnalyticsError.ALREADY_INITIALIZED */] = 'initializeAnalytics() cannot be called again with different options than those ' +
-        'it was initially called with. It can be called again with the same options to ' +
-        'return the existing instance, or getAnalytics() can be used ' +
-        'to get a reference to the already-intialized instance.',
-    _a["already-initialized-settings" /* 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.',
-    _a["interop-component-reg-failed" /* AnalyticsError.INTEROP_COMPONENT_REG_FAILED */] = 'Firebase Analytics Interop Component failed to instantiate: {$reason}',
-    _a["invalid-analytics-context" /* AnalyticsError.INVALID_ANALYTICS_CONTEXT */] = 'Firebase Analytics is not supported in this environment. ' +
-        'Wrap initialization of analytics in analytics.isSupported() ' +
-        'to prevent initialization in unsupported environments. Details: {$errorInfo}',
-    _a["indexeddb-unavailable" /* AnalyticsError.INDEXEDDB_UNAVAILABLE */] = 'IndexedDB unavailable or restricted in this environment. ' +
-        'Wrap initialization of analytics in analytics.isSupported() ' +
-        'to prevent initialization in unsupported environments. Details: {$errorInfo}',
-    _a["fetch-throttle" /* AnalyticsError.FETCH_THROTTLE */] = 'The config fetch request timed out while in an exponential backoff state.' +
-        ' Unix timestamp in milliseconds when fetch request throttling ends: {$throttleEndTimeMillis}.',
-    _a["config-fetch-failed" /* AnalyticsError.CONFIG_FETCH_FAILED */] = 'Dynamic config fetch failed: [{$httpStatus}] {$responseMessage}',
-    _a["no-api-key" /* AnalyticsError.NO_API_KEY */] = 'The "apiKey" field is empty in the local Firebase config. Firebase Analytics requires this field to' +
-        'contain a valid API key.',
-    _a["no-app-id" /* AnalyticsError.NO_APP_ID */] = 'The "appId" field is empty in the local Firebase config. Firebase Analytics requires this field to' +
-        'contain a valid app ID.',
-    _a);
-var ERROR_FACTORY = new ErrorFactory('analytics', 'Analytics', ERRORS);
-
 /**
  * @license
  * Copyright 2020 Google LLC
@@ -807,6 +858,32 @@ function setUserProperties$1(gtagFunction, initializationPromise, properties, op
         });
     });
 }
+/**
+ * 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
+ */
+function internalGetGoogleAnalyticsClientId(gtagFunction, initializationPromise) {
+    return __awaiter(this, void 0, void 0, function () {
+        var measurementId;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, initializationPromise];
+                case 1:
+                    measurementId = _a.sent();
+                    return [2 /*return*/, new Promise(function (resolve, reject) {
+                            gtagFunction("get" /* GtagCommand.GET */, measurementId, 'client_id', function (clientId) {
+                                if (!clientId) {
+                                    reject(ERROR_FACTORY.create("no-client-id" /* AnalyticsError.NO_CLIENT_ID */));
+                                }
+                                resolve(clientId);
+                            });
+                        })];
+            }
+        });
+    });
+}
 /**
  * Set whether collection is enabled for this ID.
  *
@@ -1237,6 +1314,22 @@ function setCurrentScreen(analyticsInstance, screenName, options) {
     analyticsInstance = getModularInstance(analyticsInstance);
     setCurrentScreen$1(wrappedGtagFunction, initializationPromisesMap[analyticsInstance.app.options.appId], screenName, options).catch(function (e) { return logger.error(e); });
 }
+/**
+ * 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}.
+ *
+ * @public
+ *
+ * @param app - The {@link @firebase/app#FirebaseApp} to use.
+ */
+function getGoogleAnalyticsClientId(analyticsInstance) {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            analyticsInstance = getModularInstance(analyticsInstance);
+            return [2 /*return*/, internalGetGoogleAnalyticsClientId(wrappedGtagFunction, initializationPromisesMap[analyticsInstance.app.options.appId])];
+        });
+    });
+}
 /**
  * Use gtag `config` command to set `user_id`.
  *
@@ -1322,7 +1415,7 @@ function setConsent(consentSettings) {
 }
 
 var name = "@firebase/analytics";
-var version = "0.9.4";
+var version = "0.9.5-canary.0832dcac2";
 
 /**
  * Firebase Analytics
@@ -1359,5 +1452,5 @@ function registerAnalytics() {
 }
 registerAnalytics();
 
-export { getAnalytics, initializeAnalytics, isSupported, logEvent, setAnalyticsCollectionEnabled, setConsent, setCurrentScreen, setDefaultEventParameters, setUserId, setUserProperties, settings };
+export { getAnalytics, getGoogleAnalyticsClientId, initializeAnalytics, isSupported, logEvent, setAnalyticsCollectionEnabled, setConsent, setCurrentScreen, setDefaultEventParameters, setUserId, setUserProperties, settings };
 //# sourceMappingURL=index.esm.js.map