zeitlich 0.2.11 → 0.2.13

package/dist/index.d.cts

@@ -1,60 +1,38 @@
-import { A as AgentResponse, a as ActivityToolHandler, G as GlobArgs, F as FileEditArgs, B as BashArgs, S as SkillProvider, b as SkillMetadata, c as Skill } from './workflow-BhjsEQc1.cjs';
-export { d as AgentConfig, e as AgentFile, f as AgentState, g as AgentStateManager, h as AgentStatus, i as AppendToolResultFn, j as AskUserQuestionArgs, k as BaseAgentState, l as BaseThreadManager, m as FileReadArgs, n as FileWriteArgs, o as GrepArgs, I as InferToolResults, J as JsonPrimitive, p as JsonSerializable, q as JsonValue, P as ParsedToolCall, r as ParsedToolCallUnion, s as PostToolUseFailureHook, t as PostToolUseFailureHookContext, u as PostToolUseFailureHookResult, v as PostToolUseHook, w as PostToolUseHookContext, x as PreToolUseHook, y as PreToolUseHookContext, z as PreToolUseHookResult, C as ProcessToolCallsContext, R as RawToolCall, D as ReadSkillArgs, E as RunAgentActivity, H as RunAgentConfig, K as SessionEndHook, L as SessionEndHookContext, M as SessionExitReason, N as SessionLifecycleHooks, O as SessionStartHook, Q as SessionStartHookContext, T as SubagentArgs, U as SubagentConfig, V as SubagentHooks, W as SubagentInput, X as SubagentWorkflow, Y as TaskCreateArgs, Z as TaskGetArgs, _ as TaskListArgs, $ as TaskStatus, a0 as TaskUpdateArgs, a1 as ThreadManager, a2 as ThreadManagerConfig, a3 as ThreadOps, a4 as ToolArgs, a5 as ToolCallResult, a6 as ToolCallResultUnion, a7 as ToolDefinition, a8 as ToolHandler, a9 as ToolHandlerContext, aa as ToolHandlerResponse, ab as ToolHooks, ac as ToolMap, ad as ToolMessageContent, ae as ToolNames, af as ToolResult, ag as ToolResultConfig, ah as ToolRouter, ai as ToolWithHandler, aj as WorkflowTask, ak as ZeitlichSession, al as ZeitlichSharedActivities, am as agentQueryName, an as agentStateChangeUpdateName, ao as askUserQuestionTool, ap as bashTool, aq as createAgentStateManager, ar as createAskUserQuestionHandler, as as createBashToolDescription, at as createReadSkillHandler, au as createReadSkillTool, av as createSession, aw as createSharedActivities, ax as createSubagentTool, ay as createTaskCreateHandler, az as createTaskGetHandler, aA as createTaskListHandler, aB as createTaskUpdateHandler, aC as createThreadManager, aD as createToolRouter, aE as defineSubagent, aF as defineTool, aG as editTool, aH as globTool, aI as grepTool, aJ as hasNoOtherToolCalls, aK as isTerminalStatus, aL as parseSkillFile, aM as proxyDefaultThreadOps, aN as readFileTool, aO as taskCreateTool, aP as taskGetTool, aQ as taskListTool, aR as taskUpdateTool, aS as withAutoAppend, aT as writeFileTool } from './workflow-BhjsEQc1.cjs';
-import { SimplePlugin } from '@temporalio/plugin';
-import Redis from 'ioredis';
+import { GlobArgs, FileEditArgs, BashArgs } from './workflow.cjs';
+export { AgentState, AgentStateManager, AskUserQuestionArgs, FileReadArgs, FileWriteArgs, GrepArgs, JsonPrimitive, JsonSerializable, JsonValue, ReadSkillArgs, SessionLifecycleHooks, TaskCreateArgs, TaskGetArgs, TaskListArgs, TaskUpdateArgs, ZeitlichSession, askUserQuestionTool, bashTool, createAgentStateManager, createAskUserQuestionHandler, createBashToolDescription, createReadSkillHandler, createReadSkillTool, createSession, createTaskCreateHandler, createTaskGetHandler, createTaskListHandler, createTaskUpdateHandler, editTool, getShortId, globTool, grepTool, parseSkillFile, proxyDefaultThreadOps, readFileTool, taskCreateTool, taskGetTool, taskListTool, taskUpdateTool, writeFileTool } from './workflow.cjs';
+import { M as ModelInvoker, R as RunAgentConfig, A as AgentResponse, b as ActivityToolHandler, S as SkillProvider, c as SkillMetadata, d as Skill } from './model-invoker-y_zlyMqu.cjs';
+export { e as AgentConfig, f as AgentFile, g as AgentStatus, h as AppendToolResultFn, B as BaseAgentState, C as ContentPart, H as Hooks, I as InferToolResults, i as MessageContent, a as ModelInvokerConfig, P as ParsedToolCall, j as ParsedToolCallUnion, k as PostHumanMessageAppendHook, l as PostHumanMessageAppendHookContext, m as PostToolUseFailureHook, n as PostToolUseFailureHookContext, o as PostToolUseFailureHookResult, p as PostToolUseHook, q as PostToolUseHookContext, r as PreHumanMessageAppendHook, s as PreHumanMessageAppendHookContext, t as PreToolUseHook, u as PreToolUseHookContext, v as PreToolUseHookResult, w as ProcessToolCallsContext, x as RawToolCall, y as RunAgentActivity, z as SessionConfig, D as SessionEndHook, E as SessionEndHookContext, F as SessionExitReason, G as SessionStartHook, J as SessionStartHookContext, K as SubagentArgs, L as SubagentConfig, N as SubagentHooks, O as SubagentInput, Q as SubagentWorkflow, U as TaskStatus, T as ThreadOps, V as TokenUsage, W as ToolArgs, X as ToolCallResult, Y as ToolCallResultUnion, Z as ToolDefinition, _ as ToolHandler, $ as ToolHandlerContext, a0 as ToolHandlerResponse, a1 as ToolHooks, a2 as ToolMap, a3 as ToolMessageContent, a4 as ToolNames, a5 as ToolResult, a6 as ToolResultConfig, a7 as ToolRouter, a8 as ToolWithHandler, a9 as WorkflowTask, aa as agentQueryName, ab as agentStateChangeUpdateName, ac as createSubagentTool, ad as createToolRouter, ae as defineSubagent, af as defineTool, ag as hasNoOtherToolCalls, ah as isTerminalStatus, ai as withAutoAppend } from './model-invoker-y_zlyMqu.cjs';
+export { B as BaseThreadManager, T as ThreadManagerConfig, c as createThreadManager } from './thread-manager-qc0g5Rvd.cjs';
 import { WorkflowClient } from '@temporalio/client';
