@lyriel/openclaw-plugin 0.1.0 → 0.1.2

package/README.md

@@ -5,82 +5,13 @@ with the Hermes plugin — a Hermes user and an OpenClaw user coordinate
 through Lyriel without either one knowing what runtime the other is on,
 because both runtimes integrate against the same HTTP substrate API.
 
-## What you get
-
-- 🪶 **Inbound surfacing.** Lyriel asks and group-plan updates arrive in your
-  active OpenClaw session as the next turn's context. A daemon long-polls
-  `/api/inbox` and injects each dispatch via
-  `api.session.workflow.enqueueNextTurnInjection`, so the next thing your
-  agent says to you references the incoming Lyriel ask.
-- **Five LLM tools** so you drive Lyriel in natural language:
-  - `lyriel_send_ask` — "ping @noor about dinner thursday"
-  - `lyriel_reply` — "reply yes thursday works"
-  - `lyriel_plan_send` — "start a plan with @noor and @maya about dinner"
-  - `lyriel_plan_reply` — "tell the plan I can do friday too"
-  - `lyriel_plan_lock` — "lock the plan at thursday 7pm Mission Cantina"
-- **Full agent context** when drafting Lyriel replies — your OpenClaw
-  memory, calendar tools, preferences, etc. are all available to the LLM.
-- **Channel-agnostic.** Works no matter which messaging channel your
-  OpenClaw is connected to (Telegram, Signal, Discord, iMessage, etc.). The
-  surfacing path uses the host-owned next-turn injection surface rather
-  than a specific channel adapter, so there's nothing to wire per platform.
-
 ## Install
 
-### Local development (against a globally-installed OpenClaw)
-
-OpenClaw's `--link` install path expects compiled JavaScript output, not raw
-TypeScript (source-checkout fallback only applies inside the openclaw monorepo
-itself). One-time setup from this directory:
-
-```bash
-# 1. Symlink the global openclaw runtime so tsc can resolve plugin-sdk types.
-mkdir -p node_modules
-ln -sfn /opt/homebrew/lib/node_modules/openclaw node_modules/openclaw
-
-# 2. Install local build deps.
-npm install --no-save typebox typescript
-
-# 3. Re-create the openclaw symlink (npm install clobbers it).
-ln -sfn /opt/homebrew/lib/node_modules/openclaw node_modules/openclaw
-
-# 4. Build to dist/.
-npx tsc -p tsconfig.build.json
-
-# 5. Link the plugin into OpenClaw.
-openclaw plugins install --link "$(pwd)"
-
-# 6. Restart so the runtime picks up the new plugin.
-openclaw gateway restart
-```
-
-Re-run `npx tsc -p tsconfig.build.json` after any edit to the `*.ts` files;
-the gateway re-reads `dist/` on the next plugin reload.
-
-### Bundled (in-tree development against the openclaw monorepo)
-
-```bash
-cd /path/to/openclaw
-ln -s /path/to/lyriel-repo/clients/openclaw-plugin extensions/lyriel
-pnpm install
-pnpm test -- extensions/lyriel/
-```
-
-The bundled path discovers TS source directly; no precompile needed.
-
-### Published (from npm)
-
 ```bash
 npm install -g @lyriel/openclaw-plugin
 openclaw plugins install @lyriel/openclaw-plugin
 ```
 
-The `prepare` script in package.json builds `dist/` on install, so the
-plugin is ready as soon as npm finishes. `openclaw plugins install`
-then registers it with the OpenClaw runtime. ClawHub publish
-(`openclaw plugins install clawhub:lyriel/openclaw-plugin`) is a v0.2
-follow-up that wraps the same npm package.
-
 ## Configure
 
 OpenClaw config lives at `~/.openclaw/openclaw.json`. Add a `plugins.entries.lyriel`
@@ -93,8 +24,7 @@ block alongside whatever other plugin entries you already have:
       "lyriel": {
         "enabled": true,
         "config": {
-          "apiKey": "lyk_xxxxxxxxxxxxxxxx",
-          "baseUrl": "https://lyriel.ai"
+          "apiKey": "lyk_xxxxxxxxxxxxxxxx"
         }
       }
     }
