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

Enable contenteditable on table by pressing the tab key

I am looking to manage the error handling service, and my next step is to intentionally insert a single error into my service and have it automated

A Promise-based value returned by a Typescript decorator with universal methods

Using a URL in an AJAX request

bindings and validation of input values in angularjs

Error: There was a problem trying to import the `.d.ts` file

How to Access Nested Arrays in ReactJS

When comparing TypeScript class functions with regular functions and variables, which one yields better performance?

Is Python being used to track NBA.com stats?

Investigate the CSS display property of an element using JavaScript

Encountering the "ExpressionChangedAfterItHasBeenCheckedError" in Angular 2

Learning the process of configuring neo4j connection details without relying on environment variables

Is mocking all dependencies in an AngularJS controller necessary for unit testing?

Get the npm distribution package without the need to actually install npm

Configuring headless unit testing with requirejs

Storing information in an array and converting it to JSON using dual nested foreach loops in PHP

What is the best way to change between different Angular 2 material tabs using typescript?

What is the method for accessing 'this' beyond the scope of my object?

Extracting key-value pairs and unkeyed values from a JSON string during deserialization

Finding the correct placement for importing 'reflect-metadata' in Next.js version 14.1.0