@bpmn-nova/studio 0.3.0-preview → 0.3.2-preview

package/dist/modules/runtime/index.d.ts

@@ -0,0 +1,169 @@
+import type { BpmnEdge, BpmnNode, ProcessModel } from '../core/index.js'
+
+export type ActivityStatus = 'idle' | 'active' | 'completed' | 'failed' | 'cancelled' | 'skipped'
+export interface RuntimeParticipant { id?: string; name: string; avatarUrl?: string }
+export type RuntimeApprovalActionType =
+  | 'submit' | 'approve' | 'reject' | 'return' | 'add-sign' | 'transfer' | 'delegate' | 'withdraw' | 'comment' | 'skip'
+  | (string & {})
+export interface RuntimeAssetRef {
+  id: string
+  name: string
+  mediaType: string
+  size?: number
+  width?: number
+  height?: number
+}
+export type RuntimeApprovalContentBlock =
+  | { type: 'paragraph'; text: string }
+  | { type: 'image'; assetId: string; alt?: string }
+  | { type: 'file'; assetId: string }
+  | { type: string; [key: string]: unknown }
+export interface RuntimeApprovalContent {
+  plainText?: string
+  blocks?: RuntimeApprovalContentBlock[]
+  assets?: RuntimeAssetRef[]
+}
+export interface RuntimeApprovalAction {
+  id: string
+  type: RuntimeApprovalActionType
+  label?: string
+  elementId: string
+  visitId: string
+  activityId?: string
+  actor?: RuntimeParticipant
+  occurredAt: string
+  targets?: RuntimeParticipant[]
+  targetElementId?: string
+  content?: RuntimeApprovalContent
+  metadata?: Record<string, unknown>
+}
+export interface RuntimeApprovalActionPresentation extends Omit<RuntimeApprovalAction, 'content'> {
+  explicitLabel: string | null
+  label: string
+  iconId?: string
+  tone?: string
+  content: Required<RuntimeApprovalContent>
+  plainText: string
+  images: RuntimeAssetRef[]
+  files: RuntimeAssetRef[]
+  imageCount: number
+  fileCount: number
+  assetCount: number
+  order: number
+}
+export interface RuntimeApprovalActionSummary {
+  actions: RuntimeApprovalActionPresentation[]
+  latestAction: RuntimeApprovalActionPresentation | null
+  actionText: string
+  actionSummary: string
+  imageCount: number
+  fileCount: number
+  assetCount: number
+}
+export interface ActivityInstance {
+  id: string
+  elementId: string
+  status: Exclude<ActivityStatus, 'idle'>
+  startTime?: string
+  endTime?: string
+  assignee?: string
+  assigneeId?: string
+  participant?: RuntimeParticipant
+  visitId?: string
+  multiInstanceId?: string
+  approvalMode?: 'single' | 'all' | 'any'
+  multiInstanceMode?: 'parallel' | 'sequential'
+  totalInstances?: number
+  requiredInstances?: number
+  outcome?: string
+  comment?: string
+}
+export interface RuntimeTransition {
+  id: string
+  type: 'forward' | 'reject' | 'return' | 'skip'
+  sourceActivityId?: string
+  sourceElementId: string
+  targetElementId?: string
+  operator?: string
+  occurredAt?: string
+  time?: string
+  comment?: string
+  actionId?: string
+  state?: 'active' | 'resolved'
+  resolvedAt?: string
+  resolvedByActivityId?: string
+  invalidatedActivityIds?: string[]
+  invalidatedEdgeIds?: string[]
+}
+export interface RuntimeEdgeVisit {
+  id: string
+  edgeId: string
+  visitId?: string
+  occurredAt?: string
+  time?: string
+  status?: 'effective' | 'superseded'
+}
+export interface ProcessInstanceSnapshot {
+  processInstanceId: string
+  status: 'running' | 'completed' | 'suspended' | 'terminated'
+  activities: ActivityInstance[]
+  actions?: RuntimeApprovalAction[]
+  visitedEdges: string[]
+  transitions?: RuntimeTransition[]
+  edgeVisits?: RuntimeEdgeVisit[]
+}
+export interface RuntimeTransitionPresentation extends RuntimeTransition {
+  state: 'active' | 'resolved'
+  visible: boolean
+  sourceName: string
+  targetName: string
+  label: string
+  latest: boolean
+  issues: string[]
+  invalidatedActivityIds: string[]
+  invalidatedEdgeIds: string[]
+  action: RuntimeApprovalActionPresentation | null
+}
+export interface NodeRuntimePresentation extends RuntimeApprovalActionSummary {
+  elementId: string
+  status: ActivityStatus | 'rejected'
+  pathStatus: ActivityStatus
+  superseded: boolean
+  statusLabel: string
+  summary: string
+  fullSummary: string
+  participants: RuntimeParticipant[]
+  approvalMode: 'single' | 'all' | 'any' | null
+  multiInstanceMode: 'parallel' | 'sequential' | null
+  completed: number
+  total: number
+  required: number
+  round: number
+  records: ActivityInstance[]
+  latestRecords: ActivityInstance[]
+  visits: Array<{ id: string; round: number; records: ActivityInstance[] } & RuntimeApprovalActionSummary>
+  transitions: RuntimeTransitionPresentation[]
+  isReentry: boolean
+  hasDetails: boolean
+}
+export interface RuntimePresentation {
+  runtime: ProcessInstanceSnapshot
+  getNode(elementId: string): NodeRuntimePresentation
+  getEdge(edgeId: string): { edgeId: string; status: ActivityStatus; visited: boolean; historicallyVisited: boolean; superseded: boolean }
+  getAction(actionId: string): RuntimeApprovalActionPresentation | null
+  getActions(elementId?: string | null): RuntimeApprovalActionPresentation[]
+  getTransition(transitionId: string): RuntimeTransitionPresentation | null
+  getTransitions(): RuntimeTransitionPresentation[]
+}
+export interface RuntimeAppearanceLike {
+  resolveStatus(status: string): string
+  resolveAction(action?: { type?: string; explicitLabel?: string; label?: string }): { label: string; iconId: string; tone: string }
+  resolveTransition(transition?: { type?: string }): { tone: string }
+}
+
+export function normalizeRuntime(snapshot?: Partial<ProcessInstanceSnapshot> | null): ProcessInstanceSnapshot
+export function activityState(runtime: ProcessInstanceSnapshot | null | undefined, elementId: string): ActivityStatus
+export function createRuntimePresentation(context: { model: ProcessModel; runtime?: ProcessInstanceSnapshot | null; appearance?: RuntimeAppearanceLike | null }): RuntimePresentation
+export function demoRuntime(): ProcessInstanceSnapshot
+
+export type RuntimeElement = BpmnNode | BpmnEdge