@kwirthmagnify/kwirth-common-back 0.5.26 → 0.5.28

package/dist/IBackChannelObject.d.ts

@@ -1,4 +1,4 @@
-import { ISenderAccess, IUserInfo } from '@kwirthmagnify/kwirth-common';
+import { ISenderAccess, IWebhookAccess, IUserInfo } from '@kwirthmagnify/kwirth-common';
 export interface IBackChannelObject {
     writeStorage?(id: string, secret: boolean, data: any): Promise<void>;
     readStorage?(id: string, secret: boolean): Promise<any>;
@@ -11,4 +11,5 @@ export interface IBackChannelObject {
     getUsers?(): Promise<IUserInfo[]>;
     getPluginConfig?(pluginId: string): Promise<Record<string, unknown>>;
     senders?: ISenderAccess;
+    webhooks?: IWebhookAccess;
 }

package/dist/IWebhook.d.ts

@@ -0,0 +1,30 @@
+import { IWebhookEvent, IWebhookConfig, IWebhookAccess, IWebhookConsumer, IWebhookStoredConfig } 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;
+}
+export interface IWebhook {
+    readonly id: string;
+    verify(rawBody: Buffer, headers: Record<string, string | string[] | undefined>, config: IWebhookConfig): boolean;
+    parse(rawBody: Buffer, headers: Record<string, string | string[] | undefined>): IWebhookEvent | null;
+    addConfig(config: IWebhookConfig): void;
+    removeConfig(name: string): void;
+    hasConfig(name: string): boolean;
+    getConfigNames(): string[];
+    getConfigSchema?(): IWebhookFieldDef[];
+    getNodeMeta?(): IWebhookNodeMeta;
+    startWebhook?(access: IWebhookAccess): Promise<void>;
+    stopWebhook?(): Promise<void>;
+}
+export type TWebhookConstructor = new () => IWebhook;

package/dist/IWebhook.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export * from './IBackChannelObject';
 export * from './IChannel';
 export * from './IProvider';
 export * from './ISender';
+export * from './IWebhook';
 export * from './IIdpConnector';
 export * from './oidc';
 export * from './oauth2';

package/dist/index.js

@@ -18,6 +18,7 @@ __exportStar(require("./IBackChannelObject"), exports);
 __exportStar(require("./IChannel"), exports);
 __exportStar(require("./IProvider"), exports);
 __exportStar(require("./ISender"), exports);
+__exportStar(require("./IWebhook"), exports);
 __exportStar(require("./IIdpConnector"), exports);
 __exportStar(require("./oidc"), exports);
 __exportStar(require("./oauth2"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kwirthmagnify/kwirth-common-back",
-  "version": "0.5.26",
+  "version": "0.5.28",
   "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.33",
+    "@kwirthmagnify/kwirth-common": "^0.5.34",
     "express": "^4.18.0",
     "js-yaml": "^4.1.0",
     "openid-client": "^5.7.0"