@nomalism-com/types 0.50.3 → 0.51.1

package/dist/main.d.ts

@@ -6,6 +6,7 @@ import * as NPF from "./modules/document/NPF/interface";
 import * as NRCL from "./modules/document/NRCL/interface";
 import * as Order from "./modules/document/order/interfaces";
 import * as Proforma from "./modules/document/proforma/interfaces";
+import * as PropostaBuilder from "./modules/document/propostaBuilder/interface";
 import * as PropostaFornecedor from "./modules/document/propostaFornecedor/interfaces";
 import * as PropostaSheets from "./modules/document/propostaSheets/interface";
 import * as ProviderCreditNoteFromReturn from "./modules/document/providerCreditNoteFromReturn/interfaces";
@@ -141,4 +142,4 @@ import * as stockErrors from "./shared/errors/stockErrors";
 import * as userErrors from "./shared/errors/userErrors";
 import * as viewErrors from "./shared/errors/viewErrors";
 import * as shared from "./shared/interface";
-export { AccountCode, AdminPanel, AllowedDevice, BankData, BillOfLading, Catalogo, Channel, Chat, ChatRapidMessage, ChatSubscriber, Client, ClientType, CLT, Commissioner, ConferirEncomenda, Country, CurrentAccount, Dashboard, DeliveryMethods, DisplayLabel, DisplayLabels, DocumentHeader, DocumentHeaderHistory, DocumentHeaderSubscriber, DocumentHeaderSurvey, DocumentLine, DocumentLineAssoc, DocumentLineMt, DocumentLineNote, DocumentLineRm, documentManagementErrors, DocumentSet, DocumentType, EmailAccount, EmailLog, EmailTemplate, EmailTemplateAttachment, EmailVerification, ErrorLog, EuPago, ExternalDocumentHeader, ExternalDocumentType, Favorites, File, Gmails, GoogleCalendar, GoogleFilePermission, GoogleSheetPool, GoogleSheets, integrationErrors, Inventario, Language, LLM, Location, MaterialEntrance, MaturityDates, MobilePrint, Multimedia, Npc, NPF, NRCL, Observation, Order, OrderManagement, Password, PatchNotes, Payment, PaymentBatch, PaymentMethods, Persona, PersonaMerge, Portal, PreSale, PreSaleProduct, Printer, Prison, ProductGoogleSheets, ProductImage, ProductLocation, ProductUpdate, Proforma, ProjectInfo, Promotion, PropostaFornecedor, PropostaSheets, ProviderCreditNoteFromReturn, ProviderFinancialCreditNote, Providers, ProviderServiceInvoice, ProviderType, Purchase, PurchaseConditions, Quebra, QueryList, QueryParameter, ReasonForExemption, RecurrentTasks, RefreshToken, ReturnReason, ReturnToProvider, Saft, SavedEmPicking, SavedProviderProposal, Schedule, SchedulePrintJob, SegmentsArea, Sessions, Settings, shared, Shippings, SideMenu, SidemenuHighlight, SmsSender, SmsTemplate, StartDocumentHeaderLastUpdate, stockErrors, StockMovement, StoreOperator, StoreOperatorSaftLock, Swift, SystemModule, Tag, Task, TaskMessage, Tenant, TenantSaftLock, Theme, Tickets, TicketsLanguage, TimeSheet, Transformado, UnitOfMeasure, UpfrontReturn, userErrors, Users, UserTokens, VatTax, VatTaxZone, VatValidation, Vehicles, viewErrors, WebSocket, Workflow, };
+export { AccountCode, AdminPanel, AllowedDevice, BankData, BillOfLading, Catalogo, Channel, Chat, ChatRapidMessage, ChatSubscriber, Client, ClientType, CLT, Commissioner, ConferirEncomenda, Country, CurrentAccount, Dashboard, DeliveryMethods, DisplayLabel, DisplayLabels, DocumentHeader, DocumentHeaderHistory, DocumentHeaderSubscriber, DocumentHeaderSurvey, DocumentLine, DocumentLineAssoc, DocumentLineMt, DocumentLineNote, DocumentLineRm, documentManagementErrors, DocumentSet, DocumentType, EmailAccount, EmailLog, EmailTemplate, EmailTemplateAttachment, EmailVerification, ErrorLog, EuPago, ExternalDocumentHeader, ExternalDocumentType, Favorites, File, Gmails, GoogleCalendar, GoogleFilePermission, GoogleSheetPool, GoogleSheets, integrationErrors, Inventario, Language, LLM, Location, MaterialEntrance, MaturityDates, MobilePrint, Multimedia, Npc, NPF, NRCL, Observation, Order, OrderManagement, Password, PatchNotes, Payment, PaymentBatch, PaymentMethods, Persona, PersonaMerge, Portal, PreSale, PreSaleProduct, Printer, Prison, ProductGoogleSheets, ProductImage, ProductLocation, ProductUpdate, Proforma, ProjectInfo, Promotion, PropostaBuilder, PropostaFornecedor, PropostaSheets, ProviderCreditNoteFromReturn, ProviderFinancialCreditNote, Providers, ProviderServiceInvoice, ProviderType, Purchase, PurchaseConditions, Quebra, QueryList, QueryParameter, ReasonForExemption, RecurrentTasks, RefreshToken, ReturnReason, ReturnToProvider, Saft, SavedEmPicking, SavedProviderProposal, Schedule, SchedulePrintJob, SegmentsArea, Sessions, Settings, shared, Shippings, SideMenu, SidemenuHighlight, SmsSender, SmsTemplate, StartDocumentHeaderLastUpdate, stockErrors, StockMovement, StoreOperator, StoreOperatorSaftLock, Swift, SystemModule, Tag, Task, TaskMessage, Tenant, TenantSaftLock, Theme, Tickets, TicketsLanguage, TimeSheet, Transformado, UnitOfMeasure, UpfrontReturn, userErrors, Users, UserTokens, VatTax, VatTaxZone, VatValidation, Vehicles, viewErrors, WebSocket, Workflow, };

