@cloudcome/utils-uni 1.34.0 → 1.35.1

package/dist/weixin.mjs

@@ -0,0 +1,130 @@
+import { request } from "./cloud.mjs";
+import { objectMap } from "@cloudcome/utils-core/object";
+import { tryFlatten } from "@cloudcome/utils-core/try";
+//#region src/weixin/token.ts
+/**
+* 构建微信 access_token 获取服务。
+*
+* 自动处理缓存逻辑：优先从临时数据中获取，不存在时调用微信 API 获取并缓存。
+*
+* @param options - 构造选项
+* @returns 获取 access_token 的异步函数
+*
+* @example
+* ```ts
+* const getAccessToken = await buildWeixinAccessTokenService({
+*   appId: 'wx123',
+*   appSecret: 'secret',
+*   getTempDataService: () => kv.get('token'),
+*   setTempDataService: (token, ttl) => kv.set('token', token, ttl),
+* })
+* const token = await getAccessToken()
+* ```
+*/
+async function buildWeixinAccessTokenService(options) {
+	const { appId, appSecret, _mockRequest, getTempDataService, setTempDataService } = options;
+	return async function getWeixinAccessTokenService() {
+		let accessToken = await getTempDataService();
+		if (accessToken) return accessToken;
+		const { data: accessInfo } = await (_mockRequest || request)({
+			url: "https://api.weixin.qq.com/cgi-bin/token",
+			method: "GET",
+			query: {
+				grant_type: "client_credential",
+				appid: appId,
+				secret: appSecret
+			}
+		});
+		if (!accessInfo.access_token) throw new Error(accessInfo.errmsg || "获取 access_token 失败");
+		accessToken = accessInfo.access_token;
+		const [err] = await tryFlatten(setTempDataService(accessToken, accessInfo.expires_in * 1e3));
+		if (err) console.error("设置临时数据失败", err);
+		return accessToken;
+	};
+}
+//#endregion
+//#region src/weixin/notice.ts
+/**
+* 构建微信订阅消息发送服务。
+*
+* 封装微信订阅消息发送逻辑，自动处理 access_token 获取、openId 查找、
+* 字段长度截断（thing 类型 20 字符，character_string 类型 32 字符）等。
+*
+* @template T - payload 字段类型
+* @param options - 构造选项
+* @returns 发送订阅消息的函数
+*
+* @example
+* ```ts
+* const sendNotice = buildSendWeixinNoticeService({
+*   templateId: 'tmpl_abc123',
+*   getWeixinAccessTokenService: getAccessToken,
+*   getUserWeixinOpenId: async (userId) => {
+*     const user = await db.collection('users').doc(userId).get()
+*     return user.data?.openId
+*   },
+* })
+*
+* await sendNotice({
+*   userId: 'user-123',
+*   clientEnv: 'release',
+*   payload: { thing1: '订单已发货', number1: 12345 },
+*   page: '/pages/order/detail?id=12345',
+* })
+* ```
+*/
+function buildSendWeixinNoticeService(options) {
+	const { templateId, getWeixinAccessTokenService, getUserWeixinOpenId, _mockRequest } = options;
+	return async function sendWeixinNoticeService(sendData) {
+		const { userId, page, payload } = sendData;
+		const wxOpenId = await getUserWeixinOpenId(userId);
+		if (!wxOpenId) throw new Error("用户未绑定微信");
+		const accessToken = await getWeixinAccessTokenService();
+		const { data } = await (_mockRequest || request)({
+			url: `https://api.weixin.qq.com/cgi-bin/message/subscribe/send`,
+			method: "POST",
+			query: { access_token: accessToken },
+			data: {
+				touser: wxOpenId,
+				template_id: templateId,
+				page: page.replace(/^\//, ""),
+				miniprogram_state: sendData.clientEnv === "trial" ? "trial" : "formal",
+				lang: "zh_CN",
+				data: objectMap(payload, (val, key) => ({ value: _fixPayloadValue(key, val) }))
+			}
+		});
+		if (data.errcode === 43101) return;
+		if (data.errcode !== 0) throw new Error(data.errmsg || "发送失败，未知错误");
+	};
+}
+/**
+* 修复通知 payload 字段值，根据微信模板字段类型自动截断。
+*
+* 截断规则：
+* - thing 类型：20 字符以内
+* - character_string 类型：32 字符以内
+* - 其他类型：不处理
+*
+* @param key - 模板字段 key（如 thing1, number1）
+* @param val - 字段值
+* @returns 修复后的值
+*/
+function _fixPayloadValue(key, val) {
+	if (key.startsWith("thing")) return _autoEllipsis(val.toString(), 20);
+	if (key.startsWith("character_string")) return _autoEllipsis(val.toString(), 32);
+	return val;
+}
+/**
+* 字符串超长时自动截断并添加省略号。
+*
+* @param val - 原始字符串
+* @param len - 最大长度
+* @returns 截断后的字符串
+*/
+function _autoEllipsis(val, len) {
+	return val.length > len ? `${val.slice(0, len - 3)}...` : val;
+}
+//#endregion
+export { buildSendWeixinNoticeService, buildWeixinAccessTokenService };
+
+//# sourceMappingURL=weixin.mjs.map

package/dist/weixin.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"weixin.mjs","names":[],"sources":["../src/weixin/token.ts","../src/weixin/notice.ts"],"sourcesContent":["import { tryFlatten } from '@cloudcome/utils-core/try';\nimport { request } from '../cloud';\n\n/**\n * 构建微信 access_token 获取服务的选项\n */\nexport type BuildWeixinAccessTokenServiceOptions = {\n  /**\n   * 微信小程序应用ID\n   */\n  appId: string;\n\n  /**\n   * 微信小程序应用密钥\n   */\n  appSecret: string;\n\n  /**\n   * 获取临时数据（用于缓存 access_token）\n   * @returns 缓存的 access_token，无缓存时返回空字符串\n   */\n  getTempDataService: () => Promise<string>;\n\n  /**\n   * 设置临时数据（用于缓存 access_token）\n   * @param accessToken access_token 值\n   * @param expiresIn 过期时间，单位毫秒\n   */\n  setTempDataService: (accessToken: string, expiresIn: number) => Promise<void>;\n\n  /**\n   * 模拟请求函数，用于单元测试注入\n   */\n  _mockRequest?: typeof request;\n};\n\n/**\n * 构建微信 access_token 获取服务。\n *\n * 自动处理缓存逻辑：优先从临时数据中获取，不存在时调用微信 API 获取并缓存。\n *\n * @param options - 构造选项\n * @returns 获取 access_token 的异步函数\n *\n * @example\n * ```ts\n * const getAccessToken = await buildWeixinAccessTokenService({\n *   appId: 'wx123',\n *   appSecret: 'secret',\n *   getTempDataService: () => kv.get('token'),\n *   setTempDataService: (token, ttl) => kv.set('token', token, ttl),\n * })\n * const token = await getAccessToken()\n * ```\n */\nexport async function buildWeixinAccessTokenService(options: BuildWeixinAccessTokenServiceOptions) {\n  const { appId, appSecret, _mockRequest, getTempDataService, setTempDataService } = options;\n\n  return async function getWeixinAccessTokenService() {\n    let accessToken = await getTempDataService();\n    if (accessToken) return accessToken;\n\n    const { data: accessInfo } = await (_mockRequest || request)<{\n      access_token: string;\n      expires_in: number;\n      errmsg: string;\n      errcode: number;\n    }>({\n      url: 'https://api.weixin.qq.com/cgi-bin/token',\n      method: 'GET',\n      query: {\n        grant_type: 'client_credential',\n        appid: appId,\n        secret: appSecret,\n      },\n    });\n\n    if (!accessInfo.access_token) throw new Error(accessInfo.errmsg || '获取 access_token 失败');\n    accessToken = accessInfo.access_token;\n\n    const [err] = await tryFlatten(setTempDataService(accessToken, accessInfo.expires_in * 1000));\n    if (err) console.error('设置临时数据失败', err);\n\n    return accessToken;\n  };\n}\n","import { request } from '@/cloud';\nimport { objectMap } from '@cloudcome/utils-core/object';\n\n/**\n * 发送微信订阅消息的数据结构\n * @template T - payload 字段类型，key 为模板字段名，value 为 string | number\n */\nexport type SendData<T> = {\n  /**\n   * 用户ID，用于查找对应的微信 openId\n   */\n  userId: string;\n\n  /**\n   * 小程序环境\n   * - `develop`: 开发版\n   * - `trial`: 体验版\n   * - `release`: 正式版\n   */\n  clientEnv: 'develop' | 'trial' | 'release';\n\n  /**\n   * 通知数据，key 对应模板字段（如 thing1, number1）\n   */\n  payload: T;\n\n  /**\n   * 点击消息后跳转的页面路径，开头 `/` 会被自动移除\n   */\n  page: string;\n};\n\n/**\n * 构建微信订阅消息发送服务的选项\n */\nexport type BuildSendWeixinNoticeServiceOptions = {\n  /**\n   * 订阅消息模板ID\n   */\n  templateId: string;\n\n  /**\n   * 获取微信 access_token 的服务函数\n   */\n  getWeixinAccessTokenService: () => Promise<string>;\n\n  /**\n   * 根据用户ID获取微信 openId\n   * @param userId - 用户ID\n   * @returns 微信 openId，未绑定时返回空字符串\n   */\n  getUserWeixinOpenId: (userId: string) => Promise<string>;\n\n  /**\n   * 模拟请求函数，用于单元测试注入\n   */\n  _mockRequest?: typeof request;\n};\n\n/**\n * 构建微信订阅消息发送服务。\n *\n * 封装微信订阅消息发送逻辑，自动处理 access_token 获取、openId 查找、\n * 字段长度截断（thing 类型 20 字符，character_string 类型 32 字符）等。\n *\n * @template T - payload 字段类型\n * @param options - 构造选项\n * @returns 发送订阅消息的函数\n *\n * @example\n * ```ts\n * const sendNotice = buildSendWeixinNoticeService({\n *   templateId: 'tmpl_abc123',\n *   getWeixinAccessTokenService: getAccessToken,\n *   getUserWeixinOpenId: async (userId) => {\n *     const user = await db.collection('users').doc(userId).get()\n *     return user.data?.openId\n *   },\n * })\n *\n * await sendNotice({\n *   userId: 'user-123',\n *   clientEnv: 'release',\n *   payload: { thing1: '订单已发货', number1: 12345 },\n *   page: '/pages/order/detail?id=12345',\n * })\n * ```\n */\nexport function buildSendWeixinNoticeService<T extends Record<string, number | string>>(\n  options: BuildSendWeixinNoticeServiceOptions,\n) {\n  const { templateId, getWeixinAccessTokenService, getUserWeixinOpenId, _mockRequest } = options;\n\n  return async function sendWeixinNoticeService(sendData: SendData<T>) {\n    const { userId, page, payload } = sendData;\n    const wxOpenId = await getUserWeixinOpenId(userId);\n    if (!wxOpenId) throw new Error('用户未绑定微信');\n\n    const accessToken = await getWeixinAccessTokenService();\n    const { data } = await (_mockRequest || request)<{\n      errcode: number;\n      errmsg: string;\n    }>({\n      url: `https://api.weixin.qq.com/cgi-bin/message/subscribe/send`,\n      method: 'POST',\n      query: {\n        access_token: accessToken,\n      },\n      data: {\n        touser: wxOpenId,\n        template_id: templateId,\n        page: page.replace(/^\\//, ''),\n        miniprogram_state: sendData.clientEnv === 'trial' ? 'trial' : 'formal',\n        lang: 'zh_CN',\n        data: objectMap(payload, (val, key) => ({\n          value: _fixPayloadValue(key as string, val),\n        })),\n      },\n    });\n\n    if (data.errcode === 43101) return;\n\n    if (data.errcode !== 0) throw new Error(data.errmsg || '发送失败，未知错误');\n  };\n}\n\n/**\n * 修复通知 payload 字段值，根据微信模板字段类型自动截断。\n *\n * 截断规则：\n * - thing 类型：20 字符以内\n * - character_string 类型：32 字符以内\n * - 其他类型：不处理\n *\n * @param key - 模板字段 key（如 thing1, number1）\n * @param val - 字段值\n * @returns 修复后的值\n */\nfunction _fixPayloadValue(key: string, val: number | string) {\n  if (key.startsWith('thing')) return _autoEllipsis(val.toString(), 20);\n  if (key.startsWith('character_string')) return _autoEllipsis(val.toString(), 32);\n  return val;\n}\n\n/**\n * 字符串超长时自动截断并添加省略号。\n *\n * @param val - 原始字符串\n * @param len - 最大长度\n * @returns 截断后的字符串\n */\nfunction _autoEllipsis(val: string, len: number) {\n  return val.length > len ? `${val.slice(0, len - 3)}...` : val;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAuDA,eAAsB,8BAA8B,SAA+C;CACjG,MAAM,EAAE,OAAO,WAAW,cAAc,oBAAoB,uBAAuB;CAEnF,OAAO,eAAe,8BAA8B;EAClD,IAAI,cAAc,MAAM,oBAAoB;EAC5C,IAAI,aAAa,OAAO;EAExB,MAAM,EAAE,MAAM,eAAe,OAAO,gBAAgB,SAKjD;GACD,KAAK;GACL,QAAQ;GACR,OAAO;IACL,YAAY;IACZ,OAAO;IACP,QAAQ;IACT;GACF,CAAC;EAEF,IAAI,CAAC,WAAW,cAAc,MAAM,IAAI,MAAM,WAAW,UAAU,qBAAqB;EACxF,cAAc,WAAW;EAEzB,MAAM,CAAC,OAAO,MAAM,WAAW,mBAAmB,aAAa,WAAW,aAAa,IAAK,CAAC;EAC7F,IAAI,KAAK,QAAQ,MAAM,YAAY,IAAI;EAEvC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACKX,SAAgB,6BACd,SACA;CACA,MAAM,EAAE,YAAY,6BAA6B,qBAAqB,iBAAiB;CAEvF,OAAO,eAAe,wBAAwB,UAAuB;EACnE,MAAM,EAAE,QAAQ,MAAM,YAAY;EAClC,MAAM,WAAW,MAAM,oBAAoB,OAAO;EAClD,IAAI,CAAC,UAAU,MAAM,IAAI,MAAM,UAAU;EAEzC,MAAM,cAAc,MAAM,6BAA6B;EACvD,MAAM,EAAE,SAAS,OAAO,gBAAgB,SAGrC;GACD,KAAK;GACL,QAAQ;GACR,OAAO,EACL,cAAc,aACf;GACD,MAAM;IACJ,QAAQ;IACR,aAAa;IACb,MAAM,KAAK,QAAQ,OAAO,GAAG;IAC7B,mBAAmB,SAAS,cAAc,UAAU,UAAU;IAC9D,MAAM;IACN,MAAM,UAAU,UAAU,KAAK,SAAS,EACtC,OAAO,iBAAiB,KAAe,IAAI,EAC5C,EAAE;IACJ;GACF,CAAC;EAEF,IAAI,KAAK,YAAY,OAAO;EAE5B,IAAI,KAAK,YAAY,GAAG,MAAM,IAAI,MAAM,KAAK,UAAU,YAAY;;;;;;;;;;;;;;;AAgBvE,SAAS,iBAAiB,KAAa,KAAsB;CAC3D,IAAI,IAAI,WAAW,QAAQ,EAAE,OAAO,cAAc,IAAI,UAAU,EAAE,GAAG;CACrE,IAAI,IAAI,WAAW,mBAAmB,EAAE,OAAO,cAAc,IAAI,UAAU,EAAE,GAAG;CAChF,OAAO;;;;;;;;;AAUT,SAAS,cAAc,KAAa,KAAa;CAC/C,OAAO,IAAI,SAAS,MAAM,GAAG,IAAI,MAAM,GAAG,MAAM,EAAE,CAAC,OAAO"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudcome/utils-uni",
-  "version": "1.34.0",
+  "version": "1.35.1",
   "description": "cloudcome utils for uni-app",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -15,6 +15,9 @@
       ],
       "database": [
         "./dist/database.d.ts"
+      ],
+      "weixin": [
+        "./dist/weixin.d.ts"
       ]
     }
   },
