fleek-track-analytics 0.0.2 → 0.0.3

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "fleek-track-analytics",
-  "version": "0.0.2",
-  "main": "./dist/index.js",
-  "types": "./lin/types.d.ts",
+  "version": "0.0.3",
+  "main": "./dist/src/index.js",
+  "types": "./dist/src/types.d.ts",
   "repository": "https://github.com/joinfleek/fleek-track-analytics.git",
   "author": "yugalbfleek <yugal@joinfleek.com>",
   "license": "MIT",

package/src/analytics-tool/lazy-load-tool.ts

@@ -1,36 +0,0 @@
-import { tAPP, tPLATFORM } from '../types';
-import { tToolWraperFunction } from './types';
-
-const getAnalyticsToolWrapper = async (platform: tPLATFORM) => {
-  try {
-    if (platform === 'REACT_NATIVE') {
-      return (await import('./react-native-segment')).reactNativeSegment;
-    }
-    if (platform === 'NODE' || platform === 'WEB') {
-      return (await import('./web-segment')).webSegment;
-    }
-
-    return null;
-  } catch (e) {
-    console.log(e);
-    throw new Error(JSON.stringify(e));
-  }
-};
-
-const ERROR_MESSAGES = {
-  TOOL_INIT_FAILED_AT_LAZY_LOAD: 'TOOL_INIT_FAILED_AT_LAZY_LOAD',
-};
-
-export const lazyLoadTool = async (platform: tPLATFORM, app: tAPP) => {
-  let tool = null;
-  try {
-    const toolWrapper: tToolWraperFunction | null = await getAnalyticsToolWrapper(platform);
-    if (toolWrapper) {
-      tool = await Promise.resolve(toolWrapper(app));
-    }
-  } catch (e) {
-    console.error(ERROR_MESSAGES.TOOL_INIT_FAILED_AT_LAZY_LOAD, { platform, app });
-  }
-
-  return tool;
-};

package/src/analytics-tool/react-native-segment.ts

@@ -1,28 +0,0 @@
-import { createClient } from '@segment/analytics-react-native';
-import { getSegmentKey } from './utils/getSegmentKey';
-import { tToolWraperFunction } from './types';
-import { tAPP, tTrack } from '../types';
-
-export const reactNativeSegment: tToolWraperFunction = (APP: tAPP) => {
-  const segmentKey = getSegmentKey(APP);
-  const client = createClient({
-    writeKey: segmentKey,
-    trackAppLifecycleEvents: true,
-  });
-
-  const { track, screen, identify } = client;
-
-  const trackWrapper: tTrack = (eventName, eventParams) => {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const data = eventParams as Record<string | number, any>;
-
-    track(eventName, data);
-  };
-
-  return {
-    track: trackWrapper,
-    screen,
-    identify,
-    type: 'RN_SEGMENT',
-  };
-};

package/src/analytics-tool/types.ts

@@ -1,3 +0,0 @@
-import { IAnalyticsWrapper, tAPP } from '../types';
-
-export type tToolWraperFunction = (APP: tAPP) => IAnalyticsWrapper;

package/src/analytics-tool/utils/getSegmentKey.ts

@@ -1,4 +0,0 @@
-import { tAPP } from '../../types';
-
-export const getSegmentKey = (APP: tAPP) => process.env[`SEGMENT_PROJECT_KEY_${APP}`] || SEGMENT_KEY_NOT_FOUND;
-export const SEGMENT_KEY_NOT_FOUND = 'SEGMENT_KEY_NOT_FOUND';

package/src/analytics-tool/web-segment.ts

@@ -1,17 +0,0 @@
-import { getSegmentKey } from './utils/getSegmentKey';
-import { AnalyticsBrowser } from '@segment/analytics-next';
-import { tToolWraperFunction } from './types';
-import { tAPP } from '../types';
-
-export const webSegment: tToolWraperFunction = (APP: tAPP) => {
-  const segmentKey = getSegmentKey(APP);
-  const client = AnalyticsBrowser.load({ writeKey: segmentKey });
-  const { track, page, identify } = client;
-
-  return {
-    track,
-    screen: page,
-    identify,
-    type: 'WEB_SEGMENT',
-  };
-};

package/src/event-map/event-map.ts

