react-marketing-tools 0.4.3 → 0.4.4

package/dist/analytics/analyticsEventService.d.cts

@@ -0,0 +1,13 @@
+import { TrackAnalyticsEventOptions } from '../types/index.cjs';
+/**
+ *
+ * @paramType {object} options
+ * @property {object} data this is an object of any data you want to collect in analytics
+ * @property {object} eventNameInfo
+ * @property {string} analyticsType
+ * @property {array | undefined} userDataKeysToHashArray default for this value is null, when used it should include an array of strings you wish to hash.
+ * @property {boolean} dataLayerCheck
+ * @property {object} consoleLogData (optional) is an object with the following attributes, "showGlobalVars", "showJourneyPropsPayload", "showUserProps" if any of the values are true you will be able to see the respective payload in your console.
+ */
+declare const trackAnalyticsEvent: (options: TrackAnalyticsEventOptions) => Promise<void>;
+export { trackAnalyticsEvent };

package/dist/analytics/analyticsEventService.d.ts

@@ -0,0 +1,13 @@
+import { TrackAnalyticsEventOptions } from '../types/index.js';
+/**
+ *
+ * @paramType {object} options
+ * @property {object} data this is an object of any data you want to collect in analytics
+ * @property {object} eventNameInfo
+ * @property {string} analyticsType
+ * @property {array | undefined} userDataKeysToHashArray default for this value is null, when used it should include an array of strings you wish to hash.
+ * @property {boolean} dataLayerCheck
+ * @property {object} consoleLogData (optional) is an object with the following attributes, "showGlobalVars", "showJourneyPropsPayload", "showUserProps" if any of the values are true you will be able to see the respective payload in your console.
+ */
+declare const trackAnalyticsEvent: (options: TrackAnalyticsEventOptions) => Promise<void>;
+export { trackAnalyticsEvent };

package/dist/analytics/ga4GoogleAnalyticsEventTracking.d.cts

@@ -0,0 +1,3 @@
+import { Ga4GoogleAnalyticsEventTracking } from '../types';
+declare const ga4GoogleAnalyticsEventTracking: (options: Ga4GoogleAnalyticsEventTracking) => Promise<void>;
+export default ga4GoogleAnalyticsEventTracking;

package/dist/analytics/ga4GoogleAnalyticsEventTracking.d.ts

@@ -0,0 +1,3 @@
+import { Ga4GoogleAnalyticsEventTracking } from '../types';
+declare const ga4GoogleAnalyticsEventTracking: (options: Ga4GoogleAnalyticsEventTracking) => Promise<void>;
+export default ga4GoogleAnalyticsEventTracking;

package/dist/analytics/handleDataLayerPush.d.cts

@@ -0,0 +1,3 @@
+import { HandleDataLayerPushOptions } from '../types';
+declare const handleDataLayerPush: (options: HandleDataLayerPushOptions) => Promise<void>;
+export default handleDataLayerPush;

package/dist/analytics/handleDataLayerPush.d.ts

@@ -0,0 +1,3 @@
+import { HandleDataLayerPushOptions } from '../types';
+declare const handleDataLayerPush: (options: HandleDataLayerPushOptions) => Promise<void>;
+export default handleDataLayerPush;

package/dist/analytics/helpers.d.cts

@@ -0,0 +1,41 @@
+import DeviceDetector from 'device-detector-js';
+import { AllowedTypes, EventNameInfo } from '../types';
+/**
+ *
+ * @param {object} user the structure of this data is dictated by you, aka your API or DB.
+ * @param {[string]} includeUserKeys is an array of strings that represent keys from your user data that you want to whitelist, the value for each key in the whitelist will be hashed.
+ * @returns a new user object with all values hashed including only the whitelisted key value pairs
+ */
+export declare const hashUserData: (user: Record<AllowedTypes, AllowedTypes>, includeUserKeys: Array<string>) => Promise<Record<AllowedTypes, AllowedTypes>>;
+/**
+ *
+ * @param {object} user the structure of this data is dictated by you, aka your API or DB.
+ * @param {[string]} includeUserKeys is an array of strings that represent keys from your user data that you want to map over, if no keys are supplied the original passed in user data is returned.
+ * @param {boolean} showMissingUserAttributesInConsole a boolean condition to show or hide "user" attributes that are not included in the "includeUserKeys" array, by console logging in dev tools.
+ * @returns If no "includeUserKeys" are supplied the original ser object is returned, otherwise, a new user object with only the key value pairs that you included in your includeUserKeys array is returned.
+ */
+export declare const buildNewUserData: (user: Record<AllowedTypes, AllowedTypes>, includeUserKeys: Array<string>, showMissingUserAttributesInConsole: boolean | undefined) => Record<string, string>;
+/**
+ *
+ * @paramType {Object} eventNameInfo
+ * @property {analyticsPrefixActionList} actionPrefix either a built in value of JOURNEY | INTERACTION or a custom value added to the analyticsPrefixActionList object.
+ * @property {string} description an OPTIONAL value passed in that is formatted like the following from 'Very descriptive description' to VERY_DESCRIPTIVE_DESCRIPTION.
+ * @property {string} globalAppEvent the current event name for this track event selected from the analyticsGlobalEventActionList
+ * @property {string} previousGlobalAppEvent an OPTIONAL value, the previous event name for this track event selected from the analyticsGlobalEventActionList.
+ * @returns string eventName for this specific tracked event
+ */
+export declare const buildAnalyticsEventName: (eventNameInfo: EventNameInfo) => string;
+/**
+ *
+ * @param {object} data
+ * @param {string} globalAppEvent
+ * @returns dataObject
+ */
+export declare const buildEventDataObject: (data: Record<AllowedTypes, AllowedTypes>, globalAppEvent: string) => Promise<Record<AllowedTypes, AllowedTypes>>;
+/**
+ *
+ * @param {string} eventName
+ * @returns a Boolean value, true if the event name is already in the dataLayer.
+ */
+export declare const defaultDataLayerEventCheck: (eventName: string) => boolean;
+export declare const deviceDetectorInfo: (userAgent: string) => DeviceDetector.DeviceDetectorResult;

