hvp-shared 9.4.0 → 10.0.0

package/dist/contracts/document/requests.d.ts

@@ -50,8 +50,6 @@ export interface CreateDocumentRequest {
     title: string;
     /** Optional — auto-generated from title via slugify if omitted. */
     slug?: string;
-    /** Optional human-readable code (e.g. "PROT-EGO-01"). */
-    code?: string;
     purpose: Purpose;
     type: DocumentType;
     tags?: string[];
@@ -75,7 +73,6 @@ export interface CreateDocumentRequest {
 export interface UpdateDocumentMetadataRequest {
     title?: string;
     slug?: string;
-    code?: string | null;
     purpose?: Purpose;
     type?: DocumentType;
     tags?: string[];

package/dist/contracts/document/responses.d.ts

@@ -28,7 +28,6 @@ export interface PublicDocumentResponse {
     id: string;
     slug: string;
     title: string;
-    code: string | null;
     purpose: Purpose;
     type: DocumentType;
     status: DocumentStatus;
@@ -74,7 +73,6 @@ export interface DocumentSummaryResponse {
     id: string;
     slug: string;
     title: string;
-    code: string | null;
     purpose: Purpose;
     type: DocumentType;
     status: DocumentStatus;

package/dist/contracts/supplier-orders/responses.d.ts

@@ -3,6 +3,10 @@
  */
 /**
  * Stock figures (current / min / optimal) for a single warehouse or aggregated globally.
+ *
+ * Values are expressed in **sale units** (the unit that stock is tracked in:
+ * ml, tablets, individual items). To convert to purchase units (bottle, box,
+ * case), divide by `conversionFactor`.
  */
 export interface SupplierOrderStockFigures {
     currentStock: number;
@@ -10,7 +14,7 @@ export interface SupplierOrderStockFigures {
     optimalStock: number;
 }
 /**
- * Per-warehouse breakdown of stock for a single product.
+ * Per-warehouse breakdown of stock for a single product (in sale units).
  */
 export interface SupplierOrderWarehouseBreakdown extends SupplierOrderStockFigures {
     warehouse: string;
@@ -18,17 +22,40 @@ export interface SupplierOrderWarehouseBreakdown extends SupplierOrderStockFigur
 /**
  * Single product line in the supplier order suggestions response.
  *
- * `suggested` is computed as `max(optimalStock - currentStock, 0)` against the global
- * (cross-warehouse) figures. `suggestedSubtotal` is the line cost without IVA.
+ * Stock and the sale-unit gap are tracked in **sale units**, but the suggested
+ * order quantity is expressed in **purchase units** (bottle, box) — that's how
+ * suppliers actually fulfill orders. The conversion uses `ceil` because you
+ * can't buy 0.9 bottles.
+ *
+ * - `gapSaleUnits` = max(optimalStock - currentStock, 0) (sale units)
+ * - `global.suggested` = ceil(gapSaleUnits / conversionFactor) (purchase units)
+ * - `suggestedSubtotal` = global.suggested × purchaseUnitPrice (MXN, no IVA)
  */
 export interface SupplierOrderItemResponse {
     qvetCode: number;
     name: string;
-    unitPurchasePrice: number;
+    /** Unit in which the supplier sells (e.g. "BOTELLA", "CAJA"). Drives the order quantity. */
+    purchaseUnit: string;
+    /** Unit in which the product is dispensed/sold (e.g. "ML", "PIEZA"). Drives stock figures. */
+    saleUnit: string;
+    /** Sale units contained in one purchase unit (e.g. 100 if a bottle has 100 ml). */
+    conversionFactor: number;
+    /** Price per purchase unit (BI, no IVA). */
+    purchaseUnitPrice: number;
+    /** Price per sale unit (BI, no IVA). Informative — used for granular calculations. */
+    saleUnitPrice: number;
+    /**
+     * Global stock figures across all warehouses, in sale units.
+     * `suggested` here is in **purchase units** (the field used in the order).
+     * `gapSaleUnits` is the raw gap before conversion.
+     */
     global: SupplierOrderStockFigures & {
+        gapSaleUnits: number;
         suggested: number;
     };
+    /** Per-warehouse breakdown (sale units). */
     byWarehouse: SupplierOrderWarehouseBreakdown[];
+    /** Line cost = global.suggested × purchaseUnitPrice (MXN, no IVA). */
     suggestedSubtotal: number;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hvp-shared",
-  "version": "9.4.0",
+  "version": "10.0.0",
   "description": "Shared types and utilities for HVP backend and frontend",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",