@flexkit/agent-protocol 0.3.0 → 0.3.2

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.ts CHANGED
@@ -270,6 +270,16 @@ declare const dataPartSchema: z.ZodObject<{
270
270
  'suggested-prompt': z.ZodObject<{
271
271
  prompt: z.ZodString;
272
272
  }, z.core.$strip>;
273
+ 'mid-turn-message': z.ZodObject<{
274
+ attachments: z.ZodArray<z.ZodObject<{
275
+ filename: z.ZodString;
276
+ mediaType: z.ZodString;
277
+ sizeBytes: z.ZodNumber;
278
+ url: z.ZodString;
279
+ }, z.core.$strip>>;
280
+ messageId: z.ZodString;
281
+ text: z.ZodString;
282
+ }, z.core.$strip>;
273
283
  }, z.core.$strip>;
274
284
  type DataPart = z.infer<typeof dataPartSchema>;
275
285
  type DataPartType = keyof DataPart;
@@ -278,6 +288,40 @@ declare function isDataPartType(type: string): type is DataPartType;
278
288
  /** The `type` of a UI message part carrying this data part. */
279
289
  type DataPartMessageType = `data-${DataPartType}`;
280
290
 
291
+ type ActivityItemKind = 'approval_request';
292
+ /** `done` = resolved by the system (e.g. the approval was decided); `dismissed` = hidden by the recipient. */
293
+ type ActivityItemState = 'unread' | 'read' | 'done' | 'dismissed';
294
+ type ActivityItemResolution = 'approved' | 'rejected' | 'expired' | 'cancelled';
295
+ /** One entry in a user's Studio Activity inbox. */
296
+ interface ActivityItem {
297
+ approvalId: string | null;
298
+ automationId: string | null;
299
+ automationRunId: string | null;
300
+ body: string | null;
301
+ chatId: string | null;
302
+ chatMessageId: string | null;
303
+ createdAt: string;
304
+ id: string;
305
+ kind: ActivityItemKind;
306
+ readAt: string | null;
307
+ /** True when the item waits on the recipient (an approval request). */
308
+ requiresAction: boolean;
309
+ resolution: ActivityItemResolution | null;
310
+ resolvedAt: string | null;
311
+ state: ActivityItemState;
312
+ title: string;
313
+ }
314
+ interface ActivityItemsPage {
315
+ hasMore: boolean;
316
+ items: ActivityItem[];
317
+ }
318
+ /** Badge counts plus unread items newer than the client's `since` watermark (newest first, at most 5). */
319
+ interface ActivitySummary {
320
+ needsActionCount: number;
321
+ newItems: ActivityItem[];
322
+ unreadCount: number;
323
+ }
324
+
281
325
  /** Run and approval shapes returned by the automations API. */
282
326
  type AutomationRunStatus = 'running' | 'awaiting_approval' | 'success' | 'skipped' | 'failed' | 'cancelled';
283
327
  type AutomationTriggerType = 'entity' | 'manual' | 'schedule' | 'webhook';
