@kortyx/telemetry-contracts 0.4.0 → 0.6.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 (5) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/dist/index.d.ts +97 -2
  3. package/dist/index.js +402 -334
  4. package/dist/index.js.map +1 -1
  5. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.6.0](https://github.com/kortyx-io/kortyx/compare/telemetry-contracts-v0.5.0...telemetry-contracts-v0.6.0) (2026-09-14)
4
+
5
+
6
+ ### Features
7
+
8
+ * **studio:** add manual and scheduled updates through a release CDN ([#181](https://github.com/kortyx-io/kortyx/issues/181)) ([af1fde3](https://github.com/kortyx-io/kortyx/commit/af1fde351642f3bf8e240ff41f5c7f9ad88584de))
9
+
10
+ ## [0.5.0](https://github.com/kortyx-io/kortyx/compare/telemetry-contracts-v0.4.0...telemetry-contracts-v0.5.0) (2026-09-11)
11
+
12
+
13
+ ### Features
14
+
15
+ * complete client responses while workflows continue in background ([#165](https://github.com/kortyx-io/kortyx/issues/165)) ([a8a08cd](https://github.com/kortyx-io/kortyx/commit/a8a08cd1e9533e4b44efa4af54a2d2cec54431ae))
16
+
3
17
  ## [0.4.0](https://github.com/kortyx-io/kortyx/compare/telemetry-contracts-v0.3.0...telemetry-contracts-v0.4.0) (2026-09-10)
4
18
 
5
19
 
package/dist/index.d.ts CHANGED
@@ -1,5 +1,88 @@
1
1
  import { z } from 'zod';
2
2
 
3
+ declare const StudioReleaseVersionSchema: z.ZodString;
4
+ declare const StudioReleaseSchema: z.ZodObject<{
5
+ format: z.ZodLiteral<1>;
6
+ installer: z.ZodLiteral<1>;
7
+ version: z.ZodString;
8
+ api: z.ZodString;
9
+ studio: z.ZodString;
10
+ }, z.core.$strip>;
11
+ type StudioRelease = z.infer<typeof StudioReleaseSchema>;
12
+ declare const StudioUpdateSettingsSchema: z.ZodObject<{
13
+ automatic: z.ZodBoolean;
14
+ hourUtc: z.ZodNumber;
15
+ }, z.core.$strip>;
16
+ type StudioUpdateSettings = z.infer<typeof StudioUpdateSettingsSchema>;
17
+ declare const StudioUpdateOperationSchema: z.ZodObject<{
18
+ id: z.ZodUUID;
19
+ from: z.ZodString;
20
+ release: z.ZodObject<{
21
+ format: z.ZodLiteral<1>;
22
+ installer: z.ZodLiteral<1>;
23
+ version: z.ZodString;
24
+ api: z.ZodString;
25
+ studio: z.ZodString;
26
+ }, z.core.$strip>;
27
+ phase: z.ZodEnum<{
28
+ failed: "failed";
29
+ succeeded: "succeeded";
30
+ starting: "starting";
31
+ pulling: "pulling";
32
+ backup: "backup";
33
+ installing: "installing";
34
+ verifying: "verifying";
35
+ }>;
36
+ startedAt: z.ZodISODateTime;
37
+ updatedAt: z.ZodISODateTime;
38
+ backup: z.ZodNullable<z.ZodString>;
39
+ messages: z.ZodArray<z.ZodString>;
40
+ }, z.core.$strip>;
41
+ type StudioUpdateOperation = z.infer<typeof StudioUpdateOperationSchema>;
42
+ declare const StudioUpdateStatusSchema: z.ZodObject<{
43
+ current: z.ZodNullable<z.ZodString>;
44
+ available: z.ZodNullable<z.ZodObject<{
45
+ format: z.ZodLiteral<1>;
46
+ installer: z.ZodLiteral<1>;
47
+ version: z.ZodString;
48
+ api: z.ZodString;
49
+ studio: z.ZodString;
50
+ }, z.core.$strip>>;
51
+ checkedAt: z.ZodNullable<z.ZodISODateTime>;
52
+ checkError: z.ZodNullable<z.ZodString>;
53
+ settings: z.ZodObject<{
54
+ automatic: z.ZodBoolean;
55
+ hourUtc: z.ZodNumber;
56
+ }, z.core.$strip>;
57
+ operation: z.ZodNullable<z.ZodObject<{
58
+ id: z.ZodUUID;
59
+ from: z.ZodString;
60
+ release: z.ZodObject<{
61
+ format: z.ZodLiteral<1>;
62
+ installer: z.ZodLiteral<1>;
63
+ version: z.ZodString;
64
+ api: z.ZodString;
65
+ studio: z.ZodString;
66
+ }, z.core.$strip>;
67
+ phase: z.ZodEnum<{
68
+ failed: "failed";
69
+ succeeded: "succeeded";
70
+ starting: "starting";
71
+ pulling: "pulling";
72
+ backup: "backup";
73
+ installing: "installing";
74
+ verifying: "verifying";
75
+ }>;
76
+ startedAt: z.ZodISODateTime;
77
+ updatedAt: z.ZodISODateTime;
78
+ backup: z.ZodNullable<z.ZodString>;
79
+ messages: z.ZodArray<z.ZodString>;
80
+ }, z.core.$strip>>;
81
+ }, z.core.$strip>;
82
+ type StudioUpdateStatus = z.infer<typeof StudioUpdateStatusSchema>;
83
+ declare function newerStudioVersion(candidate: string, current: string): boolean;
84
+ declare function studioUpdateRunning(operation: StudioUpdateOperation | null): boolean;
85
+
3
86
  type StudioWorkflowCall = {
4
87
  id: string;
5
88
  invocationId: string;
@@ -34,7 +117,7 @@ type StudioWorkflowCall = {
34
117
  /** Logical calls are ordered by persisted sequence, independently within each branch. */
35
118
  declare function projectWorkflowCalls(events: StudioDetailEvent[]): StudioWorkflowCall[];
36
119
 
37
- declare const TELEMETRY_EVENT_TYPES: readonly ["span.started", "span.ended", "span.failed", "generation.completed", "tool.started", "tool.completed", "tool.failed", "interrupt.created", "interrupt.resolved", "interrupt.expired", "interrupt.cancelled", "run.cancelled", "run.limit_reached", "workflow.transitioned", "workflow.call.started", "workflow.call.suspended", "workflow.call.resumed", "workflow.call.completed", "workflow.call.failed", "workflow.call.reused", "workflow.call.restored", "session.checkpointed", "session.forked", "session.rolled_back"];
120
+ declare const TELEMETRY_EVENT_TYPES: readonly ["span.started", "span.ended", "span.failed", "generation.completed", "tool.started", "tool.completed", "tool.failed", "response.completed", "interrupt.created", "interrupt.resolved", "interrupt.expired", "interrupt.cancelled", "run.cancelled", "run.limit_reached", "workflow.transitioned", "workflow.call.started", "workflow.call.suspended", "workflow.call.resumed", "workflow.call.completed", "workflow.call.failed", "workflow.call.reused", "workflow.call.restored", "session.checkpointed", "session.forked", "session.rolled_back"];
38
121
  declare const TelemetryServiceSchema: z.ZodObject<{
39
122
  name: z.ZodString;
40
123
  deploymentRef: z.ZodOptional<z.ZodString>;
@@ -120,6 +203,7 @@ declare const TelemetryEventTypeSchema: z.ZodEnum<{
120
203
  "tool.started": "tool.started";
121
204
  "tool.completed": "tool.completed";
122
205
  "tool.failed": "tool.failed";
206
+ "response.completed": "response.completed";
123
207
  "interrupt.created": "interrupt.created";
124
208
  "interrupt.resolved": "interrupt.resolved";
125
209
  "interrupt.expired": "interrupt.expired";
@@ -175,6 +259,7 @@ declare const TelemetryEventSchema: z.ZodObject<{
175
259
  "tool.started": "tool.started";
176
260
  "tool.completed": "tool.completed";
177
261
  "tool.failed": "tool.failed";
262
+ "response.completed": "response.completed";
178
263
  "interrupt.created": "interrupt.created";
179
264
  "interrupt.resolved": "interrupt.resolved";
180
265
  "interrupt.expired": "interrupt.expired";
@@ -233,6 +318,7 @@ declare const TelemetryEventBatchSchema: z.ZodObject<{
233
318
  "tool.started": "tool.started";
234
319
  "tool.completed": "tool.completed";
235
320
  "tool.failed": "tool.failed";
321
+ "response.completed": "response.completed";
236
322
  "interrupt.created": "interrupt.created";
237
323
  "interrupt.resolved": "interrupt.resolved";
238
324
  "interrupt.expired": "interrupt.expired";
@@ -792,6 +878,7 @@ declare const StudioSessionSchema: z.ZodObject<{
792
878
  environment: z.ZodString;
793
879
  }, z.core.$strict>;
794
880
  declare const StudioInterruptSchema: z.ZodObject<{
881
+ afterResponseCompleted: z.ZodOptional<z.ZodBoolean>;
795
882
  id: z.ZodString;
796
883
  status: z.ZodEnum<{
797
884
  failed: "failed";
@@ -854,6 +941,7 @@ declare const StudioDetailEventSchema: z.ZodObject<{
854
941
  "tool.started": "tool.started";
855
942
  "tool.completed": "tool.completed";
856
943
  "tool.failed": "tool.failed";
944
+ "response.completed": "response.completed";
857
945
  "interrupt.created": "interrupt.created";
858
946
  "interrupt.resolved": "interrupt.resolved";
859
947
  "interrupt.expired": "interrupt.expired";
@@ -1128,6 +1216,7 @@ declare const StudioSessionsResponseSchema: z.ZodObject<{
1128
1216
  }, z.core.$strict>;
1129
1217
  declare const StudioInterruptsResponseSchema: z.ZodObject<{
1130
1218
  interrupts: z.ZodArray<z.ZodObject<{
1219
+ afterResponseCompleted: z.ZodOptional<z.ZodBoolean>;
1131
1220
  id: z.ZodString;
1132
1221
  status: z.ZodEnum<{
1133
1222
  failed: "failed";
@@ -1259,6 +1348,7 @@ declare const StudioRunDetailResponseSchema: z.ZodObject<{
1259
1348
  "tool.started": "tool.started";
1260
1349
  "tool.completed": "tool.completed";
1261
1350
  "tool.failed": "tool.failed";
1351
+ "response.completed": "response.completed";
1262
1352
  "interrupt.created": "interrupt.created";
1263
1353
  "interrupt.resolved": "interrupt.resolved";
1264
1354
  "interrupt.expired": "interrupt.expired";
@@ -1352,6 +1442,7 @@ declare const StudioRunDetailResponseSchema: z.ZodObject<{
1352
1442
  environment: z.ZodString;
1353
1443
  }, z.core.$strict>>;
1354
1444
  interrupts: z.ZodArray<z.ZodObject<{
1445
+ afterResponseCompleted: z.ZodOptional<z.ZodBoolean>;
1355
1446
  id: z.ZodString;
1356
1447
  status: z.ZodEnum<{
1357
1448
  failed: "failed";
@@ -1538,6 +1629,7 @@ declare const StudioSessionDetailResponseSchema: z.ZodObject<{
1538
1629
  "tool.started": "tool.started";
1539
1630
  "tool.completed": "tool.completed";
1540
1631
  "tool.failed": "tool.failed";
1632
+ "response.completed": "response.completed";
1541
1633
  "interrupt.created": "interrupt.created";
1542
1634
  "interrupt.resolved": "interrupt.resolved";
1543
1635
  "interrupt.expired": "interrupt.expired";
@@ -1576,6 +1668,7 @@ declare const StudioSessionDetailResponseSchema: z.ZodObject<{
1576
1668
  payload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
1577
1669
  }, z.core.$strict>>;
1578
1670
  interrupts: z.ZodArray<z.ZodObject<{
1671
+ afterResponseCompleted: z.ZodOptional<z.ZodBoolean>;
1579
1672
  id: z.ZodString;
1580
1673
  status: z.ZodEnum<{
1581
1674
  failed: "failed";
@@ -1632,6 +1725,7 @@ declare const StudioSessionDetailResponseSchema: z.ZodObject<{
1632
1725
  }, z.core.$strict>;
1633
1726
  declare const StudioInterruptDetailResponseSchema: z.ZodObject<{
1634
1727
  interrupt: z.ZodObject<{
1728
+ afterResponseCompleted: z.ZodOptional<z.ZodBoolean>;
1635
1729
  id: z.ZodString;
1636
1730
  status: z.ZodEnum<{
1637
1731
  failed: "failed";
@@ -1694,6 +1788,7 @@ declare const StudioInterruptDetailResponseSchema: z.ZodObject<{
1694
1788
  "tool.started": "tool.started";
1695
1789
  "tool.completed": "tool.completed";
1696
1790
  "tool.failed": "tool.failed";
1791
+ "response.completed": "response.completed";
1697
1792
  "interrupt.created": "interrupt.created";
1698
1793
  "interrupt.resolved": "interrupt.resolved";
1699
1794
  "interrupt.expired": "interrupt.expired";
@@ -2024,4 +2119,4 @@ type StudioWorkflowsResponse = z.infer<typeof StudioWorkflowsResponseSchema>;
2024
2119
  type StudioCatalogsResponse = z.infer<typeof StudioCatalogsResponseSchema>;
2025
2120
  type StudioContextResponse = z.infer<typeof StudioContextResponseSchema>;
2026
2121
 
2027
- export { type EnsureWorkflowTopologyRequest, EnsureWorkflowTopologyRequestSchema, type EnsureWorkflowTopologyResponse, EnsureWorkflowTopologyResponseSchema, type KortyxTelemetryEvent, type KortyxTelemetryEventType, type KortyxTelemetryService, type KortyxWorkflowTopologyEdge, type KortyxWorkflowTopologyNode, type KortyxWorkflowTopologyTransition, STUDIO_TIME_RANGES, type StudioCatalogsResponse, StudioCatalogsResponseSchema, type StudioChange, type StudioChangeResource, StudioChangeResourceSchema, StudioChangeSchema, type StudioContextResponse, StudioContextResponseSchema, type StudioDetailEvent, StudioDetailEventSchema, type StudioInterrupt, type StudioInterruptDetailResponse, StudioInterruptDetailResponseSchema, type StudioInterruptInteractionMode, StudioInterruptInteractionModeSchema, type StudioInterruptOption, StudioInterruptOptionSchema, StudioInterruptSchema, type StudioInterruptStatus, StudioInterruptStatusSchema, type StudioInterruptType, StudioInterruptTypeSchema, type StudioInterruptsResponse, StudioInterruptsResponseSchema, type StudioMetric, StudioMetricSchema, type StudioPricingSource, StudioPricingSourceSchema, type StudioPricingStatus, StudioPricingStatusSchema, type StudioResumeOutcome, StudioResumeOutcomeSchema, type StudioRun, type StudioRunDetailResponse, StudioRunDetailResponseSchema, StudioRunSchema, type StudioRunStatus, StudioRunStatusSchema, type StudioRunsResponse, StudioRunsResponseSchema, type StudioSession, type StudioSessionDetailResponse, StudioSessionDetailResponseSchema, StudioSessionSchema, type StudioSessionsResponse, StudioSessionsResponseSchema, type StudioTimeRange, type StudioTimeRangeContext, StudioTimeRangeContextSchema, StudioTimeRangeQuerySchema, type StudioTimeRangeResolution, StudioTimeRangeSchema, type StudioWorkflow, type StudioWorkflowCall, type StudioWorkflowHealth, StudioWorkflowHealthSchema, type StudioWorkflowInternalEdge, StudioWorkflowInternalEdgeSchema, type StudioWorkflowNode, StudioWorkflowNodeSchema, StudioWorkflowSchema, type StudioWorkflowTransition, StudioWorkflowTransitionSchema, type StudioWorkflowsResponse, StudioWorkflowsResponseSchema, TELEMETRY_EVENT_TYPES, type TelemetryEventBatch, type TelemetryEventBatchResponse, TelemetryEventBatchResponseSchema, TelemetryEventBatchSchema, TelemetryEventSchema, TelemetryEventTypeSchema, type TelemetryPricingHint, TelemetryPricingHintSchema, type TelemetryPricingLineItem, TelemetryPricingLineItemSchema, type TelemetryPricingSource, TelemetryPricingSourceSchema, type TelemetryPricingUnit, TelemetryPricingUnitSchema, type TelemetryPricingUsageType, TelemetryPricingUsageTypeSchema, TelemetryServiceSchema, type TelemetryUnitPrice, TelemetryUnitPriceSchema, type TelemetryUsageItem, TelemetryUsageItemSchema, WorkflowTopologyCallSchema, WorkflowTopologyEdgeSchema, WorkflowTopologyNodeSchema, WorkflowTopologyTransitionSchema, projectWorkflowCalls, resolveStudioInterruptStatus, resolveStudioTimeRange };
2122
+ export { type EnsureWorkflowTopologyRequest, EnsureWorkflowTopologyRequestSchema, type EnsureWorkflowTopologyResponse, EnsureWorkflowTopologyResponseSchema, type KortyxTelemetryEvent, type KortyxTelemetryEventType, type KortyxTelemetryService, type KortyxWorkflowTopologyEdge, type KortyxWorkflowTopologyNode, type KortyxWorkflowTopologyTransition, STUDIO_TIME_RANGES, type StudioCatalogsResponse, StudioCatalogsResponseSchema, type StudioChange, type StudioChangeResource, StudioChangeResourceSchema, StudioChangeSchema, type StudioContextResponse, StudioContextResponseSchema, type StudioDetailEvent, StudioDetailEventSchema, type StudioInterrupt, type StudioInterruptDetailResponse, StudioInterruptDetailResponseSchema, type StudioInterruptInteractionMode, StudioInterruptInteractionModeSchema, type StudioInterruptOption, StudioInterruptOptionSchema, StudioInterruptSchema, type StudioInterruptStatus, StudioInterruptStatusSchema, type StudioInterruptType, StudioInterruptTypeSchema, type StudioInterruptsResponse, StudioInterruptsResponseSchema, type StudioMetric, StudioMetricSchema, type StudioPricingSource, StudioPricingSourceSchema, type StudioPricingStatus, StudioPricingStatusSchema, type StudioRelease, StudioReleaseSchema, StudioReleaseVersionSchema, type StudioResumeOutcome, StudioResumeOutcomeSchema, type StudioRun, type StudioRunDetailResponse, StudioRunDetailResponseSchema, StudioRunSchema, type StudioRunStatus, StudioRunStatusSchema, type StudioRunsResponse, StudioRunsResponseSchema, type StudioSession, type StudioSessionDetailResponse, StudioSessionDetailResponseSchema, StudioSessionSchema, type StudioSessionsResponse, StudioSessionsResponseSchema, type StudioTimeRange, type StudioTimeRangeContext, StudioTimeRangeContextSchema, StudioTimeRangeQuerySchema, type StudioTimeRangeResolution, StudioTimeRangeSchema, type StudioUpdateOperation, StudioUpdateOperationSchema, type StudioUpdateSettings, StudioUpdateSettingsSchema, type StudioUpdateStatus, StudioUpdateStatusSchema, type StudioWorkflow, type StudioWorkflowCall, type StudioWorkflowHealth, StudioWorkflowHealthSchema, type StudioWorkflowInternalEdge, StudioWorkflowInternalEdgeSchema, type StudioWorkflowNode, StudioWorkflowNodeSchema, StudioWorkflowSchema, type StudioWorkflowTransition, StudioWorkflowTransitionSchema, type StudioWorkflowsResponse, StudioWorkflowsResponseSchema, TELEMETRY_EVENT_TYPES, type TelemetryEventBatch, type TelemetryEventBatchResponse, TelemetryEventBatchResponseSchema, TelemetryEventBatchSchema, TelemetryEventSchema, TelemetryEventTypeSchema, type TelemetryPricingHint, TelemetryPricingHintSchema, type TelemetryPricingLineItem, TelemetryPricingLineItemSchema, type TelemetryPricingSource, TelemetryPricingSourceSchema, type TelemetryPricingUnit, TelemetryPricingUnitSchema, type TelemetryPricingUsageType, TelemetryPricingUsageTypeSchema, TelemetryServiceSchema, type TelemetryUnitPrice, TelemetryUnitPriceSchema, type TelemetryUsageItem, TelemetryUsageItemSchema, WorkflowTopologyCallSchema, WorkflowTopologyEdgeSchema, WorkflowTopologyNodeSchema, WorkflowTopologyTransitionSchema, newerStudioVersion, projectWorkflowCalls, resolveStudioInterruptStatus, resolveStudioTimeRange, studioUpdateRunning };