@nomalism-com/types 0.37.6 → 0.37.7

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

@@ -0,0 +1,371 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import {
+  ICreateRequest,
+  IUpdateRequest,
+  ICreateFromHeaderRequest,
+  IBasicSearchRequest,
+  IFindRequest,
+  ICreateFromHeaderMaturityDate,
+  ITransferOwnershipRequest,
+  IUpdateManyWithPersona,
+  ISendClientNotificationRequest,
+  IDocumentPdfRequest,
+  IFindByTypeRequest,
+  IDocumentListRequest,
+  IWarningType,
+  type IMultipleRegularizationDocuments,
+  type IMultipleRegularizationPayments,
+  type IMultipleRegularizations,
+} from './interfaces';
+import { documentTypeCodeTypes } from '../documentType/interfaces';
+
+const createFromHeaderMaturityDate: IShared.IRouteRequest<ICreateFromHeaderMaturityDate> = {
+  id: joi.string().uuid().required(),
+  name: joi.string().required(),
+  days: joi.number().integer().positive().allow(0).required(),
+};
+
+const createBodyKeys: IShared.IRouteRequestWithStamps<ICreateRequest> = {
+  document_type_id: joi.number().required(),
+
+  external_id: joi.string().allow(null).optional(),
+  document_set_id: joi.string().uuid().required(),
+  pdf_link: joi.string().allow(null).optional(),
+  google_sheet_id: joi.string().allow(null).optional(),
+  external_pdf_link: joi.string().allow(null).optional(),
+  sent: joi.boolean().optional(),
+
+  owner_id: joi.string().uuid().required(),
+  owner_number: joi.number().required(),
+  owner_name: joi.string().required(),
+
+  reason_for_exemption_id: joi.string().uuid().allow(null).optional(),
+  reason_for_exemption: joi.string().allow(null),
+
+  billing_persona_id: joi.string().uuid().allow(null).optional(),
+  billing_persona_nif: joi.string().allow(null).optional(),
+  billing_persona_name: joi.string().allow(null).optional(),
+  billing_persona_email: joi
+    .string()
+    .email({ tlds: { allow: false } })
+    .allow(null)
+    .optional(),
+  billing_persona_telephone: joi.string().allow(null).optional(),
+  billing_persona_address_street: joi.string().allow(null).optional(),
+  billing_persona_address_postal_code: joi.string().trim(true).lowercase().allow(null).optional(),
+  billing_persona_address_locality: joi.string().allow(null).optional(),
+  billing_persona_address_country_id: joi.string().allow(null).optional(),
+  billing_persona_address_country_name: joi.string().allow(null).optional(),
+
+  delivery_persona_id: joi.string().uuid().allow(null).optional(),
+  delivery_persona_name: joi.string().allow(null).optional(),
+  delivery_persona_email: joi
+    .string()
+    .email({ tlds: { allow: false } })
+    .allow(null)
+    .optional(),
+  delivery_persona_telephone: joi.string().allow(null).optional(),
+  delivery_persona_address_street: joi.string().allow(null).optional(),
+  delivery_persona_address_postal_code: joi.string().trim(true).lowercase().allow(null).optional(),
+  delivery_persona_address_locality: joi.string().allow(null).optional(),
+  delivery_persona_address_country_id: joi.string().allow(null).optional(),
+  delivery_persona_address_country_name: joi.string().allow(null).optional(),
+
+  payment_method_id: joi.string().uuid().allow(null).optional(),
+  payment_method: joi.string().allow(null).optional(),
+
+  maturity_date: joi.object().keys(createFromHeaderMaturityDate).optional(),
+
+  delivery_method_id: joi.string().uuid().allow(null).optional(),
+  delivery_method: joi.string().allow(null).optional(),
+
+  delivery_departure_street: joi.string().allow(null).optional(),
+  delivery_departure_postal_code: joi.string().trim(true).lowercase().allow(null).optional(),
+  delivery_departure_locality: joi.string().allow(null).optional(),
+
+  vehicle_id: joi.string().uuid().allow(null).optional(),
+  vehicle: joi.string().allow(null).optional(),
+
+  commissioner_id: joi.string().uuid().allow(null).optional(),
+  commission_percentage: joi.number().positive().allow(0).default(0).optional(),
+  return_reason: joi.string().allow(null).optional(),
+
+  updated_by: joi.string().uuid().allow(null).optional(),
+  created_by: joi.string().uuid().allow(null).optional(),
+};
+export const createBody = joi
+  .object()
+  .keys(createBodyKeys)
+  .and('reason_for_exemption_id', 'reason_for_exemption')
+  // .and('persona_id', 'contact_name', 'email', 'phone_number')
+  // .and(
+  //   'delivery_country_name',
+  //   'delivery_country_id',
+  //   'delivery_street',
+  //   'delivery_locality',
+  //   'delivery_postal_code',
+  // )
+  // .and(
+  //   'billing_country_name',
+  //   'billing_country_id',
+  //   'billing_street',
+  //   'billing_locality',
+  //   'billing_postal_code',
+  // )
+  .and('payment_method_id', 'payment_method')
+  .and('delivery_method_id', 'delivery_method')
+  .and('delivery_departure_street', 'delivery_departure_postal_code', 'delivery_departure_locality')
+  .and('vehicle_id', 'vehicle')
+  .messages(messages);
+
+const createFromHeaderBodyKeys: IShared.IRouteRequest<ICreateFromHeaderRequest> = {
+  document_type_id: joi.number().required(),
+  emission_date: joi.date().optional(),
+  from_header: joi.array().items(joi.string().uuid().required()).required(),
+  from_lines: joi.array().items(joi.string().uuid().optional()).required(),
+  payments: joi.array().items(
+    joi
+      .object({
+        document_header_id: joi.string().uuid().optional(),
+        date: joi.date().required(),
+        debit: joi.number().positive().allow(0).required(),
+        credit: joi.number().allow(0).required(),
+        payment_method_id: joi.string().uuid().required(),
+        payment_method: joi.string().required(),
+        notes: joi.string().allow('', null).required(),
+      })
+      .optional(),
+  ),
+  delivery_method_id: joi.string().optional(),
+  delivery_adresses: joi
+    .object({
+      delivery_departure_street: joi.string().required(),
+      delivery_departure_locality: joi.string().required(),
+      delivery_departure_postal_code: joi.string().trim(true).lowercase().required(),
+      delivery_street: joi.string().required(),
+      delivery_locality: joi.string().required(),
+      delivery_postal_code: joi.string().trim(true).lowercase().required(),
+    })
+    .allow(null)
+    .optional(),
+  email: joi
+    .string()
+    .email({ tlds: { allow: false } })
+    .allow(null)
+    .optional(),
+  maturity_date: joi.object().keys(createFromHeaderMaturityDate).optional(),
+  return_reason: joi.string().optional(),
+  provider_ref: joi.string().optional(),
+  global_discount: joi.number().min(0).max(100).optional(),
+  current_account: joi.boolean().optional(),
+};
+export const createFromHeaderBody = joi.object().keys(createFromHeaderBodyKeys).messages(messages);
+
+const findQueryKeys: IShared.IRouteRequest<IFindRequest> = {
+  owner_id: joi.string().uuid().required(),
+  document_type_id: joi.number().required(),
+  closed: joi.boolean().optional(),
+};
+export const findQuery = joi.object().keys(findQueryKeys).messages(messages);
+
+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);
+
+const updateBodyKeys: IShared.IRouteRequestWithStamps<IUpdateRequest> = {
+  external_id: joi.string().allow(null).optional(),
+  external_pdf_link: joi.string().allow(null).optional(),
+  google_sheet_id: joi.string().allow(null).optional(),
+  pdf_link: joi.string().allow(null).optional(),
+  sent: joi.boolean().optional(),
+
+  owner_id: joi.string().uuid().optional(),
+  owner_number: joi.number().integer().positive().optional(),
+  owner_name: joi.string().optional(),
+
+  reason_for_exemption_id: joi.string().uuid().allow(null).optional(),
+  reason_for_exemption: joi.string().allow(null).optional(),
+
+  billing_persona_id: joi.string().uuid().allow(null).optional(),
+  billing_persona_nif: joi.string().allow(null).optional(),
+  billing_persona_name: joi.string().allow(null).optional(),
+  billing_persona_email: joi
+    .string()
+    .email({ tlds: { allow: false } })
+    .allow(null)
+    .optional(),
+  billing_persona_telephone: joi.string().allow(null).optional(),
+  billing_persona_address_street: joi.string().allow(null).optional(),
+  billing_persona_address_postal_code: joi.string().trim(true).lowercase().allow(null).optional(),
+  billing_persona_address_locality: joi.string().allow(null).optional(),
+  billing_persona_address_country_id: joi.string().allow(null).optional(),
+  billing_persona_address_country_name: joi.string().allow(null).optional(),
+
+  delivery_persona_id: joi.string().uuid().allow(null).optional(),
+  delivery_persona_name: joi.string().allow(null).optional(),
+  delivery_persona_email: joi
+    .string()
+    .email({ tlds: { allow: false } })
+    .allow(null)
+    .optional(),
+  delivery_persona_telephone: joi.string().allow(null).optional(),
+  delivery_persona_address_street: joi.string().allow(null).optional(),
+  delivery_persona_address_postal_code: joi.string().trim(true).lowercase().allow(null).optional(),
+  delivery_persona_address_locality: joi.string().allow(null).optional(),
+  delivery_persona_address_country_id: joi.string().allow(null).optional(),
+  delivery_persona_address_country_name: joi.string().allow(null).optional(),
+
+  payment_method_id: joi.string().uuid().allow(null).optional(),
+  payment_method: joi.string().allow(null).optional(),
+
+  maturity_date_id: joi.string().uuid().allow(null).optional(),
+  maturity_date: joi.string().allow(null).optional(),
+  maturity_date_days: joi.number().integer().positive().allow(0).allow(null).optional(),
+
+  delivery_method_id: joi.string().uuid().allow(null).optional(),
+  delivery_method: joi.string().allow(null).optional(),
+
+  delivery_departure_street: joi.string().allow(null).optional(),
+  delivery_departure_postal_code: joi.string().trim(true).lowercase().allow(null).optional(),
+  delivery_departure_locality: joi.string().allow(null).optional(),
+
+  vehicle_id: joi.string().uuid().allow(null).optional(),
+  vehicle: joi.string().allow(null).optional(),
+
+  commissioner_id: joi.string().uuid().allow(null).optional(),
+  commission_percentage: joi.number().positive().allow(0).optional(),
+  commission_paid: joi.boolean().optional(),
+
+  is_archived: joi.boolean().optional(),
+  is_void: joi.boolean().optional(),
+  is_void_reason: joi.string().optional(),
+  is_force_adjudicated: joi.boolean().optional(),
+  who_handles: joi.string().allow(null).optional(),
+  warning: joi
+    .string()
+    .optional()
+    .valid(...Object.values(IWarningType)),
+  created_by: joi.string().uuid().allow(null).optional(),
+};
+export const updateBody = joi
+  .object()
+  .keys(updateBodyKeys)
+  .and('reason_for_exemption_id', 'reason_for_exemption')
+  .and('persona_id', 'contact_name', 'email', 'phone_number')
+  .and(
+    'delivery_country_name',
+    'delivery_country_id',
+    'delivery_street',
+    'delivery_locality',
+    'delivery_postal_code',
+  )
+  .and(
+    'billing_country_name',
+    'billing_country_id',
+    'billing_street',
+    'billing_locality',
+    'billing_postal_code',
+  )
+  .and('payment_method_id', 'payment_method')
+  .and('maturity_date_id', 'maturity_date', 'maturity_date_days')
+  .and('delivery_method_id', 'delivery_method')
+  .and('delivery_departure_street', 'delivery_departure_postal_code', 'delivery_departure_locality')
+  .and('vehicle_id', 'vehicle')
+  .messages(messages);
+
+const transferClientOwnershipBodyKeys: IShared.IRouteRequest<ITransferOwnershipRequest> = {
+  document_header_id: joi.string().uuid().required(),
+  client_id: joi.string().uuid().required(),
+};
+export const transferClientOwnershipBody = joi
+  .object()
+  .keys(transferClientOwnershipBodyKeys)
+  .messages(messages);
+
+const updateManyWithPersonaBodyKeys: IShared.IRouteRequest<IUpdateManyWithPersona> = {
+  id: joi.string().uuid().required(),
+  name: joi.string().allow(null).optional(),
+  telephone: joi.string().allow(null).optional(),
+  email: joi
+    .string()
+    .email({ tlds: { allow: false } })
+    .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(),
+  country_name: joi.string().allow(null).optional(),
+};
+export const updateManyWithPersonaBody = joi
+  .object()
+  .keys(updateManyWithPersonaBodyKeys)
+  .messages(messages);
+
+const sendClientNotificationBodyKeys: IShared.IRouteRequest<ISendClientNotificationRequest> = {
+  name: joi.string().allow('', null).required(),
+  email: joi
+    .string()
+    .email({ tlds: { allow: false } })
+    .allow('', null)
+    .required(),
+  dontSendEmail: joi.boolean().default(false).optional(),
+};
+export const sendClientNotificationBody = joi
+  .object()
+  .keys(sendClientNotificationBodyKeys)
+  .messages(messages);
+
+const findByTypeQueryKeys: IShared.IRouteRequest<IFindByTypeRequest> = {
+  documentTypeCodes: joi
+    .array()
+    .items(
+      joi
+        .string()
+        .valid(...documentTypeCodeTypes)
+        .required(),
+    )
+    .required(),
+};
+export const findByTypeQuery = joi.object().keys(findByTypeQueryKeys).messages(messages);
+
+const documentPdfQueryKeys: IShared.IRouteRequest<IDocumentPdfRequest> = {
+  token: joi.string().optional(),
+};
+
+export const documentPdfQuery = joi.object().keys(documentPdfQueryKeys).messages(messages);
+
+export const documentLineQuery = joi
+  .object<IShared.IRouteRequest<IDocumentListRequest>>()
+  .keys({
+    closed: joi.boolean().default(false).optional(),
+  })
+  .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/documentHeaderHistory/interfaces.ts

