@elizaos/plugin-zai 2.0.3-beta.5

package/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2024 elizaOS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+

package/README.md

@@ -0,0 +1,48 @@
+# @elizaos/plugin-zai
+
+First-party z.ai model provider plugin for elizaOS.
+
+This plugin targets **z.ai's general OpenAI-compatible API** and supports:
+
+- `TEXT_SMALL`, `TEXT_LARGE`
+
+## Install
+
+```bash
+eliza plugins install @elizaos/plugin-zai
+```
+
+## Configuration
+
+| Variable | Required | Default | Description |
+| --- | --- | --- | --- |
+| `ZAI_API_KEY` | Yes | – | z.ai API key |
+| `Z_AI_API_KEY` | No | – | Legacy alias accepted when `ZAI_API_KEY` is unset |
+| `ZAI_BASE_URL` | No | `https://api.z.ai/api/paas/v4` | General API base URL. Coding Plan and Anthropic-compatible coding-tool endpoints are rejected here. |
+| `ZAI_SMALL_MODEL` | No | `glm-4.5-air` | Small model id |
+| `ZAI_LARGE_MODEL` | No | `glm-5.1` | Large model id |
+| `ZAI_THINKING_TYPE` | No | – | Optional thinking mode override: `enabled` or `disabled`; unset uses z.ai's default |
+| `ZAI_COT_BUDGET` | No | – | Deprecated compatibility setting. Positive values enable thinking mode; z.ai does not accept Anthropic `budget_tokens`. |
+| `ZAI_COT_BUDGET_SMALL` | No | – | Deprecated compatibility setting for small-model calls |
+| `ZAI_COT_BUDGET_LARGE` | No | – | Deprecated compatibility setting for large-model calls |
+
+Prefer `ZAI_API_KEY` for new configuration. `Z_AI_API_KEY` exists only for compatibility with older z.ai wiring.
+
+This plugin targets z.ai's general API only. Do not point it at
+`https://api.z.ai/api/coding/paas/v4` or `https://api.z.ai/api/anthropic`; those
+paths are reserved for z.ai's coding tools and `getBaseURL` rejects them.
+
+## Usage
+
+```ts
+import { AgentRuntime, ModelType } from "@elizaos/core";
+import zaiPlugin from "@elizaos/plugin-zai";
+
+const runtime = new AgentRuntime({ plugins: [zaiPlugin] });
+
+const text = await runtime.useModel(ModelType.TEXT_LARGE, {
+  prompt: "Write a haiku about local-first AI.",
+});
+
+console.log(text);
+```

package/auto-enable.ts

@@ -0,0 +1,17 @@
+// Auto-enable check for @elizaos/plugin-zai.
+//
+// Plugin manifest entry-point — referenced by package.json's
+// `elizaos.plugin.autoEnableModule`. Keep this module light: env reads only,
+// no service init, no transitive imports of the full plugin runtime.
+type PluginAutoEnableContext = {
+  env: Record<string, string | undefined>;
+};
+
+/** Enable when a z.ai API key is present in the environment. */
+export function shouldEnable(ctx: PluginAutoEnableContext): boolean {
+  const env = ctx.env;
+  return Boolean(
+    (env.ZAI_API_KEY && env.ZAI_API_KEY.trim() !== "") ||
+      (env.Z_AI_API_KEY && env.Z_AI_API_KEY.trim() !== "")
+  );
+}

package/package.json

