@aigne/poe 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 1.0.0 (2025-08-14)
+
+
+### Features
+
+* **model:** add poe chat model support ([#365](https://github.com/AIGNE-io/aigne-framework/issues/365)) ([b2cce67](https://github.com/AIGNE-io/aigne-framework/commit/b2cce67bdab1c6dec273929bcdd79e1d15410119))

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,127 @@
+# @aigne/poe
+
+<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/poe)](https://www.npmjs.com/package/@aigne/poe)
+[![Elastic-2.0 licensed](https://img.shields.io/npm/l/@aigne/poe)](https://github.com/AIGNE-io/aigne-framework/blob/main/LICENSE.md)
+
+AIGNE Poe SDK for integrating with Poe language models and API services within the [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework).
+
+## Introduction
+
+`@aigne/poe` provides a seamless integration between the AIGNE Framework and Poe's language models and API services. This package enables developers to easily leverage Poe's models in their AIGNE applications, providing a consistent interface across the framework while taking advantage of Poe's advanced AI capabilities.
+
+<picture>
+  <source srcset="https://raw.githubusercontent.com/AIGNE-io/aigne-framework/main/assets/aigne-poe-dark.png" media="(prefers-color-scheme: dark)">
+  <source srcset="https://raw.githubusercontent.com/AIGNE-io/aigne-framework/main/assets/aigne-poe.png" media="(prefers-color-scheme: light)">
+  <img src="https://raw.githubusercontent.com/AIGNE-io/aigne-framework/main/aigne-poe.png" alt="AIGNE Arch" />
+</picture>
+
+## Features
+
+* **Poe API Integration**: Direct connection to Poe's API services
+* **Chat Completions**: Support for Poe's chat completions API with all available models
+* **Function Calling**: Built-in support for function calling capabilities
+* **Streaming Responses**: Support for streaming responses for more responsive applications
+* **Type-Safe**: Comprehensive TypeScript typings for all APIs and models
+* **Consistent Interface**: Compatible with the AIGNE Framework's model interface
+* **Error Handling**: Robust error handling and retry mechanisms
+* **Full Configuration**: Extensive configuration options for fine-tuning behavior
+
+## Installation
+
+### Using npm
+
+```bash
+npm install @aigne/poe @aigne/core
+```
+
+### Using yarn
+
+```bash
+yarn add @aigne/poe @aigne/core
+```
+
+### Using pnpm
+
+```bash
+pnpm add @aigne/poe @aigne/core
+```
+
+## Basic Usage
+
+```typescript file="test/poe-chat-model.test.ts" region="example-poe-chat-model"
+import { PoeChatModel } from "@aigne/poe";
+
+const model = new PoeChatModel({
+  // Provide API key directly or use environment variable POE_API_KEY
+  apiKey: "your-api-key", // Optional if set in env variables
+  // Specify model (defaults to 'openai/gpt-4o')
+  model: "claude-3-opus",
+  modelOptions: {
+    temperature: 0.7,
+  },
+});
+
+const result = await model.invoke({
+  messages: [{ role: "user", content: "Which model are you using?" }],
+});
+
+console.log(result);
+/* Output:
+  {
+    text: "I'm powered by Poe, using the Claude 3 Opus model from Anthropic.",
+    model: "claude-3-opus",
+    usage: {
+      inputTokens: 5,
+      outputTokens: 14
+    }
+  }
+  */
+```
+
+## Streaming Responses
+
+```typescript file="test/poe-chat-model.test.ts" region="example-poe-chat-model-streaming"
+import { isAgentResponseDelta } from "@aigne/core";
+import { PoeChatModel } from "@aigne/poe";
+
+const model = new PoeChatModel({
+  apiKey: "your-api-key",
+  model: "claude-3-opus",
+});
+
+const stream = await model.invoke(
+  {
+    messages: [{ role: "user", content: "Which model are you using?" }],
+  },
+  { streaming: true },
+);
+
+let fullText = "";
+const json = {};
+
+for await (const chunk of stream) {
+  if (isAgentResponseDelta(chunk)) {
+    const text = chunk.delta.text?.text;
+    if (text) fullText += text;
+    if (chunk.delta.json) Object.assign(json, chunk.delta.json);
+  }
+}
+
+console.log(fullText); // Output: "I'm powered by Poe, using the Claude 3 Opus model from Anthropic."
+console.log(json); // { model: "anthropic/claude-3-opus", usage: { inputTokens: 5, outputTokens: 14 } }
+```
+
+## License
+
+Elastic-2.0

package/lib/cjs/index.d.ts

@@ -0,0 +1 @@
+export * from "./poe.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("./poe.js"), exports);

package/lib/cjs/package.json

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

package/lib/cjs/poe.d.ts

@@ -0,0 +1,22 @@
+import { OpenAIChatModel, type OpenAIChatModelOptions } from "@aigne/openai";
+/**
+ * Implementation of the ChatModel interface for Poe's API (Grok)
+ *
+ * This model uses OpenAI-compatible API format to interact with X.AI models,
+ * providing access to models like Grok.
+ *
+ * Default model: 'grok-2-latest'
+ *
+ * @example
+ * Here's how to create and use an Poe chat model:
+ * {@includeCode ../test/poe-chat-model.test.ts#example-poe-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../test/poe-chat-model.test.ts#example-poe-chat-model-streaming}
+ */
+export declare class PoeChatModel extends OpenAIChatModel {
+    constructor(options?: OpenAIChatModelOptions);
+    protected apiKeyEnvName: string;
+    protected supportsParallelToolCalls: boolean;
+}

package/lib/cjs/poe.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PoeChatModel = void 0;
+const openai_1 = require("@aigne/openai");
+const POE_DEFAULT_CHAT_MODEL = "gpt-5-mini";
+const POE_BASE_URL = "https://api.poe.com/v1";
+/**
+ * Implementation of the ChatModel interface for Poe's API (Grok)
+ *
+ * This model uses OpenAI-compatible API format to interact with X.AI models,
+ * providing access to models like Grok.
+ *
+ * Default model: 'grok-2-latest'
+ *
+ * @example
+ * Here's how to create and use an Poe chat model:
+ * {@includeCode ../test/poe-chat-model.test.ts#example-poe-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../test/poe-chat-model.test.ts#example-poe-chat-model-streaming}
+ */
+class PoeChatModel extends openai_1.OpenAIChatModel {
+    constructor(options) {
+        super({
+            ...options,
+            model: options?.model || POE_DEFAULT_CHAT_MODEL,
+            baseURL: options?.baseURL || POE_BASE_URL,
+        });
+    }
+    apiKeyEnvName = "POE_API_KEY";
+    supportsParallelToolCalls = false;
+}
+exports.PoeChatModel = PoeChatModel;

package/lib/dts/index.d.ts

@@ -0,0 +1 @@
+export * from "./poe.js";

package/lib/dts/poe.d.ts

@@ -0,0 +1,22 @@
+import { OpenAIChatModel, type OpenAIChatModelOptions } from "@aigne/openai";
+/**
+ * Implementation of the ChatModel interface for Poe's API (Grok)
+ *
+ * This model uses OpenAI-compatible API format to interact with X.AI models,
+ * providing access to models like Grok.
+ *
+ * Default model: 'grok-2-latest'
+ *
+ * @example
+ * Here's how to create and use an Poe chat model:
+ * {@includeCode ../test/poe-chat-model.test.ts#example-poe-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../test/poe-chat-model.test.ts#example-poe-chat-model-streaming}
+ */
+export declare class PoeChatModel extends OpenAIChatModel {
+    constructor(options?: OpenAIChatModelOptions);
+    protected apiKeyEnvName: string;
+    protected supportsParallelToolCalls: boolean;
+}

package/lib/esm/index.d.ts

@@ -0,0 +1 @@
+export * from "./poe.js";

package/lib/esm/index.js

@@ -0,0 +1 @@
+export * from "./poe.js";

package/lib/esm/package.json

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

package/lib/esm/poe.d.ts

@@ -0,0 +1,22 @@
+import { OpenAIChatModel, type OpenAIChatModelOptions } from "@aigne/openai";
+/**
+ * Implementation of the ChatModel interface for Poe's API (Grok)
+ *
+ * This model uses OpenAI-compatible API format to interact with X.AI models,
+ * providing access to models like Grok.
+ *
+ * Default model: 'grok-2-latest'
+ *
+ * @example
+ * Here's how to create and use an Poe chat model:
+ * {@includeCode ../test/poe-chat-model.test.ts#example-poe-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../test/poe-chat-model.test.ts#example-poe-chat-model-streaming}
+ */
+export declare class PoeChatModel extends OpenAIChatModel {
+    constructor(options?: OpenAIChatModelOptions);
+    protected apiKeyEnvName: string;
+    protected supportsParallelToolCalls: boolean;
+}

package/lib/esm/poe.js

@@ -0,0 +1,30 @@
+import { OpenAIChatModel } from "@aigne/openai";
+const POE_DEFAULT_CHAT_MODEL = "gpt-5-mini";
+const POE_BASE_URL = "https://api.poe.com/v1";
+/**
+ * Implementation of the ChatModel interface for Poe's API (Grok)
+ *
+ * This model uses OpenAI-compatible API format to interact with X.AI models,
+ * providing access to models like Grok.
+ *
+ * Default model: 'grok-2-latest'
+ *
+ * @example
+ * Here's how to create and use an Poe chat model:
+ * {@includeCode ../test/poe-chat-model.test.ts#example-poe-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../test/poe-chat-model.test.ts#example-poe-chat-model-streaming}
+ */
+export class PoeChatModel extends OpenAIChatModel {
+    constructor(options) {
+        super({
+            ...options,
+            model: options?.model || POE_DEFAULT_CHAT_MODEL,
+            baseURL: options?.baseURL || POE_BASE_URL,
+        });
+    }
+    apiKeyEnvName = "POE_API_KEY";
+    supportsParallelToolCalls = false;
+}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@aigne/poe",
+  "description": "AIGNE Poe SDK for integrating with Poe's language 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/openai": "^0.11.2"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.2.18",
+    "@types/node": "^24.0.12",
+    "npm-run-all": "^4.1.5",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.8.3",
+    "@aigne/test-utils": "^0.5.28",
+    "@aigne/core": "^1.50.0"
+  },
+  "version": "1.0.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"
+  }
+}