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

package/lib/popup/popup.config.d.ts

@@ -1,193 +0,0 @@
-import { ElementRef, Injector, StaticProvider, Type, ViewContainerRef } from '@angular/core';
-import { Observable } from 'rxjs';
-import { PopupOrigin } from './popup.origin';
-import { ViewId } from '../view/workbench-view.model';
-/**
- * Configures the content to be displayed in a popup.
- *
- * A popup is a visual workbench component for displaying content above other content. It is positioned relative to an anchor,
- * which can be either a page coordinate (x/y) or an HTML element. When using an element as the popup anchor, the popup also
- * moves when the anchor element moves.
- */
-export declare abstract class PopupConfig {
-    /**
-     * Controls where to open the popup.
-     *
-     * Provide either a coordinate or an element to serve as the popup anchor. The align setting can be used to control
-     * the region where to open the popup relative to the anchor.
-     *
-     * If you use an element as the popup anchor, the popup also moves when the anchor element moves. If you use a coordinate
-     * and open the popup in the context of a view, the popup opens relative to the bounds of that view. Otherwise, it
-     * is positioned relative to the page viewport. If you move or resize the view or the page, the popup will also be moved
-     * depending on the pair of coordinates used.
-     *
-     * The following coordinate pairs are supported:
-     * - x/y: relative to the "top/left" corner of the view or page viewport
-     * - top/left: equivalent to passing a "x/y" coordinate
-     * - top/right: relative to the "top/right" corner of the view or page viewport
-     * - bottom/left: relative to the "bottom/left" corner of the view or page viewport
-     * - bottom/right: relative to the "bottom/right" corner of the view or page viewport
-     *
-     * Positioning the popup using coordinates allows to pass an Observable to update the popup position. Note that the popup
-     * will not display until the Observable emits the first coordinate.
-     */
-    abstract readonly anchor: ElementRef<Element> | Element | PopupOrigin | Observable<PopupOrigin>;
-    /**
-     * Specifies the component to display in the popup.
-     *
-     * In the component, you can inject the popup handle {@link Popup} to interact with the popup, such as to close it
-     * or obtain its input data.
-     */
-    abstract readonly component: Type<any>;
-    /**
-     * Instructs Angular how to construct the component. In most cases, construct options need not to be set.
-     */
-    readonly componentConstructOptions?: {
-        /**
-         * Sets the injector for the instantiation of the popup component, giving you control over the objects available
-         * for injection into the popup component. If not specified, uses the application's root injector, or the view's
-         * injector if opened in the context of a view.
-         *
-         * ```ts
-         * Injector.create({
-         *   parent: ...,
-         *   providers: [
-         *    {provide: <DiToken>, useValue: <value>}
-         *   ],
-         * })
-         * ```
-         */
-        injector?: Injector;
-        /**
-         * Specifies providers to be registered with the popup injector. Unlike providers that are registered via a separate {@link injector},
-         * passed providers are registered in the same injector as the popup handle itself, allowing for dependency injection of the popup handle.
-         */
-        providers?: StaticProvider[];
-        /**
-         * Sets the component's attachment point in Angular's logical component tree (not the DOM tree used for rendering), effecting when
-         * Angular checks the component for changes during a change detection cycle. If not set, inserts the component at the top level
-         * in the component tree.
-         */
-        viewContainerRef?: ViewContainerRef;
-    };
-    /**
-     * Hint where to align the popup relative to the popup anchor, unless there is not enough space available in that area. By default,
-     * if not specified, the popup opens north of the anchor.
-     */
-    readonly align?: 'east' | 'west' | 'north' | 'south';
-    /**
-     * Optional data to pass to the popup component. In the component, you can inject the popup handle {@link Popup} to read input data.
-     */
-    readonly input?: any;
-    /**
-     * Controls when to close the popup.
-     */
-    readonly closeStrategy?: CloseStrategy;
-    /**
-     * Specifies the preferred popup size. If not specified, the popup adjusts its size to the content size.
-     */
-    readonly size?: PopupSize;
-    /**
-     * Specifies CSS class(es) to add to the popup, e.g., to locate the popup in tests.
-     */
-    readonly cssClass?: string | string[];
-    /**
-     * Specifies the context in which to open the popup.
-     */
-    readonly context?: {
-        /**
-         * Specifies the view the popup belongs to.
-         *
-         * Binds the popup to the lifecycle of a view so that it displays only if the view is active and closes when the view is closed.
-         *
-         * By default, if opening the popup in the context of a view, that view is used as the popup's contextual view.
-         * If you set the view id to `null`, the popup will open without referring to the contextual view.
-         */
-        viewId?: ViewId | null;
-    };
-}
-/**
- * Specifies when to close the popup.
- */
-export interface CloseStrategy {
-    /**
-     * Controls if to close the popup on focus loss, returning the result set via {@link Popup#setResult} to the popup opener.
-     * Defaults to `true`.
-     */
-    onFocusLost?: boolean;
-    /**
-     * Controls if to close the popup when pressing escape. Defaults to `true`.
-     * No return value will be passed to the popup opener.
-     */
-    onEscape?: boolean;
-}
-/**
- * Represents the preferred popup size as specified by the popup opener.
- */
-export interface PopupSize {
-    /**
-     * Specifies the min-height of the popup.
-     */
-    minHeight?: string;
-    /**
-     * Specifies the height of the popup.
-     */
-    height?: string;
-    /**
-     * Specifies the max-height of the popup.
-     */
-    maxHeight?: string;
-    /**
-     * Specifies the min-width of the popup.
-     */
-    minWidth?: string;
-    /**
-     * Specifies the width of the popup.
-     */
-    width?: string;
-    /**
-     * Specifies the max-width of the popup.
-     */
-    maxWidth?: string;
-}
-/**
- * Represents a handle that a popup component can inject to interact with the popup, for example,
- * to read input data or the configured size, or to close the popup.
- */
-export declare abstract class Popup<T = unknown, R = unknown> {
-    /**
-     * Input data as passed by the popup opener when opened the popup, or `undefined` if not passed.
-     */
-    abstract readonly input: T | undefined;
-    /**
-     * Preferred popup size as specified by the popup opener, or `undefined` if not set.
-     */
-    abstract readonly size: PopupSize | undefined;
-    /**
-     * Provides information about the context in which this popup was opened.
-     *
-     * @deprecated since version 18.0.0-beta.4; Inject {@link WorkbenchView} instead.
-     */
-    abstract readonly referrer: PopupReferrer;
-    /**
-     * CSS classes associated with the popup.
-     */
-    abstract readonly cssClasses: string[];
-    /**
-     * Sets a result that will be passed to the popup opener when the popup is closed on focus loss {@link CloseStrategy#onFocusLost}.
-     */
-    abstract setResult(result?: R): void;
-    /**
-     * Closes the popup. Optionally, pass a result or an error to the popup opener.
-     */
-    abstract close(result?: R | Error): void;
-}
-/**
- * Information about the context in which a popup was opened.
- */
-export interface PopupReferrer {
-    /**
-     * Identity of the view if opened in the context of a view.
-     */
-    viewId?: ViewId;
-}

