@adtrackify/at-tracking-event-types 4.30.1 → 4.32.0

package/dist/cjs/types/api/destinations/destinations.d.ts

@@ -1,69 +1,69 @@
-import { TRACKING_EVENT_NAME } from '../../event/base/event-name-enum.js';
-import { EmqHealthStatus } from '../emq/emq-health.js';
-import { DESTINATION, DESTINATION_TYPE, EVENT_TRIGGER_CONDITION } from './destination-enums.js';
-import type { DestinationHealthStatus } from '../health/health-status.js';
-import type { ForwardingHealthStatus } from '../health/forwarding-health.js';
-import type { DestinationEventConfig } from './custom-event-mapping.js';
-export interface Destination {
-    id: string;
-    accountId: string;
-    pixelId: string;
-    destination: DESTINATION;
-    destinationType?: DESTINATION_TYPE;
-    displayName?: string;
-    enabled: boolean;
-    configuration?: UserDestinationConfiguration;
-    createdAt: string;
-    updatedAt: string;
-    orderConfig?: DestinationOrderConfig;
-    healthStatus?: DestinationHealthStatus;
-    emqHealthStatus?: EmqHealthStatus;
-    forwardingHealthStatus?: ForwardingHealthStatus;
-}
-export interface DestinationOrderConfig {
-    blockedSources?: string[];
-    blockedTags?: string[];
-}
-export interface UserDestinationConfiguration {
-    [key: string]: any;
-    eventBlacklist?: string[];
-    events?: EventConfiguration[];
-    trigger?: DestinationTriggerConfiguration;
-    forwarding?: ForwardingConfiguration;
-    eventConfig?: DestinationEventConfig;
-}
-export interface DestinationTriggerConfiguration {
-    shopify?: ShopifyTriggerConfiguration;
-    exludeDomains?: string[];
-    excludePages?: string[];
-    domains?: string[];
-    pages?: string[];
-    events?: EventTriggerConfiguration[];
-}
-export interface ShopifyTriggerConfiguration {
-    enabled: boolean;
-    collections?: string[];
-    tags?: string[];
-}
-export interface EventTriggerConfiguration {
-    name: TRACKING_EVENT_NAME;
-    count: number;
-    condition: EVENT_TRIGGER_CONDITION;
-}
-export interface EventConfiguration {
-    sourceEventName: string;
-    exclude?: boolean;
-    sample: EventSampleConfiguration;
-    transformations?: EventTransformation[];
-}
-export interface EventTransformation {
-    transformationEventName: string;
-    enabled: boolean;
-}
-export interface EventSampleConfiguration {
-    enabled: boolean;
-    rate: number;
-}
-export interface ForwardingConfiguration {
-    productIdFormat?: string;
-}
+import { TRACKING_EVENT_NAME } from '../../event/base/event-name-enum.js';
+import { EmqHealthStatus } from '../emq/emq-health.js';
+import { DESTINATION, DESTINATION_TYPE, EVENT_TRIGGER_CONDITION } from './destination-enums.js';
+import type { DestinationHealthStatus } from '../health/health-status.js';
+import type { ForwardingHealthStatus } from '../health/forwarding-health.js';
+import type { DestinationEventConfig } from './custom-event-mapping.js';
+export interface Destination {
+    id: string;
+    accountId: string;
+    pixelId: string;
+    destination: DESTINATION;
+    destinationType?: DESTINATION_TYPE;
+    displayName?: string;
+    enabled: boolean;
+    configuration?: UserDestinationConfiguration;
+    createdAt: string;
+    updatedAt: string;
+    orderConfig?: DestinationOrderConfig;
+    healthStatus?: DestinationHealthStatus;
+    emqHealthStatus?: EmqHealthStatus;
+    forwardingHealthStatus?: ForwardingHealthStatus;
+}
+export interface DestinationOrderConfig {
+    blockedSources?: string[];
+    blockedTags?: string[];
+}
+export interface UserDestinationConfiguration {
+    [key: string]: any;
+    eventBlacklist?: string[];
+    events?: EventConfiguration[];
+    trigger?: DestinationTriggerConfiguration;
+    forwarding?: ForwardingConfiguration;
+    eventConfig?: DestinationEventConfig;
+}
+export interface DestinationTriggerConfiguration {
+    shopify?: ShopifyTriggerConfiguration;
+    exludeDomains?: string[];
+    excludePages?: string[];
+    domains?: string[];
+    pages?: string[];
+    events?: EventTriggerConfiguration[];
+}
+export interface ShopifyTriggerConfiguration {
+    enabled: boolean;
+    collections?: string[];
+    tags?: string[];
+}
+export interface EventTriggerConfiguration {
+    name: TRACKING_EVENT_NAME;
+    count: number;
+    condition: EVENT_TRIGGER_CONDITION;
+}
+export interface EventConfiguration {
+    sourceEventName: string;
+    exclude?: boolean;
+    sample: EventSampleConfiguration;
+    transformations?: EventTransformation[];
+}
+export interface EventTransformation {
+    transformationEventName: string;
+    enabled: boolean;
+}
+export interface EventSampleConfiguration {
+    enabled: boolean;
+    rate: number;
+}
+export interface ForwardingConfiguration {
+    productIdFormat?: string;
+}

