@zhin.js/adapter-wechat-mp 5.0.12 → 5.0.13

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @zhin.js/adapter-wechat-mp
 
+## 5.0.13
+
+### Patch Changes
+
+- 5969c5b: Add SideEventGateway so adapters forward notice/request/system into HandlerIndex. HandlerContext now exposes only generation-safe capabilities and prompt ports; live Endpoint escape hatches are removed.
+- Updated dependencies [5969c5b]
+- Updated dependencies [d336a3f]
+- Updated dependencies [5969c5b]
+- Updated dependencies [5969c5b]
+- Updated dependencies [974772e]
+- Updated dependencies [5969c5b]
+- Updated dependencies [2f786bd]
+- Updated dependencies [1312ca0]
+- Updated dependencies [985fa22]
+  - @zhin.js/im-contract@1.0.4
+  - @zhin.js/core@1.5.12
+  - @zhin.js/adapter@1.1.11
+  - @zhin.js/host-http@1.0.11
+  - @zhin.js/command@1.0.15
+  - zhin.js@6.0.12
+
 ## 5.0.12
 
 ### Patch Changes

package/adapters/wechat-mp.js

@@ -3,7 +3,7 @@
  * Convention entry: discover `adapters/wechat-mp.ts` → defineAdapter.
  */
 import { defineAdapter } from 'zhin.js/adapter';
-import { messageGatewayToken } from '@zhin.js/core/runtime';
+import { messageGatewayToken, sideEventGatewayToken } from '@zhin.js/core/runtime';
 import { httpHostToken } from '@zhin.js/host-http';
 import { WeChatMpEndpoint } from "../lib/endpoint.js";
 import { resolveWeChatMpConfig, } from "../lib/protocol.js";
