[![npm version][npm-image]][npm-url]
[![downloads][downloads-image]][npm-url]
[![build status][build-image]][build-url]
[![coverage status][coverage-image]][coverage-url]
[![Node.JS version][node-version]][node-url]

core-types-json-schema

This package provides conversion functions between [core-types][core-types-github-url] and JSON Schema (and Open API through the openapi-json-schema package).

You probably don't want to use this package directly, but rather [typeconv][typeconv-github-url] which uses this package to convert between TypeScript, JSON Schema, GraphQL and Open API.

See

Other conversion packages:
* [core-types-ts][core-types-ts-github-url]
* [core-types-graphql][core-types-graphql-github-url]

Usage

There are four main conversion functions, convertCoreTypesToJsonSchema, convertJsonSchemaToCoreTypes, convertCoreTypesToOpenApi and convertOpenApiTpCoreTypes, all returning a wrapped value, of the type ConversionResult.

This package also re-exports jsonSchemaTypeToOpenApi and openApiToJsonSchemaType from openapi-json-schema.

core-types to JSON Schema

``ts
import { convertCoreTypesToJsonSchema } from 'core-types-json-schema'

let doc; // This core-types document comes from somewhere

const { data: jsonSchema } = convertCoreTypesToJsonSchema( doc );
`

You can provide options as a second argument on the type:

`ts
interface ConvertCoreTypesToJsonSchemaOptions
{
sourceFilename?: string;
filename?: string;
userPackage?: string;
userPackageUrl?: string;
}
`

These fields will be used when constructing a comment ($comment) at the root of the JSON Schema, describing the context of where the schema comes from.

JSON Schema to core-types

`ts
import { convertJsonSchemaToCoreTypes } from 'core-types-json-schema'

let jsonSchema; // This JSON Schema comes from somewhere

const { data: doc } = convertJsonSchemaToCoreTypes( jsonSchema );
`

core-types to Open API

`ts
import { convertCoreTypesToOpenApi } from 'core-types-json-schema'

let doc; // This core-types document comes from somewhere

const { data: jsonSchema } = convertCoreTypesToOpenApi( doc );
`

You can provide options as a second argument on the type:

`ts
interface CoreTypesToOpenApiOptions extends ConvertCoreTypesToJsonSchemaOptions
{
title: string;
version: string;
schemaVersion?: string;
}
`

The title and version are required for Open API. The schemaVersion defaults to 3.0.0.

Open API to core-types

`ts
import { convertOpenApiTpCoreTypes } from 'core-types-json-schema'

let openApiSchema; // This Open API schema comes from somewhere

const { data: doc } = convertOpenApiTpCoreTypes( openApiSchema );
``

[npm-image]: https://img.shields.io/npm/v/core-types-json-schema.svg
[npm-url]: https://npmjs.org/package/core-types-json-schema
[downloads-image]: https://img.shields.io/npm/dm/core-types-json-schema.svg
[build-image]: https://img.shields.io/github/actions/workflow/status/grantila/core-types-json-schema/master.yml?branch=master
[build-url]: https://github.com/grantila/core-types-json-schema/actions?query=workflow%3AMaster
[coverage-image]: https://coveralls.io/repos/github/grantila/core-types-json-schema/badge.svg?branch=master
[coverage-url]: https://coveralls.io/github/grantila/core-types-json-schema?branch=master
[node-version]: https://img.shields.io/node/v/core-types-json-schema
[node-url]: https://nodejs.org/en/

[typeconv-github-url]: https://github.com/grantila/typeconv
[core-types-github-url]: https://github.com/grantila/core-types
[core-types-ts-github-url]: https://github.com/grantila/core-types-ts
[core-types-graphql-github-url]: https://github.com/grantila/core-types-graphql