# @amazebot/rocket-socket

> Communicate with Rocket.Chat Realtime API via websocket (DDP).

Latest version **0.1.1** (published 2019-04-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @amazebot/rocket-socket
pnpm add @amazebot/rocket-socket
yarn add @amazebot/rocket-socket
bun add @amazebot/rocket-socket
```

Provides the command `rocket-call`.

## Health

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

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

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2019-04-21 |
| First published | 2018-12-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | > 8.0.0 |
| Dependencies | 4 |
| Unpacked size | 43.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Tim Kinnane |
| Maintainers | timkinnane |
| Keywords | rocket.chat, chat, chatops, messaging, CUI, typescript, DDP |

## Links

- npm: https://www.npmjs.com/package/@amazebot/rocket-socket
- Repository: https://github.com/Amazebot/rocket-control
- Homepage: https://github.com/Amazebot/rocket-control/tree/master/packages/socket
- Issues: https://github.com/Amazebot/rocket-control/issues
- npm.io page: https://npm.io/package/@amazebot/rocket-socket

## Dependencies (4)

- [ws](https://npm.io/package/ws.md) ^6.1.2
- [@types/ws](https://npm.io/package/@types/ws.md) ^6.0.1
- [@amazebot/config](https://npm.io/package/@amazebot/config.md) ^0.1.1
- [@amazebot/logger](https://npm.io/package/@amazebot/logger.md) ^0.1.1

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2019-04-21
- 0.1.0 — 2019-02-27
- 0.0.1 — 2018-12-11

## README

[control]: https://github.com/Amazebot/rocket-control
[config]: https://github.com/Amazebot/rocket-control#config
[mentions]: https://github.com/Amazebot/rocket-control/tree/master/packages/examples/src/bot-mentions.ts

# 🔌 Rocket Socket
Communicate with Rocket.Chat Realtime API via websocket (DDP).

---

### Usage

See the main [`rocket-control` README][control] for general configuration.

[This example script][mentions] uses `rocket-socket` and `rocket-sims` to create
a new bot user, connect to the general channel and stream all bot mentions to
the console.

#### `new Socket()`

Accepts options object, or uses defaults from environment config. Attributes can
include `host` *string* and `ssl` *boolean*.

Creates a websocket handler instance to manage the connection with Rocket.Chat.

```ts
import { Socket } from '@amazebot/rocket-socket'
const socket = new Socket()
```

#### `.open()` and `.close()`

Opens connection with Rocket.Chat. Returns promise.

Accepts option number of ms to attempt re-opening.

```ts
const socket = new Socket()
await socket.open()
await socket.close()
```

#### `.login(credentials)` and `.logout()`

Login can be called without explicit `.open()`, it will open the socket to login.

Login can be called without credentials to use the default user/pass from environment [configs][control].

Login returns a credential object that can be used to resume login after closing and re-opening socket.

Login accepts a range of credential objects (including the resume object mentioned above):

Username/password:
```ts
{
  username: string
  password: string
}
```

Server credentials:
```ts
{
  user: { username: string }
  password: { digest: string, algorithm: string }
}
```

Oauth token:
```ts
{
  oauth: {
    credentialToken: string
    credentialSecret: string
  }
}
```

Resume token:
```ts
{
  resume: string
}
```

#### `.connected` and `.loggedIn`

Boolean attributes for confirming connection status.

#### `.subscribe(name, params, callback)`

Subscribe to any stream of events on the server, passing the stream `name` and `params` *array* as per Realtime API docs here: https://rocket.chat/docs/developer-guides/realtime-api/subscriptions/

The callback function will be called with every emitted event.

Subscribe method returns a subscription object, with the same attributes used to create it, along with an `.id` and `.unsubscribe()` method.

### CLI Usage

Method calls can also be made over DDP manually through the CLI, using a method
name and optional other parameters. Results will be printed to console. Requires
the same config as above, with username/password as ENV or command line opts.

#### Locally with `ts-node`

Run pre-compiled locally, using

```sh
> ts-node src/cli --method getServerInfo
```

Outputs

```sh
{ result:
   { version: '0.73.2',
...
```

You can also pass params

```sh
> ts-node src/cli --method getRoomNameById --params GENERAL
```

Outputs

```sh
{ result: 'general' }
```

#### As a dependency with `rocket-call`

Run the compiled bin when installed as a dependency

```sh
> node_modules/bin/rocket-call --method getServerInfo
```

Or use the alias arguments for both method and params

```sh
> node_modules/bin/rocket-call -m getRoomNameById -p GENERAL
```

Could work as a global NPM package too.

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