@insta-dev01/insta-plugin-openclaw 1.0.0 → 1.0.1

package/src/tools/get-plugin-profile.ts

@@ -1,152 +0,0 @@
-import type {
-  OpenClawPluginToolContext,
-  OpenClawPluginToolFactory,
-} from "openclaw/plugin-sdk/plugin-entry";
-import { readProfile } from "../utils/profile.js";
-import { readSession } from "../utils/session.js";
-
-// ──────────────────────────────────────────────────────────────────────────────
-// 敏感字段白名单：这些字段的值会被 * 号掩码处理
-// ──────────────────────────────────────────────────────────────────────────────
-const SENSITIVE_KEYS: Set<string> = new Set(["app_secret"]);
-
-/**
- * 对字符串值进行脱敏：
- * - 保留前 2 个字符，其余替换为 *
- * - 若值 ≤ 4 个字符，则全部替换
- */
-function maskSecret(value: string): string {
-  if (!value) return value;
-  if (value.length <= 4) return "*".repeat(value.length);
-  return value.slice(0, 2) + "*".repeat(value.length - 2);
-}
-
-/**
- * 对 Record 对象中 SENSITIVE_KEYS 里的字段进行打码，返回新对象（不修改原始数据）。
- */
-function maskSensitiveFields(
-  obj: Record<string, unknown>,
-): Record<string, unknown> {
-  const result: Record<string, unknown> = {};
-  for (const [key, value] of Object.entries(obj)) {
-    if (SENSITIVE_KEYS.has(key) && typeof value === "string") {
-      result[key] = maskSecret(value);
-    } else {
-      result[key] = value;
-    }
-  }
-  return result;
-}
-
-/**
- * 对 session token 进行脱敏：保留前 4 个字符，其余替换为 *
- */
-function maskSessionToken(token: string): string {
-  if (!token) return token;
-  if (token.length <= 4) return "*".repeat(token.length);
-  return token.slice(0, 4) + "*".repeat(token.length - 4);
-}
-
-// ──────────────────────────────────────────────────────────────────────────────
-// 工具：insta_get_plugin_profile
-// ──────────────────────────────────────────────────────────────────────────────
-
-/** 工具的空参数 JSON Schema（无需任何输入参数）*/
-const EMPTY_PARAMS = {
-  type: "object" as const,
-  properties: {},
-  required: [] as string[],
-  additionalProperties: false,
-};
-
-/**
- * 工具工厂函数。
- * 在 index.ts 中通过 api.registerTool(getPluginProfileToolFactory) 注册。
- */
-export const getPluginProfileToolFactory: OpenClawPluginToolFactory = (
-  ctx: OpenClawPluginToolContext,
-) => {
-  return {
-    name: "insta_get_plugin_profile",
-    label: "获取引态插件配置与注册状态",
-    description: [
-      "查询引态（Instaon）OpenClaw 插件的基础配置信息和服务端注册状态。",
-      "返回以下数据：",
-      "  · profile（插件配置）：app_key、name、description、claw_id、hourly_rate、",
-      "    enable_commissioned、enable_hired、scene_tags、custom_tags、avatar、instance_type 等。",
-      "    敏感字段（如 app_secret）以 * 号掩码返回，不会暴露明文。",
-      "  · session（注册状态）：服务端颁发的激活 token（脱敏）；未注册时为 null。",
-      "  · registered：布尔值，表示插件是否已成功在引态平台完成服务端注册。",
-      "适用场景：排查插件配置、确认服务端注册是否成功。",
-    ].join("\n"),
-
-    // 该工具不需要任何输入参数
-    parameters: EMPTY_PARAMS,
-
-    execute: async (_toolCallId: string, _params: unknown) => {
-      // 优先使用 agentDir（工作目录），其次 workspaceDir，最后 cwd
-      const baseDir = ctx.agentDir ?? ctx.workspaceDir ?? process.cwd();
-
-      // 并行读取 profile 与 session
-      const [profile, sessionToken] = await Promise.all([
-        readProfile(baseDir),
-        readSession(baseDir),
-      ]);
-
-      // profile 不存在时的错误响应
-      if (!profile) {
-        const errorResult = {
-          success: false,
-          error:
-            "未找到插件配置文件（.insta/config/profile.json）。" +
-            "请先通过引态平台完成初始化配置。",
-          registered: false,
-          profile: null,
-          session: null,
-        };
-        return {
-          content: [
-            {
-              type: "text" as const,
-              text: JSON.stringify(errorResult, null, 2),
-            },
-          ],
-          details: errorResult,
-        };
-      }
-
-      // 对 profile 字段进行脱敏
-      const safeProfile = maskSensitiveFields(
-        profile as unknown as Record<string, unknown>,
-      );
-
-      // 对 session token 进行脱敏
-      const safeSession = sessionToken
-        ? {
-            token: maskSessionToken(sessionToken),
-            status: "已激活",
-          }
-        : {
-            token: null,
-            status: "未注册",
-          };
-
-      const successResult = {
-        success: true,
-        registered: !!sessionToken,
-        profile: safeProfile,
-        session: safeSession,
-      };
-
-      return {
-        content: [
-          {
-            type: "text" as const,
-            text: JSON.stringify(successResult, null, 2),
-          },
-        ],
-        details: successResult,
-      };
-    },
-  };
-};

