@magicpixel/rn-mp-client-sdk 0.2.0

package/lib/typescript/processors/data-element.processor.d.ts

@@ -0,0 +1,12 @@
+import type { MapLike } from '../common/app-types';
+import type { ClientSdkDeItem } from '../models/mp-client-sdk';
+export declare class DataElementProcessor {
+    /**
+     * Process all the data elements at once, or if a set of keys are specified, processes only
+     * those keys and updates the dataElements object in global-fns file
+     * @param sdkDataElements
+     * @param eventData
+     * @param optDeKeys
+     */
+    static processDataElements(sdkDataElements: MapLike<ClientSdkDeItem>, eventData?: Record<string, any>, optDeKeys?: string[]): Promise<MapLike<any>>;
+}

package/lib/typescript/processors/qc.processor.d.ts

@@ -0,0 +1,4 @@
+import type { ClientSdkQcItem } from '../models/mp-client-sdk';
+export declare class QcProcessor {
+    static processQc(sdkQc: ClientSdkQcItem[], eventName: string, evtId: string): string[];
+}

package/lib/typescript/processors/tag.processor.d.ts

@@ -0,0 +1,27 @@
+export declare class TagProcessor {
+    private static findApplicableTags;
+    /**
+     * Core function which actually puts the tag on page based on the tag type (JS or Image)
+     * @param eventName
+     * @param evtId
+     */
+    static processTags(eventName: string, evtId: string): Promise<void>;
+    /**
+     * Takes all the placeholders in a tag and replaces them with actual values from data elements or
+     * actual static values. Method returns an object with errCd and replaced content and a boolean identifier
+     * to denote if this process failed or not
+     * @param tagInfo
+     * @param tag
+     * @param provider
+     * @param prStatus
+     * @param dataElements
+     * @param transFunctions
+     */
+    private static hydrateTag;
+    private static findPlaceHolders;
+    private static resourceParamsToActualValues;
+    private static parseParamValue;
+    private static replacePlaceHolders;
+    private static checkTagDateValidity;
+    private static replaceValues;
+}

package/lib/typescript/processors/trans-function.processor.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Process all the data elements at once, or if a set of keys are specified, processes only
+ * those keys and updates the dataElements object in global-fns file
+ * @param dataElements
+ * @param sdkTransFunctions
+ * @param optTfnKeys
+ */
+import type { MapLike } from '../common/app-types';
+import type { ClientSdkTfnItem } from '../models/mp-client-sdk';
+export declare class TransFunctionProcessor {
+    static processTransformationFunctions(dataElements: MapLike<any>, sdkTransFunctions: MapLike<ClientSdkTfnItem>, optTfnKeys?: string[]): MapLike<any>;
+}

package/lib/typescript/processors/visit-id.processor.d.ts

@@ -0,0 +1,7 @@
+export declare class VisitIdProcessor {
+    static init(): Promise<void>;
+    static initIdlEventListener(): Promise<void>;
+    static initDebugId(): Promise<void>;
+    static setOrResetVisitInfo(): Promise<void>;
+    static setOrResetVisitorId(): Promise<void>;
+}

package/package.json

