@walkeros/server-destination-datamanager 0.3.1

package/dist/examples/index.d.mts

@@ -0,0 +1,153 @@
+import { Mapping as Mapping$1, Destination as Destination$1 } from '@walkeros/core';
+import { DestinationServer } from '@walkeros/server-core';
+
+type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'none';
+
+interface Settings {
+    /** OAuth 2.0 access token with datamanager scope */
+    accessToken: string;
+    /** Array of destination accounts and conversion actions/user lists */
+    destinations: Destination[];
+    /** Default event source if not specified per event */
+    eventSource?: EventSource;
+    /** Maximum number of events to batch before sending (max 2000) */
+    batchSize?: number;
+    /** Time in milliseconds to wait before auto-flushing batch */
+    batchInterval?: number;
+    /** If true, validate request without ingestion (testing mode) */
+    validateOnly?: boolean;
+    /** Override API endpoint (for testing) */
+    url?: string;
+    /** Request-level consent for all events */
+    consent?: Consent;
+    /** Test event code for debugging (optional) */
+    testEventCode?: string;
+    /** Log level for debugging (optional) */
+    logLevel?: LogLevel;
+    /** Guided helpers: User data mapping (applies to all events) */
+    userData?: Mapping$1.Map;
+    /** Guided helper: First-party user ID */
+    userId?: Mapping$1.Value;
+    /** Guided helper: GA4 client ID */
+    clientId?: Mapping$1.Value;
+    /** Guided helper: Privacy-safe attribution (Google's sessionAttributes) */
+    sessionAttributes?: Mapping$1.Value;
+    /** Consent mapping: Map consent field to adUserData (string = field name, boolean = static value) */
+    consentAdUserData?: string | boolean;
+    /** Consent mapping: Map consent field to adPersonalization (string = field name, boolean = static value) */
+    consentAdPersonalization?: string | boolean;
+}
+interface Mapping {
+    gclid?: Mapping$1.Value;
+    gbraid?: Mapping$1.Value;
+    wbraid?: Mapping$1.Value;
+    sessionAttributes?: Mapping$1.Value;
+}
+interface Env extends DestinationServer.Env {
+    fetch?: typeof fetch;
+}
+type Types = Destination$1.Types<Settings, Mapping, Env>;
+type Config = {
+    settings: Settings;
+} & DestinationServer.Config<Types>;
+type Rule = Mapping$1.Rule<Mapping>;
+/**
+ * Destination account and product identifier
+ * https://developers.google.com/data-manager/api/reference/rest/v1/Destination
+ */
+interface Destination {
+    /** Operating account details */
+    operatingAccount: OperatingAccount;
+    /** Product-specific destination ID (conversion action or user list) */
+    productDestinationId: string;
+}
+/**
+ * Operating account information
+ */
+interface OperatingAccount {
+    /** Account ID (e.g., "123-456-7890" for Google Ads) */
+    accountId: string;
+    /** Type of account */
+    accountType: AccountType;
+}
+type AccountType = 'GOOGLE_ADS' | 'DISPLAY_VIDEO_ADVERTISER' | 'DISPLAY_VIDEO_PARTNER' | 'GOOGLE_ANALYTICS_PROPERTY';
+type EventSource = 'WEB' | 'APP' | 'IN_STORE' | 'PHONE' | 'OTHER';
+/**
+ * Consent for Digital Markets Act (DMA) compliance
+ * https://developers.google.com/data-manager/api/devguides/concepts/dma
+ */
+interface Consent {
+    /** Consent for data collection and use */
+    adUserData?: ConsentStatus;
+    /** Consent for ad personalization */
+    adPersonalization?: ConsentStatus;
+}
+type ConsentStatus = 'CONSENT_GRANTED' | 'CONSENT_DENIED';
+
+/**
+ * Purchase event mapping for Google Ads conversion
+ */
+declare const Purchase: Rule;
+/**
+ * Lead event mapping
+ */
+declare const Lead: Rule;
+/**
+ * Page view mapping for GA4
+ */
+declare const PageView: Rule;
+/**
+ * Complete mapping configuration
+ */
+declare const mapping: {
+    order: {
+        complete: Rule;
+    };
+    lead: {
+        submit: Rule;
+    };
+    page: {
+        view: Rule;
+    };
+};
+/**
+ * User data mapping configuration
+ * Maps walkerOS user properties to Data Manager user identifiers
+ */
+declare const userDataMapping: Config;
+
+declare const mapping$1_Lead: typeof Lead;
+declare const mapping$1_PageView: typeof PageView;
+declare const mapping$1_Purchase: typeof Purchase;
+declare const mapping$1_mapping: typeof mapping;
+declare const mapping$1_userDataMapping: typeof userDataMapping;
+declare namespace mapping$1 {
+  export { mapping$1_Lead as Lead, mapping$1_PageView as PageView, mapping$1_Purchase as Purchase, mapping$1_mapping as mapping, mapping$1_userDataMapping as userDataMapping };
+}
+
+/**
+ * Minimal configuration for Google Data Manager
+ */
+declare const minimal: Config;
+/**
+ * Complete configuration with all options
+ */
+declare const complete: Config;
+/**
+ * GA4-specific configuration
+ */
+declare const ga4: Config;
+/**
+ * Debug configuration with logging enabled
+ */
+declare const debug: Config;
+
+declare const basic_complete: typeof complete;
+declare const basic_debug: typeof debug;
+declare const basic_ga4: typeof ga4;
+declare const basic_minimal: typeof minimal;
+declare namespace basic {
+  export { basic_complete as complete, basic_debug as debug, basic_ga4 as ga4, basic_minimal as minimal };
+}
+
+export { basic, mapping$1 as mapping };