package/src/tools/grab-task.ts

@@ -1,133 +0,0 @@
-import type {
-  OpenClawPluginToolContext,
-  OpenClawPluginToolFactory,
-} from "openclaw/plugin-sdk/plugin-entry";
-import { taskApiPost } from "../core/task-api.js";
-
-// ──────────────────────────────────────────────────────────────────────────────
-// 响应数据类型
-// ──────────────────────────────────────────────────────────────────────────────
-
-/** 抢单成功时 data 字段结构 */
-interface GrabSuccessData {
-  task_id: string;
-  grab_time: string;
-}
-
-// 服务端已知错误码
-const ERROR_CODE_MESSAGES: Record<number, string> = {
-  40001: "任务已被其他 Bot 抢先认领（task_already_grabbed）",
-  40002: "任务当前不可认领，可能已过期或状态异常（task_not_available）",
-  40003: "任务不存在（task_not_found）",
-  40100: "未授权，请检查 app_key / app_secret 配置（unauthorized）",
-  40101: "API Key 或 Secret 无效（invalid_credentials）",
-  40102: "Bot 尚未激活（bot_inactive）",
-  40103: "Bot 尚未审核通过（bot_not_approved）",
-};
-
-// ──────────────────────────────────────────────────────────────────────────────
-// 工具参数 JSON Schema
-// ──────────────────────────────────────────────────────────────────────────────
-
-const GRAB_TASK_PARAMS = {
-  type: "object" as const,
-  properties: {
-    task_id: {
-      type: "string",
-      description:
-        "需要认领的任务 UUID，可通过 insta_list_tasks 工具获取。",
-    },
-  },
-  required: ["task_id"] as string[],
-  additionalProperties: false,
-};
-
-// ──────────────────────────────────────────────────────────────────────────────
-// 工具：insta_grab_task
-// ──────────────────────────────────────────────────────────────────────────────
-
-/**
- * 任务抢单工具工厂函数。
- * 在 index.ts 中通过 api.registerTool(grabTaskToolFactory) 注册。
- */
-export const grabTaskToolFactory: OpenClawPluginToolFactory = (
-  ctx: OpenClawPluginToolContext,
-) => {
-  return {
-    name: "insta_grab_task",
-    label: "认领引态任务池中的任务（抢单）",
-    description: [
-      "向引态（Instaon）任务系统发起抢单请求，将指定任务标记为「已认领」状态。",
-      "抢单成功后，该任务归属于当前 Bot（claw_id），可继续执行并提交产物。",
-      "参数说明：",
-      "  · task_id（必填）：目标任务的 UUID，可通过 insta_list_tasks 工具查询获取。",
-      "返回说明：",
-      "  · ok=true：抢单成功，data 中包含 task_id 和 grab_time。",
-      "  · ok=false：抢单失败，error 中包含具体原因（如已被抢、不可认领等）。",
-      "认证方式：自动读取本地 profile.json 中的 app_key / app_secret。",
-    ].join("\n"),
-
-    parameters: GRAB_TASK_PARAMS,
-
-    execute: async (_toolCallId: string, params: unknown) => {
-      try {
-        const p = params as Record<string, unknown>;
-        const taskId =
-          typeof p["task_id"] === "string" ? p["task_id"].trim() : "";
-
-        // ── 参数校验 ──────────────────────────────────────────────────────────
-        if (!taskId) {
-          const err = { ok: false, error: "缺少必填参数：task_id（任务 UUID）" };
-          return {
-            content: [{ type: "text" as const, text: JSON.stringify(err) }],
-            details: err,
-          };
-        }
-
-        const baseDir = ctx.agentDir ?? ctx.workspaceDir ?? process.cwd();
-
-        const resp = await taskApiPost<GrabSuccessData>(
-          baseDir,
-          `/bots/tasks/${taskId}/grab`,
-        );
-
-        // ── 抢单成功 ──────────────────────────────────────────────────────────
-        if (resp.code === 0) {
-          const result = {
-            ok: true,
-            task_id: resp.data?.task_id ?? taskId,
-            grab_time: resp.data?.grab_time ?? null,
-            message: "抢单成功，任务已标记为已认领状态",
-          };
-          return {
-            content: [{ type: "text" as const, text: JSON.stringify(result, null, 2) }],
-            details: result,
-          };
-        }
-
-        // ── 抢单失败（业务错误） ───────────────────────────────────────────────
-        const humanMessage =
-          ERROR_CODE_MESSAGES[resp.code] ??
-          `抢单失败（code=${resp.code}，message=${resp.message}）`;
-
-        const err = {
-          ok: false,
-          code: resp.code,
-          error: humanMessage,
-          raw_message: resp.message,
-        };
-        return {
-          content: [{ type: "text" as const, text: JSON.stringify(err, null, 2) }],
-          details: err,
-        };
-      } catch (e: unknown) {
-        const message = e instanceof Error ? e.message : "抢单过程中发生未知错误";
-        const err = { ok: false, error: message };
-        return {
-          content: [{ type: "text" as const, text: message }],
-          details: err,
-        };
-      }
-    },
-  };
-};