package/lib/popup/popup.origin.d.ts

@@ -1,44 +0,0 @@
-/**
- * Represents a point on the page or view, optionally with a dimension, where a workbench popup should be attached.
- */
-export type PopupOrigin = (Point | TopLeftPoint | TopRightPoint | BottomLeftPoint | BottomRightPoint) & {
-    width?: number;
-    height?: number;
-};
-/**
- * Coordinate relative to the "x/y" corner of the view or page viewport.
- */
-export interface Point {
-    x: number;
-    y: number;
-}
-/**
- * Coordinate relative to the "top/left" corner of the view or page viewport.
- *
- * This is equivalent to passing a "x/y" coordinate as {@link Point}.
- */
-export interface TopLeftPoint {
-    top: number;
-    left: number;
-}
-/**
- * Coordinate relative to the "top/right" corner of the view or page viewport.
- */
-export interface TopRightPoint {
-    top: number;
-    right: number;
-}
-/**
- * Coordinate relative to the "bottom/left" corner of the view or page viewport.
- */
-export interface BottomLeftPoint {
-    bottom: number;
-    left: number;
-}
-/**
- * Coordinate relative to the "bottom/right" corner of the view or page viewport.
- */
-export interface BottomRightPoint {
-    bottom: number;
-    right: number;
-}

