@wecom/crypto - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

lib/index.d.ts

@@ -31,1 +31,21 @@ /// <reference types="node" />
 export declare function encrypt(encodingAESKey: string, message: string, id: string, random?: Buffer): string;
+export interface GetJsApiSignatureOptions {
+    /** 当前页面的 URL */
+    url: string;
+    /** 用于签名的 jsapi ticket */
+    ticket: string;
+    /** 生成签名的随机串 */
+    nonceStr?: string;
+    /** 生成签名的时间戳 */
+    timestamp?: number | string;
+}
+/**
+ * 获取 JSAPI 签名
+ *
+ * @param options 签名相关参数
+ */
+export declare function getJsApiSignature(options: GetJsApiSignatureOptions): {
+    timestamp: string | number;
+    nonceStr: string;
+    signature: string;
+};

lib/index.js

@@ -70,2 +70,16 @@ 'use strict';
 /**
+ * 获取 JSAPI 签名
+ *
+ * @param options 签名相关参数
+ */
+function getJsApiSignature(options) {
+    const { url, ticket } = options;
+    const nonceStr = options.nonceStr || Math.random().toString(36).slice(2);
+    const timestamp = options.timestamp || Math.floor(Date.now() / 1000);
+    const signature = crypto.createHash('sha1')
+        .update(`jsapi_ticket=${ticket}&noncestr=${nonceStr}&timestamp=${timestamp}&url=${url}`)
+        .digest('hex');
+    return { timestamp, nonceStr, signature };
+}
+/**
  * @param data
@@ -107,2 +121,3 @@ */
 exports.encrypt = encrypt;
+exports.getJsApiSignature = getJsApiSignature;
 exports.getSignature = getSignature;

package.json

 {
   "name": "@wecom/crypto",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "license": "MIT",
@@ -5,0 +5,0 @@ "main": "./lib/index.js",

README.md

 # @wecom/crypto
 
-企业微信回调加解密库，详见企业微信 API 文档 [加解密方案说明](https://open.work.weixin.qq.com/api/doc/90001/90148/91144)。
+企业微信加解密库，详见企业微信 API 文档 [加解密方案说明](https://work.weixin.qq.com/api/doc/90001/90148/91144) 和 [JS-SDK使用权限签名算法](https://work.weixin.qq.com/api/doc/90000/90136/90506)。
 
@@ -45,1 +45,11 @@ ## 使用
 ```
+
+### 获取 JS-SDK 签名
+
+```typescript
+import { getJsApiSignature } from '@wecom/crypto'
+
+const { timestamp, nonceStr, signature } = getJsApiSignature({ url, ticket });
+
+console.log({ timestamp, nonceStr, signature });
+```

No alert changes

Improved metrics

Total package byte prevSize

10433

23.09%

Lines of code

279

21.3%

Number of lines in readme file

55

22.22%

No dependency changes