@zhin.js/adapter-github 1.1.19 → 1.1.21

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @zhin.js/adapter-github
 
+## 1.1.21
+
+### Patch Changes
+
+- af8f803: Use the current Endpoint's platform profile for Agent account identity, with per-field configured fallbacks and scoped, identity-approved profile tools. Keep SOUL first-person and independent of account names. Profile ports preserve the source Client, cancellation, truthful update outcomes and private image authority.
+
+  Adapter Feature API 2.1 and Tool Feature API 1.1 describe the additive profile requirements; new Core, official adapters and generated plugins declare the corresponding floors. Existing compatible API-2.0/API-1.0 plugins remain accepted by the newer providers. npm releases remain patch.
+
+  Private IM assets now bind to the full canonical conversation and principal. Existing IM asset records that contain only the earlier lossy hash remain on disk until their original expiry, but cannot be safely rebound; recapture them. No automatic file deletion, platform profile mutation or workspace SOUL rewrite occurs during upgrade.
+
+- Updated dependencies [b88e988]
+- Updated dependencies [f78eb84]
+- Updated dependencies [c15cef9]
+- Updated dependencies [b0c02a2]
+- Updated dependencies [af8f803]
+- Updated dependencies [26fda97]
+- Updated dependencies [976886c]
+- Updated dependencies [032dc96]
+  - @zhin.js/adapter@1.1.27
+  - @zhin.js/client@1.1.23
+  - @zhin.js/im-contract@1.1.10
+  - @zhin.js/core@1.1.55
+  - @zhin.js/tool@1.1.14
+  - @zhin.js/page@1.1.13
+  - @zhin.js/host-http@1.1.13
+  - @zhin.js/agent-feature@1.1.12
+  - @zhin.js/feature-kit@1.1.11
+  - @zhin.js/skill@1.1.12
+
+## 1.1.20
+
+### Patch Changes
+
+- Updated dependencies [5e878ba]
+  - @zhin.js/page@1.1.12
+
 ## 1.1.19
 
 ### Patch Changes

package/lib/endpoint.js

@@ -1,6 +1,7 @@
 import { createEndpointSpecification, endpointSpec } from 'zhin.js/adapter';
 import { formatCompact, getAdapterLogger } from '@zhin.js/logger';
 import { GhClient } from './gh-client.js';
+import { createGithubSelfProfile } from './self-profile.js';
 import { enrichInboundContent, formatInboundContent, formatOutboundBody, githubInboundConversation, parseChannelId, } from './protocol.js';
 import { registerGithubWebhookRoutes } from './webhook.js';
 import { WorkspaceManager } from './workspace-manager.js';
