@mitreka/coreflow-types 0.0.3 → 0.0.5

package/auth.ts

@@ -0,0 +1,159 @@
+import type { BaseEntity } from "./entity.js";
+
+export type AccessCompany = {
+  id: string;
+  name: string;
+  is_owner: boolean;
+}
+
+export type AccessRole = {
+  id: string;
+  name: string;
+}
+
+export type AccessToken = {
+  iss: string; // issuer
+  sub: string; // client id
+  scope: string; // scopes of client, separated by space
+  permissions: string[]; // permissions of client
+  company_id: string; // company id
+  user_id: string; // user id
+  iat: number;
+  exp: number;
+}
+
+export type AccessTokenResponse = {
+  access_token: string;
+  token_type: string; // Bearer
+  expires_in: number;
+  scope: string;
+  refresh_token?: string;
+  id_token?: string; // JWT of IDToken
+}
+
+export type AccessUser = {
+  id: string;
+  username: string;
+  name: string;
+  email: string;
+  phone?: string;
+}
+
+export type AuthAccessType = 'offline' | 'online';
+
+export type AuthGrantType = 'authorization_code' | 'refresh_token';
+
+export type AuthResponseType = 'code' | 'token';
+
+/**
+ * Authorization request
+ */
+export type AuthorizationRequest = {
+  client_id: string;
+  client_secret: string;
+  code: string;
+  code_challenge: string;
+  code_challenge_method: string;
+  code_verifier: string;
+  grant_type: AuthGrantType;
+  response_type: AuthResponseType;
+  refresh_token: string;
+  scope: string;
+  state: string;
+  redirect_uri: string;
+}
+
+export type IDToken = {
+  iss: string;
+  aud: string; // Client ID
+  sub: string; // User ID
+  name: string;
+  email: string;
+  iat: number;
+  exp: number;
+}
+
+export type KeyPair = {
+  private: string;
+  public: string;
+}
+
+export interface OAuthClient extends BaseEntity, OAuthClientEntity {
+  id: string;
+}
+
+export interface OAuthClientEntity {
+  name: string;
+  company_id: string;
+  secret: string;
+  description?: string;
+  is_active: boolean;
+  expired_at: Date;
+}
+
+export interface OAuthGrant {
+  id: string;
+  client_id: string;
+  user_id: string;
+  scopes: string;
+  is_granted: boolean;
+  expires_at?: Date;
+  granted_at: Date;
+}
+
+export interface OAuthScope extends BaseEntity, OAuthScopeEntity {
+  id: string;
+}
+
+export interface OAuthScopeEntity {
+  name: string;
+  description?: string;
+}
+
+export type RefreshToken = {
+  jti: string;
+  iat: number;
+  exp: number;
+}
+
+export type RefreshTokenOptions = {
+  grant_type: AuthGrantType; // refresh_token
+  refresh_token: string;
+  company_id?: string;
+  scope?: string;
+}
+
+export type TokenExpires = {
+  accessExpiresIn: string;
+  refreshExpiresIn: string;
+}
+
+export type TokenPair = {
+  access_token: string;
+  refresh_token: string;
+}
+
+export type UserCredentials = {
+  username: string;
+  password: string;
+}
+
+export type UserSession = {
+  company: AccessCompany;
+  roles: AccessRole[];
+  user: AccessUser;
+}
+
+export type UserVerify = {
+  jti: string;
+  company_id: string;
+  permissions: string[];
+  user: AccessUser;
+}
+
+export type UserVerifyRequest = {
+  username: string;
+  password: string;
+  refresh_token: string;
+  company_id: string;
+}

package/common.ts

@@ -0,0 +1,4 @@
+export type Point = {
+  x: number;
+  y: number;
+}

package/company.ts

