@snowplow/react-native-tracker 1.4.0 → 2.0.0

package/lib/module/constants.js

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2020-2023 Snowplow Analytics Ltd. All rights reserved.
+ *
+ * This program is licensed to you under the Apache License Version 2.0,
+ * and you may not use this file except in compliance with the Apache License Version 2.0.
+ * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the Apache License Version 2.0 is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
+ */
+
+'use strict';
+
+const logMessages = {
+  // configuration errors
+  namespace: 'namespace parameter is required to be set',
+  endpoint: 'endpoint parameter is required to be set',
+  network: 'networkConfig is invalid',
+  tracker: 'trackerConfig is invalid',
+  session: 'sessionConfig is invalid',
+  emitter: 'emitterConfig is invalid',
+  subject: 'subjectConfig is invalid',
+  gdpr: 'gdprConfig is invalid',
+  gc: 'gcConfig is invalid',
+  // event errors
+  context: 'invalid contexts parameter',
+  selfDesc: 'selfDescribing event requires schema and data parameters to be set',
+  evType: 'event argument can only be an object',
+  screenViewReq: 'screenView event requires name as string parameter to be set',
+  structuredReq: 'structured event requires category and action parameters to be set',
+  pageviewReq: 'pageView event requires pageUrl parameter to be set',
+  timingReq: 'timing event requires category, variable and timing parameters to be set',
+  consentGReq: 'consentGranted event requires expiry, documentId and version parameters to be set',
+  consentWReq: 'consentWithdrawn event requires all, documentId and version parameters to be set',
+  ecomReq: 'ecommerceTransaction event requires orderId, totalValue to be set and items to be an array of valid ecommerceItems',
+  deepLinkReq: 'deepLinkReceived event requires the url parameter to be set',
+  messageNotificationReq: 'messageNotification event requires title, body, and trigger parameters to be set',
+  // global contexts errors
+  gcTagType: 'tag argument is required to be a string',
+  gcType: 'global context argument is invalid',
+  // api error prefix
+  createTracker: 'createTracker:',
+  removeTracker: 'removeTracker: trackerNamespace can only be a string',
+  // methods
+  trackSelfDesc: 'trackSelfDescribingEvent:',
+  trackScreenView: 'trackScreenViewEvent:',
+  trackStructured: 'trackStructuredEvent:',
+  trackPageView: 'trackPageViewEvent:',
+  trackTiming: 'trackTimingEvent:',
+  trackConsentGranted: 'trackConsentGranted:',
+  trackConsentWithdrawn: 'trackConsentWithdrawn:',
+  trackEcommerceTransaction: 'trackEcommerceTransaction:',
+  trackDeepLinkReceived: 'trackDeepLinkReceivedEvent:',
+  trackMessageNotification: 'trackMessageNotificationEvent:',
+  removeGlobalContexts: 'removeGlobalContexts:',
+  addGlobalContexts: 'addGlobalContexts:',
+  // setters
+  setUserId: 'setUserId: userId can only be a string or null',
+  setNetworkUserId: 'setNetworkUserId: networkUserId can only be a string(UUID) or null',
+  setDomainUserId: 'setDomainUserId: domainUserId can only be a string(UUID) or null',
+  setIpAddress: 'setIpAddress: ipAddress can only be a string or null',
+  setUseragent: 'setUseragent: useragent can only be a string or null',
+  setTimezone: 'setTimezone: timezone can only be a string or null',
+  setLanguage: 'setLanguage: language can only be a string or null',
+  setScreenResolution: 'setScreenResolution: screenResolution can only be of ScreenSize type or null',
+  setScreenViewport: 'setScreenViewport: screenViewport can only be of ScreenSize type or null',
+  setColorDepth: 'setColorDepth: colorDepth can only be a number(integer) or null',
+  setSubjectData: 'setSubjectData:'
+};
+const schemas = {
+  payloadData: 'iglu:com.snowplowanalytics.snowplow/payload_data/jsonschema/1-0-4',
+  timingSchema: 'iglu:com.snowplowanalytics.snowplow/timing/jsonschema/1-0-0',
+  deepLinkReceivedSchema: 'iglu:com.snowplowanalytics.mobile/deep_link_received/jsonschema/1-0-0',
+  messageNotificationSchema: 'iglu:com.snowplowanalytics.mobile/message_notification/jsonschema/1-0-0',
+  screenViewSchema: 'iglu:com.snowplowanalytics.mobile/screen_view/jsonschema/1-0-0'
+};
+export { logMessages, schemas };
+//# sourceMappingURL=constants.js.map

