Merge branch '7-data.updateTag-Request' into 'dev'

Resolve "Add data.updateTag request"

Closes #7

See merge request manuscript/surix/app-service!14

README.md

@@ -29,6 +29,7 @@ const requests = Surix.requests;
 - `addTagsToEntity`: Add tags to an existing entity.
 - `removeTagsFromEntity`: Removes tags from an entity.
 - `getTags`: Gets all the entity tags in the project.
+- `updateTag`: Updates the specified tag in an entity. <!--readme added-->
 - `project`: Fetches the current Surix project.
 - `getAppData`: Fetches app data stored by the app in the current project
 - `updateAppData`: Updates/adds app data to the current project
@@ -168,6 +169,22 @@ service.request(requests.data.removeTagsFromEntity, args).then((updatedEntity) =
 
 **Note**: Tags that are not in the entity will be ignored.
 
+### Updating a tag in an entity
+```javascript
+const args = {
+    tags: 'people',
+    update: {
+        name: 'persons'
+    }
+};
+
+surix.request(requests.data.updateTag, args).then(updatedTag => {
+    //Tag updated successfully
+}).catch(error) => {
+    //Error
+});
+```
+
 ### Get all tags in the project
 ```javascript
 service.request(requests.data.getTags).then((tags) => {

build/dist/src/requests.d.ts

@@ -7,6 +7,7 @@ export declare const requests: {
         addTagsToEntity: string;
         removeTagsFromEntity: string;
         getTags: string;
+        updateTag: string,
         getAppData: string;
         updateAppData: string;
     };

src/requests.ts

@@ -7,6 +7,7 @@ export const requests = {
         addTagsToEntity: 'data.addTagsToEntity',
         removeTagsFromEntity: 'data.removeTagsFromEntity',
         getTags: 'data.getTags',
+        updateTag: 'data.updateTag',
         getAppData: 'data.getAppData',
         updateAppData: 'data.updateAppData'
     },

tests/service.test.tsx

@@ -1,4 +1,5 @@
 import { Service, requests } from '..';
+import { request } from 'http';
 
 jest.spyOn(global.window.parent , 'postMessage');
 
@@ -66,5 +67,21 @@ describe('Requests', async () => {
 
             expect(window.parent.postMessage).toHaveBeenCalled();
         });
+        test('Update Tag', async() => {
+            const args = {
+                tag: 'current tag name',
+                upadate: {
+                    name: 'new tag name'
+                }
+            };
+            surix.request(requests.data.updateTag, args).then(updatedTag => {
+                //Tag updated successfully
+           }).catch((error) => {
+               //Error
+           }); 
+
+           expect(window.parent.postMessage).toHaveBeenCalled();
+        });
+
     });
 });