@@ -0,0 +1,163 @@
+import type { Point } from './common.js'
+import type { BaseEntity } from './entity.js'
+import type { User } from './user.js';
+
+export interface City extends BaseEntity, CityEntity {
+  id: string;
+}
+
+export interface CityEntity {
+  name: string;
+  province_id: string;
+}
+
+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
+  address?: string;
+}
+
+export interface Company extends BaseEntity, CompanyEntity {
+  id: string;
+}
+
+export interface CompanyEntity {
+  name: string;
+  address?: string;
+  country?: string;
+  province?: string;
+  city?: string;
+  zip_code?: string;
+  phone_number?: string;
+  email?: string;
+  fax?: string;
+  website?: string;
+  coordinate?: Point;
+  radius?: number;
+  projects?: Project[];
+  users?: User[];
+}
+
+export interface Country extends BaseEntity, CountryEntity {
+  id: string;
+}
+
+export interface CountryEntity {
+  country_code: string;
+  name: string;
+  phone_code?: string;
+}
+
+export interface Industry extends BaseEntity, IndustriEntity {
+  id: string;
+}
+
+export interface IndustriEntity {
+  name: string;
+}
+
+export interface OrganizationLevel extends BaseEntity, OrganizationLevelEntity {
+  id: string;
+}
+
+export interface OrganizationLevelEntity {
+  company: Company;
+  parent?: OrganizationLevel;
+  parent_id?: string;
+  company_id: string;
+  children: OrganizationLevel[];
+  name: string;
+  code: string;
+  level: number;
+  is_active: boolean;
+}
+
+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;
+}
+
+export interface OrganizationStructureMember extends BaseEntity, OrganizationStructureMemberEntity {
+  version: OrganizationStructureVersion;
+  version_id: string;
+  node: OrganizationStructureNode;
+  node_id: string;
+  user_id: string;
+  member_role: string;
+  is_primary: boolean;
+}
+
+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;
+  code: string;
+  level: number;
+  is_active: boolean;
+  parent_node_id?: string;
+  source_level_id?: string;
+  mpath?: string;
+  members: OrganizationStructureMember[];
+}
+
+export interface OrganizationStructureVersion extends BaseEntity, OrganizationStructureVersionEntity {
+  id: string;
+}
+
+export interface OrganizationStructureVersionEntity {
+  company_id: string;
+  period_type: string;
+  period_label: string;
+  period_start: string;
+  period_end: string;
+  decree_no?: string;
+  decree_date?: string;
+  status: "draft" | "active" | "archived";
+  notes?: string;
+  nodes: OrganizationStructureNode[];
+}
+
+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;
+}

package/coreflow.ts

@@ -0,0 +1,20 @@
+import type { KeyPair, TokenExpires, TokenPair } from './auth.js';
+import type { CryptorOptions } from './cryptor.js';
+
+export interface CoreFlowOptions {
+  client_id: string;
+  client_secret: string;
+  cryptor: CryptorOptions;
+  endpoints: EndpointList;
+  keys: KeyPair;
+  tokens: TokenPair;
+  tokenExpires: TokenExpires;
+}
+
+export interface EndpointList {
+  auth?: string;
+  company?: string;
+  subscription?: string;
+  task?: string;
+  user?: string;
+}

package/cryptor.ts

@@ -0,0 +1,4 @@
+export type CryptorOptions = {
+  key: string;
+  iv: string;
+}

package/entity.ts

@@ -0,0 +1,11 @@
+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;
+}

package/find.ts

@@ -0,0 +1,28 @@
+import type { Company } from './company.js';
+import type { Role, User } from './user.js';
+
+export type EntityRelations = {
+  company: ['user', 'project'];
+  user: ['company', 'project', 'role'];
+}
+
+export type FindOptions<T> = {
+  page: number;
+  limit: number;
+  search: string;
+  order: FindOrderOptions<T>;
+  where: FindWhereOptions<T>;
+  with: Array<FindEntityOptions<T>>;
+}
+
+export type FindEntityOptions<T> =
+  T extends Company ? EntityRelations['company'][number] :
+  T extends Role ? EntityRelations['company'][number] :
+  T extends User ? EntityRelations['user'][number] : never
+
+export type FindOrder = 'ASC' | 'DESC'
+
+export type FindOrderOptions<T> = { [K in keyof T]?: FindOrder }
+
+export type FindWhereOptions<T> = { [K in keyof T]?: T[K] | T[K][] } |
+  Array<{ [K in keyof T]?: T[K] | T[K][] }>

package/hr.ts

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

package/index.ts

@@ -0,0 +1,13 @@
+export * from './auth.js';
+export * from './common.js'
+export * from './company.js';
+export * from './coreflow.js';
+export * from './cryptor.js';
+export * from './entity.js';
+export * from './find.js';
+export * from './hr.js';
+export * from './resource.js';
+export * from './storage.js';
+export * from './subscription.js';
+export * from './task.js';
+export * from './user.js';

package/package.json

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

package/{API.ts → resource.ts}