@@ -1,28 +0,0 @@
-export enum EVENT_NAMES {
-  ADD_TO_CART = 'ADD_TO_CART',
-}
-
-//TODO Imelement product card entity
-export interface ProductCartEventData {
-  value: number;
-  valueCurrencyCode: string;
-  vendor: string;
-  productCategoryL2: Array<string>;
-  productCategoryL1: Array<string>;
-  productGenderCategory: Array<string>;
-  productType: string;
-  price: number;
-  priceCurrencyCode: string;
-  brand: Array<string>;
-  collectionName: Array<string>;
-  quantity: number;
-  productId: string;
-  url: string;
-  failureReason: string;
-  productName: string;
-  grade: string;
-}
-
-export interface EVENT_MAP {
-  [EVENT_NAMES.ADD_TO_CART]: ProductCartEventData;
-}

package/src/index.ts

@@ -1,3 +0,0 @@
-import { testFunction } from './init/init';
-
-testFunction();

package/src/init/init.test.ts

@@ -1,16 +0,0 @@
-import { init } from './init';
-
-describe('init', () => {
-  test('it returns object of type AnalyticsWrapper', async () => {
-    expect.assertions(3);
-    const output = await init({
-      platform: 'REACT_NATIVE',
-      App: 'CONSUMER_WEB',
-      segment: true,
-      pixel: true,
-    });
-    expect(output).toHaveProperty('track');
-    expect(output).toHaveProperty('identify');
-    expect(output).toHaveProperty('screen');
-  });
-});

package/src/init/init.ts

@@ -1,36 +0,0 @@
-import { lazyLoadTool } from '../analytics-tool/lazy-load-tool';
-import { IAnalyticsWrapper, tInit } from '../types';
-
-const failedAnalyticsReurn: IAnalyticsWrapper = {
-  track: () => {},
-  identify: () => {},
-  screen: () => {},
-  type: 'FAILED_INIT',
-};
-
-export const init: tInit = async (params) => {
-  console.log(params);
-  // get right analytics-tool to get data
-  // attach analytics type to returned object
-  try {
-    const analyticsWrapper = await lazyLoadTool(params.platform, params.App);
-    if (!analyticsWrapper) {
-      console.log('ANALYTICS_WRAPPER_NULL');
-    }
-    return analyticsWrapper || failedAnalyticsReurn;
-  } catch (e) {
-    console.log('MAIN_INIT_FAILED', JSON.stringify(e));
-    return failedAnalyticsReurn;
-  }
-};
-
-export const testFunction = async () => {
-  console.log(
-    await init({
-      platform: 'REACT_NATIVE',
-      App: 'CONSUMER_APP',
-      segment: true,
-      pixel: false,
-    }),
-  );
-};

package/src/types.ts

@@ -1,50 +0,0 @@
-import { EVENT_MAP, EVENT_NAMES } from './event-map/event-map';
-
-// [TODO] add callback for web
-export type tTrack = <T extends EVENT_NAMES>(eventName: T, eventParams: EVENT_MAP[T]) => void;
-
-/**
- * Segment React Native params type: JSONMap
- */
-export type JsonList = Array<JsonValue>;
-export type JsonValue = boolean | number | string | null | JsonList | JsonMap | undefined;
-export interface JsonMap {
-  [key: string]: JsonValue;
-  [index: number]: JsonValue;
-}
-
-/** */
-
-type tWebScreen = (
-  category?: string,
-  name?: string,
-  properties?: Record<string, unknown>,
-  options?: Record<string, unknown>,
-  callback?: () => void,
-) => void;
-
-type tRNScreen = (name: string, properties?: JsonMap) => void;
-
-export type tScreen = tWebScreen | tRNScreen;
-
-export type tPLATFORM = 'REACT_NATIVE' | 'WEB' | 'NODE';
-
-export type tAPP = 'VENDOR_APP' | 'CONSUMER_APP' | 'CONSUMER_WEB';
-
-export interface AnalyticsInit {
-  platform: tPLATFORM;
-  App: tAPP;
-  segment: boolean;
-  pixel: boolean;
-}
-
-export interface IAnalyticsWrapper {
-  track: tTrack;
-  identify: () => void;
-  screen: tScreen;
-  type: string;
-}
-
-type tInit = (params: AnalyticsInit) => Promise<IAnalyticsWrapper>;
-
-export { tInit };