@scion/workbench 19.0.0-beta.3 → 20.0.0-beta.2

package/lib/workbench-config.d.ts

@@ -1,339 +0,0 @@
-import { ComponentType } from '@angular/cdk/portal';
-import { Signal, Type } from '@angular/core';
-import { LogAppender, LogLevel } from './logging';
-import { MicrofrontendPlatformConfig } from '@scion/microfrontend-platform';
-import { MicrofrontendPlatformConfigLoader } from './microfrontend-platform/microfrontend-platform-config-loader';
-import { WorkbenchPerspectives } from './perspective/workbench-perspective.model';
-import { WorkbenchStorage } from './storage/workbench-storage';
-import { WorkbenchTextProviderFn } from './text/workbench-text-provider.model';
-import { WorkbenchIconProviderFn } from './icon/workbench-icon-provider.model';
-import { WorkbenchLayoutFn } from './layout/workbench-layout';
-/**
- * Configuration of the SCION Workbench.
- */
-export declare abstract class WorkbenchConfig {
-    /**
-     * Defines the layout(s) of the application. Defaults to a single layout with only a main area.
-     *
-     * An application can have multiple layouts, called perspectives. A perspective defines an arrangement of parts and views.
-     * Parts can be docked to the side or positioned relative to each other. Views are stacked in parts and can be dragged to other parts.
-     * Content can be displayed in both parts and views.
-     *
-     * A perspective typically has a main area part and other parts docked to the side, providing navigation and context-sensitive assistance to support
-     * the user's workflow. Initially empty or displaying a welcome page, the main area is where the workbench opens new views by default.
-     * Unlike any other part, the main area is shared between perspectives, and its layout is not reset when resetting perspectives.
-     *
-     * See {@link WorkbenchLayoutFn} for more information and an example.
-     */
-    abstract layout?: WorkbenchLayoutFn | WorkbenchPerspectives;
-    /**
-     * Provides texts to the SCION Workbench.
-     *
-     * A text provider is a function that returns the text for a translation key.
-     *
-     * Texts starting with the percent symbol (`%`) are passed to the text provider for translation, with the percent symbol omitted.
-     * Otherwise, the text is returned as is.
-     *
-     * The SCION Workbench uses the following translation keys for built-in texts:
-     * - workbench.clear.tooltip
-     * - workbench.close.action
-     * - workbench.close_all_tabs.action
-     * - workbench.close_other_tabs.action
-     * - workbench.close_tab.action
-     * - workbench.close_tab.tooltip
-     * - workbench.close_tabs_to_the_left.action
-     * - workbench.close_tabs_to_the_right.action
-     * - workbench.close.tooltip
-     * - workbench.dev_mode_only_hint.tooltip
-     * - workbench.minimize.tooltip
-     * - workbench.move_tab_down.action
-     * - workbench.move_tab_to_new_window.action
-     * - workbench.move_tab_to_the_left.action
-     * - workbench.move_tab_to_the_right.action
-     * - workbench.move_tab_up.action
-     * - workbench.null_content.message
-     * - workbench.null_view_developer_hint.message
-     * - workbench.ok.action
-     * - workbench.page_not_found.message
-     * - workbench.page_not_found.title
-     * - workbench.page_not_found_developer_hint.message
-     * - workbench.show_open_tabs.tooltip
-     *
-     * The function:
-     * - Can call `inject` to get any required dependencies.
-     * - Can call `toSignal` to convert an Observable to a Signal.
-     *
-     * @see WorkbenchTextProviderFn
-     */
-    abstract textProvider?: WorkbenchTextProviderFn;
-    /**
-     * Provides icons to the SCION Workbench.
-     *
-     * An icon provider is a function that returns a component for an icon. The component renders the icon.
-     *
-     * Defaults to a Material icon provider, interpreting the icon as a Material icon ligature.
-     *
-     * The default icon provider requires the application to include the Material icon font, for example in `styles.scss`, as follows:
-     * ```scss
-     * @import url('https://fonts.googleapis.com/css2?family=Material+Symbols+Rounded');
-     * ```
-     *
-     * The SCION Workbench uses the following icons:
-     * - `workbench.clear`: Clear button in input fields
-     * - `workbench.close`: Close button in views, dialogs and notifications
-     * - `workbench.dirty`: Visual indicator for view with unsaved content
-     * - `workbench.menu_down`: Menu button of drop down menus
-     * - `workbench.minimize`: Minimize button in docked parts
-     * - `workbench.pin`: Visual indicator for a pinned view
-     * - `workbench.search`: Visual indicator in search or filter fields
-     *
-     * To not replace built-in workbench icons, the icon provider can return `undefined` for icons starting with the `workbench.` prefix.
-     *
-     * The function can call `inject` to get any required dependencies.
-     *
-     * @see WorkbenchIconProviderFn
-     */
-    abstract iconProvider?: WorkbenchIconProviderFn;
-    /**
-     * Specifies the component to display in `<wb-workbench>` while the workbench is starting.
-     *
-     * Defaults to a splash showing a loading indicator (ellipsis throbber).
-     *
-     * Note: No splash screen is displayed if starting the workbench in an app initializer.
-     */
-    abstract splashComponent?: ComponentType<unknown>;
-    /**
-     * Specifies the component to display a view tab, enabling custom design or functionality.
-     *
-     * The component can inject {@link WorkbenchView} and {@link VIEW_TAB_RENDERING_CONTEXT} to get a reference to the view and the rendering context.
-     */
-    abstract viewTabComponent?: ComponentType<unknown>;
-    /**
-     * Defines the component to display when no route matches the requested path.
-     *
-     * This can happen when navigating to a non-existent route or after loading the application, if the routes have changed since the user's last session.
-     *
-     * The component can inject {@link WorkbenchView} to get a reference to the view, e.g., to obtain the requested URL.
-     */
-    abstract pageNotFoundComponent?: ComponentType<unknown>;
-    /**
-     * Controls which built-in menu items to display in the view context menu.
-     *
-     * Set to `false` to exclude all built-in menu items.
-     */
-    abstract viewMenuItems?: ViewMenuItemsConfig | false;
-    /**
-     * Configures startup of the SCION Workbench.
-     *
-     * The SCION Workbench starts automatically when the `<wb-workbench>` component is added to the DOM. Alternatively,
-     * the workbench can be started manually using {@link WorkbenchLauncher.launch}, such as in an app initializer or a route guard.
-     *
-     * The application can hook into the startup process of the SCION Workbench by providing one or more initializers to {@link provideWorkbenchInitializer}.
-     * Initializers execute at defined points during startup, enabling the application's controlled initialization. The workbench is fully started once
-     * all initializers have completed.
-     *
-     * The application can inject {@link WorkbenchStartup} to check if the workbench has completed startup.
-     */
-    abstract startup?: {
-        /**
-         * Controls when to start the SCION Workbench. Defaults to `LAZY`.
-         *
-         * - **LAZY**
-         *   Starts the workbench when the `<wb-workbench>` component is added to the DOM or manually via {@link WorkbenchLauncher#launch},
-         *   e.g., from a route guard or app initializer.
-         *
-         *  - **APP_INITIALIZER**
-         *   Starts the workbench during application bootstrapping, blocking Angular's app startup until the workbench is ready.
-         *   No splash is displayed.
-         *
-         * @deprecated since version 19.0.0-beta.3. To start the workbench in an app initializer, use Angular's `provideAppInitializer()` function: `provideAppInitializer(() => inject(WorkbenchLauncher).launch())`. Otherwise, no migration is necessary. No replacement. API will be removed in version 21.
-         */
-        launcher?: 'LAZY' | 'APP_INITIALIZER';
-        /**
-         * Specifies the component to display in `<wb-workbench>` while the workbench is starting.
-         *
-         * Note: No splash screen is displayed when using the app initializer strategy.
-         *
-         * @deprecated since version 19.0.0-beta.3. Property has been moved. Configure the splash in `WorkbenchConfig.splashComponent`. Property will be removed in version 21.
-         */
-        splash?: ComponentType<unknown>;
-    };
-    /**
-     * Configures microfrontend support in the workbench, allowing the integration of microfrontends as workbench views or
-     * workbench popups.
-     *
-     * The workbench uses the "SCION Microfrontend Platform" for providing microfrontend support. To learn more about the
-     * "SCION Microfrontend Platform", refer to https://github.com/SchweizerischeBundesbahnen/scion-microfrontend-platform.
-     *
-     * The workbench allows any web page to be embedded as a workbench view or workbench popup. The web app has to provide
-     * a manifest in which it describes its views and popups. To integrate a third-party application where customization is not
-     * possible, the host application can provide a manifest for that application. If embedded content needs to interact with
-     * the workbench, the web app can use the library `@scion/workbench-client`, a pure TypeScript library based on the
-     * web stack-agnostic `@scion/microfrontend-platform` library.
-     *
-     * The workbench integrates microfrontends through so-called intents, a mechanism known from Android development, enabling
-     * controlled collaboration across application boundaries. "SCION Microfrontend Platform DevTools" can help to inspect
-     * integrated applications and dependencies. The DevTools are available in the form of a microfrontend that can be embedded
-     * like any other microfrontend. Refer to the documentation for detailed instructions on how to integrate
-     * "SCION Microfrontend Platform DevTools".
-     *
-     * Typically, the host app provides API to integrated micro apps via the intent mechanism. Consider registering intent handlers
-     * under the DI token {@link MICROFRONTEND_PLATFORM_POST_STARTUP}.
-     */
-    abstract microfrontendPlatform?: MicrofrontendPlatformConfig | Type<MicrofrontendPlatformConfigLoader>;
-    /**
-     * Provides persistent storage to the SCION Workbench.
-     *
-     * If not set, the workbench uses the browser's local storage as persistent storage.
-     */
-    abstract storage?: Type<WorkbenchStorage>;
-    /**
-     * Configures the behavior of workbench dialogs.
-     */
-    abstract dialog?: {
-        /**
-         * Configures the area to block for application-modal dialogs. If not set, defaults to `workbench`.
-         *
-         * - **workbench:** blocks the {@link WorkbenchComponent|workbench element}, still allowing interaction with elements outside the workbench element.
-         *
-         * - **viewport** blocks the browser viewport, preventing interaction with the application until application-modal dialogs are closed.
-         */
-        modalityScope?: 'workbench' | 'viewport';
-    };
-    /**
-     * Configures logging for the workbench.
-     */
-    abstract logging?: {
-        /**
-         * Sets the minimum severity level a log message must have in order to be logged. By default, if not specified, it is set to {@link LogLevel#INFO}.
-         *
-         * At runtime, you can change the minimum required log level by setting the `loglevel` query parameter.
-         */
-        logLevel?: LogLevel;
-        /**
-         * Registers log appenders to output log messages. Multiple appenders are allowed. By default, if not specified, log messages are written to the console.
-         */
-        logAppenders?: Type<LogAppender>[];
-    };
-}
-/**
- * Configuration of built-in menu items in the view's context menu.
- *
- * Each property represents a menu item, allowing customization of visibility, accelerators, and more.
- *
- * Texts can be changed or localized using a {@link WorkbenchTextProviderFn text provider} passed to {@link provideWorkbench} via the workbench config object.
- */
-export interface ViewMenuItemsConfig {
-    /**
-     * Configures the menu item for closing a view tab.
-     *
-     * Set to `false` to exclude it.
-     *
-     * The menu item text can be changed or localized using a {@link WorkbenchTextProviderFn}.
-     * Translation key: `workbench.close_tab.action`
-     */
-    close?: MenuItemConfig | false;
-    /**
-     * Configures the menu item for closing other view tabs.
-     *
-     * Set to `false` to exclude it.
-     *
-     * The menu item text can be changed or localized using a {@link WorkbenchTextProviderFn}.
-     * Translation key: `workbench.close_other_tabs.action`
-     */
-    closeOthers?: MenuItemConfig | false;
-    /**
-     * Configures the menu item for closing all view tabs.
-     *
-     * Set to `false` to exclude it.
-     *
-     * The menu item text can be changed or localized using a {@link WorkbenchTextProviderFn}.
-     * Translation key: `workbench.close_all_tabs.action`
-     */
-    closeAll?: MenuItemConfig | false;
-    /**
-     * Configures the menu item for closing view tabs to the right.
-     *
-     * Set to `false` to exclude it.
-     *
-     * The menu item text can be changed or localized using a {@link WorkbenchTextProviderFn}.
-     * Translation key: `workbench.close_tabs_to_the_right.action`
-     */
-    closeToTheRight?: MenuItemConfig | false;
-    /**
-     * Configures the menu item for closing view tabs to the left.
-     *
-     * Set to `false` to exclude it.
-     *
-     * The menu item text can be changed or localized using a {@link WorkbenchTextProviderFn}.
-     * Translation key: `workbench.close_tabs_to_the_left.action`
-     */
-    closeToTheLeft?: MenuItemConfig | false;
-    /**
-     * Configures the menu item for moving a view up.
-     *
-     * Set to `false` to exclude it.
-     *
-     * The menu item text can be changed or localized using a {@link WorkbenchTextProviderFn}.
-     * Translation key: `workbench.move_tab_up.action`
-     */
-    moveUp?: MenuItemConfig | false;
-    /**
-     * Configures the menu item for moving a view to the right.
-     *
-     * Set to `false` to exclude it.
-     *
-     * The menu item text can be changed or localized using a {@link WorkbenchTextProviderFn}.
-     * Translation key: `workbench.move_tab_to_the_right.action`
-     */
-    moveRight?: MenuItemConfig | false;
-    /**
-     * Configures the menu item for moving a view down.
-     *
-     * Set to `false` to exclude it.
-     *
-     * The menu item text can be changed or localized using a {@link WorkbenchTextProviderFn}.
-     * Translation key: `workbenchworkbench.move_tab_down.action`
-     */
-    moveDown?: MenuItemConfig | false;
-    /**
-     * Configures the menu item for moving a view to the left.
-     *
-     * Set to `false` to exclude it.
-     *
-     * The menu item text can be changed or localized using a {@link WorkbenchTextProviderFn}.
-     * Translation key: `workbench.move_tab_to_the_left.action`
-     */
-    moveLeft?: MenuItemConfig | false;
-    /**
-     * Configures the menu item for moving a view to a new window.
-     *
-     * Set to `false` to exclude it.
-     *
-     * The menu item text can be changed or localized using a {@link WorkbenchTextProviderFn}.
-     * Translation key: `workbench.move_tab_to_new_window.action`
-     */
-    moveToNewWindow?: MenuItemConfig | false;
-}
-/**
- * Configures a built-in menu item.
- */
-export interface MenuItemConfig {
-    /**
-     * @deprecated since version 19.0.0-beta.2. Set to `false` in {@link ViewMenuItemsConfig} to exclude the menu item. API will be removed in version 21.
-     */
-    visible?: boolean;
-    /**
-     * Specifies the text of this menu item.
-     *
-     * Can be a string or a function that returns a string or a {@link Signal}.
-     *
-     * The function can call `inject` to get any required dependencies, or use `toSignal` to convert an observable to a signal.
-     *
-     * @deprecated since version 19.0.0-beta.3. Register a text provider to change or localize menu item texts. Register the text provider via workbench configuration passed to the `provideWorkbench` function. API will be removed in version 21.
-     */
-    text?: string | (() => string | Signal<string>);
-    accelerator?: string[];
-    group?: string;
-    cssClass?: string | string[];
-}

