@walkeros/server-destination-datamanager 0.0.0-next-20251219153324

package/dist/examples/index.d.mts

@@ -0,0 +1,218 @@
+import { Mapping as Mapping$1, Destination as Destination$1 } from '@walkeros/core';
+import { DestinationServer } from '@walkeros/server-core';
+import { OAuth2Client } from 'google-auth-library';
+
+interface Settings {
+    /**
+     * Service account credentials (client_email + private_key)
+     * Recommended for serverless environments (AWS Lambda, Docker, etc.)
+     */
+    credentials?: {
+        client_email: string;
+        private_key: string;
+    };
+    /**
+     * Path to service account JSON file
+     * For local development or environments with filesystem access
+     */
+    keyFilename?: string;
+    /**
+     * OAuth scopes for Data Manager API
+     * @default ['https://www.googleapis.com/auth/datamanager']
+     */
+    scopes?: string[];
+    /** Array of destination accounts and conversion actions/user lists */
+    destinations: Destination[];
+    /** Event source for all events. Defaults to WEB if not specified */
+    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;
+    /** 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;
+    authClient?: OAuth2Client | null;
+}
+type InitSettings = Partial<Settings>;
+type Types = Destination$1.Types<Settings, Mapping, Env, InitSettings>;
+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 {
+    /** Reference identifier for this destination */
+    reference?: string;
+    /** Login account (account initiating the request) */
+    loginAccount?: ProductAccount;
+    /** Linked account (child account linked to login account) */
+    linkedAccount?: ProductAccount;
+    /** Operating account (account where data is sent) */
+    operatingAccount?: ProductAccount;
+    /** Product-specific destination ID (conversion action or user list) */
+    productDestinationId?: string;
+}
+/**
+ * Product account information
+ */
+interface ProductAccount {
+    /** Account ID (e.g., "123-456-7890" for Google Ads) */
+    accountId: string;
+    /** Type of account */
+    accountType: AccountType;
+}
+type AccountType = 'ACCOUNT_TYPE_UNSPECIFIED' | 'GOOGLE_ADS' | 'DISPLAY_VIDEO_ADVERTISER' | 'DISPLAY_VIDEO_PARTNER' | 'GOOGLE_ANALYTICS_PROPERTY' | 'DATA_PARTNER';
+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';
+
+/**
+ * AWS Lambda / Serverless Configuration
+ * Uses inline credentials from environment variables
+ * Best for: AWS Lambda, Docker, Kubernetes, any serverless environment
+ */
+declare const awsLambda: Config;
+/**
+ * GCP Cloud Functions / Cloud Run Configuration
+ * Uses Application Default Credentials (ADC) - no explicit auth config needed
+ * Best for: Google Cloud Functions, Cloud Run, GCE, GKE
+ */
+declare const gcpCloudFunctions: Config;
+/**
+ * Local Development Configuration
+ * Uses service account JSON file
+ * Best for: Local development, testing
+ */
+declare const localDevelopment: Config;
+/**
+ * Docker / Kubernetes Configuration
+ * Uses ADC via GOOGLE_APPLICATION_CREDENTIALS environment variable
+ * Best for: Docker containers, Kubernetes pods
+ *
+ * Setup:
+ * 1. Mount service account JSON as secret/configmap
+ * 2. Set GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json
+ * 3. ADC will automatically use it
+ */
+declare const dockerKubernetes: Config;
+/**
+ * Custom Scopes Configuration
+ * For specific use cases requiring different OAuth scopes
+ */
+declare const customScopes: Config;
+
+declare const auth_awsLambda: typeof awsLambda;
+declare const auth_customScopes: typeof customScopes;
+declare const auth_dockerKubernetes: typeof dockerKubernetes;
+declare const auth_gcpCloudFunctions: typeof gcpCloudFunctions;
+declare const auth_localDevelopment: typeof localDevelopment;
+declare namespace auth {
+  export { auth_awsLambda as awsLambda, auth_customScopes as customScopes, auth_dockerKubernetes as dockerKubernetes, auth_gcpCloudFunctions as gcpCloudFunctions, auth_localDevelopment as localDevelopment };
+}
+
+/**
+ * Minimal configuration for Google Data Manager with inline credentials
+ */
+declare const minimal: Config;
+/**
+ * Complete configuration with all options
+ */
+declare const complete: Config;
+/**
+ * GA4-specific configuration using Application Default Credentials
+ */
+declare const ga4: Config;
+/**
+ * Debug configuration with logging enabled using keyFilename
+ */
+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 };
+}
+
+/**
+ * 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 };
+}
+
+export { auth, basic, mapping$1 as mapping };

package/dist/examples/index.d.ts

@@ -0,0 +1,218 @@
+import { Mapping as Mapping$1, Destination as Destination$1 } from '@walkeros/core';
+import { DestinationServer } from '@walkeros/server-core';
+import { OAuth2Client } from 'google-auth-library';
+
+interface Settings {
+    /**
+     * Service account credentials (client_email + private_key)
+     * Recommended for serverless environments (AWS Lambda, Docker, etc.)
+     */
+    credentials?: {
+        client_email: string;
+        private_key: string;
+    };
+    /**
+     * Path to service account JSON file
+     * For local development or environments with filesystem access
+     */
+    keyFilename?: string;
+    /**
+     * OAuth scopes for Data Manager API
+     * @default ['https://www.googleapis.com/auth/datamanager']
+     */
+    scopes?: string[];
+    /** Array of destination accounts and conversion actions/user lists */
+    destinations: Destination[];
+    /** Event source for all events. Defaults to WEB if not specified */
+    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;
+    /** 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;
+    authClient?: OAuth2Client | null;
+}
+type InitSettings = Partial<Settings>;
+type Types = Destination$1.Types<Settings, Mapping, Env, InitSettings>;
+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 {
+    /** Reference identifier for this destination */
+    reference?: string;
+    /** Login account (account initiating the request) */
+    loginAccount?: ProductAccount;
+    /** Linked account (child account linked to login account) */
+    linkedAccount?: ProductAccount;
+    /** Operating account (account where data is sent) */
+    operatingAccount?: ProductAccount;
+    /** Product-specific destination ID (conversion action or user list) */
+    productDestinationId?: string;
+}
+/**
+ * Product account information
+ */
+interface ProductAccount {
+    /** Account ID (e.g., "123-456-7890" for Google Ads) */
+    accountId: string;
+    /** Type of account */
+    accountType: AccountType;
+}
+type AccountType = 'ACCOUNT_TYPE_UNSPECIFIED' | 'GOOGLE_ADS' | 'DISPLAY_VIDEO_ADVERTISER' | 'DISPLAY_VIDEO_PARTNER' | 'GOOGLE_ANALYTICS_PROPERTY' | 'DATA_PARTNER';
+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';
+
+/**
+ * AWS Lambda / Serverless Configuration
+ * Uses inline credentials from environment variables
+ * Best for: AWS Lambda, Docker, Kubernetes, any serverless environment
+ */
+declare const awsLambda: Config;
+/**
+ * GCP Cloud Functions / Cloud Run Configuration
+ * Uses Application Default Credentials (ADC) - no explicit auth config needed
+ * Best for: Google Cloud Functions, Cloud Run, GCE, GKE
+ */
+declare const gcpCloudFunctions: Config;
+/**
+ * Local Development Configuration
+ * Uses service account JSON file
+ * Best for: Local development, testing
+ */
+declare const localDevelopment: Config;
+/**
+ * Docker / Kubernetes Configuration
+ * Uses ADC via GOOGLE_APPLICATION_CREDENTIALS environment variable
+ * Best for: Docker containers, Kubernetes pods
+ *
+ * Setup:
+ * 1. Mount service account JSON as secret/configmap
+ * 2. Set GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json
+ * 3. ADC will automatically use it
+ */
+declare const dockerKubernetes: Config;
+/**
+ * Custom Scopes Configuration
+ * For specific use cases requiring different OAuth scopes
+ */
+declare const customScopes: Config;
+
+declare const auth_awsLambda: typeof awsLambda;
+declare const auth_customScopes: typeof customScopes;
+declare const auth_dockerKubernetes: typeof dockerKubernetes;
+declare const auth_gcpCloudFunctions: typeof gcpCloudFunctions;
+declare const auth_localDevelopment: typeof localDevelopment;
+declare namespace auth {
+  export { auth_awsLambda as awsLambda, auth_customScopes as customScopes, auth_dockerKubernetes as dockerKubernetes, auth_gcpCloudFunctions as gcpCloudFunctions, auth_localDevelopment as localDevelopment };
+}
+
+/**
+ * Minimal configuration for Google Data Manager with inline credentials
+ */
+declare const minimal: Config;
+/**
+ * Complete configuration with all options
+ */
+declare const complete: Config;
+/**
+ * GA4-specific configuration using Application Default Credentials
+ */
+declare const ga4: Config;
+/**
+ * Debug configuration with logging enabled using keyFilename
+ */
+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 };
+}
+
+/**
+ * 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 };
+}
+
+export { auth, basic, mapping$1 as mapping };