@nomalism-com/types 0.36.32 → 0.37.1

package/src/modules/supply/externalDocumentHeader/interface.ts

@@ -1,120 +0,0 @@
-import * as IShared from '../../../shared/interface';
-import { ExternalDocumentHeader } from '../../../shared/entities/stock';
-import { IUpdateDataRequest } from '../documentLine/interfaces';
-export type Entity = ExternalDocumentHeader;
-export declare const Route = 'external_document_header';
-export declare const UpperName = 'ExternalDocumentHeader';
-export declare const LowerName: string;
-type IEntityExtended = Entity;
-export type IFindByIdResponse = Omit<IEntityExtended, ''>;
-export interface IFindByOwnerIdItem {
-  id: string | null;
-  document_header_id: string;
-  is_void: boolean;
-  pdf_link: string | null;
-  external_id: string | null;
-  label: string;
-  visible: boolean;
-  loading: boolean;
-  emission_date: Date;
-  retryPayload: IUpdateDataRequest | null;
-}
-export interface IFindByOwnerIdItemWithVersions extends IFindByOwnerIdItem {
-  older_versions: IFindByOwnerIdItem[];
-}
-
-export type IFindRequest = Record<string, unknown>;
-export type IFindResponse = Omit<IEntityExtended, ''>;
-export interface IFindPaginatedRequest extends IFindRequest, IShared.IPaginationRequest {}
-export type IFindWithPaginationResponse = IShared.IPaginationResponse<Omit<IEntityExtended, ''>>;
-export interface ICreateRequest {
-  document_header_id: string;
-  external_id: string;
-  external_pdf_link: string;
-  pdf_link: string;
-}
-export interface IUpdateRequest {
-  external_id?: string;
-  external_pdf_link?: string;
-  pdf_link?: string;
-}
-export interface ISendEmailDocument {
-  template: IShared.IUserSendEmailDocumentTemplate;
-  external_document_header_ids: string[];
-  document_line_assoc_ids: string[];
-  user: {
-    name: string;
-    email: string;
-  };
-}
-
-export enum IPublicDocumentHeaderNoteType {
-  Provider = 'Provider',
-  Client = 'Client',
-}
-
-export interface PublicDocumentHeaderNote {
-  id: string;
-  note: string;
-  type: IPublicDocumentHeaderNoteType;
-  created_at: Date;
-  updated_at: Date;
-  created_by: string;
-  updated_by: string;
-}
-
-export type ISendEmailDocumentRequest = IShared.RequireOnlyOne<
-  ISendEmailDocument,
-  'document_line_assoc_ids' | 'external_document_header_ids'
->;
-export interface IPublicFindByOwnerIdResponse {
-  start_document_header_id: string;
-  label: string;
-  emission_date: Date;
-  pdf_link: string;
-  new_chat_messages: number;
-  pc_tags: string[];
-}
-
-export interface PublicDocumentHeaderNoteCreateRequest {
-  document_header_id: string;
-  note: string;
-  type: IPublicDocumentHeaderNoteType;
-}
-
-export interface PublicDocumentHeaderNoteUpdateRequest {
-  note: string;
-}
-
-export interface IRepository {
-  findById(selector: IShared.IFindByIdRequest): Promise<IFindByIdResponse | null>;
-
-  publicFindByOwnerId(
-    params: IShared.IFindByOwnerIdRequest,
-  ): Promise<IPublicFindByOwnerIdResponse[]>;
-
-  findByOwnerId(params: IShared.IFindByOwnerIdRequest): Promise<IFindByOwnerIdItemWithVersions[]>;
-
-  sendEmailDocument: (data: ISendEmailDocumentRequest) => Promise<void>;
-
-  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>;
-
-  createPublicDocumentHeaderNote: (
-    data: PublicDocumentHeaderNoteCreateRequest[],
-  ) => Promise<PublicDocumentHeaderNote[]>;
-
-  updatePublicDocumentHeaderNote: (
-    selector: IShared.IFindByIdRequest,
-    data: PublicDocumentHeaderNoteUpdateRequest[],
-  ) => Promise<PublicDocumentHeaderNote[]>;
-}
-export type IController = IShared.IEntityWithUserToken<IRepository>;
-export {};

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

