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

package/src/tools/submit-deliverable.ts

@@ -1,268 +0,0 @@
-import { createWriteStream, existsSync } from "node:fs";
-import { readdir, stat, readFile } from "node:fs/promises";
-import { basename, join } from "node:path";
-import { tmpdir } from "node:os";
-import { randomBytes } from "node:crypto";
-import archiver from "archiver";
-import type {
-  OpenClawPluginToolContext,
-  OpenClawPluginToolFactory,
-} from "openclaw/plugin-sdk/plugin-entry";
-import { taskApiPostMultipart } from "../core/task-api.js";
-
-// ──────────────────────────────────────────────────────────────────────────────
-// 响应数据类型
-// ──────────────────────────────────────────────────────────────────────────────
-
-/** 上传交付物成功时 data 字段结构 */
-interface DeliverableData {
-  result_zip_url?: string;
-  result_description_url?: string;
-  uploaded_at?: string;
-  [key: string]: unknown;
-}
-
-// ──────────────────────────────────────────────────────────────────────────────
-// 工具参数 JSON Schema
-// ──────────────────────────────────────────────────────────────────────────────
-
-const SUBMIT_DELIVERABLE_PARAMS = {
-  type: "object" as const,
-  properties: {
-    task_id: {
-      type: "string",
-      description: "已认领任务的 UUID（通过 insta_grab_task 抢单成功后获得）",
-    },
-    artifact_path: {
-      type: "string",
-      description:
-        "产物路径（绝对路径）。" +
-        "若为目录，将自动递归打包成 ZIP 后提交；" +
-        "若为文件（含 .zip），直接上传，无需额外打包。",
-    },
-    result_description: {
-      type: "string",
-      description:
-        "任务执行结果描述/报告（必填文字说明）。" +
-        "请用简洁语言描述本次任务的执行结论、关键产出和注意事项，" +
-        "此文本将与产物文件一并提交给任务发布方。",
-    },
-  },
-  required: ["task_id", "artifact_path", "result_description"] as string[],
-  additionalProperties: false,
-};
-
-// ──────────────────────────────────────────────────────────────────────────────
-// 内部工具：将目录打包为 ZIP（写入临时文件）
-// ──────────────────────────────────────────────────────────────────────────────
-
-/**
- * 将指定目录递归打包成 ZIP 文件，写到系统临时目录。
- *
- * @param dirPath  需要打包的目录绝对路径
- * @returns        生成的临时 ZIP 文件绝对路径
- */
-async function packDirectoryToZip(dirPath: string): Promise<string> {
-  const suffix = randomBytes(6).toString("hex");
-  const zipName = `insta_delivery_${suffix}.zip`;
-  const zipPath = join(tmpdir(), zipName);
-
-  await new Promise<void>((resolve, reject) => {
-    const output = createWriteStream(zipPath);
-    const archive = archiver("zip", { zlib: { level: 6 } });
-
-    output.on("close", resolve);
-    archive.on("error", reject);
-
-    archive.pipe(output);
-
-    // 将整个目录添加进 zip（保留目录内部结构，根节点命名与目录名一致）
-    archive.directory(dirPath, basename(dirPath));
-
-    archive.finalize();
-  });
-
-  return zipPath;
-}
-
-// ──────────────────────────────────────────────────────────────────────────────
-// 工具：insta_submit_deliverable
-// ──────────────────────────────────────────────────────────────────────────────
-
-/**
- * 提交任务产物工具工厂函数。
- *
- * 功能：
- *   1. 校验 task_id / artifact_path / result_description
- *   2. 判断 artifact_path 是目录还是文件：
- *      - 目录 → 调用 archiver 递归打包成 ZIP
- *      - 文件 → 直接读取使用
- *   3. 通过 multipart/form-data POST 到 /bots/tasks/{task_id}/deliverable
- *      字段：result_description（文本）+ zip_file（文件）
- *   4. 服务端收到后自动将任务状态流转为 completed，无需手动调用状态更新接口
- *
- * 在 index.ts 中通过 api.registerTool(submitDeliverableToolFactory) 注册。
- */
-export const submitDeliverableToolFactory: OpenClawPluginToolFactory = (
-  ctx: OpenClawPluginToolContext,
-) => {
-  return {
-    name: "insta_submit_deliverable",
-    label: "打包并提交引态任务产物",
-    description: [
-      "将本地产物文件或目录打包提交到引态（Instaon）任务系统，完成任务交付。",
-      "提交成功后任务状态将自动流转为「已完成（completed）」，无需手动更新状态。",
-      "参数说明：",
-      "  · task_id（必填）：已认领任务的 UUID，可通过 insta_grab_task 抢单后获取。",
-      "  · artifact_path（必填）：产物路径（绝对路径）。",
-      "    - 若指向目录：自动递归打包成 ZIP 后提交。",
-      "    - 若指向文件（含 .zip）：直接上传，不额外打包。",
-      "  · result_description（必填）：任务执行结果的文字说明/报告，",
-      "    将与产物文件一并提交给任务发布方。",
-      "返回说明：",
-      "  · ok=true：提交成功，data 中包含 result_zip_url 等链接信息。",
-      "  · ok=false：提交失败，error 中包含具体原因。",
-      "认证方式：自动读取本地 profile.json 中的 app_key / app_secret。",
-    ].join("\n"),
-
-    parameters: SUBMIT_DELIVERABLE_PARAMS,
-
-    execute: async (_toolCallId: string, params: unknown) => {
-      let tempZipPath: string | null = null;
-
-      try {
-        const p = params as Record<string, unknown>;
-        const taskId =
-          typeof p["task_id"] === "string" ? p["task_id"].trim() : "";
-        const artifactPath =
-          typeof p["artifact_path"] === "string" ? p["artifact_path"].trim() : "";
-        const resultDescription =
-          typeof p["result_description"] === "string"
-            ? p["result_description"].trim()
-            : "";
-
-        // ── Step 1: 参数校验 ─────────────────────────────────────────────────
-        if (!taskId) {
-          const err = { ok: false, error: "缺少必填参数：task_id（任务 UUID）" };
-          return {
-            content: [{ type: "text" as const, text: JSON.stringify(err) }],
-            details: err,
-          };
-        }
-
-        if (!artifactPath) {
-          const err = { ok: false, error: "缺少必填参数：artifact_path（产物路径）" };
-          return {
-            content: [{ type: "text" as const, text: JSON.stringify(err) }],
-            details: err,
-          };
-        }
-
-        if (!resultDescription) {
-          const err = {
-            ok: false,
-            error: "缺少必填参数：result_description（任务执行结果描述）",
-          };
-          return {
-            content: [{ type: "text" as const, text: JSON.stringify(err) }],
-            details: err,
-          };
-        }
-
-        if (!existsSync(artifactPath)) {
-          const err = { ok: false, error: `产物路径不存在：${artifactPath}` };
-          return {
-            content: [{ type: "text" as const, text: JSON.stringify(err) }],
-            details: err,
-          };
-        }
-
-        // ── Step 2: 判断路径类型，必要时打包 ZIP ─────────────────────────────
-        const pathStat = await stat(artifactPath);
-        let uploadFilePath: string;
-        let packed = false;
-
-        if (pathStat.isDirectory()) {
-          // 目录 → 先检查是否为空目录
-          const entries = await readdir(artifactPath);
-          if (entries.length === 0) {
-            const err = { ok: false, error: `产物目录为空，无法提交：${artifactPath}` };
-            return {
-              content: [{ type: "text" as const, text: JSON.stringify(err) }],
-              details: err,
-            };
-          }
-          // 打包成 zip
-          tempZipPath = await packDirectoryToZip(artifactPath);
-          uploadFilePath = tempZipPath;
-          packed = true;
-        } else {
-          // 普通文件 → 直接上传
-          uploadFilePath = artifactPath;
-        }
-
-        // ── Step 3: 读取文件，构造 multipart/form-data ────────────────────────
-        const fileBuffer = await readFile(uploadFilePath);
-        const filename = basename(uploadFilePath);
-        const blob = new Blob([fileBuffer], { type: "application/zip" });
-
-        const formData = new FormData();
-        formData.append("result_description", resultDescription);
-        formData.append("zip_file", blob, filename);
-
-        // ── Step 4: 调用交付物上传接口 ────────────────────────────────────────
-        const baseDir = ctx.agentDir ?? ctx.workspaceDir ?? process.cwd();
-
-        const resp = await taskApiPostMultipart<DeliverableData>(
-          baseDir,
-          `/bots/tasks/${taskId}/deliverable`,
-          formData,
-        );
-
-        if (resp.code !== 0) {
-          const err = {
-            ok: false,
-            code: resp.code,
-            error: resp.message ?? "提交交付物失败",
-          };
-          return {
-            content: [{ type: "text" as const, text: JSON.stringify(err, null, 2) }],
-            details: err,
-          };
-        }
-
-        // ── Step 5: 返回成功结果 ──────────────────────────────────────────────
-        const result = {
-          ok: true,
-          task_id: taskId,
-          packed_from_directory: packed,
-          uploaded_filename: filename,
-          data: resp.data ?? {},
-          message:
-            "产物提交成功，任务状态已自动流转为「已完成」",
-        };
-
-        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,
-        };
-      } finally {
-        // ── 清理临时 ZIP 文件 ─────────────────────────────────────────────────
-        if (tempZipPath) {
-          const { unlink } = await import("node:fs/promises");
-          await unlink(tempZipPath).catch(() => {
-            // 清理失败不影响主流程，静默处理
-          });
-        }
-      }
-    },
-  };
-};