package/dist/analytics/helpers.d.ts

@@ -0,0 +1,41 @@
+import DeviceDetector from 'device-detector-js';
+import { AllowedTypes, EventNameInfo } from '../types';
+/**
+ *
+ * @param {object} user the structure of this data is dictated by you, aka your API or DB.
+ * @param {[string]} includeUserKeys is an array of strings that represent keys from your user data that you want to whitelist, the value for each key in the whitelist will be hashed.
+ * @returns a new user object with all values hashed including only the whitelisted key value pairs
+ */
+export declare const hashUserData: (user: Record<AllowedTypes, AllowedTypes>, includeUserKeys: Array<string>) => Promise<Record<AllowedTypes, AllowedTypes>>;
+/**
+ *
+ * @param {object} user the structure of this data is dictated by you, aka your API or DB.
+ * @param {[string]} includeUserKeys is an array of strings that represent keys from your user data that you want to map over, if no keys are supplied the original passed in user data is returned.
+ * @param {boolean} showMissingUserAttributesInConsole a boolean condition to show or hide "user" attributes that are not included in the "includeUserKeys" array, by console logging in dev tools.
+ * @returns If no "includeUserKeys" are supplied the original ser object is returned, otherwise, a new user object with only the key value pairs that you included in your includeUserKeys array is returned.
+ */
+export declare const buildNewUserData: (user: Record<AllowedTypes, AllowedTypes>, includeUserKeys: Array<string>, showMissingUserAttributesInConsole: boolean | undefined) => Record<string, string>;
+/**
+ *
+ * @paramType {Object} eventNameInfo
+ * @property {analyticsPrefixActionList} actionPrefix either a built in value of JOURNEY | INTERACTION or a custom value added to the analyticsPrefixActionList object.
+ * @property {string} description an OPTIONAL value passed in that is formatted like the following from 'Very descriptive description' to VERY_DESCRIPTIVE_DESCRIPTION.
+ * @property {string} globalAppEvent the current event name for this track event selected from the analyticsGlobalEventActionList
+ * @property {string} previousGlobalAppEvent an OPTIONAL value, the previous event name for this track event selected from the analyticsGlobalEventActionList.
+ * @returns string eventName for this specific tracked event
+ */
+export declare const buildAnalyticsEventName: (eventNameInfo: EventNameInfo) => string;
+/**
+ *
+ * @param {object} data
+ * @param {string} globalAppEvent
+ * @returns dataObject
+ */
+export declare const buildEventDataObject: (data: Record<AllowedTypes, AllowedTypes>, globalAppEvent: string) => Promise<Record<AllowedTypes, AllowedTypes>>;
+/**
+ *
+ * @param {string} eventName
+ * @returns a Boolean value, true if the event name is already in the dataLayer.
+ */
+export declare const defaultDataLayerEventCheck: (eventName: string) => boolean;
+export declare const deviceDetectorInfo: (userAgent: string) => DeviceDetector.DeviceDetectorResult;

package/dist/buildConfig/index.d.cts

@@ -0,0 +1,8 @@
+import { BuildConfigOptions, Config, AnalyticsPlatform } from '../types/index.cjs';
+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/buildConfig/index.d.ts

@@ -0,0 +1,8 @@
+import { BuildConfigOptions, Config, AnalyticsPlatform } from '../types/index.js';
+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.cts

