bigcapital/packages/server/src/interfaces/Model.ts

export interface IModel {
  name: string;
  tableName: string;
  fields: { [key: string]: any };
}

export interface IFilterMeta {
  sortOrder: string;
  sortBy: string;
}

export interface IPaginationMeta {
  pageSize: number;
  page: number;
}

export interface IModelMetaDefaultSort {
  sortOrder: ISortOrder;
  sortField: string;
}

export type IModelColumnType =
  | 'text'
  | 'number'
  | 'enumeration'
  | 'boolean'
  | 'relation';

export type ISortOrder = 'DESC' | 'ASC';

export interface IModelMetaFieldCommon {
  name: string;
  column: string;
  columnable?: boolean;
  fieldType: IModelColumnType;
  customQuery?: Function;
}

export interface IModelMetaFieldNumber {
  fieldType: 'number';
  minLength?: number;
  maxLength?: number;
}

export interface IModelMetaFieldOther {
  fieldType: 'text' | 'boolean';
}

export type IModelMetaField = IModelMetaFieldCommon &
  (IModelMetaFieldOther | IModelMetaEnumerationField | IModelMetaRelationField);

export interface IModelMetaEnumerationOption {
  key: string;
  label: string;
}

export interface IModelMetaEnumerationField {
  fieldType: 'enumeration';
  options: IModelMetaEnumerationOption[];
}

export interface IModelMetaRelationFieldCommon {
  fieldType: 'relation';
}

export interface IModelMetaRelationEnumerationField {
  relationType: 'enumeration';
  relationKey: string;
  relationEntityLabel: string;
  relationEntityKey: string;
}

export type IModelMetaRelationField = IModelMetaRelationFieldCommon & (
  IModelMetaRelationEnumerationField
);

export interface IModelMeta {
  defaultFilterField: string;
  defaultSort: IModelMetaDefaultSort;
  fields: { [key: string]: IModelMetaField };
}