@snowplow/react-native-tracker 0.2.0 → 1.1.0

package/src/api.ts

@@ -1,168 +0,0 @@
-/*
- * Copyright (c) 2020-2021 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 { NativeModules } from 'react-native';
-import type {
-  InitTrackerConfig,
-  OptTrackerConfig,
-  SubjectData,
-  ScreenViewProps,
-  SelfDescribingProps,
-  StructuredProps,
-  PageViewProps,
-  EventContext,
-} from './types';
-
-const { RNSnowplowTracker } = NativeModules;
-
-/*
- * Initialize a tracker from specified argmap.
- *
- * @param argmap - The configuration to use for the tracker instance
- * @returns - A promise fullfilled if the tracker is initialized
- */
-function initializeTracker(argmap: InitTrackerConfig): Promise<void> {
-
-  const defaults: OptTrackerConfig = {// defaults for optional params
-    method: 'post',
-    protocol: 'https',
-    base64Encoded : true,
-    platformContext : true,
-    applicationContext : false,
-    lifecycleEvents : false,
-    screenContext : true,
-    sessionContext : true,
-    foregroundTimeout : 600,
-    backgroundTimeout : 300,
-    checkInterval : 15,
-    installTracking : false
-  };
-
-  const ok = typeof argmap.endpoint !== 'undefined' && typeof argmap.appId !== 'undefined' && typeof argmap.namespace !== 'undefined';
-
-  if (ok) {
-    return <Promise<void>>Promise.resolve(
-      RNSnowplowTracker.initialize({...defaults, ...argmap})
-    );
-  } else {
-    const initReason = 'SnowplowTracker: initialize() requires endpoint, namespace and appId parameter to be set';
-    return Promise.reject(new Error(initReason));
-  }
-}
-
-/*
- * Sets or updates data for the Subject
- *
- * @param argmap - The subject data to be used
- * @returns - A promise that is fullfilled if the Subject data is set
- */
-function setSubjectData(argmap: SubjectData): Promise<void> {
-  return <Promise<void>>Promise.resolve(
-    RNSnowplowTracker.setSubjectData(argmap)
-  );
-}
-
-/*
- * Tracks a ScreenView event
- *
- * @param argmap - The ScreenView event's parameters
- * @param ctxt - An array of contexts to be attached to the event
- * @returns - A promise that is fullfilled if the event is tracked successfully
- */
-function trackScreenViewEvent(
-  argmap: ScreenViewProps,
-  ctxt: EventContext[] = []
-): Promise<void> {
-  if (typeof argmap.screenName !== 'undefined') {
-    return <Promise<void>>Promise.resolve(
-      RNSnowplowTracker.trackScreenViewEvent(argmap, ctxt)
-    );
-  } else {
-    const reason = 'SnowplowTracker: trackScreenViewEvent() requires screenName parameter to be set';
-    return Promise.reject(new Error(reason));
-  }
-}
-
-/*
- * Tracks a SelfDescribing event
- *
- * @param argmap - The SelfDescribing event's parameters
- * @param ctxt - An array of contexts to be attached to the event
- * @returns - A promise that is fullfilled if the event is tracked successfully
- */
-function trackSelfDescribingEvent(
-  argmap: SelfDescribingProps,
-  ctxt: EventContext[] = []
-): Promise<void> {
-  if (typeof argmap.schema !== 'undefined' && typeof argmap.data !== 'undefined') {
-    return <Promise<void>>Promise.resolve(
-      RNSnowplowTracker.trackSelfDescribingEvent(argmap, ctxt)
-    );
-  } else {
-    const reason = 'SnowplowTracker: trackSelfDescribingEvent() requires schema and data parameters to be set';
-    return Promise.reject(new Error(reason));
-  }
-}
-
-/*
- * Tracks a Structured event
- *
- * @param argmap - The Structured event's parameters
- * @param ctxt - An array of contexts to be attached to the event
- * @returns - A promise that is fullfilled if the event is tracked successfully
- */
-function trackStructuredEvent(
-  argmap: StructuredProps,
-  ctxt: EventContext[] = []
-): Promise<void> {
-  if (typeof argmap.category !== 'undefined' && typeof argmap.action !== 'undefined') {
-    return <Promise<void>>Promise.resolve(
-      RNSnowplowTracker.trackStructuredEvent(argmap, ctxt)
-    );
-  } else {
-    const reason = 'SnowplowTracker: trackStructuredEvent() requires category and action parameters to be set';
-    return Promise.reject(new Error(reason));
-  }
-}
-
-/*
- * Tracks a PageView event
- *
- * @param argmap - The PageView event's parameters
- * @param ctxt - An array of contexts to be attached to the event
- * @returns - A promise that is fullfilled if the event is tracked successfully
- */
-function trackPageViewEvent(
-  argmap: PageViewProps,
-  ctxt: EventContext[] = []
-): Promise<void> {
-  if (typeof argmap.pageUrl !== 'undefined') {
-    return <Promise<void>>Promise.resolve(
-      RNSnowplowTracker.trackPageViewEvent(argmap, ctxt)
-    );
-  } else {
-    const reason = 'SnowplowTracker: trackPageViewEvent() requires pageUrl parameter to be set';
-    return Promise.reject(new Error(reason));
-  }
-}
-
-export {
-  initializeTracker,
-  setSubjectData,
-  trackScreenViewEvent,
-  trackSelfDescribingEvent,
-  trackStructuredEvent,
-  trackPageViewEvent,
-};

