@ningboyz/wxmp 1.0.23 → 1.0.25

package/README.md

@@ -1,6 +1,6 @@
 # @ningboyz/wxmp
 
-微信小程序请求库。目录、模块类和初始化方式沿用 PC 端 `@ningboyz/apis` 的结构，底层通过 `wx.request` 发送请求。
+微信小程序请求库。目录、模块类和初始化方式沿用 PC 端 `@ningboyz/apis` 的结构，普通请求通过 `wx.request` 发送，文件上传通过 `wx.uploadFile` 发送。
 
 ```text
 src/
@@ -9,7 +9,7 @@ src/
     index.ts           参数、类型和模块导出
     types.ts           请求配置与拦截器类型
     wx.ts              微信请求底层
-    core/              登录、单位接口
+    core/              登录、单位、附件上传接口
     noti/              公告接口
     wtui/              启动配置、公钥接口
 ```
@@ -64,6 +64,40 @@ await Request.wtui.envr.startkey();
 
 业务统一通过 `Request.core`、`Request.noti`、`Request.wtui` 调用，由 `Request.createRequest` 完成模块初始化。
 
+## 上传附件
+
+先完成初始化，再把微信选择文件得到的本地路径传给 `uploaddb`：
+
+```ts
+import Request, { TCorePathUploaddbQuerys } from "@ningboyz/wxmp";
+
+wx.chooseMessageFile({
+  count: 1,
+  type: "file",
+  async success(res) {
+    try {
+      const result = await Request.core.path.uploaddb(
+        new TCorePathUploaddbQuerys(),
+        {
+          filePath: res.tempFiles[0].path,
+          name: "file" // 示例字段名，按后端接收文件的字段名填写
+        }
+      );
+      if (!result.ONSTATUS) throw new Error(result.ERORMEMO);
+      console.log(result.LISTDATA);
+    } catch (error) {
+      console.error("上传失败", error);
+    }
+  }
+});
+```
+
+每次上传一个文件，多文件需逐个调用。上传参数可增加 `formData` 传额外表单字段；如需传 JSON，可使用 `formData: { params: JSON.stringify(data) }`。
+`txupload` 按后端要求填写，参数类默认值与 Web 端一致为 `-1`。微信后台需配置上传接口的 `uploadFile` 合法域名。
+
+上传沿用鉴权、超时和请求/响应拦截器，请求拦截器中的 `data` 是额外表单字段。请保留其表单结构，文件本身由 `filePath` 和 `name` 指定。
+上传的 `Content-Type` 和 boundary 由微信生成，通用拦截器设置的 `Content-Type` 会被移除。服务器返回的 JSON 字符串解析后再进入统一响应处理。
+
 ## 构建
 
 ```bash

package/es/index.js

@@ -1,11 +1,11 @@
 import { CoreRequest as t } from "./packages/core/index.js";
 import { NotiRequest as r } from "./packages/noti/index.js";
 import { WtuiRequest as o } from "./packages/wtui/index.js";
-import { REQUEST_TIMEOUT_MILLISECONDS as d, TWxConfig as n } from "./packages/types.js";
+import { REQUEST_TIMEOUT_MILLISECONDS as p, TWxConfig as C } from "./packages/types.js";
 import { WxRequestError as c } from "./packages/wx.js";
-import { TCoreUnitSelectdbQuerys as C, TCoreUserDetailddCardQuerys as R, TCoreUserUpdatedbQuerys as q, TWxLoginParams as Q } from "./packages/core/types.js";
-import { TNotiMainDetaildbQuerys as l, TNotiMainGet4NotiQuerys as w } from "./packages/noti/types.js";
-class m {
+import { TCorePathUploaddbQuerys as x, TCoreUnitSelectdbQuerys as Q, TCoreUserDetailddCardQuerys as f, TCoreUserUpdateclQuerys as l, TCoreUserUpdatedbQuerys as y, TWxLoginParams as R } from "./packages/core/types.js";
+import { TNotiMainDetaildbQuerys as w, TNotiMainGet4NotiQuerys as E } from "./packages/noti/types.js";
+class T {
   static core;
   static noti;
   static wtui;
@@ -16,16 +16,18 @@ class m {
 export {
   t as CoreRequest,
   r as NotiRequest,
-  d as REQUEST_TIMEOUT_MILLISECONDS,
-  m as Request,
-  C as TCoreUnitSelectdbQuerys,
-  R as TCoreUserDetailddCardQuerys,
-  q as TCoreUserUpdatedbQuerys,
-  l as TNotiMainDetaildbQuerys,
-  w as TNotiMainGet4NotiQuerys,
-  n as TWxConfig,
-  Q as TWxLoginParams,
+  p as REQUEST_TIMEOUT_MILLISECONDS,
+  T as Request,
+  x as TCorePathUploaddbQuerys,
+  Q as TCoreUnitSelectdbQuerys,
+  f as TCoreUserDetailddCardQuerys,
+  l as TCoreUserUpdateclQuerys,
+  y as TCoreUserUpdatedbQuerys,
+  w as TNotiMainDetaildbQuerys,
+  E as TNotiMainGet4NotiQuerys,
+  C as TWxConfig,
+  R as TWxLoginParams,
   o as WtuiRequest,
   c as WxRequestError,
-  m as default
+  T as default
 };

package/es/packages/core/index.d.ts

@@ -1,9 +1,11 @@
 import { IWxConfig } from '../types';
 import { default as UserRequest } from './user';
 import { default as UnitRequest } from './unit';
+import { default as PathRequest } from './path';
 declare class CoreRequest {
     user: UserRequest;
     unit: UnitRequest;
+    path: PathRequest;
     constructor(config: IWxConfig);
 }
 export default CoreRequest;

package/es/packages/core/index.js

@@ -1,15 +1,17 @@
 import { createWxRequest as r } from "../wx.js";
 import s from "./user.js";
 import o from "./unit.js";
-class c {
+import u from "./path.js";
+class h {
   user;
   unit;
-  constructor(t) {
-    const e = r(t);
-    this.user = new s(e), this.unit = new o(e);
+  path;
+  constructor(e) {
+    const t = r(e);
+    this.user = new s(t), this.unit = new o(t), this.path = new u(t);
   }
 }
 export {
-  c as CoreRequest,
-  c as default
+  h as CoreRequest,
+  h as default
 };

package/es/packages/core/path.d.ts

@@ -0,0 +1,16 @@
+import { TCore } from '@ningboyz/types';
+import { WxRequest } from '../wx';
+import { IWxUploadFileParams } from '../types';
+import { ICorePathUploaddbQuerys } from './types';
+declare class PathRequest {
+    private wxRequest;
+    constructor(wxRequest: WxRequest);
+    /**
+     * 上传附件
+     * @param querys
+     * @param params 本地文件路径、文件字段名及额外表单字段
+     * @returns
+     */
+    uploaddb(querys: ICorePathUploaddbQuerys, params: IWxUploadFileParams): Promise<import('@ningboyz/types/es/response/IResponse.js').IResponse<TCore.IPathResponse[]>>;
+}
+export default PathRequest;

package/es/packages/core/path.js

@@ -0,0 +1,18 @@
+class u {
+  wxRequest;
+  constructor(t) {
+    this.wxRequest = t;
+  }
+  /**
+   * 上传附件
+   * @param querys
+   * @param params 本地文件路径、文件字段名及额外表单字段
+   * @returns
+   */
+  uploaddb(t, e) {
+    return this.wxRequest.postFile("/gapi/core/tpath/uploaddb", t, e);
+  }
+}
+export {
+  u as default
+};

package/es/packages/core/types.d.ts

@@ -21,6 +21,12 @@ export interface ICoreUserDetailddCardQuerys {
 export declare class TCoreUserDetailddCardQuerys implements ICoreUserDetailddCardQuerys {
     usermain: number;
 }
+export interface ICoreUserUpdateclQuerys {
+    entityid: string;
+}
+export declare class TCoreUserUpdateclQuerys implements ICoreUserUpdateclQuerys {
+    entityid: string;
+}
 /** ========== unit ========== */
 export interface ICoreUnitSelectdbQuerys {
     unitmain: number;
@@ -30,3 +36,10 @@ export declare class TCoreUnitSelectdbQuerys implements ICoreUnitSelectdbQuerys
     unitmain: number;
     queuesby: string;
 }
+/** ========== path ========== */
+export interface ICorePathUploaddbQuerys {
+    txupload: number;
+}
+export declare class TCorePathUploaddbQuerys implements ICorePathUploaddbQuerys {
+    txupload: number;
+}

package/es/packages/core/types.js

@@ -10,12 +10,20 @@ class r {
   usermain = -1;
 }
 class d {
+  entityid = "";
+}
+class t {
   unitmain = -1;
   queuesby = "-1";
 }
+class o {
+  txupload = -1;
+}
 export {
-  d as TCoreUnitSelectdbQuerys,
+  o as TCorePathUploaddbQuerys,
+  t as TCoreUnitSelectdbQuerys,
   r as TCoreUserDetailddCardQuerys,
+  d as TCoreUserUpdateclQuerys,
   a as TCoreUserUpdatedbQuerys,
   s as TWxLoginParams
 };

package/es/packages/core/user.d.ts

@@ -1,6 +1,6 @@
 import { TCore } from '@ningboyz/types';
 import { WxRequest } from '../wx';
-import { ICoreUserDetailddCardQuerys, ICoreUserUpdatedbQuerys, IWxLoginParams } from './types';
+import { ICoreUserDetailddCardQuerys, ICoreUserUpdateclQuerys, ICoreUserUpdatedbQuerys, IWxLoginParams } from './types';
 declare class UserRequest {
     private wxRequest;
     constructor(wxRequest: WxRequest);
@@ -26,5 +26,11 @@ declare class UserRequest {
     updatedb(querys: ICoreUserUpdatedbQuerys, params: object): Promise<import('@ningboyz/types/es/response/IResponse.js').IResponse<TCore.IUserResponse[]>>;
     /** 获取用户详情（房产） */
     detailddCard(querys: ICoreUserDetailddCardQuerys, params: object): Promise<import('@ningboyz/types/es/response/IResponse.js').IResponse<TCore.IUserResponse[]>>;
+    /**
+     * 更新用户头像
+     * @param params
+     * @returns
+     */
+    updatecl(querys: ICoreUserUpdateclQuerys, params: object): Promise<import('@ningboyz/types/es/response/IResponse.js').IResponse<TCore.IUserResponse[]>>;
 }
 export default UserRequest;

package/es/packages/core/user.js

@@ -33,6 +33,14 @@ class r {
   detailddCard(e, t) {
     return this.wxRequest.post("/gapi/core/tuser/detaildd", e, t);
   }
+  /**
+   * 更新用户头像
+   * @param params
+   * @returns
+   */
+  updatecl(e, t) {
+    return this.wxRequest.post("/gapi/core/tuser/coverurl/updatedb", e, t);
+  }
 }
 export {
   r as default

package/es/packages/types.d.ts

@@ -32,6 +32,15 @@ export interface IWxRequestOptions {
     headers?: Record<string, string>;
     contentType?: string;
 }
+/** 微信小程序单文件上传参数。 */
+export interface IWxUploadFileParams {
+    /** 选择文件后得到的本地临时路径。 */
+    filePath: string;
+    /** 后端接收文件的表单字段名。 */
+    name: string;
+    /** 额外表单字段；对象或数组请先 JSON.stringify。 */
+    formData?: Record<string, string | number | boolean>;
+}
 export type TWxInterceptorsRequest = (request: IWxInternalRequestConfig) => IWxInternalRequestConfig | Promise<IWxInternalRequestConfig>;
 export type TWxInterceptorsResponse = (response: IWxResponse) => IWxResponse | Promise<IWxResponse>;
 export interface IWxConfig {

package/es/packages/wx.d.ts

@@ -1,5 +1,5 @@
 import { TResp } from '@ningboyz/types';
-import { IWxConfig, IWxInternalRequestConfig, IWxRequestOptions } from './types';
+import { IWxConfig, IWxInternalRequestConfig, IWxRequestOptions, IWxUploadFileParams } from './types';
 /** 网络和 HTTP 异常。HTTP 错误保留状态码、响应体及请求配置。 */
 declare class WxRequestError extends Error {
     readonly config: IWxInternalRequestConfig;
@@ -18,6 +18,8 @@ declare class WxRequest {
      * JSON 提交，对应 apis 里的 postJson。国密加密接口请走此方法。
      */
     postJson<T>(url: string, querys?: object, params?: object, headers?: Record<string, string>): Promise<TResp.IResponse<T>>;
+    /** 单文件上传。data 拦截的是额外表单字段，multipart boundary 由微信生成。 */
+    postFile<T>(url: string, querys: object | undefined, params: IWxUploadFileParams, headers?: Record<string, string>): Promise<TResp.IResponse<T>>;
     get<T>(url: string, querys?: object, headers?: Record<string, string>): Promise<TResp.IResponse<T>>;
     request<T>(url: string, options: IWxRequestOptions): Promise<TResp.IResponse<T>>;
     private send;

package/es/packages/wx.js

@@ -1,62 +1,96 @@
 import { Const as T } from "@ningboyz/types";
 import n from "lodash";
-import { REQUEST_TIMEOUT_MILLISECONDS as R } from "./types.js";
-const E = 200, m = 300, h = "application/json", y = "application/x-www-form-urlencoded";
+import { REQUEST_TIMEOUT_MILLISECONDS as p } from "./types.js";
+const m = 200, R = 300, w = "application/json", y = "application/x-www-form-urlencoded";
 class u extends Error {
-  constructor(e, s, t, i) {
-    super(e), this.config = s, this.statusCode = t, this.data = i, this.name = "WxRequestError";
+  constructor(e, s, t, r) {
+    super(e), this.config = s, this.statusCode = t, this.data = r, this.name = "WxRequestError";
   }
 }
-class w {
+class C {
   constructor(e) {
     this.config = e;
   }
   /**
    * 表单提交。body 字段名 params，值是 JSON 字符串，对应 apis 里的 post。
    */
-  async post(e, s, t, i) {
-    const r = n.isNil(t) ? void 0 : { params: JSON.stringify(t) }, o = this.createHeader(n.isNil(t) ? void 0 : y, i);
-    return this.send("POST", e, s, r, o);
+  async post(e, s, t, r) {
+    const i = n.isNil(t) ? void 0 : { params: JSON.stringify(t) }, o = this.createHeader(n.isNil(t) ? void 0 : y, r);
+    return this.send("POST", e, s, i, o);
   }
   /**
    * JSON 提交，对应 apis 里的 postJson。国密加密接口请走此方法。
    */
-  async postJson(e, s, t, i) {
-    const r = this.createHeader(h, i);
-    return this.send("POST", e, s, t, r);
+  async postJson(e, s, t, r) {
+    const i = this.createHeader(w, r);
+    return this.send("POST", e, s, t, i);
+  }
+  /** 单文件上传。data 拦截的是额外表单字段，multipart boundary 由微信生成。 */
+  async postFile(e, s, t, r) {
+    let i = {
+      url: e,
+      method: "POST",
+      querys: s,
+      data: t.formData,
+      header: this.createHeader(void 0, r)
+    };
+    this.config.interceptorsRequest && (i = await this.config.interceptorsRequest(i));
+    const o = Object.fromEntries(Object.entries(i.header).filter(([h]) => h.toLowerCase() !== "content-type"));
+    i = { ...i, header: o };
+    const c = this.createRequestUrl(i.url, i.querys), a = await new Promise((h, g) => {
+      this.getMiniProgramWx().uploadFile({
+        url: c,
+        filePath: t.filePath,
+        name: t.name,
+        formData: i.data,
+        header: o,
+        timeout: this.config.timeout ?? p,
+        success: h,
+        fail: (l) => g(new u(l.errMsg || "文件上传失败", i))
+      });
+    });
+    let d;
+    try {
+      d = JSON.parse(a.data);
+    } catch {
+      if (a.statusCode >= m && a.statusCode < R)
+        throw new u("文件上传响应不是有效的 JSON", i, a.statusCode, a.data);
+      d = a.data;
+    }
+    return this.handleResponse({ ...a, data: d }, i);
   }
   async get(e, s, t) {
-    const i = this.createHeader(void 0, t);
-    return this.send("GET", e, s, void 0, i);
+    const r = this.createHeader(void 0, t);
+    return this.send("GET", e, s, void 0, r);
   }
   async request(e, s) {
-    const t = s.contentType ?? (s.method === "GET" ? void 0 : h), i = this.createHeader(t, s.headers);
-    return this.send(s.method, e, s.querys, s.data, i);
+    const t = s.contentType ?? (s.method === "GET" ? void 0 : w), r = this.createHeader(t, s.headers);
+    return this.send(s.method, e, s.querys, s.data, r);
   }
-  async send(e, s, t, i, r) {
+  async send(e, s, t, r, i) {
     let o = {
       url: s,
       method: e,
       querys: t,
-      data: i,
-      header: r
+      data: r,
+      header: i
     };
     this.config.interceptorsRequest && (o = await this.config.interceptorsRequest(o));
-    const a = this.createRequestUrl(o.url, o.querys), d = this.config.timeout ?? R, f = await new Promise((g, l) => {
+    const c = this.createRequestUrl(o.url, o.querys), a = this.config.timeout ?? p, d = await new Promise((h, g) => {
       this.getMiniProgramWx().request({
-        url: a,
+        url: c,
         method: o.method,
         data: o.data,
         header: o.header,
-        timeout: d,
-        success: g,
-        fail: (p) => l(new u(p.errMsg || "网络请求失败", o))
+        timeout: a,
+        success: h,
+        fail: (l) => g(new u(l.errMsg || "网络请求失败", o))
       });
     });
-    return this.handleResponse(f, o);
+    return this.handleResponse(d, o);
   }
   async handleResponse(e, s) {
-    if (e.statusCode < E || e.statusCode >= m)
+    if (e.statusCode < m || e.statusCode >= R)
       throw this.tryHandleSessionExpired(e.data, e.statusCode), new u(`请求失败，状态码 ${e.statusCode}`, s, e.statusCode, e.data);
     let t = {
       data: e.data,
@@ -67,8 +101,8 @@ class w {
   }
   tryHandleSessionExpired(e, s) {
     if (!this.config.loseTokenState) return;
-    const t = this.config.sessionExpiredErrorKey || T.ErrorKey.CONST_ERROR_KEY_TO_会话过期, i = e !== null && typeof e == "object" ? e.ERRORKEY : void 0;
-    (s === 401 || i === t) && this.config.loseTokenState();
+    const t = this.config.sessionExpiredErrorKey || T.ErrorKey.CONST_ERROR_KEY_TO_会话过期, r = e !== null && typeof e == "object" ? e.ERRORKEY : void 0;
+    (s === 401 || r === t) && this.config.loseTokenState();
   }
   getMiniProgramWx() {
     const e = globalThis.wx;
@@ -77,11 +111,11 @@ class w {
     return e;
   }
   createRequestUrl(e, s) {
-    const t = this.config.baseURL.endsWith("/") ? this.config.baseURL.slice(0, -1) : this.config.baseURL, i = e.startsWith("/") ? e : `/${e}`, r = {
+    const t = this.config.baseURL.endsWith("/") ? this.config.baseURL.slice(0, -1) : this.config.baseURL, r = e.startsWith("/") ? e : `/${e}`, i = {
       ...this.createAuthQuerys(),
       ...this.toLowerCase(s)
-    }, o = Object.entries(r).filter(([, a]) => !n.isNil(a)).map(([a, d]) => `${encodeURIComponent(a)}=${encodeURIComponent(String(d))}`).join("&");
-    return o.length === 0 ? `${t}${i}` : `${t}${i}?${o}`;
+    }, o = Object.entries(i).filter(([, c]) => !n.isNil(c)).map(([c, a]) => `${encodeURIComponent(c)}=${encodeURIComponent(String(a))}`).join("&");
+    return o.length === 0 ? `${t}${r}` : `${t}${r}?${o}`;
   }
   createAuthQuerys() {
     const e = {};
@@ -95,9 +129,9 @@ class w {
     return n.isNil(e) ? {} : n.mapKeys(e, (s, t) => t.toLowerCase());
   }
 }
-const S = (c) => new w(c);
+const S = (f) => new C(f);
 export {
-  w as WxRequest,
+  C as WxRequest,
   u as WxRequestError,
   S as createWxRequest
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ningboyz/wxmp",
-  "version": "1.0.23",
+  "version": "1.0.25",
   "private": false,
   "description": "宁波甬政微信小程序库",
   "author": "nbyt-syq",
@@ -29,7 +29,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@ningboyz/types": "1.8.91-es.0",
+    "@ningboyz/types": "1.8.89-es.0",
     "lodash": "4.17.21"
   },
   "devDependencies": {