Security News
Oracle Drags Its Feet in the JavaScript Trademark Dispute
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
core-types-json-schema
Advanced tools
This package provides conversion functions between core-types
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
which uses this package to convert between TypeScript, JSON Schema, GraphQL and Open API.
Other conversion packages:
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
.
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:
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.
import { convertJsonSchemaToCoreTypes } from 'core-types-json-schema'
let jsonSchema; // This JSON Schema comes from somewhere
const { data: doc } = convertJsonSchemaToCoreTypes( jsonSchema );
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:
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
.
import { convertOpenApiTpCoreTypes } from 'core-types-json-schema'
let openApiSchema; // This Open API schema comes from somewhere
const { data: doc } = convertOpenApiTpCoreTypes( openApiSchema );
FAQs
core-types ⬌ JSON Schema conversion
The npm package core-types-json-schema receives a total of 12,880 weekly downloads. As such, core-types-json-schema popularity was classified as popular.
We found that core-types-json-schema demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
Security News
The Linux Foundation is warning open source developers that compliance with global sanctions is mandatory, highlighting legal risks and restrictions on contributions.
Security News
Maven Central now validates Sigstore signatures, making it easier for developers to verify the provenance of Java packages.