Extract the necessary fields from the JSON Schema

Question

Extract the necessary fields from the JSON Schema

I am in search of a solution to extract the required fields from a JSON Schema and Data combination.

Currently, we are utilizing AJV for getting error messages in our forms using JSON Schema, and it has been performing really well.

I am looking for a method to retrieve all the required fields (even if already filled) so that I can label those fields with * as "required". The required fields may vary depending on the schema and data combinations.

I also attempted to extract the required fields using tv4, but without success.

Your assistance would be greatly appreciated.

Here is an example of such a schema:

{
  "type": "object",
  "required": [
    "checkbox"
  ],
  "properties": {
    "checkbox": {
      "type": "boolean"
    },
    "textbox": {
      "type": "string"
    }
  },
  "oneOf": [
    {
      "required": [
        "textbox"
      ],
      "properties": {
        "checkbox": {
          "enum": [
            true
          ]
        }
      }
    },
    {
      "properties": {
        "checkbox": {
          "enum": [
            false
          ]
        }
      }
    }
  ],
  "additionalProperties": false
}

javascript json jsonschema ajv tv4

Answer 1

Answer №1

After reviewing your inquiry, the most straightforward approach to achieve your desired outcome would be:

Retrieve the Json data when the page loads,
Go through the json data to eliminate valid values (refer to example 1),
Invoke tv4.validateMultiple(data, schema),
Inspect the result object and retrieve the necessary fields (refer to example 2).

example 1

for(let prop in data) {
    if(data.hasOwnProperty(prop)) {
        //assign a null value, -1, or any other universally undesirable value
        data[prop].value = null;
    }
}

example 2

let result = tv4.validateMultiple(data, schema);
let required = result.errors;

Answer 2

After reviewing your inquiry, the most straightforward approach to achieve your desired outcome would be:

Retrieve the Json data when the page loads,
Go through the json data to eliminate valid values (refer to example 1),
Invoke tv4.validateMultiple(data, schema),
Inspect the result object and retrieve the necessary fields (refer to example 2).

example 1

for(let prop in data) {
    if(data.hasOwnProperty(prop)) {
        //assign a null value, -1, or any other universally undesirable value
        data[prop].value = null;
    }
}

example 2

let result = tv4.validateMultiple(data, schema);
let required = result.errors;

Answer 3

Answer №2

The issue was resolved through the following steps:

We decided to fork tv4 (renamed as tv4 - for ease of editing) by visiting the link below:

https://github.com/mikila85/tv4

We then generated an array of "Requireds".
Next, we proceeded to iterate through each required field, resetting its data and forwarding the data+schema to AJV for validation (opted for AJV over tv4 due to quicker parsing).

This approach allowed us to identify which specific required fields were necessary for the provided data.

Below are the functional implementations we crafted (though not the most polished, they serve their purpose well):

function getAllRequiredFields() {
    var allRequiredFields = tv4.validateMultiple($scope.formModel, $scope.formSchema).requireds;
    allRequiredFields = allRequiredFields.filter(function onlyUnique(value, index, self) {
        return self.indexOf(value) === index;
    });

    return allRequiredFields;
}

function getRequiredFields() {
    var t0 = performance.now();

    // This function should be invoked on every model change for optimal performance as it utilizes tv4's data+schema optimization.
    var allRequiredFields = getAllRequiredFields();
    angular.forEach(allRequiredFields, function (requiredPath) {
        var modelWithDeletedRequiredProperty = angular.copy($scope.formModel);

        deleteValue(modelWithDeletedRequiredProperty, requiredPath);
        if (!validateForm(modelWithDeletedRequiredProperty)) {

            var requiredError = getErrorObjectsArray(validateForm.errors).find(function (error) {
                return error.path === requiredPath;
            });

            if (requiredError) {
                localValidation[requiredError.inputName] = localValidation[requiredError.inputName] || {};
                localValidation[requiredError.inputName].isRequired = true;
                requiredFieldsPath.push(requiredError.inputName);
            }
        }
    });

    var t1 = performance.now();
    console.log("form checking took " + (t1 - t0) + " milliseconds.");
}

Answer 4

The issue was resolved through the following steps:

We decided to fork tv4 (renamed as tv4 - for ease of editing) by visiting the link below:

https://github.com/mikila85/tv4

We then generated an array of "Requireds".
Next, we proceeded to iterate through each required field, resetting its data and forwarding the data+schema to AJV for validation (opted for AJV over tv4 due to quicker parsing).

This approach allowed us to identify which specific required fields were necessary for the provided data.

Below are the functional implementations we crafted (though not the most polished, they serve their purpose well):

