@zhin.js/contract 1.1.22 → 1.1.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,18 @@
1
1
  # @zhin.js/contract
2
2
 
3
- Remote Console 与 PageManager 的**共享契约**:Console Entry 形状、`PluginRegisterHostApi`、`ConsoleClientEntry`、`ConsoleEntriesResponse`、路径常量等。无运行时逻辑,供 `@zhin.js/pagemanager`、`@zhin.js/client` 与插件 `client/` 共用。
3
+ Remote Console **浏览器侧共享类型与常量**,供 `@zhin.js/client`、`@zhin.js/pagemanager` 与 zhin-console 共用。除常量外无运行时逻辑。
4
+
5
+ | 导出 | 说明 |
6
+ |------|------|
7
+ | `PluginRegisterHostApi`、`ConsolePluginRegister` | 入口模块 `register(api)` 收到的宿主 API:`React`、`addRoute`、`addTool`,以及可选的 `removeRoute` / `removeTool`(供入口重载时移除已消失入口的注册) |
8
+ | `PluginAddRouteInput`、`PluginAddToolInput` | `addRoute` / `addTool` 的入参 |
9
+ | `ConsoleClientEntry`、`ConsoleEntriesResponse`、`ConsoleEntry` | `GET /entries` 的返回形状 |
10
+ | `DEFAULT_CONSOLE_BASE_PATH`、`CONSOLE_HOST_REACT_NAMESPACE_KEY`、`CONSOLE_SHARED_MODULES_KEY` | 路径与宿主共享模块的全局键 |
11
+ | `SIDE_EVENT_PUSH`、`SIDE_EVENT_RPC`、`INBOX_RPC`、`ENDPOINT_RPC`、`SIDE_EVENT_NAMES` | 兼容性再导出;wire 协议的唯一来源是 `@zhin.js/console-protocol` |
12
+
13
+ 页面元数据(`definePage`、`definePageBlueprint`)不在本包,请从 `@zhin.js/console-contract`(或 `@zhin.js/page` / `zhin.js/page`)导入。
14
+
15
+ `react` 是可选 peer:仅类型声明引用 `ReactNode`。
4
16
 
5
17
  领域术语与关系图见 **[../pagemanager/CONTEXT.md](../pagemanager/CONTEXT.md)**。
6
18
 
package/lib/index.d.ts CHANGED
@@ -1,18 +1,7 @@
1
1
  export { DEFAULT_CONSOLE_BASE_PATH, CONSOLE_HOST_REACT_NAMESPACE_KEY, CONSOLE_SHARED_MODULES_KEY, SIDE_EVENT_PUSH, SIDE_EVENT_RPC, INBOX_RPC, ENDPOINT_RPC, SIDE_EVENT_NAMES, } from "./constants.js";
2
- export { ZHIN_SESSION_ID_HEADER, AGENT_STREAM_MEDIA_TYPE, ZHIN_AGENT_SESSION_API_PREFIX, AgentStreamEventType, formatAgentStreamNdjsonLine, createAgentStreamReduceState, reduceAgentStreamEvent, createAgentStreamNdjsonParserState, parseAgentStreamNdjsonChunk, flushAgentStreamNdjsonParser, iterateAgentStreamNdjson, foldAgentStreamNdjson, } from "./agent-stream.js";
3
- export type { AgentStreamEvent, AgentStreamEventTypeName, StartAgentSessionResponse, ContinueAgentSessionBody, ContinueAgentSessionResponse, AgentStreamReduceState, AgentStreamNdjsonParserState, FoldAgentStreamOptions, } from "./agent-stream.js";
2
+ import type { ConsolePageSection } from "@zhin.js/console-protocol";
3
+ export type { ConsolePageSection } from "@zhin.js/console-protocol";
4
4
  export type RuntimeEnv = "development" | "production";
