@ebowwa/channel-types 0.1.0 → 0.2.0

package/src/plugins/types.plugin.ts

@@ -0,0 +1,227 @@
+// src/plugins/types.plugin.ts
+
+import type { ChannelId } from "../index.js";
+import type {
+  ChannelConfigAdapter,
+  ChannelOutboundAdapter,
+  ChannelGatewayAdapter,
+  ChannelStatusAdapter,
+  ChannelThreadingAdapter,
+  ChannelMessagingAdapter,
+  ChannelOnboardingAdapter,
+} from "./types.adapters.js";
+
+// ============================================================
+// CHANNEL META
+// ============================================================
+
+export interface ChannelMeta {
+  /** Human-readable label */
+  label: string;
+
+  /** Short description */
+  blurb?: string;
+
+  /** Path to documentation */
+  docsPath?: string;
+
+  /** Icon (emoji or URL) */
+  icon?: string;
+
+  /** System image for UI */
+  systemImage?: string;
+
+  /** Allow quickstart from this channel */
+  quickstartAllowFrom?: boolean;
+}
+
+// ============================================================
+// CHANNEL CAPABILITIES
+// ============================================================
+
+export interface ChannelCapabilities {
+  /** Supported chat types */
+  chatTypes: ("direct" | "group" | "channel" | "thread")[];
+
+  /** Feature flags */
+  supports: {
+    text: boolean;
+    media: boolean;
+    replies: boolean;
+    threads: boolean;
+    reactions: boolean;
+    editing: boolean;
+    streaming: boolean;
+    polls?: boolean;
+    buttons?: boolean;
+    cards?: boolean;
+  };
+
+  /** Native commands (e.g., /help) */
+  nativeCommands?: boolean;
+
+  /** Block streaming (some channels don't support it) */
+  blockStreaming?: boolean;
+
+  /** Media constraints */
+  media?: {
+    maxFileSize?: number;
+    supportedMimeTypes?: string[];
+  };
+
+  /** Rate limits */
+  rateLimits?: {
+    messagesPerMinute?: number;
+    charactersPerMessage?: number;
+  };
+}
+
+// ============================================================
+// CHANNEL PLUGIN (OpenClaw Pattern)
+// ============================================================
+
+/**
+ * Channel plugin interface following OpenClaw adapter pattern.
+ * Composable adapters for different channel capabilities.
+ */
+export interface ChannelPlugin<ResolvedAccount = unknown> {
+  /** Unique channel identifier */
+  id: string;
+
+  /** Display metadata */
+  meta: ChannelMeta;
+
+  /** Channel capabilities */
+  capabilities: ChannelCapabilities;
+
+  // Adapters (compose only what you need)
+
+  /** Account/config management */
+  config: ChannelConfigAdapter<ResolvedAccount>;
+
+  /** Message delivery */
+  outbound?: ChannelOutboundAdapter<ResolvedAccount>;
+
+  /** Account lifecycle (start/stop monitoring) */
+  gateway?: ChannelGatewayAdapter<ResolvedAccount>;
+
+  /** Health probes and audits */
+  status?: ChannelStatusAdapter<ResolvedAccount>;
+
+  /** Threading support */
+  threading?: ChannelThreadingAdapter;
+
+  /** Target normalization */
+  messaging?: ChannelMessagingAdapter;
+
+  /** Setup wizard */
+  onboarding?: ChannelOnboardingAdapter;
+}
+
+// ============================================================
+// LEGACY PLUGIN TYPES (for backward compatibility)
+// ============================================================
+
+/**
+ * @deprecated Use ChannelPlugin with adapters instead
+ */
+export interface LegacyChannelPlugin {
+  /** Unique plugin identifier (e.g., "telegram", "discord") */
+  id: string;
+
+  /** Human-readable name */
+  name: string;
+
+  /** Plugin description */
+  description?: string;
+
+  /** Plugin version */
+  version?: string;
+
+  /** Channel capabilities */
+  capabilities: ChannelCapabilities;
+
+  /** Supported chat types (dm, group, channel, etc.) */
+  chatTypes?: string[];
+
+  /** Create channel connector instance */
+  create: (config: unknown) => ChannelConnectorInstance;
+
+  /** Validate configuration */
+  validateConfig?: (config: unknown) => ValidationResult;
+
+  /** Default configuration template */
+  defaultConfig?: Record<string, unknown>;
+}
+
+/**
+ * Channel connector instance created by plugin.
+ * Minimal interface for runtime channel operations.
+ */
+export interface ChannelConnectorInstance {
+  /** Channel ID */
+  id: ChannelId;
+
+  /** Start the connector */
+  start(): Promise<void>;
+
+  /** Stop the connector */
+  stop(): Promise<void>;
+
+  /** Send message */
+  send(message: unknown): Promise<void>;
+
+  /** Check if connected */
+  isConnected(): boolean;
+}
+
+// ============================================================
+// VALIDATION TYPES
+// ============================================================
+
+export interface ValidationResult {
+  valid: boolean;
+  errors?: string[];
+}
+
+// ============================================================
+// PLUGIN LIFECYCLE TYPES
+// ============================================================
+
+export interface PluginLifecycle {
+  /** Called when plugin is loaded */
+  onLoad?(): Promise<void> | void;
+
+  /** Called when plugin is unloaded */
+  onUnload?(): Promise<void> | void;
+
+  /** Called before channel is created */
+  beforeCreate?(config: unknown): Promise<unknown> | unknown;
+
+  /** Called after channel is created */
+  afterCreate?(channel: ChannelConnectorInstance): Promise<void> | void;
+}
+
+// ============================================================
+// PLUGIN METADATA
+// ============================================================
+
+export interface PluginMetadata {
+  /** Plugin author */
+  author?: string;
+
+  /** Plugin homepage */
+  homepage?: string;
+
+  /** Plugin repository */
+  repository?: string;
+
+  /** Plugin license */
+  license?: string;
+
+  /** Plugin tags */
+  tags?: string[];
+
+  /** Plugin dependencies */
+  dependencies?: string[];
+}

package/tsconfig.json

@@ -1,20 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "ESNext",
-    "moduleResolution": "bundler",
-    "lib": ["ES2022"],
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "resolveJsonModule": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
-}