@aigne/aigne-hub 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## [0.1.0](https://github.com/AIGNE-io/aigne-framework/compare/aigne-hub-v0.0.1...aigne-hub-v0.1.0) (2025-07-15)
+
+
+### Features
+
+* **memory:** support did space memory adapter ([#229](https://github.com/AIGNE-io/aigne-framework/issues/229)) ([6f69b64](https://github.com/AIGNE-io/aigne-framework/commit/6f69b64e98b963db9d6ab5357306b445385eaa68))
+* **model:** support aigne-hub model adapter ([#253](https://github.com/AIGNE-io/aigne-framework/issues/253)) ([4b33f8d](https://github.com/AIGNE-io/aigne-framework/commit/4b33f8d1a819f52357db81d502c56b55eaa0669f))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/core bumped to 1.34.0
+    * @aigne/transport bumped to 0.10.0
+  * devDependencies
+    * @aigne/openai bumped to 0.10.0
+    * @aigne/test-utils bumped to 0.5.8

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,125 @@
+# @aigne/aigne-hub
+
+[![GitHub stars](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/aigne-hub)](https://www.npmjs.com/package/@aigne/aigne-hub)
+[![Elastic-2.0 licensed](https://img.shields.io/npm/l/@aigne/aigne-hub)](https://github.com/AIGNE-io/aigne-framework/blob/main/LICENSE.md)
+
+AIGNE SDK for accessing AI chat models via [AIGNE Hub](https://github.com/AIGNE-io/aigne-framework), a unified proxy layer for multiple LLM providers.
+
+# Introduction
+
+`@aigne/aigne-hub` connects your application to the AIGNE Hub service, a gateway that aggregates multiple LLM providers such as OpenAI, Anthropic, AWS Bedrock, Google, DeepSeek, Ollama, xAI, and OpenRouter. You can call any supported model simply by passing the appropriate `model` name.
+
+It enables you to switch providers without changing your client-side logic.
+
+## Supported Providers
+
+The AIGNE Hub backend supports the following AI providers via a single, unified API:
+
+```ts
+type AIProvider = 'openai' | 'anthropic' | 'bedrock' | 'deepseek' | 'google' | 'ollama' | 'openRouter' | 'xai';
+```
+## Example models:
+- openai/gpt-4o-mini
+- anthropic/claude-3-sonnet
+- bedrock/us.amazon.titan-text-lite-v1
+- google/gemini-pro
+- xai/grok-1
+- openRouter/mistralai/mistral-7b-instruct
+- ollama/llama3
+
+## Features
+- 🔌 Unified LLM Access: Route all requests through one endpoint
+- 🧠 Multi-provider Support: Choose from any supported vendor via the model name
+- 🔐 API Key Security: Use accessKey to manage authentication and authorization
+- 💬 Chat Completions: Works with standard messages format ({ role, content })
+- 🌊 Streaming Support: Enable streaming: true for real-time token-level responses
+- 🧱 Framework Compatible: Seamless integration with the AIGNE Framework
+
+## Installation
+### Using npm
+
+```
+npm install @aigne/aigne-hub @aigne/core
+```
+### Using yarn
+```
+yarn add @aigne/aigne-hub @aigne/core
+```
+### Using pnpm
+```
+pnpm add @aigne/aigne-hub @aigne/core
+```
+
+## Basic Usage
+```typescript
+import { AIGNEHubChatModel } from "@aigne/aigne-hub";
+
+const model = new AIGNEHubChatModel({
+  url: "https://your-aigne-hub-instance/ai-kit/api/v2/chat",
+  accessKey: "your-access-key-id",
+  model: "openai/gpt-4o-mini",
+});
+
+const result = await model.invoke({
+  messages: [{ role: "user", content: "Hello, world!" }],
+});
+
+console.log(result);
+/* Example Output:
+  {
+    text: "Hello! How can I help you today?",
+    model: "openai/gpt-4o-mini",
+    usage: {
+      inputTokens: 8,
+      outputTokens: 9
+    }
+  }
+*/
+```
+## Streaming Usage
+```typescript
+import { AIGNEHubChatModel } from "@aigne/aigne-hub";
+
+const model = new AIGNEHubChatModel({
+  url: "https://your-aigne-hub-instance/ai-kit/api/v2/chat",
+  accessKey: "your-access-key-id",
+  model: "openai/gpt-4o-mini",
+});
+
+const stream = await model.invoke(
+  {
+    messages: [{ role: "user", content: "Hello, who are you?" }],
+  },
+  { 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: "Hello! How can I assist you today?"
+console.log(json); // { model: "gpt-4o", usage: { inputTokens: 10, outputTokens: 9 } }
+```
+## Configuration Options
+```typescript
+interface ClientChatModelOptions {
+  url: string;              // Your AIGNE Hub endpoint
+  accessKey: string;      // API access key
+  model: string;            // Model name with provider prefix (e.g. openai/gpt-4o-mini)
+  modelOptions?: object;    // Optional model-specific parameters
+}
+```
+
+## License
+
+Elastic-2.0

package/lib/cjs/aigne-hub-model.d.ts

@@ -0,0 +1,17 @@
+import { type AgentInvokeOptions, type AgentProcessResult, ChatModel, type ChatModelInput, type ChatModelOptions, type ChatModelOutput } from "@aigne/core";
+import { type PromiseOrValue } from "@aigne/core/utils/type-utils.js";
+import type { OpenAIChatModelOptions } from "@aigne/openai";
+interface AIGNEHubChatModelOptions {
+    url?: string;
+    accessKey?: string;
+    model?: string;
+    modelOptions?: ChatModelOptions;
+    clientOptions?: OpenAIChatModelOptions["clientOptions"];
+}
+export declare class AIGNEHubChatModel extends ChatModel {
+    options: AIGNEHubChatModelOptions;
+    private client;
+    constructor(options: AIGNEHubChatModelOptions);
+    process(input: ChatModelInput, options: AgentInvokeOptions): PromiseOrValue<AgentProcessResult<ChatModelOutput>>;
+}
+export {};

package/lib/cjs/aigne-hub-model.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AIGNEHubChatModel = void 0;
+const core_1 = require("@aigne/core");
+const type_utils_js_1 = require("@aigne/core/utils/type-utils.js");
+const base_client_js_1 = require("@aigne/transport/http-client/base-client.js");
+const zod_1 = require("zod");
+const DEFAULT_CHAT_MODEL = "openai/gpt-4o";
+const DEFAULT_URL = "https://www.aikit.rocks/ai-kit/api/v2/chat";
+const aigneHubChatModelOptionsSchema = zod_1.z.object({
+    url: zod_1.z.string().optional(),
+    accessKey: zod_1.z.string().optional(),
+    model: zod_1.z.string().optional(),
+    modelOptions: zod_1.z
+        .object({
+        model: zod_1.z.string().optional(),
+        temperature: zod_1.z.number().optional(),
+        topP: zod_1.z.number().optional(),
+        frequencyPenalty: zod_1.z.number().optional(),
+        presencePenalty: zod_1.z.number().optional(),
+        parallelToolCalls: zod_1.z.boolean().optional().default(true),
+    })
+        .optional(),
+    clientOptions: zod_1.z.object({}).optional(),
+});
+class AIGNEHubChatModel extends core_1.ChatModel {
+    options;
+    client;
+    constructor(options) {
+        (0, type_utils_js_1.checkArguments)("AIGNEHubChatModel", aigneHubChatModelOptionsSchema, options);
+        super();
+        this.options = options;
+        this.client = new base_client_js_1.BaseClient({
+            ...options,
+            url: options.url ?? process.env.AIGNE_HUB_BASE_URL ?? DEFAULT_URL,
+            model: options.model ?? DEFAULT_CHAT_MODEL,
+            accessKey: options.accessKey ?? process.env.AIGNE_HUB_ACCESS_KEY,
+        });
+    }
+    process(input, options) {
+        return this.client.__invoke(undefined, input, options);
+    }
+}
+exports.AIGNEHubChatModel = AIGNEHubChatModel;

package/lib/cjs/index.d.ts

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

package/lib/cjs/package.json

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

package/lib/dts/aigne-hub-model.d.ts

@@ -0,0 +1,17 @@
+import { type AgentInvokeOptions, type AgentProcessResult, ChatModel, type ChatModelInput, type ChatModelOptions, type ChatModelOutput } from "@aigne/core";
+import { type PromiseOrValue } from "@aigne/core/utils/type-utils.js";
+import type { OpenAIChatModelOptions } from "@aigne/openai";
+interface AIGNEHubChatModelOptions {
+    url?: string;
+    accessKey?: string;
+    model?: string;
+    modelOptions?: ChatModelOptions;
+    clientOptions?: OpenAIChatModelOptions["clientOptions"];
+}
+export declare class AIGNEHubChatModel extends ChatModel {
+    options: AIGNEHubChatModelOptions;
+    private client;
+    constructor(options: AIGNEHubChatModelOptions);
+    process(input: ChatModelInput, options: AgentInvokeOptions): PromiseOrValue<AgentProcessResult<ChatModelOutput>>;
+}
+export {};

package/lib/dts/index.d.ts

@@ -0,0 +1 @@
+export * from "./aigne-hub-model.js";

package/lib/esm/aigne-hub-model.d.ts

@@ -0,0 +1,17 @@
+import { type AgentInvokeOptions, type AgentProcessResult, ChatModel, type ChatModelInput, type ChatModelOptions, type ChatModelOutput } from "@aigne/core";
+import { type PromiseOrValue } from "@aigne/core/utils/type-utils.js";
+import type { OpenAIChatModelOptions } from "@aigne/openai";
+interface AIGNEHubChatModelOptions {
+    url?: string;
+    accessKey?: string;
+    model?: string;
+    modelOptions?: ChatModelOptions;
+    clientOptions?: OpenAIChatModelOptions["clientOptions"];
+}
+export declare class AIGNEHubChatModel extends ChatModel {
+    options: AIGNEHubChatModelOptions;
+    private client;
+    constructor(options: AIGNEHubChatModelOptions);
+    process(input: ChatModelInput, options: AgentInvokeOptions): PromiseOrValue<AgentProcessResult<ChatModelOutput>>;
+}
+export {};

package/lib/esm/aigne-hub-model.js

@@ -0,0 +1,40 @@
+import { ChatModel, } from "@aigne/core";
+import { checkArguments } from "@aigne/core/utils/type-utils.js";
+import { BaseClient } from "@aigne/transport/http-client/base-client.js";
+import { z } from "zod";
+const DEFAULT_CHAT_MODEL = "openai/gpt-4o";
+const DEFAULT_URL = "https://www.aikit.rocks/ai-kit/api/v2/chat";
+const aigneHubChatModelOptionsSchema = z.object({
+    url: z.string().optional(),
+    accessKey: z.string().optional(),
+    model: z.string().optional(),
+    modelOptions: z
+        .object({
+        model: z.string().optional(),
+        temperature: z.number().optional(),
+        topP: z.number().optional(),
+        frequencyPenalty: z.number().optional(),
+        presencePenalty: z.number().optional(),
+        parallelToolCalls: z.boolean().optional().default(true),
+    })
+        .optional(),
+    clientOptions: z.object({}).optional(),
+});
+export class AIGNEHubChatModel extends ChatModel {
+    options;
+    client;
+    constructor(options) {
+        checkArguments("AIGNEHubChatModel", aigneHubChatModelOptionsSchema, options);
+        super();
+        this.options = options;
+        this.client = new BaseClient({
+            ...options,
+            url: options.url ?? process.env.AIGNE_HUB_BASE_URL ?? DEFAULT_URL,
+            model: options.model ?? DEFAULT_CHAT_MODEL,
+            accessKey: options.accessKey ?? process.env.AIGNE_HUB_ACCESS_KEY,
+        });
+    }
+    process(input, options) {
+        return this.client.__invoke(undefined, input, options);
+    }
+}

package/lib/esm/index.d.ts

@@ -0,0 +1 @@
+export * from "./aigne-hub-model.js";

package/lib/esm/index.js

@@ -0,0 +1 @@
+export * from "./aigne-hub-model.js";

package/lib/esm/package.json

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

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@aigne/aigne-hub",
+  "version": "0.1.0",
+  "description": "AIGNE Hub SDK for integrating with Hub AI models",
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
+  "homepage": "https://github.com/AIGNE-io/aigne-framework",
+  "license": "Elastic-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AIGNE-io/aigne-framework"
+  },
+  "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",
+  "dependencies": {
+    "zod": "^3.25.67",
+    "@aigne/core": "^1.34.0",
+    "@aigne/transport": "^0.10.0"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.2.18",
+    "detect-port": "^2.1.0",
+    "hono": "^4.8.4",
+    "npm-run-all": "^4.1.5",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.8.3",
+    "@aigne/openai": "^0.10.0",
+    "@aigne/test-utils": "^0.5.8"
+  },
+  "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"
+  }
+}