Update types, documentation and functionality

Author: dwyfrequency

packages/analytics/src/api.ts

@@ -725,7 +725,7 @@ export type CustomEventName<T> = T extends EventNameString ? never : T;
  *
  * Use the {@link ConsentSettings} to specify individual consent type values. By default consent
  * types are set to "granted".
- *
+ * @public
  * @param consentSettings Maps the applicable end user consent state for gtag.js.
  */
 export function setConsent(consentSettings: ConsentSettings): void {

packages/analytics/src/functions.ts

@@ -156,14 +156,7 @@ export let defaultConsentSettingsForInit: ConsentSettings | undefined;
  * @param consentSettings Maps the applicable end user consent state for gtag.js.
  */
 export function _setConsentDefaultForInit(
-  consentSettings: ConsentSettings
+  consentSettings?: ConsentSettings
 ): void {
-  if (defaultConsentSettingsForInit) {
-    defaultConsentSettingsForInit = {
-      ...defaultConsentSettingsForInit,
-      ...consentSettings
-    };
-  } else {
-    defaultConsentSettingsForInit = consentSettings;
-  }
+  defaultConsentSettingsForInit = consentSettings;
 }

packages/analytics/src/initialize-analytics.ts

@@ -28,7 +28,10 @@ import {
 import { ERROR_FACTORY, AnalyticsError } from './errors';
 import { findGtagScriptOnPage, insertScriptTag } from './helpers';
 import { AnalyticsSettings } from './public-types';
-import { defaultConsentSettingsForInit } from './functions';
+import {
+  defaultConsentSettingsForInit,
+  _setConsentDefaultForInit
+} from './functions';
 
 async function validateIndexedDB(): Promise<boolean> {
   if (!isIndexedDBAvailable()) {
@@ -122,6 +125,7 @@ export async function _initializeAnalytics(
   // Detects if there are consent settings that need to be configured.
   if (defaultConsentSettingsForInit) {
     gtagCore(GtagCommand.CONSENT, 'default', defaultConsentSettingsForInit);
+    _setConsentDefaultForInit(undefined);
   }
 
   // This command initializes gtag.js and only needs to be called once for the entire web app,

packages/analytics/src/public-types.ts

@@ -289,13 +289,29 @@ export interface EventParams {
   [key: string]: unknown;
 }
 
-/** Maps the applicable end user consent state. */
+/**
+ * Consent status settings for each consent type.
+ * @public
+ */
 export interface ConsentSettings {
+  // Enables storage, such as cookies, related to advertising
   ad_storage?: ConsentStatusString;
+  // Enables storage, such as cookies, related to analytics (for example, visit duration)
   analytics_storage?: ConsentStatusString;
+  // Enables storage that supports the functionality of the website or app such as language settings
+  functionality_storage?: ConsentStatusString;
+  // Enables storage related to personalization such as video recommendations
+  personalization_storage?: ConsentStatusString;
+  // Enables storage related to security such as authentication functionality, fraud prevention,
+  // and other user protection
+  security_storage?: ConsentStatusString;
+  [key: string]: unknown;
 }
 
 /* eslint-enable camelcase */
 
-/** Whether a particular consent type has been granted or denied. */
+/**
+ * Whether a particular consent type has been granted or denied.
+ * @public
+ */
 export type ConsentStatusString = 'granted' | 'denied';