[EDT-1549] set/resetPlaceholder methods

packages/sdk/src/controllers/VariableController.ts

@@ -325,6 +325,33 @@ export class VariableController {
         return res.setVariableLabel(id, label).then((result) => getEditorResponseData<null>(result));
     };
 
+    /**
+     * Internal private method to set/reset a placeholder for a variable
+     */
+    private setPlaceholderInternal = async (id: string, placeholder: string | null) => {
+        const res = await this.#editorAPI;
+        return res.setVariablePlaceholder(id, placeholder).then((result) => getEditorResponseData<null>(result));
+    };
+
+    /**
+     * This method sets a new placeholder for a variable
+     * @param id id of the variable
+     * @param placeholder placeholder of the variable
+     * @returns
+     */
+    setPlaceholder = async (id: string, placeholder: string) => {
+        return this.setPlaceholderInternal(id, placeholder);
+    };
+
+    /**
+     * This method resets a placeholder for a variable
+     * @param id id of the variable
+     * @returns
+     */
+    resetPlaceholder = async (id: string) => {
+        return this.setPlaceholderInternal(id, null);
+    };
+
     /**
      * This method sets a new type for a variable
      * @param id id of the variable

packages/sdk/src/tests/controllers/VariableController.test.ts

@@ -62,6 +62,7 @@ describe('VariableController', () => {
         addVariable: async () => getEditorResponseData(castToEditorResponse(null)),
         removeVariables: async () => getEditorResponseData(castToEditorResponse(null)),
         setVariableLabel: async () => getEditorResponseData(castToEditorResponse(null)),
+        setVariablePlaceholder: async () => getEditorResponseData(castToEditorResponse(null)),
         setVariableType: async () => getEditorResponseData(castToEditorResponse(null)),
         setListVariableItems: async () => getEditorResponseData(castToEditorResponse(null)),
         setVariableValue: async () => getEditorResponseData(castToEditorResponse(null)),
@@ -89,6 +90,7 @@ describe('VariableController', () => {
         jest.spyOn(mockEditorApi, 'addVariable');
         jest.spyOn(mockEditorApi, 'removeVariables');
         jest.spyOn(mockEditorApi, 'setVariableLabel');
+        jest.spyOn(mockEditorApi, 'setVariablePlaceholder');
         jest.spyOn(mockEditorApi, 'setVariableType');
         jest.spyOn(mockEditorApi, 'setListVariableItems');
         jest.spyOn(mockEditorApi, 'setVariableValue');
@@ -155,6 +157,18 @@ describe('VariableController', () => {
         expect(mockEditorApi.setVariableLabel).toHaveBeenCalledWith('3', 'newLabel');
     });
 
+    it('set variable placeholder', async () => {
+        await mockedVariableController.setPlaceholder('3', 'newPlaceholder');
+        expect(mockEditorApi.setVariablePlaceholder).toHaveBeenCalledTimes(1);
+        expect(mockEditorApi.setVariablePlaceholder).toHaveBeenCalledWith('3', 'newPlaceholder');
+    });
+
+    it('reset variable placeholder', async () => {
+        await mockedVariableController.resetPlaceholder('3');
+        expect(mockEditorApi.setVariablePlaceholder).toHaveBeenCalledTimes(1);
+        expect(mockEditorApi.setVariablePlaceholder).toHaveBeenCalledWith('3', null);
+    });
+
     it('set variable type', async () => {
         await mockedVariableController.setType('3', VariableType.group);
         expect(mockEditorApi.setVariableType).toHaveBeenCalledTimes(1);

packages/sdk/src/types/VariableTypes.ts

@@ -43,6 +43,7 @@ export interface Variable {
     isReadonly: boolean;
     isRequired: boolean;
     occurrences: number;
+    placeholder?: string | null;
 }
 
 export interface ImageVariable extends Variable {