Referencing specific enum values?

a0js commented 5 months ago

Is it possible to reference a specific enum value that is defined in another referenced definition? For example in defining a discriminating union:

const schema = {
  title: "OptionRestrictions"
  oneOf: [
    {
      type:"object",
      properties: {
        option: {
          const: <reference enum value Square here>
        },
        length: {
          type: 'number'
        }
      }
    },
    {
      type:"object",
      properties: {
        option: {
          const: <reference enum value Circle here>
        },
        radius: {
          type: 'number'
        }
      }
    }
  ],
  definitions: {
    options: {
      title: "Options",
      type: "string",
      enum: ['square','circle',],
      tsEnumNames: ['Square','Circle']
    }
  }
}

Ideally it would output something like this:

export const enum Options {
  Square = 'square'.
  Circle = 'circle'
}
export type OptionRestrictions =
  |  {
        option: Options.Square,
        length: 'number'
     }
  |  {
       option: Options.Circle,
       radius: 'number'
     };

bcherny commented 5 months ago

You can do something like this:

{
  "title": "Example Schema",
  "type": "object",
  "definitions": {
    "circle": {
      "type": "string",
      "enum": [
        "circle"
      ]
    },
    "square": {
      "type": "string",
      "enum": [
        "square"
      ]
    },
    "shape": {
      "oneOf": [
        {
          "$ref": "#/definitions/circle"
        },
        {
          "$ref": "#/definitions/square"
        }
      ]
    }
  },
  "properties": {
    "shape": {
      "$ref": "#/definitions/shape"
    }
  }
}

=>

/* eslint-disable */
/**
 * This file was automatically generated by json-schema-to-typescript.
 * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
 * and run json-schema-to-typescript to regenerate this file.
 */

export type Shape = Circle | Square;
export type Circle = "circle";
export type Square = "square";

export interface ExampleSchema {
  shape?: Shape;
  [k: string]: unknown;
}

a0js commented 5 months ago

Thank you @bcherny!

bcherny / json-schema-to-typescript

Referencing specific enum values? #600