# @ignitial/iio-app-client

> Ignitial.io web application client library

Latest version **5.2.4** (published 2020-08-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ignitial/iio-app-client
pnpm add @ignitial/iio-app-client
yarn add @ignitial/iio-app-client
bun add @ignitial/iio-app-client
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.2.4 |
| Published | 2020-08-19 |
| First published | 2018-12-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 26.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Victor Andritoiu |
| Maintainers | ignitial |

## Links

- npm: https://www.npmjs.com/package/@ignitial/iio-app-client
- Repository: https://github.com/ignitialio/iio-app-client
- Homepage: https://github.com/ignitialio/iio-app-client#readme
- Issues: https://github.com/ignitialio/iio-app-client/issues
- npm.io page: https://npm.io/package/@ignitial/iio-app-client

## Dependencies (9)

- [bson](https://npm.io/package/bson.md) ^4.1.0
- [loadjs](https://npm.io/package/loadjs.md) ^3.6.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.20
- [d3-selection](https://npm.io/package/d3-selection.md) ^1.4.2
- [babel-polyfill](https://npm.io/package/babel-polyfill.md) ^6.26.0
- [socket.io-client](https://npm.io/package/socket.io-client.md) ^2.3.0
- [socket.io-stream](https://npm.io/package/socket.io-stream.md) ^0.9.1
- [json-schema-faker](https://npm.io/package/json-schema-faker.md) ^0.5.0-rcv.27
- [generate-json-schema](https://npm.io/package/generate-json-schema.md) ^1.0.0

## Recent versions

- 5.2.4 (latest) — 2020-08-19
- 5.2.3 — 2020-05-03
- 5.2.2 — 2020-05-03
- 5.2.1 — 2020-01-30
- 5.2.0 — 2020-01-30
- 5.1.12 — 2020-01-27
- 5.1.11 — 2019-12-18
- 5.1.10 — 2019-11-27
- 5.1.9 — 2019-11-18
- 5.1.8 — 2019-11-18
- 5.1.7 — 2019-11-15
- 5.1.6 — 2019-11-13
- 5.1.5 — 2019-10-31
- 5.1.4 — 2019-08-29
- 5.1.3 — 2019-08-11
- … 24 more at https://npm.io/package/@ignitial/iio-app-client/versions

## README

# IgnitialIO web application client library

This library allows an web app to take advantage of the
[IIOS](https://github.com/ignitialio/iio-services) services framework.  
It implements several concepts:
- web socket communication using [socket.io](https://www.npmjs.com/package/socket.io)
- unified services: these are services defined server-side that can be called
browser side as if they were seamlesly local to browser. They use web sockets to
do so.
- modules: these are services (you can see this as server app plugins) implemented
server-side and eventually available browser side. If so, unlikely unified
services, they are defined with one instance per all web socket clients (e.g.
connection), while unified services provide one instance per client
- API gateway: is providing an unified service for each available IIO
micro-service. In this way, any micro-service can be used locally to the browser.
- static configuration management for the web app
- static file serve
- REST API capabilities thanks to [connect-rest](https://www.npmjs.com/package/connect-rest)
- AWS S3 or compliant (e.g. Minio S3) file storage
- i18n

## Architecture

### _i18n_  

It provides internationalization features allowing to use transparent translation
for any string.

### _modules_

Base class for implementing client side plugin (for example VueJS plugin) to
remotely access server modules.

### _services_

Base class for implementing client side plugin (for example VueJS plugin) to
remotely access server services (unified services + IIO micro-services).

### _utils_

Base class for implementing utility plugin (for example VueJS plugin).

## Tests  

Tests are mainly done trough the full application. For example:
[IgnitialIO application template](https://github.com/ignitialio/iio-app-template)

---
_Source: https://npm.io/package/@ignitial/iio-app-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
