Ensuring the validation of JSON schemas with dynamically generated keys using Typescript

Question

Ensuring the validation of JSON schemas with dynamically generated keys using Typescript

I have a directory called 'schemas' that holds various JSON files containing different schemas.

For instance,

/schemas/banana-schema.json

{
  "$schema": "http://json-schema.org/draft-06/schema",
  "type": "object",
  "properties": {
    "banana_name": {
      "type": "string"
    },
    "id": {
      "type": "integer"
    },
    "banana_weight": {
      "type": "number"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    },
    "required": ["id"]
  }
}

/schemas/orange-schema.json

{
  "$schema": "http://json-schema.org/draft-06/schema",
  "type": "object",
  "properties": {
    "orange_name": {
      "type": "string"
    },
    "id": {
      "type": "integer"
    },
    "orange_sweetness": {
      "type": "number"
    },
    "orange_timestamp": {
      "type": "string",
      "format": "date-time"
    },
    "required": ["id"]
  }
}

Each schema has different attributes. My aim is to validate the following:

All keys (e.g. banana_name, id, timestamp, orange_name, orange_sweetness, and so on) across all schemas adhere to the same naming convention (lowercase with an underscore: 'xxx' or 'xxx_yyy').
Any key containing the word 'timestamp' must be in 'date-time' format.
Every schema must include the 'id' key. ('id' is mandatory for all schemas)

Is it feasible to create a unit test that imports all JSON schemas and performs these validations?

javascript json typescript unit-testing validation

Answer 1

Answer №1

To ensure schema validation during runtime, it is essential to utilize a JSON Schema Validator like Ajv instead of relying solely on TypeScript features.

If you wish to code under a type-safe environment, consider creating type definitions for the fruits schema.

While TypeScript offers static type checking at compile-time, it does not provide runtime type checking capabilities.

Considering your specific requirements:

Enforcing naming conventions

This can be achieved using regular expressions.

Ensuring existence of key 'id' in any schema

Here are some advantages that TypeScript brings:

interface Schema {
  id: number;
}

interface AppleSchema extends Schema {
  apple_name: string,
  apple_weight: number,
  // additional properties...
}

interface MongoSchema extends Schema {
  mango_name: string,
  mango_mature: number,
  // additional properties...
}

// leveraging the benefits of TypeScript
export function testApple(apple: AppleSchema) {
  console.log(apple.id); // accessing apple.id, apple.apple_name, apple.apple_weight ...
}

// and more
export function findFruit<T extends Schema>(fruits: T[], id: number) {
    return fruits.find(fruit => fruit.id === id)
}

Answer 2

To ensure schema validation during runtime, it is essential to utilize a JSON Schema Validator like Ajv instead of relying solely on TypeScript features.

If you wish to code under a type-safe environment, consider creating type definitions for the fruits schema.

While TypeScript offers static type checking at compile-time, it does not provide runtime type checking capabilities.

Considering your specific requirements:

Enforcing naming conventions

This can be achieved using regular expressions.

Ensuring existence of key 'id' in any schema

Here are some advantages that TypeScript brings:

interface Schema {
  id: number;
}

interface AppleSchema extends Schema {
  apple_name: string,
  apple_weight: number,
  // additional properties...
}

interface MongoSchema extends Schema {
  mango_name: string,
  mango_mature: number,
  // additional properties...
}

// leveraging the benefits of TypeScript
export function testApple(apple: AppleSchema) {
  console.log(apple.id); // accessing apple.id, apple.apple_name, apple.apple_weight ...
}

// and more
export function findFruit<T extends Schema>(fruits: T[], id: number) {
    return fruits.find(fruit => fruit.id === id)
}

Ensuring the validation of JSON schemas with dynamically generated keys using Typescript

Answer №1

Similar questions

Accessing Properties in React.js: A Guide

What is the best way to have Vue i18n fetch translations from a .json file during Unit Testing?

Encountering NotFoundHttpException with Jquery Ajax in Laravel 4

best practices for choosing items from a dropdown menu using Angular

Attempting to populate the database with information from a JSON array

Utilizing client-side properties in an onClick event within Next.js framework

Having trouble testing Material-ui Modal using react-test-renderer

Error encountered due to an unhandled promise rejection of type

Checking the parameters passed to a function in Typescript: A step-by-step guide

How can you effectively blend Vue/Angular with other JavaScript resources to enhance your development process?

Sometimes jQuery may require multiple executions with just one click

Can the parameters in a .slice() be customized within a v-for loop?

Navigating with ASP.NET 5 Routing and AngularJS Routing

Swap out a portion of HTML content with the value from an input using JavaScript

Ways to determine the generic type of a property value from a decorated property within a decorator

Setting a variable in Angular after a successful AJAX call

What are the steps for designing personalized syncfusion grid-columns while still preserving the built-in search functionality of syncfusion?

Generating a JSON object on the fly in a React Native application

Attempting to manipulate information within the @click event handler embedded within a v-for loop

Leveraging the combination of <Form>, jQuery, Sequelize, and SQL for authentication and navigation tasks