5
- export type ConsoleUser = {
6
- id: string;
7
- name: string;
8
- roles?: string[];
9
- permissions: string[];
10
- };
11
- export type ConsoleAuthContext = unknown;
12
- export type ConsoleAuthAdapter = {
13
- getUser(ctx: ConsoleAuthContext): Promise<ConsoleUser | null> | ConsoleUser | null;
14
- hasPermission(user: ConsoleUser, permission: string): boolean;
15
- };
16
5
  export type EntryModuleSpec = string | {
17
6
  dev: string;
18
7
  prod?: string;
@@ -38,20 +27,6 @@ export type ConsoleEntry = {
38
27
  };
39
28
  requiredPermissions?: string[];
40
29
  };
41
- export type ConsoleFileAddEntryInput = {
42
- id?: string;
43
- development: string;
44
- production: string;
45
- serverDevelopment?: string;
46
- serverProduction?: string;
47
- order?: number;
48
- enabled?: boolean;
49
- meta?: {
50
- name?: string;
51
- version?: string;
52
- };
53
- requiredPermissions?: string[];
54
- };
55
30
  export type ConsoleClientEntry = Omit<ConsoleEntry, "serverPaths"> & {
56
31
  resolvedModule: string;
57
32
  };
@@ -67,6 +42,8 @@ export type PluginAddRouteInput = {
67
42
  order?: number;
68
43
  group?: string;
69
44
  fullWidth?: boolean;
45
+ /** Console navigation section the Page declared (ADR 0052). */
46
+ section?: ConsolePageSection;
70
47
  };
71
48
  requiredPermissions?: string[];
72
49
  requiredRoles?: string[];
@@ -82,34 +59,13 @@ export type PluginRegisterHostApi = {
82
59
  React: typeof import("react");
83
60
  addRoute(input: PluginAddRouteInput): void;
84
61
  addTool(input: PluginAddToolInput): string;
62
+ /** Optional: lets the entry loader drop what a removed plugin entry registered. */
63
+ removeRoute?(path: string): void;
64
+ removeTool?(id: string): void;
85
65
  };
86
66
  export type ConsolePluginRegister = (api: PluginRegisterHostApi) => void | Promise<void>;
87
67
  export type ConsoleEntriesResponse = {
88
68
  entries: ConsoleClientEntry[];
89
69
  runtimeEnvHint: RuntimeEnv | null;
90
70
  };