@@ -1,4 +1,4 @@
-export type APIResponseCollection<T> = {
+export type ResourceCollection<T> = {
   message: string;
   data: T[];
   meta: {
@@ -9,7 +9,7 @@ export type APIResponseCollection<T> = {
   };
 }
 
-export type APIResponseEntity<T> = {
+export type ResourceEntity<T> = {
   message: string;
   data: T;
 }

package/storage.ts

@@ -0,0 +1,9 @@
+import type { BaseEntity } from "./entity.js";
+
+export interface Storage extends BaseEntity, StorageEntity {
+  id: string;
+}
+
+export interface StorageEntity {
+
+}

package/subscription.ts

@@ -0,0 +1,19 @@
+import type { BaseEntity } from './entity.js';
+
+export interface Subscriber extends BaseEntity, SubscriberEntity {
+  id: string;
+}
+
+export interface SubscriberEntity {
+  email: string;
+  is_validated: boolean;
+}
+
+export interface Subscription extends BaseEntity, SubscriptionEntity {
+  id: string;
+}
+
+export interface SubscriptionEntity {
+  name: string;
+  price: number;
+}

package/task.ts

@@ -0,0 +1,219 @@
+import type { BaseEntity } from './entity.js';
+
+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;
+}
+
+export enum BoardType {
+  BACKLOG, PROGRESS, DONE
+}
+
+export interface Color extends ColorEntity {
+  id: string;
+}
+
+export interface ColorEntity {
+  name: string;
+  color_code: string;
+  color_order: number;
+}
+
+export interface Comment extends BaseEntity, CommentEntity {
+  id: string;
+}
+
+export interface CommentEntity {
+  parent_id: string;
+  task_id: string;
+  comment_text: string;
+  member_id: string;
+}
+
+export interface Label {
+  id: string;
+  workspace_id: string;
+  color_id: string;
+}
+
+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;
+}
+
+export interface StoryPoint extends BaseEntity, StoryPointEntity {
+  id: string;
+}
+
+export interface StoryPointEntity {
+  story_point_type_id: string;
+  story_point_label: string;
+  story_point_value: number;
+}
+
+export interface StoryPointType {
+  id: string;
+  name: string;
+}
+
+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;
+}
+
+export interface SubtaskAssignee extends BaseEntity, SubtaskAssigneeEntity {
+  id: string;
+}
+
+export interface SubtaskAssigneeEntity {
+  subtask_id: string;
+  member_id: string;
+}
+
+export interface SubtaskGroup extends BaseEntity, SubtaskGroupEntity {
+  id: string;
+}
+
+export interface SubtaskGroupEntity {
+  company_id: string;
+  task_id: string;
+  name: string;
+}
+
+export interface Task extends BaseEntity, TaskEntity {
+  id: string;
+}
+
+export interface TaskEntity {
+  company_id: string;
+  workspace_id?: string;
+  board_id?: string;
+  priority_id?: string;
+  story_point_id?: string;
+  title: string;
+  description?: string;
+  start_end?: Date;
+  due_date?: Date;
+  is_due_date: boolean;
+  assignee_id?: string;
+  assigner_id?: string;
+  status_checklist?: number;
+  order_position?: string;
+}
+
+export interface TaskActivity extends BaseEntity, TaskActivityEntity {
+  id: string;
+}
+
+export interface TaskActivityEntity {
+  task_id: string;
+  message: string;
+}
+
+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;
+}
+
+export interface TaskLabel extends BaseEntity, TaskLabelEntity {
+  id: string;
+}
+
+export interface TaskLabelEntity {
+  task_id: string;
+  label_id: string;
+}
+
+export interface TaskMember extends BaseEntity, TaskMemberEntity {
+  id: string;
+}
+
+export interface TaskMemberEntity {
+  task_id: string;
+  member_id: string;
+}
+
+export interface Workspace extends BaseEntity, WorkspaceEntity {
+  id: string;
+}
+
+export interface WorkspaceEntity {
+  color_id: string;
+  company_id: string;
+  title: string;
+  description: string;
+  order_position: number;
+  project_manager_id: string;
+  story_point_type_id: string;
+  workspace_status: WorkspaceStatus;
+}
+
+export interface WorkspaceMember extends BaseEntity, WorkspaceMemberEntity {
+  id: string;
+}
+
+export interface WorkspaceMemberEntity {
+  workspace_id: string;
+  member_id: string;
+  position_id: string;
+  email: string;
+  role: string;
+  is_favorite: boolean;
+  workspace_member_status: WorkspaceMemberStatus;
+}
+
+export enum WorkspaceMemberStatus {
+  ACTIVE = "ACTIVE",
+  INACTIVE = "INACTIVE"
+}
+
+export interface WorkspaceSkill extends BaseEntity, WorkspaceSkillEntity {
+  id: string;
+}
+
+export interface WorkspaceSkillEntity {
+  workspace_id: string;
+  skill_id: string;
+}
+
+export enum WorkspaceStatus {
+  ACTIVE = "ACTIVE",
+  CLOSED = "CLOSED",
+  HOLD = "HOLD",
+  PLANNED = "PLANNED"
+}