@nomalism-com/types 0.33.88 → 0.34.2

package/src/modules/document/propostaFornecedor/interfaces.ts

@@ -0,0 +1,17 @@
+import * as IShared from '../../../shared/interface';
+
+export interface IProviderProposalData {
+  product_id: string;
+  quantity: number;
+}
+
+export interface IProviderProposalRequest {
+  provider_id: string;
+  data: IProviderProposalData[];
+}
+
+export interface IRepository {
+  createProviderProposal(data: IProviderProposalRequest): Promise<string>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/document/propostaFornecedor/route.schema.ts

@@ -0,0 +1,21 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { IProviderProposalRequest, IProviderProposalData } from './interfaces';
+
+const providerProposalData: IShared.IRouteRequest<IProviderProposalData> = {
+  product_id: joi.string().uuid().required(),
+  quantity: joi.number().required(),
+};
+
+const providerPRoposalBodyKeys: IShared.IRouteRequest<IProviderProposalRequest> = {
+  provider_id: joi.string().uuid().required(),
+  data: joi
+    .array()
+    .items({
+      ...providerProposalData,
+    })
+    .required(),
+};
+
+export const providerProposalBody = joi.object().keys(providerPRoposalBodyKeys).messages(messages);

package/src/modules/document/propostaSheets/interface.ts

@@ -0,0 +1,113 @@
+import * as IShared from '../../../shared/interface';
+import { DocumentLinePendingConflict, DocumentLine } from '../../../shared/entities';
+
+export type Entity = DocumentLinePendingConflict;
+
+export const Route = 'documentLine_pending_conflict';
+export const UpperName = 'DocumentLinePendingConflict';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export const IConflictEnum: {
+  update: 'update';
+  delete: 'delete';
+  price: 'price';
+} = {
+  update: 'update',
+  delete: 'delete',
+  price: 'price',
+};
+export type IConflict = (typeof IConflictEnum)[keyof typeof IConflictEnum];
+export interface IFindByGooglesheetIdResponse {
+  document_header_id: string;
+}
+
+export type IConflictCreateRequest = Omit<
+  Entity,
+  'id' | 'created_at' | 'created_by' | 'updated_at' | 'updated_by'
+>;
+
+export interface IConflictFindByOwnerIdResponse extends Entity {
+  document_line: Pick<DocumentLine, 'preco_venda' | 'client_discount' | 'quantity'> & {
+    designation: string;
+    reference: string;
+  };
+}
+
+export interface ICreateSheetFromDocumentResponse {
+  google_sheet_id: string;
+}
+
+export interface ICloneSheetToNewDocumentResponse {
+  id: string;
+  document_number: number;
+}
+
+export interface IIsProcessingResponse {
+  is_processing: boolean;
+  last_error: string | null;
+}
+
+export interface ICloneSheetToNewDocumentRequest {
+  id: string;
+}
+
+export interface IImportFromSheetRequest {
+  id: string;
+  original_document_header_id?: string;
+}
+
+export interface IRmHeaderField {
+  group: string;
+  field: string;
+  label: string;
+  type?: string;
+  options?: string[];
+}
+
+export type IData = Record<string, IDataBySheetId | undefined>;
+export interface IDataBySheetId {
+  group: string;
+  field_name: string;
+  value: string | number | boolean | null;
+}
+export interface IRmGetDataBySheetIdResponse {
+  headers: IRmHeaderField[];
+  data: IData[];
+}
+
+export interface IRmUpdateDataBySheetIdRequest {
+  data: IData[];
+}
+
+export interface IRepository {
+  importFromSheet(params: IImportFromSheetRequest): Promise<IFindByGooglesheetIdResponse>;
+
+  isProcessing(params: IShared.IFindByIdRequest): Promise<IIsProcessingResponse>;
+
+  conflictAccept(params: IShared.IFindByIdRequest): Promise<void>;
+
+  conflictDelete(params: IShared.IFindByIdRequest): Promise<void>;
+
+  conflictFindByOwnerId(
+    params: IShared.IFindByOwnerIdRequest,
+  ): Promise<IConflictFindByOwnerIdResponse[]>;
+
+  rmGetDataBySheetId(params: IShared.IFindByIdRequest): Promise<IRmGetDataBySheetIdResponse>;
+
+  rmUpdateDataBySheetId(
+    params: IShared.IFindByIdRequest,
+    body: IRmUpdateDataBySheetIdRequest,
+  ): Promise<void>;
+}
+
+export interface IApi extends IRepository {
+  createSheetFromDocument(
+    params: IShared.IFindByIdRequest,
+  ): Promise<ICreateSheetFromDocumentResponse>;
+
+  cloneSheetToNewDocument(
+    params: ICloneSheetToNewDocumentRequest,
+  ): Promise<ICloneSheetToNewDocumentResponse>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/document/propostaSheets/route.schema.ts

@@ -0,0 +1,45 @@
+import joi from 'joi';
+
+import * as IShared from '../../../shared/interface';
+import { messages } from '../../../shared/messages';
+import {
+  ICloneSheetToNewDocumentRequest,
+  IRmUpdateDataBySheetIdRequest,
+  IImportFromSheetRequest,
+} from './interface';
+
+export const importFromSheetKeys = joi
+  .object<IImportFromSheetRequest>()
+  .keys({
+    id: joi.string().required(),
+    original_document_header_id: joi.string().uuid().optional(),
+  })
+  .messages(messages);
+
+// find by google sheet id validation
+const findByGoogleSheetIdKeys: IShared.IRouteRequestWithStamps<IShared.IFindByIdRequest> = {
+  id: joi.string().required(),
+};
+export const findByGoogleSheetId = joi.object().keys(findByGoogleSheetIdKeys).messages(messages);
+
+export const cloneSheetToNewDocumentQuery = joi.object<ICloneSheetToNewDocumentRequest>().keys({
+  id: joi.string().uuid().required(),
+});
+
+// Validação para lidar com o valor e campos de entrada dinâmicos
+export const rmUpdateDataByDocumentLineIdValidation = joi
+  .object<IRmUpdateDataBySheetIdRequest>()
+  .keys({
+    data: joi
+      .array()
+      .items(
+        joi
+          .object({
+            filed_name: joi.string().required(),
+            value: joi.alternatives().try(joi.string(), joi.number(), joi.boolean()).required(),
+          })
+          .required(),
+      )
+      .required(),
+  })
+  .messages(messages);

package/src/modules/document/providerCreditNoteFromReturn/interfaces.ts

@@ -0,0 +1,48 @@
+import * as IShared from '../../../shared/interface';
+
+export interface IFindProviderReturnRequest {
+  provider_id: string;
+  search_value?: string | null;
+}
+
+export interface IFindProviderReturnOptionValue {
+  document_line_id: string;
+  product_id: string;
+  product_thumbnail: string | null;
+  product_reference: string;
+  product_designation: string;
+  quantity: number;
+  unit_of_measure_quantity_notation: string;
+  provider_total_without_tax: number;
+  provider_total: number;
+}
+
+export interface IFindProviderReturnResponse {
+  id: string; // document_header_id
+  label: string; // document_name
+  value: IFindProviderReturnOptionValue[];
+}
+
+export interface ICreateProviderCreditNoteFromReturnDocumentHeaders {
+  id: string;
+  document_line_ids: string[];
+}
+
+export interface ICreateProviderCreditNoteFromReturnRequest {
+  emission_date: Date;
+  external_document_name: string;
+  observations: string;
+  document_headers: ICreateProviderCreditNoteFromReturnDocumentHeaders[];
+  acerto: number;
+  total: number;
+}
+
+export interface IRepository {
+  findProviderReturn(params: IFindProviderReturnRequest): Promise<IFindProviderReturnResponse[]>;
+
+  createProviderCreditNoteFromReturn(
+    params: ICreateProviderCreditNoteFromReturnRequest,
+  ): Promise<void>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/document/providerCreditNoteFromReturn/route.schema.ts

@@ -0,0 +1,41 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import {
+  IFindProviderReturnRequest,
+  ICreateProviderCreditNoteFromReturnDocumentHeaders,
+  ICreateProviderCreditNoteFromReturnRequest,
+} from './interfaces';
+
+const findProviderReturnQueryKeys: IShared.IRouteRequest<IFindProviderReturnRequest> = {
+  search_value: joi.string().allow('', null).optional(),
+  provider_id: joi.string().uuid().required(),
+};
+export const findProviderReturnQuery = joi
+  .object()
+  .keys(findProviderReturnQueryKeys)
+  .messages(messages);
+
+const createProviderCreditNoteFromReturnDocumentHeadersBodyKeys: IShared.IRouteRequest<ICreateProviderCreditNoteFromReturnDocumentHeaders> =
+  {
+    id: joi.string().uuid().required(),
+    document_line_ids: joi.array().unique().items(joi.string().uuid().required()).required(),
+  };
+const createProviderCreditNoteFromReturnBodyKeys: IShared.IRouteRequest<ICreateProviderCreditNoteFromReturnRequest> =
+  {
+    emission_date: joi.date().required(),
+    external_document_name: joi.string().required(),
+    observations: joi.string().allow(null, '').required(),
+    document_headers: joi
+      .array()
+      .items(
+        joi.object().keys(createProviderCreditNoteFromReturnDocumentHeadersBodyKeys).required(),
+      )
+      .required(),
+    acerto: joi.number().required(),
+    total: joi.number().positive().required(),
+  };
+export const createProviderCreditNoteFromReturnBody = joi
+  .object()
+  .keys(createProviderCreditNoteFromReturnBodyKeys)
+  .messages(messages);

package/src/modules/document/providerFinancialCreditNote/interfaces.ts

@@ -0,0 +1,36 @@
+import * as IShared from '../../../shared/interface';
+
+export interface IFindProviderInvoiceRequest {
+  provider_id: string;
+  search_value?: string | null;
+}
+
+export interface IFindProviderInvoiceResponse {
+  id: string; // invoice document_header_id
+  label: string; // invoice external_document_name
+  value: number; // invoice grand total
+}
+
+export interface IValueByVatTax {
+  taxPercentage: number;
+  total: number;
+}
+
+export interface ICreateProviderFinancialCreditNoteRequest {
+  external_document_name: string;
+  provider_id: string;
+  parent_document_header_id: string | null;
+  emission_date: Date;
+  observations: string;
+  values: IValueByVatTax[];
+}
+
+export interface IRepository {
+  findProviderInvoice(params: IFindProviderInvoiceRequest): Promise<IFindProviderInvoiceResponse[]>;
+
+  createProviderFinancialCreditNote(
+    params: ICreateProviderFinancialCreditNoteRequest,
+  ): Promise<void>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/document/providerFinancialCreditNote/route.schema.ts

@@ -0,0 +1,40 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import {
+  IFindProviderInvoiceRequest,
+  IValueByVatTax,
+  ICreateProviderFinancialCreditNoteRequest,
+} from './interfaces';
+
+const findProviderInvoiceQueryKeys: IShared.IRouteRequest<IFindProviderInvoiceRequest> = {
+  search_value: joi.string().allow('', null).optional(),
+  provider_id: joi.string().uuid().required(),
+};
+export const findProviderInvoiceQuery = joi
+  .object()
+  .keys(findProviderInvoiceQueryKeys)
+  .messages(messages);
+
+const valueByVatTaxKeys: IShared.IRouteRequest<IValueByVatTax> = {
+  taxPercentage: joi.number().positive().allow(0).required(),
+  total: joi.number().positive().required(),
+};
+
+const createProviderFinancialCreditNoteBodyKeys: IShared.IRouteRequest<ICreateProviderFinancialCreditNoteRequest> =
+  {
+    emission_date: joi.date().required(),
+    external_document_name: joi.string().required(),
+    provider_id: joi.string().uuid().required(),
+    parent_document_header_id: joi.string().uuid().optional().allow(null, ''),
+    observations: joi.string().allow(null, '').required(),
+    values: joi
+      .array()
+      .unique('taxPercentage')
+      .items(joi.object().keys(valueByVatTaxKeys).required())
+      .required(),
+  };
+export const createProviderFinancialCreditNoteBody = joi
+  .object()
+  .keys(createProviderFinancialCreditNoteBodyKeys)
+  .messages(messages);

package/src/modules/document/providerServiceInvoice/interfaces.ts

@@ -0,0 +1,20 @@
+import * as IShared from '../../../shared/interface';
+
+export interface IValueByVatTax {
+  taxPercentage: number;
+  total: number;
+}
+
+export interface ICreateProviderServiceInvoiceRequest {
+  provider_id: string;
+  external_document_name: string;
+  emission_date: Date;
+  observations: string;
+  values: IValueByVatTax[];
+}
+
+export interface IRepository {
+  createProviderServiceInvoice(params: ICreateProviderServiceInvoiceRequest): Promise<void>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/document/providerServiceInvoice/route.schema.ts

@@ -0,0 +1,26 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { type ICreateProviderServiceInvoiceRequest, type IValueByVatTax } from './interfaces';
+
+const valueByVatTaxKeys: IShared.IRouteRequest<IValueByVatTax> = {
+  taxPercentage: joi.number().positive().allow(0).required(),
+  total: joi.number().positive().required(),
+};
+
+const createProviderServiceInvoiceBodyKeys: IShared.IRouteRequest<ICreateProviderServiceInvoiceRequest> =
+  {
+    provider_id: joi.string().uuid().required(),
+    emission_date: joi.date().required(),
+    external_document_name: joi.string().required(),
+    observations: joi.string().allow(null, '').required(),
+    values: joi
+      .array()
+      .unique('taxPercentage')
+      .items(joi.object().keys(valueByVatTaxKeys).required())
+      .required(),
+  };
+export const createProviderServiceInvoiceBody = joi
+  .object()
+  .keys(createProviderServiceInvoiceBodyKeys)
+  .messages(messages);

package/src/modules/document/purchase/interfaces.ts

@@ -0,0 +1,112 @@
+import * as IShared from '../../../shared/interface';
+import { DocumentLineNote } from '../../../shared/entities';
+
+export const Route = 'purchase';
+export const UpperName = 'Purchase';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export type IUnpaidMaterialEntranceLineType = 'Por comprar' | 'Comprado' | 'Devolvido' | 'Prisão';
+
+export interface IUnpaidMaterialEntranceLineDetails {
+  document_line_id: string;
+  quantity: number;
+  notes: DocumentLineNote[];
+  pc_name: string | null;
+  pc_id: string | null;
+}
+
+export interface IUnpaidMaterialEntranceLineResponse {
+  group: string;
+  document_line_ids: string[];
+  product_id: string;
+  reference: string;
+  designation: string;
+  multimedia_id: string | null;
+  provider_ref: string | null;
+  pf_id: string;
+  ef_name: string;
+  quantity: number;
+  discount: number;
+  provider_purchase_discount: number;
+  provider_tax_value: number;
+  client_tax_value: number;
+  global_discount: number;
+  preco_custo: number;
+  preco_venda: number;
+  margin: number | null;
+  total_without_tax: number;
+  total: number;
+  types: IUnpaidMaterialEntranceLineType[];
+  created_by: string;
+  created_at: Date;
+  details: IUnpaidMaterialEntranceLineDetails[];
+  consignacao: boolean;
+}
+
+export interface IUnpaidMaterialEntranceItemResponse {
+  name: string;
+  lines: IUnpaidMaterialEntranceLineResponse[];
+}
+
+export interface IUnpaidMaterialEntranceResponse {
+  entradaMaterial: IUnpaidMaterialEntranceItemResponse[];
+}
+
+export interface IPurchaseFromProviderShipping {
+  product_id: string;
+  price: number;
+}
+
+export interface IPurchaseFromProviderAdjustment {
+  value: number; // (pode ser negativo)
+}
+
+export interface IPurchaseFromProviderTaxRetention {
+  value: number;
+}
+
+export interface IPurchaseFromProviderRequest {
+  invoice_number: string;
+  invoice_emission_date: Date;
+  invoice_due_date: Date;
+  document_line_ids: string[];
+  global_discount?: number | null;
+  shipping?: IPurchaseFromProviderShipping;
+  adjustment?: IPurchaseFromProviderAdjustment;
+  tax_retention?: IPurchaseFromProviderTaxRetention;
+  note?: string;
+  vat_self_accounting?: boolean;
+  purchase_without_invoice: boolean;
+}
+
+export interface ISyncRequest {
+  provider_id: string;
+  document_line_ids: string[];
+}
+
+export interface ISyncLines {
+  document_line_id: string;
+  preco_custo: number;
+}
+
+export interface ISyncResponse {
+  provider_discount: number;
+  provider_tax: number;
+  lines: ISyncLines[];
+}
+
+export interface IRepository {
+  findUnpaidMaterialEntrance(
+    selector: IShared.IFindByIdRequest,
+  ): Promise<IUnpaidMaterialEntranceResponse>;
+
+  findUnpaidMaterialEntranceProviders(): Promise<IShared.IFindMinifiedResponse[]>;
+
+  purchaseFromProvider(data: IPurchaseFromProviderRequest): Promise<void>;
+
+  sync(data: ISyncRequest): Promise<ISyncResponse>;
+}
+
+export type IApi = IRepository;
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/document/purchase/route.schema.ts

@@ -0,0 +1,51 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+
+import {
+  IPurchaseFromProviderRequest,
+  ISyncRequest,
+  IPurchaseFromProviderShipping,
+  IPurchaseFromProviderAdjustment,
+  IPurchaseFromProviderTaxRetention,
+} from './interfaces';
+
+const purchaseFromProviderBodyKeys: IShared.IRouteRequest<IPurchaseFromProviderRequest> = {
+  invoice_number: joi.string().required(),
+  invoice_emission_date: joi.date().required(),
+  invoice_due_date: joi.date().required(),
+  document_line_ids: joi.array().items(joi.string().required()).required(),
+  global_discount: joi.number().min(0).max(100).allow(null).optional(),
+  shipping: joi
+    .object<IPurchaseFromProviderShipping>()
+    .keys({
+      product_id: joi.string().required(),
+      price: joi.number().allow(0).positive().required(),
+    })
+    .optional(),
+  adjustment: joi
+    .object<IPurchaseFromProviderAdjustment>()
+    .keys({
+      value: joi.number().required(),
+    })
+    .optional(),
+  tax_retention: joi
+    .object<IPurchaseFromProviderTaxRetention>()
+    .keys({
+      value: joi.number().allow(0).positive().required(),
+    })
+    .optional(),
+  note: joi.string().allow('', null).optional(),
+  vat_self_accounting: joi.boolean().optional(),
+  purchase_without_invoice: joi.boolean().required(),
+};
+
+export const purchaseFromProviderBody = joi
+  .object()
+  .keys(purchaseFromProviderBodyKeys)
+  .messages(messages);
+
+export const syncBody = joi.object<ISyncRequest>().keys({
+  document_line_ids: joi.array().items(joi.string().uuid().required()).required(),
+  provider_id: joi.string().uuid().required(),
+});

package/src/modules/document/quebra/interfaces.ts

@@ -0,0 +1,46 @@
+import { DocumentLineNote } from '../../../shared/entities';
+import * as IShared from '../../../shared/interface';
+
+export const Route = 'quebra';
+export const UpperName = 'Quebra';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface IInventoryLossResponse {
+  document_line_id: string;
+  id_provider: number;
+  product_id: string;
+  product_thumbnail: string;
+  product_reference: string;
+  product_description: string;
+  quantity: number;
+  unit_of_measure_quantity_notation: string;
+  notes: DocumentLineNote[];
+  updated_by: string | null;
+  updated_at: Date;
+}
+
+export interface ICreateManyProducts {
+  id: string;
+  quantity: number;
+  note?: string;
+}
+
+export interface ICreateManyRequest {
+  products: ICreateManyProducts[];
+}
+
+export interface IDeleteInventoryLossRequest {
+  document_line_ids: string[];
+}
+
+export interface IRepository {
+  findInventoryLosses(): Promise<IInventoryLossResponse[]>;
+
+  findInventoryLossesProviders(): Promise<IShared.IFindMinifiedResponse[]>;
+
+  createMany(data: ICreateManyRequest): Promise<string>;
+
+  deleteInventoryLosses(data: IDeleteInventoryLossRequest): Promise<void>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/document/quebra/route.schema.ts

@@ -0,0 +1,25 @@
+import joi from 'joi';
+
+import * as IShared from '../../../shared/interface';
+import { messages } from '../../../shared/messages';
+import { ICreateManyProducts, ICreateManyRequest, IDeleteInventoryLossRequest } from './interfaces';
+
+const productsCreateQuebraKeys: IShared.IRouteRequestWithStamps<ICreateManyProducts> = {
+  id: joi.string().uuid().required(),
+  quantity: joi.number().positive().required(),
+  note: joi.string().optional(),
+};
+
+const createQuebraKeys: IShared.IRouteRequestWithStamps<ICreateManyRequest> = {
+  products: joi.array().items(joi.object().keys(productsCreateQuebraKeys)).min(1).required(),
+};
+export const createQuebraBody = joi.object().keys(createQuebraKeys).messages(messages);
+// inventoryLossRequest
+const deleteInventoryLossBodyKeys: IShared.IRouteRequest<IDeleteInventoryLossRequest> = {
+  document_line_ids: joi.array().items(joi.string().uuid().required()).required(),
+};
+
+export const deleteInventoryLossBody = joi
+  .object()
+  .keys(deleteInventoryLossBodyKeys)
+  .messages(messages);