@mitreka/coreflow-types 0.0.10 → 0.0.12

package/{resource.ts → api.ts}

@@ -5,21 +5,19 @@ export type PageMetaData = {
   total_pages: number;
 }
 
-export type ResourceCollection<T> = {
+/**
+ * List response.
+ */
+export type ListResponse<T> = {
   message: string;
-  data: T[];
   meta: PageMetaData;
+  data: T[];
 }
 
-export type ResourceListRequest = {
-  id: string;
-  order: string;
-  page: number;
-  limit: number;
-  q: string;
-}
-
-export type ResourceEntity<T> = {
+/**
+ * Single API response
+ */
+export type SingleResponse<T> = {
   message: string;
   data: T;
 }

package/auth.ts

@@ -1,45 +1,45 @@
 import type { BaseEntity } from "./entity.js";
+import type { BaseEntityFilters, QueryFilters } from "./filter.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
-}
+  refresh_token?: string; // Refresh Token JWT
+  id_token?: string; // IDToken JWT
+};
 
 export type AccessUser = {
   id: string;
-  username: string;
-  name: string;
   email: string;
+  name: string;
   phone?: string;
-}
+};
 
 export type AuthAccessType = 'offline' | 'online';
+export type AuthChallengeMethod = 'S256';
 export type AuthGrantType = 'authorization_code' | 'refresh_token';
 export type AuthResponseType = 'code' | 'token';
 
@@ -49,34 +49,45 @@ export type AuthorizationParam = {
   code: string;
   code_verifier: string;
   code_challenge: string;
-  code_challenge_method: string;
+  code_challenge_method: AuthChallengeMethod;
+  company_id: string;
+  error: string;
   grant_type: AuthGrantType;
   redirect_uri: string;
   refresh_token: string;
   response_type: AuthResponseType;
   scope: string;
   state: string;
-}
+  token_version: number; // Custom key for token format compatibility. Remove it if not used by any client.
+  user_id: string;
+};
+
+export type AuthorizationCallback = Pick<AuthorizationParam, 'code' | 'error' | 'state'>;
 
 /**
  * Authorization exchange
  */
-export type AuthorizationExchange = Omit<AuthorizationParam, 'code_challenge' | 'code_challenge_method' | 'refresh_token' | 'response_type' | 'scope' | 'state'>;
+export type AuthorizationExchange = Pick<AuthorizationParam, 'client_id' | 'client_secret' | 'code' | 'code_verifier' | 'grant_type' | 'redirect_uri' | 'token_version'>;
 
 /**
  * Authorization refresh
  */
-export type AuthorizationRefresh = Pick<AuthorizationParam, 'client_id' | 'client_secret' | 'grant_type' | 'refresh_token'>;
+export type AuthorizationRefresh = Pick<AuthorizationParam, 'client_id' | 'client_secret' | 'company_id' | 'grant_type' | 'refresh_token'>;
 
 /**
  * Authorization request
  */
-export type AuthorizationRequest = Omit<AuthorizationParam, 'client_secret' | 'code' | 'code_verifier' | 'grant_type' | 'refresh_token'>;
+export type AuthorizationRequest = Omit<AuthorizationParam, 'client_secret' | 'code' | 'code_verifier' | 'company_id' | 'error' | 'grant_type' | 'refresh_token'>;
+
+/**
+ * Authorize client
+ */
+export type AuthorizeClient = Pick<AuthorizationRequest, 'client_id' | 'user_id' | 'scope' | 'redirect_uri' | 'code_challenge' | 'code_challenge_method' | 'state'>;
 
 export type ClientDetail = {
   name: string;
   description?: string;
-}
+};
 
 export type IDToken = {
   iss: string;
@@ -86,123 +97,138 @@ export type IDToken = {
   email?: string;
   iat: number;
   exp: number;
-}
+};
 
 export type KeyPair = {
   private: string;
   public: string;
-}
+};
 
