# service-dashboards-node

> Application dashboards microservice in Node.js / ES2017

Latest version **1.1.0** (published 2022-12-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install service-dashboards-node
pnpm add service-dashboards-node
yarn add service-dashboards-node
bun add service-dashboards-node
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2022-12-20 |
| First published | 2022-05-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=14.0.0 |
| Dependencies | 8 |
| Unpacked size | 150.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Conceptual Vision Consulting LLC |
| Maintainers | pipdeveloper |
| Keywords | pip.services, dashboard, microservice |

## Links

- npm: https://www.npmjs.com/package/service-dashboards-node
- Repository: https://github.com/pip-services-content2/service-dashboards-node
- Homepage: https://github.com/pip-services-content2/service-dashboards-node#readme
- Issues: https://github.com/pip-services-content2/service-dashboards-node/issues
- npm.io page: https://npm.io/package/service-dashboards-node

## Dependencies (8)

- [pip-services3-aws-nodex](https://npm.io/package/pip-services3-aws-nodex.md) ^1.1.*
- [pip-services3-rpc-nodex](https://npm.io/package/pip-services3-rpc-nodex.md) ^1.2.*
- [pip-services3-data-nodex](https://npm.io/package/pip-services3-data-nodex.md) ^1.0.*
- [pip-services3-commons-nodex](https://npm.io/package/pip-services3-commons-nodex.md) ^1.0.*
- [pip-services3-mongodb-nodex](https://npm.io/package/pip-services3-mongodb-nodex.md) ^1.0.*
- [pip-services3-swagger-nodex](https://npm.io/package/pip-services3-swagger-nodex.md) ^1.0.*
- [pip-services3-container-nodex](https://npm.io/package/pip-services3-container-nodex.md) ^1.0.*
- [pip-services3-components-nodex](https://npm.io/package/pip-services3-components-nodex.md) ^1.4.*

## Recent versions

- 1.1.0 (latest) — 2022-12-20
- 1.0.0 — 2022-05-12

## README

# Dashboards Microservice

This is an application dashboards microservice from Pip.Services library. 
It provides guidance to application users: introduces about application features, tells about new version and so on.
Each dashboard:
- Can be written in multiple languages
- Can include one or more pages with title, text and a picture
- Supports editing lifecycle via status tracking

The microservice currently supports the following deployment options:
* Deployment platforms: Standalone Process, Seneca
* External APIs: HTTP/REST, Seneca, AWS Lambda
* Persistence: In-Memory, Flat Files, MongoDB

This microservice has dependencies on the following microservices:
- [pip-services-attachments](https://github.com/pip-services-content2/pip-services-attachments-node) - to reference pictures and documents associates with dashboards

<a name="links"></a> Quick Links:

* [Download Links](doc/Downloads.md)
* [Development Dashboard](doc/Development.md)
* [Configuration Dashboard](doc/Configuration.md)
* [Deployment Dashboard](doc/Deployment.md)
* Client SDKs
  - [Node.js SDK](https://github.com/pip-services-content2/client-dashboards-node)
* Communication Protocols
  - [HTTP Version 1](doc/HttpProtocolV1.md)
  - [Seneca Version 1](doc/SenecaProtocolV1.md)

##  Contract

Logical contract of the microservice is presented below. For physical implementation (HTTP/REST, Thrift, Seneca, Lambda, etc.),
please, refer to documentation of the specific protocol.

```typescript
export class TileSizeV1 {
    public static readonly Small = "small";
    public static readonly Medium = "medium";
    public static readonly Large = "large";
}

cexport class TileV1 {
    public title?: string;
    public index: number;
    public color: string;
    public size: string;
    public params?: any;
}

export class TileGroupV1 {
    public title?: string;
    public index: number;
    public tiles?: TileV1[];
}

export class DashboardV1 implements IStringIdentifiable {
    /* Identification */
    public id: string;
    public user_id: string;
    public app: string;
    public kind?: string;

    /* Content */
    public groups: TileGroupV1[];
}

interface IDashboardsV1 {
    getDashboards(correlationId: string, filter: FilterParams, paging: PagingParams): Promise<DataPage<DashboardV1>>;

    getDashboard(correlationId: string, userId: string, app: string, kind: string): Promise<DashboardV1>;

    setDashboard(correlationId: string, dashboard: DashboardV1): Promise<DashboardV1>;

    deleteDashboards(correlationId: string, filter: FilterParams): Promise<void>;
}
```

## Download

Right now the only way to get the microservice is to check it out directly from github repository
```bash
git clone git@github.com:pip-services-content2/service-dashboards-node.git
```

Pip.Service team is working to implement packaging and make stable releases available for your 
as zip downloadable archieves.

## Run

Add **config.yaml** file to the root of the microservice folder and set configuration parameters.
As the starting point you can use example configuration from **config.example.yaml** file. 

Example of microservice configuration
```yaml
---
- descriptor: "pip-services-commons:logger:console:default:1.0"
  level: "trace"

- descriptor: "service-dashboards:persistence:file:default:1.0"
  path: "./data/dashboards.json"

- descriptor: "service-dashboards:controller:default:default:1.0"

- descriptor: "pip-services-attachments:client:http:default:1.0"
  connection:
    protocol: "http"
    host: "0.0.0.0"
    port: 8082

- descriptor: "service-dashboards:service:http:default:1.0"
  connection:
    protocol: "http"
    host: "0.0.0.0"
    port: 8080
```
 
For more information on the microservice configuration see [Configuration Dashboard](Configuration.md).

Start the microservice using the command:
```bash
node run
```

## Use

The easiest way to work with the microservice is to use client SDK. 
The complete list of available client SDKs for different languages is listed in the [Quick Links](#links)

If you use Node.js then you should add dependency to the client SDK into **package.json** file of your project
```javascript
{
    ...
    "dependencies": {
        ....
        "client-dashboards-node": "^1.0.*",
        ...
    }
}
```

Inside your code get the reference to the client SDK
```javascript
var sdk = new require('client-dashboards-node');
```

Define client configuration parameters that match configuration of the microservice external API
```javascript
// Client configuration
var config = {
    connection: {
        protocol: 'http',
        host: 'localhost', 
        port: 8080
    }
};
```

Instantiate the client and open connection to the microservice
```javascript
// Create the client instance
var client = sdk.DashboardsHttpClientV1(config);

// Connect to the microservice
try {
    await client.open(null);
    // Work with the microservice
    ...
} catch(err) {
    console.error('Connection to the microservice failed');
    console.error(err);
}
```

Now the client is ready to perform operations
```javascript
// Get a dashboard
let dashboard = await client.getDashboard(
    null,
    '123', 'Test App 1', 'default'
);
```

```javascript
// Sets an updated dashboard
let dashboard = await client.setDashboard(
    null,
    dashboard
);
```    

## Acknowledgements

This microservice was created and currently maintained by *Sergey Seroukhov*.

---
_Source: https://npm.io/package/service-dashboards-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._