package/dist/examples/index.d.ts

@@ -0,0 +1,153 @@
+import { Mapping as Mapping$1, Destination as Destination$1 } from '@walkeros/core';
+import { DestinationServer } from '@walkeros/server-core';
+
+type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'none';
+
+interface Settings {
+    /** OAuth 2.0 access token with datamanager scope */
+    accessToken: string;
+    /** Array of destination accounts and conversion actions/user lists */
+    destinations: Destination[];
+    /** Default event source if not specified per event */
+    eventSource?: EventSource;
+    /** Maximum number of events to batch before sending (max 2000) */
+    batchSize?: number;
+    /** Time in milliseconds to wait before auto-flushing batch */
+    batchInterval?: number;
+    /** If true, validate request without ingestion (testing mode) */
+    validateOnly?: boolean;
+    /** Override API endpoint (for testing) */
+    url?: string;
+    /** Request-level consent for all events */
+    consent?: Consent;
+    /** Test event code for debugging (optional) */
+    testEventCode?: string;
+    /** Log level for debugging (optional) */
+    logLevel?: LogLevel;
+    /** Guided helpers: User data mapping (applies to all events) */
+    userData?: Mapping$1.Map;
+    /** Guided helper: First-party user ID */
+    userId?: Mapping$1.Value;
+    /** Guided helper: GA4 client ID */
+    clientId?: Mapping$1.Value;
+    /** Guided helper: Privacy-safe attribution (Google's sessionAttributes) */
+    sessionAttributes?: Mapping$1.Value;
+    /** Consent mapping: Map consent field to adUserData (string = field name, boolean = static value) */
+    consentAdUserData?: string | boolean;
+    /** Consent mapping: Map consent field to adPersonalization (string = field name, boolean = static value) */
+    consentAdPersonalization?: string | boolean;
+}
+interface Mapping {
+    gclid?: Mapping$1.Value;
+    gbraid?: Mapping$1.Value;
+    wbraid?: Mapping$1.Value;
+    sessionAttributes?: Mapping$1.Value;
+}
+interface Env extends DestinationServer.Env {
+    fetch?: typeof fetch;
+}
+type Types = Destination$1.Types<Settings, Mapping, Env>;
+type Config = {
+    settings: Settings;
+} & DestinationServer.Config<Types>;
+type Rule = Mapping$1.Rule<Mapping>;
+/**
+ * Destination account and product identifier
+ * https://developers.google.com/data-manager/api/reference/rest/v1/Destination
+ */
+interface Destination {
+    /** Operating account details */
+    operatingAccount: OperatingAccount;
+    /** Product-specific destination ID (conversion action or user list) */
+    productDestinationId: string;
+}
+/**
+ * Operating account information
+ */
+interface OperatingAccount {
+    /** Account ID (e.g., "123-456-7890" for Google Ads) */
+    accountId: string;
+    /** Type of account */
+    accountType: AccountType;
+}
+type AccountType = 'GOOGLE_ADS' | 'DISPLAY_VIDEO_ADVERTISER' | 'DISPLAY_VIDEO_PARTNER' | 'GOOGLE_ANALYTICS_PROPERTY';
+type EventSource = 'WEB' | 'APP' | 'IN_STORE' | 'PHONE' | 'OTHER';
+/**
+ * Consent for Digital Markets Act (DMA) compliance
+ * https://developers.google.com/data-manager/api/devguides/concepts/dma
+ */
+interface Consent {
+    /** Consent for data collection and use */
+    adUserData?: ConsentStatus;
+    /** Consent for ad personalization */
+    adPersonalization?: ConsentStatus;
+}
+type ConsentStatus = 'CONSENT_GRANTED' | 'CONSENT_DENIED';
+
+/**
+ * Purchase event mapping for Google Ads conversion
+ */
+declare const Purchase: Rule;
+/**
+ * Lead event mapping
+ */
+declare const Lead: Rule;
+/**
+ * Page view mapping for GA4
+ */
+declare const PageView: Rule;
+/**
+ * Complete mapping configuration
+ */
+declare const mapping: {
+    order: {
+        complete: Rule;
+    };
+    lead: {
+        submit: Rule;
+    };
+    page: {
+        view: Rule;
+    };
+};
+/**
+ * User data mapping configuration
+ * Maps walkerOS user properties to Data Manager user identifiers
+ */
+declare const userDataMapping: Config;
+
+declare const mapping$1_Lead: typeof Lead;
+declare const mapping$1_PageView: typeof PageView;
+declare const mapping$1_Purchase: typeof Purchase;
+declare const mapping$1_mapping: typeof mapping;
+declare const mapping$1_userDataMapping: typeof userDataMapping;
+declare namespace mapping$1 {
+  export { mapping$1_Lead as Lead, mapping$1_PageView as PageView, mapping$1_Purchase as Purchase, mapping$1_mapping as mapping, mapping$1_userDataMapping as userDataMapping };
+}
+
+/**
+ * Minimal configuration for Google Data Manager
+ */
+declare const minimal: Config;
+/**
+ * Complete configuration with all options
+ */
+declare const complete: Config;
+/**
+ * GA4-specific configuration
+ */
+declare const ga4: Config;
+/**
+ * Debug configuration with logging enabled
+ */
+declare const debug: Config;
+
+declare const basic_complete: typeof complete;
+declare const basic_debug: typeof debug;
+declare const basic_ga4: typeof ga4;
+declare const basic_minimal: typeof minimal;
+declare namespace basic {
+  export { basic_complete as complete, basic_debug as debug, basic_ga4 as ga4, basic_minimal as minimal };
+}
+
+export { basic, mapping$1 as mapping };

