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

package/lib/layout/migration/model/{workbench-layout-migration-v5.model.d.ts → workbench-grid-migration-v5.model.d.ts}

@@ -30,7 +30,7 @@ export interface MViewV5 {
         cssClass?: string[];
     };
 }
-export type ViewIdV5 = `view.${number}`;
-export type NavigationDataV5 = {
+export interface NavigationDataV5 {
     [key: string]: unknown;
-};
+}
+export type ViewIdV5 = `view.${number}`;

package/lib/layout/migration/model/{workbench-layout-migration-v6.model.d.ts → workbench-grid-migration-v6.model.d.ts}

@@ -29,7 +29,7 @@ export interface MViewV6 {
         cssClass?: string[];
     };
 }
-export type ViewIdV6 = `view.${number}`;
-export type NavigationDataV6 = {
+export interface NavigationDataV6 {
     [key: string]: unknown;
-};
+}
+export type ViewIdV6 = `view.${number}`;

package/lib/layout/migration/model/{workbench-layout-migration-v7.model.d.ts → workbench-grid-migration-v7.model.d.ts}

@@ -30,8 +30,8 @@ export interface MViewV7 {
         cssClass?: string[];
     };
 }
+export interface NavigationDataV7 {
+    [key: string]: unknown;
+}
 export type PartIdV7 = `part.${string}`;
 export type ViewIdV7 = `view.${number}`;
-export type NavigationDataV7 = {
-    [key: string]: unknown;
-};

package/lib/layout/migration/model/workbench-layout-migration-v2.model.d.ts