package/src/index.ts

@@ -1,71 +0,0 @@
-/*
- * Copyright (c) 2020-2021 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, errorHandler } from './utils';
-
-import type { TrackerConfig, ReactNativeTracker } from './types';
-
-/*
- * Creates a React Native Tracker object
- *
- * @param namespace - The tracker namespace
- * @param config - The configuration to be used for the tracker
- * @returns The tracker object
- */
-function createTracker(
-  namespace: string,
-  config: TrackerConfig
-): ReactNativeTracker {
-  // initTrackerPromise
-  const initTrackerPromise: Promise<void> = Promise.resolve(
-    api.initializeTracker({
-      ...config,
-      namespace,
-    })
-  );
-
-  // mkMethod creates methods subscribed to the initTrackerPromise
-  const mkMethod = safeWait(initTrackerPromise, errorHandler);
-
-  // tracker methods
-  const setSubjectData = mkMethod(api.setSubjectData);
-  const trackScreenViewEvent = mkMethod(api.trackScreenViewEvent);
-  const trackSelfDescribingEvent = mkMethod(api.trackSelfDescribingEvent);
-  const trackStructuredEvent = mkMethod(api.trackStructuredEvent);
-  const trackPageViewEvent = mkMethod(api.trackPageViewEvent);
-
-  return Object.freeze({
-    setSubjectData,
-    trackScreenViewEvent,
-    trackSelfDescribingEvent,
-    trackStructuredEvent,
-    trackPageViewEvent,
-  });
-}
-
-export { createTracker };
-export type {
-  ReactNativeTracker,
-  TrackerConfig,
-  HttpMethod,
-  HttpProtocol,
-  SubjectData,
-  ScreenViewProps,
-  SelfDescribingProps,
-  StructuredProps,
-  PageViewProps,
-  EventContext
-} from './types';

package/src/types.ts

