react-marketing-tools 0.4.3 → 0.4.4

package/dist/types/index.d.cts

@@ -0,0 +1,130 @@
+export interface AnalyticsEventActionPrefix extends Record<string, string> {
+}
+export interface AnalyticsGlobalEventAction extends Record<string, string> {
+}
+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;
+    userDataKeysToHashArray?: 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: AnalyticsEventActionPrefix;
+    analyticsGlobalEventActionList: AnalyticsGlobalEventAction;
+};
+export type BuildConfigOptions = {
+    appName: string;
+    appSessionCookieName: string;
+    eventActionPrefix?: AnalyticsEventActionPrefix;
+    globalEventActionList?: AnalyticsGlobalEventAction;
+    includeUserKeys?: Array<string> | undefined;
+    showMissingUserAttributesInConsole?: boolean;
+    showMeBuildInEventActionPrefixList?: boolean;
+    TOKENS?: Tokens;
+    withDeviceInfo?: boolean;
+    withServerLocationInfo?: boolean;
+};
+export declare let config: Config;
+export type ProviderStateProps = {
+    appName: string;
+    appSessionCookieName: string;
+    analyticsPlatform: AnalyticsPlatform;
+    eventActionPrefixList: AnalyticsEventActionPrefix;
+    analyticsGlobalEventActionList: AnalyticsGlobalEventAction;
+};
+export type ProviderApiProps = {
+    trackAnalyticsEvent: (options: TrackAnalyticsEventOptions) => Promise<void>;
+    showMeBuildInAnalyticsPlatform: () => void;
+    showMeBuildInEventActionPrefixList: () => void;
+    showMeBuildInGlobalEventActionList: () => void;
+};

package/dist/utilities/assertValueCheckers.d.cts

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

package/dist/utilities/assertValueCheckers.d.ts

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

package/dist/utilities/commonFunctions.d.cts

@@ -0,0 +1,5 @@
+export declare const isClientSide: () => boolean;
+export declare const objectHasAttributes: (obj: object, 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/commonFunctions.d.ts

@@ -0,0 +1,5 @@
+export declare const isClientSide: () => boolean;
+export declare const objectHasAttributes: (obj: object, 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.cts

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

package/dist/utilities/cookies.d.ts

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

package/package.json

@@ -1,25 +1,20 @@
 {
   "name": "react-marketing-tools",
   "type": "module",
-  "version": "0.4.3",
+  "version": "0.4.4",
   "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/)",
   "homepage": "https://www.heyrory.com/",
   "repository": {
     "type": "git",
-    "url": "https://github.com/bronz3beard/react-marketing-tools"
+    "url": "git+https://github.com/bronz3beard/react-marketing-tools.git"
   },
   "bugs": {
     "url": "https://github.com/bronz3beard/react-marketing-tools/issues"
   },
   "files": [
-    "./dist/index.d.ts",
-    "./dist/types/index.d.ts",
-    "./dist/manifest.json",
-    "./dist/react-marketing-tools.es.js",
-    "./dist/react-marketing-tools.umd.js",
-    "./README.md"
+    "dist"
   ],
   "keywords": [
     "javascript",
@@ -34,23 +29,35 @@
     "pixel",
     "dataLayer"
   ],
-  "main": "./dist/react-marketing-tools.umd.js",
+  "main": "./dist/react-marketing-tools.umd.cjs",
   "module": "./dist/react-marketing-tools.es.js",
   "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"
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/react-marketing-tools.es.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/react-marketing-tools.umd.cjs"
+      }
     }
   },
+  "sideEffects": false,
   "scripts": {
-    "dev": "vite",
-    "build": "tsc && vite build",
-    "build:watch": "tsc && vite build --watch",
-    "preview": "vite preview",
+    "build": "vite build && tsc -p tsconfig.build.json && node scripts/emit-cts-types.mjs && node scripts/copy-legacy-umd.mjs",
+    "build:watch": "vite build --watch",
+    "check:package": "publint --strict && attw --pack .",
+    "check:size": "node scripts/check-size.mjs",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "lint": "eslint .",
     "mock:publish": "npm pack --dry-run",
-    "check-types": "tsc --noEmit --pretty"
+    "prepublishOnly": "npm run build && npm run check:size",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit"
   },
   "browserslist": {
     "production": [
@@ -64,36 +71,30 @@
       "last 1 safari version"
     ]
   },
-  "eslintConfig": {
-    "env": {
-      "browser": true,
-      "node": true,
-      "es2020": true
-    },
-    "extends": [
-      "eslint:recommended",
-      "plugin:react/recommended"
-    ],
-    "parserOptions": {
-      "sourceType": "module"
-    }
-  },
   "dependencies": {
-    "device-detector-js": "^3.0.3",
-    "prop-types": "^15.8.1"
+    "device-detector-js": "^3.0.3"
+  },
+  "peerDependencies": {
+    "react": ">=17.0.0"
   },
   "devDependencies": {
-    "@types/node": "^18.11.18",
-    "@types/react": "^18.0.26",
-    "@types/react-dom": "^18.0.10",
-    "@vitejs/plugin-react": "^2.0.0",
-    "eslint": "^8.21.0",
-    "eslint-plugin-react": "^7.30.1",
-    "prettier": "^2.7.1",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "typescript": "^5.3.3",
-    "vite": "^5.0.10",
-    "vite-plugin-dts": "^1.7.1"
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@types/node": "^22.20.4",
+    "@types/react": "^19.3.0",
+    "@types/react-dom": "^19.3.0",
+    "@typescript/native": "npm:typescript@^7.0.2",
+    "@eslint/js": "^10.0.1",
+    "eslint": "^10.11.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-react-hooks": "^7.1.1",
+    "jsdom": "^30.1.0",
+    "prettier": "^3.9.8",
+    "publint": "^0.3.24",
+    "react": "^19.3.0",
+    "react-dom": "^19.3.0",
+    "typescript": "npm:@typescript/typescript6@^6.0.2",
+    "typescript-eslint": "^8.70.0",
+    "vite": "^8.3.0",
+    "vitest": "^5.0.1"
   }
 }