@begapp/sdk 2.0.0 → 2.1.0

package/README.md

@@ -2,9 +2,52 @@
 
 Librería cliente para consumir los servicios de BegaApp desde cualquier aplicación externa. Permite configurar la API Key y consumir fácilmente endpoints.
 
+## Audiencia dinámica
+
+Los avisos estáticos mantienen la firma existente:
+
+```js
+await crearNotificacionBegaApp('RECEPCION_CREADA', data);
+```
+
+Para un aviso dinámico, la aplicación origen identifica al destinatario usando
+su identidad externa. Bega resuelve el vínculo y valida que el usuario esté
+autorizado en la definición del aviso:
+
+```js
+await crearNotificacionBegaApp('RECEPCION_ELIMINADA', data, {
+  recipients: {
+    users: [{ source: 'easy-bodega', externalId: creadorId }]
+  },
+  context: {
+    actor: { source: 'easy-bodega', externalId: usuarioActualId }
+  }
+});
+```
+
+Las mismas opciones están disponibles como cuarto argumento de
+`crearNotificacionFileBegaApp(codigoAviso, data, files, options)`.
+
+### Suprimir el correo en una ejecución
+
+Si el aviso tiene correo habilitado en Bega, la aplicación origen puede decidir
+que una ejecución concreta se entregue solo por chat y campanita:
+
+```js
+await crearNotificacionBegaApp('RECEPCION_ACTUALIZADA', data, {
+  delivery: { email: false }
+});
+```
+
+Omitir `delivery.email` conserva el comportamiento configurado en Bega. Enviar
+`true` no habilita el correo si la definición del aviso lo tiene desactivado.
+
+Durante la transición el servidor también acepta el `ObjectId` histórico, pero
+las integraciones nuevas deben usar el código estable configurado en Bega.
+
 ---
 
 ## 🚀 Instalación
 
 ```bash
-npm install @begaapp/sdk
+npm install @begaapp/sdk

package/package.json

@@ -1,11 +1,16 @@
 {
   "name": "@begapp/sdk",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "SDK para interactuar con el servicio de notificaciones de Bega App",
   "main": "index.js",
   "type": "module",
+  "files": [
+    "index.js",
+    "src",
+    "README.md"
+  ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "node --test"
   },
   "keywords": [],
   "author": "Bega App",

package/src/notificaciones.js

@@ -1,27 +1,42 @@
 import { getClient } from './client.js';
 
-export async function crearNotificacionBegaApp(id, data) {
-    try {
-        if (!id || typeof data !== 'object') {
-            throw new Error("crearNotificacion requiere un ID y un objeto data.");
-        }
+function buildNotificationPayload(identifier, data, options = {}) {
+    if (!identifier || !data || typeof data !== 'object' || Array.isArray(data)) {
+        throw new Error("crearNotificacion requiere un identificador y un objeto data.");
+    }
+    // `id` se conserva durante la transición para servidores SDK anteriores.
+    const payload = { identifier, id: identifier, data };
+    if (options.context) payload.context = options.context;
+    if (options.recipients) payload.recipients = options.recipients;
+    if (options.delivery) payload.delivery = options.delivery;
+    if (options.attachments) payload.attachments = options.attachments;
+    return payload;
+}
 
+function sdkError(error) {
+    return {
+        status: "error",
+        code: error.response?.data?.code,
+        message: error.response?.data?.message || error.message,
+        details: error.response?.data?.details
+    };
+}
+
+export async function crearNotificacionBegaApp(identifier, data, options = {}) {
+    try {
         const client = getClient();
-        const res = await client.post("/notification/create-notification", {
-            id,
-            data,
-        });
+        const res = await client.post("/notification/create-notification", buildNotificationPayload(identifier, data, options));
 
         return { status: "success", data: res.data };
     } catch (error) {
-        return { status: "error", message: error.message }
+        return sdkError(error);
     }
 }
 
-export async function crearNotificacionFileBegaApp(id, data, files) {
+export async function crearNotificacionFileBegaApp(identifier, data, files, options = {}) {
     try {
-        if (!id || typeof data !== 'object') {
-            throw new Error("crearNotificacionFileBegaApp requiere un ID y un objeto data.");
+        if (!identifier || typeof data !== 'object') {
+            throw new Error("crearNotificacionFileBegaApp requiere un identificador y un objeto data.");
         }
 
         if (!files || files.length <= 0) {
@@ -36,7 +51,7 @@ export async function crearNotificacionFileBegaApp(id, data, files) {
                 const form = new FormData();
                 form.append('file', file, `${name}.pdf`);
                 form.append('meta', JSON.stringify({ generatedAt: new Date().toISOString() }));
-                form.append('id', id);
+                form.append('id', identifier);
 
                 console.log("ASÍ ESTOY ARMANDO EL FORM: ", form);
 
@@ -63,14 +78,12 @@ export async function crearNotificacionFileBegaApp(id, data, files) {
 
         console.log("ESTE ES MI ATTACHMENTS: ", attachments);
 
-        const res = await client.post("/notification/create-notification", {
-            id,
-            attachments,
-            data,
-        });
+        const res = await client.post("/notification/create-notification", buildNotificationPayload(identifier, data, { ...options, attachments }));
 
         return { status: "success", data: res.data };
     } catch (error) {
-        return { status: "error", message: error.message }
+        return sdkError(error);
     }
-}
+}
+
+export { buildNotificationPayload };