@@ -0,0 +1,169 @@
+{
+  "name": "@elizaos/plugin-zai",
+  "version": "2.0.3-beta.5",
+  "type": "module",
+  "main": "dist/node/index.node.js",
+  "module": "dist/node/index.node.js",
+  "types": "dist/node/index.d.ts",
+  "browser": "dist/browser/index.browser.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/elizaos-plugins/plugin-zai.git"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/node/index.d.ts",
+      "browser": {
+        "types": "./dist/browser/index.d.ts",
+        "import": "./dist/browser/index.browser.js",
+        "default": "./dist/browser/index.browser.js"
+      },
+      "node": {
+        "types": "./dist/node/index.d.ts",
+        "import": "./dist/node/index.node.js",
+        "default": "./dist/node/index.node.js"
+      },
+      "import": {
+        "types": "./dist/node/index.d.ts",
+        "default": "./dist/node/index.node.js"
+      },
+      "default": {
+        "types": "./dist/node/index.d.ts",
+        "default": "./dist/node/index.node.js"
+      }
+    },
+    "./*.css": "./dist/*.css",
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "import": "./dist/*.js",
+      "default": "./dist/*.js"
+    }
+  },
+  "files": [
+    "dist",
+    "auto-enable.ts"
+  ],
+  "elizaos": {
+    "plugin": {
+      "autoEnableModule": "./auto-enable.ts",
+      "capabilities": [
+        "text-large",
+        "text-small"
+      ]
+    }
+  },
+  "sideEffects": false,
+  "dependencies": {
+    "@ai-sdk/openai-compatible": "^2.0.51",
+    "@elizaos/core": "2.0.3-beta.5",
+    "ai": "^6.0.23"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.14",
+    "@types/bun": "^1.3.10",
+    "@types/node": "^25.0.3",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.4"
+  },
+  "scripts": {
+    "dev": "bun run build.ts --watch",
+    "clean": "node ../../packages/scripts/rm-path-recursive.mjs dist .turbo .turbo-tsconfig.json tsconfig.tsbuildinfo",
+    "format": "bunx @biomejs/biome format --write .",
+    "format:check": "bunx @biomejs/biome format .",
+    "lint": "bunx @biomejs/biome check --write --unsafe .",
+    "lint:check": "bunx @biomejs/biome check . --no-errors-on-unmatched",
+    "typecheck": "tsgo --noEmit -p tsconfig.json",
+    "test": "bunx vitest run --config vitest.config.ts",
+    "test:watch": "bunx vitest --config vitest.config.ts",
+    "build": "bun run build.ts",
+    "build:ts": "bun run build.ts"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "agentConfig": {
+    "pluginType": "elizaos:plugin:1.0.0",
+    "pluginParameters": {
+      "ZAI_API_KEY": {
+        "type": "string",
+        "description": "API key used to authenticate requests to z.ai's general OpenAI-compatible API",
+        "required": true,
+        "sensitive": true
+      },
+      "ZAI_BASE_URL": {
+        "type": "string",
+        "description": "Base URL for z.ai's general OpenAI-compatible API. Coding Plan and Anthropic-compatible coding-tool endpoints are intentionally rejected here.",
+        "required": false,
+        "default": "https://api.z.ai/api/paas/v4",
+        "sensitive": false
+      },
+      "ZAI_SMALL_MODEL": {
+        "type": "string",
+        "description": "Override the default z.ai small model identifier",
+        "required": false,
+        "default": "glm-4.5-air",
+        "sensitive": false
+      },
+      "ZAI_LARGE_MODEL": {
+        "type": "string",
+        "description": "Override the default z.ai large model identifier",
+        "required": false,
+        "default": "glm-5.1",
+        "sensitive": false
+      },
+      "ZAI_EXPERIMENTAL_TELEMETRY": {
+        "type": "boolean",
+        "description": "Enable experimental telemetry features for enhanced debugging and usage analytics.",
+        "required": false,
+        "default": false,
+        "sensitive": false
+      },
+      "ZAI_BROWSER_BASE_URL": {
+        "type": "string",
+        "description": "Browser-only proxy endpoint base URL for z.ai requests. Do not expose API keys in browser clients.",
+        "required": false,
+        "sensitive": false
+      },
+      "ZAI_COT_BUDGET": {
+        "type": "string",
+        "description": "Deprecated compatibility setting. A positive value enables z.ai thinking mode, but z.ai's OpenAI-compatible API does not accept Anthropic budget_tokens.",
+        "required": false,
+        "sensitive": false
+      },
+      "ZAI_COT_BUDGET_SMALL": {
+        "type": "string",
+        "description": "Deprecated compatibility setting. A positive value enables z.ai thinking mode for small-model calls.",
+        "required": false,
+        "sensitive": false
+      },
+      "ZAI_COT_BUDGET_LARGE": {
+        "type": "string",
+        "description": "Deprecated compatibility setting. A positive value enables z.ai thinking mode for large-model calls.",
+        "required": false,
+        "sensitive": false
+      },
+      "ZAI_THINKING_TYPE": {
+        "type": "string",
+        "description": "Optional z.ai thinking mode override: enabled or disabled. When unset, z.ai uses its service default.",
+        "required": false,
+        "sensitive": false
+      }
+    }
+  },
+  "eliza": {
+    "platforms": [
+      "browser",
+      "node"
+    ],
+    "runtime": "both",
+    "platformDetails": {
+      "browser": "Browser-compatible build available via exports.browser",
+      "node": "Node.js build available via exports.node"
+    }
+  },
+  "peerDependencies": {
+    "@elizaos/core": "2.0.3-beta.5"
+  },
+  "gitHead": "ff6157011c9459670021cc28a6797592a78b8817"
+}