@nomalism-com/types 0.33.88 → 0.34.2

package/src/modules/user/persona/route.schema.ts

@@ -0,0 +1,94 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import {
+  IBasicSearchRequest,
+  ICreateRequest,
+  IDeletePersonaRequest,
+  IFindByEmailRequest,
+  IFindRequest,
+  IUpdateRequest,
+} from './interface';
+
+// create body validation
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  name: joi.string().allow(null, '').optional(),
+  nif: joi.string().allow(null, '').optional(),
+  street: joi.string().allow(null, '').optional(),
+  locality: joi.string().allow(null, '').optional(),
+  postal_code: joi.string().trim(true).lowercase().allow(null, '').optional(),
+  country_id: joi.string().uuid().allow(null, '').optional(),
+  telephone: joi.string().allow(null, '').optional(),
+  email: joi
+    .string()
+    .email({ tlds: { allow: false } })
+    .allow(null, '')
+    .optional(),
+  observations: joi.string().allow(null, '').optional(),
+  provider_id: joi.string().uuid().allow(null, ''),
+  client_id: joi.string().uuid().allow(null, ''),
+  commissioner_id: joi.string().uuid().allow(null, ''),
+  store_operator_id: joi.string().uuid().allow(null, ''),
+  reason_for_exemption_id: joi.string().uuid().allow(null, '').optional(),
+  main: joi.boolean().default(false).optional(),
+  contact: joi.boolean().default(false).optional(),
+};
+
+export const createBody = joi
+  .object()
+  .keys(createBodyKeys)
+  .xor('provider_id', 'client_id', 'commissioner_id')
+  .messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  name: joi.string().allow(null, '').optional(),
+  nif: joi.string().allow(null, '').optional(),
+  street: joi.string().allow(null, '').optional(),
+  locality: joi.string().allow(null, '').optional(),
+  postal_code: joi.string().trim(true).lowercase().allow(null, '').optional(),
+  country_id: joi.string().uuid().allow(null, '').optional(),
+  telephone: joi.string().allow(null, '').optional(),
+  email: joi
+    .string()
+    .email({ tlds: { allow: false } })
+    .allow(null, '')
+    .optional(),
+  observations: joi.string().allow(null, '').optional(),
+  reason_for_exemption_id: joi.string().uuid().allow(null, '').optional(),
+  main: joi.boolean().optional(),
+  contact: joi.boolean().optional(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);
+
+const findQueryKeys: IShared.IRouteRequest<IFindRequest> = {
+  search_value: joi.string().allow('', null).optional(),
+};
+export const findQuery = joi.object().keys(findQueryKeys).messages(messages);
+
+const getBasicSearchQueryKeys: IShared.IRouteRequest<IBasicSearchRequest> = {
+  per_page: joi.number().integer().positive().default(10).optional(),
+  current_page: joi.number().integer().positive().default(1).optional(),
+  inactive: joi.boolean().default(false).optional(),
+  search_value: joi.string().allow('', null).optional(),
+  types: joi.string().allow('', null).optional(),
+};
+export const getBasicSearchParamsValidate = joi
+  .object()
+  .keys(getBasicSearchQueryKeys)
+  .messages(messages);
+
+const deleteQueryKeys: IShared.IRouteRequest<IDeletePersonaRequest> = {
+  id: joi.string().uuid().required(),
+  new_main_persona_id: joi.string().uuid().optional(),
+};
+export const deleteQueryValidate = joi.object().keys(deleteQueryKeys).messages(messages);
+
+const findByEmailQueryKeys: IShared.IRouteRequest<IFindByEmailRequest> = {
+  email: joi
+    .string()
+    .trim(true)
+    .lowercase()
+    .email({ tlds: { allow: false } }),
+};
+export const FindByEmailQueryValidate = joi.object().keys(findByEmailQueryKeys).messages(messages);

package/src/modules/user/providerType/interface.ts

