wechat-offiaccount 0.2.1 → 0.3.0

package/CHANGELOG

@@ -23,4 +23,10 @@ v0.2.1:
       - 问题修复
         1、补充微信小程序相关types
             * wx.openPrivacyContract()
-            * wx.getPrivacySetting()
+            * wx.getPrivacySetting()
+v0.3.0:
+    date:2026-03-07
+    changes:
+      - 新增功能
+        1、微信公众号辅助调试服务器部分功能暴露API接口
+            * JsApiSignature 微信sdk验证签名

package/README.md

@@ -132,6 +132,20 @@ module.exports = config
 
 然后需要启动后部署到外网可以访问的服务器上，最后就可以作为微信公众号后台服务器使用，然后进行各种测试学习了。
 
+### 调试服务器API接口
+
+> v0.3.0 新增
+
+为了更好的提供服务，对部分可能需要二次开发的接口（开发服务器）进行了封装，比如：
+
+一、微信sdk验证签名接口
+
+```js
+const { JsApiSignature } = require("wechat-offiaccount/nodejs/index")
+```
+
+具体使用参考 [./nodejs/server.js](./nodejs/server.js)
+
 ## 版权
 
 MIT License

package/bin/run

@@ -3,13 +3,13 @@
 'use strict';
 
 process.title = 'offiaccount-cli'
-const { log } = require('devby')
+const { log } = require('../nodejs/utils/log')
 const path = require('path')
 
 const jsonfile = require('../package.json')
 
 // 命令行传递的参数
