@aigne/ideogram 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [0.2.0](https://github.com/AIGNE-io/aigne-framework/compare/ideogram-v0.1.0...ideogram-v0.2.0) (2025-08-27)
+
+
+### Features
+
+* **models:** support gemini and ideogram images models ([#412](https://github.com/AIGNE-io/aigne-framework/issues/412)) ([6534fec](https://github.com/AIGNE-io/aigne-framework/commit/6534fecb0bdfb4b0a4440d44c0e563b9a029a68f))
+* **models:** support gemini and ideogram images models ([#412](https://github.com/AIGNE-io/aigne-framework/issues/412)) ([6534fec](https://github.com/AIGNE-io/aigne-framework/commit/6534fecb0bdfb4b0a4440d44c0e563b9a029a68f))

package/LICENSE.md

@@ -0,0 +1,93 @@
+Elastic License 2.0
+
+URL: https://www.elastic.co/licensing/elastic-license
+
+## Acceptance
+
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+
+The licensor grants you a non-exclusive, royalty-free, worldwide,
+non-sublicensable, non-transferable license to use, copy, distribute, make
+available, and prepare derivative works of the software, in each case subject to
+the limitations and conditions below.
+
+## Limitations
+
+You may not provide the software to third parties as a hosted or managed
+service, where the service provides users with access to any substantial set of
+the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality
+in the software, and you may not remove or obscure any functionality in the
+software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices
+of the licensor in the software. Any use of the licensor’s trademarks is subject
+to applicable law.
+
+## Patents
+
+The licensor grants you a license, under any patent claims the licensor can
+license, or becomes able to license, to make, have made, use, sell, offer for
+sale, import and have imported the software, in each case subject to the
+limitations and conditions in this license. This license does not cover any
+patent claims that you cause to be infringed by modifications or additions to
+the software. If you or your company make any written claim that the software
+infringes or contributes to infringement of any patent, your patent license for
+the software granted under these terms ends immediately. If your company makes
+such a claim, your patent license ends immediately for work on behalf of your
+company.
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you
+also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the
+software prominent notices stating that you have modified the software.
+
+## No Other Rights
+
+These terms do not imply any licenses other than those expressly granted in
+these terms.
+
+## Termination
+
+If you use the software in violation of these terms, such use is not licensed,
+and your licenses will automatically terminate. If the licensor provides you
+with a notice of your violation, and you cease all violation of this license no
+later than 30 days after you receive that notice, your licenses will be
+reinstated retroactively. However, if you violate these terms after such
+reinstatement, any additional violation of these terms will cause your licenses
+to terminate automatically and permanently.
+
+## No Liability
+
+*As far as the law allows, the software comes as is, without any warranty or
+condition, and the licensor will not be liable to you for any damages arising
+out of these terms or the use or nature of the software, under any kind of
+legal claim.*
+
+## Definitions
+
+The **licensor** is the entity offering these terms, and the **software** is the
+software the licensor makes available under these terms, including any portion
+of it.
+
+**you** refers to the individual or entity agreeing to these terms.
+
+**your company** is any legal entity, sole proprietorship, or other kind of
+organization that you work for, plus all organizations that have control over,
+are under the control of, or are under common control with that
+organization. **control** means ownership of substantially all the assets of an
+entity, or the power to direct its management and policies by vote, contract, or
+otherwise. Control can be direct or indirect.
+
+**your licenses** are all the licenses granted to you for the software under
+these terms.
+
+**use** means anything you do with the software requiring one of your licenses.
+
+**trademark** means trademarks, service marks, and similar rights.

package/README.md

@@ -0,0 +1,82 @@
+# @aigne/ideogram
+
+<p align="center">
+  <picture>
+    <source srcset="https://raw.githubusercontent.com/AIGNE-io/aigne-framework/main/logo-dark.svg" media="(prefers-color-scheme: dark)">
+    <source srcset="https://raw.githubusercontent.com/AIGNE-io/aigne-framework/main/logo.svg" media="(prefers-color-scheme: light)">
+    <img src="https://raw.githubusercontent.com/AIGNE-io/aigne-framework/main/logo.svg" alt="AIGNE Logo" width="400" />
+  </picture>
+</p>
+
+[![GitHub star chart](https://img.shields.io/github/stars/AIGNE-io/aigne-framework?style=flat-square)](https://star-history.com/#AIGNE-io/aigne-framework)
+[![Open Issues](https://img.shields.io/github/issues-raw/AIGNE-io/aigne-framework?style=flat-square)](https://github.com/AIGNE-io/aigne-framework/issues)
+[![codecov](https://codecov.io/gh/AIGNE-io/aigne-framework/graph/badge.svg?token=DO07834RQL)](https://codecov.io/gh/AIGNE-io/aigne-framework)
+[![NPM Version](https://img.shields.io/npm/v/@aigne/ideogram)](https://www.npmjs.com/package/@aigne/ideogram)
+[![Elastic-2.0 licensed](https://img.shields.io/npm/l/@aigne/ideogram)](https://github.com/AIGNE-io/aigne-framework/blob/main/LICENSE.md)
+
+AIGNE Ideogram SDK for integrating with Ideogram's image generation models and API services within the [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework).
+
+## Introduction
+
+`@aigne/ideogram` provides a seamless integration between the AIGNE Framework and Ideogram's powerful image generation models and APIs. This package enables developers to easily leverage Ideogram's advanced image generation capabilities in their AIGNE applications, providing a consistent interface across the framework while taking advantage of Ideogram's state-of-the-art image synthesis technology.
+
+
+## Installation
+
+### Using npm
+
+```bash
+npm install @aigne/ideogram 
+```
+
+### Using yarn
+
+```bash
+yarn add @aigne/ideogram 
+```
+
+### Using pnpm
+
+```bash
+pnpm add @aigne/ideogram 
+```
+
+## Basic Usage
+
+```typescript
+import { IdeogramImageModel } from "@aigne/ideogram";
+
+const model = new IdeogramImageModel({
+  apiKey: "your-api-key", // Optional if set in env variables
+});
+
+const result = await model.invoke({
+  prompt: "A serene mountain landscape at sunset with golden light",
+});
+
+console.log(result);
+/* Output:
+  {
+    images: [
+      {
+        url: "https://api.ideogram.ai/generation/...",
+      }
+    ],
+    usage: {
+      promptTokens: 0
+      imageCount: 0
+    }
+  }
+  */
+```
+## Environment Variables
+
+Set the following environment variable for automatic API key detection:
+
+```bash
+export IDEOGRAM_API_KEY="your-ideogram-api-key"
+```
+
+## License
+
+Elastic-2.0

package/lib/cjs/ideogram-image-model.d.ts

@@ -0,0 +1,36 @@
+import { ImageModel, type ImageModelInput, type ImageModelOptions, type ImageModelOutput } from "@aigne/core";
+export interface IdeogramImageModelInput extends ImageModelInput {
+    seed?: number;
+    resolution?: string;
+    aspectRatio?: string;
+    renderingSpeed?: string;
+    magicPrompt?: string;
+    negativePrompt?: string;
+    numImages?: number;
+    colorPalette?: any;
+    styleCodes?: string[];
+    styleType?: string;
+}
+export interface IdeogramImageModelOutput extends ImageModelOutput {
+}
+export interface IdeogramImageModelOptions extends ImageModelOptions<IdeogramImageModelInput, IdeogramImageModelOutput> {
+    apiKey?: string;
+    baseURL?: string;
+    modelOptions?: Omit<Partial<IdeogramImageModelInput>, "model">;
+}
+export declare class IdeogramImageModel extends ImageModel<IdeogramImageModelInput, IdeogramImageModelOutput> {
+    options?: IdeogramImageModelOptions | undefined;
+    constructor(options?: IdeogramImageModelOptions | undefined);
+    protected apiKeyEnvName: string;
+    get credential(): {
+        url: string;
+        apiKey: string | undefined;
+    };
+    get modelOptions(): Omit<Partial<IdeogramImageModelInput>, "model"> | undefined;
+    /**
+     * Process the input and generate a response
+     * @param input The input to process
+     * @returns The generated response
+     */
+    process(input: IdeogramImageModelInput): Promise<ImageModelOutput>;
+}

package/lib/cjs/ideogram-image-model.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdeogramImageModel = void 0;
+const core_1 = require("@aigne/core");
+const camelize_js_1 = require("@aigne/core/utils/camelize.js");
+const type_utils_js_1 = require("@aigne/core/utils/type-utils.js");
+const zod_1 = require("zod");
+const IDEOGRAM_BASE_URL = "https://api.ideogram.ai/v1/ideogram-v3/generate";
+const ideogramImageModelInputSchema = core_1.imageModelInputSchema.extend({});
+const ideogramImageModelOptionsSchema = zod_1.z.object({
+    apiKey: zod_1.z.string().optional(),
+    baseURL: zod_1.z.string().optional(),
+    modelOptions: zod_1.z.object({}).optional(),
+    clientOptions: zod_1.z.object({}).optional(),
+});
+class IdeogramImageModel extends core_1.ImageModel {
+    options;
+    constructor(options) {
+        super({
+            ...options,
+            inputSchema: ideogramImageModelInputSchema,
+            description: options?.description ?? "Draw or edit image by Ideogram image models",
+        });
+        this.options = options;
+        if (options)
+            (0, type_utils_js_1.checkArguments)(this.name, ideogramImageModelOptionsSchema, options);
+    }
+    apiKeyEnvName = "IDEOGRAM_API_KEY";
+    get credential() {
+        return {
+            url: this.options?.baseURL || process.env.IDEOGRAM_BASE_URL || IDEOGRAM_BASE_URL,
+            apiKey: this.options?.apiKey || process.env[this.apiKeyEnvName],
+        };
+    }
+    get modelOptions() {
+        return this.options?.modelOptions;
+    }
+    /**
+     * Process the input and generate a response
+     * @param input The input to process
+     * @returns The generated response
+     */
+    async process(input) {
+        const model = input.model;
+        const formData = new FormData();
+        const inputKeys = [
+            "prompt",
+            "seed",
+            "resolution",
+            "aspectRatio",
+            "renderingSpeed",
+            "magicPrompt",
+            "negativePrompt",
+            "colorPalette",
+            "styleCodes",
+            "styleType",
+        ];
+        const mergedInput = (0, camelize_js_1.snakelize)((0, type_utils_js_1.pick)({ ...this.modelOptions, ...input }, inputKeys));
+        if (input.n) {
+            formData.append("num_images", input.n.toString());
+        }
+        Object.keys(mergedInput).forEach((key) => {
+            if (mergedInput[key]) {
+                formData.append(key, mergedInput[key]);
+            }
+        });
+        const { url, apiKey } = this.credential;
+        if (!apiKey)
+            throw new Error(`${this.name} requires an API key. Please provide it via \`options.apiKey\`, or set the \`${this.apiKeyEnvName}\` environment variable`);
+        const response = await fetch(url, {
+            method: "POST",
+            headers: { "api-key": apiKey },
+            body: formData,
+        });
+        if (!response.ok) {
+            const error = await response.text();
+            throw new Error(`Ideogram API error: ${response.status} ${response.statusText} ${error}`);
+        }
+        const data = await response.json();
+        return {
+            images: data.data.map((item) => ({ url: item.url })),
+            usage: {
+                inputTokens: 0,
+                outputTokens: 0,
+            },
+            model,
+        };
+    }
+}
+exports.IdeogramImageModel = IdeogramImageModel;

package/lib/cjs/index.d.ts

@@ -0,0 +1 @@
+export * from "./ideogram-image-model.js";

package/lib/cjs/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ideogram-image-model.js"), exports);

package/lib/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/lib/dts/ideogram-image-model.d.ts

@@ -0,0 +1,36 @@
+import { ImageModel, type ImageModelInput, type ImageModelOptions, type ImageModelOutput } from "@aigne/core";
+export interface IdeogramImageModelInput extends ImageModelInput {
+    seed?: number;
+    resolution?: string;
+    aspectRatio?: string;
+    renderingSpeed?: string;
+    magicPrompt?: string;
+    negativePrompt?: string;
+    numImages?: number;
+    colorPalette?: any;
+    styleCodes?: string[];
+    styleType?: string;
+}
+export interface IdeogramImageModelOutput extends ImageModelOutput {
+}
+export interface IdeogramImageModelOptions extends ImageModelOptions<IdeogramImageModelInput, IdeogramImageModelOutput> {
+    apiKey?: string;
+    baseURL?: string;
+    modelOptions?: Omit<Partial<IdeogramImageModelInput>, "model">;
+}
+export declare class IdeogramImageModel extends ImageModel<IdeogramImageModelInput, IdeogramImageModelOutput> {
+    options?: IdeogramImageModelOptions | undefined;
+    constructor(options?: IdeogramImageModelOptions | undefined);
+    protected apiKeyEnvName: string;
+    get credential(): {
+        url: string;
+        apiKey: string | undefined;
+    };
+    get modelOptions(): Omit<Partial<IdeogramImageModelInput>, "model"> | undefined;
+    /**
+     * Process the input and generate a response
+     * @param input The input to process
+     * @returns The generated response
+     */
+    process(input: IdeogramImageModelInput): Promise<ImageModelOutput>;
+}

package/lib/dts/index.d.ts

@@ -0,0 +1 @@
+export * from "./ideogram-image-model.js";

package/lib/esm/ideogram-image-model.d.ts

@@ -0,0 +1,36 @@
+import { ImageModel, type ImageModelInput, type ImageModelOptions, type ImageModelOutput } from "@aigne/core";
+export interface IdeogramImageModelInput extends ImageModelInput {
+    seed?: number;
+    resolution?: string;
+    aspectRatio?: string;
+    renderingSpeed?: string;
+    magicPrompt?: string;
+    negativePrompt?: string;
+    numImages?: number;
+    colorPalette?: any;
+    styleCodes?: string[];
+    styleType?: string;
+}
+export interface IdeogramImageModelOutput extends ImageModelOutput {
+}
+export interface IdeogramImageModelOptions extends ImageModelOptions<IdeogramImageModelInput, IdeogramImageModelOutput> {
+    apiKey?: string;
+    baseURL?: string;
+    modelOptions?: Omit<Partial<IdeogramImageModelInput>, "model">;
+}
+export declare class IdeogramImageModel extends ImageModel<IdeogramImageModelInput, IdeogramImageModelOutput> {
+    options?: IdeogramImageModelOptions | undefined;
+    constructor(options?: IdeogramImageModelOptions | undefined);
+    protected apiKeyEnvName: string;
+    get credential(): {
+        url: string;
+        apiKey: string | undefined;
+    };
+    get modelOptions(): Omit<Partial<IdeogramImageModelInput>, "model"> | undefined;
+    /**
+     * Process the input and generate a response
+     * @param input The input to process
+     * @returns The generated response
+     */
+    process(input: IdeogramImageModelInput): Promise<ImageModelOutput>;
+}

package/lib/esm/ideogram-image-model.js

@@ -0,0 +1,86 @@
+import { ImageModel, imageModelInputSchema, } from "@aigne/core";
+import { snakelize } from "@aigne/core/utils/camelize.js";
+import { checkArguments, pick } from "@aigne/core/utils/type-utils.js";
+import { z } from "zod";
+const IDEOGRAM_BASE_URL = "https://api.ideogram.ai/v1/ideogram-v3/generate";
+const ideogramImageModelInputSchema = imageModelInputSchema.extend({});
+const ideogramImageModelOptionsSchema = z.object({
+    apiKey: z.string().optional(),
+    baseURL: z.string().optional(),
+    modelOptions: z.object({}).optional(),
+    clientOptions: z.object({}).optional(),
+});
+export class IdeogramImageModel extends ImageModel {
+    options;
+    constructor(options) {
+        super({
+            ...options,
+            inputSchema: ideogramImageModelInputSchema,
+            description: options?.description ?? "Draw or edit image by Ideogram image models",
+        });
+        this.options = options;
+        if (options)
+            checkArguments(this.name, ideogramImageModelOptionsSchema, options);
+    }
+    apiKeyEnvName = "IDEOGRAM_API_KEY";
+    get credential() {
+        return {
+            url: this.options?.baseURL || process.env.IDEOGRAM_BASE_URL || IDEOGRAM_BASE_URL,
+            apiKey: this.options?.apiKey || process.env[this.apiKeyEnvName],
+        };
+    }
+    get modelOptions() {
+        return this.options?.modelOptions;
+    }
+    /**
+     * Process the input and generate a response
+     * @param input The input to process
+     * @returns The generated response
+     */
+    async process(input) {
+        const model = input.model;
+        const formData = new FormData();
+        const inputKeys = [
+            "prompt",
+            "seed",
+            "resolution",
+            "aspectRatio",
+            "renderingSpeed",
+            "magicPrompt",
+            "negativePrompt",
+            "colorPalette",
+            "styleCodes",
+            "styleType",
+        ];
+        const mergedInput = snakelize(pick({ ...this.modelOptions, ...input }, inputKeys));
+        if (input.n) {
+            formData.append("num_images", input.n.toString());
+        }
+        Object.keys(mergedInput).forEach((key) => {
+            if (mergedInput[key]) {
+                formData.append(key, mergedInput[key]);
+            }
+        });
+        const { url, apiKey } = this.credential;
+        if (!apiKey)
+            throw new Error(`${this.name} requires an API key. Please provide it via \`options.apiKey\`, or set the \`${this.apiKeyEnvName}\` environment variable`);
+        const response = await fetch(url, {
+            method: "POST",
+            headers: { "api-key": apiKey },
+            body: formData,
+        });
+        if (!response.ok) {
+            const error = await response.text();
+            throw new Error(`Ideogram API error: ${response.status} ${response.statusText} ${error}`);
+        }
+        const data = await response.json();
+        return {
+            images: data.data.map((item) => ({ url: item.url })),
+            usage: {
+                inputTokens: 0,
+                outputTokens: 0,
+            },
+            model,
+        };
+    }
+}

package/lib/esm/index.d.ts

@@ -0,0 +1 @@
+export * from "./ideogram-image-model.js";

package/lib/esm/index.js

@@ -0,0 +1 @@
+export * from "./ideogram-image-model.js";

package/lib/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@aigne/ideogram",
+  "description": "AIGNE Ideogram SDK for integrating with Ideogram's image models and API services",
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
+  "homepage": "https://www.aigne.io/framework",
+  "license": "Elastic-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AIGNE-io/aigne-framework"
+  },
+  "bugs": {
+    "url": "https://github.com/AIGNE-io/aigne-framework/issues"
+  },
+  "files": [
+    "lib/cjs",
+    "lib/dts",
+    "lib/esm",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "type": "module",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "types": "./lib/dts/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js",
+      "types": "./lib/dts/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@aigne/core": "1.55.1"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.2.18",
+    "@types/node": "^24.0.12",
+    "detect-port": "^2.1.0",
+    "hono": "^4.9.4",
+    "npm-run-all": "^4.1.5",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.8.3",
+    "zod": "3.25.67"
+  },
+  "version": "0.2.0",
+  "scripts": {
+    "lint": "tsc --noEmit",
+    "build": "tsc --build scripts/tsconfig.build.json",
+    "clean": "rimraf lib test/coverage",
+    "test": "bun test",
+    "test:coverage": "bun test --coverage --coverage-reporter=lcov --coverage-reporter=text",
+    "postbuild": "node ../../scripts/post-build-lib.mjs"
+  }
+}