Merge pull request #19 from alphamanuscript/add-partial-update

Adds partial update of entities

Author: habbes

packages/client/README.md

@@ -70,6 +70,25 @@ The entity above would be converted to:
   tags: []
 }
 ```
+Dates are expanded as `text` for now and will correctly be expanded to `datetime` in future versions of `@surix/data-helpers`. Arrays are not supported for now.
+
+
+#### `project.entities.patch(entity: Entity)`
+
+Updates a entity partially. I.e adds onto the already existing entity identified by the `_id` field.
+
+```javascript
+const entity = {
+  _id: 'someid',
+  data: {
+    phone: '0712345678'
+  },
+  tags: ['tag']
+}
+
+const updatedEntity = await project.entities.patch(entity);
+```
+
  Dates created with the `Date()` function are expanded as `text`. and those created with `new Date()` are correctly expanded to `datetime`.
 
 #### `project.entities.put(entity: Entity)`

packages/client/src/project/entities.ts

@@ -13,6 +13,16 @@ export function getProjectEntities (projectId: string, apiClient: AxiosInstance)
       const entities = res.data;
       return wrapEntityArray(entities);
     },
+    async update(entity: Entity): Promise<WrappedEntity> {
+      const _entity = { ...entity };
+      const entityId = _entity._id;
+      delete _entity._id;
+      const expandedEntity = expandEntity(_entity);
+      const res = await apiClient.patch<ApiEntity>(
+        `/projects/${projectId}/entities/${entityId}`, expandedEntity);
+      const returnedEntity = res.data;
+      return wrapEntity(returnedEntity);
+    },
     async put(entity: Entity): Promise<WrappedEntity> {
       const _entity = { ...entity }; // Make a shallow copy
       const entityId = _entity._id;

packages/client/src/project/tests/entities.test.ts

@@ -89,7 +89,7 @@ describe('Project Entities', () => {
           name: 'someone 1'
         },
         tags: []
-      }
+      };
       let apiClient: AxiosInstance;
       async function callMockCreate (entity: any): Promise<dataHelpers.WrappedEntity> {
         apiClient = api.getApiClient('http://baseurl', 'somekey');
@@ -102,7 +102,7 @@ describe('Project Entities', () => {
       }
       it('should call POST /projects/:pid/entities endpoint with entity', async () => {
         const entity = userEntity;
-        const expectedEntity = dataHelpers.expandEntity(entity)
+        const expectedEntity = dataHelpers.expandEntity(entity);
         await callMockCreate(entity);
         expect(apiClient.post).toHaveBeenCalledWith('/projects/project1/entities', expectedEntity);
       });
@@ -113,32 +113,58 @@ describe('Project Entities', () => {
         expect(entity).toMatchSnapshot();
       });
     });
-    describe('put', () => {
+    describe('patch', () => {
       const userEntity = {
         data: {
           name: 'someone 1'
         },
         tags: []
-      }
-      let apiClient: AxiosInstance;
-      async function callMockPut (entity: any): Promise<dataHelpers.WrappedEntity> {
+      };
+      async function callMockUpdate (entity: any): Promise<dataHelpers.WrappedEntity> {
         apiClient = api.getApiClient('http://baseurl', 'somekey');
-        jest.spyOn(apiClient, 'put').mockReturnValue(Promise.resolve({ data: 
+        jest.spyOn(apiClient, 'patch').mockReturnValue(Promise.resolve({ data: 
           { entity } }));
         jest.spyOn(dataHelpers, 'wrapEntity');
         const project = getProjectApi('project1', apiClient);
-        const ent = await project.entities.put(entity);
+        const ent = await project.entities.update(entity);
         return ent;
       }
-      it('should call PUT /projects/:pid/entities/:eid endpoint with entity', async () => {
+      it('should call PATCH /projects/:pid/entities/:eid endpoint with entity', async () => {
         const entity = { ...userEntity };
-        entity['_id'] = 'entity1';
-        const expectedEntity = dataHelpers.expandEntity(entity);
-        const frozen = Object.freeze(entity);
-        await callMockPut(frozen);
-        expect(apiClient.put).toHaveBeenCalledWith(
-          '/projects/project1/entities/entity1', expectedEntity);
+          entity['_id'] = 'entity1';
+          const expectedEntity = dataHelpers.expandEntity(entity);
+          const frozen = Object.freeze(entity);
+          await callMockUpdate(frozen);
+          expect(apiClient.patch).toHaveBeenCalledWith(
+            '/projects/project1/entities/entity1', expectedEntity);
       });
     });
+      describe('put', () => {
+        const userEntity = {
+          data: {
+            name: 'someone 1'
+          },
+          tags: []
+        };
+        let apiClient: AxiosInstance;
+        async function callMockPut (entity: any): Promise<dataHelpers.WrappedEntity> {
+          apiClient = api.getApiClient('http://baseurl', 'somekey');
+          jest.spyOn(apiClient, 'put').mockReturnValue(Promise.resolve({ data: 
+            { entity } }));
+          jest.spyOn(dataHelpers, 'wrapEntity');
+          const project = getProjectApi('project1', apiClient);
+          const ent = await project.entities.put(entity);
+          return ent;
+        }
+        it('should call PUT /projects/:pid/entities/:eid endpoint with entity', async () => {
+          const entity = { ...userEntity };
+          entity['_id'] = 'entity1';
+          const expectedEntity = dataHelpers.expandEntity(entity);
+          const frozen = Object.freeze(entity);
+          await callMockPut(frozen);
+          expect(apiClient.put).toHaveBeenCalledWith(
+            '/projects/project1/entities/entity1', expectedEntity);
+        });
+    });
   }); 
 });

packages/client/src/types.ts

@@ -10,6 +10,7 @@ export interface ProjectEntities {
   get(id: string): Promise<WrappedEntity>;
   query(query?: Query): Promise<WrappedEntity[]>;
   create(entity: Entity): Promise<WrappedEntity>;
+  update(entity: Entity): Promise<WrappedEntity>;
   put(entity: Entity): Promise<WrappedEntity>;
 }
 

packages/data-helpers/README.md

@@ -37,7 +37,7 @@ const {
 } = require('@surix/data-helpers')
 ```
 
-### `expnadEntity`
+### `expandEntity`
 
 Converts a user friendly version of an entity to the raw version of the entity.  
 *Note: For now, dates are interpreted `text` type but will be updated to `datatime` in future*