@shadowob/connector 1.1.3-dev.251

package/dist/index.cjs

@@ -0,0 +1,293 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  createConnectorPlan: () => createConnectorPlan,
+  createConnectorPlans: () => createConnectorPlans
+});
+module.exports = __toCommonJS(index_exports);
+var DEFAULT_SERVER_URL = "https://shadowob.com";
+var DEFAULT_WORK_DIR = ".";
+var DEFAULT_PROJECT_NAME = "shadow-buddy";
+var DEFAULT_CC_AGENT = "codex";
+var shellQuote = (value) => {
+  if (!value) return "''";
+  return `'${value.replace(/'/g, `'\\''`)}'`;
+};
+var normalizeServerUrl = (value) => {
+  const trimmed = value.trim() || DEFAULT_SERVER_URL;
+  return trimmed.endsWith("/api") ? trimmed.slice(0, -4) : trimmed.replace(/\/$/, "");
+};
+var tokenOrPlaceholder = (token) => token.trim() || "<BUDDY_TOKEN>";
+function buildOpenClawPlan(input) {
+  const token = tokenOrPlaceholder(input.token);
+  const serverUrl = normalizeServerUrl(input.serverUrl);
+  const jsonConfig = JSON.stringify(
+    {
+      channels: {
+        shadowob: {
+          token,
+          serverUrl
+        }
+      }
+    },
+    null,
+    2
+  );
+  const commands = [
+    {
+      label: "Install plugin",
+      command: "openclaw plugins install @shadowob/openclaw-shadowob"
+    },
+    {
+      label: "Set Buddy token",
+      command: `openclaw config set channels.shadowob.token ${shellQuote(token)}`
+    },
+    {
+      label: "Set Shadow server URL",
+      command: `openclaw config set channels.shadowob.serverUrl ${shellQuote(serverUrl)}`
+    },
+    {
+      label: "Restart gateway",
+      command: "openclaw gateway restart"
+    }
+  ];
+  const quickCommand = commands.map((item) => item.command).join(" && ");
+  const connectCommand = [
+    "npx @shadowob/connector@latest connect",
+    "--target openclaw",
+    `--server-url ${shellQuote(serverUrl)}`,
+    `--token ${shellQuote(token)}`
+  ].join(" ");
+  return {
+    target: "openclaw",
+    title: "OpenClaw",
+    summary: "Install the Shadow channel plugin and bind this Buddy token to OpenClaw.",
+    connectCommand,
+    quickCommand,
+    commands,
+    configBlocks: [{ label: "openclaw.json", language: "json", content: jsonConfig }],
+    aiPrompt: [
+      "Configure this Shadow Buddy in OpenClaw.",
+      "",
+      `Shadow server URL: ${serverUrl}`,
+      `Buddy token: ${token}`,
+      "",
+      "Run these steps in order:",
+      ...commands.map((item, index) => `${index + 1}. ${item.command}`),
+      "",
+      "Confirm each step and then verify the gateway is running."
+    ].join("\n"),
+    docsUrl: "/product/index.html",
+    capabilities: [
+      "channelMessages",
+      "dms",
+      "threads",
+      "mentions",
+      "attachments",
+      "images",
+      "interactive",
+      "slashCommands",
+      "onlineStatus",
+      "typing",
+      "activityStatus",
+      "reactions",
+      "editDelete"
+    ]
+  };
+}
+function buildHermesPlan(input) {
+  const token = tokenOrPlaceholder(input.token);
+  const serverUrl = normalizeServerUrl(input.serverUrl);
+  const envBlock = [
+    `SHADOW_BASE_URL=${shellQuote(serverUrl)}`,
+    `SHADOW_TOKEN=${shellQuote(token)}`,
+    "SHADOW_ALLOW_ALL_USERS=true",
+    "SHADOW_HEARTBEAT_INTERVAL_SECONDS=30",
+    `SHADOW_SLASH_COMMANDS_JSON=${shellQuote("[]")}`
+  ].join("\n");
+  const yamlConfig = [
+    "plugins:",
+    "  enabled:",
+    "    - shadowob",
+    "",
+    "platforms:",
+    "  shadowob:",
+    "    enabled: true",
+    `    token: "${token}"`,
+    "    extra:",
+    `      base_url: "${serverUrl}"`,
+    "      mention_only: false",
+    "      rest_only: false",
+    "      catchup_minutes: 0",
+    "      download_media: true",
+    "      slash_commands: []"
+  ].join("\n");
+  const commands = [
+    {
+      label: "Copy plugin directory",
+      command: "mkdir -p ~/.hermes/plugins && cp -R ./packages/connector/hermes-shadowob-plugin ~/.hermes/plugins/shadowob"
+    },
+    {
+      label: "Install plugin dependencies",
+      command: "python -m pip install -r ~/.hermes/plugins/shadowob/requirements.txt"
+    },
+    {
+      label: "Enable plugin",
+      command: "hermes plugins enable shadowob"
+    },
+    {
+      label: "Start gateway",
+      command: "hermes gateway"
+    }
+  ];
+  const connectCommand = [
+    "npx @shadowob/connector@latest connect",
+    "--target hermes",
+    `--server-url ${shellQuote(serverUrl)}`,
+    `--token ${shellQuote(token)}`
+  ].join(" ");
+  return {
+    target: "hermes",
+    title: "Hermes Agent",
+    summary: "Install the ShadowOB Hermes platform plugin and run Hermes gateway for this Buddy.",
+    connectCommand,
+    quickCommand: commands.map((item) => item.command).join(" && "),
+    commands,
+    configBlocks: [
+      { label: "~/.hermes/.env", language: "bash", content: envBlock },
+      { label: "~/.hermes/config.yaml", language: "yaml", content: yamlConfig }
+    ],
+    aiPrompt: [
+      "Configure this Shadow Buddy in Hermes Agent.",
+      "",
+      `Shadow server URL: ${serverUrl}`,
+      `Buddy token: ${token}`,
+      "",
+      "Install the bundled ShadowOB platform plugin, write the environment values above, enable the plugin, then run hermes gateway. The plugin resolves the Buddy agent id and channel policy from Shadow at runtime."
+    ].join("\n"),
+    docsUrl: "https://hermes-agent.nousresearch.com/docs/user-guide/messaging",
+    capabilities: [
+      "channelMessages",
+      "dms",
+      "threads",
+      "attachments",
+      "images",
+      "interactive",
+      "slashCommands",
+      "onlineStatus",
+      "typing",
+      "activityStatus",
+      "cronDelivery"
+    ]
+  };
+}
+function buildCcConnectPlan(input) {
+  const token = tokenOrPlaceholder(input.token);
+  const serverUrl = normalizeServerUrl(input.serverUrl);
+  const projectName = input.projectName?.trim() || DEFAULT_PROJECT_NAME;
+  const workDir = input.workDir?.trim() || DEFAULT_WORK_DIR;
+  const agentType = input.agentType?.trim() || DEFAULT_CC_AGENT;
+  const tomlConfig = [
+    'language = "zh"',
+    "",
+    "[[projects]]",
+    `name = "${projectName}"`,
+    `work_dir = "${workDir}"`,
+    `agent_type = "${agentType}"`,
+    "",
+    "[[projects.platforms]]",
+    'type = "shadowob"',
+    "",
+    "[projects.platforms.options]",
+    `token = "${token}"`,
+    `server_url = "${serverUrl}"`,
+    'allow_from = "*"',
+    "listen_dms = true",
+    "share_session_in_channel = false",
+    'progress_style = "compact"'
+  ].join("\n");
+  const commands = [
+    { label: "Install cc-connect", command: "npm install -g cc-connect" },
+    { label: "Create config directory", command: "mkdir -p ~/.cc-connect" },
+    {
+      label: "Edit config",
+      command: "$EDITOR ~/.cc-connect/config.toml"
+    },
+    { label: "Start cc-connect", command: "cc-connect" }
+  ];
+  const connectCommand = [
+    "npx @shadowob/connector@latest connect",
+    "--target cc-connect",
+    `--server-url ${shellQuote(serverUrl)}`,
+    `--token ${shellQuote(token)}`,
+    `--work-dir ${shellQuote(workDir)}`,
+    `--project-name ${shellQuote(projectName)}`,
+    `--agent-type ${shellQuote(agentType)}`
+  ].join(" ");
+  return {
+    target: "cc-connect",
+    title: "cc-connect",
+    summary: "Use cc-connect ShadowOB Socket.IO platform support with this Buddy token.",
+    connectCommand,
+    quickCommand: commands.map((item) => item.command).join(" && "),
+    commands,
+    configBlocks: [{ label: "~/.cc-connect/config.toml", language: "toml", content: tomlConfig }],
+    aiPrompt: [
+      "Configure this Shadow Buddy in cc-connect.",
+      "",
+      `Shadow server URL: ${serverUrl}`,
+      `Buddy token: ${token}`,
+      `Project work_dir: ${workDir}`,
+      `Agent type: ${agentType}`,
+      "",
+      "Install cc-connect, add the TOML platform block, and start cc-connect."
+    ].join("\n"),
+    docsUrl: "https://github.com/buggyblues/cc-connect/blob/main/docs/shadowob.md",
+    capabilities: [
+      "channelMessages",
+      "dms",
+      "attachments",
+      "images",
+      "interactive",
+      "slashCommands",
+      "typing",
+      "streamingPreviews",
+      "forms"
+    ]
+  };
+}
+function createConnectorPlan(input) {
+  if (input.target === "openclaw") return buildOpenClawPlan(input);
+  if (input.target === "hermes") return buildHermesPlan(input);
+  if (input.target === "cc-connect") return buildCcConnectPlan(input);
+  throw new Error(`Unsupported connector target: ${String(input.target)}`);
+}
+function createConnectorPlans(input) {
+  return ["openclaw", "hermes", "cc-connect"].map(
+    (target) => createConnectorPlan({ ...input, target })
+  );
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createConnectorPlan,
+  createConnectorPlans
+});

package/dist/index.d.cts

@@ -0,0 +1,35 @@
+type ShadowConnectorTarget = 'openclaw' | 'hermes' | 'cc-connect';
+interface ShadowConnectorInput {
+    target: ShadowConnectorTarget;
+    serverUrl: string;
+    token: string;
+    hermesHome?: string;
+    workDir?: string;
+    projectName?: string;
+    agentType?: 'codex' | 'claudecode' | 'opencode' | 'gemini' | 'cursor' | string;
+}
+interface ConnectorCommand {
+    label: string;
+    command: string;
+}
+interface ConnectorConfigBlock {
+    label: string;
+    language: 'bash' | 'json' | 'toml' | 'yaml' | 'text';
+    content: string;
+}
+interface ConnectorPlan {
+    target: ShadowConnectorTarget;
+    title: string;
+    summary: string;
+    connectCommand: string;
+    quickCommand: string;
+    commands: ConnectorCommand[];
+    configBlocks: ConnectorConfigBlock[];
+    aiPrompt: string;
+    docsUrl: string;
+    capabilities: string[];
+}
+declare function createConnectorPlan(input: ShadowConnectorInput): ConnectorPlan;
+declare function createConnectorPlans(input: Omit<ShadowConnectorInput, 'target'>): ConnectorPlan[];
+
+export { type ConnectorCommand, type ConnectorConfigBlock, type ConnectorPlan, type ShadowConnectorInput, type ShadowConnectorTarget, createConnectorPlan, createConnectorPlans };

package/dist/index.d.ts

@@ -0,0 +1,35 @@
+type ShadowConnectorTarget = 'openclaw' | 'hermes' | 'cc-connect';
+interface ShadowConnectorInput {
+    target: ShadowConnectorTarget;
+    serverUrl: string;
+    token: string;
+    hermesHome?: string;
+    workDir?: string;
+    projectName?: string;
+    agentType?: 'codex' | 'claudecode' | 'opencode' | 'gemini' | 'cursor' | string;
+}
+interface ConnectorCommand {
+    label: string;
+    command: string;
+}
+interface ConnectorConfigBlock {
+    label: string;
+    language: 'bash' | 'json' | 'toml' | 'yaml' | 'text';
+    content: string;
+}
+interface ConnectorPlan {
+    target: ShadowConnectorTarget;
+    title: string;
+    summary: string;
+    connectCommand: string;
+    quickCommand: string;
+    commands: ConnectorCommand[];
+    configBlocks: ConnectorConfigBlock[];
+    aiPrompt: string;
+    docsUrl: string;
+    capabilities: string[];
+}
+declare function createConnectorPlan(input: ShadowConnectorInput): ConnectorPlan;
+declare function createConnectorPlans(input: Omit<ShadowConnectorInput, 'target'>): ConnectorPlan[];
+
+export { type ConnectorCommand, type ConnectorConfigBlock, type ConnectorPlan, type ShadowConnectorInput, type ShadowConnectorTarget, createConnectorPlan, createConnectorPlans };

package/dist/index.js

@@ -0,0 +1,267 @@
+// src/index.ts
+var DEFAULT_SERVER_URL = "https://shadowob.com";
+var DEFAULT_WORK_DIR = ".";
+var DEFAULT_PROJECT_NAME = "shadow-buddy";
+var DEFAULT_CC_AGENT = "codex";
+var shellQuote = (value) => {
+  if (!value) return "''";
+  return `'${value.replace(/'/g, `'\\''`)}'`;
+};
+var normalizeServerUrl = (value) => {
+  const trimmed = value.trim() || DEFAULT_SERVER_URL;
+  return trimmed.endsWith("/api") ? trimmed.slice(0, -4) : trimmed.replace(/\/$/, "");
+};
+var tokenOrPlaceholder = (token) => token.trim() || "<BUDDY_TOKEN>";
+function buildOpenClawPlan(input) {
+  const token = tokenOrPlaceholder(input.token);
+  const serverUrl = normalizeServerUrl(input.serverUrl);
+  const jsonConfig = JSON.stringify(
+    {
+      channels: {
+        shadowob: {
+          token,
+          serverUrl
+        }
+      }
+    },
+    null,
+    2
+  );
+  const commands = [
+    {
+      label: "Install plugin",
+      command: "openclaw plugins install @shadowob/openclaw-shadowob"
+    },
+    {
+      label: "Set Buddy token",
+      command: `openclaw config set channels.shadowob.token ${shellQuote(token)}`
+    },
+    {
+      label: "Set Shadow server URL",
+      command: `openclaw config set channels.shadowob.serverUrl ${shellQuote(serverUrl)}`
+    },
+    {
+      label: "Restart gateway",
+      command: "openclaw gateway restart"
+    }
+  ];
+  const quickCommand = commands.map((item) => item.command).join(" && ");
+  const connectCommand = [
+    "npx @shadowob/connector@latest connect",
+    "--target openclaw",
+    `--server-url ${shellQuote(serverUrl)}`,
+    `--token ${shellQuote(token)}`
+  ].join(" ");
+  return {
+    target: "openclaw",
+    title: "OpenClaw",
+    summary: "Install the Shadow channel plugin and bind this Buddy token to OpenClaw.",
+    connectCommand,
+    quickCommand,
+    commands,
+    configBlocks: [{ label: "openclaw.json", language: "json", content: jsonConfig }],
+    aiPrompt: [
+      "Configure this Shadow Buddy in OpenClaw.",
+      "",
+      `Shadow server URL: ${serverUrl}`,
+      `Buddy token: ${token}`,
+      "",
+      "Run these steps in order:",
+      ...commands.map((item, index) => `${index + 1}. ${item.command}`),
+      "",
+      "Confirm each step and then verify the gateway is running."
+    ].join("\n"),
+    docsUrl: "/product/index.html",
+    capabilities: [
+      "channelMessages",
+      "dms",
+      "threads",
+      "mentions",
+      "attachments",
+      "images",
+      "interactive",
+      "slashCommands",
+      "onlineStatus",
+      "typing",
+      "activityStatus",
+      "reactions",
+      "editDelete"
+    ]
+  };
+}
+function buildHermesPlan(input) {
+  const token = tokenOrPlaceholder(input.token);
+  const serverUrl = normalizeServerUrl(input.serverUrl);
+  const envBlock = [
+    `SHADOW_BASE_URL=${shellQuote(serverUrl)}`,
+    `SHADOW_TOKEN=${shellQuote(token)}`,
+    "SHADOW_ALLOW_ALL_USERS=true",
+    "SHADOW_HEARTBEAT_INTERVAL_SECONDS=30",
+    `SHADOW_SLASH_COMMANDS_JSON=${shellQuote("[]")}`
+  ].join("\n");
+  const yamlConfig = [
+    "plugins:",
+    "  enabled:",
+    "    - shadowob",
+    "",
+    "platforms:",
+    "  shadowob:",
+    "    enabled: true",
+    `    token: "${token}"`,
+    "    extra:",
+    `      base_url: "${serverUrl}"`,
+    "      mention_only: false",
+    "      rest_only: false",
+    "      catchup_minutes: 0",
+    "      download_media: true",
+    "      slash_commands: []"
+  ].join("\n");
+  const commands = [
+    {
+      label: "Copy plugin directory",
+      command: "mkdir -p ~/.hermes/plugins && cp -R ./packages/connector/hermes-shadowob-plugin ~/.hermes/plugins/shadowob"
+    },
+    {
+      label: "Install plugin dependencies",
+      command: "python -m pip install -r ~/.hermes/plugins/shadowob/requirements.txt"
+    },
+    {
+      label: "Enable plugin",
+      command: "hermes plugins enable shadowob"
+    },
+    {
+      label: "Start gateway",
+      command: "hermes gateway"
+    }
+  ];
+  const connectCommand = [
+    "npx @shadowob/connector@latest connect",
+    "--target hermes",
+    `--server-url ${shellQuote(serverUrl)}`,
+    `--token ${shellQuote(token)}`
+  ].join(" ");
+  return {
+    target: "hermes",
+    title: "Hermes Agent",
+    summary: "Install the ShadowOB Hermes platform plugin and run Hermes gateway for this Buddy.",
+    connectCommand,
+    quickCommand: commands.map((item) => item.command).join(" && "),
+    commands,
+    configBlocks: [
+      { label: "~/.hermes/.env", language: "bash", content: envBlock },
+      { label: "~/.hermes/config.yaml", language: "yaml", content: yamlConfig }
+    ],
+    aiPrompt: [
+      "Configure this Shadow Buddy in Hermes Agent.",
+      "",
+      `Shadow server URL: ${serverUrl}`,
+      `Buddy token: ${token}`,
+      "",
+      "Install the bundled ShadowOB platform plugin, write the environment values above, enable the plugin, then run hermes gateway. The plugin resolves the Buddy agent id and channel policy from Shadow at runtime."
+    ].join("\n"),
+    docsUrl: "https://hermes-agent.nousresearch.com/docs/user-guide/messaging",
+    capabilities: [
+      "channelMessages",
+      "dms",
+      "threads",
+      "attachments",
+      "images",
+      "interactive",
+      "slashCommands",
+      "onlineStatus",
+      "typing",
+      "activityStatus",
+      "cronDelivery"
+    ]
+  };
+}
+function buildCcConnectPlan(input) {
+  const token = tokenOrPlaceholder(input.token);
+  const serverUrl = normalizeServerUrl(input.serverUrl);
+  const projectName = input.projectName?.trim() || DEFAULT_PROJECT_NAME;
+  const workDir = input.workDir?.trim() || DEFAULT_WORK_DIR;
+  const agentType = input.agentType?.trim() || DEFAULT_CC_AGENT;
+  const tomlConfig = [
+    'language = "zh"',
+    "",
+    "[[projects]]",
+    `name = "${projectName}"`,
+    `work_dir = "${workDir}"`,
+    `agent_type = "${agentType}"`,
+    "",
+    "[[projects.platforms]]",
+    'type = "shadowob"',
+    "",
+    "[projects.platforms.options]",
+    `token = "${token}"`,
+    `server_url = "${serverUrl}"`,
+    'allow_from = "*"',
+    "listen_dms = true",
+    "share_session_in_channel = false",
+    'progress_style = "compact"'
+  ].join("\n");
+  const commands = [
+    { label: "Install cc-connect", command: "npm install -g cc-connect" },
+    { label: "Create config directory", command: "mkdir -p ~/.cc-connect" },
+    {
+      label: "Edit config",
+      command: "$EDITOR ~/.cc-connect/config.toml"
+    },
+    { label: "Start cc-connect", command: "cc-connect" }
+  ];
+  const connectCommand = [
+    "npx @shadowob/connector@latest connect",
+    "--target cc-connect",
+    `--server-url ${shellQuote(serverUrl)}`,
+    `--token ${shellQuote(token)}`,
+    `--work-dir ${shellQuote(workDir)}`,
+    `--project-name ${shellQuote(projectName)}`,
+    `--agent-type ${shellQuote(agentType)}`
+  ].join(" ");
+  return {
+    target: "cc-connect",
+    title: "cc-connect",
+    summary: "Use cc-connect ShadowOB Socket.IO platform support with this Buddy token.",
+    connectCommand,
+    quickCommand: commands.map((item) => item.command).join(" && "),
+    commands,
+    configBlocks: [{ label: "~/.cc-connect/config.toml", language: "toml", content: tomlConfig }],
+    aiPrompt: [
+      "Configure this Shadow Buddy in cc-connect.",
+      "",
+      `Shadow server URL: ${serverUrl}`,
+      `Buddy token: ${token}`,
+      `Project work_dir: ${workDir}`,
+      `Agent type: ${agentType}`,
+      "",
+      "Install cc-connect, add the TOML platform block, and start cc-connect."
+    ].join("\n"),
+    docsUrl: "https://github.com/buggyblues/cc-connect/blob/main/docs/shadowob.md",
+    capabilities: [
+      "channelMessages",
+      "dms",
+      "attachments",
+      "images",
+      "interactive",
+      "slashCommands",
+      "typing",
+      "streamingPreviews",
+      "forms"
+    ]
+  };
+}
+function createConnectorPlan(input) {
+  if (input.target === "openclaw") return buildOpenClawPlan(input);
+  if (input.target === "hermes") return buildHermesPlan(input);
+  if (input.target === "cc-connect") return buildCcConnectPlan(input);
+  throw new Error(`Unsupported connector target: ${String(input.target)}`);
+}
+function createConnectorPlans(input) {
+  return ["openclaw", "hermes", "cc-connect"].map(
+    (target) => createConnectorPlan({ ...input, target })
+  );
+}
+export {
+  createConnectorPlan,
+  createConnectorPlans
+};