@esfaenza/extensions 11.2.22 → 11.2.23

package/lib/models/InboundMessageTypes.d.ts

@@ -0,0 +1,5 @@
+/** Enumeratore dei tipi di messaggio che i moduli esterni possono contattare sull'applicazione principale */
+export declare enum InboundMessageTypes {
+    /** Evento di navigazione */
+    Navigation = 0
+}

package/lib/models/InterComMessage.d.ts

@@ -0,0 +1,12 @@
+/** Classe che rappresenta un generico messaggio scambiato fra applicazione e moduli */
+export declare class InterComMessage {
+    type: any;
+    message: any;
+    /**
+     * Costruttore
+     *
+     * @param type Tipo di messaggio
+     * @param message Contenuto del messaggio
+     */
+    constructor(type: any, message: any);
+}

package/lib/modules/extensions.full.module.d.ts

@@ -8,6 +8,7 @@ import { ExtensionsModuleConfig } from '../models/ExtensionsModuleConfig';
  * HashingService,
  * MessageService,
  * UtilityService
+ * InterComService
  *
  * con eventuali provider che utilizzano
  */

package/lib/services/extensions.intercom.service.d.ts

@@ -0,0 +1,25 @@
+import { Subject } from "rxjs";
+import { InterComMessage } from "../models/InterComMessage";
+/** Service che si occupa di gestire la comunicazione fra i moduli interni ed esterni dell'applicativo */
+export declare class InterComService {
+    /** Messaggi in uscita, uno per ogni recipient registratosi dall'entrypoint **register** */
+    outbounds: {
+        [id: string]: Subject<InterComMessage>;
+    };
+    /** Messaggi in entrata, unico per applicazione principale */
+    inbounds: Subject<InterComMessage>;
+    /**
+     * Metodo che permette di inviare un messaggio dall'applicazione ad un modulo esterno o viceversa
+     *
+     * @param {any} messageType Tipologia di messaggio. Sarà di tipo **InboundMessageTypes** per tutti i messaggi inbound, dinamico per tutti i mesaggi outbound (il tipo dipenderà dagli enum dei messaggi dei moduli esterni)
+     * @param {any} message Messaggio da inviare che può essere un dto in casi complessi ma dovrà essere gestito a dovere lato implementativo
+     * @param {string} recipient Destinatario del messaggio. Per i messaggi inbound dev'essere lasciato vuoto, per i messaggi outbound sarà valorizzato alla chiave del modulo a cui si vuole inviare il messaggio
+     */
+    send(messageType: any, message: any, recipient?: string): void;
+    /**
+     * Permette di registrare un modulo esterno alla lista dei moduli in listening sulla coda di messaggi
+     *
+     * @param {string} key Chiave del modulo da registrare. Tutti i messaggi inbound saranno inviati dall'applicazione principale su questa chiave
+     */
+    register(key: string): void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esfaenza/extensions",
-  "version": "11.2.22",
+  "version": "11.2.23",
   "dependencies": {
     "tslib": "^2.0.0"
   },

package/public-api.d.ts

@@ -10,3 +10,7 @@ export * from './lib/tokens';
 export * from './lib/models/CallResult';
 export * from './lib/models/CsvHeaders';
 export * from './lib/models/GenericItem';
+/** Intercom */
+export * from './lib/models/InboundMessageTypes';
+export * from './lib/models/InterComMessage';
+export * from './lib/services/extensions.intercom.service';