@cpdunphy/neuroid-reactnative-sdk 3.6.3

package/package.json

@@ -0,0 +1,162 @@
+{
+  "name": "@cpdunphy/neuroid-reactnative-sdk",
+  "version": "3.6.3",
+  "description": "Official NeuroID React Native SDK",
+  "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",
+    "neuroid-reactnative-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",
+    "postinstall": "patch-package",
+    "bootstrap": "yarn"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "repository": "https://github.com/cpdunphy-nid/neuroid",
+  "author": "NeuroID <engineering@neuro-id.com> (https://github.com/Neuro-ID/neuroid-reactnative-sdk)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Neuro-ID/neuroid-reactnative-sdk/issues"
+  },
+  "homepage": "https://github.com/Neuro-ID/neuroid-reactnative-sdk#readme",
+  "devDependencies": {
+    "@commitlint/config-conventional": "^17.7.0",
+    "@react-native-community/eslint-config": "^3.2.0",
+    "@release-it/conventional-changelog": "^10.0.0",
+    "@types/jest": "^29.5.5",
+    "@types/react": "^18.2.24",
+    "commitlint": "^17.7.2",
+    "eslint": "^8.50.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "husky": "^8.0.3",
+    "jest": "^29.7.0",
+    "pod-install": "^0.1.0",
+    "prettier": "^3.0.3",
+    "react": "18.2.0",
+    "react-native": "0.74.0",
+    "react-native-builder-bob": "^0.18.0",
+    "react-scripts": "^0.0.0",
+    "release-it": "^19.0.2",
+    "typescript": "^4.1.3",
+    "yarn-audit-fix": "^10.0.7"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": ">=0.73.0"
+  },
+  "jest": {
+    "preset": "react-native",
+    "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,
+    "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-community/cli-platform-android": "^7.0.1",
+    "patch-package": "^8.0.0",
+    "postinstall-postinstall": "^2.1.0",
+    "react-dev-utils": "^12.0.1"
+  },
+  "resolutions": {
+    "nth-check": "2.0.1",
+    "postcss": "8.4.35"
+  },
+  "overrides": {
+    "body-parser": "^1.20.3",
+    "rollup": "^3.29.5",
+    "path-to-regexp": "^0.1.10",
+    "nth-check": "^2.0.1",
+    "cross-spawn": "^7.0.5",
+    "postcss": "8.4.35"
+  }
+}

package/src/index.tsx

