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

package/lib/routing/workbench-router.service.d.ts

@@ -1,180 +1,65 @@
-import { NavigationExtras, Router } from '@angular/router';
-import { Dictionary } from '@scion/toolkit/util';
-import { NgZone, OnDestroy } from '@angular/core';
-import { WorkbenchLayoutService } from '../layout/workbench-layout.service';
-import { WorkbenchViewRegistry } from '../view/workbench-view.registry';
-import { ɵWorkbenchLayout } from '../layout/ɵworkbench-layout';
+import { NavigationExtras } from '@angular/router';
+import { Commands, NavigateFn, WorkbenchNavigationExtras } from './routing.model';
 import * as i0 from "@angular/core";
 /**
- * Provides workbench view navigation capabilities based on Angular Router.
+ * Enables navigation of workbench views and modification of the workbench layout.
+ *
+ * A view is a visual workbench element for displaying content side-by-side or stacked. A view can be navigated to any route.
+ *
+ * A view can inject `ActivatedRoute` to obtain parameters passed to the navigation and/or read data associated with the route.
  */
-export declare class WorkbenchRouter implements OnDestroy {
-    private _router;
-    private _viewRegistry;
-    private _workbenchLayoutService;
-    private _zone;
-    private _singleTaskExecutor;
-    /**
-     * Holds the current navigational context during a workbench navigation, or `null` if no navigation is in progress.
-     */
-    private _currentNavigationContext;
-    constructor(_router: Router, _viewRegistry: WorkbenchViewRegistry, _workbenchLayoutService: WorkbenchLayoutService, _zone: NgZone);
+export declare abstract class WorkbenchRouter {
     /**
-     * Navigates based on the provided array of commands, and is like 'Router.navigate(...)' but with a workbench view as the router outlet target.
-     * Navigation is absolute unless providing a `relativeTo` route in navigational extras.
+     * Navigates based on the provided array of commands and extras. This method is similar to Angular's `Router.navigate(...)`, but with a view as the navigation target.
      *
-     * By passing navigation extras, you can control navigation. By default, the router opens a new view tab if no view is found that matches the
-     * specified path. Matrix parameters do not affect view resolution. If one (or more) view(s) match the specified path, they are navigated
-     * instead of opening the view in a new view tab, e.g., to update matrix parameters.
+     * A command can be a string or an object literal. A string represents a path segment, an object literal associates matrix parameters with the preceding segment.
+     * Multiple segments can be combined into a single command, separated by a forward slash.
      *
-     * The router supports for closing views matching the routing commands by setting `close` in navigational extras.
+     * By default, navigates existing views that match the path, or opens a new view otherwise. Matrix params do not affect view resolution.
+     * This behavior can be changed by setting an explicit navigation target in navigation extras.
      *
-     * ### Commands
-     * - Multiple static segments can be merged into one, e.g. `['/team/11/user', userName, {details: true}]`
-     * - The first segment name can be prepended with `/`, `./`, or `../`
-     * - Matrix parameters can be used to associate optional data with the URL, e.g. `['user', userName, {details: true}]`
-     *   Matrix parameters are like regular URL parameters, but do not affect route and view resolution. Unlike query parameters, matrix parameters
-     *   are not global but part of the routing path, which makes them suitable for auxiliary routes.
+     * By default, navigation is absolute. Set `relativeTo` in extras for relative navigation.
      *
-     * ### Usage
+     * The router supports for closing views matching the routing commands by setting `close` in navigation extras.
      *
+     * ### Usage
      * ```
-     * router.navigate(['team', 33, 'user', 11]);
-     * router.navigate(['team/11/user', userName, {details: true}]); // multiple static segments can be merged into one
-     * router.navigate(['teams', {selection: 33'}]); // matrix parameter 'selection' with the value '33'.
+     * inject(WorkbenchRouter).navigate(['team', 33, 'user', 11]);
+     * inject(WorkbenchRouter).navigate(['team/11/user', userName, {details: true}]); // multiple static segments can be merged into one
+     * inject(WorkbenchRouter).navigate(['teams', {selection: 33'}]); // matrix parameter `selection` with the value `33`.
      * ```
      *
      * @see WorkbenchRouterLinkDirective
      */
-    navigate(commands: Commands, extras?: WorkbenchNavigationExtras): Promise<boolean>;
-    /**
-     * Experimental API for modifying the workbench layout.
-     *
-     * @param onNavigate - Callback to modify the current layout.
-     *        The callback is passed the current layout which can be modified and returned for navigation. Returning `null` does not perform the navigation.
-     * @param extras - Controls how to perform the navigation.
-     */
-    ɵnavigate(onNavigate: (layout: ɵWorkbenchLayout) => Promise<ɵWorkbenchLayout | WorkbenchNavigation | null> | ɵWorkbenchLayout | WorkbenchNavigation | null, extras?: NavigationExtras): Promise<boolean>;
-    /**
-     * This method name begins with underscores to indicate that it must only be invoked from within {@link SingleTaskExecutor}.
-     */
-    private __createUrlTree;
-    /**
-     * @see normalizeCommands
-     */
-    private normalizeOutletCommands;
+    abstract navigate(commands: Commands, extras?: WorkbenchNavigationExtras): Promise<boolean>;
     /**
-     * Normalizes commands to their absolute form.
+     * Performs changes to the current workbench layout.
      *
-     * ---
-     * As of Angular 6.x, commands which target a named outlet (auxiliary route) are not normalized, meaning that
-     * relative navigational symbols like `/`, `./`, or `../` are not resolved (see `create_url_tree.ts` method: `computeNavigation`).
+     * The router will invoke the passed function with the current workbench layout. The layout has methods for modifying it.
+     * The layout is immutable, so each modification creates a new instance. Use the instance for further modifications and finally return it.
      *
-     * Example: router.navigate([{outlets: {[outlet]: commands}}])
-     *
-     * To bypass that restriction, we first create a URL tree without specifying the target outlet. As expected, this translates into a
-     * URL with all navigational symbols resolved. Then, we extract the URL segments of the resolved route and convert it back into commands.
-     * The resulting commands are in their absolute form and may be used for the effective navigation to target a named router outlet.
-     */
-    private normalizeCommands;
-    /**
-     * Blocks until the initial layout is available, i.e. after completion of Angular's initial navigation.
-     */
-    private waitForInitialLayout;
-    /**
-     * Serializes given commands into valid URL segments.
-     */
-    private serializeCommands;
-    ngOnDestroy(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<WorkbenchRouter, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<WorkbenchRouter>;
-}
-/**
- * Represents the extra options used during navigation.
- */
-export interface WorkbenchNavigationExtras extends NavigationExtras {
-    /**
-     * Instructs the router to activate the view. Defaults to `true` if not specified.
-     */
-    activate?: boolean;
-    /**
-     * Closes the view(s) that match the specified path. Matrix parameters do not affect view resolution.
-     * The path supports the asterisk wildcard segment (`*`) to match view(s) with any value in that segment.
-     * To close a specific view, set a view target instead of a path.
-     */
-    close?: boolean;
-    /**
-     * Controls where to open the view.
+     * The function can call `inject` to get any required dependencies.
      *
-     * One of:
-     * - 'auto':    Opens the view in a new view tab if no view is found that matches the specified path. Matrix parameters do not affect
-     *              view resolution. If one (or more) view(s) match the specified path, they are navigated instead of opening the view
-     *              in a new view tab, e.g., to update matrix parameters. This is the default behavior if not set.
-     * - 'blank':   Opens the view in a new view tab.
-     * - <view.id>: Navigates the specified view. If already opened, replaces it, or opens the view in a new view tab otherwise.
-     *              Note that the passed view identifier must start with `view.`, e.g., `view.5`.
+     * ## Workbench Layout
+     * The workbench layout is a grid of parts. Parts are aligned relative to each other. A part is a stack of views. Content is displayed in views.
      *
-     * If not specified, defaults to `auto`.
-     */
-    target?: string | 'blank' | 'auto';
-    /**
-     * Specifies in which part to open the view. By default, if not specified, opens the view in the active part of the main area,
-     * if the layout has one, otherwise in the active part of the layout.
-     */
-    blankPartId?: string;
-    /**
-     * Specifies the position where to insert the view into the tab bar when using 'blank' view target strategy.
-     * If not specified, the view is inserted after the active view. Set the index to 'start' or 'end' for inserting
-     * the view at the beginning or at the end.
-     */
-    blankInsertionIndex?: number | 'start' | 'end';
-    /**
-     * State that will be passed to the navigation.
+     * ## Example
+     * The following example adds a part to the left of the main area, inserts a view and navigates it.
      *
-     * See {@link NavigationExtras#state} for detailed instructions on how to access passed state during and after the navigation.
+     * ```ts
+     * inject(WorkbenchRouter).navigate(layout => layout
+     *   .addPart('left', {relativeTo: MAIN_AREA, align: 'left'})
+     *   .addView('navigator', {partId: 'left'})
+     *   .navigateView('navigator', ['path/to/view'])
+     *   .activateView('navigator')
+     * );
+     * ```
      *
-     * In addition, the workbench router makes state available to the routed component as resolved data under the key {@link WorkbenchRouteData.state}.
-     */
-    state?: Dictionary;
-    /**
-     * Specifies CSS class(es) to be added to the view, useful in end-to-end tests for locating view and view tab.
-     * CSS class(es) will not be added to the browser URL, consequently will not survive a page reload.
-     */
-    cssClass?: string | string[];
-}
-/**
- * An array of URL fragments with which to construct a view's URL.
- *
- * If the path is static, can be the literal URL string. For a dynamic path, pass an array of path segments,
- * followed by the parameters for each segment.
- *
- * The last segment allows adding matrix parameters in the form of a dictionary to provide additional data along
- * with the URL. Matrix parameters do not affect route resolution. In the routed component, matrix parameters are
- * available in {@link ActivatedRoute#params}.
- *
- * Example command array with 'details' as matrix parameter: `['user', userName, {details: true}]`,
- */
-export type Commands = any[];
-/**
- * Information about a workbench navigation operation.
- */
-export interface WorkbenchNavigation {
-    /**
-     * The target layout to apply.
-     */
-    layout: ɵWorkbenchLayout;
-    /**
-     * View outlet delta to apply to the current URL. For each outlet to add, remove, or change,
-     * add a property to this dictionary and set the commands to construct the outlet URL.
-     * To remove an outlet from the URL, set its commands to `null`.
-     */
-    viewOutlets?: {
-        [outlet: string]: Commands | null;
-    };
-    /**
-     * State to be passed to the routed component as resolved data under the key {@link WorkbenchRouteData.state}.
+     * @param onNavigate - Specifies the callback to modify the layout.
+     * @param extras - Controls how to perform the navigation.
+     * @see NavigateFn
      */
-    viewStates?: {
-        [outlet: string]: Dictionary;
-    };
+    abstract navigate(onNavigate: NavigateFn, extras?: Omit<NavigationExtras, 'relativeTo' | 'state'>): Promise<boolean>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WorkbenchRouter, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WorkbenchRouter>;
 }

package/lib/routing/workbench-url-observer.service.d.ts

@@ -4,16 +4,17 @@ import { WorkbenchAuxiliaryRoutesRegistrator } from './workbench-auxiliary-route
 import { WorkbenchViewRegistry } from '../view/workbench-view.registry';
 import { WorkbenchPartRegistry } from '../part/workbench-part.registry';
 import { WorkbenchLayoutService } from '../layout/workbench-layout.service';
-import { WorkbenchRouter } from './workbench-router.service';
 import { WorkbenchLayoutDiffer } from './workbench-layout-differ';
 import { WorkbenchPopupDiffer } from './workbench-popup-differ';
 import { Logger } from '../logging';
 import { ɵWorkbenchLayoutFactory } from '../layout/ɵworkbench-layout.factory';
+import { WorkbenchDialogDiffer } from './workbench-dialog-differ';
+import { ɵWorkbenchRouter } from './ɵworkbench-router.service';
 import * as i0 from "@angular/core";
 /**
  * Tracks the browser URL for workbench layout changes.
  *
- * - For each added view, constructs a {@link WorkbenchView} and registers view specific auxiliary routes of all primary routes
+ * - For each added view, constructs a {@link WorkbenchView} and registers view specific auxiliary routes of all top-level routes
  * - For each removed view, destroys {@link WorkbenchView} and unregisters its auxiliary routes
  * - For each added part, constructs a {@link WorkbenchPart}
  * - For each removed part, destroys {@link WorkbenchPart}
@@ -21,7 +22,7 @@ import * as i0 from "@angular/core";
  */
 export declare class WorkbenchUrlObserver {
     private _router;
-    private _auxRoutesRegistrator;
+    private _auxiliaryRoutesRegistrator;
     private _viewRegistry;
     private _partRegistry;
     private _workbenchLayoutService;
@@ -30,8 +31,9 @@ export declare class WorkbenchUrlObserver {
     private _workbenchLayoutFactory;
     private _workbenchLayoutDiffer;
     private _workbenchPopupDiffer;
+    private _workbenchDialogDiffer;
     private _logger;
-    constructor(_router: Router, _auxRoutesRegistrator: WorkbenchAuxiliaryRoutesRegistrator, _viewRegistry: WorkbenchViewRegistry, _partRegistry: WorkbenchPartRegistry, _workbenchLayoutService: WorkbenchLayoutService, _environmentInjector: EnvironmentInjector, _workbenchRouter: WorkbenchRouter, _workbenchLayoutFactory: ɵWorkbenchLayoutFactory, _workbenchLayoutDiffer: WorkbenchLayoutDiffer, _workbenchPopupDiffer: WorkbenchPopupDiffer, _logger: Logger);
+    constructor(_router: Router, _auxiliaryRoutesRegistrator: WorkbenchAuxiliaryRoutesRegistrator, _viewRegistry: WorkbenchViewRegistry, _partRegistry: WorkbenchPartRegistry, _workbenchLayoutService: WorkbenchLayoutService, _environmentInjector: EnvironmentInjector, _workbenchRouter: ɵWorkbenchRouter, _workbenchLayoutFactory: ɵWorkbenchLayoutFactory, _workbenchLayoutDiffer: WorkbenchLayoutDiffer, _workbenchPopupDiffer: WorkbenchPopupDiffer, _workbenchDialogDiffer: WorkbenchDialogDiffer, _logger: Logger);
     /** Invoked at the beginning of each navigation */
     private onNavigationStart;
     /** Invoked upon successful navigation */
@@ -47,13 +49,17 @@ export declare class WorkbenchUrlObserver {
      */
     private createWorkbenchNavigationContext;
     /**
-     * For each added view, registers auxiliary routes of all primary routes.
+     * For each added view, registers auxiliary routes of all top-level routes.
      */
     private registerAddedViewAuxiliaryRoutes;
     /**
-     * For each added popup, registers auxiliary routes of all primary routes.
+     * For each added popup, registers auxiliary routes of all top-level routes.
      */
     registerAddedPopupAuxiliaryRoutes(): void;
+    /**
+     * For each added dialog, registers auxiliary routes of all top-level routes.
+     */
+    registerAddedDialogAuxiliaryRoutes(): void;
     /**
      * Reverts the workbench layout differ to the state before the navigation.
      *
@@ -66,6 +72,12 @@ export declare class WorkbenchUrlObserver {
      * Invoke this method after navigation failure or cancellation. The navigation is cancelled when guards perform a redirect or reject navigation.
      */
     private undoWorkbenchPopupDiffer;
+    /**
+     * Reverts the dialog outlet differ to the state before the navigation.
+     *
+     * Invoke this method after navigation failure or cancellation. The navigation is cancelled when guards perform a redirect or reject navigation.
+     */
+    private undoWorkbenchDialogDiffer;
     /**
      * Undoes the registration of auxiliary routes.
      *

package/lib/routing//311/265workbench-router.service.d.ts

@@ -0,0 +1,75 @@
+import { NavigationExtras, Router, UrlTree } from '@angular/router';
+import { WorkbenchRouter } from './workbench-router.service';
+import { Injector, NgZone, OnDestroy } from '@angular/core';
+import { WorkbenchLayoutService } from '../layout/workbench-layout.service';
+import { ɵWorkbenchLayout } from '../layout/ɵworkbench-layout';
+import { Commands, WorkbenchNavigationContext, WorkbenchNavigationExtras } from './routing.model';
+import { WorkbenchViewRegistry } from '../view/workbench-view.registry';
+import { Logger } from '../logging';
+import * as i0 from "@angular/core";
+/** @inheritDoc */
+export declare class ɵWorkbenchRouter implements WorkbenchRouter, OnDestroy {
+    private _router;
+    private _workbenchLayoutService;
+    private _workbenchViewRegistry;
+    private _injector;
+    private _logger;
+    private _zone;
+    private _singleTaskExecutor;
+    /**
+     * Holds the current navigational context during a workbench navigation, or `null` if no navigation is in progress.
+     */
+    private _currentNavigationContext;
+    constructor(_router: Router, _workbenchLayoutService: WorkbenchLayoutService, _workbenchViewRegistry: WorkbenchViewRegistry, _injector: Injector, _logger: Logger, _zone: NgZone);
+    /** @inheritDoc */
+    navigate(commands: Commands, extras?: WorkbenchNavigationExtras): Promise<boolean>;
+    navigate(navigateFn: ɵNavigateFn, extras?: Omit<NavigationExtras, 'relativeTo' | 'state'>): Promise<boolean>;
+    navigate(commandsOrNavigateFn: Commands | ɵNavigateFn, extras?: WorkbenchNavigationExtras | Omit<NavigationExtras, 'relativeTo' | 'state'>): Promise<boolean>;
+    /**
+     * Performs changes to the current workbench layout.
+     *
+     * Unlike {@link navigate}, does not perform the navigation but returns the URL tree instead.
+     *
+     * The router will invoke the callback and pass the current layout for modification. The callback can call `inject` to get any required dependencies.
+     *
+     * The following example adds a part to the left of the main area, inserts a view and navigates it.
+     *
+     * ```ts
+     * inject(WorkbenchRouter).createUrlTree(layout => layout
+     *   .addPart('left', {relativeTo: MAIN_AREA, align: 'left'})
+     *   .addView('navigator', {partId: 'left'})
+     *   .navigateView('navigator', ['path/to/view'])
+     *   .activateView('navigator'),
+     * );
+     * ```
+     *
+     * @param onNavigate - Specifies the callback to modify the layout.
+     * @param extras - Controls how to perform the navigation.
+     * @see NavigateFn
+     */
+    createUrlTree(onNavigate: (layout: ɵWorkbenchLayout) => Promise<ɵWorkbenchLayout | null> | ɵWorkbenchLayout | null, extras?: Omit<NavigationExtras, 'relativeTo' | 'state'>): Promise<UrlTree | null>;
+    /**
+     * Decides if given view can be closed, invoking `CanClose` guard if implemented.
+     */
+    private canCloseView;
+    /**
+     * Returns the context of the current workbench navigation, when being invoked during navigation, or throws an error otherwise.
+     */
+    getCurrentNavigationContext(): WorkbenchNavigationContext;
+    /**
+     * Sets navigational contextual data.
+     */
+    setCurrentNavigationContext(context: WorkbenchNavigationContext | null): void;
+    /**
+     * Blocks until the initial layout is available, i.e. after completion of Angular's initial navigation.
+     */
+    private waitForInitialLayout;
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ɵWorkbenchRouter, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ɵWorkbenchRouter>;
+}
+/**
+ * @inheritDoc
+ * @see NavigateFn
+ */
+export type ɵNavigateFn = (layout: ɵWorkbenchLayout) => Promise<ɵWorkbenchLayout | null> | ɵWorkbenchLayout | null;

package/lib/startup/workbench-launcher.service.d.ts

@@ -1,4 +1,4 @@
-import { WorkbenchModuleConfig } from '../workbench-module-config';
+import { WorkbenchConfig } from '../workbench-config';
 import { EnvironmentProviders, Injector, NgZone } from '@angular/core';
 import { Logger } from '../logging';
 import * as i0 from "@angular/core";
@@ -9,7 +9,7 @@ import * as i0 from "@angular/core";
  * Workbench initializers may execute in parallel. To register a workbench initializer, provide a class implementing
  * {@link WorkbenchInitializer} as a multi-provider using the DI class token {@link WorkbenchInitializer}.
  *
- * When importing the {@link WorkbenchModule}, you can configure which workbench launching strategy to use.
+ * The SCION Workbench supports the following launchers:
  *
  *  - **APP_INITIALIZER**
  *   Launches the workbench in an Angular `APP_INITIALIZER`, which is before bootstrapping the app component.
@@ -23,7 +23,7 @@ import * as i0 from "@angular/core";
  *   tree.
  *
  * The workbench component displays a startup splash until completed startup. You can configure a custom splash in
- * {@link WorkbenchModuleConfig#startup#splash}. When launching the workbench in an Angular `APP_INITIALIZER`, no splash will
+ * {@link WorkbenchConfig#startup#splash}. When launching the workbench in an Angular `APP_INITIALIZER`, no splash will
  * display since the workbench will start upfront.
  */
 export declare class WorkbenchLauncher {
@@ -97,4 +97,4 @@ export declare class WorkbenchStartup {
 /**
  * Provides a set of DI providers for launching the workbench.
  */
-export declare function provideWorkbenchLauncher(workbenchModuleConfig: WorkbenchModuleConfig): EnvironmentProviders | [];
+export declare function provideWorkbenchLauncher(workbenchConfig: WorkbenchConfig): EnvironmentProviders | [];

package/lib/testing/public_api.d.ts

@@ -1 +1,2 @@
 export { WorkbenchTestingModule } from './workbench-testing.module';
+export { provideWorkbenchForTest } from './workbench.provider';

package/lib/testing/workbench-testing.module.d.ts

@@ -1,12 +1,11 @@
 import { ModuleWithProviders } from '@angular/core';
-import { WorkbenchModuleConfig } from '../workbench-module-config';
+import { WorkbenchConfig } from '../workbench-config';
 import * as i0 from "@angular/core";
-import * as i1 from "../workbench.module";
 /**
  * Sets up the SCION Workbench to be used for testing.
  *
- * It does the following:
- * - provides the workbench applying given config
+ * Does the following:
+ * - provides the workbench with given config
  * - configures the workbench to name the initial part 'main'
  * - installs a sequence for activation instants
  * - configures the testbed to auto-detect changes
@@ -27,13 +26,15 @@ import * as i1 from "../workbench.module";
  *    });
  * });
  * ```
+ *
+ * @deprecated since version 17.0.0-beta.8; Register SCION Workbench providers using `provideWorkbench` function instead; API will be removed in a future release; API will be removed in a future release.
  */
 export declare class WorkbenchTestingModule {
     /**
      * Sets up the SCION Workbench to be used for testing.
      */
-    static forTest(config?: WorkbenchModuleConfig): ModuleWithProviders<WorkbenchTestingModule>;
+    static forTest(config?: WorkbenchConfig): ModuleWithProviders<WorkbenchTestingModule>;
     static ɵfac: i0.ɵɵFactoryDeclaration<WorkbenchTestingModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<WorkbenchTestingModule, never, never, [typeof i1.WorkbenchModule]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<WorkbenchTestingModule, never, never, never>;
     static ɵinj: i0.ɵɵInjectorDeclaration<WorkbenchTestingModule>;
 }

package/lib/testing/workbench.provider.d.ts

@@ -0,0 +1,29 @@
+import { WorkbenchConfig } from '../workbench-config';
+import { EnvironmentProviders } from '@angular/core';
+/**
+ * Returns the set of dependency-injection providers to enable and configure the SCION Workbench in tests.
+ *
+ * Does the following:
+ * - provides the workbench with given config
+ * - configures the workbench to name the initial part 'main'
+ * - installs a sequence for activation instants
+ * - configures the testbed to auto-detect changes
+ * - disables animations
+ * - performs the initial navigation
+ *
+ * ### Usage
+ *
+ * ```
+ * beforeEach(() => {
+ *   TestBed.configureTestingModule({
+ *      imports: [
+ *        WorkbenchTestingModule.forTest(),
+ *        RouterTestingModule.withRoutes([
+ *          {path: 'test-view', component: TestComponent},
+ *        ]),
+ *      ],
+ *    });
+ * });
+ * ```
+ */
+export declare function provideWorkbenchForTest(config?: WorkbenchConfig): EnvironmentProviders;

package/lib/view/public_api.d.ts

@@ -1 +1,2 @@
-export { WorkbenchView } from './workbench-view.model';
+export { WorkbenchView, ViewId } from './workbench-view.model';
+export { canMatchWorkbenchView } from './workbench-view-route-guards';

package/lib/view/view-move-handler.service.d.ts

@@ -1,8 +1,7 @@
-import { Injector } from '@angular/core';
 import { ViewDragService } from '../view-dnd/view-drag.service';
 import { Router } from '@angular/router';
 import { LocationStrategy } from '@angular/common';
-import { WorkbenchRouter } from '../routing/workbench-router.service';
+import { ɵWorkbenchRouter } from '../routing/ɵworkbench-router.service';
 import { ɵWorkbenchLayoutFactory } from '../layout/ɵworkbench-layout.factory';
 import * as i0 from "@angular/core";
 /**
@@ -15,8 +14,7 @@ export declare class ViewMoveHandler {
     private _viewDragService;
     private _router;
     private _locationStrategy;
-    private _injector;
-    constructor(_workbenchId: string, _workbenchRouter: WorkbenchRouter, _workbenchLayoutFactory: ɵWorkbenchLayoutFactory, _viewDragService: ViewDragService, _router: Router, _locationStrategy: LocationStrategy, _injector: Injector);
+    constructor(_workbenchId: string, _workbenchRouter: ɵWorkbenchRouter, _workbenchLayoutFactory: ɵWorkbenchLayoutFactory, _viewDragService: ViewDragService, _router: Router, _locationStrategy: LocationStrategy);
     private installViewMoveListener;
     private addView;
     private moveViewToNewWindow;

package/lib/view/view-portal.pipe.d.ts

@@ -2,6 +2,7 @@ import { PipeTransform } from '@angular/core';
 import { WorkbenchViewRegistry } from './workbench-view.registry';
 import { WbComponentPortal } from '../portal/wb-component-portal';
 import type { ViewComponent } from '../view/view.component';
+import { ViewId } from './workbench-view.model';
 import * as i0 from "@angular/core";
 /**
  * Resolves the portal for the given view, or throws an error if the view is not registered.
@@ -9,7 +10,7 @@ import * as i0 from "@angular/core";
 export declare class ViewPortalPipe implements PipeTransform {
     private _viewRegistry;
     constructor(_viewRegistry: WorkbenchViewRegistry);
-    transform(viewId: string | null): WbComponentPortal<ViewComponent> | null;
+    transform(viewId: ViewId | null): WbComponentPortal<ViewComponent> | null;
     static ɵfac: i0.ɵɵFactoryDeclaration<ViewPortalPipe, never>;
     static ɵpipe: i0.ɵɵPipeDeclaration<ViewPortalPipe, "wbViewPortal", true>;
 }

package/lib/view/view.component.d.ts

@@ -1,5 +1,4 @@
 import { ElementRef, OnDestroy } from '@angular/core';
-import { ActivatedRoute, RouterOutlet } from '@angular/router';
 import { SciViewportComponent } from '@scion/components/viewport';
 import { ViewMenuService } from '../part/view-context-menu/view-menu.service';
 import { ɵWorkbenchView } from './ɵworkbench-view.model';
@@ -8,13 +7,7 @@ import { ViewDragService } from '../view-dnd/view-drag.service';
 import * as i0 from "@angular/core";
 import * as i1 from "../glass-pane/glass-pane.directive";
 /**
- * Is the graphical representation of a workbench view.
- *
- * The view has its dedicated router outlet to display view content. Use route path parameters
- * to decide what specific content to present. Use matrix parameters to associate optional data
- * with the view outlet URL.
- *
- * Title and heading of this view are either set via `WorkbenchView`, or given as route data or matrix parameter.
+ * Renders the workbench view, using a router-outlet to display view content.
  */
 export declare class ViewComponent implements OnDestroy {
     private _view;
@@ -23,15 +16,12 @@ export declare class ViewComponent implements OnDestroy {
     private _viewDragService;
     private _viewport$;
     set setViewport(viewport: SciViewportComponent);
-    routerOutlet: RouterOutlet;
     get viewId(): string;
     get cssClasses(): string;
     get isViewDragActive(): boolean;
     constructor(_view: ɵWorkbenchView, _logger: Logger, _host: ElementRef<HTMLElement>, _viewDragService: ViewDragService, viewContextMenuService: ViewMenuService);
     private onActivateView;
     private onDeactivateView;
-    onActivateRoute(route: ActivatedRoute): void;
-    onDeactivateRoute(): void;
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ViewComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<ViewComponent, "wb-view", never, {}, {}, never, never, true, [{ directive: typeof i1.GlassPaneDirective; inputs: {}; outputs: {}; }]>;

package/lib/view/workbench-view-route-guards.d.ts

@@ -0,0 +1,36 @@
+import { CanMatchFn } from '@angular/router';
+/**
+ * Matches the route if target of a workbench view and navigating with the given hint.
+ *
+ * Can be used to differentiate between routes with an identical path. For example, the views of the initial layout or a perspective
+ * are usually navigated to the empty path route to avoid cluttering the URL. A hint can be set when navigating the view to match a
+ * particular route.
+ *
+ * ### Example:
+ *
+ * The following routes both match the empty path, but only if navigated with a specific hint.
+ * ```ts
+ * const routes: Routes = [
+ *   {path: '', canMatch: [canMatchWorkbenchView('navigator')], component: NavigatorComponent},
+ *   {path: '', canMatch: [canMatchWorkbenchView('outline')], component: OutlineComponent},
+ * ];
+ * ```
+ *
+ * The following example navigates to the `OutlineComponent`, passing a hint to match the route.
+ * ```ts
+ * inject(WorkbenchRouter).navigate([], {hint: 'outline'});
+ * ```
+ */
+export declare function canMatchWorkbenchView(navigationHint: string): CanMatchFn;
+/**
+ * Matches the route if, or if not target of a workbench view.
+ *
+ * Can be used to guard the application's root route from matching an empty path view navigation.
+ */
+export declare function canMatchWorkbenchView(canMatch: boolean): CanMatchFn;
+/**
+ * Matches if the view has been navigated (or cannot be found).
+ *
+ * The view cannot be found during initial navigation as the workbench layout is loaded asynchronously.
+ */
+export declare const canMatchNotFoundPage: CanMatchFn;