@snowplow/react-native-tracker 2.1.1 → 4.0.2-dev.0

package/src/events.ts

@@ -1,355 +0,0 @@
-'use strict';
-
-import { isObject } from './utils';
-import { logMessages } from './constants';
-import type {
-  SelfDescribing,
-  EventContext,
-  ScreenViewProps,
-  StructuredProps,
-  PageViewProps,
-  TimingProps,
-  ConsentGrantedProps,
-  ConsentWithdrawnProps,
-  EcommerceItem,
-  EcommerceTransactionProps,
-  DeepLinkReceivedProps,
-  MessageNotificationProps,
-  ScrollChangedProps,
-  ListItemViewProps,
-} from './types';
-
-/**
- * Validates whether an object is valid self-describing
- *
- * @param sd {Object} - the object to validate
- * @returns - boolean
- */
-function isValidSD(sd: SelfDescribing | EventContext): boolean {
-  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: EventContext[]): Promise<boolean> {
-  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: SelfDescribing): Promise<boolean> {
-  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: ScreenViewProps): Promise<boolean> {
-  // 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 scroll changed event
- *
- * @param argmap {Object} - the object to validate
- * @returns - boolean promise
- */
-function validateScrollChanged(argmap: ScrollChangedProps): Promise<boolean> {
-  // validate type
-  if (!isObject(argmap)) {
-    return Promise.reject(new Error(logMessages.evType));
-  }
-
-  return Promise.resolve(true);
-}
-
-/**
- * Validates a list item view event
- *
- * @param argmap {Object} - the object to validate
- * @returns - boolean promise
- */
-function validateListItemView(argmap: ListItemViewProps): Promise<boolean> {
-  // validate type
-  if (!isObject(argmap)) {
-    return Promise.reject(new Error(logMessages.evType));
-  }
-  // validate required props
-  if (typeof argmap.index !== 'number') {
-    return Promise.reject(new Error(logMessages.listItemViewReq));
-  }
-
-  return Promise.resolve(true);
-}
-
-/**
- * Validates a structured event
- *
- * @param argmap {Object} - the object to validate
- * @returns - boolean promise
- */
-function validateStructured(argmap: StructuredProps): Promise<boolean> {
-  // 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: PageViewProps): Promise<boolean> {
-  // 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: TimingProps): Promise<boolean> {
-  // 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: ConsentGrantedProps): Promise<boolean> {
-  // 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: ConsentWithdrawnProps
-): Promise<boolean> {
-  // 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: DeepLinkReceivedProps
-): Promise<boolean> {
-  // 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: MessageNotificationProps
-): Promise<boolean> {
-  // 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: EcommerceItem): boolean {
-  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: EcommerceItem[]): boolean {
-  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: EcommerceTransactionProps
-): Promise<boolean> {
-  // 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,
-  validateScrollChanged,
-  validateListItemView,
-  validateStructured,
-  validatePageView,
-  validateTiming,
-  validateConsentGranted,
-  validateConsentWithdrawn,
-  isValidEcomItem,
-  validItemsArg,
-  validateEcommerceTransaction,
-  validateDeepLinkReceived,
-  validateMessageNotification,
-};

package/src/index.ts

@@ -1,184 +0,0 @@
-'use strict';
-
-import * as api from './api';
-import { safeWait, safeWaitCallback, errorHandler } from './utils';
-import type {
-  NetworkConfiguration,
-  TrackerControllerConfiguration,
-  ReactNativeTracker,
-} from './types';
-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: string,
-  networkConfig: NetworkConfiguration,
-  controllerConfig: TrackerControllerConfiguration = {}
-): ReactNativeTracker {
-  // initTrackerPromise
-  const initTrackerPromise: Promise<void> = 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 trackScrollChangedEvent = mkMethod(
-    api.trackScrollChangedEvent(namespace)
-  );
-  const trackListItemViewEvent = mkMethod(
-    api.trackListItemViewEvent(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,
-    trackScrollChangedEvent,
-    trackListItemViewEvent,
-    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: string): Promise<boolean> {
-  return <Promise<boolean>>(
-    api.removeTracker(trackerNamespace).catch((e) => errorHandler(e))
-  );
-}
-
-/**
- * Removes all trackers
- *
- * @returns - A boolean promise
- */
-function removeAllTrackers(): Promise<boolean> {
-  return <Promise<boolean>>(
-    api.removeAllTrackers().catch((e) => errorHandler(e))
-  );
-}
-
-export { createTracker, removeTracker, removeAllTrackers, getWebViewCallback };
-
-export type {
-  ReactNativeTracker,
-  TrackerControllerConfiguration,
-  NetworkConfiguration,
-  TrackerConfiguration,
-  SessionConfiguration,
-  EmitterConfiguration,
-  SubjectConfiguration,
-  GdprConfiguration,
-  GCConfiguration,
-  SelfDescribing,
-  EventContext,
-  ScreenViewProps,
-  StructuredProps,
-  PageViewProps,
-  TimingProps,
-  ConsentGrantedProps,
-  ConsentWithdrawnProps,
-  EcommerceTransactionProps,
-  DeepLinkReceivedProps,
-  MessageNotificationProps,
-  EcommerceItem,
-  ConsentDocument,
-  GlobalContext,
-  HttpMethod,
-  DevicePlatform,
-  LogLevel,
-  Basis,
-  BufferOption,
-  ScreenSize,
-  Trigger,
-} from './types';