# raml-js-data-provider

> A npm module to observe API spec folder and generate JavaScript object from RAML for Web Socket server.

Latest version **0.1.2** (published 2018-11-02) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install raml-js-data-provider
pnpm add raml-js-data-provider
yarn add raml-js-data-provider
bun add raml-js-data-provider
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2018-11-02 |
| First published | 2017-08-12 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.5.0 |
| Dependencies | 5 |
| Unpacked size | 33.1 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Pawel Psztyc, Advanced Rest Client Authors |
| Maintainers | jarrodek, mulesoft-npm |
| Keywords | api-console, builder, node, bower, dependencies |

## Links

- npm: https://www.npmjs.com/package/raml-js-data-provider
- Repository: https://github.com/advanced-rest-client/raml-js-data-provider
- Homepage: https://github.com/advanced-rest-client/raml-js-data-provider#readme
- Issues: https://github.com/advanced-rest-client/raml-js-data-provider/issues
- npm.io page: https://npm.io/package/raml-js-data-provider

## Dependencies (5)

- [ws](https://npm.io/package/ws.md) ^3.1.0
- [gulp](https://npm.io/package/gulp.md) 4.0.0
- [winston](https://npm.io/package/winston.md) ^2.3.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^3.0.0
- [raml-json-enhance-node](https://npm.io/package/raml-json-enhance-node.md) ^0.3.1

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2018-11-02
- 0.1.1 — 2018-01-10
- 0.1.0 — 2017-08-12

## README

# raml-js-data-provider

A npm module to run web socket server, observe changes to a RAML project folder
(and any file in it) and to update connected clients with RAML JS data
after change.

## Example

```javascript
const {RamlJsDataProvider} = require('raml-js-data-provider');

const prev = new RamlJsDataProvider({
  projectRoot: '/path/to/api/directory/',
  api: 'api.raml',
  verbose: true
});
prev.start()
.then(port => console.log('Web socket server is running on port: ' + port));
```

Script above runs a web socket server and observes `/path/to/api/directory/`
path for any change. If content of the directory change then clients connected
to the server receive an update.

### Options

| Option | Type | Default | Description |
| ---- | ---- | ---- | ---- |
| `api` | `String` | `api.raml` | The RAML entry point file. |
| `host` | `String` | `127.0.0.1` | Host name for the web socket server. |
| `port` | `Number` | `undefined` | Port name for the web socket server. If not set it uses first available port from range `<49152, 65535>`. |
| `projectRoot` | `String` | Current working directory | API project folder location. |
| `verbose` | `Boolean` | `false` | Prints debug messages |

## The protocol

Web socket server do not listen for any incoming messages since there's nothing
to pull from the server. It only sends information to clients.

Incoming to clients message is a string of stringified JavaScript object.
After parsing it to an object each message contains `payload` property describing
the purpose of the message.

Currently supported payloads are:

-   raml - when receiving API spec
-   generating-json - when serve started generating a JSON data from the RAML spec and clients should expect RAML data shortly.
-   error - when error occurred while parsing RAML data.

The `raml` payload comes with `data` property containing parsed RAML data as JavaScript object.
`generating-json` does not carry any other properties.

The `error` message contains `level` and `message` properties. Currently `level`
is either `critical` or undefined.

### Example

```javascript
...
// Initializes web socket
init(host, port) {
  var socket = new WebSocket(`ws://${host}:${port}`);
  socket.addEventListener('message', this.onMessage.bind(this));
}
// Handler for the `message` event of web socket connection.
onMessage(event) {
  var message = JSON.parse(event.data);
  switch (message.payload) {
    case 'raml':
      this.useRamlData(message.data);
      break;
    case 'generating-json':
      this.openLoader();
      break;
    case 'error':
      this.notifyError(message.level, message.message);
      break;
    default:
      console.log('Unknown payload received', message.payload);
  }
}
```

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