@cuylabs/agent-runtime-dapr 0.5.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

package/README.md

@@ -0,0 +1,260 @@
+# @cuylabs/agent-runtime-dapr
+
+Run AI agents with **Dapr durability** — crash-safe workflows, persistent state,
+and scheduled jobs. Built on `@cuylabs/agent-core` and `@cuylabs/agent-runtime`.
+
+## Why Dapr?
+
+Dapr provides the durable infrastructure while your agent owns the intelligence:
+
+```
+Your code (agent + tools)  ←→  Dapr sidecar (state, workflows, jobs)
+```
+
+- **Crash recovery** — if the process dies mid-turn, Dapr resumes from the last checkpoint.
+- **Persistent state** — execution history, sessions, and checkpoints survive restarts.
+- **Scheduled jobs** — trigger agent work on a cron schedule via Dapr Jobs API.
+- **Zero vendor lock-in** — Dapr runs anywhere: local Docker, Kubernetes, cloud.
+
+## Installation
+
+```bash
+pnpm add @cuylabs/agent-runtime-dapr @cuylabs/agent-core @dapr/dapr
+```
+
+Focused imports are also available when you want the package surface to mirror the internal modules:
+
+```ts
+import { createDaprExecutionObserver } from "@cuylabs/agent-runtime-dapr/execution";
+import { createDaprAgentRunner } from "@cuylabs/agent-runtime-dapr/host";
+import { DaprWorkflowClient } from "@cuylabs/agent-runtime-dapr/workflow";
+```
+
+## Quick Start
+
+### Step 1: Define your agent
+
+```ts
+import { createAgent, Tool } from "@cuylabs/agent-core";
+import { openai } from "@ai-sdk/openai";
+import { z } from "zod";
+
+const greetTool = Tool.define("greet", {
+  description: "Greet someone by name.",
+  parameters: z.object({ name: z.string() }),
+  execute: async ({ name }) => ({
+    title: `Greeted ${name}`,
+    output: `Hello, ${name}!`,
+    metadata: {},
+  }),
+});
+
+const agent = createAgent({
+  model: openai("gpt-4o"),
+  cwd: process.cwd(),
+  systemPrompt: "You are a helpful assistant. Use the greet tool when asked.",
+  maxSteps: 10,
+  tools: [greetTool],
+});
+```
+
+### Step 2: Create the runner
+
+```ts
+import { WorkflowRuntime } from "@dapr/dapr";
+import { createDaprAgentRunner } from "@cuylabs/agent-runtime-dapr";
+
+const runner = createDaprAgentRunner({
+  agent,
+  name: "my-agent",
+  workflowRuntime: new WorkflowRuntime(),
+});
+
+await runner.serve({ port: 3000 });
+```
+
+### Step 3: Start with Dapr
+
+```bash
+dapr run --app-id my-agent --dapr-grpc-port 50001 -- npx tsx my-agent.ts
+```
+
+### Step 4: Send requests
+
+```bash
+# Direct execution (synchronous)
+curl -s http://localhost:3000/agents/run \
+  -H "Content-Type: application/json" \
+  -d '{"message": "Greet Carlos"}' | jq
+
+# Durable workflow (async, crash-recoverable)
+curl -s http://localhost:3000/agents/workflow \
+  -H "Content-Type: application/json" \
+  -d '{"message": "Greet Carlos"}' | jq
+```
+
+That's it. The runner handles workflow registration, HTTP server, runtime wiring,
+logging, and graceful shutdown.
+
+## Multi-Agent Host
+
+Run multiple agents in a single process with `createDaprMultiAgentRunner()`:
+
+```ts
+import { createDaprMultiAgentRunner } from "@cuylabs/agent-runtime-dapr";
+
+const runner = createDaprMultiAgentRunner({
+  agents: [
+    { agent: greeter, name: "greeter" },
+    { agent: calculator, name: "calculator" },
+  ],
+  workflowRuntime: new WorkflowRuntime(),
+});
+
+await runner.serve({ port: 3000 });
+```
+
+Each agent gets its own workflow definition, execution store, and logging —
+but they share a single Dapr sidecar, workflow worker, and HTTP port.
+
+```bash
+# Target a specific agent by URL path
+curl -s http://localhost:3000/agents/greeter/run \
+  -H "Content-Type: application/json" \
+  -d '{"message": "Say hi to Alice"}' | jq
+```
+
+## Two Execution Modes
+
+Every agent host exposes two ways to run a turn:
+
+| Mode | Endpoint | Behavior |
+|------|----------|----------|
+| **Direct** | `POST /agents/run` | Synchronous. Returns result in the HTTP response. State is persisted, but execution is not crash-recoverable. |
+| **Workflow** | `POST /agents/workflow` | Asynchronous. Returns `202` with an `instanceId` immediately. The turn runs as a Dapr workflow — crash-safe with activity-level checkpoints. |
+
+The workflow decomposes each turn into four activities:
+
+```
+model-step → tool-call → step-commit → output-commit
+```
+
+Each activity is a checkpoint. If the process crashes after `tool-call`, Dapr
+replays from that point — the model call and tool execution don't repeat.
+
+## HTTP API Reference
+
+| Method | Path | Description |
+|--------|------|-------------|
+| `GET` | `/health` | Liveness check |
+| `GET` | `/healthz` | Liveness alias |
+| `GET` | `/ready` | Readiness check |
+| `GET` | `/readyz` | Readiness alias |
+| `GET` | `/agents` | List registered agents |
+| `POST` | `/agents/run` | Run agent turn (direct) |
+| `POST` | `/agents/workflow` | Run agent turn (durable workflow) |
+| `POST` | `/agents/:id/run` | Run specific agent (direct) |
+| `POST` | `/agents/:id/workflow` | Run specific agent (durable workflow) |
+| `GET` | `/agents/:id/executions/:sessionId` | Get execution details |
+| `GET` | `/agents/:id/executions/:sessionId/checkpoints` | Get execution checkpoints |
+| `GET` | `/agents/:id/workflows/:instanceId` | Get workflow state |
+| `POST` | `/job/:name` | Handle Dapr scheduled job trigger |
+
+## Runner Options
+
+`createDaprAgentRunner()` accepts these options:
+
+| Option | Required | Default | Description |
+|--------|----------|---------|-------------|
+| `agent` | Yes | — | The `Agent` instance |
+| `name` | No | `agent.name` | Agent ID in the Dapr ecosystem |
+| `workflowRuntime` | Yes | — | `new WorkflowRuntime()` from `@dapr/dapr` |
+| `daprHttpEndpoint` | No | `http://$DAPR_HOST:$DAPR_HTTP_PORT` | Sidecar HTTP endpoint |
+| `stateStoreName` | No | `"statestore"` | Dapr state store component |
+| `driverOptions` | No | — | Advanced Dapr runtime driver options: API token, retries, timeouts, custom `fetch`, sidecar verification |
+| `observers` | No | `[]` | Extra execution lifecycle observers |
+| `logging` | No | `true` | Enable/disable console logging |
+| `logPrefix` | No | `[${name}]` | Log line prefix |
+| `aliases` | No | `[]` | Alternative names for agent lookup |
+
+The runner returns an object with:
+
+- `start()` — start runtime and workflow worker
+- `serve(options?)` — start HTTP server, block on SIGINT/SIGTERM
+- `run(message, options?)` — run a task programmatically
+- `stop()` — graceful shutdown
+
+Runner startup is transactional: if the workflow worker fails to start, the
+runtime is stopped before the error is returned.
+
+## Retention and Cleanup
+
+Durability needs explicit retention. The package exposes cleanup methods on both durable stores so hosts can trim history without reaching into raw Dapr state.
+
+```ts
+await runtimeBundle.executionStore.cleanup({
+  maxAgeMs: 7 * 24 * 60 * 60 * 1000,
+  maxCheckpointsPerExecution: 20,
+});
+
+await runStore.cleanup({
+  maxAgeMs: 30 * 24 * 60 * 60 * 1000,
+  maxRuns: 10_000,
+});
+```
+
+The intended production pattern is to schedule cleanup as ordinary runtime work rather than relying on ad hoc scripts.
+
+## Going Deeper
+
+For advanced use cases (custom workflow shapes, custom HTTP handlers, cross-service
+invocation), the package also exports the lower-level building blocks:
+
+| Helper | Purpose |
+|--------|---------|
+| `createDaprAgentWorkflowHost()` | Wrap an Agent into a workflow host |
+| `createDaprWorkflowWorker()` | Register workflow hosts in a WorkflowRuntime |
+| `createDaprAgentRuntime()` | Create runtime bundle (scheduling + runner + store) |
+| `startDaprHostHttpServer()` | Start the HTTP control surface |
+| `DaprWorkflowClient` | Manage workflow instances via HTTP API |
+| `DaprRuntimeDriver` | Low-level `RuntimeDriver` for Dapr state |
+| `DaprExecutionStore` | Persistent execution snapshots and checkpoints |
+| `createDaprExecutionObserver()` | Persist execution events to the store |
+| `createDaprLoggingObserver()` | Console logging for execution lifecycle |
+| `DaprServiceInvoker` | Call agents across Dapr service boundaries |
+
+See the [docs/](docs/) folder for detailed guides:
+
+- [Architecture](docs/architecture.md) — how the three packages compose
+- [Workflow Internals](docs/workflow-internals.md) — the 4-activity decomposition
+- [API Reference](docs/api-reference.md) — all exported types and functions
+- [Advanced Patterns](docs/advanced-patterns.md) — cross-service invocation, custom observers, etc.
+
+## Examples
+
+The [`examples/`](examples/) directory has complete, runnable scripts:
+
+| Script | Lines | Description |
+|--------|-------|-------------|
+| [`simple-agent.ts`](examples/simple-agent.ts) | ~55 | Minimal agent with one tool |
+| [`coding-agent.ts`](examples/coding-agent.ts) | ~45 | File-system tools via `@cuylabs/agent-code` |
+| [`multi-agent.ts`](examples/multi-agent.ts) | ~85 | Two agents in one process |
+| [`maintenance-host.ts`](examples/maintenance-host.ts) | ~200 | Scheduled cleanup worker with `/metrics` and Dapr job callbacks |
+
+See the [examples README](examples/README.md) for step-by-step setup and usage.
+
+## Production Notes
+
+- `DaprRuntimeDriver` verifies the sidecar is reachable on startup (`verifySidecarOnStart`, default `true`)
+- Per-request timeout: 15s default (`requestTimeoutMs`)
+- Automatic retries for transient failures (`maxRequestRetries`, default `2`)
+- Supports Dapr API token authentication (`dapr-api-token` header)
+- `GET /ready` and `GET /readyz` report runtime, worker, sidecar, and state-store readiness
+- Dapr Jobs API calls are isolated behind an internal adapter so scheduler changes stay local to the Dapr package
+- Use `DaprExecutionStore.cleanup(...)` and `DaprOrchestratorRunStore.cleanup(...)` to enforce retention budgets
+- For a concrete operational service, see [`examples/maintenance-host.ts`](examples/maintenance-host.ts)
+- For containers: run one sidecar per app process, point `daprHttpEndpoint` at the local sidecar
+
+## License
+
+Apache-2.0