@ebowwa/channel-types 0.1.1 → 0.2.1

package/src/example.js

@@ -0,0 +1,431 @@
+"use strict";
+/**
+ * Example: Composable Channel-LLM Architecture
+ *
+ * This demonstrates how to:
+ * 1. Create a channel connector (Discord)
+ * 2. Create an LLM handler (GLM)
+ * 3. Connect them via a bridge
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var g = generator.apply(thisArg, _arguments || []), i, q = [];
+    return i = Object.create((typeof AsyncIterator === "function" ? AsyncIterator : Object).prototype), verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
+    function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
+    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var index_js_1 = require("./index.js");
+// ============================================================
+// EXAMPLE: Discord Channel Connector
+// ============================================================
+var DiscordChannel = /** @class */ (function () {
+    function DiscordChannel(accountId) {
+        this.label = "Discord";
+        this.capabilities = index_js_1.RICH_CAPABILITIES;
+        this.connected = false;
+        this.id = (0, index_js_1.createChannelId)("discord", accountId);
+    }
+    DiscordChannel.prototype.start = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                // In real impl: connect to Discord gateway
+                this.connected = true;
+                console.log("[".concat(this.label, "] Started"));
+                return [2 /*return*/];
+            });
+        });
+    };
+    DiscordChannel.prototype.stop = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                this.connected = false;
+                console.log("[".concat(this.label, "] Stopped"));
+                return [2 /*return*/];
+            });
+        });
+    };
+    DiscordChannel.prototype.onMessage = function (handler) {
+        this.messageHandler = handler;
+    };
+    DiscordChannel.prototype.send = function (response) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                // In real impl: send to Discord API
+                console.log("[".concat(this.label, "] Sending: ").concat(response.content.text));
+                return [2 /*return*/];
+            });
+        });
+    };
+    DiscordChannel.prototype.stream = function (response, chunks) {
+        return __awaiter(this, void 0, void 0, function () {
+            var fullText, chunk, e_1_1;
+            var _a, chunks_1, chunks_1_1;
+            var _b, e_1, _c, _d;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        fullText = "";
+                        _e.label = 1;
+                    case 1:
+                        _e.trys.push([1, 6, 7, 12]);
+                        _a = true, chunks_1 = __asyncValues(chunks);
+                        _e.label = 2;
+                    case 2: return [4 /*yield*/, chunks_1.next()];
+                    case 3:
+                        if (!(chunks_1_1 = _e.sent(), _b = chunks_1_1.done, !_b)) return [3 /*break*/, 5];
+                        _d = chunks_1_1.value;
+                        _a = false;
+                        chunk = _d;
+                        fullText += chunk.text;
+                        console.log("[".concat(this.label, "] Stream: ").concat(fullText));
+                        _e.label = 4;
+                    case 4:
+                        _a = true;
+                        return [3 /*break*/, 2];
+                    case 5: return [3 /*break*/, 12];
+                    case 6:
+                        e_1_1 = _e.sent();
+                        e_1 = { error: e_1_1 };
+                        return [3 /*break*/, 12];
+                    case 7:
+                        _e.trys.push([7, , 10, 11]);
+                        if (!(!_a && !_b && (_c = chunks_1.return))) return [3 /*break*/, 9];
+                        return [4 /*yield*/, _c.call(chunks_1)];
+                    case 8:
+                        _e.sent();
+                        _e.label = 9;
+                    case 9: return [3 /*break*/, 11];
+                    case 10:
+                        if (e_1) throw e_1.error;
+                        return [7 /*endfinally*/];
+                    case 11: return [7 /*endfinally*/];
+                    case 12: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    DiscordChannel.prototype.isConnected = function () {
+        return this.connected;
+    };
+    // Simulate receiving a message (for testing)
+    DiscordChannel.prototype.simulateMessage = function (text, senderId) {
+        return __awaiter(this, void 0, void 0, function () {
+            var message, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!this.messageHandler)
+                            return [2 /*return*/];
+                        message = {
+                            messageId: "msg-".concat(Date.now()),
+                            channelId: this.id,
+                            timestamp: new Date(),
+                            sender: { id: senderId, username: "user_".concat(senderId) },
+                            text: text,
+                            context: { isDM: true },
+                        };
+                        return [4 /*yield*/, this.messageHandler(message)];
+                    case 1:
+                        response = _a.sent();
+                        if (!response) return [3 /*break*/, 3];
+                        return [4 /*yield*/, this.send(response)];
+                    case 2:
+                        _a.sent();
+                        _a.label = 3;
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    return DiscordChannel;
+}());
+// ============================================================
+// EXAMPLE: GLM LLM Handler
+// ============================================================
+var GLMHandler = /** @class */ (function () {
+    function GLMHandler() {
+        this.id = "glm-4.7";
+        this.model = "glm-4-flash";
+        this.ready = true;
+    }
+    GLMHandler.prototype.process = function (message) {
+        return __awaiter(this, void 0, void 0, function () {
+            var startTime, responseText;
+            return __generator(this, function (_a) {
+                startTime = Date.now();
+                responseText = this.generateResponse(message.text);
+                return [2 /*return*/, {
+                        content: {
+                            text: responseText,
+                            replyToOriginal: true,
+                        },
+                        replyTo: (0, index_js_1.createMessageRef)(message.messageId, message.channelId),
+                        isComplete: true,
+                        metadata: {
+                            model: this.model,
+                            latency: Date.now() - startTime,
+                        },
+                    }];
+            });
+        });
+    };
+    GLMHandler.prototype.stream = function (message) {
+        return __asyncGenerator(this, arguments, function stream_1() {
+            var response, words, i;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, __await(this.process(message))];
+                    case 1:
+                        response = _a.sent();
+                        words = response.content.text.split(" ");
+                        i = 0;
+                        _a.label = 2;
+                    case 2:
+                        if (!(i < words.length)) return [3 /*break*/, 7];
+                        return [4 /*yield*/, __await({
+                                text: words[i] + " ",
+                                done: i === words.length - 1,
+                                seq: i,
+                            })];
+                    case 3: return [4 /*yield*/, _a.sent()];
+                    case 4:
+                        _a.sent();
+                        return [4 /*yield*/, __await(new Promise(function (r) { return setTimeout(r, 50); }))];
+                    case 5:
+                        _a.sent();
+                        _a.label = 6;
+                    case 6:
+                        i++;
+                        return [3 /*break*/, 2];
+                    case 7: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    GLMHandler.prototype.isReady = function () {
+        return this.ready;
+    };
+    GLMHandler.prototype.generateResponse = function (input) {
+        // Simple echo + prefix for demo
+        if (input.toLowerCase().includes("hello")) {
+            return "Hello! How can I help you today?";
+        }
+        if (input.toLowerCase().includes("status")) {
+            return "All systems operational. GLM 4.7 is ready to assist.";
+        }
+        return "I received your message: \"".concat(input, "\"");
+    };
+    return GLMHandler;
+}());
+// ============================================================
+// EXAMPLE: Simple Bridge Implementation
+// ============================================================
+var SimpleBridge = /** @class */ (function () {
+    function SimpleBridge() {
+        this.channels = new Map();
+        this.handlers = new Map();
+        this.defaultHandlers = new Map();
+    }
+    SimpleBridge.prototype.registerChannel = function (channel) {
+        var _this = this;
+        var key = this.channelKey(channel.id);
+        this.channels.set(key, channel);
+        // Set up message routing
+        channel.onMessage(function (message) { return __awaiter(_this, void 0, void 0, function () {
+            var handlerId, handler;
+            return __generator(this, function (_a) {
+                handlerId = this.defaultHandlers.get(key);
+                if (!handlerId) {
+                    console.warn("No handler for channel ".concat(key));
+                    return [2 /*return*/];
+                }
+                handler = this.handlers.get(handlerId);
+                if (!handler) {
+                    console.warn("Handler ".concat(handlerId, " not found"));
+                    return [2 /*return*/];
+                }
+                return [2 /*return*/, handler.process(message)];
+            });
+        }); });
+        console.log("[Bridge] Registered channel: ".concat(channel.label));
+    };
+    SimpleBridge.prototype.registerHandler = function (handler) {
+        this.handlers.set(handler.id, handler);
+        console.log("[Bridge] Registered handler: ".concat(handler.id));
+    };
+    SimpleBridge.prototype.setDefaultHandler = function (channelId, handlerId) {
+        this.defaultHandlers.set(this.channelKey(channelId), handlerId);
+        console.log("[Bridge] Set default handler: ".concat(this.channelKey(channelId), " \u2192 ").concat(handlerId));
+    };
+    SimpleBridge.prototype.start = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _i, _a, channel;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _i = 0, _a = this.channels.values();
+                        _b.label = 1;
+                    case 1:
+                        if (!(_i < _a.length)) return [3 /*break*/, 4];
+                        channel = _a[_i];
+                        return [4 /*yield*/, channel.start()];
+                    case 2:
+                        _b.sent();
+                        _b.label = 3;
+                    case 3:
+                        _i++;
+                        return [3 /*break*/, 1];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    SimpleBridge.prototype.stop = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _i, _a, channel;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _i = 0, _a = this.channels.values();
+                        _b.label = 1;
+                    case 1:
+                        if (!(_i < _a.length)) return [3 /*break*/, 4];
+                        channel = _a[_i];
+                        return [4 /*yield*/, channel.stop()];
+                    case 2:
+                        _b.sent();
+                        _b.label = 3;
+                    case 3:
+                        _i++;
+                        return [3 /*break*/, 1];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    SimpleBridge.prototype.getChannels = function () {
+        return Array.from(this.channels.values());
+    };
+    SimpleBridge.prototype.getHandlers = function () {
+        return Array.from(this.handlers.values());
+    };
+    SimpleBridge.prototype.channelKey = function (id) {
+        return "".concat(id.platform, ":").concat(id.accountId);
+    };
+    return SimpleBridge;
+}());
+// ============================================================
+// USAGE EXAMPLE
+// ============================================================
+function main() {
+    return __awaiter(this, void 0, void 0, function () {
+        var bridge, glmHandler, discordChannel;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    console.log("=== Composable Channel-LLM Example ===\n");
+                    bridge = new SimpleBridge();
+                    glmHandler = new GLMHandler();
+                    bridge.registerHandler(glmHandler);
+                    discordChannel = new DiscordChannel("my-bot-123");
+                    bridge.registerChannel(discordChannel);
+                    // 4. Connect channel to handler
+                    bridge.setDefaultHandler(discordChannel.id, glmHandler.id);
+                    // 5. Start the bridge
+                    return [4 /*yield*/, bridge.start()];
+                case 1:
+                    // 5. Start the bridge
+                    _a.sent();
+                    // 6. Simulate messages
+                    console.log("\n--- Simulating messages ---\n");
+                    return [4 /*yield*/, discordChannel.simulateMessage("Hello!", "user-1")];
+                case 2:
+                    _a.sent();
+                    return [4 /*yield*/, discordChannel.simulateMessage("What's the status?", "user-2")];
+                case 3:
+                    _a.sent();
+                    return [4 /*yield*/, discordChannel.simulateMessage("Can you help me with a task?", "user-3")];
+                case 4:
+                    _a.sent();
+                    // 7. Stop
+                    console.log("\n--- Stopping ---\n");
+                    return [4 /*yield*/, bridge.stop()];
+                case 5:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    });
+}
+// Run example
+main().catch(console.error);
+/**
+ * Output:
+ *
+ * === Composable Channel-LLM Example ===
+ *
+ * [Bridge] Registered handler: glm-4.7
+ * [Bridge] Registered channel: Discord
+ * [Bridge] Set default handler: discord:my-bot-123 → glm-4.7
+ * [Discord] Started
+ *
+ * --- Simulating messages ---
+ *
+ * [Discord] Sending: Hello! How can I help you today?
+ * [Discord] Sending: All systems operational. GLM 4.7 is ready to assist.
+ * [Discord] Sending: I received your message: "Can you help me with a task?"
+ *
+ * --- Stopping ---
+ *
+ * [Discord] Stopped
+ */

package/src/index.js

@@ -0,0 +1,76 @@
+"use strict";
+/**
+ * @ebowwa/channel-types
+ *
+ * Composable types for channel-LLM communication.
+ *
+ * Architecture:
+ *   Channel (Discord/Telegram/WhatsApp)
+ *       ↓ ChannelMessage (normalized)
+ *   LLMHandler.process()
+ *       ↓ ChannelResponse (normalized)
+ *   Channel delivers response
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeChannelConfigs = exports.serializeChannelConfig = exports.parseChannelConfigs = exports.parseChannelConfig = exports.createChannelConfig = exports.getChannelsByPlatform = exports.getEnabledChannels = exports.validateChannelConfig = exports.getChannelId = exports.loadChannelConfigsFromEnv = exports.RICH_CAPABILITIES = exports.DEFAULT_CAPABILITIES = void 0;
+exports.createChannelId = createChannelId;
+exports.createMessageRef = createMessageRef;
+exports.channelIdsMatch = channelIdsMatch;
+exports.formatChannelId = formatChannelId;
+// ============================================================
+// UTILITY TYPES
+// ============================================================
+/** Create a simple channel ID */
+function createChannelId(platform, accountId, instanceId) {
+    return { platform: platform, accountId: accountId, instanceId: instanceId };
+}
+/** Create a simple message ref */
+function createMessageRef(messageId, channelId) {
+    return { messageId: messageId, channelId: channelId };
+}
+/** Check if two channel IDs match */
+function channelIdsMatch(a, b) {
+    return (a.platform === b.platform &&
+        a.accountId === b.accountId &&
+        a.instanceId === b.instanceId);
+}
+/** Format channel ID for logging */
+function formatChannelId(id) {
+    var base = "".concat(id.platform, ":").concat(id.accountId);
+    return id.instanceId ? "".concat(base, ":").concat(id.instanceId) : base;
+}
+/** Default capabilities for text-only channels */
+exports.DEFAULT_CAPABILITIES = {
+    supports: {
+        text: true,
+        media: false,
+        replies: false,
+        threads: false,
+        reactions: false,
+        editing: false,
+        streaming: false,
+    },
+};
+/** Full capabilities for rich channels (Discord, Slack) */
+exports.RICH_CAPABILITIES = {
+    supports: {
+        text: true,
+        media: true,
+        replies: true,
+        threads: true,
+        reactions: true,
+        editing: true,
+        streaming: true,
+    },
+};
+var config_js_1 = require("./config.js");
+Object.defineProperty(exports, "loadChannelConfigsFromEnv", { enumerable: true, get: function () { return config_js_1.loadChannelConfigsFromEnv; } });
+Object.defineProperty(exports, "getChannelId", { enumerable: true, get: function () { return config_js_1.getChannelId; } });
+Object.defineProperty(exports, "validateChannelConfig", { enumerable: true, get: function () { return config_js_1.validateChannelConfig; } });
+Object.defineProperty(exports, "getEnabledChannels", { enumerable: true, get: function () { return config_js_1.getEnabledChannels; } });
+Object.defineProperty(exports, "getChannelsByPlatform", { enumerable: true, get: function () { return config_js_1.getChannelsByPlatform; } });
+Object.defineProperty(exports, "createChannelConfig", { enumerable: true, get: function () { return config_js_1.createChannelConfig; } });
+Object.defineProperty(exports, "parseChannelConfig", { enumerable: true, get: function () { return config_js_1.parseChannelConfig; } });
+Object.defineProperty(exports, "parseChannelConfigs", { enumerable: true, get: function () { return config_js_1.parseChannelConfigs; } });
+Object.defineProperty(exports, "serializeChannelConfig", { enumerable: true, get: function () { return config_js_1.serializeChannelConfig; } });
+Object.defineProperty(exports, "serializeChannelConfigs", { enumerable: true, get: function () { return config_js_1.serializeChannelConfigs; } });

package/src/index.ts

@@ -25,6 +25,7 @@ export type ChannelPlatform =
   | "signal"
   | "web"
   | "cli"
+  | "ssh"
   | "custom";
 
 /** Unique channel identifier */
@@ -349,6 +350,7 @@ export type {
   SignalChannelConfig,
   CLIChannelConfig,
   WebChannelConfig,
+  SSHChannelConfig,
   ChannelConfig,
   ChannelConfigMap,
 } from "./config.js";
@@ -365,3 +367,6 @@ export {
   serializeChannelConfig,
   serializeChannelConfigs,
 } from "./config.js";
+
+// Re-export plugin types and registry
+export * from "./plugins/index.js";

package/src/plugins/index.ts

@@ -0,0 +1,5 @@
+// Plugin system exports
+
+export * from "./types.adapters.js";
+export * from "./types.plugin.js";
+export * from "./registry.js";