feat: wechat

README.md

@@ -5,3 +5,4 @@
 - [`request-template`](packages/request-template) 基础请求封装
 - [`request-template/axios`](packages/axios) `axios` 版请求封装
 - [`request-template/vue3-hooks`](packages/vue3-hooks) `vue3 hooks` 式封装
+- [`request-template/wechat`](packages/wechat) `wechat` 版请求封装

jest.config.js

@@ -9,7 +9,7 @@ module.exports = {
       statements: 50,
     },
   },
-  collectCoverageFrom: ['packages/**/src/**.ts', '!**/packages/**/dist/**'],
+  collectCoverageFrom: ['packages/**/src/**.ts', '!**/packages/**/dist/**', '!**/packages/wechat/**'],
   transform: {
     '^.+\\.tsx?$': [
       'ts-jest',

package.json

@@ -73,6 +73,7 @@
     "fs-extra": "^10.1.0",
     "jest": "^29.2.1",
     "minimist": "^1.2.6",
+    "miniprogram-api-typings": "^3.6.0",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.7.1",
     "rimraf": "^3.0.2",

packages/wechat/README.md

@@ -0,0 +1,8 @@
+# 请求模版封装：微信版
+
+## 安装方法
+
+```
+npm intall @request-template/wechat
+```
+

packages/wechat/api-extractor.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../api-extractor.json",
+  "mainEntryPointFilePath": "./dist/packages/<unscopedPackageName>/src/index.d.ts",
+  "dtsRollup": {
+    "publicTrimmedFilePath": "./dist/request-template-vue3-hooks.d.ts"
+  }
+}

packages/wechat/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@request-template/wechat",
+  "version": "1.0.0",
+  "description": "请求模板封装-微信版",
+  "main": "dist/request-template-wechat.esm-bundler.js",
+  "types": "dist/request-template-wechat.d.ts",
+  "buildOptions": {
+    "filename": "request-template-wechat",
+    "formats": [
+      "esm-bundler",
+      "cjs"
+    ]
+  },
+  "sideEffects": false,
+  "files": [
+    "dist/*",
+    "CHANGELOG.md",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {},
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mengxinssfd/request-template.git"
+  },
+  "author": "DYH",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/mengxinssfd/request-template/issues"
+  },
+  "homepage": "https://github.com/mengxinssfd/request-template#readme",
+  "devDependencies": {
+    "axios": "^0.26.1",
+    "request-template": "^2.0.0"
+  },
+  "peerDependencies": {
+    "request-template": "^2.0.0"
+  }
+}

packages/wechat/src/WechatRequestTemplate.ts

@@ -0,0 +1,64 @@
+import { Context, CustomConfig, RequestTemplate } from 'request-template';
+
+export interface WechatCustomConfig extends CustomConfig {
+  loading?: boolean;
+  showSuccessMsg?: boolean;
+  successMsg?: string;
+}
+
+export class WechatRequestTemplate<
+  CC extends WechatCustomConfig = WechatCustomConfig,
+> extends RequestTemplate<CC> {
+  protected isCancel(value: any) {
+    return value?.errMsg === 'request:fail abort';
+  }
+
+  protected fetch(ctx) {
+    const baseConfig = this.globalConfigs.requestConfig;
+    const config = ctx.requestConfig;
+
+    const method = config.method || baseConfig.method;
+    return new Promise((resolve, reject) => {
+      const task = wx.request({
+        url: (config.baseURL || baseConfig.baseURL) + (config.url || baseConfig.url),
+        method,
+        data:
+          method === 'get'
+            ? { ...baseConfig.params, ...config.params }
+            : { ...baseConfig.data, ...config.data },
+        header: { ...baseConfig.headers, ...config.headers },
+        success: resolve,
+        fail: reject,
+      });
+      // 注册取消事件
+      this.registerCanceler(ctx, task.abort.bind(task));
+    }) as any;
+  }
+
+  // eslint-disable-next-line
+  protected handleCanceler(_ctx) {}
+
+  protected beforeRequest(ctx: Context<CC>) {
+    // 复用基础模板逻辑
+    super.beforeRequest(ctx);
+
+    // 未设置showSuccessMsg时，且非get请求则全部显示请求成功信息
+    if (ctx.requestConfig.method !== 'get' && ctx.customConfig.showSuccessMsg === undefined) {
+      ctx.customConfig.showSuccessMsg = true;
+    }
+
+    // 全局开启loading
+    if (ctx.customConfig.loading) {
+      wx.showLoading({ title: 'LOADING...' });
+    }
+  }
+
+  // 关闭loading
+  protected afterRequest(ctx) {
+    super.afterRequest(ctx); // 复用基础模板逻辑
+    // 加个定时器避免请求太快，loading一闪而过
+    setTimeout(() => {
+      wx.hideLoading();
+    }, 200);
+  }
+}

packages/wechat/src/index.ts

@@ -0,0 +1 @@
+export * from './WechatRequestTemplate';

tsconfig.json

@@ -31,7 +31,11 @@
     "paths": {
       "request-template": ["packages/request-template/src"],
       "@request-template/*": ["packages/*/src"]
-    }
+    },
+    // request-template-wechat 微信wx类型声明
+    // 加上了微信的类型声明文件后，jest的全局声明就失效了，所以加上jest
+    "types": ["miniprogram-api-typings", "jest"],
+    "skipLibCheck": true
   },
   "include": ["packages/*/src", "packages/*/__tests__"]
 }