@pstdio/workbench 0.8.0 → 0.9.0

package/dist/storage.d.ts

@@ -1,20 +1,19 @@
-declare type ContributionSource = "module" | "extension";
-
-declare type ContributionSource_2 = "module" | "extension";
-
-export declare const createLocalStorageHistoryPersistence: (input: CreateWorkbenchStoragePersistenceInput) => WorkbenchHistoryPersistence;
+import { FileRendererSectionTarget } from '@pstdio/sdk/extensions';
+import { NavigationTargetPage as NavigationTargetPage_2 } from '@pstdio/sdk/extensions';
+import { NavigationTargetPanel as NavigationTargetPanel_2 } from '@pstdio/sdk/extensions';
+import { PageLocation } from '@pstdio/sdk/extensions';
+import { PlacementIdentity } from '@pstdio/sdk/extensions';
+import { ResourceRef } from '@pstdio/sdk/extensions';
 
-export declare const createLocalStorageLastResourcePersistence: (input: CreateLocalStorageLastResourcePersistenceInput) => LastResourcePersistenceAdapter;
-
-export declare interface CreateLocalStorageLastResourcePersistenceInput extends CreateWorkbenchStoragePersistenceInput {
-    scope?: string;
-}
+declare type ContributionSource = "module" | "extension";
 
 export declare const createLocalStorageLayoutPersistence: (input: CreateWorkbenchStoragePersistenceInput) => LayoutPersistenceAdapter;
 
-export declare const createLocalStoragePanelsPersistence: (input: CreateLocalStoragePanelsPersistenceInput) => WorkbenchPanelsPersistenceAdapter;
+export declare const createLocalStoragePageLocationPersistence: (input: CreateWorkbenchStoragePersistenceInput) => WorkbenchPageLocationPersistence;
+
+export declare const createLocalStoragePanelMenuStatePersistence: (input: CreateLocalStoragePanelMenuStatePersistenceInput) => WorkbenchPanelMenuStatePersistenceAdapter;
 