package/lib/workbench-element-references.d.ts

@@ -1,17 +0,0 @@
-import { InjectionToken, TemplateRef, ViewContainerRef, WritableSignal } from '@angular/core';
-/**
- * DI token to inject the DOM location where to attach iframes.
- */
-export declare const IFRAME_OVERLAY_HOST: InjectionToken<WritableSignal<ViewContainerRef | undefined>>;
-/**
- * DI token to inject the DOM location where to attach the visual placeholder when dragging a view over a drop zone.
- */
-export declare const VIEW_DROP_ZONE_OVERLAY_HOST: InjectionToken<WritableSignal<ViewContainerRef | undefined>>;
-/**
- * DI token to inject the DOM location of the {@link WorkbenchComponent} HTML element.
- */
-export declare const WORKBENCH_ELEMENT_REF: InjectionToken<WritableSignal<ViewContainerRef | undefined>>;
-/**
- * DI token to inject the template for the desktop, if any.
- */
-export declare const DESKTOP: InjectionToken<WritableSignal<TemplateRef<void> | undefined>>;

package/lib/workbench-id.d.ts

@@ -1,7 +0,0 @@
-import { InjectionToken } from '@angular/core';
-/**
- * DI token to get a unique id of the workbench.
- *
- * The id is different each time the app is reloaded. Different workbench windows have different ids.
- */
-export declare const WORKBENCH_ID: InjectionToken<string>;

