Update public api signature for setUserId to reflect internal functions (#6671)

* Update public api signature for setUserId

* Update API reports

* Add changeset

Author: dwyfrequency

.changeset/moody-icons-repeat.md

@@ -0,0 +1,5 @@
+---
+'@firebase/analytics': patch
+---
+
+Correct `id` type in `setUserId`

common/api-review/analytics.api.md

@@ -421,7 +421,7 @@ export interface SettingsOptions {
 }
 
 // @public
-export function setUserId(analyticsInstance: Analytics, id: string, options?: AnalyticsCallOptions): void;
+export function setUserId(analyticsInstance: Analytics, id: string | null, options?: AnalyticsCallOptions): void;
 
 // @public
 export function setUserProperties(analyticsInstance: Analytics, properties: CustomParams, options?: AnalyticsCallOptions): void;

packages/analytics/src/api.ts

@@ -177,7 +177,7 @@ export function setCurrentScreen(
  */
 export function setUserId(
   analyticsInstance: Analytics,
-  id: string,
+  id: string | null,
   options?: AnalyticsCallOptions
 ): void {
   analyticsInstance = getModularInstance(analyticsInstance);

packages/analytics/src/functions.test.ts

@@ -116,6 +116,18 @@ describe('FirebaseAnalytics methods', () => {
     });
   });
 
+  it('setUserId() with null (user) id calls gtag correctly (instance)', async () => {
+    await setUserId(gtagStub, fakeInitializationPromise, null);
+    expect(gtagStub).to.have.been.calledWith(
+      GtagCommand.CONFIG,
+      fakeMeasurementId,
+      {
+        'user_id': null,
+        update: true
+      }
+    );
+  });
+
   it('setUserId() calls gtag correctly (instance)', async () => {
     await setUserId(gtagStub, fakeInitializationPromise, 'user123');
     expect(gtagStub).to.have.been.calledWith(
@@ -137,6 +149,15 @@ describe('FirebaseAnalytics methods', () => {
     });
   });
 
+  it('setUserId() with null (user) id calls gtag correctly (global)', async () => {
+    await setUserId(gtagStub, fakeInitializationPromise, null, {
+      global: true
+    });
+    expect(gtagStub).to.be.calledWith(GtagCommand.SET, {
+      'user_id': null
+    });
+  });
+
   it('setUserProperties() calls gtag correctly (instance)', async () => {
     await setUserProperties(gtagStub, fakeInitializationPromise, {
       'currency': 'USD',