agent-relay 1.6.0 → 2.0.4

package/packages/hooks/dist/types.d.ts

@@ -0,0 +1,285 @@
+/**
+ * Agent Relay Hook Types
+ *
+ * Core types for the agent-relay hooks system. Hooks allow agents to intercept
+ * and modify behavior at various points in the agent lifecycle.
+ */
+import type { SendPayload } from '@agent-relay/protocol/types';
+/**
+ * A message in the conversation history
+ */
+export interface ConversationMessage {
+    /** Role of the message sender */
+    role: 'user' | 'assistant' | 'system';
+    /** Message content */
+    content: string;
+    /** Timestamp when the message was created */
+    timestamp?: number;
+}
+/**
+ * Output from the agent (tool calls, responses, etc.)
+ */
+export interface AgentOutput {
+    /** Type of output */
+    type: 'text' | 'tool_call' | 'tool_result';
+    /** Content of the output */
+    content: string;
+    /** Tool name if type is tool_call or tool_result */
+    tool?: string;
+    /** Timestamp of the output */
+    timestamp: number;
+}
+/**
+ * Memory interface for persisting data across hook invocations
+ */
+export interface HookMemory {
+    /** Get a value from memory */
+    get<T = unknown>(key: string): T | undefined;
+    /** Set a value in memory */
+    set<T = unknown>(key: string, value: T): void;
+    /** Delete a value from memory */
+    delete(key: string): boolean;
+    /** Check if a key exists */
+    has(key: string): boolean;
+    /** Clear all memory */
+    clear(): void;
+}
+/**
+ * Relay interface for sending messages to other agents
+ */
+export interface HookRelay {
+    /** Send a message to a specific agent or broadcast */
+    send(to: string | '*', body: string, options?: Partial<SendPayload>): Promise<void>;
+    /** Check if connected to the relay daemon */
+    isConnected(): boolean;
+    /** Get the current agent's name in the relay */
+    getAgentName(): string | undefined;
+}
+/**
+ * Context provided to hooks during execution
+ *
+ * This interface provides hooks with access to the current execution context,
+ * allowing them to inspect and modify agent behavior.
+ */
+export interface HookContext {
+    /** Unique identifier for this agent instance */
+    agentId: string;
+    /** Session identifier for the current conversation */
+    sessionId: string;
+    /** Working directory of the agent */
+    workingDir: string;
+    /** Environment variables available to the hook */
+    env: Record<string, string | undefined>;
+    /**
+     * Inject content into the agent's input stream.
+     * This content will be processed as if it came from the user.
+     * @param content - The content to inject
+     */
+    inject(content: string): void;
+    /**
+     * Send a message through the relay to other agents.
+     * @param to - Target agent name or '*' for broadcast
+     * @param body - Message body
+     * @param options - Optional message options
+     */
+    send(to: string | '*', body: string, options?: Partial<SendPayload>): Promise<void>;
+    /** Persistent memory for storing data across hook invocations */
+    memory: HookMemory;
+    /** Relay interface for agent communication */
+    relay: HookRelay;
+    /** Array of outputs from the current agent turn */
+    output: AgentOutput[];
+    /** Conversation message history */
+    messages: ConversationMessage[];
+}
+/**
+ * Result returned by a hook execution
+ *
+ * Hooks can modify agent behavior by returning specific fields:
+ * - inject: Add content to the agent's input
+ * - suppress: Prevent the triggering action from executing
+ * - stop: Halt further hook processing
+ */
+export interface HookResult {
+    /**
+     * Content to inject into the agent's input stream.
+     * If provided, this content will be processed as user input.
+     */
+    inject?: string;
+    /**
+     * If true, suppress the action that triggered the hook.
+     * For example, on a Stop hook, this would prevent the agent from stopping.
+     */
+    suppress?: boolean;
+    /**
+     * If true, stop processing any remaining hooks in the chain.
+     * The current hook's result will be the final result.
+     */
+    stop?: boolean;
+}
+/**
+ * Hook event types that can trigger hook execution
+ */
+export type HookEventType = 'PreToolCall' | 'PostToolCall' | 'Stop' | 'Start' | 'Error' | 'Message';
+/**
+ * Configuration for a hook
+ */
+export interface HookConfig {
+    /** The event type that triggers this hook */
+    event: HookEventType;
+    /** Command to execute for the hook */
+    command: string;
+    /** Optional working directory for the command */
+    workingDir?: string;
+    /** Optional timeout in milliseconds */
+    timeout?: number;
+    /** Whether this hook is enabled */
+    enabled?: boolean;
+}
+/**
+ * Handler function signature for programmatic hooks
+ */
+export type HookHandler = (context: HookContext) => HookResult | Promise<HookResult>;
+/**
+ * Extended context for session start hooks
+ */
+export interface SessionStartContext extends HookContext {
+    /** Task description if agent was started with a task */
+    task?: string;
+    /** Task ID if linked to external system */
+    taskId?: string;
+    /** Task source (e.g., 'beads', 'linear', 'github') */
+    taskSource?: string;
+}
+/**
+ * Extended context for session end hooks
+ */
+export interface SessionEndContext extends HookContext {
+    /** Exit code if available */
+    exitCode?: number;
+    /** Duration of the session in milliseconds */
+    duration: number;
+    /** Whether the session ended gracefully */
+    graceful: boolean;
+}
+/**
+ * Extended context for output hooks
+ */
+export interface OutputContext extends HookContext {
+    /** Cleaned output (ANSI codes stripped) */
+    content: string;
+    /** Raw output with ANSI codes */
+    rawContent: string;
+    /** Whether this is a complete line */
+    isComplete: boolean;
+}
+/**
+ * Extended context for message received hooks
+ */
+export interface MessageReceivedContext extends HookContext {
+    /** Sender agent name */
+    from: string;
+    /** Message body */
+    body: string;
+    /** Message ID */
+    messageId: string;
+    /** Thread ID if threaded */
+    thread?: string;
+}
+/**
+ * Extended context for message sent hooks
+ */
+export interface MessageSentContext extends HookContext {
+    /** Target agent name */
+    to: string;
+    /** Message body */
+    body: string;
+    /** Thread ID if threaded */
+    thread?: string;
+}
+/**
+ * Extended context for idle hooks
+ */
+export interface IdleContext extends HookContext {
+    /** Duration of inactivity in milliseconds */
+    idleDuration: number;
+    /** Number of times idle hook has fired this session */
+    idleCount: number;
+}
+/**
+ * Extended context for error hooks
+ */
+export interface ErrorContext extends HookContext {
+    /** The error that occurred */
+    error: Error;
+    /** Phase where error occurred (e.g., 'output', 'message', 'tool') */
+    phase?: string;
+}
+/**
+ * Lifecycle hook handler types
+ */
+export type OnSessionStartHook = (ctx: SessionStartContext) => Promise<HookResult | void> | HookResult | void;
+export type OnSessionEndHook = (ctx: SessionEndContext) => Promise<HookResult | void> | HookResult | void;
+export type OnOutputHook = (ctx: OutputContext) => Promise<HookResult | void> | HookResult | void;
+export type OnMessageReceivedHook = (ctx: MessageReceivedContext) => Promise<HookResult | void> | HookResult | void;
+export type OnMessageSentHook = (ctx: MessageSentContext) => Promise<HookResult | void> | HookResult | void;
+export type OnIdleHook = (ctx: IdleContext) => Promise<HookResult | void> | HookResult | void;
+export type OnErrorHook = (ctx: ErrorContext) => Promise<HookResult | void> | HookResult | void;
+/**
+ * Lifecycle hook definitions for registration
+ */
+export interface LifecycleHooks {
+    onSessionStart?: OnSessionStartHook | OnSessionStartHook[];
+    onSessionEnd?: OnSessionEndHook | OnSessionEndHook[];
+    onOutput?: OnOutputHook | OnOutputHook[];
+    onMessageReceived?: OnMessageReceivedHook | OnMessageReceivedHook[];
+    onMessageSent?: OnMessageSentHook | OnMessageSentHook[];
+    onIdle?: OnIdleHook | OnIdleHook[];
+    onError?: OnErrorHook | OnErrorHook[];
+}
+/**
+ * Lifecycle hook event names
+ */
+export type LifecycleHookEvent = 'sessionStart' | 'sessionEnd' | 'output' | 'messageReceived' | 'messageSent' | 'idle' | 'error';
+/**
+ * Pattern handler for custom namespaces (e.g., @deploy:, @notify:)
+ */
+export type PatternHandler = (target: string, message: string, ctx: HookContext) => Promise<HookResult | void> | HookResult | void;
+/**
+ * Memory configuration for hooks
+ */
+export interface HooksMemoryConfig {
+    /** Memory adapter type: 'inmemory', 'supermemory', etc. */
+    type?: string;
+    /** API key for external memory services */
+    apiKey?: string;
+    /** Custom API endpoint */
+    endpoint?: string;
+    /** Whether to inject memories on session start */
+    injectOnStart?: boolean;
+    /** Maximum memories to inject on start */
+    maxStartMemories?: number;
+    /** Whether to prompt for memory save on session end */
+    promptOnEnd?: boolean;
+    /** Whether to auto-save detected learnings (default: true) */
+    autoSave?: boolean;
+    /** Whether to track learnings for session-end summary (default: true) */
+    autoSaveOnEnd?: boolean;
+}
+/**
+ * Full hooks configuration
+ */
+export interface HooksConfig {
+    /** Lifecycle hooks */
+    hooks?: LifecycleHooks;
+    /** Pattern handlers by namespace */
+    patterns?: Record<string, PatternHandler | 'builtin'>;
+    /** Idle timeout in milliseconds (default: 30000) */
+    idleTimeout?: number;
+    /** Whether to enable trajectory tracking hooks */
+    trajectoryTracking?: boolean;
+    /** Memory system configuration */
+    memory?: HooksMemoryConfig | boolean;
+}
+export declare const HOOK_ABI_VERSION = 1;
+//# sourceMappingURL=types.d.ts.map

