# asc-rpc

> JSON RPC module for NestJS framework

Latest version **1.0.4** (published 2023-09-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install asc-rpc
pnpm add asc-rpc
yarn add asc-rpc
bun add asc-rpc
```

## 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.0.4 |
| Published | 2023-09-18 |
| First published | 2022-09-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 112.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | badrus shoolehk al ar fanny |
| Maintainers | badrus |

## Links

- npm: https://www.npmjs.com/package/asc-rpc
- npm.io page: https://npm.io/package/asc-rpc

## Recent versions

- 1.0.4 (latest) — 2023-09-18
- 1.0.3 — 2022-09-24
- 1.0.2 — 2022-09-24
- 1.0.1 — 2022-09-24
- 1.0.0 — 2022-09-24

## README

Implemented JSON RPC [specification](https://www.jsonrpc.org/specification)


## Contents

- [Install](#install)
- [Import module](#import-module)
- [How to use simple handler](#how-to-use-simple-handler)
    - [Create handler](#create-simple-handler)
    - [Add to providers](#add-simple-handler-provider)
    - [Test with curl](#test-simple-handler-curl)
- [How to use multiple handlers in one class](#multi-handlers-in-class)
    - [Create handlers](#create-multiple-handlers)
    - [Add to providers](#add-multiple-handler-provider)
    - [Test with curl](#test-multiple-handler-curl)
- [Decorators description](#decorators-description)
- [Samples](#samples)
- [Changelog](#changelog)


### <a id="install"></a> Install

   `npm i --save asc-rpc`

### <a id="import-module"></a> Import module

Import module `RpcModule` from `asc-rpc`, example  

```typescript
        JsonRpcModule.forRoot({
            path: '/rpc', // path to RPC
        })
```

### <a id="how-to-use-simple-handler"></a> How to use simple handler

Create simple RPC handler

#### <a id="create-simple-handler"></a> Create handler

create RPC handler  

```typescript
import { RpcId, RpcPayload, RpcVersion, RpcMethod, IRpcHandler, RpcHandler } from 'asc-rpc';

@RpcHandler({
    method: 'test',
})
export class TestHandler implements IRpcHandler<Payload> {
    public async invoke(
        @RpcPayload() payload: Payload,
        @RpcVersion() version: string,
        @RpcId() id: number | string,
        @RpcMethod() method: string
    ) {
        return payload;
    }
}
```


#### <a id="add-simple-handler-provider"></a> Add to providers

Add `TestHandler` to providers array  

 
#### <a id="test-simple-handler-curl"></a> Test with cURL

Every request to RPC is POST method and response status = 200  

Test with curl  

```bash
curl -X POST "http://localhost:3000/rpc" -H "accept: application/json" -H "Content-Type: application/json" -d '{"jsonrpc": "2.0", "method": "test", "id": 2}'
```
    
    

### <a id="multi-handlers-in-class"></a> How to use multiple handlers in one class

Create multiple RPC handler in one class  

#### <a id="create-multiple-handlers"></a> Create handlers

Create RPC class handler  

```typescript
import { RpcId, RpcPayload, RpcVersion, RpcMethod, RpcMethodHandler, RpcHandler } from 'asc-rpc';

@RpcHandler({
    method: 'contact',
})
export class ContactHandler {
    @RpcMethodHandler('add')
    public async add(
        @RpcPayload() payload: Payload,
        @RpcVersion() version: string,
        @RpcId() id: number | string,
        @RpcMethod() method: string
    ) {
        return payload;
    }
    
    @RpcMethodHandler('delete')
    public async delete(
        @RpcPayload() payload: Payload,
        @RpcVersion() version: string,
        @RpcId() id: number | string,
        @RpcMethod() method: string
    ) {
        return payload;
    }
}
```


#### <a id="add-multiple-handler-provider"></a> Add to providers

Add `ContactHandler` to providers array  

 
#### <a id="test-multiple-handler-curl"></a> Test with cURL

Every request to RPC is POST method and response status = 200  

Test with curl `contact.add`  

```bash
curl -X POST "http://localhost:3000/rpc" -H "accept: application/json" -H "Content-Type: application/json" -d '{"jsonrpc": "2.0", "method": "contact.add", "id": 2}'
```
    

Test with curl `contact.delete`  

```bash
curl -X POST "http://localhost:3000/rpc" -H "accept: application/json" -H "Content-Type: application/json" -d '{"jsonrpc": "2.0", "method": "contact.delete", "id": 2}'
```


### Decorators description

| field |  decorator |  description | required  | other  |
|---|---|---|---|---|
| `params` | `@RpcPayload()`  |  get payload ( params ) | false  | use pipes...  | 
| `jsonrpc` | `@RpcVersion()` | get rpc version  | true  | use pipes...  |  
| `method` | `@RpcMethod()` | get rpc version  | true  | use pipes...  |  
| `id` | `@RpcId()`  | get client operation id  | false  | if not send - response not send, RPC notification. use pipes...  |

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