feat(package): upgrade logger and add detailed readme

EME-5329

Co-authored-by: Gabor Nemeth <gabor.nemeth@emarsys.com>

README.md

@@ -1,24 +1,45 @@
-# Escher Suite API client for JavaScript
-[![Dependency Status](https://david-dm.org/emartech/escher-suiteapi-js.svg)](https://david-dm.org/emartech/escher-suiteapi-js)
-[![devDependency Status](https://david-dm.org/emartech/escher-suiteapi-js/dev-status.svg)](https://david-dm.org/emartech/escher-suiteapi-js#info=devDependencies)
+# @emartech/escher-request
 
 ## Usage
 
+### Javascript
+
 ```javascript
-const SuiteRequest = require('escher-suiteapi-js');
+const { EscherRequest, EscherRequestOption } = require('@emartech/escher-request');
+
+const options = new EscherRequestOption('example.host.com', {
+  credentialScope: 'eu/service/ems_request'
+});
+const request = EscherRequest.create('escher.key', 'escher.secret', options);
+
+const heroId = 1;
+const hero = await request.get(`/heroes/${heroId}`);
+console.log(hero);
+
+const heroes = await request.post('/heroes', {
+  name: 'Captain America',
+  sex: 'male'
+});
+console.log(heroes);
+```
+
+### Typescript
+
+```typescript
+const { EscherRequest, EscherRequestOption } = require('@emartech/escher-request');
 
-const options = new SuiteRequest.Options('example.host.com', {
+const options = new EscherRequestOption('example.host.com', {
   credentialScope: 'eu/service/ems_request'
 });
-const suiteRequest = SuiteRequest.create('escher.key', 'escher.secret', options);
+const request = EscherRequest.create('escher.key', 'escher.secret', options);
 
 const heroId = 1;
-let response = await suiteRequest.get(`/heroes/${heroId}`);
-console.log(response);
+const hero = await request.get<{ name: string; }>(`/heroes/${heroId}`);
+console.log(hero);
 
-let response = await suiteRequest.post('/heroes', {
+const heroes = await request.post<{ name: string; }[]>('/heroes', {
   name: 'Captain America',
   sex: 'male'
 });
-console.log(response);
+console.log(heroes);
 ```

package.json

@@ -28,7 +28,7 @@
     "node": ">=14.0.0"
   },
   "dependencies": {
-    "@emartech/json-logger": "5.0.2",
+    "@emartech/json-logger": "6.0.0",
     "axios": "0.27.2",
     "escher-auth": "3.2.4"
   },

src/request.ts

@@ -7,7 +7,7 @@ import { RequestWrapper, ExtendedRequestOption, TransformedResponse } from './wr
 export { TransformedResponse } from './wrapper';
 import { EscherRequestError } from './requestError';
 export { EscherRequestError } from './requestError';
-import createLogger from '@emartech/json-logger';
+import { createLogger } from '@emartech/json-logger';
 const logger = createLogger('suiterequest');
 
 export class EscherRequest {

src/wrapper.ts

@@ -4,7 +4,7 @@ import { AxiosError, AxiosRequestConfig, AxiosResponse, AxiosResponseHeaders, Ca
 import { Agent as HttpAgent } from 'http';
 import { Agent as HttpsAgent } from 'https';
 import axios from 'axios';
-import createLogger from '@emartech/json-logger';
+import { createLogger } from '@emartech/json-logger';
 const logger = createLogger('suiterequest');
 const debugLogger = createLogger('suiterequest-debug');