package/lib/workbench.component.d.ts

@@ -1,41 +0,0 @@
-import { WorkbenchStartup } from './startup/workbench-startup.service';
-import { ɵWorkbenchService } from './ɵworkbench.service';
-import * as i0 from "@angular/core";
-/**
- * Main entry point component of the SCION Workbench.
- */
-export declare class WorkbenchComponent {
-    private _workbenchLauncher;
-    private _logger;
-    private readonly _workbenchRouter;
-    private _iframeOverlayHost;
-    private _viewDropZoneOverlayHost;
-    /** Splash to display during workbench startup. */
-    protected splash: import("@angular/cdk/portal").ComponentType<unknown>;
-    protected workbenchStartup: WorkbenchStartup;
-    protected workbenchService: ɵWorkbenchService;
-    constructor();
-    /**
-     * Toggles layout maximization by pressing Ctrl+Shift+F12.
-     */
-    private installMaximizeShortcutListener;
-    /**
-     * Starts the SCION Workbench. Has no effect if already started, e.g., in an app initializer or route guard.
-     */
-    private startWorkbench;
-    /**
-     * Disables change detection during navigation to avoid partial DOM updates of the workbench layout
-     * if the navigation is asynchronous (e.g., because of lazy loading, async guards, or resolvers).
-     */
-    private disableChangeDetectionDuringNavigation;
-    /**
-     * Initializes tokens to inject references to workbench elements.
-     */
-    private provideWorkbenchElementReferences;
-    /**
-     * Throws if loading the workbench recursively.
-     */
-    private throwOnCircularLoad;
-    static ɵfac: i0.ɵɵFactoryDeclaration<WorkbenchComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<WorkbenchComponent, "wb-workbench", never, {}, {}, never, never, true, never>;
-}