-export interface OAuthClient extends BaseEntity, OAuthClientEntity {
+export interface OAuthClientEntity extends BaseEntity {
   id: string;
-}
-
-export interface OAuthClientEntity {
-  name: string;
   company_id: string;
+  name: string;
   secret: string;
   description?: string;
   is_active: boolean;
   expired_at: Date;
 }
 
-export interface OAuthGrant extends OAuthGrantEntity {
+export type OAuthClient = Omit<OAuthClientEntity, 'id' | keyof BaseEntity>;
+export type OAuthClientRequest = QueryFilters & BaseEntityFilters & {
   id: string;
-}
+  company_id: string;
+  name: string;
+  secret: string;
+  is_active: string;
+  expired_at_from: string;
+  expired_at_to: string;
+};
 
 export interface OAuthGrantEntity {
+  id: string;
   client_id: string;
   user_id: string;
   code: string;
-  scopes: string;
-  auth_code: string;
+  scope: string;
   redirect_uri: string;
-  expired_at?: Date;
-  granted_at?: Date;
+  expired_at: Date;
+  granted_at: Date;
+  code_challenge: string;
+  code_challenge_method: AuthChallengeMethod;
 }
 
+export type OAuthGrant = Omit<OAuthGrantEntity, 'id'>;
+export type OAuthGrantRequest = QueryFilters & {
+  id: string;
+  client_id: string;
+  user_id: string;
+  code: string;
+  scope: string;
+  redirect_uri: string;
+  expired_at_from: string;
+  expired_at_to: string;
+  granted_at_from: string;
+  granted_at_to: string;
+  code_challenge: string;
+  code_challenge_method: AuthChallengeMethod;
+};
+
 export type OAuthLogin = {
-  username: string;
+  email: string;
   password: string;
   client_id: string;
   redirect_uri: string;
   scope: string;
-}
+};
 
-export interface OAuthScope extends BaseEntity, OAuthScopeEntity {
+export interface OAuthScopeEntity extends BaseEntity {
   id: string;
-}
-
-export interface OAuthScopeEntity {
   name: string;
   description?: string;
 }
 
-export interface OAuthSession extends OAuthSessionEntity {
+export type OAuthScope = Pick<OAuthScopeEntity, 'name' | 'description'>;
+export type OAuthScopeRequest = QueryFilters & BaseEntityFilters & {
   id: string;
-}
+  name: string;
+};
 
 export interface OAuthSessionEntity {
+  id: string;
   user_id: string;
   ip_address: string;
   user_agent: string;
-  expires_at?: Date;
+  expired_at?: Date;
 }
 
-export type RedirectUriOptions = {
-  client_id: string;
-  code_challenge: string;
-  code_challenge_method: string;
-  redirect_uri: string;
-  response_type: AuthResponseType;
-  scope: string;
-  state?: string;
-}
+export type OAuthSession = Omit<OAuthSessionEntity, 'id'>;
 
 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 SessionList = {
   active: string;
   list: string[];
-}
+};
 
 export type TokenExpires = {
   accessExpiresIn: string;
   refreshExpiresIn: string;
-}
+};
 
 export type TokenPair = {
   access_token: string;
   refresh_token: string;
+};
+
+export type UserIdentity = {
+  company_id: string;
+  email: string;
+  jti: string;
+  name: string;
+  user_id: string;
 }
 
 export type UserSession = {
   company: AccessCompany;
   roles: AccessRole[];
   user: AccessUser;
-}
+};
 
-export type UserVerify = {
-  jti: string;
+export type UserIdentityParam = {
   company_id: string;
-  permissions: string[];
-  user: AccessUser;
-}
-
-export type UserVerifyRequest = {
-  username: string;
+  email: string;
+  jti: string;
   password: string;
   refresh_token: string;
-  company_id: string;
-}
+  user_id: string;
+};
+
+export type UserVerifyByJti = Pick<UserIdentityParam, 'company_id' | 'jti'>;
+export type UserVerifyByToken = Pick<UserIdentityParam, 'company_id' | 'refresh_token'>;
+export type UserVerifyByUserId = Pick<UserIdentityParam, 'company_id' | 'user_id'>;
+export type UserVerifyByCredentials = Pick<UserIdentityParam, 'company_id' | 'email' | 'password'>;

package/company.ts

@@ -1,21 +1,22 @@
 import type { Point } from './common.js'
 import type { BaseEntity } from './entity.js'
-import type { User } from './user.js';
+import type { BaseEntityFilters, QueryFilters } from './filter.js';
 