package/dist/cjs/types/api/destinations/destinations.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=destinations.js.map

package/dist/cjs/types/api/destinations/index.d.ts

@@ -1,7 +1,7 @@
-export * from './destination-enums.js';
-export * from './destinations.js';
-export * from './destination-catalog.js';
-export * from './third-party-destination-configs.js';
-export * from './third-party-integration-configs.js';
-export * from './third-party-contact-acquisition-configs.js';
-export * from './custom-event-mapping.js';
+export * from './destination-enums.js';
+export * from './destinations.js';
+export * from './destination-catalog.js';
+export * from './third-party-destination-configs.js';
+export * from './third-party-integration-configs.js';
+export * from './third-party-contact-acquisition-configs.js';
+export * from './custom-event-mapping.js';

package/dist/cjs/types/api/destinations/index.js

@@ -1,24 +1,24 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./destination-enums.js"), exports);
-__exportStar(require("./destinations.js"), exports);
-__exportStar(require("./destination-catalog.js"), exports);
-__exportStar(require("./third-party-destination-configs.js"), exports);
-__exportStar(require("./third-party-integration-configs.js"), exports);
-__exportStar(require("./third-party-contact-acquisition-configs.js"), exports);
-__exportStar(require("./custom-event-mapping.js"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./destination-enums.js"), exports);
+__exportStar(require("./destinations.js"), exports);
+__exportStar(require("./destination-catalog.js"), exports);
+__exportStar(require("./third-party-destination-configs.js"), exports);
+__exportStar(require("./third-party-integration-configs.js"), exports);
+__exportStar(require("./third-party-contact-acquisition-configs.js"), exports);
+__exportStar(require("./custom-event-mapping.js"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/types/api/destinations/third-party-contact-acquisition-configs.d.ts

@@ -1,9 +1,9 @@
-import { Destination, UserDestinationConfiguration } from './destinations.js';
-export interface KlaviyoContactAcquisition extends Destination {
-    configuration: KlaviyoContactAcquisitionConfiguration;
-}
-export interface KlaviyoContactAcquisitionConfiguration extends UserDestinationConfiguration {
-    apiAccessToken: string;
-    listId?: string;
-    reactivateListId?: string;
-}
+import { Destination, UserDestinationConfiguration } from './destinations.js';
+export interface KlaviyoContactAcquisition extends Destination {
+    configuration: KlaviyoContactAcquisitionConfiguration;
+}
+export interface KlaviyoContactAcquisitionConfiguration extends UserDestinationConfiguration {
+    apiAccessToken: string;
+    listId?: string;
+    reactivateListId?: string;
+}

package/dist/cjs/types/api/destinations/third-party-contact-acquisition-configs.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=third-party-contact-acquisition-configs.js.map

package/dist/cjs/types/api/destinations/third-party-destination-configs.d.ts

@@ -1,189 +1,189 @@
-import { Destination, UserDestinationConfiguration } from './destinations.js';
-export interface AdTrackifyFacebookDestination extends Destination {
-    configuration: FacebookPixelConfiguration;
-}
-export interface AdTrackifyTikTokDestination extends Destination {
-    configuration: TiktokPixelConfiguration;
-}
-export interface AdTrackifyGoogleAnalytics4Destination extends Destination {
-    configuration: GoogleAnalytics4Configuration;
-}
-export interface AdTrackifyPinterestDestination extends Destination {
-    configuration: PinterestConfiguration;
-}
-export interface AdTrackifySnapchatDestination extends Destination {
-    configuration: SnapchatConfiguration;
-}
-export interface AdTrackifyKlaviyoDestination extends Destination {
-    configuration: KlaviyoConfiguration;
-}
-export interface AdTrackifySendlaneDestination extends Destination {
-    configuration: SendlaneConfiguration;
-}
-export interface AdTrackifyOutboxDestination extends Destination {
-    configuration: OutbrainConfiguration;
-}
-export interface AdTrackifyGoogleAdsV2Destination extends Destination {
-    configuration: GoogleAdsV2Configuration;
-}
-export interface AdTrackifyOmnisendDestination extends Destination {
-    configuration: OmnisendConfiguration;
-}
-export interface AdTrackifyAttentiveDestination extends Destination {
-    configuration: AttentiveConfiguration;
-}
-export interface AdTrackifyYotpoDestination extends Destination {
-    configuration: YotpoConfiguration;
-}
-export interface AdTrackifyPostHogDestination extends Destination {
-    configuration: PostHogConfiguration;
-}
-export interface AdTrackifyLoopsDestination extends Destination {
-    configuration: LoopsConfiguration;
-}
-export interface FacebookPixelConfiguration extends UserDestinationConfiguration {
-    apiAccessToken?: string;
-    enableConversionAPI: boolean;
-    pixelId: string;
-}
-export interface TiktokPixelConfiguration extends UserDestinationConfiguration {
-    apiAccessToken?: string;
-    enableConversionAPI: boolean;
-    pixelId: string;
-}
-export interface GoogleAnalytics4Configuration extends UserDestinationConfiguration {
-    apiSecret: string;
-    measurementId: string;
-}
-export interface GoogleAdsConfiguration extends UserDestinationConfiguration {
-    pixelId: string;
-    conversionID: string;
-}
-export interface HubspotPixelConfiguration extends UserDestinationConfiguration {
-    hubspotId: string;
-}
-export interface TwitterPixelConfiguration extends UserDestinationConfiguration {
-    twitterPixelId: string;
-}
-export interface IntercomTagConfiguration extends UserDestinationConfiguration {
-    appId: string;
-    apiBase: string;
-}
-export interface WebhookConfiguration extends UserDestinationConfiguration {
-    webhookUrl: string;
-}
-export interface CustomHTMLConfiguration extends UserDestinationConfiguration {
-    html: string;
-    location: CustomHTMLLocation;
-}
-export interface PinterestConfiguration extends UserDestinationConfiguration {
-    pixelId: string;
-    enableConversionAPI: boolean;
-    advertiserId?: string;
-    apiAccessToken?: string;
-}
-export interface SnapchatConfiguration extends UserDestinationConfiguration {
-    snapchatPixelId: string;
-    enableConversionAPI: boolean;
-    apiAccessToken?: string;
-}
-export interface KlaviyoConfiguration extends UserDestinationConfiguration {
-    apiAccessToken: string;
-    enablePredictivePopup: boolean;
-    signupFormId?: string;
-    clonedSignupFormId?: string;
-}
-export interface SendlaneConfiguration extends UserDestinationConfiguration {
-    apiAccessToken: string;
-    sendlaneIntegrationToken: string;
-}
-export interface OmnisendConfiguration extends UserDestinationConfiguration {
-    apiKey: string;
-}
-export interface AttentiveConfiguration extends UserDestinationConfiguration {
-    apiKey: string;
-}
-export interface OutbrainConfiguration extends UserDestinationConfiguration {
-    pixelId: string;
-}
-export interface GoogleAdsV2Configuration extends UserDestinationConfiguration {
-    accountId: string;
-    merchantCenterId: string;
-    conversionId: string;
-}
-export interface YotpoConfiguration extends UserDestinationConfiguration {
-    appKey: string;
-    secretKey: string;
-    apiAccessToken?: string;
-}
-export declare enum POSTHOG_REGION {
-    US = "us",
-    EU = "eu"
-}
-export interface PostHogConfiguration extends UserDestinationConfiguration {
-    projectApiKey: string;
-    region: POSTHOG_REGION;
-    enableAutoCapture?: boolean;
-    enableSessionRecording?: boolean;
-}
-export interface LoopsConfiguration extends UserDestinationConfiguration {
-    apiKey: string;
-}
-export declare enum POSTHOG_EVENT {
-    PAGEVIEW = "$pageview",
-    PAGELEAVE = "$pageleave",
-    IDENTIFY = "$identify",
-    ADD_TO_CART = "add_to_cart",
-    VIEW_ITEM = "view_item",
-    VIEW_CATEGORY = "view_category",
-    INITIATE_CHECKOUT = "initiate_checkout",
-    PURCHASE = "purchase",
-    SEARCH = "search",
-    SIGN_UP = "sign_up",
-    LEAD = "lead"
-}
-export interface PostHogEventProperties {
-    distinct_id?: string;
-    $current_url?: string;
-    $referrer?: string;
-    $ip?: string;
-    $user_agent?: string;
-    $browser?: string;
-    $device_type?: string;
-    $os?: string;
-    value?: number;
-    currency?: string;
-    order_id?: string;
-    items?: PostHogItem[];
-    search_query?: string;
-    [key: string]: unknown;
-}
-export interface PostHogItem {
-    product_id?: string;
-    product_name?: string;
-    product_brand?: string;
-    product_category?: string;
-    price?: number;
-    quantity?: number;
-    variant?: string;
-}
-export interface PostHogApiRequest {
-    api_key: string;
-    event: string;
-    properties: PostHogEventProperties;
-    timestamp?: string;
-}
-export interface PostHogBatchRequest {
-    api_key: string;
-    batch: PostHogBatchEvent[];
-}
-export interface PostHogBatchEvent {
-    event: string;
-    properties: PostHogEventProperties;
-    timestamp?: string;
-}
-export declare enum CustomHTMLLocation {
-    HEADER = "header",
-    FOOTER = "footer",
-    BODY = "body"
-}
+import { Destination, UserDestinationConfiguration } from './destinations.js';
+export interface AdTrackifyFacebookDestination extends Destination {
+    configuration: FacebookPixelConfiguration;
+}
+export interface AdTrackifyTikTokDestination extends Destination {
+    configuration: TiktokPixelConfiguration;
+}
+export interface AdTrackifyGoogleAnalytics4Destination extends Destination {
+    configuration: GoogleAnalytics4Configuration;
+}
+export interface AdTrackifyPinterestDestination extends Destination {
+    configuration: PinterestConfiguration;
+}
+export interface AdTrackifySnapchatDestination extends Destination {
+    configuration: SnapchatConfiguration;
+}
+export interface AdTrackifyKlaviyoDestination extends Destination {
+    configuration: KlaviyoConfiguration;
+}
+export interface AdTrackifySendlaneDestination extends Destination {
+    configuration: SendlaneConfiguration;
+}
+export interface AdTrackifyOutboxDestination extends Destination {
+    configuration: OutbrainConfiguration;
+}
+export interface AdTrackifyGoogleAdsV2Destination extends Destination {
+    configuration: GoogleAdsV2Configuration;
+}
+export interface AdTrackifyOmnisendDestination extends Destination {
+    configuration: OmnisendConfiguration;
+}
+export interface AdTrackifyAttentiveDestination extends Destination {
+    configuration: AttentiveConfiguration;
+}
+export interface AdTrackifyYotpoDestination extends Destination {
+    configuration: YotpoConfiguration;
+}
+export interface AdTrackifyPostHogDestination extends Destination {
+    configuration: PostHogConfiguration;
+}
+export interface AdTrackifyLoopsDestination extends Destination {
+    configuration: LoopsConfiguration;
+}
+export interface FacebookPixelConfiguration extends UserDestinationConfiguration {
+    apiAccessToken?: string;
+    enableConversionAPI: boolean;
+    pixelId: string;
+}
+export interface TiktokPixelConfiguration extends UserDestinationConfiguration {
+    apiAccessToken?: string;
+    enableConversionAPI: boolean;
+    pixelId: string;
+}
+export interface GoogleAnalytics4Configuration extends UserDestinationConfiguration {
+    apiSecret: string;
+    measurementId: string;
+}
+export interface GoogleAdsConfiguration extends UserDestinationConfiguration {
+    pixelId: string;
+    conversionID: string;
+}
+export interface HubspotPixelConfiguration extends UserDestinationConfiguration {
+    hubspotId: string;
+}
+export interface TwitterPixelConfiguration extends UserDestinationConfiguration {
+    twitterPixelId: string;
+}
+export interface IntercomTagConfiguration extends UserDestinationConfiguration {
+    appId: string;
+    apiBase: string;
+}
+export interface WebhookConfiguration extends UserDestinationConfiguration {
+    webhookUrl: string;
+}
+export interface CustomHTMLConfiguration extends UserDestinationConfiguration {
+    html: string;
+    location: CustomHTMLLocation;
+}
+export interface PinterestConfiguration extends UserDestinationConfiguration {
+    pixelId: string;
+    enableConversionAPI: boolean;
+    advertiserId?: string;
+    apiAccessToken?: string;
+}
+export interface SnapchatConfiguration extends UserDestinationConfiguration {
+    snapchatPixelId: string;
+    enableConversionAPI: boolean;
+    apiAccessToken?: string;
+}
+export interface KlaviyoConfiguration extends UserDestinationConfiguration {
+    apiAccessToken: string;
+    enablePredictivePopup: boolean;
+    signupFormId?: string;
+    clonedSignupFormId?: string;
+}
+export interface SendlaneConfiguration extends UserDestinationConfiguration {
+    apiAccessToken: string;
+    sendlaneIntegrationToken: string;
+}
+export interface OmnisendConfiguration extends UserDestinationConfiguration {
+    apiKey: string;
+}
+export interface AttentiveConfiguration extends UserDestinationConfiguration {
+    apiKey: string;
+}
+export interface OutbrainConfiguration extends UserDestinationConfiguration {
+    pixelId: string;
+}
+export interface GoogleAdsV2Configuration extends UserDestinationConfiguration {
+    accountId: string;
+    merchantCenterId: string;
+    conversionId: string;
+}
+export interface YotpoConfiguration extends UserDestinationConfiguration {
+    appKey: string;
+    secretKey: string;
+    apiAccessToken?: string;
+}
+export declare enum POSTHOG_REGION {
+    US = "us",
+    EU = "eu"
+}
+export interface PostHogConfiguration extends UserDestinationConfiguration {
+    projectApiKey: string;
+    region: POSTHOG_REGION;
+    enableAutoCapture?: boolean;
+    enableSessionRecording?: boolean;
+}
+export interface LoopsConfiguration extends UserDestinationConfiguration {
+    apiKey: string;
+}
+export declare enum POSTHOG_EVENT {
+    PAGEVIEW = "$pageview",
+    PAGELEAVE = "$pageleave",
+    IDENTIFY = "$identify",
+    ADD_TO_CART = "add_to_cart",
+    VIEW_ITEM = "view_item",
+    VIEW_CATEGORY = "view_category",
+    INITIATE_CHECKOUT = "initiate_checkout",
+    PURCHASE = "purchase",
+    SEARCH = "search",
+    SIGN_UP = "sign_up",
+    LEAD = "lead"
+}
+export interface PostHogEventProperties {
+    distinct_id?: string;
+    $current_url?: string;
+    $referrer?: string;
+    $ip?: string;
+    $user_agent?: string;
+    $browser?: string;
+    $device_type?: string;
+    $os?: string;
+    value?: number;
+    currency?: string;
+    order_id?: string;
+    items?: PostHogItem[];
+    search_query?: string;
+    [key: string]: unknown;
+}
+export interface PostHogItem {
+    product_id?: string;
+    product_name?: string;
+    product_brand?: string;
+    product_category?: string;
+    price?: number;
+    quantity?: number;
+    variant?: string;
+}
+export interface PostHogApiRequest {
+    api_key: string;
+    event: string;
+    properties: PostHogEventProperties;
+    timestamp?: string;
+}
+export interface PostHogBatchRequest {
+    api_key: string;
+    batch: PostHogBatchEvent[];
+}
+export interface PostHogBatchEvent {
+    event: string;
+    properties: PostHogEventProperties;
+    timestamp?: string;
+}
+export declare enum CustomHTMLLocation {
+    HEADER = "header",
+    FOOTER = "footer",
+    BODY = "body"
+}