fix(sidebar): properly implement sidebar Proxy for Nextcloud 33+

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

Author: susnux

lib/sidebar/Sidebar.ts

@@ -3,6 +3,7 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
+import type { INode } from '../node/node.ts'
 import type { ISidebarContext, ISidebarTab } from './SidebarTab.ts'
 
 import { getSidebarTabs, registerSidebarTab } from './SidebarTab.ts'
@@ -17,17 +18,47 @@ export interface ISidebar {
 	/**
 	 * The current open state of the sidebar
 	 */
-	readonly open: boolean
+	readonly isOpen: boolean
 
 	/**
-	 * Open or close the sidebar
+	 * The currently active sidebar tab id
+	 */
+	readonly activeTab?: string
+
+	/**
+	 * The currently opened node in the sidebar
+	 */
+	readonly node?: INode
+
+	/**
+	 * Open the sidebar for a specific node.
+	 *
+	 * When the sidebar is fully opened the `files:sidebar:opened` event is emitted,
+	 * see also `@nextcloud/event-bus`.
 	 *
-	 * @param open - The new open state
+	 * @param node - The node to open the sidebar for
+	 * @param tab - The tab to open by default
 	 */
-	setOpen(open: boolean): void
+	open(node: INode, tab?: string): void
 
 	/**
-	 * Register a new sidebar tab
+	 * Close the sidebar.
+	 *
+	 * When the sidebar is fully closed the `files:sidebar:closed` event is emitted,
+	 * see also `@nextcloud/event-bus`.
+	 */
+	close(): void
+
+	/**
+	 * Set the active sidebar tab
+	 *
+	 * @param tabId - The tab to set active
+	 */
+	setActiveTab(tabId: string): void
+
+	/**
+	 * Register a new sidebar tab.
+	 * This should ideally be done on app initialization using Nextcloud init scripts.
 	 *
 	 * @param tab - The sidebar tab to register
 	 */
@@ -50,36 +81,49 @@ export interface ISidebar {
  */
 class SidebarProxy implements ISidebar {
 
+	get #impl(): Omit<ISidebar, 'available' | 'registerTab'> | undefined {
+		return window.OCA?.Files?._sidebar
+	}
+
 	get available(): boolean {
-		return !!window.OCA?.Files?.Sidebar
+		return !!this.#impl
 	}
 
-	get open(): boolean {
-		return !!window.OCA?.Files?.Sidebar?.state.file
+	get isOpen(): boolean {
+		return this.#impl?.isOpen ?? false
 	}
 
-	setOpen(open: boolean): void {
-		if (open) {
-			window.OCA?.Files?.Sidebar?.open()
-		} else {
-			window.OCA?.Files?.Sidebar?.close()
-		}
+	get activeTab(): string | undefined {
+		return this.#impl?.activeTab
+	}
+
+	get node(): INode | undefined {
+		return this.#impl?.node
+	}
+
+	open(node: INode, tab?: string): void {
+		this.#impl?.open(node, tab)
+	}
+
+	close(): void {
+		this.#impl?.close()
 	}
 
 	setActiveTab(tabId: string): void {
-		window.OCA?.Files?.Sidebar?.setActiveTab(tabId)
+		this.#impl?.setActiveTab(tabId)
 	}
 
 	registerTab(tab: ISidebarTab): void {
 		registerSidebarTab(tab)
 	}
 
 	getTabs(context?: ISidebarContext): ISidebarTab[] {
-		const tabs = getSidebarTabs()
+		let tabs = getSidebarTabs()
 		if (context) {
-			return tabs.filter((tab) => tab.enabled(context))
+			tabs = tabs.filter((tab) => tab.enabled(context))
 		}
-		return tabs
+
+		return tabs.sort((a, b) => a.order - b.order)
 	}
 
 }

lib/sidebar/index.ts

@@ -3,5 +3,5 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
-export type { ISidebarContext, ISidebarTab, SidebarComponent } from './SidebarTab.ts'
 export * from './Sidebar.ts'
+export * from './SidebarTab.ts'