sequential-workflow-designer 0.35.3 → 0.37.0

package/lib/index.d.ts

@@ -1,3 +1,4 @@
+import * as sequential_workflow_model from 'sequential-workflow-model';
 import { Definition, Step, Sequence, ComponentType, DefinitionWalker, StepWithParentSequence, BranchedStep, StepOrName } from 'sequential-workflow-model';
 export * from 'sequential-workflow-model';
 
@@ -62,7 +63,7 @@ declare class SimpleEvent<T> {
     unsubscribe(listener: SimpleEventListener<T>): void;
     readonly forward: (value: T) => void;
     count(): number;
-    first(): Promise<T>;
+    once(): Promise<T>;
 }
 type SimpleEventListener<T> = (value: T) => void;
 
@@ -96,15 +97,13 @@ declare class BehaviorController {
     private stop;
 }
 
-interface DefinitionChangedEvent {
-    changeType: DefinitionChangeType;
-    stepId: string | null;
-}
+type DefinitionChangedEventDetails = Omit<DefinitionChangedEvent, 'definition' | 'changeType' | 'stepId'>;
 declare class DesignerState {
     definition: Definition;
     isReadonly: boolean;
     isToolboxCollapsed: boolean;
     isEditorCollapsed: boolean;
+    private readonly preferenceStorage;
     readonly onViewportChanged: SimpleEvent<Viewport>;
     readonly onSelectedStepIdChanged: SimpleEvent<string | null>;
     readonly onStepUnselectionBlocked: SimpleEvent<string | null>;
@@ -112,21 +111,22 @@ declare class DesignerState {
     readonly onIsReadonlyChanged: SimpleEvent<boolean>;
     readonly onIsDraggingChanged: SimpleEvent<boolean>;
     readonly onIsDragDisabledChanged: SimpleEvent<boolean>;
-    readonly onDefinitionChanged: SimpleEvent<DefinitionChangedEvent>;
+    readonly onDefinitionChanged: SimpleEvent<DefinitionChangedEvent<Definition>>;
     readonly onIsToolboxCollapsedChanged: SimpleEvent<boolean>;
     readonly onIsEditorCollapsedChanged: SimpleEvent<boolean>;
+    readonly onPreferencesChanged: SimpleEvent<PreferencesChangedEvent>;
     viewport: Viewport;
     selectedStepId: string | null;
     folderPath: string[];
     isDragging: boolean;
     isDragDisabled: boolean;
-    constructor(definition: Definition, isReadonly: boolean, isToolboxCollapsed: boolean, isEditorCollapsed: boolean);
+    constructor(definition: Definition, isReadonly: boolean, isToolboxCollapsed: boolean, isEditorCollapsed: boolean, preferenceStorage: PreferenceStorage);
     setSelectedStepId(stepId: string | null): void;
     pushStepIdToFolderPath(stepId: string): void;
     setFolderPath(path: string[]): void;
     tryGetLastStepIdFromFolderPath(): string | null;
     setDefinition(definition: Definition): void;
-    notifyDefinitionChanged(changeType: DefinitionChangeType, stepId: string | null): void;
+    notifyDefinitionChanged(changeType: DefinitionChangeType, stepId: string | null, details?: DefinitionChangedEventDetails): void;
     notifyStepUnselectionBlocked(stepId: string | null): void;
     setViewport(viewport: Viewport): void;
     setIsReadonly(isReadonly: boolean): void;
@@ -134,6 +134,8 @@ declare class DesignerState {
     setIsDragDisabled(isDragDisabled: boolean): void;
     setIsToolboxCollapsed(isCollapsed: boolean): void;
     setIsEditorCollapsed(isCollapsed: boolean): void;
+    setPreferences(changes: PreferenceChange[], stepId: string): void;
+    getPreference(key: string): string | null;
 }
 
 declare class DefinitionValidator {
@@ -202,7 +204,7 @@ interface ClickDetails {
     position: Vector;
     scale: number;
 }
-type ClickCommand = SelectStepClickCommand | RerenderStepClickCommand | OpenFolderClickCommand | TriggerCustomActionClickCommand;
+type ClickCommand = SelectStepClickCommand | SetPreferencesClickCommand | OpenFolderClickCommand | TriggerCustomActionClickCommand;
 interface BaseClickCommand {
     type: ClickCommandType;
 }
@@ -210,10 +212,10 @@ interface SelectStepClickCommand extends BaseClickCommand {
     type: ClickCommandType.selectStep;
     component: StepComponent;
 }
-interface RerenderStepClickCommand extends BaseClickCommand {
-    type: ClickCommandType.rerenderStep;
+interface SetPreferencesClickCommand extends BaseClickCommand {
+    type: ClickCommandType.changePreferences;
     step: Step;
-    beforeCallback?: () => void;
+    changes: PreferenceChange[];
 }
 interface OpenFolderClickCommand extends BaseClickCommand {
     type: ClickCommandType.openFolder;
@@ -227,7 +229,7 @@ interface TriggerCustomActionClickCommand extends BaseClickCommand {
 }
 declare enum ClickCommandType {
     selectStep = 1,
-    rerenderStep = 2,
+    changePreferences = 2,
     openFolder = 3,
     triggerCustomAction = 4
 }
@@ -429,7 +431,7 @@ declare class PathBarApi {
     private readonly state;
     private readonly definitionWalker;
     constructor(state: DesignerState, definitionWalker: DefinitionWalker);
-    readonly onStateChanged: SimpleEvent<[(string[] | undefined)?, (DefinitionChangedEvent | undefined)?, unknown?, unknown?]>;
+    readonly onStateChanged: SimpleEvent<[(string[] | undefined)?, (DefinitionChangedEvent<sequential_workflow_model.Definition> | undefined)?, unknown?, unknown?]>;
     setFolderPath(path: string[]): void;
     getFolderPath(): string[];
     getFolderPathStepNames(): string[];
@@ -873,7 +875,7 @@ interface StepComponentViewContext {
     createPlaceholderForArea(parentElement: SVGElement, size: Vector, direction: PlaceholderDirection, sequence: Sequence, index: number): Placeholder;
     createRegionComponentView(parentElement: SVGElement, componentClassName: string, contentFactory: RegionComponentViewContentFactory): StepComponentView;
     getPreference(key: string): string | null;
-    setPreference(key: string, value: string): void;
+    createPreferenceChange(key: string, value: string): PreferenceChange;
 }
 interface StepContext<S extends Step = Step> {
     parentSequence: Sequence;
@@ -1205,6 +1207,21 @@ declare enum DefinitionChangeType {
     stepInserted = 6,
     rootPropertyChanged = 7,
     rootReplaced = 8
+}
+type DuplicatedStepId = [sourceStepId: string, newStepId: string];
+interface DefinitionChangedEvent<TDefinition extends Definition = Definition> {
+    definition: TDefinition;
+    changeType: DefinitionChangeType;
+    stepId: string | null;
+    duplicatedStepIds?: DuplicatedStepId[];
+}
+interface PreferenceChange {
+    key: string;
+    value: string;
+}
+interface PreferencesChangedEvent {
+    stepId: string;
+    changes: PreferenceChange[];
 }
 
 declare class StateModifier {
@@ -1230,7 +1247,7 @@ declare class StateModifier {
      * @description Check the `isDeletable` callback before calling this method.
      */
     tryDeleteById(stepId: string): boolean;
-    tryInsert(step: Step, targetSequence: Sequence, targetIndex: number): boolean;
+    tryInsert(step: Step, targetSequence: Sequence, targetIndex: number, details?: DefinitionChangedEventDetails): boolean;
     isDraggable(step: Step, parentSequence: Sequence): boolean;
     tryMove(sourceSequence: Sequence, step: Step, targetSequence: Sequence, targetIndex: number): boolean;
     isDuplicable(step: Step, parentSequence: Sequence): boolean;
@@ -1323,7 +1340,6 @@ declare class Editor {
 declare class Designer<TDefinition extends Definition = Definition> {
     private readonly view;
     private readonly state;
-    private readonly stateModifier;
     private readonly walker;
     private readonly historyController;
     private readonly api;
@@ -1343,7 +1359,7 @@ declare class Designer<TDefinition extends Definition = Definition> {
     /**
      * @description Fires when the definition has changed.
      */
-    readonly onDefinitionChanged: SimpleEvent<TDefinition>;
+    readonly onDefinitionChanged: SimpleEvent<DefinitionChangedEvent<TDefinition>>;
     /**
      * @description Fires when the viewport has changed.
      */
@@ -1364,6 +1380,14 @@ declare class Designer<TDefinition extends Definition = Definition> {
      * @description Fires when the editor is collapsed or expanded.
      */
     readonly onIsEditorCollapsedChanged: SimpleEvent<boolean>;
+    /**
+     * @description Fires when the root component and all its children are rerendered.
+     */
+    readonly onRootComponentUpdated: SimpleEvent<void>;
+    /**
+     * @description Fires when any of the designer preferences has changed.
+     */
+    readonly onPreferencesChanged: SimpleEvent<PreferencesChangedEvent>;
     /**
      * @returns the current definition of the workflow.
      */
@@ -1463,4 +1487,4 @@ declare class Designer<TDefinition extends Definition = Definition> {
 }
 
 export { Badges, CenteredViewportCalculator, ClassicWheelControllerExtension, ClickCommandType, ComponentContext, ComponentDom, ControlBarApi, CustomActionController, DefaultRegionComponentViewExtension, DefaultRegionView, DefaultSequenceComponent, DefaultSequenceComponentView, DefaultViewportController, DefaultViewportControllerDesignerExtension, DefaultViewportControllerExtension, DefinitionChangeType, Designer, DesignerApi, DesignerContext, DesignerState, Dom, Editor, EditorApi, Icons, InputView, JoinView, KeyboardAction, LabelView, LineGridDesignerExtension, ObjectCloner, OutputView, PathBarApi, PlaceholderController, PlaceholderDirection, PlaceholderGapOrientation, RectPlaceholder, RectPlaceholderDesignerExtension, RectPlaceholderView, SelectStepBehaviorEndToken, ServicesResolver, SimpleEvent, StartStopRootComponentDesignerExtension, StartStopRootComponentExtension, StepComponent, StepExtensionResolver, StepsDesignerExtension, TYPE, ToolboxApi, Uid, ValidationErrorBadgeExtension, Vector, ViewportApi, WorkspaceApi, createContainerStepComponentViewFactory, createLaunchPadStepComponentViewFactory, createSwitchStepComponentViewFactory, createTaskStepComponentViewFactory, getAbsolutePosition, race };
-export type { Attributes, Badge, BadgeExtension, BadgeView, BadgesDecorator, BadgesResult, BaseClickCommand, Behavior, BehaviorEndToken, BranchNamesResolver, ClickBehaviorWrapper, ClickBehaviorWrapperExtension, ClickCommand, ClickDetails, Component, ComponentView, ContainerStepComponentViewConfiguration, ContainerStepExtensionConfiguration, ContextMenuExtension, ContextMenuItem, ContextMenuItemsProvider, CustomAction, CustomActionHandler, CustomActionHandlerContext, Daemon, DaemonExtension, DefaultViewportControllerConfiguration, DefaultViewportControllerExtensionConfiguration, DefinitionChangedEvent, DesignerConfiguration, DesignerExtension, DraggedComponent, DraggedComponentExtension, EditorsConfiguration, FoundPlaceholders, Grid, GridExtension, I18n, KeyboardConfiguration, LaunchPadStepComponentViewConfiguration, LaunchPadStepExtensionConfiguration, LineGridConfiguration, NextScale, OpenFolderClickCommand, Placeholder, PlaceholderConfiguration, PlaceholderExtension, PlaceholderView, PreferenceStorage, RectPlaceholderConfiguration, RegionComponentViewContentFactory, RegionComponentViewExtension, RegionView, RegionViewFactory, RerenderStepClickCommand, RootComponentExtension, RootEditorContext, RootEditorProvider, RootValidator, SelectStepClickCommand, SelectedStepIdProvider, SequenceComponent, SequenceComponentExtension, SequenceContext, SequencePlaceIndicator, Services, SimpleEventListener, StartStopRootComponentExtensionConfiguration, StartStopRootComponentViewConfiguration, StateModifierDependency, StepBadgesDecoratorExtension, StepComponentView, StepComponentViewContext, StepComponentViewFactory, StepComponentViewWrapperExtension, StepContext, StepDefinition, StepDescriptionProvider, StepEditorContext, StepEditorProvider, StepExtension, StepIconUrlProvider, StepLabelProvider, StepValidator, StepsConfiguration, StepsDesignerExtensionConfiguration, SwitchStepComponentViewConfiguration, SwitchStepExtensionConfiguration, TaskStepComponentViewConfiguration, TaskStepExtensionConfiguration, ToolboxConfiguration, ToolboxGroupConfiguration, TriggerCustomActionClickCommand, UiComponent, UiComponentExtension, UidGenerator, UndoStack, UndoStackItem, ValidationErrorBadgeExtensionConfiguration, ValidationErrorBadgeViewConfiguration, ValidatorConfiguration, Viewport, ViewportController, ViewportControllerExtension, WheelController, WheelControllerExtension, WorkspaceRootSequence };
+export type { Attributes, Badge, BadgeExtension, BadgeView, BadgesDecorator, BadgesResult, BaseClickCommand, Behavior, BehaviorEndToken, BranchNamesResolver, ClickBehaviorWrapper, ClickBehaviorWrapperExtension, ClickCommand, ClickDetails, Component, ComponentView, ContainerStepComponentViewConfiguration, ContainerStepExtensionConfiguration, ContextMenuExtension, ContextMenuItem, ContextMenuItemsProvider, CustomAction, CustomActionHandler, CustomActionHandlerContext, Daemon, DaemonExtension, DefaultViewportControllerConfiguration, DefaultViewportControllerExtensionConfiguration, DefinitionChangedEvent, DefinitionChangedEventDetails, DesignerConfiguration, DesignerExtension, DraggedComponent, DraggedComponentExtension, DuplicatedStepId, EditorsConfiguration, FoundPlaceholders, Grid, GridExtension, I18n, KeyboardConfiguration, LaunchPadStepComponentViewConfiguration, LaunchPadStepExtensionConfiguration, LineGridConfiguration, NextScale, OpenFolderClickCommand, Placeholder, PlaceholderConfiguration, PlaceholderExtension, PlaceholderView, PreferenceChange, PreferenceStorage, PreferencesChangedEvent, RectPlaceholderConfiguration, RegionComponentViewContentFactory, RegionComponentViewExtension, RegionView, RegionViewFactory, RootComponentExtension, RootEditorContext, RootEditorProvider, RootValidator, SelectStepClickCommand, SelectedStepIdProvider, SequenceComponent, SequenceComponentExtension, SequenceContext, SequencePlaceIndicator, Services, SetPreferencesClickCommand, SimpleEventListener, StartStopRootComponentExtensionConfiguration, StartStopRootComponentViewConfiguration, StateModifierDependency, StepBadgesDecoratorExtension, StepComponentView, StepComponentViewContext, StepComponentViewFactory, StepComponentViewWrapperExtension, StepContext, StepDefinition, StepDescriptionProvider, StepEditorContext, StepEditorProvider, StepExtension, StepIconUrlProvider, StepLabelProvider, StepValidator, StepsConfiguration, StepsDesignerExtensionConfiguration, SwitchStepComponentViewConfiguration, SwitchStepExtensionConfiguration, TaskStepComponentViewConfiguration, TaskStepExtensionConfiguration, ToolboxConfiguration, ToolboxGroupConfiguration, TriggerCustomActionClickCommand, UiComponent, UiComponentExtension, UidGenerator, UndoStack, UndoStackItem, ValidationErrorBadgeExtensionConfiguration, ValidationErrorBadgeViewConfiguration, ValidatorConfiguration, Viewport, ViewportController, ViewportControllerExtension, WheelController, WheelControllerExtension, WorkspaceRootSequence };

package/package.json

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