@syfei49/mini-dynamic-renderer 1.0.0

package/README.md

@@ -0,0 +1,102 @@
+# @syfei49/mini-dynamic-renderer
+
+微信小程序对话接口动态渲染 SDK（v1.0.0 测试版）。
+
+引入后自动注册 `wx.request` 拦截器；当匹配的接口返回成功（`statusCode === 200`）时，在当前页面弹出 `hello world` 测试弹窗。
+
+## 安装
+
+```bash
+cd your-miniprogram-project
+npm install @syfei49/mini-dynamic-renderer
+```
+
+## 接入
+
+### 1. 在 `app.js` 顶部引入（自动注册拦截器）
+
+```javascript
+require('@syfei49/mini-dynamic-renderer');
+```
+
+### 2. 微信开发者工具构建 npm
+
+打开微信开发者工具 → **工具** → **构建 npm**
+
+### 3. 正常发起请求即可触发弹窗
+
+```javascript
+wx.request({
+  url: 'https://your-domain.com/api/chat',
+  method: 'POST',
+  data: { query: '你好' },
+  success(res) {
+    // 原有业务逻辑不变
+  }
+});
+```
+
+## 配置（可选）
+
+如需自定义拦截规则，可在 `app.js` 中显式初始化：
+
+```javascript
+const sdk = require('@syfei49/mini-dynamic-renderer');
+
+sdk.init({
+  // URL 匹配规则：字符串为包含匹配，也支持 RegExp，'*' 表示全部
+  urlPatterns: ['/api/chat'],
+  debug: true
+});
+```
+
+### 配置项
+
+| 字段 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| `urlPatterns` | `Array<string\|RegExp>` | `['*']` | 需要拦截的 URL 规则 |
+| `debug` | `boolean` | `false` | 是否输出调试日志 |
+
+## API
+
+| 方法 | 说明 |
+|------|------|
+| `init(config?)` | 初始化并注册拦截器 |
+| `getConfig()` | 获取当前配置 |
+| `isInitialized()` | 是否已初始化 |
+| `uninstall()` | 卸载拦截器，恢复原始 `wx.request` |
+| `parseRenderConfig(data)` | 解析响应中的渲染配置（预留） |
+
+## 发布到 npm
+
+在包根目录 `code/` 下执行：
+
+```bash
+# 1. 确认已登录
+npm whoami
+
+# 2. 确认 registry
+npm config get registry
+# 应为 https://registry.npmjs.org/
+
+# 3. 检查包名是否可用（404 表示可用）
+npm view @syfei49/mini-dynamic-renderer
+
+# 4. 预览将要发布的文件
+npm pack --dry-run
+
+# 5. 正式发布（作用域包首次需 public）
+npm publish --access public
+```
+
+后续版本更新：
+
+```bash
+npm version patch   # 或 minor / major
+npm publish --access public
+```
+
+## 版本说明
+
+- **v1.0.0**：拦截 `wx.request` 成功响应，弹出 `hello world` 测试弹窗
+- 后续版本将支持根据后端 `renderConfig` 动态渲染图片上传、文本等组件

package/index.js

@@ -0,0 +1,14 @@
+var initModule = require('./src/init');
+var interceptor = require('./src/interceptor');
+var handler = require('./src/handler');
+
+module.exports = {
+  version: '1.0.0',
+  init: initModule.init,
+  getConfig: initModule.getConfig,
+  isInitialized: initModule.isInitialized,
+  uninstall: interceptor.uninstallInterceptor,
+  parseRenderConfig: handler.parseRenderConfig
+};
+
+initModule.init();

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@syfei49/mini-dynamic-renderer",
+  "version": "1.0.0",
+  "description": "微信小程序对话接口动态渲染 SDK",
+  "main": "index.js",
+  "miniprogram": ".",
+  "files": [
+    "index.js",
+    "src"
+  ],
+  "keywords": [
+    "wechat",
+    "miniprogram",
+    "dynamic-renderer"
+  ],
+  "author": "syfei49",
+  "license": "MIT"
+}

package/src/handler.js

@@ -0,0 +1,49 @@
+/**
+ * 从响应数据中解析渲染配置（预留，供后续版本使用）
+ * @param {*} data - 接口返回的 data 字段
+ * @returns {Object|null}
+ */
+function parseRenderConfig(data) {
+  if (!data || typeof data !== 'object') {
+    return null;
+  }
+
+  if (data.renderConfig && typeof data.renderConfig === 'object') {
+    return data.renderConfig;
+  }
+
+  if (data.type) {
+    return data;
+  }
+
+  return null;
+}
+
+/**
+ * v1.0.0: 拦截成功后弹出 hello world 测试弹窗
+ * @param {Object} res - wx.request success 回调的响应对象
+ * @param {Object} requestOptions - 原始 wx.request 入参
+ * @param {Object} config - SDK 配置
+ */
+function handleResponse(res, requestOptions, config) {
+  var renderConfig = parseRenderConfig(res.data);
+
+  if (config.debug) {
+    console.log('[mini-dynamic-renderer] intercepted:', requestOptions.url, res.data);
+  }
+
+  wx.showModal({
+    title: 'mini-dynamic-renderer',
+    content: 'hello world',
+    showCancel: false
+  });
+
+  if (renderConfig && config.debug) {
+    console.log('[mini-dynamic-renderer] renderConfig:', renderConfig);
+  }
+}
+
+module.exports = {
+  parseRenderConfig: parseRenderConfig,
+  handleResponse: handleResponse
+};

