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

package/dist/index.d.ts

@@ -1,18 +1,20 @@
-export * from '@bpmn-nova/core'
-export * from '@bpmn-nova/bpmn-model'
-export * from '@bpmn-nova/runtime'
-export * from '@bpmn-nova/theme'
-export * from '@bpmn-nova/designer'
-export * from '@bpmn-nova/viewer'
-export * from '@bpmn-nova/flowable'
-export * from '@bpmn-nova/activiti'
-export * from '@bpmn-nova/properties'
-export * from '@bpmn-nova/icons'
-export * from '@bpmn-nova/palette'
+export * from './modules/core/index.js'
+export * from './modules/bpmn-model/index.js'
+export * from './modules/runtime/index.js'
+export * from './modules/theme/index.js'
+export * from './modules/export-svg/index.js'
+export * from './modules/designer/index.js'
+export * from './modules/viewer/index.js'
+export * from './modules/engine-flowable/index.js'
+export * from './modules/engine-activiti/index.js'
+export * from './modules/properties/index.js'
+export * from './modules/icons/index.js'
+export * from './modules/palette/index.js'
 
 import type {
   BpmnEdge,
   BpmnNode,
+  EdgeType,
   ElementSelection,
   EngineId,
   LayoutOptions,
@@ -20,20 +22,21 @@ import type {
   Point,
   ProcessModel,
   SelectionRect,
-} from '@bpmn-nova/core'
-import type { IconRegistry } from '@bpmn-nova/icons'
-import type { PaletteRegistry } from '@bpmn-nova/palette'
-import type { PropertiesRegistry } from '@bpmn-nova/properties'
-import type { DiagramNodeRenderer, DiagramRendererOptions } from '@bpmn-nova/renderer'
+} from './modules/core/index.js'
+import type { IconRegistry } from './modules/icons/index.js'
+import type { PaletteRegistry } from './modules/palette/index.js'
+import type { PropertiesRegistry } from './modules/properties/index.js'
+import type { DiagramNodeRenderer, DiagramRendererOptions } from './modules/renderer-svg/index.js'
+import type { RuntimeTimelineSvgRenderer, SvgExportArtifact, SvgExportOptions, SvgExportPreviewController, SvgNodeRenderer } from './modules/export-svg/index.js'
 import type {
   ActivityInstance as RuntimeActivityInstance,
   ProcessInstanceSnapshot as RuntimeProcessInstanceSnapshot,
-} from '@bpmn-nova/runtime'
-import type { NovaThemeInput, NovaThemeMode, NovaThemeState, RuntimeAppearanceOptions, RuntimeAppearanceResolver } from '@bpmn-nova/theme'
+} from './modules/runtime/index.js'
+import type { NovaThemeInput, NovaThemeMode, NovaThemeState, RuntimeAppearanceOptions, RuntimeAppearanceResolver } from './modules/theme/index.js'
 import type {
   RuntimeDetailsRenderer,
   RuntimeTransitionDetailsRenderer,
-} from '@bpmn-nova/viewer'
+} from './modules/viewer/index.js'
 
 // Aggregate compatibility surface. Studio re-exports the package-level types,
 // and keeps these frequently consumed declarations visible at its own entry.
@@ -84,12 +87,12 @@ export interface RuntimeTransitionRoute {
   anchorStrategy: 'outer-same-side' | 'flow-axis-fallback'
   portConflicts: number
 }
-export function routeRuntimeTransition(model: ProcessModel, transition: import('@bpmn-nova/runtime').RuntimeTransition, options?: RuntimeTransitionRouteOptions): RuntimeTransitionRoute | null
+export function routeRuntimeTransition(model: ProcessModel, transition: import('./modules/runtime/index.js').RuntimeTransition, options?: RuntimeTransitionRouteOptions): RuntimeTransitionRoute | null
 
