gws-client 0.6.4 → 1.0.0

package/README.md

@@ -2,9 +2,9 @@
 
 用于web前端调用GZCA数字证书客户端UKEY证书应用接口，调用前需确保已安装GZCA数字证书客户端并启动，支持TypeScript。
 
-## 快速开始
+## 1 快速开始
 
-### 安装
+### 1.1 安装
 
 #### 使用包管理器
 
@@ -26,7 +26,7 @@ Install with pnpm
 pnpm add gws-client
 ```
 
-### 使用
+### 1.2 使用
 
 #### ES Module
 
@@ -84,7 +84,7 @@ async function foo() {
 | onError       | 可选，socket错误时回调     | `(event: Event) => void`                                        | --        |
 | onClose       | 可选，socket关闭时回调     | `(event: Event) => void`                                        | --        |
 | onMessage     | 可选，socket收到消息时回调 | `(data: Record<string, any>) => void`                           | --        |
-| onUkeyChange   | 可选，Ukey插入拔出时回调   | `(event: {type: 'remove' \| 'insert', data: CertType}) => void` | --        |
+| onUkeyChange  | 可选，Ukey插入拔出时回调   | `(event: {type: 'remove' \| 'insert', data: CertType}) => void` | --        |
 | theme         | 可选，弹窗主题色           | `String`                                                        | `#409eff` |
 
 #### 示例
@@ -124,9 +124,9 @@ async function pkcs1Sign() {
 }
 ```
 
-## API接口
+## 2 API接口
 
-### 销毁
+### 2.1 销毁
 
 断开socket连接
 
@@ -140,7 +140,7 @@ destroy
 type Destroy = () => void;
 ```
 
-### 重启
+### 2.2 重启
 
 重新连接socket，可重新传入新配置
 
@@ -154,7 +154,7 @@ restart
 type Restart = (config?: GwsServiceConfigType) => void;
 ```
 
-### 获取签名证书
+### 2.3 获取签名证书
 
 获取签名证书，可获取证书CN项，证书CertB64，sn
 
@@ -168,7 +168,7 @@ getSignatureCert
 type GetSignatureCert = (cert?: CertType) => Promise<CertType>;
 ```
 
-### 获取签名证书列表
+### 2.4 获取签名证书列表
 
 获取签名证书列表
 
@@ -182,7 +182,7 @@ getSignatureCertList
 type GetSignatureCertList = () => Promise<CertType[]>;
 ```
 
-### 获取加密证书
+### 2.5 获取加密证书
 
 获取加密证书，可获取证书CN项，证书CertB64，sn
 
@@ -196,7 +196,7 @@ getEncryptionCert
 type GetEncryptionCert = (cert?: CertType) => Promise<CertType>;
 ```
 
-### 获取加密证书列表
+### 2.6 获取加密证书列表
 
 获取加密证书列表
 