@@ -13,6 +14,7 @@ export class GithubEndpoint extends GhClient {
     [endpointSpec] = createEndpointSpecification(this, {
         start: signal => this.#startFramework(signal), open: () => this.#openFramework(), close: () => this.#closeFramework(),
         stop: () => this.#stopFramework(), send: request => this.#sendFramework(request),
+        profile: createGithubSelfProfile({ client: this, reportAccount: id => this[endpointSpec].reportSelfUserId(id) }),
     });
     #workspaceManager;
     get database() { return this.#options.database; }

package/lib/protocol.d.ts

@@ -1,14 +1,11 @@
-/**
- * GitHub webhook / comment helpers — no legacy Adapter/Endpoint / segment-mapper.
- * Canonicalization is owned by gateway/core before endpoint.send.
- */
+import type { EndpointProfileConfiguration } from 'zhin.js/adapter';
 import type { IncomingMessage } from 'node:http';
 import { type ConversationRef } from '@zhin.js/im-contract';
 import { type GenericWebhookPayload, type IssueCommentPayload, type PRReviewCommentPayload, type PRReviewPayload } from './types.js';
 export type { EventType, GenericWebhookPayload, GitHubComment, GitHubIssue, GitHubOAuthUser, GitHubPR, GitHubRepo, GitHubUser, IssueCommentPayload, ParsedChannel, PRReviewCommentPayload, PRReviewPayload, Subscription, } from './types.js';
 export { buildChannelId, parseChannelId } from './types.js';
 /** One expanded GitHub endpoint configuration produced by AdapterIndex. */
-export interface GithubEndpointConfig {
+export interface GithubEndpointConfig extends EndpointProfileConfiguration {
     readonly id: string;
     readonly host?: string;
     readonly app_id: string | number;

package/lib/self-profile.d.ts

@@ -0,0 +1,9 @@
+import { type EndpointProfile } from 'zhin.js/adapter';
+import type { GhClient } from './gh-client.js';
+interface GithubSelfProfileOptions {
+    readonly client: Pick<GhClient, 'getBotIdentity' | 'request' | 'isAppAuth'>;
+    readonly reportAccount: (id: string) => void;
+}
+/** PAT accounts read /user; GitHub Apps read the verified app bot's public user profile. */
+export declare function createGithubSelfProfile({ client, reportAccount }: GithubSelfProfileOptions): EndpointProfile;
+export {};

package/lib/self-profile.js

@@ -0,0 +1,27 @@
+import { createEndpointOperation } from 'zhin.js/adapter';
+/** PAT accounts read /user; GitHub Apps read the verified app bot's public user profile. */
+export function createGithubSelfProfile({ client, reportAccount }) {
+    return Object.freeze({
+        writableFields: Object.freeze([]),
+        async read({ signal }) {
+            const operation = createEndpointOperation({ signal });
+            const bot = await operation.prepare(() => client.getBotIdentity());
+            if (client.isAppAuth && !bot)
+                throw new Error('GitHub App bot identity is unavailable');
+            const response = await client.request({
+                method: 'GET', path: bot ? `/users/${encodeURIComponent(bot.login)}` : '/user', signal,
+            });
+            if (!response.ok)
+                throw new Error(`GitHub self profile lookup failed (${response.status}): ${response.data?.message ?? 'API request failed'}`);
+            if (!response.data?.id || typeof response.data.login !== 'string')
+                throw new Error('GitHub returned no account profile');
+            if (bot && response.data.id !== bot.userId)
+                throw new Error('GitHub returned another account profile');
+            const user = response.data;
+            reportAccount(String(user.id));
+            return { nickname: user.name || user.login,
+                ...(user.bio === null || typeof user.bio === 'string' ? { bio: user.bio } : {}),
+                ...(typeof user.avatar_url === 'string' ? { avatar: user.avatar_url } : {}) };
+        },
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhin.js/adapter-github",
-  "version": "1.1.19",
+  "version": "1.1.21",
   "description": "Zhin.js GitHub adapter for Plugin Runtime (App auth + webhook)",
   "type": "module",
   "main": "./lib/index.js",
@@ -39,28 +39,28 @@
     "directory": "plugins/adapters/github"
   },
   "dependencies": {
-    "@zhin.js/adapter": "1.1.26",
-    "@zhin.js/agent-feature": "1.1.11",
-    "@zhin.js/client": "1.1.22",
+    "@zhin.js/adapter": "1.1.27",
+    "@zhin.js/agent-feature": "1.1.12",
+    "@zhin.js/client": "1.1.23",
     "@zhin.js/console-contract": "1.1.3",
-    "@zhin.js/core": "1.1.54",
-    "@zhin.js/feature-kit": "1.1.10",
-    "@zhin.js/host-http": "1.1.12",
-    "@zhin.js/im-contract": "1.1.9",
+    "@zhin.js/core": "1.1.55",
+    "@zhin.js/feature-kit": "1.1.11",
+    "@zhin.js/host-http": "1.1.13",
+    "@zhin.js/im-contract": "1.1.10",
     "@zhin.js/logger": "1.1.2",
-    "@zhin.js/page": "1.1.11",
-    "@zhin.js/skill": "1.1.11",
-    "@zhin.js/tool": "1.1.13"
+    "@zhin.js/page": "1.1.13",
+    "@zhin.js/skill": "1.1.12",
+    "@zhin.js/tool": "1.1.14"
   },
   "peerDependencies": {
     "zod": "^4.0.0",
-    "@zhin.js/adapter": "^1.1.26",
-    "@zhin.js/agent": "^1.1.45",
-    "@zhin.js/command": "^1.1.12",
-    "@zhin.js/core": "^1.1.54",
-    "@zhin.js/host-http": "^1.1.12",
-    "@zhin.js/prompt-section": "^1.1.10",
-    "zhin.js": "^1.1.19"
+    "@zhin.js/adapter": "^1.1.27",
+    "@zhin.js/agent": "^1.1.46",
+    "@zhin.js/command": "^1.1.13",
+    "@zhin.js/core": "^1.1.55",
+    "@zhin.js/host-http": "^1.1.13",
+    "@zhin.js/prompt-section": "^1.1.11",
+    "zhin.js": "^1.1.20"
   },
   "peerDependenciesMeta": {
     "@zhin.js/agent": {
@@ -84,9 +84,9 @@
     "typescript": "^6.0.3",
     "vitest": "^4.1.10",
     "zod": "^4.4.3",
-    "@zhin.js/agent": "1.1.45",
-    "@zhin.js/prompt-section": "1.1.10",
-    "zhin.js": "1.1.19"
+    "@zhin.js/agent": "1.1.46",
+    "@zhin.js/prompt-section": "1.1.11",
+    "zhin.js": "1.1.20"
   },
   "files": [
     "adapters",
@@ -117,7 +117,7 @@
     "features": [
       {
         "package": "@zhin.js/adapter",
-        "api": "^2.0.0"
+        "api": "^2.1.0"
       },
       {
         "package": "@zhin.js/command",
@@ -125,7 +125,7 @@
       },
       {
         "package": "@zhin.js/tool",
-        "api": "^1.0.0"
+        "api": "^1.1.0"
       },
       {
         "package": "@zhin.js/skill",

package/schema.json

@@ -141,6 +141,27 @@
                 "description": "Command prefix for this endpoint."
               }
             }
+          },
+          "nickname": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "账号昵称兜底",
+            "x-i18n": {
+              "en": {
+                "description": "Fallback account nickname"
+              }
+            }
+          },
+          "profile": {
+            "$ref": "#/$defs/selfProfileFallback",
+            "description": "账号资料兜底",
+            "x-i18n": {
+              "en": {
+                "description": "Fallback account profile"
+              }
+            }
           }
         },
         "required": [
@@ -164,9 +185,93 @@
           "description": "Command prefix. The default empty string allows unprefixed commands; '/' requires a leading slash. Each endpoints[i] can override it."
         }
       }
+    },
+    "nickname": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "description": "账号昵称兜底",
+      "x-i18n": {
+        "en": {
+          "description": "Fallback account nickname"
+        }
+      }
+    },
+    "profile": {
+      "$ref": "#/$defs/selfProfileFallback",
+      "description": "账号资料兜底",
+      "x-i18n": {
+        "en": {
+          "description": "Fallback account profile"
+        }
+      }
     }
   },
   "required": [
     "endpoints"
-  ]
+  ],
+  "$defs": {
+    "selfProfileFallback": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "gender": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "enum": [
+            "male",
+            "female",
+            "other",
+            "unknown",
+            null
+          ]
+        },
+        "age": {
+          "type": [
+            "integer",
+            "null"
+          ],
+          "minimum": 0
+        },
+        "birthday": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"
+        },
+        "signature": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "avatar": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "pattern": "^(https?://[^\\s/?#]+(?:[/?#].*)?|)$"
+        },
+        "interests": {
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "type": "string"
+          }
+        },
+        "bio": {
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      }
+    }
+  }
 }

