Merge pull request #53 from elasticio/migrate-platform-api-clients

Migrate platform api clients

Author: olegosh

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.1.7 (August 30, 2021)
+* Added `PlatformApiRestClient` and `PlatformApiLogicClient` classes from `IPaaS-core-component`
+
 ## 1.1.6 (July 29, 2021)
 * Now `getAttachment` from `AttachmentProcessor` may retrieve items from `Maester`
 

README.md

@@ -9,6 +9,9 @@
     - [ApiKeyRestClient](#ApiKeyRestClient)
     - [CookieRestClient](#CookieRestClient)
     - [OAuth2AuthorizationCodeRestClient](#OAuth2AuthorizationCodeRestClient)
+  - [Platform API Clients](#PlatformAPI-Clients)
+    - [PlatformApiRestClient](#PlatformApiRestClient)
+    - [PlatformApiLogicClient](#PlatformApiLogicClient)
   - [JSON Schema Converter](#JSON-Schema-Converter)
   - [JSON Transformation](#JSON-Transformation)
   - [Attachment Processor](#Attachment-Processor)
@@ -29,7 +32,7 @@ npm install @elastic.io/component-commons-library
 ## REST Clients
 A number of REST Client classes are available to use and extend to create Clients for a given API.
 
-Each of the REST Clients extends from the `NoAuthRestClient`, overriding the relevant methods.
+Each of the REST Clients extends from the `NoAuthRestClient`, overriding the relevant methods. Exception is PlatformApiRestClient and PlatformApiLogicClient.
 
 ### NoAuthRestClient
 [NoAuthRestClient](https://github.com/elasticio/component-commons-library/blob/master/lib/authentication/NoAuthRestClient.ts) class to make rest requests no no auth APIs by provided options.
@@ -135,6 +138,52 @@ Handles both V1 and V2 of the NTLM Protocol.
 const Client = new NtlmRestClient(emitter, cfg);
 ```
 
+## Platform API Clients
+A number of Platform API Client classes are available to use and extend them to create Clients for Platform API.
+
+### PlatformApiRestClient
+[PlatformApiRestClient](https://github.com/elasticio/component-commons-library/blob/master/lib/authentication/PlatformApiRestClient.ts)
+class extends [BasicAuthRestClient](#BasicAuthRestClient) class.
+The method inside this class checks for the status code 200, if not, then throws an error. And also checks that the response came with the correct data in the JSON format and the other expected response headers.
+
+#### constructor(emitter, cfg)
+- emitter - EIO emitting context.
+- cfg - configuration of EIO component object.
+
+```
+const Client = new PlatformApiRestClient(emitter, cfg);
+```
+
+### PlatformApiLogicClient
+[PlatformApiLogicClient](https://github.com/elasticio/component-commons-library/blob/master/lib/authentication/PlatformApiLogicClient.ts)
+class extends [PlatformApiRestClient](#PlatformApiRestClient) class.
+Contains useful methods to manipulate flow's state to set it either to active running or to inactive stopped, searching flows, workspaces, credentials and more.
+
+#### constructor(emitter, cfg)
+- emitter - EIO emitting context.
+- cfg - configuration of EIO component object.
+
+```
+const Client = new PlatformApiLogicClient(emitter, cfg);
+```
+
+#### List of methods
+- fetchAllFlowsForWorkspace(options) - Fetch all flows for a given workspace
+- fetchAllCredentialsForWorkspace(options) - Fetch all credentials for a given workspace
+- fetchComponentsAccessibleFromContract(options) - Fetch All Components Accessible From a Given Workspace
+- splitParallelization(maxParallelization, splitFactor) - Helping method to calculate right number of parallel calls
+- fetchFlowList(options) - Fetches a list of flows
+- fetchWorkspaceList(options) - Fetch a list of all workspaces across all contracts for a user
+- fetchWorkspaceId(workspaceUniqueCriteria) - Given a set of unique criteria, find the workspace that matches
+- removeNonWritableProperties(flow, includeDataSamples) - Given a flow, remove the properties of the flow that are regularly changed by the system such as last executed time
+- fetchFlowId(flowUniqueCriteria) - Fetch flow by it's unique criteria
+- fetchFlowById(id) - Fetch flow by it's id
+- fetchFlowByNameAndWorkspaceId(flowName, workspaceId) - Fetch flow by flow name and workspace id
+- changeFlowState(options) - Given a flow, change the flow to a given state (running, stopped, etc)
+- startFlow(flowId, options) - sets the flow to active running state
+- stopFlow(flowId, options) - sets the flow to inactive stopped state
+- hydrateFlow(options) - Hydrates the flow using removeNonWritableProperties method, but additionally enriches the flow with all data samples, credential names, command and component Id fields.
+
 ## JSON Schema Converter
 Contains tools for JSON metadata generation