@signetai/connector-openclaw 0.140.1

package/README.md

@@ -0,0 +1,71 @@
+# @signetai/connector-openclaw
+
+Signet connector for OpenClaw (and its earlier names: clawdbot, moltbot).
+
+## Overview
+
+Unlike other harnesses, OpenClaw reads `~/.agents/AGENTS.md` directly, so no
+generated output file is needed. Instead, this connector patches the JSON
+config to point OpenClaw at the Signet workspace and enables memory hooks.
+
+## Installation
+
+```bash
+npm install @signetai/connector-openclaw
+# or
+bun add @signetai/connector-openclaw
+```
+
+## Usage
+
+```typescript
+import { OpenClawConnector } from '@signetai/connector-openclaw';
+
+const connector = new OpenClawConnector();
+await connector.install('~/.agents');
+```
+
+## What It Does
+
+- Patches JSON config files: `~/.openclaw/openclaw.json`,
+  `~/.clawdbot/clawdbot.json`, `~/.moldbot/moldbot.json`,
+  `~/.moltbot/moltbot.json`
+- Also discovers config via modern env vars used by OpenClaw:
+  `OPENCLAW_CONFIG_PATH`, `CLAWDBOT_CONFIG_PATH`,
+  `OPENCLAW_STATE_DIR`, `CLAWDBOT_STATE_DIR`
+- State-dir discovery follows OpenClaw compatibility behavior and may
+  detect legacy config filenames in that directory (`clawdbot.json`,
+  `moldbot.json`, `moltbot.json`) in addition to `openclaw.json`
+- Preserves legacy env compatibility used by older installs:
+  `OPENCLAW_HOME`, `CLAWDBOT_HOME`, `MOLDBOT_HOME`, `MOLTBOT_HOME`,
+  `OPENCLAW_STATE_HOME`
+- Sets `agents.defaults.workspace` to point at `~/.agents`
+- Enables the `signet-memory` internal hook entry
+- Creates hook handler files in `~/.agents/hooks/agent-memory/` for
+  `/remember`, `/recall`, and `/context` commands
+
+## API
+
+### `install(basePath: string): Promise<InstallResult>`
+
+Install the connector. Patches all found OpenClaw config files and installs
+hook handler files.
+
+### `uninstall(basePath?: string): Promise<UninstallResult>`
+
+Uninstall the connector. Disables the `signet-memory` hook in all configs
+and removes hook handler files.
+
+### `isInstalled(): boolean`
+
+Check whether any OpenClaw config has signet-memory enabled.
+
+## Idempotent
+
+Safe to run multiple times. Re-running `install()` will update configs and
+hook files to the current expected state without duplicating or corrupting
+existing configuration.
+
+## License
+
+Apache-2.0

package/bin/install.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+import { runConnectorInstaller } from "@signetai/connector-base";
+import { OpenClawConnector } from "../dist/index.js";
+
+runConnectorInstaller("openclaw", OpenClawConnector);

package/dist/index.d.ts