package/lib/popup/popup.service.d.ts

@@ -1,68 +0,0 @@
-import { PopupConfig } from './popup.config';
-import * as i0 from "@angular/core";
-/**
- * Allows displaying a component in a workbench popup.
- *
- * A popup is a visual workbench component for displaying content above other content. It is positioned relative to an anchor,
- * which can be either a coordinate or an HTML element. The popup moves when the anchor moves.
- *
- * Unlike views, popups are not part of the persistent Workbench navigation, meaning that popups do not survive a page reload.
- */
-export declare class PopupService {
-    private readonly _environmentInjector;
-    private readonly _overlay;
-    private readonly _focusManager;
-    private readonly _viewRegistry;
-    private readonly _zone;
-    private readonly _document;
-    private readonly _view;
-    /**
-     * Displays the specified component in a popup.
-     *
-     * To position the popup, provide either a coordinate or an element to serve as the popup anchor.
-     *
-     * If you use an element as the popup anchor, the popup also moves when the anchor element moves. If you use a coordinate
-     * and open the popup in the context of a view, the popup opens relative to the bounds of that view. Otherwise, it
-     * is positioned relative to the page viewport. If you move or resize the view or the page, the popup will also be moved
-     * depending on the pair of coordinates used.
-     *
-     * By setting the alignment of the popup, you can control the region where to open the popup relative to its anchor.
-     *
-     * Optionally, you can pass data to the popup component. The component can inject the popup handle {@link Popup} to
-     * read input data or to close the popup.
-     *
-     * By default, the popup will close on focus loss, or when the user hits the escape key.
-     *
-     * If opening the popup in the context of a view, the popup is bound to the lifecycle of the view, that is, the popup
-     * is displayed only if the view is active and is closed when the view is closed.
-     *
-     * @param   config - Controls popup behavior
-     * @returns a promise that:
-     *          - resolves to the result if closed with a result
-     *          - resolves to `undefined` if closed without a result
-     */
-    open<R>(config: PopupConfig): Promise<R | undefined>;
-    /**
-     * Creates the popup handle.
-     */
-    private createPopup;
-    /**
-     * Closes the popup depending on the configured popup closing strategy.
-     */
-    private installPopupCloser;
-    /**
-     * Hides the popup when its contextual view is detached, and displays it when it is reattached. Also restores the focus on re-activation.
-     * The contextual view is detached if not active, or located in the peripheral area and the main area is maximized.
-     */
-    private hidePopupOnViewDetach;
-    /**
-     * Creates a signal that tracks the position of the popup anchor.
-     */
-    private trackPopupOrigin;
-    /**
-     * Resolves the contextual view to which the popup is bound.
-     */
-    private resolveContextualView;
-    static ɵfac: i0.ɵɵFactoryDeclaration<PopupService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<PopupService>;
-}

package/lib/popup/public_api.d.ts

@@ -1,3 +0,0 @@
-export { PopupService } from './popup.service';
-export { Popup, PopupConfig, CloseStrategy, PopupSize, PopupReferrer } from './popup.config';
-export { Point, TopLeftPoint, TopRightPoint, BottomLeftPoint, BottomRightPoint, PopupOrigin } from './popup.origin';

package/lib/portal/wb-component-portal.d.ts

