[Feature] Statically set schemas

It would be great if we could do something like this:

import { buildSchema } from '@camberi/firecms';
import { Category } from "@my-projects/schemas";

export const categorySchema = buildSchema<Category>({
 /** everything here stays the same, but now, typescript complains if the schema mismatches with the Category. **/
});

Thanks a lot for your work here 💯

[fgatti675]

Hi @PupoSDC Thanks a lot for your PR!! I have merged it but modified it a little bit. The function you need is now called buildSchemaFrom and I have modified it slightly. I have also tried checking the property data types based on the Typescript types but failed! I already tried once and failed as well, I have to admit Typescript has defeated me here! I am pretty sure it’s possible but I am getting something wrong.

It is not released yet, but it is merged into the master branch so if you would like to use it you can link your project to it directly.

If anyone sees this and is willing to try, the goal is to be able to type check property data types based on a given Typescript type.

A simplified version of the model would be:

interface EntitySchema<Key extends string = string, T extends any = any> {
    properties: Record<Key, Property<T>>;
}

type Property<T = any> =
    T extends string ? StringProperty :
        T extends number ? NumberProperty : never;


interface StringProperty {
    dataType: "string";
}

interface NumberProperty {
    dataType: "number";
}

function buildSchemaFrom<Type extends Partial<{ [P in Key]: T; }>,
    Key extends string = Extract<keyof Type, string>,
    T = any>(
    schema: EntitySchema<Key, T>
): EntitySchema<Key, T> {
    return schema;
}

type Product = {
    name: string,
    price: number,
}

export const productSchema = buildSchemaFrom<Product>({
    properties: {
        name: {
            dataType: "string"
        },
        price: {
            dataType: "string", // THIS SHOULD FAIL
        },
        // missing: { // This fails if uncommented, which is expected
        //     dataType: "string",
        // },
    }
});

If anyone manages to get the simplified version working we can probably escalate it to the whole app 😃

[fgatti675]

Ah I understand! So getting statically type checks based on your Typescript interfaces. Makes total sense, and would make a nice enhancement. I’m adding it to the backlog. If you feel like giving a shot at the implementation let me know!