@kravc/schema 2.6.0 → 2.7.1

package/eslint.config.mjs

@@ -0,0 +1,55 @@
+import globals from "globals";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import js from "@eslint/js";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+    baseDirectory: __dirname,
+    recommendedConfig: js.configs.recommended,
+    allConfig: js.configs.all
+});
+
+export default [...compat.extends("eslint:recommended"), {
+    languageOptions: {
+        globals: {
+            ...globals.node,
+            ...globals.mocha,
+        },
+
+        ecmaVersion: 2018,
+        sourceType: "commonjs",
+    },
+
+    rules: {
+        "comma-style": "error",
+        "consistent-this": ["error", "_this"],
+
+        indent: ["error", 2, {
+            SwitchCase: 1,
+            VariableDeclarator: 2,
+        }],
+
+        "keyword-spacing": "error",
+        "no-multi-spaces": "off",
+        "no-spaced-func": "error",
+        "no-trailing-spaces": "error",
+        quotes: ["error", "single"],
+        semi: ["error", "never"],
+        curly: ["error"],
+        "prefer-arrow-callback": "error",
+        "space-before-blocks": "error",
+
+        "space-before-function-paren": [1, {
+            anonymous: "always",
+            named: "never",
+        }],
+
+        "space-infix-ops": "error",
+        "space-unary-ops": "error",
+        "no-return-await": "error",
+        eqeqeq: "error",
+    },
+}];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kravc/schema",
-  "version": "2.6.0",
+  "version": "2.7.1",
   "description": "Advanced JSON schema manipulation and validation library.",
   "keywords": [
     "JSON",
@@ -27,24 +27,21 @@
   "license": "ISC",
   "dependencies": {
     "credentials-context": "^2.0.0",
-    "lodash.clonedeep": "^4.5.0",
-    "lodash.groupby": "^4.6.0",
-    "lodash.isundefined": "^3.0.1",
-    "lodash.keyby": "^4.6.0",
-    "lodash.pick": "^4.4.0",
-    "lodash.set": "^4.3.2",
-    "lodash.uniq": "^4.5.0",
+    "lodash": "^4.17.21",
     "security-context": "^4.0.0",
     "validator": "^13.9.0",
     "z-schema": "^6.0.1"
   },
   "devDependencies": {
-    "chai": "^4.3.7",
-    "eslint": "^8.35.0",
+    "@eslint/eslintrc": "^3.2.0",
+    "@eslint/js": "^9.15.0",
+    "chai": "^5.1.2",
+    "eslint": "^9.15.0",
+    "globals": "^15.12.0",
     "js-yaml": "^4.1.0",
-    "jsonld": "^5.2.0",
-    "mocha": "^10.2.0",
-    "nyc": "^15.1.0"
+    "jsonld": "^8.3.2",
+    "mocha": "^10.8.2",
+    "nyc": "^17.1.0"
   },
   "nyc": {
     "include": "src",

package/src/Schema.js

@@ -1,7 +1,6 @@
 'use strict'
 
-const pick                 = require('lodash.pick')
-const cloneDeep            = require('lodash.clonedeep')
+const { pick, cloneDeep }  = require('lodash')
 const validateId           = require('./helpers/validateId')
 const normalizeRequired    = require('./helpers/normalizeRequired')
 const normalizeProperties  = require('./helpers/normalizeProperties')

package/src/ValidationError.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const pick = require('lodash.pick')
+const { pick } = require('lodash')
 
 class ValidationError extends Error {
   constructor(schemaId, invalidObject, validationErrors) {

package/src/Validator.js

@@ -1,8 +1,8 @@
 'use strict'
 
-const keyBy               = require('lodash.keyby')
-const groupBy             = require('lodash.groupby')
+const { keyBy, groupBy }  = require('lodash')
 const ZSchema             = require('z-schema')
+const cleanupNulls        = require('./helpers/cleanupNulls')
 const getReferenceIds     = require('./helpers/getReferenceIds')
 const ValidationError     = require('./ValidationError')
 const cleanupAttributes   = require('./helpers/cleanupAttributes')
@@ -43,7 +43,7 @@ class Validator {
     this._jsonSchemasMap = keyBy(jsonSchemas, 'id')
   }
 
-  validate(object, schemaId, shouldNullifyEmptyValues = false) {
+  validate(object, schemaId, shouldNullifyEmptyValues = false, shouldCleanupNulls = false) {
     const jsonSchema = this._jsonSchemasMap[schemaId]
 
     if (!jsonSchema) {
@@ -51,7 +51,11 @@ class Validator {
     }
 
     const objectJson = JSON.stringify(object)
-    const result = JSON.parse(objectJson)
+    let result = JSON.parse(objectJson)
+
+    if (shouldCleanupNulls) {
+      result = cleanupNulls(result)
+    }
 
     try {
       // NOTE: Drop attributes from objects that are not defined in schema.
@@ -68,6 +72,7 @@ class Validator {
       //       or numbers are '1', '2'... strings.
       normalizeAttributes(result, jsonSchema, this._jsonSchemasMap)
 
+    // eslint-disable-next-line no-unused-vars
     } catch (error) {
       // NOTE: Skip errors in cleanup and normalize attributes methods,
       //       validation fails for objects with invalid value types.

package/src/Validator.spec.js

@@ -40,7 +40,7 @@ describe('Validator', () => {
     })
   })
 
-  describe('.validate(object, schemaId, shouldNullifyEmptyValues = false)', () => {
+  describe('.validate(object, schemaId, shouldNullifyEmptyValues = false, shouldCleanupNulls = true)', () => {
     it('returns validated, cleaned and normalized object', () => {
       const validator = new Validator(SCHEMAS)
 
@@ -48,15 +48,20 @@ describe('Validator', () => {
 
       const input = {
         name: 'Oleksandr',
+        toBeRemoved: null,
         contactDetails: {
-          email: 'a@kra.vc'
+          email: 'a@kra.vc',
+          toBeRemoved: null,
         },
-        favoriteItems: [{
-          id:         '1',
-          name:       'Student Book',
-          categories: [ 'Education' ],
-          _createdAt
-        }],
+        favoriteItems: [
+          {
+            id:         '1',
+            name:       'Student Book',
+            categories: [ 'Education' ],
+            toBeRemoved: null,
+            _createdAt
+          },
+        ],
         locations: [{
           name: 'Home',
           address: {
@@ -77,7 +82,11 @@ describe('Validator', () => {
         _createdAt
       }
 
-      const validInput = validator.validate(input, 'Profile')
+      const validInput = validator.validate(input, 'Profile', false, true)
+
+      expect(validInput.toBeRemoved).to.not.exist
+      expect(validInput.contactDetails.toBeRemoved).to.not.exist
+      expect(validInput.favoriteItems[0].toBeRemoved).to.not.exist
 
       expect(validInput._createdAt).to.not.exist
       expect(validInput.preferences._createdAt).to.not.exist

package/src/helpers/cleanupAttributes.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const isUndefined = require('lodash.isundefined')
+const { isUndefined } = require('lodash')
 
 const cleanupAttributes = (object, jsonSchema, schemasMap) => {
   const { id, enum: isEnum } = jsonSchema

package/src/helpers/cleanupNulls.js

@@ -0,0 +1,42 @@
+'use strict'
+
+const { isArray } = Array
+const { isObject, cloneDeep } = require('lodash')
+
+const cleanupNulls = object => {
+  if (!isObject(object)) {
+    return
+  }
+
+  for (const key in object) {
+    const value = object[key]
+
+    if (isArray(value)) {
+      for (const item of value) {
+        cleanupNulls(item)
+      }
+
+      continue
+    }
+
+    if (isObject(value)) {
+      cleanupNulls(value)
+
+      continue
+    }
+
+    const isNull = value === null
+
+    if (isNull) {
+      delete object[key]
+    }
+  }
+}
+
+module.exports = input => {
+  const object = cloneDeep(input)
+
+  cleanupNulls(object)
+
+  return object
+}

package/src/helpers/getReferenceIds.js

@@ -1,8 +1,7 @@
 'use strict'
 
-const uniq        = require('lodash.uniq')
-const Schema      = require('../Schema')
-const isUndefined = require('lodash.isundefined')
+const { isUndefined, uniq } = require('lodash')
+const Schema = require('../Schema')
 
 const getReferenceIds = (schema, schemasMap) => {
   const getSchema = id => schemasMap[id]

package/src/helpers/mapObject.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const isUndefined = require('lodash.isundefined')
+const { isUndefined } = require('lodash')
 
 const mapObject = (object, jsonSchema, schemasMap, callback) => {
   const { id, enum: isEnum } = jsonSchema

package/src/helpers/normalizeAttributes.js

@@ -1,8 +1,8 @@
 'use strict'
 
 const mapObject     = require('./mapObject')
-const isUndefined   = require('lodash.isundefined')
 const normalizeType = require('./normalizeType')
+const { isUndefined } = require('lodash')
 
 const normalizeAttributes = (object, jsonSchema, jsonSchemasMap) => {
   const callback = (propertyName, propertySchema, object) => {

package/src/helpers/normalizeProperties.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const isUndefined = require('lodash.isundefined')
+const { isUndefined } = require('lodash')
 
 const normalizeProperties = properties => {
   const { enum: isEnum } = properties

package/src/helpers/nullifyEmptyValues.js

@@ -1,7 +1,6 @@
 'use strict'
 
-const get = require('lodash.get')
-const set = require('lodash.set')
+const { get, set } = require('lodash')
 const { schemaSymbol, jsonSymbol } = require('z-schema')
 
 const FORMAT_ERROR_CODES = [

package/.eslintrc.yml

@@ -1,42 +0,0 @@
-extends: 'eslint:recommended'
-
-parserOptions:
-  ecmaVersion: 2018
-
-env:
-  es6: true
-  node: true
-  mocha: true
-
-rules:
-  comma-style: error
-  consistent-this:
-    - error
-    - _this
-  indent:
-    - error
-    - 2
-    - SwitchCase: 1
-      VariableDeclarator: 2
-  keyword-spacing: error
-  no-multi-spaces: off
-  no-spaced-func: error
-  no-trailing-spaces: error
-  quotes:
-    - error
-    - single
-  semi:
-    - error
-    - never
-  curly:
-    - error
-  prefer-arrow-callback: error
-  space-before-blocks: error
-  space-before-function-paren:
-    - 1
-    - anonymous: always
-      named: never
-  space-infix-ops: error
-  space-unary-ops: error
-  no-return-await: error
-  eqeqeq: error