@@ -1,81 +0,0 @@
-import { ComponentType } from '@angular/cdk/portal';
-import { ComponentRef, Injector, Provider, Signal, ViewContainerRef } from '@angular/core';
-/**
- * Like the Angular CDK 'ComponentPortal' but does not destroy the component on detach.
- *
- * IMPORTANT: In order for the component to have the "correct" injection context, construct it the time attaching it to the Angular component tree,
- * or by calling {@link createComponentFromInjectionContext}. The "correct" injection context is crucial, for example, if the portal is displayed
- * in a router outlet, so that child outlets can register with their logical parent outlet. The Angular router uses the logical outlet hierarchy to
- * resolve and activate child routes.
- *
- * @see WbComponentPortal
- */
-export declare class WbComponentPortal<T = any> {
-    private _componentType;
-    private _options?;
-    private _viewContainerRef;
-    private _componentRef;
-    private _logger;
-    private _attached;
-    constructor(_componentType: ComponentType<T>, _options?: PortalOptions | undefined);
-    /**
-     * Constructs the portal's component using given injection context.
-     */
-    private createComponent;
-    /**
-     * Constructs the portal's component using the given injection context.
-     */
-    createComponentFromInjectionContext(injectionContext: Injector): void;
-    /**
-     * Attaches this portal to the given {@link ViewContainerRef} according to the following rules:
-     *
-     * - If the component is not yet constructed, constructs it based on the given view container's injection context.
-     * - If already attached to the given view container, does nothing.
-     * - If already attached to a different view container, detaches it first.
-     */
-    attach(viewContainerRef: ViewContainerRef): void;
-    /**
-     * Detaches this portal from its view container without destroying it. Does nothing if not attached.
-     *
-     * The portal is removed from the DOM and its change detector detached from the Angular change detector tree,
-     * so it will not be checked for changes until it is reattached.
-     */
-    detach(): void;
-    get isConstructed(): boolean;
-    isAttachedTo(viewContainerRef: ViewContainerRef): boolean;
-    get isDestroyed(): boolean;
-    get componentRef(): ComponentRef<T>;
-    get attached(): Signal<boolean>;
-    private onDestroy;
-    /**
-     * Destroys the component instance and all the data structures associated with it.
-     */
-    destroy(): void;
-}
-/**
- * Controls instantiation of the component.
- */
-export interface PortalOptions {
-    /**
-     * Providers registered with the injector for the instantiation of the component.
-     */
-    providers?: Provider[];
-}
-/**
- * Lifecycle hook for component rendered by {@link WbComponentPortal} when attaching to the DOM.
- */
-export interface OnAttach {
-    /**
-     * Method invoked after attached this component to the DOM.
-     */
-    onAttach(): void;
-}
-/**
- * Lifecycle hook for component rendered by {@link WbComponentPortal} when detaching from the DOM.
- */
-export interface OnDetach {
-    /**
-     * Method invoked before detaching this component from the DOM.
-     */
-    onDetach(): void;
-}

package/lib/portal/workbench-portal-outlet.directive.d.ts