@@ -0,0 +1,274 @@
+import { NativeModules, Platform } from 'react-native';
+import type {
+  NeuroIDClass,
+  NeuroIDConfigOptions,
+  SessionStartResult,
+} from './types';
+import { version } from '../package.json';
+import NeuroIDLog from './logger';
+
+const LINKING_ERROR =
+  `The package 'neuroid-reactnative-sdk' doesn't seem to be linked. Make sure: \n\n` +
+  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
+  '- You rebuilt the app after installing the package\n' +
+  '- You are not using Expo managed workflow\n';
+
+const NeuroidReactnativeSdk = NativeModules.NeuroidReactnativeSdk
+  ? NativeModules.NeuroidReactnativeSdk
+  : new Proxy(
+      {},
+      {
+        get() {
+          throw new Error(LINKING_ERROR);
+        },
+      }
+    );
+
+var usingRNNavigation = false;
+
+export const NeuroID: NeuroIDClass = {
+  configure: async function configure(
+    apiKey: string,
+    configOptions?: NeuroIDConfigOptions
+  ): Promise<boolean> {
+    usingRNNavigation = !!configOptions?.usingReactNavigation;
+
+    const pattern = /key_(live|test)_[A-Za-z0-9]+/;
+    if (!pattern.test(apiKey)) {
+      NeuroIDLog.e('Invalid API Key');
+      return Promise.resolve(false);
+    }
+
+    const configured = await NeuroidReactnativeSdk.configure(
+      apiKey,
+      configOptions
+    );
+
+    return Promise.resolve(configured);
+  },
+
+  enableLogging: function enableLogging(enable?: boolean): Promise<void> {
+    NeuroIDLog.enableLogging(enable);
+
+    if (enable) {
+      NeuroIDLog.i('Logging Enabled');
+    }
+
+    return Promise.resolve(NeuroidReactnativeSdk.enableLogging(enable));
+  },
+
+  excludeViewByTestID: function excludeViewByTestID(
+    excludedView: string
+  ): Promise<void> {
+    return Promise.resolve(
+      NeuroidReactnativeSdk.excludeViewByTestID(excludedView)
+    );
+  },
+
+  getClientID: function getClientID(): Promise<string> {
+    return Promise.resolve(NeuroidReactnativeSdk.getClientID());
+  },
+
+  getEnvironment: function getEnvironment(): Promise<string> {
+    return Promise.resolve(NeuroidReactnativeSdk.getEnvironment());
+  },
+
+  getSDKVersion: function getSDKVersion(): Promise<string> {
+    return new Promise((res) => res(`React-Native:${version}`));
+  },
+
+  getScreenName: function getScreenName(): Promise<string> {
+    return Promise.resolve(NeuroidReactnativeSdk.getScreenName());
+  },
+
+  getSessionID: function getSessionID(): Promise<string> {
+    return Promise.resolve(NeuroidReactnativeSdk.getSessionID());
+  },
+
+  getUserID: function getUserID(): Promise<string> {
+    return Promise.resolve(NeuroidReactnativeSdk.getUserID());
+  },
+
+  getRegisteredUserID: function getUserID(): Promise<string> {
+    return Promise.resolve(NeuroidReactnativeSdk.getRegisteredUserID());
+  },
+
+  isStopped: function isStopped(): Promise<boolean> {
+    return Promise.resolve(NeuroidReactnativeSdk.isStopped());
+  },
+
+  setEnvironmentProduction: function setEnvironmentProduction(value: Boolean) {
+    NeuroIDLog.i('**** NOTE: THIS METHOD IS DEPRECATED');
+    NeuroIDLog.d(`Environment Being Set - ${value ? 'Production' : 'Test'}`);
+    return Promise.resolve();
+  },
+
+  setScreenName: function setScreenName(screenName: string): Promise<boolean> {
+    NeuroIDLog.d('setScreenName()', screenName);
+    return Promise.resolve(NeuroidReactnativeSdk.setScreenName(screenName));
+  },
+
+  setSiteId: function setSiteId(siteId: string): Promise<void> {
+    // Pre-release
+    NeuroIDLog.i('SiteID set ', siteId);
+    NeuroIDLog.i('**** NOTE: THIS METHOD IS DEPRECATED');
+    return Promise.resolve(NeuroidReactnativeSdk.setSiteId(siteId));
+  },
+
+  setUserID: function setUserID(userID: string): Promise<boolean> {
+    NeuroIDLog.i('Setting User ID: ', userID);
+
+    return new Promise((resolve, reject) => {
+      const result = NeuroidReactnativeSdk.setUserID(userID);
+
+      if (result) {
+        resolve(true);
+      } else {
+        NeuroIDLog.e('Failed to set user ID');
+        reject(false);
+      }
+    });
+  },
+
+  setRegisteredUserID: function setRegisteredUserID(
+    userID: string
+  ): Promise<boolean> {
+    NeuroIDLog.i('Setting Registered User ID: ', userID);
+
+    return new Promise((resolve, reject) => {
+      const result = NeuroidReactnativeSdk.setRegisteredUserID(userID);
+
+      if (result) {
+        resolve(true);
+      } else {
+        NeuroIDLog.e('Failed to set registered user ID');
+        reject(false);
+      }
+    });
+  },
+
+  attemptedLogin: function attemptedLogin(userID: string): Promise<boolean> {
+    NeuroIDLog.i('Attempted Login User ID: ', userID);
+
+    return new Promise((resolve, reject) => {
+      const result = NeuroidReactnativeSdk.attemptedLogin(userID ?? '');
+
+      if (result) {
+        resolve(true);
+      } else {
+        NeuroIDLog.e('Failed to set attmpted login user ID');
+        reject(false);
+      }
+    });
+  },
+
+  setVerifyIntegrationHealth: function setVerifyIntegrationHealth(
+    value: Boolean
+  ) {
+    if (value)
+      NeuroIDLog.i(
+        'Please view the Xcode or Android Studio console to see instructions on how to access The Integration Health Report'
+      );
+
+    return Promise.resolve(
+      NeuroidReactnativeSdk.setVerifyIntegrationHealth(value)
+    );
+  },
+
+  setVariable: function setVariable(key: string, value: string): Promise<void> {
+    return new Promise(async function (resolve) {
+      NeuroIDLog.d(`Setting Variable - ${key}: ${value}`);
+      await NeuroidReactnativeSdk.setVariable(key, value);
+      resolve();
+    });
+  },
+
+  start: function start(): Promise<Boolean> {
+    return new Promise(async function (resolve) {
+      try {
+        const result = await Promise.resolve(NeuroidReactnativeSdk.start());
+        let _cid = await NeuroidReactnativeSdk.getSessionID();
+
+        NeuroIDLog.d('NeuroID Started: ', result);
+        NeuroIDLog.i('Client ID:', _cid);
+        resolve(result);
+      } catch (e: any) {
+        NeuroIDLog.e('Failed to start NID', e);
+        resolve(false);
+      }
+    });
+  },
+
+  stop: function stop(): Promise<Boolean> {
+    return new Promise(async function (resolve) {
+      try {
+        const result = await Promise.resolve(NeuroidReactnativeSdk.stop());
+        resolve(result);
+        NeuroIDLog.d('NeuroID Stopped: ', result);
+      } catch (e: any) {
+        NeuroIDLog.e('Failed to stop NID', e);
+        resolve(false);
+      }
+    });
+  },
+
+  registerPageTargets: function registerPageTargets(): Promise<void> {
+    if (Platform.OS === 'ios') {
+      if (!usingRNNavigation) {
+        return Promise.resolve(NeuroidReactnativeSdk.registerPageTargets());
+      } else {
+        return Promise.resolve();
+      }
+    }
+    return Promise.resolve(NeuroidReactnativeSdk.registerPageTargets());
+  },
+
+  setupPage: async function setupPage(screenName: string): Promise<void> {
+    await Promise.resolve(NeuroidReactnativeSdk.setScreenName(screenName));
+
+    return Promise.resolve(NeuroidReactnativeSdk.registerPageTargets());
+  },
+
+  startSession: async function startSession(
+    sessionID?: string
+  ): Promise<SessionStartResult> {
+    const result = await NeuroidReactnativeSdk.startSession(sessionID);
+    NeuroIDLog.d('startSession(): ' + result.sessionID + ' ' + result.started);
+    return Promise.resolve({
+      sessionID: result.sessionID as string,
+      started: result.started as boolean,
+    } as SessionStartResult);
+  },
+
+  stopSession: async function stopSession(): Promise<boolean> {
+    let result = await NeuroidReactnativeSdk.stopSession();
+    NeuroIDLog.d('stopSession(): ' + result);
+    return Promise.resolve(result);
+  },
+
+  pauseCollection: async function pauseCollection(): Promise<void> {
+    NeuroidReactnativeSdk.pauseCollection();
+    NeuroIDLog.d('pauseCollection()');
+    return Promise.resolve();
+  },
+
+  resumeCollection: async function resumeCollection(): Promise<void> {
+    NeuroidReactnativeSdk.resumeCollection();
+    NeuroIDLog.d('resumeCollection()');
+    return Promise.resolve();
+  },
+
+  startAppFlow: async function startAppFlow(
+    siteID: string,
+    userID?: string
+  ): Promise<SessionStartResult> {
+    const result = await NeuroidReactnativeSdk.startAppFlow(siteID, userID);
+    NeuroIDLog.d('startAppFlow(): ' + result.sessionID + ' ' + result.started);
+    return Promise.resolve({
+      sessionID: result.sessionID as string,
+      started: result.started as boolean,
+    } as SessionStartResult);
+  },
+};
+
+export default NeuroID;

