@mitreka/coreflow-types 0.0.2 → 0.0.4

package/API.ts

@@ -0,0 +1,15 @@
+export type APIResponseCollection<T> = {
+  message: string;
+  data: T[];
+  meta: {
+    page: number;
+    limit: number;
+    total: number;
+    total_pages: number;
+  };
+}
+
+export type APIResponseEntity<T> = {
+  message: string;
+  data: T;
+}

package/Auth.ts

@@ -1,10 +1,10 @@
-export interface AccessCompany {
+export type AccessCompany = {
   id: string;
   name: string;
   is_active: boolean;
 }
 
-export interface AccessRole {
+export type AccessRole = {
   id: string;
   name: string;
   permissions: string[];
@@ -12,7 +12,7 @@ export interface AccessRole {
   is_active: boolean;
 }
 
-export interface AccessToken {
+export type AccessToken = {
   company: AccessCompany;
   role: AccessRole;
   user: AccessUser;
@@ -20,7 +20,7 @@ export interface AccessToken {
   exp: number;
 }
 
-export interface AccessUser {
+export type AccessUser = {
   id: string;
   username: string;
   name: string;
@@ -28,32 +28,32 @@ export interface AccessUser {
   phone?: string;
 }
 
-export interface KeyPair {
+export type KeyPair = {
   private?: string;
   public?: string;
 }
 
-export interface RefreshToken {
+export type RefreshToken = {
   jti: string;
   iat: number;
   exp: number;
 }
 
-export interface RefreshTokenOptions {
+export type RefreshTokenOptions = {
   role_id?: string;
 }
 
-export interface TokenExpires {
+export type TokenExpires = {
   accessExpiresIn: string;
   refreshExpiresIn: string;
 }
 
-export interface TokenPair {
+export type TokenPair = {
   access_token: string;
   refresh_token: string;
 }
 
-export interface UserVerify {
+export type UserVerify = {
   companies: AccessCompany[];
   jti: string;
   roles: AccessRole[];

package/Company.ts

@@ -1,31 +1,34 @@
-import { type Point } from "./DB.js";
+import { BaseEntity, type Point } from "./common.js";
 
-export interface City {
+export interface City extends BaseEntity, CityEntity {
   id: string;
+}
+
+export interface CityEntity {
   name: string;
   province_id: string;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
-export interface Client {
+export interface Client extends BaseEntity, ClientEntity {
   id: string;
+}
+
+export interface ClientEntity {
   parent_id?: string;
   company_id: string;
   user_am_id: string; // Account Manager
   name: string;
   code: string;
   abbrev: string; // Singkatan
-  coordinate: Point; // Maps
+  coordinate?: Point; // Maps
   address?: string;
 }
 
-export interface Company {
+export interface Company extends BaseEntity, CompanyEntity {
   id: string;
+}
+
+export interface CompanyEntity {
   name: string;
   address?: string;
   country?: string;
@@ -38,40 +41,31 @@ export interface Company {
   website?: string;
   coordinate?: Point;
   radius?: number;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
-export interface Country {
+export interface Country extends BaseEntity, CountryEntity {
   id: string;
+}
+
+export interface CountryEntity {
   country_code: string;
   name: string;
-  phone_code: string;
-  created_at: Date;
-  created_by: string;
-  updated_at: Date;
-  updated_by: string;
-  deleted_at?: Date;
-  deleted_by?: string;
+  phone_code?: string;
 }
 
-export interface Industry {
+export interface Industry extends BaseEntity, IndustriEntity {
   id: string;
+}
+
+export interface IndustriEntity {
   name: string;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
-export interface OrganizationLevel {
+export interface OrganizationLevel extends BaseEntity, OrganizationLevelEntity {
   id: string;
+}
+
+export interface OrganizationLevelEntity {
   company: Company;
   parent?: OrganizationLevel;
   parent_id?: string;
@@ -81,23 +75,21 @@ export interface OrganizationLevel {
   code: string;
   level: number;
   is_active: boolean;
-  created_at: Date;
-  updated_at: Date;
 }
 
-export interface OrganizationLevelMember {
+export interface OrganizationLevelMember extends BaseEntity, OrganizationLevelMemberEntity {
   id: string;
+}
+
+export interface OrganizationLevelMemberEntity {
   level: OrganizationLevel;
   organization_level_id: string;
   user_id: string;
   member_role: string;
   is_primary: boolean;
-  created_at: Date;
-  updated_at: Date;
 }
 
-export interface OrganizationStructureMember {
-  id: string;
+export interface OrganizationStructureMember extends BaseEntity, OrganizationStructureMemberEntity {
   version: OrganizationStructureVersion;
   version_id: string;
   node: OrganizationStructureNode;
@@ -105,12 +97,23 @@ export interface OrganizationStructureMember {
   user_id: string;
   member_role: string;
   is_primary: boolean;
-  created_at: Date;
-  updated_at: Date;
 }
 
-export class OrganizationStructureNode {
+export interface OrganizationStructureMemberEntity {
+  version: OrganizationStructureVersion;
+  version_id: string;
+  node: OrganizationStructureNode;
+  node_id: string;
+  user_id: string;
+  member_role: string;
+  is_primary: boolean;
+}
+
+export interface OrganizationStructureNode extends BaseEntity, OrganizationStructureNodeEntity {
   id: string;
+}
+
+export interface OrganizationStructureNodeEntity {
   version: OrganizationStructureVersion;
   version_id: string;
   name: string;
@@ -120,13 +123,14 @@ export class OrganizationStructureNode {
   parent_node_id?: string;
   source_level_id?: string;
   mpath?: string;
-  created_at: Date;
-  updated_at: Date;
   members: OrganizationStructureMember[];
 }
 
-export interface OrganizationStructureVersion {
+export interface OrganizationStructureVersion extends BaseEntity, OrganizationStructureVersionEntity {
   id: string;
+}
+
+export interface OrganizationStructureVersionEntity {
   company_id: string;
   period_type: string;
   period_label: string;
@@ -134,29 +138,22 @@ export interface OrganizationStructureVersion {
   period_end: string;
   decree_no?: string;
   decree_date?: string;
-  status: 'draft' | 'active' | 'archived';
+  status: "draft" | "active" | "archived";
   notes?: string;
-  created_at: Date;
-  updated_at: Date;
-  created_by?: string;
-  updated_by?: string;
   nodes: OrganizationStructureNode[];
 }
 
-export interface Project {
+export interface Project extends BaseEntity, ProjectEntity {
   id: string;
+}
+
+export interface ProjectEntity {
   company_id: string;
   client_id: string;
   name: string;
   start_date: Date;
   end_date: Date;
-  user_pm_id: string;
-  pic_name: string;
-  pic_phone: string;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
+  user_pm_id?: string;
+  pic_name?: string;
+  pic_phone?: string;
 }

package/HR.ts

@@ -0,0 +1,3 @@
+export interface Attendance {
+  id: string;
+}

package/Subscription.ts

@@ -1,23 +1,19 @@
-export interface Subscriber {
+import { BaseEntity } from "./common";
+
+export interface Subscriber extends BaseEntity, SubscriberEntity {
   id: string;
+}
+
+export interface SubscriberEntity {
   email: string;
   is_validated: boolean;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
-export interface Subscription {
+export interface Subscription extends BaseEntity, SubscriptionEntity {
   id: string;
+}
+
+export interface SubscriptionEntity {
   name: string;
   price: number;
-  created_at: Date;
-  created_by: string;
-  deleted_at?: Date,
-  deleted_by?: string,
-  updated_at?: Date,
-  updated_by?: string
 }

package/Task.ts

@@ -1,42 +1,41 @@
-export interface Board {
+import { BaseEntity } from "./common";
+
+export interface Board extends BaseEntity, BoardEntity {
   id: string;
+}
+
+export interface BoardEntity {
   company_id: string;
   workspace_id: string;
   name: string;
   board_type: BoardType;
   order_no: number;
   order_position: number;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
 export enum BoardType {
   Backlog, Progress, Done
 }
 
-export interface Color {
+export interface Color extends ColorEntity {
   id: string;
+}
+
+export interface ColorEntity {
   name: string;
   color_code: string;
   color_order: number;
 }
 
-export interface Comment {
+export interface Comment extends BaseEntity, CommentEntity {
   id: string;
+}
+
+export interface CommentEntity {
   parent_id: string;
   task_id: string;
   comment_text: string;
   member_id: string;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
 export interface Label {
@@ -45,32 +44,31 @@ export interface Label {
   color_id: string;
 }
 
-export interface Priority {
+export interface LabelCreate {
+  workspace_id: string;
+  color_id: string;
+}
+
+export interface Priority extends BaseEntity, PriorityEntity {
   id: string;
+}
+
+export interface PriorityEntity {
   company_id: string;
   workspace_id: string;
   color_id: string;
   name: string;
   order_position: number;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
-export interface StoryPoint {
+export interface StoryPoint extends BaseEntity, StoryPointEntity {
   id: string;
+}
+
+export interface StoryPointEntity {
   story_point_type_id: string;
   story_point_label: string;
   story_point_value: number;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
 export interface StoryPointType {
@@ -78,49 +76,43 @@ export interface StoryPointType {
   name: string;
 }
 
-export interface Subtask {
+export interface Subtask extends BaseEntity, SubtaskEntity {
   id: string;
+}
+
+export interface SubtaskEntity {
   task_id: string;
   subtask_group_id: string;
   name: string;
   is_done: boolean;
   completed_at?: Date;
   completed_by?: string;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
-export interface SubtaskAssignee {
+export interface SubtaskAssignee extends BaseEntity, SubtaskAssigneeEntity {
   id: string;
+}
+
+export interface SubtaskAssigneeEntity {
   subtask_id: string;
   member_id: string;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
-export interface SubtaskGroup {
+export interface SubtaskGroup extends BaseEntity, SubtaskGroupEntity {
   id: string;
+}
+
+export interface SubtaskGroupEntity {
   company_id: string;
   task_id: string;
   name: string;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
-export interface Task {
+export interface Task extends BaseEntity, TaskEntity {
   id: string;
+}
+
+export interface TaskEntity {
   company_id: string;
   workspace_id?: string;
   board_id?: string;
@@ -135,67 +127,52 @@ export interface Task {
   assigner_id?: string;
   status_checklist?: number;
   order_position?: string;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
-export interface TaskActivity {
+export interface TaskActivity extends BaseEntity, TaskActivityEntity {
   id: string;
+}
+
+export interface TaskActivityEntity {
   task_id: string;
   message: string;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
-export interface TaskAttachment {
+export interface TaskAttachment extends BaseEntity, TaskActivityEntity {
   id: string;
+}
+
+export interface TaskAttachmentEntity {
   task_id: string;
   upload_id: string;
   file_name: string;
   file_type: string;
   size: number;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
-export interface TaskLabel {
+export interface TaskLabel extends BaseEntity, TaskLabelEntity {
   id: string;
+}
+
+export interface TaskLabelEntity {
   task_id: string;
   label_id: string;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
-export interface TaskMember {
+export interface TaskMember extends BaseEntity, TaskMemberEntity {
   id: string;
+}
+
+export interface TaskMemberEntity {
   task_id: string;
   member_id: string;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
-export interface Workspace {
+export interface Workspace extends BaseEntity, WorkspaceEntity {
   id: string;
+}
+
+export interface WorkspaceEntity {
   color_id: string;
   company_id: string;
   title: string;
@@ -204,16 +181,13 @@ export interface Workspace {
   project_manager_id: string;
   story_point_type_id: string;
   workspace_status: WorkspaceStatus;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
-export interface WorkspaceMember {
+export interface WorkspaceMember extends BaseEntity, WorkspaceMemberEntity {
   id: string;
+}
+
+export interface WorkspaceMemberEntity {
   workspace_id: string;
   member_id: string;
   position_id: string;
@@ -221,12 +195,6 @@ export interface WorkspaceMember {
   role: string;
   is_favorite: boolean;
   workspace_member_status: WorkspaceMemberStatus;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
 export enum WorkspaceMemberStatus {
@@ -234,16 +202,13 @@ export enum WorkspaceMemberStatus {
   Inactive = "Inactive"
 }
 
-export interface WorkspaceSkill {
+export interface WorkspaceSkill extends BaseEntity, WorkspaceSkillEntity {
   id: string;
+}
+
+export interface WorkspaceSkillEntity {
   workspace_id: string;
   skill_id: string;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
 export enum WorkspaceStatus {

package/User.ts

@@ -1,69 +1,46 @@
-export interface CreateUser {
-  company_id: string;
-  role_id: string;
-  username: string;
-  password: string;
-  name: string;
-  email: string;
-  phone?: string;
-  is_active: boolean;
-  is_loginable: boolean;
-  address?: string;
-  avatar?: string;
-  gender: UserGender;
-  birth_date?: Date;
-  birth_place?: string;
-  country?: string;
-  meta?: UserMeta
-}
+import { BaseEntity } from "./common";
 
-export interface Permission {
+export interface Permission extends BaseEntity, PermissionEntity {
   id: string;
+}
+
+export interface PermissionEntity {
   name: string;
   actions: string[];
-  created_at: Date;
-  created_by: string;
-  update_at: Date;
-  update_by: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
-export interface Role {
+export interface Role extends BaseEntity, RoleEntity {
   id: string;
+}
+
+export interface RoleEntity {
   company_id: string;
   name: string;
   permission: string[];
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
-export interface Skill {
+export interface Skill extends BaseEntity, SkillEntity {
   id: string;
+}
+
+export interface SkillEntity {
   company_id: string;
   parent_id: string;
   name: string;
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
-export interface User {
+export interface User extends BaseEntity, UserEntity {
   id: string;
+}
+
+export interface UserEntity {
   username: string;
   password: string;
   name: string;
   email: string;
   phone?: string;
   is_active: boolean;
-  is_loginable: boolean;
+  is_suspended: boolean;
   address?: string;
   avatar?: string;
   gender: UserGender;
@@ -71,25 +48,23 @@ export interface User {
   birth_place?: string;
   country?: string;
   meta?: UserMeta
-  created_at: Date;
-  created_by: string;
-  updated_at?: Date;
-  updated_by?: string;
-  deleted_at?: Date;
-  deleted_by?: string;
 }
 
-export interface UserCompany {
+export interface UserCompany extends BaseEntity, UserCompanyEntity {
   id: string;
+}
+
+export interface UserCompanyEntity {
   user_id: string;
   company_id: string;
   is_active: boolean;
   load?: UserLoad;
-  created_at: Date;
-  created_by: string;
 }
 
-export type UserGender = "F" | "M";
+export enum UserGender {
+  Female = "F",
+  Male = "M"
+}
 
 export type UserLoad = {
   status: UserLoadStatus;
@@ -97,7 +72,11 @@ export type UserLoad = {
   project: number;
 }
 
-export type UserLoadStatus = "High" | "Normal" | "Low";
+export enum UserLoadStatus {
+  High = "High",
+  Medium = "Medium",
+  Low = "Low"
+}
 
 export type UserMeta = {
   token: string;
@@ -112,6 +91,12 @@ export interface UserRole {
   created_by: string;
 }
 
+export interface UserRoleCreate {
+  user_id: string;
+  role_id: string;
+  is_active: boolean;
+}
+
 export interface UserSkill {
   id: string;
   user_id: string;
@@ -120,8 +105,22 @@ export interface UserSkill {
   created_by: string;
 }
 
+export interface UserSkillCreate {
+  user_id: string;
+  skill_id: string;
+}
+
 export interface UserSubscription {
   id: string;
   user_id: string;
   subscription_id: string;
+  start_date?: Date;
+  end_date?: Date;
+}
+
+export interface UserSubscriptionCreate {
+  user_id: string;
+  subscription_id: string;
+  start_date?: Date;
+  end_date?: Date;
 }

package/{DB.ts → common.ts}

@@ -1,3 +1,12 @@
+export interface BaseEntity {
+  created_at: Date;
+  created_by: string;
+  updated_at?: Date;
+  updated_by?: string;
+  deleted_at?: Date;
+  deleted_by?: string;
+}
+
 export type FindOptions<T> = {
   page: number;
   limit: number;

package/index.d.ts

@@ -1,7 +1,9 @@
+export * from "./API.ts";
 export * from "./Auth.ts";
-export * from "./DB.ts";
 export * from "./Company.ts";
 export * from "./CoreFlow.ts";
+export * from "./common.ts";
+export * from "./HR.ts";
 export * from "./Subscription.ts";
 export * from "./Task.ts";
 export * from "./User.ts";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mitreka/coreflow-types",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "CoreFlow Types Definition",
   "author": {
     "name": "Riyan Widiyanto",