-const parsed = require("devby").options({
+const parsed = require("../nodejs/utils/options")({
     "-c": "--config"
 }, process.argv)
 
@@ -19,7 +19,7 @@ if (parsed.config && parsed.config.length > 0) {
     let configFile = require(path.join(process.cwd(), parsed.config[0]))
 
     // 启动
-    require('../nodejs/index')(configFile)
+    require('../nodejs/server')(configFile)
 
 } else {
     log(`

package/nodejs/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 微信sdk验证签名
+ * @param url 
+ * @param config 
+ */
+export function JsApiSignature(url: string, config: any): Promise<any>

package/nodejs/index.js

@@ -1,32 +1,5 @@
-const express = require('express')
-const path = require('path')
-const auth = require('./libs/auth')
-const JsApiSignature = require('./libs/JsApiSignature')
-const { log, error, network } = require('devby')
-const jsonfile = require('../package.json')
 
-module.exports = (config) => {
-    const app = express()
-
-    // 静态资源
-    app.use(express.static(path.resolve(__dirname, '../')))
-
-    // 获取微信签名
-    app.get("/JsApiSignature", JsApiSignature(config))
-
-    /**
-     * 我们这里使用测试号，通过”接口配置信息“来验证
-     * https://mp.weixin.qq.com/debug/cgi-bin/sandboxinfo?action=showinfo&t=sandbox/index
-     */
-    app.use(auth(config))
-
-    app.listen(config.port, () => {
-
-        let ipv4 = network().IPv4[0]?.address || '127.0.0.1'
-
-        log(`${jsonfile.name}@v${jsonfile.version}
-微信公众号辅助调试服务器启动成功
-        `)
-        error(`访问 http://${ipv4}:${config.port}`)
-    })
-}
+/**
+ * 微信sdk验证签名
+ */
+exports.JsApiSignature = require('./libs/JsApiSignature')

package/nodejs/libs/JsApiSignature.js

@@ -1,17 +1,16 @@
 const sha1 = require('sha1')
 
-module.exports = (config) => {
-    return (req, res) => {
+module.exports = (url, config) => {
+    const { appID } = config
 
-        const { url } = req.query
-        const { appID } = config
+    /**
+     * 生成js-sdk的签名
+     * 1、组合参与签名的四个参数：jsapi_ticket（临时票据）、noncestr（随机字符串）、timestamp（时间戳）、url（当前服务器地址）
+     * 2、将其进行字典序排序，以‘&’拼接在一起
+     * 3、进行sha1加密，最终生成signature
+     */
 
-        /**
-         * 生成js-sdk的签名
-         * 1、组合参与签名的四个参数：jsapi_ticket（临时票据）、noncestr（随机字符串）、timestamp（时间戳）、url（当前服务器地址）
-         * 2、将其进行字典序排序，以‘&’拼接在一起
-         * 3、进行sha1加密，最终生成signature
-         */
+    return new Promise()((resolve, reject) => {
 
         require('./getJsapiTicket')(config).then(jsapi_ticket => {
 
@@ -32,16 +31,14 @@ module.exports = (config) => {
             // sha1加密
             const sha1Str = sha1(str)
 
-            res.setHeader('Access-Control-Allow-Origin', '*')
-            res.send(JSON.stringify({
+            resolve({
                 appId: appID,
                 timestamp,
                 nonceStr: noncestr,
                 signature: sha1Str
-            }))
-
+            })
         })
 
-    }
+    })
 
 }

package/nodejs/libs/getAccessToken.js

@@ -1,4 +1,4 @@
-const { get } = require('devby')
+const { get } = require('../utils/remote')
 const fs = require('fs')
 const path = require('path')
 

package/nodejs/libs/getJsapiTicket.js

@@ -1,4 +1,4 @@
-const { get } = require('devby')
+const { get } = require('../utils/remote')
 const fs = require('fs')
 const path = require('path')
 

package/nodejs/server.js

@@ -0,0 +1,43 @@
+const express = require('express')
+const path = require('path')
+const auth = require('./libs/auth')
+const JsApiSignature = require('./libs/JsApiSignature')
+const { log, error } = require('./utils/log')
+const network = require('./utils/network')
+const jsonfile = require('../package.json')
+
+module.exports = (config) => {
+    const app = express()
+
+    // 静态资源
+    app.use(express.static(path.resolve(__dirname, '../')))
+
+    // 获取微信签名
+    app.get("/JsApiSignature", function (req, res) {
+        const { url } = req.query
+
+        JsApiSignature(url, config).then(data => {
+
+            res.setHeader('Access-Control-Allow-Origin', '*')
+            res.send(JSON.stringify(data))
+
+        })
+
+    })
+
+    /**
+     * 我们这里使用测试号，通过”接口配置信息“来验证
+     * https://mp.weixin.qq.com/debug/cgi-bin/sandboxinfo?action=showinfo&t=sandbox/index
+     */
+    app.use(auth(config))
+
+    app.listen(config.port, () => {
+
+        let ipv4 = network().IPv4[0]?.address || '127.0.0.1'
+
+        log(`${jsonfile.name}@v${jsonfile.version}
+微信公众号辅助调试服务器启动成功
+        `)
+        error(`访问 http://${ipv4}:${config.port}`)
+    })
+}

package/nodejs/utils/log.js

@@ -0,0 +1,14 @@
+// 日志
+exports.log = function (txt) {
+    console.log("\x1B[34m" + txt + "\x1B[39m");
+};
+
+// 警告
+exports.warn = function (txt) {
+    console.log("\x1B[33m" + txt + "\x1B[39m");
+};
+
+// 错误
+exports.error = function (txt) {
+    console.log("\x1B[35m" + txt + "\x1B[39m");
+};

package/nodejs/utils/network.js

@@ -0,0 +1,27 @@
+module.exports = function () {
+
+    let infomation = {
+        IPv4: [],
+        IPv6: []
+    };
+
+    let networks = require('os').networkInterfaces()
+    for (let typeName in networks) {
+        let network = networks[typeName]
+        for (let index = 0; index < network.length; index++) {
+            if (network[index].family == 'IPv4' && network[index].address != '127.0.0.1') {
+                infomation.IPv4.push({
+                    address: network[index].address,
+                    mac: network[index].mac
+                });
+            } else if (network[index].family == 'IPv6' && network[index].address != '::1') {
+                infomation.IPv6.push({
+                    address: network[index].address,
+                    mac: network[index].mac
+                });
+            }
+        }
+    }
+
+    return infomation;
+};

package/nodejs/utils/options.js

@@ -0,0 +1,49 @@
+/**
+ * 
+ * 命令行参数解析
+ * 
+ * @param {JSON} config 命令参数缩小到全写的映射
+ * @param {Array} argv 需要判断类型的值
+ * 
+ * @returns {JSON} 返回整理后的参数
+ * 
+ */
+module.exports = function (config, argv) {
+
+  let resultConfig = {
+    __terminal__: []
+  }, flag = null;
+  for (let i = 2; i < argv.length; i++) {
+
+    // 如果是新的配置
+    if (/^--[0-9a-zA-Z]+$/.test(argv[i]) || /^-[0-9a-zA-Z]$/.test(argv[i])) {
+      let key = argv[i];
+
+      // 如果是缩写，需要映射
+      if (key.length == 2) {
+        key = config[key];
+
+        // 如果是错误缩写
+        if (!key) {
+          flag = null;
+          continue;
+        }
+      }
+
+      flag = key.replace(/^--/, "");
+      resultConfig[flag] = [];
+    }
+
+    // 如果是普通的参数
+    else if (flag != null) {
+      resultConfig[flag].push(argv[i]);
+    }
+
+    else {
+      resultConfig.__terminal__.push(argv[i]);
+    }
+
+  }
+
+  return resultConfig;
+};

package/nodejs/utils/remote.js

@@ -0,0 +1,21 @@
+const https = require('https');
+const http = require('http');
+
+exports.get = function (url, options = {}) {
+    return new Promise((resolve, reject) => {
+
+        let handler = /^https/.test(url) ? https : http;
+
+        handler.get(url, res => {
+            res.on('data', (data) => {
+                if (options.json) {
+                    resolve(JSON.parse(data.toString('utf8')));
+                } else {
+                    resolve(data);
+                }
+            });
+        }).on('error', (e) => {
+            reject(e);
+        });
+    })
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wechat-offiaccount",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "微信公众号辅助调试服务器 + 微信官方js-sdk，支持typescript开发",
   "sideEffects": false,
   "main": "src/index.js",
@@ -29,11 +29,10 @@
   },
   "homepage": "https://github.com/oi-contrib/WeChat-offiaccount",
   "dependencies": {
-    "devby": "^0.4.6",
     "express": "^4.18.2",
     "sha1": "^1.1.1"
   },
   "devDependencies": {
-    "zdebug.js": "^0.2.0"
+    "zdebug.js": "^0.3.0"
   }
 }