@kwirthmagnify/kwirth-common-back 0.5.49 → 0.5.51

package/dist/IProvider.d.ts

@@ -50,6 +50,42 @@ export interface IProviderSubscriptionHelp {
  * IConfigFieldDef, el mismo que usan senders, webhooks, idps y logins.
  */
 export type IProviderFieldDef = IConfigFieldDef;
+/**
+ * Lo que un provider sabe contar de si mismo.
+ *
+ * Existe para que kwirth pueda decir si algo esta siendo consumido o esta emitiendo para nadie, que
+ * es de las pocas preguntas que NADIE puede responder desde fuera: cada provider guarda sus
+ * suscriptores en su propia estructura y hasta ahora no habia forma de preguntarselo.
+ *
+ * ⚠️ Solo el NUMERO, no quienes son: 'IProviderSubscriber' es una interfaz de un solo metodo y no
+ * lleva identidad, asi que un provider no tiene con que identificarlos. Dibujar el grafo de quien
+ * consume a quien pedira ampliar ese contrato, y es una decision aparte.
+ */
+export interface IProviderStats {
+    /** Cuantos suscriptores tiene AHORA. Cero significa que esta emitiendo para nadie. */
+    subscribers: number;
+    /**
+     * ENTREGAS hechas desde que el provider arranco: una por cada vez que se llama a
+     * processProviderEvent, no una por evento producido. OPCIONAL: quien no lo lleve se muestra como
+     * "no informa", igual que el resto.
+     *
+     * Se cuentan entregas y no eventos a proposito. Un provider que produce mil eventos y los filtra
+     * todos no esta moviendo nada, y el numero util para quien opera es el trabajo que SE HACE. Ademas
+     * el sitio donde incrementar es inequivoco —justo donde ya se llama al suscriptor—, y eso hace que
+     * cablearlo en dieciseis providers no dependa de interpretar el codigo de cada uno.
+     *
+     * Es un ACUMULADO, no una tasa: quien lo lea resta dos lecturas y divide por el tiempo. El provider
+     * no debe saber nada de ventanas ni de medias — eso obligaria a guardar historia en el camino
+     * caliente, que es justo lo que no puede pasar.
+     *
+     * ⚠️ El incremento va JUNTO a la llamada al suscriptor, y es un entero. Nada
+     * de timestamps por evento, nada de arrays que crezcan, nada de objetos nuevos: lo que duele en
+     * Node no es el contador, es la basura que genera.
+     */
+    events?: number;
+    /** Errores al entregar, con el mismo criterio: acumulado y barato. */
+    errors?: number;
+}
 /**
  * Interface that all provider plugins must implement.
  * Use 'any' for clusterInfo to avoid pulling in kubernetes/docker dependencies.
@@ -89,6 +125,16 @@ export interface IProvider extends IExtension {
      * mismo array desde el back.js, que el core lee al instalar sin instanciar nada.
      */
     getConfigSchema?(): IProviderFieldDef[];
+    /**
+     * Que sabe el provider de si mismo ahora mismo. OPCIONAL, como el resto de este bloque: quien no
+     * lo implemente se muestra como "no informa", que es distinto de cero — un cero seria una
+     * afirmacion que nadie puede sostener.
+     *
+     * ⚠️ Tiene que ser BARATO: devuelve lo que ya tienes, no lo calcules. Se llama cuando alguien
+     * abre una pantalla de estado, pero un provider no sabe con que frecuencia, y recorrer
+     * estructuras aqui convierte una consulta en trabajo para todos.
+     */
+    getStats?(): IProviderStats;
     startProvider(): Promise<void>;
     stopProvider(): Promise<void>;
     router: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kwirthmagnify/kwirth-common-back",
-  "version": "0.5.49",
+  "version": "0.5.51",
   "description": "Backend interfaces for building Kwirth provider and channel plugins",
   "scripts": {
     "build": "tsc",