package/dist/modules/document/propostaBuilder/interface.d.ts

@@ -0,0 +1,166 @@
+import * as IShared from "../../../shared/interface";
+import * as IGoogleSheets from "../../integration/googleSheets/interfaces";
+/**
+ * Proposta builder: substitui a MASTER PROPOSTA (Google Sheets) por linhas
+ * guardadas no próprio sistema. O cálculo é feito no backend (stockservice) e
+ * o resultado alimenta o importador de propostas existente (PropostaSheets).
+ */
+export declare const Route = "proposta_builder";
+export declare const groupValues: readonly ["cortinado", "estore", "almofada", "estofo", "papel", "outros", "tapete", "terceiros"];
+export type IGroup = (typeof groupValues)[number];
+/** Chave de importação usada no lugar de `google_sheet_id` (ver PropostaSheets.isProcessing). */
+export declare const BUILDER_IMPORT_KEY_PREFIX = "builder:";
+export type IValue = string | number | null;
+/** Entradas de uma linha de qualquer grupo (chaves do grupo: ver `inputKeysByGroup`). */
+export type IInputs = Partial<Record<string, IValue>>;
+/** Resultado calculado de uma linha de qualquer grupo (chaves do grupo: ver `calcKeysByGroup`). */
+export type ICalc = Record<string, IValue>;
+export declare const cortinadoInputKeys: readonly ["janela", "largura", "altura", "altura_2", "altura_3", "origem_medida", "coef", "molde", "tecido2_coef", "cortina_qtd", "cortina_modelo", "cortina_forro", "cortina_abertura", "cortina_bainha", "cortina_extra", "cortina_notas", "cortina_desconto", "cortina_deslizadores", "cortina_preco_ml_manual", "calha_qtd", "calha_modelo", "calha_sistema", "calha_espacamento", "calha_cordao", "calha_fixacao", "calha_cor", "calha_embelezadores", "calha_cor_acessorios", "calha_notas", "calha_suporte_qtd", "calha_suporte", "calha_suporte_preco", "calha_uniao_qtd", "calha_uniao_preco", "calha_comando_qtd", "calha_comando", "calha_comando_preco", "calha_curva_qtd", "calha_curva_preco", "calha_desconto", "calha_molde", "calha_abertura", "calha_comprimento", "calha_preco_manual", "varao_qtd", "varao_modelo", "varao_cor", "varao_notas", "varao_suporte_qtd", "varao_suporte", "varao_suporte_preco", "varao_terminal_qtd", "varao_terminal", "varao_terminal_preco", "varao_argolas_qtd", "varao_argolas", "varao_argolas_preco", "varao_uniao_qtd", "varao_uniao", "varao_uniao_preco", "varao_desconto", "varao_molde", "varao_preco_manual", "tecido1_ref", "tecido1_preco_m", "tecido1_orientacao", "tecido1_acerto_cv", "tecido1_acerto_ch", "tecido1_desconto", "tecido1_metragem_manual", "tecido1_bh", "tecido1_bl", "tecido2_ref", "tecido2_preco_m", "tecido2_orientacao", "tecido2_acerto_cv", "tecido2_acerto_ch", "tecido2_desconto", "tecido2_metragem_manual", "tecido2_bh", "tecido2_bl"];
+export type ICortinadoInputKey = (typeof cortinadoInputKeys)[number];
+/** Valores introduzidos pela lojista (células brancas do sheet). Chaves em falta = células vazias. */
+export type ICortinadoInputs = Partial<Record<ICortinadoInputKey, IValue>>;
+export declare const cortinadoCalcKeys: readonly ["descricao_cortina", "descricao_calha", "descricao_varao", "descricao_tecido1", "descricao_tecido2", "descricao_cliente", "descricao_producao", "tecido1_nome", "tecido2_nome", "alertas", "cortina_multiplicador", "cortina_preco_ml", "cortina_desconto_valor", "cortina_total", "calha_cortada_a", "calha_preco_un", "calha_desconto_valor", "calha_total", "varao_largura", "varao_preco_un", "varao_desconto_valor", "varao_total", "tecido1_largura", "tecido1_largura_bruta", "tecido1_altura_bruta", "tecido1_alturas_cv", "tecido1_tecido_cv", "tecido1_alturas_ch", "tecido1_tecido_ch", "tecido1_alerta", "tecido1_calculos", "tecido1_metragem_unit", "tecido1_metragem_total", "tecido1_desconto_valor", "tecido1_total", "tecido2_largura", "tecido2_largura_bruta", "tecido2_altura_bruta", "tecido2_alturas_cv", "tecido2_tecido_cv", "tecido2_alturas_ch", "tecido2_tecido_ch", "tecido2_alerta", "tecido2_calculos", "tecido2_metragem_unit", "tecido2_metragem_total", "tecido2_desconto_valor", "tecido2_total", "total_sem_desconto", "desconto_total", "total"];
+export type ICortinadoCalcKey = (typeof cortinadoCalcKeys)[number];
+/** Resultado calculado (células cinzentas do sheet). `null` = célula vazia ou erro (#N/A…). */
+export type ICortinadoCalc = Record<ICortinadoCalcKey, IValue>;
+export declare const estoreInputKeys: readonly ["janela", "largura", "altura", "estore_qtd", "estore_modelo", "estore_tela", "estore_fornecedor", "estore_fixacao", "estore_enrolamento", "estore_base", "estore_cor_acessorios", "estore_poleia", "estore_mola", "estore_lado_corrente", "estore_altura_instalacao", "estore_preco_manual", "motor_qtd", "motor", "motor_posicao", "comando_qtd", "comando", "acessorio_qtd", "acessorio", "estore_notas", "estore_desconto"];
+export type IEstoreInputKey = (typeof estoreInputKeys)[number];
+export type IEstoreInputs = Partial<Record<IEstoreInputKey, IValue>>;
+export declare const estoreCalcKeys: readonly ["descricao_producao", "descricao_cliente", "largura_calculo", "altura_calculo", "estore_preco_un", "motor_preco_un", "comando_preco_un", "acessorio_preco_un", "total_sem_desconto", "desconto_total", "total"];
+export type IEstoreCalcKey = (typeof estoreCalcKeys)[number];
+export type IEstoreCalc = Record<IEstoreCalcKey, IValue>;
+export declare const almofadaInputKeys: readonly ["almofada_qtd", "almofada_modelo", "almofada_largura", "almofada_altura", "almofada_notas", "almofada_desconto", "almofada_preco_manual", "tecido1_ref", "tecido1_preco_m", "tecido1_metragem", "tecido1_uso", "tecido1_desconto", "tecido2_ref", "tecido2_preco_m", "tecido2_metragem", "tecido2_uso", "tecido2_desconto"];
+export type IAlmofadaInputKey = (typeof almofadaInputKeys)[number];
+export type IAlmofadaInputs = Partial<Record<IAlmofadaInputKey, IValue>>;
+export declare const almofadaCalcKeys: readonly ["descricao_cliente", "descricao_producao", "preco_modelo", "confecao_desconto_valor", "confecao_total", "tecido1_desconto_valor", "tecido1_total", "tecido2_desconto_valor", "tecido2_total", "total_sem_desconto", "desconto_total", "total"];
+export type IAlmofadaCalcKey = (typeof almofadaCalcKeys)[number];
+export type IAlmofadaCalc = Record<IAlmofadaCalcKey, IValue>;
+export declare const estofoInputKeys: readonly ["estofo_qtd", "estofo_descricao", "estofo_preco_un", "estofo_desconto", "tecido1_qtd", "tecido1_ref", "tecido1_preco_m", "tecido1_desconto", "tecido2_qtd", "tecido2_ref", "tecido2_preco_m", "tecido2_desconto"];
+export type IEstofoInputKey = (typeof estofoInputKeys)[number];
+export type IEstofoInputs = Partial<Record<IEstofoInputKey, IValue>>;
+export declare const estofoCalcKeys: readonly ["descricao_cliente", "confecao_desconto_valor", "confecao_total", "tecido1_desconto_valor", "tecido1_total", "tecido2_desconto_valor", "tecido2_total", "total_sem_desconto", "desconto_total", "total"];
+export type IEstofoCalcKey = (typeof estofoCalcKeys)[number];
+export type IEstofoCalc = Record<IEstofoCalcKey, IValue>;
+export declare const artigoInputKeys: readonly ["artigo_qtd", "artigo_ref", "artigo_descricao", "artigo_preco_un", "artigo_desconto"];
+export type IArtigoInputKey = (typeof artigoInputKeys)[number];
+export type IArtigoInputs = Partial<Record<IArtigoInputKey, IValue>>;
+export declare const artigoCalcKeys: readonly ["descricao_cliente", "total_sem_desconto", "desconto_total", "total"];
+export type IArtigoCalcKey = (typeof artigoCalcKeys)[number];
+export type IArtigoCalc = Record<IArtigoCalcKey, IValue>;
+export declare const tapeteInputKeys: readonly ["tapete_divisao", "tapete_largura", "tapete_altura", "tapete_diametro", "tapete_qtd", "tapete_modelo", "tapete_cor", "tapete_acabamento", "tapete_emenda", "tapete_notas", "tapete_desconto", "acabamento_extra", "acabamento_extra_cor", "acabamento_extra_desconto", "transporte_especial"];
+export type ITapeteInputKey = (typeof tapeteInputKeys)[number];
+export type ITapeteInputs = Partial<Record<ITapeteInputKey, IValue>>;
+export declare const tapeteCalcKeys: readonly ["descricao_producao", "area_m2", "preco_m2", "tapete_desconto_valor", "tapete_total", "acabamento_extra_ml", "acabamento_extra_preco_ml", "acabamento_extra_desconto_valor", "acabamento_extra_total", "preco_un", "total_sem_desconto", "desconto_total", "total"];
+export type ITapeteCalcKey = (typeof tapeteCalcKeys)[number];
+export type ITapeteCalc = Record<ITapeteCalcKey, IValue>;
+export declare const servicoInputKeys: readonly ["servico_valor", "servico_descricao", "servico_morada"];
+export type IServicoInputKey = (typeof servicoInputKeys)[number];
+export type IServicoInputs = Partial<Record<IServicoInputKey, IValue>>;
+export declare const servicoCalcKeys: readonly ["descricao_noma", "pago_a", "total_sem_desconto", "desconto_total", "total"];
+export type IServicoCalcKey = (typeof servicoCalcKeys)[number];
+export type IServicoCalc = Record<IServicoCalcKey, IValue>;
+/** Chaves de entrada válidas por grupo. */
+export declare const inputKeysByGroup: Record<IGroup, readonly string[]>;
+/** Chaves de cálculo por grupo. */
+export declare const calcKeysByGroup: Record<IGroup, readonly string[]>;
+export type IFieldKind = "text" | "number" | "percent" | "list";
+export interface IFieldDef {
+    key: string;
+    label: string;
+    section: string;
+    kind: IFieldKind;
+    /** chave em `IGroupSchema.lists` quando `kind === "list"` */
+    list?: string;
+    /** false = calculado (cinzento no sheet), readonly na UI */
+    editable: boolean;
+    /** coluna de origem no sheet, só para rastreabilidade */
+    sheet_column: string;
+    default?: string | number;
+}
+export interface ISchemaSection {
+    key: string;
+    label: string;
+}
+export interface ISchemaList {
+    values: string[];
+    /** false = o sheet só avisa (aceita outros valores). */
+    strict: boolean;
+}
+export interface IGroupSchema {
+    group: IGroup;
+    max_lines: number;
+    line_label_prefix: string;
+    /** rótulos próprios das linhas (ex.: serviços "N1".."RM"); sem isto usa-se `line_label_prefix + (n + 1)` */
+    line_labels?: string[];
+    /** posição da 1.ª linha do grupo no `CONFIG!A3:B` do sheet (identidade usada pelo importador) */
+    index_offset: number;
+    sections: ISchemaSection[];
+    fields: IFieldDef[];
+    lists: Record<string, ISchemaList>;
+}
+export interface IFindSchemaRequest {
+    group: IGroup;
+}
+export interface ILineInput {
+    /** posição da linha no grupo (0 = C1). Identidade usada pelo importador. */
+    index: number;
+    inputs: IInputs;
+}
+export interface IFindLinesRequest {
+    document_header_id: string;
+    group: IGroup;
+}
+export interface IFindLinesResponse {
+    lines: ILineInput[];
+}
+export interface ISaveLinesRequest {
+    document_header_id: string;
+    group: IGroup;
+    lines: ILineInput[];
+}
+export interface IPreviewRequest {
+    document_header_id: string;
+    group: IGroup;
+    lines: ILineInput[];
+}
+export interface ILineCalc {
+    index: number;
+    label: string;
+    /** a linha tem pelo menos um valor preenchido */
+    filled: boolean;
+    calc: ICalc;
+    /** problemas que impedem a importação (erro de preço, tecido inexistente…) */
+    errors: string[];
+    /** String Noma equivalente à coluna `CONFIG!B` do sheet (útil para auditoria/paridade) */
+    noma_string: string;
+    products: IGoogleSheets.IGetProduct[];
+}
+export interface ITotals {
+    lines: number;
+    /** soma dos totais sem desconto (com IVA) */
+    total_sem_desconto: number;
+    /** soma dos descontos (com IVA) */
+    desconto_total: number;
+    /** total a pagar (com IVA) */
+    total: number;
+}
+export interface IPreviewResponse {
+    lines: ILineCalc[];
+    totals: ITotals;
+}
+export interface IImportRequest {
+    id: string;
+}
+export interface IImportResponse {
+    document_header_id: string;
+    /** valor a usar em PropostaSheets.isProcessing / estado de importação */
+    import_key: string;
+}
+export interface IRepository {
+    findSchema(params: IFindSchemaRequest): Promise<IGroupSchema>;
+    findLines(params: IFindLinesRequest): Promise<IFindLinesResponse>;
+    saveLines(params: ISaveLinesRequest): Promise<void>;
+    preview(params: IPreviewRequest): Promise<IPreviewResponse>;
+    importToDocument(params: IImportRequest): Promise<IImportResponse>;
+}
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nomalism-com/types",
   "description": "A nomalism package with all necessary types and validations for developing APIs",
-  "version": "0.50.3",
+  "version": "0.51.1",
   "author": "Nomalism <it.nomalism@gmail.com> (https://nomalism.com/)",
   "license": "UNLICENSED",
   "type": "module",
@@ -31,14 +31,14 @@
     "@types/node": "^26.6.5",
     "@typescript-eslint/eslint-plugin": "^8.62.0",
     "@typescript-eslint/parser": "^8.62.0",
-    "eslint": "^10.12.0",
+    "eslint": "^10.13.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-simple-import-sort": "^14.0.0",
     "globals": "^17.13.0",
     "husky": "^9.1.7",
     "lint-staged": "^17.6.0",
     "prettier": "^3.9.10",
-    "tsup": "^8.5.1",
+    "tsup": "^9.0.0",
     "typescript-eslint": "^8.71.2"
   },
   "repository": {