@rebilly/instruments 4.5.0 → 4.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rebilly/instruments",
-  "version": "4.5.0",
+  "version": "4.6.0",
   "author": "Rebilly",
   "license": "MIT",
   "main": "dist/index.js",
@@ -8,17 +8,26 @@
   "scripts": {
     "build": "yarn rollup -c --environment NODE_ENV:production",
     "dev": "yarn rollup -c --watch --environment NODE_ENV:development",
+    "format": "prettier --write . --config ../.prettierrc --ignore-path ../.prettierignore",
+    "format:check": "prettier --check . --config ../.prettierrc --ignore-path ../.prettierignore",
+    "lint": "yarn format && eslint --ext .ts,.js,.vue --ignore-path ../.eslintignore --config ../.eslintrc.js --fix src",
+    "lint:no-fix": "yarn lint --no-fix",
     "test:unit": "vitest run",
     "test:unit:watch": "vitest"
   },
   "dependencies": {
     "@babel/cli": "^7.21.5",
     "@babel/core": "^7.22.9",
-    "@babel/preset-env": "^7.22.9",
+    "@babel/preset-env": "^7.22.14",
     "@rebilly/api-metadata": "*",
     "@rebilly/risk-data-collector": "*",
     "@vue/reactivity": "^3.2.39",
     "ajv": "^8.12.0",
+    "eslint": "^8.38.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-no-only-tests": "^2.6.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-vue": "^9.12.0",
     "jwt-decode": "^3.1.2",
     "lodash.camelcase": "^4.3.0",
     "lodash.clonedeep": "^4.5.0",
@@ -26,8 +35,10 @@
     "lodash.kebabcase": "^4.1.1",
     "lodash.merge": "^4.6.2",
     "popostmate": "2.0.0",
+    "prettier": "^2.8.8",
     "rebilly-js-sdk": "*",
-    "values.js": "^2.0.0"
+    "values.js": "^2.0.0",
+    "vue-eslint-parser": "^9.3.1"
   },
   "devDependencies": {
     "@rollup/plugin-babel": "^6.0.3",

package/project.json

@@ -17,6 +17,15 @@
           ]
         ]
       }
+    },
+    "lint:no-fix": {
+      "executor": "nx:run-script",
+      "options": {
+        "script": "lint:no-fix"
+      },
+      "dependsOn": [
+        "^build"
+      ]
     }
   }
 }

package/rollup.config.mjs

@@ -6,18 +6,18 @@ import replace from '@rollup/plugin-replace';
 import nodePolyfills from 'rollup-plugin-polyfill-node';
 import ignore from 'rollup-plugin-ignore';
 import versionInjector from 'rollup-plugin-version-injector';
-import { builtinModules } from 'module'
+import { builtinModules } from 'module';
 import { terser } from 'rollup-plugin-terser';
 
-const isDevMode = (process.env.NODE_ENV === 'development');
+const isDevMode = process.env.NODE_ENV === 'development';
 
 const buildOptions = () => {
     const options = [
         // Locates a module in the project's node_modules
-        resolve({ 
-            extensions: [ '.mjs', '.js', '.jsx', '.json' ],
+        resolve({
+            extensions: ['.mjs', '.js', '.jsx', '.json'],
             preferBuiltins: true,
-            mainFields: ['browser', 'jsnext:main', 'module', 'main']
+            mainFields: ['browser', 'jsnext:main', 'module', 'main'],
         }),
         // Converts CommonJS to ES6 modules
         commonjs(),
@@ -29,7 +29,7 @@ const buildOptions = () => {
         // Replace values at bundle time
         replace({
             preventAssignment: true,
-            'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV)
+            'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV),
         }),
         // Allows the use of named imports in addition to the default import on node modules
         nodePolyfills(),
@@ -37,20 +37,21 @@ const buildOptions = () => {
         babel({
             exclude: 'node_modules/**',
             babelHelpers: 'runtime',
-            skipPreflightCheck: true
+            skipPreflightCheck: true,
         }),
         // Converts .json files to ES6 modules
         json(),
-    ]
+    ];
     if (!isDevMode) {
         options.push(
             // Inject version from package.json (RebillyInstruments.version)
             versionInjector(),
             // Minify and reduce bundle file sizes
-            terser())
+            terser(),
+        );
     }
     return options;
-}
+};
 
 const buildOutput = () => {
     const output = [
@@ -59,26 +60,20 @@ const buildOutput = () => {
             format: 'es',
             sourcemap: isDevMode ? 'inline' : false,
         },
-    ]
+    ];
     if (!isDevMode) {
-        output.push(
-            {
-                file: 'dist/index.min.js',
-                format: 'iife',
-                name: 'RebillyInstruments',
-                exports: 'default'
-            },
-        )
+        output.push({
+            file: 'dist/index.min.js',
+            format: 'iife',
+            name: 'RebillyInstruments',
+            exports: 'default',
+        });
     }
     return output;
-}
+};
 
 export default {
     input: 'src/index.js',
-    output: [
-        ...buildOutput(),
-    ],
-    plugins: [
-        ...buildOptions(),
-    ],
+    output: [...buildOutput()],
+    plugins: [...buildOptions()],
 };

package/src/data/options-schema/index.js

@@ -1,96 +1,112 @@
-import schema from './schemas/options-schema';
 import AJV from 'ajv/dist/2019';
