@walkeros/web-destination-gtag 0.1.2 → 0.2.1

package/README.md

@@ -28,10 +28,10 @@ npm install @walkeros/web-destination-gtag
 ## Usage
 
 ```typescript
-import { createCollector } from '@walkeros/collector';
+import { startFlow } from '@walkeros/collector';
 import { destinationGtag } from '@walkeros/web-destination-gtag';
 
-const { elb } = await createCollector();
+const { elb } = await startFlow();
 
 elb('walker destination', destinationGtag, {
   settings: {
@@ -66,6 +66,60 @@ For custom event mapping (`mapping.entity.action.settings`):
 | `ads` | `AdsMapping` | Google Ads specific event mapping configuration | No       | `{ label: 'conversion_label' }`    |
 | `gtm` | `GTMMapping` | GTM specific event mapping configuration        | No       | `{}`                               |
 
+## Consent Mode
+
+The gtag destination automatically handles Google Consent Mode v2 with a "deny
+by default" approach. Configure consent mode using the `como` setting:
+
+```typescript
+import { destinationGtag } from '@walkeros/web-destination-gtag';
+
+const destination = destinationGtag({
+  settings: {
+    como: true, // Enable with default mapping
+    ga4: { measurementId: 'G-XXXXXXXXXX' },
+  },
+});
+```
+
+### Configuration Options
+
+| Value    | Description          | Default Mapping                                                                                        |
+| -------- | -------------------- | ------------------------------------------------------------------------------------------------------ |
+| `false`  | Disable consent mode | -                                                                                                      |
+| `true`   | Use default mapping  | `marketing` → `ad_storage`, `ad_user_data`, `ad_personalization`<br>`functional` → `analytics_storage` |
+| `object` | Custom mapping       | `{ [walkerOSGroup]: gtagParameter \| gtagParameter[] }`                                                |
+
+### Custom Mapping
+
+```typescript
+const destination = destinationGtag({
+  settings: {
+    como: {
+      marketing: ['ad_storage', 'ad_personalization'],
+      analytics: 'analytics_storage',
+    },
+    ga4: { measurementId: 'G-XXXXXXXXXX' },
+  },
+});
+```
+
+### Usage
+
+Consent mode automatically activates when you send consent events through
+walkerOS:
+
+```typescript
+// Grant consent
+elb('walker consent', { marketing: true, functional: true });
+
+// Deny consent
+elb('walker consent', { marketing: false, functional: false });
+```
+
+The destination handles all gtag consent calls automatically, ensuring
+compliance with privacy regulations.
+
 ## Examples
 
 ### E-commerce Purchase

package/dist/examples/index.d.mts

@@ -1,14 +1,5 @@
 import { Mapping as Mapping$1 } from '@walkeros/core';
-
-declare function ga4Purchase$1(): unknown[];
-declare function ga4AddToCart$1(): unknown[];
-declare function adsConversion$1(): unknown[];
-declare function gtmEvent(): Record<string, unknown>;
-
-declare const events_gtmEvent: typeof gtmEvent;
-declare namespace events {
-  export { adsConversion$1 as adsConversion, ga4AddToCart$1 as ga4AddToCart, ga4Purchase$1 as ga4Purchase, events_gtmEvent as gtmEvent };
-}
+import { DestinationWeb } from '@walkeros/web-core';
 
 declare global {
     interface Window {
@@ -16,6 +7,23 @@ declare global {
         [key: string]: unknown;
     }
 }
+interface Env extends DestinationWeb.Env {
+    window: {
+        gtag: Gtag.Gtag;
+        dataLayer: unknown[];
+    };
+    document: {
+        createElement: (tagName: string) => {
+            src: string;
+            async?: boolean;
+            setAttribute: (name: string, value: string) => void;
+            removeAttribute: (name: string) => void;
+        };
+        head: {
+            appendChild: (node: unknown) => void;
+        };
+    };
+}
 interface AdsMapping {
     label?: string;
 }
@@ -32,6 +40,27 @@ interface GTMMapping {
 type Rule = Mapping$1.Rule<Mapping>;
 type Include = Array<'all' | 'context' | 'data' | 'event' | 'globals' | 'source' | 'user' | 'version'>;
 
+declare const init: Env | undefined;
+declare const push: Env;
+declare const simulation: string[];
+
+declare const env_init: typeof init;
+declare const env_push: typeof push;
+declare const env_simulation: typeof simulation;
+declare namespace env {
+  export { env_init as init, env_push as push, env_simulation as simulation };
+}
+
+declare function ga4Purchase$1(): unknown[];
+declare function ga4AddToCart$1(): unknown[];
+declare function adsConversion$1(): unknown[];
+declare function gtmEvent(): Record<string, unknown>;
+
+declare const events_gtmEvent: typeof gtmEvent;
+declare namespace events {
+  export { adsConversion$1 as adsConversion, ga4AddToCart$1 as ga4AddToCart, ga4Purchase$1 as ga4Purchase, events_gtmEvent as gtmEvent };
+}
+
 declare const ga4Purchase: Rule;
 declare const ga4AddToCart: Rule;
 declare const adsConversion: Rule;
@@ -57,4 +86,4 @@ declare namespace mapping {
   export { mapping_adsConversion as adsConversion, mapping_combinedPurchase as combinedPurchase, mapping_config as config, mapping_ga4AddToCart as ga4AddToCart, mapping_ga4Purchase as ga4Purchase, mapping_gtmProductView as gtmProductView };
 }
 
-export { events, mapping };
+export { env, events, mapping };

package/dist/examples/index.d.ts

@@ -1,14 +1,5 @@
 import { Mapping as Mapping$1 } from '@walkeros/core';
-
-declare function ga4Purchase$1(): unknown[];
-declare function ga4AddToCart$1(): unknown[];
-declare function adsConversion$1(): unknown[];
-declare function gtmEvent(): Record<string, unknown>;
-
-declare const events_gtmEvent: typeof gtmEvent;
-declare namespace events {
-  export { adsConversion$1 as adsConversion, ga4AddToCart$1 as ga4AddToCart, ga4Purchase$1 as ga4Purchase, events_gtmEvent as gtmEvent };
-}
+import { DestinationWeb } from '@walkeros/web-core';
 
 declare global {
     interface Window {
@@ -16,6 +7,23 @@ declare global {
         [key: string]: unknown;
     }
 }
+interface Env extends DestinationWeb.Env {
+    window: {
+        gtag: Gtag.Gtag;
+        dataLayer: unknown[];
+    };
+    document: {
+        createElement: (tagName: string) => {
+            src: string;
+            async?: boolean;
+            setAttribute: (name: string, value: string) => void;
+            removeAttribute: (name: string) => void;
+        };
+        head: {
+            appendChild: (node: unknown) => void;
+        };
+    };
+}
 interface AdsMapping {
     label?: string;
 }
@@ -32,6 +40,27 @@ interface GTMMapping {
 type Rule = Mapping$1.Rule<Mapping>;
 type Include = Array<'all' | 'context' | 'data' | 'event' | 'globals' | 'source' | 'user' | 'version'>;
 
+declare const init: Env | undefined;
+declare const push: Env;
+declare const simulation: string[];
+
+declare const env_init: typeof init;
+declare const env_push: typeof push;
+declare const env_simulation: typeof simulation;
+declare namespace env {
+  export { env_init as init, env_push as push, env_simulation as simulation };
+}
+
+declare function ga4Purchase$1(): unknown[];
+declare function ga4AddToCart$1(): unknown[];
+declare function adsConversion$1(): unknown[];
+declare function gtmEvent(): Record<string, unknown>;
+
+declare const events_gtmEvent: typeof gtmEvent;
+declare namespace events {
+  export { adsConversion$1 as adsConversion, ga4AddToCart$1 as ga4AddToCart, ga4Purchase$1 as ga4Purchase, events_gtmEvent as gtmEvent };
+}
+
 declare const ga4Purchase: Rule;
 declare const ga4AddToCart: Rule;
 declare const adsConversion: Rule;
@@ -57,4 +86,4 @@ declare namespace mapping {
   export { mapping_adsConversion as adsConversion, mapping_combinedPurchase as combinedPurchase, mapping_config as config, mapping_ga4AddToCart as ga4AddToCart, mapping_ga4Purchase as ga4Purchase, mapping_gtmProductView as gtmProductView };
 }
 
-export { events, mapping };
+export { env, events, mapping };