sequential-workflow-designer 0.24.8 → 0.26.0

package/lib/index.d.ts

@@ -71,14 +71,18 @@ declare function race<A, B, C, D>(timeout: number, a: SimpleEvent<A>, b: SimpleE
 interface Behavior {
     onStart(position: Vector): void;
     onMove(delta: Vector): Behavior | void;
-    onEnd(interrupt: boolean, element: Element | null): void;
+    onEnd(interrupt: boolean, element: Element | null, previousEndToken: BehaviorEndToken | null): BehaviorEndToken | void;
+}
+interface BehaviorEndToken {
+    type: string;
 }
 
 declare class BehaviorController {
     private readonly dom;
     private readonly shadowRoot;
-    private state?;
     static create(shadowRoot: ShadowRoot | undefined): BehaviorController;
+    private previousEndToken;
+    private state;
     private constructor();
     start(startPosition: Vector, behavior: Behavior): void;
     private bind;
@@ -461,23 +465,27 @@ declare class ToolboxApi {
 }
 
 declare class ViewportApi {
+    private readonly state;
     private readonly workspaceController;
     private readonly viewportController;
-    constructor(workspaceController: WorkspaceControllerWrapper, viewportController: ViewportController);
+    private readonly animator;
+    constructor(state: DesignerState, workspaceController: WorkspaceControllerWrapper, viewportController: ViewportController);
+    limitScale(scale: number): number;
     resetViewport(): void;
     zoom(direction: boolean): void;
     moveViewportToStep(stepId: string): void;
+    handleWheelEvent(e: WheelEvent): void;
 }
 
 declare class WorkspaceApi {
     private readonly state;
     private readonly workspaceController;
     constructor(state: DesignerState, workspaceController: WorkspaceControllerWrapper);
+    getViewport(): Viewport;
+    setViewport(viewport: Viewport): void;
     getCanvasPosition(): Vector;
     getCanvasSize(): Vector;
     getRootComponentSize(): Vector;
-    getViewport(): Viewport;
-    setViewport(viewport: Viewport): void;
     updateRootComponent(): void;
     updateBadges(): void;
     updateCanvasSize(): void;
@@ -497,6 +505,15 @@ declare class DesignerApi {
     private constructor();
 }
 
+declare const TYPE = "selectStep";
+declare class SelectStepBehaviorEndToken implements BehaviorEndToken {
+    readonly stepId: string;
+    readonly time: number;
+    static is(token: BehaviorEndToken | null): token is SelectStepBehaviorEndToken;
+    readonly type = "selectStep";
+    constructor(stepId: string, time: number);
+}
+
 declare class Badges {
     private readonly g;
     private readonly position;
@@ -664,13 +681,13 @@ interface TaskStepExtensionConfiguration {
 }
 
 declare class CenteredViewportCalculator {
-    static center(margin: number, canvasSize: Vector, rootComponentSize: Vector): Viewport;
-    static focusOnComponent(canvasSize: Vector, viewport: Viewport, componentPosition: Vector, componentSize: Vector): Viewport;
+    static center(padding: number, canvasSize: Vector, rootComponentSize: Vector): Viewport;
+    static getFocusedOnComponent(canvasSize: Vector, viewport: Viewport, componentPosition: Vector, componentSize: Vector): Viewport;
 }
 
 declare class ClassicWheelController implements WheelController {
     private readonly api;
-    static create(api: WorkspaceApi): ClassicWheelController;
+    static create(api: ViewportApi): ClassicWheelController;
     private constructor();
     onWheel(e: WheelEvent): void;
 }
@@ -679,24 +696,32 @@ declare class ClassicWheelControllerExtension implements WheelControllerExtensio
     readonly create: typeof ClassicWheelController.create;
 }
 
-declare class QuantifiedScaleViewportCalculator {
-    static zoom(current: Viewport, direction: boolean): Viewport;
-    static zoomByWheel(current: Viewport, e: WheelEvent, canvasPosition: Vector): Viewport | null;
+interface DefaultViewportControllerConfiguration {
+    scales: number[];
+    smoothDeltaYLimit: number;
+    padding: number;
 }
 
 declare class DefaultViewportController implements ViewportController {
+    readonly smoothDeltaYLimit: number;
+    private readonly nqn;
     private readonly api;
-    static create(api: WorkspaceApi): DefaultViewportController;
-    private readonly animator;
+    private readonly padding;
+    static create(api: WorkspaceApi, configuration?: DefaultViewportControllerConfiguration): DefaultViewportController;
     private constructor();
-    setDefault(): void;
-    zoom(direction: boolean): void;
-    focusOnComponent(componentPosition: Vector, componentSize: Vector): void;
-    animateTo(viewport: Viewport): void;
+    getDefault(): Viewport;
+    getZoomed(direction: boolean): Viewport | null;
+    getFocusedOnComponent(componentPosition: Vector, componentSize: Vector): Viewport;
+    getNextScale(scale: number, direction: boolean): NextScale;
+    limitScale(scale: number): number;
 }
 
+type DefaultViewportControllerExtensionConfiguration = DefaultViewportControllerConfiguration;
 declare class DefaultViewportControllerExtension implements ViewportControllerExtension {
-    readonly create: typeof DefaultViewportController.create;
+    private readonly configuration;
+    static create(configuration?: DefaultViewportControllerExtensionConfiguration): DefaultViewportControllerExtension;
+    private constructor();
+    create(api: WorkspaceApi): DefaultViewportController;
 }
 
 interface RectPlaceholderConfiguration {
@@ -745,6 +770,7 @@ declare class DefaultRegionComponentViewExtension implements RegionComponentView
 interface DesignerExtension {
     steps?: StepExtension[];
     stepComponentViewWrapper?: StepComponentViewWrapperExtension;
+    clickBehaviorWrapperExtension?: ClickBehaviorWrapperExtension;
     badges?: BadgeExtension[];
     uiComponents?: UiComponentExtension[];
     draggedComponent?: DraggedComponentExtension;
@@ -793,6 +819,12 @@ interface SequenceContext {
 interface StepComponentViewWrapperExtension {
     wrap(view: StepComponentView, stepContext: StepContext): StepComponentView;
 }
+interface ClickBehaviorWrapperExtension {
+    create(customActionController: CustomActionController): ClickBehaviorWrapper;
+}
+interface ClickBehaviorWrapper {
+    wrap(behavior: Behavior, commandOrNull: ClickCommand | null): Behavior;
+}
 interface BadgeExtension {
     id: string;
     createForStep(parentElement: SVGElement, view: StepComponentView, stepContext: StepContext, componentContext: ComponentContext): Badge;
@@ -800,7 +832,7 @@ interface BadgeExtension {
     createStartValue(): unknown;
 }
 interface WheelControllerExtension {
-    create(api: WorkspaceApi): WheelController;
+    create(viewportApi: ViewportApi, workspaceApi: WorkspaceApi): WheelController;
 }
 interface WheelController {
     onWheel(e: WheelEvent): void;
@@ -865,9 +897,16 @@ interface ViewportControllerExtension {
     create(api: WorkspaceApi): ViewportController;
 }
 interface ViewportController {
-    setDefault(): void;
-    zoom(direction: boolean): void;
-    focusOnComponent(componentPosition: Vector, componentSize: Vector): void;
+    smoothDeltaYLimit: number;
+    getDefault(): Viewport;
+    getZoomed(direction: boolean): Viewport | null;
+    getFocusedOnComponent(componentPosition: Vector, componentSize: Vector): Viewport;
+    getNextScale(scale: number, direction: boolean): NextScale;
+    limitScale(scale: number): number;
+}
+interface NextScale {
+    current: number;
+    next: number;
 }
 interface Viewport {
     readonly position: Vector;
@@ -1106,13 +1145,9 @@ declare class ControlBarApi {
     private readonly state;
     private readonly historyController;
     private readonly stateModifier;
-    private readonly viewportApi;
-    static create(state: DesignerState, historyController: HistoryController | undefined, stateModifier: StateModifier, viewportApi: ViewportApi): ControlBarApi;
+    static create(state: DesignerState, historyController: HistoryController | undefined, stateModifier: StateModifier): ControlBarApi;
     private constructor();
     readonly onStateChanged: SimpleEvent<unknown>;
-    resetViewport(): void;
-    zoomIn(): void;
-    zoomOut(): void;
     isDragDisabled(): boolean;
     toggleIsDragDisabled(): void;
     isUndoRedoSupported(): boolean;
@@ -1124,6 +1159,50 @@ declare class ControlBarApi {
     canDelete(): boolean;
 }
 
+declare class DefaultViewportControllerDesignerExtension implements DesignerExtension {
+    readonly viewportController: ViewportControllerExtension;
+    static create(configuration: DefaultViewportControllerExtensionConfiguration): DesignerExtension;
+    private constructor();
+}
+
+declare class LineGrid implements Grid {
+    readonly size: Vector;
+    readonly element: SVGPathElement;
+    static create(size: Vector): LineGrid;
+    private constructor();
+    setScale(_: number, scaledSize: Vector): void;
+}
+
+declare class LineGridExtension implements GridExtension {
+    private readonly configuration;
+    static create(configuration?: LineGridConfiguration): LineGridExtension;
+    private constructor();
+    create(): LineGrid;
+}
+
+declare class LineGridDesignerExtension implements DesignerExtension {
+    readonly grid: LineGridExtension;
+    static create(configuration?: LineGridConfiguration): DesignerExtension;
+    private constructor();
+}
+
+declare class StartStopRootComponentDesignerExtension implements DesignerExtension {
+    readonly rootComponent: RootComponentExtension;
+    static create(configuration: StartStopRootComponentExtensionConfiguration): DesignerExtension;
+    private constructor();
+}
+
+interface StepsDesignerExtensionConfiguration {
+    container?: ContainerStepExtensionConfiguration;
+    switch?: SwitchStepExtensionConfiguration;
+    task?: TaskStepExtensionConfiguration;
+}
+declare class StepsDesignerExtension implements DesignerExtension {
+    readonly steps: StepExtension<Step>[];
+    static create(configuration: StepsDesignerExtensionConfiguration): StepsDesignerExtension;
+    protected constructor(steps: StepExtension<Step>[]);
+}
+
 declare class Editor {
     private readonly view;
     private readonly renderer;
@@ -1270,36 +1349,4 @@ declare class Designer<TDefinition extends Definition = Definition> {
     private getHistoryController;
 }
 
-declare class LineGrid implements Grid {
-    readonly size: Vector;
-    readonly element: SVGPathElement;
-    static create(size: Vector): LineGrid;
-    private constructor();
-    setScale(_: number, scaledSize: Vector): void;
-}
-
-declare class LineGridExtension implements GridExtension {
-    private readonly configuration;
-    static create(configuration?: LineGridConfiguration): LineGridExtension;
-    private constructor();
-    create(): LineGrid;
-}
-
-declare class LineGridDesignerExtension implements DesignerExtension {
-    readonly grid: LineGridExtension;
-    static create(configuration?: LineGridConfiguration): DesignerExtension;
-    private constructor();
-}
-
-interface StepsDesignerExtensionConfiguration {
-    container?: ContainerStepExtensionConfiguration;
-    switch?: SwitchStepExtensionConfiguration;
-    task?: TaskStepExtensionConfiguration;
-}
-declare class StepsDesignerExtension implements DesignerExtension {
-    readonly steps: StepExtension<Step>[];
-    static create(configuration: StepsDesignerExtensionConfiguration): StepsDesignerExtension;
-    protected constructor(steps: StepExtension<Step>[]);
-}
-
-export { Attributes, Badge, BadgeExtension, BadgeView, Badges, BadgesResult, BaseClickCommand, CenteredViewportCalculator, ClassicWheelControllerExtension, ClickCommand, ClickCommandType, ClickDetails, Component, ComponentContext, ComponentDom, ComponentView, ContainerStepComponentViewConfiguration, ContainerStepExtensionConfiguration, ContextMenuExtension, ContextMenuItem, ContextMenuItemsProvider, ControlBarApi, CustomAction, CustomActionController, CustomActionHandler, CustomActionHandlerContext, Daemon, DaemonExtension, DefaultRegionComponentViewExtension, DefaultRegionView, DefaultSequenceComponent, DefaultSequenceComponentView, DefaultViewportController, DefaultViewportControllerExtension, DefinitionChangeType, DefinitionChangedEvent, Designer, DesignerApi, DesignerConfiguration, DesignerContext, DesignerExtension, DesignerState, Dom, DraggedComponent, DraggedComponentExtension, Editor, EditorApi, EditorsConfiguration, FoundPlaceholders, Grid, GridExtension, I18n, Icons, InputView, JoinView, KeyboardAction, KeyboardConfiguration, LabelView, LineGridConfiguration, LineGridDesignerExtension, ObjectCloner, OpenFolderClickCommand, OutputView, PathBarApi, Placeholder, PlaceholderController, PlaceholderControllerExtension, PlaceholderDirection, PlaceholderExtension, PlaceholderView, PreferenceStorage, QuantifiedScaleViewportCalculator, RectPlaceholder, RectPlaceholderConfiguration, RectPlaceholderView, RegionComponentViewContentFactory, RegionComponentViewExtension, RegionView, RegionViewFactory, RerenderStepClickCommand, RootComponentExtension, RootEditorContext, RootEditorProvider, RootValidator, SelectStepClickCommand, SelectedStepIdProvider, SequenceComponent, SequenceComponentExtension, SequenceContext, SequencePlaceIndicator, Services, ServicesResolver, SimpleEvent, SimpleEventListener, StartStopRootComponentExtension, StartStopRootComponentExtensionConfiguration, StartStopRootComponentViewConfiguration, StateModifierDependency, StepComponent, StepComponentView, StepComponentViewContext, StepComponentViewFactory, StepComponentViewWrapperExtension, StepContext, StepDefinition, StepDescriptionProvider, StepEditorContext, StepEditorProvider, StepExtension, StepExtensionResolver, StepIconUrlProvider, StepLabelProvider, StepValidator, StepsConfiguration, StepsDesignerExtension, StepsDesignerExtensionConfiguration, SwitchStepComponentViewConfiguration, SwitchStepExtensionConfiguration, TaskStepComponentViewConfiguration, TaskStepExtensionConfiguration, ToolboxApi, ToolboxConfiguration, ToolboxGroupConfiguration, TriggerCustomActionClickCommand, UiComponent, UiComponentExtension, Uid, UidGenerator, UndoStack, UndoStackItem, ValidationErrorBadgeExtension, ValidationErrorBadgeExtensionConfiguration, ValidationErrorBadgeViewConfiguration, ValidatorConfiguration, Vector, Viewport, ViewportController, ViewportControllerExtension, WheelController, WheelControllerExtension, WorkspaceApi, createContainerStepComponentViewFactory, createSwitchStepComponentViewFactory, createTaskStepComponentViewFactory, getAbsolutePosition, race };
+export { Attributes, Badge, BadgeExtension, BadgeView, Badges, BadgesResult, BaseClickCommand, Behavior, BehaviorEndToken, CenteredViewportCalculator, ClassicWheelControllerExtension, ClickBehaviorWrapper, ClickBehaviorWrapperExtension, ClickCommand, ClickCommandType, ClickDetails, Component, ComponentContext, ComponentDom, ComponentView, ContainerStepComponentViewConfiguration, ContainerStepExtensionConfiguration, ContextMenuExtension, ContextMenuItem, ContextMenuItemsProvider, ControlBarApi, CustomAction, CustomActionController, CustomActionHandler, CustomActionHandlerContext, Daemon, DaemonExtension, DefaultRegionComponentViewExtension, DefaultRegionView, DefaultSequenceComponent, DefaultSequenceComponentView, DefaultViewportController, DefaultViewportControllerConfiguration, DefaultViewportControllerDesignerExtension, DefaultViewportControllerExtension, DefaultViewportControllerExtensionConfiguration, DefinitionChangeType, DefinitionChangedEvent, Designer, DesignerApi, DesignerConfiguration, DesignerContext, DesignerExtension, DesignerState, Dom, DraggedComponent, DraggedComponentExtension, Editor, EditorApi, EditorsConfiguration, FoundPlaceholders, Grid, GridExtension, I18n, Icons, InputView, JoinView, KeyboardAction, KeyboardConfiguration, LabelView, LineGridConfiguration, LineGridDesignerExtension, NextScale, ObjectCloner, OpenFolderClickCommand, OutputView, PathBarApi, Placeholder, PlaceholderController, PlaceholderControllerExtension, PlaceholderDirection, PlaceholderExtension, PlaceholderView, PreferenceStorage, RectPlaceholder, RectPlaceholderConfiguration, RectPlaceholderView, RegionComponentViewContentFactory, RegionComponentViewExtension, RegionView, RegionViewFactory, RerenderStepClickCommand, RootComponentExtension, RootEditorContext, RootEditorProvider, RootValidator, SelectStepBehaviorEndToken, SelectStepClickCommand, SelectedStepIdProvider, SequenceComponent, SequenceComponentExtension, SequenceContext, SequencePlaceIndicator, Services, ServicesResolver, SimpleEvent, SimpleEventListener, StartStopRootComponentDesignerExtension, StartStopRootComponentExtension, StartStopRootComponentExtensionConfiguration, StartStopRootComponentViewConfiguration, StateModifierDependency, StepComponent, StepComponentView, StepComponentViewContext, StepComponentViewFactory, StepComponentViewWrapperExtension, StepContext, StepDefinition, StepDescriptionProvider, StepEditorContext, StepEditorProvider, StepExtension, StepExtensionResolver, StepIconUrlProvider, StepLabelProvider, StepValidator, StepsConfiguration, StepsDesignerExtension, StepsDesignerExtensionConfiguration, SwitchStepComponentViewConfiguration, SwitchStepExtensionConfiguration, TYPE, TaskStepComponentViewConfiguration, TaskStepExtensionConfiguration, ToolboxApi, ToolboxConfiguration, ToolboxGroupConfiguration, TriggerCustomActionClickCommand, UiComponent, UiComponentExtension, Uid, UidGenerator, UndoStack, UndoStackItem, ValidationErrorBadgeExtension, ValidationErrorBadgeExtensionConfiguration, ValidationErrorBadgeViewConfiguration, ValidatorConfiguration, Vector, Viewport, ViewportApi, ViewportController, ViewportControllerExtension, WheelController, WheelControllerExtension, WorkspaceApi, createContainerStepComponentViewFactory, createSwitchStepComponentViewFactory, createTaskStepComponentViewFactory, getAbsolutePosition, race };

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "sequential-workflow-designer",
 	"description": "Customizable no-code component for building flow-based programming applications.",
-	"version": "0.24.8",
+	"version": "0.26.0",
 	"type": "module",
 	"main": "./lib/esm/index.js",
 	"types": "./lib/index.d.ts",