@reminix/runtime 0.0.13 → 0.0.16

package/dist/agent.d.ts

@@ -1,7 +1,12 @@
 /**
  * Agent classes for Reminix Runtime.
  */
-import type { ExecuteRequest, ExecuteResponse, Message } from './types.js';
+import type { AgentInvokeRequest, AgentInvokeResponse, JSONSchema, Capabilities } from './types.js';
+/**
+ * Named agent templates with predefined input/output schemas.
+ * The default template is 'prompt'; use it when no template or input/output is provided.
+ */
+export type AgentTemplate = 'prompt' | 'chat' | 'task' | 'rag' | 'thread';
 /**
  * Web-standard fetch handler type.
  */
@@ -10,22 +15,22 @@ export type FetchHandler = (request: Request) => Promise<Response>;
  * Metadata returned by agents for discovery.
  */
 export interface AgentMetadata {
-    type: 'agent' | 'chat_agent' | 'adapter';
-    adapter?: string;
-    /** Top-level keys expected in request body (besides stream, context) */
-    requestKeys?: string[];
-    /** Top-level keys returned in response */
-    responseKeys?: string[];
+    description?: string;
+    capabilities: Capabilities;
+    input: JSONSchema;
+    output?: JSONSchema;
+    /** Named template (prompt, chat, task, rag, thread) when agent uses a template. */
+    template?: AgentTemplate;
     [key: string]: unknown;
 }
 /**
- * Handler type for execute requests.
+ * Handler type for invoke requests.
  */
-export type ExecuteHandler = (request: ExecuteRequest) => Promise<ExecuteResponse>;
+export type InvokeHandler = (request: AgentInvokeRequest) => Promise<AgentInvokeResponse>;
 /**
- * Handler type for streaming execute requests.
+ * Handler type for streaming invoke requests.
  */
