feat: Allow registering actions for a view

Signed-off-by: Christopher Ng <[email protected]>

lib/index.ts

@@ -7,6 +7,7 @@ import { type Entry, getNewFileMenu } from './newFileMenu'
 import { type Folder } from './files/folder'
 
 export { FileAction, getFileActions, registerFileAction, DefaultType } from './fileAction'
+export { ViewAction } from './viewAction.ts'
 export { Header, getFileListHeaders, registerFileListHeaders } from './fileListHeaders'
 export { type Entry, NewMenuEntryCategory } from './newFileMenu'
 export { Permission } from './permissions'

lib/navigation/view.ts

@@ -2,11 +2,13 @@
  * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
-import type { Folder } from '../files/folder'
-import type { Node } from '../files/node'
+
+import type { Folder } from '../files/folder.ts'
+import type { Node } from '../files/node.ts'
 import isSvg from 'is-svg'
 
-import { Column } from './column.js'
+import { Column } from './column.ts'
+import { ViewAction } from '../viewAction.ts'
 
 export type ContentsWithRoot = {
 	folder: Folder,
@@ -80,6 +82,11 @@ interface ViewData {
 	 */
 	// eslint-disable-next-line no-use-before-define
 	loadChildViews?: (view: View) => Promise<void>
+
+	/**
+	 * The view actions.
+	 */
+	actions?: ViewAction[],
 }
 
 export class View implements ViewData {
@@ -171,6 +178,10 @@ export class View implements ViewData {
 		return this._view.loadChildViews
 	}
 
+	get actions() {
+		return this._view.actions
+	}
+
 }
 
 /**
@@ -240,5 +251,11 @@ const isValidView = function(view: ViewData): boolean {
 		throw new Error('View loadChildViews must be a function')
 	}
 
+	if (view.actions) {
+		if (!view.actions.every((action) => action instanceof ViewAction)) {
+			throw new Error('View actions must be an array of ViewAction. Invalid action found.')
+		}
+	}
+
 	return true
 }

lib/viewAction.ts

@@ -0,0 +1,99 @@
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+import { Node } from './files/node.ts'
+import { View } from './navigation/view.ts'
+
+export interface ViewActionData {
+	/** Unique ID */
+	id: string
+
+	/** Translated name of the action */
+	displayName: (view: View) => string
+
+	/** Translated title of the action */
+	title?: (view: View) => string
+
+	/** Raw svg string */
+	iconSvgInline: (view: View) => string
+
+	/** Returns true if this action shoud be shown */
+	show?: (view: View, nodes: Node[]) => boolean
+
+	/** Returns true if the action should be disabled */
+	disabled?: (view: View, nodes: Node[]) => boolean
+
+	/** Function to execute */
+	exec: (view: View, nodes: Node[]) => Promise<void>,
+}
+
+export class ViewAction {
+
+	private _action: ViewActionData
+
+	constructor(action: ViewActionData) {
+		this.validateAction(action)
+		this._action = action
+	}
+
+	get id() {
+		return this._action.id
+	}
+
+	get displayName() {
+		return this._action.displayName
+	}
+
+	get title() {
+		return this._action.title
+	}
+
+	get iconSvgInline() {
+		return this._action.iconSvgInline
+	}
+
+	get show() {
+		return this._action.show
+	}
+
+	get disabled() {
+		return this._action.disabled
+	}
+
+	get exec() {
+		return this._action.exec
+	}
+
+	private validateAction(action: ViewActionData) {
+		if (!action.id || typeof action.id !== 'string') {
+			throw new Error('Invalid id')
+		}
+
+		if (!action.displayName || typeof action.displayName !== 'function') {
+			throw new Error('Invalid displayName function')
+		}
+
+		if ('title' in action && typeof action.title !== 'function') {
+			throw new Error('Invalid title function')
+		}
+
+		if (!action.iconSvgInline || typeof action.iconSvgInline !== 'function') {
+			throw new Error('Invalid iconSvgInline function')
+		}
+
+		if ('show' in action && typeof action.show !== 'function') {
+			throw new Error('Invalid show function')
+		}
+
+		if ('disabled' in action && typeof action.disabled !== 'function') {
+			throw new Error('Invalid disabled function')
+		}
+
+		if (!action.exec || typeof action.exec !== 'function') {
+			throw new Error('Invalid exec function')
+		}
+	}
+
+}