Skip to content
Snippets Groups Projects
Schema.ts 987 B
Newer Older
export type BuildObj = {
  type: "String" | "Date" | "Float" | "Int" | "Boolean";
  required?: boolean;
};
Frank Bessou's avatar
Frank Bessou committed

export type Cardinality = "*" | "1" | "?" | "+";

export type CardinalityPair = `${Cardinality}${Cardinality}`;

export type RelationDefinition<EntityType extends string> = {
  name: string;
  cardinality: CardinalityPair;
  subject: EntityType;
  object: EntityType;
};
Frank Bessou's avatar
Frank Bessou committed

export type EntitySchema = Record<string, BuildObj>;

export type EntitiesSchemas<EntityTypes extends string> = Record<
  EntityTypes,
  EntitySchema
>;
Frank Bessou's avatar
Frank Bessou committed

// eslint-disable-next-line @typescript-eslint/no-explicit-any
export type Schema<
  EntityTypes extends string = string,
  ESchemas extends EntitiesSchemas<EntityTypes> = EntitiesSchemas<EntityTypes>,
  RDefs extends RelationDefinition<EntityTypes>[] = RelationDefinition<EntityTypes>[]
> = {
  entities: ESchemas;
  relationsDefinitions: RDefs;
Frank Bessou's avatar
Frank Bessou committed
};

export type SchemaEntityTypes<S extends Schema<string>> = Extract<
  keyof S["entities"],
  string
>;