-
Notifications
You must be signed in to change notification settings - Fork 39
Expand file tree
/
Copy pathports.ts
More file actions
289 lines (264 loc) · 8.97 KB
/
ports.ts
File metadata and controls
289 lines (264 loc) · 8.97 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
/**
* Storage Port Interfaces
*
* These interfaces define the contracts for storage adapters.
* Following the Ports & Adapters (Hexagonal Architecture) pattern.
*/
import type { ConnectionEntity } from "../tools/connection/schema";
import type {
VirtualMCPEntity,
VirtualMCPCreateData,
VirtualMCPUpdateData,
} from "../tools/virtual/schema";
import type {
MonitoringLog,
OrganizationSettings,
OrganizationTag,
Project,
ProjectConnection,
ProjectPluginConfig,
ProjectUI,
Thread,
ThreadMessage,
} from "./types";
export interface ThreadStoragePort {
create(data: Partial<Thread>): Promise<Thread>;
get(id: string): Promise<Thread | null>;
update(id: string, data: Partial<Thread>): Promise<Thread>;
/**
* Atomically transitions a thread to "failed" only when its current
* persisted status is "in_progress". Safe to call concurrently — the
* conditional WHERE clause prevents clobbering a terminal status.
*
* Returns true if the row was updated, false if it was already in a
* terminal state (no-op).
*/
forceFailIfInProgress(id: string): Promise<boolean>;
delete(id: string): Promise<void>;
list(
organizationId: string,
createdBy?: string,
options?: { limit?: number; offset?: number },
): Promise<{ threads: Thread[]; total: number }>;
// Message operations - upserts by id (updates existing rows)
saveMessages(data: ThreadMessage[]): Promise<void>;
listMessages(
threadId: string,
options?: {
limit?: number;
offset?: number;
sort?: "asc" | "desc";
},
): Promise<{ messages: ThreadMessage[]; total: number }>;
}
// ============================================================================
// Project Storage Ports
// ============================================================================
export interface ProjectStoragePort {
list(organizationId: string): Promise<Project[]>;
get(projectId: string): Promise<Project | null>;
getBySlug(organizationId: string, slug: string): Promise<Project | null>;
create(data: {
organizationId: string;
slug: string;
name: string;
description?: string | null;
enabledPlugins?: string[] | null;
ui?: ProjectUI | null;
}): Promise<Project>;
update(
projectId: string,
data: Partial<{
name: string;
description: string | null;
enabledPlugins: string[] | null;
ui: ProjectUI | null;
}>,
): Promise<Project | null>;
delete(projectId: string): Promise<boolean>;
}
export interface ProjectConnectionStoragePort {
list(projectId: string): Promise<ProjectConnection[]>;
add(projectId: string, connectionId: string): Promise<ProjectConnection>;
remove(projectId: string, connectionId: string): Promise<boolean>;
}
export interface ProjectPluginConfigStoragePort {
list(projectId: string): Promise<ProjectPluginConfig[]>;
get(projectId: string, pluginId: string): Promise<ProjectPluginConfig | null>;
upsert(
projectId: string,
pluginId: string,
data: {
connectionId?: string | null;
settings?: Record<string, unknown> | null;
},
): Promise<ProjectPluginConfig>;
delete(projectId: string, pluginId: string): Promise<boolean>;
}
// ============================================================================
// Connection Storage Port
// ============================================================================
export interface ConnectionStoragePort {
create(data: Partial<ConnectionEntity>): Promise<ConnectionEntity>;
findById(id: string): Promise<ConnectionEntity | null>;
list(
organizationId: string,
options?: { includeVirtual?: boolean },
): Promise<ConnectionEntity[]>;
update(
id: string,
data: Partial<ConnectionEntity>,
): Promise<ConnectionEntity>;
delete(id: string): Promise<void>;
testConnection(
id: string,
headers?: Record<string, string>,
): Promise<{ healthy: boolean; latencyMs: number }>;
}
// ============================================================================
// Organization Settings Storage Port
// ============================================================================
export interface OrganizationSettingsStoragePort {
get(organizationId: string): Promise<OrganizationSettings | null>;
upsert(
organizationId: string,
data?: Partial<
Pick<OrganizationSettings, "sidebar_items" | "enabled_plugins">
>,
): Promise<OrganizationSettings>;
}
// ============================================================================
// Monitoring Storage Interface
// ============================================================================
/**
* Property filter options for querying monitoring logs
*/
export interface PropertyFilters {
/** Exact match: filter logs where property key equals value */
properties?: Record<string, string>;
/** Exists: filter logs that have these property keys */
propertyKeys?: string[];
/** Pattern match: filter logs where property value matches pattern (SQL LIKE) */
propertyPatterns?: Record<string, string>;
/** In match: filter logs where property value (comma-separated) contains the specified value */
propertyInValues?: Record<string, string>;
}
export interface MonitoringStorage {
log(event: MonitoringLog): Promise<void>;
logBatch(events: MonitoringLog[]): Promise<void>;
query(filters: {
organizationId?: string;
connectionId?: string;
excludeConnectionIds?: string[];
virtualMcpId?: string;
toolName?: string;
isError?: boolean;
startDate?: Date;
endDate?: Date;
limit?: number;
offset?: number;
propertyFilters?: PropertyFilters;
}): Promise<{ logs: MonitoringLog[]; total: number }>;
getStats(filters: {
organizationId: string;
startDate?: Date;
endDate?: Date;
}): Promise<{
totalCalls: number;
errorRate: number;
avgDurationMs: number;
}>;
getLastUsedByVirtualMcpIds(
organizationId: string,
virtualMcpIds: string[],
): Promise<Record<string, string>>;
}
// ============================================================================
// Virtual MCP Storage Port
// ============================================================================
// Re-export types from schema for convenience
export type {
VirtualMCPEntity,
VirtualMCPCreateData,
VirtualMCPUpdateData,
} from "../tools/virtual/schema";
import type {
VirtualToolEntity,
VirtualToolCreateData,
VirtualToolUpdateData,
} from "../tools/virtual-tool/schema";
// Re-export virtual tool types
export type { VirtualToolEntity, VirtualToolCreateData, VirtualToolUpdateData };
export interface VirtualMCPStoragePort {
create(
organizationId: string,
userId: string,
data: VirtualMCPCreateData,
): Promise<VirtualMCPEntity>;
findById(
id: string,
organizationId?: string,
): Promise<VirtualMCPEntity | null>;
list(organizationId: string): Promise<VirtualMCPEntity[]>;
listByConnectionId(
organizationId: string,
connectionId: string,
): Promise<VirtualMCPEntity[]>;
update(
id: string,
userId: string,
data: VirtualMCPUpdateData,
): Promise<VirtualMCPEntity>;
delete(id: string): Promise<void>;
removeConnectionReferences(connectionId: string): Promise<void>;
// Virtual Tool CRUD methods
listVirtualTools(virtualMcpId: string): Promise<VirtualToolEntity[]>;
getVirtualTool(
virtualMcpId: string,
toolName: string,
): Promise<VirtualToolEntity | null>;
createVirtualTool(
virtualMcpId: string,
data: VirtualToolCreateData,
connectionDependencies: string[],
): Promise<VirtualToolEntity>;
updateVirtualTool(
virtualMcpId: string,
toolName: string,
data: VirtualToolUpdateData,
connectionDependencies?: string[],
): Promise<VirtualToolEntity>;
deleteVirtualTool(virtualMcpId: string, toolName: string): Promise<void>;
// Indirect dependency management
syncIndirectDependencies(
virtualMcpId: string,
connectionIds: string[],
): Promise<void>;
}
// ============================================================================
// Tag Storage Port
// ============================================================================
export interface TagStoragePort {
// Organization tags
listOrgTags(organizationId: string): Promise<OrganizationTag[]>;
getTag(tagId: string): Promise<OrganizationTag | null>;
getTagByName(
organizationId: string,
name: string,
): Promise<OrganizationTag | null>;
createTag(organizationId: string, name: string): Promise<OrganizationTag>;
deleteTag(tagId: string): Promise<void>;
// Member tags
getMemberTags(memberId: string): Promise<OrganizationTag[]>;
setMemberTags(memberId: string, tagIds: string[]): Promise<void>;
addMemberTag(memberId: string, tagId: string): Promise<void>;
removeMemberTag(memberId: string, tagId: string): Promise<void>;
// Member verification
verifyMemberOrg(memberId: string, organizationId: string): Promise<boolean>;
// Bulk operations for monitoring
getUserTagsInOrg(
userId: string,
organizationId: string,
): Promise<OrganizationTag[]>;
getMembersWithTags(organizationId: string): Promise<Map<string, string[]>>;
}