fix(Package): Export JsonSchema type

Closes #240

ts/jsonSchema.ts → ts/JsonSchema.ts

@@ -18,7 +18,7 @@ import { JSONSchema7 } from 'json-schema'
  *
  * For more details see the guidelines for authoring schemas.
  */
-export default interface JsonSchema extends JSONSchema7 {
+export interface JsonSchema extends JSONSchema7 {
   /**
    * The id for the type or property schema to be used
    * when generating JSON-LD.

ts/__tests__/helpers.ts

@@ -1,11 +1,11 @@
 import fs from 'fs-extra'
 import path from 'path'
-import JsonSchema from '../jsonSchema'
+import { JsonSchema } from '../JsonSchema'
 
 export const schema = (name: string): Promise<JsonSchema> =>
-  fs.readJSON(path.join(__dirname, '..', '..', 'public', name)) as Promise<
-    JsonSchema
-  >
+  fs.readJSON(
+    path.join(__dirname, '..', '..', 'public', name)
+  ) as Promise<JsonSchema>
 
 export const snapshot = (dirname: string, name: string): string =>
   path.join(dirname, '__file_snapshots__', name)

ts/bindings/python.ts

@@ -12,8 +12,8 @@ import {
   filterUnionSchemas,
   getSchemaProperties,
   readSchemas,
-  Schema,
 } from '../helpers'
+import { JsonSchema } from '../JsonSchema'
 
 const MAX_LINE_LENGTH = 75 // Desired max length - 4 to allow for indent
 
@@ -102,7 +102,7 @@ function formatDocstring(description: string): string {
 /**
  * Generate a `class`.
  */
-export function classGenerator(schema: Schema): string {
+export function classGenerator(schema: JsonSchema): string {
   const { title, extends: parent, description } = schema
   assert(title !== undefined)
 
@@ -166,7 +166,7 @@ export function classGenerator(schema: Schema): string {
 /**
  * Generate a `Union` type.
  */
-export function unionGenerator(schema: Schema): string {
+export function unionGenerator(schema: JsonSchema): string {
   const { title = '', description } = schema
   let code = ''
   if (description !== undefined) {
@@ -179,7 +179,7 @@ export function unionGenerator(schema: Schema): string {
 /**
  * Convert a schema definition to a Python type
  */
-function schemaToType(schema: Schema): string {
+function schemaToType(schema: JsonSchema): string {
   const { type, anyOf, allOf, $ref } = schema
 
   if ($ref !== undefined) return `"${$ref.replace('.schema.json', '')}"`
@@ -201,7 +201,7 @@ function schemaToType(schema: Schema): string {
 /**
  * Convert a schema with the `anyOf` property to a Python `Union` type.
  */
-function anyOfToType(anyOf: Schema[]): string {
+function anyOfToType(anyOf: JsonSchema[]): string {
   const types = anyOf
     .map((schema) => schemaToType(schema))
     .reduce(
@@ -222,15 +222,15 @@ function anyOfToType(anyOf: Schema[]): string {
  * used on a property and the last schema is the final, expected, type of
  * the property).
  */
-function allOfToType(allOf: Schema[]): string {
+function allOfToType(allOf: JsonSchema[]): string {
   if (allOf.length === 1) return schemaToType(allOf[0])
   else return schemaToType(allOf[allOf.length - 1])
 }
 
 /**
  * Convert a schema with the `array` property to a Python `Array` type.
  */
-function arrayToType(schema: Schema): string {
+function arrayToType(schema: JsonSchema): string {
   const items = Array.isArray(schema.items)
     ? anyOfToType(schema.items)
     : schema.items !== undefined

ts/bindings/r.ts

@@ -10,8 +10,8 @@ import {
   filterUnionSchemas,
   getSchemaProperties,
   readSchemas,
-  Schema,
 } from '../helpers'
+import { JsonSchema } from '../JsonSchema'
 
 /**
  * Run `build()` when this file is run as a Node script
@@ -51,7 +51,7 @@ ${unionsCode}
 /**
  * Generate a constructor function for a normal type.
  */
-export function classGenerator(schema: Schema): string {
+export function classGenerator(schema: JsonSchema): string {
   const { title = 'Untitled', extends: parent, description = title } = schema
   const { all, inherited, own } = getSchemaProperties(schema)
 
@@ -100,7 +100,7 @@ export function classGenerator(schema: Schema): string {
 /**
  * Generate a `Union` type.
  */
-export function unionGenerator(schema: Schema): string {
+export function unionGenerator(schema: JsonSchema): string {
   const { title = '', description = title } = schema
   let code = docComment(description, ['@export'])
   code += `${title} <- ${schemaToType(schema)}\n\n`
@@ -125,7 +125,7 @@ function docComment(description: string, tags: string[] = []): string {
 /**
  * Convert a schema definition to a R class
  */
-function schemaToType(schema: Schema): string {
+function schemaToType(schema: JsonSchema): string {
   const { type, anyOf, allOf, $ref } = schema
 
   if ($ref !== undefined) return `${$ref.replace('.schema.json', '')}`
@@ -147,7 +147,7 @@ function schemaToType(schema: Schema): string {
 /**
  * Convert a schema with the `anyOf` property to a `Union` type checker.
  */
-function anyOfToType(anyOf: Schema[]): string {
+function anyOfToType(anyOf: JsonSchema[]): string {
   const types = anyOf
     .map((schema) => schemaToType(schema))
     .reduce(
@@ -162,15 +162,15 @@ function anyOfToType(anyOf: Schema[]): string {
 /**
  * Convert a schema with the `allOf` property to a type.
  */
-function allOfToType(allOf: Schema[]): string {
+function allOfToType(allOf: JsonSchema[]): string {
   if (allOf.length === 1) return schemaToType(allOf[0])
   else return schemaToType(allOf[allOf.length - 1])
 }
 
 /**
  * Convert a schema with the `array` property to an `Array` type checker.
  */
-function arrayToType(schema: Schema): string {
+function arrayToType(schema: JsonSchema): string {
   const items = Array.isArray(schema.items)
     ? anyOfToType(schema.items)
     : schema.items !== undefined

ts/bindings/typescript.ts

@@ -12,8 +12,8 @@ import {
   filterUnionSchemas,
   getSchemaProperties,
   readSchemas,
-  Schema,
 } from '../helpers'
+import { JsonSchema } from '../JsonSchema'
 
 /**
  * Runs Prettier to beautify code contents based on the project settings
@@ -72,7 +72,7 @@ ${await generateTypeMaps()}
  * Generate a `interface Types`, that maps all types
  * and can be used to get a type from its name at compile time.
  */
-export const typesInterface = (schemas: Schema[]): string => {
+export const typesInterface = (schemas: JsonSchema[]): string => {
   return `export interface Types {\n${schemas
     .map(({ title }) =>
       title !== undefined ? `  ${title}: ${titleToType(title)}` : ''
@@ -101,7 +101,7 @@ export const titleToType = (title: string): string => {
 /**
  * Generate a `interface` and a factory function for each type.
  */
-export const interfaceGenerator = (schema: Schema): string => {
+export const interfaceGenerator = (schema: JsonSchema): string => {
   const {
     title = 'Undefined',
     extends: parent,
@@ -155,7 +155,7 @@ export const interfaceGenerator = (schema: Schema): string => {
 /**
  * Generate a `Union` type.
  */
-export const unionGenerator = (schema: Schema): string => {
+export const unionGenerator = (schema: JsonSchema): string => {
   const { title = '', description } = schema
   return (
     docComment(description) +
@@ -194,7 +194,7 @@ const docComment = (description?: string, tags: string[] = []): string => {
 /**
  * Convert a JSON Schema definition to a Typescript type
  */
-const schemaToType = (schema: Schema): string => {
+const schemaToType = (schema: JsonSchema): string => {
   const { type, anyOf, allOf, $ref } = schema
 
   if ($ref !== undefined) return $refToType($ref)
@@ -225,7 +225,7 @@ const $refToType = ($ref: string): string => {
 /**
  * Convert a JSON Schema with the `anyOf` property to a Typescript `Union` type.
  */
-const anyOfToType = (anyOf: Schema[]): string => {
+const anyOfToType = (anyOf: JsonSchema[]): string => {
   const types = anyOf
     .map((schema) => schemaToType(schema))
     .reduce(
@@ -246,7 +246,7 @@ const anyOfToType = (anyOf: Schema[]): string => {
  * used on a property and the last schema is the final, expected, type of
  * the property).
  */
-const allOfToType = (allOf: Schema[]): string => {
+const allOfToType = (allOf: JsonSchema[]): string => {
   if (allOf.length === 1) return schemaToType(allOf[0])
   else return schemaToType(allOf[allOf.length - 1])
 }
@@ -257,7 +257,7 @@ const allOfToType = (allOf: Schema[]): string => {
  * Uses the more explicity `Array<>` syntax over the shorter`[]` syntax
  * because the latter necessitates the use of, sometime superfluous, parentheses.
  */
-const arrayToType = (schema: Schema): string => {
+const arrayToType = (schema: JsonSchema): string => {
   const items = Array.isArray(schema.items)
     ? anyOfToType(schema.items)
     : schema.items !== undefined

ts/docs.ts

@@ -16,7 +16,7 @@ import flatten from 'lodash.flatten'
 import path from 'path'
 import { readSchemas } from './helpers'
 import log from './log'
-import JsonSchema from './jsonSchema'
+import { JsonSchema } from './JsonSchema'
 import {
   Article,
   article,

ts/helpers.ts

@@ -8,8 +8,7 @@ import fs from 'fs-extra'
 import globby from 'globby'
 import path from 'path'
 import toposort from 'toposort'
-import JsonSchema from './jsonSchema'
-export { default as Schema } from './jsonSchema'
+import { JsonSchema } from './JsonSchema'
 
 /**
  * Read the schemas from `public/*.schema.json` and dereference

ts/index.browser.ts

@@ -1,3 +1,3 @@
-export * from './jsonSchema'
+export * from './JsonSchema'
 export * from './types'
 export * from './util/index.browser'

ts/index.ts

@@ -1,3 +1,3 @@
-export * from './jsonSchema'
+export * from './JsonSchema'
 export * from './types'
 export * from './util'

ts/schema.ts

@@ -12,7 +12,7 @@ import yaml from 'js-yaml'
 import cloneDeep from 'lodash.clonedeep'
 import path from 'path'
 import log from './log'
-import JsonSchema from './jsonSchema'
+import { JsonSchema } from './JsonSchema'
 import { versionMajor } from './util/version'
 
 const SCHEMA_SOURCE_DIR = path.join(__dirname, '..', 'schema')

ts/util/jsonSchemas.ts

@@ -9,7 +9,7 @@
 
 import fs from 'fs'
 import path from 'path'
-import JsonSchema from '../jsonSchema'
+import { JsonSchema } from '../JsonSchema'
 
 // Lazily loaded set of JSON Schemas
 let SCHEMAS: Record<string, JsonSchema> = {}