@zhin.js/adapter-line 1.1.17 → 1.1.19

package/src/console-spec.ts

@@ -0,0 +1,16 @@
+/**
+ * LINE Console 页面元数据（浏览器与服务端共享；不要在这里 import 服务端代码）。
+ */
+import type { AdapterConsoleField } from 'zhin.js/adapter';
+
+export const lineConsoleSpec = {
+  adapterKey: 'line',
+  adapterDisplayName: 'LINE',
+  fields: [
+    { key: 'channelSecret', required: true, env: true, description: 'LINE channel secret' },
+    { key: 'channelAccessToken', required: true, env: true, description: 'LINE channel access token' },
+  ] as readonly AdapterConsoleField[],
+  docsUrl: 'https://zhin.js.org/adapters/line',
+  readPermission: 'line:read',
+  writePermission: 'line:write',
+} as const;

package/src/console.ts

@@ -0,0 +1,18 @@
+/**
+ * LINE Console RPC：运行状态 + endpoint 增删（原 `line endpoint` 聊天命令）。
+ *
+ * 页面绑定 `pages/index`，读取 / 写入分别要求 `<adapter>:read` / `<adapter>:write`。
+ */
+import { createAdapterConsoleRpc, type AdapterConsoleResources } from 'zhin.js/adapter';
+import type { PluginConsoleRpc } from 'zhin.js';
+import { lineConsoleSpec } from './console-spec.js';
+
+export function createLineConsoleRpc(
+  _resources: AdapterConsoleResources,
+  getConfig: () => unknown,
+): PluginConsoleRpc {
+  return createAdapterConsoleRpc({
+    ...lineConsoleSpec,
+    getConfig,
+  });
+}

package/src/endpoint.ts

