@amaster.ai/pi-image-gen 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,310 @@
+# @amaster.ai/pi-image-gen
+
+![pi-image-gen preview](https://raw.githubusercontent.com/TGYD-helige/pi/master/packages/pi-image-gen/preview.png)
+
+Pi extension that adds an `image_generate` tool. Supported providers:
+
+| Provider                       | Model id (alias)                              | Env var               |
+| ------------------------------ | --------------------------------------------- | --------------------- |
+| OpenAI                         | `gpt-image-1` (alias `gpt-image-2`)             | `OPENAI_API_KEY`      |
+| Google Gemini ("Nano Banana")  | `gemini-3-pro-image` (alias `nano-banana-pro`), `gemini-3-pro-image-preview`, `gemini-3.1-flash-image` (alias `nano-banana`), `gemini-3.1-flash-image-preview`, `gemini-2.5-flash-image` (alias `nano-banana-2`), `gemini-2.0-flash-image` | `GEMINI_API_KEY`      |
+| Alibaba DashScope (Qwen-Image) | `qwen-image-2.0-pro` (alias `qwen-image-pro`), `qwen-image-2.0` (alias `qwen-image-2`, `qwen-image`) | `DASHSCOPE_API_KEY` |
+| OpenRouter                     | any (use `openrouter/<vendor>/<id>`)          | `OPENROUTER_API_KEY`  |
+| Custom providers               | whatever you declare in settings              | (your choice, via `$VAR`) |
+
+The env-var names match [pi.dev's provider table](https://pi.dev/docs/latest/providers) — if the agent already has a key set for a provider, this extension will reuse it. You don't need to introduce a new variable.
+
+The active model is **fixed in settings.json**. The `image_generate` tool intentionally does **not** take a `model` parameter — point your project at one model, get consistent output. To switch models, edit settings and run `/image-gen reload`.
+
+## Install
+
+```sh
+pnpm add @amaster.ai/pi-image-gen
+```
+
+The package's `pi.extensions` field auto-registers it with the host pi-coding-agent runtime; no extra wiring needed.
+
+## Configure
+
+Settings are read by `pi-shared`'s `loadPiSettings`, which merges three files (low-to-high priority):
+
+1. `~/.pi/agent/settings.json` (global)
+2. `$PI_AGENT_HOME/settings.json` (agent dir, if `PI_AGENT_HOME` is set)
+3. `<cwd>/.pi/settings.json` (project)
+
+All settings live under the `pi-image-gen` key. The minimum viable config sets `defaultModel`:
+
+```json
+{
+  "pi-image-gen": {
+    "defaultModel": "nano-banana"
+  }
+}
+```
+
+…and exports the matching env var:
+
+```sh
+export GEMINI_API_KEY=sk-...
+```
+
+That's it. From the agent: `image_generate({ prompt: "a cyberpunk cat" })`.
+
+### All settings fields
+
+```json
+{
+  "pi-image-gen": {
+    "defaultModel": "nano-banana",
+    "outputDir": ".pi/images",
+
+    "providers": {
+      "openai":     { "baseUrl": "https://my-proxy.example.com/v1", "apiKey": "${MY_OPENAI_KEY}" },
+      "gemini":     { "headers": { "x-goog-trace": "pi-prod" } },
+      "dashscope":  { "baseUrl": "https://dashscope-intl.aliyuncs.com/api/v1" },
+      "openrouter": { "apiKey": "$OPENROUTER_API_KEY" }
+    },
+
+    "customProviders": {
+      "my-stable-diffusion": {
+        "api": "openai",
+        "baseUrl": "https://api.my-sd.example.com/v1",
+        "apiKey": "${MY_SD_KEY}",
+        "headers": { "x-tenant": "team-a" },
+        "models": [
+          { "id": "sd-3-large", "alias": "sd3" },
+          "sd-3-medium"
+        ]
+      }
+    }
+  }
+}
+```
+
+| Field             | Purpose                                                                                  |
+| ----------------- | ---------------------------------------------------------------------------------------- |
+| `defaultModel`    | Model id or alias the tool will use. **Required.**                                       |
+| `outputDir`       | Where to write generated images. Relative paths resolve against the session cwd. Default `.pi/images`. |
+| `providers`       | Per-built-in-provider override. Set `apiKey`, `baseUrl`, or `headers` to point at a proxy or non-standard env var. |
+| `customProviders` | User-defined providers — see below.                                                      |
+
+`apiKey`, `baseUrl`, and `headers` values support `$VAR` and `${VAR}` env interpolation, with `:-` fallback (e.g. `${FOO:-default}`).
+
+## Built-in setup walkthrough
+
+### 1. OpenAI (`gpt-image-1` / `gpt-image-2`)
+
+```sh
+export OPENAI_API_KEY=sk-...
+```
+
+```json
+{ "pi-image-gen": { "defaultModel": "gpt-image-2" } }
+```
+
+### 2. Google Gemini "Nano Banana"
+
+```sh
+export GEMINI_API_KEY=...
+```
+
+```json
+{ "pi-image-gen": { "defaultModel": "nano-banana" } }
+```
+
+### 3. Alibaba DashScope (Qwen-Image)
+
+```sh
+export DASHSCOPE_API_KEY=...
+```
+
+```json
+{ "pi-image-gen": { "defaultModel": "qwen-image-2" } }
+```
+
+For the international DashScope endpoint, override the base URL:
+
+```json
+{
+  "pi-image-gen": {
+    "defaultModel": "qwen-image-2",
+    "providers": {
+      "dashscope": { "baseUrl": "https://dashscope-intl.aliyuncs.com/api/v1" }
+    }
+  }
+}
+```
+
+### 4. OpenRouter (one key, many models)
+
+```sh
+export OPENROUTER_API_KEY=...
+```
+
+```json
+{ "pi-image-gen": { "defaultModel": "openrouter/google/gemini-2.5-flash-image" } }
+```
+
+The string after `openrouter/` is the OpenRouter model slug; pass any image model OpenRouter supports.
+
+## Custom providers
+
+Use `customProviders` for anything not built in: a self-hosted Stable Diffusion, an internal corp gateway, a third-party image API. The shape mirrors [pi.dev's custom-provider docs](https://pi.dev/docs/latest/custom-provider).
+
+Each custom provider declares:
+
+| Field      | Required | Notes                                                                                |
+| ---------- | -------- | ------------------------------------------------------------------------------------ |
+| `api` | yes      | One of `openai`, `gemini`, `dashscope`, `openrouter`. Picks the image-API wire shape. |
+| `baseUrl`  | yes      | API endpoint URL. `$VAR` syntax supported.                                           |
+| `apiKey`   | usually  | API key string. `$VAR` syntax supported.                                             |
+| `name`     | no       | Display name shown in `/image-gen list`.                                             |
+| `headers`  | no       | Extra headers merged into every request.                                             |
+| `models`   | no       | Optional model id/alias list. Omit to make this a **catch-all** — the provider will accept any unknown model id (passed through as the remote id). Provide a list only when you want aliases or want to route specific ids elsewhere. Each entry is a string or `{ id, alias?, name? }`. |
+
+> Note: pi.dev custom providers also have an `api` field, but its values (`openai-completions`, `anthropic-messages`, …) are LLM streaming formats that don't apply to image generation. The values here (`openai`, `gemini`, `dashscope`, `openrouter`) are image-API wire shapes — same field name, different namespace.
+
+### Example: self-hosted Stable Diffusion (OpenAI-compatible)
+
+```sh
+export SD_KEY=local-secret
+```
+
+```json
+{
+  "pi-image-gen": {
+    "defaultModel": "sd3",
+    "customProviders": {
+      "my-sd": {
+        "api": "openai",
+        "baseUrl": "http://localhost:8000/v1",
+        "apiKey": "$SD_KEY",
+        "models": [{ "id": "sd-3-large", "alias": "sd3" }]
+      }
+    }
+  }
+}
+```
+
+The agent calls `image_generate({prompt: ...})`; the extension sees `defaultModel: "sd3"`, finds it under `my-sd`, and POSTs to `http://localhost:8000/v1/images/generations` with `Bearer $SD_KEY`.
+
+### Example: Volcengine Doubao image API (OpenAI-compatible)
+
+```json
+{
+  "pi-image-gen": {
+    "defaultModel": "doubao-seed-image",
+    "customProviders": {
+      "doubao": {
+        "api": "openai",
+        "baseUrl": "https://ark.cn-beijing.volces.com/api/v3",
+        "apiKey": "${ARK_API_KEY}",
+        "models": [{ "id": "doubao-seedream-4-0-250828", "alias": "doubao-seed-image" }]
+      }
+    }
+  }
+}
+```
+
+### Example: a Gemini-shape proxy
+
+If your provider speaks the Google Generative Language wire format:
+
+```json
+{
+  "pi-image-gen": {
+    "defaultModel": "internal-banana",
+    "customProviders": {
+      "internal": {
+        "api": "gemini",
+        "baseUrl": "https://gemini-proxy.corp.example/v1beta",
+        "apiKey": "$INTERNAL_GEMINI_KEY",
+        "models": [{ "id": "gemini-2.5-flash-image", "alias": "internal-banana" }]
+      }
+    }
+  }
+}
+```
+
+### Direct addressing without an alias
+
+If a custom provider has no `models` list, you can still address it with `<providerName>/<remoteId>`:
+
+```json
+{
+  "pi-image-gen": {
+    "defaultModel": "my-sd/sd-3-large",
+    "customProviders": {
+      "my-sd": { "api": "openai", "baseUrl": "http://localhost:8000/v1", "apiKey": "$SD_KEY" }
+    }
+  }
+}
+```
+
+## Tool: `image_generate`
+
+```ts
+image_generate({
+  prompt: string,                  // required — what to draw or how to edit
+  image?: string[],                // optional — array of file paths or http(s) URLs
+  n?: number,                      // 1–8, default 1
+  size?: string,                   // e.g. "1024x1024" — provider-specific
+  filename?: string,               // filename prefix (no extension)
+  outputDir?: string,              // override settings.outputDir for this call
+})
+```
+
+Returns the absolute file path(s) of saved images. Files land in `outputDir` (default `<cwd>/.pi/images`), filename pattern `<filename or model-UTC-stamp>.<ext>`.
+
+### Tool result format
+
+The tool's text result is shaped as ready-to-paste markdown the model can copy verbatim into its reply, so the UI renders the image inline:
+
+```
+Generated 1 image(s) via amaster (custom) (qwen-image-2.0). Show each one to the user as inline markdown — copy the lines below verbatim into your reply:
+
+![white](/Users/.../white.png)
+```
+
+The `alt` text is the filename without its extension — i.e. whatever you passed as `filename`, or `<model>-<UTC-stamp>` if you didn't. When OpenAI returns a `revised_prompt`, it appears as a quote line under the image:
+
+```
+![beaver](/Users/.../beaver.png)
+> revised prompt: a cute beaver, photorealistic, water droplets
+```
+
+### Image-to-image / edit
+
+`image` is always an array — pass `["path"]` for a single image, `["a", "b"]` for multi-image conditioning. Each entry must be:
+
+- **Local file path** — absolute or relative (resolved against the session cwd).
+- **http(s) URL** — downloaded with the same fetch (and abort signal) used for the API call.
+
+Base64 strings and `data:` URIs are intentionally rejected — tool arguments don't survive megabyte-sized strings cleanly. If you have raw image bytes, write them to a file first and pass the path.
+
+**Iterating on a previous result:** pass the previous output path back. The next image is conditioned on the last one:
+
+```
+image_generate({ prompt: "a beaver chewing wood", filename: "beaver" })
+  → /Users/.../.pi/images/beaver.png
+
+image_generate({ prompt: "now in watercolor style", image: ["/Users/.../.pi/images/beaver.png"] })
+  → /Users/.../.pi/images/gpt-image-1-20260605-...png  (edited)
+```
+
+Provider behavior:
+
+| Provider | Image input route |
+|---|---|
+| OpenAI (`gpt-image-1`) | `POST /v1/images/edits` (multipart). Supports multi-image. |
+| Gemini (`gemini-3.x-flash-image`, `nano-banana`) | `inline_data` parts prepended to the user message. Supports multi-image. |
+| DashScope (`qwen-image-2.0`, `qwen-image-2.0-pro`) | `image` parts in `messages[].content`. |
+
+There is intentionally no `model` parameter on the tool — the active model is fixed by `pi-image-gen.defaultModel` in settings.
+
+## Slash commands
+
+- `/image-gen list` — show the active model, which provider it routes to, whether the key is set, configured providers, and the catalog of built-in model ids.
+- `/image-gen reload` — re-read settings from disk.
+
+Use `/image-gen list` to verify your config — it will tell you when `defaultModel` is unset, points at a provider with no API key, or names an unknown id.

package/dist/config.d.ts

@@ -0,0 +1,24 @@
+import type { ImageGenSettings, ResolvedModel, ResolvedProvider } from './types.js';
+export declare function loadImageGenSettings(cwd: string): ImageGenSettings;
+/**
+ * Resolve a model id (or alias) to a (provider, remoteModelId) pair using:
+ *   1. Custom providers' explicit model lists (alias or id match).
+ *   2. Built-in known models (alias or id match).
+ *   3. `<provider>/<remote-id>` fallback for explicit routing.
+ *   4. Catch-all: any custom provider that didn't declare a `models` list
+ *      will accept any unknown model id, passing it through as the remote id.
+ *      This lets users configure a single OpenAI-compatible gateway and use
+ *      any model name without restating it in `models`.
+ */
+export declare function resolveModel(modelOrAlias: string, settings: ImageGenSettings): ResolvedModel | {
+    error: string;
+};
+export declare function listKnownModelIds(): string[];
+export type ConfiguredProvider = ResolvedProvider & {
+    /** True for customProviders without an explicit `models` list — accepts any unknown id. */
+    catchAll: boolean;
+    /** Number of model entries explicitly declared. */
+    modelCount: number;
+};
+export declare function listConfiguredProviders(settings: ImageGenSettings): ConfiguredProvider[];
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAIV,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EACjB,MAAM,YAAY,CAAC;AAIpB,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CASlE;AAsED;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAC1B,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,gBAAgB,GACzB,aAAa,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAgDnC;AA4BD,wBAAgB,iBAAiB,IAAI,MAAM,EAAE,CAE5C;AAED,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG;IAClD,2FAA2F;IAC3F,QAAQ,EAAE,OAAO,CAAC;IAClB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,kBAAkB,EAAE,CAcxF"}