@@ -1,79 +0,0 @@
-import joi from 'joi';
-import { messages } from '../../../shared/messages';
-import * as IShared from '../../../shared/interface';
-import {
-  IFindRequest,
-  IFindPaginatedRequest,
-  ICreateRequest,
-  IUpdateRequest,
-  ISendEmailDocumentRequest,
-  PublicDocumentHeaderNoteUpdateRequest,
-  PublicDocumentHeaderNoteCreateRequest,
-} from './interface';
-
-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);
-
-// create body validation
-const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
-  document_header_id: joi.string().uuid().required(),
-  external_id: joi.string().required(),
-  external_pdf_link: joi.string().required(),
-  pdf_link: joi.string().required(),
-};
-export const createBody = joi.object().keys(createBodyKeys).messages(messages);
-
-// update body validation
-const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
-  external_id: joi.string(),
-  external_pdf_link: joi.string(),
-  pdf_link: joi.string(),
-};
-export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);
-
-const sendEmailDocumentBodyKeys: IShared.IRouteRequest<ISendEmailDocumentRequest> = {
-  template: joi
-    .string()
-    .valid(...IShared.IUserSendEmailDocumentTemplateTypes)
-    .required(),
-  document_line_assoc_ids: joi.array().items(joi.string().uuid()),
-  external_document_header_ids: joi.array().items(joi.string().uuid()),
-  user: joi
-    .object()
-    .keys({
-      name: joi.string().required(),
-      email: joi.string().trim(true).lowercase().required(),
-    })
-    .optional(),
-};
-
-export const sendEmailDocumentBody = joi
-  .object()
-  .keys(sendEmailDocumentBodyKeys)
-  .xor('document_line_assoc_ids', 'external_document_header_ids')
-  .messages(messages);
-
-// create Note body validation
-const createNoteBodyKeys: IShared.IRouteRequest<PublicDocumentHeaderNoteCreateRequest> = {
-  document_header_id: joi.string().uuid().required(),
-  note: joi.string().required(),
-  type: joi.string().required().valid('Client', 'Provider'),
-};
-
-export const createNoteBody = joi.object().keys(createNoteBodyKeys).messages(messages);
-
-// update Note body validation
-const updateNoteBodyKeys: IShared.IRouteRequest<PublicDocumentHeaderNoteUpdateRequest> = {
-  note: joi.string().required().allow(''),
-};
-export const updateNoteBody = joi.object().keys(updateNoteBodyKeys).messages(messages);

package/src/modules/supply/externalDocumentType/interface.ts

@@ -1,14 +0,0 @@
-import { ExternalDocumentType } from '../../../shared/entities/stock';
-import * as IShared from '../../../shared/interface';
-
-export type Entity = ExternalDocumentType;
-export const Route = 'external_document_type';
-export const UpperName = 'ExternalDocumentType';
-export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
-
-export interface IRepository {
-  find(): Promise<Entity[]>;
-  findMinified(params?: IShared.IFindMinifiedRequest): Promise<IShared.IFindMinifiedResponse[]>;
-}
-
-export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/supply/orderManagement/interface.ts

@@ -1,49 +0,0 @@
-import { IProductType } from '../../stock/productGoogleSheets/interface';
-
-export const Route = 'order_management';
-export const UpperName = 'OrderManagement';
-export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
-
-export interface IFindProviderProductsRequest {
-  provider_id: string;
-}
-
-export interface IFindProposals {
-  id: string;
-  name: string;
-  start_document_header_id: string;
-  pdf_link: string | null;
-}
-
-export interface IFindProviderProductsResponse {
-  product_id: string;
-  type: IProductType;
-  obs: boolean;
-  multimedia_id: string | null;
-  ref: string;
-  des: string;
-  provider_ref: string | null;
-  price_cost: number;
-  price_sale: number;
-  available: number;
-  last_ef_date: Date | null;
-  ordered_quantity: number;
-  last_em_date: Date | null;
-  notation: string;
-  pfs: IFindProposals[];
-  pcs: IFindProposals[];
-  client_quantity: number;
-  pre_ordered_quantity: number;
-  last6m_consumption: number;
-}
-
-export interface IFindAllProviderProductsResponse extends IFindProviderProductsResponse {
-  provider_id: string;
-}
-
-export interface IRepository {
-  findProviderProducts(
-    params: IFindProviderProductsRequest,
-  ): Promise<IFindProviderProductsResponse[]>;
-  findAllProviderProducts(): Promise<IFindAllProviderProductsResponse[]>;
-}