-import { BaseChatModel, BaseChatModelCallOptions, BindToolsInput } from '@langchain/core/language_models/chat_models';
 import { IFileSystem, BashOptions } from 'just-bash';
 import '@temporalio/workflow';
-import '@langchain/core/messages';
+import '@temporalio/common/lib/interfaces';
 import 'zod';
 import '@temporalio/common';
-import '@temporalio/common/lib/interfaces';
+import 'ioredis';
 
 /**
- * Options for the Zeitlich plugin
- *
- * @experimental The Zeitlich plugin is an experimental feature; APIs may change without notice.
+ * Query the parent workflow's state from within an activity.
+ * Resolves the workflow handle from the current activity context.
  */
-interface ZeitlichPluginOptions {
-    redis: Redis;
-}
+declare function queryParentWorkflowState<T>(client: WorkflowClient, queryName: string): Promise<T>;
 /**
- * A Temporal plugin that integrates Zeitlich for use in workflows.
- * This plugin creates shared activities for thread management.
- * Workflow-specific activities (like runAgent) should be created separately.
+ * Wraps a `ModelInvoker` into a `RunAgentActivity` by automatically
+ * loading tool definitions from the parent workflow state via query.
  *
- * @experimental The Zeitlich plugin is an experimental feature; APIs may change without notice.
- */
-declare class ZeitlichPlugin extends SimplePlugin {
-    constructor(options: ZeitlichPluginOptions);
-}
-
-/**
- * Configuration for invoking the model
- */
-interface InvokeModelConfig {
-    threadId: string;
-    agentName: string;
-}
-/**
- * Core model invocation logic - shared utility for workflow-specific activities
+ * This is the generic bridge between any provider-specific model invoker
+ * and the session's `runAgent` contract.
+ *
+ * @example
+ * ```typescript
+ * import { createRunAgentActivity } from 'zeitlich';
+ * import { createLangChainModelInvoker } from 'zeitlich/adapters/langchain';
  *
- * @param options - Named options object
- * @param options.redis - Redis client for thread management
- * @param options.config - Model invocation configuration (threadId, agentName)
- * @param options.model - Pre-instantiated LangChain chat model
- * @param options.client - Temporal WorkflowClient for querying workflow state
- * @returns Agent response with message and metadata
+ * const invoker = createLangChainModelInvoker({ redis, model });
+ * return { runAgent: createRunAgentActivity(client, invoker) };
+ * ```
  */
