openclaw-event-server-plugin 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,929 @@
+/**
+ * OpenClaw Event Server Plugin
+ *
+ * Broadcasts raw internal/plugin hook events with a canonical envelope and
+ * emits synthetic agent status/activity events for downstream consumers.
+ */
+import { OpenClawPluginApi } from './runtime/types';
+declare function activate(api: OpenClawPluginApi): void;
+declare function deactivate(): Promise<void>;
+declare const plugin: {
+    id: string;
+    name: string;
+    version: string;
+    configSchema: {
+        type: string;
+        additionalProperties: boolean;
+        properties: {
+            enabled: {
+                type: string;
+                description: string;
+                default: boolean;
+            };
+            webhooks: {
+                type: string;
+                description: string;
+                items: {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        url: {
+                            type: string;
+                            description: string;
+                        };
+                        method: {
+                            type: string;
+                            enum: string[];
+                            default: string;
+                            description: string;
+                        };
+                        headers: {
+                            type: string;
+                            additionalProperties: {
+                                type: string;
+                            };
+                            description: string;
+                        };
+                        authToken: {
+                            type: string;
+                            description: string;
+                        };
+                        includeFullPayload: {
+                            type: string;
+                            default: boolean;
+                            description: string;
+                        };
+                    };
+                };
+                default: never[];
+            };
+            filters: {
+                type: string;
+                description: string;
+                properties: {
+                    includeTypes: {
+                        type: string;
+                        items: {
+                            type: string;
+                            enum: readonly import("./events").EventType[];
+                        };
+                        description: string;
+                    };
+                    excludeTypes: {
+                        type: string;
+                        items: {
+                            type: string;
+                            enum: readonly import("./events").EventType[];
+                        };
+                        description: string;
+                    };
+                    channelId: {
+                        type: string;
+                        description: string;
+                    };
+                    toolName: {
+                        type: string;
+                        description: string;
+                    };
+                    sessionId: {
+                        type: string;
+                        description: string;
+                    };
+                };
+            };
+            retry: {
+                type: string;
+                description: string;
+                properties: {
+                    maxAttempts: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                        default: number;
+                    };
+                    initialDelayMs: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                        default: number;
+                    };
+                    maxDelayMs: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                        default: number;
+                    };
+                    backoffMultiplier: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                        default: number;
+                    };
+                };
+            };
+            queue: {
+                type: string;
+                description: string;
+                properties: {
+                    maxSize: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                        default: number;
+                    };
+                    flushIntervalMs: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                        default: number;
+                    };
+                    persistToDisk: {
+                        type: string;
+                        default: boolean;
+                    };
+                    persistPath: {
+                        type: string;
+                        description: string;
+                    };
+                };
+            };
+            logging: {
+                type: string;
+                description: string;
+                properties: {
+                    debug: {
+                        type: string;
+                        default: boolean;
+                    };
+                    logSuccess: {
+                        type: string;
+                        default: boolean;
+                    };
+                    logErrors: {
+                        type: string;
+                        default: boolean;
+                    };
+                    logQueue: {
+                        type: string;
+                        default: boolean;
+                    };
+                };
+            };
+            status: {
+                type: string;
+                description: string;
+                properties: {
+                    workingWindowMs: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                        default: number;
+                        description: string;
+                    };
+                    sleepingWindowMs: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                        default: number;
+                        description: string;
+                    };
+                    tickIntervalMs: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                        default: number;
+                        description: string;
+                    };
+                    subagentIdleWindowMs: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                        default: number;
+                        description: string;
+                    };
+                };
+            };
+            redaction: {
+                type: string;
+                description: string;
+                properties: {
+                    enabled: {
+                        type: string;
+                        default: boolean;
+                    };
+                    replacement: {
+                        type: string;
+                        default: string;
+                    };
+                    fields: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                        default: string[];
+                    };
+                };
+            };
+            eventLog: {
+                type: string;
+                description: string;
+                properties: {
+                    enabled: {
+                        type: string;
+                        default: boolean;
+                    };
+                    path: {
+                        type: string;
+                        description: string;
+                        default: string;
+                    };
+                    maxFileSizeMb: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                        default: number;
+                        description: string;
+                    };
+                    format: {
+                        type: string;
+                        enum: string[];
+                        default: string;
+                    };
+                    minLevel: {
+                        type: string;
+                        enum: string[];
+                        default: string;
+                    };
+                    includeRuntimeLogs: {
+                        type: string;
+                        default: boolean;
+                    };
+                };
+            };
+            security: {
+                type: string;
+                description: string;
+                properties: {
+                    ws: {
+                        type: string;
+                        properties: {
+                            bindAddress: {
+                                type: string;
+                                default: string;
+                            };
+                            requireAuth: {
+                                type: string;
+                                default: boolean;
+                            };
+                            authToken: {
+                                type: string;
+                            };
+                            allowedOrigins: {
+                                type: string;
+                                items: {
+                                    type: string;
+                                };
+                                default: never[];
+                            };
+                            allowedIps: {
+                                type: string;
+                                items: {
+                                    type: string;
+                                };
+                                default: never[];
+                            };
+                        };
+                    };
+                    hmac: {
+                        type: string;
+                        properties: {
+                            enabled: {
+                                type: string;
+                                default: boolean;
+                            };
+                            secret: {
+                                type: string;
+                            };
+                            secretFilePath: {
+                                type: string;
+                                default: string;
+                            };
+                            algorithm: {
+                                type: string;
+                                enum: string[];
+                                default: string;
+                            };
+                        };
+                    };
+                };
+            };
+            correlationIdHeader: {
+                type: string;
+                default: string;
+            };
+            webhookTimeoutMs: {
+                type: string;
+                minimum: number;
+                maximum: number;
+                default: number;
+            };
+            hookBridge: {
+                type: string;
+                description: string;
+                properties: {
+                    enabled: {
+                        type: string;
+                        default: boolean;
+                    };
+                    dryRun: {
+                        type: string;
+                        default: boolean;
+                    };
+                    allowedActionDirs: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                        default: never[];
+                    };
+                    localScriptDefaults: {
+                        type: string;
+                        properties: {
+                            timeoutMs: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                            maxPayloadBytes: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                        };
+                    };
+                    actions: {
+                        type: string;
+                        additionalProperties: {
+                            type: string;
+                            properties: {
+                                type: {
+                                    type: string;
+                                    enum: string[];
+                                };
+                                url: {
+                                    type: string;
+                                };
+                                method: {
+                                    type: string;
+                                    enum: string[];
+                                };
+                                headers: {
+                                    type: string;
+                                    additionalProperties: {
+                                        type: string;
+                                    };
+                                };
+                                authToken: {
+                                    type: string;
+                                };
+                                path: {
+                                    type: string;
+                                };
+                                args: {
+                                    type: string;
+                                    items: {
+                                        type: string;
+                                    };
+                                };
+                                timeoutMs: {
+                                    type: string;
+                                };
+                                maxPayloadBytes: {
+                                    type: string;
+                                };
+                            };
+                            required: string[];
+                        };
+                        default: {};
+                    };
+                    rules: {
+                        type: string;
+                        default: never[];
+                        items: {
+                            type: string;
+                            properties: {
+                                id: {
+                                    type: string;
+                                };
+                                enabled: {
+                                    type: string;
+                                };
+                                action: {
+                                    type: string;
+                                };
+                                cooldownMs: {
+                                    type: string;
+                                    minimum: number;
+                                };
+                                coalesce: {
+                                    type: string;
+                                    properties: {
+                                        enabled: {
+                                            type: string;
+                                        };
+                                        keyFields: {
+                                            type: string;
+                                            items: {
+                                                type: string;
+                                            };
+                                        };
+                                        windowMs: {
+                                            type: string;
+                                            minimum: number;
+                                        };
+                                        strategy: {
+                                            type: string;
+                                            enum: string[];
+                                        };
+                                    };
+                                };
+                                when: {
+                                    type: string;
+                                    properties: {
+                                        eventType: {
+                                            oneOf: ({
+                                                type: string;
+                                                items?: undefined;
+                                            } | {
+                                                type: string;
+                                                items: {
+                                                    type: string;
+                                                };
+                                            })[];
+                                        };
+                                        toolName: {
+                                            oneOf: ({
+                                                type: string;
+                                                items?: undefined;
+                                            } | {
+                                                type: string;
+                                                items: {
+                                                    type: string;
+                                                };
+                                            })[];
+                                        };
+                                        agentId: {
+                                            oneOf: ({
+                                                type: string;
+                                                items?: undefined;
+                                            } | {
+                                                type: string;
+                                                items: {
+                                                    type: string;
+                                                };
+                                            })[];
+                                        };
+                                        sessionId: {
+                                            oneOf: ({
+                                                type: string;
+                                                items?: undefined;
+                                            } | {
+                                                type: string;
+                                                items: {
+                                                    type: string;
+                                                };
+                                            })[];
+                                        };
+                                        sessionKey: {
+                                            oneOf: ({
+                                                type: string;
+                                                items?: undefined;
+                                            } | {
+                                                type: string;
+                                                items: {
+                                                    type: string;
+                                                };
+                                            })[];
+                                        };
+                                        contains: {
+                                            type: string;
+                                            additionalProperties: {
+                                                type: string;
+                                            };
+                                        };
+                                        equals: {
+                                            type: string;
+                                            additionalProperties: {
+                                                oneOf: {
+                                                    type: string;
+                                                }[];
+                                            };
+                                        };
+                                        requiredPaths: {
+                                            type: string;
+                                            items: {
+                                                type: string;
+                                            };
+                                        };
+                                        typeChecks: {
+                                            type: string;
+                                            additionalProperties: {
+                                                type: string;
+                                                enum: string[];
+                                            };
+                                        };
+                                        inList: {
+                                            type: string;
+                                            additionalProperties: {
+                                                type: string;
+                                                items: {
+                                                    oneOf: {
+                                                        type: string;
+                                                    }[];
+                                                };
+                                            };
+                                        };
+                                        notInList: {
+                                            type: string;
+                                            additionalProperties: {
+                                                type: string;
+                                                items: {
+                                                    oneOf: {
+                                                        type: string;
+                                                    }[];
+                                                };
+                                            };
+                                        };
+                                        matchesRegex: {
+                                            type: string;
+                                            additionalProperties: {
+                                                type: string;
+                                            };
+                                        };
+                                        notMatchesRegex: {
+                                            type: string;
+                                            additionalProperties: {
+                                                type: string;
+                                            };
+                                        };
+                                        domainAllowlist: {
+                                            type: string;
+                                            items: {
+                                                type: string;
+                                            };
+                                        };
+                                        domainBlocklist: {
+                                            type: string;
+                                            items: {
+                                                type: string;
+                                            };
+                                        };
+                                        domainPath: {
+                                            type: string;
+                                        };
+                                        idleForMsGte: {
+                                            type: string;
+                                            minimum: number;
+                                        };
+                                        parentStatus: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                            required: string[];
+                        };
+                    };
+                    toolGuard: {
+                        type: string;
+                        properties: {
+                            enabled: {
+                                type: string;
+                                default: boolean;
+                            };
+                            dryRun: {
+                                type: string;
+                                default: boolean;
+                            };
+                            timeoutMs: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                            onError: {
+                                type: string;
+                                enum: string[];
+                                default: string;
+                            };
+                            scopeKeyBy: {
+                                type: string;
+                                enum: string[];
+                                default: string;
+                            };
+                            retryBackoffMs: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                            retryBackoffReason: {
+                                type: string;
+                            };
+                            approvalCacheTtlMs: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                            stopOnMatchDefault: {
+                                type: string;
+                                default: boolean;
+                            };
+                            redaction: {
+                                type: string;
+                                properties: {
+                                    enabled: {
+                                        type: string;
+                                        default: boolean;
+                                    };
+                                    replacement: {
+                                        type: string;
+                                        default: string;
+                                    };
+                                    fields: {
+                                        type: string;
+                                        items: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                            rules: {
+                                type: string;
+                                default: never[];
+                                items: {
+                                    type: string;
+                                    properties: {
+                                        id: {
+                                            type: string;
+                                        };
+                                        enabled: {
+                                            type: string;
+                                        };
+                                        priority: {
+                                            type: string;
+                                        };
+                                        action: {
+                                            type: string;
+                                        };
+                                        decision: {
+                                            type: string;
+                                            properties: {
+                                                block: {
+                                                    type: string;
+                                                };
+                                                blockReason: {
+                                                    type: string;
+                                                };
+                                                blockReasonTemplate: {
+                                                    type: string;
+                                                };
+                                                params: {
+                                                    type: string;
+                                                };
+                                            };
+                                        };
+                                        stopOnMatch: {
+                                            type: string;
+                                        };
+                                        cooldownMs: {
+                                            type: string;
+                                            minimum: number;
+                                        };
+                                        when: {
+                                            type: string;
+                                            properties: {
+                                                eventType: {
+                                                    oneOf: ({
+                                                        type: string;
+                                                        items?: undefined;
+                                                    } | {
+                                                        type: string;
+                                                        items: {
+                                                            type: string;
+                                                        };
+                                                    })[];
+                                                };
+                                                toolName: {
+                                                    oneOf: ({
+                                                        type: string;
+                                                        items?: undefined;
+                                                    } | {
+                                                        type: string;
+                                                        items: {
+                                                            type: string;
+                                                        };
+                                                    })[];
+                                                };
+                                                agentId: {
+                                                    oneOf: ({
+                                                        type: string;
+                                                        items?: undefined;
+                                                    } | {
+                                                        type: string;
+                                                        items: {
+                                                            type: string;
+                                                        };
+                                                    })[];
+                                                };
+                                                sessionId: {
+                                                    oneOf: ({
+                                                        type: string;
+                                                        items?: undefined;
+                                                    } | {
+                                                        type: string;
+                                                        items: {
+                                                            type: string;
+                                                        };
+                                                    })[];
+                                                };
+                                                sessionKey: {
+                                                    oneOf: ({
+                                                        type: string;
+                                                        items?: undefined;
+                                                    } | {
+                                                        type: string;
+                                                        items: {
+                                                            type: string;
+                                                        };
+                                                    })[];
+                                                };
+                                                contains: {
+                                                    type: string;
+                                                    additionalProperties: {
+                                                        type: string;
+                                                    };
+                                                };
+                                                equals: {
+                                                    type: string;
+                                                    additionalProperties: {
+                                                        oneOf: {
+                                                            type: string;
+                                                        }[];
+                                                    };
+                                                };
+                                                requiredPaths: {
+                                                    type: string;
+                                                    items: {
+                                                        type: string;
+                                                    };
+                                                };
+                                                typeChecks: {
+                                                    type: string;
+                                                    additionalProperties: {
+                                                        type: string;
+                                                        enum: string[];
+                                                    };
+                                                };
+                                                inList: {
+                                                    type: string;
+                                                    additionalProperties: {
+                                                        type: string;
+                                                        items: {
+                                                            oneOf: {
+                                                                type: string;
+                                                            }[];
+                                                        };
+                                                    };
+                                                };
+                                                notInList: {
+                                                    type: string;
+                                                    additionalProperties: {
+                                                        type: string;
+                                                        items: {
+                                                            oneOf: {
+                                                                type: string;
+                                                            }[];
+                                                        };
+                                                    };
+                                                };
+                                                matchesRegex: {
+                                                    type: string;
+                                                    additionalProperties: {
+                                                        type: string;
+                                                    };
+                                                };
+                                                notMatchesRegex: {
+                                                    type: string;
+                                                    additionalProperties: {
+                                                        type: string;
+                                                    };
+                                                };
+                                                domainAllowlist: {
+                                                    type: string;
+                                                    items: {
+                                                        type: string;
+                                                    };
+                                                };
+                                                domainBlocklist: {
+                                                    type: string;
+                                                    items: {
+                                                        type: string;
+                                                    };
+                                                };
+                                                domainPath: {
+                                                    type: string;
+                                                };
+                                                idleForMsGte: {
+                                                    type: string;
+                                                    minimum: number;
+                                                };
+                                                parentStatus: {
+                                                    type: string;
+                                                };
+                                            };
+                                        };
+                                    };
+                                    required: string[];
+                                };
+                            };
+                        };
+                    };
+                    runtime: {
+                        type: string;
+                        properties: {
+                            maxPendingEvents: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                            concurrency: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                            dropPolicy: {
+                                type: string;
+                                enum: string[];
+                                default: string;
+                            };
+                        };
+                    };
+                    telemetry: {
+                        type: string;
+                        properties: {
+                            highWatermarks: {
+                                type: string;
+                                items: {
+                                    type: string;
+                                    minimum: number;
+                                    maximum: number;
+                                };
+                                default: number[];
+                            };
+                            slowActionMs: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                            failureRateWindowMs: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                            failureRateThresholdPct: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                            failureRateMinSamples: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                            saturationWindowMs: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                default: number;
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+    activate: typeof activate;
+    deactivate: typeof deactivate;
+};
+export default plugin;
+//# sourceMappingURL=index.d.ts.map