@firebase/analytics 0.7.11-canary.69e2ee064 → 0.7.11-canary.ad773fa45

package/dist/src/api.d.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 import { FirebaseApp } from '@firebase/app';
-import { Analytics, AnalyticsCallOptions, AnalyticsSettings, CustomParams, EventNameString, EventParams } from './public-types';
+import { Analytics, AnalyticsCallOptions, AnalyticsSettings, ConsentSettings, CustomParams, EventNameString, EventParams } from './public-types';
 import { ANALYTICS_TYPE } from './constants';
 import { AnalyticsService } from './factory';
 export { settings } from './factory';
@@ -94,7 +94,7 @@ export declare function setAnalyticsCollectionEnabled(analyticsInstance: Analyti
  * With gtag's "set" command, the values passed persist on the current page and are passed with
  * all subsequent events.
  * @public
- * @param customParams Any custom params the user may pass to gtag.js.
+ * @param customParams - Any custom params the user may pass to gtag.js.
  */
 export declare function setDefaultEventParameters(customParams: CustomParams): void;
 /**
@@ -432,3 +432,13 @@ export declare function logEvent<T extends string>(analyticsInstance: Analytics,
  * @public
  */
 export declare type CustomEventName<T> = T extends EventNameString ? never : T;
+/**
+ * Sets the applicable end user consent state for this web app across all gtag references once
+ * Firebase Analytics is initialized.
+ *
+ * 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 declare function setConsent(consentSettings: ConsentSettings): void;

package/dist/src/constants.d.ts

@@ -26,5 +26,6 @@ export declare const GTAG_URL = "https://www.googletagmanager.com/gtag/js";
 export declare const enum GtagCommand {
     EVENT = "event",
     SET = "set",
-    CONFIG = "config"
+    CONFIG = "config",
+    CONSENT = "consent"
 }

package/dist/src/functions.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { AnalyticsCallOptions, CustomParams, EventParams } from './public-types';
+import { AnalyticsCallOptions, CustomParams, EventParams, ConsentSettings } from './public-types';
 import { Gtag } from './types';
 /**
  * Event parameters to set on 'gtag' during initialization.
@@ -58,6 +58,17 @@ export declare function setUserProperties(gtagFunction: Gtag, initializationProm
  * @param enabled If true, collection is enabled for this ID.
  */
 export declare function setAnalyticsCollectionEnabled(initializationPromise: Promise<string>, enabled: boolean): Promise<void>;
+/**
+ * Consent parameters to default to during 'gtag' initialization.
+ */
+export declare let defaultConsentSettingsForInit: ConsentSettings | undefined;
+/**
+ * Sets the variable {@link defaultConsentSettingsForInit} for use in the initialization of
+ * analytics.
+ *
+ * @param consentSettings Maps the applicable end user consent state for gtag.js.
+ */
+export declare function _setConsentDefaultForInit(consentSettings?: ConsentSettings): void;
 /**
  * Sets the variable `defaultEventParametersForInit` for use in the initialization of
  * analytics.

package/dist/src/public-types.d.ts

@@ -246,3 +246,33 @@ export interface EventParams {
     page_path?: string;
     [key: string]: unknown;
 }
+/**
+ * Consent status settings for each consent type.
+ * For more information, see
+ * {@link https://developers.google.com/tag-platform/tag-manager/templates/consent-apis
+ * | the GA4 reference documentation for consent state and consent types}.
+ * @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;
+}
+/**
+ * Whether a particular consent type has been granted or denied.
+ * @public
+ */
+export declare type ConsentStatusString = 'granted' | 'denied';

package/dist/src/types.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { ControlParams, EventParams, CustomParams } from './public-types';
+import { ControlParams, EventParams, CustomParams, ConsentSettings } from './public-types';
 /**
  * Encapsulates metadata concerning throttled fetch requests.
  */
@@ -48,5 +48,6 @@ export interface Gtag {
     (command: 'config', targetId: string, config?: ControlParams | EventParams | CustomParams): void;
     (command: 'set', config: CustomParams): void;
     (command: 'event', eventName: string, eventParams?: ControlParams | EventParams | CustomParams): void;
+    (command: 'consent', subCommand: 'default' | 'update', consentSettings: ConsentSettings): void;
 }
 export declare type DataLayer = IArguments[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/analytics",
-  "version": "0.7.11-canary.69e2ee064",
+  "version": "0.7.11-canary.ad773fa45",
   "description": "A analytics package for new firebase packages",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "main": "dist/index.cjs.js",
@@ -37,18 +37,18 @@
     "typings:public": "node ../../scripts/build/use_typings.js ./dist/analytics-public.d.ts"
   },
   "peerDependencies": {
-    "@firebase/app": "0.7.27-canary.69e2ee064"
+    "@firebase/app": "0.7.27-canary.ad773fa45"
   },
   "dependencies": {
-    "@firebase/installations": "0.5.11-canary.69e2ee064",
-    "@firebase/logger": "0.3.3-canary.69e2ee064",
-    "@firebase/util": "1.6.2-canary.69e2ee064",
-    "@firebase/component": "0.5.16-canary.69e2ee064",
+    "@firebase/installations": "0.5.11-canary.ad773fa45",
+    "@firebase/logger": "0.3.3-canary.ad773fa45",
+    "@firebase/util": "1.6.2-canary.ad773fa45",
+    "@firebase/component": "0.5.16-canary.ad773fa45",
     "tslib": "^2.1.0"
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@firebase/app": "0.7.27-canary.69e2ee064",
+    "@firebase/app": "0.7.27-canary.ad773fa45",
     "rollup": "2.72.1",
     "@rollup/plugin-commonjs": "21.1.0",
     "@rollup/plugin-json": "4.1.0",