-declare function invokeModel({ redis, model, client, config: { threadId, agentName }, }: {
-    redis: Redis;
-    client: WorkflowClient;
-    config: InvokeModelConfig;
-    model: BaseChatModel<BaseChatModelCallOptions & {
-        tools?: BindToolsInput;
-    }>;
-}): Promise<AgentResponse>;
+declare function createRunAgentActivity<M>(client: WorkflowClient, invoker: ModelInvoker<M>): (config: RunAgentConfig) => Promise<AgentResponse<M>>;
 
 /**
  * Result of a glob operation
@@ -93,8 +71,46 @@ type BashExecOut = {
 };
 /** BashOptions with `fs` required */
 type BashToolOptions = Required<Pick<BashOptions, "fs">> & Omit<BashOptions, "fs">;
+/**
+ * Creates a Bash tool handler that executes shell commands in a sandboxed environment.
+ *
+ * @param bashOptions - Options including a required `fs` (file system implementation from `just-bash`)
+ * @returns Activity tool handler for Bash tool calls
+ *
+ * @example
+ * ```typescript
+ * import { createBashHandler } from 'zeitlich';
+ *
+ * const bashHandlerActivity = createBashHandler({ fs: inMemoryFileSystem });
+ * ```
+ */
 declare const createBashHandler: (bashOptions: BashToolOptions) => ActivityToolHandler<BashArgs, BashExecOut | null>;
 