@@ -210,7 +210,7 @@ getEncryptionCertList
 type GetEncryptionCertList = () => Promise<CertType[]>;
 ```
 
-### 获取证书详情
+### 2.7 获取证书详情
 
 获取证书详情，可获取证书公钥CertPublicKey，证书序列号CertSerial，证书有效期CertValidTime
 
@@ -232,7 +232,7 @@ type GetCertInfo = (params: {
 | ------- | ---------------- | -------- | ------ |
 | CertB64 | 必填，证书Base64 | `String` | --     |
 
-### PKCS1签名
+### 2.8 PKCS1签名
 
 PKCS1签名，返回签名值
 
@@ -256,7 +256,7 @@ type Pkcs1Sign = (
 | Data    | 必填，待签名原文   | `String`   | --     |
 | IsLogin | 可选，证书登录状态 | `Y` \| `N` | --     |
 
-### PKCS1验签
+### 2.9 PKCS1验签
 
 PKCS1验签，传入curCert时使用该证书，返回验签结果，`true`为验签成功，验签失败时返回`Promise.reject`
 
@@ -285,7 +285,7 @@ type Pkcs1VerifySignature = (
 | SignData | 必填，Base64编码的签名值   | `String` | --     |
 | CertB64  | 可选，Base64编码的签名证书 | `String` | --     |
 
-### PKCS1 B64签名
+### 2.10 PKCS1 B64签名
 
 PKCS1 base64签名，传入curCert时使用该证书，返回签名值
 
@@ -311,7 +311,7 @@ type Pkcs1Base64Sign = (params: {
 | DataB64 | 与Data二选一 ， Base64编码的待签名原文，同时存在时使用DataB64 | `String`   | --     |
 | IsLogin | 可选，证书登录状态                                            | `Y` \| `N` | --     |
 
-### PKCS1 B64验签
+### 2.11 PKCS1 B64验签
 
 PKCS1 base64验签，返回验签结果，`true`为验签成功，验签失败时返回`Promise.reject`
 
@@ -339,7 +339,7 @@ type Pkcs1Base64VerifySignature = (params: {
 | SignData | 必填，Base64编码的签名值                                      | `String` | --     |
 | CertB64  | 可选，Base64编码的签名证书                                    | `String` | --     |
 
-### PKCS1哈希签名
+### 2.12 PKCS1哈希签名
 
 PKCS1哈希签名，返回签名值
 
@@ -366,7 +366,7 @@ type Pkcs1HashSign = (
 | HashAlg | 可选，哈希算法                         | `sm3` \| `sha1`\| `sha256` | `sm3`  |
 | IsLogin | 可选，证书登录状态                     | `Y` \| `N`                 | --     |
 
-### PKCS1哈希验签
+### 2.13 PKCS1哈希验签
 
 PKCS1哈希验签，返回验签结果，传入curCert时使用该证书，`true`为验签成功，验签失败时返回`Promise.reject`
 
@@ -394,7 +394,7 @@ type Pkcs1Base64VerifySignature = (params: {
 | CertB64  | 可选，Base64编码的签名证书               | `String`                   | --     |
 | HashAlg  | 可选，哈希算法                           | `sm3` \| `sha1`\| `sha256` | `sm3`  |
 
-### PKCS7签名
+### 2.14 PKCS7签名
 
 PKCS7签名，返回签名值
 
@@ -425,7 +425,7 @@ type Pkcs7Sign = (
 | IsDetached | 必填，Y为detach，N为attach，attach模式签名值带了原文          | `Y` \| `N` | --     |
 | IsLogin    | 可选，证书登录状态                                            | `Y` \| `N` | --     |
 
-### PKCS7验签
+### 2.15 PKCS7验签
 
 PKCS7验签，返回验签结果，传入curCert时使用该证书，`true`为验签成功，验签失败时返回`Promise.reject`
 
@@ -451,7 +451,7 @@ type Pkcs7VerifySignature = (params: {
 | DataB64  | 与Data二选一 ， Base64编码的待签名原文，同时存在时使用DataB64 | `String` | --     |
 | SignData | 必填，签名值                                                  | `String` | --     |
 
-### base64编码
+### 2.16 base64编码
 
 base64编码，返回base64编码内容
 
@@ -471,7 +471,7 @@ type Base64Encode = (params: { Data: string }) => string;
 | ---- | ---------------------- | -------- | ------ |
 | Data | 必填，base64待编码内容 | `String` | --     |
 
-### base64解码
+### 2.17 base64解码
 
 base64解码，返回base64解码内容
 
@@ -491,7 +491,7 @@ type Base64Decode = (params: { DataB64: string }) => string;
 | ------- | ---------------------- | -------- | ------ |
 | DataB64 | 必填，base64待解码内容 | `String` | --     |
 
-### SM3哈希
+### 2.18 SM3哈希
 
 SM3哈希，返回SM3哈希值
 
@@ -511,7 +511,7 @@ type Sm3Hash = (params: { Data: string }) => Promise<string>;
 | ---- | ------------------------ | -------- | ------ |
 | Data | 必填，待计算杂凑值的原文 | `String` | --     |
 
-### SM3 B64哈希
+### 2.19 SM3 B64哈希
 
 SM3 B64哈希
 
@@ -531,7 +531,7 @@ type Sm3HexHash = (params: { DataB64: string }) => Promise<string>;
 | ------- | ------------------------------ | -------- | ------ |
 | DataB64 | 必填，待计算杂凑值的原文base64 | `String` | --     |
 
-### SM3 文件哈希
+### 2.20 SM3 文件哈希
 
 SM3 文件哈希
 
@@ -551,7 +551,7 @@ type Sm3FileHash = (params: { SrcFile: string }) => Promise<string>;
 | ------- | ------------------------------------------------------- | -------- | ------ |
 | SrcFile | 必填，待计算杂凑值的本地文件全路径。建议使用正斜杠（/） | `String` | --     |
 
-### SM3哈希加密
+### 2.21 SM3哈希加密
 
 SM3哈希加密
 
@@ -579,7 +579,7 @@ type Sm3HashEncryption = (params: {
 | Key     | 与KeyB64二选一，密钥                                          | `String` | --     |
 | KeyB64  | 与Key二选一 ， base64编码的密钥，同时存在时使用KeyB64         | `String` | --     |
 
-### PKCS7加密
+### 2.22 PKCS7加密
 
 PKCS7加密，返回加密字符串
 
@@ -605,7 +605,7 @@ type Pkcs7Encryption = (params: {
 | DataB64     | 与Data二选一 ， Base64编码的待加密原文，同时存在时使用DataB64 | `String` | --     |
 | CertB64List | 必填，加密证书base64，多个以\|连接                            | `String` | --     |
 
-### PKCS7解密
+### 2.23 PKCS7解密
 
 PKCS7解密，返回解密字符串
 
@@ -631,7 +631,7 @@ type Pkcs7Decryption = (params: {
 | shouldDecodeBase64 | 可选，是否需要base64解码 | `Boolean`  | --     |
 | IsLogin            | 可选，证书登录状态       | `Y` \| `N` | --     |
 
-### 非对称加密
+### 2.24 非对称加密
 
 非对称加密，返回加密字符串
 
@@ -653,7 +653,7 @@ type AsymmetricDecryption = (params: { Data: string；IsLogin?: string }) => Pro
 | CertB64 | 可选，加密证书B64  | `String`   | --     |
 | IsLogin | 可选，证书登录状态 | `Y` \| `N` | --     |
 
-### 非对称解密
+### 2.25 非对称解密
 
 非对称解密，返回解密字符串
 
@@ -676,7 +676,7 @@ type AsymmetricDecryption = (
 | ---- | ---------------- | -------- | ------ |
 | Data | 必填，待解密原文 | `String` | --     |
 
-### SM4对称加密
+### 2.26 SM4对称加密
 
 SM4对称加密，传入curCert时使用该证书，返回加密字符串，加密密钥
 
@@ -705,7 +705,7 @@ type Sm4Encryption = (params: {
 | Data   | 加密密文       | `String` |
 | KeyB64 | Base64对称密钥 | `String` |
 
-### SM4对称解密
+### 2.27 SM4对称解密
 
 SM4对称解密，返回解密字符串
 
@@ -729,7 +729,7 @@ type Sm4Decryption = (params: {
 | Data   | 必填，待解密原文     | `String` | --     |
 | KeyB64 | 必填，Base64对称密钥 | `String` | --     |
 
-### 获取印章列表
+### 2.28 获取印章列表
 
 获取印章列表，传入curCert时使用该证书，可获取印章SealId
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gws-client",
-  "version": "0.6.4",
+  "version": "1.0.0",
   "type": "module",
   "module": "dist/index.es.js",
   "main": "dist/index.cjs.js",