-export declare interface CreateLocalStoragePanelsPersistenceInput extends CreateWorkbenchStoragePersistenceInput {
+export declare interface CreateLocalStoragePanelMenuStatePersistenceInput extends CreateWorkbenchStoragePersistenceInput {
     scope: string;
 }
 
@@ -26,11 +25,10 @@ export declare interface CreateLocalStorageTreePersistenceInput extends CreateWo
 
 export declare const createLocalStorageWorkbenchPersistence: (input: CreateLocalStorageWorkbenchPersistenceInput) => {
     snapshotPersistence: WorkbenchPersistenceAdapter;
-    historyPersistence: WorkbenchHistoryPersistence;
-    layoutPersistence: LayoutPersistenceAdapter_2;
-    panelsPersistence: WorkbenchPanelsPersistenceAdapter;
+    layoutPersistence: LayoutPersistenceAdapter;
+    panelMenuStatePersistence: WorkbenchPanelMenuStatePersistenceAdapter;
+    pageLocationPersistence: WorkbenchPageLocationPersistence;
     treePersistence: TreeRendererPersistenceAdapter;
-    lastResourcePersistence: LastResourcePersistenceAdapter;
     sidePanelPersistence: WorkbenchSidePanelPersistenceAdapter;
 };
 
@@ -48,18 +46,6 @@ declare interface CreateWorkbenchStoragePersistenceInput {
     storage?: WorkbenchStorageLike;
 }
 
-declare interface HistoryStoreState {
-    entries: readonly WorkbenchNavigationEntry[];
-    cursor: number;
-    recentlyClosed: readonly WorkbenchNavigationEntry[];
-    hydrating: boolean;
-}
-
-declare interface LastResourcePersistenceAdapter {
-    getLastResource(): ResourceRef | undefined;
-    setLastResource(resource: ResourceRef | undefined): void;
-}
-
 declare interface LayoutPersistenceAdapter {
     getLayout(scope?: LayoutScope): WorkbenchLayout | undefined;
     setLayout(layout: WorkbenchLayout, scope?: LayoutScope): void;
@@ -72,50 +58,52 @@ declare interface LayoutPersistenceAdapter {
     dispose?(): void;
 }
 
-declare interface LayoutPersistenceAdapter_2 {
-    getLayout(scope?: LayoutScope_2): WorkbenchLayout_2 | undefined;
-    setLayout(layout: WorkbenchLayout_2, scope?: LayoutScope_2): void;
-    listScopes?(projectId: string): LayoutScope_2[];
-    transformLayouts?(projectId: string, transform: (layout: WorkbenchLayout_2, scope: LayoutScope_2) => WorkbenchLayout_2 | undefined): void;
-    getCompatibilityMarker?(key: string): string | undefined;
-    setCompatibilityMarker?(key: string, value: string): void;
-    advanceWriteGeneration?(): number;
-    flush?(): void;
-    dispose?(): void;
-}
-
 declare type LayoutScope = string;
 
-declare type LayoutScope_2 = string;
+declare type NavigationTarget = NavigationTargetItem | NavigationTargetCompound;
 
-declare interface PersistedTreeRendererStates {
-    statesByTreeId: Record<string, TreeRendererState>;
+declare interface NavigationTargetCommand {
+    kind: "command";
+    commandId: string;
+    args?: unknown;
 }
 
-declare interface PersistedWorkbenchHistory extends Omit<HistoryStoreState, "hydrating"> {
-    version: 1 | 2;
+declare interface NavigationTargetCompound {
+    kind: "compound";
+    targets: readonly (NavigationTargetPage | NavigationTargetPanel)[];
 }
 
-declare interface PersistedWorkbenchPanels {
-    openByRegionId: Record<string, boolean>;
+declare interface NavigationTargetHref {
+    kind: "href";
+    href: string;
 }
 
-declare interface ResourceRef {
-    kind: string;
-    uri: string;
-    id?: string;
-    label?: string;
-    icon?: string;
-    metadata?: Record<string, unknown>;
+declare type NavigationTargetItem = NavigationTargetPage | NavigationTargetPanel | NavigationTargetCommand | NavigationTargetHref;
+
+declare type NavigationTargetPage = NavigationTargetPage_2;
+
+declare type NavigationTargetPanel = NavigationTargetPanel_2 | NavigationTargetShellPanel;
+
+declare interface NavigationTargetShellPanel {
+    kind: "panel";
+    panel: ShellPlacementRef;
+    resource?: NavigationTargetPanel_2["resource"];
+    open?: NavigationTargetPanel_2["open"];
+    title?: string;
 }
 
-declare interface ResourceRef_2 {
-    kind: string;
-    uri: string;
-    id?: string;
-    label?: string;
-    icon?: string;
-    metadata?: Record<string, unknown>;
+declare interface PersistedTreeRendererStates {
+    statesByTreeId: Record<string, TreeRendererState>;
+}
+
+declare interface PersistedWorkbenchPanelMenuState {
+    openByMenuId: Record<string, boolean>;
+}
+
+/** Core-only panel ref for host-owned shell placements. Extensions cannot address them. */
+declare interface ShellPlacementRef {
+    kind: "shell-placement";
+    id: string;
 }
 
 declare interface TreeRendererPersistenceAdapter {
@@ -132,18 +120,9 @@ declare interface TreeRendererState {
 
 declare type WidgetMountStrategy = "active" | "keep-mounted";
 
-declare type WidgetMountStrategy_2 = "active" | "keep-mounted";
-
-declare interface WorkbenchClosedSubPanel {
-    region: WorkbenchPanelRegion;
-    reference: WorkbenchSubPanelRef;
-    resource?: ResourceRef;
-    title?: string;
-}
-
-declare interface WorkbenchHistoryPersistence {
-    getHistory(scope?: string): PersistedWorkbenchHistory | undefined;
-    setHistory(state: PersistedWorkbenchHistory, scope?: string): void;
+declare interface WorkbenchCommandTarget {
+    commandId: string;
+    args?: unknown;
 }
 
 declare interface WorkbenchLayout {
@@ -151,54 +130,46 @@ declare interface WorkbenchLayout {
     locationSubPanelSelections?: Record<string, Partial<Record<WorkbenchPanelRegion, string>>>;
     activeWidgetId?: string;
     activeLocationWidgetId?: string;
-    activeResourceUri?: string;
+    activeResourceKey?: string;
 }
 
-declare interface WorkbenchLayout_2 {
-    regions: Record<WorkbenchRegion_2, WorkbenchRegionState_2>;
-    locationSubPanelSelections?: Record<string, Partial<Record<WorkbenchPanelRegion_2, string>>>;
-    activeWidgetId?: string;
-    activeLocationWidgetId?: string;
-    activeResourceUri?: string;
+declare interface WorkbenchPageLocationPersistence {
+    load(projectId: string): PageLocation | undefined;
+    save(projectId: string, location: PageLocation): void;
 }
 
-declare interface WorkbenchLocationRef {
-    key: string;
-    modeId?: string;
+declare interface WorkbenchPanelInstance {
+    instanceId: string;
+    panelId: string;
+    placementIdentity?: PlacementIdentity;
     viewId?: string;
+    ownerId?: string;
+    source?: ContributionSource;
     resource?: ResourceRef;
-    contributionId?: string;
-    instanceKey?: string;
+    section?: FileRendererSectionTarget;
+    resourceKey?: string;
+    ownerResourceKey?: string;
     title?: string;
+    pinned?: boolean;
+    closable: boolean;
+    mountStrategy?: WorkbenchPanelMountStrategy;
+    hiddenByDefault?: boolean;
+    tabRetention?: WorkbenchTabRetention;
+    tab?: WorkbenchPanelTab;
 }
 
-declare interface WorkbenchNavigationEntry {
-    entryId: string;
-    recordedAt: number;
-    location: WorkbenchLocationRef;
-    selectedSubPanels: Partial<Record<WorkbenchPanelRegion, WorkbenchSubPanelRef>>;
-    kind: "resource" | "view" | "widget" | "mode";
-    modeId?: string;
-    resource?: ResourceRef;
-    viewId?: string;
-    widgetId?: string;
-    contributionId?: string;
-    title?: string;
-    closedSubPanel?: WorkbenchClosedSubPanel;
+declare interface WorkbenchPanelMenuStatePersistenceAdapter {
+    getMenuStates(scope?: string): PersistedWorkbenchPanelMenuState | undefined;
+    setMenuStates(state: PersistedWorkbenchPanelMenuState, scope?: string): void;
 }
 
-declare type WorkbenchPanelRegion = (typeof workbenchPanelRegions)[number];
+declare type WorkbenchPanelMountStrategy = WidgetMountStrategy;
 
-declare type WorkbenchPanelRegion_2 = (typeof workbenchPanelRegions_2)[number];
+declare type WorkbenchPanelRegion = (typeof workbenchPanelRegions)[number];
 
 declare const workbenchPanelRegions: readonly ["main", "secondary", "side"];
 
-declare const workbenchPanelRegions_2: readonly ["main", "secondary", "side"];
-
-declare interface WorkbenchPanelsPersistenceAdapter {
-    getPanelStates(scope?: string): PersistedWorkbenchPanels | undefined;
-    setPanelStates(state: PersistedWorkbenchPanels, scope?: string): void;
-}
+declare type WorkbenchPanelTab = WorkbenchWidgetTab;
 
 declare interface WorkbenchPersistenceAdapter {
     getSnapshot(scope?: string): WorkbenchSnapshot | undefined;
@@ -209,11 +180,7 @@ declare interface WorkbenchPersistenceAdapter {
 
 declare type WorkbenchRegion = (typeof workbenchRegions)[number];
 
-declare type WorkbenchRegion_2 = (typeof workbenchRegions_2)[number];
-
-declare const workbenchRegions: readonly ["nav", "activity", "sidenav-header", "sidenav", "main-header", "main-left-menu", "main", "main-right-menu", "secondary-header", "secondary-left-menu", "secondary", "secondary-right-menu", "side-header", "side-left-menu", "side", "side-right-menu", "status", "overlay"];
-
-declare const workbenchRegions_2: readonly ["nav", "activity", "sidenav-header", "sidenav", "main-header", "main-left-menu", "main", "main-right-menu", "secondary-header", "secondary-left-menu", "secondary", "secondary-right-menu", "side-header", "side-left-menu", "side", "side-right-menu", "status", "overlay"];
+declare const workbenchRegions: readonly ["nav", "activity", "sidenav", "main-header", "main-left-menu", "main", "main-right-menu", "secondary-header", "secondary-left-menu", "secondary", "secondary-right-menu", "side-header", "side-left-menu", "side", "side-right-menu", "status", "overlay"];
 
 declare interface WorkbenchRegionState {
     id: WorkbenchRegion;
@@ -223,14 +190,6 @@ declare interface WorkbenchRegionState {
     activeWidgetId?: string;
 }
 
-declare interface WorkbenchRegionState_2 {
-    id: WorkbenchRegion_2;
-    visible: boolean;
-    size?: number;
-    widgets: WorkbenchWidgetPlacement_2[];
-    activeWidgetId?: string;
-}
-
 declare type WorkbenchSidePanelMode = "floating" | "closed" | "attached";
 
 declare interface WorkbenchSidePanelPersistenceAdapter {
@@ -252,27 +211,54 @@ export declare interface WorkbenchStorageLike {
 
 export declare const workbenchStoragePersistenceKey: (namespace: string, kind: WorkbenchStoragePersistenceKind, scope: string | undefined) => string;
 
-export declare type WorkbenchStoragePersistenceKind = "history" | "layout" | "layout-compatibility" | "layout-generation" | "layout-resource-index" | "layout-scope-index" | "panels" | "side-panel" | "tree" | "last-resource";
+export declare type WorkbenchStoragePersistenceKind = "layout" | "layout-compatibility" | "layout-generation" | "layout-resource-index" | "layout-scope-index" | "panel-menus" | "page-location" | "side-panel" | "tree";
 
-declare interface WorkbenchSubPanelRef {
-    contributionId: string;
-    resourceUri?: string;
-    instanceKey?: string;
+declare type WorkbenchTabAction = ({
+    kind: "command";
+} & WorkbenchCommandTarget) | {
+    kind: "navigation";
+    target: NavigationTarget;
+};
+
+declare interface WorkbenchTabMenuGroup {
+    id: string;
+    rows: readonly WorkbenchTabMenuRow[];
+}
+
+declare interface WorkbenchTabMenuRow {
+    id: string;
+    label: string;
+    icon?: string;
+    iconColor?: string;
+    selected?: boolean;
+    disabled?: boolean;
+    action?: WorkbenchTabAction;
 }
 
 declare type WorkbenchTabRetention = "preview" | "persistent";
 
-declare type WorkbenchTabRetention_2 = "preview" | "persistent";
+declare interface WorkbenchTabSnapshot {
+    label?: string;
+    icon?: string;
+    indicator?: {
+        icon: string;
+        color?: string;
+        label?: string;
+    };
+    menu?: readonly WorkbenchTabMenuGroup[];
+}
 
 declare interface WorkbenchWidgetPlacement {
     widgetId: string;
     contributionId: string;
+    placementIdentity?: PlacementIdentity;
     viewId?: string;
     ownerId?: string;
     source?: ContributionSource;
     resource?: ResourceRef;
-    resourceUri?: string;
-    ownerResourceUri?: string;
+    section?: FileRendererSectionTarget;
+    resourceKey?: string;
+    ownerResourceKey?: string;
     title?: string;
     pinned?: boolean;
     closable?: boolean;
@@ -283,39 +269,14 @@ declare interface WorkbenchWidgetPlacement {
     role?: WorkbenchWidgetRole;
 }
 
-declare interface WorkbenchWidgetPlacement_2 {
-    widgetId: string;
-    contributionId: string;
-    viewId?: string;
-    ownerId?: string;
-    source?: ContributionSource_2;
-    resource?: ResourceRef_2;
-    resourceUri?: string;
-    ownerResourceUri?: string;
-    title?: string;
-    pinned?: boolean;
-    closable?: boolean;
-    mountStrategy?: WidgetMountStrategy_2;
-    hiddenByDefault?: boolean;
-    tabRetention?: WorkbenchTabRetention_2;
-    tab?: WorkbenchWidgetTab_2;
-    role?: WorkbenchWidgetRole_2;
-}
-
 declare type WorkbenchWidgetRole = "content" | "location" | "sub-panel" | "panel-menu";
 
-declare type WorkbenchWidgetRole_2 = "content" | "location" | "sub-panel" | "panel-menu";
-
 declare interface WorkbenchWidgetTab {
-    contentRendererId?: string;
-    /** Custom actions shown when the user activates an already-active tab. */
-    customMenuRendererId?: string;
-}
-
-declare interface WorkbenchWidgetTab_2 {
-    contentRendererId?: string;
-    /** Custom actions shown when the user activates an already-active tab. */
-    customMenuRendererId?: string;
+    getSnapshot(instance: WorkbenchPanelInstance): WorkbenchTabSnapshot;
+    subscribe?(listener: () => void): {
+        dispose(): void;
+    } | (() => void);
+    refreshEvents?: readonly string[];
 }
 
 export { }