@ningboyz/wxmp 0.0.0-stage → 1.0.0

package/.prettierrc

@@ -0,0 +1,15 @@
+{
+  "printWidth": 200,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": false,
+  "trailingComma": "none",
+  "bracketSpacing": true,
+  "bracketSameLine": true,
+  "arrowParens": "always",
+  "htmlWhitespaceSensitivity": "ignore",
+  "vueIndentScriptAndStyle": false,
+  "endOfLine": "auto",
+  "singleAttributePerLine": false
+}

package/package.json

@@ -1,6 +1,28 @@
-{
-  "name": "@ningboyz/wxmp",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+  "name": "@ningboyz/wxmp",
+  "version": "1.0.0",
+  "private": false,
+  "description": "宁波甬政微信小程序库",
+  "author": "nbyt-syq",
+  "license": "ISC",
+  "keywords": [],
+  "main": "src/index.ts",
+  "scripts": {
+    "build": "vite build",
+    "prettier": "prettier --config ./.prettierrc --write \"./**/*.{ts,tsx}\" "
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "@ningboyz/types": "1.8.55",
+    "lodash": "4.17.21"
+  },
+  "devDependencies": {
+    "@types/lodash": "4.17.20",
+    "vite": "7.1.3",
+    "vite-plugin-dts": "4.5.4",
+    "vite-plugin-tsx-resolve-types": "0.0.4"
+  }
+}

package/src/client/wxClient.ts

@@ -0,0 +1,30 @@
+import { TCore } from "@ningboyz/types";
+import { WxRequest, createWxRequest } from "../request/wxRequest";
+import { IWxConfig, IWxLoginParams } from "../types";
+
+class WxClient {
+  private wxRequest: WxRequest;
+
+  private constructor(config: IWxConfig) {
+    this.wxRequest = createWxRequest(config);
+  }
+
+  public static create = (config: IWxConfig): WxClient => {
+    return new WxClient(config);
+  };
+
+  /**
+   * 微信登录
+   * @param params
+   * @returns
+   */
+  public login(params: IWxLoginParams) {
+    return this.wxRequest.post<TCore.IUserResponse[]>("/gapi/core/tuser/verifyd2/weixin", undefined, params);
+  }
+}
+
+const createWxClient = (config: IWxConfig): WxClient => {
+  return WxClient.create(config);
+};
+
+export { type WxClient, createWxClient };

package/src/index.ts

@@ -0,0 +1,19 @@
+import { WxClient, createWxClient } from "./client/wxClient";
+import { WxRequest, createWxRequest } from "./request/wxRequest";
+import { IWxConfig, IWxInternalRequestConfig, IWxLoginParams, IWxQueryParams, IWxResponse, TWxConfig, TWxInterceptorsRequest, TWxInterceptorsResponse, TWxLoginParams } from "./types";
+
+export {
+  type WxClient,
+  createWxClient,
+  type WxRequest,
+  createWxRequest,
+  type IWxConfig,
+  type IWxInternalRequestConfig,
+  type IWxLoginParams,
+  type IWxQueryParams,
+  type IWxResponse,
+  type TWxInterceptorsRequest,
+  type TWxInterceptorsResponse,
+  TWxConfig,
+  TWxLoginParams
+};

package/src/request/wxRequest.ts

