Merge pull request #18 from alphamanuscript/add-full-update

Add full update on entities using put

Author: habbes

packages/client/README.md

@@ -70,7 +70,23 @@ 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.
+ 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)`
+
+Updates an entity by completely replacing its data.
+
+```javascript
+const entity = {
+  _id: 'someid', // The id of the entity to be updated
+  data: {
+    name: 'My name'
+  }
+}
+
+const changedEntity = await project.entities.put(entity);
+
+```
 #### `project.entities.get(id: string)`
 
 Fetches an entity by ID.

packages/client/src/api/api.ts

@@ -3,7 +3,7 @@ import axios, { AxiosInstance } from 'axios';
 export function getApiClient (baseUrl: string, apiKey: string): AxiosInstance {
   const axiosInstance = axios.create({
     baseURL: baseUrl
-  })
-  axiosInstance.defaults.headers['Authorization'] = `apikey ${apiKey}`
-  return axiosInstance
+  });
+  axiosInstance.defaults.headers['Authorization'] = `apikey ${apiKey}`;
+  return axiosInstance;
 }

packages/client/src/client/client.ts

@@ -23,7 +23,7 @@ export class Client {
     }, opts);
     let baseUrl = _opts.environment === 'production' ? PRODUCTION_URL : STAGING_URL;
     baseUrl = _opts.baseUrl || baseUrl;
-    const apiKey = `${_opts.keyId}:${_opts.keySecret}` 
+    const apiKey = `${_opts.keyId}:${_opts.keySecret}`;
     this._apiClient = getApiClient(baseUrl, apiKey);
   }
 

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 put(entity: Entity): Promise<WrappedEntity> {
+      const _entity = { ...entity }; // Make a shallow copy
+      const entityId = _entity._id;
+      delete _entity._id;
+      const expandedEntity = expandEntity(_entity);
+      const res = await apiClient.put<ApiEntity>(
+        `/projects/${projectId}/entities/${entityId}`, expandedEntity);
+      const returnedEntity = res.data;
+      return wrapEntity(returnedEntity);
+    },
     async create(entity: Entity): Promise<WrappedEntity> {
       const expandedEntity = expandEntity(entity);
       const res = await apiClient.post<ApiEntity>(

packages/client/src/project/tests/__snapshots__/files.test.ts.snap

@@ -113,5 +113,32 @@ describe('Project Entities', () => {
         expect(entity).toMatchSnapshot();
       });
     });
+    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/project/tests/__snapshots__/tags.test.ts.snap

@@ -9,7 +9,8 @@ export interface Project {
 export interface ProjectEntities {
   get(id: string): Promise<WrappedEntity>;
   query(query?: Query): Promise<WrappedEntity[]>;
-  create(entity: any): Promise<WrappedEntity>;
+  create(entity: Entity): Promise<WrappedEntity>;
+  put(entity: Entity): Promise<WrappedEntity>;
 }
 
 export interface ProjectFiles {
@@ -73,4 +74,5 @@ export interface DataField {
 export interface Entity {
   data: DataField;
   tags?: string[];
+  _id?: string;
 }