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

package/dist/esm/index.esm2017.js

@@ -65,6 +65,65 @@ const logger = new Logger('@firebase/analytics');
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+const ERRORS = {
+    ["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.',
+    ["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.',
+    ["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.',
+    ["interop-component-reg-failed" /* AnalyticsError.INTEROP_COMPONENT_REG_FAILED */]: 'Firebase Analytics Interop Component failed to instantiate: {$reason}',
+    ["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}',
+    ["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}',
+    ["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}.',
+    ["config-fetch-failed" /* AnalyticsError.CONFIG_FETCH_FAILED */]: 'Dynamic config fetch failed: [{$httpStatus}] {$responseMessage}',
+    ["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.',
+    ["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.',
+    ["no-client-id" /* AnalyticsError.NO_CLIENT_ID */]: 'The "client_id" field is empty.',
+    ["invalid-gtag-resource" /* AnalyticsError.INVALID_GTAG_RESOURCE */]: 'Trusted Types detected an invalid gtag resource: {$gtagURL}.'
+};
+const 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)) {
+        const 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.
@@ -74,15 +133,37 @@ const logger = new Logger('@firebase/analytics');
 function promiseAllSettled(promises) {
     return Promise.all(promises.map(promise => promise.catch(e => 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
+    let 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) {
+    const trustedTypesPolicy = createTrustedTypesPolicy('firebase-js-sdk-policy', {
+        createScriptURL: createGtagTrustedTypesScriptURL
+    });
     const 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 = `${GTAG_URL}?l=${dataLayerName}&id=${measurementId}`;
+    const gtagScriptURL = `${GTAG_URL}?l=${dataLayerName}&id=${measurementId}`;
+    script.src = trustedTypesPolicy
+        ? trustedTypesPolicy === null || trustedTypesPolicy === void 0 ? void 0 : trustedTypesPolicy.createScriptURL(gtagScriptURL)
+        : gtagScriptURL;
     script.async = true;
     document.head.appendChild(script);
 }
@@ -223,24 +304,34 @@ measurementIdToAppId) {
      * @param idOrNameOrParams Measurement ID if command is EVENT/CONFIG, params if command is SET.
      * @param gtagParams Params if event is EVENT/CONFIG.
      */
-    async function gtagWrapper(command, idOrNameOrParams, gtagParams) {
+    async function gtagWrapper(command, ...args) {
         try {
             // If event, check that relevant initialization promises have completed.
             if (command === "event" /* GtagCommand.EVENT */) {
+                const [measurementId, gtagParams] = args;
                 // If EVENT, second arg must be measurementId.
-                await gtagOnEvent(gtagCore, initializationPromisesMap, dynamicConfigPromisesList, idOrNameOrParams, gtagParams);
+                await gtagOnEvent(gtagCore, initializationPromisesMap, dynamicConfigPromisesList, measurementId, gtagParams);
             }
             else if (command === "config" /* GtagCommand.CONFIG */) {
+                const [measurementId, gtagParams] = args;
                 // If CONFIG, second arg must be measurementId.
-                await gtagOnConfig(gtagCore, initializationPromisesMap, dynamicConfigPromisesList, measurementIdToAppId, idOrNameOrParams, gtagParams);
+                await gtagOnConfig(gtagCore, initializationPromisesMap, dynamicConfigPromisesList, measurementIdToAppId, measurementId, gtagParams);
             }
             else if (command === "consent" /* GtagCommand.CONSENT */) {
-                // If CONFIG, second arg must be measurementId.
+                const [gtagParams] = args;
                 gtagCore("consent" /* GtagCommand.CONSENT */, 'update', gtagParams);
             }
-            else {
+            else if (command === "get" /* GtagCommand.GET */) {
+                const [measurementId, fieldName, callback] = args;
+                gtagCore("get" /* GtagCommand.GET */, measurementId, fieldName, callback);
+            }
+            else if (command === "set" /* GtagCommand.SET */) {
+                const [customParams] = args;
                 // If SET, second arg must be params.
-                gtagCore("set" /* GtagCommand.SET */, idOrNameOrParams);
+                gtagCore("set" /* GtagCommand.SET */, customParams);
+            }
+            else {
+                gtagCore(command, ...args);
             }
         }
         catch (e) {
@@ -294,50 +385,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.
- */
-const ERRORS = {
-    ["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.',
-    ["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.',
-    ["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.',
-    ["interop-component-reg-failed" /* AnalyticsError.INTEROP_COMPONENT_REG_FAILED */]: 'Firebase Analytics Interop Component failed to instantiate: {$reason}',
-    ["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}',
-    ["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}',
-    ["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}.',
-    ["config-fetch-failed" /* AnalyticsError.CONFIG_FETCH_FAILED */]: 'Dynamic config fetch failed: [{$httpStatus}] {$responseMessage}',
-    ["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.',
-    ["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.'
-};
-const ERROR_FACTORY = new ErrorFactory('analytics', 'Analytics', ERRORS);
-
 /**
  * @license
  * Copyright 2020 Google LLC
@@ -678,6 +725,23 @@ async function setUserProperties$1(gtagFunction, initializationPromise, properti
         });
     }
 }
+/**
+ * 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
+ */
+async function internalGetGoogleAnalyticsClientId(gtagFunction, initializationPromise) {
+    const measurementId = await initializationPromise;
+    return new Promise((resolve, reject) => {
+        gtagFunction("get" /* GtagCommand.GET */, measurementId, 'client_id', (clientId) => {
+            if (!clientId) {
+                reject(ERROR_FACTORY.create("no-client-id" /* AnalyticsError.NO_CLIENT_ID */));
+            }
+            resolve(clientId);
+        });
+    });
+}
 /**
  * Set whether collection is enabled for this ID.
  *
@@ -1067,6 +1131,18 @@ function setCurrentScreen(analyticsInstance, screenName, options) {
     analyticsInstance = getModularInstance(analyticsInstance);
     setCurrentScreen$1(wrappedGtagFunction, initializationPromisesMap[analyticsInstance.app.options.appId], screenName, options).catch(e => 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.
+ */
+async function getGoogleAnalyticsClientId(analyticsInstance) {
+    analyticsInstance = getModularInstance(analyticsInstance);
+    return internalGetGoogleAnalyticsClientId(wrappedGtagFunction, initializationPromisesMap[analyticsInstance.app.options.appId]);
+}
 /**
  * Use gtag `config` command to set `user_id`.
  *
@@ -1152,7 +1228,7 @@ function setConsent(consentSettings) {
 }
 
 const name = "@firebase/analytics";
-const version = "0.9.4";
+const version = "0.9.5-canary.0832dcac2";
 
 /**
  * Firebase Analytics
@@ -1188,5 +1264,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.esm2017.js.map