# gravit-api

> JS API implementation for GravitLauncher

Latest version **1.1.0-release** (published 2020-10-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install gravit-api
pnpm add gravit-api
yarn add gravit-api
bun add gravit-api
```

## 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 | 1.1.0-release |
| Published | 2020-10-20 |
| First published | 2020-06-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 48.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Andrew Molchanov |
| Maintainers | jocat |
| Keywords | gravitlauncher |

## Links

- npm: https://www.npmjs.com/package/gravit-api
- Repository: https://github.com/JoCat/gravit-api
- Homepage: https://github.com/JoCat/gravit-api#readme
- Issues: https://github.com/JoCat/gravit-api/issues
- npm.io page: https://npm.io/package/gravit-api

## Dependencies (3)

- [ws](https://npm.io/package/ws.md) ^7.3.0
- [isomorphic-ws](https://npm.io/package/isomorphic-ws.md) ^4.0.1
- [get-random-values](https://npm.io/package/get-random-values.md) ^1.2.0

## Recent versions

- 1.1.0-release (latest) — 2020-10-20
- 1.1.0-rc2 — 2020-06-30
- 1.0.3 — 2020-06-30
- 1.0.2 — 2020-06-23
- 1.0.1 — 2020-06-23
- 1.0.0 — 2020-06-20
- 0.2.1 — 2020-06-20

## README

# GravitAPI
[![npm](https://img.shields.io/npm/v/gravit-api?style=flat-square)](https://www.npmjs.com/package/gravit-api)
[![GitHub license](https://img.shields.io/github/license/JoCat/gravit-api?style=flat-square)](https://github.com/JoCat/gravit-api/blob/master/LICENSE)
[![GitHub issues](https://img.shields.io/github/issues/JoCat/gravit-api?style=flat-square)](https://github.com/JoCat/gravit-api/issues)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

Реализация JS API для [GravitLauncher](https://github.com/GravitLauncher/Launcher)

## Установка

Используя npm:

```bash
npm i gravit-api
```

Используя jsDelivr CDN:

```html
<script src="https://cdn.jsdelivr.net/npm/gravit-api/dist/gravit-api.min.js"></script>
```

Используя unpkg CDN:

```html
<script src="https://unpkg.com/gravit-api/dist/gravit-api.min.js"></script>
```

## Пример использования

```js
// Подключение класса API
const GravitApi = require('gravit-api');

// Данные для запроса
const wsUrl = 'ws://localhost:9274/api';
const userdata = {
    login: 'test',
    password: 'test'
};

// Инициализация класса API
const api = new GravitApi();

// Подключение и отправка/обработка запросов с использованием Promise

api.connect(wsUrl) // Подключение к сокету лаунчсервера
.then(() => {
    api.send('getAvailabilityAuth').then(auth => { //Запрос списка методов авторизации
        console.log(auth.list);
        api.close(); // Закрытие соединения
    }).catch(console.error);
}).catch(console.error);

// или в стиле async/await

(async () => {
    try {
        await api.connect(wsUrl);
        const auth = await api.send('getAvailabilityAuth');
        console.log(auth.list);
    } catch (error) {
        console.error(error);
    } finally {
        api.close();
    }
})();
```

Более подробные примеры использования можно найти [здесь](https://github.com/JoCat/gravit-api/tree/master/example)

## Методы и параметры

Класс `GravitApi` содержит следущее:

Свойство:
* `requestMap` - коллекция с обработчиками ответов от лаунчсервера добавляемыми функцией `send`

Методы:
* `connect(url)` - подключение к сокету лаунчсервера, где:
    * `url` - адрес сокета лаунчсервера
* `close()` - отключение от сокета лаунчсервера
* `send(type, obj)` - отправка запроса к лаунчсерверу, где:
    * `type` - тип запроса
    * `obj` - объект с параметрами запроса
* `getUUIDv4()` - генерация случайного UUID для запроса, используется в `sendRequest`

Эвенты (стандартные эвенты [вебсокета](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket)):
* `onOpen()` - обработчик эвента [onopen](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/onopen)
* `onClose()` - обработчик эвента [onclose](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/onclose)
* `onMessage()` - обработчик эвента [onmessage](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/onmessage)
* `onError()` - обработчик эвента [onerror](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/onerror)

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