@ai-monitor/types 1.0.0

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.
Files changed (6) hide show
  1. package/README.md +33 -0
  2. package/dist/index.d.ts +224 -0
  3. package/dist/index.d.ts.map +1 -0
  4. package/dist/index.js +7 -0
  5. package/dist/index.js.map +1 -0
  6. package/package.json +27 -0
package/README.md ADDED
@@ -0,0 +1,33 @@
1
+ # @ai-monitor/types
2
+
3
+ Canonical TypeScript type definitions shared by `@ai-monitor/bridge` and `ai-monitor-relay`.
4
+
5
+ ## Contents
6
+
7
+ - **BridgeEvent** — Unified event envelope (v1.0) for all AI tool observations
8
+ - **RPC Frame Types** — `ReqFrame`, `ResFrame`, `EventFrame` for WebSocket gateway protocol
9
+ - **Connect Handshake** — `ConnectParams`, `HelloOkPayload` for gateway authentication
10
+ - **SessionSummary** — In-memory session metadata exposed via `sessions.list` RPC
11
+ - **GatewayConfigBase** — Shared gateway configuration interface
12
+
13
+ ## Protocol Version
14
+
15
+ Current protocol version: **3** (exported as `PROTOCOL_VERSION`).
16
+
17
+ ## iOS Alignment
18
+
19
+ The Swift types in `MyAIPartner/Core/Networking/OpenClawProtocol.swift` mirror these definitions.
20
+ When updating types here, ensure the Swift side is updated to match (see version anchor comment in that file).
21
+
22
+ ## Usage
23
+
24
+ ```typescript
25
+ import type { BridgeEvent, ReqFrame, ResFrame, EventFrame } from "@ai-monitor/types";
26
+ import { PROTOCOL_VERSION } from "@ai-monitor/types";
27
+ ```
28
+
29
+ ## Build
30
+
31
+ ```bash
32
+ npm run build # tsc → dist/
33
+ ```
package/dist/index.d.ts ADDED
@@ -0,0 +1,224 @@
1
+ /** Supported protocol version for gateway ↔ client handshake */
2
+ export declare const PROTOCOL_VERSION = 3;
3
+ export type BuiltinToolName = "claude-code" | "gemini" | "codex" | "cursor" | "openclaw";
4
+ /** Known built-in tools plus any custom plugin tool name. */
5
+ export type ToolName = BuiltinToolName | (string & {});
6
+ export type EventType = "session.start" | "session.chunk" | "session.end" | "session.import";
7
+ export interface ReqFrame {
8
+ type: "req";
9
+ id: string;
10
+ method: string;
11
+ params?: unknown;
12
+ }
13
+ export interface ResponseError {
14
+ code: string;
15
+ message: string;
16
+ retryable?: boolean;
17
+ retryAfterMs?: number;
18
+ details?: unknown;
19
+ }
20
+ export interface ResFrame {
21
+ type: "res";
22
+ id: string;
23
+ ok: boolean;
24
+ payload?: unknown;
25
+ error?: ResponseError;
26
+ }
27
+ export interface EventFrame {
28
+ type: "event";
29
+ event: string;
30
+ payload?: unknown;
31
+ seq?: number;
32
+ }
33
+ export interface ConnectParams {
34
+ minProtocol?: number;
35
+ maxProtocol?: number;
36
+ client?: {
37
+ id: string;
38
+ displayName?: string;
39
+ version?: string;
40
+ platform?: string;
41
+ mode?: string;
42
+ instanceId?: string;
43
+ };
44
+ role?: string;
45
+ scopes?: string[];
46
+ caps?: string[];
47
+ auth?: {
48
+ token?: string;
49
+ deviceToken?: string;
50
+ };
51
+ device?: {
52
+ id: string;
53
+ publicKey?: string;
54
+ signature?: string;
55
+ /** Epoch milliseconds (OpenClaw expects Type.Integer({ minimum: 0 })) */
56
+ signedAt?: number;
57
+ nonce?: string;
58
+ };
59
+ /** Commands the client supports (e.g. OpenClaw tool commands) */
60
+ commands?: string[];
61
+ /** Permissions the client requests/declares */
62
+ permissions?: Record<string, boolean>;
63
+ }
64
+ export interface HelloOkPayload {
65
+ type: "hello-ok";
66
+ protocol: number;
67
+ policy?: {
68
+ tickIntervalMs?: number;
69
+ };
70
+ auth?: {
71
+ role?: string;
72
+ scopes?: string[];
73
+ deviceToken?: string;
74
+ };
75
+ }
76
+ export interface SessionSummary {
77
+ key: string;
78
+ kind: "direct" | "group" | "global" | "unknown";
79
+ tool: ToolName;
80
+ sessionId: string;
81
+ displayName: string;
82
+ derivedTitle?: string;
83
+ lastMessagePreview?: string;
84
+ updatedAt: number;
85
+ model?: string;
86
+ inputTokens?: number;
87
+ outputTokens?: number;
88
+ upstreamKey?: string;
89
+ }
90
+ export interface GatewaySessionRow extends SessionSummary {
91
+ totalTokens?: number;
92
+ canSendMessage?: boolean;
93
+ systemSent?: boolean;
94
+ abortedLastRun?: boolean;
95
+ thinkingLevel?: string;
96
+ }
97
+ export type ChatContent = string | ContentBlock[];
98
+ export interface ContentBlock {
99
+ type: "text" | "thinking" | "tool_use" | "tool_result" | "image";
100
+ text?: string;
101
+ thinking?: string;
102
+ toolCallId?: string;
103
+ toolName?: string;
104
+ mimeType?: string;
105
+ fileName?: string;
106
+ }
107
+ export interface ChatUsage {
108
+ input?: number;
109
+ output?: number;
110
+ total?: number;
111
+ }
112
+ export interface ChatMessage {
113
+ role: "user" | "assistant" | "system" | "tool" | "unknown";
114
+ content: ChatContent;
115
+ timestamp?: number;
116
+ model?: string;
117
+ usage?: ChatUsage;
118
+ toolCallId?: string;
119
+ toolName?: string;
120
+ stopReason?: string;
121
+ }
122
+ export interface SessionsListParams {
123
+ limit?: number;
124
+ offset?: number;
125
+ activeMinutes?: number;
126
+ search?: string;
127
+ label?: string;
128
+ tool?: string;
129
+ includeDerivedTitles?: boolean;
130
+ includeLastMessage?: boolean;
131
+ includeGlobal?: boolean;
132
+ includeUnknown?: boolean;
133
+ agentId?: string;
134
+ }
135
+ export interface SessionsListResponse {
136
+ ts: number;
137
+ count: number;
138
+ sessions: GatewaySessionRow[];
139
+ }
140
+ export interface ChatHistoryParams {
141
+ sessionKey: string;
142
+ limit?: number;
143
+ }
144
+ export interface ChatHistoryResponse {
145
+ sessionKey: string;
146
+ sessionId: string;
147
+ messages: ChatMessage[];
148
+ model?: string;
149
+ thinkingLevel?: string;
150
+ }
151
+ export interface ChatAttachment {
152
+ type: string;
153
+ mimeType: string;
154
+ fileName: string;
155
+ content: string;
156
+ }
157
+ export interface ChatSendParams {
158
+ sessionKey: string;
159
+ message: string;
160
+ idempotencyKey?: string;
161
+ thinking?: string;
162
+ timeoutMs?: number;
163
+ attachments?: ChatAttachment[];
164
+ }
165
+ export interface ChatSendResult {
166
+ ok: boolean;
167
+ runId?: string;
168
+ status?: string;
169
+ }
170
+ export interface ChatAbortParams {
171
+ sessionKey: string;
172
+ runId: string;
173
+ }
174
+ export interface GatewayConfigBase {
175
+ port: number;
176
+ auth: "none" | "token" | "device-token";
177
+ token?: string;
178
+ allowedOrigins?: string[];
179
+ }
180
+ export interface BridgeEvent {
181
+ version: "1.0";
182
+ eventId: string;
183
+ sessionId: string;
184
+ eventType: EventType;
185
+ tool: ToolName;
186
+ timestamp: string;
187
+ host: {
188
+ hostnameHash: string;
189
+ os: string;
190
+ arch: string;
191
+ };
192
+ context: {
193
+ cwd: string;
194
+ projectId?: string;
195
+ };
196
+ payload: {
197
+ command?: string;
198
+ chunk?: string;
199
+ seq?: number;
200
+ exitCode?: number;
201
+ durationMs?: number;
202
+ tokens?: {
203
+ input?: number;
204
+ output?: number;
205
+ };
206
+ role?: "user" | "assistant" | "system" | "tool" | "unknown";
207
+ /** Original role string when it was remapped by the whitelist filter (debug only) */
208
+ rawRole?: string;
209
+ /** Display name shown in iOS session list */
210
+ displayName?: string;
211
+ /** AI-derived title for the session */
212
+ derivedTitle?: string;
213
+ /** Model used in the session (e.g. "claude-sonnet-4-6") */
214
+ model?: string;
215
+ lastMessagePreview?: string;
216
+ /** Original upstream session key (e.g. OpenClaw session.key) for proxying RPCs */
217
+ upstreamKey?: string;
218
+ };
219
+ privacy: {
220
+ redacted: boolean;
221
+ rulesVersion: string;
222
+ };
223
+ }
224
+ //# sourceMappingURL=index.d.ts.map
package/dist/index.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,gEAAgE;AAChE,eAAO,MAAM,gBAAgB,IAAI,CAAC;AAElC,MAAM,MAAM,eAAe,GACvB,aAAa,GACb,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,UAAU,CAAC;AAEf,6DAA6D;AAC7D,MAAM,MAAM,QAAQ,GAAG,eAAe,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAEvD,MAAM,MAAM,SAAS,GACjB,eAAe,GACf,eAAe,GACf,aAAa,GACb,gBAAgB,CAAC;AAMrB,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,KAAK,CAAC;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,KAAK,CAAC;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,OAAO,CAAC;IACZ,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAMD,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE;QACP,EAAE,EAAE,MAAM,CAAC;QACX,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAChD,MAAM,CAAC,EAAE;QACP,EAAE,EAAE,MAAM,CAAC;QACX,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,yEAAyE;QACzE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,iEAAiE;IACjE,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACrC,IAAI,CAAC,EAAE;QACL,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAMD,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;IAChD,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAMD,MAAM,WAAW,iBAAkB,SAAQ,cAAc;IACvD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAMD,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,YAAY,EAAE,CAAC;AAElD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,aAAa,GAAG,OAAO,CAAC;IACjE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;IAC3D,OAAO,EAAE,WAAW,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAMD,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,cAAc,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,OAAO,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACf;AAMD,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,cAAc,CAAC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,KAAK,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,SAAS,CAAC;IACrB,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE;QACJ,YAAY,EAAE,MAAM,CAAC;QACrB,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,OAAO,EAAE;QACP,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,OAAO,EAAE;QACP,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE;YAAE,KAAK,CAAC,EAAE,MAAM,CAAC;YAAC,MAAM,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;QAC7C,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;QAC5D,qFAAqF;QACrF,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,6CAA6C;QAC7C,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,uCAAuC;QACvC,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,2DAA2D;QAC3D,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,kFAAkF;QAClF,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,OAAO,EAAE;QACP,QAAQ,EAAE,OAAO,CAAC;QAClB,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;CACH"}
package/dist/index.js ADDED
@@ -0,0 +1,7 @@
1
+ // ─────────────────────────────────────────────────────────────
2
+ // Unified Event Protocol (BridgeEvent v1.0)
3
+ // Canonical type definitions shared by bridge and relay.
4
+ // ─────────────────────────────────────────────────────────────
5
+ /** Supported protocol version for gateway ↔ client handshake */
6
+ export const PROTOCOL_VERSION = 3;
7
+ //# sourceMappingURL=index.js.map
package/dist/index.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,gEAAgE;AAChE,4CAA4C;AAC5C,yDAAyD;AACzD,gEAAgE;AAEhE,gEAAgE;AAChE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC"}
package/package.json ADDED
@@ -0,0 +1,27 @@
1
+ {
2
+ "name": "@ai-monitor/types",
3
+ "version": "1.0.0",
4
+ "private": false,
5
+ "type": "module",
6
+ "main": "dist/index.js",
7
+ "types": "dist/index.d.ts",
8
+ "exports": {
9
+ ".": {
10
+ "types": "./dist/index.d.ts",
11
+ "import": "./dist/index.js"
12
+ }
13
+ },
14
+ "files": [
15
+ "dist",
16
+ "README.md"
17
+ ],
18
+ "publishConfig": {
19
+ "access": "public"
20
+ },
21
+ "scripts": {
22
+ "build": "tsc"
23
+ },
24
+ "devDependencies": {
25
+ "typescript": "^5.7.3"
26
+ }
27
+ }