Merge pull request #1483 from nextcloud-libraries/feat/registry

feat(registry): add new registry to keep track of registration changes

Author: susnux

__tests__/actions/fileAction.spec.ts

@@ -9,6 +9,7 @@ import type { Folder, Node } from '../../lib/node/index.ts'
 
 import { beforeEach, describe, expect, test, vi } from 'vitest'
 import { DefaultType, getFileActions, registerFileAction } from '../../lib/actions/index.ts'
+import { getRegistry } from '../../lib/registry.ts'
 import logger from '../../lib/utils/logger.ts'
 
 const folder = {} as Folder
@@ -43,6 +44,24 @@ describe('FileActions init', () => {
 		expect(getFileActions()[0]).toStrictEqual(action)
 	})
 
+	test('register FileAction emits registry event', () => {
+		const callback = vi.fn()
+		const action: IFileAction = {
+			id: 'test',
+			displayName: () => 'Test',
+			iconSvgInline: () => '<svg></svg>',
+			exec: async () => true,
+		}
+
+		getRegistry().addEventListener('register:action', callback)
+		registerFileAction(action)
+
+		expect(callback).toHaveBeenCalled()
+		expect(callback.mock.calls[0][0]).toBeInstanceOf(CustomEvent)
+		expect(callback.mock.calls[0][0].type).toBe('register:action')
+		expect(callback.mock.calls[0][0].detail).toBe(action)
+	})
+
 	test('getFileActions() returned array is reactive', () => {
 		logger.debug = vi.fn()
 

__tests__/actions/fileListAction.spec.ts

@@ -9,6 +9,7 @@ import type { Folder } from '../../lib/node/index.ts'
 
 import { beforeEach, describe, expect, test, vi } from 'vitest'
 import { getFileListActions, registerFileListAction } from '../../lib/actions/fileListAction.ts'
+import { getRegistry } from '../../lib/registry.ts'
 import logger from '../../lib/utils/logger.ts'
 
 const folder = {} as Folder
@@ -84,6 +85,19 @@ describe('FileListActions init', () => {
 		expect(logger.error).toHaveBeenCalledWith('FileListAction with id "test" is already registered', { action: testActionB })
 		expect(getFileListActions()).toHaveLength(1)
 	})
+
+	test('register FileAction emits registry event', () => {
+		const callback = vi.fn()
+		const testAction = mockAction('test')
+
+		getRegistry().addEventListener('register:listAction', callback)
+		registerFileListAction(testAction)
+
+		expect(callback).toHaveBeenCalled()
+		expect(callback.mock.calls[0][0]).toBeInstanceOf(CustomEvent)
+		expect(callback.mock.calls[0][0].type).toBe('register:listAction')
+		expect(callback.mock.calls[0][0].detail).toBe(testAction)
+	})
 })
 
 describe('Invalid IFileListAction registraction', () => {

__tests__/fileListFilter.spec.ts __tests__/filters/listFilter.spec.ts__tests__/fileListFilter.spec.ts renamed to __tests__/filters/listFilter.spec.ts

@@ -3,18 +3,18 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
-import type { IFileListFilterChip } from '../lib/fileListFilters.ts'
+import type { IFileListFilterChip } from '../../lib/filters/index.ts'
 
-import { subscribe } from '@nextcloud/event-bus'
 import { beforeEach, describe, expect, test, vi } from 'vitest'
-import { FileListFilter, getFileListFilters, registerFileListFilter, unregisterFileListFilter } from '../lib/fileListFilters.ts'
+import { FileListFilter, getFileListFilters, registerFileListFilter, unregisterFileListFilter } from '../../lib/filters/index.ts'
+import { getRegistry } from '../../lib/registry.ts'
 
 class TestFilter extends FileListFilter {
 	public testUpdated() {
 		this.filterUpdated()
 	}
 
-	public testUpdateChips(chips) {
+	public testUpdateChips(chips: IFileListFilterChip[]) {
 		this.updateChips(chips)
 	}
 }
@@ -99,13 +99,14 @@ describe('File list filter functions', () => {
 		const filter = new FileListFilter('my:id')
 		const spy = vi.fn()
 
-		subscribe('files:filter:added', spy)
+		getRegistry().addEventListener('register:listFilter', spy)
 
 		expect(window._nc_filelist_filters).toBe(undefined)
 
 		registerFileListFilter(filter)
 		expect(spy).toHaveBeenCalled()
-		expect(spy).toHaveBeenCalledWith(filter)
+		expect(spy.mock.calls[0][0]).toBeInstanceOf(CustomEvent)
+		expect(spy.mock.calls[0][0].detail).toBe(filter)
 	})
 
 	test('cannot register a filter twice', () => {
@@ -144,11 +145,12 @@ describe('File list filter functions', () => {
 		const spy = vi.fn()
 
 		registerFileListFilter(filter)
-		subscribe('files:filter:removed', spy)
+		getRegistry().addEventListener('unregister:listFilter', spy)
 
 		unregisterFileListFilter(filter.id)
 		expect(spy).toHaveBeenCalled()
-		expect(spy).toHaveBeenCalledWith(filter.id)
+		expect(spy.mock.calls[0][0]).toBeInstanceOf(CustomEvent)
+		expect(spy.mock.calls[0][0].detail).toBe(filter)
 	})
 
 	test('can get registered filters', () => {

__tests__/fileListHeaders.spec.ts __tests__/headers/listHeaders.spec.ts__tests__/fileListHeaders.spec.ts renamed to __tests__/headers/listHeaders.spec.ts

@@ -3,11 +3,12 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
-import type { Folder } from '../lib/node/index.ts'
+import type { IFolder, IView } from '../../lib/index.ts'
 
 import { beforeEach, describe, expect, test, vi } from 'vitest'
-import { getFileListHeaders, Header, registerFileListHeaders } from '../lib/fileListHeaders.ts'
-import logger from '../lib/utils/logger.ts'
+import { getFileListHeaders, Header, registerFileListHeaders } from '../../lib/headers/index.ts'
+import { getRegistry } from '../../lib/registry.ts'
+import logger from '../../lib/utils/logger.ts'
 
 describe('FileListHeader init', () => {
 	beforeEach(() => {
@@ -22,7 +23,7 @@ describe('FileListHeader init', () => {
 		expect(logger.debug).toHaveBeenCalledTimes(1)
 	})
 
-	test('Initializing FileListHeader', () => {
+	test('register FileListHeader', () => {
 		logger.debug = vi.fn()
 		const header = new Header({
 			id: 'test',
@@ -34,7 +35,7 @@ describe('FileListHeader init', () => {
 
 		expect(header.id).toBe('test')
 		expect(header.order).toBe(1)
-		expect(header.enabled!({} as Folder, {})).toBe(true)
+		expect(header.enabled!({} as IFolder, {} as IView)).toBe(true)
 
 		registerFileListHeaders(header)
 
@@ -44,6 +45,25 @@ describe('FileListHeader init', () => {
 		expect(logger.debug).toHaveBeenCalled()
 	})
 
+	test('register FileListHeader emits registry event', () => {
+		logger.debug = vi.fn()
+		const callback = vi.fn()
+		const header = new Header({
+			id: 'test',
+			order: 1,
+			enabled: () => true,
+			render: () => {},
+			updated: () => {},
+		})
+
+		getRegistry().addEventListener('register:listHeader', callback)
+		registerFileListHeaders(header)
+		expect(callback).toHaveBeenCalled()
+		expect(callback.mock.calls[0][0]).toBeInstanceOf(CustomEvent)
+		expect(callback.mock.calls[0][0].type).toBe('register:listHeader')
+		expect(callback.mock.calls[0][0].detail).toBe(header)
+	})
+
 	test('getFileListHeaders() returned array is reactive', () => {
 		logger.debug = vi.fn()
 
@@ -178,9 +198,9 @@ describe('FileListHeader exec', () => {
 		expect(header.render).toBe(render)
 		expect(header.updated).toBe(updated)
 
-		header.enabled!({} as Folder, {})
-		header.render(null as any as HTMLElement, {} as Folder, {})
-		header.updated({} as Folder, {})
+		header.enabled!({} as IFolder, {} as IView)
+		header.render(null as any as HTMLElement, {} as IFolder, {} as IView)
+		header.updated({} as IFolder, {} as IView)
 
 		expect(enabled).toHaveBeenCalled()
 		expect(render).toHaveBeenCalled()

__tests__/newFileMenu.spec.ts __tests__/newMenu/newFileMenu.spec.ts__tests__/newFileMenu.spec.ts renamed to __tests__/newMenu/newFileMenu.spec.ts

@@ -3,14 +3,14 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
-import type { NewMenuEntry } from '../lib/newMenu/index.ts'
+import type { NewMenuEntry } from '../../lib/newMenu/index.ts'
 
 import { afterEach, describe, expect, test, vi } from 'vitest'
-import { addNewFileMenuEntry, getNewFileMenu, getNewFileMenuEntries } from '../lib/newMenu/index.ts'
-import { NewMenu, NewMenuEntryCategory } from '../lib/newMenu/NewMenu.ts'
-import { Folder } from '../lib/node/index.ts'
-import { Permission } from '../lib/permissions.ts'
-import logger from '../lib/utils/logger.ts'
+import { addNewFileMenuEntry, getNewFileMenu, getNewFileMenuEntries } from '../../lib/newMenu/index.ts'
+import { NewMenu, NewMenuEntryCategory } from '../../lib/newMenu/NewMenu.ts'
+import { Folder } from '../../lib/node/index.ts'
+import { Permission } from '../../lib/permissions.ts'
+import logger from '../../lib/utils/logger.ts'
 
 describe('NewFileMenu init', () => {
 	test('Initializing NewFileMenu', () => {

lib/actions/fileAction.ts

@@ -5,6 +5,7 @@
 
 import type { ActionContext, ActionContextSingle } from '../types.ts'
 
+import { getRegistry } from '../registry.ts'
 import logger from '../utils/logger.ts'
 
 export const DefaultType = Object.freeze({
@@ -134,6 +135,8 @@ export function registerFileAction(action: IFileAction): void {
 	}
 
 	window._nc_fileactions.push(action)
+	getRegistry()
+		.dispatchTypedEvent('register:action', new CustomEvent('register:action', { detail: action }))
 }
 
 /**

lib/actions/fileListAction.ts

@@ -5,6 +5,7 @@
 
 import type { ViewActionContext } from '../types.ts'
 
+import { getRegistry } from '../registry.ts'
 import logger from '../utils/logger.ts'
 
 export interface IFileListAction {
@@ -50,6 +51,8 @@ export function registerFileListAction(action: IFileListAction) {
 	}
 
 	window._nc_filelistactions.push(action)
+	getRegistry()
+		.dispatchTypedEvent('register:listAction', new CustomEvent('register:listAction', { detail: action }))
 }
 
 /**

lib/dav/index.ts

@@ -1,4 +1,3 @@
-/* eslint-disable jsdoc/check-tag-names */
 /*!
  * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
  * SPDX-License-Identifier: AGPL-3.0-or-later

lib/filters/functions.ts

@@ -0,0 +1,51 @@
+/*!
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+import type { IFileListFilter } from './listFilters.ts'
+
+import { getRegistry } from '../registry.ts'
+
+/**
+ * Register a new filter on the file list
+ *
+ * This only must be called once to register the filter,
+ * when the filter state changes you need to call `filterUpdated` on the filter instead.
+ *
+ * @param filter The filter to register on the file list
+ */
+export function registerFileListFilter(filter: IFileListFilter): void {
+	window._nc_filelist_filters ??= new Map<string, IFileListFilter>()
+	if (window._nc_filelist_filters.has(filter.id)) {
+		throw new Error(`File list filter "${filter.id}" already registered`)
+	}
+
+	window._nc_filelist_filters.set(filter.id, filter)
+	getRegistry()
+		.dispatchTypedEvent('register:listFilter', new CustomEvent('register:listFilter', { detail: filter }))
+}
+
+/**
+ * Remove a registered filter from the file list
+ *
+ * @param filterId The unique ID of the filter to remove
+ */
+export function unregisterFileListFilter(filterId: string): void {
+	if (window._nc_filelist_filters && window._nc_filelist_filters.has(filterId)) {
+		const filter = window._nc_filelist_filters.get(filterId)!
+		window._nc_filelist_filters.delete(filterId)
+		getRegistry()
+			.dispatchTypedEvent('unregister:listFilter', new CustomEvent('unregister:listFilter', { detail: filter }))
+	}
+}
+
+/**
+ * Get all registered file list filters
+ */
+export function getFileListFilters(): IFileListFilter[] {
+	if (!window._nc_filelist_filters) {
+		return []
+	}
+	return [...window._nc_filelist_filters.values()]
+}

lib/filters/index.ts

@@ -0,0 +1,13 @@
+/*!
+ * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+export type * from './listFilters.ts'
+
+export {
+	getFileListFilters,
+	registerFileListFilter,
+	unregisterFileListFilter,
+} from './functions.ts'
+export { FileListFilter } from './listFilters.ts'