package/src/modules/supply/payment/interface.ts

@@ -1,229 +0,0 @@
-import * as IShared from '../../../shared/interface';
-import { Payment, DocumentHeader } from '../../../shared/entities/stock';
-import * as IUser from '../../user/users/interface';
-import * as IObservation from '../../integration/observation/interfaces';
-
-export type Entity = Payment;
-export const Route = 'payment';
-export const UpperName = 'Payment';
-export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
-
-type IEntityExtended = Entity;
-
-// omit any unnecessary fields
-export type IFindByIdResponse = Omit<IEntityExtended, ''>;
-
-// omit any unnecessary fields
-export type IFindByOwnerIdResponse = Omit<IEntityExtended, ''>;
-
-export type IFindRequest = Record<string, unknown>;
-
-// omit any unnecessary fields
-export type IFindResponse = Omit<IEntityExtended, ''>;
-
-export interface IFindPaginatedRequest extends IFindRequest, IShared.IPaginationRequest {}
-
-export type IFindWithPaginationResponse = IShared.IPaginationResponse<Omit<IEntityExtended, ''>>;
-
-export interface ICreateForThisDocumentHeaderRequest {
-  date: Date;
-  debit: number;
-  credit: number;
-  payment_method_id?: string | null;
-  payment_method?: string | null;
-  notes: string | null;
-}
-
-export interface ICreateRequest extends ICreateForThisDocumentHeaderRequest {
-  document_header_id: string;
-}
-
-export interface ICurrentAccountNotes {
-  date: string;
-  credit: number | null;
-  debit: number | null;
-  iban: string | null;
-  payment_batch_id: string | null;
-  payment_method: string | null;
-  notes: string | null;
-  owner_name: string;
-  created_at: string;
-  created_by: string;
-  updated_at: string;
-  updated_by: string;
-}
-
-export interface IFindCurrentAccountByOwnerIdResponse {
-  payment_date: string;
-  emission_date: string;
-  document_description: string;
-  document_name: string;
-  debit: number;
-  credit: number;
-  notes: ICurrentAccountNotes[];
-  por_regularizar: number;
-  balance: number;
-  href?: string | null;
-}
-
-export interface IUnpaidPurchasesRequest {
-  provider_id: string;
-  client_id: string | null;
-}
-
-export interface IUnpaidByDatePurchasesRequest {
-  due_date: Date;
-}
-
-export type IPaymentOrigin =
-  | 'CC Fornecedor'
-  | 'CC Cliente'
-  | 'CC Fornecedor (Descontinuado)'
-  | 'CC Cliente (Descontinuado)';
-
-export interface IUnpaidPurchasesResponse extends Pick<Entity, 'date' | 'debit' | 'credit'> {
-  document_header: Pick<DocumentHeader, 'emission_date' | 'pdf_link' | 'id'>;
-  origin: IPaymentOrigin;
-  document_type_code: string | null;
-  document_name: string;
-  user?: {
-    user_name: string;
-    provider_id: string;
-    client_id?: string | null;
-  };
-  maturity_days: number;
-  observations: IObservation.IFindByOwnerResponse[];
-}
-
-export interface IProviderPaymentDocument {
-  document_header_id: string;
-  value: number;
-  discount_value?: number | null;
-}
-
-export interface IProviderPaymentRequest {
-  provider_id: string;
-  client_id: string | null;
-  documents: IProviderPaymentDocument[];
-  total: number;
-}
-
-export interface IPaymentsNotExportedRequest {
-  whiteList?: string[];
-}
-
-export interface IPaymentsNotExportedResponse {
-  iban: string;
-  payment_ids: string[];
-  npf_dh: {
-    id: string;
-    name: string;
-    pdf_link: string | null;
-    total: number;
-  }[];
-  provider: string;
-  value: number;
-}
-
-export interface IExportPaymentsRequest {
-  provider: string;
-  value: number;
-  npf_ids?: string[];
-}
-
-export type IBatchType = 'national' | 'international' | 'null';
-
-export interface IPaymentsBatchNpfDh {
-  id: string;
-  name: string;
-  sent: string | null;
-  owner_id: string;
-  owner_number: number;
-  owner_name: string;
-  external_document_header_id: string | null;
-  pdf_link: string | null;
-  total: number;
-}
-
-export interface IPaymentsBatchResponse {
-  batch_id: string;
-  batch_value: number;
-  batch_type: IBatchType | null;
-  multimedia_id: string | null;
-  times_downloaded: number;
-  npf_dh: IPaymentsBatchNpfDh[];
-  updated_at: Date;
-  updated_by: string;
-  created_at: Date;
-}
-
-export const IExportCurrentAccountOutputEnum: {
-  csv: 'csv';
-  pdf: 'pdf';
-} = {
-  csv: 'csv',
-  pdf: 'pdf',
-};
-
-export type IExportCurrentAccountOutput =
-  (typeof IExportCurrentAccountOutputEnum)[keyof typeof IExportCurrentAccountOutputEnum];
-
-export const IExportCurrentAccountOutputOptions = Object.keys(IExportCurrentAccountOutputEnum);
-
-export interface IExportCurrentAccountRequest {
-  token: string;
-  owner_id: string;
-  output: IExportCurrentAccountOutput;
-  start_date: Date | null;
-  end_date: Date | null;
-}
-export interface IFindCurrentAccountPaginatedRequest
-  extends IShared.IFindByOwnerIdRequest,
-    IShared.IPaginationRequest {}
-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>;
-
-  findPaymentsNotExported(
-    params: IPaymentsNotExportedRequest,
-  ): Promise<IPaymentsNotExportedResponse[]>;
-
-  findPaymentBatches(): Promise<IPaymentsBatchResponse[]>;
-
-  deleteBatch(data: IShared.IFindByIdRequest): Promise<void>;
-
-  findCurrentAccountByOwnerId(
-    params: IShared.IFindByOwnerIdRequest,
-  ): Promise<IFindCurrentAccountByOwnerIdResponse[]>;
-
-  findBalanceByOwnerId(params: IShared.IFindByOwnerIdRequest): Promise<number>;
-
-  findSettledMaterialEntrance(params: IUnpaidPurchasesRequest): Promise<IUnpaidPurchasesResponse[]>;
-
-  findSettledMaterialEntranceProviders(): Promise<IUser.IFindProvidersWithClientIdResponse[]>;
-
-  findSettledMaterialEntranceByDate(
-    params: IUnpaidByDatePurchasesRequest,
-  ): Promise<IUnpaidPurchasesResponse[]>;
-
-  createProvidersPayments(params: IProviderPaymentRequest[]): Promise<string[]>;
-
-  exportPayments(params: IExportPaymentsRequest[]): Promise<void>;
-
-  updateDownloadedBatchNumber(id: IShared.IFindByIdRequest): Promise<void>;
-
-  exportCurrentAccount(
-    params: IExportCurrentAccountRequest,
-  ): Promise<IFindCurrentAccountByOwnerIdResponse[]>;
-
-  findCurrentAccountPaginated(
-    params: IFindCurrentAccountPaginatedRequest,
-  ): Promise<IShared.IPaginationResponse<IFindCurrentAccountByOwnerIdResponse>>;
-}
-
-export type IController = IShared.IEntityWithUserToken<IRepository>;

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

