@randstad-uca/aws-sns-publisher 1.2.2 → 1.2.4

package/build/constants.d.ts

@@ -32,6 +32,7 @@ export declare const validEventTypes: {
     push: string;
     addUserIdentity: string;
     deleteOneSignalUser: string;
+    customEvents: string;
 };
 export declare const validDocumentStatus: {
     enviado: string;

package/build/constants.js

@@ -35,6 +35,7 @@ exports.validEventTypes = {
     push: 'push',
     addUserIdentity: 'add-user-identity',
     deleteOneSignalUser: 'delete-one-signal-user',
+    customEvents: 'custom-events',
 };
 exports.validDocumentStatus = {
     enviado: 'enviado',

package/build/generate-schema-doc.js

@@ -21,6 +21,7 @@ const push_schema_1 = require("./schemas/push.schema");
 const cv_schema_1 = require("./schemas/cv.schema");
 const user_identity_schema_1 = require("./schemas/user-identity.schema");
 const one_signal_schema_1 = require("./schemas/one-signal.schema");
+const custom_events_schema_1 = require("./schemas/custom-events.schema");
 const schemas = {
     [constants_1.validEventTypes.sms]: { schema: sms_schema_1.SMSSchema, label: 'SMS' },
     [constants_1.validEventTypes.updatePersonalData]: {
@@ -119,6 +120,10 @@ const schemas = {
         schema: one_signal_schema_1.DeleteOneSignalUserSchema,
         label: 'Delete OneSignal User',
     },
+    [constants_1.validEventTypes.customEvents]: {
+        schema: custom_events_schema_1.CustomEventsSchema,
+        label: 'Custom Events',
+    },
 };
 function getFieldsFromJoi(schema) {
     const description = schema.describe();

package/build/schemas/custom-events.schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const CustomEventsSchema: Joi.ArraySchema<any[]>;

package/build/schemas/custom-events.schema.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomEventsSchema = void 0;
+const joi_1 = __importDefault(require("joi"));
+const CustomEventItemSchema = joi_1.default.object({
+    name: joi_1.default.string().required(),
+    external_id: joi_1.default.string().uuid().required(),
+    properties: joi_1.default.object().pattern(joi_1.default.string(), joi_1.default.string()).optional(),
+    idempotency_key: joi_1.default.string().uuid().optional(),
+}).unknown(false);
+exports.CustomEventsSchema = joi_1.default.array()
+    .items(CustomEventItemSchema)
+    .min(1)
+    .required()
+    .meta({ className: 'CustomEventsType' });

package/build/schemas/index.d.ts

@@ -1,5 +1,6 @@
 export * from './alert.schema';
 export * from './certifications.schema';
+export * from './custom-events.schema';
 export * from './update-documents-status.schema';
 export * from './education.schema';
 export * from './email.schema';

package/build/schemas/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./alert.schema"), exports);
 __exportStar(require("./certifications.schema"), exports);
+__exportStar(require("./custom-events.schema"), exports);
 __exportStar(require("./update-documents-status.schema"), exports);
 __exportStar(require("./education.schema"), exports);
 __exportStar(require("./email.schema"), exports);

package/build/types/custom-events.type.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was automatically generated by joi-to-typescript
+ * Do not modify this file manually
+ */
+export interface CustomEventItem {
+    name: string;
+    external_id: string;
+    properties: {
+        [key: string]: string;
+    };
+}
+export type CustomEventsType = CustomEventItem[];

package/build/types/custom-events.type.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * This file was automatically generated by joi-to-typescript
+ * Do not modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/types/index.d.ts

@@ -4,6 +4,7 @@
  */
 export * from './alert.type';
 export * from './certifications.type';
+export * from './custom-events.type';
 export * from './cv.type';
 export * from './education.type';
 export * from './email.type';

package/build/types/index.js

@@ -20,6 +20,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./alert.type"), exports);
 __exportStar(require("./certifications.type"), exports);
+__exportStar(require("./custom-events.type"), exports);
 __exportStar(require("./cv.type"), exports);
 __exportStar(require("./education.type"), exports);
 __exportStar(require("./email.type"), exports);

package/build/validator.js

@@ -17,6 +17,7 @@ const cv_schema_1 = require("./schemas/cv.schema");
 const update_documents_status_schema_1 = require("./schemas/update-documents-status.schema");
 const user_identity_schema_1 = require("./schemas/user-identity.schema");
 const one_signal_schema_1 = require("./schemas/one-signal.schema");
+const custom_events_schema_1 = require("./schemas/custom-events.schema");
 const validateSchema = (eventType, data) => {
     let schema;
     switch (eventType) {
@@ -94,6 +95,9 @@ const validateSchema = (eventType, data) => {
         case constants_1.validEventTypes.deleteOneSignalUser:
             schema = one_signal_schema_1.DeleteOneSignalUserSchema;
             break;
+        case constants_1.validEventTypes.customEvents:
+            schema = custom_events_schema_1.CustomEventsSchema;
+            break;
         default:
             console.error(`Unknown event type: ${eventType}`);
             return false;

package/package.json

@@ -1,50 +1,50 @@
-{
-  "name": "@randstad-uca/aws-sns-publisher",
-  "version": "1.2.2",
-  "description": "AWS SNS Publisher",
-  "main": "./build/index.js",
-  "types": "./build/index.d.ts",
-  "files": [
-    "build/**/*",
-    "schema-doc.md"
-  ],
-  "scripts": {
-    "clean": "rimraf build",
-    "build": "npm run clean && npx tsc",
-    "test": "echo \"No tests implemented yet\" && exit 0",
-    "prepublishOnly": "npm run test && npm run generate-types && npm run generate-doc && npm run build",
-    "pub": "npm publish",
-    "generate-doc": "ts-node ./src/generate-schema-doc.ts",
-    "generate-types": "ts-node ./src/generate-types.ts"
-  },
-  "keywords": [
-    "aws",
-    "sns",
-    "publisher"
-  ],
-  "author": "Facundo Brusa",
-  "repository": {
-    "type": "git",
-    "url": "git+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"
-  },
-  "devDependencies": {
-    "@types/node": "^22.15.17",
-    "joi-to-typescript": "^4.15.0",
-    "rimraf": "^6.0.1",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.7.3"
-  },
-  "dependencies": {
-    "@aws-sdk/client-sns": "^3.741.0",
-    "joi": "^17.13.3",
-    "uuid": "^11.0.5"
-  }
-}
+{
+  "name": "@randstad-uca/aws-sns-publisher",
+  "version": "1.2.4",
+  "description": "AWS SNS Publisher",
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "files": [
+    "build/**/*",
+    "schema-doc.md"
+  ],
+  "scripts": {
+    "clean": "rimraf build",
+    "build": "npm run clean && npx tsc",
+    "test": "echo \"No tests implemented yet\" && exit 0",
+    "prepublishOnly": "npm run test && npm run generate-types && npm run generate-doc && npm run build",
+    "pub": "npm publish",
+    "generate-doc": "ts-node ./src/generate-schema-doc.ts",
+    "generate-types": "ts-node ./src/generate-types.ts"
+  },
+  "keywords": [
+    "aws",
+    "sns",
+    "publisher"
+  ],
+  "author": "Facundo Brusa",
+  "repository": {
+    "type": "git",
+    "url": "git+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"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.17",
+    "joi-to-typescript": "^4.15.0",
+    "rimraf": "^6.0.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.7.3"
+  },
+  "dependencies": {
+    "@aws-sdk/client-sns": "^3.741.0",
+    "joi": "^17.13.3",
+    "uuid": "^11.0.5"
+  }
+}

package/readme.md

@@ -1,156 +1,156 @@
-# @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: 'your-sns-topic-ARN',
-  apiName: 'api-name', // If the topic type is FIFO you must define a valid apiName
-})
-  .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`.
-<span style="color: red;">Esta se utiliza como bandera para la creación del MessageDeduplicationId y MessageGroupId necesarios en topics FIFO.</span>
-
-
-- `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."
-  }
-}
-```
-
----
-
-## 📄 Schema Documentation
-
-See [schema-doc.md](./schema-doc.md) for a full list of event types and their schema fields
-
----
-
-🧩 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.
-
-- <span style="color:red">En caso de usar topics FIFO, es importante pasar un `apiName` **valido** para deduplicación.</span>
+# @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: 'your-sns-topic-ARN',
+  apiName: 'api-name', // If the topic type is FIFO you must define a valid apiName
+})
+  .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`.
+<span style="color: red;">Esta se utiliza como bandera para la creación del MessageDeduplicationId y MessageGroupId necesarios en topics FIFO.</span>
+
+
+- `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."
+  }
+}
+```
+
+---
+
+## 📄 Schema Documentation
+
+See [schema-doc.md](./schema-doc.md) for a full list of event types and their schema fields
+
+---
+
+🧩 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.
+
+- <span style="color:red">En caso de usar topics FIFO, es importante pasar un `apiName` **valido** para deduplicación.</span>