@@ -1,282 +1,36 @@
-import { EndpointDeliveryError } from '@zhin.js/im-contract';
-/**
- * LineEndpoint — lifecycle, outbound, admit, OpenAPI helpers for agent tools.
- */
-import { Endpoint, type EndpointManagement, type EndpointSendRequest } from 'zhin.js/adapter';
-import type { HttpHost, HttpRouteRegistration } from '@zhin.js/host-http';
-import { formatCompact, getAdapterLogger } from '@zhin.js/logger';
-import type { CapabilityId } from 'zhin.js';
-import {
-  formatInboundContent,
-  formatOutboundMessages,
-  generateMessageId,
-  isLineLifecycleEvent,
-  isMessageEvent,
-  isValidLineRecipientId,
-  lineInboundConversation,
-  type LineApiResponse,
-  type LineEvent,
-  type ResolvedLineConfig,
-} from './protocol.js';
-import { registerLineWebhookRoutes } from './webhook.js';
-import { receiveLineSideEvent } from './side-event-dispatch.js';
-import { LineClient } from './client.js';
-
-/** LINE replyToken 有效期短，过期后 reply 必 400；缓存带时间戳，超时弃用改走 push。 */
-const REPLY_TOKEN_TTL_MS = 60_000;
-/** 出站 HTTP 调用统一 30s 超时。 */
-const OUTBOUND_TIMEOUT_MS = 30_000;
-
-export type LineFetch = (
-  url: string,
-  init?: {
-    readonly method?: string;
-    readonly headers?: Record<string, string>;
-    readonly body?: string;
-    readonly signal?: AbortSignal;
-  },
-) => Promise<{
-  readonly ok: boolean;
-  readonly status: number;
-  text(): Promise<string>;
-  json(): Promise<unknown>;
-}>;
-
-export interface LineEndpointOptions {
-  readonly id: CapabilityId;
-  readonly http: HttpHost;
-  readonly config: ResolvedLineConfig;
-  readonly fetch?: LineFetch;
-}
-
-export class LineEndpoint extends Endpoint<LineClient> {
-  readonly client: LineClient;
-  readonly #logger!: ReturnType<typeof getAdapterLogger>;
-
-  readonly #options: LineEndpointOptions;
-  readonly #fetch: LineFetch;
-  #routeReleases: HttpRouteRegistration[] = [];
-  #replyTokenCache = new Map<string, { token: string; timestamp: number }>();
-  readonly #admissions = new Map<string, { readonly promise: Promise<void>; expires: number }>();
-  #open = false;
-  #started = false;
-  readonly management: EndpointManagement = createLineEndpointManagement(this);
-
-  constructor(options: LineEndpointOptions) {
-    super();
-    this.#logger = getAdapterLogger('line', options.config.id);
-    this.#options = options;
-    this.#fetch = options.fetch ?? globalThis.fetch;
-    this.client = new LineClient(options.config, this.#fetch);
-  }
-
-  /** Used by webhook handler. */
-  get isOpen(): boolean {
-    return this.#open;
-  }
-
-  get config(): ResolvedLineConfig {
-    return this.#options.config;
-  }
-
-  async start(): Promise<void> {
-    if (this.#started) return;
-    this.#started = true;
-    try {
-      this.#routeReleases.push(...registerLineWebhookRoutes(this.#options.http, this));
-      this.#logger.debug(formatCompact({
-        endpoint: this.#options.config.id,
-        op: 'webhook',
-        path: this.#options.config.webhookPath,
-      }));
-    } catch (error) {
-      await this.stop();
-      this.#logger.error('Failed to connect LINE endpoint:', error);
-      throw error;
-    }
-  }
-
-  open(): void {
-    this.#open = true;
-  }
-
-  close(): void {
-    this.#open = false;
-  }
-
-  async stop(): Promise<void> {
-    this.#open = false;
-    this.#replyTokenCache.clear();
-    this.#admissions.clear();
-    for (const release of this.#routeReleases.splice(0)) release();
-    this.#started = false;
-    this.#logger.debug(formatCompact({ op: 'disconnect' }));
-  }
-
-  async send({ conversation, payload }: EndpointSendRequest): Promise<string> {
-    try {
-      const messages = formatOutboundMessages(payload);
-      if (messages.length === 0) {
-        throw new EndpointDeliveryError('invalid_payload', 'No valid LINE messages to send', 'not_sent');
-      }
-      // LINE recipient id 前缀（U/G/R）自带场景信息，原生 id 即投递地址。
-      const target = conversation.id;
-
-      const cached = this.#replyTokenCache.get(target);
-      if (cached) {
-        this.#replyTokenCache.delete(target);
-        if (Date.now() - cached.timestamp <= REPLY_TOKEN_TTL_MS) {
-          return await this.#replyMessage(cached.token, messages);
-        }
-      }
-
-      if (!isValidLineRecipientId(target)) {
-        throw new EndpointDeliveryError('invalid_recipient',
-          `Invalid LINE recipient ID "${target}": must start with U (user), G (group), or R (room)`, 'not_sent',
-        );
-      }
-      return await this.#pushMessage(target, messages);
-    } catch (error) {
-      if (error instanceof EndpointDeliveryError) throw error;
-      throw new EndpointDeliveryError('delivery_unconfirmed', 'Outbound request outcome is unknown', 'unknown', { cause: error });
-    }
-  }
-
-  /** Test / internal: admit a parsed event when open (non-webhook path). */
-  admit(event: LineEvent): void {
-    if (!this.#open) return;
-    void this.admitAccepted(event).catch((err) => {
-      this.#logger.warn(formatCompact({ op: 'line_gateway_receive_failed', error: err instanceof Error ? err.message : String(err) }));
-    });
-  }
-
-  /** Webhook acknowledgement follows actual runtime generation admission. */
-  async admitAccepted(event: LineEvent): Promise<void> {
-    if (!this.#open) throw new Error('LINE endpoint is closed');
-    const id = event.webhookEventId;
-    if (typeof id !== 'string' || !id.trim()) return this.#dispatchAccepted(event);
-    const now = Date.now();
-    for (const [key, entry] of this.#admissions) if (entry.expires <= now) this.#admissions.delete(key);
-    const existing = this.#admissions.get(id);
-    if (existing) return existing.promise;
-    // Never evict in-flight admissions: overload returns 503 and permits platform retry.
-    if (this.#admissions.size >= 10_000) throw new Error('LINE admission dedup capacity exhausted');
-    const entry = { promise: Promise.resolve().then(() => this.#dispatchAccepted(event)), expires: Infinity };
-    this.#admissions.set(id, entry);
-    try {
-      await entry.promise;
-      if (this.#admissions.get(id) === entry) entry.expires = Date.now() + 24 * 60 * 60 * 1000;
-    } catch (error) {
-      if (this.#admissions.get(id) === entry) this.#admissions.delete(id);
-      throw error;
-    }
-  }
-
-  async #dispatchAccepted(event: LineEvent): Promise<void> {
-    if (!this.#open) throw new Error('LINE endpoint is closed');
-    void this.emitPlatform(event.type || 'event', event).catch((error) => {
-      this.#logger.warn(formatCompact({
-        op: 'line_platform_event_failed',
-        event: event.type,
-        error: error instanceof Error ? error.message : String(error),
-      }));
-    });
-    if (isLineLifecycleEvent(event)) {
-      await receiveLineSideEvent(
-        (name, payload) => this.emitAccepted(name, payload),
-        String(this.#options.id),
-        this.#options.config.id,
-        event,
-        this.#logger,
-      );
-      return;
-    }
-    const conversation = lineInboundConversation(String(this.#options.id), event.source);
-    if ('replyToken' in event && typeof event.replyToken === 'string') {
-      this.#replyTokenCache.set(conversation.id, { token: event.replyToken, timestamp: Date.now() });
-    }
-    await this.emitAccepted('message.receive', {
-      conversation,
-      message: { conversation, id: generateMessageId(event) },
-      content: formatInboundContent(event),
-      sender: { id: event.source.userId || conversation.id },
-      endpointId: this.#options.config.id,
-      metadata: Object.freeze({
-        eventType: event.type,
-        sourceType: event.source.type,
-        timestamp: event.timestamp,
-        ...(isMessageEvent(event) ? { messageType: event.message.type } : {}),
-      }),
-    });
-  }
-
-  async #replyMessage(
-    replyToken: string,
-    messages: ReturnType<typeof formatOutboundMessages>,
-  ): Promise<string> {
-    const url = `${this.#options.config.apiBaseUrl}/v2/bot/message/reply`;
-    const response = await this.#fetch(url, {
-      method: 'POST',
-      headers: {
-        'Content-Type': 'application/json',
-        Authorization: `Bearer ${this.#options.config.channelAccessToken}`,
-      },
-      body: JSON.stringify({ replyToken, messages }),
-      signal: AbortSignal.timeout(OUTBOUND_TIMEOUT_MS),
-    });
-    if (!response.ok) {
-      throw await lineResponseError(response);
-    }
-    const result = await response.json() as LineApiResponse;
-    return requireMessageId(result.sentMessages?.[0]?.id);
-  }
-
-  async #pushMessage(
-    to: string,
-    messages: ReturnType<typeof formatOutboundMessages>,
-  ): Promise<string> {
-    const url = `${this.#options.config.apiBaseUrl}/v2/bot/message/push`;
-    const response = await this.#fetch(url, {
-      method: 'POST',
-      headers: {
-        'Content-Type': 'application/json',
-        Authorization: `Bearer ${this.#options.config.channelAccessToken}`,
-      },
-      body: JSON.stringify({ to, messages }),
-      signal: AbortSignal.timeout(OUTBOUND_TIMEOUT_MS),
-    });
-    if (!response.ok) {
-      throw await lineResponseError(response);
-    }
-    const result = await response.json() as LineApiResponse;
-    return requireMessageId(result.sentMessages?.[0]?.id);
+import { createEndpointSpecification, endpointSpec, type Endpoint } from 'zhin.js/adapter';
+import { LineClient, type LineEndpointOptions } from './client.js';
+export type { LineEndpointOptions } from './client.js';
+export type { LineFetch } from './client.js';
+
+/** Actual protocol Client; framework lifecycle and admission stay in their symbol namespace. */
+export class LineEndpoint extends LineClient implements Endpoint {
+  readonly [endpointSpec] = this.#createSpecification();
+  constructor(options: LineEndpointOptions) { super(options); }
+  #createSpecification() {
+    const hooks = {
+      start: (signal: AbortSignal) => this.#startFramework(signal),
+      open: () => this.openInput(), close: () => this.closeInput(), stop: () => this.disconnectTransport(),
+      send: (request: import('zhin.js/adapter').EndpointSendRequest) => this.sendPayload(request),
+      name: this.configName(),
+      management: this.endpointManagement,
+    };
+    Object.defineProperty(hooks, 'transportState', { get: () => this.transportState });
+    return createEndpointSpecification(this, hooks);
+  }
+  #startFramework(signal: AbortSignal) { return this.connectTransport(signal); }
+  protected override inboundReceiptCurrent(): boolean { return !this.executionSignal?.aborted; }
+  protected override receiveInboundCallback<T>(receive: () => T | Promise<T>): Promise<T> {
+    return this[endpointSpec].events.run(receive);
+  }
+  protected override publishEvent(name: string, payload: unknown): Promise<unknown> {
+    return this[endpointSpec].events.emit(name, payload);
+  }
+  protected override publishAccepted(name: string, payload: unknown): Promise<void> {
+    return this[endpointSpec].events.emitAccepted(name, payload).then(() => undefined);
+  }
+  protected override async publishPlatform(name: string, event: unknown): Promise<unknown> {
+    await super.publishPlatform(name, event);
+    return this[endpointSpec].events.platform(name, event);
   }
-
-  /**
-   * group/room 成员列表：Bot API 无群列表，只能按已知 groupId/roomId 拉成员。
-   * members/ids 分页（next continuation token）后逐个取 profile 归一 nickname；
-   * 单个 profile 失败（用户已退群等）时回退 userId 占位，不拖垮整批。
-   */
-}
-
-function createLineEndpointManagement(endpoint: LineEndpoint): EndpointManagement {
-  return Object.freeze<EndpointManagement>({
-    // listGroups 不接：LINE Bot API 没有"我加入了哪些群"的接口，群 id 只能来自入站事件。
-    listGroupMembers: (groupId) => endpoint.client.getGroupMembers(groupId),
-  });
-}
-
-async function lineResponseError(response: Awaited<ReturnType<LineFetch>>): Promise<EndpointDeliveryError> {
-  // Error responses may carry sentMessages: a failed request can have partial side effects.
-  let body: { sentMessages?: unknown[] };
-  try { body = await response.json() as { sentMessages?: unknown[] }; }
-  catch { return new EndpointDeliveryError('delivery_unconfirmed', `LINE HTTP ${response.status}`, 'unknown'); }
-  const disposition = Array.isArray(body?.sentMessages) && body.sentMessages.length > 0
-    ? 'unknown' : response.status >= 400 && response.status < 500 && response.status !== 408 && response.status !== 409 ? 'rejected' : 'unknown';
-  return new EndpointDeliveryError(disposition === 'unknown' ? 'delivery_unconfirmed' : 'platform_rejected', `LINE HTTP ${response.status}`, disposition);
-}
-
-function requireMessageId(value: unknown): string {
-  if (typeof value === 'string' && value.trim().length > 0) return value;
-  throw new EndpointDeliveryError('delivery_unconfirmed', 'Platform did not return a real message ID', 'unknown');
 }

package/src/index.ts

@@ -45,7 +45,7 @@ export {
 
 export {
   LineClient,
-  lineClient,
   type LineClientEventMap,
   type LineGroupMember,
 } from './client.js';
+export { LineAdapter } from './adapter.js';

package/lib/line-runtime-state.d.ts

@@ -1 +0,0 @@
-export declare const lineRuntimeStateToken: import("zhin.js").Token<import("@zhin.js/adapter").EndpointRuntimeState>;

package/lib/line-runtime-state.js

@@ -1,6 +0,0 @@
-/**
- * LINE 插件实例的运行时状态：adapter create() 注册的 endpoint 列表。
- * 由 plugin.ts setup() provide，adapter create 与 `line endpoint` 命令共享（同一 owner generation）。
- */
-import { defineEndpointRuntimeStateToken } from 'zhin.js/adapter';
-export const lineRuntimeStateToken = defineEndpointRuntimeStateToken('line');

package/src/line-runtime-state.ts

@@ -1,7 +0,0 @@
-/**
- * LINE 插件实例的运行时状态：adapter create() 注册的 endpoint 列表。
- * 由 plugin.ts setup() provide，adapter create 与 `line endpoint` 命令共享（同一 owner generation）。
- */
-import { defineEndpointRuntimeStateToken } from 'zhin.js/adapter';
-
-export const lineRuntimeStateToken = defineEndpointRuntimeStateToken('line');