@nomalism-com/types 0.47.16 → 0.47.17

package/dist/index.cjs

@@ -44,17 +44,17 @@ __export(main_exports, {
   DeliveryMethods: () => interfaces_exports54,
   DeliveryMethodsRoutes: () => route_schema_exports96,
   DocumentHeader: () => interfaces_exports43,
-  DocumentHeaderHistory: () => interfaces_exports44,
+  DocumentHeaderHistory: () => interfaces_exports45,
   DocumentHeaderRoutes: () => route_schema_exports68,
   DocumentHeaderSubscriber: () => interface_exports35,
   DocumentHeaderSubscriberRoutes: () => route_schema_exports69,
-  DocumentHeaderSurvey: () => interfaces_exports45,
+  DocumentHeaderSurvey: () => interfaces_exports46,
   DocumentHeaderSurveyRoutes: () => route_schema_exports70,
-  DocumentLine: () => interfaces_exports46,
-  DocumentLineAssoc: () => interfaces_exports47,
+  DocumentLine: () => interfaces_exports47,
+  DocumentLineAssoc: () => interfaces_exports48,
   DocumentLineMt: () => interface_exports36,
   DocumentLineMtRoutes: () => route_schema_exports72,
-  DocumentLineNote: () => interfaces_exports48,
+  DocumentLineNote: () => interfaces_exports44,
   DocumentLineNoteRoutes: () => route_schema_exports73,
   DocumentLineRm: () => interface_exports37,
   DocumentLineRmRoutes: () => route_schema_exports74,
@@ -3249,6 +3249,28 @@ __export(route_schema_exports68, {
   updateBody: () => updateBody27
 });
 import joi69 from "joi";
+
+// src/modules/supply/documentLineNote/interfaces.ts
+var interfaces_exports44 = {};
+__export(interfaces_exports44, {
+  IDocumentLineNoteTypeEnum: () => IDocumentLineNoteTypeEnum,
+  Route: () => Route77,
+  documentLineNoteTypes: () => documentLineNoteTypes
+});
+var IDocumentLineNoteTypeEnum = {
+  Quebra: "Quebra",
+  Entrada: "Entrada",
+  Compra: "Compra",
+  Devolucao: "Devolucao",
+  Transformado: "Transformado",
+  Inventario: "Inventario",
+  PC: "PC",
+  PF: "PF"
+};
+var documentLineNoteTypes = Object.keys(IDocumentLineNoteTypeEnum);
+var Route77 = "document_line_note";
+
+// src/modules/supply/documentHeader/route.schema.ts
 var createFromHeaderMaturityDate = {
   id: joi69.string().uuid().required(),
   name: joi69.string().required(),
@@ -3343,7 +3365,11 @@ var createFromHeaderBodyKeys = {
   external_document_name: joi69.string().optional(),
   account_code: joi69.string().allow(null, "").empty("").optional(),
   copy_from_document: joi69.string().allow(null, "").empty("").optional(),
-  owner_ref_document: joi69.string().allow(null, "").empty("").optional()
+  owner_ref_document: joi69.string().allow(null, "").empty("").optional(),
+  document_line_note: joi69.object({
+    note: joi69.string().allow("", null).empty("").required(),
+    type: joi69.string().valid(...documentLineNoteTypes).required()
+  }).optional()
 };
 var createFromHeaderBody = joi69.object().keys(createFromHeaderBodyKeys).messages(messages);
 var findQueryKeys11 = {
@@ -3494,18 +3520,18 @@ var findCountByOwnersIdsKeys = {
 var findCountByOwnersIds = joi69.object().keys(findCountByOwnersIdsKeys).messages(messages);
 
 // src/modules/supply/documentHeaderHistory/interfaces.ts
-var interfaces_exports44 = {};
-__export(interfaces_exports44, {
-  Route: () => Route77
+var interfaces_exports45 = {};
+__export(interfaces_exports45, {
+  Route: () => Route78
 });
-var Route77 = "document_header_history";
+var Route78 = "document_header_history";
 
 // src/modules/supply/documentHeaderSubscriber/interface.ts
 var interface_exports35 = {};
 __export(interface_exports35, {
-  Route: () => Route78
+  Route: () => Route79
 });
-var Route78 = "document_header_subscriber";
+var Route79 = "document_header_subscriber";
 
 // src/modules/supply/documentHeaderSubscriber/route.schema.ts
 var route_schema_exports69 = {};
@@ -3520,11 +3546,11 @@ var createBodyKeys32 = {
 var createBody34 = joi70.object().keys(createBodyKeys32).messages(messages);
 
 // src/modules/supply/documentHeaderSurvey/interfaces.ts
-var interfaces_exports45 = {};
-__export(interfaces_exports45, {
-  Route: () => Route79
+var interfaces_exports46 = {};
+__export(interfaces_exports46, {
+  Route: () => Route80
 });
-var Route79 = "document_header_survey";
+var Route80 = "document_header_survey";
 
 // src/modules/supply/documentHeaderSurvey/route.schema.ts
 var route_schema_exports70 = {};
@@ -3551,11 +3577,11 @@ var updateSurveyBodyKeys = {
 var updateSurveyBody = joi71.object().keys(updateSurveyBodyKeys).messages(messages);
 
 // src/modules/supply/documentLine/interfaces.ts
-var interfaces_exports46 = {};
-__export(interfaces_exports46, {
-  Route: () => Route80
+var interfaces_exports47 = {};
+__export(interfaces_exports47, {
+  Route: () => Route81
 });
-var Route80 = "document_line";
+var Route81 = "document_line";
 
 // src/modules/supply/documentLine/route.schema.ts
 var route_schema_exports71 = {};
@@ -3637,18 +3663,18 @@ var updateManyByDocumentHeaderBody = joi72.object().keys({
 });
 
 // src/modules/supply/documentLineAssoc/interfaces.ts
-var interfaces_exports47 = {};
-__export(interfaces_exports47, {
-  Route: () => Route81
+var interfaces_exports48 = {};
+__export(interfaces_exports48, {
+  Route: () => Route82
 });
-var Route81 = "document_line_assoc";
+var Route82 = "document_line_assoc";
 
 // src/modules/supply/documentLineMT/interface.ts
 var interface_exports36 = {};
 __export(interface_exports36, {
-  Route: () => Route82
+  Route: () => Route83
 });
-var Route82 = "document_line_mt";
+var Route83 = "document_line_mt";
 
 // src/modules/supply/documentLineMT/route.schema.ts
 var route_schema_exports72 = {};
@@ -3667,26 +3693,6 @@ var updateKeys = {
 };
 var updateBody29 = joi73.object().keys(updateKeys).messages(messages);
 
-// src/modules/supply/documentLineNote/interfaces.ts
-var interfaces_exports48 = {};
-__export(interfaces_exports48, {
-  IDocumentLineNoteTypeEnum: () => IDocumentLineNoteTypeEnum,
-  Route: () => Route83,
-  documentLineNoteTypes: () => documentLineNoteTypes
-});
-var IDocumentLineNoteTypeEnum = {
-  Quebra: "Quebra",
-  Entrada: "Entrada",
-  Compra: "Compra",
-  Devolucao: "Devolucao",
-  Transformado: "Transformado",
-  Inventario: "Inventario",
-  PC: "PC",
-  PF: "PF"
-};
-var documentLineNoteTypes = Object.keys(IDocumentLineNoteTypeEnum);
-var Route83 = "document_line_note";
-
 // src/modules/supply/documentLineNote/route.schema.ts
 var route_schema_exports73 = {};
 __export(route_schema_exports73, {

package/dist/index.js

@@ -44,17 +44,17 @@ __export(main_exports, {
   DeliveryMethods: () => interfaces_exports54,
   DeliveryMethodsRoutes: () => route_schema_exports96,
   DocumentHeader: () => interfaces_exports43,
-  DocumentHeaderHistory: () => interfaces_exports44,
+  DocumentHeaderHistory: () => interfaces_exports45,
   DocumentHeaderRoutes: () => route_schema_exports68,
   DocumentHeaderSubscriber: () => interface_exports35,
   DocumentHeaderSubscriberRoutes: () => route_schema_exports69,
-  DocumentHeaderSurvey: () => interfaces_exports45,
+  DocumentHeaderSurvey: () => interfaces_exports46,
   DocumentHeaderSurveyRoutes: () => route_schema_exports70,
-  DocumentLine: () => interfaces_exports46,
-  DocumentLineAssoc: () => interfaces_exports47,
+  DocumentLine: () => interfaces_exports47,
+  DocumentLineAssoc: () => interfaces_exports48,
   DocumentLineMt: () => interface_exports36,
   DocumentLineMtRoutes: () => route_schema_exports72,
-  DocumentLineNote: () => interfaces_exports48,
+  DocumentLineNote: () => interfaces_exports44,
   DocumentLineNoteRoutes: () => route_schema_exports73,
   DocumentLineRm: () => interface_exports37,
   DocumentLineRmRoutes: () => route_schema_exports74,
@@ -3249,6 +3249,28 @@ __export(route_schema_exports68, {
   updateBody: () => updateBody27
 });
 import joi69 from "joi";
+
+// src/modules/supply/documentLineNote/interfaces.ts
+var interfaces_exports44 = {};
+__export(interfaces_exports44, {
+  IDocumentLineNoteTypeEnum: () => IDocumentLineNoteTypeEnum,
+  Route: () => Route77,
+  documentLineNoteTypes: () => documentLineNoteTypes
+});
+var IDocumentLineNoteTypeEnum = {
+  Quebra: "Quebra",
+  Entrada: "Entrada",
+  Compra: "Compra",
+  Devolucao: "Devolucao",
+  Transformado: "Transformado",
+  Inventario: "Inventario",
+  PC: "PC",
+  PF: "PF"
+};
+var documentLineNoteTypes = Object.keys(IDocumentLineNoteTypeEnum);
+var Route77 = "document_line_note";
+
+// src/modules/supply/documentHeader/route.schema.ts
 var createFromHeaderMaturityDate = {
   id: joi69.string().uuid().required(),
   name: joi69.string().required(),
@@ -3343,7 +3365,11 @@ var createFromHeaderBodyKeys = {
   external_document_name: joi69.string().optional(),
   account_code: joi69.string().allow(null, "").empty("").optional(),
   copy_from_document: joi69.string().allow(null, "").empty("").optional(),
-  owner_ref_document: joi69.string().allow(null, "").empty("").optional()
+  owner_ref_document: joi69.string().allow(null, "").empty("").optional(),
+  document_line_note: joi69.object({
+    note: joi69.string().allow("", null).empty("").required(),
+    type: joi69.string().valid(...documentLineNoteTypes).required()
+  }).optional()
 };
 var createFromHeaderBody = joi69.object().keys(createFromHeaderBodyKeys).messages(messages);
 var findQueryKeys11 = {
@@ -3494,18 +3520,18 @@ var findCountByOwnersIdsKeys = {
 var findCountByOwnersIds = joi69.object().keys(findCountByOwnersIdsKeys).messages(messages);
 
 // src/modules/supply/documentHeaderHistory/interfaces.ts
-var interfaces_exports44 = {};
-__export(interfaces_exports44, {
-  Route: () => Route77
+var interfaces_exports45 = {};
+__export(interfaces_exports45, {
+  Route: () => Route78
 });
-var Route77 = "document_header_history";
+var Route78 = "document_header_history";
 
 // src/modules/supply/documentHeaderSubscriber/interface.ts
 var interface_exports35 = {};
 __export(interface_exports35, {
-  Route: () => Route78
+  Route: () => Route79
 });
-var Route78 = "document_header_subscriber";
+var Route79 = "document_header_subscriber";
 
 // src/modules/supply/documentHeaderSubscriber/route.schema.ts
 var route_schema_exports69 = {};
@@ -3520,11 +3546,11 @@ var createBodyKeys32 = {
 var createBody34 = joi70.object().keys(createBodyKeys32).messages(messages);
 
 // src/modules/supply/documentHeaderSurvey/interfaces.ts
-var interfaces_exports45 = {};
-__export(interfaces_exports45, {
-  Route: () => Route79
+var interfaces_exports46 = {};
+__export(interfaces_exports46, {
+  Route: () => Route80
 });
-var Route79 = "document_header_survey";
+var Route80 = "document_header_survey";
 
 // src/modules/supply/documentHeaderSurvey/route.schema.ts
 var route_schema_exports70 = {};
@@ -3551,11 +3577,11 @@ var updateSurveyBodyKeys = {
 var updateSurveyBody = joi71.object().keys(updateSurveyBodyKeys).messages(messages);
 
 // src/modules/supply/documentLine/interfaces.ts
-var interfaces_exports46 = {};
-__export(interfaces_exports46, {
-  Route: () => Route80
+var interfaces_exports47 = {};
+__export(interfaces_exports47, {
+  Route: () => Route81
 });
-var Route80 = "document_line";
+var Route81 = "document_line";
 
 // src/modules/supply/documentLine/route.schema.ts
 var route_schema_exports71 = {};
@@ -3637,18 +3663,18 @@ var updateManyByDocumentHeaderBody = joi72.object().keys({
 });
 
 // src/modules/supply/documentLineAssoc/interfaces.ts
-var interfaces_exports47 = {};
-__export(interfaces_exports47, {
-  Route: () => Route81
+var interfaces_exports48 = {};
+__export(interfaces_exports48, {
+  Route: () => Route82
 });
-var Route81 = "document_line_assoc";
+var Route82 = "document_line_assoc";
 
 // src/modules/supply/documentLineMT/interface.ts
 var interface_exports36 = {};
 __export(interface_exports36, {
-  Route: () => Route82
+  Route: () => Route83
 });
-var Route82 = "document_line_mt";
+var Route83 = "document_line_mt";
 
 // src/modules/supply/documentLineMT/route.schema.ts
 var route_schema_exports72 = {};
@@ -3667,26 +3693,6 @@ var updateKeys = {
 };
 var updateBody29 = joi73.object().keys(updateKeys).messages(messages);
 
-// src/modules/supply/documentLineNote/interfaces.ts
-var interfaces_exports48 = {};
-__export(interfaces_exports48, {
-  IDocumentLineNoteTypeEnum: () => IDocumentLineNoteTypeEnum,
-  Route: () => Route83,
-  documentLineNoteTypes: () => documentLineNoteTypes
-});
-var IDocumentLineNoteTypeEnum = {
-  Quebra: "Quebra",
-  Entrada: "Entrada",
-  Compra: "Compra",
-  Devolucao: "Devolucao",
-  Transformado: "Transformado",
-  Inventario: "Inventario",
-  PC: "PC",
-  PF: "PF"
-};
-var documentLineNoteTypes = Object.keys(IDocumentLineNoteTypeEnum);
-var Route83 = "document_line_note";
-
 // src/modules/supply/documentLineNote/route.schema.ts
 var route_schema_exports73 = {};
 __export(route_schema_exports73, {

package/dist/modules/supply/documentHeader/interfaces.d.ts

@@ -1,6 +1,7 @@
 import { DocumentHeader, DocumentHeaderVirtuals, DocumentLineNote, DocumentType, StartDocumentHeaderVirtuals, VatTax } from "../../../shared/entities/stock";
 import * as IShared from "../../../shared/interface";
 import * as IProjectInfo from "../../integration/projectInfo/interfaces";
+import * as IDocumentLineNote from "../documentLineNote/interfaces";
 import * as IDocumentType from "../documentType/interfaces";
 import * as IPayment from "../payment/interface";
 export type Entity = Omit<DocumentHeader, "external_data">;
@@ -133,6 +134,15 @@ export interface ICreateFromHeaderRequest {
     store_operator_id?: string | null;
     copy_from_document?: string | null;
     owner_ref_document?: string | null;
+    /**
+     * Nota opcional a inserir nas linhas selecionadas (from_lines) aquando da
+     * criação do documento. Usada, por exemplo, na transição "Criar Devolução"
+     * (EM -> DF), onde o utilizador introduz uma nota do tipo "Devolucao".
+     */
+    document_line_note?: {
+        note: string;
+        type: IDocumentLineNote.IDocumentLineNoteType;
+    };
 }
 export interface IUpdateRequest {
     external_id?: string | null;

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.47.16",
+  "version": "0.47.17",
   "author": "Nomalism <it.nomalism@gmail.com> (https://nomalism.com/)",
   "license": "UNLICENSED",
   "type": "module",