From a445a87339afe51ccc56ecae4008cf97eb38280e Mon Sep 17 00:00:00 2001
From: Louis Chemineau <louis@chmn.me>
Date: Thu, 25 Jan 2024 10:25:16 +0100
Subject: Move modal outside of the Version component.

This is for accessibility, to have the NcListItem (<li>) as a direct child of the <ul>

Signed-off-by: Louis Chemineau <louis@chmn.me>
---
 apps/files_versions/src/utils/versions.js | 164 ------------------------------
 apps/files_versions/src/utils/versions.ts | 150 +++++++++++++++++++++++++++
 2 files changed, 150 insertions(+), 164 deletions(-)
 delete mode 100644 apps/files_versions/src/utils/versions.js
 create mode 100644 apps/files_versions/src/utils/versions.ts

(limited to 'apps/files_versions/src/utils')

diff --git a/apps/files_versions/src/utils/versions.js b/apps/files_versions/src/utils/versions.js
deleted file mode 100644
index 98df139a87f..00000000000
--- a/apps/files_versions/src/utils/versions.js
+++ /dev/null
@@ -1,164 +0,0 @@
-/**
- * @copyright 2022 Louis Chemineau <mlouis@chmn.me>
- *
- * @author Louis Chemineau <mlouis@chmn.me>
- *
- * @license AGPL-3.0-or-later
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-
-import { getCurrentUser } from '@nextcloud/auth'
-import { joinPaths } from '@nextcloud/paths'
-import { generateRemoteUrl, generateUrl } from '@nextcloud/router'
-import moment from '@nextcloud/moment'
-
-import { encodeFilePath } from '../../../files/src/utils/fileUtils.ts'
-
-import client from '../utils/davClient.js'
-import davRequest from '../utils/davRequest.js'
-import logger from '../utils/logger.js'
-
-/**
- * @typedef {object} Version
- * @property {string} fileId - The id of the file associated to the version.
- * @property {string} label - 'Current version' or ''
- * @property {string} filename - File name relative to the version DAV endpoint
- * @property {string} basename - A base name generated from the mtime
- * @property {string} mime - Empty for the current version, else the actual mime type of the version
- * @property {string} etag - Empty for the current version, else the actual mime type of the version
- * @property {string} size - Human readable size
- * @property {string} type - 'file'
- * @property {number} mtime - Version creation date as a timestamp
- * @property {string} permissions - Only readable: 'R'
- * @property {boolean} hasPreview - Whether the version has a preview
- * @property {string} previewUrl - Preview URL of the version
- * @property {string} url - Download URL of the version
- * @property {string} source - The WebDAV endpoint of the ressource
- * @property {string|null} fileVersion - The version id, null for the current version
- */
-
-/**
- * @param fileInfo
- * @return {Promise<Version[]>}
- */
-export async function fetchVersions(fileInfo) {
-	const path = `/versions/${getCurrentUser()?.uid}/versions/${fileInfo.id}`
-
-	try {
-		/** @type {import('webdav').ResponseDataDetailed<import('webdav').FileStat[]>} */
-		const response = await client.getDirectoryContents(path, {
-			data: davRequest,
-			details: true,
-		})
-		return response.data
-			// Filter out root
-			.filter(({ mime }) => mime !== '')
-			.map(version => formatVersion(version, fileInfo))
-	} catch (exception) {
-		logger.error('Could not fetch version', { exception })
-		throw exception
-	}
-}
-
-/**
- * Restore the given version
- *
- * @param {Version} version
- */
-export async function restoreVersion(version) {
-	try {
-		logger.debug('Restoring version', { url: version.url })
-		await client.moveFile(
-			`/versions/${getCurrentUser()?.uid}/versions/${version.fileId}/${version.fileVersion}`,
-			`/versions/${getCurrentUser()?.uid}/restore/target`,
-		)
-	} catch (exception) {
-		logger.error('Could not restore version', { exception })
-		throw exception
-	}
-}
-
-/**
- * Format version
- *
- * @param {object} version - raw version received from the versions DAV endpoint
- * @param {object} fileInfo - file properties received from the files DAV endpoint
- * @return {Version}
- */
-function formatVersion(version, fileInfo) {
-	const mtime = moment(version.lastmod).unix() * 1000
-	let previewUrl = ''
-
-	if (mtime === fileInfo.mtime) { // Version is the current one
-		previewUrl = generateUrl('/core/preview?fileId={fileId}&c={fileEtag}&x=250&y=250&forceIcon=0&a=0', {
-			fileId: fileInfo.id,
-			fileEtag: fileInfo.etag,
-		})
-	} else {
-		previewUrl = generateUrl('/apps/files_versions/preview?file={file}&version={fileVersion}', {
-			file: joinPaths(fileInfo.path, fileInfo.name),
-			fileVersion: version.basename,
-		})
-	}
-
-	return {
-		fileId: fileInfo.id,
-		label: version.props['version-label'],
-		filename: version.filename,
-		basename: moment(mtime).format('LLL'),
-		mime: version.mime,
-		etag: `${version.props.getetag}`,
-		size: version.size,
-		type: version.type,
-		mtime,
-		permissions: 'R',
-		hasPreview: version.props['has-preview'] === 1,
-		previewUrl,
-		url: joinPaths('/remote.php/dav', version.filename),
-		source: generateRemoteUrl('dav') + encodeFilePath(version.filename),
-		fileVersion: version.basename,
-	}
-}
-
-/**
- * @param {Version} version
- * @param {string} newLabel
- */
-export async function setVersionLabel(version, newLabel) {
-	return await client.customRequest(
-		version.filename,
-		{
-			method: 'PROPPATCH',
-			data: `<?xml version="1.0"?>
-					<d:propertyupdate xmlns:d="DAV:"
-						xmlns:oc="http://owncloud.org/ns"
-						xmlns:nc="http://nextcloud.org/ns"
-						xmlns:ocs="http://open-collaboration-services.org/ns">
-					<d:set>
-						<d:prop>
-							<nc:version-label>${newLabel}</nc:version-label>
-						</d:prop>
-					</d:set>
-					</d:propertyupdate>`,
-		},
-	)
-}
-
-/**
- * @param {Version} version
- */
-export async function deleteVersion(version) {
-	await client.deleteFile(version.filename)
-}
diff --git a/apps/files_versions/src/utils/versions.ts b/apps/files_versions/src/utils/versions.ts
new file mode 100644
index 00000000000..b33f75aefa7
--- /dev/null
+++ b/apps/files_versions/src/utils/versions.ts
@@ -0,0 +1,150 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable jsdoc/require-param */
+/* eslint-disable jsdoc/require-jsdoc */
+/**
+ * @copyright 2022 Louis Chemineau <mlouis@chmn.me>
+ *
+ * @author Louis Chemineau <mlouis@chmn.me>
+ *
+ * @license AGPL-3.0-or-later
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import { getCurrentUser } from '@nextcloud/auth'
+import { joinPaths } from '@nextcloud/paths'
+import { generateRemoteUrl, generateUrl } from '@nextcloud/router'
+import moment from '@nextcloud/moment'
+
+import { encodeFilePath } from '../../../files/src/utils/fileUtils.ts'
+
+import client from '../utils/davClient.js'
+import davRequest from '../utils/davRequest.js'
+import logger from '../utils/logger.js'
+import type { FileStat, ResponseDataDetailed } from 'webdav'
+
+export interface Version {
+	fileId: string, // The id of the file associated to the version.
+	label: string, // 'Current version' or ''
+	filename: string, // File name relative to the version DAV endpoint
+	basename: string, // A base name generated from the mtime
+	mime: string, // Empty for the current version, else the actual mime type of the version
+	etag: string, // Empty for the current version, else the actual mime type of the version
+	size: string, // Human readable size
+	type: string, // 'file'
+	mtime: number, // Version creation date as a timestamp
+	permissions: string, // Only readable: 'R'
+	hasPreview: boolean, // Whether the version has a preview
+	previewUrl: string, // Preview URL of the version
+	url: string, // Download URL of the version
+	source: string, // The WebDAV endpoint of the ressource
+	fileVersion: string|null, // The version id, null for the current version
+}
+
+export async function fetchVersions(fileInfo: any): Promise<Version[]> {
+	const path = `/versions/${getCurrentUser()?.uid}/versions/${fileInfo.id}`
+
+	try {
+		const response = await client.getDirectoryContents(path, {
+			data: davRequest,
+			details: true,
+		}) as ResponseDataDetailed<FileStat[]>
+
+		return response.data
+			// Filter out root
+			.filter(({ mime }) => mime !== '')
+			.map(version => formatVersion(version, fileInfo))
+	} catch (exception) {
+		logger.error('Could not fetch version', { exception })
+		throw exception
+	}
+}
+
+/**
+ * Restore the given version
+ */
+export async function restoreVersion(version: Version) {
+	try {
+		logger.debug('Restoring version', { url: version.url })
+		await client.moveFile(
+			`/versions/${getCurrentUser()?.uid}/versions/${version.fileId}/${version.fileVersion}`,
+			`/versions/${getCurrentUser()?.uid}/restore/target`,
+		)
+	} catch (exception) {
+		logger.error('Could not restore version', { exception })
+		throw exception
+	}
+}
+
+/**
+ * Format version
+ */
+function formatVersion(version: any, fileInfo: any): Version {
+	const mtime = moment(version.lastmod).unix() * 1000
+	let previewUrl = ''
+
+	if (mtime === fileInfo.mtime) { // Version is the current one
+		previewUrl = generateUrl('/core/preview?fileId={fileId}&c={fileEtag}&x=250&y=250&forceIcon=0&a=0', {
+			fileId: fileInfo.id,
+			fileEtag: fileInfo.etag,
+		})
+	} else {
+		previewUrl = generateUrl('/apps/files_versions/preview?file={file}&version={fileVersion}', {
+			file: joinPaths(fileInfo.path, fileInfo.name),
+			fileVersion: version.basename,
+		})
+	}
+
+	return {
+		fileId: fileInfo.id,
+		label: version.props['version-label'],
+		filename: version.filename,
+		basename: moment(mtime).format('LLL'),
+		mime: version.mime,
+		etag: `${version.props.getetag}`,
+		size: version.size,
+		type: version.type,
+		mtime,
+		permissions: 'R',
+		hasPreview: version.props['has-preview'] === 1,
+		previewUrl,
+		url: joinPaths('/remote.php/dav', version.filename),
+		source: generateRemoteUrl('dav') + encodeFilePath(version.filename),
+		fileVersion: version.basename,
+	}
+}
+
+export async function setVersionLabel(version: Version, newLabel: string) {
+	return await client.customRequest(
+		version.filename,
+		{
+			method: 'PROPPATCH',
+			data: `<?xml version="1.0"?>
+					<d:propertyupdate xmlns:d="DAV:"
+						xmlns:oc="http://owncloud.org/ns"
+						xmlns:nc="http://nextcloud.org/ns"
+						xmlns:ocs="http://open-collaboration-services.org/ns">
+					<d:set>
+						<d:prop>
+							<nc:version-label>${newLabel}</nc:version-label>
+						</d:prop>
+					</d:set>
+					</d:propertyupdate>`,
+		},
+	)
+}
+
+export async function deleteVersion(version: Version) {
+	await client.deleteFile(version.filename)
+}
-- 
cgit v1.2.3