opencode-image 0.1.2 → 2.0.0

package/README.md

@@ -7,9 +7,31 @@
 - 兼容任何 OpenAI 风格的 `/images/generations` 与 `/images/edits` 接口
 - 跨平台缩放（基于 [sharp](https://sharp.pixelplumbing.com)），不依赖 `sips` 等系统命令
 
+## 版本与兼容（重要）
+
+| 版本 | 目标 opencode | 插件 API | npm 安装 |
+|---|---|---|---|
+| **2.x**（当前线，`next` tag） | opencode **2.0+** | `@opencode/plugin@2`（`Plugin.define` + `ctx.tool` / `ctx.session`） | `opencode-image@next` |
+| 1.x（`latest` tag） | opencode **1.x** | `@opencode-ai/plugin` | `opencode-image@latest` |
+
+- v2 的插件运行时**只认** `export default { id, effect | setup }`，v1 形态的插件在 v2 里加载不了，所以这是**大版本切换**。
+- 本仓库 `publishConfig.tag` 固定为 `next`，直接 `npm publish` **不会**顶掉 `latest`，因此 **v1 老用户不会被自动升级到 2.x**。
+- v1 线要出新补丁：`bun run release:legacy`（打 patch 到 `latest`）。
+
 ## 安装
 
-在 `opencode.json` / `opencode.jsonc` 里配置：
+opencode **2.0+**（v2 插件 API）：
+
+```jsonc
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugin": [
+    ["opencode-image@next", { "apiKey": "sk-..." }]
+  ]
+}
+```
+
+opencode **1.x**（保持老版本）：
 
 ```jsonc
 {
@@ -20,7 +42,8 @@
 }
 ```
 
-opencode 启动时会自动从 npm 安装插件到 `~/.cache/opencode/packages/opencode-image/node_modules/`。
+opencode 启动时会自动从 npm 安装插件到 `~/.cache/opencode/packages/opencode-image.../node_modules/`。
+
 
 ## 配置项
 

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-import { type Plugin } from "@opencode-ai/plugin";
-export declare const OpenCodeImagePlugin: Plugin;
+import { Plugin } from "@opencode/plugin";
+export declare const OpenCodeImagePlugin: Plugin.Plugin;
 export default OpenCodeImagePlugin;

package/dist/index.js

@@ -1,5 +1,6 @@
 // src/index.ts
-import { tool } from "@opencode-ai/plugin";
+import { Plugin } from "@opencode/plugin";
+import { Schema } from "effect";
 import * as fs5 from "node:fs";
 import * as path5 from "node:path";
 
@@ -295,6 +296,7 @@ function resolveOptions(options) {
     serverPort: opts.serverPort ?? DEFAULT_SERVER_PORT,
     serverIdleMs: opts.serverIdleMs ?? DEFAULT_SERVER_IDLE_MS,
     updateCheck: opts.updateCheck ?? true,
+    injectPrompt: opts.injectPrompt ?? true,
     cacheDir: opts.cacheDir ?? DEFAULT_CACHE_DIR,
     cacheLimit: opts.cacheLimit ?? DEFAULT_CACHE_LIMIT,
     timeoutMs: opts.timeoutMs ?? DEFAULT_TIMEOUT_MS
@@ -406,9 +408,9 @@ class ImageServer {
         return Buffer.from(relative2.split(path4.sep).join("/"), "utf8").toString("base64url");
       }
     }
-    for (const [id2, registered] of this.extra) {
+    for (const [id, registered] of this.extra) {
       if (registered === file)
-        return id2;
+        return id;
     }
     const id = randomUUID().replace(/-/g, "").slice(0, 16);
     this.extra.set(id, file);
@@ -460,9 +462,9 @@ class ImageServer {
     const port = this.configuredPort || derivePort(path4.resolve(opts.outDir));
     const server = http.createServer((req, res) => void this.handle(req, res));
     server.unref();
-    const failure = await new Promise((resolve3) => {
-      server.once("error", resolve3);
-      server.listen(port, "127.0.0.1", () => resolve3(undefined));
+    const failure = await new Promise((resolve) => {
+      server.once("error", resolve);
+      server.listen(port, "127.0.0.1", () => resolve(undefined));
     });
     if (!failure) {
       this.server = server;
@@ -514,15 +516,15 @@ class ImageServer {
     const root = this.root;
     if (!root)
       return;
-    let relative2;
+    let relative;
     try {
-      relative2 = Buffer.from(id, "base64url").toString("utf8");
+      relative = Buffer.from(id, "base64url").toString("utf8");
     } catch {
       return;
     }
-    if (!relative2 || relative2.includes("\x00") || path4.isAbsolute(relative2))
+    if (!relative || relative.includes("\x00") || path4.isAbsolute(relative))
       return;
-    const target = path4.resolve(root, relative2);
+    const target = path4.resolve(root, relative);
     if (target === root || !target.startsWith(root + path4.sep))
       return;
     try {
@@ -573,9 +575,25 @@ class ImageServer {
 }
 
 // src/index.ts
-var z = tool.schema;
-function resolveDestination(filename, outDir, ctx) {
-  const dir = resolveOutDir(ctx.directory, outDir);
+var PLUGIN_ID = "opencode-image";
+var GENERATE_DESCRIPTION = "Generate an image from a text prompt. This is the only supported way to create images in this session: " + "the endpoint and API key are already configured inside this plugin, so NEVER call the image API yourself " + "(no curl, no scripts) and never read the API key out of opencode.json. " + "The first line of the output is a Markdown image line (plus a separate 查看原图 link when displayMaxSize > 0); " + "you MUST copy those lines verbatim into your reply text, otherwise the user cannot see the picture. " + "If the output contains a line starting with [请转述给用户], relay that line to the user as well. " + "To refine a result, call image_edit with the returned path instead of generating a new image.";
+var EDIT_DESCRIPTION = "Edit an existing image with a text instruction (image-to-image). Prefer this over generating a new image " + "when the user wants to adjust a picture: pass the exact path returned by a previous image_generate or " + "image_edit call to keep refining the same one. " + "Same rules: never call the image API yourself and never read the API key; copy the Markdown image line " + "(and the 查看原图 link, if present) from the output verbatim into your reply, and relay any line starting " + "with [请转述给用户].";
+var CACHE_DESCRIPTION = "Inspect or clear the preview-thumbnail cache used for rendering images in the conversation. " + 'Use action="status" to report the cache directory, file count, total size and age of the oldest entry; ' + 'action="clean" to delete every cached preview (the generated images in outDir are NOT touched). ' + "This returns text only — do not turn it into a Markdown image line.";
+var SYSTEM_RULE = "Image generation/editing: always use the `image_generate` / `image_edit` tools provided by the " + "opencode-image plugin — the endpoint and API key are already configured there. Never call the image API " + "directly, never read the API key from config, and do not use the imagegen skill or its CLI. Copy the " + "Markdown image line from that tool's output verbatim into your reply so the user can see the picture.";
+var GenerateInput = Schema.Struct({
+  prompt: Schema.String,
+  filename: Schema.optional(Schema.String)
+});
+var EditInput = Schema.Struct({
+  image: Schema.String,
+  prompt: Schema.String,
+  filename: Schema.optional(Schema.String)
+});
+var CacheInput = Schema.Struct({
+  action: Schema.Literals(["status", "clean"])
+});
+function resolveDestination(filename, options, directory) {
+  const dir = resolveOutDir(directory, options.outDir);
   if (filename) {
     const target = path5.isAbsolute(filename) ? filename : path5.join(dir, filename);
     return `${target.replace(/\.[A-Za-z0-9]+$/, "")}.png`;
@@ -585,123 +603,119 @@ function resolveDestination(filename, outDir, ctx) {
   return path5.join(dir, `image-${stamp}-${suffix}.png`);
 }
 function asAttachment(file) {
-  return [
-    {
-      type: "file",
-      mime: "image/png",
-      filename: path5.basename(file),
-      url: `data:image/png;base64,${fs5.readFileSync(file).toString("base64")}`
-    }
-  ];
+  return {
+    type: "file",
+    mime: "image/png",
+    name: path5.basename(file),
+    uri: `data:image/png;base64,${fs5.readFileSync(file).toString("base64")}`
+  };
 }
-var OpenCodeImagePlugin = async (_input, rawOptions) => {
-  const options = resolveOptions(rawOptions);
-  const cache = new PreviewCache(options.cacheDir, options.cacheLimit);
-  const server = new ImageServer(options.serverIdleMs, options.serverPort, cache);
-  const selfVersion = readOwnVersion();
-  let updateHint;
-  let updateChecked = false;
-  const upgradeNotice = async () => {
-    if (!options.updateCheck || updateChecked || !selfVersion)
+var OpenCodeImagePlugin = Plugin.define({
+  id: PLUGIN_ID,
+  setup: async (ctx) => {
+    const options = resolveOptions(ctx.options);
+    const directory = ctx.location.directory;
+    const outDir = resolveOutDir(directory, options.outDir);
+    const cache = new PreviewCache(options.cacheDir, options.cacheLimit);
+    const server = new ImageServer(options.serverIdleMs, options.serverPort, cache);
+    const selfVersion = readOwnVersion();
+    let updateHint;
+    let updateChecked = false;
+    const upgradeNotice = async () => {
+      if (!options.updateCheck || updateChecked || !selfVersion)
+        return updateHint;
+      updateChecked = true;
+      updateHint = await checkForUpdate(selfVersion);
       return updateHint;
-    updateChecked = true;
-    updateHint = await checkForUpdate(selfVersion);
-    return updateHint;
-  };
-  const result = async (label, prompt, file, ctx, usage) => {
-    const { width, height } = await imageDimensions(file);
-    let display;
-    try {
-      await server.start({ outDir: resolveOutDir(ctx.directory, options.outDir) });
-      const alt = prompt.slice(0, 60);
-      const lines = [`![${alt}](${server.url(file, options.displayMaxSize)})`];
-      if (options.displayMaxSize > 0)
-        lines.push(`[查看原图](${server.url(file, 0)})`);
-      display = lines.join(`
+    };
+    const render = async (label, prompt, file, progress, usage) => {
+      const { width, height } = await imageDimensions(file);
+      let display;
+      try {
+        await server.start({ outDir });
+        const alt = prompt.slice(0, 60);
+        const lines = [`![${alt}](${server.url(file, options.displayMaxSize)})`];
+        if (options.displayMaxSize > 0)
+          lines.push(`[查看原图](${server.url(file, 0)})`);
+        display = lines.join(`
 `);
-    } catch (error) {
-      display = `[opencode-image: local image server unavailable, cannot render inline: ${String(error)}]`;
-    }
-    const notice = await upgradeNotice();
-    const output = [
-      display,
-      `${label} saved to ${file} (${width}x${height})`,
-      `Refine it by calling image_edit with image="${file}" and a prompt describing the change.`,
-      `IMPORTANT: copy the Markdown image line above verbatim into your reply text, otherwise the user cannot see the picture.`
-    ];
-    if (notice)
-      output.push(notice);
-    const cacheNotice = server.consumeCacheNotice();
-    if (cacheNotice)
-      output.push(cacheNotice);
-    return {
-      title: `${label}: ${prompt.slice(0, 60)}`,
-      output: output.join(`
-`),
-      metadata: { file, prompt, usage },
-      attachments: asAttachment(file)
+      } catch (error) {
+        display = `[opencode-image: local image server unavailable, cannot render inline: ${String(error)}]`;
+      }
+      const notice = await upgradeNotice();
+      const output = [
+        display,
+        `${label} saved to ${file} (${width}x${height})`,
+        `Refine it by calling image_edit with image="${file}" and a prompt describing the change.`,
+        `IMPORTANT: copy the Markdown image line above verbatim into your reply text, otherwise the user cannot see the picture.`
+      ];
+      if (notice)
+        output.push(notice);
+      const cacheNotice = server.consumeCacheNotice();
+      if (cacheNotice)
+        output.push(cacheNotice);
+      progress(`${label}: ${prompt.slice(0, 60)}`);
+      return {
+        content: [{ type: "text", text: output.join(`
+`) }, asAttachment(file)],
+        metadata: { file, prompt, usage }
+      };
     };
-  };
-  const generate = async (args, ctx) => {
-    ctx.metadata({ title: `Generating image: ${args.prompt.slice(0, 60)}` });
-    const { signal, clear } = withTimeout(ctx.abort, options.timeoutMs);
-    try {
-      const remote = await generateImage(options, args.prompt, signal);
-      const raw = await fetchImageBytes(remote, signal);
-      const destination = resolveDestination(args.filename, options.outDir, ctx);
-      await persistImage(raw, destination, options.maxSize);
-      return result("Image generated", args.prompt, destination, ctx, remote.usage);
-    } finally {
-      clear();
-    }
-  };
-  const edit = async (args, ctx) => {
-    const source = path5.isAbsolute(args.image) ? args.image : path5.resolve(ctx.directory, args.image);
-    if (!fs5.existsSync(source))
-      throw new Error(`image_edit: source image not found: ${source}`);
-    ctx.metadata({ title: `Editing image: ${args.prompt.slice(0, 60)}` });
-    const { signal, clear } = withTimeout(ctx.abort, options.timeoutMs);
-    try {
-      const upload = await toPngBuffer(source, options.maxSize);
-      const remote = await editImage(options, upload, `${path5.basename(source, path5.extname(source))}.png`, args.prompt, signal);
-      const raw = await fetchImageBytes(remote, signal);
-      const destination = resolveDestination(args.filename, options.outDir, ctx);
-      await persistImage(raw, destination, options.maxSize);
-      return result("Image edited", args.prompt, destination, ctx, remote.usage);
-    } finally {
-      clear();
-    }
-  };
-  return {
-    tool: {
-      image_generate: tool({
-        description: "Generate a new image from a text prompt using an OpenAI-compatible image API. " + "The result starts with a Markdown image line (plus a separate 查看原图 link when displayMaxSize is set) that you MUST copy verbatim into your reply text, " + "If the output contains a line starting with [请转述给用户], relay that line to the user in your reply. " + "otherwise the user cannot see the picture. To iterate on a result, call image_edit with the returned path.",
-        args: {
-          prompt: z.string().describe("Detailed description of the image to generate"),
-          filename: z.string().optional().describe("Optional output file name or path; defaults to a timestamped name")
-        },
-        execute: generate
-      }),
-      image_edit: tool({
-        description: "Edit an existing image with a text instruction (image-to-image). Pass the exact path returned by a previous " + "image_generate or image_edit call to keep refining the same picture. " + "The result starts with a Markdown image line (plus a separate 查看原图 link when displayMaxSize is set) that you MUST copy verbatim into your reply text, " + "If the output contains a line starting with [请转述给用户], relay that line to the user in your reply. " + "otherwise the user cannot see the picture.",
-        args: {
-          image: z.string().describe("Path to the source image, normally the file returned by image_generate/image_edit"),
-          prompt: z.string().describe("What to change, e.g. 'make the hat red, keep everything else identical'"),
-          filename: z.string().optional().describe("Optional output file name or path; defaults to a timestamped name")
-        },
-        execute: edit
-      }),
-      image_cache: tool({
-        description: "Inspect or clear the preview-thumbnail cache used for rendering images in the conversation. " + 'Use action="status" to report the cache directory, file count, total size and age of the oldest entry; ' + 'action="clean" to delete every cached preview (the generated images in outDir are NOT touched). ' + "This returns text only — do not turn it into a Markdown image line.",
-        args: {
-          action: z.enum(["status", "clean"]).describe("status = 查看缓存；clean = 清空缓存")
-        },
+    await ctx.tool.transform((tools) => {
+      tools.add({
+        name: "image_generate",
+        description: GENERATE_DESCRIPTION,
+        input: GenerateInput,
+        options: { codemode: false },
+        execute: async (args, toolCtx) => {
+          const title = `Generating image: ${args.prompt.slice(0, 60)}`;
+          await toolCtx.progress({ title });
+          const { signal, clear } = withTimeout(toolCtx.signal, options.timeoutMs);
+          try {
+            const remote = await generateImage(options, args.prompt, signal);
+            const raw = await fetchImageBytes(remote, signal);
+            const destination = resolveDestination(args.filename, options, directory);
+            await persistImage(raw, destination, options.maxSize);
+            return await render("Image generated", args.prompt, destination, (m) => void toolCtx.progress({ title: m }), remote.usage);
+          } finally {
+            clear();
+          }
+        }
+      });
+      tools.add({
+        name: "image_edit",
+        description: EDIT_DESCRIPTION,
+        input: EditInput,
+        options: { codemode: false },
+        execute: async (args, toolCtx) => {
+          const source = path5.isAbsolute(args.image) ? args.image : path5.resolve(directory, args.image);
+          if (!fs5.existsSync(source))
+            throw new Error(`image_edit: source image not found: ${source}`);
+          const title = `Editing image: ${args.prompt.slice(0, 60)}`;
+          await toolCtx.progress({ title });
+          const { signal, clear } = withTimeout(toolCtx.signal, options.timeoutMs);
+          try {
+            const upload = await toPngBuffer(source, options.maxSize);
+            const remote = await editImage(options, upload, `${path5.basename(source, path5.extname(source))}.png`, args.prompt, signal);
+            const raw = await fetchImageBytes(remote, signal);
+            const destination = resolveDestination(args.filename, options, directory);
+            await persistImage(raw, destination, options.maxSize);
+            return await render("Image edited", args.prompt, destination, (m) => void toolCtx.progress({ title: m }), remote.usage);
+          } finally {
+            clear();
+          }
+        }
+      });
+      tools.add({
+        name: "image_cache",
+        description: CACHE_DESCRIPTION,
+        input: CacheInput,
+        options: { codemode: false },
         execute: async (args) => {
           if (args.action === "clean") {
             const removed = server.cleanCache();
             return {
-              title: `已清理图片缓存（${removed.count} 个 / ${humanBytes(removed.bytes)}）`,
-              output: [
+              content: [
                 `已清理 ${removed.count} 个预览文件，共 ${humanBytes(removed.bytes)}。`,
                 `缓存目录：${removed.dir}`,
                 `注意：这不影响 outDir 里的原图，会话里的图片仍能正常显示（需要时会重新生成缩略图）。`
@@ -712,8 +726,7 @@ var OpenCodeImagePlugin = async (_input, rawOptions) => {
           }
           const stats = server.cacheStats();
           return {
-            title: `图片缓存：${stats.count} 个 / ${humanBytes(stats.bytes)}`,
-            output: [
+            content: [
               `缓存目录：${stats.dir}`,
               `文件数量：${stats.count}`,
               `占用大小：${humanBytes(stats.bytes)}`,
@@ -724,15 +737,17 @@ var OpenCodeImagePlugin = async (_input, rawOptions) => {
             metadata: stats
           };
         }
-      })
-    },
-    dispose: async () => {
-      server.stop();
-    }
-  };
-};
+      });
+    });
+    if (options.injectPrompt)
+      await ctx.session.hook("context", (event) => {
+        event.system.push({ type: "text", text: SYSTEM_RULE });
+      });
+    return () => server.stop();
+  }
+});
 var src_default = OpenCodeImagePlugin;
 export {
-  src_default as default,
-  OpenCodeImagePlugin
+  OpenCodeImagePlugin,
+  src_default as default
 };

package/dist/options.d.ts

@@ -30,6 +30,8 @@ export type PluginOptions = {
     serverIdleMs?: number;
     /** 首次出图时查一次 npm 最新版，落后则在工具输出末尾附升级提示。默认开启 */
     updateCheck?: boolean;
+    /** 往系统提示里注入一条"用哪个工具生图"的规则。默认开启 */
+    injectPrompt?: boolean;
     /** 对话里展示用的缩略图缓存目录，默认 <系统临时目录>/opencode-image */
     cacheDir?: string;
     /** 缩略图缓存最多保留多少个文件，超出按最久未访问淘汰；0 表示不限制 */
@@ -56,6 +58,7 @@ export type ResolvedOptions = {
     serverPort: number;
     serverIdleMs: number;
     updateCheck: boolean;
+    injectPrompt: boolean;
     cacheDir: string;
     cacheLimit: number;
     timeoutMs: number;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "opencode-image",
-  "version": "0.1.2",
-  "description": "Image generation and editing tools for opencode, with inline rendering in the conversation.",
+  "version": "2.0.0",
+  "description": "Image generation and editing tools for opencode (v2 plugin API), with inline rendering in the conversation.",
   "type": "module",
   "license": "MIT",
   "keywords": [
@@ -23,7 +23,8 @@
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public"
+    "access": "public",
+    "tag": "next"
   },
   "exports": {
     ".": {
@@ -39,25 +40,31 @@
   ],
   "scripts": {
     "build": "bun run build:js && bun run build:types",
-    "build:js": "bun build src/index.ts --target=node --format=esm --external sharp --external @opencode-ai/plugin --outfile=dist/index.js",
+    "build:js": "bun build src/index.ts --target=node --format=esm --external sharp --external @opencode/plugin --external effect --outfile=dist/index.js",
     "build:types": "tsc --emitDeclarationOnly --declaration --outDir dist",
     "typecheck": "tsc --noEmit",
     "test": "bun test",
     "prepublishOnly": "bun run build && bun test",
-    "release": "npm version patch && npm publish && rm -rf ~/.cache/opencode/packages/opencode-image*"
+    "release": "npm publish && rm -rf ~/.cache/opencode/packages/opencode-image*",
+    "release:legacy": "npm version patch && npm publish --tag latest"
   },
   "engines": {
     "node": ">=18"
   },
   "dependencies": {
-    "@opencode-ai/plugin": "^1.18.30",
     "sharp": "^0.35.4"
   },
+  "peerDependencies": {
+    "@opencode/plugin": ">=2.0.27",
+    "effect": "^4.0.0"
+  },
   "devDependencies": {
+    "@opencode/plugin": "2.0.27",
     "@types/node": "^24.12.2",
+    "effect": "4.0.1",
     "typescript": "^5.8.2"
   },
   "bin": {
-    "opencode-image": "./bin/cli.js"
+    "opencode-image": "bin/cli.js"
   }
 }