Merge pull request #52514 from nextcloud/feat/template-field-extraction-improvements

feat: only get template fields once selected

Author: elzody

apps/files/appinfo/routes.php

@@ -136,6 +136,11 @@
 			'url' => '/api/v1/templates',
 			'verb' => 'GET'
 		],
+		[
+			'name' => 'Template#listTemplateFields',
+			'url' => '/api/v1/templates/fields/{fileId}',
+			'verb' => 'GET'
+		],
 		[
 			'name' => 'Template#create',
 			'url' => '/api/v1/templates/create',

apps/files/lib/Controller/TemplateController.php

@@ -52,6 +52,24 @@ public function list(): DataResponse {
 		}, $this->templateManager->listTemplates()));
 	}
 
+	/**
+	 * List the fields for the template specified by the given file ID
+	 *
+	 * @param int $fileId File ID of the template
+	 * @return DataResponse<Http::STATUS_OK, array<string, FilesTemplateField>, array{}>
+	 *
+	 * 200: Fields returned
+	 */
+	#[NoAdminRequired]
+	public function listTemplateFields(int $fileId): DataResponse {
+		$fields = $this->templateManager->listTemplateFields($fileId);
+
+		return new DataResponse(
+			array_merge([], ...$fields),
+			Http::STATUS_OK
+		);
+	}
+
 	/**
 	 * Create a template
 	 *

apps/files/openapi.json

@@ -1233,6 +1233,80 @@
                 }
             }
         },
+        "/ocs/v2.php/apps/files/api/v1/templates/fields/{fileId}": {
+            "get": {
+                "operationId": "template-list-template-fields",
+                "summary": "List the fields for the template specified by the given file ID",
+                "tags": [
+                    "template"
+                ],
+                "security": [
+                    {
+                        "bearer_auth": []
+                    },
+                    {
+                        "basic_auth": []
+                    }
+                ],
+                "parameters": [
+                    {
+                        "name": "fileId",
+                        "in": "path",
+                        "description": "File ID of the template",
+                        "required": true,
+                        "schema": {
+                            "type": "integer",
+                            "format": "int64"
+                        }
+                    },
+                    {
+                        "name": "OCS-APIRequest",
+                        "in": "header",
+                        "description": "Required to be true for the API request to pass",
+                        "required": true,
+                        "schema": {
+                            "type": "boolean",
+                            "default": true
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Fields returned",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "required": [
+                                        "ocs"
+                                    ],
+                                    "properties": {
+                                        "ocs": {
+                                            "type": "object",
+                                            "required": [
+                                                "meta",
+                                                "data"
+                                            ],
+                                            "properties": {
+                                                "meta": {
+                                                    "$ref": "#/components/schemas/OCSMeta"
+                                                },
+                                                "data": {
+                                                    "type": "object",
+                                                    "additionalProperties": {
+                                                        "$ref": "#/components/schemas/TemplateField"
+                                                    }
+                                                }
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "/ocs/v2.php/apps/files/api/v1/templates/create": {
             "post": {
                 "operationId": "template-create",

apps/files/src/services/Templates.js

@@ -11,6 +11,11 @@ export const getTemplates = async function() {
 	return response.data.ocs.data
 }
 
+export const getTemplateFields = async function(fileId) {
+	const response = await axios.get(generateOcsUrl(`apps/files/api/v1/templates/fields/${fileId}`))
+	return response.data.ocs.data
+}
+
 /**
  * Create a new file from a specified template
  *

apps/files/src/views/TemplatePicker.vue

@@ -57,7 +57,7 @@ import { translate as t } from '@nextcloud/l10n'
 import { generateRemoteUrl } from '@nextcloud/router'
 import { normalize, extname, join } from 'path'
 import { defineComponent } from 'vue'
-import { createFromTemplate, getTemplates } from '../services/Templates.js'
+import { createFromTemplate, getTemplates, getTemplateFields } from '../services/Templates.js'
 
 import NcEmptyContent from '@nextcloud/vue/components/NcEmptyContent'
 import NcModal from '@nextcloud/vue/components/NcModal'
@@ -215,7 +215,7 @@ export default defineComponent({
 			}
 		},
 
-		async createFile(templateFields) {
+		async createFile(templateFields = []) {
 			const currentDirectory = new URL(window.location.href).searchParams.get('dir') || '/'
 
 			// If the file doesn't have an extension, add the default one
@@ -274,9 +274,12 @@ export default defineComponent({
 		},
 
 		async onSubmit() {
-			if (this.selectedTemplate?.fields?.length > 0) {
+			const fileId = this.selectedTemplate?.fileid
+			const fields = await getTemplateFields(fileId)
+
+			if (fields.length > 0) {
 				spawnDialog(TemplateFiller, {
-					fields: this.selectedTemplate.fields,
+					fields,
 					onSubmit: this.createFile,
 				})
 			} else {

dist/4052-4052.js

@@ -0,0 +1 @@
+4052-4052.js.license