@kwirthmagnify/kwirth-common-back 0.5.39 → 0.5.41

package/dist/IExtensionConfig.d.ts

@@ -0,0 +1,28 @@
+export declare enum EConfigFieldType {
+    TEXT = "text",
+    NUMBER = "number",
+    BOOLEAN = "boolean",
+    PASSWORD = "password",
+    SELECT = "select",
+    JSON = "json"
+}
+export interface IConfigFieldDef {
+    /** Clave con la que el valor se guarda en la configuracion. */
+    name: string;
+    /** Etiqueta que ve el usuario en el formulario. */
+    label: string;
+    /** Ausente = EConfigFieldType.TEXT. */
+    type?: EConfigFieldType;
+    required?: boolean;
+    /** Valores admitidos cuando 'type' es SELECT. Ignorado en el resto. */
+    options?: string[];
+    /** Valor con el que se precarga el campo mientras no haya nada guardado. */
+    default?: string | number | boolean;
+    /** El campo es comun a TODAS las configuraciones de la extension, no propio de cada una. */
+    common?: boolean;
+}
+export interface IExtensionNodeMeta {
+    label: string;
+    icon?: string;
+    description?: string;
+}

package/dist/IExtensionConfig.js

@@ -0,0 +1,38 @@
+"use strict";
+/*
+    Contrato COMUN de configuracion de extensiones.
+
+    Toda extension que publique un formulario de configuracion (senders, webhooks, conectores IdP,
+    logins y providers) describe sus campos con ESTE tipo. Antes cada familia tenia el suyo, casi
+    identico pero divergente: provider decia 'string' donde el resto decia 'text', solo el tenia
+    'default', solo sender y webhook tenian 'common', y su definicion ni siquiera vivia aqui (estaba
+    dentro del core, en back/src/tools/ProviderManager.ts).
+
+    OJO: no confundir EConfigFieldType (el tipo de UN CAMPO del formulario) con EExtensionType (el
+    tipo de la extension: provider, sender, plugin...), que vive en kwirth-common y es lo que declara
+    el package.json del artefacto.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EConfigFieldType = void 0;
+/*
+    Tipo de un campo del formulario de configuracion.
+
+    Lo que hoy pinta el front para cada valor:
+      TEXT      campo de texto. Es el comportamiento por defecto cuando 'type' se omite.
+      NUMBER    campo numerico.
+      BOOLEAN   switch. Los gestores de sender, webhook, idp y provider lo pintan; el de login no.
+      PASSWORD  campo enmascarado con ojo de visibilidad.
+      SELECT    desplegable alimentado por 'options'. Los gestores de sender, webhook y login lo
+                pintan; los de idp y provider no.
+      JSON      area de texto libre para JSON. NINGUN gestor lo pinta todavia: hoy cae a campo de
+                texto. Declararlo es valido, pero no esperes editor estructurado.
+*/
+var EConfigFieldType;
+(function (EConfigFieldType) {
+    EConfigFieldType["TEXT"] = "text";
+    EConfigFieldType["NUMBER"] = "number";
+    EConfigFieldType["BOOLEAN"] = "boolean";
+    EConfigFieldType["PASSWORD"] = "password";
+    EConfigFieldType["SELECT"] = "select";
+    EConfigFieldType["JSON"] = "json";
+})(EConfigFieldType || (exports.EConfigFieldType = EConfigFieldType = {}));

package/dist/IIdpConnector.d.ts

@@ -1,15 +1,11 @@
+import { EConfigFieldType, IConfigFieldDef } from './IExtensionConfig';
 export declare enum EIdpConnectorKind {
     OIDC = "oidc",
     OAUTH2 = "oauth2"
 }
