Remove regulation-specific privacy fields from public API (#3236)

* Remove regulation-specific privacy fields from public API documentation

Removed ccpaEnforced and gdprEnforced from public API types in favor of
generalized privacy fields (analyticsAllowed, marketingAllowed, saleOfDataAllowed).

The regulation-specific fields are now internal-only types, still computed
and sent to analytics backend for compatibility.

Addresses caution-tape-bot feedback from Shopify/shopify-dev#63408

* Fix test to use internal type with privacy fields

Author: juanpprieto

.changeset/remove-regulation-specific-fields.md

@@ -0,0 +1,6 @@
+---
+'@shopify/hydrogen-react': patch
+'@shopify/hydrogen': patch
+---
+
+Remove regulation-specific privacy fields from public API documentation. The generalized privacy fields (analyticsAllowed, marketingAllowed, saleOfDataAllowed) remain available.

packages/hydrogen-react/docs/generated/generated_docs_data.json

@@ -13,6 +13,7 @@ import type {
   ShopifyAnalyticsPayload,
   ShopifyMonorailPayload,
   ShopifyPageViewPayload,
+  ShopifyPageViewPayloadWithPrivacyFields,
 } from './analytics-types.js';
 import {version} from '../package.json';
 
@@ -64,7 +65,7 @@ describe(`analytics schema - custom storefront customer tracking`, () => {
     });
 
     it(`base payload with non-default values using hydrogenSubchannelId`, () => {
-      const pageViewPayload: ShopifyPageViewPayload = {
+      const pageViewPayload: ShopifyPageViewPayloadWithPrivacyFields = {
         ...BASE_PAYLOAD,
         shopId: 'gid://shopify/Shop/2',
         hasUserConsent: false,

packages/hydrogen-react/src/analytics-schema-custom-storefront-customer-tracking.test.ts

@@ -1,7 +1,10 @@
 import {
   ShopifyAnalyticsPayload,
+  ShopifyAnalyticsPayloadWithPrivacyFields,
   ShopifyPageViewPayload,
+  ShopifyPageViewPayloadWithPrivacyFields,
   ShopifyAddToCartPayload,
+  ShopifyAddToCartPayloadWithPrivacyFields,
   ShopifyMonorailPayload,
   ShopifyAnalyticsProduct,
   ShopifyMonorailEvent,
@@ -19,7 +22,7 @@ const PRODUCT_ADDED_TO_CART_EVENT_NAME = 'product_added_to_cart';
 const SEARCH_SUBMITTED_EVENT_NAME = 'search_submitted';
 
 function prepareAdditionalPayload(
-  payload: ShopifyPageViewPayload,
+  payload: ShopifyPageViewPayload | ShopifyPageViewPayloadWithPrivacyFields,
 ): Pick<ShopifyMonorailPayload, 'canonical_url' | 'customer_id'> {
   return {
     canonical_url: payload.canonicalUrl || payload.url,
@@ -30,7 +33,7 @@ function prepareAdditionalPayload(
 // Send the page view event to the Monorail server.
 // It also sends additional page view events based on the page type.
 export function pageView(
-  payload: ShopifyPageViewPayload,
+  payload: ShopifyPageViewPayload | ShopifyPageViewPayloadWithPrivacyFields,
 ): ShopifyMonorailEvent[] {
   const pageViewPayload = payload;
   const additionalPayload = prepareAdditionalPayload(pageViewPayload);
@@ -196,7 +199,7 @@ export function searchView(
 }
 
 export function addToCart(
-  payload: ShopifyAddToCartPayload,
+  payload: ShopifyAddToCartPayload | ShopifyAddToCartPayloadWithPrivacyFields,
 ): ShopifyMonorailEvent[] {
   const addToCartPayload = payload;
   const cartToken = parseGid(addToCartPayload.cartId);
@@ -221,8 +224,11 @@ export function addToCart(
 }
 
 function formatPayload(
-  payload: ShopifyAnalyticsPayload,
+  payload: ShopifyAnalyticsPayload | ShopifyAnalyticsPayloadWithPrivacyFields,
 ): ShopifyMonorailPayload {
+  const payloadWithPrivacy =
+    payload as ShopifyAnalyticsPayloadWithPrivacyFields;
+
   return {
     source: payload.shopifySalesChannel || ShopifySalesChannel.headless,
     asset_version_id: payload.assetVersionId || version,
@@ -244,9 +250,9 @@ function formatPayload(
     shop_id: parseInt(parseGid(payload.shopId).id),
     currency: payload.currency,
 
-    ccpa_enforced: payload.ccpaEnforced || false,
-    gdpr_enforced: payload.gdprEnforced || false,
-    gdpr_enforced_as_string: payload.gdprEnforced ? 'true' : 'false',
+    ccpa_enforced: payloadWithPrivacy.ccpaEnforced || false,
+    gdpr_enforced: payloadWithPrivacy.gdprEnforced || false,
+    gdpr_enforced_as_string: payloadWithPrivacy.gdprEnforced ? 'true' : 'false',
     analytics_allowed: payload.analyticsAllowed || false,
     marketing_allowed: payload.marketingAllowed || false,
     sale_of_data_allowed: payload.saleOfDataAllowed || false,

packages/hydrogen-react/src/analytics-schema-custom-storefront-customer-tracking.ts

@@ -117,10 +117,6 @@ type ShopifyAnalyticsBase = {
   totalValue?: number;
   /** Product list. */
   products?: ShopifyAnalyticsProduct[];
-  /** Result of `!customerPrivacyApi.saleOfDataAllowed()` */
-  ccpaEnforced?: boolean;
-  /** Result of `!(customerPrivacyApi.marketingAllowed() && customerPrivacy.analyticsProcessingAllowed())`*/
-  gdprEnforced?: boolean;
   /** Result of `customerPrivacyApi.analyticsProcessingAllowed()` */
   analyticsAllowed?: boolean;
   /** Result of `customerPrivacyApi.marketingAllowed()` */
@@ -129,6 +125,16 @@ type ShopifyAnalyticsBase = {
   saleOfDataAllowed?: boolean;
 };
 
+/**
+ * @internal
+ * Internal type that includes computed regulation-specific fields.
+ * These fields are computed by Hydrogen and sent to analytics backend.
+ */
+type ShopifyAnalyticsBaseWithPrivacyFields = ShopifyAnalyticsBase & {
+  ccpaEnforced?: boolean;
+  gdprEnforced?: boolean;
+};
+
 export type ShopifySalesChannels = keyof typeof ShopifySalesChannel;
 export type AnalyticsEventNames = keyof typeof AnalyticsEventName;
 
@@ -149,6 +155,17 @@ export interface ShopifyPageViewPayload
   searchString?: string;
 }
 
+/**
+ * @internal
+ * Internal payload type with privacy fields for analytics backend.
+ */
+export type ShopifyPageViewPayloadWithPrivacyFields = Omit<
+  ShopifyPageViewPayload,
+  keyof ShopifyAnalyticsBase
+> &
+  ShopifyAnalyticsBaseWithPrivacyFields &
+  ClientBrowserParameters;
+
 export type ShopifyPageView = {
   /** Use `AnalyticsEventName.PAGE_VIEW` constant. */
   eventName: string;
@@ -162,6 +179,17 @@ export interface ShopifyAddToCartPayload
   cartId: string;
 }
 
+/**
+ * @internal
+ * Internal payload type with privacy fields for analytics backend.
+ */
+export type ShopifyAddToCartPayloadWithPrivacyFields = Omit<
+  ShopifyAddToCartPayload,
+  keyof ShopifyAnalyticsBase
+> &
+  ShopifyAnalyticsBaseWithPrivacyFields &
+  ClientBrowserParameters;
+
 export type ShopifyAddToCart = {
   /** Use `AnalyticsEventName.ADD_TO_CART` constant. */
   eventName: string;
@@ -184,6 +212,15 @@ export type ShopifyMonorailEvent = {
 export type ShopifyAnalyticsPayload =
   | ShopifyPageViewPayload
   | ShopifyAddToCartPayload;
+
+/**
+ * @internal
+ * Internal analytics payload type with privacy fields for analytics backend.
+ */
+export type ShopifyAnalyticsPayloadWithPrivacyFields =
+  | ShopifyPageViewPayloadWithPrivacyFields
+  | ShopifyAddToCartPayloadWithPrivacyFields;
+
 export type ShopifyAnalytics = ShopifyPageView | ShopifyAddToCart;
 
 export type ShopifyCookies = {