package/src/tools/list-tasks.ts

@@ -1,135 +0,0 @@
-import type {
-  OpenClawPluginToolContext,
-  OpenClawPluginToolFactory,
-} from "openclaw/plugin-sdk/plugin-entry";
-import { taskApiGet } from "../core/task-api.js";
-
-// ──────────────────────────────────────────────────────────────────────────────
-// 响应数据类型
-// ──────────────────────────────────────────────────────────────────────────────
-
-/** 任务池单条任务摘要（与 API 文档字段对应） */
-interface TaskSummary {
-  id: string;
-  title: string;
-  category: string;
-  bounty: string | number;
-  deadline: string;
-  created_at: string;
-}
-
-/** 任务列表分页响应 data 字段 */
-interface TaskListData {
-  items: TaskSummary[];
-  total: number;
-  page: number;
-  page_size: number;
-  total_pages: number | null;
-}
-
-// ──────────────────────────────────────────────────────────────────────────────
-// 工具参数 JSON Schema
-// ──────────────────────────────────────────────────────────────────────────────
-
-const LIST_TASKS_PARAMS = {
-  type: "object" as const,
-  properties: {
-    page: {
-      type: "number",
-      description: "页码，从 1 开始，默认为 1",
-    },
-    page_size: {
-      type: "number",
-      description: "每页返回的任务数量，范围 1~100，默认为 20",
-    },
-  },
-  required: [] as string[],
-  additionalProperties: false,
-};
-
-// ──────────────────────────────────────────────────────────────────────────────
-// 工具：insta_list_tasks
-// ──────────────────────────────────────────────────────────────────────────────
-
-/**
- * 查询引态任务池可接单任务列表工具工厂函数。
- * 在 index.ts 中通过 api.registerTool(listTasksToolFactory) 注册。
- */
-export const listTasksToolFactory: OpenClawPluginToolFactory = (
-  ctx: OpenClawPluginToolContext,
-) => {
-  return {
-    name: "insta_list_tasks",
-    label: "查询引态任务池可接单列表",
-    description: [
-      "查询引态（Instaon）任务池中当前可供 Bot 认领的任务列表。",
-      "返回任务的基础摘要信息，包括：",
-      "  · id：任务唯一 ID（UUID），抢单时需要传入此值。",
-      "  · title：任务标题。",
-      "  · category：任务分类。",
-      "  · bounty：赏金（元）。",
-      "  · deadline：截止时间（ISO 8601 格式）。",
-      "  · created_at：任务创建时间。",
-      "参数说明：",
-      "  · page（可选）：页码，默认 1。",
-      "  · page_size（可选）：每页数量，默认 20，最大 100。",
-      "认证方式：自动读取本地 profile.json 中的 app_key / app_secret。",
-    ].join("\n"),
-
-    parameters: LIST_TASKS_PARAMS,
-
-    execute: async (_toolCallId: string, params: unknown) => {
-      try {
-        const p = (params ?? {}) as Record<string, unknown>;
-        const page = typeof p["page"] === "number" ? Math.max(1, Math.floor(p["page"])) : 1;
-        const pageSize =
-          typeof p["page_size"] === "number"
-            ? Math.min(100, Math.max(1, Math.floor(p["page_size"])))
-            : 20;
-
-        const baseDir = ctx.agentDir ?? ctx.workspaceDir ?? process.cwd();
-
-        const resp = await taskApiGet<TaskListData>(
-          baseDir,
-          "/bots/tasks/available",
-          { page, page_size: pageSize },
-        );
-
-        // 服务端业务错误（code !== 0）
-        if (resp.code !== 0) {
-          const err = {
-            ok: false,
-            code: resp.code,
-            error: resp.message ?? "查询任务列表失败",
-            data: null,
-          };
-          return {
-            content: [{ type: "text" as const, text: JSON.stringify(err, null, 2) }],
-            details: err,
-          };
-        }
-
-        const result = {
-          ok: true,
-          total: resp.data?.total ?? 0,
-          page: resp.data?.page ?? page,
-          page_size: resp.data?.page_size ?? pageSize,
-          total_pages: resp.data?.total_pages ?? null,
-          items: resp.data?.items ?? [],
-        };
-
-        return {
-          content: [{ type: "text" as const, text: JSON.stringify(result, null, 2) }],
-          details: result,
-        };
-      } catch (e: unknown) {
-        const message = e instanceof Error ? e.message : "查询任务列表时发生未知错误";
-        const err = { ok: false, error: message };
-        return {
-          content: [{ type: "text" as const, text: message }],
-          details: err,
-        };
-      }
-    },
-  };
-};

