react-marketing-tools 0.3.5 → 0.3.7

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { ReactNode, Context } from 'react';
 import type { ProviderStateProps, ProviderApiProps } from './types';
+export * from './types';
 export { config, analyticsPlatform, buildConfig, showMeBuildInAnalyticsPlatform, showMeBuildInGlobalEventActionList, showMeBuildInEventActionPrefixList, } from './buildConfig';
 export { trackAnalyticsEvent } from './analytics/analyticsEventService';
 export declare const ContextState: Context<ProviderStateProps>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-marketing-tools",
   "type": "module",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "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/)",
@@ -14,10 +14,10 @@
     "url": "https://github.com/bronz3beard/react-marketing-tools/issues"
   },
   "files": [
-    "./dist",
+    "./dist/index.d.ts",
     "./dist/manifest.json",
-    "./dist/react-data-matrix.es.js",
-    "./dist/react-data-matrix.umd.js",
+    "./dist/react-marketing-tools.es.js",
+    "./dist/react-marketing-tools.umd.js",
     "./README.md"
   ],
   "keywords": [
@@ -38,6 +38,7 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/react-marketing-tools.es.js",
       "require": "./dist/react-marketing-tools.umd.js"
     }

package/dist/.vite/manifest.json

@@ -1,7 +0,0 @@
-{
-  "lib/index.tsx": {
-    "file": "react-marketing-tools.umd.js",
-    "isEntry": true,
-    "src": "lib/index.tsx"
-  }
-}

package/dist/analytics/analyticsEventService.d.ts

@@ -1,13 +0,0 @@
-import { TrackAnalyticsEventOptions } from '../types';
-/**
- *
- * @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} userDataToHashKeyArray 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.ts

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

package/dist/analytics/handleDataLayerPush.d.ts

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

package/dist/analytics/helpers.d.ts

@@ -1,41 +0,0 @@
-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.ts

@@ -1,8 +0,0 @@
-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/ipInfo/index.d.ts

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

package/dist/types/index.d.ts

@@ -1,125 +0,0 @@
-export type Event = {
-    name: string;
-    params: Record<AllowedTypes, AllowedTypes>;
-};
-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[];
-};
-export type EventNameInfo = {
-    eventName: string;
-    description?: string;
-    actionPrefix: string;
-    globalAppEvent: string;
-    previousGlobalAppEvent?: string;
-};
-export type AllowedTypes = string | number;
-export type TrackAnalyticsEventOptions = {
-    data: Record<AllowedTypes, AllowedTypes>;
-    eventNameInfo: EventNameInfo;
-    analyticsType: string;
-    userDataToHashKeyArray: Array<string> | null;
-    dataLayerCheck: boolean;
-    consoleLogData?: object;
-};
-export type GlobalVars = {
-    app: string;
-    device_category?: string | undefined;
-    device_os?: string | undefined;
-    device_browser?: string | undefined;
-};
-export type DataLayer = {
-    event: string;
-    globalVars: GlobalVars;
-    journeyProps: Record<any, any>;
-    userProps: Record<any, any>;
-};
-export 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 type ServerLocationData = {
-    SERVER_CITY: string;
-    SERVER_COUNTRY: string;
-    SERVER_HOSTNAME: string;
-    SERVER_IP: string;
-    SERVER_LOCATION: string;
-    SERVER_POSTAL: string;
-    SERVER_REGION: string;
-    SERVER_TIMEZONE: string;
-};
-export type IpInfo = {
-    city: string;
-    country: string;
-    SERVER_HOSTNAME: string;
-    hostname: string;
-    ip: string;
-    loc: string;
-    postal: string;
-    region: string;
-    timezone: string;
-};
-export type Ga4GoogleAnalyticsEventTracking = AnalyticsTrackerDataOptions;
-export type Platform = 'GOOGLE' | 'FACEBOOK' | 'DATALAYER_PUSH';
-export type AnalyticsPlatform = {
-    [key in Platform]: Platform;
-};
-export type Tokens = {
-    IP_INFO_TOKEN?: string;
-    GA4_PUBLIC_API_SECRET?: string;
-    GA4_PUBLIC_MEASUREMENT_ID?: string;
-};
-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>;
-};
-export 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 type ProviderStateProps = {
-    appName: string;
-    appSessionCookieName: string;
-    analyticsPlatform: AnalyticsPlatform;
-    eventActionPrefixList: Record<string, string>;
-    analyticsGlobalEventActionList: Record<string, string>;
-};
-export type ProviderApiProps = {
-    trackAnalyticsEvent: (options: TrackAnalyticsEventOptions) => Promise<void>;
-    showMeBuildInAnalyticsPlatform: () => void;
-    showMeBuildInEventActionPrefixList: () => void;
-    showMeBuildInGlobalEventActionList: () => void;
-};

package/dist/utilities/assertValueCheckers.d.ts

@@ -1 +0,0 @@
-export declare const assertIsTrue: (condition: boolean, errorMessage?: string) => void;

package/dist/utilities/commonFunctions.d.ts

@@ -1,5 +0,0 @@
-export declare const isClientSide: () => boolean;
-export declare const objectHasAttributes: (obj: Record<any, any>, key?: string) => boolean;
-export declare const replaceWhiteSpace: (stringValue: string, replaceValue: string) => string;
-export declare const checkAllArrayValuesReturnTrue: (valueArray: boolean[]) => boolean;
-export declare const hashString: (value: string) => Promise<string>;

package/dist/utilities/cookies.d.ts

@@ -1 +0,0 @@
-export declare const getCookieValueByName: (name: string) => string | undefined;