@nomalism-com/types 0.36.32 → 0.37.2

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

@@ -1,31 +0,0 @@
-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

@@ -1,61 +0,0 @@
-import * as IShared from '../../../shared/interface';
-import { VatTaxZone, VatTax } from '../../../shared/entities/stock';
-
-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>;

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

@@ -1,40 +0,0 @@
-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(),
-  value: joi.number().positive().required(),
-  vat_tax_id: joi.string().uuid().required(),
-  country_id: joi.string().uuid().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(),
-  value: joi.number().positive().optional(),
-  vat_tax_id: joi.string().uuid().optional(),
-  country_id: joi.string().uuid().optional(),
-  external_id: joi.string().optional(),
-};
-export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);
-
-const findQueryKeys: IShared.IRouteRequest<IFindRequest> = {
-  country_id: joi.string().uuid().optional(),
-  vat_tax_id: joi.string().uuid().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/stock/vatValidation/interfaces.ts

@@ -1,10 +0,0 @@
-import { VatValidation } from '../../../shared/entities/stock';
-
-export type Entity = VatValidation;
-export const Route = 'vat_validation';
-export const UpperName = 'VatValidation';
-export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
-
-export interface IRepository {
-  findByLatest(nif: string): Promise<Entity | null>;
-}

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

@@ -1,8 +0,0 @@
-import joi from 'joi';
-import { messages } from '../../../shared/messages';
-
-const findByLatestBodyKeys = {
-  nif: joi.string().required(),
-};
-
-export const findByLatestBody = joi.object().keys(findByLatestBodyKeys).messages(messages);

package/src/modules/stock/workflow/interfaces.ts

@@ -1,64 +0,0 @@
-import * as IShared from '../../../shared/interface';
-import { Workflow } from '../../../shared/entities/stock';
-import * as DocumentType from '../../supply/documentType/interfaces';
-import { IDocumentTypeUserType } from '../../supply/documentType/interfaces';
-
-export type Entity = Workflow;
-export const Route = 'workflow';
-export const UpperName = 'Workflow';
-export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
-
-export type IFindRequest = Record<string, unknown>;
-
-export interface ICreateRequest {
-  from_document_type_id: number;
-  to_document_type_id: number;
-
-  transition_name: string;
-
-  is_active: boolean;
-}
-
-export interface IUpdateRequest {
-  from_document_type_id?: number;
-  to_document_type_id?: number;
-
-  transition_name?: string;
-
-  is_active?: boolean;
-}
-
-export interface IFindByQueryRequest extends IShared.IPaginationRequest {
-  id?: number;
-  from?: number;
-}
-
-export interface IFindByOwnerIdRequest {
-  from?: number;
-  to?: number;
-  user_type?: IDocumentTypeUserType;
-}
-
-export interface IFindByOwnerIdResponse extends Entity {
-  from_document_type: DocumentType.Entity | null;
-  to_document_type: DocumentType.Entity | null;
-}
-
-export interface IRepository {
-  findById(id: number): Promise<Workflow | null>;
-  findByQuery(data: IFindByQueryRequest): Promise<IShared.IPaginationResponse<Workflow>>;
-
-  findByOwnerId(data: IFindByOwnerIdRequest): Promise<IFindByOwnerIdResponse[]>;
-  find(data: IFindRequest): Promise<IFindByOwnerIdResponse[]>;
-
-  create(data: ICreateRequest): Promise<IFindByOwnerIdResponse>;
-  update(
-    selector: IShared.IFindByIdNumberRequest,
-    data: IUpdateRequest,
-  ): Promise<IFindByOwnerIdResponse | null>;
-  deleteOne(selector: IShared.IFindByIdNumberRequest): Promise<IFindByOwnerIdResponse | null>;
-}
-
-export type IController = IShared.IEntityWithUserToken<IRepository>;
-
-export type IApi = Omit<IRepository, 'findById' | 'findByQuery'>;

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

@@ -1,28 +0,0 @@
-import joi from 'joi';
-import { messages } from '../../../shared/messages';
-import * as IShared from '../../../shared/interface';
-import { ICreateRequest, IUpdateRequest, IFindByOwnerIdRequest } from './interfaces';
-import { documentTypeUserTypes } from '../../supply/documentType/interfaces';
-
-const postBodyValidatorKeys: IShared.IRouteRequest<ICreateRequest> = {
-  from_document_type_id: joi.number().integer(),
-  to_document_type_id: joi.number().integer(),
-  transition_name: joi.string().required(),
-  is_active: joi.boolean().default(false).optional(),
-};
-export const postBodyValidator = joi.object().keys(postBodyValidatorKeys).messages(messages);
-
-const putBodyValidatorKeys: IShared.IRouteRequest<IUpdateRequest> = {
-  from_document_type_id: joi.number().integer(),
-  to_document_type_id: joi.number().integer(),
-  transition_name: joi.string(),
-  is_active: joi.boolean().optional(),
-};
-export const putBodyValidator = joi.object().keys(putBodyValidatorKeys).messages(messages);
-
-const getByOwnerQueryKeys: IShared.IRouteRequest<IFindByOwnerIdRequest> = {
-  from: joi.number().integer().allow(null),
-  to: joi.number().integer().allow(null),
-  user_type: joi.string().valid(...documentTypeUserTypes),
-};
-export const getByOwnerQuery = joi.object().keys(getByOwnerQueryKeys).messages(messages);

package/src/modules/supply/clientCurrentAccount/interfaces.ts

@@ -1,152 +0,0 @@
-import * as IShared from '../../../shared/interface';
-import { ClientCurrentAccount } from '../../../shared/entities/stock';
-
-export type Entity = ClientCurrentAccount;
-export const Route = 'client_current_account';
-export const UpperName = 'ClientCurrentAccount';
-export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
-
-// phc document type enum
-export const IPhcDocumentTypeEnum: {
-  encomenda_de_cliente: '1|Encomenda de Cliente';
-  fatura_ad: '1|Fatura AD';
-  factura: '1|Factura';
-  factura_re: '9|Fatura RE';
-  factura_re_app: '12|Fatura RE APP';
-} = {
-  encomenda_de_cliente: '1|Encomenda de Cliente',
-  fatura_ad: '1|Fatura AD',
-  factura: '1|Factura',
-  factura_re: '9|Fatura RE',
-  factura_re_app: '12|Fatura RE APP',
-};
-export type IPhcDocumentType = (typeof IPhcDocumentTypeEnum)[keyof typeof IPhcDocumentTypeEnum];
-export const IPhcDocumentType = Object.keys(IPhcDocumentTypeEnum);
-
-export const IBasicSearchDocumentTypeEnum: {
-  faturaPorDevolver: 'faturaPorDevolver';
-  faturaDevolvida: 'faturaDevolvida';
-  faturaPorPagar: 'faturaPorPagar';
-  faturaPaga: 'faturaPaga';
-  adiantamento: 'adiantamento';
-  adiantamentoUsado: 'adiantamentoUsado';
-  encomendaAberta: 'encomendaAberta';
-  encomendaFechada: 'encomendaFechada';
-} = {
-  faturaPorDevolver: 'faturaPorDevolver',
-  faturaDevolvida: 'faturaDevolvida',
-  faturaPorPagar: 'faturaPorPagar',
-  faturaPaga: 'faturaPaga',
-  adiantamento: 'adiantamento',
-  adiantamentoUsado: 'adiantamentoUsado',
-  encomendaAberta: 'encomendaAberta',
-  encomendaFechada: 'encomendaFechada',
-};
-
-export type IBasicSearchDocumentType =
-  (typeof IBasicSearchDocumentTypeEnum)[keyof typeof IBasicSearchDocumentTypeEnum];
-export const IBasicSearchDocumentType = Object.keys(IBasicSearchDocumentTypeEnum);
-
-// find
-export type IFindRequest = IShared.IPaginationRequest & IShared.IFindByOwnerIdRequest;
-
-// faturasPorPagar
-export interface IFindFaturasPorPagarResponse {
-  id: string;
-  owner_id: string;
-  label: string;
-  valor_max_regularizavel: number;
-}
-export interface IPagarFaturaRequest {
-  id: string;
-  valor: number;
-}
-
-// devoluções
-export interface ILinhasFaturasParaDevolucao {
-  id: string; // (phc_documents.id)
-  reference: string;
-  designation: string;
-  quantity: number;
-  preco_venda: number;
-  total: number;
-  devolvido: boolean; // (se a linha já foi devolvida ou não)
-  desconto: number;
-  taxa_iva: number;
-  unidade: string;
-}
-export interface IFindFaturasParaDevolucaoResponse {
-  id: string;
-  owner_id: string;
-  owner_number: number;
-  label: string;
-  linhas: ILinhasFaturasParaDevolucao[];
-}
-export interface IDevolverRequest {
-  ids: string[];
-}
-
-export interface IBasicSearchRequest extends IShared.IPaginationRequest {
-  search_value: string | null;
-  inactive?: boolean;
-}
-
-export interface IBasicSearchResponse {
-  id: string;
-  owner_id: string;
-  document_header_id?: string;
-  type: IBasicSearchDocumentType;
-  nome: string;
-  nif: string;
-  email: string;
-  telephone: string;
-  numero_cliente: string;
-  numero_documento: string;
-  valor: number;
-}
-
-export interface IMultipleRegularizationPayments {
-  value: number;
-  payment_method_id: string;
-  payment_method: string;
-}
-
-export type IMultipleRegularizationPaymentsType = 'credit' | 'debit';
-
-export interface IMultipleRegularizationDocuments {
-  owner_id: string;
-  document_header_id: string;
-  type: IMultipleRegularizationPaymentsType;
-  value: number;
-}
-
-export interface IMultipleRegularizations {
-  documents: IMultipleRegularizationDocuments[];
-  payments?: IMultipleRegularizationPayments[];
-}
-
-export interface IRepository {
-  find(params: IShared.IFindByOwnerIdRequest): Promise<Entity[]>;
-
-  findByOwnerId(params: IFindRequest): Promise<IShared.IPaginationResponse<Entity>>;
-
-  findFaturaPorPagar(params: IShared.IFindByIdRequest): Promise<IFindFaturasPorPagarResponse>;
-
-  pagarFatura(params: IPagarFaturaRequest): Promise<void>;
-
-  findFaturaParaDevolver(
-    params: IShared.IFindByIdRequest,
-  ): Promise<IFindFaturasParaDevolucaoResponse>;
-
-  devolver(params: IDevolverRequest): Promise<void>;
-
-  findByBasicSearch(
-    data: IBasicSearchRequest,
-  ): Promise<IShared.IPaginationResponse<IBasicSearchResponse>>;
-
-  regularizarMultiplosDocumentos(data: IMultipleRegularizations): Promise<void>;
-}
-
-export type IController = IShared.IEntityWithUserToken<IRepository>;
-
-export type IApi = Omit<IRepository, 'find'>;

package/src/modules/supply/clientCurrentAccount/route.schema.ts

@@ -1,66 +0,0 @@
-import joi from 'joi';
-import { messages } from '../../../shared/messages';
-import * as IShared from '../../../shared/interface';
-import {
-  IFindRequest,
-  IDevolverRequest,
-  IPagarFaturaRequest,
-  IBasicSearchRequest,
-  IMultipleRegularizations,
-  IMultipleRegularizationDocuments,
-  IMultipleRegularizationPayments,
-} from './interfaces';
-
-const findByOwnerIdBodyKeys: IShared.IRouteRequest<IFindRequest> = {
-  per_page: joi.number().integer().positive().default(10).optional(),
-  current_page: joi.number().integer().positive().default(1).optional(),
-  owner_id: joi.string().uuid().required(),
-};
-export const findByOwnerIdBodyKeysBody = joi
-  .object()
-  .keys(findByOwnerIdBodyKeys)
-  .messages(messages);
-
-// pagarFatura
-const pagarFaturaBodyKeys: IShared.IRouteRequest<IPagarFaturaRequest> = {
-  id: joi.string().uuid().required(),
-  valor: joi.number().positive().required(),
-};
-export const pagarFaturaBody = joi.object().keys(pagarFaturaBodyKeys).messages(messages);
-
-// devolver
-const devolverBodyKeys: IShared.IRouteRequest<IDevolverRequest> = {
-  ids: joi.array().items(joi.string().uuid().required()).required(),
-};
-export const devolverBody = joi.object().keys(devolverBodyKeys).messages(messages);
-
-// basic search
-const basicSearchQueryKeys: IShared.IRouteRequest<IBasicSearchRequest> = {
-  search_value: joi.string().allow('', null).optional(),
-  per_page: joi.number().positive().integer().default(10).allow(null).optional(),
-  inactive: joi.boolean().default(false).optional(),
-  current_page: joi.number().positive().integer().allow(null).optional(),
-};
-export const basicSearchQuery = joi.object().keys(basicSearchQueryKeys).messages(messages);
-
-// regularizar multiplos documentos
-const multipleDocumentsBodyKeys: IShared.IRouteRequest<IMultipleRegularizationDocuments> = {
-  owner_id: joi.string().uuid().required(),
-  document_header_id: joi.string().uuid().required(),
-  type: joi.string().valid('credit', 'debit').required(),
-  value: joi.number().positive().required(),
-};
-
-const multiplePaymentsBodyKeys: IShared.IRouteRequest<IMultipleRegularizationPayments> = {
-  value: joi.number().positive().required(),
-  payment_method_id: joi.string().uuid().required(),
-  payment_method: joi.string().required(),
-};
-const regularizarMultiplosBodyKeys: IShared.IRouteRequest<IMultipleRegularizations> = {
-  documents: joi.array().items(multipleDocumentsBodyKeys).required(),
-  payments: joi.array().items(multiplePaymentsBodyKeys).optional(),
-};
-export const regularizarMultiplosBody = joi
-  .object()
-  .keys(regularizarMultiplosBodyKeys)
-  .messages(messages);

package/src/modules/supply/counter/interfaces.ts

@@ -1,34 +0,0 @@
-import * as IShared from '../../../shared/interface';
-import { Counter } from '../../../shared/entities/stock';
-
-export type Entity = Counter;
-export const Route = 'counter';
-export const UpperName = 'Counter';
-export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
-
-export interface IFindByDocTypeRequest {
-  document_type: number;
-}
-
-export interface ICreateRequest {
-  name: string;
-  document_type: number;
-  year: number;
-}
-
-export interface IUpdateRequest {
-  name: string;
-  document_type: number;
-  year: number;
-}
-
-export interface IRepository {
-  findByDocType(data: IFindByDocTypeRequest): Promise<Entity | null>;
-  findAll(): Promise<Entity[]>;
-  create(data: ICreateRequest): Promise<Entity>;
-  update(data: IUpdateRequest): Promise<Entity | null>;
-}
-
-export type IController = IShared.IEntityWithUserToken<IRepository>;
-
-export type IApi = Omit<IRepository, 'findAll'>;

package/src/modules/supply/counter/route.schema.ts

@@ -1,26 +0,0 @@
-import joi from 'joi';
-import { messages } from '../../../shared/messages';
-import * as IShared from '../../../shared/interface';
-import { IFindByDocTypeRequest, ICreateRequest, IUpdateRequest } from './interfaces';
-
-const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
-  document_type: joi.number().required(),
-  year: joi.number().required(),
-  name: joi.string().required(),
-};
-export const createBody = joi.object().keys(createBodyKeys).messages(messages);
-
-const findByDocumentTypeParamsKeys: IShared.IRouteRequest<IFindByDocTypeRequest> = {
-  document_type: joi.number().required(),
-};
-export const findByDocumentTypeParams = joi
-  .object()
-  .keys(findByDocumentTypeParamsKeys)
-  .messages(messages);
-
-const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
-  document_type: joi.number().required(),
-  year: joi.number().required(),
-  name: joi.string().required(),
-};
-export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);