chore(refactor): split open api functions

Two api endpoints deserve two different functions
in particular as they also expect different params.

This also allows narrowing down the types a little more.

Signed-off-by: Max <max@nextcloud.com>

Author: max-nextcloud

src/apis/connect.ts

@@ -10,10 +10,15 @@ import axios from '@nextcloud/axios'
 import { generateUrl } from '@nextcloud/router'
 
 export interface OpenParams {
-	fileId?: number
+	fileId: number
+	filePath?: string // not send to the api but included in the connection
+	baseVersionEtag?: string
+}
+
+export interface OpenShareParams {
+	token: string
+	filePath?: string
 	baseVersionEtag?: string
-	filePath: string
-	token?: string
 	guestName?: string
 }
 
@@ -27,16 +32,31 @@ export interface OpenData {
 	hasOwner: boolean
 }
 
+/**
+ * Open editing connection to a file when logged in
+ *
+ * @param params Parameters identifying the document
+ */
+export async function openFile(params: OpenParams): Promise<{ connection: Connection, data: OpenData }> {
+	const url = generateUrl(`/apps/text/session/${params.fileId}/create`)
+	const response = await axios.put(url, params)
+	const { document, session } = response.data
+	const connection = {
+		documentId: document.id,
+		sessionId: session.id,
+		sessionToken: session.token,
+		baseVersionEtag: document.baseVersionEtag,
+	}
+	return { connection, data: response.data }
+}
+
 /**
  * Open editing connection to the document
  *
  * @param params Parameters identifying the document
  */
-export async function open(params: OpenParams): Promise<{ connection: Connection, data: OpenData }> {
-	const _baseUrl = params.token
-		? generateUrl('/apps/text/public')
-		: generateUrl('/apps/text')
-	const url = `${_baseUrl}/session/${params.fileId}/create`
+export async function openShare(params: OpenShareParams): Promise<{ connection: Connection, data: OpenData }> {
+	const url = generateUrl('/apps/text/public/session/123/create')
 	const response = await axios.put(url, params)
 	const { document, session } = response.data
 	const connection = {

src/composables/useConnection.ts

@@ -8,14 +8,14 @@ import type { OpenData } from '../apis/connect.ts'
 import type { Document, Session } from '../services/SyncService.ts'
 
 import { inject, provide, shallowRef } from 'vue'
-import { open } from '../apis/connect.ts'
+import * as api from '../apis/connect.ts'
 
 export interface Connection {
 	documentId: number
 	sessionId: number
 	sessionToken: string
 	baseVersionEtag: string
-	filePath: string
+	filePath?: string
 	shareToken?: string
 }
 
@@ -65,13 +65,8 @@ export function provideConnection(
 		const guestName = localStorage.getItem('nick') ?? ''
 		const { connection: opened, data }
 			= openInitialSession(props, baseVersionEtag)
-				|| (await open({
-					fileId: props.fileId,
-					guestName,
-					token: props.shareToken,
-					filePath: props.relativePath,
-					baseVersionEtag,
-				}))
+				|| await openShare(props, baseVersionEtag, guestName)
+				|| await openFile(props, baseVersionEtag)
 		await setBaseVersionEtag(data.document.baseVersionEtag)
 		connection.value = opened
 		openData.value = data
@@ -134,3 +129,52 @@ function openInitialSession(
 		return { connection, data: props.initialSession }
 	}
 }
+
+/**
+ * Get the connection and additional data from the initial session if available.
+ *
+ * @param props Props of the editor component
+ * @param props.relativePath Relative path to the file.
+ * @param props.shareToken Share token of the file.
+ * @param baseVersionEtag Etag from the last editing session.
+ * @param guestName to be shown to other participants.
+ */
+async function openShare(
+	props: {
+		relativePath: string
+		shareToken?: string
+	},
+	baseVersionEtag: string | undefined,
+	guestName: string | undefined,
+) {
+	if (props.shareToken) {
+		return api.openShare({
+			guestName,
+			token: props.shareToken,
+			filePath: props.relativePath,
+			baseVersionEtag,
+		})
+	}
+}
+
+/**
+ * Get the connection and additional data from the initial session if available.
+ *
+ * @param props Props of the editor component
+ * @param props.fileId id of the file
+ * @param props.relativePath Relative path to the file.
+ * @param baseVersionEtag Etag from the last editing session.
+ */
+async function openFile(
+	props: {
+		fileId: number
+		relativePath: string
+	},
+	baseVersionEtag: string | undefined,
+) {
+	return api.openFile({
+		fileId: props.fileId,
+		filePath: props.relativePath,
+		baseVersionEtag,
+	})
+}

src/tests/services/SyncService.spec.ts

@@ -54,7 +54,7 @@ describe('Sync service', () => {
 			setBaseVersionEtag,
 		)
 		vi.mock('../../apis/connect')
-		vi.mocked(connect.open).mockResolvedValue(openResult)
+		vi.mocked(connect.openFile).mockResolvedValue(openResult)
 		const openHandler = vi.fn()
 		const service = new SyncService({ connection, openConnection })
 		service.bus.on('opened', openHandler)