-export type ExecuteStreamHandler = (request: ExecuteRequest) => AsyncGenerator<string, void, unknown>;
+export type InvokeStreamHandler = (request: AgentInvokeRequest) => AsyncGenerator<string, void, unknown>;
 /**
  * Abstract base class defining the agent interface.
  *
@@ -34,10 +39,6 @@ export type ExecuteStreamHandler = (request: ExecuteRequest) => AsyncGenerator<s
  * `AgentAdapter` for framework adapters.
  */
 export declare abstract class AgentBase {
-    /**
-     * Whether execute supports streaming. Override to enable.
-     */
-    get streaming(): boolean;
     /**
      * Return the agent name.
      */
@@ -48,13 +49,13 @@ export declare abstract class AgentBase {
      */
     get metadata(): AgentMetadata;
     /**
-     * Handle an execute request.
+     * Handle an invoke request.
      */
-    abstract execute(request: ExecuteRequest): Promise<ExecuteResponse>;
+    abstract invoke(request: AgentInvokeRequest): Promise<AgentInvokeResponse>;
     /**
-     * Handle a streaming execute request.
+     * Handle a streaming invoke request.
      */
-    executeStream(_request: ExecuteRequest): AsyncGenerator<string, void, unknown>;
+    invokeStream(_request: AgentInvokeRequest): AsyncGenerator<string, void, unknown>;
     /**
      * Create a web-standard fetch handler for this agent.
      *
@@ -92,8 +93,8 @@ export declare abstract class AgentBase {
 export declare class Agent extends AgentBase {
     private readonly _name;
     private readonly _metadata;
-    private _executeHandler;
-    private _executeStreamHandler;
+    private _invokeHandler;
+    private _invokeStreamHandler;
     /**
      * Create a new agent.
      *
@@ -101,7 +102,7 @@ export declare class Agent extends AgentBase {
      * @param options - Optional configuration
      */
     constructor(name: string, options?: {
-        metadata?: Record<string, unknown>;
+        metadata?: Partial<AgentMetadata>;
     });
     /**
      * Return the agent name.
@@ -111,10 +112,6 @@ export declare class Agent extends AgentBase {
      * Return agent metadata for discovery.
      */
     get metadata(): AgentMetadata;
-    /**
-     * Whether execute supports streaming.
-     */
-    get streaming(): boolean;
     /**
      * Register a handler.
      *
@@ -123,25 +120,25 @@ export declare class Agent extends AgentBase {
      *   return { output: 'Hello!' };
      * });
      */
-    handler(fn: ExecuteHandler): this;
+    handler(fn: InvokeHandler): this;
     /**
      * Register a streaming handler.
      *
      * @example
      * agent.streamHandler(async function* (request) {
-     *   yield '{"chunk": "Hello"}';
-     *   yield '{"chunk": " world!"}';
+     *   yield 'Hello';
+     *   yield ' world!';
      * });
      */
-    streamHandler(fn: ExecuteStreamHandler): this;
+    streamHandler(fn: InvokeStreamHandler): this;
     /**
-     * Handle an execute request.
+     * Handle an invoke request.
      */
-    execute(request: ExecuteRequest): Promise<ExecuteResponse>;
+    invoke(request: AgentInvokeRequest): Promise<AgentInvokeResponse>;
     /**
-     * Handle a streaming execute request.
+     * Handle a streaming invoke request.
      */
-    executeStream(request: ExecuteRequest): AsyncGenerator<string, void, unknown>;
+    invokeStream(request: AgentInvokeRequest): AsyncGenerator<string, void, unknown>;
 }
 /**
  * Options for creating an agent with the agent() factory.
@@ -149,76 +146,58 @@ export declare class Agent extends AgentBase {
 export interface AgentOptions {
     /** Human-readable description of what the agent does */
     description?: string;
-    /** Optional metadata for discovery */
-    metadata?: Record<string, unknown>;
     /**
-     * JSON Schema for input parameters.
-     * The keys in `properties` become the top-level request keys.
-     * Defaults to { prompt: string } if not provided.
+     * Named template (prompt, chat, task). When set, input/output default to the template's schemas
+     * unless overridden by explicit input/output.
      */
-    parameters?: {
-        type: 'object';
-        properties: Record<string, unknown>;
-        required?: string[];
-    };
-    /** JSON Schema for output */
-    output?: Record<string, unknown>;
+    template?: AgentTemplate;
     /**
-     * Handler function - can be a regular async function or an async generator for streaming.
-     *
-     * Regular function: Returns output directly
-     * Async generator: Yields string chunks (automatically collected for non-streaming requests)
+     * JSON Schema for input.
+     * Defaults to template schema if template is set, else { prompt: string }.
      */
-    handler: ((input: Record<string, unknown>, context?: Record<string, unknown>) => Promise<unknown>) | ((input: Record<string, unknown>, context?: Record<string, unknown>) => AsyncGenerator<string, void, unknown>);
-}
-/**
- * Options for creating a chat agent with the chatAgent() factory.
- */
-export interface ChatAgentOptions {
-    /** Human-readable description of what the agent does */
-    description?: string;
-    /** Optional metadata for discovery */
-    metadata?: Record<string, unknown>;
+    input?: JSONSchema;
+    /** JSON Schema for output. Defaults to template schema if set, else string. */
+    output?: JSONSchema;
     /**
      * Handler function - can be a regular async function or an async generator for streaming.
      *
-     * Regular function: Returns a list of Message objects
+     * Regular function: Returns output directly
      * Async generator: Yields string chunks (automatically collected for non-streaming requests)
      */
-    handler: ((messages: Message[], context?: Record<string, unknown>) => Promise<Message[]>) | ((messages: Message[], context?: Record<string, unknown>) => AsyncGenerator<string, void, unknown>);
+    handler: ((input: Record<string, unknown>, context?: Record<string, unknown>) => Promise<unknown>) | ((input: Record<string, unknown>, context?: Record<string, unknown>) => AsyncGenerator<string, void, unknown>);
 }
 /**
  * Create an agent from a configuration object.
  *
- * By default, agents expect `{ prompt: string }` in the request body and
- * return `{ output: ... }`. You can customize by providing `parameters`.
+ * By default, agents expect `{ input: { prompt: string } }` in the request body and
+ * return `{ output: string }`. You can customize by providing `input` schema.
  *
  * @example
  * ```typescript
- * // Simple agent with default parameters
- * // Request: { prompt: 'Hello world' }
+ * // Simple agent with default input/output
+ * // Request: { input: { prompt: 'Hello world' } }
  * // Response: { output: 'You said: Hello world' }
  * const echo = agent('echo', {
  *   description: 'Echo the prompt',
  *   handler: async ({ prompt }) => `You said: ${prompt}`,
  * });
  *
- * // Agent with custom parameters
- * // Request: { a: 1, b: 2 }
+ * // Agent with custom input schema
+ * // Request: { input: { a: 1, b: 2 } }
  * // Response: { output: 3 }
  * const calculator = agent('calculator', {
  *   description: 'Add two numbers',
- *   parameters: {
+ *   input: {
  *     type: 'object',
  *     properties: { a: { type: 'number' }, b: { type: 'number' } },
  *     required: ['a', 'b'],
  *   },
+ *   output: { type: 'number' },
  *   handler: async ({ a, b }) => (a as number) + (b as number),
  * });
  *
  * // Streaming agent (async generator)
- * // Request: { prompt: 'hello world' }
- * // Response: { output: 'hello world ' } (streamed)
+ * // Request: { input: { prompt: 'hello world' }, stream: true }
  * const streamer = agent('streamer', {
  *   description: 'Stream text word by word',
  *   handler: async function* ({ prompt }) {
@@ -230,38 +209,4 @@ export interface ChatAgentOptions {
  * ```
  */
 export declare function agent(name: string, options: AgentOptions): Agent;