@@ -40,6 +43,11 @@
       "types": "./dist/database.d.ts",
       "import": "./dist/database.mjs",
       "require": "./dist/database.cjs"
+    },
+    "./weixin": {
+      "types": "./dist/weixin.d.ts",
+      "import": "./dist/weixin.mjs",
+      "require": "./dist/weixin.cjs"
     }
   },
   "files": [
@@ -49,22 +57,22 @@
     "node": ">=22"
   },
   "dependencies": {
-    "@cloudcome/utils-core": "~1.20.0",
-    "@cloudcome/utils-vue": "~1.13.3",
+    "@cloudcome/utils-core": "~1.21.0",
+    "@cloudcome/utils-vue": "~1.14.1",
     "@dcloudio/types": "^3.4.31",
     "@dcloudio/uni-app": "3.0.0-alpha-5000820260430001",
     "vue": "^3.5.34",
     "zod": "^4.4.3"
   },
   "keywords": [
-    "utils",
     "cloudcome",
+    "utils",
+    "utils-browser",
     "utils-core",
-    "utils-vue",
+    "utils-node",
     "utils-react",
     "utils-uni",
-    "utils-node",
-    "utils-browser"
+    "utils-vue"
   ],
   "homepage": "https://cloudcome.github.io/utils/",
   "license": "MIT",