function getAllRequiredFields() {
    var allRequiredFields = tv4.validateMultiple($scope.formModel, $scope.formSchema).requireds;
    allRequiredFields = allRequiredFields.filter(function onlyUnique(value, index, self) {
        return self.indexOf(value) === index;
    });

    return allRequiredFields;
}

function getRequiredFields() {
    var t0 = performance.now();

    // This function should be invoked on every model change for optimal performance as it utilizes tv4's data+schema optimization.
    var allRequiredFields = getAllRequiredFields();
    angular.forEach(allRequiredFields, function (requiredPath) {
        var modelWithDeletedRequiredProperty = angular.copy($scope.formModel);

        deleteValue(modelWithDeletedRequiredProperty, requiredPath);
        if (!validateForm(modelWithDeletedRequiredProperty)) {

            var requiredError = getErrorObjectsArray(validateForm.errors).find(function (error) {
                return error.path === requiredPath;
            });

            if (requiredError) {
                localValidation[requiredError.inputName] = localValidation[requiredError.inputName] || {};
                localValidation[requiredError.inputName].isRequired = true;
                requiredFieldsPath.push(requiredError.inputName);
            }
        }
    });

    var t1 = performance.now();
    console.log("form checking took " + (t1 - t0) + " milliseconds.");
}

Answer 5

Answer №3

This particular function is designed to retrieve schema indices in a recursive manner, offering the possibility for customization.

   // https://github.com/pubkey/rxdb/blob/master/src/rx-schema.js
 export function obtainIndices(schemaJSON, previousPath = '') {
        let schemaIndexes = [];
        Object.entries(schemaJSON).forEach(entry => {
            const key = entry[0];
            const obj = entry[1];
            const path = key === 'properties' ? previousPath : util.trimDots(previousPath + '.' + key);

            if (obj.index)
                indexes.push([path]);

            if (typeof obj === 'object' && !Array.isArray(obj)) {
                const additionalIndices = getIndexes(obj, path);
                schemaIndexes = schemaIndexes.concat(additionalIndices);
            }
        });

        if (previousPath === '') {
            const additionalCompoundIndices = schemaJSON.compoundIndexes || [];
            schemaIndexes = schemaIndexes.concat(additionalCompoundIndices);
        }

        schemaIndexes = schemaIndexes
            .filter((element, position, array) => array.indexOf(element) === position); // unique;
        return schemaIndexes;
    }

Answer 6

This particular function is designed to retrieve schema indices in a recursive manner, offering the possibility for customization.

   // https://github.com/pubkey/rxdb/blob/master/src/rx-schema.js
 export function obtainIndices(schemaJSON, previousPath = '') {
        let schemaIndexes = [];
        Object.entries(schemaJSON).forEach(entry => {
            const key = entry[0];
            const obj = entry[1];
            const path = key === 'properties' ? previousPath : util.trimDots(previousPath + '.' + key);

            if (obj.index)
                indexes.push([path]);

            if (typeof obj === 'object' && !Array.isArray(obj)) {
                const additionalIndices = getIndexes(obj, path);
                schemaIndexes = schemaIndexes.concat(additionalIndices);
            }
        });

        if (previousPath === '') {
            const additionalCompoundIndices = schemaJSON.compoundIndexes || [];
            schemaIndexes = schemaIndexes.concat(additionalCompoundIndices);
        }

        schemaIndexes = schemaIndexes
            .filter((element, position, array) => array.indexOf(element) === position); // unique;
        return schemaIndexes;
    }

Extract the necessary fields from the JSON Schema

Answer №1

Answer №2

Answer №3

Similar questions

Decoding JSON with JavaScript following the response from JsonConvert.SerializeObject(json) in a .NET handler

Visualizing link values in Les Miserables using d3.js in Co-occurrence demo

Struggling with passing data to a child component in React

Error Encountered in jQuery UI SelectMenu

Displaying tooltips dynamically for newly added elements all sharing a common class in React

Executing multiple commands using Node.js TCP communication

Experiencing excessive CPU usage while utilizing a progress bar in Angular

Creating a JSON document with a specific structure using Java

Tips for achieving JSON formatting with JavaScript or jQuery

What is the best way to utilize Link navigation in order to navigate away from a blocked route in the latest version of Next.js,

JQuery fails to retrieve accurate width measurements

How to use the ObjC RestKit library for object mapping to a JSON NSString?

Designing Object-Oriented JavaScript

Struggling with JavaScript's getElementById function

The attempt to convert the value from type '__NSSingleObjectArrayI' to 'NSDictionary' was unsuccessful

The issue of jQuery's .last() function triggering multiple times with just a single click on the last

Discover the perfect method for combining two objects while updating any empty values with a new specified value. Furthermore, in the case where the new value is also

Error: 'window not defined' or 'document not defined' encountered while importing a module in Next.js

Ways to retrieve the specified data in Javascript in string format

Selenium, scrolling through web pages