Update Tealium initialisation to v2 TealiumConfig properties (#19)

* Update to v2 TealiumConfig properties

* Update CHANGELOG.md

* Update README

Co-authored-by: Soliman <soliman.achahbar@arhs-spikeseed.com>

Author: Soliman13

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+### Version 1.3.0
+    
+- BREAKING CHANGES
+    - We are not anymore supporting Tealium versions lower than 2.0.2.
+    
 ### Version 1.2.3
 
 - News

README.md

@@ -48,7 +48,7 @@ or
 |instabug-reactnative|:white_check_mark:| \>= 9.0.0
 |@adobe/react-native-acpanalytics|:white_check_mark:| \>= 1.1.6
 |@adobe/react-native-acpcore|:white_check_mark:| \>= 1.2.4
-|tealium-react-native|:white_check_mark:| \>= 1.0.10
+|tealium-react-native|:white_check_mark:| \>= 2.0.2
 
 ---
 

index.d.ts

@@ -1,7 +1,7 @@
 import { IInit } from './src/model';
 import { IInstabug } from './src/model/instabug';
 import { ISentry } from './src/model/sentry';
-import {ITealium} from "./src/model/tealium";
+import { ITealiumConfig } from './src/model/tealium';
 
 declare const DEBUG_LOG: number;
 declare const WARNING_LOG: number;
@@ -12,7 +12,7 @@ declare const init: (initConfig: IInit) => void;
 
 declare const setupReactotron: (config?: any, plugins?: Array<Function>) => any;
 
-declare const createTealiumLogger: (Tealium: any, config: ITealium, printLogs?: boolean) => Function;
+declare const createTealiumLogger: (Tealium: any, config: ITealiumConfig, printLogs?: boolean) => Function;
 declare const createAdobeLogger: (ACPAnalytics: any, ACPCore: any, printLogs?: boolean) => Function;
 declare const createFirebaseLogger: (analytics: any, printLogs?: boolean) => Function;
 declare const createCrashlyticsLogger: (crashlytics: any, printLogs?: boolean) => Function;

package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-native-logging-tools",
   "title": "React Native library created to ease logging",
-  "version": "1.2.3",
+  "version": "1.3.0",
   "main": "src/index.ts",
   "typings": "index.d.ts",
   "scripts": {
@@ -46,7 +46,7 @@
     "react-native-flipper": ">=0.50.0",
     "reactotron-react-native": ">=4.0.0",
     "reactotron-redux": ">=3.0.0",
-    "tealium-react-native": ">=1.0.10"
+    "tealium-react-native": ">=2.0.2"
   },
   "devDependencies": {
     "@babel/preset-typescript": "^7.8.3",

src/__tests__/index.spec.ts

@@ -1,22 +1,22 @@
 import {
-  init,
-  createSentryLogger,
-  createFirebaseLogger,
   createAdobeLogger,
-  createTealiumLogger,
-  logEvent,
   createCrashlyticsLogger,
-  recordError,
-  logWarningEvent,
-  logDebugEvent,
-  logNetworkEvent,
-  logErrorEvent,
+  createFirebaseLogger,
   createInstabugLogger,
+  createSentryLogger,
+  createTealiumLogger,
   DEBUG_LOG,
+  init,
+  logDebugEvent,
+  logErrorEvent,
+  logEvent,
+  logNetworkEvent,
+  logWarningEvent,
+  recordError,
 } from '../index';
 import * as Init from '../modules/init';
-import { ITealium } from '../model/tealium';
-import { log } from '../modules/events';
+import {Collectors, Dispatchers, ITealiumConfig} from '../model/tealium';
+import {log} from '../modules/events';
 
 describe('index test suite', () => {
   const useFlipperPlugin: boolean = true;
@@ -56,7 +56,14 @@ describe('index test suite', () => {
     initialize: jest.fn(),
     trackEvent: jest.fn(),
   };
-  const configTealium: ITealium = { account: 'accountName', profile: 'profileName', environment: 'environment' };
+  const configTealium: ITealiumConfig = {
+    collectors: [Collectors.Connectivity, Collectors.DeviceData],
+    dataSource: 'datasssource',
+    dispatchers: [Dispatchers.RemoteCommands, Dispatchers.Collect],
+    account: 'accountName',
+    profile: 'profileName',
+    environment: 'dev',
+  };
 
   const Reactotron = {
     configure: () => Reactotron,

src/model/tealium.ts

@@ -1,9 +1,38 @@
-export interface ITealium {
+export interface ITealiumConfig {
   account: string;
   profile: string;
-  environment: string;
-  iosDatasource?: string;
-  androidDatasource?: string;
-  instance?: string;
-  isLifecycleEnabled?: boolean;
+  environment: 'dev' | 'qa' | 'prod';
+  dataSource?: string;
+  collectors: Collectors[];
+  dispatchers: Dispatchers[];
+  customVisitorId?: string;
+  memoryReportingEnabled?: boolean;
+  overrideCollectURL?: string;
+  overrideCollectBatchURL?: string;
+  overrideCollectDomain?: string;
+  overrideLibrarySettingsURL?: string;
+  overrideTagManagementURL?: string;
+  deepLinkTrackingEnabled?: boolean;
+  qrTraceEnabled?: boolean;
+  loglevel?: 'dev' | 'qa' | 'prod' | 'silent';
+  consentLoggingEnabled?: boolean;
+  consentPolicy?: 'ccpa' | 'gdpr';
+  consentExpiry?: { time: number, unit: 'minutes' | 'hours' | 'months' | 'days' };
+  batchingEnabled?: boolean;
+  lifecycleAutotrackingEnabled?: boolean;
+  useRemoteLibrarySettings?: boolean;
+  visitorServiceEnabled?: boolean;
+}
+
+export enum Collectors {
+  AppData = 'AppData',
+  Connectivity = 'Connectivity',
+  DeviceData = 'DeviceData',
+  Lifecycle = 'Lifecycle',
+}
+
+export enum Dispatchers {
+  Collect = 'Collect',
+  TagManagement = 'TagManagement',
+  RemoteCommands = 'RemoteCommands',
 }

src/modules/loggers/tealium.ts

@@ -1,16 +1,8 @@
-import { ITealium } from '../../model/tealium';
+import { ITealiumConfig } from '../../model/tealium';
 import {excludeLogs, sendEventToFlipper} from '../init';
 
-export const createTealiumLogger = (Tealium: any, config: ITealium, printLogs: boolean = false) => {
-  Tealium.initialize(
-    config.account,
-    config.profile,
-    config.environment,
-    config.iosDatasource,
-    config.androidDatasource,
-    config.instance,
-    config.isLifecycleEnabled,
-  );
+export const createTealiumLogger = (Tealium: any, config: ITealiumConfig, printLogs: boolean = false) => {
+  Tealium.initialize(config);
   sendEventToFlipper('tealium', 'Tealium connected successfully');
   return (event: string, params: any, eventType: number) => {
     if (eventType !== -1 && excludeLogs && excludeLogs.tealium && excludeLogs.tealium.includes(eventType)) {