package/src/logger.tsx

@@ -0,0 +1,30 @@
+import type { NeuroIDLogClass } from './types';
+
+var showlogs = true;
+export const NeuroIDLog: NeuroIDLogClass = {
+  enableLogging: function enableLogging(value?: boolean) {
+    showlogs = value === false ? false : true;
+  },
+  log: function log(...message: String[]) {
+    if (showlogs) {
+      console.log('(NeuroID) ', message);
+    }
+  },
+  d: function d(...message: String[]) {
+    if (showlogs) {
+      console.debug('(NeuroID Debug) ', message);
+    }
+  },
+  i: function i(...message: String[]) {
+    if (showlogs) {
+      console.info('(NeuroID Info) ', message);
+    }
+  },
+  e: function e(...message: String[]) {
+    if (showlogs) {
+      console.error('****** NeuroID ERROR: ******\n', message);
+    }
+  },
+};
+
+export default NeuroIDLog;

package/src/types.js

@@ -0,0 +1 @@
+export {};

package/src/types.ts

@@ -0,0 +1,61 @@
+export interface NeuroIDClass {
+  configure: (
+    apiKey: string,
+    options: NeuroIDConfigOptions
+  ) => Promise<boolean>;
+  enableLogging: (enable?: boolean) => Promise<void>;
+  excludeViewByTestID: (excludedView: string) => Promise<void>;
+
+  getClientID: () => Promise<string>;
+  getEnvironment: () => Promise<string>;
+  getSDKVersion: () => Promise<string>; // JS side not native
+  getScreenName: () => Promise<string>; // ios, NOT Android
+  getSessionID: () => Promise<string>;
+  getUserID: () => Promise<string>;
+  getRegisteredUserID: () => Promise<string>;
+
+  isStopped: () => Promise<boolean>;
+  setEnvironmentProduction: (value: Boolean) => Promise<void>; // deprecated
+  setScreenName: (screenName: string) => Promise<boolean>;
+  setSiteId: (siteId: string) => Promise<void>; // deprecated
+  setUserID: (userID: string) => Promise<boolean>;
+  setRegisteredUserID: (userID: string) => Promise<boolean>;
+  attemptedLogin: (userID: string) => Promise<boolean>;
+  setVerifyIntegrationHealth: (value: Boolean) => Promise<void>;
+  setVariable(key: string, value: string): Promise<void>;
+
+  start: () => Promise<Boolean>;
+  stop: () => Promise<Boolean>;
+
+  registerPageTargets: () => Promise<void>;
+  setupPage: (screenName: string) => Promise<void>;
+  startSession: (sessionID?: string) => Promise<SessionStartResult>;
+  stopSession: () => Promise<boolean>;
+  resumeCollection: () => Promise<void>;
+  pauseCollection: () => Promise<void>;
+  startAppFlow: (
+    siteID: string,
+    userID?: string
+  ) => Promise<SessionStartResult>;
+}
+
+export interface NeuroIDConfigOptions {
+  usingReactNavigation: boolean;
+  isAdvancedDevice: boolean;
+  environment: string;
+  advancedDeviceKey?: string;
+  useAdvancedDeviceProxy: boolean;
+}
+
+export interface NeuroIDLogClass {
+  enableLogging: (enable?: boolean) => void;
+  log: (...message: String[]) => void;
+  d: (...message: String[]) => void;
+  i: (...message: String[]) => void;
+  e: (...message: String[]) => void;
+}
+
+export interface SessionStartResult {
+  started: boolean;
+  sessionID: String;
+}