package/dist/examples/index.js

@@ -0,0 +1,235 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/examples/index.ts
+var examples_exports = {};
+__export(examples_exports, {
+  basic: () => basic_exports,
+  mapping: () => mapping_exports
+});
+module.exports = __toCommonJS(examples_exports);
+
+// src/examples/mapping.ts
+var mapping_exports = {};
+__export(mapping_exports, {
+  Lead: () => Lead,
+  PageView: () => PageView,
+  Purchase: () => Purchase,
+  mapping: () => mapping,
+  userDataMapping: () => userDataMapping
+});
+var import_core = require("@walkeros/core");
+var Purchase = {
+  name: "purchase",
+  data: {
+    map: {
+      // Required fields
+      transactionId: "data.id",
+      conversionValue: "data.total",
+      currency: { key: "data.currency", value: "USD" },
+      eventName: { value: "purchase" },
+      // User identification
+      userId: "user.id",
+      email: "user.id",
+      // Will be hashed automatically
+      // Attribution identifiers (captured by browser source from URL)
+      gclid: "context.gclid",
+      // Google Click ID
+      gbraid: "context.gbraid",
+      // iOS attribution
+      wbraid: "context.wbraid",
+      // Web-to-app
+      // Shopping cart data
+      cartData: {
+        map: {
+          items: {
+            loop: [
+              "nested",
+              {
+                condition: (entity) => (0, import_core.isObject)(entity) && entity.entity === "product",
+                map: {
+                  merchantProductId: "data.id",
+                  price: "data.price",
+                  quantity: { key: "data.quantity", value: 1 }
+                }
+              }
+            ]
+          }
+        }
+      }
+    }
+  }
+};
+var Lead = {
+  name: "generate_lead",
+  data: {
+    map: {
+      eventName: { value: "generate_lead" },
+      conversionValue: { value: 10 },
+      currency: { value: "USD" }
+    }
+  }
+};
+var PageView = {
+  name: "page_view",
+  data: {
+    map: {
+      eventName: { value: "page_view" }
+    }
+  }
+};
+var mapping = {
+  order: {
+    complete: Purchase
+  },
+  lead: {
+    submit: Lead
+  },
+  page: {
+    view: PageView
+  }
+};
+var userDataMapping = {
+  settings: {
+    accessToken: "ya29.c.xxx",
+    destinations: [
+      {
+        operatingAccount: {
+          accountId: "123-456-7890",
+          accountType: "GOOGLE_ADS"
+        },
+        productDestinationId: "AW-CONVERSION-123"
+      }
+    ]
+  },
+  data: {
+    map: {
+      email: "user.id",
+      phone: "data.phone",
+      firstName: "data.firstName",
+      lastName: "data.lastName",
+      regionCode: "data.country",
+      postalCode: "data.zip"
+    }
+  },
+  mapping
+};
+
+// src/examples/basic.ts
+var basic_exports = {};
+__export(basic_exports, {
+  complete: () => complete,
+  debug: () => debug,
+  ga4: () => ga4,
+  minimal: () => minimal
+});
+var minimal = {
+  settings: {
+    accessToken: "ya29.c.xxx",
+    destinations: [
+      {
+        operatingAccount: {
+          accountId: "123-456-7890",
+          accountType: "GOOGLE_ADS"
+        },
+        productDestinationId: "AW-CONVERSION-123"
+      }
+    ]
+  }
+};
+var complete = {
+  settings: {
+    accessToken: "ya29.c.xxx",
+    destinations: [
+      {
+        operatingAccount: {
+          accountId: "123-456-7890",
+          accountType: "GOOGLE_ADS"
+        },
+        productDestinationId: "AW-CONVERSION-123"
+      },
+      {
+        operatingAccount: {
+          accountId: "987654321",
+          accountType: "GOOGLE_ANALYTICS_PROPERTY"
+        },
+        productDestinationId: "G-XXXXXXXXXX"
+      }
+    ],
+    eventSource: "WEB",
+    batchSize: 100,
+    batchInterval: 5e3,
+    validateOnly: false,
+    consent: {
+      adUserData: "CONSENT_GRANTED",
+      adPersonalization: "CONSENT_GRANTED"
+    },
+    // Guided helpers (apply to all events)
+    userData: {
+      email: "user.id",
+      phone: "data.phone",
+      firstName: "data.firstName",
+      lastName: "data.lastName"
+    },
+    userId: "user.id",
+    clientId: "user.device",
+    sessionAttributes: "context.sessionAttributes"
+  },
+  data: {
+    map: {
+      eventSource: { value: "WEB" }
+    }
+  }
+};
+var ga4 = {
+  settings: {
+    accessToken: "ya29.c.xxx",
+    destinations: [
+      {
+        operatingAccount: {
+          accountId: "123456789",
+          accountType: "GOOGLE_ANALYTICS_PROPERTY"
+        },
+        productDestinationId: "G-XXXXXXXXXX"
+      }
+    ],
+    eventSource: "WEB"
+  }
+};
+var debug = {
+  settings: {
+    accessToken: "ya29.c.xxx",
+    destinations: [
+      {
+        operatingAccount: {
+          accountId: "123-456-7890",
+          accountType: "GOOGLE_ADS"
+        },
+        productDestinationId: "AW-CONVERSION-123"
+      }
+    ],
+    logLevel: "debug"
+    // Shows all API calls and responses
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  basic,
+  mapping
+});