package/packages/hooks/dist/types.js

@@ -0,0 +1,10 @@
+/**
+ * Agent Relay Hook Types
+ *
+ * Core types for the agent-relay hooks system. Hooks allow agents to intercept
+ * and modify behavior at various points in the agent lifecycle.
+ */
+import { PROTOCOL_VERSION } from '@agent-relay/protocol';
+// Hook ABI version aligns with protocol wire version
+export const HOOK_ABI_VERSION = PROTOCOL_VERSION;
+//# sourceMappingURL=types.js.map

package/packages/hooks/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@agent-relay/hooks",
+  "version": "2.0.4",
+  "description": "Hook emitter, registry, and trajectory hooks for Agent Relay",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./inbox-check": {
+      "types": "./dist/inbox-check/index.d.ts",
+      "import": "./dist/inbox-check/index.js",
+      "default": "./dist/inbox-check/index.js"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/types.js",
+      "default": "./dist/types.js"
+    },
+    "./browser": {
+      "types": "./dist/browser.d.ts",
+      "import": "./dist/browser.js",
+      "default": "./dist/browser.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "dependencies": {
+    "@agent-relay/protocol": "2.0.4",
+    "@agent-relay/config": "2.0.4",
+    "@agent-relay/trajectory": "2.0.4"
+  },
+  "devDependencies": {
+    "@types/node": "^22.19.3",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AgentWorkforce/relay.git",
+    "directory": "packages/hooks"
+  }
+}

package/packages/mcp/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Agent Workforce Incorporated
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.