91
- export type PageTitleI18n = Readonly<Partial<Record<'zh-CN' | 'en', string>>>;
92
- export interface PageComponentProps {
93
- pluginId?: string;
94
- owner?: string;
95
- localName?: string;
96
- route?: string;
97
- title?: string;
98
- [key: string]: unknown;
99
- }
100
- export interface PageMetadata {
101
- readonly title?: string;
102
- readonly titleI18n?: PageTitleI18n;
103
- readonly icon?: string;
104
- readonly group?: string;
105
- readonly order?: number;
106
- readonly parent?: string;
107
- readonly fullWidth?: boolean;
108
- readonly hideInNav?: boolean;
109
- readonly requiredPermissions?: readonly string[];
110
- readonly requiredRoles?: readonly string[];
111
- }
112
- export type DefinedPage = Readonly<PageMetadata>;
113
- export type PageExport<P = PageComponentProps> = import("react").ComponentType<P>;
114
- export declare function definePage(metadata?: PageMetadata): DefinedPage;
115
71
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,gCAAgC,EAChC,0BAA0B,EAC1B,eAAe,EACf,cAAc,EACd,SAAS,EACT,YAAY,EACZ,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACvB,6BAA6B,EAC7B,oBAAoB,EACpB,2BAA2B,EAC3B,4BAA4B,EAC5B,sBAAsB,EACtB,kCAAkC,EAClC,2BAA2B,EAC3B,4BAA4B,EAC5B,wBAAwB,EACxB,qBAAqB,GACtB,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EACV,gBAAgB,EAChB,wBAAwB,EACxB,yBAAyB,EACzB,wBAAwB,EACxB,4BAA4B,EAC5B,sBAAsB,EACtB,4BAA4B,EAC5B,sBAAsB,GACvB,MAAM,mBAAmB,CAAC;AAE3B,MAAM,MAAM,UAAU,GAAG,aAAa,GAAG,YAAY,CAAC;AAEtD,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC;AAEzC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,CAAC,GAAG,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,WAAW,GAAG,IAAI,CAAC;IACnF,aAAa,CAAC,IAAI,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;CAC/D,CAAC;AAEF,MAAM,MAAM,eAAe,GACvB,MAAM,GACN;IACE,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEN,MAAM,MAAM,iBAAiB,GAAG;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,WAAW,CAAC,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1D,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3C,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3C,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,EAAE,aAAa,CAAC,GAAG;IACnE,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,OAAO,EAAE,SAAS,CAAC;IACnC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,CAAC,EAAE,OAAO,OAAO,EAAE,SAAS,GAAG,MAAM,CAAC;IAC1C,IAAI,CAAC,EAAE;QACL,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,SAAS,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QAC9D,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB,CAAC;IACF,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,OAAO,OAAO,EAAE,SAAS,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,EAAE,cAAc,OAAO,CAAC,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAC3C,OAAO,CAAC,KAAK,EAAE,kBAAkB,GAAG,MAAM,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAEzF,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC9B,cAAc,EAAE,UAAU,GAAG,IAAI,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;AAE9E,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,CAAC,EAAE,aAAa,CAAC;IACnC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,mBAAmB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACjD,QAAQ,CAAC,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC5C;AAED,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC;AAEjD,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,kBAAkB,IAAI,OAAO,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;AAElF,wBAAgB,UAAU,CAAC,QAAQ,GAAE,YAAiB,GAAG,WAAW,CAEnE"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,gCAAgC,EAChC,0BAA0B,EAC1B,eAAe,EACf,cAAc,EACd,SAAS,EACT,YAAY,EACZ,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACpE,YAAY,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,MAAM,MAAM,UAAU,GAAG,aAAa,GAAG,YAAY,CAAC;AAEtD,MAAM,MAAM,eAAe,GACvB,MAAM,GACN;IACE,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEN,MAAM,MAAM,iBAAiB,GAAG;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,WAAW,CAAC,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1D,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3C,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,EAAE,aAAa,CAAC,GAAG;IACnE,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,OAAO,EAAE,SAAS,CAAC;IACnC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,CAAC,EAAE,OAAO,OAAO,EAAE,SAAS,GAAG,MAAM,CAAC;IAC1C,IAAI,CAAC,EAAE;QACL,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,SAAS,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QAC9D,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,+DAA+D;QAC/D,OAAO,CAAC,EAAE,kBAAkB,CAAC;KAC9B,CAAC;IACF,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,OAAO,OAAO,EAAE,SAAS,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,EAAE,cAAc,OAAO,CAAC,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAC3C,OAAO,CAAC,KAAK,EAAE,kBAAkB,GAAG,MAAM,CAAC;IAC3C,mFAAmF;IACnF,WAAW,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,UAAU,CAAC,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAEzF,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC9B,cAAc,EAAE,UAAU,GAAG,IAAI,CAAC;CACnC,CAAC"}
package/lib/index.js CHANGED
@@ -1,6 +1,2 @@
1
1
  export { DEFAULT_CONSOLE_BASE_PATH, CONSOLE_HOST_REACT_NAMESPACE_KEY, CONSOLE_SHARED_MODULES_KEY, SIDE_EVENT_PUSH, SIDE_EVENT_RPC, INBOX_RPC, ENDPOINT_RPC, SIDE_EVENT_NAMES, } from "./constants.js";
2
- export { ZHIN_SESSION_ID_HEADER, AGENT_STREAM_MEDIA_TYPE, ZHIN_AGENT_SESSION_API_PREFIX, AgentStreamEventType, formatAgentStreamNdjsonLine, createAgentStreamReduceState, reduceAgentStreamEvent, createAgentStreamNdjsonParserState, parseAgentStreamNdjsonChunk, flushAgentStreamNdjsonParser, iterateAgentStreamNdjson, foldAgentStreamNdjson, } from "./agent-stream.js";
3
- export function definePage(metadata = {}) {
4
- return Object.freeze({ ...metadata });
5
- }
6
2
  //# sourceMappingURL=index.js.map