@@ -0,0 +1,15 @@
+import * as IShared from '../../../shared/interface';
+import { DocumentHeaderHistory } from '../../../shared/entities/stock';
+
+export type Entity = DocumentHeaderHistory;
+export const Route = 'documentHeaderHistory';
+export const UpperName = 'DocumentHeaderHistory';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export type IFindByOwnerIdResponse = Omit<DocumentHeaderHistory, 'id' | 'document_header_id'>;
+
+export interface IRepository {
+  findByOwnerId(selector: IShared.IFindByOwnerIdRequest): Promise<IFindByOwnerIdResponse[]>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

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

@@ -0,0 +1,210 @@
+import * as IShared from '../../../shared/interface';
+import {
+  DocumentLine,
+  DocumentLineVirtuals,
+  DocumentLinePendingConflict,
+  DocumentLineBaseVirtuals,
+  ProductPromotionVirtuals,
+  DocumentLineNote,
+  DocumentLineRM,
+} from '../../../shared/entities/stock';
+import * as IDocumentLineAssoc from '../documentLineAssoc/interfaces';
+import { IDocumentTypeCodeType, IDocumentTypeUserType } from '../documentType/interfaces';
+import { IProductType } from '../../stock/productGoogleSheets/interface';
+import type { IGetProductType, IGetProductGroup } from '../../integration/googleSheets/interfaces';
+
+export type Entity = DocumentLine;
+export const Route = 'documentLine';
+export const UpperName = 'DocumentLine';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export type IDocumentLineVirtuals = DocumentLineVirtuals;
+export type IDocumentLineBaseVirtuals = DocumentLineBaseVirtuals;
+export type IDocumentLineRM = DocumentLineRM;
+
+export type IPromotions = Pick<
+  ProductPromotionVirtuals,
+  'exclusive_to_location_id' | 'exclusive_to_client_id' | 'discount'
+>;
+
+export type IDataKeys =
+  | 'Conferir Encomenda' // Informações durante a conferência de encomenda de fornecedor: Espera Info Cliente ou interna, Espera Nomalism, etc
+  // aviso cliente
+  | 'AvisoCliente'
+  // entrada de material
+  | 'Quantidade Encomendada Originalmente' // Usado na entrada de material quando a quantidade de entrada é diferente da encomendada e o utilizador marca como conforme. Nesse caso a quantidade da encomenda é alterada para coincidir com a quantidade de entrada e a quantidade original encomendada é guardada nesta chave para histórico
+  | 'Linha criada na EM' // Linha que foi criada na entrada de material resultante da desdobragem ou chegada inesperada
+  | 'Opcao EM' // Usado para todas as seleções de entrada de material
+  // devoluções a fornecedor
+  | 'Levantar DF' // Parcela presa, marcada para devolução, dada como levantada
+  | 'Enviar Email NCF' // DESCONTINUAR: Parcela presa, marcada para devolução, enviado email ao fornecedor a pedir emissão de nota de crédito
+  | 'Fechar DF' // DESCONTINUAR: Parcela presa, marcada para devolução, fechada
+  // regularizações
+  | 'Documento pago' // Usado nas linhas da NPF que regularizam documentos não-legados
+  | 'Pagamento' // Usado nas linhas da NPF que regularizam documentos PHC
+  | 'Recibo do documento' // Usado por linhas de recibo para indicar a fatura relacionada
+  // existem e são usados no SQL mas não precisam ser acedidos por código:
+  // | 'Saldos Migrados'
+  // | 'Estado PHC'
+  // pdf retry
+  | 'Emitir' // Foi solicitada a emissão de documento externo manualmente
+  | 'Backup PDF'; // Foi solicitado o backup do PDF externo manualmente
+
+export interface IDataPayload {
+  value: unknown;
+  updated_at: Date;
+  updated_by: string;
+  location_id: string;
+  history?: IDataPayload[];
+}
+
+export type IData = { [K in IDataKeys]?: IDataPayload };
+
+export interface IImportedFromSheets {
+  type: IGetProductType;
+  group: IGetProductGroup;
+  index: number;
+  reference: string;
+}
+
+export interface IDataDocumentoPago {
+  name: string;
+  dh_id: string;
+  value: number;
+  discount_value: number;
+}
+
+export interface IDataPagamento {
+  name: string;
+  cca_id?: string;
+  pca_id?: string;
+  value: number;
+  discount_value: number;
+}
+
+export interface IDocumentLineDocuments {
+  code: IDocumentTypeCodeType;
+  user_type: IDocumentTypeUserType;
+  start_document_header_id?: string;
+  pdf_link?: string;
+  external_url?: string;
+  label?: string;
+  edh_id?: string;
+}
+
+export interface IHistory {
+  what: string;
+  when: string;
+  who: string;
+}
+
+export interface IEntityExtended extends Omit<DocumentLine, 'data'> {
+  group: string;
+  document_headers: IDocumentLineDocuments[];
+  document_line_rm: IDocumentLineRM | null;
+  pending_conflict: DocumentLinePendingConflict | null;
+  document_line_notes: DocumentLineNote[];
+  product_type: IProductType | null;
+  product_id_provider: number | null;
+  product_provider_ref: string | null;
+  product_dnt_come_anymore: boolean;
+  product_no_discount: boolean;
+  product_measure: string | null;
+  product_integer_only: boolean;
+}
+
+export interface ICreateRequest
+  extends Omit<IDocumentLineAssoc.ICreateRequest, 'document_line_id'> {
+  document_line_id?: string;
+
+  product_id?: string;
+  quantity: number;
+  preco_venda: number;
+  client_tax: number;
+  client_discount: number;
+  preco_custo: number;
+  provider_tax: number;
+  provider_discount: number;
+  document_line_group_id?: string;
+  data: IData;
+}
+
+export interface IUpdateRequest {
+  product_id?: string;
+  quantity?: number;
+  preco_venda?: number;
+  client_tax?: number;
+  client_discount?: number;
+  preco_custo?: number;
+  provider_tax?: number;
+  provider_discount?: number;
+  provider_purchase_discount?: number;
+  document_line_group_id?: string;
+  sent_to_client?: boolean;
+  sent_to_provider?: boolean;
+}
+
+export interface IUpdateDataRequest {
+  trigger_states?: boolean;
+
+  document_header_id: string;
+  document_line_ids: string[];
+  datafield: IDataKeys;
+  payload: IDataPayload;
+}
+
+export interface IUpdateManyRequest {
+  ids: string[];
+  client_discount?: number;
+  price_cost?: number;
+  provider_discount?: number;
+  provider_estimated_delivery_date?: Date | null;
+  provider_purchase_discount?: number;
+  consignacao?: boolean;
+  cancelled?: boolean;
+}
+
+export interface IUpdateManyByDocumentHeaderRequest {
+  sent_to_provider?: boolean;
+}
+
+export interface IUpdateDataRequestWithoutStamps extends Omit<IUpdateDataRequest, 'payload'> {
+  payload: Pick<IDataPayload, 'value'> & {
+    updated_by?: string;
+  };
+}
+
+export interface IUpdateLineStatesTriggerResponse {
+  document_header_id: string;
+  trigger_event: boolean;
+  broker_topic?: IShared.IBrokerTopic;
+}
+
+export interface IPrintLabelParamsRequest {
+  document_line_ids: string;
+}
+
+export interface IPrintLabelQueryRequest {
+  token: string;
+}
+
+export interface IRepository {
+  create(data: ICreateRequest[]): Promise<IDocumentLineAssoc.IEntityExtended[]>;
+
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<void>;
+
+  updateData(data: IUpdateDataRequest): Promise<IDocumentLineAssoc.IEntityWithDocumentLine[]>;
+
+  updateMany(data: IUpdateManyRequest): Promise<void>;
+
+  updateManyByDocumentHeader(
+    selector: IShared.IFindByIdRequest,
+    data: IUpdateManyByDocumentHeaderRequest,
+  ): Promise<void>;
+
+  updateIndexes(document_line_ids: string[]): Promise<void>;
+
+  deleteMany(document_line_ids: string[]): Promise<void>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;