+import schema from './schemas/options-schema';
 
 export class RebillyInstrumentsConfigError extends Error {
-  constructor(message) {
-    super(message);
-    this.name = "Rebilly Instruments Configuration Error";
-  }
+    constructor(message) {
+        super(message);
+        this.name = 'Rebilly Instruments Configuration Error';
+    }
 
-  trimStack() {
-    Error.captureStackTrace(this, RebillyInstrumentsConfigError)
-    return this
-  }
+    trimStack() {
+        Error.captureStackTrace(this, RebillyInstrumentsConfigError);
+        return this;
+    }
 }
 
 const ajv = new AJV({
-  allErrors: true,
-  removeAdditional: true,
-  useDefaults: true
+    allErrors: true,
+    removeAdditional: true,
+    useDefaults: true,
 });
 const validate = ajv.compile(schema);
 
 export function sanitize(data) {
-  // cast data to be only json object
-  return JSON.parse(
-    JSON.stringify(data)
-  )
+    // cast data to be only json object
+    return JSON.parse(JSON.stringify(data));
 }
 
 export function validateOptions(data) {
-  const sanitizedData = sanitize(data);
-  const valid = validate(sanitizedData);
-  if (valid) {
-    return sanitizedData;
-  }
-
-  validate.errors.forEach(error => {
-    let errorMessage = ``;
-    let instancePathReadable = error.instancePath.substring(1).replace(/\//gi, '.');
-    instancePathReadable = instancePathReadable.replace(/\.\d+/ig, (match) => {
-      return `[${match.replace('.', '')}]`;
-    });
-    if (!instancePathReadable.length) {
-      instancePathReadable = 'options'
+    const sanitizedData = sanitize(data);
+    const valid = validate(sanitizedData);
+    if (valid) {
+        return sanitizedData;
     }
 
-    switch(error.keyword) {
-      case 'if':
-      case 'false schema':
-        // ignore keywords
-        break;
-      case 'required':
-        if (error.schemaPath.match(/(oneOf|anyOf)/)) {
-          // ignore and allow their oneOf or anyOf keywords to handle error message
-          break;
-        }
-        errorMessage = `${instancePathReadable} ${error.message}`;
-        break;
-      case 'oneOf':
-      case 'anyOf':
-        console.error(
-          new RebillyInstrumentsConfigError(`${instancePathReadable} ${error.message}, see schemas below.`)
-            .trimStack()
+    validate.errors.forEach((error) => {
+        let errorMessage = ``;
+        let instancePathReadable = error.instancePath
+            .substring(1)
+            .replace(/\//gi, '.');
+        instancePathReadable = instancePathReadable.replace(
+            /\.\d+/gi,
+            (match) => `[${match.replace('.', '')}]`,
         );
-        const schemaPath = error.schemaPath.replace('#/', '').split('/');
-        let nodes = schema;
-        schemaPath.forEach(item => nodes = nodes[item]);
-        nodes.forEach(node => {
-          const displayNode = JSON.stringify(node, null, 2);
-          console.error(`${instancePathReadable} ${error.keyword} schema.\n${displayNode}`, );
-        });
-        break;
-      case 'enum':
-        let value = instancePathReadable.split('.').reduce((acc, key) => {
-          return acc[key];
-        }, data);
-        errorMessage = `${instancePathReadable} ${error.message}: ${error.params.allowedValues}. received: ${value}`
-        break;
-      case 'dependentRequired':
-      case 'maxLength':
-      case 'minItems':
-      case 'pattern':
-        errorMessage = `${instancePathReadable} ${error.message}`;
-        break;
-      default:
-        errorMessage = `Error with ${instancePathReadable} - See error message`;
-        console.error(error);
-        break;
-    }
-    if (errorMessage) {
-      console.error(new RebillyInstrumentsConfigError(errorMessage).trimStack());
-    }
-  });
+        if (!instancePathReadable.length) {
+            instancePathReadable = 'options';
+        }
 
-  console.error(new RebillyInstrumentsConfigError('Configuration is invalid').trimStack());
-}
+        let nodes;
+        let schemaPath;
+        let value;
+        switch (error.keyword) {
+            case 'if':
+            case 'false schema':
+                // ignore keywords
+                break;
+            case 'required':
+                if (error.schemaPath.match(/(oneOf|anyOf)/)) {
+                    // ignore and allow their oneOf or anyOf keywords to handle error message
+                    break;
+                }
+                errorMessage = `${instancePathReadable} ${error.message}`;
+                break;
+            case 'oneOf':
+            case 'anyOf':
+                console.error(
+                    new RebillyInstrumentsConfigError(
+                        `${instancePathReadable} ${error.message}, see schemas below.`,
+                    ).trimStack(),
+                );
+                schemaPath = error.schemaPath.replace('#/', '').split('/');
+                nodes = schema;
+                schemaPath.forEach((item) => {
+                    nodes = nodes[item];
+                });
+                nodes.forEach((node) => {
+                    const displayNode = JSON.stringify(node, null, 2);
+                    console.error(
+                        `${instancePathReadable} ${error.keyword} schema.\n${displayNode}`,
+                    );
+                });
+                break;
+            case 'enum':
+                value = instancePathReadable
+                    .split('.')
+                    .reduce((acc, key) => acc[key], data);
+                errorMessage = `${instancePathReadable} ${error.message}: ${error.params.allowedValues}. received: ${value}`;
+                break;
+            case 'dependentRequired':
+            case 'maxLength':
+            case 'minItems':
+            case 'pattern':
+                errorMessage = `${instancePathReadable} ${error.message}`;
+                break;
+            default:
+                errorMessage = `Error with ${instancePathReadable} - See error message`;
+                console.error(error);
+                break;
+        }
+        if (errorMessage) {
+            console.error(
+                new RebillyInstrumentsConfigError(errorMessage).trimStack(),
+            );
+        }
+    });
+
+    console.error(
+        new RebillyInstrumentsConfigError(
+            'Configuration is invalid',
+        ).trimStack(),
+    );
+    return undefined;
+}