package/lib/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,gCAAgC,EAChC,0BAA0B,EAC1B,eAAe,EACf,cAAc,EACd,SAAS,EACT,YAAY,EACZ,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACvB,6BAA6B,EAC7B,oBAAoB,EACpB,2BAA2B,EAC3B,4BAA4B,EAC5B,sBAAsB,EACtB,kCAAkC,EAClC,2BAA2B,EAC3B,4BAA4B,EAC5B,wBAAwB,EACxB,qBAAqB,GACtB,MAAM,mBAAmB,CAAC;AAsI3B,MAAM,UAAU,UAAU,CAAC,WAAyB,EAAE;IACpD,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,QAAQ,EAAE,CAAC,CAAC;AACxC,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,gCAAgC,EAChC,0BAA0B,EAC1B,eAAe,EACf,cAAc,EACd,SAAS,EACT,YAAY,EACZ,gBAAgB,GACjB,MAAM,gBAAgB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zhin.js/contract",
3
- "version": "1.1.22",
3
+ "version": "1.1.24",
4
4
  "description": "Zhin console / PageManager shared contract (entries, PluginRegisterHostApi)",
5
5
  "type": "module",
6
6
  "exports": {
@@ -14,12 +14,19 @@
14
14
  "src"
15
15
  ],
16
16
  "dependencies": {
17
- "@zhin.js/ai": "1.1.54",
18
- "@zhin.js/console-protocol": "1.1.14"
17
+ "@zhin.js/console-protocol": "1.2.1"
18
+ },
19
+ "peerDependencies": {
20
+ "react": ">=18"
21
+ },
22
+ "peerDependenciesMeta": {
23
+ "react": {
24
+ "optional": true
25
+ }
19
26
  },
20
27
  "devDependencies": {
21
28
  "@types/react": "^19.2.18",
22
- "rimraf": "^6.1.3",
29
+ "rimraf": "^6.1.4",
23
30
  "typescript": "^6.0.3"
24
31
  },
25
32
  "license": "MIT",
package/src/index.ts CHANGED
@@ -8,48 +8,11 @@ export {
8
8
  ENDPOINT_RPC,
9
9
  SIDE_EVENT_NAMES,
10
10
  } from "./constants.js";
11
-
12
- export {
13
- ZHIN_SESSION_ID_HEADER,
14
- AGENT_STREAM_MEDIA_TYPE,
15
- ZHIN_AGENT_SESSION_API_PREFIX,
16
- AgentStreamEventType,
17
- formatAgentStreamNdjsonLine,
18
- createAgentStreamReduceState,
19
- reduceAgentStreamEvent,
20
- createAgentStreamNdjsonParserState,
21
- parseAgentStreamNdjsonChunk,
22
- flushAgentStreamNdjsonParser,
23
- iterateAgentStreamNdjson,
24
- foldAgentStreamNdjson,
25
- } from "./agent-stream.js";
26
- export type {
27
- AgentStreamEvent,
28
- AgentStreamEventTypeName,
29
- StartAgentSessionResponse,
30
- ContinueAgentSessionBody,
31
- ContinueAgentSessionResponse,
32
- AgentStreamReduceState,
33
- AgentStreamNdjsonParserState,
34
- FoldAgentStreamOptions,
35
- } from "./agent-stream.js";
11
+ import type { ConsolePageSection } from "@zhin.js/console-protocol";
12
+ export type { ConsolePageSection } from "@zhin.js/console-protocol";
36
13
 
37
14
  export type RuntimeEnv = "development" | "production";
38
15
 
39
- export type ConsoleUser = {
40
- id: string;
41
- name: string;
42
- roles?: string[];
43
- permissions: string[];
44
- };
45
-
46
- export type ConsoleAuthContext = unknown;
47
-
48
- export type ConsoleAuthAdapter = {
49
- getUser(ctx: ConsoleAuthContext): Promise<ConsoleUser | null> | ConsoleUser | null;
50
- hasPermission(user: ConsoleUser, permission: string): boolean;
51
- };
52
-
53
16
  export type EntryModuleSpec =
