sinfactura-types 1.5.0 → 1.5.2

package/dist/index.d.ts

@@ -15,6 +15,7 @@ export * from "./maintenance";
 export * from "./mercadopago";
 export * from "./notification";
 export * from "./order";
+export * from "./payment";
 export * from "./product";
 export * from "./return";
 export * from "./stock";

package/dist/index.js

@@ -15,6 +15,7 @@ export * from "./maintenance";
 export * from "./mercadopago";
 export * from "./notification";
 export * from "./order";
+export * from "./payment";
 export * from "./product";
 export * from "./return";
 export * from "./stock";

package/dist/payment.d.ts

@@ -0,0 +1,49 @@
+/**
+ * WebSocket broadcast payload for the `payment_received` action.
+ *
+ * Fired by the API when a "money received" event is persisted across any
+ * of three sources (MP webhook, Stripe webhook, MP movements poller).
+ * Receivers (FE) should:
+ *   1. Render an immediate snackbar toast using `total` + `currency` + `payerName`.
+ *   2. Invalidate RTK Query tags `PaymentReceived` + `PaymentReceivedUnlinked`
+ *      so the canonical row is refetched from `GET /payments/received`.
+ */
+export type PaymentReceivedSource = "mp" | "stripe" | "mp_movement";
+export interface PaymentReceivedWsPayload {
+    source: PaymentReceivedSource;
+    paymentId: string;
+    total: number;
+    currency: string;
+    payerName?: string;
+    paidAt: number;
+    customerId?: string;
+    orderId?: string;
+    invoiceId?: string;
+}
+/**
+ * REST shape of a payment row returned by `GET /payments/received` (api#902).
+ *
+ * Distinct from `PaymentReceivedWsPayload` (api#880, the WS broadcast):
+ *   - This carries denormalized labels (customerName, orderCode, invoiceCode)
+ *     attached server-side at response time so the FE doesn't N+1 fetch.
+ *   - The WS broadcast is the lean live-tail event; this is the canonical row.
+ */
+export interface PaymentReceived {
+    paymentId: string;
+    source: PaymentReceivedSource;
+    total: number;
+    currency: string;
+    payerName?: string;
+    payerEmail?: string;
+    payerCuit?: string;
+    paidAt: number;
+    customerId?: string;
+    customerName?: string;
+    orderId?: string;
+    orderCode?: string;
+    invoiceId?: string;
+    invoiceCode?: string;
+    accountId?: string;
+    linkedAt?: number;
+    linkSource?: "auto" | "manual";
+}

package/dist/payment.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sinfactura-types",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "main": "dist/index.js",
   "type": "module",
   "types": "./dist/index.d.ts",