@@ -0,0 +1,170 @@
+{
+  "name": "@magicpixel/rn-mp-client-sdk",
+  "version": "0.2.0",
+  "description": "test",
+  "main": "lib/commonjs/index",
+  "module": "lib/module/index",
+  "types": "lib/typescript/index.d.ts",
+  "react-native": "src/index",
+  "source": "src/index",
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "rn-mp-client-sdk.podspec",
+    "!lib/typescript/example",
+    "!android/build",
+    "!ios/build",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__"
+  ],
+  "scripts": {
+    "test": "jest",
+    "typescript": "tsc --noEmit",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "prepare": "bob build",
+    "release": "release-it",
+    "example": "yarn --cwd example",
+    "bootstrap": "yarn example && yarn && yarn example pods",
+    "postpublish": "node quick-version-increment.js"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "repository": "https://github.com/mp",
+  "author": "MP Engineering <engineering@magicpixel.io> (https://magicpixel.io)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/mp/issues"
+  },
+  "homepage": "https://github.com/mp#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "devDependencies": {
+    "@arkweid/lefthook": "^0.7.7",
+    "@babel/eslint-parser": "^7.18.2",
+    "@commitlint/config-conventional": "^17.0.2",
+    "@react-native-community/eslint-config": "^3.0.2",
+    "@release-it/conventional-changelog": "^5.0.0",
+    "@types/flat": "^5.0.2",
+    "@types/jest": "29.0.3",
+    "@types/react": "~17.0.21",
+    "@types/react-native": "0.68.0",
+    "commitlint": "^17.0.2",
+    "eslint": "^8.4.1",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "jest": "29.1.1",
+    "pod-install": "^0.1.0",
+    "prettier": "^2.0.5",
+    "react": "17.0.2",
+    "react-native": "0.68.2",
+    "react-native-builder-bob": "^0.18.3",
+    "release-it": "^15.0.0",
+    "ts-jest": "^29.0.2",
+    "tsconfig-paths": "^4.1.0",
+    "typescript": "^4.5.2"
+  },
+  "resolutions": {
+    "@types/react": "17.0.21"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "jest": {
+    "preset": "react-native",
+    "transform": {
+      ".+\\.(t|j)s$": "ts-jest"
+    },
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": "angular"
+      }
+    }
+  },
+  "eslintConfig": {
+    "root": true,
+    "parser": "@babel/eslint-parser",
+    "extends": [
+      "@react-native-community",
+      "prettier"
+    ],
+    "rules": {
+      "prettier/prettier": [
+        "error",
+        {
+          "quoteProps": "consistent",
+          "singleQuote": true,
+          "tabWidth": 2,
+          "trailingComma": "es5",
+          "useTabs": false
+        }
+      ]
+    }
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "lib/"
+  ],
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      "commonjs",
+      "module",
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "dependencies": {
+    "@react-native-async-storage/async-storage": "^1.17.10",
+    "@react-native-firebase/analytics": "^15.6.0",
+    "@react-native-firebase/app": "^15.6.0",
+    "expo-device": "^4.3.0",
+    "flat": "^5.0.2",
+    "nanoid": "^4.0.0",
+    "performant-array-to-tree": "^1.11.0",
+    "react-native-event-listeners": "^1.0.7",
+    "ts-node": "^10.9.1"
+  }
+}

package/src/common/app-types.ts

