@nomalism-com/types 0.33.88 → 0.34.2

package/src/modules/stock/stockMovement/interface.ts

@@ -0,0 +1,78 @@
+import * as IShared from '../../../shared/interface';
+import { StockMovement } from '../../../shared/entities';
+
+export type Entity = StockMovement;
+export const Route = 'stock_movement';
+export const UpperName = 'StockMovement';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface IFindByProviderResponse
+  extends Omit<StockMovement, 'product_id' | 'stock_to_date'> {
+  reference: string;
+}
+
+export type IFindByOwnerIdResponse = Omit<StockMovement, 'document_line_id' | 'product_id'>;
+
+export const ExportFormatEnum: {
+  csv: 'csv';
+  xml: 'xml';
+} = {
+  csv: 'csv',
+  xml: 'xml',
+};
+
+export type IExportFormat = (typeof ExportFormatEnum)[keyof typeof ExportFormatEnum];
+
+export const exportFormats = Object.keys(ExportFormatEnum);
+
+export const ExportVersionEnum: {
+  v1_02: 'v1_02';
+  v2_01: 'v2_01';
+} = {
+  v1_02: 'v1_02',
+  v2_01: 'v2_01',
+};
+
+export type IExportVersion = (typeof ExportVersionEnum)[keyof typeof ExportVersionEnum];
+
+export const exportVersions = Object.keys(ExportVersionEnum);
+
+export interface IExportRequest {
+  date: Date;
+  format: IExportFormat;
+  version: IExportVersion;
+  token: string;
+}
+
+// https://info.portaldasfinancas.gov.pt/pt/apoio_contribuinte/Comunicacao_inventarios_exist%C3%AAncias/Documents/comunicacaoinventarios.pdf
+export interface IExportCsvResponse {
+  productCategory: string;
+  productCode: string;
+  productDescription: string;
+  productNumberCode: string;
+  closingStockQuantity: number;
+  unitOfMeasure: string;
+  closingStockValue: number;
+}
+
+export interface IFindStockMovementPaginatedRequest
+  extends IShared.IFindByOwnerIdRequest,
+    IShared.IPaginationRequest {}
+
+export interface IRepository {
+  findByProvider(selector: IShared.IFindByIdNumberRequest): Promise<IFindByProviderResponse[]>;
+
+  findByOwnerId(selector: IShared.IFindByOwnerIdRequest): Promise<IFindByOwnerIdResponse[]>;
+
+  exportCsv(selector: IExportRequest): Promise<IExportCsvResponse[]>;
+
+  findStockMovementPaginated(
+    selector: IFindStockMovementPaginatedRequest,
+  ): Promise<IShared.IPaginationResponse<IFindByOwnerIdResponse>>;
+}
+
+export interface IController extends IRepository {
+  findByOwnerId(selector: IShared.IFindByOwnerIdRequest): Promise<IFindByOwnerIdResponse[]>;
+
+  exportCsv(selector: IExportRequest): Promise<IExportCsvResponse[]>;
+}

package/src/modules/stock/stockMovement/route.schema.ts

@@ -0,0 +1,34 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import {
+  IExportRequest,
+  exportVersions,
+  exportFormats,
+  IFindStockMovementPaginatedRequest,
+} from './interface';
+
+const exportCsvQueryKeys: IShared.IRouteRequest<IExportRequest> = {
+  date: joi.date().required(),
+  format: joi
+    .string()
+    .valid(...exportFormats)
+    .required(),
+  version: joi
+    .string()
+    .valid(...exportVersions)
+    .required(),
+  token: joi.string().required(),
+};
+export const exportCsvQuery = joi.object().keys(exportCsvQueryKeys).messages(messages);
+
+// find with pagination query validation
+const findWithPaginationQueryKeys: IShared.IRouteRequest<IFindStockMovementPaginatedRequest> = {
+  owner_id: joi.string().uuid().required(),
+  per_page: joi.number().integer().positive().default(10).optional(),
+  current_page: joi.number().integer().positive().default(1).optional(),
+};
+export const findStockMovementWithPaginationQuery = joi
+  .object()
+  .keys(findWithPaginationQueryKeys)
+  .messages(messages);

