@zhin.js/adapter-telegram 1.0.69 → 1.1.2

package/plugin.js

@@ -0,0 +1,19 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { createEndpointRuntimeState } from 'zhin.js/adapter';
+import { definePlugin } from 'zhin.js';
+import { permissionHostToken } from '@zhin.js/permission';
+import { checkTelegramPlatformPermit } from "./lib/platform-permit.js";
+import { telegramRuntimeStateToken } from "./lib/telegram-runtime-state.js";
+export default definePlugin({
+    name: 'telegram',
+    metadata: {
+        displayName: 'Telegram Bot API Adapter',
+    },
+    setup(context) {
+        context.resources.provide(telegramRuntimeStateToken, createEndpointRuntimeState());
+        if (context.resources.has(permissionHostToken)) {
+            const host = context.resources.use(permissionHostToken);
+            return host.registerPlatform('telegram', checkTelegramPlatformPermit);
+        }
+    },
+});

package/schema.json

@@ -0,0 +1,141 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "polling": {
+      "type": "boolean",
+      "default": true,
+      "description": "Long-poll getUpdates (default). Set false for webhook via httpHostToken."
+    },
+    "webhook": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "Webhook settings when polling is false.",
+      "properties": {
+        "domain": {
+          "type": "string"
+        },
+        "path": {
+          "type": "string",
+          "default": "/telegram/webhook"
+        },
+        "secretToken": {
+          "type": "string",
+          "description": "Verified via X-Telegram-Bot-Api-Secret-Token."
+        }
+      }
+    },
+    "allowedUpdates": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "default": [
+        "message",
+        "callback_query"
+      ]
+    },
+    "apiBaseUrl": {
+      "type": "string",
+      "default": "https://api.telegram.org"
+    },
+    "master": {
+      "type": [
+        "string",
+        "number"
+      ],
+      "description": "框架 master（Telegram user id；AI/工具权限、endpoint 管理）。endpoints[i].master 可逐项覆盖"
+    },
+    "trusted": {
+      "type": "array",
+      "items": {
+        "type": [
+          "string",
+          "number"
+        ],
+        "description": "Trusted Telegram user id"
+      },
+      "description": "框架 trusted 用户列表（弱于 master）。endpoints[i].trusted 可逐项追加"
+    },
+    "endpoints": {
+      "type": "array",
+      "minItems": 1,
+      "description": "多账号：一个插件实例挂多个 endpoint。每项与顶层字段同构（id 必填，其余覆盖顶层）",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "master": {
+            "type": [
+              "string",
+              "number"
+            ],
+            "description": "本 endpoint 的框架 master（Telegram user id）；覆盖顶层 master"
+          },
+          "trusted": {
+            "type": "array",
+            "items": {
+              "type": [
+                "string",
+                "number"
+              ],
+              "description": "Trusted Telegram user id"
+            },
+            "description": "本 endpoint 的 trusted 列表"
+          },
+          "token": {
+            "type": "string",
+            "description": "Telegram bot token"
+          },
+          "polling": {
+            "type": "boolean"
+          },
+          "webhook": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "domain": {
+                "type": "string"
+              },
+              "path": {
+                "type": "string"
+              },
+              "secretToken": {
+                "type": "string"
+              }
+            }
+          },
+          "allowedUpdates": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "apiBaseUrl": {
+            "type": "string"
+          },
+          "commandPrefix": {
+            "type": "string"
+          },
+          "id": {
+            "type": "string",
+            "description": "Telegram bot name"
+          }
+        },
+        "required": [
+          "id",
+          "token"
+        ]
+      }
+    },
+    "commandPrefix": {
+      "type": "string",
+      "default": "",
+      "description": "命令前缀（默认 '' 无前缀，任意文本按命令匹配；如 '/' 要求 / 开头）。endpoints[i] 可逐项覆盖"
+    }
+  },
+  "required": [
+    "endpoints"
+  ]
+}

package/src/client.ts

@@ -0,0 +1,16 @@
+import { defineEndpointClient } from 'zhin.js/adapter';
+import type { TelegramClient } from './endpoint.js';
+import type { TelegramUpdate } from './protocol.js';
+
+export type TelegramClientEventMap = Record<string, TelegramUpdate>;
+
+declare module '@zhin.js/feature-kit' {
+  interface AdapterClientRegistry {
+    readonly telegram: {
+      readonly client: TelegramClient;
+      readonly events: TelegramClientEventMap;
+    };
+  }
+}
+
+export const telegramClient = defineEndpointClient<TelegramClient, TelegramClientEventMap>('telegram');