@kwirthmagnify/kwirth-common-back 0.5.40 → 0.5.42

package/dist/IIdpConnector.d.ts

@@ -1,15 +1,11 @@
+import { TConfigFieldType, IConfigFieldDef } from '@kwirthmagnify/kwirth-common';
 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 TConfigFieldType, comun a todas las extensiones. */
+export type IdpFieldType = TConfigFieldType;
+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 { TConfigFieldType, IConfigFieldDef } from '@kwirthmagnify/kwirth-common';
+/** @deprecated usa TConfigFieldType, comun a todas las extensiones. */
+export type LoginFieldType = TConfigFieldType;
+/** 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,4 @@
-import { KwirthData } from '@kwirthmagnify/kwirth-common';
+import { KwirthData, IConfigFieldDef } from '@kwirthmagnify/kwirth-common';
 /**
  * Minimal interface representing the channel side that providers interact with.
  * Providers only need to call processProviderEvent on their subscribers.
@@ -44,6 +44,11 @@ export interface IProviderSubscriptionHelp {
     /** 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.
@@ -67,6 +72,22 @@ export interface IProvider {
      * 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,11 @@
-import { ISenderMessage, ISenderConfig, ISenderAccess, ISenderStoredConfig, ISenderResult } from '@kwirthmagnify/kwirth-common';
+import { ISenderMessage, ISenderConfig, ISenderAccess, ISenderStoredConfig, ISenderResult, TConfigFieldType, IConfigFieldDef, IExtensionNodeMeta } from '@kwirthmagnify/kwirth-common';
 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 TConfigFieldType, comun a todas las extensiones. */
+export type SenderFieldType = TConfigFieldType;
+/** 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,11 @@
-import { IWebhookEvent, IWebhookConfig, IWebhookAccess, IWebhookConsumer, IWebhookStoredConfig } from '@kwirthmagnify/kwirth-common';
+import { IWebhookEvent, IWebhookConfig, IWebhookAccess, IWebhookConsumer, IWebhookStoredConfig, TConfigFieldType, IConfigFieldDef, IExtensionNodeMeta } from '@kwirthmagnify/kwirth-common';
 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 TConfigFieldType, comun a todas las extensiones. */
+export type WebhookFieldType = TConfigFieldType;
+/** 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kwirthmagnify/kwirth-common-back",
-  "version": "0.5.40",
+  "version": "0.5.42",
   "description": "Backend interfaces for building Kwirth provider and channel plugins",
   "scripts": {
     "build": "tsc",
@@ -26,7 +26,7 @@
   "license": "ISC",
   "dependencies": {
     "@kubernetes/client-node": "^1.4.0",
-    "@kwirthmagnify/kwirth-common": "^0.5.45",
+    "@kwirthmagnify/kwirth-common": "^0.5.46",
     "express": "^4.18.0",
     "js-yaml": "^4.1.0",
     "openid-client": "^5.7.0"