@@ -27,6 +27,7 @@ export default defineAdapter({
         return new WeChatMpEndpoint({
             id: context.id,
             gateway: context.use(messageGatewayToken),
+            sideEvents: context.use(sideEventGatewayToken),
             http: context.use(httpHostToken),
             config,
         });

package/adapters/wechat-mp.ts

@@ -2,7 +2,7 @@
  * Convention entry: discover `adapters/wechat-mp.ts` → defineAdapter.
  */
 import { defineAdapter } from 'zhin.js/adapter';
-import { messageGatewayToken } from '@zhin.js/core/runtime';
+import { messageGatewayToken, sideEventGatewayToken } from '@zhin.js/core/runtime';
 import { httpHostToken } from '@zhin.js/host-http';
 import { WeChatMpEndpoint } from '../src/endpoint.js';
 import {
@@ -32,6 +32,7 @@ export default defineAdapter<WeChatMpAdapterConfig>({
     return new WeChatMpEndpoint({
       id: context.id,
       gateway: context.use(messageGatewayToken),
+      sideEvents: context.use(sideEventGatewayToken),
       http: context.use(httpHostToken),
       config,
     });

package/lib/endpoint.d.ts

@@ -1,5 +1,5 @@
 import type { EndpointFriend, EndpointInstance, EndpointManagement, EndpointSendRequest } from 'zhin.js/adapter';
-import type { MessageGateway } from '@zhin.js/core/runtime';
+import type { MessageGateway, SideEventGateway } from '@zhin.js/core/runtime';
 import type { HttpHost } from '@zhin.js/host-http';
 import type { CapabilityId } from 'zhin.js';
 import { type ResolvedWeChatMpConfig, type WeChatMessage } from './protocol.js';
@@ -13,6 +13,7 @@ export type WeChatMpFetch = (url: string, init?: {
 export interface WeChatMpEndpointOptions {
     readonly id: CapabilityId;
     readonly gateway: MessageGateway;
+    readonly sideEvents?: SideEventGateway;
     readonly http: HttpHost;
     readonly config: ResolvedWeChatMpConfig;
     readonly fetch?: WeChatMpFetch;

package/lib/endpoint.js

@@ -7,6 +7,7 @@ import { extractOutboundText, formatCustomerServiceBody, formatInboundContent, f
 import { buildMediaUploadForm, readOutboundMedia, resolveMediaBinary, } from './media-upload.js';
 import { getPassiveReplyCapture, recordPassiveReplyText, } from './passive-reply.js';
 import { registerWeChatMpWebhookRoutes } from './webhook.js';
+import { receiveWeChatMpSideEvent } from './side-event-dispatch.js';
 /** token 失效类错误码：40001/40014 invalid access_token、42001 access_token expired。 */
 const TOKEN_INVALID_ERRCODES = new Set([40001, 40014, 42001]);
 /**
@@ -132,6 +133,9 @@ export class WeChatMpEndpoint {
     admit(msg) {
         if (!this.#open)
             return;
+        if (receiveWeChatMpSideEvent(this.#options.sideEvents, this.#options.config.id, msg, this.#logger)) {
+            return;
+        }
         const conversation = wechatMpInboundConversation(String(this.#options.id), msg);
         void this.#options.gateway.receive({
             conversation,

package/lib/side-event-dispatch.d.ts

@@ -0,0 +1,4 @@
+import type { SideEventGateway } from '@zhin.js/core/runtime';
+import { type getAdapterLogger } from '@zhin.js/logger';
+import { type WeChatMessage } from './protocol.js';
+export declare function receiveWeChatMpSideEvent(sideEvents: SideEventGateway | undefined, configId: string, msg: WeChatMessage, logger: ReturnType<typeof getAdapterLogger>): boolean;

package/lib/side-event-dispatch.js

@@ -0,0 +1,38 @@
+import { buildNotice, senderFromId } from '@zhin.js/core';
+import { formatCompact } from '@zhin.js/logger';
+import { formatInboundId } from './protocol.js';
+function mapWeChatMpEventParts(eventName) {
+    switch (eventName) {
+        case 'subscribe':
+            return { scene_type: 'friend', sub_type: 'increase' };
+        case 'unsubscribe':
+            return { scene_type: 'friend', sub_type: 'decrease' };
+        default:
+            return { scene_type: 'wechat-mp', sub_type: eventName || 'unknown' };
+    }
+}
+export function receiveWeChatMpSideEvent(sideEvents, configId, msg, logger) {
+    if (!sideEvents || msg.MsgType !== 'event')
+        return false;
+    const eventName = msg.Event ?? 'unknown';
+    const parts = mapWeChatMpEventParts(eventName);
+    void sideEvents.receiveNotice(buildNotice(msg, {
+        $id: `wechat-mp:${formatInboundId(msg)}`,
+        $adapter: 'wechat-mp',
+        $endpoint: configId,
+        $type: 'notice',
+        $scene_id: msg.FromUserName,
+        $scene_type: parts.scene_type,
+        $sub_type: parts.sub_type,
+        $actor: senderFromId(msg.FromUserName),
+        $timestamp: msg.CreateTime ?? Date.now(),
+    })).catch((err) => {
+        logger.warn(formatCompact({
+            op: 'wechat_mp_side_event_failed',
+            endpoint: configId,
+            event: eventName,
+            error: err instanceof Error ? err.message : String(err),
+        }));
+    });
+    return true;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhin.js/adapter-wechat-mp",
-  "version": "5.0.12",
+  "version": "5.0.13",
   "type": "module",
   "description": "Zhin.js WeChat Official Account adapter for Plugin Runtime (HTTP webhook)",
   "main": "./lib/index.js",
@@ -8,18 +8,18 @@
   "dependencies": {
     "axios": "^1.19.0",
     "xml2js": "^0.6.2",
-    "@zhin.js/adapter": "1.1.10",
-    "@zhin.js/core": "1.5.11",
-    "@zhin.js/host-http": "1.0.10",
-    "@zhin.js/im-contract": "1.0.3",
+    "@zhin.js/adapter": "1.1.11",
+    "@zhin.js/core": "1.5.12",
+    "@zhin.js/host-http": "1.0.11",
+    "@zhin.js/im-contract": "1.0.4",
     "@zhin.js/logger": "1.0.76"
   },
   "peerDependencies": {
-    "@zhin.js/adapter": "1.1.10",
-    "@zhin.js/command": "1.0.14",
-    "@zhin.js/core": "1.5.11",
-    "@zhin.js/host-http": "1.0.10",
-    "zhin.js": "6.0.11"
+    "@zhin.js/adapter": "1.1.11",
+    "@zhin.js/command": "1.0.15",
+    "@zhin.js/core": "1.5.12",
+    "@zhin.js/host-http": "1.0.11",
+    "zhin.js": "6.0.12"
   },
   "peerDependenciesMeta": {
     "@zhin.js/command": {
@@ -34,7 +34,7 @@
     "@types/xml2js": "^0.4.14",
     "typescript": "^6.0.3",
     "vitest": "^4.1.10",
-    "zhin.js": "6.0.11"
+    "zhin.js": "6.0.12"
   },
   "keywords": [
     "zhin",

package/src/endpoint.ts

@@ -3,7 +3,7 @@
  */
 import axios from 'axios';
 import type { EndpointFriend, EndpointInstance, EndpointManagement, EndpointSendRequest } from 'zhin.js/adapter';
-import type { MessageGateway } from '@zhin.js/core/runtime';
+import type { MessageGateway, SideEventGateway } from '@zhin.js/core/runtime';
 import type { HttpHost, HttpRouteRegistration } from '@zhin.js/host-http';
 import { formatCompact, getAdapterLogger } from '@zhin.js/logger';
 import type { CapabilityId } from 'zhin.js';
@@ -29,6 +29,7 @@ import {
   recordPassiveReplyText,
 } from './passive-reply.js';
 import { registerWeChatMpWebhookRoutes } from './webhook.js';
+import { receiveWeChatMpSideEvent } from './side-event-dispatch.js';
 
 /** token 失效类错误码：40001/40014 invalid access_token、42001 access_token expired。 */
 const TOKEN_INVALID_ERRCODES = new Set([40001, 40014, 42001]);
@@ -52,6 +53,7 @@ export type WeChatMpFetch = (
 export interface WeChatMpEndpointOptions {
   readonly id: CapabilityId;
   readonly gateway: MessageGateway;
+  readonly sideEvents?: SideEventGateway;
   readonly http: HttpHost;
   readonly config: ResolvedWeChatMpConfig;
   readonly fetch?: WeChatMpFetch;
@@ -184,6 +186,14 @@ export class WeChatMpEndpoint implements EndpointInstance {
   /** Test / internal: admit a parsed message when open (non-webhook path). */
   admit(msg: WeChatMessage): void {
     if (!this.#open) return;
+    if (receiveWeChatMpSideEvent(
+      this.#options.sideEvents,
+      this.#options.config.id,
+      msg,
+      this.#logger,
+    )) {
+      return;
+    }
     const conversation = wechatMpInboundConversation(String(this.#options.id), msg);
     void this.#options.gateway.receive({
       conversation,

package/src/side-event-dispatch.ts

@@ -0,0 +1,45 @@
+import { buildNotice, senderFromId } from '@zhin.js/core';
+import type { SideEventGateway } from '@zhin.js/core/runtime';
+import { formatCompact, type getAdapterLogger } from '@zhin.js/logger';
+import { formatInboundId, type WeChatMessage } from './protocol.js';
+
+function mapWeChatMpEventParts(eventName: string): { scene_type: string; sub_type: string } {
+  switch (eventName) {
+    case 'subscribe':
+      return { scene_type: 'friend', sub_type: 'increase' };
+    case 'unsubscribe':
+      return { scene_type: 'friend', sub_type: 'decrease' };
+    default:
+      return { scene_type: 'wechat-mp', sub_type: eventName || 'unknown' };
+  }
+}
+
+export function receiveWeChatMpSideEvent(
+  sideEvents: SideEventGateway | undefined,
+  configId: string,
+  msg: WeChatMessage,
+  logger: ReturnType<typeof getAdapterLogger>,
+): boolean {
+  if (!sideEvents || msg.MsgType !== 'event') return false;
+  const eventName = msg.Event ?? 'unknown';
+  const parts = mapWeChatMpEventParts(eventName);
+  void sideEvents.receiveNotice(buildNotice(msg, {
+    $id: `wechat-mp:${formatInboundId(msg)}`,
+    $adapter: 'wechat-mp' as never,
+    $endpoint: configId,
+    $type: 'notice',
+    $scene_id: msg.FromUserName,
+    $scene_type: parts.scene_type,
+    $sub_type: parts.sub_type,
+    $actor: senderFromId(msg.FromUserName),
+    $timestamp: msg.CreateTime ?? Date.now(),
+  })).catch((err) => {
+    logger.warn(formatCompact({
+      op: 'wechat_mp_side_event_failed',
+      endpoint: configId,
+      event: eventName,
+      error: err instanceof Error ? err.message : String(err),
+    }));
+  });
+  return true;
+}