Merge pull request #14 from alphamanuscript/update-versions

Update versions and fixes a few things

Author: grafitto

packages/client/README.md

@@ -16,32 +16,20 @@ Create Client instance:
 const client = new Client();
 ```
 
-Create Client for the staging server
-
-```javascript
-const client = new Client({ environment: 'staging' });
-```
+Create Client for the server
 
 Use custom base URL
 
 ```javascript
-const client = new Client({ baseUrl: 'https://mydomain.com/api' });
+const client = new Client({ 
+  environment: 'staging', // staging or production
+  baseUrl: 'https://mydomain.com/api', // custom server
+  keyId: 'key id provided by surix',
+  keySecret: 'key secret provided by surix'
+  });
 ```
 
-Authenticate
-
-```javascript
-await client.authenticate({ email: 'me@email.com', password: 'strong password' });
-// Continue using client
-
-// Or
-client.authenticate({
-  email: 'me@email.com',
-  password: 'strong password'
-}).then(authenticatedClient => {
-  // Continue using authenticatedClient
-})
-```
+Note: `keyId` and `keySecret` are provided in the surix dashboard, under account settings.
 
 Select project to work with:
 

packages/client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@surix/client",
-  "version": "0.6.2",
+  "version": "0.7.2",
   "description": "Surix API Client",
   "keywords": [
     "surix",
@@ -29,7 +29,7 @@
     "test": "jest src",
     "test:watch": "jest --watch src",
     "test:e2e": "jest test/e2e",
-    "test:all": "yarn test && yarn test:e2e",
+    "test:all": "yarn test",
     "clean": "rm -rf lib dist",
     "build": "yarn clean && yarn build:node && yarn build:umd",
     "build:node": "tsc",

packages/client/src/client/test/__snapshots__/client.test.ts.snap

@@ -4,6 +4,7 @@ exports[`Client new instance should create http client based on production Surix
 Array [
   Array [
     "https://api.surix.co/api",
+    "someid:somesecret",
   ],
 ]
 `;
@@ -12,6 +13,7 @@ exports[`Client new instance should override baseUrl if baseUrl option is provid
 Array [
   Array [
     "http://mydomain.com/api",
+    "someid:somesecret",
   ],
 ]
 `;
@@ -20,6 +22,7 @@ exports[`Client new instance when environment is not set to production should cr
 Array [
   Array [
     "https://surix-staging.herokuapp.com/api",
+    "someid:somesecret",
   ],
 ]
 `;

packages/client/src/client/test/client.test.ts

@@ -3,25 +3,30 @@ import * as projectApi from '../../project';
 import { Client } from '../client';
 
 describe('Client', () => {
+  const authKey = {
+    keyId: 'someid',
+    keySecret: 'somesecret'
+  }
+
   describe('new instance', () => {
     it('should create http client based on production Surix API url', () => {
       const spy = jest.spyOn(api, 'getApiClient');
-      new Client();
+      new Client({ ...authKey });
       expect(spy.mock.calls).toMatchSnapshot();
       spy.mockRestore();
     });
     describe('when environment is not set to production', () => {
       it('should create http client based on staging url', () => {
         const spy = jest.spyOn(api, 'getApiClient');
-        new Client({ environment: 'staging' });
+        new Client({ environment: 'staging', ...authKey });
         expect(spy.mock.calls).toMatchSnapshot();
         spy.mockRestore();
       });
     });
     it('should override baseUrl if baseUrl option is provided', () => {
       const spy = jest.spyOn(api, 'getApiClient');
       const baseUrl = 'http://mydomain.com/api';
-      new Client({ baseUrl });
+      new Client({ baseUrl, ...authKey });
       expect(spy.mock.calls).toMatchSnapshot();
       spy.mockRestore();
     });
@@ -32,7 +37,7 @@ describe('Client', () => {
       const apiClient = {};
       jest.spyOn(api, 'getApiClient').mockReturnValue(apiClient);
       jest.spyOn(projectApi, 'getProjectApi');
-      const client = new Client();
+      const client = new Client({ ...authKey });
       client.project('id');
       expect(projectApi.getProjectApi).toHaveBeenCalledWith('id', apiClient);
     });

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

@@ -41,7 +41,7 @@ describe('Project Entities', () => {
   describe('get', () => {
     let apiClient: AxiosInstance;
     async function callMockedGet (): Promise<dataHelpers.WrappedEntity> {
-      apiClient = api.getApiClient('http://baseurl');
+      apiClient = api.getApiClient('http://baseurl', 'somekey');
       jest.spyOn(apiClient, 'get').mockReturnValue(Promise.resolve({ data: apiEntities[0] }));
       jest.spyOn(dataHelpers, 'wrapEntity');
       const project = getProjectApi('project1', apiClient);
@@ -61,7 +61,7 @@ describe('Project Entities', () => {
   describe('query', () => {
     let apiClient: AxiosInstance;
     async function callMockedQuery (query?: Query): Promise<dataHelpers.WrappedEntity[]> {
-      apiClient = api.getApiClient('http://baseurl');
+      apiClient = api.getApiClient('http://baseurl', 'somekey');
       jest.spyOn(apiClient, 'post').mockReturnValue(Promise.resolve({ data: apiEntities }));
       jest.spyOn(dataHelpers, 'wrapEntityArray');
       const project = getProjectApi('project1', apiClient);

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

@@ -43,7 +43,7 @@ describe('Project Files', () => {
   describe('get', () => {
     let apiClient: AxiosInstance;
     function callMockedGet (): Promise<dataHelpers.WrappedFile> {
-      apiClient = api.getApiClient('http://baseurl');
+      apiClient = api.getApiClient('http://baseurl', 'somekey');
       jest.spyOn(apiClient, 'get').mockReturnValue(
         Promise.resolve({ data: apiFiles[0] })
       );
@@ -65,7 +65,7 @@ describe('Project Files', () => {
   describe('list', () => {
     let apiClient: AxiosInstance;
     function callMockedList (): Promise<dataHelpers.WrappedFile[]> {
-      apiClient = api.getApiClient('http://baseurl');
+      apiClient = api.getApiClient('http://baseurl', 'somekey');
       jest.spyOn(apiClient, 'get').mockReturnValue(
         Promise.resolve({ data: apiFiles })
       );

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

@@ -11,7 +11,7 @@ describe('Project tags', () => {
       { name: 'users' }
     ];
     function callMockedList(): Promise<any[]> {
-      apiClient = api.getApiClient('http://baseurl');
+      apiClient = api.getApiClient('http://baseurl', 'somekey');
       jest.spyOn(apiClient, 'get').mockReturnValue(
         Promise.resolve({ data: tags })
       );

packages/client/test/e2e/basic.test.ts

@@ -59,7 +59,6 @@ const codeFromRaw = raw.data.address
 - `wrappedEntity.get(key, defaultValue?)`: returns plain value of the specified field
 - `wrappedEntity.type(key, defaultType?)`: returns type of the specified field
 - `wrappedEntity.field(key, defaultType?)`: returns the raw field with the specified key
-- `wrappedEntity.label(key, defaultLabel?)`: return the label of the specified field
 - `wrappedEntity.data()`: returns the data of the entity as a plain key-value object (without field metadata)
 
 #### properties
@@ -69,4 +68,5 @@ You can access the top-level properties of the entity directly:
 - `wrappedEntity.createdAt`
 - `wrappedEntity.updatedAt`
 - `wrappedEntity.createdBy`
+- `wrappedEntity.updatedBy`
 - `wrappedEntity.rawEntity`: Returns the raw entity from the API

packages/client/test/index.html

@@ -1,6 +1,6 @@
 {
   "name": "@surix/data-helpers",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Utilities for making it easy to work with Surix data",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",