@@ -0,0 +1,26 @@
+import { ReactElement, ReactNode, Context } from 'react';
+import type { ProviderStateProps, ProviderApiProps } from './types/index.cjs';
+export type { Event, GooglePayload, EventNameInfo, AllowedTypes, TrackAnalyticsEventOptions, GlobalVars, DataLayer, ConsoleLogData, AnalyticsTrackerDataOptions, HandleDataLayerPushOptions, ServerLocationData, IpInfo, Ga4GoogleAnalyticsEventTracking, Platform, AnalyticsPlatform, Tokens, Config, BuildConfigOptions, ProviderStateProps, ProviderApiProps, AnalyticsEventActionPrefix, AnalyticsGlobalEventAction, } from './types/index.cjs';
+export { config, analyticsPlatform, buildConfig, showMeBuildInAnalyticsPlatform, showMeBuildInGlobalEventActionList, showMeBuildInEventActionPrefixList, } from './buildConfig/index.cjs';
+export { trackAnalyticsEvent } from './analytics/analyticsEventService.cjs';
+export declare const ContextState: Context<ProviderStateProps>;
+export declare const ContextApi: Context<ProviderApiProps>;
+type ReactMarketingProviderProps = {
+    children: ReactNode;
+};
+export declare const ReactMarketingProvider: ({ children, }: ReactMarketingProviderProps) => ReactElement;
+/**
+ * @property {string} appName
+ * @property {string} appSessionCookieName
+ * @property {AnalyticsPlatform} analyticsPlatform
+ * @property {AnalyticsEventActionPrefix} eventActionPrefixList
+ * @property {AnalyticsGlobalEventAction} 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/index.d.ts

@@ -1,14 +1,14 @@
-import { ReactNode, Context } from 'react';
-import type { ProviderStateProps, ProviderApiProps } from './types';
-export type { Event, GooglePayload, EventNameInfo, AllowedTypes, TrackAnalyticsEventOptions, GlobalVars, DataLayer, ConsoleLogData, AnalyticsTrackerDataOptions, HandleDataLayerPushOptions, ServerLocationData, IpInfo, Ga4GoogleAnalyticsEventTracking, Platform, AnalyticsPlatform, Tokens, Config, BuildConfigOptions, ProviderStateProps, ProviderApiProps, AnalyticsEventActionPrefix, AnalyticsGlobalEventAction, } from './types';
-export { config, analyticsPlatform, buildConfig, showMeBuildInAnalyticsPlatform, showMeBuildInGlobalEventActionList, showMeBuildInEventActionPrefixList, } from './buildConfig';
-export { trackAnalyticsEvent } from './analytics/analyticsEventService';
+import { ReactElement, ReactNode, Context } from 'react';
+import type { ProviderStateProps, ProviderApiProps } from './types/index.js';
+export type { Event, GooglePayload, EventNameInfo, AllowedTypes, TrackAnalyticsEventOptions, GlobalVars, DataLayer, ConsoleLogData, AnalyticsTrackerDataOptions, HandleDataLayerPushOptions, ServerLocationData, IpInfo, Ga4GoogleAnalyticsEventTracking, Platform, AnalyticsPlatform, Tokens, Config, BuildConfigOptions, ProviderStateProps, ProviderApiProps, AnalyticsEventActionPrefix, AnalyticsGlobalEventAction, } from './types/index.js';
+export { config, analyticsPlatform, buildConfig, showMeBuildInAnalyticsPlatform, showMeBuildInGlobalEventActionList, showMeBuildInEventActionPrefixList, } from './buildConfig/index.js';
+export { trackAnalyticsEvent } from './analytics/analyticsEventService.js';
 export declare const ContextState: Context<ProviderStateProps>;
 export declare const ContextApi: Context<ProviderApiProps>;
 type ReactMarketingProviderProps = {
     children: ReactNode;
 };
-export declare const ReactMarketingProvider: ({ children, }: ReactMarketingProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const ReactMarketingProvider: ({ children, }: ReactMarketingProviderProps) => ReactElement;
 /**
  * @property {string} appName
  * @property {string} appSessionCookieName

package/dist/ipInfo/index.d.cts

@@ -0,0 +1,3 @@
+import { IpInfo, ServerLocationData } from '../types';
+export declare const buildServerLocationData: (withServerLocationInfo: boolean | undefined, IP_INFO_TOKEN: string | undefined) => Promise<ServerLocationData | undefined>;
+export declare const getIpInfo: (IP_INFO_TOKEN: string) => Promise<IpInfo>;

package/dist/ipInfo/index.d.ts

@@ -0,0 +1,3 @@
+import { IpInfo, ServerLocationData } from '../types';
+export declare const buildServerLocationData: (withServerLocationInfo: boolean | undefined, IP_INFO_TOKEN: string | undefined) => Promise<ServerLocationData | undefined>;
+export declare const getIpInfo: (IP_INFO_TOKEN: string) => Promise<IpInfo>;