@stamn/stamn-plugin 0.1.0-alpha.0

package/README.md

@@ -0,0 +1,51 @@
+# @stamn/openclaw-plugin
+
+Stamn plugin for OpenClaw.
+
+## Install
+
+```bash
+npm install @stamn/openclaw-plugin
+```
+
+### From source
+
+```bash
+git clone https://github.com/stamnhq/sdk.git stamn-sdk
+git clone https://github.com/stamnhq/cli.git stamn-cli
+git clone https://github.com/stamnhq/openclaw-plugin.git stamn-openclaw-plugin
+cd stamn-sdk && npm install && cd ..
+cd stamn-cli && npm install && cd ..
+cd stamn-openclaw-plugin && npm install
+```
+
+## Usage
+
+```typescript
+import { registerCli } from "@stamn/openclaw-plugin";
+import type { StamnConfig } from "@stamn/cli";
+
+export default {
+  id: "stamn",
+  name: "Stamn",
+  register(api) {
+    const config = api.config as StamnConfig;
+    registerCli(api, config);
+  },
+};
+```
+
+This registers the following commands under the `stamn` namespace within OpenClaw CLI:
+
+- `stamn agent login` — device login flow
+- `stamn agent config` — view/update agent config
+- `stamn status` — connection status and server health
+- `stamn uninstall` — remove all Stamn config
+
+## Configuration
+
+Config is stored in `~/.openclaw/openclaw.json` under `plugins.entries.stamn.config`. The plugin ships with an `openclaw.plugin.json` manifest defining the config schema.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,63 @@
+import { StamnConfig, ConfigAdapter } from '@stamn/cli';
+
+interface PluginLogger {
+    info(msg: string, ...args: unknown[]): void;
+    warn(msg: string, ...args: unknown[]): void;
+    error(msg: string, ...args: unknown[]): void;
+    debug(msg: string, ...args: unknown[]): void;
+}
+interface ToolParameterProperty {
+    type: string;
+    description?: string;
+    enum?: string[];
+}
+interface ToolParameters {
+    type: 'object';
+    properties: Record<string, ToolParameterProperty>;
+    required?: string[];
+}
+interface ToolResultContent {
+    type: 'text';
+    text: string;
+}
+interface ToolResult {
+    content: ToolResultContent[];
+}
+interface PluginApi {
+    logger: PluginLogger;
+    config: Record<string, unknown>;
+    registerService(service: {
+        id: string;
+        start: () => void | Promise<void>;
+        stop: () => void | Promise<void>;
+    }): void;
+    registerCli(fn: (ctx: {
+        program: unknown;
+    }) => void, opts: {
+        commands: string[];
+    }): void;
+    registerCommand(cmd: {
+        name: string;
+        description: string;
+        acceptsArgs?: boolean;
+        handler: (ctx: {
+            args?: string;
+        }) => {
+            text: string;
+        } | Promise<{
+            text: string;
+        }>;
+    }): void;
+    registerTool(tool: {
+        name: string;
+        description: string;
+        parameters: ToolParameters;
+        execute: (args: Record<string, unknown>) => ToolResult | Promise<ToolResult>;
+    }): void;
+}
+
+declare function registerCli(api: PluginApi, config: StamnConfig): void;
+
+declare function createOpenclawAdapter(): ConfigAdapter;
+
+export { type PluginApi, type PluginLogger, type ToolParameterProperty, type ToolParameters, type ToolResult, type ToolResultContent, createOpenclawAdapter, registerCli };

package/dist/index.js

