sequential-workflow-designer 0.19.4 → 0.21.0

package/lib/index.d.ts

@@ -167,7 +167,8 @@ interface ComponentView {
 interface StepComponentView extends ComponentView {
     sequenceComponents: SequenceComponent[] | null;
     placeholders: Placeholder[] | null;
-    hasOutput(): boolean;
+    hasOutput: boolean;
+    haveCollapsedChildren?: boolean;
     /**
      * @param click Details about the click.
      * @returns `true` if selected a step, a click command if clicked a specific action, `null` if not clicked at this view.
@@ -272,8 +273,11 @@ declare class ComponentContext {
     readonly iconProvider: IconProvider;
     readonly placeholderController: PlaceholderController;
     readonly stepComponentFactory: StepComponentFactory;
+    readonly definitionWalker: DefinitionWalker;
     readonly services: Services;
-    static create(stepsConfiguration: StepsConfiguration, validatorConfiguration: ValidatorConfiguration | undefined, state: DesignerState, stepExtensionResolver: StepExtensionResolver, services: Services): ComponentContext;
+    readonly preferenceStorage: PreferenceStorage;
+    readonly i18n: I18n;
+    static create(configuration: DesignerConfiguration, state: DesignerState, stepExtensionResolver: StepExtensionResolver, definitionWalker: DefinitionWalker, preferenceStorage: PreferenceStorage, i18n: I18n, services: Services): ComponentContext;
     private constructor();
 }
 
@@ -342,6 +346,7 @@ declare class DesignerContext {
     readonly services: Services;
     readonly componentContext: ComponentContext;
     readonly definitionWalker: DefinitionWalker;
+    readonly i18n: I18n;
     readonly stateModifier: StateModifier;
     readonly layoutController: LayoutController;
     readonly workspaceController: WorkspaceControllerWrapper;
@@ -349,7 +354,7 @@ declare class DesignerContext {
     readonly customActionController: CustomActionController;
     readonly historyController: HistoryController | undefined;
     static create(parent: HTMLElement, startDefinition: Definition, configuration: DesignerConfiguration, services: Services): DesignerContext;
-    constructor(theme: string, state: DesignerState, configuration: DesignerConfiguration, services: Services, componentContext: ComponentContext, definitionWalker: DefinitionWalker, stateModifier: StateModifier, layoutController: LayoutController, workspaceController: WorkspaceControllerWrapper, behaviorController: BehaviorController, customActionController: CustomActionController, historyController: HistoryController | undefined);
+    constructor(theme: string, state: DesignerState, configuration: DesignerConfiguration, services: Services, componentContext: ComponentContext, definitionWalker: DefinitionWalker, i18n: I18n, stateModifier: StateModifier, layoutController: LayoutController, workspaceController: WorkspaceControllerWrapper, behaviorController: BehaviorController, customActionController: CustomActionController, historyController: HistoryController | undefined);
     setWorkspaceController(controller: WorkspaceController): void;
 }
 
@@ -405,8 +410,9 @@ declare class PathBarApi {
 
 declare class ToolboxDataProvider {
     private readonly iconProvider;
+    private readonly i18n;
     private readonly configuration;
-    constructor(iconProvider: IconProvider, configuration: ToolboxConfiguration | false);
+    constructor(iconProvider: IconProvider, i18n: I18n, configuration: ToolboxConfiguration | false);
     getAllGroups(): ToolboxGroupData[];
     private readonly createItemData;
     applyFilter(allGroups: ToolboxGroupData[], filter: string | undefined): ToolboxGroupData[];
@@ -475,6 +481,7 @@ declare class DesignerApi {
     readonly viewport: ViewportApi;
     readonly pathBar: PathBarApi;
     readonly definitionWalker: DefinitionWalker;
+    readonly i18n: I18n;
     static create(context: DesignerContext): DesignerApi;
     private constructor();
 }
@@ -504,7 +511,7 @@ declare class ValidationErrorBadgeExtension implements BadgeExtension {
     static create(configuration?: ValidationErrorBadgeExtensionConfiguration): ValidationErrorBadgeExtension;
     readonly id = "validationError";
     private constructor();
-    createForStep(parentElement: SVGElement, stepContext: StepContext<Step>, componentContext: ComponentContext): Badge;
+    createForStep(parentElement: SVGElement, view: StepComponentView, stepContext: StepContext<Step>, componentContext: ComponentContext): Badge;
     createForRoot(parentElement: SVGElement, componentContext: ComponentContext): Badge;
     readonly createStartValue: () => boolean;
 }
@@ -548,17 +555,6 @@ declare class OutputView {
     setIsHidden(isHidden: boolean): void;
 }
 
-declare class RegionView {
-    private readonly lines;
-    private readonly width;
-    private readonly height;
-    static create(parent: SVGElement, widths: number[], height: number): RegionView;
-    constructor(lines: SVGLineElement[], width: number, height: number);
-    getClientPosition(): Vector;
-    resolveClick(click: ClickDetails): boolean;
-    setIsSelected(isSelected: boolean): void;
-}
-
 declare class DefaultSequenceComponentView implements ComponentView {
     readonly g: SVGGElement;
     readonly width: number;
@@ -702,6 +698,21 @@ declare class RectPlaceholder implements Placeholder {
     resolveClick(): null;
 }
 
+declare class DefaultRegionView implements RegionView {
+    private readonly lines;
+    private readonly width;
+    private readonly height;
+    static create(parent: SVGElement, widths: number[], height: number): DefaultRegionView;
+    constructor(lines: SVGLineElement[], width: number, height: number);
+    getClientPosition(): Vector;
+    resolveClick(click: ClickDetails): true | null;
+    setIsSelected(isSelected: boolean): void;
+}
+
+declare class DefaultRegionComponentViewExtension implements RegionComponentViewExtension {
+    create(parentElement: SVGElement, componentClassName: string, stepContext: StepContext, _: StepComponentViewContext, contentFactory: RegionComponentViewContentFactory): StepComponentView;
+}
+
 interface DesignerExtension {
     steps?: StepExtension[];
     stepComponentViewWrapper?: StepComponentViewWrapperExtension;
@@ -712,6 +723,7 @@ interface DesignerExtension {
     viewportController?: ViewportControllerExtension;
     placeholderController?: PlaceholderControllerExtension;
     placeholder?: PlaceholderExtension;
+    regionComponentView?: RegionComponentViewExtension;
     grid?: GridExtension;
     rootComponent?: RootComponentExtension;
     sequenceComponent?: SequenceComponentExtension;
@@ -724,9 +736,14 @@ interface StepExtension<S extends Step = Step> {
 }
 type StepComponentViewFactory = StepExtension['createComponentView'];
 interface StepComponentViewContext {
+    i18n: I18n;
+    getStepName(): string;
     getStepIconUrl(): string | null;
     createSequenceComponent(parentElement: SVGElement, sequence: Sequence): SequenceComponent;
     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;
 }
 interface StepContext<S extends Step = Step> {
     parentSequence: Sequence;
@@ -747,7 +764,7 @@ interface StepComponentViewWrapperExtension {
 }
 interface BadgeExtension {
     id: string;
-    createForStep(parentElement: SVGElement, stepContext: StepContext, componentContext: ComponentContext): Badge;
+    createForStep(parentElement: SVGElement, view: StepComponentView, stepContext: StepContext, componentContext: ComponentContext): Badge;
     createForRoot?: (parentElement: SVGElement, componentContext: ComponentContext) => Badge;
     createStartValue(): unknown;
 }
@@ -828,6 +845,19 @@ interface DaemonExtension {
 }
 interface Daemon {
     destroy(): void;
+}
+interface RegionView {
+    getClientPosition(): Vector;
+    /**
+     * @returns `true` if the click is inside the region, `null` if it's outside. The view may return a command to be executed.
+     */
+    resolveClick(click: ClickDetails): true | ClickCommand | null;
+    setIsSelected(isSelected: boolean): void;
+}
+type RegionViewFactory = (parent: SVGElement, widths: number[], height: number) => RegionView;
+type RegionComponentViewContentFactory = (g: SVGGElement, regionViewFactory: RegionViewFactory) => StepComponentView;
+interface RegionComponentViewExtension {
+    create(parentElement: SVGElement, componentClassName: string, stepContext: StepContext, viewContext: StepComponentViewContext, contentFactory: RegionComponentViewContentFactory): StepComponentView;
 }
 
 interface DesignerConfiguration<TDefinition extends Definition = Definition> {
@@ -888,12 +918,21 @@ interface DesignerConfiguration<TDefinition extends Definition = Definition> {
      * @description Custom definition walker.
      */
     definitionWalker?: DefinitionWalker;
+    /**
+     * @description Custom preference storage. By default, all preferences are stored in the memory.
+     */
+    preferenceStorage?: PreferenceStorage;
     /**
      * @description Custom generator of unique identifiers.
      */
     uidGenerator?: UidGenerator;
+    /**
+     * @description Custom translation function.
+     */
+    i18n?: I18n;
 }
 type UidGenerator = () => string;
+type I18n = (key: string, defaultValue: string) => string;
 type CustomActionHandler = (action: CustomAction, step: Step | null, sequence: Sequence, context: CustomActionHandlerContext) => void;
 interface CustomAction {
     type: string;
@@ -938,6 +977,10 @@ interface ToolboxGroupConfiguration {
     name: string;
     steps: StepDefinition[];
 }
+interface PreferenceStorage {
+    setItem(key: string, value: string): void;
+    getItem(key: string): string | null;
+}
 interface StepsConfiguration {
     isSelectable?: (step: Step, parentSequence: Sequence) => boolean;
     canInsertStep?: (step: Step, targetSequence: Sequence, targetIndex: number) => boolean;
@@ -1214,4 +1257,4 @@ declare class StepsDesignerExtension implements DesignerExtension {
     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, DefaultSequenceComponent, DefaultSequenceComponentView, DefaultViewportController, DefaultViewportControllerExtension, DefinitionChangeType, DefinitionChangedEvent, Designer, DesignerApi, DesignerConfiguration, DesignerContext, DesignerExtension, DesignerState, Dom, DraggedComponent, DraggedComponentExtension, Editor, EditorApi, EditorsConfiguration, Grid, GridExtension, Icons, InputView, JoinView, KeyboardAction, KeyboardConfiguration, LabelView, LineGridConfiguration, LineGridDesignerExtension, ObjectCloner, OpenFolderClickCommand, OutputView, PathBarApi, Placeholder, PlaceholderController, PlaceholderControllerExtension, PlaceholderDirection, PlaceholderExtension, PlaceholderView, QuantifiedScaleViewportCalculator, RectPlaceholder, RectPlaceholderConfiguration, RectPlaceholderView, RegionView, RerenderStepClickCommand, RootComponentExtension, RootEditorContext, RootEditorProvider, RootValidator, SelectStepClickCommand, SelectedStepIdProvider, SequenceComponent, SequenceComponentExtension, SequenceContext, SequencePlaceIndicator, Services, ServicesResolver, SimpleEvent, SimpleEventListener, 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, 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, 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, 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 };

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "sequential-workflow-designer",
 	"description": "Customizable no-code component for building flow-based programming applications.",
-	"version": "0.19.4",
+	"version": "0.21.0",
 	"type": "module",
 	"main": "./lib/esm/index.js",
 	"types": "./lib/index.d.ts",
@@ -89,7 +89,7 @@
 		"karma-spec-reporter": "^0.0.36",
 		"karma-typescript": "^5.5.3",
 		"karma-typescript-es6-transform": "^5.5.3",
-		"prettier": "^2.8.2",
+		"prettier": "^3.2.5",
 		"rollup": "^3.18.0",
 		"rollup-plugin-dts": "^5.2.0",
 		"rollup-plugin-typescript2": "^0.34.1",