package/src/tools/propose-registration.ts

@@ -1,116 +0,0 @@
-import type {
-  OpenClawPluginToolContext,
-  OpenClawPluginToolFactory,
-} from "openclaw/plugin-sdk/plugin-entry";
-import { VALID_SCENE_TAG_IDS } from "../core/register-identity.js";
-import { setPendingRegistration } from "../channel/registration-store.js";
-
-// ── Parameters schema (mirrors register-identity params) ──────────────────────
-
-const PARAMS_SCHEMA = {
-  type: "object" as const,
-  properties: {
-    name: {
-      type: "string",
-      description: "档案名称",
-    },
-    avatar: {
-      type: "string",
-      description: "头像图片 URL（必须是可访问的合法 URL）",
-    },
-    description: {
-      type: "string",
-      description: "服务描述",
-    },
-    hourly_rate: {
-      type: "number",
-      description: "时薪（必须 > 0，单位：元）",
-    },
-    scene_tags: {
-      type: "array",
-      items: { type: "string" },
-      description: `场景标签 ID 数组（1-3 个）。合法值：${[...VALID_SCENE_TAG_IDS].join(", ")}`,
-    },
-    custom_tags: {
-      type: "array",
-      items: { type: "string" },
-      description: "自定义标签列表（可选）",
-    },
-    instance_type: {
-      type: "number",
-      enum: [0, 1],
-      description: "实例类型：0 = 本地实例（推荐），1 = 影子实例",
-    },
-  },
-  required: ["name", "avatar", "description", "hourly_rate", "scene_tags", "instance_type"] as string[],
-  additionalProperties: false,
-};
-
-// ── Tool factory ──────────────────────────────────────────────────────────────
-
-/**
- * Tool: insta_propose_registration
- *
- * Stores AI-suggested registration parameters as a "pending confirmation" record.
- * The host will surface a Control UI component to the user so they can review,
- * optionally edit, and then confirm the parameters via the
- * `instaclaw.registration.submit` gateway method.
- *
- * This tool does NOT perform the actual registration. Use it when you want to
- * let the user review before committing.
- */
-export const proposeRegistrationToolFactory: OpenClawPluginToolFactory = (
-  _ctx: OpenClawPluginToolContext,
-) => {
-  return {
-    name: "insta_propose_registration",
-    label: "提交 InstaClaw 注册提案",
-    description: [
-      '将建议的 InstaClaw 注册参数暂存为"待用户确认"状态。',
-      "调用后，控制面板会显示一个确认表单，用户可在其中查看、修改参数，",
-      '然后点击"确认注册"完成注册。',
-      "",
-      "此工具不会立即注册，仅用于暂存建议参数供用户审阅。",
-      "",
-      "参数：",
-      "  · name（必填）：档案名称",
-      "  · avatar（必填）：头像 URL",
-      "  · description（必填）：服务描述",
-      "  · hourly_rate（必填）：时薪，必须 > 0",
-      "  · scene_tags（必填）：场景标签 ID 数组（1-3 个）",
-      "  · custom_tags（可选）：自定义标签",
-      "  · instance_type（必填）：0 = 本地实例，1 = 影子实例",
-    ].join("\n"),
-    parameters: PARAMS_SCHEMA,
-
-    execute: async (_toolCallId, params) => {
-      const p = params as Record<string, unknown>;
-
-      setPendingRegistration({
-        name: p["name"] as string,
-        avatar: p["avatar"] as string,
-        description: p["description"] as string,
-        hourly_rate: p["hourly_rate"] as number,
-        scene_tags: p["scene_tags"] as string[],
-        custom_tags: p["custom_tags"] as string[] | undefined,
-        instance_type: p["instance_type"] as 0 | 1,
-      });
-
-      const successText = [
-        "注册信息已暂存 ✓",
-        "",
-        `名称：${p["name"]}`,
-        `时薪：${p["hourly_rate"]} 元`,
-        `场景标签：${(p["scene_tags"] as string[]).join(", ")}`,
-        `实例类型：${p["instance_type"] === 0 ? "本地实例" : "影子实例"}`,
-        "",
-        "请在控制面板的「InstaClaw 服务注册」卡片中确认信息，点击「确认注册」完成注册。",
-      ].join("\n");
-
-      return {
-        content: [{ type: "text" as const, text: successText }],
-        details: { stored: true },
-      };
-    },
-  };
-};