+/**
+ * Generates a formatted file tree string from an `IFileSystem` instance.
+ * Useful for including filesystem context in agent prompts.
+ *
+ * @param fs - File system implementation (e.g. from `just-bash`)
+ * @param opts - Optional configuration for tree generation
+ * @param opts.dir - Root directory to start from (defaults to `/`)
+ * @param opts.separator - Path separator (`/` or `\\`, defaults to `/`)
+ * @param opts.depth - Maximum directory depth (defaults to 10)
+ * @param opts.sort - Sort entries alphabetically with directories first (defaults to true)
+ * @returns Formatted file tree string
+ *
+ * @example
+ * ```typescript
+ * import { toTree } from 'zeitlich';
+ *
+ * const fileTree = await toTree(inMemoryFileSystem);
+ * // Returns:
+ * // /
+ * // ├─ src/
+ * // │  ├─ index.ts
+ * // │  └─ utils.ts
+ * // └─ package.json
+ * ```
+ */
 declare const toTree: (fs: IFileSystem, opts?: {
     dir?: string;
     separator?: "/" | "\\";
@@ -129,4 +145,4 @@ declare class FileSystemSkillProvider implements SkillProvider {
     private discoverSkillDirs;
 }
 
-export { ActivityToolHandler, AgentResponse, BashArgs, FileEditArgs, FileSystemSkillProvider, GlobArgs, type InvokeModelConfig, Skill, SkillMetadata, SkillProvider, ZeitlichPlugin, type ZeitlichPluginOptions, createBashHandler, createEditHandler, createGlobHandler, invokeModel, toTree };
+export { ActivityToolHandler, AgentResponse, BashArgs, FileEditArgs, FileSystemSkillProvider, GlobArgs, ModelInvoker, RunAgentConfig, Skill, SkillMetadata, SkillProvider, createBashHandler, createEditHandler, createGlobHandler, createRunAgentActivity, queryParentWorkflowState, toTree };

package/dist/index.d.ts

@@ -1,60 +1,38 @@
-import { A as AgentResponse, a as ActivityToolHandler, G as GlobArgs, F as FileEditArgs, B as BashArgs, S as SkillProvider, b as SkillMetadata, c as Skill } from './workflow-BhjsEQc1.js';
-export { d as AgentConfig, e as AgentFile, f as AgentState, g as AgentStateManager, h as AgentStatus, i as AppendToolResultFn, j as AskUserQuestionArgs, k as BaseAgentState, l as BaseThreadManager, m as FileReadArgs, n as FileWriteArgs, o as GrepArgs, I as InferToolResults, J as JsonPrimitive, p as JsonSerializable, q as JsonValue, P as ParsedToolCall, r as ParsedToolCallUnion, s as PostToolUseFailureHook, t as PostToolUseFailureHookContext, u as PostToolUseFailureHookResult, v as PostToolUseHook, w as PostToolUseHookContext, x as PreToolUseHook, y as PreToolUseHookContext, z as PreToolUseHookResult, C as ProcessToolCallsContext, R as RawToolCall, D as ReadSkillArgs, E as RunAgentActivity, H as RunAgentConfig, K as SessionEndHook, L as SessionEndHookContext, M as SessionExitReason, N as SessionLifecycleHooks, O as SessionStartHook, Q as SessionStartHookContext, T as SubagentArgs, U as SubagentConfig, V as SubagentHooks, W as SubagentInput, X as SubagentWorkflow, Y as TaskCreateArgs, Z as TaskGetArgs, _ as TaskListArgs, $ as TaskStatus, a0 as TaskUpdateArgs, a1 as ThreadManager, a2 as ThreadManagerConfig, a3 as ThreadOps, a4 as ToolArgs, a5 as ToolCallResult, a6 as ToolCallResultUnion, a7 as ToolDefinition, a8 as ToolHandler, a9 as ToolHandlerContext, aa as ToolHandlerResponse, ab as ToolHooks, ac as ToolMap, ad as ToolMessageContent, ae as ToolNames, af as ToolResult, ag as ToolResultConfig, ah as ToolRouter, ai as ToolWithHandler, aj as WorkflowTask, ak as ZeitlichSession, al as ZeitlichSharedActivities, am as agentQueryName, an as agentStateChangeUpdateName, ao as askUserQuestionTool, ap as bashTool, aq as createAgentStateManager, ar as createAskUserQuestionHandler, as as createBashToolDescription, at as createReadSkillHandler, au as createReadSkillTool, av as createSession, aw as createSharedActivities, ax as createSubagentTool, ay as createTaskCreateHandler, az as createTaskGetHandler, aA as createTaskListHandler, aB as createTaskUpdateHandler, aC as createThreadManager, aD as createToolRouter, aE as defineSubagent, aF as defineTool, aG as editTool, aH as globTool, aI as grepTool, aJ as hasNoOtherToolCalls, aK as isTerminalStatus, aL as parseSkillFile, aM as proxyDefaultThreadOps, aN as readFileTool, aO as taskCreateTool, aP as taskGetTool, aQ as taskListTool, aR as taskUpdateTool, aS as withAutoAppend, aT as writeFileTool } from './workflow-BhjsEQc1.js';
-import { SimplePlugin } from '@temporalio/plugin';
-import Redis from 'ioredis';
+import { GlobArgs, FileEditArgs, BashArgs } from './workflow.js';
+export { AgentState, AgentStateManager, AskUserQuestionArgs, FileReadArgs, FileWriteArgs, GrepArgs, JsonPrimitive, JsonSerializable, JsonValue, ReadSkillArgs, SessionLifecycleHooks, TaskCreateArgs, TaskGetArgs, TaskListArgs, TaskUpdateArgs, ZeitlichSession, askUserQuestionTool, bashTool, createAgentStateManager, createAskUserQuestionHandler, createBashToolDescription, createReadSkillHandler, createReadSkillTool, createSession, createTaskCreateHandler, createTaskGetHandler, createTaskListHandler, createTaskUpdateHandler, editTool, getShortId, globTool, grepTool, parseSkillFile, proxyDefaultThreadOps, readFileTool, taskCreateTool, taskGetTool, taskListTool, taskUpdateTool, writeFileTool } from './workflow.js';
+import { M as ModelInvoker, R as RunAgentConfig, A as AgentResponse, b as ActivityToolHandler, S as SkillProvider, c as SkillMetadata, d as Skill } from './model-invoker-y_zlyMqu.js';
+export { e as AgentConfig, f as AgentFile, g as AgentStatus, h as AppendToolResultFn, B as BaseAgentState, C as ContentPart, H as Hooks, I as InferToolResults, i as MessageContent, a as ModelInvokerConfig, P as ParsedToolCall, j as ParsedToolCallUnion, k as PostHumanMessageAppendHook, l as PostHumanMessageAppendHookContext, m as PostToolUseFailureHook, n as PostToolUseFailureHookContext, o as PostToolUseFailureHookResult, p as PostToolUseHook, q as PostToolUseHookContext, r as PreHumanMessageAppendHook, s as PreHumanMessageAppendHookContext, t as PreToolUseHook, u as PreToolUseHookContext, v as PreToolUseHookResult, w as ProcessToolCallsContext, x as RawToolCall, y as RunAgentActivity, z as SessionConfig, D as SessionEndHook, E as SessionEndHookContext, F as SessionExitReason, G as SessionStartHook, J as SessionStartHookContext, K as SubagentArgs, L as SubagentConfig, N as SubagentHooks, O as SubagentInput, Q as SubagentWorkflow, U as TaskStatus, T as ThreadOps, V as TokenUsage, W as ToolArgs, X as ToolCallResult, Y as ToolCallResultUnion, Z as ToolDefinition, _ as ToolHandler, $ as ToolHandlerContext, a0 as ToolHandlerResponse, a1 as ToolHooks, a2 as ToolMap, a3 as ToolMessageContent, a4 as ToolNames, a5 as ToolResult, a6 as ToolResultConfig, a7 as ToolRouter, a8 as ToolWithHandler, a9 as WorkflowTask, aa as agentQueryName, ab as agentStateChangeUpdateName, ac as createSubagentTool, ad as createToolRouter, ae as defineSubagent, af as defineTool, ag as hasNoOtherToolCalls, ah as isTerminalStatus, ai as withAutoAppend } from './model-invoker-y_zlyMqu.js';
+export { B as BaseThreadManager, T as ThreadManagerConfig, c as createThreadManager } from './thread-manager-qc0g5Rvd.js';
 import { WorkflowClient } from '@temporalio/client';
-import { BaseChatModel, BaseChatModelCallOptions, BindToolsInput } from '@langchain/core/language_models/chat_models';
 import { IFileSystem, BashOptions } from 'just-bash';
 import '@temporalio/workflow';
-import '@langchain/core/messages';
+import '@temporalio/common/lib/interfaces';
 import 'zod';
 import '@temporalio/common';
-import '@temporalio/common/lib/interfaces';
+import 'ioredis';
 
 /**
- * Options for the Zeitlich plugin
- *
- * @experimental The Zeitlich plugin is an experimental feature; APIs may change without notice.
+ * Query the parent workflow's state from within an activity.
+ * Resolves the workflow handle from the current activity context.
  */
-interface ZeitlichPluginOptions {
-    redis: Redis;
-}
+declare function queryParentWorkflowState<T>(client: WorkflowClient, queryName: string): Promise<T>;
 /**
- * A Temporal plugin that integrates Zeitlich for use in workflows.
- * This plugin creates shared activities for thread management.
- * Workflow-specific activities (like runAgent) should be created separately.
+ * Wraps a `ModelInvoker` into a `RunAgentActivity` by automatically
+ * loading tool definitions from the parent workflow state via query.
  *
- * @experimental The Zeitlich plugin is an experimental feature; APIs may change without notice.
- */
-declare class ZeitlichPlugin extends SimplePlugin {
-    constructor(options: ZeitlichPluginOptions);
-}
-
-/**
- * Configuration for invoking the model
- */
-interface InvokeModelConfig {
-    threadId: string;
-    agentName: string;
-}
-/**
- * Core model invocation logic - shared utility for workflow-specific activities
+ * This is the generic bridge between any provider-specific model invoker
+ * and the session's `runAgent` contract.
+ *
+ * @example
+ * ```typescript
+ * import { createRunAgentActivity } from 'zeitlich';
+ * import { createLangChainModelInvoker } from 'zeitlich/adapters/langchain';
  *
- * @param options - Named options object
- * @param options.redis - Redis client for thread management
- * @param options.config - Model invocation configuration (threadId, agentName)
- * @param options.model - Pre-instantiated LangChain chat model
- * @param options.client - Temporal WorkflowClient for querying workflow state
- * @returns Agent response with message and metadata
+ * const invoker = createLangChainModelInvoker({ redis, model });
+ * return { runAgent: createRunAgentActivity(client, invoker) };
+ * ```
  */
-declare function invokeModel({ redis, model, client, config: { threadId, agentName }, }: {
-    redis: Redis;
-    client: WorkflowClient;
-    config: InvokeModelConfig;
-    model: BaseChatModel<BaseChatModelCallOptions & {
-        tools?: BindToolsInput;
-    }>;
-}): Promise<AgentResponse>;
+declare function createRunAgentActivity<M>(client: WorkflowClient, invoker: ModelInvoker<M>): (config: RunAgentConfig) => Promise<AgentResponse<M>>;
 
 /**
  * Result of a glob operation
@@ -93,8 +71,46 @@ type BashExecOut = {
 };
 /** BashOptions with `fs` required */
 type BashToolOptions = Required<Pick<BashOptions, "fs">> & Omit<BashOptions, "fs">;
+/**
+ * Creates a Bash tool handler that executes shell commands in a sandboxed environment.
+ *
+ * @param bashOptions - Options including a required `fs` (file system implementation from `just-bash`)
+ * @returns Activity tool handler for Bash tool calls
+ *
+ * @example
+ * ```typescript
+ * import { createBashHandler } from 'zeitlich';
+ *
+ * const bashHandlerActivity = createBashHandler({ fs: inMemoryFileSystem });
+ * ```
+ */
 declare const createBashHandler: (bashOptions: BashToolOptions) => ActivityToolHandler<BashArgs, BashExecOut | null>;
 
+/**
+ * Generates a formatted file tree string from an `IFileSystem` instance.
+ * Useful for including filesystem context in agent prompts.
+ *
+ * @param fs - File system implementation (e.g. from `just-bash`)
+ * @param opts - Optional configuration for tree generation
+ * @param opts.dir - Root directory to start from (defaults to `/`)
+ * @param opts.separator - Path separator (`/` or `\\`, defaults to `/`)
+ * @param opts.depth - Maximum directory depth (defaults to 10)
+ * @param opts.sort - Sort entries alphabetically with directories first (defaults to true)
+ * @returns Formatted file tree string
+ *
+ * @example
+ * ```typescript
+ * import { toTree } from 'zeitlich';
+ *
+ * const fileTree = await toTree(inMemoryFileSystem);
+ * // Returns:
+ * // /
+ * // ├─ src/
+ * // │  ├─ index.ts
+ * // │  └─ utils.ts
+ * // └─ package.json
+ * ```
+ */
 declare const toTree: (fs: IFileSystem, opts?: {
     dir?: string;
     separator?: "/" | "\\";
@@ -129,4 +145,4 @@ declare class FileSystemSkillProvider implements SkillProvider {
     private discoverSkillDirs;
 }
 
-export { ActivityToolHandler, AgentResponse, BashArgs, FileEditArgs, FileSystemSkillProvider, GlobArgs, type InvokeModelConfig, Skill, SkillMetadata, SkillProvider, ZeitlichPlugin, type ZeitlichPluginOptions, createBashHandler, createEditHandler, createGlobHandler, invokeModel, toTree };
+export { ActivityToolHandler, AgentResponse, BashArgs, FileEditArgs, FileSystemSkillProvider, GlobArgs, ModelInvoker, RunAgentConfig, Skill, SkillMetadata, SkillProvider, createBashHandler, createEditHandler, createGlobHandler, createRunAgentActivity, queryParentWorkflowState, toTree };