@copilotz/admin 0.3.6 → 0.3.8

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/dist/index.d.cts CHANGED
@@ -3,6 +3,12 @@ import React, { ReactNode } from 'react';
3
3
  type RequestHeadersProvider = () => Record<string, string> | Promise<Record<string, string>>;
4
4
  type AdminDatePreset = "24h" | "7d" | "30d";
5
5
  type AdminActivityInterval = "hour" | "day";
6
+ type AdminPage = "dashboard" | "threads" | "thread-detail" | "participants" | "participant-detail" | "agents" | "agent-detail" | "collection-items" | "collection-item-detail" | "events";
7
+ interface AdminRoute {
8
+ page: AdminPage;
9
+ resourceId?: string;
10
+ collection?: string;
11
+ }
6
12
  interface AdminOverview {
7
13
  threadTotals: {
8
14
  total: number;
@@ -84,6 +90,61 @@ interface AdminAgentSummary {
84
90
  totalTokens: number;
85
91
  lastActivityAt: string | null;
86
92
  }
93
+ interface AdminThreadDetail {
94
+ id: string;
95
+ name: string;
96
+ externalId: string | null;
97
+ description: string | null;
98
+ participants: string[] | null;
99
+ status: string;
100
+ summary: string | null;
101
+ mode: string | null;
102
+ metadata: Record<string, unknown> | null;
103
+ createdAt: string | null;
104
+ updatedAt: string | null;
105
+ }
106
+ interface AdminMessage {
107
+ id: string;
108
+ threadId: string;
109
+ senderUserId: string | null;
110
+ senderId: string | null;
111
+ senderType: "agent" | "user" | "system" | "tool";
112
+ targetId: string | null;
113
+ content: string | null;
114
+ toolCallId: string | null;
115
+ toolCalls: unknown[] | null;
116
+ reasoning: string | null;
117
+ metadata: Record<string, unknown> | null;
118
+ createdAt: string | null;
119
+ updatedAt: string | null;
120
+ }
121
+ interface AdminMessagePageInfo {
122
+ hasMoreBefore: boolean;
123
+ oldestMessageId: string | null;
124
+ newestMessageId: string | null;
125
+ }
126
+ interface AdminMessagePage {
127
+ data: AdminMessage[];
128
+ pageInfo: AdminMessagePageInfo;
129
+ }
130
+ type AdminParticipantDetail = Record<string, unknown>;
131
+ type AdminCollectionItem = Record<string, unknown> & {
132
+ id?: string;
133
+ };
134
+ interface AdminQueueEvent {
135
+ id: string;
136
+ threadId: string;
137
+ eventType: string;
138
+ payload: unknown;
139
+ parentEventId: string | null;
140
+ traceId: string | null;
141
+ priority: number | null;
142
+ status: "pending" | "processing" | "completed" | "failed" | "expired" | "overwritten";
143
+ namespace: string | null;
144
+ metadata: Record<string, unknown> | null;
145
+ createdAt: string | null;
146
+ updatedAt: string | null;
147
+ }
87
148
  interface AdminFilters {
88
149
  namespace?: string;
89
150
  range?: AdminDatePreset;
@@ -130,6 +191,10 @@ interface AdminConfig {
130
191
  configured?: string;
131
192
  unconfigured?: string;
132
193
  noResults?: string;
194
+ eventsTitle?: string;
195
+ dashboardTitle?: string;
196
+ collectionsTitle?: string;
197
+ collectionsEndpoint?: string;
133
198
  };
134
199
  features?: {
135
200
  showOverview?: boolean;
@@ -137,27 +202,38 @@ interface AdminConfig {
137
202
  showThreads?: boolean;
138
203
  showParticipants?: boolean;
139
204
  showAgents?: boolean;
205
+ showEvents?: boolean;
206
+ showCollections?: boolean;
140
207
  };
141
208
  ui?: {
142
209
  compact?: boolean;
143
210
  maxActivityBars?: number;
144
211
  };
212
+ sidebar?: {
213
+ defaultOpen?: boolean;
214
+ collapsible?: "icon" | "offcanvas" | "none";
215
+ };
145
216
  baseUrl?: string;
146
217
  getRequestHeaders?: RequestHeadersProvider;
147
218
  namespace?: string;
148
219
  initialRange?: AdminDatePreset;
149
220
  initialInterval?: AdminActivityInterval;
221
+ defaultPage?: AdminPage;
222
+ onNavigate?: (route: AdminRoute) => void;
150
223
  }
151
224
  interface ResolvedAdminConfig {
152
225
  branding: Required<NonNullable<AdminConfig["branding"]>>;
153
226
  labels: Required<NonNullable<AdminConfig["labels"]>>;
154
227
  features: Required<NonNullable<AdminConfig["features"]>>;
155
228
  ui: Required<NonNullable<AdminConfig["ui"]>>;
229
+ sidebar: Required<NonNullable<AdminConfig["sidebar"]>>;
156
230
  baseUrl: string;
157
231
  getRequestHeaders: RequestHeadersProvider;
158
232
  namespace: string;
159
233
  initialRange: AdminDatePreset;
160
234
  initialInterval: AdminActivityInterval;
235
+ defaultPage: AdminPage;
236
+ onNavigate: ((route: AdminRoute) => void) | null;
161
237
  }
162
238
  interface AdminSectionState {
163
239
  overview: AdminOverview | null;
@@ -187,28 +263,31 @@ declare const CopilotzAdmin: React.FC<CopilotzAdminProps>;
187
263
 
188
264
  declare function useCopilotzAdmin(options?: UseCopilotzAdminOptions): UseCopilotzAdminResult;
189
265
 
190
- declare function fetchAdminOverview(range: AdminDatePreset, namespace?: string, options?: {
191
- baseUrl?: string;
192
- getRequestHeaders?: RequestHeadersProvider;
193
- }): Promise<AdminOverview>;
194
- declare function fetchAdminActivity(range: AdminDatePreset, interval: AdminActivityInterval, namespace?: string, options?: {
195
- baseUrl?: string;
196
- getRequestHeaders?: RequestHeadersProvider;
197
- }): Promise<AdminActivityPoint[]>;
198
- declare function fetchAdminThreads(search?: string, namespace?: string, options?: {
199
- baseUrl?: string;
200
- getRequestHeaders?: RequestHeadersProvider;
201
- }): Promise<AdminThreadSummary[]>;
202
- declare function fetchAdminParticipants(search?: string, namespace?: string, options?: {
266
+ interface FetchOptions {
203
267
  baseUrl?: string;
204
268
  getRequestHeaders?: RequestHeadersProvider;
205
- }): Promise<AdminParticipantSummary[]>;
206
- declare function fetchAdminAgents(search?: string, namespace?: string, options?: {
207
- baseUrl?: string;
208
- getRequestHeaders?: RequestHeadersProvider;
209
- }): Promise<AdminAgentSummary[]>;
269
+ }
270
+ declare function fetchAdminOverview(range: AdminDatePreset, namespace?: string, options?: FetchOptions): Promise<AdminOverview>;
271
+ declare function fetchAdminActivity(range: AdminDatePreset, interval: AdminActivityInterval, namespace?: string, options?: FetchOptions): Promise<AdminActivityPoint[]>;
272
+ declare function fetchAdminThreads(search?: string, namespace?: string, options?: FetchOptions): Promise<AdminThreadSummary[]>;
273
+ declare function fetchAdminParticipants(search?: string, namespace?: string, options?: FetchOptions): Promise<AdminParticipantSummary[]>;
274
+ declare function fetchAdminAgents(search?: string, namespace?: string, options?: FetchOptions): Promise<AdminAgentSummary[]>;
275
+ declare function fetchParticipantDetail(participantId: string, options?: FetchOptions): Promise<AdminParticipantDetail | null>;
276
+ declare function updateParticipant(participantId: string, data: Record<string, unknown>, options?: FetchOptions): Promise<AdminParticipantDetail>;
277
+ declare function fetchCollectionNames(options?: FetchOptions): Promise<string[]>;
278
+ declare function fetchCollectionItems(collection: string, queryOptions?: {
279
+ search?: string;
280
+ namespace?: string;
281
+ limit?: number;
282
+ offset?: number;
283
+ }, options?: FetchOptions): Promise<AdminCollectionItem[]>;
284
+ declare function fetchCollectionItem(collection: string, itemId: string, namespace?: string, options?: FetchOptions): Promise<AdminCollectionItem>;
285
+ declare function createCollectionItem(collection: string, data: Record<string, unknown>, namespace?: string, options?: FetchOptions): Promise<AdminCollectionItem>;
286
+ declare function updateCollectionItem(collection: string, itemId: string, data: Record<string, unknown>, namespace?: string, options?: FetchOptions): Promise<AdminCollectionItem>;
287
+ declare function deleteCollectionItem(collection: string, itemId: string, namespace?: string, options?: FetchOptions): Promise<void>;
288
+ declare function fetchThreadEvents(threadId: string, options?: FetchOptions): Promise<AdminQueueEvent | undefined>;
210
289
 
211
290
  declare const defaultAdminConfig: ResolvedAdminConfig;
212
- declare function mergeAdminConfig(_baseConfig: AdminConfig, userConfig?: Partial<AdminConfig>): ResolvedAdminConfig;
291
+ declare function mergeAdminConfig(_baseConfig: ResolvedAdminConfig, userConfig?: Partial<AdminConfig>): ResolvedAdminConfig;
213
292
 
214
- export { type AdminActivityInterval, type AdminActivityPoint, type AdminAgentSummary, type AdminConfig, type AdminDatePreset, type AdminFilters, type AdminOverview, type AdminParticipantSummary, type AdminSectionState, type AdminThreadSummary, CopilotzAdmin, type RequestHeadersProvider, type UseCopilotzAdminOptions, type UseCopilotzAdminResult, defaultAdminConfig, fetchAdminActivity, fetchAdminAgents, fetchAdminOverview, fetchAdminParticipants, fetchAdminThreads, mergeAdminConfig, useCopilotzAdmin };
293
+ export { type AdminActivityInterval, type AdminActivityPoint, type AdminAgentSummary, type AdminCollectionItem, type AdminConfig, type AdminDatePreset, type AdminFilters, type AdminMessage, type AdminMessagePage, type AdminMessagePageInfo, type AdminOverview, type AdminPage, type AdminParticipantDetail, type AdminParticipantSummary, type AdminQueueEvent, type AdminRoute, type AdminSectionState, type AdminThreadDetail, type AdminThreadSummary, CopilotzAdmin, type RequestHeadersProvider, type UseCopilotzAdminOptions, type UseCopilotzAdminResult, createCollectionItem, defaultAdminConfig, deleteCollectionItem, fetchAdminActivity, fetchAdminAgents, fetchAdminOverview, fetchAdminParticipants, fetchAdminThreads, fetchCollectionItem, fetchCollectionItems, fetchCollectionNames, fetchParticipantDetail, fetchThreadEvents, mergeAdminConfig, updateCollectionItem, updateParticipant, useCopilotzAdmin };
package/dist/index.d.ts CHANGED
@@ -3,6 +3,12 @@ import React, { ReactNode } from 'react';
3
3
  type RequestHeadersProvider = () => Record<string, string> | Promise<Record<string, string>>;
4
4
  type AdminDatePreset = "24h" | "7d" | "30d";
5
5
  type AdminActivityInterval = "hour" | "day";
6
+ type AdminPage = "dashboard" | "threads" | "thread-detail" | "participants" | "participant-detail" | "agents" | "agent-detail" | "collection-items" | "collection-item-detail" | "events";
7
+ interface AdminRoute {
8
+ page: AdminPage;
9
+ resourceId?: string;
10
+ collection?: string;
11
+ }
6
12
  interface AdminOverview {
7
13
  threadTotals: {
8
14
  total: number;
@@ -84,6 +90,61 @@ interface AdminAgentSummary {
84
90
  totalTokens: number;
85
91
  lastActivityAt: string | null;
86
92
  }
93
+ interface AdminThreadDetail {
94
+ id: string;
95
+ name: string;
96
+ externalId: string | null;
97
+ description: string | null;
98
+ participants: string[] | null;
99
+ status: string;
100
+ summary: string | null;
101
+ mode: string | null;
102
+ metadata: Record<string, unknown> | null;
103
+ createdAt: string | null;
104
+ updatedAt: string | null;
105
+ }
106
+ interface AdminMessage {
107
+ id: string;
108
+ threadId: string;
109
+ senderUserId: string | null;
110
+ senderId: string | null;
111
+ senderType: "agent" | "user" | "system" | "tool";
112
+ targetId: string | null;
113
+ content: string | null;
114
+ toolCallId: string | null;
115
+ toolCalls: unknown[] | null;
116
+ reasoning: string | null;
117
+ metadata: Record<string, unknown> | null;
118
+ createdAt: string | null;
119
+ updatedAt: string | null;
120
+ }
121
+ interface AdminMessagePageInfo {
122
+ hasMoreBefore: boolean;
123
+ oldestMessageId: string | null;
124
+ newestMessageId: string | null;
125
+ }
126
+ interface AdminMessagePage {
127
+ data: AdminMessage[];
128
+ pageInfo: AdminMessagePageInfo;
129
+ }
130
+ type AdminParticipantDetail = Record<string, unknown>;
131
+ type AdminCollectionItem = Record<string, unknown> & {
132
+ id?: string;
133
+ };
134
+ interface AdminQueueEvent {
135
+ id: string;
136
+ threadId: string;
137
+ eventType: string;
138
+ payload: unknown;
139
+ parentEventId: string | null;
140
+ traceId: string | null;
141
+ priority: number | null;
142
+ status: "pending" | "processing" | "completed" | "failed" | "expired" | "overwritten";
143
+ namespace: string | null;
144
+ metadata: Record<string, unknown> | null;
145
+ createdAt: string | null;
146
+ updatedAt: string | null;
147
+ }
87
148
  interface AdminFilters {
88
149
  namespace?: string;
89
150
  range?: AdminDatePreset;
@@ -130,6 +191,10 @@ interface AdminConfig {
130
191
  configured?: string;
131
192
  unconfigured?: string;
132
193
  noResults?: string;
194
+ eventsTitle?: string;
195
+ dashboardTitle?: string;
196
+ collectionsTitle?: string;
197
+ collectionsEndpoint?: string;
133
198
  };
134
199
  features?: {
135
200
  showOverview?: boolean;
@@ -137,27 +202,38 @@ interface AdminConfig {
137
202
  showThreads?: boolean;
138
203
  showParticipants?: boolean;
139
204
  showAgents?: boolean;
205
+ showEvents?: boolean;
206
+ showCollections?: boolean;
140
207
  };
141
208
  ui?: {
142
209
  compact?: boolean;
143
210
  maxActivityBars?: number;
144
211
  };
212
+ sidebar?: {
213
+ defaultOpen?: boolean;
214
+ collapsible?: "icon" | "offcanvas" | "none";
215
+ };
145
216
  baseUrl?: string;
146
217
  getRequestHeaders?: RequestHeadersProvider;
147
218
  namespace?: string;
148
219
  initialRange?: AdminDatePreset;
149
220
  initialInterval?: AdminActivityInterval;
221
+ defaultPage?: AdminPage;
222
+ onNavigate?: (route: AdminRoute) => void;
150
223
  }
151
224
  interface ResolvedAdminConfig {
152
225
  branding: Required<NonNullable<AdminConfig["branding"]>>;
153
226
  labels: Required<NonNullable<AdminConfig["labels"]>>;
154
227
  features: Required<NonNullable<AdminConfig["features"]>>;
155
228
  ui: Required<NonNullable<AdminConfig["ui"]>>;
229
+ sidebar: Required<NonNullable<AdminConfig["sidebar"]>>;
156
230
  baseUrl: string;
157
231
  getRequestHeaders: RequestHeadersProvider;
158
232
  namespace: string;
159
233
  initialRange: AdminDatePreset;
160
234
  initialInterval: AdminActivityInterval;
235
+ defaultPage: AdminPage;
236
+ onNavigate: ((route: AdminRoute) => void) | null;
161
237
  }
162
238
  interface AdminSectionState {
163
239
  overview: AdminOverview | null;
@@ -187,28 +263,31 @@ declare const CopilotzAdmin: React.FC<CopilotzAdminProps>;
187
263
 
188
264
  declare function useCopilotzAdmin(options?: UseCopilotzAdminOptions): UseCopilotzAdminResult;
189
265
 
190
- declare function fetchAdminOverview(range: AdminDatePreset, namespace?: string, options?: {
191
- baseUrl?: string;
192
- getRequestHeaders?: RequestHeadersProvider;
193
- }): Promise<AdminOverview>;
194
- declare function fetchAdminActivity(range: AdminDatePreset, interval: AdminActivityInterval, namespace?: string, options?: {
195
- baseUrl?: string;
196
- getRequestHeaders?: RequestHeadersProvider;
197
- }): Promise<AdminActivityPoint[]>;
198
- declare function fetchAdminThreads(search?: string, namespace?: string, options?: {
199
- baseUrl?: string;
200
- getRequestHeaders?: RequestHeadersProvider;
201
- }): Promise<AdminThreadSummary[]>;
202
- declare function fetchAdminParticipants(search?: string, namespace?: string, options?: {
266
+ interface FetchOptions {
203
267
  baseUrl?: string;
204
268
  getRequestHeaders?: RequestHeadersProvider;
205
- }): Promise<AdminParticipantSummary[]>;
206
- declare function fetchAdminAgents(search?: string, namespace?: string, options?: {
207
- baseUrl?: string;
208
- getRequestHeaders?: RequestHeadersProvider;
209
- }): Promise<AdminAgentSummary[]>;
269
+ }
270
+ declare function fetchAdminOverview(range: AdminDatePreset, namespace?: string, options?: FetchOptions): Promise<AdminOverview>;
271
+ declare function fetchAdminActivity(range: AdminDatePreset, interval: AdminActivityInterval, namespace?: string, options?: FetchOptions): Promise<AdminActivityPoint[]>;
272
+ declare function fetchAdminThreads(search?: string, namespace?: string, options?: FetchOptions): Promise<AdminThreadSummary[]>;
273
+ declare function fetchAdminParticipants(search?: string, namespace?: string, options?: FetchOptions): Promise<AdminParticipantSummary[]>;
274
+ declare function fetchAdminAgents(search?: string, namespace?: string, options?: FetchOptions): Promise<AdminAgentSummary[]>;
275
+ declare function fetchParticipantDetail(participantId: string, options?: FetchOptions): Promise<AdminParticipantDetail | null>;
276
+ declare function updateParticipant(participantId: string, data: Record<string, unknown>, options?: FetchOptions): Promise<AdminParticipantDetail>;
277
+ declare function fetchCollectionNames(options?: FetchOptions): Promise<string[]>;
278
+ declare function fetchCollectionItems(collection: string, queryOptions?: {
279
+ search?: string;
280
+ namespace?: string;
281
+ limit?: number;
282
+ offset?: number;
283
+ }, options?: FetchOptions): Promise<AdminCollectionItem[]>;
284
+ declare function fetchCollectionItem(collection: string, itemId: string, namespace?: string, options?: FetchOptions): Promise<AdminCollectionItem>;
285
+ declare function createCollectionItem(collection: string, data: Record<string, unknown>, namespace?: string, options?: FetchOptions): Promise<AdminCollectionItem>;
286
+ declare function updateCollectionItem(collection: string, itemId: string, data: Record<string, unknown>, namespace?: string, options?: FetchOptions): Promise<AdminCollectionItem>;
287
+ declare function deleteCollectionItem(collection: string, itemId: string, namespace?: string, options?: FetchOptions): Promise<void>;
288
+ declare function fetchThreadEvents(threadId: string, options?: FetchOptions): Promise<AdminQueueEvent | undefined>;
210
289
 
211
290
  declare const defaultAdminConfig: ResolvedAdminConfig;
212
- declare function mergeAdminConfig(_baseConfig: AdminConfig, userConfig?: Partial<AdminConfig>): ResolvedAdminConfig;
291
+ declare function mergeAdminConfig(_baseConfig: ResolvedAdminConfig, userConfig?: Partial<AdminConfig>): ResolvedAdminConfig;
213
292
 
214
- export { type AdminActivityInterval, type AdminActivityPoint, type AdminAgentSummary, type AdminConfig, type AdminDatePreset, type AdminFilters, type AdminOverview, type AdminParticipantSummary, type AdminSectionState, type AdminThreadSummary, CopilotzAdmin, type RequestHeadersProvider, type UseCopilotzAdminOptions, type UseCopilotzAdminResult, defaultAdminConfig, fetchAdminActivity, fetchAdminAgents, fetchAdminOverview, fetchAdminParticipants, fetchAdminThreads, mergeAdminConfig, useCopilotzAdmin };
293
+ export { type AdminActivityInterval, type AdminActivityPoint, type AdminAgentSummary, type AdminCollectionItem, type AdminConfig, type AdminDatePreset, type AdminFilters, type AdminMessage, type AdminMessagePage, type AdminMessagePageInfo, type AdminOverview, type AdminPage, type AdminParticipantDetail, type AdminParticipantSummary, type AdminQueueEvent, type AdminRoute, type AdminSectionState, type AdminThreadDetail, type AdminThreadSummary, CopilotzAdmin, type RequestHeadersProvider, type UseCopilotzAdminOptions, type UseCopilotzAdminResult, createCollectionItem, defaultAdminConfig, deleteCollectionItem, fetchAdminActivity, fetchAdminAgents, fetchAdminOverview, fetchAdminParticipants, fetchAdminThreads, fetchCollectionItem, fetchCollectionItems, fetchCollectionNames, fetchParticipantDetail, fetchThreadEvents, mergeAdminConfig, updateCollectionItem, updateParticipant, useCopilotzAdmin };