react-marketing-tools 0.2.8 → 0.3.0

package/dist/types.d.ts

@@ -0,0 +1,104 @@
+export declare type Event = {
+    name: string;
+    params: Record<AllowedTypes, AllowedTypes>;
+};
+export declare 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[];
+};
+export declare type EventNameInfo = {
+    eventName: string;
+    description?: string;
+    actionPrefix: string;
+    globalAppEvent: string;
+    previousGlobalAppEvent?: string;
+};
+export declare type AllowedTypes = string | number;
+export declare type TrackAnalyticsEventOptions = {
+    data: Record<AllowedTypes, AllowedTypes>;
+    eventNameInfo: EventNameInfo;
+    analyticsType: string;
+    userDataToHashKeyArray: Array<string> | null;
+    dataLayerCheck: boolean;
+    consoleLogData?: object;
+};
+export declare type GlobalVars = {
+    app: string;
+    device_category?: string | undefined;
+    device_os?: string | undefined;
+    device_browser?: string | undefined;
+};
+export declare type DataLayer = {
+    event: string;
+    globalVars: GlobalVars;
+    journeyProps: Record<any, any>;
+    userProps: Record<any, any>;
+};
+export declare type ConsoleLogData = {
+    showGlobalVars?: boolean;
+    showJourneyPropsPayload?: boolean;
+    showUserProps?: boolean;
+};
+export interface AnalyticsTrackerDataOptions {
+    consoleLogData: ConsoleLogData | null;
+    data: Record<any, any>;
+    eventName: string;
+    globalAppEvent: string;
+    userDetails: Record<any, any>;
+}
+export interface HandleDataLayerPushOptions extends AnalyticsTrackerDataOptions {
+    dataLayerCheck: boolean;
+}
+export declare type Ga4GoogleAnalyticsEventTracking = AnalyticsTrackerDataOptions;
+export declare type Platform = 'GOOGLE' | 'FACEBOOK' | 'DATALAYER_PUSH';
+export declare type AnalyticsPlatform = {
+    [key in Platform]: Platform;
+};
+export declare type Tokens = {
+    IP_INFO_TOKEN?: string;
+    GA4_PUBLIC_API_SECRET?: string;
+    GA4_PUBLIC_MEASUREMENT_ID?: string;
+};
+export declare 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>;
+};
+export declare type BuildConfigOptions = {
+    appName: string;
+    appSessionCookieName: string;
+    eventActionPrefix?: Record<string, string>;
+    globalEventActionList?: Record<string, string>;
+    includeUserKeys?: Array<string> | undefined;
+    showMissingUserAttributesInConsole?: boolean;
+    TOKENS?: Tokens;
+    withDeviceInfo?: boolean;
+    withServerLocationInfo?: boolean;
+};
+export declare let config: Config;
+export declare type ProviderStateProps = {
+    appName: string;
+    appSessionCookieName: string;
+    analyticsPlatform: AnalyticsPlatform;
+    eventActionPrefixList: Record<string, string>;
+    analyticsGlobalEventActionList: Record<string, string>;
+};
+export declare type ProviderApiProps = {
+    trackAnalyticsEvent: (options: TrackAnalyticsEventOptions) => Promise<void>;
+    showMeBuildInAnalyticsPlatform: () => void;
+    showMeBuildInEventActionPrefixList: () => void;
+    showMeBuildInGlobalEventActionList: () => void;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-marketing-tools",
-  "version": "0.2.8",
+  "version": "0.3.0",
   "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": [

package/dist/lib/buildConfig/types.d.ts

@@ -1,28 +0,0 @@
-export declare type Platform = Record<string, string>;
-export declare type Tokens = {
-    IP_INFO_TOKEN?: string;
-    GA4_PUBLIC_API_SECRET?: string;
-    GA4_PUBLIC_MEASUREMENT_ID?: string;
-};
-export declare 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>;
-};
-export declare type BuildConfigOptions = {
-    appName: string;
-    appSessionCookieName: string;
-    eventActionPrefix: Record<string, string>;
-    globalEventActionList: Record<string, string>;
-    includeUserKeys: Array<string>;
-    showMissingUserAttributesInConsole: boolean | undefined;
-    TOKENS?: Tokens;
-    withDeviceInfo: boolean | undefined;
-    withServerLocationInfo: boolean | undefined;
-};

package/dist/lib/index.d.ts

@@ -1,25 +0,0 @@
-import { ReactNode, Context } from 'react';
-import { ProviderApiProps, ProviderStateProps } from './types';
-export { buildConfig, analyticsPlatform } 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;

package/dist/lib/types.d.ts

@@ -1,14 +0,0 @@
-import { Platform, TrackAnalyticsEventOptions } from '..';
-export declare type ProviderStateProps = {
-    appName: string;
-    appSessionCookieName: string;
-    analyticsPlatform: Platform;
-    eventActionPrefixList: Record<string, string>;
-    analyticsGlobalEventActionList: Record<string, string>;
-};
-export declare type ProviderApiProps = {
-    trackAnalyticsEvent: (options: TrackAnalyticsEventOptions) => Promise<void>;
-    showMeBuildInAnalyticsPlatform: () => void;
-    showMeBuildInEventActionPrefixList: () => void;
-    showMeBuildInGlobalEventActionList: () => void;
-};