react-marketing-tools 0.2.8 → 0.2.9

package/dist/index.d.ts

@@ -1,5 +1,144 @@
-export * from './lib/analytics/types'
-export * from './lib/buildConfig/types'
-export * from './lib/ipInfo/types'
-export * from './lib/types'
-export * from './lib/index'
+// react-marketing-tools.d.ts
+
+declare module 'react-marketing-tools' {
+  // Event types
+  export type Event = {
+    name: string
+    params: Record<AllowedTypes, AllowedTypes>
+  }
+
+  // GooglePayload type - Represents the payload structure for Google Analytics
+  export type GooglePayload = {
+    non_personalized_ads: boolean
+    client_id: string
+    user_id: string
+    user_properties: {
+      user_id: string
+      user_type: string
+      client_id: string
+    }
+    events: Event[]
+  }
+
+  // EventNameInfo type - Information about a specific analytics event
+  export type EventNameInfo = {
+    eventName: string
+    description?: string
+    actionPrefix: string
+    globalAppEvent: string
+    previousGlobalAppEvent?: string
+  }
+
+  // AllowedTypes type - Union type for allowed parameter types in events
+  export type AllowedTypes = string | number
+
+  // TrackAnalyticsEventOptions type - Options for tracking an analytics event
+  export type TrackAnalyticsEventOptions = {
+    data: Record<AllowedTypes, AllowedTypes>
+    eventNameInfo: EventNameInfo
+    analyticsType: string
+    userDataToHashKeyArray: Array<string> | null
+    dataLayerCheck: boolean
+    consoleLogData?: object
+  }
+
+  // GlobalVars type - Represents global variables in analytics tracking
+  export type GlobalVars = {
+    app: string
+    device_category?: string | undefined
+    device_os?: string | undefined
+    device_browser?: string | undefined
+  }
+
+  // DataLayer type - Represents the data layer for analytics events
+  export type DataLayer = {
+    event: string
+    globalVars: GlobalVars
+    journeyProps: Record<any, any>
+    userProps: Record<any, any>
+  }
+
+  // ConsoleLogData type - Options for console logging analytics data
+  export type ConsoleLogData = {
+    showGlobalVars?: boolean
+    showJourneyPropsPayload?: boolean
+    showUserProps?: boolean
+  }
+
+  // AnalyticsTrackerDataOptions interface - Options for analytics tracking
+  export interface AnalyticsTrackerDataOptions {
+    consoleLogData: ConsoleLogData | null
+    data: Record<any, any>
+    eventName: string
+    globalAppEvent: string
+    userDetails: Record<any, any>
+  }
+
+  // HandleDataLayerPushOptions type - Options for handling data layer push
+  export interface HandleDataLayerPushOptions
+    extends AnalyticsTrackerDataOptions {
+    dataLayerCheck: boolean
+  }
+
+  // Ga4GoogleAnalyticsEventTracking type - Options for GA4 Google Analytics event tracking
+  export type Ga4GoogleAnalyticsEventTracking = AnalyticsTrackerDataOptions
+
+  // Platform type - Union type for supported analytics platforms
+  export type Platform = 'GOOGLE' | 'FACEBOOK' | 'DATALAYER_PUSH'
+
+  // Tokens type - Represents tokens used in the analytics configuration
+  export type Tokens = {
+    IP_INFO_TOKEN?: string
+    GA4_PUBLIC_API_SECRET?: string
+    GA4_PUBLIC_MEASUREMENT_ID?: string
+  }
+
+  // Config type - Represents the configuration for analytics tracking
+  export type Config = {
+    TOKENS?: Tokens
+    appName: string
+    appSessionCookieName: string
+    withDeviceInfo?: boolean
+    includeUserKeys: Array<string>
+    showMissingUserAttributesInConsole: boolean | undefined
+    withServerLocationInfo: boolean | undefined
+    eventActionPrefixList: Record<string, string>
+    analyticsGlobalEventActionList: Record<string, string>
+  }
+
+  // BuildConfigOptions type - Options for building the analytics configuration
+  export type BuildConfigOptions = {
+    appName: string
+    appSessionCookieName: string
+    eventActionPrefix?: Record<string, string>
+    globalEventActionList?: Record<string, string>
+    includeUserKeys?: boolean
+    showMissingUserAttributesInConsole?: boolean
+    TOKENS?: Tokens
+    withDeviceInfo?: boolean
+    withServerLocationInfo?: boolean
+  }
+
+  // Function declarations
+  export const analyticsPlatform: {
+    [key in Platform]: Platform
+  }
+
+  // Function to log supported analytics platforms
+  export const showMeBuildInAnalyticsPlatform: () => void
+
+  export const analyticsEventActionPrefixList: Record<string, string>
+
+  // Function to log built-in event action prefix list
+  export const showMeBuildInEventActionPrefixList: () => void
+
+  export const analyticsGlobalEventActionList: Record<string, string>
+
+  // Function to log built-in global event action list
+  export const showMeBuildInGlobalEventActionList: () => void
+
+  export let config: Config
+
+  // Function to build the analytics configuration
+  export const buildConfig: (options: BuildConfigOptions) => void
+}

package/dist/lib/types.d.ts

@@ -1,4 +1,5 @@
-import { Platform, TrackAnalyticsEventOptions } from '..';
+import { TrackAnalyticsEventOptions } from './analytics/types';
+import { Platform } from './buildConfig/types';
 export declare type ProviderStateProps = {
     appName: string;
     appSessionCookieName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-marketing-tools",
-  "version": "0.2.8",
+  "version": "0.2.9",
   "description": "React Marketing Tools are a set of tools to make it easier for you to implement analytics and track user journeys, interactions throughout your App. using dataLayer/Google Tag Manager, GA4 fetch directly or coming soon facebook pixel.",
   "license": "MIT",
   "author": "bronz3beard <exempli.gratia.webdesign@gmail.com> (https://www.heyrory.com/)",
@@ -43,7 +43,8 @@
     "build": "tsc && vite build",
     "build:watch": "tsc && vite build --watch",
     "preview": "vite preview",
-    "mock:publish": "npm pack --dry-run"
+    "mock:publish": "npm pack --dry-run",
+    "check-types": "tsc --noEmit --pretty"
   },
   "browserslist": {
     "production": [