@eclipse-glsp/client 0.10.0-next.e5fcffe.169 → 1.0.0

package/lib/features/layout/{layout-commands.d.ts → layout-elements-action.d.ts}

@@ -13,9 +13,8 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Action, ElementAndBounds } from '@eclipse-glsp/protocol';
-import { Command, CommandExecutionContext, CommandReturn, ElementMove, IActionDispatcher, SModelElement } from 'sprotty';
-import { WriteableElementAndBounds, WriteableElementMove } from '../../utils/layout-utils';
+import { Action, ElementAndBounds, Writable } from '@eclipse-glsp/protocol';
+import { ElementMove, IActionDispatcher, IActionHandler, ICommand, SModelElement } from 'sprotty';
 import { BoundsAwareModelElement } from '../../utils/smodel-util';
 import { IMovementRestrictor } from '../change-bounds/movement-restrictor';
 import { SelectionService } from '../select/selection-service';
@@ -27,7 +26,13 @@ export declare enum ResizeDimension {
     Height = 1,
     Width_And_Height = 2
 }
-export declare namespace Reduce {
+/**
+ * A function that computes a single number from a set of given numbers
+ * i.e. it reduces the given numbers to one single number.
+ * Mainly used by the {@link ResizeElementsCommand} to reduce the given dimensions to a target dimension value.
+ */
+export declare type ReduceFunction = (...values: number[]) => number;
+export declare namespace ReduceFunction {
     /**
      * Returns the minimal value of the given numbers.
      * @param values Numbers to be evaluated.
@@ -58,12 +63,14 @@ export declare namespace Reduce {
      */
     function last(...values: number[]): number;
     /**
-     * Returns the reduce function that corresponds to the given {@link ReduceFunctionKind}.
+     * Returns the reduce function that corresponds to the given {@link ReduceFunctionType}.
      * @param type The reduce function kind.
      * @returns The corresponding reduce function.
      */
+    function get(type: ReduceFunctionType): ReduceFunction;
 }
-declare type ReduceFn = (...values: number[]) => number;
+/** Union type of all {@link ReduceFunction} keys. */
+export declare type ReduceFunctionType = Exclude<keyof typeof ReduceFunction, 'get'>;
 export interface ResizeElementsAction extends Action {
     kind: typeof ResizeElementsAction.KIND;
     /**
@@ -75,9 +82,9 @@ export interface ResizeElementsAction extends Action {
      */
     dimension: ResizeDimension;
     /**
-     * Function to reduce the dimension to a target dimension value, see Reduce.* for potential functions.
+     * Type of the {@link ReduceFunction} that should be used to reduce the dimension to a target dimension value
      */
-    reductionFunction: ReduceFn;
+    reduceFunction: ReduceFunctionType;
 }
 export declare namespace ResizeElementsAction {
     const KIND = "resizeElementAction";
@@ -85,9 +92,30 @@ export declare namespace ResizeElementsAction {
     function create(options: {
         elementIds?: string[];
         dimension?: ResizeDimension;
-        reductionFunction: ReduceFn;
+        reduceFunction: ReduceFunctionType;
     }): ResizeElementsAction;
 }
+export declare abstract class LayoutElementsActionHandler implements IActionHandler {
+    protected actionDispatcher: IActionDispatcher;
+    protected selectionService: SelectionService;
+    protected movementRestrictor?: IMovementRestrictor;
+    abstract handle(action: Action): void | Action | ICommand;
+    getSelectedElements(selection: {
+        elementIds: string[];
+    }): BoundsAwareModelElement[];
+    protected abstract isActionElement(element: SModelElement): element is BoundsAwareModelElement;
+    dispatchAction(action: Action): void;
+    dispatchActions(actions: Action[]): void;
+}
+export declare class ResizeElementsActionHandler extends LayoutElementsActionHandler {
+    handle(action: ResizeElementsAction): void;
+    resizeWidth(elements: BoundsAwareModelElement[], reduceFn: ReduceFunction): void;
+    resizeHeight(elements: BoundsAwareModelElement[], reduceFn: ReduceFunction): void;
+    resizeWidthAndHeight(elements: BoundsAwareModelElement[], reduceFn: ReduceFunction): void;
+    dispatchResizeActions(elements: BoundsAwareModelElement[], change: (element: BoundsAwareModelElement, bounds: Writable<ElementAndBounds>) => void): void;
+    createElementAndBounds(element: BoundsAwareModelElement, change: (_element: BoundsAwareModelElement, _bounds: Writable<ElementAndBounds>) => void): Writable<ElementAndBounds> | undefined;
+    protected isActionElement(element: SModelElement): element is BoundsAwareModelElement;
+}
 export declare enum Alignment {
     Left = 0,
     Center = 1,
@@ -96,12 +124,39 @@ export declare enum Alignment {
     Middle = 4,
     Bottom = 5
 }
-export declare namespace Select {
+/**
+ * A function that retrieves a specific (sub)-selection of elements from a given set of elements.
+ * Mainly used by the {@link AlignElementsActionHandler}.
+ */
+export declare type SelectFunction = (elements: BoundsAwareModelElement[]) => BoundsAwareModelElement[];
+export declare namespace SelectFunction {
+    /**
+     * Select all elements from the given set of elements.
+     * @param elements The set of elements.
+     * @returns All elements.
+     */
     function all(elements: BoundsAwareModelElement[]): BoundsAwareModelElement[];
+    /**
+     * Select the first element from a given set of elements.
+     * @param elements The elements.
+     * @returns An array containing the first element of the given elements.
+     */
     function first(elements: BoundsAwareModelElement[]): BoundsAwareModelElement[];
+    /**
+     * Select the last element from a given set of elements.
+     * @param elements The elements.
+     * @returns An array containing the last element of the given elements.
+     */
     function last(elements: BoundsAwareModelElement[]): BoundsAwareModelElement[];
+    /**
+     * Returns the select function that corresponds to the given {@link SelectFunctionType}.
+     * @param type The select function type.
+     * @returns The corresponding select function.
+     */
+    function get(kind: SelectFunctionType): SelectFunction;
 }
-declare type SelectFn = (elements: BoundsAwareModelElement[]) => BoundsAwareModelElement[];
+/** Union type of all {@link SelectFunction} keys. */
+export declare type SelectFunctionType = Exclude<keyof typeof SelectFunction, 'get'>;
 export interface AlignElementsAction extends Action {
     kind: typeof AlignElementsAction.KIND;
     /**
@@ -113,10 +168,10 @@ export interface AlignElementsAction extends Action {
      */
     alignment: Alignment;
     /**
-     * Function to selected elements that are considered during alignment calculation, see Select.* for potential functions.
+     * Function to selected elements that are considered during alignment calculation.
      * The default value is {@link Select.all}.
      */
-    selectionFunction: SelectFn;
+    selectFunction: SelectFunctionType;
 }
 export declare namespace AlignElementsAction {
     const KIND = "alignElements";
@@ -124,57 +179,20 @@ export declare namespace AlignElementsAction {
     function create(options?: {
         elementIds?: string[];
         alignment?: Alignment;
-        selectionFunction?: SelectFn;
+        selectionFunction?: SelectFunctionType;
     }): AlignElementsAction;
 }
-declare abstract class LayoutElementsCommand extends Command {
-    protected action: ResizeElementsAction | AlignElementsAction;
-    protected actionDispatcher: IActionDispatcher;
-    protected selectionService: SelectionService;
-    readonly movementRestrictor?: IMovementRestrictor | undefined;
-    constructor(action: ResizeElementsAction | AlignElementsAction, actionDispatcher: IActionDispatcher, selectionService: SelectionService, movementRestrictor?: IMovementRestrictor | undefined);
-    getActionElements(context: CommandExecutionContext): BoundsAwareModelElement[];
-    protected abstract isActionElement(element: SModelElement): element is BoundsAwareModelElement;
-    dispatchAction(action: Action): void;
-    dispatchActions(actions: Action[]): void;
-}
-export declare class ResizeElementsCommand extends LayoutElementsCommand {
-    protected action: ResizeElementsAction;
-    protected actionDispatcher: IActionDispatcher;
-    protected selectionService: SelectionService;
-    readonly movementRestrictor?: IMovementRestrictor | undefined;
-    static readonly KIND = "resizeElementAction";
-    constructor(action: ResizeElementsAction, actionDispatcher: IActionDispatcher, selectionService: SelectionService, movementRestrictor?: IMovementRestrictor | undefined);
-    protected isActionElement(element: SModelElement): element is BoundsAwareModelElement;
-    execute(context: CommandExecutionContext): CommandReturn;
-    resizeWidth(elements: BoundsAwareModelElement[]): void;
-    resizeHeight(elements: BoundsAwareModelElement[]): void;
-    resizeWidthAndHeight(elements: BoundsAwareModelElement[]): void;
-    dispatchResizeActions(elements: BoundsAwareModelElement[], change: (element: BoundsAwareModelElement, bounds: WriteableElementAndBounds) => void): void;
-    createElementAndBounds(element: BoundsAwareModelElement, change: (_element: BoundsAwareModelElement, _bounds: WriteableElementAndBounds) => void): WriteableElementAndBounds | undefined;
-    undo(context: CommandExecutionContext): CommandReturn;
-    redo(context: CommandExecutionContext): CommandReturn;
-}
-export declare class AlignElementsCommand extends LayoutElementsCommand {
-    protected action: AlignElementsAction;
-    protected actionDispatcher: IActionDispatcher;
-    protected selectionService: SelectionService;
-    readonly movementRestrictor?: IMovementRestrictor | undefined;
-    static readonly KIND = "alignElements";
-    constructor(action: AlignElementsAction, actionDispatcher: IActionDispatcher, selectionService: SelectionService, movementRestrictor?: IMovementRestrictor | undefined);
-    protected isActionElement(element: SModelElement): element is BoundsAwareModelElement;
-    execute(context: CommandExecutionContext): CommandReturn;
+export declare class AlignElementsActionHandler extends LayoutElementsActionHandler {
+    handle(action: AlignElementsAction): void;
     alignLeft(elements: BoundsAwareModelElement[]): void;
     alignCenter(elements: BoundsAwareModelElement[]): void;
     alignRight(elements: BoundsAwareModelElement[]): void;
     alignTop(elements: BoundsAwareModelElement[]): void;
     alignMiddle(elements: BoundsAwareModelElement[]): void;
     alignBottom(elements: BoundsAwareModelElement[]): void;
-    dispatchAlignActions(elements: BoundsAwareModelElement[], change: (element: BoundsAwareModelElement, move: WriteableElementMove) => void): void;
-    createElementMove(element: BoundsAwareModelElement, change: (_element: BoundsAwareModelElement, _move: WriteableElementMove) => void): WriteableElementMove | undefined;
+    dispatchAlignActions(elements: BoundsAwareModelElement[], change: (element: BoundsAwareModelElement, move: Writable<ElementMove>) => void): void;
+    createElementMove(element: BoundsAwareModelElement, change: (_element: BoundsAwareModelElement, _move: Writable<ElementMove>) => void): Writable<ElementMove> | undefined;
     createElementAndBounds(element: BoundsAwareModelElement, move: ElementMove): ElementAndBounds;
-    undo(context: CommandExecutionContext): CommandReturn;
-    redo(context: CommandExecutionContext): CommandReturn;
+    protected isActionElement(element: SModelElement): element is BoundsAwareModelElement;
 }
-export {};
-//# sourceMappingURL=layout-commands.d.ts.map
+//# sourceMappingURL=layout-elements-action.d.ts.map

package/lib/features/layout/layout-elements-action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"layout-elements-action.d.ts","sourceRoot":"","sources":["../../../src/features/layout/layout-elements-action.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;kFAckF;AAClF,OAAO,EACH,MAAM,EAEN,gBAAgB,EAKhB,QAAQ,EACX,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,cAAc,EAAE,QAAQ,EAAc,aAAa,EAAE,MAAM,SAAS,CAAC;AAG9G,OAAO,EAAE,uBAAuB,EAAe,MAAM,yBAAyB,CAAC;AAE/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAE/D;;GAEG;AAEH,oBAAY,eAAe;IACvB,KAAK,IAAA;IACL,MAAM,IAAA;IACN,gBAAgB,IAAA;CACnB;AAED;;;;GAIG;AACH,oBAAY,cAAc,GAAG,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,KAAK,MAAM,CAAC;AAE7D,yBAAiB,cAAc,CAAC;IAC5B;;;;OAIG;IACH,SAAgB,GAAG,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAE/C;IAED;;;;OAIG;IACH,SAAgB,GAAG,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAE/C;IAED;;;OAGG;IACH,SAAgB,GAAG,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAE/C;IAED;;;;OAIG;IACH,SAAgB,KAAK,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAEjD;IAED;;;;OAIG;IACH,SAAgB,IAAI,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAEhD;IAED;;;;OAIG;IACH,SAAgB,GAAG,CAAC,IAAI,EAAE,kBAAkB,GAAG,cAAc,CAE5D;CACJ;AAED,qDAAqD;AACrD,oBAAY,kBAAkB,GAAG,OAAO,CAAC,MAAM,OAAO,cAAc,EAAE,KAAK,CAAC,CAAC;AAE7E,MAAM,WAAW,oBAAqB,SAAQ,MAAM;IAChD,IAAI,EAAE,OAAO,oBAAoB,CAAC,IAAI,CAAC;IAEvC;;OAEG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,eAAe,CAAC;IAE3B;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;CACtC;AAED,yBAAiB,oBAAoB,CAAC;IAC3B,MAAM,IAAI,wBAAwB,CAAC;IAE1C,SAAgB,EAAE,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,oBAAoB,CAO9D;IAED,SAAgB,MAAM,CAAC,OAAO,EAAE;QAC5B,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;QACtB,SAAS,CAAC,EAAE,eAAe,CAAC;QAC5B,cAAc,EAAE,kBAAkB,CAAC;KACtC,GAAG,oBAAoB,CAOvB;CACJ;AAED,8BACsB,2BAA4B,YAAW,cAAc;IAEvE,SAAS,CAAC,gBAAgB,EAAE,iBAAiB,CAAC;IAG9C,SAAS,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;IAI7C,SAAS,CAAC,kBAAkB,CAAC,EAAE,mBAAmB,CAAC;IAEnD,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,QAAQ;IAEzD,mBAAmB,CAAC,SAAS,EAAE;QAAE,UAAU,EAAE,MAAM,EAAE,CAAA;KAAE,GAAG,uBAAuB,EAAE;IAMnF,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,IAAI,uBAAuB;IAE9F,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIpC,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;CAG3C;AAED,qBACa,2BAA4B,SAAQ,2BAA2B;IACxE,MAAM,CAAC,MAAM,EAAE,oBAAoB,GAAG,IAAI;IAe1C,WAAW,CAAC,QAAQ,EAAE,uBAAuB,EAAE,EAAE,QAAQ,EAAE,cAAc,GAAG,IAAI;IAUhF,YAAY,CAAC,QAAQ,EAAE,uBAAuB,EAAE,EAAE,QAAQ,EAAE,cAAc,GAAG,IAAI;IAUjF,oBAAoB,CAAC,QAAQ,EAAE,uBAAuB,EAAE,EAAE,QAAQ,EAAE,cAAc,GAAG,IAAI;IAYzF,qBAAqB,CACjB,QAAQ,EAAE,uBAAuB,EAAE,EACnC,MAAM,EAAE,CAAC,OAAO,EAAE,uBAAuB,EAAE,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,KAAK,IAAI,GACvF,IAAI;IAaP,sBAAsB,CAClB,OAAO,EAAE,uBAAuB,EAChC,MAAM,EAAE,CAAC,QAAQ,EAAE,uBAAuB,EAAE,OAAO,EAAE,QAAQ,CAAC,gBAAgB,CAAC,KAAK,IAAI,GACzF,QAAQ,CAAC,gBAAgB,CAAC,GAAG,SAAS;IAezC,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,IAAI,uBAAuB;CAGxF;AAGD,oBAAY,SAAS;IACjB,IAAI,IAAA;IACJ,MAAM,IAAA;IACN,KAAK,IAAA;IACL,GAAG,IAAA;IACH,MAAM,IAAA;IACN,MAAM,IAAA;CACT;AAED;;;GAGG;AACH,oBAAY,cAAc,GAAG,CAAC,QAAQ,EAAE,uBAAuB,EAAE,KAAK,uBAAuB,EAAE,CAAC;AAChG,yBAAiB,cAAc,CAAC;IAC5B;;;;OAIG;IACH,SAAgB,GAAG,CAAC,QAAQ,EAAE,uBAAuB,EAAE,GAAG,uBAAuB,EAAE,CAElF;IAED;;;;OAIG;IACH,SAAgB,KAAK,CAAC,QAAQ,EAAE,uBAAuB,EAAE,GAAG,uBAAuB,EAAE,CAEpF;IAED;;;;OAIG;IACH,SAAgB,IAAI,CAAC,QAAQ,EAAE,uBAAuB,EAAE,GAAG,uBAAuB,EAAE,CAEnF;IAED;;;;OAIG;IACH,SAAgB,GAAG,CAAC,IAAI,EAAE,kBAAkB,GAAG,cAAc,CAE5D;CACJ;AAED,qDAAqD;AACrD,oBAAY,kBAAkB,GAAG,OAAO,CAAC,MAAM,OAAO,cAAc,EAAE,KAAK,CAAC,CAAC;AAE7E,MAAM,WAAW,mBAAoB,SAAQ,MAAM;IAC/C,IAAI,EAAE,OAAO,mBAAmB,CAAC,IAAI,CAAC;IAEtC;;OAEG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;IACrB;;;OAGG;IACH,cAAc,EAAE,kBAAkB,CAAC;CACtC;AAED,yBAAiB,mBAAmB,CAAC;IAC1B,MAAM,IAAI,kBAAkB,CAAC;IAEpC,SAAgB,EAAE,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,mBAAmB,CAO7D;IAED,SAAgB,MAAM,CAClB,OAAO,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,SAAS,CAAC,EAAE,SAAS,CAAC;QAAC,iBAAiB,CAAC,EAAE,kBAAkB,CAAA;KAAO,GACvG,mBAAmB,CAQrB;CACJ;AAED,qBACa,0BAA2B,SAAQ,2BAA2B;IACvE,MAAM,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI;IAsBzC,SAAS,CAAC,QAAQ,EAAE,uBAAuB,EAAE,GAAG,IAAI;IAKpD,WAAW,CAAC,QAAQ,EAAE,uBAAuB,EAAE,GAAG,IAAI;IAQtD,UAAU,CAAC,QAAQ,EAAE,uBAAuB,EAAE,GAAG,IAAI;IAKrD,QAAQ,CAAC,QAAQ,EAAE,uBAAuB,EAAE,GAAG,IAAI;IAKnD,WAAW,CAAC,QAAQ,EAAE,uBAAuB,EAAE,GAAG,IAAI;IAQtD,WAAW,CAAC,QAAQ,EAAE,uBAAuB,EAAE,GAAG,IAAI;IAKtD,oBAAoB,CAChB,QAAQ,EAAE,uBAAuB,EAAE,EACnC,MAAM,EAAE,CAAC,OAAO,EAAE,uBAAuB,EAAE,IAAI,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,IAAI,GAChF,IAAI;IAeP,iBAAiB,CACb,OAAO,EAAE,uBAAuB,EAChC,MAAM,EAAE,CAAC,QAAQ,EAAE,uBAAuB,EAAE,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,IAAI,GAClF,QAAQ,CAAC,WAAW,CAAC,GAAG,SAAS;IAgBpC,sBAAsB,CAAC,OAAO,EAAE,uBAAuB,EAAE,IAAI,EAAE,WAAW,GAAG,gBAAgB;IAa7F,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,IAAI,uBAAuB;CAGxF"}