-export type RuntimeParticipant = import('@bpmn-nova/runtime').RuntimeParticipant
-export type RuntimeTransition = import('@bpmn-nova/runtime').RuntimeTransition
-export type NodeRuntimePresentation = import('@bpmn-nova/runtime').NodeRuntimePresentation
-export type RuntimePresentation = import('@bpmn-nova/runtime').RuntimePresentation
+export type RuntimeParticipant = import('./modules/runtime/index.js').RuntimeParticipant
+export type RuntimeTransition = import('./modules/runtime/index.js').RuntimeTransition
+export type NodeRuntimePresentation = import('./modules/runtime/index.js').NodeRuntimePresentation
+export type RuntimePresentation = import('./modules/runtime/index.js').RuntimePresentation
 export interface ActivityInstance extends RuntimeActivityInstance {
   visitId?: string
   multiInstanceId?: string
@@ -104,18 +107,18 @@ export interface ProcessInstanceSnapshot extends RuntimeProcessInstanceSnapshot
 }
 
 export type ViewerProjection = 'auto' | 'standard' | 'approval' | 'compact'
-export type RuntimeTraceProjection = import('@bpmn-nova/viewer').RuntimeTraceProjection
-export type RuntimeTraceItem = import('@bpmn-nova/viewer').RuntimeTraceItem
-export type RuntimeTraceLink = import('@bpmn-nova/viewer').RuntimeTraceLink
-export type RuntimeTraceGroup = import('@bpmn-nova/viewer').RuntimeTraceGroup
+export type RuntimeTraceProjection = import('./modules/viewer/index.js').RuntimeTraceProjection
+export type RuntimeTraceItem = import('./modules/viewer/index.js').RuntimeTraceItem
+export type RuntimeTraceLink = import('./modules/viewer/index.js').RuntimeTraceLink
+export type RuntimeTraceGroup = import('./modules/viewer/index.js').RuntimeTraceGroup
 export interface RuntimeTraceProjectionOptions {
   includePredicted?: boolean
   showStartMilestone?: boolean
   showEndMilestone?: boolean
 }
 export interface ViewerTimelineOptions {
-  title?: string | null | ((context: import('@bpmn-nova/viewer').ViewerTimelineContext) => string | null)
-  description?: string | null | ((context: import('@bpmn-nova/viewer').ViewerTimelineContext) => string | null)
+  title?: string | null | ((context: import('./modules/viewer/index.js').ViewerTimelineContext) => string | null)
+  description?: string | null | ((context: import('./modules/viewer/index.js').ViewerTimelineContext) => string | null)
 }
 export interface RuntimeDetailsLayoutOptions {
   placement?: 'popover' | 'center' | 'bottom'
@@ -129,13 +132,15 @@ export interface RuntimeDetailsOptions {
   desktop?: RuntimeDetailsLayoutOptions
   mobile?: RuntimeDetailsLayoutOptions
 }
-export type RuntimeTimelineRenderer = import('@bpmn-nova/viewer').RuntimeTimelineRenderer
-export type RuntimeTraceClickEvent = import('@bpmn-nova/viewer').RuntimeTraceClickEvent
+export type RuntimeTimelineRenderer = import('./modules/viewer/index.js').RuntimeTimelineRenderer
+export type RuntimeTraceClickEvent = import('./modules/viewer/index.js').RuntimeTraceClickEvent
 export interface ViewerOptions {
   container: HTMLElement
   model: ProcessModel
   runtime?: ProcessInstanceSnapshot | null
   iconRegistry?: IconRegistry
+  nodeRenderers?: Record<string, Function>
+  nodeRenderer?: Function
   projection?: ViewerProjection
   responsive?: boolean
   timeline?: ViewerTimelineOptions
@@ -143,15 +148,47 @@ export interface ViewerOptions {
   runtimeTraceOptions?: RuntimeTraceProjectionOptions
   onTraceClick?: (event: RuntimeTraceClickEvent) => void
   runtimePresenter?: (context: { model: ProcessModel; runtime: ProcessInstanceSnapshot | null; appearance: RuntimeAppearanceResolver }) => RuntimePresentation
+  runtimeTraceProjector?: import('./modules/viewer/index.js').ViewerOptions['runtimeTraceProjector']
+  runtimeAssetResolver?: import('./modules/viewer/index.js').RuntimeAssetResolver
+  theme?: NovaThemeInput
+  runtimeAppearance?: RuntimeAppearanceOptions
+  svgExport?: SvgExportOptions & { label?: string; nodeRenderers?: Record<string, SvgNodeRenderer>; runtimeTimelineRenderer?: RuntimeTimelineSvgRenderer }
+  onThemeChange?: (state: NovaThemeState) => void
+  runtimeTimelineRenderer?: RuntimeTimelineRenderer
+  onRuntimeTraceItemClick?: import('./modules/viewer/index.js').ViewerOptions['onRuntimeTraceItemClick']
+  onProjectionChange?: import('./modules/viewer/index.js').ViewerOptions['onProjectionChange']
   runtimeDetailsRenderer?: RuntimeDetailsRenderer | null
-  onRuntimeDetailsOpen?: Function
+  onRuntimeDetailsOpen?: import('./modules/viewer/index.js').ViewerOptions['onRuntimeDetailsOpen']
   runtimeTransitionDetailsRenderer?: RuntimeTransitionDetailsRenderer | null
-  onRuntimeTransitionDetailsOpen?: Function
+  onRuntimeTransitionDetailsOpen?: import('./modules/viewer/index.js').ViewerOptions['onRuntimeTransitionDetailsOpen']
+  onElementClick?: import('./modules/viewer/index.js').ViewerOptions['onElementClick']
 }
 export class BpmnViewer {
   constructor(options: ViewerOptions)
-  setDisplayOptions(options: { timeline?: ViewerTimelineOptions; runtimeDetails?: RuntimeDetailsOptions; runtimeTraceOptions?: RuntimeTraceProjectionOptions }): void
+  model: ProcessModel
+  runtime: ProcessInstanceSnapshot | null
+  projection: ViewerProjection
+  responsive: boolean
+  activeProjection: Exclude<ViewerProjection, 'auto'>
+  traceProjection: RuntimeTraceProjection | null
+  setModel(model: ProcessModel): void
+  setRuntime(runtime: ProcessInstanceSnapshot | null): void
+  setDisplayOptions(options: { timeline?: ViewerTimelineOptions; runtimeDetails?: RuntimeDetailsOptions; runtimeTraceOptions?: RuntimeTraceProjectionOptions; runtimeAssetResolver?: import('./modules/viewer/index.js').RuntimeAssetResolver | null }): void
+  setProjection(projection: ViewerProjection): void
+  setTheme(theme: NovaThemeInput): NovaThemeState
+  setThemeMode(mode: NovaThemeMode): NovaThemeState
+  getThemeState(): NovaThemeState
+  exportSvg(options?: SvgExportOptions): Promise<SvgExportArtifact>
+  openSvgExportPreview(options?: SvgExportOptions & { previewTitle?: string; onDownload?: (artifact: SvgExportArtifact) => void }): SvgExportPreviewController
+  setRuntimeAppearance(options: RuntimeAppearanceOptions | null): void
   fitView(): void
+  zoomBy(delta: number): void
+  clearSelection(): void
+  openRuntimeDetails(node: BpmnNode, presentation?: NodeRuntimePresentation, anchor?: Element | null): boolean
+  openRuntimeTransitionDetails(transition: import('./modules/runtime/index.js').RuntimeTransitionPresentation | string, anchor?: Element | null): boolean
+  closeRuntimeAssetPreview(): void
+  closeRuntimeDetails(): void
+  refresh(): void
   destroy(): void
 }
 
@@ -165,9 +202,16 @@ export interface StudioState {
   canRedo: boolean
   engine: EngineId
   propertiesProfile: 'business' | 'developer'
+  allowedNodeTypes: NodeType[] | null
+  allowedEdgeTypes: EdgeType[] | null
   activeScopeId: string
   scopePath: Array<{ id: string; name: string; kind: 'process' | 'subProcess' }>
 }
+export interface StudioValidationIssue {
+  level: 'error' | 'warning'
+  elementId?: string
+  message: string
+}
 export interface NodePreset extends Partial<Omit<BpmnNode, 'properties'>> { properties?: Record<string, unknown> }
 export interface TemplateDefinition {
   nodes: Array<{ key: string; nodeType: NodeType; offset?: Point; preset?: NodePreset }>
@@ -187,6 +231,8 @@ export interface StudioControllerOptions {
   historyLimit?: number
   extensions?: StudioExtension[]
   propertiesProfile?: 'business' | 'developer'
+  allowedNodeTypes?: Iterable<NodeType> | null
+  allowedEdgeTypes?: Iterable<EdgeType> | null
 }
 export interface StudioCommands {
   createNode(input: { nodeType: NodeType; point?: Point; preset?: NodePreset }): BpmnNode
@@ -253,6 +299,8 @@ export class BpmnStudioController {
   navigateToScope(scopeId: string): boolean
   setModel(model: ProcessModel, options?: { resetHistory?: boolean }): void
   setPropertiesProfile(profile: 'business' | 'developer'): void
+  allowsNodeType(nodeType: NodeType): boolean
+  allowsEdgeType(edgeType: EdgeType): boolean
   startConnect(sourceId: string): boolean
   cancelConnect(): void
   createNode(input: Parameters<StudioCommands['createNode']>[0]): BpmnNode
@@ -275,6 +323,7 @@ export class BpmnStudioController {
   redo(): boolean
   exportXml(engine?: EngineId): string
   importXml(xml: string, engine?: EngineId): ProcessModel
+  validate(): StudioValidationIssue[]
   registerExtension(extension: StudioExtension): () => void
   destroy(): void
 }
@@ -387,15 +436,45 @@ export class BpmnCanvas {
   setTheme(theme: NovaThemeInput): NovaThemeState
   setThemeMode(mode: NovaThemeMode): NovaThemeState
   getThemeState(): NovaThemeState
+  exportSvg(options?: SvgExportOptions): Promise<SvgExportArtifact>
+  openSvgExportPreview(options?: SvgExportOptions & { previewTitle?: string; onDownload?: (artifact: SvgExportArtifact) => void }): SvgExportPreviewController
   closeContextMenu(): void
   destroy(): void
 }
 export function createBpmnCanvas(options: BpmnCanvasOptions): BpmnCanvas
 
+export interface StudioShellActions {
+  undo(): boolean
+  redo(): boolean
+  beautify(options?: LayoutOptions): void
+  rerouteEdges(options?: LayoutOptions): void
+  fitView(): void
+  validate(): StudioValidationIssue[]
+  importXml(xml: string, engine?: EngineId): ProcessModel
+  exportXml(engine?: EngineId): string
+  exportSvg(options?: SvgExportOptions): Promise<SvgExportArtifact>
+  openSvgExportPreview(options?: SvgExportOptions & {
+    previewTitle?: string
+    onDownload?: (artifact: SvgExportArtifact) => void
+  }): SvgExportPreviewController | null
+}
+export interface StudioShellSlotContext {
+  studio: BpmnStudioController
+  shell: BpmnStudioShell
+  canvas: BpmnCanvas
+  actions: StudioShellActions
+  getState(): StudioState
+  subscribe(listener: (event: StudioEvent) => void): () => void
+}
+export type StudioShellDomSlot =
+  | HTMLElement
+  | ((context: StudioShellSlotContext & { container: HTMLElement }) => void | (() => void))
 export interface StudioShellSlots {
-  left?: HTMLElement | ((context: Record<string, unknown>) => void | (() => void))
-  right?: HTMLElement | ((context: Record<string, unknown>) => void | (() => void))
-  header?: HTMLElement | ((context: Record<string, unknown>) => void | (() => void))
+  left?: StudioShellDomSlot
+  right?: StudioShellDomSlot
+  headerStart?: StudioShellDomSlot
+  header?: StudioShellDomSlot
+  footer?: StudioShellDomSlot
   contextMenu?: ContextMenuSlot
   selectionToolbar?: SelectionToolbarSlot
   runtimeDetails?: RuntimeDetailsRenderer
@@ -403,6 +482,19 @@ export interface StudioShellSlots {
   runtimeTimeline?: RuntimeTimelineRenderer
   [name: string]: HTMLElement | Function | undefined
 }
+export type StudioShellRegionMode = 'default' | 'hidden'
+export interface StudioShellRegions {
+  header?: StudioShellRegionMode
+  left?: StudioShellRegionMode
+  right?: StudioShellRegionMode
+  footer?: StudioShellRegionMode
+}
+export interface StudioShellRegionState {
+  header: StudioShellRegionMode
+  left: StudioShellRegionMode
+  right: StudioShellRegionMode
+  footer: StudioShellRegionMode
+}
 export interface StudioShellOptions {
   container: HTMLElement
   studio: BpmnStudioController
@@ -416,9 +508,11 @@ export interface StudioShellOptions {
     timeline?: ViewerTimelineOptions
   }
   slots?: StudioShellSlots
+  regions?: StudioShellRegions
   layout?: (context: Record<string, unknown>) => void | (() => void)
   runtime?: ProcessInstanceSnapshot | null
   mode?: 'design' | 'viewer' | 'instance'
+  allowedModes?: Array<'design' | 'viewer' | 'instance'>
   projection?: ViewerProjection
   responsive?: boolean
   projectionOptions?: Array<{ value: ViewerProjection; label: string }>
@@ -426,12 +520,16 @@ export interface StudioShellOptions {
   rightWidth?: number
   theme?: NovaThemeInput
   runtimeAppearance?: RuntimeAppearanceOptions
+  svgExport?: SvgExportOptions & { label?: string; nodeRenderers?: Record<string, SvgNodeRenderer>; runtimeTimelineRenderer?: RuntimeTimelineSvgRenderer }
   onThemeChange?: (state: NovaThemeState) => void
 }
 export class BpmnStudioShell {
   constructor(options: StudioShellOptions)
+  readonly actions: StudioShellActions
   canvas?: BpmnCanvas
   viewer?: BpmnViewer
+  getRegions(): Readonly<StudioShellRegionState>
+  setRegions(regions: StudioShellRegions): Readonly<StudioShellRegionState>
   setMode(mode: 'design' | 'viewer' | 'instance'): void
   setRuntime(runtime: ProcessInstanceSnapshot | null): void
   setProjection(projection: ViewerProjection): void
@@ -442,6 +540,8 @@ export class BpmnStudioShell {
   setRuntimeAppearance(options: RuntimeAppearanceOptions | null): void
   fitView(): void
   zoomBy(factor: number): void
+  exportSvg(options?: SvgExportOptions): Promise<SvgExportArtifact>
+  openSvgExportPreview(options?: SvgExportOptions & { previewTitle?: string; onDownload?: (artifact: SvgExportArtifact) => void }): SvgExportPreviewController | null
   destroy(): void
 }
 export function createStudioShell(options: StudioShellOptions): BpmnStudioShell

package/dist/index.js

@@ -1,16 +1,17 @@
-export * from '@bpmn-nova/core';
-export * from '@bpmn-nova/bpmn-model';
-export * from '@bpmn-nova/runtime';
-export * from '@bpmn-nova/theme';
-export * from '@bpmn-nova/designer';
-export * from '@bpmn-nova/viewer';
-export * from '@bpmn-nova/flowable';
-export * from '@bpmn-nova/activiti';
-export * from '@bpmn-nova/properties';
+export * from './modules/core/index.js';
+export * from './modules/bpmn-model/index.js';
+export * from './modules/runtime/index.js';
+export * from './modules/theme/index.js';
+export * from './modules/export-svg/index.js';
+export * from './modules/designer/index.js';
+export * from './modules/viewer/index.js';
+export * from './modules/engine-flowable/index.js';
+export * from './modules/engine-activiti/index.js';
+export * from './modules/properties/index.js';
 export * from './controller.js';
 export * from './interactions.js';
 export * from './canvas.js';
 export * from './context-menu.js';
 export * from './shell.js';
-export * from '@bpmn-nova/icons';
-export * from '@bpmn-nova/palette';
+export * from './modules/icons/index.js';
+export * from './modules/palette/index.js';

package/dist/interactions.js

@@ -1,4 +1,4 @@
-import { NODE_DEFINITIONS } from '@bpmn-nova/core';
+import { NODE_DEFINITIONS } from './modules/core/index.js';
 
 export const CREATE_INTENT_MIME = 'application/x-bpmn-nova-create-intent+json';
 

package/dist/modules/bpmn-model/index.d.ts

@@ -0,0 +1,11 @@
+import type { EngineId, ProcessModel } from '../core/index.js'
+import type { FlowableEngineProfile } from '../engine-flowable/index.js'
+import type { ActivitiEngineProfile } from '../engine-activiti/index.js'
+
+export const engineProfiles: {
+  flowable: FlowableEngineProfile
+  activiti: ActivitiEngineProfile
+}
+export function detectEngineFromXml(xml: string): EngineId
+export function importBpmn(xml: string, engineHint?: EngineId): ProcessModel
+export function exportBpmn(model: ProcessModel, engineOverride?: EngineId): string