package/src/tools/upload-artifact.ts

@@ -1,222 +0,0 @@
-import { existsSync } from "node:fs";
-import { readFile } from "node:fs/promises";
-import { basename } from "node:path";
-import type {
-  OpenClawPluginToolContext,
-  OpenClawPluginToolFactory,
-} from "openclaw/plugin-sdk/plugin-entry";
-import { getInstaUrl } from "../core/urls.js";
-import { readProfile } from "../utils/profile.js";
-
-// ──────────────────────────────────────────────────────────────────────────────
-// 响应结构定义
-// ──────────────────────────────────────────────────────────────────────────────
-
-/**
- * 制品上传并绑定接口的响应结构。
- * upload 子字段为必须；bind 子字段在传入 sessionId 时才会出现。
- */
-interface UploadAndBindResponse {
-  upload: {
-    url?: string;
-    address?: string;
-    status?: string;
-    [key: string]: unknown;
-  };
-  bind?: {
-    id?: string | number;
-    session_id?: string;
-    name?: string;
-    address?: string;
-    status?: string;
-    [key: string]: unknown;
-  };
-}
-
-/**
- * 将服务端原始响应解析为强类型结构。
- * 若必填字段缺失则返回 null，由调用方透传原始数据。
- */
-function parseUploadAndBindResponse(
-  raw: unknown,
-): UploadAndBindResponse | null {
-  if (raw === null || typeof raw !== "object" || Array.isArray(raw)) {
-    return null;
-  }
-  const obj = raw as Record<string, unknown>;
-
-  // upload 字段为必须
-  if (
-    obj["upload"] === null ||
-    typeof obj["upload"] !== "object" ||
-    Array.isArray(obj["upload"])
-  ) {
-    return null;
-  }
-
-  return raw as UploadAndBindResponse;
-}
-
-// ──────────────────────────────────────────────────────────────────────────────
-// 工具参数 JSON Schema
-// ──────────────────────────────────────────────────────────────────────────────
-
-const UPLOAD_PARAMS = {
-  type: "object" as const,
-  properties: {
-    filePath: {
-      type: "string",
-      description: "需要上传的本地文件的绝对路径",
-    },
-    sessionId: {
-      type: "string",
-      description:
-        "当前雇佣会话的 sessionId。处于用户雇佣会话时必须传入，" +
-        "上传完成后会自动将文件与该会话关联。" +
-        "如果系统提示词中包含【当前会话信息】，请将其中的 sessionId 值传入此参数。",
-    },
-  },
-  required: ["filePath"] as string[],
-  additionalProperties: false,
-};
-
-// ──────────────────────────────────────────────────────────────────────────────
-// 工具：insta_upload_artifact
-// ──────────────────────────────────────────────────────────────────────────────
-
-/**
- * 制品文件上传工具工厂函数。
- *
- * 功能：
- *   1. 校验本地文件是否存在
- *   2. 通过 multipart/form-data POST 到引态制品上传接口
- *   3. 可选传入 sessionId，将制品与雇佣会话自动绑定
- *   4. 解析并返回服务端响应（含下载地址等信息）
- *
- * 在 index.ts 中通过 api.registerTool(uploadArtifactToolFactory) 注册。
- */
-export const uploadArtifactToolFactory: OpenClawPluginToolFactory = (
-  _ctx: OpenClawPluginToolContext,
-) => {
-  return {
-    name: "insta_upload_artifact",
-    label: "上传制品文件到引态平台",
-    description: [
-      "当用户雇佣你的时候（远程），用户无法操作你local环境，因此你需要把你的产物通过平台传递给用户。",
-      "将本地制品文件上传到引态（Instaon）平台，并获取可访问的文件链接，可直接发送给用户。",
-      "多个文件建议先压缩为 zip 后再使用此工具上传，不要上传无关文件。",
-      "参数说明：",
-      "  · filePath（必填）：需要上传的本地文件绝对路径。",
-      "  · sessionId（可选）：当前雇佣会话的 sessionId。",
-      "    若系统提示词中包含【当前会话信息】，请将其中的 sessionId 传入，",
-      "    上传完成后文件将自动与该雇佣会话关联。",
-      "返回数据：",
-      "  · upload.url 或 upload.address：文件的可访问地址。",
-      "  · bind（仅传入 sessionId 时出现）：会话绑定结果。",
-    ].join("\n"),
-
-    parameters: UPLOAD_PARAMS,
-
-    execute: async (_toolCallId: string, params: unknown) => {
-      try {
-        const p = params as Record<string, unknown>;
-        const filePath =
-          typeof p["filePath"] === "string" ? p["filePath"].trim() : "";
-        const sessionId =
-          typeof p["sessionId"] === "string" ? p["sessionId"].trim() : "";
-
-        // ── Step 1: 参数校验 ────────────────────────────────────────────────
-        if (!filePath) {
-          const err = {
-            ok: false,
-            error: "缺少必填参数：filePath（文件绝对路径）",
-          };
-          return {
-            content: [{ type: "text" as const, text: JSON.stringify(err) }],
-            details: err,
-          };
-        }
-
-        if (!existsSync(filePath)) {
-          const err = { ok: false, error: `文件不存在：${filePath}` };
-          return {
-            content: [{ type: "text" as const, text: JSON.stringify(err) }],
-            details: err,
-          };
-        }
-
-        // ── Step 2: 读取文件，构造 multipart/form-data ─────────────────────
-        const fileBuffer = await readFile(filePath);
-        const filename = basename(filePath);
-        const blob = new Blob([fileBuffer]);
-
-        const formData = new FormData();
-        formData.append("file", blob, filename);
-        if (sessionId) {
-          formData.append("sessionId", sessionId);
-        }
-
-        // ── Step 3: 读取认证凭据 ──────────────────────────────────────────
-        const baseDir = _ctx.agentDir ?? _ctx.workspaceDir ?? process.cwd();
-        const profile = await readProfile(baseDir);
-        if (!profile?.app_key || !profile?.app_secret) {
-          const err = {
-            ok: false,
-            error: "未找到有效的 app_key / app_secret，请先完成档案注册。",
-          };
-          return {
-            content: [{ type: "text" as const, text: JSON.stringify(err) }],
-            details: err,
-          };
-        }
-
-        // ── Step 4: 调用制品上传并绑定接口 ────────────────────────────────
-        const uploadUrl = getInstaUrl("artifactUploadAndBind");
-        const response = await fetch(uploadUrl, {
-          method: "POST",
-          headers: {
-            "x-app-key": profile.app_key,
-            "x-app-secret": profile.app_secret,
-          },
-          body: formData,
-        });
-
-        if (!response.ok) {
-          const errText = await response
-            .text()
-            .catch(() => `HTTP ${response.status}`);
-          throw new Error(`上传失败：HTTP ${response.status} ${errText}`);
-        }
-
-        // ── Step 5: 解析并返回响应 ─────────────────────────────────────────
-        const rawData: unknown = await response.json();
-        const result = parseUploadAndBindResponse(rawData);
-
-        if (result === null) {
-          // 响应结构不符合预期，原样透传，不丢失信息
-          return {
-            content: [
-              { type: "text" as const, text: JSON.stringify(rawData, null, 2) },
-            ],
-            details: rawData,
-          };
-        }
-
-        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/utils/file-lock.ts

@@ -1,43 +0,0 @@
-import { mkdir, open, stat, unlink } from "node:fs/promises";
-import { dirname, join } from "node:path";
-
-const STALE_MS = 30_000;
-
-export async function ensureDir(filePath: string): Promise<void> {
-  await mkdir(dirname(filePath), { recursive: true });
-}
-
-export async function acquireLock(baseDir: string, lockName: string): Promise<string> {
-  const lockPath = join(baseDir, lockName);
-  for (let i = 0; i < 100; i++) {
-    try {
-      const fd = await open(lockPath, "wx");
-      await fd.write(Buffer.from(`${process.pid}\n`));
-      await fd.close();
-      return lockPath;
-    } catch (err: unknown) {
-      const code = (err as NodeJS.ErrnoException).code;
-      if (code !== "EEXIST") throw err;
-
-      try {
-        const s = await stat(lockPath);
-        if (Date.now() - s.mtimeMs > STALE_MS) {
-          await unlink(lockPath);
-          continue;
-        }
-      } catch {
-        // lock removed between checks — retry
-      }
-      await new Promise((r) => setTimeout(r, 50 + Math.random() * 50));
-    }
-  }
-  throw new Error(`Failed to acquire lock: ${lockPath}`);
-}
-
-export async function releaseLock(lockPath: string): Promise<void> {
-  try {
-    await unlink(lockPath);
-  } catch {
-    // already released
-  }
-}

package/src/utils/profile.ts

@@ -1,45 +0,0 @@
-import { readFile, writeFile } from "node:fs/promises";
-import { dirname, join } from "node:path";
-import { acquireLock, ensureDir, releaseLock } from "./file-lock.js";
-
-export type Profile = {
-  app_key: string;
-  app_secret: string;
-  name: string;
-  description: string;
-  claw_id: string;
-  hourly_rate: number;
-  enable_commissioned: boolean;
-  enable_hired: boolean;
-  scene_tags: string[];
-  custom_tags: string[];
-  avatar: string;
-  instance_type: number;
-};
-
-const PROFILE_RELATIVE_PATH = ".insta/config/profile.json";
-
-export async function readProfile(baseDir: string): Promise<Profile | null> {
-  const filePath = join(baseDir, PROFILE_RELATIVE_PATH);
-  try {
-    const raw = await readFile(filePath, "utf-8");
-    return JSON.parse(raw) as Profile;
-  } catch {
-    return null;
-  }
-}
-
-export async function writeProfile(
-  baseDir: string,
-  profile: Profile,
-): Promise<void> {
-  const filePath = join(baseDir, PROFILE_RELATIVE_PATH);
-  await ensureDir(filePath);
-
-  const lockPath = await acquireLock(dirname(filePath), ".profile.lock");
-  try {
-    await writeFile(filePath, JSON.stringify(profile, null, 2), "utf-8");
-  } finally {
-    await releaseLock(lockPath);
-  }
-}

package/src/utils/session.ts

@@ -1,30 +0,0 @@
-import { readFile, writeFile } from "node:fs/promises";
-import { join } from "node:path";
-import { acquireLock, ensureDir, releaseLock } from "./file-lock.js";
-
-const SESSION_RELATIVE_PATH = ".insta/.activate_session";
-
-export async function readSession(baseDir: string): Promise<string | null> {
-  const filePath = join(baseDir, SESSION_RELATIVE_PATH);
-  try {
-    const raw = await readFile(filePath, "utf-8");
-    return raw.trim() || null;
-  } catch {
-    return null;
-  }
-}
-
-export async function writeSession(
-  baseDir: string,
-  sessionId: string,
-): Promise<void> {
-  const filePath = join(baseDir, SESSION_RELATIVE_PATH);
-  await ensureDir(filePath);
-
-  const lockPath = await acquireLock(join(baseDir, ".insta"), ".session.lock");
-  try {
-    await writeFile(filePath, sessionId, "utf-8");
-  } finally {
-    await releaseLock(lockPath);
-  }
-}

package/tests/profile.test.ts

@@ -1,70 +0,0 @@
-import { mkdtemp, rm } from "node:fs/promises";
-import { tmpdir } from "node:os";
-import { join } from "node:path";
-import { describe, it, expect, afterEach, beforeEach } from "vitest";
-import { readProfile, writeProfile, type Profile } from "../src/utils/profile.js";
-
-let workDir: string;
-
-beforeEach(async () => {
-  workDir = await mkdtemp(join(tmpdir(), "profile-test-"));
-});
-
-afterEach(async () => {
-  await rm(workDir, { recursive: true, force: true });
-});
-
-const sampleProfile: Profile = {
-  app_key: "key_123",
-  app_secret: "secret_abc",
-  name: "Test App",
-  description: "A test profile",
-  claw_id: "claw_001",
-  hourly_rate: 50.0,
-  enable_commissioned: true,
-  enable_hired: true,
-  scene_tags: ["social", "automation"],
-  custom_tags: ["beta"],
-  avatar: "https://example.com/avatar.png",
-  instance_type: 0,
-};
-
-describe("readProfile", () => {
-  it("returns null when file does not exist", async () => {
-    const result = await readProfile(workDir);
-    expect(result).toBeNull();
-  });
-
-  it("returns profile after write", async () => {
-    await writeProfile(workDir, sampleProfile);
-    const result = await readProfile(workDir);
-    expect(result).toEqual(sampleProfile);
-  });
-});
-
-describe("writeProfile", () => {
-  it("creates directory structure and writes file", async () => {
-    await writeProfile(workDir, sampleProfile);
-    const result = await readProfile(workDir);
-    expect(result).not.toBeNull();
-    expect(result!.name).toBe("Test App");
-  });
-
-  it("overwrites existing profile", async () => {
-    await writeProfile(workDir, sampleProfile);
-    const updated = { ...sampleProfile, name: "Updated" };
-    await writeProfile(workDir, updated);
-    const result = await readProfile(workDir);
-    expect(result!.name).toBe("Updated");
-  });
-
-  it("handles concurrent writes without corruption", async () => {
-    const writes = Array.from({ length: 20 }, (_, i) =>
-      writeProfile(workDir, { ...sampleProfile, hourly_rate: i }),
-    );
-    await Promise.all(writes);
-    const result = await readProfile(workDir);
-    expect(result).not.toBeNull();
-    expect(typeof result!.hourly_rate).toBe("number");
-  });
-});