@onlineapps/conn-orch-orchestrator 1.0.0

package/API.md

@@ -0,0 +1,195 @@
+## Modules
+
+<dl>
+<dt><a href="#module_@onlineapps/conn-orch-orchestrator">@onlineapps/conn-orch-orchestrator</a></dt>
+<dd><p>Workflow orchestration connector that handles message routing and workflow execution.
+Coordinates all other connectors to process workflow messages.</p>
+</dd>
+</dl>
+
+## Classes
+
+<dl>
+<dt><a href="#WorkflowOrchestrator">WorkflowOrchestrator</a></dt>
+<dd></dd>
+<dt><a href="#WorkflowOrchestrator">WorkflowOrchestrator</a></dt>
+<dd></dd>
+</dl>
+
+## Functions
+
+<dl>
+<dt><a href="#processWorkflowMessage">processWorkflowMessage(message, serviceName)</a> ⇒ <code>Promise.&lt;Object&gt;</code></dt>
+<dd><p>Process a workflow message</p>
+</dd>
+<dt><a href="#generateCookbook">generateCookbook(openApiSpec)</a> ⇒ <code>Object</code></dt>
+<dd><p>Generate cookbook from OpenAPI spec (utility method)</p>
+</dd>
+<dt><a href="#transformResponse">transformResponse(response, mapping)</a> ⇒ <code>Object</code></dt>
+<dd><p>Transform API response using cookbook mapping</p>
+</dd>
+</dl>
+
+<a name="module_@onlineapps/conn-orch-orchestrator"></a>
+
+## @onlineapps/conn-orch-orchestrator
+Workflow orchestration connector that handles message routing and workflow execution.
+Coordinates all other connectors to process workflow messages.
+
+**See**: [GitHub Repository](https://github.com/onlineapps/oa-drive/tree/main/shared/connector/conn-orch-orchestrator)  
+**Since**: 1.0.0  
+**Author**: OA Drive Team  
+**License**: MIT  
+<a name="module_@onlineapps/conn-orch-orchestrator..create"></a>
+
+### @onlineapps/conn-orch-orchestrator~create(config) ⇒ [<code>WorkflowOrchestrator</code>](#WorkflowOrchestrator)
+Create orchestrator instance
+
+**Kind**: inner method of [<code>@onlineapps/conn-orch-orchestrator</code>](#module_@onlineapps/conn-orch-orchestrator)  
+**Returns**: [<code>WorkflowOrchestrator</code>](#WorkflowOrchestrator) - New orchestrator instance  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| config | <code>Object</code> | Configuration options |
+| config.mqClient | <code>Object</code> | MQ client instance |
+| config.registryClient | <code>Object</code> | Registry client instance |
+| config.apiMapper | <code>Object</code> | API mapper instance |
+| config.cookbook | <code>Object</code> | Cookbook connector instance |
+| [config.logger] | <code>Object</code> | Logger instance |
+
+**Example**  
+```js
+const orchestrator = create({
+  mqClient: new MQClient(),
+  registryClient: new RegistryClient(),
+  apiMapper: new ApiMapper(),
+  cookbook: new CookbookConnector()
+});
+```
+<a name="WorkflowOrchestrator"></a>
+
+## WorkflowOrchestrator
+**Kind**: global class  
+
+* [WorkflowOrchestrator](#WorkflowOrchestrator)
+    * [new WorkflowOrchestrator()](#new_WorkflowOrchestrator_new)
+    * [new WorkflowOrchestrator(config)](#new_WorkflowOrchestrator_new)
+
+<a name="new_WorkflowOrchestrator_new"></a>
+
+### new WorkflowOrchestrator()
+Main orchestration class that coordinates all workflow execution.
+Handles message routing, step execution, and workflow state management.
+
+This is the core logic moved from service-wrapper's WorkflowProcessor to make
+service-wrapper a true thin orchestration layer.
+
+<a name="new_WorkflowOrchestrator_new"></a>
+
+### new WorkflowOrchestrator(config)
+Create a new WorkflowOrchestrator instance
+
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| config | <code>Object</code> |  | Configuration object |
+| config.mqClient | <code>Object</code> |  | MQ client for message operations |
+| config.registryClient | <code>Object</code> |  | Registry client for service discovery |
+| config.apiMapper | <code>Object</code> |  | API mapper for cookbook to HTTP mapping |
+| config.cookbook | <code>Object</code> |  | Cookbook connector for validation and execution |
+| [config.cache] | <code>Object</code> |  | Cache connector for caching |
+| [config.errorHandler] | <code>Object</code> |  | Error handler connector |
+| [config.logger] | <code>Object</code> |  | Logger instance |
+| [config.defaultTimeout] | <code>number</code> | <code>30000</code> | Default timeout for operations |
+
+<a name="WorkflowOrchestrator"></a>
+
+## WorkflowOrchestrator
+**Kind**: global class  
+
+* [WorkflowOrchestrator](#WorkflowOrchestrator)
+    * [new WorkflowOrchestrator()](#new_WorkflowOrchestrator_new)
+    * [new WorkflowOrchestrator(config)](#new_WorkflowOrchestrator_new)
+
+<a name="new_WorkflowOrchestrator_new"></a>
+
+### new WorkflowOrchestrator()
+Main orchestration class that coordinates all workflow execution.
+Handles message routing, step execution, and workflow state management.
+
+This is the core logic moved from service-wrapper's WorkflowProcessor to make
+service-wrapper a true thin orchestration layer.
+
+<a name="new_WorkflowOrchestrator_new"></a>
+
+### new WorkflowOrchestrator(config)
+Create a new WorkflowOrchestrator instance
+
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| config | <code>Object</code> |  | Configuration object |
+| config.mqClient | <code>Object</code> |  | MQ client for message operations |
+| config.registryClient | <code>Object</code> |  | Registry client for service discovery |
+| config.apiMapper | <code>Object</code> |  | API mapper for cookbook to HTTP mapping |
+| config.cookbook | <code>Object</code> |  | Cookbook connector for validation and execution |
+| [config.cache] | <code>Object</code> |  | Cache connector for caching |
+| [config.errorHandler] | <code>Object</code> |  | Error handler connector |
+| [config.logger] | <code>Object</code> |  | Logger instance |
+| [config.defaultTimeout] | <code>number</code> | <code>30000</code> | Default timeout for operations |
+
+<a name="processWorkflowMessage"></a>
+
+## processWorkflowMessage(message, serviceName) ⇒ <code>Promise.&lt;Object&gt;</code>
+Process a workflow message
+
+**Kind**: global function  
+**Returns**: <code>Promise.&lt;Object&gt;</code> - Processing result  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| message | <code>Object</code> | Workflow message from queue |
+| message.workflow_id | <code>string</code> | Workflow ID |
+| message.cookbook | <code>Object</code> | Cookbook definition |
+| message.current_step | <code>string</code> | Current step ID |
+| message.context | <code>Object</code> | Workflow context |
+| serviceName | <code>string</code> | Name of the service processing this |
+
+**Example**  
+```js
+const result = await orchestrator.processWorkflowMessage({
+  workflow_id: 'wf-123',
+  cookbook: cookbookDef,
+  current_step: 'step1',
+  context: {}
+}, 'hello-service');
+```
+<a name="generateCookbook"></a>
+
+## generateCookbook(openApiSpec) ⇒ <code>Object</code>
+Generate cookbook from OpenAPI spec (utility method)
+
+**Kind**: global function  
+**Returns**: <code>Object</code> - Generated cookbook  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| openApiSpec | <code>Object</code> | OpenAPI specification |
+
+**Example**  
+```js
+const cookbook = orchestrator.generateCookbook(openApiSpec);
+```
+<a name="transformResponse"></a>
+
+## transformResponse(response, mapping) ⇒ <code>Object</code>
+Transform API response using cookbook mapping
+
+**Kind**: global function  
+**Returns**: <code>Object</code> - Transformed response  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| response | <code>Object</code> | API response |
+| mapping | <code>Object</code> | Output mapping |
+