@@ -0,0 +1,205 @@
+import { TResp } from "@ningboyz/types";
+import _ from "lodash";
+import { IWxConfig, IWxInternalRequestConfig, IWxQueryParams, IWxResponse, REQUEST_TIMEOUT_MILLISECONDS } from "../types";
+
+const HTTP_STATUS_MIN = 200;
+const HTTP_STATUS_MAX = 300;
+const CONTENT_TYPE_JSON = "application/json";
+const CONTENT_TYPE_FORM = "application/x-www-form-urlencoded";
+
+interface IWxRequestFail {
+  errMsg: string;
+}
+
+interface IWxRequestSuccess<T> {
+  data: T;
+  statusCode: number;
+}
+
+interface IWxRequestOption<T> {
+  url: string;
+  method: "GET" | "POST";
+  data?: object | string;
+  header: Record<string, string>;
+  timeout: number;
+  success: (result: IWxRequestSuccess<T>) => void;
+  fail: (error: IWxRequestFail) => void;
+}
+
+interface IMiniProgramWx {
+  request: <T>(option: IWxRequestOption<T>) => void;
+}
+
+class WxRequest {
+  private config: IWxConfig;
+
+  private constructor(config: IWxConfig) {
+    this.config = config;
+  }
+
+  public static create(config: IWxConfig): WxRequest {
+    return new WxRequest(config);
+  }
+
+  /**
+   * 表单提交。body 字段名 params，值是 JSON 字符串，对应 apis 里的 post。
+   */
+  public post<T>(url: string, querys?: IWxQueryParams, params?: object, headers?: Record<string, string>): Promise<TResp.IResponse<T>> {
+    const data = _.isNil(params) ? void 0 : { params: JSON.stringify(params) };
+    const header = this.createHeader(_.isNil(params) ? void 0 : CONTENT_TYPE_FORM, headers);
+    return this.send<T>("POST", url, querys, data, header);
+  }
+
+  /**
+   * JSON 提交，对应 apis 里的 postJson。国密加密接口请走此方法。
+   */
+  public postJson<T>(url: string, querys?: IWxQueryParams, params?: object, headers?: Record<string, string>): Promise<TResp.IResponse<T>> {
+    const header = this.createHeader(CONTENT_TYPE_JSON, headers);
+    return this.send<T>("POST", url, querys, params, header);
+  }
+
+  public get<T>(url: string, querys?: IWxQueryParams, headers?: Record<string, string>): Promise<TResp.IResponse<T>> {
+    const header = this.createHeader(void 0, headers);
+    return this.send<T>("GET", url, querys, void 0, header);
+  }
+
+  private send<T>(method: "GET" | "POST", url: string, querys: IWxQueryParams | undefined, data: object | undefined, header: Record<string, string>): Promise<TResp.IResponse<T>> {
+    return (async () => {
+      let requestConfig: IWxInternalRequestConfig = {
+        url,
+        method,
+        querys,
+        data,
+        header
+      };
+
+      if (!_.isNil(this.config.interceptorsRequest)) {
+        requestConfig = await this.config.interceptorsRequest(requestConfig);
+      }
+
+      const requestUrl = this.createRequestUrl(requestConfig.url, requestConfig.querys);
+      const timeout = this.config.timeout ?? REQUEST_TIMEOUT_MILLISECONDS;
+
+      return await new Promise<TResp.IResponse<T>>((resolve) => {
+        try {
+          this.getMiniProgramWx().request<TResp.IResponse<T>>({
+            url: requestUrl,
+            method: requestConfig.method,
+            data: requestConfig.data,
+            header: requestConfig.header,
+            timeout,
+            success: (result) => {
+              void this.handleSuccess<T>(result, requestConfig).then(resolve);
+            },
+            fail: (error) => {
+              resolve(TResp.TResponse.toError(error.errMsg));
+            }
+          });
+        } catch (error) {
+          const message = error instanceof Error ? error.message : "请求失败";
+          resolve(TResp.TResponse.toError(message));
+        }
+      });
+    })();
+  }
+
+  private async handleSuccess<T>(result: IWxRequestSuccess<TResp.IResponse<T>>, requestConfig: IWxInternalRequestConfig): Promise<TResp.IResponse<T>> {
+    if (result.statusCode < HTTP_STATUS_MIN || result.statusCode >= HTTP_STATUS_MAX) {
+      return TResp.TResponse.toError(`请求失败，状态码 ${result.statusCode}`);
+    }
+
+    let response: IWxResponse = {
+      data: result.data,
+      statusCode: result.statusCode,
+      config: requestConfig
+    };
+
+    if (!_.isNil(this.config.interceptorsResponse)) {
+      response = await this.config.interceptorsResponse(response);
+    }
+
+    this.tryHandleSessionExpired(response.data);
+
+    return response.data as TResp.IResponse<T>;
+  }
+
+  private tryHandleSessionExpired(data: unknown): void {
+    if (_.isNil(this.config.loseTokenState) || _.isNil(this.config.sessionExpiredErrorKey)) {
+      return;
+    }
+    if (_.isNil(data) || typeof data !== "object") {
+      return;
+    }
+    const resp = data as TResp.IResponse<unknown>;
+    if (resp.ERRORKEY === this.config.sessionExpiredErrorKey) {
+      this.config.loseTokenState();
+    }
+  }
+
+  private getMiniProgramWx(): IMiniProgramWx {
+    const miniProgramWx = (globalThis as { wx?: IMiniProgramWx }).wx;
+    if (_.isNil(miniProgramWx)) {
+      throw new Error("当前环境不存在微信小程序 wx");
+    }
+    return miniProgramWx;
+  }
+
+  private createRequestUrl(url: string, querys?: IWxQueryParams): string {
+    const baseURL = this.config.baseURL.endsWith("/") ? this.config.baseURL.slice(0, -1) : this.config.baseURL;
+    const path = url.startsWith("/") ? url : `/${url}`;
+    const mergedQuerys: IWxQueryParams = {
+      r: Date.now(),
+      ...this.createAuthQuerys(),
+      ...this.toLowerCase(querys)
+    };
+    const search = Object.entries(mergedQuerys)
+      .filter(([, value]) => !_.isNil(value))
+      .map(([key, value]) => `${encodeURIComponent(key)}=${encodeURIComponent(String(value))}`)
+      .join("&");
+    if (search.length === 0) {
+      return `${baseURL}${path}`;
+    }
+    return `${baseURL}${path}?${search}`;
+  }
+
+  private createAuthQuerys(): IWxQueryParams {
+    const querys: IWxQueryParams = {};
+    if (!_.isNil(this.config.whobuild) && this.config.whobuild !== 0) {
+      querys.whobuild = this.config.whobuild;
+    }
+    if (!_.isNil(this.config.userIndx) && this.config.userIndx !== 0) {
+      querys.userindx = this.config.userIndx;
+    }
+    return querys;
+  }
+
+  private createHeader(contentType: string | undefined, headers?: Record<string, string>): Record<string, string> {
+    const header: Record<string, string> = {};
+    if (!_.isNil(contentType)) {
+      header["content-type"] = contentType;
+    }
+    if (!_.isNil(this.config.usrtoken) && this.config.usrtoken !== "") {
+      header.usrtoken = this.config.usrtoken;
+    }
+    if (!_.isNil(this.config.dbConfig) && this.config.dbConfig !== "") {
+      header.dbconfig = this.config.dbConfig;
+    }
+    if (!_.isNil(headers)) {
+      Object.assign(header, headers);
+    }
+    return header;
+  }
+
+  private toLowerCase(querys?: IWxQueryParams): IWxQueryParams {
+    if (_.isNil(querys)) {
+      return {};
+    }
+    return _.mapKeys(querys, (_value, key) => key.toLowerCase());
+  }
+}
+
+const createWxRequest = (config: IWxConfig): WxRequest => {
+  return WxRequest.create(config);
+};
+
+export { type WxRequest, createWxRequest };