@@ -103,91 +33,16 @@ block alongside whatever other plugin entries you already have:
 ```
 
 - `apiKey` — your `lyk_...` from https://lyriel.ai/me/agent (required)
-- `baseUrl` — defaults to `https://lyriel.ai`; override for dev
-  (`http://localhost:5173`) or a cloudflared tunnel
-- `surfaceSessionKey` — optional. Pin a specific session for inbound surfacing;
-  otherwise the plugin auto-tracks the most recently active session.
+- `baseUrl` — defaults to `https://lyriel.ai`; only set this for dev (localhost or a tunnel)
 
 Prefer editing the file via `openclaw config` so the gateway picks up changes
 without manual JSON re-parsing.
 
-If `surfaceSessionKey` is unset, the plugin tracks the most recent session
-that received any user message and injects Lyriel surfaces there. The first
-inbound dispatch may not surface until you've engaged at least once after
-gateway start.
-
-## How it works
-
-```
-                ┌───────────────────────────────────────────────────────┐
-                │           OpenClaw Gateway (always-on)                │
-                │                                                       │
-   register()   │  ┌──────────────────┐    ┌─────────────────────────┐  │
-   ─────────▶   │  │ Inbox poll loop  │    │ LLM tool handlers       │  │
-                │  │ (gateway_start)  │    │ lyriel_send_ask         │  │
-                │  └─────────┬────────┘    │ lyriel_reply            │  │
-                │            │             │ lyriel_plan_send        │  │
-                │            ▼             │ lyriel_plan_reply       │  │
-                │  pending.ts (ask_id /    │ lyriel_plan_lock        │  │
-                │   plan_id → callback)    └────────────┬────────────┘  │
-                │            │                          │               │
-                │            ▼                          │               │
-                │  api.session.workflow.                │               │
-                │    enqueueNextTurnInjection({         │               │
-                │      sessionKey,                      │               │
-                │      text: formatted surface,         │               │
-                │    })                                 │               │
-                │            │                          │               │
-                └────────────┼──────────────────────────┼───────────────┘
-                             │                          │
-                             ▼                          ▼
-                ┌───────────────────────────────────────────────────────┐
-                │                User's OpenClaw session                │
-                │                                                       │
-                │  Next agent turn picks up:                            │
-                │  🪶 Lyriel ask from @noor: "dinner thursday?"         │
-                │                                                       │
-                │  User says: "yes thursday works"                      │
-                │                                                       │
-                │  LLM calls lyriel_reply → plugin POSTs callback       │
-                └───────────────────────────────────────────────────────┘
-```
-
-## Comparison with the Hermes plugin
-
-| | Hermes plugin | This plugin |
-|---|---|---|
-| Language | Python | TypeScript |
-| Surface path | Hermes `inject_message` (CLI) + gateway Telegram adapter | OpenClaw `enqueueNextTurnInjection` (channel-agnostic) |
-| Background task | `threading.Thread(daemon=True)` | `gateway_start` lifecycle hook + `setTimeout` loop |
-| Tool registration | `ctx.register_tool` | `api.registerTool` |
-| Pending callback state | in-process `dict` | in-process `Map` |
-| Proactive notification | yes — Telegram push | no — appears on next agent turn |
-
-The "no proactive push" gap is deliberate. OpenClaw users connect via many
-possible channels; surfacing through next-turn injection is one path that
-works for all of them. A truly push-notification path can be added later
-once we know which channel design partners actually live in.
-
-## Cross-provider interop
-
-The whole point of having a plugin per provider: a user can be on Hermes
-and address a friend who's on OpenClaw (or vice versa) and neither side
-needs to know about the other's runtime. The provider adapter on Lyriel's
-server (`web/src/lib/server/agents/{hermes,openclaw}.ts`) dispatches into
-each user's provider via that provider's inbound API. This plugin is the
-client-side half of the OpenClaw integration.
-
-End-to-end: Hermes user → Hermes Lyriel plugin → Lyriel API → Lyriel
-OpenClaw adapter → OpenClaw `/v1/chat/completions` → user's OpenClaw
-agent → OpenClaw Lyriel plugin (this) → callback → Lyriel → Hermes Lyriel
-plugin surfaces the reply.
 
 ## Troubleshooting
 
 **"apiKey missing" warning in logs.** Set `plugins.entries.lyriel.config.apiKey`
