@scion/workbench 17.0.0-beta.5 → 17.0.0-beta.6

package/lib/common/grid-element-if-visible.pipe.d.ts

@@ -0,0 +1,13 @@
+import { PipeTransform } from '@angular/core';
+import { MPart, MTreeNode } from '../layout/workbench-layout.model';
+import * as i0 from "@angular/core";
+/**
+ * Returns given grid element, but only if visible.
+ *
+ * @see isGridElementVisible
+ */
+export declare class GridElementIfVisiblePipe implements PipeTransform {
+    transform(gridElement: MTreeNode | MPart | null | undefined): MTreeNode | MPart | null;
+    static ɵfac: i0.ɵɵFactoryDeclaration<GridElementIfVisiblePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<GridElementIfVisiblePipe, "wbGridElementIfVisible", true>;
+}

package/lib/layout/main-area-layout/main-area-layout.component.d.ts

@@ -1,5 +1,5 @@
 import { ɵWorkbenchPart } from '../../part/ɵworkbench-part.model';
-import { MPart, MTreeNode } from '../workbench-layout.model';
+import { MPartGrid } from '../workbench-layout.model';
 import { WorkbenchLayoutService } from '../workbench-layout.service';
 import { ViewDragService } from '../../view-dnd/view-drag.service';
 import { WbViewDropEvent } from '../../view-dnd/view-drop-zone.directive';
@@ -32,13 +32,10 @@ export declare class MainAreaLayoutComponent {
     private _part;
     private _workbenchLayoutService;
     private _viewDragService;
-    get partId(): string;
+    protected get partId(): string;
     constructor(_workbenchId: string, _part: ɵWorkbenchPart, _workbenchLayoutService: WorkbenchLayoutService, _viewDragService: ViewDragService);
-    /**
-     * Root element of the main area layout.
-     */
-    get root(): MTreeNode | MPart;
-    onViewDrop(event: WbViewDropEvent): void;
+    protected get mainAreaGrid(): MPartGrid;
+    protected onViewDrop(event: WbViewDropEvent): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<MainAreaLayoutComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<MainAreaLayoutComponent, "wb-main-area-layout", never, {}, {}, never, never, true, never>;
 }

package/lib/layout/workbench-layout.component.d.ts

@@ -1,7 +1,7 @@
 import { WorkbenchLayoutService } from './workbench-layout.service';
 import { ɵWorkbenchLayout } from './ɵworkbench-layout';
 import { ViewDragService } from '../view-dnd/view-drag.service';
-import { MPart, MTreeNode } from './workbench-layout.model';
+import { MPartGrid } from './workbench-layout.model';
 import { WbViewDropEvent } from '../view-dnd/view-drop-zone.directive';
 import * as i0 from "@angular/core";
 /**
@@ -32,9 +32,9 @@ export declare class WorkbenchLayoutComponent {
     private _workbenchId;
     private _viewDragService;
     layout: ɵWorkbenchLayout | undefined;
-    root: MTreeNode | MPart | undefined;
+    protected grid: MPartGrid | undefined;
     constructor(_workbenchId: string, _viewDragService: ViewDragService, workbenchLayoutService: WorkbenchLayoutService);
-    onViewDrop(event: WbViewDropEvent): void;
+    protected onViewDrop(event: WbViewDropEvent): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<WorkbenchLayoutComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<WorkbenchLayoutComponent, "wb-workbench-layout", never, {}, {}, never, never, true, never>;
 }

package/lib/layout/workbench-layouts.util.d.ts

@@ -0,0 +1,12 @@
+import { MPart, MTreeNode } from './workbench-layout.model';
+/**
+ * Recursively collects all parts of a given element and its descendants.
+ */
+declare function collectParts(element: MPart | MTreeNode): MPart[];
+/**
+ * Provides helper functions for operating on a workbench layout.
+ */
+export declare const WorkbenchLayouts: {
+    readonly collectParts: typeof collectParts;
+};
+export {};

package/lib/logging/logger.d.ts

