N21-1587 generate api and adjust tests (#2968)

* generate api * add isProtected parameter * adjust tests --------- Co-authored-by: Malte Berg <[email protected]>
hpi-schul-cloud · Dec 22, 2023 · e88fa08 · e88fa08
1 parent acd27f4
commit e88fa08
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 0 deletions.
diff --git a/src/components/external-tools/configuration/external-tool-validation.composable.unit.ts b/src/components/external-tools/configuration/external-tool-validation.composable.unit.ts
@@ -16,6 +16,7 @@ describe("useExternalToolValidation", () => {
 			name: "ToolParameter",
 			displayName: "Tool Parameter",
 			isOptional: true,
+			isProtected: false,
 			type: ToolParameterType.String,
 			regexComment: "comment",
 			location: ToolParameterLocation.PATH,

diff --git a/src/serverApi/v3/api.ts b/src/serverApi/v3/api.ts
@@ -1308,6 +1308,12 @@ export interface CustomParameterPostParams {
      * @memberof CustomParameterPostParams
      */
     isOptional: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CustomParameterPostParams
+     */
+    isProtected: boolean;
 }
 /**
  * 
@@ -1375,6 +1381,12 @@ export interface CustomParameterResponse {
      * @memberof CustomParameterResponse
      */
     isOptional: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CustomParameterResponse
+     */
+    isProtected: boolean;
 }
 
 /**

diff --git a/src/store/context-external-tools.unit.ts b/src/store/context-external-tools.unit.ts
@@ -462,6 +462,8 @@ describe("ContextExternalToolsModule", () => {
 										toolConfigurationTemplate.parameters[0].description,
 									isOptional:
 										toolConfigurationTemplate.parameters[0].isOptional,
+									isProtected:
+										toolConfigurationTemplate.parameters[0].isProtected,
 									regex: toolConfigurationTemplate.parameters[0].regex,
 									regexComment:
 										toolConfigurationTemplate.parameters[0].regexComment,
@@ -569,6 +571,8 @@ describe("ContextExternalToolsModule", () => {
 										toolConfigurationTemplate.parameters[0].description,
 									isOptional:
 										toolConfigurationTemplate.parameters[0].isOptional,
+									isProtected:
+										toolConfigurationTemplate.parameters[0].isProtected,
 									regex: toolConfigurationTemplate.parameters[0].regex,
 									regexComment:
 										toolConfigurationTemplate.parameters[0].regexComment,

diff --git a/src/store/external-tool/mapper/external-tool.mapper.ts b/src/store/external-tool/mapper/external-tool.mapper.ts
@@ -26,6 +26,7 @@ export class ExternalToolMapper {
 			description: response.description,
 			displayName: response.displayName,
 			isOptional: response.isOptional,
+			isProtected: response.isProtected,
 			regex: response.regex,
 			regexComment: response.regexComment,
 		};

diff --git a/src/store/external-tool/tool-parameter.ts b/src/store/external-tool/tool-parameter.ts
@@ -22,4 +22,6 @@ export interface ToolParameter {
 	type: ToolParameterType;
 
 	isOptional: boolean;
+
+	isProtected: boolean;
 }
diff --git a/src/store/school-external-tools.unit.ts b/src/store/school-external-tools.unit.ts
@@ -342,6 +342,8 @@ describe("SchoolExternalToolsModule", () => {
 										toolConfigurationTemplate.parameters[0].description,
 									isOptional:
 										toolConfigurationTemplate.parameters[0].isOptional,
+									isProtected:
+										toolConfigurationTemplate.parameters[0].isProtected,
 									regex: toolConfigurationTemplate.parameters[0].regex,
 									regexComment:
 										toolConfigurationTemplate.parameters[0].regexComment,
@@ -444,6 +446,8 @@ describe("SchoolExternalToolsModule", () => {
 										toolConfigurationTemplate.parameters[0].description,
 									isOptional:
 										toolConfigurationTemplate.parameters[0].isOptional,
+									isProtected:
+										toolConfigurationTemplate.parameters[0].isProtected,
 									regex: toolConfigurationTemplate.parameters[0].regex,
 									regexComment:
 										toolConfigurationTemplate.parameters[0].regexComment,

diff --git a/tests/test-utils/factory/customParameterResponseFactory.ts b/tests/test-utils/factory/customParameterResponseFactory.ts
@@ -13,5 +13,6 @@ export const customParameterResponseFactory =
 		location: CustomParameterResponseLocationEnum.Body,
 		name: `CustomParameter${sequence}`,
 		isOptional: false,
+		isProtected: false,
 		displayName: `Custom Parameter ${sequence}`,
 	}));
diff --git a/tests/test-utils/factory/toolParameterFactory.ts b/tests/test-utils/factory/toolParameterFactory.ts
@@ -14,5 +14,6 @@ export const toolParameterFactory = Factory.define<ToolParameter>(
 		displayName: `Parameter ${sequence}`,
 		description: "test description",
 		isOptional: true,
+		isProtected: false,
 	})
 );