@@ -1,30 +0,0 @@
-import { OnDestroy, TemplateRef, ViewContainerRef } from '@angular/core';
-import { WbComponentPortal } from './wb-component-portal';
-import * as i0 from "@angular/core";
-/**
- * Directive version of {@link WbComponentPortal}, enabling declarative use in templates.
- *
- * Unlike `CdkPortalOutlet` the portal is not destroyed on detach.
- *
- * ---
- * Usage:
- *
- * ```html
- * <ng-container *wbPortalOutlet="greeting"/>
- * <!-- or -->
- * <ng-template [wbPortalOutlet]="greeting"/>
- * ````
- *
- * @see WbComponentPortal
- */
-export declare class WorkbenchPortalOutletDirective implements OnDestroy {
-    private _viewContainerRef;
-    private _portal;
-    constructor(_viewContainerRef: ViewContainerRef, nullTemplate: TemplateRef<void>);
-    set portal(portal: WbComponentPortal | null);
-    private attach;
-    private detach;
-    ngOnDestroy(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<WorkbenchPortalOutletDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<WorkbenchPortalOutletDirective, "ng-template[wbPortalOutlet]", never, { "portal": { "alias": "wbPortalOutlet"; "required": true; }; }, {}, never, never, true, never>;
-}

package/lib/public_api.d.ts

@@ -1,22 +0,0 @@
-export { WorkbenchConfig, MenuItemConfig, ViewMenuItemsConfig } from './workbench-config';
-export { provideWorkbench } from './workbench.provider';
-export { WorkbenchService } from './workbench.service';
-export { WORKBENCH_ID } from './workbench-id';
-export { WorkbenchPartAction, WorkbenchPartActionFn, WorkbenchMenuItem, WorkbenchViewMenuItemFn, WorkbenchTheme, CanClose, CanCloseFn, CanCloseRef } from './workbench.model';
-export { WorkbenchComponent } from './workbench.component';
-export { VIEW_TAB_RENDERING_CONTEXT, ViewTabRenderingContext } from './workbench.constants';
-export * from './layout/public_api';
-export * from './desktop/public_api';
-export * from './perspective/public_api';
-export * from './part/public_api';
-export * from './view/public_api';
-export * from './routing/public_api';
-export * from './message-box/public_api';
-export * from './dialog/public_api';
-export * from './notification/public_api';
-export * from './popup/public_api';
-export * from './common/public_api';
-export * from './microfrontend-platform/public_api';
-export * from './startup/public_api';
-export * from './logging/public_api';
-export * from './storage/public_api';

package/lib/registry/workbench-object-registry.d.ts

@@ -1,51 +0,0 @@
-/**
- * Provides a registry for workbench model objects.
- */
-export declare class WorkbenchObjectRegistry<KEY, T> {
-    private readonly _objects;
-    private readonly _objectsById;
-    private readonly _nullObjectErrorFn;
-    private readonly _onUnregister;
-    readonly objects: import("@angular/core").Signal<T[]>;
-    /**
-     * Creates an instance of the registry.
-     *
-     * This registry must be constructed within an injection context. Destroying the injection context will also destroy the registry,
-     * invoking the specified `onUnregister` function for each object in the registry.
-     *
-     * @param config - Configures the registry.
-     * @param config.nullObjectErrorFn - Function to provide an error when looking up an object not contained in the registry.
-     * @param config.onUnregister - Function invoked when an object is unregistered.
-     */
-    constructor(config?: {
-        nullObjectErrorFn?: (key: KEY) => Error;
-        onUnregister?: (object: T) => void;
-    });
-    /**
-     * Registers an object under given key, replacing any previously registered object with the same key.
-     */
-    register(key: KEY, object: T): void;
-    /**
-     * Unregisters specified object.
-     */
-    unregister(key: KEY): T | null;
-    /**
-     * Returns the object of the given identity. If not found, by default, throws an error unless setting the `orElseNull` option.
-     */
-    get(key: KEY): T;
-    get(key: KEY, options?: {
-        orElse: null;
-    }): T | null;
-    /**
-     * Indicates whether an object with the specified key exists or not.
-     */
-    has(key: KEY): boolean;
-    /**
-     * Indicates whether this registry is empty.
-     */
-    isEmpty(): boolean;
-    /**
-     * Clears this registry.
-     */
-    clear(): void;
-}

package/lib/routing/empty-outlet/empty-outlet.component.d.ts

@@ -1,15 +0,0 @@
-import * as i0 from "@angular/core";
-/**
- * Angular standardizes component-less auxiliary routes by adding the `ɵEmptyOutletComponent` component,
- * but only for routes registered via {@link ROUTES} DI token or passed to {@link Router#resetConfig}.
- *
- * Consequently, auxiliary routes that the workbench dynamically registers based on the current workbench
- * state must also be standardized. However, we do not use Angular's {@link ɵEmptyOutletComponent} component
- * as it does not fill the content to the available space, required for view content.
- *
- * For more information, see the `standardizeConfig` function in Angular.
- */
-export declare class ɵEmptyOutletComponent {
-    static ɵfac: i0.ɵɵFactoryDeclaration<ɵEmptyOutletComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ɵEmptyOutletComponent, "ng-component", never, {}, {}, never, never, true, never>;
-}

package/lib/routing/public_api.d.ts

@@ -1,5 +0,0 @@
-export { WorkbenchRouter } from './workbench-router.service';
-export { WorkbenchRouterLinkDirective } from './workbench-router-link.directive';
-export { WorkbenchRouteData } from './workbench-route-data';
-export { Commands, NavigationData, NavigationState, WorkbenchNavigationExtras, NavigateFn } from './routing.model';
-export { canMatchWorkbenchView, canMatchWorkbenchPerspective, canMatchWorkbenchPart } from './workbench-route-guards';

package/lib/routing/router-outlet-root-context.directive.d.ts

@@ -1,10 +0,0 @@
-import * as i0 from "@angular/core";
-/**
- * Pretends the router outlet to be a top-level router outlet.
- *
- * Use this directive on nested router outlets to be the target of top-level routes, i.e., routes registered by the workbench for each part and view.
- */
-export declare class RouterOutletRootContextDirective {
-    static ɵfac: i0.ɵɵFactoryDeclaration<RouterOutletRootContextDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<RouterOutletRootContextDirective, "router-outlet[wbRouterOutletRootContext]", never, {}, {}, never, never, true, never>;
-}