@@ -1,4 +1,4 @@
-import { LoggerName } from './logging.model';
+import { LoggerName, LogLevel } from './logging.model';
 import * as i0 from "@angular/core";
 /**
  * Logger used by the workbench to log messages.
@@ -16,6 +16,10 @@ import * as i0 from "@angular/core";
  * @see {@link LogAppender}
  */
 export declare abstract class Logger {
+    /**
+     * Log level of the workbench logger.
+     */
+    abstract readonly logLevel: LogLevel;
     /**
      * Logs a message with debug severity.
      *

package/lib/logging//311/265logger.d.ts

@@ -4,7 +4,7 @@ import { Logger } from './logger';
 import * as i0 from "@angular/core";
 export declare class ɵLogger implements Logger {
     private _logAppenders;
-    private _logLevel;
+    logLevel: LogLevel;
     constructor(_logAppenders: LogAppender[], router: Router, logLevel: LogLevel);
     debug(message: string | (() => string), ...args: any[]): void;
     info(message: string | (() => string), ...args: any[]): void;

package/lib/part/view-context-menu/view-menu.service.d.ts

@@ -1,4 +1,4 @@
-import { ElementRef, Injector } from '@angular/core';
+import { ElementRef, Injector, NgZone } from '@angular/core';
 import { Overlay } from '@angular/cdk/overlay';
 import { WorkbenchViewRegistry } from '../../view/workbench-view.registry';
 import { Observable } from 'rxjs';
@@ -12,6 +12,7 @@ import * as i0 from "@angular/core";
 export declare class ViewMenuService {
     private _overlay;
     private _injector;
+    private _zone;
     private _viewRegistry;
     private _workbenchService;
     private _workbenchModuleConfig;
@@ -19,7 +20,7 @@ export declare class ViewMenuService {
     private static readonly TOP_RIGHT;
     private static readonly BOTTOM_LEFT;
     private static readonly BOTTOM_RIGHT;
-    constructor(_overlay: Overlay, _injector: Injector, _viewRegistry: WorkbenchViewRegistry, _workbenchService: WorkbenchService, _workbenchModuleConfig: WorkbenchModuleConfig);
+    constructor(_overlay: Overlay, _injector: Injector, _zone: NgZone, _viewRegistry: WorkbenchViewRegistry, _workbenchService: WorkbenchService, _workbenchModuleConfig: WorkbenchModuleConfig);
     /**
      * Shows a menu with menu items registered in given {@link WorkbenchView}.
      *

package/lib/view-dnd/grid-drop-targets.util.d.ts

@@ -0,0 +1,24 @@
+import { ViewMoveEventTarget } from './view-drag.service';
+import { MPartGrid } from '../layout/workbench-layout.model';
+/**
+ * Resolves the drop target for moving a view to the root part (or node) of a grid.
+ *
+ * Examples:
+ * - Droping a view at the grid's boundaries (north, south, east, west).
+ * - Dropping a view on the grid's start page (center).
+ *
+ * When dropping a view on the grid's start page, the root of the grid can be a part or a node,
+ * depending on whether the grid contains structural parts.
+ */
+declare function resolve(target: {
+    grid: MPartGrid;
+    dropRegion: 'west' | 'east' | 'north' | 'south' | 'center';
+    workbenchId: string;
+}): ViewMoveEventTarget;
+/**
+ * Provides helper functions for dragging a view to a grid.
+ */
+export declare const GridDropTargets: {
+    readonly resolve: typeof resolve;
+};
+export {};

package/lib/view-dnd/view-drag.service.d.ts

@@ -135,57 +135,65 @@ export interface ViewDragData {
  * Event emitted when moving a view.
  */
 export interface ViewMoveEvent {
-    source: {
-        viewId: string;
-        partId: string;
-        viewUrlSegments: UrlSegment[];
-        workbenchId: string;
-    };
-    target: {
-        /**
-         * Part (or node) where (or relative to which) to add the view.
-         *
-         * Rules for different regions:
-         * - If not specifying a region, {@link elementId} is mandatory and must reference a part.
-         * - For regions `north`, `south`, `east`, or `west`, {@link elementId} can reference a part or node,
-         *   relative to which to align the view. If not set, the view is aligend relative to the root of
-         *   the entire layout.
-         *
-         * Note: Property is ignored when moving the view to a new window.
-         */
-        elementId?: string;
-        /**
-         * Region of {@link elementId} where to add the view (in a new part).
-         *
-         * If not specified, {@link elementId} must reference a part to which to add the view.
-         *
-         * Note:
-         * - Property is ignored when moving the view to a new window.
-         * - Property is required if {@link elementId} is a node.
-         */
-        region?: 'north' | 'east' | 'south' | 'west';
-        /**
-         * Position where to insert the view. The position is zero-based. If not set, adds the view after the active view.
-         */
-        position?: number | 'start' | 'end';
+    source: ViewMoveEventSource;
+    target: ViewMoveEventTarget;
+}
+/**
+ * Describes a view to be moved to another location.
+ */
+export interface ViewMoveEventSource {
+    viewId: string;
+    partId: string;
+    viewUrlSegments: UrlSegment[];
+    workbenchId: string;
+}
+/**
+ * Describes the target location for moving a view.
+ */
+export interface ViewMoveEventTarget {
+    /**
+     * Part (or node) where (or relative to which) to add the view.
+     *
+     * Rules for different regions:
+     * - If not specifying a region, {@link elementId} is mandatory and must reference a part.
+     * - For regions `north`, `south`, `east`, or `west`, {@link elementId} can reference a part or node,
+     *   relative to which to align the view. If not set, the view is aligned relative to the root of
+     *   the entire layout.
+     *
+     * Note: Property is ignored when moving the view to a new window.
+     */
+    elementId?: string;
+    /**
+     * Region of {@link elementId} where to add the view (in a new part).
+     *
+     * If not specified, {@link elementId} must reference a part to which to add the view.
+     *
+     * Note:
+     * - Property is ignored when moving the view to a new window.
+     * - Property is required if {@link elementId} is a node.
+     */
+    region?: 'north' | 'east' | 'south' | 'west';
+    /**
+     * Position where to insert the view. The position is zero-based. If not set, adds the view after the active view.
+     */
+    position?: number | 'start' | 'end';
+    /**
+     * Identifier of the target workbench, or 'new-window' to move the view to a new browser window.
+     */
+    workbenchId: string | 'new-window';
+    /**
+     * Describes the part to be created if the region is 'north', 'east', 'south', or 'west'.
+     */
+    newPart?: {
         /**
-         * Identifier of the target workbench, or 'new-window' to move the view to a new browser window.
+         * Identity of the new part. If not set, assigns a UUID.
          */
-        workbenchId: string | 'new-window';
+        id?: string;
         /**
-         * Describes the part to be created if the region is 'north', 'east', 'south', or 'west'.
+         * Proportional size of the part relative to the reference part.
+         * The ratio is the closed interval [0,1]. If not set, defaults to `0.5`.
          */
-        newPart?: {
-            /**
-             * Identity of the new part. If not set, assigns a UUID.
-             */
-            id?: string;
-            /**
-             * Proportional size of the part relative to the reference part.
-             * The ratio is the closed interval [0,1]. If not set, defaults to `0.5`.
-             */
-            ratio?: number;
-        };
+        ratio?: number;
     };
 }
 export interface ViewDragEventListenerOptions extends EventListenerOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scion/workbench",
-  "version": "17.0.0-beta.5",
+  "version": "17.0.0-beta.6",
   "description": "SCION Workbench enables the creation of Angular web applications that require a flexible layout to arrange content side-by-side or stacked, all personalizable by the user via drag & drop.",
   "license": "EPL-2.0",
   "private": false,

package/esm2022/lib/common/grid-element-visible.pipe.mjs

@@ -1,29 +0,0 @@
-/*
- * Copyright (c) 2018-2023 Swiss Federal Railways
- *
- * This program and the accompanying materials are made
- * available under the terms of the Eclipse Public License 2.0
- * which is available at https://www.eclipse.org/legal/epl-2.0/
- *
- * SPDX-License-Identifier: EPL-2.0
- */
-import { Pipe } from '@angular/core';
-import { isGridElementVisible } from '../layout/ɵworkbench-layout';
-import * as i0 from "@angular/core";
-/**
- * Tests if given element is visible.
- *
- * @see isGridElementVisible
- */
-export class GridElementVisiblePipe {
-    transform(gridElement) {
-        return !!gridElement && isGridElementVisible(gridElement);
-    }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.0.3", ngImport: i0, type: GridElementVisiblePipe, deps: [], target: i0.ɵɵFactoryTarget.Pipe }); }
-    static { this.ɵpipe = i0.ɵɵngDeclarePipe({ minVersion: "14.0.0", version: "17.0.3", ngImport: i0, type: GridElementVisiblePipe, isStandalone: true, name: "wbGridElementVisible" }); }
-}
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.0.3", ngImport: i0, type: GridElementVisiblePipe, decorators: [{
-            type: Pipe,
-            args: [{ name: 'wbGridElementVisible', standalone: true }]
-        }] });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ3JpZC1lbGVtZW50LXZpc2libGUucGlwZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uL3Byb2plY3RzL3NjaW9uL3dvcmtiZW5jaC9zcmMvbGliL2NvbW1vbi9ncmlkLWVsZW1lbnQtdmlzaWJsZS5waXBlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOzs7Ozs7OztHQVFHO0FBRUgsT0FBTyxFQUFDLElBQUksRUFBZ0IsTUFBTSxlQUFlLENBQUM7QUFFbEQsT0FBTyxFQUFDLG9CQUFvQixFQUFDLE1BQU0sNkJBQTZCLENBQUM7O0FBRWpFOzs7O0dBSUc7QUFFSCxNQUFNLE9BQU8sc0JBQXNCO0lBRTFCLFNBQVMsQ0FBQyxXQUFpRDtRQUNoRSxPQUFPLENBQUMsQ0FBQyxXQUFXLElBQUksb0JBQW9CLENBQUMsV0FBVyxDQUFDLENBQUM7SUFDNUQsQ0FBQzs4R0FKVSxzQkFBc0I7NEdBQXRCLHNCQUFzQjs7MkZBQXRCLHNCQUFzQjtrQkFEbEMsSUFBSTttQkFBQyxFQUFDLElBQUksRUFBRSxzQkFBc0IsRUFBRSxVQUFVLEVBQUUsSUFBSSxFQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLypcbiAqIENvcHlyaWdodCAoYykgMjAxOC0yMDIzIFN3aXNzIEZlZGVyYWwgUmFpbHdheXNcbiAqXG4gKiBUaGlzIHByb2dyYW0gYW5kIHRoZSBhY2NvbXBhbnlpbmcgbWF0ZXJpYWxzIGFyZSBtYWRlXG4gKiBhdmFpbGFibGUgdW5kZXIgdGhlIHRlcm1zIG9mIHRoZSBFY2xpcHNlIFB1YmxpYyBMaWNlbnNlIDIuMFxuICogd2hpY2ggaXMgYXZhaWxhYmxlIGF0IGh0dHBzOi8vd3d3LmVjbGlwc2Uub3JnL2xlZ2FsL2VwbC0yLjAvXG4gKlxuICogU1BEWC1MaWNlbnNlLUlkZW50aWZpZXI6IEVQTC0yLjBcbiAqL1xuXG5pbXBvcnQge1BpcGUsIFBpcGVUcmFuc2Zvcm19IGZyb20gJ0Bhbmd1bGFyL2NvcmUnO1xuaW1wb3J0IHtNUGFydCwgTVRyZWVOb2RlfSBmcm9tICcuLi9sYXlvdXQvd29ya2JlbmNoLWxheW91dC5tb2RlbCc7XG5pbXBvcnQge2lzR3JpZEVsZW1lbnRWaXNpYmxlfSBmcm9tICcuLi9sYXlvdXQvybV3b3JrYmVuY2gtbGF5b3V0JztcblxuLyoqXG4gKiBUZXN0cyBpZiBnaXZlbiBlbGVtZW50IGlzIHZpc2libGUuXG4gKlxuICogQHNlZSBpc0dyaWRFbGVtZW50VmlzaWJsZVxuICovXG5AUGlwZSh7bmFtZTogJ3diR3JpZEVsZW1lbnRWaXNpYmxlJywgc3RhbmRhbG9uZTogdHJ1ZX0pXG5leHBvcnQgY2xhc3MgR3JpZEVsZW1lbnRWaXNpYmxlUGlwZSBpbXBsZW1lbnRzIFBpcGVUcmFuc2Zvcm0ge1xuXG4gIHB1YmxpYyB0cmFuc2Zvcm0oZ3JpZEVsZW1lbnQ6IE1UcmVlTm9kZSB8IE1QYXJ0IHwgbnVsbCB8IHVuZGVmaW5lZCk6IGdyaWRFbGVtZW50IGlzIChNVHJlZU5vZGUgfCBNUGFydCkge1xuICAgIHJldHVybiAhIWdyaWRFbGVtZW50ICYmIGlzR3JpZEVsZW1lbnRWaXNpYmxlKGdyaWRFbGVtZW50KTtcbiAgfVxufVxuIl19

package/lib/common/grid-element-visible.pipe.d.ts

@@ -1,13 +0,0 @@
-import { PipeTransform } from '@angular/core';
-import { MPart, MTreeNode } from '../layout/workbench-layout.model';
-import * as i0 from "@angular/core";
-/**
- * Tests if given element is visible.
- *
- * @see isGridElementVisible
- */
-export declare class GridElementVisiblePipe implements PipeTransform {
-    transform(gridElement: MTreeNode | MPart | null | undefined): gridElement is (MTreeNode | MPart);
-    static ɵfac: i0.ɵɵFactoryDeclaration<GridElementVisiblePipe, never>;
-    static ɵpipe: i0.ɵɵPipeDeclaration<GridElementVisiblePipe, "wbGridElementVisible", true>;
-}