package/lib/workbench.constants.d.ts

@@ -1,73 +0,0 @@
-import { InjectionToken } from '@angular/core';
-/**
- * Represents the id prefix of parts.
- *
- * @see PartId
- */
-export declare const PART_ID_PREFIX = "part.";
-/**
- * Represents the id prefix of views.
- *
- * @see ViewId
- */
-export declare const VIEW_ID_PREFIX = "view.";
-/**
- * Represents the id prefix of activities.
- */
-export declare const ACTIVITY_ID_PREFIX = "activity.";
-/**
- * Represents the id prefix of popups.
- */
-export declare const POPUP_ID_PREFIX = "popup.";
-/**
- * Represents the id prefix of dialogs.
- */
-export declare const DIALOG_ID_PREFIX = "dialog.";
-/**
- * Represents the id prefix of message boxes.
- */
-export declare const MESSAGE_BOX_ID_PREFIX = "messagebox.";
-/**
- * Format of a part outlet name.
- */
-export type PartOutlet = `${typeof PART_ID_PREFIX}${string}`;
-/**
- * Format of a view outlet name.
- */
-export type ViewOutlet = `${typeof VIEW_ID_PREFIX}${number}`;
-/**
- * Format of a popup outlet name.
- */
-export type PopupOutlet = `${typeof POPUP_ID_PREFIX}${string}`;
-/**
- * Format of a dialog outlet name.
- */
-export type DialogOutlet = `${typeof DIALOG_ID_PREFIX}${string}`;
-/**
- * Format of a messagebox outlet name.
- */
-export type MessageBoxOutlet = `${typeof MESSAGE_BOX_ID_PREFIX}${string}`;
-/**
- * Union of workbench outlets.
- */
-export type WorkbenchOutlet = PartOutlet | ViewOutlet | PopupOutlet | DialogOutlet | MessageBoxOutlet;
-/**
- * Name of the query parameter that contains the layout of the main area.
- */
-export declare const MAIN_AREA_LAYOUT_QUERY_PARAM = "main_area";
-/**
- * Defines the context in which a viewtab is rendered.
- *
- * - `tab`: if rendered as view tab in the tabbar
- * - `list-item`:  if rendered as list item in the view list menu
- * - `drag-image`: if rendered as drag image while dragging a view tab
- */
-export type ViewTabRenderingContext = 'tab' | 'list-item' | 'drag-image';
-/**
- * DI token to inject the context in which the view tab is rendered.
- */
-export declare const VIEW_TAB_RENDERING_CONTEXT: InjectionToken<ViewTabRenderingContext>;
-/**
- * Prefix used to identify an anonymous perspective that the workbench creates for views moved to a new window.
- */
-export declare const ANONYMOUS_PERSPECTIVE_ID_PREFIX = "anonymous.";