-export interface City extends BaseEntity, CityEntity {
+export interface CityEntity extends BaseEntity {
   id: string;
-}
-
-export interface CityEntity {
   name: string;
   province_id: string;
 }
 
-export interface Client extends BaseEntity, ClientEntity {
+export type City = Pick<CityEntity, 'name' | 'province_id'>;
+export type CityRequest = QueryFilters & BaseEntityFilters & {
   id: string;
-}
+  name: string;
+  province_id: string;
+};
 
-export interface ClientEntity {
+export interface ClientEntity extends BaseEntity {
+  id: string;
   parent_id?: string;
   company_id: string;
   user_am_id: string; // Account Manager
@@ -26,11 +27,20 @@ export interface ClientEntity {
   address?: string;
 }
 
-export interface Company extends BaseEntity, CompanyEntity {
+export type Client = Omit<ClientEntity, 'id' | keyof BaseEntity>;
+export type ClientRequest = QueryFilters & BaseEntityFilters & {
   id: string;
-}
+  parent_id: string;
+  company_id: string;
+  user_am_id: string;
+  name: string;
+  code: string;
+  abbrev: string;
+  address: string;
+};
 
-export interface CompanyEntity {
+export interface CompanyEntity extends BaseEntity {
+  id: string;
   name: string;
   address?: string;
   country?: string;
@@ -41,30 +51,49 @@ export interface CompanyEntity {
   email?: string;
   fax?: string;
   website?: string;
-  coordinate?: Point;
-  radius?: number;
-  projects?: Project[];
-  users?: User[];
 }
 
-export interface Country extends BaseEntity, CountryEntity {
+export type Company = Omit<CompanyEntity, 'id' | keyof BaseEntity>;
+export type CompanyRequest = QueryFilters & BaseEntityFilters & {
+  id: string;
+  name: string;
+  address: string;
+  country: string;
+  province: string;
+  city: string;
+  zip_code: string;
+  phone_number: string;
+  email: string;
+  fax: string;
+  website: string;
+};
+
+export interface CountryEntity extends BaseEntity {
   id: string;
-}
-
-export interface CountryEntity {
   country_code: string;
   name: string;
   phone_code?: string;
 }
 
-export interface Industry extends BaseEntity, IndustriEntity {
+export type Country = Omit<CountryEntity, 'id' | keyof BaseEntity>;
+export type CountryRequest = QueryFilters & BaseEntityFilters & {
   id: string;
-}
+  country_code: string;
+  name: string;
+  phone_code: string;
+};
 
-export interface IndustriEntity {
+export interface IndustriEntity extends BaseEntity {
+  id: string;
   name: string;
 }
 
+export type Industry = Omit<IndustriEntity, 'id' | keyof BaseEntity>;
+export type IndustryRequest = QueryFilters & BaseEntityFilters & {
+  id: string;
+  name: string;
+};
+
 export interface OrganizationLevel extends BaseEntity, OrganizationLevelEntity {
   id: string;
 }

package/error.ts

@@ -15,6 +15,13 @@ export class BadRequestError extends HttpError {
   }
 }
 
+export class ConflictError extends HttpError {
+  constructor(message: string = 'Conflict') {
+    super(409, message);
+    this.name = 'ConflictError';
+  }
+}
+
 export class UnauthorizedError extends HttpError {
   constructor(message = 'Unauthorized') {
     super(401, message);

package/filter.ts

@@ -0,0 +1,52 @@
+/**
+ * Expired filters.
+ */
+export type ExpiredFilters = {
+  expired_at_from: string;
+  expired_at_to: string;
+};
+
+/**
+ * Granted filters.
+ */
+export type GrantedFilters = {
+  granted_at_from: string;
+  granted_at_to: string;
+};
+
+/**
+ * Query filters.
+ */
+export type QueryFilters = {
+  order: string;
+  page: number;
+  limit: number;
+  q: string;
+}
+
+/**
+ * Inclusive BaseEntity filters.
+ */
+export type BaseEntityFilters = {
+  created_at_from: string;
+  created_at_to: string;
+  created_by: string;
+  updated_at_from: string;
+  updated_at_to: string;
+  updated_by: string;
+  deleted_at_from: string;
+  deleted_at_to: string;
+  deleted_by: string;
+}
+
+/**
+ * Inclusive RelationEntity filters.
+ */
+export type RelationEntityFilters = {
+  created_at_from: string;
+  created_at_to: string;
+  created_by: string;
+  updated_at_from: string;
+  updated_at_to: string;
+  updated_by: string;
+}

package/find.ts

@@ -12,14 +12,8 @@ export type FindOptions<T> = {
   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 }

package/index.ts

@@ -1,3 +1,4 @@
+export * from './api.js';
 export * from './auth.js';
 export * from './common.js'
 export * from './company.js';
@@ -6,8 +7,8 @@ export * from './cryptor.js';
 export * from './entity.js';
 export * from './error.js';
 export * from './find.js';
+export * from './filter.js';
 export * from './hr.js';
-export * from './resource.js';
 export * from './storage.js';
 export * from './subscription.js';
 export * from './task.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mitreka/coreflow-types",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "description": "CoreFlow Types Definition",
   "author": {
     "name": "Riyan Widiyanto",
@@ -26,4 +26,4 @@
   "scripts": {},
   "dependencies": {},
   "peerDependencies": {}
-}
+}

package/user.ts

@@ -1,57 +1,62 @@
-import type { Company } from './company.js';
+import type { BaseEntityFilters, QueryFilters, RelationEntityFilters } from './filter.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;
-}
-
-export interface PermissionEntity {
+export interface PermissionEntity extends BaseEntity {
+  id: string
   name: string;
   module: string;
   description?: string;
 }
 
-export interface Role extends BaseEntity, RoleEntity {
+export type Permission = Omit<PermissionEntity, 'id' | keyof BaseEntity>;
+export type PermissionRequest = QueryFilters & BaseEntityFilters & {
   id: string;
-}
+  name: string;
+  module: string;
+  description: string;
+};
 
-export interface RoleEntity {
+export interface RoleEntity extends BaseEntity {
+  id: string;
   company_id: string;
   name: string;
   is_active: boolean;
   is_owner: boolean;
 }
 
-export interface RolePermission extends RelationEntity, RolePermissionEntity {
+export type Role = Omit<RoleEntity, 'id' | keyof BaseEntity>;
+export type RoleRequest = QueryFilters & BaseEntityFilters & {
   id: string;
-}
+  company_id: string;
+  name: string;
+  is_active: string;
+  is_owner: string;
+};
 
-export interface RolePermissionEntity {
+export interface RolePermissionEntity extends RelationEntity {
+  id: string;
   role_id: string;
   permission_id: string;
 }
 
-export interface Skill extends BaseEntity, SkillEntity {
-  id: string;
-}
+export type RolePermission = Omit<RolePermissionEntity, 'id' | keyof BaseEntity>;
+export type RolePermissionRequest = QueryFilters & RolePermissionEntity;
 
-export interface SkillEntity {
+export interface SkillEntity extends BaseEntity {
+  id: string;
   company_id: string;
   parent_id: string;
   name: string;
 }
 
-export interface User extends BaseEntity, UserEntity {
-  id: string;
-}
+export type Skill = Omit<SkillEntity, 'id' | keyof BaseEntity>;
+export type SkillRequest = QueryFilters & SkillEntity;
 
-export interface UserEntity {
-  username: string;
-  password: string;
-  name: string;
+export interface UserEntity extends BaseEntity {
+  id: string;
   email: string;
+  password?: string;
+  name: string;
   phone?: string;
   is_active: boolean;
   is_loginable: boolean;
@@ -61,26 +66,43 @@ export interface UserEntity {
   birth_date?: Date;
   birth_place?: string;
   country?: string;
-  meta?: UserMeta
-  companies?: Company[];
-  roles?: Role[];
-  skills?: Skill[];
-  subscriptions?: Subscription[];
-  tasks?: Task[];
+  meta?: UserMeta;
 }
 
-export interface UserCompany extends BaseEntity, UserCompanyEntity {
+export type User = Omit<UserEntity, 'id' | keyof BaseEntity>;
+export type UserRequest = QueryFilters & BaseEntityFilters & {
+  id: string;
+  email: string;
+  name: string;
+  phone: string;
+  is_active: string;
+  is_loginable: string;
+  address: string;
+  avatar: string;
+  gender: string;
+  birth_date: string;
+  birth_place: string;
+  country: string;
+};
+
+export interface UserCompanyEntity extends RelationEntity {
   id: string;
-}
-
-export interface UserCompanyEntity {
   user_id: string;
   company_id: string;
-  is_active: boolean;
-  is_owner: boolean;
+  is_admin: boolean;
+  is_primary: boolean;
   load?: UserLoad;
 }
 
+export type UserCompany = Omit<UserCompanyEntity, 'id' | keyof RelationEntity>;
+export type UserCompanyRequest = QueryFilters & RelationEntityFilters & {
+  id: string;
+  user_id: string;
+  company_id: string;
+  is_admin: boolean | string;
+  is_primary: boolean | string;
+};
+
 export enum UserGender {
   FEMALE = "F",
   MALE = "M"
@@ -90,7 +112,7 @@ export type UserLoad = {
   status: UserLoadStatus;
   task: number;
   project: number;
-}
+};
 
 export enum UserLoadStatus {
   HIGH = "HIGH",
@@ -100,17 +122,21 @@ export enum UserLoadStatus {
 
 export type UserMeta = {
   token: string;
-}
+};
 
-export interface UserRole {
+export interface UserRoleEntity extends RelationEntity {
   id: string;
   user_id: string;
   role_id: string;
   is_active: boolean;
-  created_at: Date;
-  created_by: string;
 }
 
+export type UserRole = Omit<UserRoleEntity, 'id' | keyof RelationEntity>;
+export type UserRoleRequest = QueryFilters & RelationEntityFilters &
+  Omit<UserRoleEntity, 'is_active' | keyof RelationEntity> & {
+    is_active: boolean | string;
+  }
+
 export interface UserRoleCreate {
   user_id: string;
   role_id: string;
@@ -130,6 +156,8 @@ export interface UserSkillCreate {
   skill_id: string;
 }
 
+export type UserSkillRequest = QueryFilters & RelationEntityFilters & UserSkill;
+
 export interface UserSubscription {
   id: string;
   user_id: string;