# Mender SDK for JavaScript

## Usage


```js
import Mender from 'mender';

const mender = new Mender(process.env.MENDER_URL);

mender.login(username, password)
  .then(it => {
    console.log(it);
  }, e => {
    console.error(e);
  });
```

## Docs

* https://docs.mender.io/1.6/apis
* Mender Device Authentication Service
* Mender Deployment Service: https://github.com/mendersoftware/deployments
* Mender Device Inventory Service:
  - https://github.com/mendersoftware/inventory
  - https://github.com/mendersoftware/deviceadm
* Mender User Administration Service: https://github.com/mendersoftware/useradm
* Mender API Gateway
* Minio object storage
* Storage service proxy based on OpenResty

## Code Generating From swagger

```sh
yarn add -d swagger-codegen-axios-flow
yarn run swagger-codegen-axios-flow < docs/_data/inventory.json > docs/_data/inventory.js
```

ref. https://github.com/yongjhih/swagger-codegen-axios-flow

## Installation

```sh
yarn add mender
```

for latest version:

```sh
yarn add git+ssh://git@github.com/yongjhih/mender.js.git#dist
```

and also you can install specific commit of dist:

```
yarn add git+ssh://git@github.com/yongjhih/mender.js.git#<commit-id>
```


## Development

* Please deploy after implemented feature

## Deployment

* git checkout dist && git merge master
* yarn deploy

### Testing and coverage

```
yarn build && yarn test && yarn coverage
```

You can open flow-coverage/ and coverage/lcov-report to see

### Requirements

* node
* yarn

```
brew install node yarn
```

### Build

p.s. We used babel as default compiler before, you can also use flow-remove-types

```sh
yarn build && yarn test
```

### Type checking with flow

```sh
yarn run flow
```

You should install a flow plugin on your IDE instead.

### API Documentation

```sh
yarn docs
```

You can open docs/ to see

## Stack

* ES6
* Functional
* Promise

* Type-safety
* Null-safety
* Generic
* Unit testable / coverage report

* package manager: yarn (~~npm~~)
* http client: axios (~~request~~, ~~node-fetch~~)
* static type checking: facebook/flow (~~Microsoft/TypeScript~~, ~~Google/Dart~~, ~~kotlin2javascript~~)
* runtime type checking: codemix/flow-runtime (~~tcomb~~)
* testing frameworks: jest (~~mocha~~, ~~karma~~, ~~jasmine~~)
* mock web: nock

## Why JavaScript+Flow

I considered that Python, KotlinScript, GoLang, JavaScript, Dart, TypeScript, JavaScript+Flow, Rust, Ruby, OCaml, ReasonML.
I choose JavaScript+Flow, because it's type-safety, null-safety, supports generics and functional.

* Flow: facebook/flow compile-time type checking system
* +flow-runtime (relacement of ~~tcomb~~)

Python has PEP 484 decorator/annotation feature that could be able to do type checking
But I realized that there is nobody care about that too much in the Python community.
There is not too much activity.

And it shouldn't be as decorator for type checking, it should be real type/class for type checking with Generic and Null-Safety.
Actually I really want to write KotlinScript, but it's not ready for our teammates.

## Credit

* The main class has been generated by https://github.com/yongjhih/swagger-codegen-axios-flow