@adtrackify/at-tracking-event-types 1.0.29 → 1.0.33

package/build.js

@@ -11,12 +11,16 @@ new Generator({
   output: 'dist/index.d.ts',
 }).generate()
 
+
+const shared = {
+}
+
 build({
   entryPoints: ['./src/index.ts'],
-  outdir: 'dist',
+  external: Object.keys(dependencies),
   bundle: true,
-  format: 'esm',
+  format: 'cjs',
   platform: 'node',
   sourcemap: 'linked',
-  external: Object.keys(dependencies)
-})
+  outdir: 'dist',
+})

package/dist/index.d.ts

@@ -1 +1,425 @@
-export * from './types';
+declare module '@adtrackify/at-tracking-event-types/index' {
+  export * from '@adtrackify/at-tracking-event-types/types/index';
+  export * from '@adtrackify/at-tracking-event-types/utils/index';
+
+}
+declare module '@adtrackify/at-tracking-event-types/types/adtrackify-event-bus-event' {
+  import { TrackingEvent } from '@adtrackify/at-tracking-event-types/types/tracking-event-type';
+  export interface AdtrackifyEventBusEvent {
+      eventId: string;
+      eventType: string;
+      eventTime: string;
+      eventData?: object;
+  }
+  export interface AdtrackifyEventBusTrackingEvent extends AdtrackifyEventBusEvent {
+      eventData: {
+          trackingEvent: TrackingEvent;
+          pixelId: string;
+      };
+  }
+
+}
+declare module '@adtrackify/at-tracking-event-types/types/adtrackify-standard-events' {
+  export enum ADTRACKIFY_STANDARD_EVENT {
+      ADD_PAYMENT_INFO = "add_payment_info",
+      ADD_SHIPPING_INFO = "add_shipping_info",
+      ADD_TO_CART = "add_to_cart",
+      ADD_TO_WISHLIST = "add_to_wishlist",
+      INITIATE_CHECKOUT = "initiate_checkout",
+      LEAD = "lead",
+      LOGIN = "login",
+      PAGE_VIEW = "page_view",
+      PURCHASE = "purchase",
+      REFUND = "refund",
+      SEARCH = "search",
+      SIGN_UP = "sign_up",
+      VIEW_CART = "view_cart",
+      VIEW_CONTENT = "view_content",
+      SELECT_SHIPPING_METHOD = "select_shipping_method",
+      VIRTUALIZED_VIEWED_PAYMENT_FORM = "virtualized_viewd_payment_form"
+  }
+
+}
+declare module '@adtrackify/at-tracking-event-types/types/api/account' {
+  export interface Account {
+      id: string;
+      accountName: string;
+      companyName?: string;
+      accountStatus: ACCOUNT_STATUS;
+      primaryEmail: string;
+      publicApiKey?: string;
+      subscriptionId?: string;
+      ownerId?: string;
+      createdAt: string;
+      updatedAt: string;
+  }
+  export enum ACCOUNT_STATUS {
+      PENDING = "pending",
+      ACTIVE = "active",
+      INACTIVE = "inactive"
+  }
+
+}
+declare module '@adtrackify/at-tracking-event-types/types/api/destination' {
+  export interface Destination {
+      id: string;
+      accountId: string;
+      pixelId: string;
+      destination: string;
+      displayName?: string;
+      enabled: boolean;
+      configuration?: any;
+      createdAt: string;
+      updatedAt: string;
+  }
+  export interface DestinationCatalogItem {
+      id: string;
+      active: boolean;
+      destinationKey: string;
+      destinationType: string;
+      displayName?: string;
+      shortName?: string;
+      description?: string;
+      url: string;
+      fields?: any;
+      createdAt: string;
+      updatedAt: string;
+  }
+  export interface DestinationCatalogFields {
+      component_type: string;
+      name: string;
+      description: string;
+      label: string;
+      type: string;
+      required: boolean;
+      order: number;
+  }
+  export interface AdTrackifyFacebookDestination extends Destination {
+      configuration: FacebookPixelConfiguration;
+  }
+  export interface FacebookPixelConfiguration {
+      apiAccessToken?: string;
+      enableConversionAPI: boolean;
+      pixelId: string;
+  }
+  export interface GoogleAnalytics4Configuration {
+      measurementId: string;
+  }
+
+}
+declare module '@adtrackify/at-tracking-event-types/types/api/destinations' {
+  export enum DESTINATIONS {
+      FACEBOOK = "facebook",
+      TIKTOK = "tiktok",
+      GOOGLE_ADS = "googleAds",
+      GOOGLE_ANALYTICS_4 = "googleAnalytics4"
+  }
+
+}
+declare module '@adtrackify/at-tracking-event-types/types/api/index' {
+  export * from '@adtrackify/at-tracking-event-types/types/api/account';
+  export * from '@adtrackify/at-tracking-event-types/types/api/destination';
+  export * from '@adtrackify/at-tracking-event-types/types/api/destinations';
+  export * from '@adtrackify/at-tracking-event-types/types/api/shopify-app-install';
+  export * from '@adtrackify/at-tracking-event-types/types/api/subscription';
+  export * from '@adtrackify/at-tracking-event-types/types/api/user';
+
+}
+declare module '@adtrackify/at-tracking-event-types/types/api/shopify-app-install' {
+  export interface ShopifyAppInstall {
+      shopifyAppInstallId: string;
+      shop: string;
+      accessToken?: string;
+      appStatus?: string;
+      appSubscriptionStatus?: ShopifyAppSubscriptionStatus;
+      code?: string;
+      hmac?: string;
+      host?: string;
+      installRequest?: ShopifyInstallRequest;
+      isAppEnabled?: boolean;
+      pixelId?: string;
+      shopInfo?: any;
+      state?: string;
+      timestamp?: number;
+      createdAt: string;
+      updatedAt: string;
+  }
+  export enum ShopifyAppInstallStatus {
+      STARTED = "started",
+      COMPLETED = "completed",
+      UNINSTALLED = "uninstalled",
+      FAILED = "failed",
+      NONE = "none"
+  }
+  export enum ShopifyAppSubscriptionStatus {
+      ACTIVE = "active",
+      CANCELLED = "cancelled",
+      DECLINED = "declined",
+      EXPIRED = "expired",
+      FROZEN = "frozen",
+      PENDING = "pending",
+      NOT_SUBMITTED = "na"
+  }
+  export interface ShopifyInstallRequest {
+      shop?: string;
+      session?: string;
+      hmac?: string;
+      host?: string;
+      nonce?: string;
+      timestamp?: string;
+      status?: string;
+  }
+  export interface ShopifyStoreInfo {
+      [key: string]: any;
+  }
+
+}
+declare module '@adtrackify/at-tracking-event-types/types/api/subscription' {
+  export interface Subscription {
+      id: string;
+      accountId?: string;
+      shopifyAppInstallId?: string;
+      shopifyDomain?: string;
+      stripeCustomerId?: string;
+      stripeSubscriptionId?: string;
+      stripeCompletedCheckoutSession?: any;
+      shopifyChargeId?: string;
+      subscriptionPlan?: SubscriptionPlan;
+      status?: SUBSCRIPTION_STATUS;
+      paymentStatus?: PAYMENT_STATUS;
+      paymentGateway?: PAYMENT_GATEWAY;
+      createdAt: string;
+      updatedAt: string;
+  }
+  export interface SubscriptionPlan {
+      id: number;
+      planName: string;
+      description: string;
+      sku: string;
+      price: string;
+      billingFrequency: PLAN_BILLING_FREQUENCY;
+      trialLengthDays?: number;
+      trialRequiresCreditCard?: boolean;
+  }
+  export enum PLAN_BILLING_FREQUENCY {
+      MONTHLY = "monthly",
+      YEARLY = "yearly"
+  }
+  export enum PAYMENT_STATUS {
+      CURRENT = "current",
+      PAST_DUE = "past_due",
+      CANCELLED = "cancelled",
+      FAILED = "failed"
+  }
+  export enum SUBSCRIPTION_STATUS {
+      ACTIVE = "active",
+      CANCELLED = "cancelled",
+      DECLINED = "declined",
+      EXPIRED = "expired",
+      FROZEN = "frozen",
+      PENDING = "pending",
+      NOT_SUBMITTED = "na"
+  }
+  export enum PAYMENT_GATEWAY {
+      STRIPE = "stripe",
+      PAYPAL = "paypal",
+      SHOPIFY = "shopify"
+  }
+  export const StripeBillingMap: any;
+  export const SubscriptionPlanSeedItems: {
+      items: SubscriptionPlan[];
+  };
+  export const getPlanDetails: (planId: number, stage: string) => SubscriptionPlan;
+
+}
+declare module '@adtrackify/at-tracking-event-types/types/api/user' {
+  export interface User {
+      id: string;
+      sub: string;
+      userId: string;
+      Username: string;
+      UserLastModifiedDate: string;
+      Enabled: boolean;
+      UserStatus: string;
+      email: string;
+      email_verified: string;
+      name: string;
+      family_name: string;
+  }
+
+}
+declare module '@adtrackify/at-tracking-event-types/types/index' {
+  export * from '@adtrackify/at-tracking-event-types/types/adtrackify-standard-events';
+  export * from '@adtrackify/at-tracking-event-types/types/third-party-event-configuration-types';
+  export * from '@adtrackify/at-tracking-event-types/types/tracking-event-type';
+  export * from '@adtrackify/at-tracking-event-types/types/adtrackify-event-bus-event';
+  export * from '@adtrackify/at-tracking-event-types/types/api/index';
+
+}
+declare module '@adtrackify/at-tracking-event-types/types/third-party-event-configuration-types' {
+  export interface DestinationConfiguration {
+      eventConfigurations: DestinationEventSpecificConfiguration[];
+  }
+  export interface DestinationEventSpecificConfiguration {
+      enabled: boolean;
+      sourceEventName: string;
+      destinationEventName: string;
+  }
+
+}
+declare module '@adtrackify/at-tracking-event-types/types/tracking-event-type' {
+  import { IResult } from 'ua-parser-js';
+  import { ADTRACKIFY_STANDARD_EVENT } from '@adtrackify/at-tracking-event-types/types/adtrackify-standard-events';
+  export interface TrackingEvent {
+      id: string;
+      type: string;
+      name: ADTRACKIFY_STANDARD_EVENT;
+      pixelId: string;
+      context: TrackingEventContext;
+      data: TrackingEventData;
+      testCode?: string;
+      sentAtEpoch?: number;
+      collectedAt?: string;
+      version: string;
+  }
+  export interface TrackingEventContext {
+      identity: TrackingEventIdentity;
+      click?: AdClickInfo;
+      campaign?: CampaignInfo;
+      page?: PageInfo;
+      device?: DeviceInfo;
+      locale?: string;
+      timezone?: string;
+      userAgent?: string;
+      ipAddress?: string;
+      ipv6Address?: string;
+  }
+  export interface TrackingEventIdentity {
+      gender?: string;
+      dob?: string;
+      phone?: string;
+      id?: string;
+      firstName?: string;
+      lastName?: string;
+      email?: string;
+      address?: AddressInfo;
+      addresses?: AddressInfo[];
+  }
+  export interface AdClickInfo {
+      fbp?: string;
+      fbc?: string;
+      fbclid?: string;
+      gclid?: string;
+  }
+  export interface TrackingEventData {
+      [key: string]: any;
+      firstName?: string;
+      lastName?: string;
+      email?: string;
+      phone?: string;
+      addresses?: AddressInfo[];
+      cartId?: string;
+      transactionId?: string;
+      affiliation?: string;
+      currency?: string;
+      price?: number;
+      subtotalPrice?: number;
+      value?: number;
+      tax?: number;
+      shipping?: number;
+      coupon?: string;
+      paymentType?: string;
+      shippingTier?: string;
+      creativeName?: string;
+      creativeSlot?: string;
+      locationId?: string;
+      promotionId?: string;
+      promotionName?: string;
+      items?: GenericContent[];
+  }
+  export interface GenericContent {
+      [key: string]: any;
+      content_type?: string;
+      id?: string;
+      name?: string;
+      sku?: string;
+      brand?: string;
+      variant?: string;
+      coupon?: string;
+      currency?: string;
+      discount?: number;
+      index?: number;
+      value?: number;
+      price?: number;
+      quantity?: number;
+      url?: string;
+      locationId?: string;
+      imageUrl?: string;
+      category?: string;
+      category2?: string;
+      category3?: string;
+      category4?: string;
+      category5?: string;
+  }
+  export interface AddressInfo {
+      email?: string;
+      phone?: string;
+      firstName?: string;
+      lastName?: string;
+      company?: string;
+      address1?: string;
+      address2?: string;
+      city?: string;
+      province?: string;
+      provinceCode?: string;
+      country?: string;
+      countryCode?: string;
+      zip?: string;
+  }
+  export interface CampaignInfo {
+      name?: string;
+      source?: string;
+      medium?: string;
+      term?: string;
+      content?: string;
+  }
+  export interface PageInfo {
+      path?: string;
+      referrer?: string;
+      search?: string;
+      title?: string;
+      url?: string;
+      qsp?: any;
+  }
+  export type DeviceInfo = IResult;
+  export const Currencies: string[];
+
+}
+declare module '@adtrackify/at-tracking-event-types/utils/fake-tracking-event-generator' {
+  import { AdClickInfo, AddressInfo, CampaignInfo, GenericContent, PageInfo, TrackingEvent, TrackingEventContext, TrackingEventIdentity } from '@adtrackify/at-tracking-event-types/index';
+  export const generateFakeTrackingEvent: (event?: Partial<TrackingEvent>) => TrackingEvent;
+  export const populateGenericTrackingEventData: (event?: Partial<TrackingEvent>) => TrackingEvent;
+  export const generateFakePurchaseEvent: (event?: Partial<TrackingEvent>) => TrackingEvent;
+  export const generateFakeViewContentEvent: (event?: Partial<TrackingEvent>) => TrackingEvent;
+  export const generateFakeAddToCartEvent: (event?: Partial<TrackingEvent>) => TrackingEvent;
+  export const generateFakeEcommerceItems: (numItems?: number) => GenericContent[];
+  export const generateFakeEcommerceItem: () => GenericContent;
+  export const generateFakeEventContext: (context?: Partial<TrackingEventContext>) => TrackingEventContext;
+  export const generateFakePageInfo: (pageInfo?: Partial<PageInfo>) => PageInfo;
+  export const generateFakeCampiagnInfo: (campaignInfo?: Partial<CampaignInfo>) => CampaignInfo;
+  export const generateFakeAdClickInfo: (clickInfo?: Partial<AdClickInfo>) => AdClickInfo;
+  export const generateFakeTrackingEventIdentity: (identity?: Partial<TrackingEventIdentity>) => TrackingEventIdentity;
+  export const generateFakeAddress: (address?: AddressInfo) => AddressInfo;
+  export const choasFake: <T>(input?: T | undefined) => T | null | undefined;
+  export function randomEnum<T>(anEnum: T): T[keyof T];
+  export const randomEnumKey: (enumeration: any) => string;
+
+}
+declare module '@adtrackify/at-tracking-event-types/utils/index' {
+  export * from '@adtrackify/at-tracking-event-types/utils/fake-tracking-event-generator';
+
+}
+declare module '@adtrackify/at-tracking-event-types' {
+  import main = require('@adtrackify/at-tracking-event-types/src/index');
+  export = main;
+}