@@ -1,325 +0,0 @@
-/*
- * Copyright (c) 2020-2021 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.
- */
-
-/**
- * HttpMethod type
- */
-export type HttpMethod = 'post' | 'get';
-
-/**
- * HttpProtocol type
- */
-export type HttpProtocol = 'https' | 'http';
-
-/**
- * The Subject Data
- */
-export type SubjectData = {
-  /**
-   * user id
-   */
-  userId?: string;
-  /**
-   * screen width (integer)
-   */
-  screenWidth?: number;
-  /**
-   * screen height (integer)
-   */
-  screenHeight?: number;
-  /**
-   * color depth (integer)
-   */
-  colorDepth?: number;
-  /**
-   * timezone
-   */
-  timezone?: string;
-  /**
-   * language
-   */
-  language?: string;
-  /**
-   * IP address
-   */
-  ipAddress?: string;
-  /**
-   * user agent
-   */
-  useragent?: string;
-  /**
-   * network user id (UUIDv4)
-   */
-  networkUserId?: string;
-  /**
-   * domain user id
-   */
-  domainUserId?: string;
-  /**
-   * viewport width (integer)
-   */
-  viewportWidth?: number;
-  /**
-   * viewport height (integer)
-   */
-  viewportHeight?: number;
-};
-
-/**
- * ScreenView event properties
- * schema: iglu:com.snowplowanalytics.mobile/screen_view/jsonschema/1-0-0
- */
-export type ScreenViewProps = {
-  /**
-   * The name of the screen viewed
-   */
-  screenName: string;
-  /**
-   * The type of screen that was viewed
-   */
-  screenType?: string;
-  /**
-   * The type of transition that led to the screen being viewed
-   */
-  transitionType?: string;
-};
-
-/**
- * SelfDescribing event properties
- */
-export type SelfDescribingProps = {
-  /**
-   * The schema of the event
-   */
-  schema: string;
-  /**
-   * The event data
-   */
-  data: Record<string, unknown>;
-};
-
-/**
- * Structured event properties
- */
-export type StructuredProps = {
-  /**
-   * The category of the event
-   */
-  category: string;
-  /**
-   * The action the event represents
-   */
-  action: string;
-  /**
-   * The label the action refers to
-   */
-  label?: string;
-  /**
-   * The property associated with the user action
-   */
-  property?: string;
-  /**
-   * The value associated with the user action
-   */
-  value?: number;
-};
-
-/**
- * PageView event properties
- */
-export type PageViewProps = {
-  /**
-   * The page URL
-   */
-  pageUrl: string;
-  /**
-   * The page title
-   */
-  pageTitle?: string;
-  /**
-   * The referrer URL
-   */
-  pageReferrer?: string;
-};
-
-/**
- * Context type
- */
-export type EventContext = {
-  /**
-   * The context schema
-   */
-  schema: string;
-  /**
-   * The context data
-   */
-  data: Record<string, unknown>;
-};
-
-/**
- * The ReactNativeTracker type
- */
-export type ReactNativeTracker = {
-  /**
-   * Sets or updates subject data
-   *
-   * @param argmap - The subject data to be set or updated
-   */
-  readonly setSubjectData: (argmap: SubjectData) => Promise<void>;
-
-  /**
-   * Tracks a screen-view event
-   *
-   * @param argmap - The screen-view event's properties
-   * @param ctxt - The array of event contexts
-   */
-  readonly trackScreenViewEvent: (
-    argmap: ScreenViewProps,
-    ctxt?: EventContext[]
-  ) => Promise<void>;
-
-  /**
-   * Tracks a self-descibing event
-   *
-   * @param argmap - The self-describing event properties
-   * @param ctxt - The array of event contexts
-   */
-  readonly trackSelfDescribingEvent: (
-    argmap: SelfDescribingProps,
-    ctxt: EventContext[]
-  ) => Promise<void>;
-
-  /**
-   * Tracks a structured event
-   *
-   * @param argmap - The structured event properties
-   * @param ctxt - The array of event contexts
-   */
-  readonly trackStructuredEvent: (
-    argmap: StructuredProps,
-    ctxt: EventContext[]
-  ) => Promise<void>;
-
-  /**
-   * Tracks a page-view event
-   *
-   * @param argmap - The page-view event properties
-   * @param ctxt - The array of event contexts
-   */
-  readonly trackPageViewEvent: (
-    argmap: PageViewProps,
-    ctxt: EventContext[]
-  ) => Promise<void>;
-};
-
-/**
- * The optional configuration parameters of the tracker
- */
-export interface OptTrackerConfig {
-  /**
-   * The HTTP method used
-   * @defaultValue 'post'
-   */
-  method?: HttpMethod;
-
-  /**
-   * The HTTP protocol used
-   * @defaultValue 'https'
-   */
-  protocol?: HttpProtocol;
-
-  /**
-   * Should event properties be base64 encoded where supported
-   * @defaultValue true
-   */
-  base64Encoded?: boolean;
-
-  /**
-   * Whether platform context are sent with all events
-   * @defaultValue true
-   */
-  platformContext?: boolean;
-
-  /**
-   * Whether application context are sent with all events
-   * @defaultValue false
-   */
-  applicationContext?: boolean;
-
-  /**
-   * Whether to automatically track transition from foreground to background
-   * @defaultValue false
-   */
-  lifecycleEvents?: boolean;
-
-  /**
-   * Whether to send a screen context (info for current screen) to events
-   * @defaultValue true
-   */
-  screenContext?: boolean;
-
-  /**
-   * whether to add a session context to events
-   * @defaultValue true
-   */
-  sessionContext?: boolean;
-
-  /**
-   * The session foreground timeout
-   * @defaultValue 600
-   */
-  foregroundTimeout?: number;
-
-  /**
-   * The session background timeout
-   * @defaultValue 300
-   */
-  backgroundTimeout?: number;
-
-  /**
-   * The session check interval
-   * @defaultValue 15
-   */
-  checkInterval?: number;
-
-  /**
-   * Whether install events will be tracked
-   * @defaultValue false
-   */
-  installTracking?: boolean;
-}
-
-/**
- * The configuration used for creating the tracker
- */
-export interface TrackerConfig extends OptTrackerConfig {
-  /**
-   * The collector endpoint
-   */
-  endpoint: string;
-
-  /**
-   * The app ID
-   */
-  appId: string;
-}
-
-/**
- * The tracker configuration
- */
-export interface InitTrackerConfig extends TrackerConfig {
-  /**
-   * The tracker namespace
-   */
-  namespace: string;
-}

package/src/utils.ts

@@ -1,47 +0,0 @@
-/*
- * Copyright (c) 2020-2021 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';
-
-/*
- * Returns a function that accepts a function as its argument and subscribes
- * that function to aPromise's fullfillment,
- * and errHandle to aPromise's rejection.
- *
- * @param aPromise - A Promise
- * @param errHandle - A function to handle the promise being rejected
- * @returns - A function subscribed to the Promise's fullfillment
- */
-function safeWait(aPromise: Promise<void>, errHandle: ((err: Error) => void)) {
-  return (<F extends ((...args: never[]) => Promise<void>)>(func: F) => {
-    return (...args: Parameters<F>): Promise<void> => {
-      return aPromise.then(() => func(...args)).catch((err) => errHandle(err));
-    };
-  });
-}
-
-/*
- * Handles an error.
- *
- * @param err - The error to be handled.
- */
-function errorHandler(err: Error): void {
-  if (__DEV__) {
-    console.warn(err.message);
-  }
-}
-
-export {
-  safeWait,
-  errorHandler,
-};