package/src/endpoint.ts

@@ -6,6 +6,7 @@ import type { HttpHost, HttpRouteRegistration } from '@zhin.js/host-http';
 import { formatCompact, getAdapterLogger } from '@zhin.js/logger';
 import type { CapabilityId, PluginDatabaseHost } from 'zhin.js';
 import { GhClient } from './gh-client.js';
+import { createGithubSelfProfile } from './self-profile.js';
 import {
   enrichInboundContent,
   formatInboundContent,
@@ -34,6 +35,7 @@ export class GithubEndpoint extends GhClient implements Endpoint {
   readonly [endpointSpec] = createEndpointSpecification(this, {
     start: signal => this.#startFramework(signal), open: () => this.#openFramework(), close: () => this.#closeFramework(),
     stop: () => this.#stopFramework(), send: request => this.#sendFramework(request),
+    profile: createGithubSelfProfile({ client: this, reportAccount: id => this[endpointSpec].reportSelfUserId(id) }),
   });
   #workspaceManager?: WorkspaceManager;
   get database() { return this.#options.database; }

package/src/protocol.ts

@@ -1,3 +1,4 @@
+import type { EndpointProfileConfiguration } from 'zhin.js/adapter';
 /**
  * GitHub webhook / comment helpers — no legacy Adapter/Endpoint / segment-mapper.
  * Canonicalization is owned by gateway/core before endpoint.send.
@@ -36,7 +37,7 @@ export type {
 export { buildChannelId, parseChannelId } from './types.js';
 
 /** One expanded GitHub endpoint configuration produced by AdapterIndex. */
-export interface GithubEndpointConfig {
+export interface GithubEndpointConfig extends EndpointProfileConfiguration {
   readonly id: string;
   readonly host?: string;
   readonly app_id: string | number;

package/src/self-profile.ts

@@ -0,0 +1,30 @@
+import { createEndpointOperation, type EndpointProfile } from 'zhin.js/adapter';
+import type { GhClient } from './gh-client.js';
+
+interface GithubSelfProfileOptions {
+  readonly client: Pick<GhClient, 'getBotIdentity' | 'request' | 'isAppAuth'>;
+  readonly reportAccount: (id: string) => void;
+}
+
+/** PAT accounts read /user; GitHub Apps read the verified app bot's public user profile. */
+export function createGithubSelfProfile({ client, reportAccount }: GithubSelfProfileOptions): EndpointProfile {
+  return Object.freeze<EndpointProfile>({
+    writableFields: Object.freeze([]),
+    async read({ signal }) {
+      const operation = createEndpointOperation({ signal });
+      const bot = await operation.prepare(() => client.getBotIdentity());
+      if (client.isAppAuth && !bot) throw new Error('GitHub App bot identity is unavailable');
+      const response = await client.request<{ id?: number; login?: string; name?: string | null; bio?: string | null; avatar_url?: string; message?: string }>({
+        method: 'GET', path: bot ? `/users/${encodeURIComponent(bot.login)}` : '/user', signal,
+      });
+      if (!response.ok) throw new Error(`GitHub self profile lookup failed (${response.status}): ${response.data?.message ?? 'API request failed'}`);
+      if (!response.data?.id || typeof response.data.login !== 'string') throw new Error('GitHub returned no account profile');
+      if (bot && response.data.id !== bot.userId) throw new Error('GitHub returned another account profile');
+      const user = response.data;
+      reportAccount(String(user.id));
+      return { nickname: user.name || user.login,
+        ...(user.bio === null || typeof user.bio === 'string' ? { bio: user.bio } : {}),
+        ...(typeof user.avatar_url === 'string' ? { avatar: user.avatar_url } : {}) };
+    },
+  });
+}