@@ -0,0 +1,47 @@
+import * as IShared from '../../../shared/interface';
+import { ProviderType } from '../../../shared/entities';
+
+export type Entity = ProviderType;
+export const Route = 'provider_type';
+export const UpperName = 'ProviderType';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+type IFindDetailedResponse = Entity;
+
+// omit any unnecessary fields
+export type IFindByIdResponse = Omit<IFindDetailedResponse, ''>;
+
+export type IFindRequest = Record<string, unknown>;
+
+// omit any unnecessary fields
+export type IFindResponse = Omit<IFindDetailedResponse, ''>;
+
+export interface IFindPaginatedRequest extends IFindRequest, IShared.IPaginationRequest {}
+
+export type IFindWithPaginationResponse = IShared.IPaginationResponse<
+  Omit<IFindDetailedResponse, ''>
+>;
+
+export interface ICreateRequest {
+  // create fields
+  name: string;
+}
+
+export interface IUpdateRequest {
+  // updatable fields
+  name?: string;
+}
+
+export interface IRepository {
+  findById(selector: IShared.IFindByIdRequest): Promise<IFindByIdResponse | null>;
+
+  findMinified(params?: IShared.IFindMinifiedRequest): Promise<IShared.IFindMinifiedResponse[]>;
+  find(selector: IFindRequest): Promise<IFindResponse[]>;
+  findPaginated(selector: IFindPaginatedRequest): Promise<IFindWithPaginationResponse>;
+
+  create(data: ICreateRequest): Promise<Entity>;
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<Entity | null>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<Entity | null>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/user/providerType/route.schema.ts

@@ -0,0 +1,28 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { IFindRequest, IFindPaginatedRequest, ICreateRequest, IUpdateRequest } from './interface';
+
+// create body validation
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  name: joi.string().required(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  name: joi.string().required(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);
+const findQueryKeys: IShared.IRouteRequest<IFindRequest> = {};
+export const findQuery = joi.object().keys(findQueryKeys).messages(messages);
+
+// find with pagination query validation
+const findWithPaginationQueryKeys: IShared.IRouteRequest<IFindPaginatedRequest> = {
+  per_page: joi.number().integer().positive().default(10).optional(),
+  current_page: joi.number().integer().positive().default(1).optional(),
+};
+export const findWithPaginationQuery = joi
+  .object()
+  .keys(findWithPaginationQueryKeys)
+  .messages(messages);

package/src/modules/user/providers/interface.ts

@@ -0,0 +1,130 @@
+import * as IShared from '../../../shared/interface';
+import {
+  Providers,
+  Users,
+  Country,
+  ReasonForExemption,
+  Language,
+  ProviderType,
+  PaymentMethods,
+  MaturityDates,
+  DeliveryMethods,
+  Vehicles,
+  Persona,
+} from '../../../shared/entities';
+import type { IChatType } from '../../stock/chat/interfaces';
+
+export type Entity = Providers;
+export const Route = 'provider';
+export const UpperName = 'Providers';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+interface IMainPersona extends Persona {
+  country: Country | null;
+  reason_for_exemption: ReasonForExemption | null;
+}
+
+interface IFindDetailedResponse extends Entity {
+  user: Users;
+  main_persona: IMainPersona;
+  country: Country | null;
+  language: Language | null;
+  support_language: Language | null;
+  provider_type: ProviderType | null;
+  default_payment_method: PaymentMethods | null;
+  default_maturity_date: MaturityDates | null;
+  default_delivery_method: DeliveryMethods | null;
+  default_vehicle: Vehicles | null;
+}
+
+// omit any unnecessary fields
+export type IFindByIdResponse = Omit<IFindDetailedResponse, ''>;
+
+// omit any unnecessary fields
+export type IFindByOwnerIdResponse = Omit<
+  IFindDetailedResponse,
+  | 'user'
+  | 'main_persona'
+  | 'country'
+  | 'language'
+  | 'support_language'
+  | 'provider_type'
+  | 'default_payment_method'
+  | 'default_maturity_date'
+  | 'default_delivery_method'
+  | 'default_vehicle'
+>;
+
+export interface IFindByQueryRequest {
+  number?: number[];
+  id?: string[];
+}
+
+export interface IFindRequest {}
+
+// omit any unnecessary fields
+export type IFindResponse = Omit<IFindDetailedResponse, ''>;
+
+export type IFindPaginatedRequest = IShared.IPaginationRequest;
+
+export type IFindWithPaginationResponse = IShared.IPaginationResponse<
+  Omit<IFindDetailedResponse, ''>
+>;
+
+export type ICreateMainPersona = Pick<Persona, 'nif' | 'name' | 'email' | 'telephone'>;
+
+export interface ICreateRequest {
+  user_id?: string;
+  manufacturer?: boolean;
+  inactive?: boolean;
+
+  default_discount?: number;
+  exemption_reason_id?: string | null;
+
+  main_persona: ICreateMainPersona;
+  provider_type_id?: string | null;
+  country_id?: string | null;
+  language_id?: string | null;
+  support_language_id?: string | null;
+  default_payment_method_id?: string | null;
+  default_maturity_date_id?: string | null;
+  default_delivery_method_id?: string | null;
+  default_vehicle_id?: string | null;
+  personas?: ICreateMainPersona[];
+}
+
+export interface IUpdateRequest {
+  chat_type?: IChatType;
+  manufacturer?: boolean;
+  inactive?: boolean;
+  default_discount?: number;
+  main_persona_id?: string;
+  contact_persona_id?: string;
+  country_id?: string;
+  language_id?: string;
+  support_language_id?: string | null;
+  provider_type_id?: string;
+  default_payment_method_id?: string;
+  default_maturity_date_id?: string;
+  default_delivery_method_id?: string;
+  default_vehicle_id?: string | null;
+}
+
+export interface IRepository {
+  findById(selector: IShared.IFindByIdRequest): Promise<IFindByIdResponse | null>;
+
+  findByOwnerId(params: IShared.IFindByOwnerIdRequest): Promise<IFindByOwnerIdResponse[]>;
+  findMinified(params?: IShared.IFindMinifiedRequest): Promise<IShared.IFindMinifiedResponse[]>;
+  findMinifiedManufacturer(
+    params?: IShared.IFindMinifiedRequest,
+  ): Promise<IShared.IFindMinifiedResponse[]>;
+  findByQuery(params: IFindByQueryRequest): Promise<IFindResponse[]>;
+  find(selector: IFindRequest): Promise<IFindResponse[]>;
+  findPaginated(selector: IFindPaginatedRequest): Promise<IFindWithPaginationResponse>;
+
+  create(data: ICreateRequest): Promise<IFindResponse>;
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<IFindResponse | null>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<IFindResponse | null>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/user/providers/route.schema.ts

@@ -0,0 +1,85 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import {
+  IFindRequest,
+  IFindPaginatedRequest,
+  ICreateRequest,
+  IUpdateRequest,
+  ICreateMainPersona,
+} from './interface';
+import { chatTypes } from '../../stock/chat/interfaces';
+
+const createMainPersonaKeys: IShared.IRouteRequest<ICreateMainPersona> = {
+  name: joi.string().optional(),
+  nif: joi.string().allow(null).optional(),
+  email: joi
+    .string()
+    .email({ tlds: { allow: false } })
+    .allow(null)
+    .optional(),
+  telephone: joi.string().allow(null).optional(),
+};
+
+// create body validation
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  user_id: joi.string().uuid().optional(),
+  manufacturer: joi.boolean().default(false).optional(),
+  inactive: joi.boolean().default(false).optional(),
+
+  default_discount: joi.number().positive().allow(0).default(0).max(100).optional(),
+  exemption_reason_id: joi.string().uuid().allow(null).optional(),
+
+  main_persona: joi.object().keys(createMainPersonaKeys).required(),
+  provider_type_id: joi.string().uuid().allow(null).optional(),
+  country_id: joi.string().uuid().allow(null).optional(),
+  language_id: joi.string().uuid().allow(null).optional(),
+  support_language_id: joi.string().uuid().allow(null).optional(),
+  default_payment_method_id: joi.string().uuid().allow(null).optional(),
+  default_maturity_date_id: joi.string().uuid().allow(null).optional(),
+  default_delivery_method_id: joi.string().uuid().allow(null).optional(),
+  default_vehicle_id: joi.string().uuid().allow(null).optional(),
+  personas: joi.array().items(joi.object().keys(createMainPersonaKeys)).optional(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  chat_type: joi
+    .string()
+    .valid(...chatTypes)
+    .optional(),
+  manufacturer: joi.boolean().optional(),
+  inactive: joi.boolean().optional(),
+
+  default_discount: joi.number().positive().allow(0).max(100).optional(),
+
+  provider_type_id: joi.string().uuid().allow(null).optional(),
+  country_id: joi.string().uuid().allow(null).optional(),
+  language_id: joi.string().uuid().allow(null).optional(),
+  support_language_id: joi.string().uuid().allow(null).optional(),
+  main_persona_id: joi.string().uuid().optional(),
+  contact_persona_id: joi.string().uuid().optional(),
+  default_payment_method_id: joi.string().uuid().allow(null).optional(),
+  default_maturity_date_id: joi.string().uuid().allow(null).optional(),
+  default_delivery_method_id: joi.string().uuid().allow(null).optional(),
+  default_vehicle_id: joi.string().uuid().allow(null).optional(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);
+
+// find query validation
+const findQueryKeys: IShared.IRouteRequest<IFindRequest> = {
+  number: joi.array().items(joi.number().positive().allow(0).required()).optional(),
+  id: joi.array().items(joi.string().uuid().required()).optional(),
+};
+export const findQuery = joi.object().keys(findQueryKeys).messages(messages);
+
+// find with pagination query validation
+const findWithPaginationQueryKeys: IShared.IRouteRequest<IFindPaginatedRequest> = {
+  per_page: joi.number().integer().positive().default(10).optional(),
+  current_page: joi.number().integer().positive().default(1).optional(),
+};
+export const findWithPaginationQuery = joi
+  .object()
+  .keys(findWithPaginationQueryKeys)
+  .messages(messages);

package/src/modules/user/purchaseConditions/interface.ts

@@ -0,0 +1,58 @@
+import * as IShared from '../../../shared/interface';
+import { PurchaseConditions } from '../../../shared/entities';
+
+export type Entity = PurchaseConditions;
+export const Route = 'purchase_conditions';
+export const UpperName = 'PurchaseConditions';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+interface IFindDetailedResponse extends Entity {}
+
+// omit any unnecessary fields
+export type IFindByIdResponse = Omit<IFindDetailedResponse, 'product_category'>;
+
+// omit any unnecessary fields
+export type IFindByOwnerIdResponse = Omit<IFindDetailedResponse, ''>;
+
+export type IFindRequest = Record<string, unknown>;
+
+// omit any unnecessary fields
+export type IFindResponse = Omit<IFindDetailedResponse, ''>;
+
+export interface IFindPaginatedRequest extends IFindRequest, IShared.IPaginationRequest {}
+
+export type IFindWithPaginationResponse = IShared.IPaginationResponse<
+  Omit<IFindDetailedResponse, ''>
+>;
+
+export interface ICreateRequest {
+  // create fields
+  provider_id: string;
+  discount: string;
+  deadline: string;
+  minimum_quantity: string;
+}
+
+export interface IUpdateRequest {
+  // updatable fields
+  discount?: string;
+  deadline?: string;
+  minimum_quantity?: string;
+}
+
+export interface IRepository {
+  findById(selector: IShared.IFindByIdRequest): Promise<IFindByIdResponse | null>;
+
+  findByOwnerId(params: IShared.IFindByOwnerIdRequest): Promise<IFindByOwnerIdResponse[]>;
+  find(selector: IFindRequest): Promise<IFindResponse[]>;
+  findPaginated(selector: IFindPaginatedRequest): Promise<IFindWithPaginationResponse>;
+
+  create(data: ICreateRequest): Promise<Entity>;
+  update(
+    selector: IShared.IFindByIdRequest,
+    data: IUpdateRequest,
+  ): Promise<IFindByOwnerIdResponse | null>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<IFindByOwnerIdResponse | null>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/user/purchaseConditions/route.schema.ts

@@ -0,0 +1,33 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { IFindRequest, IFindPaginatedRequest, ICreateRequest, IUpdateRequest } from './interface';
+
+// create body validation
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  provider_id: joi.string().uuid().required(),
+  deadline: joi.string().required(),
+  discount: joi.string().required(),
+  minimum_quantity: joi.string().required(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  deadline: joi.string().optional(),
+  discount: joi.string().optional(),
+  minimum_quantity: joi.string().optional(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);
+const findQueryKeys: IShared.IRouteRequest<IFindRequest> = {};
+export const findQuery = joi.object().keys(findQueryKeys).messages(messages);
+
+// find with pagination query validation
+const findWithPaginationQueryKeys: IShared.IRouteRequest<IFindPaginatedRequest> = {
+  per_page: joi.number().integer().positive().default(10).optional(),
+  current_page: joi.number().integer().positive().default(1).optional(),
+};
+export const findWithPaginationQuery = joi
+  .object()
+  .keys(findWithPaginationQueryKeys)
+  .messages(messages);

package/src/modules/user/reasonForExemption/interface.ts

@@ -0,0 +1,53 @@
+import * as IShared from '../../../shared/interface';
+import { ReasonForExemption } from '../../../shared/entities';
+
+export type Entity = ReasonForExemption;
+export const Route = 'reason_for_exemption';
+export const UpperName = 'ReasonForExemption';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+type IFindDetailedResponse = Entity;
+
+// omit any unnecessary fields
+export type IFindByIdResponse = Omit<IFindDetailedResponse, ''>;
+
+export type IFindRequest = Record<string, unknown>;
+
+// omit any unnecessary fields
+export type IFindResponse = Omit<IFindDetailedResponse, ''>;
+
+export interface IFindPaginatedRequest extends IFindRequest, IShared.IPaginationRequest {}
+
+export type IFindWithPaginationResponse = IShared.IPaginationResponse<
+  Omit<IFindDetailedResponse, ''>
+>;
+
+export interface ICreateRequest {
+  // create fields
+  name: string;
+  description: string;
+  saft_code: string;
+  external_id: string;
+}
+
+export interface IUpdateRequest {
+  // updatable fields
+  name?: string;
+  description?: string;
+  saft_code?: string;
+  external_id?: string;
+}
+
+export interface IRepository {
+  findById(selector: IShared.IFindByIdRequest): Promise<IFindByIdResponse | null>;
+
+  findMinified(params?: IShared.IFindMinifiedRequest): Promise<IShared.IFindMinifiedResponse[]>;
+  find(selector: IFindRequest): Promise<IFindResponse[]>;
+  findPaginated(selector: IFindPaginatedRequest): Promise<IFindWithPaginationResponse>;
+
+  create(data: ICreateRequest): Promise<Entity>;
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<Entity | null>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<Entity | null>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/user/reasonForExemption/route.schema.ts

@@ -0,0 +1,34 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { IFindRequest, IFindPaginatedRequest, ICreateRequest, IUpdateRequest } from './interface';
+
+// create body validation
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  name: joi.string().required(),
+  description: joi.string().required(),
+  saft_code: joi.string().required(),
+  external_id: joi.string().required(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  name: joi.string().optional(),
+  description: joi.string().optional(),
+  saft_code: joi.string().optional(),
+  external_id: joi.string().optional(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);
+const findQueryKeys: IShared.IRouteRequest<IFindRequest> = {};
+export const findQuery = joi.object().keys(findQueryKeys).messages(messages);
+
+// find with pagination query validation
+const findWithPaginationQueryKeys: IShared.IRouteRequest<IFindPaginatedRequest> = {
+  per_page: joi.number().integer().positive().default(10).optional(),
+  current_page: joi.number().integer().positive().default(1).optional(),
+};
+export const findWithPaginationQuery = joi
+  .object()
+  .keys(findWithPaginationQueryKeys)
+  .messages(messages);

package/src/modules/user/refreshToken/interface.ts

@@ -0,0 +1,19 @@
+import * as IShared from '../../../shared/interface';
+
+export interface ICreateRequest {
+  token: string;
+  ip?: string;
+}
+
+export interface ICreateResponse {
+  access_token: string;
+  refresh_token: string;
+  expiresInToken: number;
+  expiresInRefreshToken: number;
+}
+
+export interface IRepository {
+  create(data: ICreateRequest): Promise<ICreateResponse>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/user/refreshToken/route.schema.ts

@@ -0,0 +1,10 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { ICreateRequest } from './interface';
+
+const refreshTokenBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  token: joi.string(),
+  ip: joi.string(),
+};
+export const refreshTokenBody = joi.object().keys(refreshTokenBodyKeys).messages(messages);

package/src/modules/user/segmentsArea/interface.ts

@@ -0,0 +1,49 @@
+import * as IShared from '../../../shared/interface';
+import { SegmentsArea } from '../../../shared/entities';
+
+export type Entity = SegmentsArea;
+export const Route = 'segments_area';
+export const UpperName = 'SegmentsArea';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+type IFindDetailedResponse = Entity;
+
+// omit any unnecessary fields
+export type IFindByIdResponse = Omit<IFindDetailedResponse, ''>;
+
+export type IFindRequest = Record<string, unknown>;
+
+// omit any unnecessary fields
+export type IFindResponse = Omit<IFindDetailedResponse, ''>;
+
+export interface IFindPaginatedRequest extends IFindRequest, IShared.IPaginationRequest {}
+
+export type IFindWithPaginationResponse = IShared.IPaginationResponse<
+  Omit<IFindDetailedResponse, ''>
+>;
+
+export interface ICreateRequest {
+  // create fields
+  type: string;
+  name: string;
+}
+
+export interface IUpdateRequest {
+  // updatable fields
+  type?: string;
+  name?: string;
+}
+
+export interface IRepository {
+  findById(selector: IShared.IFindByIdRequest): Promise<IFindByIdResponse | null>;
+
+  findMinified(params?: IShared.IFindMinifiedRequest): Promise<IShared.IFindMinifiedResponse[]>;
+  find(selector: IFindRequest): Promise<IFindResponse[]>;
+  findPaginated(selector: IFindPaginatedRequest): Promise<IFindWithPaginationResponse>;
+
+  create(data: ICreateRequest): Promise<Entity>;
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<Entity | null>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<Entity | null>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/user/segmentsArea/route.schema.ts

@@ -0,0 +1,30 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { IFindRequest, IFindPaginatedRequest, ICreateRequest, IUpdateRequest } from './interface';
+
+// create body validation
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  name: joi.string().required(),
+  type: joi.string().required(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  name: joi.string().required(),
+  type: joi.string().required(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);
+const findQueryKeys: IShared.IRouteRequest<IFindRequest> = {};
+export const findQuery = joi.object().keys(findQueryKeys).messages(messages);
+
+// find with pagination query validation
+const findWithPaginationQueryKeys: IShared.IRouteRequest<IFindPaginatedRequest> = {
+  per_page: joi.number().integer().positive().default(10).optional(),
+  current_page: joi.number().integer().positive().default(1).optional(),
+};
+export const findWithPaginationQuery = joi
+  .object()
+  .keys(findWithPaginationQueryKeys)
+  .messages(messages);