@@ -1,22 +1,10 @@
-export interface MPartV2 {
-    type: 'MPart';
-    id: string;
-    views: MViewV2[];
-    activeViewId?: string;
-    structural: boolean;
-}
-export interface MTreeNodeV2 {
-    type: 'MTreeNode';
-    nodeId: string;
-    child1: MTreeNodeV2 | MPartV2;
-    child2: MTreeNodeV2 | MPartV2;
-    ratio: number;
-    direction: 'column' | 'row';
-}
-export interface MPartGridV2 {
-    root: MTreeNodeV2 | MPartV2;
-    activePartId: string;
-}
-export interface MViewV2 {
-    id: string;
+export interface MPerspectiveLayoutV2 {
+    referenceLayout: {
+        workbenchGrid: string;
+        viewOutlets: string;
+    };
+    userLayout: {
+        workbenchGrid: string;
+        viewOutlets: string;
+    };
 }

package/lib/layout/migration/model/workbench-layout-migration-v3.model.d.ts

@@ -1,30 +1,10 @@
-export interface MPartV3 {
-    type: 'MPart';
-    id: string;
-    views: MViewV3[];
-    activeViewId?: ViewIdV3;
-    structural: boolean;
-}
-export interface MTreeNodeV3 {
-    type: 'MTreeNode';
-    nodeId: string;
-    child1: MTreeNodeV3 | MPartV3;
-    child2: MTreeNodeV3 | MPartV3;
-    ratio: number;
-    direction: 'column' | 'row';
-}
-export interface MPartGridV3 {
-    root: MTreeNodeV3 | MPartV3;
-    activePartId: string;
-}
-export interface MViewV3 {
-    id: ViewIdV3;
-    alternativeId?: string;
-    cssClass?: string[];
-    navigation?: {
-        hint?: string;
-        cssClass?: string[];
+export interface MPerspectiveLayoutV3 {
+    referenceLayout: {
+        workbenchGrid: string;
+        outlets: string;
+    };
+    userLayout: {
+        workbenchGrid: string;
+        outlets: string;
     };
 }
-export type ViewIdV3 = `view.${number}`;
-export declare const VIEW_ID_PREFIX_V3 = "view.";

package/lib/layout/migration/model/workbench-layout-migration-v4.model.d.ts

@@ -1,31 +1,20 @@
-export interface MPartV4 {
-    type: 'MPart';
-    id: string;
-    views: MViewV4[];
-    activeViewId?: ViewIdV4;
-    structural: boolean;
-}
-export interface MTreeNodeV4 {
-    type: 'MTreeNode';
-    nodeId: string;
-    child1: MTreeNodeV4 | MPartV4;
-    child2: MTreeNodeV4 | MPartV4;
-    ratio: number;
-    direction: 'column' | 'row';
-}
-export interface MPartGridV4 {
-    root: MTreeNodeV4 | MPartV4;
-    activePartId: string;
-}
-export interface MViewV4 {
-    id: ViewIdV4;
-    alternativeId?: string;
-    uid: string;
-    cssClass?: string[];
-    markedForRemoval?: true;
-    navigation?: {
-        hint?: string;
-        cssClass?: string[];
+export interface MWorkbenchLayoutV4 {
+    referenceLayout: {
+        grids: {
+            main: string;
+            [activityId: ActivityId]: string;
+        };
+        activityLayout: string;
+        outlets: string;
+    };
+    userLayout: {
+        grids: {
+            main: string;
+            [activityId: ActivityId]: string;
+        };
+        activityLayout: string;
+        outlets: string;
     };
 }
-export type ViewIdV4 = `view.${number}`;
+type ActivityId = `activity.${string}`;
+export {};

package/lib/layout/migration/workbench-grid-migration-v3.service.d.ts

@@ -0,0 +1,14 @@
+import { WorkbenchMigration } from '../../migration/workbench-migration';
+import * as i0 from "@angular/core";
+/**
+ * Migrates the workbench layout from version 2 to version 3.
+ *
+ * TODO [Angular 20] Remove migrator.
+ */
+export declare class WorkbenchGridMigrationV3 implements WorkbenchMigration {
+    private readonly _router;
+    migrate(json: string): string;
+    private getCurrentUrl;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WorkbenchGridMigrationV3, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WorkbenchGridMigrationV3>;
+}

package/lib/layout/migration/workbench-grid-migration-v4.service.d.ts

@@ -0,0 +1,12 @@
+import { WorkbenchMigration } from '../../migration/workbench-migration';
+import * as i0 from "@angular/core";
+/**
+ * Migrates the workbench layout from version 3 to version 4.
+ *
+ * TODO [Angular 20] Remove migrator.
+ */
+export declare class WorkbenchGridMigrationV4 implements WorkbenchMigration {
+    migrate(json: string): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WorkbenchGridMigrationV4, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WorkbenchGridMigrationV4>;
+}

package/lib/layout/migration/{workbench-layout-migration-v5.service.d.ts → workbench-grid-migration-v5.service.d.ts}

@@ -5,8 +5,8 @@ import * as i0 from "@angular/core";
  *
  * TODO [Angular 20] Remove migrator.
  */
-export declare class WorkbenchLayoutMigrationV5 implements WorkbenchMigration {
+export declare class WorkbenchGridMigrationV5 implements WorkbenchMigration {
     migrate(json: string): string;
-    static ɵfac: i0.ɵɵFactoryDeclaration<WorkbenchLayoutMigrationV5, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<WorkbenchLayoutMigrationV5>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WorkbenchGridMigrationV5, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WorkbenchGridMigrationV5>;
 }

package/lib/layout/migration/workbench-grid-migration-v6.service.d.ts

@@ -0,0 +1,12 @@
+import { WorkbenchMigration } from '../../migration/workbench-migration';
+import * as i0 from "@angular/core";
+/**
+ * Migrates the workbench layout from version 5 to version 6.
+ *
+ * TODO [Angular 20] Remove migrator.
+ */
+export declare class WorkbenchGridMigrationV6 implements WorkbenchMigration {
+    migrate(json: string): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WorkbenchGridMigrationV6, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WorkbenchGridMigrationV6>;
+}

package/lib/layout/migration/workbench-grid-migration-v7.service.d.ts

@@ -0,0 +1,10 @@
+import { WorkbenchMigration } from '../../migration/workbench-migration';
+import * as i0 from "@angular/core";
+/**
+ * Migrates the workbench layout from version 6 to version 7.
+ */
+export declare class WorkbenchGridMigrationV7 implements WorkbenchMigration {
+    migrate(json: string): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WorkbenchGridMigrationV7, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WorkbenchGridMigrationV7>;
+}

package/lib/layout/migration/{workbench-layout-migration-v6.service.d.ts → workbench-layout-migration-v2.service.d.ts}

@@ -1,12 +1,13 @@
 import { WorkbenchMigration } from '../../migration/workbench-migration';
 import * as i0 from "@angular/core";
 /**
- * Migrates the workbench layout from version 5 to version 6.
+ * Migrates the perspective layout from version 1 to version 2.
  *
  * TODO [Angular 20] Remove migrator.
  */
-export declare class WorkbenchLayoutMigrationV6 implements WorkbenchMigration {
+export declare class WorkbenchLayoutMigrationV2 implements WorkbenchMigration {
     migrate(json: string): string;
-    static ɵfac: i0.ɵɵFactoryDeclaration<WorkbenchLayoutMigrationV6, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<WorkbenchLayoutMigrationV6>;
+    private migrateViewOutlets;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WorkbenchLayoutMigrationV2, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WorkbenchLayoutMigrationV2>;
 }

package/lib/layout/migration/workbench-layout-migration-v3.service.d.ts

@@ -1,16 +1,12 @@
-import { Router } from '@angular/router';
 import { WorkbenchMigration } from '../../migration/workbench-migration';
 import * as i0 from "@angular/core";
 /**
- * Migrates the workbench layout from version 2 to version 3.
+ * Migrates the perspective layout from version 2 to version 3.
  *
  * TODO [Angular 20] Remove migrator.
  */
 export declare class WorkbenchLayoutMigrationV3 implements WorkbenchMigration {
-    private _router;
-    constructor(_router: Router);
     migrate(json: string): string;
-    private getCurrentUrl;
     static ɵfac: i0.ɵɵFactoryDeclaration<WorkbenchLayoutMigrationV3, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<WorkbenchLayoutMigrationV3>;
 }

package/lib/layout/migration/workbench-layout-migration-v4.service.d.ts

@@ -1,7 +1,7 @@
 import { WorkbenchMigration } from '../../migration/workbench-migration';
 import * as i0 from "@angular/core";
 /**
- * Migrates the workbench layout from version 3 to version 4.
+ * Migrates the perspective layout from version 3 to version 4.
  *
  * TODO [Angular 20] Remove migrator.
  */

package/lib/layout/public_api.d.ts

@@ -1,3 +1,3 @@
-export { WorkbenchLayout, ReferencePart, MAIN_AREA } from './workbench-layout';
+export { type WorkbenchLayout, type ReferencePart, MAIN_AREA, type DockingArea, type PartExtras, type DockedPartExtras, type WorkbenchLayoutFn } from './workbench-layout';
 export { MAIN_AREA_INITIAL_PART_ID } from './ɵworkbench-layout';
 export { WorkbenchLayoutFactory } from './workbench-layout.factory';

package/lib/layout/rendering-flag.d.ts

@@ -0,0 +1,7 @@
+import { Injector, WritableSignal } from '@angular/core';
+/**
+ * Creates a writable signal to read and write specified flag from and to workbench storage.
+ */
+export declare function renderingFlag<T extends string | number | boolean | null>(storageKey: string, defaultValue: T, options?: {
+    injector?: Injector;
+}): WritableSignal<T>;

package/lib/layout/{workbench-layout.model.d.ts → workbench-grid.model.d.ts}

@@ -1,6 +1,7 @@
 import { ViewId } from '../view/workbench-view.model';
 import { NavigationData } from '../routing/routing.model';
 import { PartId } from '../part/workbench-part.model';
+import { ActivityId } from '../activity/workbench-activity.model';
 /**
  * Represents the arrangement of parts as grid.
  *
@@ -42,12 +43,12 @@ export declare class MTreeNode {
     /**
      * Tests if the given object is a {@link MTreeNode}.
      */
-    static isMTreeNode(object: any): object is MTreeNode;
+    static isMTreeNode(object: unknown): object is MTreeNode;
 }
 /**
  * Represents a part in the grid.
  *
- * A part is a container for views.
+ * A part can be a stack of views or display content.
  *
  * The M-prefix indicates this object is a model object that is serialized and stored, requiring migration on breaking change.
  */
@@ -58,10 +59,12 @@ export declare class MPart {
     readonly type = "MPart";
     id: PartId;
     alternativeId?: string;
+    title?: string;
     parent?: MTreeNode;
     views: MView[];
     activeViewId?: ViewId;
     structural: boolean;
+    cssClass?: string[];
     navigation?: {
         id: string;
         hint?: string;
@@ -72,7 +75,7 @@ export declare class MPart {
     /**
      * Tests if the given object is a {@link MPart}.
      */
-    static isMPart(object: any): object is MPart;
+    static isMPart(object: unknown): object is MPart;
 }
 /**
  * Represents a view contained in a {@link MPart}.
@@ -91,3 +94,23 @@ export interface MView {
         cssClass?: string[];
     };
 }
+/**
+ * Grids referenced in the workbench layout.
+ */
+export interface WorkbenchGrids<T = ɵMPartGrid> {
+    /**
+     * Reference to the "root" grid of the workbench layout.
+     */
+    main: T;
+    /**
+     * Reference to the main area grid, a sub-grid embedded by the main area part contained in the main grid.
+     */
+    mainArea?: T;
+    /**
+     * Grids associated with activities.
+     *
+     * An activity has at least one part, the reference part, specified when creating the activity (docked part).
+     * Removing the reference part removes the activity. Most activities have a grid with only the reference part.
+     */
+    [activityId: ActivityId]: T;
+}

package/lib/{perspective/workbench-grid-merger.service.d.ts → layout/workbench-layout-merger.service.d.ts}

@@ -1,19 +1,19 @@
-import { ɵWorkbenchLayout } from '../layout/ɵworkbench-layout';
+import { ɵWorkbenchLayout } from './ɵworkbench-layout';
 import * as i0 from "@angular/core";
 /**
  * Performs a three-way merge of the local and remote layouts, using the base layout (common ancestor) as the base of the merge operation.
  *
  * TODO [#452] This implementation discards local changes when a new layout is available.
  */
-export declare class WorkbenchGridMerger {
+export declare class WorkbenchLayoutMerger {
     /**
      * Performs a merge of given local and remote layouts, using the base layout as the common ancestor.
      */
-    merge(grids: {
+    merge(layouts: {
         local: ɵWorkbenchLayout;
         remote: ɵWorkbenchLayout;
         base: ɵWorkbenchLayout;
     }): ɵWorkbenchLayout;
-    static ɵfac: i0.ɵɵFactoryDeclaration<WorkbenchGridMerger, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<WorkbenchGridMerger>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WorkbenchLayoutMerger, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WorkbenchLayoutMerger>;
 }

package/lib/layout/workbench-layout-storage.service.d.ts

@@ -0,0 +1,28 @@
+import { MWorkbenchLayout } from './workbench-layout';
+import * as i0 from "@angular/core";
+/**
+ * Provides API for reading and writing the workbench layout to storage.
+ */
+export declare class WorkbenchLayoutStorageService {
+    private readonly _storage;
+    private readonly _workbenchLayoutSerializer;
+    private readonly _logger;
+    /**
+     * Loads specified layout from storage, applying necessary migrations if the serialized layout is outdated.
+     */
+    load(perspectiveId: string): Promise<MWorkbenchLayout | null>;
+    /**
+     * Stores specified layout to storage.
+     */
+    store(perspectiveId: string, layout: MWorkbenchLayout): Promise<void>;
+    /**
+     * Reads the id of the active perspective from storage.
+     */
+    loadActivePerspectiveId(): Promise<string | null>;
+    /**
+     * Writes the id of the active perspective to storage.
+     */
+    storeActivePerspectiveId(perspectiveId: string): Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WorkbenchLayoutStorageService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WorkbenchLayoutStorageService>;
+}