Use JSON Schema for model definition

Feature Request

When defining models developers can declare both data requirements but also validation.

export const user = {
    version: 0,
    type: 'object',
    properties: {
        id: {
            type: 'string',
            primary: true
        },
        name: {
            type: 'string'
        },
        color: {
            type: 'string'
        },
        updatedAt: {
            type: 'number'
        }
    },
    indexes: ['name', 'color', 'updatedAt'],
    required: ['color']
};

Since we will need to generate those from GraphQL schema we will have limited information available (only type, required and relations)

The generated source should be editable as users might add more info into those files.

Approach 1

We generate API from GraphQL schema to JSONSchema

Pros:

• Easy to do (multiple libraries available) Cons:
• Lack of typing supports

Approach 2

Generate typescript objects from GraphQL Schema and then transform them Example: https://github.com/YousefED/typescript-json-schema/blob/master/test/programs/comments/

[Eunovo]

• Relationship (Array etc.)

Once again, why an array? Why not mark properties like this

...
       name: {
            type: 'string',
            index: true, // if 'name' is an index
        },
        postId: {
            type: 'string',
            relationship: 'many-to-one' // many comments to one post
        },
...

[kingsleyzissou]

@wtrocki @Eunovo I think the benefits of using an array to hold some of this information is that we don’t have to iterate through each field in the schema to gather the information. It’s only a slight benefit. Although it might be easier to generate the schema and add these as properties to each of the fields.