@@ -0,0 +1,78 @@
+// src/register.ts
+import { handleLogin, handleConfig, handleStatus, handleUninstall } from "@stamn/cli";
+
+// src/config.ts
+import { join } from "path";
+import { homedir } from "os";
+import { readJsonFile, writeJsonFile } from "@stamn/cli";
+function getConfigPath() {
+  return join(homedir(), ".openclaw", "openclaw.json");
+}
+function ensurePluginConfig(config) {
+  if (!config.plugins) config.plugins = {};
+  if (!config.plugins.entries) config.plugins.entries = {};
+  if (!config.plugins.entries.stamn) config.plugins.entries.stamn = {};
+  if (!config.plugins.entries.stamn.config)
+    config.plugins.entries.stamn.config = {};
+  return config;
+}
+function readOpenclawConfig() {
+  return readJsonFile(getConfigPath()) ?? {};
+}
+function createOpenclawAdapter() {
+  return {
+    getConfigPath,
+    readConfig() {
+      const raw = readOpenclawConfig();
+      const stamnConfig = raw?.plugins?.entries?.stamn?.config;
+      if (!stamnConfig) return null;
+      return stamnConfig;
+    },
+    writeConfig(updates) {
+      const config = readOpenclawConfig();
+      ensurePluginConfig(config);
+      const gatewayToken = config?.gateway?.auth?.token ?? process.env.OPENCLAW_GATEWAY_TOKEN ?? "";
+      config.plugins.entries.stamn.enabled = true;
+      config.plugins.entries.stamn.config = {
+        ...config.plugins.entries.stamn.config,
+        ...updates,
+        ...gatewayToken ? { gatewayToken } : {}
+      };
+      if (!config.gateway) config.gateway = {};
+      if (!config.gateway.http) config.gateway.http = {};
+      if (!config.gateway.http.endpoints) config.gateway.http.endpoints = {};
+      if (!config.gateway.http.endpoints.chatCompletions) {
+        config.gateway.http.endpoints.chatCompletions = { enabled: true };
+      }
+      writeJsonFile(getConfigPath(), config);
+    },
+    readStatusFile() {
+      return readJsonFile(join(homedir(), ".openclaw", "stamn-status.json"));
+    }
+  };
+}
+
+// src/register.ts
+function registerCli(api, config) {
+  const adapter = createOpenclawAdapter();
+  api.registerCli(
+    ({ program }) => {
+      const stamn = program.command("stamn").description("Stamn commands");
+      const agent = stamn.command("agent").description("Agent management");
+      agent.command("login").description("Authenticate and register an agent").option("--name <name>", "Agent name").action(
+        (opts) => handleLogin({ ...opts, server: config.serverUrl }, adapter)
+      );
+      agent.command("config").description("View or update agent configuration").option("--name <name>", "Agent display name").option("--personality", "Open editor to set agent personality").action(
+        (opts) => handleConfig(opts, adapter)
+      );
+      stamn.command("status").description("Show connection status and server health").action(() => handleStatus(config, adapter));
+      stamn.command("uninstall").description("Remove all Stamn config and data").action(() => handleUninstall(adapter));
+    },
+    { commands: ["stamn"] }
+  );
+}
+export {
+  createOpenclawAdapter,
+  registerCli
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/register.ts","../src/config.ts"],"sourcesContent":["import type { PluginApi } from \"@/types\";\nimport type { StamnConfig } from \"@stamn/cli\";\nimport { handleLogin, handleConfig, handleStatus, handleUninstall } from \"@stamn/cli\";\nimport { createOpenclawAdapter } from \"@/config\";\n\nexport function registerCli(api: PluginApi, config: StamnConfig): void {\n  const adapter = createOpenclawAdapter();\n\n  api.registerCli(\n    ({ program }) => {\n      const stamn = (program as any)\n        .command(\"stamn\")\n        .description(\"Stamn commands\");\n\n      const agent = stamn\n        .command(\"agent\")\n        .description(\"Agent management\");\n\n      agent\n        .command(\"login\")\n        .description(\"Authenticate and register an agent\")\n        .option(\"--name <name>\", \"Agent name\")\n        .action((opts: { name?: string }) =>\n          handleLogin({ ...opts, server: config.serverUrl }, adapter),\n        );\n\n      agent\n        .command(\"config\")\n        .description(\"View or update agent configuration\")\n        .option(\"--name <name>\", \"Agent display name\")\n        .option(\"--personality\", \"Open editor to set agent personality\")\n        .action((opts: { name?: string; personality?: boolean }) =>\n          handleConfig(opts, adapter),\n        );\n\n      stamn\n        .command(\"status\")\n        .description(\"Show connection status and server health\")\n        .action(() => handleStatus(config, adapter));\n\n      stamn\n        .command(\"uninstall\")\n        .description(\"Remove all Stamn config and data\")\n        .action(() => handleUninstall(adapter));\n    },\n    { commands: [\"stamn\"] },\n  );\n}\n","import { join } from \"path\";\nimport { homedir } from \"os\";\nimport { readJsonFile, writeJsonFile } from \"@stamn/cli\";\nimport type { ConfigAdapter, StamnConfig, StamnStatusFile } from \"@stamn/cli\";\n\nfunction getConfigPath(): string {\n  return join(homedir(), \".openclaw\", \"openclaw.json\");\n}\n\nfunction ensurePluginConfig(\n  config: Record<string, any>,\n): Record<string, any> {\n  if (!config.plugins) config.plugins = {};\n  if (!config.plugins.entries) config.plugins.entries = {};\n  if (!config.plugins.entries.stamn) config.plugins.entries.stamn = {};\n  if (!config.plugins.entries.stamn.config)\n    config.plugins.entries.stamn.config = {};\n  return config;\n}\n\nfunction readOpenclawConfig(): Record<string, any> {\n  return readJsonFile<Record<string, any>>(getConfigPath()) ?? {};\n}\n\nexport function createOpenclawAdapter(): ConfigAdapter {\n  return {\n    getConfigPath,\n\n    readConfig(): StamnConfig | null {\n      const raw = readOpenclawConfig();\n      const stamnConfig = raw?.plugins?.entries?.stamn?.config;\n      if (!stamnConfig) return null;\n      return stamnConfig as StamnConfig;\n    },\n\n    writeConfig(updates: Partial<StamnConfig>): void {\n      const config = readOpenclawConfig();\n      ensurePluginConfig(config);\n\n      const gatewayToken =\n        config?.gateway?.auth?.token ?? process.env.OPENCLAW_GATEWAY_TOKEN ?? \"\";\n\n      config.plugins.entries.stamn.enabled = true;\n      config.plugins.entries.stamn.config = {\n        ...config.plugins.entries.stamn.config,\n        ...updates,\n        ...(gatewayToken ? { gatewayToken } : {}),\n      };\n\n      if (!config.gateway) config.gateway = {};\n      if (!config.gateway.http) config.gateway.http = {};\n      if (!config.gateway.http.endpoints) config.gateway.http.endpoints = {};\n      if (!config.gateway.http.endpoints.chatCompletions) {\n        config.gateway.http.endpoints.chatCompletions = { enabled: true };\n      }\n\n      writeJsonFile(getConfigPath(), config);\n    },\n\n    readStatusFile(): StamnStatusFile | null {\n      return readJsonFile<StamnStatusFile>(join(homedir(), \".openclaw\", \"stamn-status.json\"));\n    },\n  };\n}\n"],"mappings":";AAEA,SAAS,aAAa,cAAc,cAAc,uBAAuB;;;ACFzE,SAAS,YAAY;AACrB,SAAS,eAAe;AACxB,SAAS,cAAc,qBAAqB;AAG5C,SAAS,gBAAwB;AAC/B,SAAO,KAAK,QAAQ,GAAG,aAAa,eAAe;AACrD;AAEA,SAAS,mBACP,QACqB;AACrB,MAAI,CAAC,OAAO,QAAS,QAAO,UAAU,CAAC;AACvC,MAAI,CAAC,OAAO,QAAQ,QAAS,QAAO,QAAQ,UAAU,CAAC;AACvD,MAAI,CAAC,OAAO,QAAQ,QAAQ,MAAO,QAAO,QAAQ,QAAQ,QAAQ,CAAC;AACnE,MAAI,CAAC,OAAO,QAAQ,QAAQ,MAAM;AAChC,WAAO,QAAQ,QAAQ,MAAM,SAAS,CAAC;AACzC,SAAO;AACT;AAEA,SAAS,qBAA0C;AACjD,SAAO,aAAkC,cAAc,CAAC,KAAK,CAAC;AAChE;AAEO,SAAS,wBAAuC;AACrD,SAAO;AAAA,IACL;AAAA,IAEA,aAAiC;AAC/B,YAAM,MAAM,mBAAmB;AAC/B,YAAM,cAAc,KAAK,SAAS,SAAS,OAAO;AAClD,UAAI,CAAC,YAAa,QAAO;AACzB,aAAO;AAAA,IACT;AAAA,IAEA,YAAY,SAAqC;AAC/C,YAAM,SAAS,mBAAmB;AAClC,yBAAmB,MAAM;AAEzB,YAAM,eACJ,QAAQ,SAAS,MAAM,SAAS,QAAQ,IAAI,0BAA0B;AAExE,aAAO,QAAQ,QAAQ,MAAM,UAAU;AACvC,aAAO,QAAQ,QAAQ,MAAM,SAAS;AAAA,QACpC,GAAG,OAAO,QAAQ,QAAQ,MAAM;AAAA,QAChC,GAAG;AAAA,QACH,GAAI,eAAe,EAAE,aAAa,IAAI,CAAC;AAAA,MACzC;AAEA,UAAI,CAAC,OAAO,QAAS,QAAO,UAAU,CAAC;AACvC,UAAI,CAAC,OAAO,QAAQ,KAAM,QAAO,QAAQ,OAAO,CAAC;AACjD,UAAI,CAAC,OAAO,QAAQ,KAAK,UAAW,QAAO,QAAQ,KAAK,YAAY,CAAC;AACrE,UAAI,CAAC,OAAO,QAAQ,KAAK,UAAU,iBAAiB;AAClD,eAAO,QAAQ,KAAK,UAAU,kBAAkB,EAAE,SAAS,KAAK;AAAA,MAClE;AAEA,oBAAc,cAAc,GAAG,MAAM;AAAA,IACvC;AAAA,IAEA,iBAAyC;AACvC,aAAO,aAA8B,KAAK,QAAQ,GAAG,aAAa,mBAAmB,CAAC;AAAA,IACxF;AAAA,EACF;AACF;;;AD1DO,SAAS,YAAY,KAAgB,QAA2B;AACrE,QAAM,UAAU,sBAAsB;AAEtC,MAAI;AAAA,IACF,CAAC,EAAE,QAAQ,MAAM;AACf,YAAM,QAAS,QACZ,QAAQ,OAAO,EACf,YAAY,gBAAgB;AAE/B,YAAM,QAAQ,MACX,QAAQ,OAAO,EACf,YAAY,kBAAkB;AAEjC,YACG,QAAQ,OAAO,EACf,YAAY,oCAAoC,EAChD,OAAO,iBAAiB,YAAY,EACpC;AAAA,QAAO,CAAC,SACP,YAAY,EAAE,GAAG,MAAM,QAAQ,OAAO,UAAU,GAAG,OAAO;AAAA,MAC5D;AAEF,YACG,QAAQ,QAAQ,EAChB,YAAY,oCAAoC,EAChD,OAAO,iBAAiB,oBAAoB,EAC5C,OAAO,iBAAiB,sCAAsC,EAC9D;AAAA,QAAO,CAAC,SACP,aAAa,MAAM,OAAO;AAAA,MAC5B;AAEF,YACG,QAAQ,QAAQ,EAChB,YAAY,0CAA0C,EACtD,OAAO,MAAM,aAAa,QAAQ,OAAO,CAAC;AAE7C,YACG,QAAQ,WAAW,EACnB,YAAY,kCAAkC,EAC9C,OAAO,MAAM,gBAAgB,OAAO,CAAC;AAAA,IAC1C;AAAA,IACA,EAAE,UAAU,CAAC,OAAO,EAAE;AAAA,EACxB;AACF;","names":[]}