54
17
  | string
55
18
  | {
@@ -74,18 +37,6 @@ export type ConsoleEntry = {
74
37
  requiredPermissions?: string[];
75
38
  };
76
39
 
77
- export type ConsoleFileAddEntryInput = {
78
- id?: string;
79
- development: string;
80
- production: string;
81
- serverDevelopment?: string;
82
- serverProduction?: string;
83
- order?: number;
84
- enabled?: boolean;
85
- meta?: { name?: string; version?: string };
86
- requiredPermissions?: string[];
87
- };
88
-
89
40
  export type ConsoleClientEntry = Omit<ConsoleEntry, "serverPaths"> & {
90
41
  resolvedModule: string;
91
42
  };
@@ -102,6 +53,8 @@ export type PluginAddRouteInput = {
102
53
  order?: number;
103
54
  group?: string;
104
55
  fullWidth?: boolean;
56
+ /** Console navigation section the Page declared (ADR 0052). */
57
+ section?: ConsolePageSection;
105
58
  };
106
59
  requiredPermissions?: string[];
107
60
  requiredRoles?: string[];
@@ -119,6 +72,9 @@ export type PluginRegisterHostApi = {
119
72
  React: typeof import("react");
120
73
  addRoute(input: PluginAddRouteInput): void;
121
74
  addTool(input: PluginAddToolInput): string;
75
+ /** Optional: lets the entry loader drop what a removed plugin entry registered. */
76
+ removeRoute?(path: string): void;
77
+ removeTool?(id: string): void;
122
78
  };
123
79
 
124
80
  export type ConsolePluginRegister = (api: PluginRegisterHostApi) => void | Promise<void>;
@@ -127,35 +83,3 @@ export type ConsoleEntriesResponse = {
127
83
  entries: ConsoleClientEntry[];
128
84
  runtimeEnvHint: RuntimeEnv | null;
129
85
  };
130
-
131
- export type PageTitleI18n = Readonly<Partial<Record<'zh-CN' | 'en', string>>>;
132
-
133
- export interface PageComponentProps {
134
- pluginId?: string;
135
- owner?: string;
136
- localName?: string;
137
- route?: string;
138
- title?: string;
139
- [key: string]: unknown;
140
- }
141
-
142
- export interface PageMetadata {
143
- readonly title?: string;
144
- readonly titleI18n?: PageTitleI18n;
145
- readonly icon?: string;
146
- readonly group?: string;
147
- readonly order?: number;
148
- readonly parent?: string;
149
- readonly fullWidth?: boolean;
150
- readonly hideInNav?: boolean;
151
- readonly requiredPermissions?: readonly string[];
152
- readonly requiredRoles?: readonly string[];
153
- }
154
-
155
- export type DefinedPage = Readonly<PageMetadata>;
156
-
157
- export type PageExport<P = PageComponentProps> = import("react").ComponentType<P>;
158
-
159
- export function definePage(metadata: PageMetadata = {}): DefinedPage {
160
- return Object.freeze({ ...metadata });
161
- }
@@ -1,8 +0,0 @@
1
- /**
2
- * Re-export agent stream wire format from @zhin.js/ai (SSOT for ADR 0039 P0).
3
- */
4
- export { ZHIN_SESSION_ID_HEADER, AGENT_STREAM_MEDIA_TYPE, ZHIN_AGENT_SESSION_API_PREFIX, AgentStreamEventType, formatAgentStreamNdjsonLine, createAgentStreamReduceState, reduceAgentStreamEvent, } from "@zhin.js/ai/agent-stream";
5
- export { createAgentStreamNdjsonParserState, parseAgentStreamNdjsonChunk, flushAgentStreamNdjsonParser, iterateAgentStreamNdjson, foldAgentStreamNdjson, } from "@zhin.js/ai/agent-stream-consumer";
6
- export type { AgentStreamEvent, AgentStreamEventTypeName, StartAgentSessionResponse, ContinueAgentSessionBody, ContinueAgentSessionResponse, AgentStreamReduceState, AgentStreamPendingInput, AgentStreamPendingAuthorization, } from "@zhin.js/ai/agent-stream";
7
- export type { AgentStreamNdjsonParserState, FoldAgentStreamOptions, } from "@zhin.js/ai/agent-stream-consumer";
8
- //# sourceMappingURL=agent-stream.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"agent-stream.d.ts","sourceRoot":"","sources":["../src/agent-stream.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACvB,6BAA6B,EAC7B,oBAAoB,EACpB,2BAA2B,EAC3B,4BAA4B,EAC5B,sBAAsB,GACvB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,kCAAkC,EAClC,2BAA2B,EAC3B,4BAA4B,EAC5B,wBAAwB,EACxB,qBAAqB,GACtB,MAAM,mCAAmC,CAAC;AAC3C,YAAY,EACV,gBAAgB,EAChB,wBAAwB,EACxB,yBAAyB,EACzB,wBAAwB,EACxB,4BAA4B,EAC5B,sBAAsB,EACtB,uBAAuB,EACvB,+BAA+B,GAChC,MAAM,0BAA0B,CAAC;AAClC,YAAY,EACV,4BAA4B,EAC5B,sBAAsB,GACvB,MAAM,mCAAmC,CAAC"}
@@ -1,6 +0,0 @@
1
- /**
2
- * Re-export agent stream wire format from @zhin.js/ai (SSOT for ADR 0039 P0).
3
- */
4
- export { ZHIN_SESSION_ID_HEADER, AGENT_STREAM_MEDIA_TYPE, ZHIN_AGENT_SESSION_API_PREFIX, AgentStreamEventType, formatAgentStreamNdjsonLine, createAgentStreamReduceState, reduceAgentStreamEvent, } from "@zhin.js/ai/agent-stream";
5
- export { createAgentStreamNdjsonParserState, parseAgentStreamNdjsonChunk, flushAgentStreamNdjsonParser, iterateAgentStreamNdjson, foldAgentStreamNdjson, } from "@zhin.js/ai/agent-stream-consumer";
6
- //# sourceMappingURL=agent-stream.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"agent-stream.js","sourceRoot":"","sources":["../src/agent-stream.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACvB,6BAA6B,EAC7B,oBAAoB,EACpB,2BAA2B,EAC3B,4BAA4B,EAC5B,sBAAsB,GACvB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,kCAAkC,EAClC,2BAA2B,EAC3B,4BAA4B,EAC5B,wBAAwB,EACxB,qBAAqB,GACtB,MAAM,mCAAmC,CAAC"}
@@ -1,33 +0,0 @@
1
- /**
2
- * Re-export agent stream wire format from @zhin.js/ai (SSOT for ADR 0039 P0).
3
- */
4
- export {
5
- ZHIN_SESSION_ID_HEADER,
6
- AGENT_STREAM_MEDIA_TYPE,
7
- ZHIN_AGENT_SESSION_API_PREFIX,
8
- AgentStreamEventType,
9
- formatAgentStreamNdjsonLine,
10
- createAgentStreamReduceState,
11
- reduceAgentStreamEvent,
12
- } from "@zhin.js/ai/agent-stream";
13
- export {
14
- createAgentStreamNdjsonParserState,
15
- parseAgentStreamNdjsonChunk,
16
- flushAgentStreamNdjsonParser,
17
- iterateAgentStreamNdjson,
18
- foldAgentStreamNdjson,
19
- } from "@zhin.js/ai/agent-stream-consumer";
20
- export type {
21
- AgentStreamEvent,
22
- AgentStreamEventTypeName,
23
- StartAgentSessionResponse,
24
- ContinueAgentSessionBody,
25
- ContinueAgentSessionResponse,
26
- AgentStreamReduceState,
27
- AgentStreamPendingInput,
28
- AgentStreamPendingAuthorization,
29
- } from "@zhin.js/ai/agent-stream";
30
- export type {
31
- AgentStreamNdjsonParserState,
32
- FoldAgentStreamOptions,
33
- } from "@zhin.js/ai/agent-stream-consumer";