# @gdjiami/jsonrpc-encryption

> JSON RPC Client By Encryption

Latest version **1.2.9-beta1** (published 2025-06-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @gdjiami/jsonrpc-encryption
pnpm add @gdjiami/jsonrpc-encryption
yarn add @gdjiami/jsonrpc-encryption
bun add @gdjiami/jsonrpc-encryption
```

## Health

**Score 40/100 (D)** — status: maintenance-mode.

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

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.9-beta1 |
| Published | 2025-06-25 |
| First published | 2020-10-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 88.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | jerry |
| Maintainers | jiami, carney520, wenson-jay |
| Keywords | jsonrpc, jsonrpc2, encryption |

## Links

- npm: https://www.npmjs.com/package/@gdjiami/jsonrpc-encryption
- npm.io page: https://npm.io/package/@gdjiami/jsonrpc-encryption

## Dependencies (3)

- [crypto-js](https://npm.io/package/crypto-js.md) ^4.0.0
- [jsencrypt](https://npm.io/package/jsencrypt.md) ^3.0.0-rc.1
- [@gdjiami/jsonrpc](https://npm.io/package/@gdjiami/jsonrpc.md) ^2.5.3

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.2.9-beta1 (latest) — 2025-06-25
- 1.2.7 — 2024-09-18
- 1.2.4 — 2024-07-16
- 1.2.3 — 2024-07-11
- 1.2.2 — 2024-07-11
- 1.2.1 — 2024-07-09
- 1.2.0 — 2023-12-27
- 1.1.9 — 2023-11-27
- 1.1.8 — 2023-10-23
- 1.1.7-beta5 — 2023-10-23
- 1.1.7-beta4 — 2023-10-23
- 1.1.7-beta3 — 2023-10-23
- 1.1.7-beta2 — 2023-10-23
- 1.1.7-beta1 — 2023-10-23
- 1.1.7 — 2023-09-08
- … 19 more at https://npm.io/package/@gdjiami/jsonrpc-encryption/versions

## README

# jsonrpc-encryption

## 介绍

基于 @gdjiami/jsonrpc 封装了加解密操作

加密算法: RSA + AES

在接口请求时能够自动完成上传数据的加密与接收数据的解密, 前端开发无需过多考虑数据的加解密操作

## 安装

```shell
yarn add @gdjiami/jsonrpc-encryption
```

## 使用

```js
// rpc.ts 生成rpc实例
const rpc = getInstance(root, { ignoreProtocolError: true })
```

```js
// 在入口文件处初始化加解密密钥,与后台进行协商
useOnMount(async () => {
  try {
    return await rpc.initial()
  } catch (error) {
    message.error(error.message)
  }
  return null
})
```

```js
// 使用 encryptRequest 进行加密请求, 其返回数据已自动解密处理
const authResult = await rpc.encryptRequest('auth.login', { account, password })
```

## 注意事项

- 前后端的加解密操作必须保持一致, 否则会出现解密失败

- 只要是刷新 securityId 报错, 就会重新进行协商密钥

- 其他请求返回错误码为 642, 会重新进行协商密钥

## 参考

[JSONRPC 协议](https://www.jsonrpc.org/specification)

## License

This project is licensed under the terms of the
[MIT license](LICENSE).

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