@@ -0,0 +1,146 @@
+/**
+ * @signetai/connector-openclaw
+ *
+ * Signet connector for OpenClaw (and its earlier names: clawdbot, moltbot).
+ *
+ * Unlike Claude Code and OpenCode, OpenClaw reads ~/.agents/AGENTS.md
+ * directly — so no generated output file is needed. Instead, this
+ * connector can patch OpenClaw config to:
+ *   1. Point `agents.defaults.workspace` at ~/.agents
+ *   2. Enable the `signet-memory` internal hook entry
+ *
+ * It also installs hook handler files that OpenClaw loads for
+ * /remember, /recall, and /context commands.
+ *
+ * @example
+ * ```typescript
+ * import { OpenClawConnector } from '@signetai/connector-openclaw';
+ *
+ * const connector = new OpenClawConnector();
+ * await connector.install('~/.agents');
+ * ```
+ */
+import { BaseConnector, type InstallResult, type UninstallResult } from "@signetai/connector-base";
+export interface OpenClawInstallOptions {
+    configureWorkspace?: boolean;
+    configureHooks?: boolean;
+    runtimePath?: "plugin" | "legacy";
+}
+export type OpenClawRuntimeState = "plugin" | "legacy" | "dual" | null;
+/**
+ * Connector for OpenClaw (and its historical names: clawdbot, moltbot).
+ *
+ * Idempotent — safe to run multiple times.
+ */
+export declare class OpenClawConnector extends BaseConnector {
+    readonly name = "OpenClaw";
+    readonly harnessId = "openclaw";
+    /**
+     * Install the connector.
+     *
+     * - Patches OpenClaw hook entries by default
+     * - Patches OpenClaw workspace only when explicitly requested
+     * - Installs hook handler files under `<basePath>/hooks/agent-memory/`
+     *
+     * **`runtimePath` default changed in 0.53:** The default is now `"plugin"`
+     * (automatic per-prompt memory injection via the OpenClaw plugin system)
+     * instead of the old `"legacy"` (manual `/remember`/`/recall` commands
+     * only). SDK callers that relied on the legacy path must now pass
+     * `{ runtimePath: "legacy" }` explicitly.
+     */
+    install(basePath: string, options?: OpenClawInstallOptions): Promise<InstallResult>;
+    /**
+     * Patch OpenClaw configs to set workspace only.
+     */
+    configureWorkspace(basePath: string): Promise<string[]>;
+    /**
+     * Sync a multi-agent roster into the `agents.list` section of all
+     * discovered OpenClaw configs. Only agents that include `"openclaw"` in
+     * their `harnesses` array (or have no harnesses specified) are written.
+     */
+    syncMultipleAgents(roster: ReadonlyArray<{
+        name: string;
+        harnesses?: ReadonlyArray<string>;
+        skills?: ReadonlyArray<string>;
+    }>, basePath: string): Promise<void>;
+    /**
+     * Return all existing OpenClaw config paths discovered on this machine.
+     */
+    getDiscoveredConfigPaths(): string[];
+    /**
+     * Return normalized workspace paths declared in discovered OpenClaw configs.
+     *
+     * Paths are expanded (`~` -> home) and de-duplicated.
+     */
+    getDiscoveredWorkspacePaths(): string[];
+    /**
+     * Uninstall the connector.
+     *
+     * Disables both legacy hooks and plugin entries, removes hook handler files.
+     */
+    uninstall(): Promise<UninstallResult>;
+    private removePluginFromAllow;
+    /**
+     * Check whether any OpenClaw config has signet enabled
+     * (via legacy hooks or plugin entry).
+     */
+    isInstalled(): boolean;
+    getRuntimeState(): OpenClawRuntimeState;
+    getConfiguredRuntimePath(): "plugin" | "legacy" | null;
+    /**
+     * Get the primary config path (first existing config, or default).
+     */
+    getConfigPath(): string;
+    /**
+     * Reject workspace paths that point into temp directories.
+     * Prevents accidental persistence of test/ephemeral paths
+     * in production OpenClaw configs.
+     */
+    private validateWorkspacePath;
+    /**
+     * Check that a resolved workspace path exists and belongs to
+     * the current user's home directory. Returns warnings (non-fatal)
+     * so callers can surface them without blocking the install.
+     */
+    private checkWorkspaceOwnership;
+    private getConfigCandidates;
+    /**
+     * Patch configs with plugin entry using the object format:
+     * plugins.entries["signet-memory-openclaw"] = { enabled, config }
+     *
+     * Migrates:
+     * - Legacy array-style plugins (["signet-memory"] -> { entries: {...} })
+     * - Top-level `signet: { daemonUrl }` key
+     * - Old plugin name "signet-memory" -> "signet-memory-openclaw"
+     */
+    private patchAllConfigsWithPlugin;
+    private patchAllConfigs;
+    private patchConfig;
+    /**
+     * Narrow config-only update: add `searchPath` to `plugins.load.paths` and
+     * ensure `plugins.allow` trusts `signet-memory-openclaw` in all discovered
+     * configs without re-running the full install flow.
+     *
+     * `searchPath` should be the **parent** directory of the plugin package
+     * (e.g. `…/@signetai/`) so OpenClaw can find `signet-memory-openclaw`
+     * as a subdirectory.
+     */
+    patchLoadPaths(searchPath: string): {
+        patched: string[];
+        warnings: string[];
+    };
+    /**
+     * Create the hook handler files that OpenClaw loads for
+     * /remember, /recall, and /context commands.
+     *
+     * This is the canonical implementation; cli.ts delegates here.
+     */
+    installHookFiles(basePath: string): string[];
+    /** Detect the indentation style used in a JSON string. */
+    private detectIndent;
+    private getHomeDir;
+}
+/** Create an OpenClaw connector instance. */
+export declare function createConnector(): OpenClawConnector;
+export default OpenClawConnector;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAKH,OAAO,EAAE,aAAa,EAAE,KAAK,aAAa,EAAE,KAAK,eAAe,EAAmB,MAAM,wBAAwB,CAAC;AAyClH,MAAM,WAAW,sBAAsB;IACtC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,WAAW,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;CAClC;AAED,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,IAAI,CAAC;AA+OvE;;;;GAIG;AACH,qBAAa,iBAAkB,SAAQ,aAAa;IACnD,QAAQ,CAAC,IAAI,cAAc;IAC3B,QAAQ,CAAC,SAAS,cAAc;IAEhC;;;;;;;;;;;;OAYG;IACG,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,sBAA2B,GAAG,OAAO,CAAC,aAAa,CAAC;IAyF7F;;OAEG;IACG,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAiB7D;;;;OAIG;IACG,kBAAkB,CACvB,MAAM,EAAE,aAAa,CAAC;QACrB,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;QAClC,MAAM,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;KAC/B,CAAC,EACF,QAAQ,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC;IAsDhB;;OAEG;IACH,wBAAwB,IAAI,MAAM,EAAE;IAIpC;;;;OAIG;IACH,2BAA2B,IAAI,MAAM,EAAE;IAgCvC;;;;OAIG;IACG,SAAS,IAAI,OAAO,CAAC,eAAe,CAAC;IAmD3C,OAAO,CAAC,qBAAqB;IA8C7B;;;OAGG;IACH,WAAW,IAAI,OAAO;IAuBtB,eAAe,IAAI,oBAAoB;IAkCvC,wBAAwB,IAAI,QAAQ,GAAG,QAAQ,GAAG,IAAI;IAWtD;;OAEG;IACH,aAAa,IAAI,MAAM;IAevB;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;IAQ7B;;;;OAIG;IACH,OAAO,CAAC,uBAAuB;IAoB/B,OAAO,CAAC,mBAAmB;IAmG3B;;;;;;;;OAQG;IACH,OAAO,CAAC,yBAAyB;IAyFjC,OAAO,CAAC,eAAe;IAsBvB,OAAO,CAAC,WAAW;IAenB;;;;;;;;OAQG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG;QAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAAC,QAAQ,EAAE,MAAM,EAAE,CAAA;KAAE;IAkF7E;;;;;OAKG;IACH,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE;IAsJ5C,0DAA0D;IAC1D,OAAO,CAAC,YAAY;IAKpB,OAAO,CAAC,UAAU;CAIlB;AAMD,6CAA6C;AAC7C,wBAAgB,eAAe,IAAI,iBAAiB,CAEnD;AAED,eAAe,iBAAiB,CAAC"}