package/openclaw.plugin.json

@@ -0,0 +1,58 @@
+{
+  "id": "stamn",
+  "name": "Stamn",
+  "configSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "apiKey": {
+        "type": "string",
+        "description": "API key for authenticating with Stamn"
+      },
+      "agentId": {
+        "type": "string",
+        "description": "Registered agent ID"
+      },
+      "agentName": {
+        "type": "string",
+        "description": "Agent display name"
+      },
+      "heartbeatIntervalMs": {
+        "type": "number",
+        "description": "Heartbeat interval in milliseconds",
+        "default": 30000
+      },
+      "autonomousIntervalMs": {
+        "type": "number",
+        "description": "Autonomous loop interval in milliseconds"
+      },
+      "personality": {
+        "type": "string",
+        "description": "Agent personality for autonomous decisions"
+      },
+      "services": {
+        "type": "array",
+        "description": "Services offered by this agent",
+        "items": {
+          "type": "object",
+          "properties": {
+            "tag": { "type": "string" },
+            "description": { "type": "string" },
+            "priceCents": { "type": "number" }
+          },
+          "required": ["tag", "description", "priceCents"]
+        }
+      }
+    },
+    "required": []
+  },
+  "uiHints": {
+    "apiKey": { "label": "API Key", "sensitive": true },
+    "agentId": { "label": "Agent ID" },
+    "agentName": { "label": "Agent Name" },
+    "personality": {
+      "label": "Personality",
+      "placeholder": "friendly and helpful"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@stamn/stamn-plugin",
+  "version": "0.1.0-alpha.0",
+  "description": "Stamn plugin for OpenClaw",
+  "type": "module",
+  "openclaw": {
+    "extensions": [
+      "./dist/index.js"
+    ]
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "openclaw.plugin.json"
+  ],
+  "scripts": {
+    "build": "tsup && node scripts/pack-plugin.mjs",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "tsup": {
+    "entry": [
+      "src/index.ts"
+    ],
+    "format": [
+      "esm"
+    ],
+    "dts": true,
+    "clean": true,
+    "sourcemap": true,
+    "noExternal": [
+      "@stamn/sdk",
+      "@stamn/cli"
+    ]
+  },
+  "keywords": [
+    "stamn",
+    "openclaw",
+    "plugin"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "@stamn/cli": "workspace:*",
+    "@stamn/sdk": "workspace:*",
+    "@types/node": "^22.0.0",
+    "@types/ws": "^8.18.0",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.0",
+    "vitest": "^4.0.18"
+  },
+  "dependencies": {
+    "ws": "^8.18.0"
+  }
+}