@mitreka/coreflow-types 0.0.18 → 0.0.19

package/README.md

@@ -1,3 +1,76 @@
 # CoreFlow Types Definition
+All entities must extend either `BaseEntity` or `RelationEntity`. For example we assume `User` interface is `BaseEntity` and `UserRole` interface is `RelationEntity`.
 
-All required type definition files
+`entity.ts`
+```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:
+
+```sql
+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:
+```ts
+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 & User;
+```
+
+## Relation Entity
+
+If you have relation schema like this:
+
+```sql
+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:
+```ts
+export interface UserRoleEntity extends RelationEntity {
+  id: string;
+  user_id: string;
+  role_id: string;
+}
+
+export type User = Omit<UserEntity, 'id' | keyof BaseEntity>;
+export type UserRequest = QueryFilters & BaseEntityFilters & User;
+```

package/auth.ts

@@ -26,7 +26,10 @@ export type AuthGrantType = 'authorization_code' | 'refresh_token';
 export type AuthPrompt = 'none' | 'select_account';
 export type AuthResponseType = 'code' | 'token';
 
-export type AuthorizationParam = {
+/**
+ * Authorization params.
+ */
+export type AuthorizationParams = {
   client_id: string;
   client_secret: string;
   code: string;
@@ -46,22 +49,22 @@ export type AuthorizationParam = {
   user_id: string;
 };
 
-export type AuthorizationCallback = Pick<AuthorizationParam, 'code' | 'error' | 'state'>;
+export type AuthorizationCallback = Pick<AuthorizationParams, 'code' | 'error' | 'state'>;
 
 /**
  * Authorization exchange
  */
-export type AuthorizationExchange = Pick<AuthorizationParam, 'client_id' | 'client_secret' | 'code' | 'code_verifier' | 'grant_type' | 'redirect_uri' | 'token_version'>;
+export type AuthorizationExchange = Pick<AuthorizationParams, 'client_id' | 'client_secret' | 'code' | 'code_verifier' | 'grant_type' | 'redirect_uri' | 'token_version'>;
 
 /**
  * Authorization refresh
  */
-export type AuthorizationRefresh = Pick<AuthorizationParam, 'client_id' | 'client_secret' | 'company_id' | 'grant_type' | 'refresh_token'>;
+export type AuthorizationRefresh = Pick<AuthorizationParams, 'client_id' | 'client_secret' | 'company_id' | 'grant_type' | 'refresh_token'>;
 
 /**
  * Authorization request
  */
-export type AuthorizationRequest = Omit<AuthorizationParam, 'client_secret' | 'code' | 'code_verifier' | 'company_id' | 'error' | 'grant_type' | 'refresh_token'>;
+export type AuthorizationRequest = Omit<AuthorizationParams, 'client_secret' | 'code' | 'code_verifier' | 'company_id' | 'error' | 'grant_type' | 'refresh_token'>;
 
 /**
  * Authorize client

package/company.ts

@@ -1,6 +1,6 @@
 import type { Point } from './common.js'
-import type { BaseEntity } from './entity.js'
-import type { BaseEntityFilters, QueryFilters } from './filter.js';
+import type { BaseEntity, RelationEntity } from './entity.js'
+import type { BaseEntityFilters, QueryFilters, RelationEntityFilters } from './filter.js';
 
 export interface CityEntity extends BaseEntity {
   id: string;
@@ -68,6 +68,19 @@ export type CompanyRequest = QueryFilters & BaseEntityFilters & {
   website: string;
 };
 
+export interface CompanyPlanEntity extends RelationEntity {
+  id: string;
+  company_id: string;
+  plan_id: string;
+  price: number;
+  start_date: Date;
+  end_date: Date;
+  is_active: boolean;
+};
+export type CompanyPlan = Omit<CompanyPlanEntity, 'id' | keyof RelationEntity>;
+export type CompanyPlanRequest = QueryFilters & RelationEntityFilters & CompanyPlan;
+
+
 export interface CountryEntity extends BaseEntity {
   id: string;
   country_code: string;

package/find.ts

@@ -1,6 +1,3 @@
-import type { Company } from './company.js';
-import type { Role, User } from './user.js';
-
 export type EntityRelations = {
   company: ['user', 'project'];
   user: ['company', 'project', 'role'];

package/index.ts

@@ -8,8 +8,6 @@ export * from './entity.js';
 export * from './error.js';
 export * from './find.js';
 export * from './filter.js';
-export * from './hr.js';
-export * from './storage.js';
-export * from './subscription.js';
+export * from './plan.js';
 export * from './task.js';
 export * from './user.js';

package/package.json

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

package/plan.ts

@@ -0,0 +1,29 @@
+import type { BaseEntity, RelationEntity } from './entity.js';
+import { type BaseEntityFilters, type QueryFilters, type RelationEntityFilters } from './filter.js';
+
+export enum PeriodType {
+  MONTH = 'month',
+  YEAR = 'year'
+};
+
+export interface PlanEntity extends BaseEntity {
+  id: string;
+  name: string;
+  description: string;
+  price: number;
+  promo_price: number;
+  period_duration: number;
+  period_type: PeriodType;
+};
+// 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
+export type Plan = Omit<PlanEntity, 'id' | keyof BaseEntity>;
+export type PlanRequest = QueryFilters & BaseEntityFilters & Plan;
+
+export interface PlanPermissionEntity extends RelationEntity {
+  id: string;
+  plan_id: string;
+  permission_id: string;
+};
+
+export type PlanPermission = Omit<PlanPermissionEntity, 'id' | keyof RelationEntity>;
+export type PlanPermissionRequest = QueryFilters & RelationEntityFilters & PlanPermission;

package/user.ts

@@ -6,15 +6,11 @@ export interface PermissionEntity extends BaseEntity {
   name: string;
   module: string;
   description?: string;
-}
+};
 
 export type Permission = Omit<PermissionEntity, 'id' | keyof BaseEntity>;
-export type PermissionRequest = QueryFilters & BaseEntityFilters & {
-  id: string;
-  name: string;
-  module: string;
-  description: string;
-};
+export type PermissionRequest = QueryFilters & BaseEntityFilters &
+  Omit<PermissionEntity, keyof BaseEntity>;
 
 export interface RoleEntity extends BaseEntity {
   id: string;
@@ -22,22 +18,17 @@ export interface RoleEntity extends BaseEntity {
   name: string;
   is_active: boolean;
   is_owner: boolean;
-}
+};
 
 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 type RoleRequest = QueryFilters & BaseEntityFilters &
+  Omit<RoleEntity, keyof BaseEntity>;
 
 export interface RolePermissionEntity extends RelationEntity {
   id: string;
   role_id: string;
   permission_id: string;
-}
+};
 
 export type RolePermission = Omit<RolePermissionEntity, 'id' | keyof BaseEntity>;
 export type RolePermissionRequest = QueryFilters & RolePermissionEntity;
@@ -47,7 +38,7 @@ export interface SkillEntity extends BaseEntity {
   company_id: string;
   parent_id: string;
   name: string;
-}
+};
 
 export type Skill = Omit<SkillEntity, 'id' | keyof BaseEntity>;
 export type SkillRequest = QueryFilters & SkillEntity;
@@ -67,23 +58,11 @@ export interface UserEntity extends BaseEntity {
   birth_place?: string;
   country?: string;
   meta?: UserMeta;
-}
+};
 
 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 type UserRequest = QueryFilters & BaseEntityFilters &
+  Omit<User, 'password' | 'meta' | keyof BaseEntity>;
 
 export interface UserCompanyEntity extends RelationEntity {
   id: string;
@@ -92,7 +71,7 @@ export interface UserCompanyEntity extends RelationEntity {
   is_admin: boolean;
   is_primary: boolean;
   load?: UserLoad;
-}
+};
 
 export type UserCompany = Omit<UserCompanyEntity, 'id' | keyof RelationEntity>;
 export type UserCompanyRequest = QueryFilters & RelationEntityFilters & {
@@ -106,7 +85,7 @@ export type UserCompanyRequest = QueryFilters & RelationEntityFilters & {
 export enum UserGender {
   FEMALE = "F",
   MALE = "M"
-}
+};
 
 export type UserLoad = {
   status: UserLoadStatus;
@@ -118,7 +97,7 @@ export enum UserLoadStatus {
   HIGH = "HIGH",
   MEDIUM = "MEDIUM",
   LOW = "LOW"
-}
+};
 
 export type UserMeta = {
   token: string;
@@ -128,7 +107,7 @@ export interface UserRoleEntity extends RelationEntity {
   id: string;
   user_id: string;
   role_id: string;
-}
+};
 
 export type UserRole = Omit<UserRoleEntity, 'id' | keyof RelationEntity>;
 export type UserRoleRequest = QueryFilters & RelationEntityFilters &
@@ -138,7 +117,7 @@ export interface UserRoleCreate {
   user_id: string;
   role_id: string;
   is_active: boolean;
-}
+};
 
 export interface UserSkill {
   id: string;
@@ -146,26 +125,11 @@ export interface UserSkill {
   skill_id: string;
   created_at: Date;
   created_by: string;
-}
+};
 
 export interface UserSkillCreate {
   user_id: string;
   skill_id: string;
-}
-
-export type UserSkillRequest = QueryFilters & RelationEntityFilters & UserSkill;
-
-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;
-}
+export type UserSkillRequest = QueryFilters & RelationEntityFilters & UserSkill;

package/hr.ts

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

package/storage.ts

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

package/subscription.ts

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