package/src/init.js

@@ -0,0 +1,57 @@
+var interceptor = require('./interceptor');
+
+var currentConfig = null;
+var initialized = false;
+
+/**
+ * 合并用户配置与默认配置
+ * @param {Object} userConfig
+ * @returns {Object}
+ */
+function mergeConfig(userConfig) {
+  var base = interceptor.DEFAULT_CONFIG;
+  var config = userConfig || {};
+
+  return {
+    urlPatterns: config.urlPatterns || base.urlPatterns,
+    debug: typeof config.debug === 'boolean' ? config.debug : base.debug
+  };
+}
+
+/**
+ * 初始化 SDK，注册 wx.request 拦截器
+ * @param {Object} [userConfig]
+ * @param {Array<string|RegExp>} [userConfig.urlPatterns] - URL 匹配规则，默认 ['*'] 匹配全部
+ * @param {boolean} [userConfig.debug] - 是否输出调试日志
+ * @returns {Object} 当前配置
+ */
+function init(userConfig) {
+  if (initialized && !userConfig) {
+    return currentConfig;
+  }
+
+  if (initialized && userConfig) {
+    interceptor.uninstallInterceptor();
+    initialized = false;
+  }
+
+  currentConfig = mergeConfig(userConfig);
+  interceptor.installInterceptor(currentConfig);
+  initialized = true;
+
+  if (currentConfig.debug) {
+    console.log('[mini-dynamic-renderer] initialized', currentConfig);
+  }
+
+  return currentConfig;
+}
+
+module.exports = {
+  init: init,
+  getConfig: function () {
+    return currentConfig;
+  },
+  isInitialized: function () {
+    return initialized;
+  }
+};

package/src/interceptor.js

@@ -0,0 +1,104 @@
+var handler = require('./handler');
+
+var originalRequest = null;
+var installed = false;
+
+var DEFAULT_CONFIG = {
+  urlPatterns: ['*'],
+  debug: false
+};
+
+/**
+ * 判断 URL 是否匹配配置的模式
+ * @param {string} url
+ * @param {Array<string|RegExp>} patterns
+ * @returns {boolean}
+ */
+function matchUrl(url, patterns) {
+  if (!patterns || patterns.length === 0) {
+    return true;
+  }
+
+  for (var i = 0; i < patterns.length; i++) {
+    var pattern = patterns[i];
+
+    if (pattern === '*') {
+      return true;
+    }
+
+    if (pattern instanceof RegExp) {
+      if (pattern.test(url)) {
+        return true;
+      }
+      continue;
+    }
+
+    if (typeof pattern === 'string' && url.indexOf(pattern) !== -1) {
+      return true;
+    }
+  }
+
+  return false;
+}
+
+/**
+ * 安装 wx.request 拦截器
+ * @param {Object} config
+ */
+function installInterceptor(config) {
+  if (installed) {
+    return;
+  }
+
+  if (typeof wx === 'undefined' || typeof wx.request !== 'function') {
+    console.warn('[mini-dynamic-renderer] wx.request is not available, skip interceptor install');
+    return;
+  }
+
+  originalRequest = wx.request;
+  installed = true;
+
+  wx.request = function (options) {
+    var userSuccess = options.success;
+    var mergedConfig = config || DEFAULT_CONFIG;
+
+    options.success = function (res) {
+      if (res && res.statusCode === 200 && matchUrl(options.url || '', mergedConfig.urlPatterns)) {
+        try {
+          handler.handleResponse(res, options, mergedConfig);
+        } catch (err) {
+          console.error('[mini-dynamic-renderer] handleResponse error:', err);
+        }
+      }
+
+      if (typeof userSuccess === 'function') {
+        userSuccess(res);
+      }
+    };
+
+    return originalRequest.call(wx, options);
+  };
+}
+
+/**
+ * 卸载拦截器，恢复原始 wx.request
+ */
+function uninstallInterceptor() {
+  if (!installed || !originalRequest) {
+    return;
+  }
+
+  wx.request = originalRequest;
+  originalRequest = null;
+  installed = false;
+}
+
+module.exports = {
+  DEFAULT_CONFIG: DEFAULT_CONFIG,
+  matchUrl: matchUrl,
+  installInterceptor: installInterceptor,
+  uninstallInterceptor: uninstallInterceptor,
+  isInstalled: function () {
+    return installed;
+  }
+};