@@ -1,122 +0,0 @@
-import joi from 'joi';
-import { messages } from '../../../shared/messages';
-import * as IShared from '../../../shared/interface';
-import {
-  IFindRequest,
-  IFindPaginatedRequest,
-  IUnpaidPurchasesRequest,
-  IProviderPaymentRequest,
-  IExportPaymentsRequest,
-  IExportCurrentAccountRequest,
-  IUnpaidByDatePurchasesRequest,
-  IProviderPaymentDocument,
-  IExportCurrentAccountOutputOptions,
-  IPaymentsNotExportedRequest,
-  IFindCurrentAccountPaginatedRequest,
-} from './interface';
-
-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);
-
-// find settled material entrances
-const findSettledMaterialEntranceQueryKeys: IShared.IRouteRequest<IUnpaidPurchasesRequest> = {
-  provider_id: joi.string().uuid().required(),
-  client_id: joi.string().uuid().allow(null).required(),
-};
-export const findSettledMaterialEntranceQuery = joi
-  .object()
-  .keys(findSettledMaterialEntranceQueryKeys)
-  .messages(messages);
-
-// create provider payment(s)
-const providerPaymentDocumentKeys: IShared.IRouteRequest<IProviderPaymentDocument> = {
-  document_header_id: joi.string().uuid().required(),
-  value: joi.number().required(),
-  discount_value: joi
-    .number()
-    .optional()
-    .allow(0, '', null)
-    .when('value', {
-      is: joi.number().positive(),
-      then: joi.number().max(joi.ref('value')),
-      otherwise: joi.number().min(joi.ref('value')),
-    }),
-};
-const providerPaymentDocument = joi.object().keys(providerPaymentDocumentKeys).required();
-const providerPaymentBodyKeys: IShared.IRouteRequest<IProviderPaymentRequest> = {
-  provider_id: joi.string().uuid().required(),
-  client_id: joi.string().uuid().allow(null).optional(),
-  documents: joi.array().items(providerPaymentDocument).required(),
-  total: joi.number().positive().allow(0).required(),
-};
-export const providerPaymentBody = joi
-  .array()
-  .items(joi.object().keys(providerPaymentBodyKeys))
-  .messages(messages);
-
-// create export payments
-const exportPaymentsBodyKeys: IShared.IRouteRequest<IExportPaymentsRequest> = {
-  value: joi.number().positive().required(),
-  provider: joi.string().required(),
-  npf_ids: joi.array().items(joi.string().uuid().required()).optional(),
-};
-export const exportPaymentsBody = joi
-  .array()
-  .items(joi.object().keys(exportPaymentsBodyKeys))
-  .messages(messages);
-
-// create export payments
-const exportCurrentAccountBetweenDatesQueryKeys: IShared.IRouteRequest<IExportCurrentAccountRequest> =
-  {
-    owner_id: joi.string().required(),
-    output: joi
-      .string()
-      .valid(...IExportCurrentAccountOutputOptions)
-      .required(),
-    start_date: joi.string().optional(),
-    end_date: joi.string().optional(),
-    token: joi.string().required(),
-  };
-export const exportCurrentAccountBetweenDatesQuery = joi
-  .object()
-  .keys(exportCurrentAccountBetweenDatesQueryKeys)
-  .messages(messages);
-
-// find by date
-const findSettledMaterialEntranceBuDateParamsKeys: IShared.IRouteRequest<IUnpaidByDatePurchasesRequest> =
-  {
-    due_date: joi.string().optional(),
-  };
-export const findSettledMaterialEntranceBuDateParams = joi
-  .object()
-  .keys(findSettledMaterialEntranceBuDateParamsKeys)
-  .messages(messages);
-
-export const findPaymentsNotExportedQuery = joi
-  .object<IPaymentsNotExportedRequest>()
-  .keys({
-    whiteList: joi.array().items(joi.string().uuid().required()).optional(),
-  })
-  .messages(messages);
-
-// find with pagination query validation
-const findCurrentAccountWithPaginationQueryKeys: IShared.IRouteRequest<IFindCurrentAccountPaginatedRequest> =
-  {
-    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 findCurrentAccountWithPaginationQuery = joi
-  .object()
-  .keys(findCurrentAccountWithPaginationQueryKeys)
-  .messages(messages);