@rebilly/risk-data-collector 2.3.0 → 2.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rebilly/risk-data-collector",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Microlibrary that collects browser data for risk assessment",
   "type": "module",
   "main": "dist/data-collector.js",
@@ -16,7 +16,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/Rebilly/risk-data-collector"
+    "url": "https://github.com/Rebilly/rebilly"
   },
   "keywords": [
     "rebilly",
@@ -25,6 +25,10 @@
     "3ds2",
     "payment"
   ],
+  "files": [
+    "dist",
+    "CHANGELOG.md"
+  ],
   "dependencies": {
     "@babel/runtime": "^7.10.1",
     "@fingerprintjs/fingerprintjs": "^3.3.3"

package/.babelrc.json

@@ -1,5 +0,0 @@
-{
-    "presets": ["@babel/preset-env"],
-    "plugins": ["@babel/plugin-transform-runtime"]
-}
-

package/.browserslistrc

@@ -1,3 +0,0 @@
-> 1%
-last 2 versions
-ie >= 11

package/.eslintrc.json

@@ -1,21 +0,0 @@
-{
-    "env": {
-        "browser": true,
-        "es6": true
-    },
-    "extends": [
-        "airbnb-base"
-    ],
-    "globals": {
-        "Atomics": "readonly",
-        "SharedArrayBuffer": "readonly"
-    },
-    "parserOptions": {
-        "ecmaVersion": 2018,
-        "sourceType": "module"
-    },
-    "rules": {
-        "no-restricted-globals": "off",
-        "import/prefer-default-export": "off"
-    }
-}

package/.github/workflows/pr.yaml

@@ -1,18 +0,0 @@
-name: Build
-
-on: pull_request
-
-jobs:
-  build-package:
-    runs-on: ubuntu-latest
-    name: Test and build package
-    steps:
-      - uses: actions/checkout@v2
-      - name: Setup node
-        uses: actions/setup-node@v1
-        with:
-          node-version: 12
-      - run: yarn install --frozen-lockfile --non-interactive
-      - run: yarn lint
-      - run: yarn test
-      - run: yarn build

package/.github/workflows/publish.yaml

@@ -1,21 +0,0 @@
-name: Publish
-
-on:
-  release:
-    types: [published]
-
-jobs:
-  build-and-publish:
-    runs-on: ubuntu-latest
-    name: Build and publish on npm
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 12
-          registry-url: https://registry.npmjs.org/
-      - run: yarn install --frozen-lockfile --non-interactive
-      - run: yarn build
-      - run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/cypress/integration/data-collector.spec.js

@@ -1,140 +0,0 @@
-/* eslint-disable no-self-compare, no-undef, no-confusing-arrow */
-import { collectData, collectDataHelper } from '../../src/data-collector';
-import getFingerprint from '../../src/fingerprint';
-import getFraudSessionId from '../../src/kount';
-import {
-  dataWithAllArguments,
-  dataMissingScreen,
-  dataMissingNavigator,
-  dataMissingFingerprintJs,
-  dataMissingKount,
-  dataMissingAllArguments,
-} from '../test-data';
-
-const isNull = (x) => !x && typeof x === 'object';
-const getType = (value) => isNull(value) ? null : typeof value;
-
-const getTypes = (data) => {
-  const dataTypes = {};
-
-  Object.entries(data)
-    .forEach(([key, value]) => {
-      if (!isNull(value) && typeof value === 'object') {
-        dataTypes[key] = getTypes(value);
-      } else {
-        dataTypes[key] = getType(value);
-      }
-    });
-
-  return dataTypes;
-};
-
-const env = 'sandbox';
-const kountAccountId = '700000';
-
-describe('collectData', () => {
-  it('Returns an object', async () => {
-    const browserData = await collectData({ env, kountAccountId });
-
-    expect(browserData).to.be.a('object');
-  });
-
-  it('Works when Kount configurations are omitted', async () => {
-    const browserData = await collectData();
-
-    expect(browserData).to.be.a('object');
-    expect(getTypes(browserData)).to.deep.equal(dataMissingKount);
-  });
-
-  it('browserData has the correct property types', async () => {
-    const browserData = getTypes(await collectData({ env, kountAccountId }));
-
-    expect(browserData).to.deep.equal(dataWithAllArguments);
-  });
-});
-
-describe('collectDataHelper', () => {
-  it('Returns an object when it receives all arguments', async () => {
-    const browserData = await collectDataHelper({
-      env,
-      screen,
-      navigator,
-      kountAccountId,
-      getFingerprint,
-      getFraudSessionId,
-    });
-
-    expect(browserData).to.be.a('object');
-  });
-
-  it('Uses fallback values whenever screen is missing', async () => {
-    const browserData = getTypes(await collectDataHelper({
-      env,
-      screen: null,
-      navigator,
-      kountAccountId,
-      getFingerprint,
-      getFraudSessionId,
-    }));
-
-    expect(browserData).to.deep.equal(dataMissingScreen);
-  });
-
-  it('Uses fallback values whenever navigator is missing', async () => {
-    const browserData = getTypes(await collectDataHelper({
-      env,
-      screen,
-      navigator: null,
-      kountAccountId,
-      getFingerprint,
-      getFraudSessionId,
-    }));
-
-    expect(browserData).to.deep.equal(dataMissingNavigator);
-  });
-
-  it('Uses fallback values whenever fingerprinterjs2 fails', async () => {
-    const mockFingerprint = () => new Promise((resolve) => {
-      resolve('');
-    });
-
-    const browserData = getTypes(await collectDataHelper({
-      env,
-      screen,
-      navigator,
-      kountAccountId,
-      getFingerprint: mockFingerprint,
-      getFraudSessionId,
-    }));
-
-    expect(browserData).to.deep.equal(dataMissingFingerprintJs);
-  });
-
-  it('Uses fallback values whenever Kount fails', async () => {
-    const mockKount = () => new Promise((resolve) => {
-      resolve('');
-    });
-
-    const browserData = getTypes(await collectDataHelper({
-      env,
-      screen,
-      navigator,
-      kountAccountId,
-      getFingerprint,
-      getFraudSessionId: mockKount,
-    }));
-
-    expect(browserData).to.deep.equal(dataMissingKount);
-  });
-
-  it('Uses fallback values if all arguments are missing', async () => {
-    const browserData = getTypes(await collectDataHelper({
-      screen: null,
-      navigator: null,
-      getFingerprint: null,
-      getFraudSessionId: null,
-    }));
-
-    expect(browserData).to.deep.equal(dataMissingAllArguments);
-  });
-});

package/cypress/test-data/index.js

@@ -1,110 +0,0 @@
-const dataWithAllArguments = {
-  riskMetadata: {
-    fingerprint: 'string',
-    extraData: {
-      kountFraudSessionId: 'string',
-    },
-    browserData: {
-      colorDepth: 'number',
-      isJavaEnabled: 'boolean',
-      language: 'string',
-      screenHeight: 'number',
-      screenWidth: 'number',
-      timeZoneOffset: 'number',
-    },
-  },
-};
-
-const dataMissingScreen = {
-  riskMetadata: {
-    fingerprint: 'string',
-    extraData: {
-      kountFraudSessionId: 'string',
-    },
-    browserData: {
-      colorDepth: null,
-      isJavaEnabled: 'boolean',
-      language: 'string',
-      screenHeight: null,
-      screenWidth: null,
-      timeZoneOffset: 'number',
-    },
-  },
-};
-
-const dataMissingNavigator = {
-  riskMetadata: {
-    fingerprint: 'string',
-    extraData: {
-      kountFraudSessionId: 'string',
-    },
-    browserData: {
-      colorDepth: 'number',
-      isJavaEnabled: null,
-      language: null,
-      screenHeight: 'number',
-      screenWidth: 'number',
-      timeZoneOffset: 'number',
-    },
-  },
-};
-
-const dataMissingFingerprintJs = {
-  riskMetadata: {
-    fingerprint: null,
-    extraData: {
-      kountFraudSessionId: 'string',
-    },
-    browserData: {
-      colorDepth: 'number',
-      isJavaEnabled: 'boolean',
-      language: 'string',
-      screenHeight: 'number',
-      screenWidth: 'number',
-      timeZoneOffset: 'number',
-    },
-  },
-};
-
-const dataMissingKount = {
-  riskMetadata: {
-    fingerprint: 'string',
-    extraData: {
-      kountFraudSessionId: null,
-    },
-    browserData: {
-      colorDepth: 'number',
-      isJavaEnabled: 'boolean',
-      language: 'string',
-      screenHeight: 'number',
-      screenWidth: 'number',
-      timeZoneOffset: 'number',
-    },
-  },
-};
-
-const dataMissingAllArguments = {
-  riskMetadata: {
-    fingerprint: null,
-    extraData: {
-      kountFraudSessionId: null,
-    },
-    browserData: {
-      colorDepth: null,
-      isJavaEnabled: null,
-      language: null,
-      screenHeight: null,
-      screenWidth: null,
-      timeZoneOffset: 'number',
-    },
-  },
-};
-
-export {
-  dataWithAllArguments,
-  dataMissingScreen,
-  dataMissingNavigator,
-  dataMissingFingerprintJs,
-  dataMissingKount,
-  dataMissingAllArguments,
-};

package/cypress.json

@@ -1,6 +0,0 @@
-{
-  "video": false,
-  "fixturesFolder": false,
-  "pluginsFile": false,
-  "supportFile": false
-}

package/rollup.config.js

@@ -1,27 +0,0 @@
-import babel from '@rollup/plugin-babel';
-import resolve from '@rollup/plugin-node-resolve';
-import commonjs from '@rollup/plugin-commonjs';
-import { terser } from 'rollup-plugin-terser';
-
-
-export default {
-  input: 'src/data-collector.js',
-  output: [
-    {
-      file: 'dist/data-collector.min.js',
-      format: 'iife',
-      name: 'RiskDataCollector',
-      sourcemap: true,
-    },
-    {
-      file: 'dist/data-collector.js',
-      format: 'es',
-    },
-  ],
-  plugins: [
-    resolve(),
-    commonjs(),
-    babel({ babelHelpers: 'runtime', skipPreflightCheck: true }),
-    terser(),
-  ],
-};

package/src/data-collector.js

@@ -1,72 +0,0 @@
-/* eslint-disable no-console */
-import fingerprinter from './fingerprint';
-import kount from './kount';
-
-async function collectDataHelper({
-  env = null,
-  screen,
-  navigator,
-  kountAccountId = null,
-  kountSessionId = null,
-  getFingerprint,
-  getFraudSessionId,
-}) {
-  const {
-    colorDepth,
-    height: screenHeight,
-    width: screenWidth,
-  } = screen || {};
-  const {
-    javaEnabled,
-    language,
-  } = navigator || {};
-  let fingerprint;
-  let kountFraudSessionId;
-
-  try {
-    fingerprint = await getFingerprint();
-
-    if (kountAccountId) {
-      kountFraudSessionId = await getFraudSessionId({ env, kountAccountId, kountSessionId });
-    }
-  } catch (e) {
-    console.error(e);
-  }
-
-  const data = {
-    riskMetadata: {
-      fingerprint: fingerprint || null,
-      extraData: {
-        kountFraudSessionId: kountFraudSessionId || null,
-      },
-      browserData: {
-        colorDepth: colorDepth || null,
-        isJavaEnabled: javaEnabled ? javaEnabled.call(navigator) : null,
-        language: language || null,
-        screenHeight: screenHeight || null,
-        screenWidth: screenWidth || null,
-        timeZoneOffset: (new Date()).getTimezoneOffset(),
-      },
-    },
-  };
-
-  return data;
-}
-
-async function collectData({
-  env = null,
-  kountAccountId = null,
-  kountSessionId = null,
-} = {}) {
-  return collectDataHelper({
-    env,
-    screen,
-    navigator,
-    kountAccountId,
-    kountSessionId,
-    getFingerprint: fingerprinter,
-    getFraudSessionId: kount,
-  });
-}
-
-export { collectData, collectDataHelper };

package/src/fingerprint.js

@@ -1,37 +0,0 @@
-import FingerprintJS from '@fingerprintjs/fingerprintjs';
-
-/**
- * generateFingerprint is implemented following guidelines
- * from the @fingerprintjs/fingerprintjs package documentation:
- * https://github.com/fingerprintjs/fingerprintjs/blob/master/docs/api.md
- */
-async function generateFingerprint() {
-  try {
-    // Turn off FingerprintJS analytics
-    const fingerprint = await FingerprintJS.load({ monitoring: false });
-    const result = await fingerprint.get();
-
-    return result.visitorId;
-  } catch (e) {
-    // eslint-disable-next-line no-console
-    console.log(e);
-
-    return '';
-  }
-}
-
-export default async function getFingerprint() {
-  return new Promise((resolve) => {
-    if (window.requestIdleCallback) {
-      requestIdleCallback(async () => {
-        const fingerprint = await generateFingerprint();
-        resolve(fingerprint);
-      });
-    } else {
-      setTimeout(async () => {
-        const fingerprint = await generateFingerprint();
-        resolve(fingerprint);
-      }, 500);
-    }
-  });
-}

package/src/kount.js

@@ -1,52 +0,0 @@
-/* eslint-disable no-undef */
-const sandboxDataCollectorUrl = 'https://tst.kaptcha.com';
-const prodDataCollectorUrl = 'https://ssl.kaptcha.com';
-
-const isProd = (env) => env === 'production';
-
-const addKountScriptElement = ({
-  env,
-  kountAccountId,
-  kountSessionId,
-}) => {
-  const baseUrl = isProd(env) ? prodDataCollectorUrl : sandboxDataCollectorUrl;
-  const kountScriptUrl = new URL(`${baseUrl}/collect/sdk`);
-  kountScriptUrl.searchParams.append('m', kountAccountId);
-  if (kountSessionId) {
-    kountScriptUrl.searchParams.append('m', kountSessionId);
-  }
-
-  const kountScript = document.createElement('script');
-  kountScript.setAttribute('class', 'kaxsdc');
-  kountScript.setAttribute('data-event', 'load');
-  kountScript.setAttribute('type', 'text/javascript');
-  kountScript.setAttribute('src', kountScriptUrl.href);
-
-  document.body.append(kountScript);
-
-  return kountScript;
-};
-
-export default async function getFraudSessionId({ env, kountAccountId, kountSessionId }) {
-  return new Promise((resolve, reject) => {
-    const kountScript = addKountScriptElement({
-      env,
-      kountAccountId,
-      kountSessionId,
-    });
-
-    kountScript.onload = () => {
-      const client = new ka.ClientSDK();
-      client.setupCallback({
-        'collect-begin': (params) => {
-          const { MercSessId } = params;
-          resolve(MercSessId);
-        },
-      });
-      client.autoLoadEvents();
-    };
-    kountScript.onerror = () => {
-      reject(new Error('Error attempting to mount Kount script'));
-    };
-  });
-}