@pstdio/workbench 0.7.0 → 0.8.0

package/dist/index.d.ts

@@ -153,6 +153,7 @@ export declare interface CommandParamDescriptor {
     accept?: string;
     multiple?: boolean;
     metadata?: Record<string, unknown>;
+    resolvedFrom?: "resource";
 }
 
 export declare interface CommandParamOption {
@@ -352,7 +353,13 @@ export declare interface ControlsUpdateValueInput {
     resource?: ResourceRef;
 }
 
-export declare const createResourceBreadcrumbItems: (resources: ResourceRegistry, resource: ResourceRef | undefined) => WorkbenchBreadcrumbItem[];
+export declare const createResourceBreadcrumbItems: (resources: ResourceRegistry, resource: ResourceRef | undefined, views?: WorkbenchViewRegistry) => WorkbenchBreadcrumbItem[];
+
+export declare const createStatusBarRegistry: (input: CreateWorkbenchStatusBarRegistryInput) => WorkbenchStatusBarRegistry;
+
+export declare const createStatusRegistry: () => WorkbenchStatusRegistry;
+
+export declare const createViewRegistry: (input: CreateWorkbenchViewRegistryInput) => WorkbenchViewRegistry;
 
 export declare const createWorkbenchCore: (input?: CreateWorkbenchCoreInput) => WorkbenchCore;
 
@@ -382,6 +389,15 @@ export declare const createWorkbenchSelectionResourceMetadata: (resource: Pick<R
     "workbench.selectionResourceUri": string;
 };
 
+declare interface CreateWorkbenchStatusBarRegistryInput {
+    hasView(viewId: string): boolean;
+}
+
+declare interface CreateWorkbenchViewRegistryInput {
+    getPanel(panelId: string): unknown;
+    openPanel(panelId: string, input?: OpenWorkbenchPanelInput): WorkbenchPanelInstance | Promise<WorkbenchPanelInstance>;
+}
+
 /**
  * Renders its own page. `render` returns `unknown` so core stays React-free — the
  * React layer treats the result as a node, exactly like WorkbenchRendererRegistration.
@@ -666,11 +682,12 @@ export declare interface HistoryController {
     restore(): HistoryEntry | undefined;
     flush(): void;
     clear(): void;
+    migrateState(transform: (state: HistoryStoreState) => HistoryStoreState): void;
 }
 
 export declare type HistoryEntry = WorkbenchNavigationEntry;
 
-declare interface HistoryStoreState {
+export declare interface HistoryStoreState {
     entries: readonly WorkbenchNavigationEntry[];
     cursor: number;
     recentlyClosed: readonly WorkbenchNavigationEntry[];
@@ -679,6 +696,8 @@ declare interface HistoryStoreState {
 
 export declare const isWorkbenchModePanelAvailable: (mode: WorkbenchModeContribution | undefined, panel: WorkbenchPanelRegion) => boolean;
 
+export declare const isWorkbenchViewHierarchyNode: (node: WorkbenchHierarchyNode) => node is WorkbenchViewHierarchyNode;
+
 export declare interface KanbanRendererContribution<TRow extends KanbanRendererRow = KanbanRendererRow> {
     id: string;
     title: string;
@@ -985,11 +1004,14 @@ declare interface MenuRegistryStoreState {
 export declare interface NavigationDispatcherContext {
     canOpenResource?(resource: ResourceRef): boolean;
     canOpenPanel?(panelId: string): boolean;
+    canOpenView?(viewId: string): boolean;
     canExecuteCommand?(commandId: string): boolean;
     createCheckpoint?(): undefined | (() => void);
     openResource(resource: ResourceRef, input?: OpenResourceInput): Promise<unknown>;
     openPanel(panelId: string, input?: OpenWorkbenchPanelInput): unknown;
+    openView(viewId: string, input?: OpenWorkbenchViewInput): Promise<unknown> | unknown;
     executeCommand(commandId: string, args?: unknown): Promise<unknown> | unknown;
+    openHref?(href: string): Promise<unknown> | unknown;
 }
 
 export declare interface NavigationParser {
@@ -1030,7 +1052,12 @@ export declare interface NavigationTargetCompound {
     targets: readonly NavigationTargetItem[];
 }
 
-export declare type NavigationTargetItem = NavigationTargetResource | NavigationTargetPanel | NavigationTargetCommand;
+declare interface NavigationTargetHref {
+    kind: "href";
+    href: string;
+}
+
+export declare type NavigationTargetItem = NavigationTargetResource | NavigationTargetView | NavigationTargetPanel | NavigationTargetCommand | NavigationTargetHref;
 
 export declare interface NavigationTargetPanel {
     kind: "panel";
@@ -1044,6 +1071,12 @@ export declare interface NavigationTargetResource {
     input?: OpenResourceInput;
 }
 
+export declare interface NavigationTargetView {
+    kind: "view";
+    viewId: string;
+    input?: OpenWorkbenchViewInput;
+}
+
 declare const NO_GROUPING = "none";
 
 export declare interface NotificationRegistry {
@@ -1060,7 +1093,8 @@ export declare interface OpenResourceInput {
 }
 
 declare interface OpenWidgetInput {
-    resource?: ResourceRef;
+    viewId?: string | null;
+    resource?: ResourceRef | null;
     title?: string;
     region?: WorkbenchRegion;
     role?: WorkbenchWidgetRole;
@@ -1078,7 +1112,10 @@ declare interface OpenWidgetInput {
 }
 
 export declare interface OpenWorkbenchPanelInput {
-    resource?: ResourceRef;
+    /** Set by the view registry. Low-level layout callers should leave this undefined. */
+    viewId?: string | null;
+    /** `null` explicitly clears an existing singleton placement's resource binding. */
+    resource?: ResourceRef | null;
     title?: string;
     region?: WorkbenchRegion;
     role?: WorkbenchWidgetRole;
@@ -1090,6 +1127,8 @@ export declare interface OpenWorkbenchPanelInput {
     strategy?: WorkbenchPanelOpenStrategy;
 }
 
+export declare type OpenWorkbenchViewInput = Omit<OpenWorkbenchPanelInput, "viewId">;
+
 export declare interface PersistedCompositionLayout {
     regions: Partial<Record<DockedCompositionRegion, PersistedCompositionRegionState>>;
 }
@@ -1104,7 +1143,7 @@ export declare interface PersistedTreeRendererStates {
 }
 
 export declare interface PersistedWorkbenchHistory extends Omit<HistoryStoreState, "hydrating"> {
-    version: 1;
+    version: 1 | 2;
 }
 
 declare interface PersistedWorkbenchPanels {
@@ -1234,6 +1273,10 @@ declare interface RegisteredWorkbenchNotification extends RegisteredContribution
     metadata?: Record<string, unknown>;
 }
 
+declare type RegisteredWorkbenchStatusSet = WorkbenchStatusSetContribution & RegisteredContributionMetadata;
+
+export declare type RegisteredWorkbenchView = WorkbenchViewContribution & RegisteredContributionMetadata;
+
 export declare const resolveAnchorRegion: (anchorId: AnchorId) => "status" | "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" | "overlay";
 
 export declare const resolveComposition: (input: ResolveCompositionInput) => ResolvedComposition;
@@ -1304,7 +1347,7 @@ export declare const resourceContextMenuPath: (resourceKind: string) => MenuPath
 
 export declare interface ResourceHierarchyCycle {
     code: typeof resourceHierarchyCycleCode;
-    path: ResourceRef[];
+    path: WorkbenchHierarchyNode[];
     repeatedUri: string;
 }
 
@@ -1314,7 +1357,7 @@ export declare interface ResourceHierarchyProvider {
     id: string;
     priority?: number;
     canResolve(resource: ResourceRef): boolean;
-    getParent(resource: ResourceRef): ResourceRef | undefined;
+    getParent(resource: ResourceRef): WorkbenchHierarchyNode | undefined;
 }
 
 export declare interface ResourceKindContribution {
@@ -1373,7 +1416,7 @@ export declare interface ResourceRegistry {
     listResources(query: string): readonly ResourceBrowseEntry[];
     registerHierarchyProvider(provider: ResourceHierarchyProvider): Disposable_2;
     listHierarchyProviders(): ResolvedResourceHierarchyProvider[];
-    walkHierarchy(resource: ResourceRef | undefined): ResourceRef[];
+    walkHierarchy(resource: ResourceRef | undefined): WorkbenchHierarchyNode[];
     onDidDetectHierarchyCycle(listener: (cycle: ResourceHierarchyCycle) => void): Disposable_2;
     isOpeningResource(): boolean;
     openResource(resource: ResourceRef, input?: OpenResourceInput): Promise<WorkbenchPanelInstance>;
@@ -1799,6 +1842,7 @@ declare interface WorkbenchCompositionRegionPanels {
 
 export declare interface WorkbenchCore extends WorkbenchCoreContributionContext {
     host: WorkbenchHost;
+    layout: WorkbenchLayoutModel;
     registerModule(module: WorkbenchModuleContribution): Disposable_2;
     unregisterModule(moduleId: string): void;
 }
@@ -1814,7 +1858,7 @@ declare interface WorkbenchCoreContributionContext {
     history: HistoryController;
     keybindings: KeybindingRegistry;
     lastResource: WorkbenchLastResourceController;
-    layout: WorkbenchLayoutModel;
+    layout: WorkbenchModuleLayoutModel;
     modes: WorkbenchModeRegistry;
     navigation: NavigationRegistry;
     navigator: WorkbenchNavigator;
@@ -1823,7 +1867,10 @@ declare interface WorkbenchCoreContributionContext {
     preferences: PreferenceRegistry;
     renderers: WorkbenchRenderers;
     resources: ResourceRegistry;
+    views: WorkbenchViewRegistry;
     settings: SettingsRegistry;
+    statusBar: WorkbenchStatusBarRegistry;
+    statuses: WorkbenchStatusRegistry;
     shell: WorkbenchShellController;
     sidePanel: WorkbenchSidePanelController;
     terminal: WorkbenchTerminalController;
@@ -1859,6 +1906,8 @@ declare interface WorkbenchFocusState {
     activeRegion: WorkbenchFocusRegionId | undefined;
 }
 
+export declare type WorkbenchHierarchyNode = ResourceRef | WorkbenchViewHierarchyNode;
+
 declare interface WorkbenchHistoryPersistence {
     getHistory(scope?: string): PersistedWorkbenchHistory | undefined;
     setHistory(state: PersistedWorkbenchHistory, scope?: string): void;
@@ -1902,11 +1951,16 @@ export declare interface WorkbenchLocationEligibility {
     resourceKinds?: string[];
     resourceIds?: string[];
     canOpen?(resource: ResourceRef): boolean;
+    canOpenLocation?(location: {
+        resource?: ResourceRef;
+        viewId?: string;
+    }): boolean;
 }
 
 declare interface WorkbenchLocationRef {
     key: string;
     modeId?: string;
+    viewId?: string;
     resource?: ResourceRef;
     contributionId?: string;
     instanceKey?: string;
@@ -1977,6 +2031,8 @@ export declare interface WorkbenchModuleContribution {
 
 export declare type WorkbenchModuleContributionContext = WorkbenchModuleContext;
 
+declare type WorkbenchModuleLayoutModel = Omit<WorkbenchLayoutModel, "registerWidget">;
+
 declare interface WorkbenchNavigationCommit {
     modeId: string | undefined;
     resource: ResourceRef | undefined;
@@ -1985,14 +2041,15 @@ declare interface WorkbenchNavigationCommit {
 
 declare type WorkbenchNavigationDiagnosticCode = "navigation_mode_missing" | "navigation_resource_missing" | "navigation_resource_incompatible" | "navigation_default_missing" | "navigation_target_stale";
 
-declare interface WorkbenchNavigationEntry {
+export declare interface WorkbenchNavigationEntry {
     entryId: string;
     recordedAt: number;
     location: WorkbenchLocationRef;
     selectedSubPanels: Partial<Record<WorkbenchPanelRegion, WorkbenchSubPanelRef>>;
-    kind: "resource" | "widget" | "mode";
+    kind: "resource" | "view" | "widget" | "mode";
     modeId?: string;
     resource?: ResourceRef;
+    viewId?: string;
     widgetId?: string;
     contributionId?: string;
     title?: string;
@@ -2111,6 +2168,7 @@ export declare interface WorkbenchPanelContribution {
 export declare interface WorkbenchPanelInstance {
     instanceId: string;
     panelId: string;
+    viewId?: string;
     ownerId?: string;
     source?: ContributionSource;
     resource?: ResourceRef;
@@ -2340,6 +2398,52 @@ export declare interface WorkbenchSnapshot {
     layout: WorkbenchLayout;
 }
 
+export declare interface WorkbenchStatusBarItem {
+    id: string;
+    viewId: string;
+    slot: WorkbenchStatusBarSlot;
+    order?: number;
+    isVisible?(): boolean;
+}
+
+export declare interface WorkbenchStatusBarRegistry {
+    store: WorkbenchStore<WorkbenchStatusBarRegistryState>;
+    registerItem(item: WorkbenchStatusBarItem): Disposable_2;
+    getItem(id: string): WorkbenchStatusBarItem | undefined;
+    listItems(): WorkbenchStatusBarItem[];
+    listVisibleItems(slot?: WorkbenchStatusBarSlot): WorkbenchStatusBarItem[];
+}
+
+export declare interface WorkbenchStatusBarRegistryState {
+    items: Record<string, WorkbenchStatusBarItem>;
+}
+
+export declare type WorkbenchStatusBarSlot = "leading" | "trailing";
+
+export declare interface WorkbenchStatusRegistry {
+    store: WorkbenchStore<WorkbenchStatusRegistryState>;
+    registerStatusSet(contribution: WorkbenchStatusSetContribution, metadata?: ContributionMetadata): Disposable_2;
+    getStatusSet(id: string): RegisteredWorkbenchStatusSet | undefined;
+    listStatusSets(): RegisteredWorkbenchStatusSet[];
+    getStatuses(id: string): readonly WorkflowStatus[] | undefined;
+    load(id: string): Promise<readonly WorkflowStatus[]>;
+    query(id: string): Promise<readonly WorkflowStatus[]>;
+    save(id: string, statuses: readonly WorkflowStatus[]): Promise<readonly WorkflowStatus[]>;
+}
+
+export declare interface WorkbenchStatusRegistryState {
+    statusSets: Record<string, RegisteredWorkbenchStatusSet>;
+    values: Record<string, readonly WorkflowStatus[]>;
+}
+
+export declare interface WorkbenchStatusSetContribution {
+    id: string;
+    title: string;
+    actions?: readonly WorkflowStatusAction[];
+    query(): Promise<readonly WorkflowStatus[]> | readonly WorkflowStatus[];
+    save?(statuses: readonly WorkflowStatus[]): Promise<readonly WorkflowStatus[]> | readonly WorkflowStatus[];
+}
+
 declare interface WorkbenchStore<TState> {
     getState(): TState;
     getInitialState(): TState;
@@ -2361,7 +2465,7 @@ declare type WorkbenchSubPanelContribution = Omit<WidgetContribution, "region" |
     fallbackRegion?: WorkbenchPanelRegion;
 } & WorkbenchPanelMenusContribution;
 
-declare interface WorkbenchSubPanelRef {
+export declare interface WorkbenchSubPanelRef {
     contributionId: string;
     resourceUri?: string;
     instanceKey?: string;
@@ -2384,6 +2488,7 @@ export declare interface WorkbenchTerminalController {
     setSessionOpener(opener: WorkbenchTerminalSessionOpener | null): void;
     /** Opens a session; the live adapter stays host-side and only the id is returned. */
     open(input: {
+        bindingId?: string;
         request: WorkbenchTerminalSessionRequest;
         title?: string;
     }): Promise<{
@@ -2402,6 +2507,7 @@ export declare interface WorkbenchTerminalController {
         sessionId: string;
         signal?: string;
     }): Promise<void>;
+    killBinding(bindingId: string): Promise<void>;
     subscribe(sessionId: string, sink: WorkbenchTerminalSessionSink): () => void;
     getSession(sessionId: string): WorkbenchTerminalSessionModel | undefined;
     listSessions(): WorkbenchTerminalSessionModel[];
@@ -2467,9 +2573,60 @@ export declare const workbenchTopHeaderLeadingMenuPath: MenuPath;
 
 export declare const workbenchTopHeaderTrailingMenuPath: MenuPath;
 
+export declare interface WorkbenchViewContribution {
+    id: string;
+    panelId: string;
+    title?: string;
+    icon?: string;
+    path?: string;
+    pathAliases?: readonly string[];
+    aliases?: readonly string[];
+    resource?: ResourceRef;
+    canResolve?(): boolean;
+    resolveInput?(input: OpenWorkbenchViewInput): OpenWorkbenchPanelInput;
+}
+
+export declare interface WorkbenchViewHierarchyNode {
+    type: "view";
+    viewId: string;
+    label?: string;
+    icon?: string;
+}
+
+export declare const workbenchViewIdContextKey = "workbench.view.id";
+
+export declare interface WorkbenchViewOpenEvent {
+    viewId: string;
+    input: OpenWorkbenchViewInput;
+    instance: WorkbenchPanelInstance;
+}
+
+export declare interface WorkbenchViewRegistry {
+    store: WorkbenchStore<WorkbenchViewRegistryStoreState>;
+    registerView(view: WorkbenchViewContribution, metadata?: ContributionMetadata): Disposable_2;
+    getView(viewId: string): RegisteredWorkbenchView | undefined;
+    listViews(): RegisteredWorkbenchView[];
+    resolveViewId(viewId: string): string | undefined;
+    resolvePath(path: string): {
+        kind: "view";
+        viewId: string;
+    } | undefined;
+    canResolveView(viewId: string): boolean;
+    isOpeningView(): boolean;
+    openView(viewId: string, input?: OpenWorkbenchViewInput): Promise<WorkbenchPanelInstance>;
+    onDidOpenView(listener: (event: WorkbenchViewOpenEvent) => void): Disposable_2;
+}
+
+export declare interface WorkbenchViewRegistryStoreState {
+    views: Record<string, RegisteredWorkbenchView>;
+    aliases: Record<string, string>;
+    paths: Record<string, string>;
+}
+
 export declare interface WorkbenchWidgetPlacement {
     widgetId: string;
     contributionId: string;
+    viewId?: string;
     ownerId?: string;
     source?: ContributionSource;
     resource?: ResourceRef;
@@ -2493,4 +2650,27 @@ declare interface WorkbenchWidgetTab {
     customMenuRendererId?: string;
 }
 
+export declare interface WorkflowStatus {
+    id: string;
+    label: string;
+    color: string;
+    icon?: string | null;
+    sortOrder: number;
+    isDefault?: boolean;
+    board?: WorkflowStatusBoardRules;
+}
+
+export declare interface WorkflowStatusAction {
+    id: string;
+    label: string;
+    icon?: string;
+}
+
+export declare interface WorkflowStatusBoardRules {
+    canCreate?: boolean;
+    canDragIn?: boolean;
+    canDragOut?: boolean;
+    actions?: readonly string[];
+}
+
 export { }