@randstad-uca/aws-sns-publisher 1.0.5 → 1.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@randstad-uca/aws-sns-publisher",
-  "version": "1.0.5",
+  "version": "1.0.8",
   "description": "AWS SNS Publisher",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
@@ -10,7 +10,9 @@
   "scripts": {
     "clean": "rimraf build",
     "build": "npm run clean && npx tsc",
-    "pub": "npm version patch && npm run build && npm publish"
+    "test": "echo \"No tests implemented yet\" && exit 0",
+    "prepublishOnly": "npm run test && npm run build",
+    "pub": "npm version patch && npm publish && git push && git push --tags"
   },
   "keywords": [
     "aws",
@@ -18,6 +20,14 @@
     "publisher"
   ],
   "author": "Facundo Brusa",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/randstad-argentina/aws-sns-publisher.git"
+  },
+  "bugs": {
+    "url": "https://github.com/randstad-argentina/aws-sns-publisher/issues"
+  },
+  "homepage": "https://github.com/randstad-argentina/aws-sns-publisher#readme",
   "license": "ISC",
   "publishConfig": {
     "access": "public"

package/readme.md

@@ -0,0 +1,147 @@
+# @randstad-uca/aws-sns-publisher
+
+---
+
+Es una librería ligera desarrollada en Node.js para publicar mensajes a Amazon SNS de forma simple, validada y con logging configurable. Ideal para sistemas desacoplados y orientados a eventos en entornos AWS.
+
+---
+
+## 📦 Instalación
+
+```bash
+npm install @randstad-uca/aws-sns-publisher
+```
+
+---
+
+## 🚀 Uso Básico
+
+```js
+import { SimpleSNSPublisher } from '@randstad-uca/aws-sns-publisher';
+
+const SNSClient = new SimpleSNSPublisher({
+  awsConfig: { region: 'us-east-1' }, // required obj
+  logEnabled: true, // optional (default value: true)
+  logLevel: 'info', // optional (default value: info)
+  throwError: true, // optional (default value: true)
+  logHandler: {
+    // You can implement your own logging handler here (optional)
+    info: (args) =>
+      // success case
+      console.log('Custom success logging handler logic', args),
+    error: (args) =>
+      // error case
+      console.error('Custom error logging handler logic', args),
+  },
+});
+
+const payload = {
+  eventType: 'sms',
+  payload: {
+    phone: '+543564123123',
+    message: 'Hello there!',
+  },
+};
+
+SNSClient.publish({
+  message: JSON.stringify(payload),
+  topicARN: 'arn:aws:sns:us-east-1:575108923687:t-notifications-dev',
+})
+  .then((result) => console.log('Success:', result))
+  .catch((err) => console.error('Error:', err));
+```
+
+---
+
+## 📘 API
+
+#### Clase: `SimpleSNSPublisher`
+
+##### Constructor
+```js
+new SimpleSNSPublisher(options: IPublisherOptions)
+```
+
+`IPublisherOptions:`
+
+- `awsConfig: SNSClientConfig` – **Requerido**. Como minimo se debe especificar la región de AWS para instanciar el cliente SNS.
+
+- `logEnabled?: boolean` – Habilita logs. Default: `true`.
+
+- `logLevel?: 'info' | 'silent'` – Nivel de log. Default: `'info'`.
+
+- `throwError?: boolean` – Si lanzar errores o no. Default: `true`.
+
+- `logHandler?: { info: Function; error: Function }` – Handler personalizado para logs.
+
+---
+
+## ✨ Metodos
+
+#### Método: `publish(options: IPublishOptions): Promise<PublishResponse>`
+
+Publica un mensaje en un topic SNS. Antes de enviar el mensaje, se valida su estructura usando la libreria `Joi`.
+
+`IPublishOptions`:
+
+- `message: string` – Debe ser un string que contenga un objeto, y este **debe** tener las siguientes propiedades:
+
+    - `eventType: string` – Tipo del evento (ej: `"sms"`, `"add-personal-data"` o cualquiera que se encuentre dentro del objeto ***validEventTypes*** ubicado en el archivo `constants.ts`).
+
+    - `payload: object` – Objeto con los datos del evento.
+
+- `topicARN: string` – ARN del SNS Topic.
+
+- `apiName?: string` – Nombre de la API emisora, las unicas validas son las que se encuentran dentro del objeto ***validApiNames*** ubicado en el archivo `constants.ts`. Esta se utiliza como bandera para la creación del MessageDeduplicationId y MessageGroupId necesarios en topics FIFO.
+
+- `extraOptions?: object` – Parámetros adicionales para `PublishCommand`.
+
+**Validaciones automáticas:**
+
+- `eventType` es obligatorio y debe estar en la lista de eventos válidos.
+
+- Se valida el `payload` según el tipo de evento con esquemas Joi definidos internamente.
+
+- Si se configura `throwError: true`, lanza error. Si no, devuelve `Promise.reject()` con el error.
+
+
+#### Método: `validateSchema(eventType: string, payload: object): boolean`
+
+Valida el `payload` contra el esquema correspondiente según eventType.
+
+---
+
+### 📎 Ejemplo de payload válido
+
+```json
+{
+  "eventType": "email",
+  "payload": {
+    "to": "user@example.com",
+    "subject": "Hello!",
+    "body": "This is an example email."
+  }
+}
+```
+
+---
+
+🧩 Características
+
+- ✅ Compatible con múltiples regiones AWS.
+
+- ✅ Validación automática con Joi.
+
+- ✅ Logging personalizable (info y error).
+
+- ✅ Ideal para arquitectura orientada a eventos.
+
+---
+
+📌 Consideraciones
+
+- Se espera que los topics estén previamente creados en SNS.
+
+- Esta librería no crea los topics automáticamente.
+
+- En caso de usar topics FIFO, es importante pasar un `apiName` **valido** para deduplicación.