@firebase/analytics 0.9.5 → 0.10.0-canary.5a2ceb07b

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @firebase/analytics
 
+## 0.10.0
+
+### Minor Changes
+
+- [`0a27d2fbf`](https://github.com/firebase/firebase-js-sdk/commit/0a27d2fbf268f07099d4fa5ecab7fbf35a579780) [#7158](https://github.com/firebase/firebase-js-sdk/pull/7158) - Add method `getGoogleAnalyticsClientId()` to retrieve an unique identifier for a web client. This allows users to log purchase and other events from their backends using Google Analytics 4 Measurement Protocol and to have those events be connected to actions taken on the client within their Firebase web app. `getGoogleAnalyticsClientId()` will simplify this event recording process.
+
 ## 0.9.5
 
 ### 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';
@@ -92,6 +92,7 @@ var ERRORS = (_a = {},
         '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);
@@ -335,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];
@@ -843,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.
  *
@@ -1273,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`.
  *
@@ -1358,7 +1415,7 @@ function setConsent(consentSettings) {
 }
 
 var name = "@firebase/analytics";
-var version = "0.9.5";
+var version = "0.10.0-canary.5a2ceb07b";
 
 /**
  * Firebase Analytics
@@ -1395,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