data-to-jsonschema-to-ts

Convert plain javascript objects to JSON Schema and TypeScript typings.

Installation

``
npm install data-to-jsonschema-to-ts
`

Example

$3

`typescript
import {
convertJsonSchemaToTs,
createJsonSchemaValidator,
generateJsonSchemaFromData,
} from "data-to-jsonschema-to-ts";

const TEST_DATA = [
{
id: 1,
name: "John Doe",
age: 30,
email: "email@email.com",
},
{
id: 1,
name: "John Doe",
age: 30,
email: "email@email.com",
address: {
street: "123 Main St",
city: "Anytown",
state: "NY",
zip: "12345",
},
},
{
id: 1,
name: "John Doe",
age: 30,
email: null,
preferences: [{ name: "pref1", value: "value1" }],
},
];

const jsonSchema = generateJsonSchemaFromData(TEST_DATA, "TestData", {
additionalProperties: false,
existingSchema: undefined,
});

console.log(JSON.stringify(jsonSchema, null, 2));
`

$3

`typescript
const validator = createJsonSchemaValidator(jsonSchema)

console.log(validator({id: 1, name: "John Doe", age: 30, email: "something@email.com"})); // valid
console.log(validator({id: 1, name: "John Doe", age: 30 })); // invalid, missing email
`

$3

`typescript
convertJsonSchemaToTs(generatedSchema, {
additionalProperties: false,
}).then((generatedTs) => {
console.log(generatedTs);
});
`

Utilities

$3

Generate a function that validates an object against a JSON Schema.

`typescript
import { createJsonSchemaValidator } from "data-to-jsonschema-to-ts";

const validator = createJsonSchemaValidator({
type: "object",
properties: {
id: { type: "number" },
name: { type: "string" },
age: { type: "number" },
email: { type: "string" }
},
required: ["id", "name", "age", "email"]
});

validator({
id: 1,
name: "John Doe",
age: 30,
email: "myemail.com"
}); // { valid: true, errors: undefined }

validator({
id: 1,
age: null
}); // { valid: false, errors: [{...}] }
`

$3

Walk a plain javascript object and call a callback function for each primitive value and it's dot notation path.

`typescript
import { traverseObject } from "data-to-jsonschema-to-ts";

const obj = {
id: 1,
profile: {
name: "John Doe",
}
}

traverseObject(obj, (value, jsonDotPath) => {
console.log(value, jsonDotPath);
});

// console output:
// 1 "id"
// 'John Doe', "profile.name"
``