-to your `lyk_...` token from `https://lyriel.ai/me/agent` (or your
-`LYRIEL_BASE_URL` equivalent). Restart the gateway after editing config.
+to your `lyk_...` token from `https://lyriel.ai/me/agent`. Restart the gateway after editing config.
 
 **Tools register but inbox dispatches never appear.** Most likely cause:
 the user hasn't sent any message after gateway start, so the plugin doesn't
@@ -198,45 +53,10 @@ poll cycle will surface accumulated dispatches.
 envelope didn't match the expected pattern. Likely a Lyriel server version
 mismatch — re-pair your agent at `/me/agent` for a fresh setup.
 
-**Surfaces arrive but in the wrong session.** Set
-`plugins.entries.lyriel.config.surfaceSessionKey` to pin a specific session.
+**Surfaces arrive but in the wrong session.** Set `plugins.entries.lyriel.config.surfaceSessionKey` to pin a specific session.
 The auto-tracking heuristic ("most recent message_received") may pick up
 short-lived sub-sessions; pinning is more predictable.
 
 **Hot reload.** OpenClaw plugin reloads keep durable session extension
 state and re-run cleanup callbacks. The inbox loop stops cleanly on
 `gateway_stop` and restarts on the next `gateway_start`.
-
-## v0 limitations
-
-- **In-process pending map.** If the gateway restarts mid-flight, pending
-  callback tokens are lost. The user will see "no pending Lyriel asks" if
-  they try to reply to an ask that arrived before the restart. Move to
-  `api.runtime.state.openKeyedStore` to survive restarts.
-- **One-pending-per-ask.** If multiple asks pile up, the LLM disambiguates
-  via ask_id (shown in each surface message).
-- **No truly proactive push.** Dispatches surface on the next agent turn
-  in the configured session. Adding per-channel push is a v0.2 task.
-- **Single user per OpenClaw gateway.** One `apiKey` per plugin instance.
-  Multi-user gateways aren't supported yet.
-
-## Publishing
-
-The package is `@lyriel/openclaw-plugin` on npm. Prerequisites: an npm
-account with publish rights on the `@lyriel` scope (claim it once with
-`npm org create lyriel`), authenticated via `npm login`.
-
-```bash
-# 1. Bump the version in package.json (and openclaw.plugin.json if the
-#    OpenClaw-facing version should track).
-# 2. Publish. prepublishOnly runs the TypeScript build into dist/ first;
-#    the files whitelist in package.json scopes the tarball to dist/ +
-#    openclaw.plugin.json.
-npm publish
-```
-
-`publishConfig.access: public` in package.json lets the scoped
-package go up without `--access public` on the command line. After
-publish, the install paste-prompt (`npm install -g
-@lyriel/openclaw-plugin && openclaw plugins install
-@lyriel/openclaw-plugin`) resolves to the new version.

package/package.json

@@ -1,19 +1,11 @@
 {
   "name": "@lyriel/openclaw-plugin",
-  "version": "0.1.0",
-  "description": "Lyriel plugin for OpenClaw. Long-polls Lyriel's /api/inbox, surfaces inbound dispatches into the user's active OpenClaw session via next-turn injection, and registers five LLM tools (lyriel_send_ask, lyriel_reply, lyriel_plan_send, lyriel_plan_reply, lyriel_plan_lock) so the user drives Lyriel in natural language. Cross-provider parity with the Hermes plugin: a Hermes user and an OpenClaw user can coordinate through Lyriel without either knowing what runtime the other is on.",
+  "version": "0.1.2",
+  "description": "Lyriel plugin for OpenClaw.",
   "type": "module",
   "license": "MIT",
   "author": "Lyriel",
   "homepage": "https://lyriel.ai",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/CharlieKerfoot/agent-net.git",
-    "directory": "clients/openclaw-plugin"
-  },
-  "bugs": {
-    "url": "https://github.com/CharlieKerfoot/agent-net/issues"
-  },
   "keywords": [
     "lyriel",
     "openclaw",
@@ -38,6 +30,7 @@
     "typebox": "1.1.38"
   },
   "devDependencies": {
+    "openclaw": "^2026.5.20",
     "typescript": "^5.5.0"
   },
   "peerDependencies": {