@mitreka/coreflow-types

CoreFlow Types Definition

All entities must extend either BaseEntity or RelationEntity. For example we assume User interface is BaseEntity and UserRole interface is RelationEntity.

entity.ts

export interface BaseEntity extends RelationEntity {
  deleted_at?: Date;
  deleted_by?: string;
}

export interface RelationEntity {
  created_at: Date;
  created_by: string;
  updated_at?: Date;
  updated_by?: string;
}

Base Entity

If you have base schema like this:

CREATE TABLE users (
  "id" primary character varying(255) not null,
  "name" character varying(255) not null,
  "email" character varying(255) not null,
  "password" character varying(255) not null,
  "created_at" timestamp not null default now(),
  "created_by" bigserial not null,
  "updated_at" timestamp,
  "updated_by" bigserial,
  "deleted_at" timestamp,
  "deleted_by" bigserial
);

Then you have to make the entities like these:

export interface UserEntity extends BaseEntity {
  id: string;
  name: string;
  email: string;
  password: string;
}

export type User = Omit<UserEntity, 'id' | keyof BaseEntity>;
export type UserRequest = QueryFilters & BaseEntityFilters &
  Omit<UserEntity, 'password' | keyof BaseEntity>;

Relation Entity

If you have relation schema like this:

CREATE TABLE user_roles (
  "id" primary character varying(255) not null,
  "user_id" character varying(255) not null,
  "role_id" character varying(255) not null,
  "created_at" timestamp not null default now(),
  "created_by" bigserial not null,
  "updated_at" timestamp,
  "updated_by" bigserial
);

Then you have to make the entities like these:

export interface UserRoleEntity extends RelationEntity {
  id: string;
  user_id: string;
  role_id: string;
}

export type UserRole = Omit<UserEntity, 'id' | keyof BaseEntity>;
export type UserRoleRequest = QueryFilters & BaseEntityFilters &
  Omit<UserRoleEntity, keyof BaseEntity>;