Merge pull request #1484 from nextcloud-libraries/chore/final-interfaces

refactor(headers): use interfaces where possible

Author: susnux

__tests__/headers/listHeaders.spec.ts

@@ -3,10 +3,10 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
-import type { IFolder, IView } from '../../lib/index.ts'
+import type { IFileListHeader, IFolder, IView } from '../../lib/index.ts'
 
 import { beforeEach, describe, expect, test, vi } from 'vitest'
-import { getFileListHeaders, Header, registerFileListHeaders } from '../../lib/headers/index.ts'
+import { getFileListHeaders, registerFileListHeader } from '../../lib/headers/index.ts'
 import { getRegistry } from '../../lib/registry.ts'
 import logger from '../../lib/utils/logger.ts'
 
@@ -16,97 +16,71 @@ describe('FileListHeader init', () => {
 	})
 
 	test('Getting empty uninitialized FileListHeader', () => {
-		logger.debug = vi.fn()
 		const headers = getFileListHeaders()
 		expect(window._nc_filelistheader).toBeDefined()
 		expect(headers).toHaveLength(0)
-		expect(logger.debug).toHaveBeenCalledTimes(1)
 	})
 
 	test('register FileListHeader', () => {
-		logger.debug = vi.fn()
-		const header = new Header({
+		const header: IFileListHeader = {
 			id: 'test',
 			order: 1,
 			enabled: () => true,
 			render: () => {},
 			updated: () => {},
-		})
+		}
 
 		expect(header.id).toBe('test')
 		expect(header.order).toBe(1)
 		expect(header.enabled!({} as IFolder, {} as IView)).toBe(true)
 
-		registerFileListHeaders(header)
+		registerFileListHeader(header)
 
 		expect(window._nc_filelistheader).toHaveLength(1)
 		expect(getFileListHeaders()).toHaveLength(1)
 		expect(getFileListHeaders()[0]).toStrictEqual(header)
-		expect(logger.debug).toHaveBeenCalled()
 	})
 
 	test('register FileListHeader emits registry event', () => {
 		logger.debug = vi.fn()
 		const callback = vi.fn()
-		const header = new Header({
+		const header: IFileListHeader = {
 			id: 'test',
 			order: 1,
 			enabled: () => true,
 			render: () => {},
 			updated: () => {},
-		})
+		}
 
 		getRegistry().addEventListener('register:listHeader', callback)
-		registerFileListHeaders(header)
+		registerFileListHeader(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()
-
-		const headers = getFileListHeaders()
-		// is empty for now
-		expect(headers).toHaveLength(0)
-
-		const header = new Header({
-			id: 'test',
-			order: 1,
-			enabled: () => true,
-			render: () => {},
-			updated: () => {},
-		})
-
-		registerFileListHeaders(header)
-
-		// Now the array changed as it should be reactive
-		expect(headers).toHaveLength(1)
-		expect(headers[0]).toStrictEqual(header)
-	})
-
 	test('Duplicate Header gets rejected', () => {
 		logger.error = vi.fn()
-		const header = new Header({
+		const header: IFileListHeader = {
 			id: 'test',
 			order: 1,
 			render: () => {},
 			updated: () => {},
-		})
+		}
 
-		registerFileListHeaders(header)
+		registerFileListHeader(header)
 		expect(getFileListHeaders()).toHaveLength(1)
 		expect(getFileListHeaders()[0]).toStrictEqual(header)
 
-		const header2 = new Header({
+		const header2: IFileListHeader = {
 			id: 'test',
 			order: 2,
 			render: () => {},
 			updated: () => {},
-		})
+		}
 
-		registerFileListHeaders(header2)
+		registerFileListHeader(header2)
 		expect(getFileListHeaders()).toHaveLength(1)
 		expect(getFileListHeaders()[0]).toStrictEqual(header)
 		expect(logger.error).toHaveBeenCalledWith('Header test already registered', { header: header2 })
@@ -115,68 +89,54 @@ describe('FileListHeader init', () => {
 
 describe('FileListHeader validate', () => {
 	test('Missing required props', () => {
-		expect(() => {
-			new Header({
-				id: null,
-				render: () => {},
-				updated: () => {},
-			} as any as Header)
-		}).toThrowError('Invalid header: id, render and updated are required')
-
-		expect(() => {
-			new Header({
-				id: '123',
-				render: null,
-				updated: () => {},
-			} as any as Header)
-		}).toThrowError('Invalid header: id, render and updated are required')
-
-		expect(() => {
-			new Header({
-				id: '123',
-				render: () => {},
-				updated: null,
-			} as any as Header)
-		}).toThrowError('Invalid header: id, render and updated are required')
+		expect(() => registerFileListHeader({
+			id: null,
+			render: () => {},
+			updated: () => {},
+		} as unknown as IFileListHeader)).toThrowError('Invalid header: id, render and updated are required')
+
+		expect(() => registerFileListHeader({
+			id: '123',
+			render: null,
+			updated: () => {},
+		} as unknown as IFileListHeader)).toThrowError('Invalid header: id, render and updated are required')
+
+		expect(() => registerFileListHeader({
+			id: '123',
+			render: () => {},
+			updated: null,
+		} as unknown as IFileListHeader)).toThrowError('Invalid header: id, render and updated are required')
 	})
 	test('Invalid id', () => {
-		expect(() => {
-			new Header({
-				id: true,
-				render: () => {},
-				updated: () => {},
-			} as any as Header)
-		}).toThrowError('Invalid id property')
+		expect(() => registerFileListHeader({
+			id: true,
+			render: () => {},
+			updated: () => {},
+		} as unknown as IFileListHeader)).toThrowError('Invalid id property')
 	})
 	test('Invalid enabled', () => {
-		expect(() => {
-			new Header({
-				id: 'test',
-				enabled: true,
-				render: () => {},
-				updated: () => {},
-			} as any as Header)
-		}).toThrowError('Invalid enabled property')
+		expect(() => registerFileListHeader({
+			id: 'test',
+			enabled: true,
+			render: () => {},
+			updated: () => {},
+		} as unknown as IFileListHeader)).toThrowError('Invalid enabled property')
 	})
 	test('Invalid render', () => {
-		expect(() => {
-			new Header({
-				id: 'test',
-				enabled: () => {},
-				render: true,
-				updated: () => {},
-			} as any as Header)
-		}).toThrowError('Invalid render property')
+		expect(() => registerFileListHeader({
+			id: 'test',
+			enabled: () => {},
+			render: true,
+			updated: () => {},
+		} as unknown as IFileListHeader)).toThrowError('Invalid render property')
 	})
 	test('Invalid updated', () => {
-		expect(() => {
-			new Header({
-				id: 'test',
-				enabled: () => {},
-				render: () => {},
-				updated: true,
-			} as any as Header)
-		}).toThrowError('Invalid updated property')
+		expect(() => registerFileListHeader({
+			id: 'test',
+			enabled: () => {},
+			render: () => {},
+			updated: true,
+		} as unknown as IFileListHeader)).toThrowError('Invalid updated property')
 	})
 })
 
@@ -186,13 +146,13 @@ describe('FileListHeader exec', () => {
 		const render = vi.fn()
 		const updated = vi.fn()
 
-		const header = new Header({
+		const header: IFileListHeader = {
 			id: 'test',
 			order: 1,
 			enabled,
 			render,
 			updated,
-		})
+		}
 
 		expect(header.enabled).toBe(enabled)
 		expect(header.render).toBe(render)

lib/headers/functions.ts

@@ -5,5 +5,4 @@
 
 export type * from './listHeaders.ts'
 
-export { Header } from './listHeaders.ts'
-export { getFileListHeaders, registerFileListHeaders } from './functions.ts'
+export { getFileListHeaders, registerFileListHeader } from './listHeaders.ts'