@@ -0,0 +1,128 @@
+import type { Logger } from './logger';
+
+export interface MapLike<T = any> {
+  [key: string]: T;
+}
+
+export interface RunQueueModel {
+  sseOnly: boolean;
+  name: string;
+  dcrName: string;
+  eventId: string;
+  dcrPayload?: Record<string, any>;
+}
+
+export type TypedAny = Record<
+  string,
+  | string
+  | number
+  | boolean
+  | string[]
+  | boolean[]
+  | number[]
+  | Record<string, string | number | boolean | string[] | boolean[] | number[]>
+>;
+
+export type EventProcessorFn = (payload: TypedAny) => void;
+
+export interface AppCustomerInfo {
+  first_name?: string;
+  last_name?: string;
+  email?: string;
+  phone_number: number;
+  country_code: number;
+  city?: string;
+  state?: string;
+  country?: string;
+}
+
+export interface AppPageLoad {
+  page_name: string;
+  is_entry?: number;
+}
+
+export interface DeJsvHelper {
+  log: typeof Logger.logDbg;
+  err: typeof Logger.logError;
+}
+
+export interface QcInfoItem {
+  nm: string;
+  id: string;
+  st: boolean;
+}
+
+export interface TagInfoItem {
+  id: string;
+  nm: string;
+  pr: string;
+  prNm: string;
+  status: boolean;
+  qc: string | string[];
+}
+
+export type ReplaceMode = 'kph' | 'rph';
+
+export interface HydrateTagInfo {
+  isInError: boolean;
+  content: string | number | null;
+  errCd: string; // error code
+  errMsg: string; // any descriptive error message
+}
+
+export interface ReportTagItem {
+  st: 200 | 900 | 1000 | number; // what happened to this tag?
+  t: string; // tag id
+  p: string; // provider id
+  tNm: string;
+  req: any; // request payload
+}
+
+export interface Report {
+  envName: string; // environment name inside magic pixel
+  envId: string; // environment id inside magic pixel
+  pname?: string; // page name
+  evt: string; // dcr event if that triggered this report
+  evtId: string; // event id
+  dt?: number; // device type (converted to int)
+  ln?: number; // language (converted to int)
+  bw?: number; // browser name (converted to int)
+  dm?: string; // clean domain name
+  items: ReportTagItem[]; // list of tag items fired on that page for that condition
+  tagCt: number; // expected tag count on this page
+  dws: 'j' | 'n'; // down stream configuration. java or node
+  v: string; // client sdk version for this call
+}
+
+export interface UrlInfo {
+  tfUrl: string;
+  errUrl: string;
+  rptUrl: string;
+  infoUrl: string;
+  baseUrl: string;
+  attrInfoUrl: string;
+  idlUrl: string;
+}
+
+export interface VisitInfo {
+  visitId: string;
+  visitTs: number;
+  visitCt: number;
+  visitDepth: number;
+  visitVer: number;
+}
+
+export interface VisitorInfo {
+  dId: string;
+  mId: string;
+  st: number;
+}
+
+export interface SdkInitOptions {
+  orgId: string;
+  env: string;
+  projectId: string;
+  baseUrl: string;
+}
+
+export type EventBusCallback = (event: string, payload: any) => void;

package/src/common/constants.ts

@@ -0,0 +1,43 @@
+import { customAlphabet } from 'nanoid/non-secure';
+import type { BaseResourceParamType } from '../models/mp-client-sdk';
+
+export class Constants {
+  static PLACEHOLDER_REGEX = new RegExp(/({{)([A-Z_0-9 -]+)(}})/gi);
+
+  static LARGE_RANDOM_POOL = customAlphabet(
+    '1234567090abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ',
+    21
+  );
+
+  static MP_DL_EVT = 'mp_dl_event';
+  static CUST_EVT = 'custom_event';
+
+  // Tag Report - Status Constants
+  static ST_OK = 200; // tag fired successfully
+  static ST_VAL_FAIL = 400; // tag validation failed - meaning one of the items marked as mandatory was found empty
+  static ST_ERR = 500; // tag was ok, but provider side failure. may be url is constructed wrong, or provider is down
+  static ST_DEP_FAIL = 1000; // processing tag dependencies failed - may be missing parameters or attributes
+  static ST_PR_BL = 1002; // provider is black listed in the data governance screen
+  static ST_PR_EXC = 1001; // tag was found, but no provider was bundled. SDK build issue. Report with high importance
+
+  static PR_TYP_JS = 'js';
+  static PR_TYP_IMG = 'img';
+  static PR_TYP_APP = 'app';
+
+  static PR_S_TYP_R = 'r';
+
+  static sortAscending = (
+    a: BaseResourceParamType,
+    b: BaseResourceParamType
+  ): number => (a.o > b.o ? 1 : -1);
+
+  // this data structure is returned by the api and stored in this key
+  // {"dId":"VNiBG7JNfoGAyvqxhxMqd","mId":"JW0FRrCtAj9K7uyNmL1ht","st":0}
+  static KEY_MP_IDL_VISITOR_ID_INFO = 'mp_idl_visitor_info';
+
+  // visitor info data structure
+  // {"visitId": "123123sdfsf", "visitCt": 1, "visitDepth": 1, visitVer: 1}
+  static KEY_MP_IDL_VISIT_ID_INFO = 'mp_idl_visit_info';
+
+  static KEY_MP_DEBUG_ID = 'mp_debug_id';
+}