@@ -371,8 +415,13 @@ interface AutomationToolAllowRule {
371
415
 
372
416
  /** Chat shapes returned by the agent chat API. */
373
417
  type AgentChatMessageRole = 'user' | 'assistant';
374
- /** `pending` exists only client-side, for a turn whose record has not been created yet. */
375
- type AgentChatMessageStatus = 'pending' | 'streaming' | 'awaiting_approval' | 'complete' | 'failed';
418
+ /**
419
+ * `pending` exists only client-side, for a turn whose record has not been
420
+ * created yet. `steering` and `queued` are user messages sent while a turn
421
+ * was running: a steering one reaches that turn at its next model step, a
422
+ * queued one starts the next turn once it has finished.
423
+ */
424
+ type AgentChatMessageStatus = 'pending' | 'streaming' | 'awaiting_approval' | 'complete' | 'failed' | 'queued' | 'steering';
376
425
  interface AgentChat {
377
426
  createdAt: string;
378
427
  id: string;
@@ -422,5 +471,18 @@ interface AgentChatTurn {
422
471
  userMessage: AgentChatMessage;
423
472
  workflowRunId: string;
424
473
  }
474
+ /** Where a message sent during a running turn went: into that turn, or after it. */
475
+ type AgentChatFollowUpDelivery = 'queue' | 'steer';
476
+ interface AgentChatFollowUp {
477
+ delivery: AgentChatFollowUpDelivery;
478
+ /** The stored user message, with status `steering` or `queued`. */
479
+ message: AgentChatMessage;
480
+ }
481
+ /** A follow-up either joined the running turn or, when that turn had already ended, started the next one. */
482
+ type AgentChatFollowUpResult = {
483
+ followUp: AgentChatFollowUp;
484
+ } | {
485
+ turn: AgentChatTurn;
486
+ };
425
487
 
426
- export { type AgentChat, type AgentChatAttachment, type AgentChatMessage, type AgentChatMessageRole, type AgentChatMessageStatus, type AgentChatPart, type AgentChatTurn, type AutomationApproval, type AutomationApprovalKind, type AutomationApprovalOperation, type AutomationApprovalPreview, type AutomationApprovalPreviewKind, type AutomationApprovalPreviewOperation, type AutomationApprovalPreviewRow, type AutomationApprovalStatus, type AutomationMutationPolicy, type AutomationRun, type AutomationRunStatus, type AutomationToolAllowRule, type AutomationTriggerType, DATA_PART_TYPES, type DataPart, type DataPartMessageType, type DataPartType, type SchemaChangePreviewSummary, dataPartSchema, errorSchema, isDataPartType };
488
+ export { type ActivityItem, type ActivityItemKind, type ActivityItemResolution, type ActivityItemState, type ActivityItemsPage, type ActivitySummary, type AgentChat, type AgentChatAttachment, type AgentChatFollowUp, type AgentChatFollowUpDelivery, type AgentChatFollowUpResult, type AgentChatMessage, type AgentChatMessageRole, type AgentChatMessageStatus, type AgentChatPart, type AgentChatTurn, type AutomationApproval, type AutomationApprovalKind, type AutomationApprovalOperation, type AutomationApprovalPreview, type AutomationApprovalPreviewKind, type AutomationApprovalPreviewOperation, type AutomationApprovalPreviewRow, type AutomationApprovalStatus, type AutomationMutationPolicy, type AutomationRun, type AutomationRunStatus, type AutomationToolAllowRule, type AutomationTriggerType, DATA_PART_TYPES, type DataPart, type DataPartMessageType, type DataPartType, type SchemaChangePreviewSummary, dataPartSchema, errorSchema, isDataPartType };
package/dist/index.js CHANGED
@@ -157,6 +157,18 @@ var dataPartSchema = z.object({
157
157
  /** One follow-up instruction offered under a finished chat reply; clicking it fills the composer. */
158
158
  "suggested-prompt": z.object({
159
159
  prompt: z.string()
160
+ }),
161
+ /**
162
+ * A message the user sent while the turn was running, at the point in the
163
+ * reply where the agent received it. The UI shows it there, in place of the
164
+ * stored user message it refers to.
165
+ */
166
+ "mid-turn-message": z.object({
167
+ attachments: z.array(
168
+ z.object({ filename: z.string(), mediaType: z.string(), sizeBytes: z.number(), url: z.string() })
169
+ ),
170
+ messageId: z.string(),
171
+ text: z.string()
160
172
  })
161
173
  });
162
174
  var DATA_PART_TYPES = Object.keys(dataPartSchema.shape);
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/data-parts.ts"],"sourcesContent":["import { z } from 'zod';\n\n/**\n * Custom `data-*` parts streamed by the Flexkit agent platform and rendered by\n * Studio. The server validates what it writes against these schemas and the\n * UI derives its part types from them, so the two can never drift.\n */\nexport const errorSchema = z.object({\n message: z.string(),\n});\n\nexport const dataPartSchema = z.object({\n 'plugin-connection': z.object({ pluginId: z.string(), connectionId: z.string().optional() }),\n /** Lifecycle of one plugin tool call, so the UI can name the in-flight call in its status line. */\n 'plugin-call': z.object({\n pluginId: z.string(),\n tool: z.string(),\n status: z.enum(['loading', 'done', 'error']),\n error: errorSchema.optional(),\n }),\n /** Written when the chat history was summarized before or during a turn. */\n 'context-compaction': z.object({\n reason: z.enum(['threshold', 'context_length_error']),\n status: z.enum(['done']),\n summarizedMessageCount: z.number(),\n }),\n /** The agent's working plan; replaced in place as steps complete. */\n plan: z.object({\n explanation: z.string().optional(),\n steps: z.array(\n z.object({\n status: z.enum(['pending', 'in_progress', 'completed']),\n step: z.string(),\n })\n ),\n updatedAt: z.string(),\n }),\n /** A delegated subtask of an automation run. */\n subtask: z.object({\n error: errorSchema.optional(),\n resultPreview: z.string().optional(),\n status: z.enum(['running', 'done', 'error']),\n stepsUsed: z.number().optional(),\n subtaskId: z.string(),\n title: z.string(),\n }),\n /** json-render patch lines, extracted from the assistant text by the stream pipeline. */\n spec: z.union([\n z.object({\n type: z.literal('patch'),\n patch: z.unknown(),\n }),\n z.object({\n type: z.literal('flat'),\n spec: z.unknown(),\n }),\n z.object({\n type: z.literal('nested'),\n spec: z.unknown(),\n }),\n ]),\n 'create-sandbox': z.object({\n sandboxId: z.string().optional(),\n status: z.enum(['loading', 'done', 'error']),\n error: errorSchema.optional(),\n }),\n 'generating-files': z.object({\n paths: z.array(z.string()),\n status: z.enum(['generating', 'uploading', 'uploaded', 'done', 'error']),\n error: errorSchema.optional(),\n }),\n 'run-artifact': z.object({\n artifactId: z.string().optional(),\n contentType: z.string().optional(),\n error: errorSchema.optional(),\n filename: z.string(),\n kind: z.enum(['html', 'pdf']).optional(),\n sizeBytes: z.number().optional(),\n status: z.enum(['uploading', 'done', 'error']),\n /** Persistent public URL of the stored artifact. */\n url: z.string().optional(),\n }),\n 'run-command': z.object({\n sandboxId: z.string(),\n commandId: z.string().optional(),\n command: z.string(),\n args: z.array(z.string()),\n status: z.enum(['executing', 'running', 'waiting', 'done', 'error']),\n exitCode: z.number().optional(),\n error: errorSchema.optional(),\n }),\n 'search-schema': z.object({\n query: z.string().optional(),\n status: z.enum(['loading', 'done', 'error']),\n error: errorSchema.optional(),\n }),\n 'web-search': z.object({\n query: z.string(),\n status: z.enum(['loading', 'done', 'error']),\n error: errorSchema.optional(),\n }),\n 'tool-delivery': z.object({\n channelId: z.string(),\n channelName: z.string(),\n provider: z.enum(['slack', 'teams']),\n status: z.enum(['loading', 'done', 'error']),\n error: errorSchema.optional(),\n }),\n 'validate-graphql': z.object({\n status: z.enum(['loading', 'valid', 'invalid', 'error']),\n errorCount: z.number().optional(),\n error: errorSchema.optional(),\n }),\n 'execute-graphql': z.object({\n operationType: z.enum(['query', 'mutation']).optional(),\n status: z.enum(['loading', 'done', 'error']),\n error: errorSchema.optional(),\n }),\n /** Emitted for proposals; the UI fetches the full proposal from the approvals API by id. */\n 'mutation-approval': z.object({\n approvalId: z.string(),\n affectedCount: z.number().nullable().optional(),\n decidedBy: z.string().optional(),\n operationsSummary: z.string(),\n reason: z.string().optional(),\n status: z.enum(['pending', 'approved', 'rejected', 'expired', 'cancelled', 'executed', 'error']),\n error: errorSchema.optional(),\n }),\n 'bulk-graphql-action': z.object({\n changedItems: z.number().optional(),\n failedItems: z.number().optional(),\n jobId: z.string().optional(),\n operationName: z.string(),\n processedItems: z.number().optional(),\n status: z.enum(['loading', 'running', 'done', 'error']),\n totalItems: z.number().optional(),\n error: errorSchema.optional(),\n }),\n 'update-memory': z.object({\n status: z.enum(['loading', 'done', 'error']),\n error: errorSchema.optional(),\n }),\n 'load-skill': z.object({\n /** True for skills attached to the automation, injected at run start rather than loaded on demand. */\n attached: z.boolean().optional(),\n skillName: z.string().optional(),\n status: z.enum(['loading', 'done', 'error']),\n error: errorSchema.optional(),\n }),\n /** Marker written by the run workflow for the trigger event so a run replays as a conversation. */\n 'user-message': z.object({\n parts: z.array(z.unknown()),\n }),\n /** Final report written by the run workflow when the agent finishes. */\n 'run-summary': z.object({\n status: z.enum(['success', 'skipped', 'failed']),\n summary: z.string(),\n }),\n /** A chat turn that ended with an error. */\n 'turn-error': z.object({\n message: z.string(),\n }),\n /** One follow-up instruction offered under a finished chat reply; clicking it fills the composer. */\n 'suggested-prompt': z.object({\n prompt: z.string(),\n }),\n});\n\nexport type DataPart = z.infer<typeof dataPartSchema>;\nexport type DataPartType = keyof DataPart;\n\nexport const DATA_PART_TYPES = Object.keys(dataPartSchema.shape) as DataPartType[];\n\nexport function isDataPartType(type: string): type is DataPartType {\n return (DATA_PART_TYPES as string[]).includes(type);\n}\n\n/** The `type` of a UI message part carrying this data part. */\nexport type DataPartMessageType = `data-${DataPartType}`;\n"],"mappings":";AAAA,SAAS,SAAS;AAOX,IAAM,cAAc,EAAE,OAAO;AAAA,EAClC,SAAS,EAAE,OAAO;AACpB,CAAC;AAEM,IAAM,iBAAiB,EAAE,OAAO;AAAA,EACrC,qBAAqB,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,GAAG,cAAc,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AAAA;AAAA,EAE3F,eAAe,EAAE,OAAO;AAAA,IACtB,UAAU,EAAE,OAAO;AAAA,IACnB,MAAM,EAAE,OAAO;AAAA,IACf,QAAQ,EAAE,KAAK,CAAC,WAAW,QAAQ,OAAO,CAAC;AAAA,IAC3C,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA;AAAA,EAED,sBAAsB,EAAE,OAAO;AAAA,IAC7B,QAAQ,EAAE,KAAK,CAAC,aAAa,sBAAsB,CAAC;AAAA,IACpD,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;AAAA,IACvB,wBAAwB,EAAE,OAAO;AAAA,EACnC,CAAC;AAAA;AAAA,EAED,MAAM,EAAE,OAAO;AAAA,IACb,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA,IACjC,OAAO,EAAE;AAAA,MACP,EAAE,OAAO;AAAA,QACP,QAAQ,EAAE,KAAK,CAAC,WAAW,eAAe,WAAW,CAAC;AAAA,QACtD,MAAM,EAAE,OAAO;AAAA,MACjB,CAAC;AAAA,IACH;AAAA,IACA,WAAW,EAAE,OAAO;AAAA,EACtB,CAAC;AAAA;AAAA,EAED,SAAS,EAAE,OAAO;AAAA,IAChB,OAAO,YAAY,SAAS;AAAA,IAC5B,eAAe,EAAE,OAAO,EAAE,SAAS;AAAA,IACnC,QAAQ,EAAE,KAAK,CAAC,WAAW,QAAQ,OAAO,CAAC;AAAA,IAC3C,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA,IAC/B,WAAW,EAAE,OAAO;AAAA,IACpB,OAAO,EAAE,OAAO;AAAA,EAClB,CAAC;AAAA;AAAA,EAED,MAAM,EAAE,MAAM;AAAA,IACZ,EAAE,OAAO;AAAA,MACP,MAAM,EAAE,QAAQ,OAAO;AAAA,MACvB,OAAO,EAAE,QAAQ;AAAA,IACnB,CAAC;AAAA,IACD,EAAE,OAAO;AAAA,MACP,MAAM,EAAE,QAAQ,MAAM;AAAA,MACtB,MAAM,EAAE,QAAQ;AAAA,IAClB,CAAC;AAAA,IACD,EAAE,OAAO;AAAA,MACP,MAAM,EAAE,QAAQ,QAAQ;AAAA,MACxB,MAAM,EAAE,QAAQ;AAAA,IAClB,CAAC;AAAA,EACH,CAAC;AAAA,EACD,kBAAkB,EAAE,OAAO;AAAA,IACzB,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA,IAC/B,QAAQ,EAAE,KAAK,CAAC,WAAW,QAAQ,OAAO,CAAC;AAAA,IAC3C,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,oBAAoB,EAAE,OAAO;AAAA,IAC3B,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC;AAAA,IACzB,QAAQ,EAAE,KAAK,CAAC,cAAc,aAAa,YAAY,QAAQ,OAAO,CAAC;AAAA,IACvE,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,gBAAgB,EAAE,OAAO;AAAA,IACvB,YAAY,EAAE,OAAO,EAAE,SAAS;AAAA,IAChC,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA,IACjC,OAAO,YAAY,SAAS;AAAA,IAC5B,UAAU,EAAE,OAAO;AAAA,IACnB,MAAM,EAAE,KAAK,CAAC,QAAQ,KAAK,CAAC,EAAE,SAAS;AAAA,IACvC,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA,IAC/B,QAAQ,EAAE,KAAK,CAAC,aAAa,QAAQ,OAAO,CAAC;AAAA;AAAA,IAE7C,KAAK,EAAE,OAAO,EAAE,SAAS;AAAA,EAC3B,CAAC;AAAA,EACD,eAAe,EAAE,OAAO;AAAA,IACtB,WAAW,EAAE,OAAO;AAAA,IACpB,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA,IAC/B,SAAS,EAAE,OAAO;AAAA,IAClB,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC;AAAA,IACxB,QAAQ,EAAE,KAAK,CAAC,aAAa,WAAW,WAAW,QAAQ,OAAO,CAAC;AAAA,IACnE,UAAU,EAAE,OAAO,EAAE,SAAS;AAAA,IAC9B,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,iBAAiB,EAAE,OAAO;AAAA,IACxB,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA,IAC3B,QAAQ,EAAE,KAAK,CAAC,WAAW,QAAQ,OAAO,CAAC;AAAA,IAC3C,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,cAAc,EAAE,OAAO;AAAA,IACrB,OAAO,EAAE,OAAO;AAAA,IAChB,QAAQ,EAAE,KAAK,CAAC,WAAW,QAAQ,OAAO,CAAC;AAAA,IAC3C,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,iBAAiB,EAAE,OAAO;AAAA,IACxB,WAAW,EAAE,OAAO;AAAA,IACpB,aAAa,EAAE,OAAO;AAAA,IACtB,UAAU,EAAE,KAAK,CAAC,SAAS,OAAO,CAAC;AAAA,IACnC,QAAQ,EAAE,KAAK,CAAC,WAAW,QAAQ,OAAO,CAAC;AAAA,IAC3C,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,oBAAoB,EAAE,OAAO;AAAA,IAC3B,QAAQ,EAAE,KAAK,CAAC,WAAW,SAAS,WAAW,OAAO,CAAC;AAAA,IACvD,YAAY,EAAE,OAAO,EAAE,SAAS;AAAA,IAChC,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,mBAAmB,EAAE,OAAO;AAAA,IAC1B,eAAe,EAAE,KAAK,CAAC,SAAS,UAAU,CAAC,EAAE,SAAS;AAAA,IACtD,QAAQ,EAAE,KAAK,CAAC,WAAW,QAAQ,OAAO,CAAC;AAAA,IAC3C,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA;AAAA,EAED,qBAAqB,EAAE,OAAO;AAAA,IAC5B,YAAY,EAAE,OAAO;AAAA,IACrB,eAAe,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS;AAAA,IAC9C,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA,IAC/B,mBAAmB,EAAE,OAAO;AAAA,IAC5B,QAAQ,EAAE,OAAO,EAAE,SAAS;AAAA,IAC5B,QAAQ,EAAE,KAAK,CAAC,WAAW,YAAY,YAAY,WAAW,aAAa,YAAY,OAAO,CAAC;AAAA,IAC/F,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,uBAAuB,EAAE,OAAO;AAAA,IAC9B,cAAc,EAAE,OAAO,EAAE,SAAS;AAAA,IAClC,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA,IACjC,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA,IAC3B,eAAe,EAAE,OAAO;AAAA,IACxB,gBAAgB,EAAE,OAAO,EAAE,SAAS;AAAA,IACpC,QAAQ,EAAE,KAAK,CAAC,WAAW,WAAW,QAAQ,OAAO,CAAC;AAAA,IACtD,YAAY,EAAE,OAAO,EAAE,SAAS;AAAA,IAChC,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,iBAAiB,EAAE,OAAO;AAAA,IACxB,QAAQ,EAAE,KAAK,CAAC,WAAW,QAAQ,OAAO,CAAC;AAAA,IAC3C,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,cAAc,EAAE,OAAO;AAAA;AAAA,IAErB,UAAU,EAAE,QAAQ,EAAE,SAAS;AAAA,IAC/B,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA,IAC/B,QAAQ,EAAE,KAAK,CAAC,WAAW,QAAQ,OAAO,CAAC;AAAA,IAC3C,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA;AAAA,EAED,gBAAgB,EAAE,OAAO;AAAA,IACvB,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC;AAAA,EAC5B,CAAC;AAAA;AAAA,EAED,eAAe,EAAE,OAAO;AAAA,IACtB,QAAQ,EAAE,KAAK,CAAC,WAAW,WAAW,QAAQ,CAAC;AAAA,IAC/C,SAAS,EAAE,OAAO;AAAA,EACpB,CAAC;AAAA;AAAA,EAED,cAAc,EAAE,OAAO;AAAA,IACrB,SAAS,EAAE,OAAO;AAAA,EACpB,CAAC;AAAA;AAAA,EAED,oBAAoB,EAAE,OAAO;AAAA,IAC3B,QAAQ,EAAE,OAAO;AAAA,EACnB,CAAC;AACH,CAAC;AAKM,IAAM,kBAAkB,OAAO,KAAK,eAAe,KAAK;AAExD,SAAS,eAAe,MAAoC;AACjE,SAAQ,gBAA6B,SAAS,IAAI;AACpD;","names":[]}
1
+ {"version":3,"sources":["../src/data-parts.ts"],"sourcesContent":["import { z } from 'zod';\n\n/**\n * Custom `data-*` parts streamed by the Flexkit agent platform and rendered by\n * Studio. The server validates what it writes against these schemas and the\n * UI derives its part types from them, so the two can never drift.\n */\nexport const errorSchema = z.object({\n message: z.string(),\n});\n\nexport const dataPartSchema = z.object({\n 'plugin-connection': z.object({ pluginId: z.string(), connectionId: z.string().optional() }),\n /** Lifecycle of one plugin tool call, so the UI can name the in-flight call in its status line. */\n 'plugin-call': z.object({\n pluginId: z.string(),\n tool: z.string(),\n status: z.enum(['loading', 'done', 'error']),\n error: errorSchema.optional(),\n }),\n /** Written when the chat history was summarized before or during a turn. */\n 'context-compaction': z.object({\n reason: z.enum(['threshold', 'context_length_error']),\n status: z.enum(['done']),\n summarizedMessageCount: z.number(),\n }),\n /** The agent's working plan; replaced in place as steps complete. */\n plan: z.object({\n explanation: z.string().optional(),\n steps: z.array(\n z.object({\n status: z.enum(['pending', 'in_progress', 'completed']),\n step: z.string(),\n })\n ),\n updatedAt: z.string(),\n }),\n /** A delegated subtask of an automation run. */\n subtask: z.object({\n error: errorSchema.optional(),\n resultPreview: z.string().optional(),\n status: z.enum(['running', 'done', 'error']),\n stepsUsed: z.number().optional(),\n subtaskId: z.string(),\n title: z.string(),\n }),\n /** json-render patch lines, extracted from the assistant text by the stream pipeline. */\n spec: z.union([\n z.object({\n type: z.literal('patch'),\n patch: z.unknown(),\n }),\n z.object({\n type: z.literal('flat'),\n spec: z.unknown(),\n }),\n z.object({\n type: z.literal('nested'),\n spec: z.unknown(),\n }),\n ]),\n 'create-sandbox': z.object({\n sandboxId: z.string().optional(),\n status: z.enum(['loading', 'done', 'error']),\n error: errorSchema.optional(),\n }),\n 'generating-files': z.object({\n paths: z.array(z.string()),\n status: z.enum(['generating', 'uploading', 'uploaded', 'done', 'error']),\n error: errorSchema.optional(),\n }),\n 'run-artifact': z.object({\n artifactId: z.string().optional(),\n contentType: z.string().optional(),\n error: errorSchema.optional(),\n filename: z.string(),\n kind: z.enum(['html', 'pdf']).optional(),\n sizeBytes: z.number().optional(),\n status: z.enum(['uploading', 'done', 'error']),\n /** Persistent public URL of the stored artifact. */\n url: z.string().optional(),\n }),\n 'run-command': z.object({\n sandboxId: z.string(),\n commandId: z.string().optional(),\n command: z.string(),\n args: z.array(z.string()),\n status: z.enum(['executing', 'running', 'waiting', 'done', 'error']),\n exitCode: z.number().optional(),\n error: errorSchema.optional(),\n }),\n 'search-schema': z.object({\n query: z.string().optional(),\n status: z.enum(['loading', 'done', 'error']),\n error: errorSchema.optional(),\n }),\n 'web-search': z.object({\n query: z.string(),\n status: z.enum(['loading', 'done', 'error']),\n error: errorSchema.optional(),\n }),\n 'tool-delivery': z.object({\n channelId: z.string(),\n channelName: z.string(),\n provider: z.enum(['slack', 'teams']),\n status: z.enum(['loading', 'done', 'error']),\n error: errorSchema.optional(),\n }),\n 'validate-graphql': z.object({\n status: z.enum(['loading', 'valid', 'invalid', 'error']),\n errorCount: z.number().optional(),\n error: errorSchema.optional(),\n }),\n 'execute-graphql': z.object({\n operationType: z.enum(['query', 'mutation']).optional(),\n status: z.enum(['loading', 'done', 'error']),\n error: errorSchema.optional(),\n }),\n /** Emitted for proposals; the UI fetches the full proposal from the approvals API by id. */\n 'mutation-approval': z.object({\n approvalId: z.string(),\n affectedCount: z.number().nullable().optional(),\n decidedBy: z.string().optional(),\n operationsSummary: z.string(),\n reason: z.string().optional(),\n status: z.enum(['pending', 'approved', 'rejected', 'expired', 'cancelled', 'executed', 'error']),\n error: errorSchema.optional(),\n }),\n 'bulk-graphql-action': z.object({\n changedItems: z.number().optional(),\n failedItems: z.number().optional(),\n jobId: z.string().optional(),\n operationName: z.string(),\n processedItems: z.number().optional(),\n status: z.enum(['loading', 'running', 'done', 'error']),\n totalItems: z.number().optional(),\n error: errorSchema.optional(),\n }),\n 'update-memory': z.object({\n status: z.enum(['loading', 'done', 'error']),\n error: errorSchema.optional(),\n }),\n 'load-skill': z.object({\n /** True for skills attached to the automation, injected at run start rather than loaded on demand. */\n attached: z.boolean().optional(),\n skillName: z.string().optional(),\n status: z.enum(['loading', 'done', 'error']),\n error: errorSchema.optional(),\n }),\n /** Marker written by the run workflow for the trigger event so a run replays as a conversation. */\n 'user-message': z.object({\n parts: z.array(z.unknown()),\n }),\n /** Final report written by the run workflow when the agent finishes. */\n 'run-summary': z.object({\n status: z.enum(['success', 'skipped', 'failed']),\n summary: z.string(),\n }),\n /** A chat turn that ended with an error. */\n 'turn-error': z.object({\n message: z.string(),\n }),\n /** One follow-up instruction offered under a finished chat reply; clicking it fills the composer. */\n 'suggested-prompt': z.object({\n prompt: z.string(),\n }),\n /**\n * A message the user sent while the turn was running, at the point in the\n * reply where the agent received it. The UI shows it there, in place of the\n * stored user message it refers to.\n */\n 'mid-turn-message': z.object({\n attachments: z.array(\n z.object({ filename: z.string(), mediaType: z.string(), sizeBytes: z.number(), url: z.string() })\n ),\n messageId: z.string(),\n text: z.string(),\n }),\n});\n\nexport type DataPart = z.infer<typeof dataPartSchema>;\nexport type DataPartType = keyof DataPart;\n\nexport const DATA_PART_TYPES = Object.keys(dataPartSchema.shape) as DataPartType[];\n\nexport function isDataPartType(type: string): type is DataPartType {\n return (DATA_PART_TYPES as string[]).includes(type);\n}\n\n/** The `type` of a UI message part carrying this data part. */\nexport type DataPartMessageType = `data-${DataPartType}`;\n"],"mappings":";AAAA,SAAS,SAAS;AAOX,IAAM,cAAc,EAAE,OAAO;AAAA,EAClC,SAAS,EAAE,OAAO;AACpB,CAAC;AAEM,IAAM,iBAAiB,EAAE,OAAO;AAAA,EACrC,qBAAqB,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,GAAG,cAAc,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AAAA;AAAA,EAE3F,eAAe,EAAE,OAAO;AAAA,IACtB,UAAU,EAAE,OAAO;AAAA,IACnB,MAAM,EAAE,OAAO;AAAA,IACf,QAAQ,EAAE,KAAK,CAAC,WAAW,QAAQ,OAAO,CAAC;AAAA,IAC3C,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA;AAAA,EAED,sBAAsB,EAAE,OAAO;AAAA,IAC7B,QAAQ,EAAE,KAAK,CAAC,aAAa,sBAAsB,CAAC;AAAA,IACpD,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;AAAA,IACvB,wBAAwB,EAAE,OAAO;AAAA,EACnC,CAAC;AAAA;AAAA,EAED,MAAM,EAAE,OAAO;AAAA,IACb,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA,IACjC,OAAO,EAAE;AAAA,MACP,EAAE,OAAO;AAAA,QACP,QAAQ,EAAE,KAAK,CAAC,WAAW,eAAe,WAAW,CAAC;AAAA,QACtD,MAAM,EAAE,OAAO;AAAA,MACjB,CAAC;AAAA,IACH;AAAA,IACA,WAAW,EAAE,OAAO;AAAA,EACtB,CAAC;AAAA;AAAA,EAED,SAAS,EAAE,OAAO;AAAA,IAChB,OAAO,YAAY,SAAS;AAAA,IAC5B,eAAe,EAAE,OAAO,EAAE,SAAS;AAAA,IACnC,QAAQ,EAAE,KAAK,CAAC,WAAW,QAAQ,OAAO,CAAC;AAAA,IAC3C,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA,IAC/B,WAAW,EAAE,OAAO;AAAA,IACpB,OAAO,EAAE,OAAO;AAAA,EAClB,CAAC;AAAA;AAAA,EAED,MAAM,EAAE,MAAM;AAAA,IACZ,EAAE,OAAO;AAAA,MACP,MAAM,EAAE,QAAQ,OAAO;AAAA,MACvB,OAAO,EAAE,QAAQ;AAAA,IACnB,CAAC;AAAA,IACD,EAAE,OAAO;AAAA,MACP,MAAM,EAAE,QAAQ,MAAM;AAAA,MACtB,MAAM,EAAE,QAAQ;AAAA,IAClB,CAAC;AAAA,IACD,EAAE,OAAO;AAAA,MACP,MAAM,EAAE,QAAQ,QAAQ;AAAA,MACxB,MAAM,EAAE,QAAQ;AAAA,IAClB,CAAC;AAAA,EACH,CAAC;AAAA,EACD,kBAAkB,EAAE,OAAO;AAAA,IACzB,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA,IAC/B,QAAQ,EAAE,KAAK,CAAC,WAAW,QAAQ,OAAO,CAAC;AAAA,IAC3C,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,oBAAoB,EAAE,OAAO;AAAA,IAC3B,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC;AAAA,IACzB,QAAQ,EAAE,KAAK,CAAC,cAAc,aAAa,YAAY,QAAQ,OAAO,CAAC;AAAA,IACvE,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,gBAAgB,EAAE,OAAO;AAAA,IACvB,YAAY,EAAE,OAAO,EAAE,SAAS;AAAA,IAChC,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA,IACjC,OAAO,YAAY,SAAS;AAAA,IAC5B,UAAU,EAAE,OAAO;AAAA,IACnB,MAAM,EAAE,KAAK,CAAC,QAAQ,KAAK,CAAC,EAAE,SAAS;AAAA,IACvC,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA,IAC/B,QAAQ,EAAE,KAAK,CAAC,aAAa,QAAQ,OAAO,CAAC;AAAA;AAAA,IAE7C,KAAK,EAAE,OAAO,EAAE,SAAS;AAAA,EAC3B,CAAC;AAAA,EACD,eAAe,EAAE,OAAO;AAAA,IACtB,WAAW,EAAE,OAAO;AAAA,IACpB,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA,IAC/B,SAAS,EAAE,OAAO;AAAA,IAClB,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC;AAAA,IACxB,QAAQ,EAAE,KAAK,CAAC,aAAa,WAAW,WAAW,QAAQ,OAAO,CAAC;AAAA,IACnE,UAAU,EAAE,OAAO,EAAE,SAAS;AAAA,IAC9B,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,iBAAiB,EAAE,OAAO;AAAA,IACxB,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA,IAC3B,QAAQ,EAAE,KAAK,CAAC,WAAW,QAAQ,OAAO,CAAC;AAAA,IAC3C,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,cAAc,EAAE,OAAO;AAAA,IACrB,OAAO,EAAE,OAAO;AAAA,IAChB,QAAQ,EAAE,KAAK,CAAC,WAAW,QAAQ,OAAO,CAAC;AAAA,IAC3C,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,iBAAiB,EAAE,OAAO;AAAA,IACxB,WAAW,EAAE,OAAO;AAAA,IACpB,aAAa,EAAE,OAAO;AAAA,IACtB,UAAU,EAAE,KAAK,CAAC,SAAS,OAAO,CAAC;AAAA,IACnC,QAAQ,EAAE,KAAK,CAAC,WAAW,QAAQ,OAAO,CAAC;AAAA,IAC3C,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,oBAAoB,EAAE,OAAO;AAAA,IAC3B,QAAQ,EAAE,KAAK,CAAC,WAAW,SAAS,WAAW,OAAO,CAAC;AAAA,IACvD,YAAY,EAAE,OAAO,EAAE,SAAS;AAAA,IAChC,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,mBAAmB,EAAE,OAAO;AAAA,IAC1B,eAAe,EAAE,KAAK,CAAC,SAAS,UAAU,CAAC,EAAE,SAAS;AAAA,IACtD,QAAQ,EAAE,KAAK,CAAC,WAAW,QAAQ,OAAO,CAAC;AAAA,IAC3C,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA;AAAA,EAED,qBAAqB,EAAE,OAAO;AAAA,IAC5B,YAAY,EAAE,OAAO;AAAA,IACrB,eAAe,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS;AAAA,IAC9C,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA,IAC/B,mBAAmB,EAAE,OAAO;AAAA,IAC5B,QAAQ,EAAE,OAAO,EAAE,SAAS;AAAA,IAC5B,QAAQ,EAAE,KAAK,CAAC,WAAW,YAAY,YAAY,WAAW,aAAa,YAAY,OAAO,CAAC;AAAA,IAC/F,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,uBAAuB,EAAE,OAAO;AAAA,IAC9B,cAAc,EAAE,OAAO,EAAE,SAAS;AAAA,IAClC,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA,IACjC,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA,IAC3B,eAAe,EAAE,OAAO;AAAA,IACxB,gBAAgB,EAAE,OAAO,EAAE,SAAS;AAAA,IACpC,QAAQ,EAAE,KAAK,CAAC,WAAW,WAAW,QAAQ,OAAO,CAAC;AAAA,IACtD,YAAY,EAAE,OAAO,EAAE,SAAS;AAAA,IAChC,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,iBAAiB,EAAE,OAAO;AAAA,IACxB,QAAQ,EAAE,KAAK,CAAC,WAAW,QAAQ,OAAO,CAAC;AAAA,IAC3C,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA,EACD,cAAc,EAAE,OAAO;AAAA;AAAA,IAErB,UAAU,EAAE,QAAQ,EAAE,SAAS;AAAA,IAC/B,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA,IAC/B,QAAQ,EAAE,KAAK,CAAC,WAAW,QAAQ,OAAO,CAAC;AAAA,IAC3C,OAAO,YAAY,SAAS;AAAA,EAC9B,CAAC;AAAA;AAAA,EAED,gBAAgB,EAAE,OAAO;AAAA,IACvB,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC;AAAA,EAC5B,CAAC;AAAA;AAAA,EAED,eAAe,EAAE,OAAO;AAAA,IACtB,QAAQ,EAAE,KAAK,CAAC,WAAW,WAAW,QAAQ,CAAC;AAAA,IAC/C,SAAS,EAAE,OAAO;AAAA,EACpB,CAAC;AAAA;AAAA,EAED,cAAc,EAAE,OAAO;AAAA,IACrB,SAAS,EAAE,OAAO;AAAA,EACpB,CAAC;AAAA;AAAA,EAED,oBAAoB,EAAE,OAAO;AAAA,IAC3B,QAAQ,EAAE,OAAO;AAAA,EACnB,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMD,oBAAoB,EAAE,OAAO;AAAA,IAC3B,aAAa,EAAE;AAAA,MACb,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,GAAG,WAAW,EAAE,OAAO,GAAG,WAAW,EAAE,OAAO,GAAG,KAAK,EAAE,OAAO,EAAE,CAAC;AAAA,IAClG;AAAA,IACA,WAAW,EAAE,OAAO;AAAA,IACpB,MAAM,EAAE,OAAO;AAAA,EACjB,CAAC;AACH,CAAC;AAKM,IAAM,kBAAkB,OAAO,KAAK,eAAe,KAAK;AAExD,SAAS,eAAe,MAAoC;AACjE,SAAQ,gBAA6B,SAAS,IAAI;AACpD;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flexkit/agent-protocol",
3
- "version": "0.3.0",
3
+ "version": "0.3.2",
4
4
  "description": "Schemas and types shared between the Flexkit agent platform and its Studio UI: streamed data parts, run, approval and chat DTOs.",
5
5
  "keywords": [
6
6
  "flexkit",