package/src/modules/stock/task/interface.ts

@@ -0,0 +1,117 @@
+import * as IShared from '../../../shared/interface';
+import { Task, TaskMessage, DocumentHeader, File } from '../../../shared/entities';
+
+export type Entity = Task;
+export const Route = 'task';
+export const UpperName = 'Task';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export const ITaskStatusDataTypeEnum: {
+  Normal: 'Normal';
+  Urgent: 'Urgent';
+  Problem: 'Problem';
+} = {
+  Normal: 'Normal',
+  Urgent: 'Urgent',
+  Problem: 'Problem',
+};
+
+export type ITaskStatusDataType =
+  (typeof ITaskStatusDataTypeEnum)[keyof typeof ITaskStatusDataTypeEnum];
+
+export const taskStatusDataType = Object.keys(ITaskStatusDataTypeEnum);
+
+export type ICreateRequest = {
+  task: string;
+};
+export type IUpdateRequest = {
+  from?: string;
+  to?: string | null;
+  task?: string;
+  read?: boolean;
+  finished?: boolean;
+  archived?: boolean;
+  status?: ITaskStatusDataType;
+  future_date?: Date | null;
+};
+
+export const IHistoryStatusDataTypeEnum: {
+  created_task: 'created_task';
+  updated_task: 'updated_task';
+  created_message: 'created_message';
+  updated_message: 'updated_message';
+  deleted_message: 'deleted_message';
+} = {
+  created_task: 'created_task',
+  updated_task: 'updated_task',
+  created_message: 'created_message',
+  updated_message: 'updated_message',
+  deleted_message: 'deleted_message',
+};
+
+export type IHistoryStatusDataType =
+  (typeof IHistoryStatusDataTypeEnum)[keyof typeof IHistoryStatusDataTypeEnum];
+
+export const historyStatusDataType = Object.keys(IHistoryStatusDataTypeEnum);
+
+export interface ITaskHistoryData {
+  status: IHistoryStatusDataType | null;
+  data: string;
+  changedAt: Date;
+  changedBy: string;
+}
+export interface ITaskHistoryResponse {
+  status: IHistoryStatusDataType | null;
+  data: string;
+  changedAt: Date;
+  changedBy: string;
+}
+
+export type IFindResponse = Omit<Entity, 'history'> & {
+  task_read: boolean;
+};
+
+export type ITaskFileType = Pick<
+  File,
+  'multimedia_id' | 'filename' | 'created_at' | 'created_by'
+> & {
+  id?: string;
+};
+
+export interface IFindWithMessagesResponse extends Entity {
+  messages: TaskMessage[];
+  document_headers: Pick<DocumentHeader, 'id' | 'document_number'>[];
+  task_read: boolean;
+  task_files: ITaskFileType[];
+}
+export type IFindTasksRequest = {
+  archived?: boolean;
+};
+
+export type IFindByOwnerResponse = {
+  task_id: string;
+  from: string;
+  to: string | null;
+  task: string;
+  created_at: Date;
+  task_read: boolean;
+  number: number;
+  status: ITaskStatusDataType;
+  future_date: Date | null;
+};
+
+export interface IRepository {
+  find(selector: IFindTasksRequest): Promise<IFindResponse[]>;
+
+  findWithMessages(id: IShared.IFindByIdRequest): Promise<IFindWithMessagesResponse>;
+
+  create(data: ICreateRequest): Promise<Entity>;
+
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<void>;
+
+  delete(selector: IShared.IFindByIdRequest): Promise<void>;
+
+  findByOwnerId: (selector: IShared.IFindByOwnerIdRequest) => Promise<IFindByOwnerResponse[]>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/stock/task/route.schema.ts

@@ -0,0 +1,31 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { ICreateRequest, IUpdateRequest, IFindTasksRequest, taskStatusDataType } from './interface';
+
+// create body validation
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  task: joi.string().required(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  from: joi.string().uuid().optional(),
+  to: joi.string().uuid().allow(null).optional(),
+  task: joi.string().optional(),
+  read: joi.boolean().optional(),
+  finished: joi.boolean().optional(),
+  archived: joi.boolean().optional(),
+  future_date: joi.date().allow(null, '').optional(),
+  status: joi
+    .string()
+    .valid(...taskStatusDataType)
+    .optional(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);
+
+const findTaskParamsKeys: IShared.IRouteRequest<IFindTasksRequest> = {
+  archived: joi.boolean().optional(),
+};
+export const findTaskParams = joi.object().keys(findTaskParamsKeys).messages(messages);

package/src/modules/stock/taskMessage/interface.ts

@@ -0,0 +1,18 @@
+import * as IShared from '../../../shared/interface';
+import { TaskMessage } from '../../../shared/entities';
+
+export type Entity = TaskMessage;
+export const Route = 'task_message';
+export const UpperName = 'TaskMessage';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export type ICreateRequest = Pick<Entity, 'message' | 'task_id'>;
+export type IUpdateRequest = Pick<Entity, 'message' | 'task_id'>;
+
+export interface IRepository {
+  create(data: ICreateRequest): Promise<Entity>;
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<void>;
+  delete(selector: IShared.IFindByIdRequest): Promise<void>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/stock/taskMessage/route.schema.ts

@@ -0,0 +1,19 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { ICreateRequest, IUpdateRequest } from './interface';
+
+// create body validation
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  task_id: joi.string().uuid().required(),
+  message: joi.string().required(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  task_id: joi.string().uuid().required(),
+  message: joi.string().required(),
+};
+
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);

package/src/modules/stock/taskRead/interface.ts

@@ -0,0 +1,17 @@
+import * as IShared from '../../../shared/interface';
+import { TaskRead } from '../../../shared/entities/stock';
+
+export type Entity = TaskRead;
+export const Route = 'task_read';
+export const UpperName = 'TaskRead';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export type ICreateRequest = Pick<Entity, 'user_id' | 'task_id'>;
+export type IDeleteRequest = Pick<Entity, 'user_id' | 'task_id'>;
+
+export interface IRepository {
+  create(data: ICreateRequest): Promise<void>;
+  delete(selector: IDeleteRequest): Promise<void>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/stock/taskRead/route.schema.ts

@@ -0,0 +1,18 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { ICreateRequest, IDeleteRequest } from './interface';
+
+// create body validation
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  task_id: joi.string().uuid().required(),
+  user_id: joi.string().uuid().required(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// delete params validation
+const deleteParamsKeys: IShared.IRouteRequest<IDeleteRequest> = {
+  task_id: joi.string().uuid().required(),
+  user_id: joi.string().uuid().required(),
+};
+export const deleteBody = joi.object().keys(deleteParamsKeys).messages(messages);

package/src/modules/stock/typeOfLocation/interface.ts

@@ -0,0 +1,51 @@
+import * as IShared from '../../../shared/interface';
+import { TypeOfLocation } from '../../../shared/entities';
+
+export type Entity = TypeOfLocation;
+export const Route = 'type_of_location';
+export const UpperName = 'TypeOfLocation';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+type IFindDetailedResponse = Entity;
+
+// omit any unnecessary fields
+export type IFindByIdResponse = Omit<IFindDetailedResponse, ''>;
+
+// 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
+  name: string;
+}
+
+export interface IUpdateRequest {
+  // updatable fields
+  name?: string;
+}
+
+export interface IRepository {
+  findById(selector: IShared.IFindByIdRequest): Promise<IFindByIdResponse | null>;
+
+  findByOwnerId(params: IShared.IFindByOwnerIdRequest): Promise<IFindByOwnerIdResponse[]>;
+  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/stock/typeOfLocation/route.schema.ts

@@ -0,0 +1,29 @@
+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().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/stock/unitOfMeasure/interface.ts

@@ -0,0 +1,64 @@
+import * as IShared from '../../../shared/interface';
+import { UnitOfMeasure } from '../../../shared/entities';
+
+export type Entity = UnitOfMeasure;
+
+export const UpperName = 'UnitOfMeasure';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+export const Route = 'unit_of_measure';
+
+type IFindDetailedResponse = Entity;
+
+// omit any unnecessary fields
+export type IFindByIdResponse = Omit<IFindDetailedResponse, ''>;
+
+// 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
+  name: string;
+  notation: string;
+  type: string;
+  external_id?: string | null;
+  default_quantity?: boolean;
+  integer_only?: boolean;
+  divisible?: boolean;
+}
+
+export interface IUpdateRequest {
+  // updatable fields
+  name?: string;
+  notation?: string;
+  type?: string;
+  external_id?: string | null;
+  default_quantity?: boolean;
+  integer_only?: boolean;
+  divisible?: boolean;
+}
+
+export interface IRepository {
+  findById(selector: IShared.IFindByIdRequest): Promise<IFindByIdResponse | null>;
+
+  findByOwnerId(params: IShared.IFindByOwnerIdRequest): Promise<IFindByOwnerIdResponse[]>;
+  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/stock/unitOfMeasure/route.schema.ts

@@ -0,0 +1,41 @@
+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(),
+  notation: joi.string().required(),
+  type: joi.string().valid('length', 'area', 'mass', 'volume').required(),
+  external_id: joi.string().allow(null).optional(),
+  default_quantity: joi.boolean().optional(),
+  divisible: joi.boolean().optional(),
+  integer_only: joi.boolean().optional(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  name: joi.string().optional(),
+  notation: joi.string().optional(),
+  type: joi.string().valid('length', 'area', 'mass', 'volume').optional(),
+  external_id: joi.string().allow(null).optional(),
+  default_quantity: joi.boolean().optional(),
+  divisible: joi.boolean().optional(),
+  integer_only: joi.boolean().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/stock/vatTax/interface.ts

@@ -0,0 +1,53 @@
+import * as IShared from '../../../shared/interface';
+import { VatTax } from '../../../shared/entities';
+
+export type Entity = VatTax;
+export const Route = 'vat_tax';
+export const UpperName = 'VatTax';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+type IFindDetailedResponse = Entity;
+
+// omit any unnecessary fields
+export type IFindByIdResponse = Omit<IFindDetailedResponse, ''>;
+
+// 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
+  name: string;
+  external_id?: string | null;
+}
+
+export interface IUpdateRequest {
+  // updatable fields
+  name?: string;
+  external_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[]>;
+  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/stock/vatTax/route.schema.ts

@@ -0,0 +1,31 @@
+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(),
+  external_id: joi.string().allow(null).optional(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  name: joi.string().optional(),
+  external_id: joi.string().allow(null).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/stock/vatTaxZone/interface.ts

@@ -0,0 +1,61 @@
+import * as IShared from '../../../shared/interface';
+import { VatTaxZone, VatTax } from '../../../shared/entities';
+
+export type Entity = VatTaxZone;
+export const Route = 'vat_tax_zone';
+export const UpperName = 'VatTaxZone';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+interface IFindDetailedResponse extends Entity {
+  vat_tax: VatTax;
+}
+
+// omit any unnecessary fields
+export type IFindByIdResponse = Omit<IFindDetailedResponse, 'vat_tax'>;
+
+// omit any unnecessary fields
+export type IFindByOwnerIdResponse = Omit<IFindDetailedResponse, 'vat_tax'>;
+
+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, 'vat_tax'>
+>;
+
+export interface ICreateRequest {
+  // create fields
+  name: string;
+  value: number;
+  vat_tax_id: string;
+  country_id: string;
+  external_id: string | null;
+}
+
+export interface IUpdateRequest {
+  // updatable fields
+  name?: string;
+  value?: number;
+  vat_tax_id?: string;
+  country_id?: string;
+  external_id?: string | null;
+}
+
+export interface IRepository {
+  findById(selector: IShared.IFindByIdRequest): Promise<IFindByIdResponse | null>;
+
+  findByOwnerId(params: IShared.IFindByOwnerIdRequest): Promise<IFindByOwnerIdResponse[]>;
+  findMinified(selector: IShared.IFindMinifiedRequest): Promise<IShared.IFindMinifiedResponse[]>;
+  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>;