-export type IdpFieldType = 'text' | 'number' | 'boolean' | 'password';
-export interface IIdpConfigFieldDef {
-    name: string;
-    label: string;
-    type?: IdpFieldType;
-    required?: boolean;
-    options?: string[];
-}
+/** @deprecated usa EConfigFieldType, comun a todas las extensiones. */
+export type IdpFieldType = EConfigFieldType;
+export type IIdpConfigFieldDef = IConfigFieldDef;
 export interface IIdpIdentity {
     email: string;
     emailVerified: boolean;

package/dist/ILogin.d.ts

@@ -1,8 +1,5 @@
-export type LoginFieldType = 'text' | 'number' | 'boolean' | 'password' | 'select';
-export interface ILoginFieldDef {
-    name: string;
-    label: string;
-    type?: LoginFieldType;
-    required?: boolean;
-    options?: string[];
-}
+import { EConfigFieldType, IConfigFieldDef } from './IExtensionConfig';
+/** @deprecated usa EConfigFieldType, comun a todas las extensiones. */
+export type LoginFieldType = EConfigFieldType;
+/** Campo de configuracion de un login. Es el contrato comun IConfigFieldDef, sin nada propio. */
+export type ILoginFieldDef = IConfigFieldDef;

package/dist/IProvider.d.ts

@@ -1,4 +1,5 @@
 import { KwirthData } from '@kwirthmagnify/kwirth-common';
+import { IConfigFieldDef } from './IExtensionConfig';
 /**
  * Minimal interface representing the channel side that providers interact with.
  * Providers only need to call processProviderEvent on their subscribers.
@@ -17,6 +18,38 @@ export interface IProviderStorage {
     writeStorageCommon(id: string, secret: boolean, data: any): Promise<void>;
     readStorageCommon(id: string, secret: boolean): Promise<any>;
 }
+/**
+ * Un campo del payload de suscripcion, descrito para que un consumidor pueda pintar un formulario
+ * en vez de exigir JSON a mano. Solo tiene sentido declararlos cuando el payload es plano; si es
+ * anidado (p.ej. otel, con 'spaces'), basta con 'usage' y 'example'.
+ */
+export interface IProviderSubscriptionField {
+    name: string;
+    type: 'string' | 'number' | 'boolean' | 'string[]';
+    required?: boolean;
+    description: string;
+}
+/**
+ * Ayuda que un provider publica sobre COMO SUSCRIBIRSE a el, es decir sobre el argumento 'data' de
+ * addSubscriber. No confundir con el 'schema' que un provider exporta desde su back.js, que
+ * describe la configuracion del propio provider (configure/configRouter).
+ *
+ * La consume provider-debug para explicarle al usuario que escribir, pero cualquier canal que
+ * ofrezca elegir provider puede usarla.
+ */
+export interface IProviderSubscriptionHelp {
+    /** Como se usa, en prosa: que entrega, que hace falta para recibir algo, gotchas. */
+    usage: string;
+    /** Payload de ejemplo, listo para pasar tal cual a addSubscriber. */
+    example: Record<string, unknown>;
+    /** Descripcion campo a campo. Opcional: solo para payloads planos. */
+    fields?: IProviderSubscriptionField[];
+}
+/**
+ * Un campo de la configuracion del PROPIO provider (no de la suscripcion). Es el contrato comun
+ * IConfigFieldDef, el mismo que usan senders, webhooks, idps y logins.
+ */
+export type IProviderFieldDef = IConfigFieldDef;
 /**
  * Interface that all provider plugins must implement.
  * Use 'any' for clusterInfo to avoid pulling in kubernetes/docker dependencies.
@@ -34,6 +67,28 @@ export interface IProvider {
      * de terceros que aun usen la config gestionada por el core.
      */
     configure?(config: Record<string, unknown>): void;
+    /**
+     * Ayuda de suscripcion. OPCIONAL: quien escriba un provider la añade si quiere. Sin ella el
+     * consumidor sigue funcionando, simplemente no tiene nada que enseñarle al usuario sobre que
+     * payload escribir.
+     */
+    getSubscriptionHelp?(): IProviderSubscriptionHelp;
+    /**
+     * Nombres de las configuraciones que el provider tiene definidas (equivalente a
+     * ISender.getConfigNames). OPCIONAL: solo tiene sentido en un provider que sea dueño de su
+     * configuracion. El gestor de extensiones lo usa para mostrar cuantas hay en la tarjeta, igual
+     * que hace con los senders. No expone valores, solo nombres.
+     */
+    getConfigNames?(): string[];
+    /**
+     * Schema de configuracion del propio provider, con el que kwirth pinta un formulario generico.
+     * Es la forma ESTANDAR de declararlo, la misma que ISender.getConfigSchema e IWebhook.
+     *
+     * Un provider al que nadie se suscribe y que no expone router NO se instancia nunca, asi que en
+     * ese caso no hay a quien preguntarselo: para esos, exporta ademas una constante 'schema' con el
+     * mismo array desde el back.js, que el core lee al instalar sin instanciar nada.
+     */
+    getConfigSchema?(): IProviderFieldDef[];
     startProvider(): Promise<void>;
     stopProvider(): Promise<void>;
     router: any;

package/dist/ISender.d.ts

@@ -1,19 +1,12 @@
 import { ISenderMessage, ISenderConfig, ISenderAccess, ISenderStoredConfig, ISenderResult } from '@kwirthmagnify/kwirth-common';
+import { EConfigFieldType, IConfigFieldDef, IExtensionNodeMeta } from './IExtensionConfig';
 export { ISenderMessage, ISenderConfig, ISenderAccess, ISenderStoredConfig, ISenderResult };
-export type SenderFieldType = 'text' | 'number' | 'boolean' | 'password' | 'select' | 'json';
-export interface ISenderFieldDef {
-    name: string;
-    label: string;
-    type?: SenderFieldType;
-    required?: boolean;
-    options?: string[];
-    common?: boolean;
-}
-export interface ISenderNodeMeta {
-    label: string;
-    icon?: string;
-    description?: string;
-}
+/** @deprecated usa EConfigFieldType, comun a todas las extensiones. */
+export type SenderFieldType = EConfigFieldType;
+/** Campo de configuracion de un sender. Es el contrato comun IConfigFieldDef, sin nada propio. */
+export type ISenderFieldDef = IConfigFieldDef;
+/** @deprecated usa IExtensionNodeMeta, comun a todas las extensiones. */
+export type ISenderNodeMeta = IExtensionNodeMeta;
 export interface ISender {
     readonly id: string;
     readonly senderType?: 'filter' | 'output';

package/dist/IWebhook.d.ts

@@ -1,19 +1,12 @@
 import { IWebhookEvent, IWebhookConfig, IWebhookAccess, IWebhookConsumer, IWebhookStoredConfig } from '@kwirthmagnify/kwirth-common';
+import { EConfigFieldType, IConfigFieldDef, IExtensionNodeMeta } from './IExtensionConfig';
 export { IWebhookEvent, IWebhookConfig, IWebhookAccess, IWebhookConsumer, IWebhookStoredConfig };
-export type WebhookFieldType = 'text' | 'number' | 'boolean' | 'password' | 'select' | 'json';
-export interface IWebhookFieldDef {
-    name: string;
-    label: string;
-    type?: WebhookFieldType;
-    required?: boolean;
-    options?: string[];
-    common?: boolean;
-}
-export interface IWebhookNodeMeta {
-    label: string;
-    icon?: string;
-    description?: string;
-}
+/** @deprecated usa EConfigFieldType, comun a todas las extensiones. */
+export type WebhookFieldType = EConfigFieldType;
+/** Campo de configuracion de un webhook. Es el contrato comun IConfigFieldDef, sin nada propio. */
+export type IWebhookFieldDef = IConfigFieldDef;
+/** @deprecated usa IExtensionNodeMeta, comun a todas las extensiones. */
+export type IWebhookNodeMeta = IExtensionNodeMeta;
 export interface IWebhook {
     readonly id: string;
     verify(rawBody: Buffer, headers: Record<string, string | string[] | undefined>, config: IWebhookConfig): boolean;

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export * from './IExtensionConfig';
 export * from './IBackChannelObject';
 export * from './ILogin';
 export * from './IChannel';

package/dist/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./IExtensionConfig"), exports);
 __exportStar(require("./IBackChannelObject"), exports);
 __exportStar(require("./ILogin"), exports);
 __exportStar(require("./IChannel"), exports);

package/dist/oauth2.js

@@ -3,12 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.oauth2ConfigSchema = oauth2ConfigSchema;
 exports.oauth2BuildAuthorizationUrl = oauth2BuildAuthorizationUrl;
 exports.oauth2HandleCallback = oauth2HandleCallback;
+const IExtensionConfig_1 = require("./IExtensionConfig");
 // esquema base de un IdP OAuth2 (el conector añade sus URLs si aplica; clientSecret 'password' → se enmascara)
 function oauth2ConfigSchema() {
     return [
-        { name: 'clientId', label: 'Client ID', type: 'text', required: true },
-        { name: 'clientSecret', label: 'Client Secret', type: 'password', required: true },
-        { name: 'scopes', label: 'Scopes', type: 'text' }
+        { name: 'clientId', label: 'Client ID', type: IExtensionConfig_1.EConfigFieldType.TEXT, required: true },
+        { name: 'clientSecret', label: 'Client Secret', type: IExtensionConfig_1.EConfigFieldType.PASSWORD, required: true },
+        { name: 'scopes', label: 'Scopes', type: IExtensionConfig_1.EConfigFieldType.TEXT }
     ];
 }
 function oauth2BuildAuthorizationUrl(config, ctx, ep) {

package/dist/oidc.js

@@ -4,6 +4,7 @@ exports.oidcConfigSchema = oidcConfigSchema;
 exports.oidcBuildAuthorizationUrl = oidcBuildAuthorizationUrl;
 exports.oidcHandleCallback = oidcHandleCallback;
 const openid_client_1 = require("openid-client");
+const IExtensionConfig_1 = require("./IExtensionConfig");
 /*
     Lógica OIDC compartida por todos los conectores OIDC (Google, Keycloak, GitLab, Microsoft, ...).
     Vive en common-back y el back la expone como global (__kwirth_back__.kwirthCommonBack), de modo
@@ -15,10 +16,10 @@ const openid_client_1 = require("openid-client");
 // esquema de config estándar de un IdP OIDC (clientSecret es 'password' → se enmascara en la UI)
 function oidcConfigSchema() {
     return [
-        { name: 'clientId', label: 'Client ID', type: 'text', required: true },
-        { name: 'clientSecret', label: 'Client Secret', type: 'password', required: true },
-        { name: 'scopes', label: 'Scopes', type: 'text' },
-        { name: 'issuer', label: 'Issuer URL', type: 'text' }
+        { name: 'clientId', label: 'Client ID', type: IExtensionConfig_1.EConfigFieldType.TEXT, required: true },
+        { name: 'clientSecret', label: 'Client Secret', type: IExtensionConfig_1.EConfigFieldType.PASSWORD, required: true },
+        { name: 'scopes', label: 'Scopes', type: IExtensionConfig_1.EConfigFieldType.TEXT },
+        { name: 'issuer', label: 'Issuer URL', type: IExtensionConfig_1.EConfigFieldType.TEXT }
     ];
 }
 async function makeClient(config, redirectUri, defaultIssuer) {

package/package.json

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