@kwirthmagnify/kwirth-common-back 0.1.0

package/dist/IProvider.d.ts

@@ -0,0 +1,25 @@
+import { KwirthData } from '@kwirthmagnify/kwirth-common';
+/**
+ * Minimal interface representing the channel side that providers interact with.
+ * Providers only need to call processProviderEvent on their subscribers.
+ */
+export interface IProviderSubscriber {
+    processProviderEvent(providerId: string, obj: any): void;
+}
+/**
+ * Interface that all provider plugins must implement.
+ * Use 'any' for clusterInfo to avoid pulling in kubernetes/docker dependencies.
+ */
+export interface IProvider {
+    readonly id: string;
+    readonly providesRouter: boolean;
+    readonly requiresApiKeyApi: boolean;
+    addSubscriber(c: IProviderSubscriber, data: any): Promise<void>;
+    removeSubscriber(c: IProviderSubscriber): Promise<void>;
+    startProvider(): Promise<void>;
+    stopProvider(): Promise<void>;
+    router: any;
+    routerAlias: string | undefined;
+    apiKeyApi: any | undefined;
+}
+export type TProviderConstructor = new (clusterInfo: any, kwirthData: KwirthData) => IProvider;

package/dist/IProvider.js

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

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './IProvider';
+export * from '@kwirthmagnify/kwirth-common';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./IProvider"), exports);
+__exportStar(require("@kwirthmagnify/kwirth-common"), exports);

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@kwirthmagnify/kwirth-common-back",
+  "version": "0.1.0",
+  "description": "Backend interfaces for building Kwirth provider and channel plugins",
+  "scripts": {
+    "build": "tsc"
+  },
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.js"
+  },
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "kwirth",
+    "provider",
+    "plugin",
+    "channel"
+  ],
+  "author": "Julio Fernandez",
+  "license": "ISC",
+  "dependencies": {
+    "@kwirthmagnify/kwirth-common": "^0.5.2"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.3"
+  }
+}