@copilotz/admin 0.9.36 → 0.9.38

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
@@ -6,8 +6,9 @@ type RequestHeadersProvider = () => Record<string, string> | Promise<Record<stri
6
6
  type AdminDatePreset = "24h" | "7d" | "30d";
7
7
  type AdminActivityInterval = "hour" | "day";
8
8
  type AdminUsageInterval = "minute" | "hour" | "day" | "week" | "month";
9
- type AdminUsageMetricKind = "tokens" | "cost" | "calls";
10
- type AdminUsageGroupBy = "thread" | "participant" | "namespace" | "provider" | "model";
9
+ type AdminUsageKind = "all" | "llm" | "tool" | "asset" | "rag" | "embedding" | (string & {});
10
+ type AdminUsageMetricKind = "tokens" | "cost" | "calls" | "duration" | "credits" | "failures" | "unpriced";
11
+ type AdminUsageGroupBy = "kind" | "resource" | "operation" | "status" | "thread" | "participant" | "namespace" | "provider" | "model";
11
12
  type AdminUsageAttribution = "generatedBy" | "initiatedBy";
12
13
  type AdminUsageDimension = "total" | "input" | "output" | "reasoning" | "cacheRead" | "cacheWrite";
13
14
  interface AdminUsageBreakdown {
@@ -26,6 +27,10 @@ interface AdminUsageBreakdown {
26
27
  }
27
28
  interface AdminUsageTotals extends AdminUsageBreakdown {
28
29
  totalCalls: number;
30
+ failedCalls: number;
31
+ unpricedCalls: number;
32
+ totalDurationMs: number;
33
+ totalCredits: number;
29
34
  }
30
35
  interface AdminOverview {
31
36
  threadTotals: {
@@ -111,12 +116,26 @@ interface AdminUsageFilters {
111
116
  metric?: AdminUsageMetricKind;
112
117
  groupBy?: AdminUsageGroupBy;
113
118
  attribution?: AdminUsageAttribution;
119
+ kind?: AdminUsageKind;
114
120
  threadId?: string;
115
121
  participantId?: string;
116
122
  participantType?: "all" | "human" | "agent" | "job";
117
123
  namespace?: string;
118
124
  provider?: string;
119
125
  model?: string;
126
+ resource?: string;
127
+ operation?: string;
128
+ status?: string;
129
+ }
130
+ interface AdminEventFilters {
131
+ namespace?: string;
132
+ threadId?: string;
133
+ status?: string;
134
+ eventType?: string;
135
+ traceId?: string;
136
+ search?: string;
137
+ limit?: number;
138
+ offset?: number;
120
139
  }
121
140
  interface AdminThreadDetail {
122
141
  id: string;
@@ -227,6 +246,7 @@ interface CopilotzAdminClient {
227
246
  limit?: number;
228
247
  before?: string;
229
248
  }): Promise<AdminMessagePage>;
249
+ listEvents(options?: AdminEventFilters): Promise<AdminQueueEvent[]>;
230
250
  getThreadEvent(threadId: string): Promise<AdminQueueEvent | undefined>;
231
251
  listCollections(): Promise<string[]>;
232
252
  listCollectionItems(collection: string, options?: AdminListOptions): Promise<AdminCollectionItem[]>;
@@ -415,7 +435,8 @@ declare function getUsageRange(period: "24h" | "7d" | "30d" | "custom", customFr
415
435
  to: string | undefined;
416
436
  };
417
437
  declare function getUsageDimensionLabel(dimension: AdminUsageDimension): "Input" | "Output" | "Reasoning" | "Cache read" | "Cache write" | "Total";
418
- declare function getUsageGroupLabel(groupBy: string): "Thread" | "Namespace" | "Provider" | "Model" | "Participant";
438
+ declare function getUsageGroupLabel(groupBy: string): "Kind" | "Resource" | "Operation" | "Status" | "Thread" | "Namespace" | "Provider" | "Model" | "Participant";
439
+ declare function getUsageMetricLabel(metricKind: AdminUsageMetricKind): "Spend" | "Tokens" | "Duration" | "Credits" | "Failures" | "Unpriced" | "Calls";
419
440
  declare function formatUsageBucket(bucket: string, interval: AdminUsageInterval): string;
420
441
  declare function formatNumber(value: number): string;
421
442
  declare function formatPercent(value: number): string;
@@ -523,4 +544,4 @@ declare function StatusBadge({ status }: {
523
544
  status?: string | null;
524
545
  }): react_jsx_runtime.JSX.Element;
525
546
 
526
- export { ADMIN_GROUP_LABELS, ADMIN_GROUP_ORDER, type AdminActivityInterval, type AdminActivityPoint, type AdminAgentSummary, type AdminBranding, type AdminClientConfig, type AdminClientOptions, type AdminClientPaths, type AdminCollectionItem, type AdminCollectionPage, type AdminDatePreset, type AdminDetailPanel, type AdminMessage, type AdminMessagePage, type AdminMessagePageInfo, type AdminModule, type AdminModuleGroup, type AdminNavItem, type AdminOverview, type AdminParticipantDetail, type AdminParticipantSummary, type AdminPermissions, type AdminQueueEvent, type AdminRouteDefinition, type AdminRouteState, type AdminRuntimeContext, type AdminScope, type AdminThreadDetail, type AdminThreadSummary, type AdminUsageAttribution, type AdminUsageBreakdown, type AdminUsageDimension, type AdminUsageFilters, type AdminUsageGroupBy, type AdminUsageInterval, type AdminUsageMetricKind, type AdminUsagePoint, type AdminUsageResponse, type AdminUsageTotals, type AggregatedUsageRow, type CollectionEditor, type CollectionEditorProps, CopilotzAdmin, type CopilotzAdminClient, type CopilotzAdminProps, EMPTY_USAGE_TOTALS, EmptyState, FilterBar, InspectorPanel, JsonPanel, type LegacyAdminConfig, MetricStrip, type MetricStripItem, PageHeader, type RequestHeadersProvider, ResourceTable, type ResourceTableColumn, StatusBadge, type UsageCalculationOptions, type UsageChartSeries, type UsageChartState, type UseCopilotzAdminOptions, type UseCopilotzAdminResult, addUsageTotals, agentsModule, aggregateUsageRows, buildUsageChartState, canAccessAdminPermission, collectAdminNavItems, collectAdminRoutes, collectCollectionEditors, collectionsModule, createAdminClient, defaultAdminConfig, defaultCopilotzModules, eventsModule, firstAccessibleRoute, formatCompactMetric, formatMetricValue, formatNumber, formatPercent, formatUsageBucket, getUsageDimensionLabel, getUsageGroupLabel, getUsageRange, getUsageTotalValue, mergeAdminConfig, overviewModule, participantsModule, threadsModule, usageModule, useAdmin, useCopilotzAdmin };
547
+ export { ADMIN_GROUP_LABELS, ADMIN_GROUP_ORDER, type AdminActivityInterval, type AdminActivityPoint, type AdminAgentSummary, type AdminBranding, type AdminClientConfig, type AdminClientOptions, type AdminClientPaths, type AdminCollectionItem, type AdminCollectionPage, type AdminDatePreset, type AdminDetailPanel, type AdminEventFilters, type AdminMessage, type AdminMessagePage, type AdminMessagePageInfo, type AdminModule, type AdminModuleGroup, type AdminNavItem, type AdminOverview, type AdminParticipantDetail, type AdminParticipantSummary, type AdminPermissions, type AdminQueueEvent, type AdminRouteDefinition, type AdminRouteState, type AdminRuntimeContext, type AdminScope, type AdminThreadDetail, type AdminThreadSummary, type AdminUsageAttribution, type AdminUsageBreakdown, type AdminUsageDimension, type AdminUsageFilters, type AdminUsageGroupBy, type AdminUsageInterval, type AdminUsageKind, type AdminUsageMetricKind, type AdminUsagePoint, type AdminUsageResponse, type AdminUsageTotals, type AggregatedUsageRow, type CollectionEditor, type CollectionEditorProps, CopilotzAdmin, type CopilotzAdminClient, type CopilotzAdminProps, EMPTY_USAGE_TOTALS, EmptyState, FilterBar, InspectorPanel, JsonPanel, type LegacyAdminConfig, MetricStrip, type MetricStripItem, PageHeader, type RequestHeadersProvider, ResourceTable, type ResourceTableColumn, StatusBadge, type UsageCalculationOptions, type UsageChartSeries, type UsageChartState, type UseCopilotzAdminOptions, type UseCopilotzAdminResult, addUsageTotals, agentsModule, aggregateUsageRows, buildUsageChartState, canAccessAdminPermission, collectAdminNavItems, collectAdminRoutes, collectCollectionEditors, collectionsModule, createAdminClient, defaultAdminConfig, defaultCopilotzModules, eventsModule, firstAccessibleRoute, formatCompactMetric, formatMetricValue, formatNumber, formatPercent, formatUsageBucket, getUsageDimensionLabel, getUsageGroupLabel, getUsageMetricLabel, getUsageRange, getUsageTotalValue, mergeAdminConfig, overviewModule, participantsModule, threadsModule, usageModule, useAdmin, useCopilotzAdmin };
package/dist/index.d.ts CHANGED
@@ -6,8 +6,9 @@ type RequestHeadersProvider = () => Record<string, string> | Promise<Record<stri
6
6
  type AdminDatePreset = "24h" | "7d" | "30d";
7
7
  type AdminActivityInterval = "hour" | "day";
8
8
  type AdminUsageInterval = "minute" | "hour" | "day" | "week" | "month";
9
- type AdminUsageMetricKind = "tokens" | "cost" | "calls";
10
- type AdminUsageGroupBy = "thread" | "participant" | "namespace" | "provider" | "model";
9
+ type AdminUsageKind = "all" | "llm" | "tool" | "asset" | "rag" | "embedding" | (string & {});
10
+ type AdminUsageMetricKind = "tokens" | "cost" | "calls" | "duration" | "credits" | "failures" | "unpriced";
11
+ type AdminUsageGroupBy = "kind" | "resource" | "operation" | "status" | "thread" | "participant" | "namespace" | "provider" | "model";
11
12
  type AdminUsageAttribution = "generatedBy" | "initiatedBy";
12
13
  type AdminUsageDimension = "total" | "input" | "output" | "reasoning" | "cacheRead" | "cacheWrite";
13
14
  interface AdminUsageBreakdown {
@@ -26,6 +27,10 @@ interface AdminUsageBreakdown {
26
27
  }
27
28
  interface AdminUsageTotals extends AdminUsageBreakdown {
28
29
  totalCalls: number;
30
+ failedCalls: number;
31
+ unpricedCalls: number;
32
+ totalDurationMs: number;
33
+ totalCredits: number;
29
34
  }
30
35
  interface AdminOverview {
31
36
  threadTotals: {
@@ -111,12 +116,26 @@ interface AdminUsageFilters {
111
116
  metric?: AdminUsageMetricKind;
112
117
  groupBy?: AdminUsageGroupBy;
113
118
  attribution?: AdminUsageAttribution;
119
+ kind?: AdminUsageKind;
114
120
  threadId?: string;
115
121
  participantId?: string;
116
122
  participantType?: "all" | "human" | "agent" | "job";
117
123
  namespace?: string;
118
124
  provider?: string;
119
125
  model?: string;
126
+ resource?: string;
127
+ operation?: string;
128
+ status?: string;
129
+ }
130
+ interface AdminEventFilters {
131
+ namespace?: string;
132
+ threadId?: string;
133
+ status?: string;
134
+ eventType?: string;
135
+ traceId?: string;
136
+ search?: string;
137
+ limit?: number;
138
+ offset?: number;
120
139
  }
121
140
  interface AdminThreadDetail {
122
141
  id: string;
@@ -227,6 +246,7 @@ interface CopilotzAdminClient {
227
246
  limit?: number;
228
247
  before?: string;
229
248
  }): Promise<AdminMessagePage>;
249
+ listEvents(options?: AdminEventFilters): Promise<AdminQueueEvent[]>;
230
250
  getThreadEvent(threadId: string): Promise<AdminQueueEvent | undefined>;
231
251
  listCollections(): Promise<string[]>;
232
252
  listCollectionItems(collection: string, options?: AdminListOptions): Promise<AdminCollectionItem[]>;
@@ -415,7 +435,8 @@ declare function getUsageRange(period: "24h" | "7d" | "30d" | "custom", customFr
415
435
  to: string | undefined;
416
436
  };
417
437
  declare function getUsageDimensionLabel(dimension: AdminUsageDimension): "Input" | "Output" | "Reasoning" | "Cache read" | "Cache write" | "Total";
418
- declare function getUsageGroupLabel(groupBy: string): "Thread" | "Namespace" | "Provider" | "Model" | "Participant";
438
+ declare function getUsageGroupLabel(groupBy: string): "Kind" | "Resource" | "Operation" | "Status" | "Thread" | "Namespace" | "Provider" | "Model" | "Participant";
439
+ declare function getUsageMetricLabel(metricKind: AdminUsageMetricKind): "Spend" | "Tokens" | "Duration" | "Credits" | "Failures" | "Unpriced" | "Calls";
419
440
  declare function formatUsageBucket(bucket: string, interval: AdminUsageInterval): string;
420
441
  declare function formatNumber(value: number): string;
421
442
  declare function formatPercent(value: number): string;
@@ -523,4 +544,4 @@ declare function StatusBadge({ status }: {
523
544
  status?: string | null;
524
545
  }): react_jsx_runtime.JSX.Element;
525
546
 
526
- export { ADMIN_GROUP_LABELS, ADMIN_GROUP_ORDER, type AdminActivityInterval, type AdminActivityPoint, type AdminAgentSummary, type AdminBranding, type AdminClientConfig, type AdminClientOptions, type AdminClientPaths, type AdminCollectionItem, type AdminCollectionPage, type AdminDatePreset, type AdminDetailPanel, type AdminMessage, type AdminMessagePage, type AdminMessagePageInfo, type AdminModule, type AdminModuleGroup, type AdminNavItem, type AdminOverview, type AdminParticipantDetail, type AdminParticipantSummary, type AdminPermissions, type AdminQueueEvent, type AdminRouteDefinition, type AdminRouteState, type AdminRuntimeContext, type AdminScope, type AdminThreadDetail, type AdminThreadSummary, type AdminUsageAttribution, type AdminUsageBreakdown, type AdminUsageDimension, type AdminUsageFilters, type AdminUsageGroupBy, type AdminUsageInterval, type AdminUsageMetricKind, type AdminUsagePoint, type AdminUsageResponse, type AdminUsageTotals, type AggregatedUsageRow, type CollectionEditor, type CollectionEditorProps, CopilotzAdmin, type CopilotzAdminClient, type CopilotzAdminProps, EMPTY_USAGE_TOTALS, EmptyState, FilterBar, InspectorPanel, JsonPanel, type LegacyAdminConfig, MetricStrip, type MetricStripItem, PageHeader, type RequestHeadersProvider, ResourceTable, type ResourceTableColumn, StatusBadge, type UsageCalculationOptions, type UsageChartSeries, type UsageChartState, type UseCopilotzAdminOptions, type UseCopilotzAdminResult, addUsageTotals, agentsModule, aggregateUsageRows, buildUsageChartState, canAccessAdminPermission, collectAdminNavItems, collectAdminRoutes, collectCollectionEditors, collectionsModule, createAdminClient, defaultAdminConfig, defaultCopilotzModules, eventsModule, firstAccessibleRoute, formatCompactMetric, formatMetricValue, formatNumber, formatPercent, formatUsageBucket, getUsageDimensionLabel, getUsageGroupLabel, getUsageRange, getUsageTotalValue, mergeAdminConfig, overviewModule, participantsModule, threadsModule, usageModule, useAdmin, useCopilotzAdmin };
547
+ export { ADMIN_GROUP_LABELS, ADMIN_GROUP_ORDER, type AdminActivityInterval, type AdminActivityPoint, type AdminAgentSummary, type AdminBranding, type AdminClientConfig, type AdminClientOptions, type AdminClientPaths, type AdminCollectionItem, type AdminCollectionPage, type AdminDatePreset, type AdminDetailPanel, type AdminEventFilters, type AdminMessage, type AdminMessagePage, type AdminMessagePageInfo, type AdminModule, type AdminModuleGroup, type AdminNavItem, type AdminOverview, type AdminParticipantDetail, type AdminParticipantSummary, type AdminPermissions, type AdminQueueEvent, type AdminRouteDefinition, type AdminRouteState, type AdminRuntimeContext, type AdminScope, type AdminThreadDetail, type AdminThreadSummary, type AdminUsageAttribution, type AdminUsageBreakdown, type AdminUsageDimension, type AdminUsageFilters, type AdminUsageGroupBy, type AdminUsageInterval, type AdminUsageKind, type AdminUsageMetricKind, type AdminUsagePoint, type AdminUsageResponse, type AdminUsageTotals, type AggregatedUsageRow, type CollectionEditor, type CollectionEditorProps, CopilotzAdmin, type CopilotzAdminClient, type CopilotzAdminProps, EMPTY_USAGE_TOTALS, EmptyState, FilterBar, InspectorPanel, JsonPanel, type LegacyAdminConfig, MetricStrip, type MetricStripItem, PageHeader, type RequestHeadersProvider, ResourceTable, type ResourceTableColumn, StatusBadge, type UsageCalculationOptions, type UsageChartSeries, type UsageChartState, type UseCopilotzAdminOptions, type UseCopilotzAdminResult, addUsageTotals, agentsModule, aggregateUsageRows, buildUsageChartState, canAccessAdminPermission, collectAdminNavItems, collectAdminRoutes, collectCollectionEditors, collectionsModule, createAdminClient, defaultAdminConfig, defaultCopilotzModules, eventsModule, firstAccessibleRoute, formatCompactMetric, formatMetricValue, formatNumber, formatPercent, formatUsageBucket, getUsageDimensionLabel, getUsageGroupLabel, getUsageMetricLabel, getUsageRange, getUsageTotalValue, mergeAdminConfig, overviewModule, participantsModule, threadsModule, usageModule, useAdmin, useCopilotzAdmin };