@janiscommerce/app-analytics/lib/screenViewEvent.js

Analytics methods for janis apps

import analytics from '@react-native-firebase/analytics';
import {isDevEnv, validObjectWithValues} from './utils';

/**
 * @function screenViewEvent
 * @description logs an event with information from the screen the user is viewing
 * @param {string} screenName Screen name the user is currently viewing.
 * @param {string} screenClass Current class associated with the view the user is currently viewing.
 * @param {string} params.client janis operating client
 * @param {string} params.userEmail janis registered user email
 * @param {string} params.userId registered user id
 * @param {string} params.language language used in the application
 * @param {string} params.appVersion app version in use
 * @throws an error when some required params is not passed
 * @returns {boolean}
 * @example
 * import {screenViewEvent} from '@janiscommerce/app-analytics'
 *
 * screenViewEvent('home','class_home')
 */

const screenViewEvent = async (screenName, screenClass = '', params) => {
  try {
    if (!screenName) throw new Error('Screen name is required');

    if (typeof screenName !== 'string')
      throw new Error('Screen name is invalid, it should be a string');

    await analytics().logScreenView({
      screen_name: screenName,
      ...(screenClass &&
        typeof screenClass === 'string' && {screen_class: screenClass}),
      ...validObjectWithValues(params),
    });

    return true;
  } catch (error) {
    if (isDevEnv()) {
      console.error(error.message);
    }

    return false;
  }
};

export default screenViewEvent;