package/src/types.ts

@@ -0,0 +1,83 @@
+const REQUEST_TIMEOUT_MILLISECONDS = 60000;
+
+export interface IWxQueryParams {
+  [key: string]: string | number | boolean | null | undefined;
+}
+
+/**
+ * 请求拦截入参/出参（对应 Web axios InternalAxiosRequestConfig）。
+ * 国密等可在此改 data、header，并挂 gmSm4KeyHex。
+ */
+export interface IWxInternalRequestConfig {
+  /** 业务 path，不含 baseURL / query */
+  url: string;
+  method: "GET" | "POST";
+  querys?: IWxQueryParams;
+  data?: object;
+  header: Record<string, string>;
+  /** 国密会话 SM4，供响应拦截解密 */
+  gmSm4KeyHex?: string;
+}
+
+/**
+ * 响应拦截入参/出参（对应 Web axios AxiosResponse）。
+ */
+export interface IWxResponse<T = unknown> {
+  data: T;
+  statusCode: number;
+  config: IWxInternalRequestConfig;
+}
+
+export type TWxInterceptorsRequest = (request: IWxInternalRequestConfig) => IWxInternalRequestConfig | Promise<IWxInternalRequestConfig>;
+
+export type TWxInterceptorsResponse = (response: IWxResponse) => IWxResponse | Promise<IWxResponse>;
+
+export interface IWxConfig {
+  baseURL: string;
+  timeout?: number;
+  whobuild?: number;
+  userIndx?: number;
+  usrtoken?: string;
+  dbConfig?: string;
+  /**
+   * 请求拦截（对齐 Web createRequest 的 interceptorsRequest）。
+   * 在内置鉴权 query/header 组装之后、真正 wx.request 之前调用。
+   */
+  interceptorsRequest?: TWxInterceptorsRequest;
+  /**
+   * 响应拦截（对齐 Web createRequest 的 interceptorsResponse）。
+   * 在 HTTP 成功拿到 body 之后、返回给业务之前调用。
+   */
+  interceptorsResponse?: TWxInterceptorsResponse;
+  /** 会话过期时回调（对齐 Web loseTokenState，按 ERRORKEY 判断） */
+  loseTokenState?: () => void;
+  /** 与 loseTokenState 配合；不传则不根据 ERRORKEY 踢登录 */
+  sessionExpiredErrorKey?: string;
+}
+
+export class TWxConfig implements IWxConfig {
+  baseURL: string = "";
+  timeout: number = REQUEST_TIMEOUT_MILLISECONDS;
+  whobuild: number = 0;
+  userIndx: number = 0;
+  usrtoken: string = "";
+  dbConfig: string = "";
+  interceptorsRequest?: TWxInterceptorsRequest = void 0;
+  interceptorsResponse?: TWxInterceptorsResponse = void 0;
+  loseTokenState?: () => void = void 0;
+  sessionExpiredErrorKey?: string = void 0;
+}
+
+export interface IWxLoginParams {
+  code: string;
+  encryptedData: string;
+  iv: string;
+}
+
+export class TWxLoginParams implements IWxLoginParams {
+  code: string = "";
+  encryptedData: string = "";
+  iv: string = "";
+}
+
+export { REQUEST_TIMEOUT_MILLISECONDS };

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ES2023"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "isolatedModules": true,
+    "moduleDetection": "force",
+    "noEmit": true,
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "experimentalDecorators": true
+  }
+}

package/vite.config.ts

@@ -0,0 +1,32 @@
+import { defineConfig } from "vite";
+
+import tsxResolveTypes from "vite-plugin-tsx-resolve-types";
+import dts from "vite-plugin-dts";
+
+export default defineConfig({
+  plugins: [
+    tsxResolveTypes(),
+    dts({
+      entryRoot: "src",
+      outDir: ["es"],
+      exclude: ["**/tests/**"]
+    })
+  ],
+  build: {
+    rollupOptions: {
+      external: ["lodash", "@ningboyz/types"],
+      output: [
+        {
+          preserveModules: true,
+          preserveModulesRoot: "src",
+          entryFileNames: "[name].js",
+          format: "esm",
+          dir: "es"
+        }
+      ]
+    },
+    lib: {
+      entry: "src/index.ts"
+    }
+  }
+});

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.