package/lib/module/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["logMessages","namespace","endpoint","network","tracker","session","emitter","subject","gdpr","gc","context","selfDesc","evType","screenViewReq","structuredReq","pageviewReq","timingReq","consentGReq","consentWReq","ecomReq","deepLinkReq","messageNotificationReq","gcTagType","gcType","createTracker","removeTracker","trackSelfDesc","trackScreenView","trackStructured","trackPageView","trackTiming","trackConsentGranted","trackConsentWithdrawn","trackEcommerceTransaction","trackDeepLinkReceived","trackMessageNotification","removeGlobalContexts","addGlobalContexts","setUserId","setNetworkUserId","setDomainUserId","setIpAddress","setUseragent","setTimezone","setLanguage","setScreenResolution","setScreenViewport","setColorDepth","setSubjectData","schemas","payloadData","timingSchema","deepLinkReceivedSchema","messageNotificationSchema","screenViewSchema"],"sourceRoot":"../../src","sources":["constants.ts"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,YAAY;;AAEZ,MAAMA,WAAW,GAAG;EAClB;EACAC,SAAS,EAAE,2CAA2C;EACtDC,QAAQ,EAAE,0CAA0C;EACpDC,OAAO,EAAE,0BAA0B;EACnCC,OAAO,EAAE,0BAA0B;EACnCC,OAAO,EAAE,0BAA0B;EACnCC,OAAO,EAAE,0BAA0B;EACnCC,OAAO,EAAE,0BAA0B;EACnCC,IAAI,EAAE,uBAAuB;EAC7BC,EAAE,EAAE,qBAAqB;EAEzB;EACAC,OAAO,EAAE,4BAA4B;EACrCC,QAAQ,EACN,oEAAoE;EACtEC,MAAM,EAAE,sCAAsC;EAC9CC,aAAa,EAAE,8DAA8D;EAC7EC,aAAa,EACX,oEAAoE;EACtEC,WAAW,EAAE,qDAAqD;EAClEC,SAAS,EACP,0EAA0E;EAC5EC,WAAW,EACT,mFAAmF;EACrFC,WAAW,EACT,kFAAkF;EACpFC,OAAO,EACL,oHAAoH;EACtHC,WAAW,EAAE,6DAA6D;EAC1EC,sBAAsB,EACpB,kFAAkF;EAEpF;EACAC,SAAS,EAAE,yCAAyC;EACpDC,MAAM,EAAE,oCAAoC;EAE5C;EACAC,aAAa,EAAE,gBAAgB;EAC/BC,aAAa,EAAE,sDAAsD;EAErE;EACAC,aAAa,EAAE,2BAA2B;EAC1CC,eAAe,EAAE,uBAAuB;EACxCC,eAAe,EAAE,uBAAuB;EACxCC,aAAa,EAAE,qBAAqB;EACpCC,WAAW,EAAE,mBAAmB;EAChCC,mBAAmB,EAAE,sBAAsB;EAC3CC,qBAAqB,EAAE,wBAAwB;EAC/CC,yBAAyB,EAAE,4BAA4B;EACvDC,qBAAqB,EAAE,6BAA6B;EACpDC,wBAAwB,EAAE,gCAAgC;EAC1DC,oBAAoB,EAAE,uBAAuB;EAC7CC,iBAAiB,EAAE,oBAAoB;EAEvC;EACAC,SAAS,EAAE,gDAAgD;EAC3DC,gBAAgB,EACd,oEAAoE;EACtEC,eAAe,EACb,kEAAkE;EACpEC,YAAY,EAAE,sDAAsD;EACpEC,YAAY,EAAE,sDAAsD;EACpEC,WAAW,EAAE,oDAAoD;EACjEC,WAAW,EAAE,oDAAoD;EACjEC,mBAAmB,EACjB,8EAA8E;EAChFC,iBAAiB,EACf,0EAA0E;EAC5EC,aAAa,EACX,iEAAiE;EACnEC,cAAc,EAAE;AAClB,CAAC;AAED,MAAMC,OAAO,GAAG;EACdC,WAAW,EACT,mEAAmE;EACrEC,YAAY,EAAE,6DAA6D;EAC3EC,sBAAsB,EACpB,uEAAuE;EACzEC,yBAAyB,EACvB,yEAAyE;EAC3EC,gBAAgB,EACd;AACJ,CAAC;AAED,SAAStD,WAAW,EAAEiD,OAAO"}

package/lib/module/events.js

@@ -0,0 +1,240 @@
+/*
+ * Copyright (c) 2020-2023 Snowplow Analytics Ltd. All rights reserved.
+ *
+ * This program is licensed to you under the Apache License Version 2.0,
+ * and you may not use this file except in compliance with the Apache License Version 2.0.
+ * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the Apache License Version 2.0 is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
+ */
+
+'use strict';
+
+import { isObject } from './utils';
+import { logMessages } from './constants';
+/**
+ * Validates whether an object is valid self-describing
+ *
+ * @param sd {Object} - the object to validate
+ * @returns - boolean
+ */
+function isValidSD(sd) {
+  return isObject(sd) && typeof sd.schema === 'string' && isObject(sd.data);
+}
+
+/**
+ * Validates whether an object is a valid array of contexts
+ *
+ * @param contexts {Object} - the object to validate
+ * @returns - boolean promise
+ */
+function validateContexts(contexts) {
+  const isValid = Object.prototype.toString.call(contexts) === '[object Array]' && contexts.map(c => isValidSD(c)).reduce((acc, curr) => acc !== false && curr, true);
+  if (!isValid) {
+    return Promise.reject(new Error(logMessages.context));
+  }
+  return Promise.resolve(true);
+}
+
+/**
+ * Validates whether an object is valid self describing
+ *
+ * @param argmap {Object} - the object to validate
+ * @returns - boolean promise
+ */
+function validateSelfDesc(argmap) {
+  if (!isValidSD(argmap)) {
+    return Promise.reject(new Error(logMessages.selfDesc));
+  }
+  return Promise.resolve(true);
+}
+
+/**
+ * Validates a screen view event
+ *
+ * @param argmap {Object} - the object to validate
+ * @returns - boolean promise
+ */
+function validateScreenView(argmap) {
+  // validate type
+  if (!isObject(argmap)) {
+    return Promise.reject(new Error(logMessages.evType));
+  }
+  // validate required props
+  if (typeof argmap.name !== 'string') {
+    return Promise.reject(new Error(logMessages.screenViewReq));
+  }
+  return Promise.resolve(true);
+}
+
+/**
+ * Validates a structured event
+ *
+ * @param argmap {Object} - the object to validate
+ * @returns - boolean promise
+ */
+function validateStructured(argmap) {
+  // validate type
+  if (!isObject(argmap)) {
+    return Promise.reject(new Error(logMessages.evType));
+  }
+  // validate required props
+  if (typeof argmap.category !== 'string' || typeof argmap.action !== 'string') {
+    return Promise.reject(new Error(logMessages.structuredReq));
+  }
+  return Promise.resolve(true);
+}
+
+/**
+ * Validates a page-view event
+ *
+ * @param argmap {Object} - the object to validate
+ * @returns - boolean promise
+ */
+function validatePageView(argmap) {
+  // validate type
+  if (!isObject(argmap)) {
+    return Promise.reject(new Error(logMessages.evType));
+  }
+  // validate required props
+  if (typeof argmap.pageUrl !== 'string') {
+    return Promise.reject(new Error(logMessages.pageviewReq));
+  }
+  return Promise.resolve(true);
+}
+
+/**
+ * Validates a timing event
+ *
+ * @param argmap {Object} - the object to validate
+ * @returns - boolean promise
+ */
+function validateTiming(argmap) {
+  // validate type
+  if (!isObject(argmap)) {
+    return Promise.reject(new Error(logMessages.evType));
+  }
+  // validate required props
+  if (typeof argmap.category !== 'string' || typeof argmap.variable !== 'string' || typeof argmap.timing !== 'number') {
+    return Promise.reject(new Error(logMessages.timingReq));
+  }
+  return Promise.resolve(true);
+}
+
+/**
+ * Validates a consent-granted event
+ *
+ * @param argmap {Object} - the object to validate
+ * @returns - boolean promise
+ */
+function validateConsentGranted(argmap) {
+  // validate type
+  if (!isObject(argmap)) {
+    return Promise.reject(new Error(logMessages.evType));
+  }
+  // validate required props
+  if (typeof argmap.expiry !== 'string' || typeof argmap.documentId !== 'string' || typeof argmap.version !== 'string') {
+    return Promise.reject(new Error(logMessages.consentGReq));
+  }
+  return Promise.resolve(true);
+}
+
+/**
+ * Validates a consent-withdrawn event
+ *
+ * @param argmap {Object} - the object to validate
+ * @returns - boolean promise
+ */
+function validateConsentWithdrawn(argmap) {
+  // validate type
+  if (!isObject(argmap)) {
+    return Promise.reject(new Error(logMessages.evType));
+  }
+  // validate required props
+  if (typeof argmap.all !== 'boolean' || typeof argmap.documentId !== 'string' || typeof argmap.version !== 'string') {
+    return Promise.reject(new Error(logMessages.consentWReq));
+  }
+  return Promise.resolve(true);
+}
+
+/**
+ * Validates a deep link received event
+ *
+ * @param argmap {Object} - the object to validate
+ * @returns - boolean promise
+ */
+function validateDeepLinkReceived(argmap) {
+  // validate type
+  if (!isObject(argmap)) {
+    return Promise.reject(new Error(logMessages.evType));
+  }
+  // validate required props
+  if (typeof argmap.url !== 'string') {
+    return Promise.reject(new Error(logMessages.deepLinkReq));
+  }
+  return Promise.resolve(true);
+}
+
+/**
+ * Validates a message notification event
+ *
+ * @param argmap {Object} - the object to validate
+ * @returns - boolean promise
+ */
+function validateMessageNotification(argmap) {
+  // validate type
+  if (!isObject(argmap)) {
+    return Promise.reject(new Error(logMessages.evType));
+  }
+  // validate required props
+  if (typeof argmap.title !== 'string' || typeof argmap.body !== 'string' || typeof argmap.trigger !== 'string' || !['push', 'location', 'calendar', 'timeInterval', 'other'].includes(argmap.trigger)) {
+    return Promise.reject(new Error(logMessages.messageNotificationReq));
+  }
+  return Promise.resolve(true);
+}
+
+/**
+ * Validates whether an object is valid ecommerce-item
+ *
+ * @param item {Object} - the object to validate
+ * @returns - boolean
+ */
+function isValidEcomItem(item) {
+  if (isObject(item) && typeof item.sku === 'string' && typeof item.price === 'number' && typeof item.quantity === 'number') {
+    return true;
+  }
+  return false;
+}
+
+/**
+ * Validates an array of ecommerce-items
+ *
+ * @param items {Object} - the object to validate
+ * @returns - boolean promise
+ */
+function validItemsArg(items) {
+  return Object.prototype.toString.call(items) === '[object Array]' && items.map(i => isValidEcomItem(i)).reduce((acc, curr) => acc !== false && curr, true);
+}
+
+/**
+ * Validates an ecommerce-transaction event
+ *
+ * @param argmap {Object} - the object to validate
+ * @returns - boolean promise
+ */
+function validateEcommerceTransaction(argmap) {
+  // validate type
+  if (!isObject(argmap)) {
+    return Promise.reject(new Error(logMessages.evType));
+  }
+  // validate required props
+  if (typeof argmap.orderId !== 'string' || typeof argmap.totalValue !== 'number' || !validItemsArg(argmap.items)) {
+    return Promise.reject(new Error(logMessages.ecomReq));
+  }
+  return Promise.resolve(true);
+}
+export { isValidSD, validateContexts, validateSelfDesc, validateScreenView, validateStructured, validatePageView, validateTiming, validateConsentGranted, validateConsentWithdrawn, isValidEcomItem, validItemsArg, validateEcommerceTransaction, validateDeepLinkReceived, validateMessageNotification };
+//# sourceMappingURL=events.js.map

package/lib/module/events.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["isObject","logMessages","isValidSD","sd","schema","data","validateContexts","contexts","isValid","Object","prototype","toString","call","map","c","reduce","acc","curr","Promise","reject","Error","context","resolve","validateSelfDesc","argmap","selfDesc","validateScreenView","evType","name","screenViewReq","validateStructured","category","action","structuredReq","validatePageView","pageUrl","pageviewReq","validateTiming","variable","timing","timingReq","validateConsentGranted","expiry","documentId","version","consentGReq","validateConsentWithdrawn","all","consentWReq","validateDeepLinkReceived","url","deepLinkReq","validateMessageNotification","title","body","trigger","includes","messageNotificationReq","isValidEcomItem","item","sku","price","quantity","validItemsArg","items","i","validateEcommerceTransaction","orderId","totalValue","ecomReq"],"sourceRoot":"../../src","sources":["events.ts"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,YAAY;;AAEZ,SAASA,QAAQ,QAAQ,SAAS;AAClC,SAASC,WAAW,QAAQ,aAAa;AAgBzC;AACA;AACA;AACA;AACA;AACA;AACA,SAASC,SAASA,CAACC,EAAiC,EAAW;EAC7D,OAAOH,QAAQ,CAACG,EAAE,CAAC,IAAI,OAAOA,EAAE,CAACC,MAAM,KAAK,QAAQ,IAAIJ,QAAQ,CAACG,EAAE,CAACE,IAAI,CAAC;AAC3E;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASC,gBAAgBA,CAACC,QAAwB,EAAoB;EACpE,MAAMC,OAAO,GACXC,MAAM,CAACC,SAAS,CAACC,QAAQ,CAACC,IAAI,CAACL,QAAQ,CAAC,KAAK,gBAAgB,IAC7DA,QAAQ,CACLM,GAAG,CAAEC,CAAC,IAAKZ,SAAS,CAACY,CAAC,CAAC,CAAC,CACxBC,MAAM,CAAC,CAACC,GAAG,EAAEC,IAAI,KAAKD,GAAG,KAAK,KAAK,IAAIC,IAAI,EAAE,IAAI,CAAC;EAEvD,IAAI,CAACT,OAAO,EAAE;IACZ,OAAOU,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAACoB,OAAO,CAAC,CAAC;EACvD;EAEA,OAAOH,OAAO,CAACI,OAAO,CAAC,IAAI,CAAC;AAC9B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASC,gBAAgBA,CAACC,MAAsB,EAAoB;EAClE,IAAI,CAACtB,SAAS,CAACsB,MAAM,CAAC,EAAE;IACtB,OAAON,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAACwB,QAAQ,CAAC,CAAC;EACxD;EAEA,OAAOP,OAAO,CAACI,OAAO,CAAC,IAAI,CAAC;AAC9B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASI,kBAAkBA,CAACF,MAAuB,EAAoB;EACrE;EACA,IAAI,CAACxB,QAAQ,CAACwB,MAAM,CAAC,EAAE;IACrB,OAAON,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAAC0B,MAAM,CAAC,CAAC;EACtD;EACA;EACA,IAAI,OAAOH,MAAM,CAACI,IAAI,KAAK,QAAQ,EAAE;IACnC,OAAOV,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAAC4B,aAAa,CAAC,CAAC;EAC7D;EAEA,OAAOX,OAAO,CAACI,OAAO,CAAC,IAAI,CAAC;AAC9B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASQ,kBAAkBA,CAACN,MAAuB,EAAoB;EACrE;EACA,IAAI,CAACxB,QAAQ,CAACwB,MAAM,CAAC,EAAE;IACrB,OAAON,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAAC0B,MAAM,CAAC,CAAC;EACtD;EACA;EACA,IACE,OAAOH,MAAM,CAACO,QAAQ,KAAK,QAAQ,IACnC,OAAOP,MAAM,CAACQ,MAAM,KAAK,QAAQ,EACjC;IACA,OAAOd,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAACgC,aAAa,CAAC,CAAC;EAC7D;EAEA,OAAOf,OAAO,CAACI,OAAO,CAAC,IAAI,CAAC;AAC9B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASY,gBAAgBA,CAACV,MAAqB,EAAoB;EACjE;EACA,IAAI,CAACxB,QAAQ,CAACwB,MAAM,CAAC,EAAE;IACrB,OAAON,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAAC0B,MAAM,CAAC,CAAC;EACtD;EACA;EACA,IAAI,OAAOH,MAAM,CAACW,OAAO,KAAK,QAAQ,EAAE;IACtC,OAAOjB,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAACmC,WAAW,CAAC,CAAC;EAC3D;EAEA,OAAOlB,OAAO,CAACI,OAAO,CAAC,IAAI,CAAC;AAC9B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASe,cAAcA,CAACb,MAAmB,EAAoB;EAC7D;EACA,IAAI,CAACxB,QAAQ,CAACwB,MAAM,CAAC,EAAE;IACrB,OAAON,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAAC0B,MAAM,CAAC,CAAC;EACtD;EACA;EACA,IACE,OAAOH,MAAM,CAACO,QAAQ,KAAK,QAAQ,IACnC,OAAOP,MAAM,CAACc,QAAQ,KAAK,QAAQ,IACnC,OAAOd,MAAM,CAACe,MAAM,KAAK,QAAQ,EACjC;IACA,OAAOrB,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAACuC,SAAS,CAAC,CAAC;EACzD;EAEA,OAAOtB,OAAO,CAACI,OAAO,CAAC,IAAI,CAAC;AAC9B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASmB,sBAAsBA,CAACjB,MAA2B,EAAoB;EAC7E;EACA,IAAI,CAACxB,QAAQ,CAACwB,MAAM,CAAC,EAAE;IACrB,OAAON,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAAC0B,MAAM,CAAC,CAAC;EACtD;EACA;EACA,IACE,OAAOH,MAAM,CAACkB,MAAM,KAAK,QAAQ,IACjC,OAAOlB,MAAM,CAACmB,UAAU,KAAK,QAAQ,IACrC,OAAOnB,MAAM,CAACoB,OAAO,KAAK,QAAQ,EAClC;IACA,OAAO1B,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAAC4C,WAAW,CAAC,CAAC;EAC3D;EAEA,OAAO3B,OAAO,CAACI,OAAO,CAAC,IAAI,CAAC;AAC9B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASwB,wBAAwBA,CAC/BtB,MAA6B,EACX;EAClB;EACA,IAAI,CAACxB,QAAQ,CAACwB,MAAM,CAAC,EAAE;IACrB,OAAON,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAAC0B,MAAM,CAAC,CAAC;EACtD;EACA;EACA,IACE,OAAOH,MAAM,CAACuB,GAAG,KAAK,SAAS,IAC/B,OAAOvB,MAAM,CAACmB,UAAU,KAAK,QAAQ,IACrC,OAAOnB,MAAM,CAACoB,OAAO,KAAK,QAAQ,EAClC;IACA,OAAO1B,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAAC+C,WAAW,CAAC,CAAC;EAC3D;EAEA,OAAO9B,OAAO,CAACI,OAAO,CAAC,IAAI,CAAC;AAC9B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS2B,wBAAwBA,CAC/BzB,MAA6B,EACX;EAClB;EACA,IAAI,CAACxB,QAAQ,CAACwB,MAAM,CAAC,EAAE;IACrB,OAAON,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAAC0B,MAAM,CAAC,CAAC;EACtD;EACA;EACA,IAAI,OAAOH,MAAM,CAAC0B,GAAG,KAAK,QAAQ,EAAE;IAClC,OAAOhC,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAACkD,WAAW,CAAC,CAAC;EAC3D;EAEA,OAAOjC,OAAO,CAACI,OAAO,CAAC,IAAI,CAAC;AAC9B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS8B,2BAA2BA,CAClC5B,MAAgC,EACd;EAClB;EACA,IAAI,CAACxB,QAAQ,CAACwB,MAAM,CAAC,EAAE;IACrB,OAAON,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAAC0B,MAAM,CAAC,CAAC;EACtD;EACA;EACA,IACE,OAAOH,MAAM,CAAC6B,KAAK,KAAK,QAAQ,IAChC,OAAO7B,MAAM,CAAC8B,IAAI,KAAK,QAAQ,IAC/B,OAAO9B,MAAM,CAAC+B,OAAO,KAAK,QAAQ,IAClC,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,EAAE,OAAO,CAAC,CAACC,QAAQ,CACjEhC,MAAM,CAAC+B,OACT,CAAC,EACD;IACA,OAAOrC,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAACwD,sBAAsB,CAAC,CAAC;EACtE;EAEA,OAAOvC,OAAO,CAACI,OAAO,CAAC,IAAI,CAAC;AAC9B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASoC,eAAeA,CAACC,IAAmB,EAAW;EACrD,IACE3D,QAAQ,CAAC2D,IAAI,CAAC,IACd,OAAOA,IAAI,CAACC,GAAG,KAAK,QAAQ,IAC5B,OAAOD,IAAI,CAACE,KAAK,KAAK,QAAQ,IAC9B,OAAOF,IAAI,CAACG,QAAQ,KAAK,QAAQ,EACjC;IACA,OAAO,IAAI;EACb;EACA,OAAO,KAAK;AACd;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASC,aAAaA,CAACC,KAAsB,EAAW;EACtD,OACEvD,MAAM,CAACC,SAAS,CAACC,QAAQ,CAACC,IAAI,CAACoD,KAAK,CAAC,KAAK,gBAAgB,IAC1DA,KAAK,CACFnD,GAAG,CAAEoD,CAAC,IAAKP,eAAe,CAACO,CAAC,CAAC,CAAC,CAC9BlD,MAAM,CAAC,CAACC,GAAG,EAAEC,IAAI,KAAKD,GAAG,KAAK,KAAK,IAAIC,IAAI,EAAE,IAAI,CAAC;AAEzD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASiD,4BAA4BA,CACnC1C,MAAiC,EACf;EAClB;EACA,IAAI,CAACxB,QAAQ,CAACwB,MAAM,CAAC,EAAE;IACrB,OAAON,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAAC0B,MAAM,CAAC,CAAC;EACtD;EACA;EACA,IACE,OAAOH,MAAM,CAAC2C,OAAO,KAAK,QAAQ,IAClC,OAAO3C,MAAM,CAAC4C,UAAU,KAAK,QAAQ,IACrC,CAACL,aAAa,CAACvC,MAAM,CAACwC,KAAK,CAAC,EAC5B;IACA,OAAO9C,OAAO,CAACC,MAAM,CAAC,IAAIC,KAAK,CAACnB,WAAW,CAACoE,OAAO,CAAC,CAAC;EACvD;EAEA,OAAOnD,OAAO,CAACI,OAAO,CAAC,IAAI,CAAC;AAC9B;AAEA,SACEpB,SAAS,EACTI,gBAAgB,EAChBiB,gBAAgB,EAChBG,kBAAkB,EAClBI,kBAAkB,EAClBI,gBAAgB,EAChBG,cAAc,EACdI,sBAAsB,EACtBK,wBAAwB,EACxBY,eAAe,EACfK,aAAa,EACbG,4BAA4B,EAC5BjB,wBAAwB,EACxBG,2BAA2B"}

package/lib/module/index.js

@@ -0,0 +1,129 @@
+/*
+ * Copyright (c) 2020-2023 Snowplow Analytics Ltd. All rights reserved.
+ *
+ * This program is licensed to you under the Apache License Version 2.0,
+ * and you may not use this file except in compliance with the Apache License Version 2.0.
+ * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the Apache License Version 2.0 is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
+ */
+
+'use strict';
+
+import * as api from './api';
+import { safeWait, safeWaitCallback, errorHandler } from './utils';
+import { getWebViewCallback } from './webViewInterface';
+
+/**
+ * Creates a React Native Tracker object
+ *
+ * @param namespace {string} - The tracker namespace
+ * @param networkConfig {Object} - The network configuration
+ * @param control {Array} - The tracker controller configuration
+ * @returns The tracker object
+ */
+function createTracker(namespace, networkConfig) {
+  let controllerConfig = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+  // initTrackerPromise
+  const initTrackerPromise = Promise.resolve(api.createTracker({
+    namespace,
+    networkConfig,
+    ...controllerConfig
+  }));
+
+  // mkMethod creates methods subscribed to the initTrackerPromise
+  const mkMethod = safeWait(initTrackerPromise, errorHandler);
+
+  // mkCallback creates callbacks subscribed to the initTrackerPromise
+  const mkCallback = safeWaitCallback(initTrackerPromise, errorHandler);
+
+  // track methods
+  const trackSelfDescribingEvent = mkMethod(api.trackSelfDescribingEvent(namespace));
+  const trackScreenViewEvent = mkMethod(api.trackScreenViewEvent(namespace));
+  const trackStructuredEvent = mkMethod(api.trackStructuredEvent(namespace));
+  const trackPageViewEvent = mkMethod(api.trackPageViewEvent(namespace));
+  const trackTimingEvent = mkMethod(api.trackTimingEvent(namespace));
+  const trackConsentGrantedEvent = mkMethod(api.trackConsentGrantedEvent(namespace));
+  const trackConsentWithdrawnEvent = mkMethod(api.trackConsentWithdrawnEvent(namespace));
+  const trackEcommerceTransactionEvent = mkMethod(api.trackEcommerceTransactionEvent(namespace));
+  const trackDeepLinkReceivedEvent = mkMethod(api.trackDeepLinkReceivedEvent(namespace));
+  const trackMessageNotificationEvent = mkMethod(api.trackMessageNotificationEvent(namespace));
+  // Global Contexts
+  const removeGlobalContexts = mkMethod(api.removeGlobalContexts(namespace));
+  const addGlobalContexts = mkMethod(api.addGlobalContexts(namespace));
+  // setters
+  const setUserId = mkMethod(api.setUserId(namespace));
+  const setNetworkUserId = mkMethod(api.setNetworkUserId(namespace));
+  const setDomainUserId = mkMethod(api.setDomainUserId(namespace));
+  const setIpAddress = mkMethod(api.setIpAddress(namespace));
+  const setUseragent = mkMethod(api.setUseragent(namespace));
+  const setTimezone = mkMethod(api.setTimezone(namespace));
+  const setLanguage = mkMethod(api.setLanguage(namespace));
+  const setScreenResolution = mkMethod(api.setScreenResolution(namespace));
+  const setScreenViewport = mkMethod(api.setScreenViewport(namespace));
+  const setColorDepth = mkMethod(api.setColorDepth(namespace));
+  const setSubjectData = mkMethod(api.setSubjectData(namespace));
+
+  // callbacks
+  const getSessionUserId = mkCallback(api.getSessionUserId(namespace));
+  const getSessionId = mkCallback(api.getSessionId(namespace));
+  const getSessionIndex = mkCallback(api.getSessionIndex(namespace));
+  const getIsInBackground = mkCallback(api.getIsInBackground(namespace));
+  const getBackgroundIndex = mkCallback(api.getBackgroundIndex(namespace));
+  const getForegroundIndex = mkCallback(api.getForegroundIndex(namespace));
+  return Object.freeze({
+    trackSelfDescribingEvent,
+    trackScreenViewEvent,
+    trackStructuredEvent,
+    trackPageViewEvent,
+    trackTimingEvent,
+    trackConsentGrantedEvent,
+    trackConsentWithdrawnEvent,
+    trackEcommerceTransactionEvent,
+    trackDeepLinkReceivedEvent,
+    trackMessageNotificationEvent,
+    removeGlobalContexts,
+    addGlobalContexts,
+    setUserId,
+    setNetworkUserId,
+    setDomainUserId,
+    setIpAddress,
+    setUseragent,
+    setTimezone,
+    setLanguage,
+    setScreenResolution,
+    setScreenViewport,
+    setColorDepth,
+    setSubjectData,
+    getSessionUserId,
+    getSessionId,
+    getSessionIndex,
+    getIsInBackground,
+    getBackgroundIndex,
+    getForegroundIndex
+  });
+}
+
+/**
+ * Removes a tracker given its namespace
+ *
+ * @param trackerNamespace {string}
+ * @returns - A boolean promise
+ */
+function removeTracker(trackerNamespace) {
+  return api.removeTracker(trackerNamespace).catch(e => errorHandler(e));
+}
+
+/**
+ * Removes all trackers
+ *
+ * @returns - A boolean promise
+ */
+function removeAllTrackers() {
+  return api.removeAllTrackers().catch(e => errorHandler(e));
+}
+export { createTracker, removeTracker, removeAllTrackers, getWebViewCallback };
+//# sourceMappingURL=index.js.map

package/lib/module/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["api","safeWait","safeWaitCallback","errorHandler","getWebViewCallback","createTracker","namespace","networkConfig","controllerConfig","arguments","length","undefined","initTrackerPromise","Promise","resolve","mkMethod","mkCallback","trackSelfDescribingEvent","trackScreenViewEvent","trackStructuredEvent","trackPageViewEvent","trackTimingEvent","trackConsentGrantedEvent","trackConsentWithdrawnEvent","trackEcommerceTransactionEvent","trackDeepLinkReceivedEvent","trackMessageNotificationEvent","removeGlobalContexts","addGlobalContexts","setUserId","setNetworkUserId","setDomainUserId","setIpAddress","setUseragent","setTimezone","setLanguage","setScreenResolution","setScreenViewport","setColorDepth","setSubjectData","getSessionUserId","getSessionId","getSessionIndex","getIsInBackground","getBackgroundIndex","getForegroundIndex","Object","freeze","removeTracker","trackerNamespace","catch","e","removeAllTrackers"],"sourceRoot":"../../src","sources":["index.ts"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,YAAY;;AAEZ,OAAO,KAAKA,GAAG,MAAM,OAAO;AAC5B,SAASC,QAAQ,EAAEC,gBAAgB,EAAEC,YAAY,QAAQ,SAAS;AAMlE,SAASC,kBAAkB,QAAQ,oBAAoB;;AAEvD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASC,aAAaA,CACpBC,SAAiB,EACjBC,aAAmC,EAEf;EAAA,IADpBC,gBAAgD,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;EAErD;EACA,MAAMG,kBAAiC,GAAGC,OAAO,CAACC,OAAO,CACvDd,GAAG,CAACK,aAAa,CAAC;IAChBC,SAAS;IACTC,aAAa;IACb,GAAGC;EACL,CAAC,CACH,CAAC;;EAED;EACA,MAAMO,QAAQ,GAAGd,QAAQ,CAACW,kBAAkB,EAAET,YAAY,CAAC;;EAE3D;EACA,MAAMa,UAAU,GAAGd,gBAAgB,CAACU,kBAAkB,EAAET,YAAY,CAAC;;EAErE;EACA,MAAMc,wBAAwB,GAAGF,QAAQ,CACvCf,GAAG,CAACiB,wBAAwB,CAACX,SAAS,CACxC,CAAC;EACD,MAAMY,oBAAoB,GAAGH,QAAQ,CAACf,GAAG,CAACkB,oBAAoB,CAACZ,SAAS,CAAC,CAAC;EAC1E,MAAMa,oBAAoB,GAAGJ,QAAQ,CAACf,GAAG,CAACmB,oBAAoB,CAACb,SAAS,CAAC,CAAC;EAC1E,MAAMc,kBAAkB,GAAGL,QAAQ,CAACf,GAAG,CAACoB,kBAAkB,CAACd,SAAS,CAAC,CAAC;EACtE,MAAMe,gBAAgB,GAAGN,QAAQ,CAACf,GAAG,CAACqB,gBAAgB,CAACf,SAAS,CAAC,CAAC;EAClE,MAAMgB,wBAAwB,GAAGP,QAAQ,CACvCf,GAAG,CAACsB,wBAAwB,CAAChB,SAAS,CACxC,CAAC;EACD,MAAMiB,0BAA0B,GAAGR,QAAQ,CACzCf,GAAG,CAACuB,0BAA0B,CAACjB,SAAS,CAC1C,CAAC;EACD,MAAMkB,8BAA8B,GAAGT,QAAQ,CAC7Cf,GAAG,CAACwB,8BAA8B,CAAClB,SAAS,CAC9C,CAAC;EACD,MAAMmB,0BAA0B,GAAGV,QAAQ,CACzCf,GAAG,CAACyB,0BAA0B,CAACnB,SAAS,CAC1C,CAAC;EACD,MAAMoB,6BAA6B,GAAGX,QAAQ,CAC5Cf,GAAG,CAAC0B,6BAA6B,CAACpB,SAAS,CAC7C,CAAC;EACD;EACA,MAAMqB,oBAAoB,GAAGZ,QAAQ,CAACf,GAAG,CAAC2B,oBAAoB,CAACrB,SAAS,CAAC,CAAC;EAC1E,MAAMsB,iBAAiB,GAAGb,QAAQ,CAACf,GAAG,CAAC4B,iBAAiB,CAACtB,SAAS,CAAC,CAAC;EACpE;EACA,MAAMuB,SAAS,GAAGd,QAAQ,CAACf,GAAG,CAAC6B,SAAS,CAACvB,SAAS,CAAC,CAAC;EACpD,MAAMwB,gBAAgB,GAAGf,QAAQ,CAACf,GAAG,CAAC8B,gBAAgB,CAACxB,SAAS,CAAC,CAAC;EAClE,MAAMyB,eAAe,GAAGhB,QAAQ,CAACf,GAAG,CAAC+B,eAAe,CAACzB,SAAS,CAAC,CAAC;EAChE,MAAM0B,YAAY,GAAGjB,QAAQ,CAACf,GAAG,CAACgC,YAAY,CAAC1B,SAAS,CAAC,CAAC;EAC1D,MAAM2B,YAAY,GAAGlB,QAAQ,CAACf,GAAG,CAACiC,YAAY,CAAC3B,SAAS,CAAC,CAAC;EAC1D,MAAM4B,WAAW,GAAGnB,QAAQ,CAACf,GAAG,CAACkC,WAAW,CAAC5B,SAAS,CAAC,CAAC;EACxD,MAAM6B,WAAW,GAAGpB,QAAQ,CAACf,GAAG,CAACmC,WAAW,CAAC7B,SAAS,CAAC,CAAC;EACxD,MAAM8B,mBAAmB,GAAGrB,QAAQ,CAACf,GAAG,CAACoC,mBAAmB,CAAC9B,SAAS,CAAC,CAAC;EACxE,MAAM+B,iBAAiB,GAAGtB,QAAQ,CAACf,GAAG,CAACqC,iBAAiB,CAAC/B,SAAS,CAAC,CAAC;EACpE,MAAMgC,aAAa,GAAGvB,QAAQ,CAACf,GAAG,CAACsC,aAAa,CAAChC,SAAS,CAAC,CAAC;EAC5D,MAAMiC,cAAc,GAAGxB,QAAQ,CAACf,GAAG,CAACuC,cAAc,CAACjC,SAAS,CAAC,CAAC;;EAE9D;EACA,MAAMkC,gBAAgB,GAAGxB,UAAU,CAAChB,GAAG,CAACwC,gBAAgB,CAAClC,SAAS,CAAC,CAAC;EACpE,MAAMmC,YAAY,GAAGzB,UAAU,CAAChB,GAAG,CAACyC,YAAY,CAACnC,SAAS,CAAC,CAAC;EAC5D,MAAMoC,eAAe,GAAG1B,UAAU,CAAChB,GAAG,CAAC0C,eAAe,CAACpC,SAAS,CAAC,CAAC;EAClE,MAAMqC,iBAAiB,GAAG3B,UAAU,CAAChB,GAAG,CAAC2C,iBAAiB,CAACrC,SAAS,CAAC,CAAC;EACtE,MAAMsC,kBAAkB,GAAG5B,UAAU,CAAChB,GAAG,CAAC4C,kBAAkB,CAACtC,SAAS,CAAC,CAAC;EACxE,MAAMuC,kBAAkB,GAAG7B,UAAU,CAAChB,GAAG,CAAC6C,kBAAkB,CAACvC,SAAS,CAAC,CAAC;EAExE,OAAOwC,MAAM,CAACC,MAAM,CAAC;IACnB9B,wBAAwB;IACxBC,oBAAoB;IACpBC,oBAAoB;IACpBC,kBAAkB;IAClBC,gBAAgB;IAChBC,wBAAwB;IACxBC,0BAA0B;IAC1BC,8BAA8B;IAC9BC,0BAA0B;IAC1BC,6BAA6B;IAC7BC,oBAAoB;IACpBC,iBAAiB;IACjBC,SAAS;IACTC,gBAAgB;IAChBC,eAAe;IACfC,YAAY;IACZC,YAAY;IACZC,WAAW;IACXC,WAAW;IACXC,mBAAmB;IACnBC,iBAAiB;IACjBC,aAAa;IACbC,cAAc;IACdC,gBAAgB;IAChBC,YAAY;IACZC,eAAe;IACfC,iBAAiB;IACjBC,kBAAkB;IAClBC;EACF,CAAC,CAAC;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASG,aAAaA,CAACC,gBAAwB,EAAoB;EACjE,OACEjD,GAAG,CAACgD,aAAa,CAACC,gBAAgB,CAAC,CAACC,KAAK,CAAEC,CAAC,IAAKhD,YAAY,CAACgD,CAAC,CAAC,CAAC;AAErE;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASC,iBAAiBA,CAAA,EAAqB;EAC7C,OACEpD,GAAG,CAACoD,iBAAiB,CAAC,CAAC,CAACF,KAAK,CAAEC,CAAC,IAAKhD,YAAY,CAACgD,CAAC,CAAC,CAAC;AAEzD;AAEA,SAAS9C,aAAa,EAAE2C,aAAa,EAAEI,iBAAiB,EAAEhD,kBAAkB"}