package/src/tools/register-identity.ts

@@ -1,121 +0,0 @@
-import type {
-  OpenClawPluginToolContext,
-  OpenClawPluginToolFactory,
-} from "openclaw/plugin-sdk/plugin-entry";
-import {
-  registerIdentity,
-  VALID_SCENE_TAG_IDS,
-} from "../core/register-identity.js";
-
-// ── Parameters schema ─────────────────────────────────────────────────────────
-
-const PARAMS_SCHEMA = {
-  type: "object" as const,
-  properties: {
-    name: {
-      type: "string",
-      description: "档案名称",
-    },
-    avatar: {
-      type: "string",
-      description: "头像图片 URL（必须是可访问的合法 URL）",
-    },
-    description: {
-      type: "string",
-      description: "服务描述",
-    },
-    hourly_rate: {
-      type: "number",
-      description: "时薪（必须 > 0，单位：元）",
-    },
-    scene_tags: {
-      type: "array",
-      items: { type: "string" },
-      description: `场景标签 ID 数组（1-3 个）。合法值：${[...VALID_SCENE_TAG_IDS].join(", ")}`,
-    },
-    custom_tags: {
-      type: "array",
-      items: { type: "string" },
-      description: "自定义标签列表（可选）",
-    },
-    instance_type: {
-      type: "number",
-      enum: [0, 1],
-      description: "实例类型：0 = 本地实例（推荐），1 = 影子实例",
-    },
-  },
-  required: ["name", "avatar", "description", "hourly_rate", "scene_tags", "instance_type"] as string[],
-  additionalProperties: false,
-};
-
-// ── Tool factory ──────────────────────────────────────────────────────────────
-
-/**
- * Tool: insta_register_identity
- *
- * Registers an InstaClaw profile via POST /profiles/create and persists the
- * resulting credentials to the local profile file. Once registered, the
- * channel's 10-second polling loop will detect the credentials and
- * automatically establish the WebSocket connection.
- */
-export const registerIdentityToolFactory: OpenClawPluginToolFactory = (
-  ctx: OpenClawPluginToolContext,
-) => {
-  return {
-    name: "insta_register_identity",
-    label: "注册 InstaClaw 档案",
-    description: [
-      "向 InstaClaw 平台注册服务档案，完成频道初始化配置。",
-      "注册成功后，凭证将保存到本地 profile 文件，",
-      "InstaClaw channel 会在 10 秒内自动检测并建立 WebSocket 连接。",
-      "",
-      "参数：",
-      "  · name（必填）：档案名称",
-      "  · avatar（必填）：头像 URL",
-      "  · description（必填）：服务描述",
-      "  · hourly_rate（必填）：时薪，必须 > 0",
-      "  · scene_tags（必填）：场景标签 ID 数组",
-      "  · custom_tags（可选）：自定义标签",
-      "  · instance_type（必填）：0 = 本地实例，1 = 影子实例",
-    ].join("\n"),
-    parameters: PARAMS_SCHEMA,
-
-    execute: async (_toolCallId, params) => {
-      const baseDir = ctx.agentDir ?? ctx.workspaceDir ?? process.cwd();
-      const p = params as Record<string, unknown>;
-
-      const result = await registerIdentity(
-        {
-          name: p["name"] as string,
-          avatar: p["avatar"] as string,
-          description: p["description"] as string,
-          hourly_rate: p["hourly_rate"] as number,
-          scene_tags: p["scene_tags"] as string[],
-          custom_tags: p["custom_tags"] as string[] | undefined,
-          instance_type: p["instance_type"] as 0 | 1,
-        },
-        baseDir,
-      );
-
-      if (!result.success) {
-        return {
-          content: [{ type: "text" as const, text: `注册失败：${result.error}` }],
-          details: result,
-        };
-      }
-
-      const successText = [
-        "注册成功 ✓",
-        `app_key:  ${result.data?.app_key}`,
-        `claw_id:  ${result.data?.claw_id}`,
-        "",
-        "InstaClaw channel 将在 10 秒内自动检测到凭证并建立 WebSocket 连接。",
-      ].join("\n");
-
-      return {
-        content: [{ type: "text" as const, text: successText }],
-        details: result,
-      };
-    },
-  };
-};