@mitreka/coreflow-types 0.0.4 → 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

@@ -1,29 +1,3 @@
-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;
-  search: string;
-  order: FindOrderOptions<T>;
-  where: FindWhereOptions<T>;
-  with?: string[];
-}
-
-export type FindOrder = "ASC" | "DESC";
-
-export type FindOrderOptions<T> = Array<{ [K in keyof T]?: FindOrder }>;
-
-export type FindWhereOptions<T> = {
-  [K in keyof T]?: T[K] | T[K][];
-}
-
 export type Point = {
   x: number;
   y: number;

package/{Company.ts → company.ts}

@@ -1,4 +1,6 @@
-import { BaseEntity, type Point } from "./common.js";
+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;
@@ -41,6 +43,8 @@ export interface CompanyEntity {
   website?: string;
   coordinate?: Point;
   radius?: number;
+  projects?: Project[];
+  users?: User[];
 }
 
 export interface Country extends BaseEntity, CountryEntity {

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/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.4",
+  "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 → subscription.ts}

@@ -1,4 +1,4 @@
-import { BaseEntity } from "./common";
+import type { BaseEntity } from './entity.js';
 
 export interface Subscriber extends BaseEntity, SubscriberEntity {
   id: string;

package/{Task.ts → task.ts}

@@ -1,4 +1,4 @@
-import { BaseEntity } from "./common";
+import type { BaseEntity } from './entity.js';
 
 export interface Board extends BaseEntity, BoardEntity {
   id: string;
@@ -14,7 +14,7 @@ export interface BoardEntity {
 }
 
 export enum BoardType {
-  Backlog, Progress, Done
+  BACKLOG, PROGRESS, DONE
 }
 
 export interface Color extends ColorEntity {
@@ -198,8 +198,8 @@ export interface WorkspaceMemberEntity {
 }
 
 export enum WorkspaceMemberStatus {
-  Active = "Active",
-  Inactive = "Inactive"
+  ACTIVE = "ACTIVE",
+  INACTIVE = "INACTIVE"
 }
 
 export interface WorkspaceSkill extends BaseEntity, WorkspaceSkillEntity {
@@ -212,8 +212,8 @@ export interface WorkspaceSkillEntity {
 }
 
 export enum WorkspaceStatus {
-  Active = "Active",
-  Closed = "Closed",
-  Hold = "Hold",
-  Planned = "Planned"
+  ACTIVE = "ACTIVE",
+  CLOSED = "CLOSED",
+  HOLD = "HOLD",
+  PLANNED = "PLANNED"
 }

package/{User.ts → user.ts}

@@ -1,4 +1,7 @@
-import { BaseEntity } from "./common";
+import type { Company } from './company.js';
+import type { BaseEntity, RelationEntity } from './entity.js';
+import type { Subscription } from './subscription.js';
+import type { Task } from './task.js';
 
 export interface Permission extends BaseEntity, PermissionEntity {
   id: string;
@@ -6,7 +9,8 @@ export interface Permission extends BaseEntity, PermissionEntity {
 
 export interface PermissionEntity {
   name: string;
-  actions: string[];
+  module: string;
+  description?: string;
 }
 
 export interface Role extends BaseEntity, RoleEntity {
@@ -16,7 +20,17 @@ export interface Role extends BaseEntity, RoleEntity {
 export interface RoleEntity {
   company_id: string;
   name: string;
-  permission: string[];
+  is_active: boolean;
+  is_owner: boolean;
+}
+
+export interface RolePermission extends RelationEntity, RolePermissionEntity {
+  id: string;
+}
+
+export interface RolePermissionEntity {
+  role_id: string;
+  permission_id: string;
 }
 
 export interface Skill extends BaseEntity, SkillEntity {
@@ -40,7 +54,7 @@ export interface UserEntity {
   email: string;
   phone?: string;
   is_active: boolean;
-  is_suspended: boolean;
+  is_loginable: boolean;
   address?: string;
   avatar?: string;
   gender: UserGender;
@@ -48,6 +62,11 @@ export interface UserEntity {
   birth_place?: string;
   country?: string;
   meta?: UserMeta
+  companies?: Company[];
+  roles?: Role[];
+  skills?: Skill[];
+  subscriptions?: Subscription[];
+  tasks?: Task[];
 }
 
 export interface UserCompany extends BaseEntity, UserCompanyEntity {
@@ -58,12 +77,13 @@ export interface UserCompanyEntity {
   user_id: string;
   company_id: string;
   is_active: boolean;
+  is_owner: boolean;
   load?: UserLoad;
 }
 
 export enum UserGender {
-  Female = "F",
-  Male = "M"
+  FEMALE = "F",
+  MALE = "M"
 }
 
 export type UserLoad = {
@@ -73,9 +93,9 @@ export type UserLoad = {
 }
 
 export enum UserLoadStatus {
-  High = "High",
-  Medium = "Medium",
-  Low = "Low"
+  HIGH = "HIGH",
+  MEDIUM = "MEDIUM",
+  LOW = "LOW"
 }
 
 export type UserMeta = {

package/Auth.ts

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

package/CoreFlow.ts

@@ -1,15 +0,0 @@
-import type { KeyPair, TokenPair } from "./Auth.js";
-
-export interface CoreFlowConfig {
-  endpoints?: EndpointList;
-  keys?: KeyPair;
-  tokens?: TokenPair;
-}
-
-export interface EndpointList {
-  auth?: string;
-  company?: string;
-  subscription?: string;
-  task?: string;
-  user?: string;
-}

package/index.d.ts

@@ -1,9 +0,0 @@
-export * from "./API.ts";
-export * from "./Auth.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";