@magaya/hyperion-node/README.md

Hyperion project to be used with node.

# Hyperion-Node - Gateway to Hyperion in Node

## Intro
Project hosting hyperion which can be included in other node projects.

```js
// process.argv needs to include an entry '--connection-string'
// the second parameter is the unique identifier of the application connecting to the database
const hyperion = require('@magaya/hyperion-node')(process.argv, 'extension-example');

// hyperion.algorithm   - access to algorithms
// hyperion.connection  - access to raw hyperion connection
// hyperion.dbx         - access to hyperion database namespaces
// hyperion.dbw         - access to hyperion write access functionality
hyperion.algorithm.findFirst(hyperion.dbx.using(hyperion.dbx.Warehousing.PickupOrder.ListByNumber))
    .then(pickup => console.log(pickup.Number));
```

## Compatibility

In production, Magaya will handle all the dependencies to ensure the extensions (NodeJS apps) run accordingly, matching compatible versions of the Magaya Explorer, NodeJS, npm and the related Hyperion packages.

In development, you'll need to install the tools that are compatible with the version of Magaya you're using, check the table below:

| Magaya        | NodeJS        |
| ------------- | ------------- |
| v12.5.2      | 20.3.0 [32 bits](https://nodejs.org/dist/v20.3.0/node-v20.3.0-x86.msi) [64 bits](https://nodejs.org/dist/v20.3.0/node-v20.3.0-x64.msi)  |
| v11.6.1      | 20.3.0 [32 bits](https://nodejs.org/dist/v20.3.0/node-v20.3.0-x86.msi) [64 bits](https://nodejs.org/dist/v20.3.0/node-v20.3.0-x64.msi)  |
| v11.6.0      | 16.5.0 [32 bits](https://nodejs.org/dist/v16.5.0/node-v16.5.0-x86.msi) [64 bits](https://nodejs.org/dist/v16.5.0/node-v16.5.0-x64.msi)  |
| v11.3.x      | 12.14.1 [32 bits](https://nodejs.org/dist/v12.14.1/node-v12.14.1-x86.msi) [64 bits](https://nodejs.org/dist/v12.14.1/node-v12.14.1-x64.msi)  |
| v11.2.x       | 8.11.1 [32 bits](https://nodejs.org/dist/v8.11.1/node-v8.11.1-x86.msi) [64 bits](https://nodejs.org/dist/v8.11.1/node-v8.11.1-x64.msi)  |
| v11.1.x       | 8.11.1 [32 bits](https://nodejs.org/dist/v8.11.1/node-v8.11.1-x86.msi) [64 bits](https://nodejs.org/dist/v8.11.1/node-v8.11.1-x64.msi)  |
| v11.0.3       | 8.11.1 [32 bits](https://nodejs.org/dist/v8.11.1/node-v8.11.1-x86.msi) [64 bits](https://nodejs.org/dist/v8.11.1/node-v8.11.1-x64.msi)  |

## Startup
To get started provide the module with an *application name* and the list of *application parameters*.

Starting with version 11.2 of Magaya, the second parameter can be an object, containing the unique identifier of the application connecting to the database and it's API Key, assigned during installation, for writting purposes.

```js
const hyperion = require('@magaya/hyperion-node')(process.argv, {
    'clientId' : 'extension-example',
    'apiKey' : '123456'
});
```

## Components
- algorithm
- connection
- dbx
- dbw

---

### Descriptions coming soon...