-/**
- * Create a chat agent from a configuration object.
- *
- * This is a convenience factory that creates an agent with a standard chat
- * interface (messages in, messages out).
- *
- * Request: `{ messages: [...] }`
- * Response: `{ messages: [{ role: 'assistant', content: '...' }, ...] }`
- *
- * @example
- * ```typescript
- * // Non-streaming chat agent
- * // Request: { messages: [{ role: 'user', content: 'hello' }] }
- * // Response: { messages: [{ role: 'assistant', content: 'You said: hello' }] }
- * const bot = chatAgent('bot', {
- *   description: 'A simple chatbot',
- *   handler: async (messages) => {
- *     const lastMsg = messages.at(-1)?.content ?? '';
- *     return [{ role: 'assistant', content: `You said: ${lastMsg}` }];
- *   },
- * });
- *
- * // Streaming chat agent (async generator)
- * const streamingBot = chatAgent('streaming-bot', {
- *   description: 'A streaming chatbot',
- *   handler: async function* (messages) {
- *     yield 'Hello';
- *     yield ' ';
- *     yield 'world!';
- *   },
- * });
- * ```
- */
-export declare function chatAgent(name: string, options: ChatAgentOptions): Agent;
 //# sourceMappingURL=agent.d.ts.map

package/dist/agent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAe3E;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,OAAO,GAAG,YAAY,GAAG,SAAS,CAAC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wEAAwE;IACxE,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,0CAA0C;IAC1C,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,cAAc,KAAK,OAAO,CAAC,eAAe,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CACjC,OAAO,EAAE,cAAc,KACpB,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AAE3C;;;;;;GAMG;AACH,8BAAsB,SAAS;IAC7B;;OAEG;IACH,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED;;OAEG;IACH,QAAQ,KAAK,IAAI,IAAI,MAAM,CAAC;IAE5B;;;OAGG;IACH,IAAI,QAAQ,IAAI,aAAa,CAO5B;IAED;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAEnE;;OAEG;IAEI,aAAa,CAAC,QAAQ,EAAE,cAAc,GAAG,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC;IAIrF;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,IAAI,YAAY;CAuH1B;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,KAAM,SAAQ,SAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA0B;IAEpD,OAAO,CAAC,eAAe,CAA+B;IACtD,OAAO,CAAC,qBAAqB,CAAqC;IAElE;;;;;OAKG;gBACS,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE;IAM1E;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,aAAa,CAQ5B;IAED;;OAEG;IACH,IAAa,SAAS,IAAI,OAAO,CAEhC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,EAAE,cAAc,GAAG,IAAI;IAKjC;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,EAAE,oBAAoB,GAAG,IAAI;IAK7C;;OAEG;IACG,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAOhE;;OAEG;IACI,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC;CAMrF;AAMD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sCAAsC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC;;;;OAIG;IACH,UAAU,CAAC,EAAE;QACX,IAAI,EAAE,QAAQ,CAAC;QACf,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACpC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;KACrB,CAAC;IACF,6BAA6B;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC;;;;;OAKG;IACH,OAAO,EACH,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,GACzF,CAAC,CACC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC9B,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sCAAsC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC;;;;;OAKG;IACH,OAAO,EACH,CAAC,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,GAChF,CAAC,CACC,QAAQ,EAAE,OAAO,EAAE,EACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC9B,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;CACjD;AA0DD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,KAAK,CAkGhE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,GAAG,KAAK,CA+JxE"}
+{"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAGpG;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;AA+H1E;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,YAAY,CAAC;IAC3B,KAAK,EAAE,UAAU,CAAC;IAClB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,mFAAmF;IACnF,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAE1F;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAChC,OAAO,EAAE,kBAAkB,KACxB,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AAE3C;;;;;;GAMG;AACH,8BAAsB,SAAS;IAC7B;;OAEG;IACH,QAAQ,KAAK,IAAI,IAAI,MAAM,CAAC;IAE5B;;;OAGG;IACH,IAAI,QAAQ,IAAI,aAAa,CAM5B;IAED;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAE1E;;OAEG;IAEI,YAAY,CAAC,QAAQ,EAAE,kBAAkB,GAAG,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC;IAIxF;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,IAAI,YAAY;CAuH1B;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,KAAM,SAAQ,SAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAyB;IAEnD,OAAO,CAAC,cAAc,CAA8B;IACpD,OAAO,CAAC,oBAAoB,CAAoC;IAEhE;;;;;OAKG;gBACS,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAA;KAAE;IAMzE;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,aAAa,CAU5B;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI;IAKhC;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,EAAE,mBAAmB,GAAG,IAAI;IAK5C;;OAEG;IACG,MAAM,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAOvE;;OAEG;IACI,YAAY,CAAC,OAAO,EAAE,kBAAkB,GAAG,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC;CAMxF;AAMD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB;;;OAGG;IACH,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,+EAA+E;IAC/E,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB;;;;;OAKG;IACH,OAAO,EACH,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,GACzF,CAAC,CACC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC9B,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;CACjD;AAWD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,KAAK,CA2DhE"}