react-marketing-tools 0.2.9 → 0.3.1

package/dist/buildConfig/index.d.ts

@@ -0,0 +1,8 @@
+import { BuildConfigOptions, Config, AnalyticsPlatform } from '../types';
+declare const analyticsPlatform: AnalyticsPlatform;
+declare const showMeBuildInAnalyticsPlatform: () => void;
+declare const showMeBuildInEventActionPrefixList: () => void;
+declare const showMeBuildInGlobalEventActionList: () => void;
+declare let config: Config;
+declare const buildConfig: (options: BuildConfigOptions) => void;
+export { config, analyticsPlatform, buildConfig, showMeBuildInAnalyticsPlatform, showMeBuildInGlobalEventActionList, showMeBuildInEventActionPrefixList, };

package/dist/index.d.ts

@@ -1,144 +1,26 @@
-// 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
-}
+import { ReactNode, Context } from 'react';
+import type { ProviderStateProps, ProviderApiProps } from './types';
+export * from './types';
+export { buildConfig } from './buildConfig';
+export { trackAnalyticsEvent } from './analytics/analyticsEventService';
+export declare const ContextState: Context<ProviderStateProps>;
+export declare const ContextApi: Context<ProviderApiProps>;
+declare type ReactMarketingProviderProps = {
+    children: ReactNode;
+};
+export declare const ReactMarketingProvider: ({ children, }: ReactMarketingProviderProps) => JSX.Element;
+/**
+ * @property {string} appName
+ * @property {string} appSessionCookieName
+ * @property {object} analyticsPlatform
+ * @property {object} eventActionPrefixList
+ * @property {object} analyticsGlobalEventActionList
+ */
+export declare const useMarketingState: () => ProviderStateProps;
+/**
+ * @property {function} trackAnalyticsEvent(options)
+ * @property {function} showMeBuildInAnalyticsPlatform
+ * @property {function} showMeBuildInEventActionPrefixList
+ * @property {function} showMeBuildInGlobalEventActionList
+ */
+export declare const useMarketingApi: () => ProviderApiProps;