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

Utilizing AngularJS's $http.get to fetch video IDs and then combining them with the /embed endpoint through the ng

Inquiries regarding scopes, node.js, and express

Take action once the Promise outside of the then block has been successfully completed

How can one efficiently update numerous data properties in a Vue.js application?

Obtaining IDs of Divs that have been Dragged into a Drop Zone upon Clicking a Button using JavaScript

Guide on creating multiple instances of vue-multiselect with a simple button click

What is the best way to convert a Java 8 LocalDateTime property to a JavaScript-style Date String when using JAX-RS?

Error occurred in the middle of processing, preventing the headers from being set

ngTagsInput retrieves and processes information from the database

Angular update row and save data to an array

The operation of my NodeJS application suddenly halts

Retrieve data from a website's API endpoint using JSON format and display it on a

Extract information from a JSON file and import it into an Angular TypeScript file

C# Deserialize JSON Array

Issue encountered with Fabric js: Unable to apply pattern fill to a group of rectangles

Experiencing an excessive number of re-renders can be a common issue in React as it has limitations set in place to prevent infinite loops. This

Issue with modal rendering in Bootstrap4 when the body is zoomed in

What is the best way to save the values of all the input fields in a datatable, excluding any fields that are empty?

Is it possible to extend the String prototype with the forEach method as found in the Array prototype?

Execute a function for each template or controller when the page loads