wechat-ts 0.0.1

package/src/server/cgi-bin/index.ts

@@ -0,0 +1,3 @@
+export * from './getAccessToken'
+export * from './getStableAccessToken'
+export * from './message'

package/src/server/cgi-bin/message/index.ts

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

package/src/server/cgi-bin/message/template/index.ts

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

package/src/server/cgi-bin/message/template/sendTemplateMessage.ts

@@ -0,0 +1,41 @@
+import { WechatResponse } from '../../../types/response'
+import { requestPost } from '../../../utils/request'
+
+/**
+ * 发送模板消息参数
+ * @interface sendTemplateMessageDTO
+ */
+export interface SendTemplateMessageDTO {
+  /** 接收者openid */
+  touser: string
+  /** 模板ID */
+  template_id: string
+  /** 跳转URL */
+  url?: string
+  /** 小程序信息 */
+  miniprogram?: {
+    /** 小程序appid */
+    appid?: string
+    /** 小程序页面路径 */
+    pagepath?: string
+  }
+  /** 模板数据 */
+  data: Record<string, { value: string; color?: string }>
+  /** 防重入id。对于同一个openid + client_msg_id, 只发送一条消息,10分钟有效,超过10分钟不保证效果。若无防重入需求，可不填 */
+  client_msg_id?: string
+}
+
+export interface SendTemplateMessageVO extends WechatResponse {
+  msgid: number
+}
+
+/**
+ * 发送模板消息
+ * @param params
+ * @returns
+ *
+ * @see https://developers.weixin.qq.com/doc/service/api/notify/template/api_sendtemplatemessage.html
+ */
+export function sendTemplateMessage(params: SendTemplateMessageDTO) {
+  return requestPost<SendTemplateMessageVO>('/cgi-bin/message/template/send', params)
+}

package/src/server/cgi-bin/ticket/getTicket.ts

@@ -0,0 +1,28 @@
+import { WechatResponse } from "../../types/response"
+import { requestGet } from "../../utils/request"
+
+export interface GetTicketDTO {
+  /** ticket 类型，jsapi 为 js-sdk 凭证；wx_card 为微信卡券凭证 */
+  type: 'jsapi' | 'wx_card'
+}
+
+export interface GetTicketVO extends WechatResponse {
+  /** 临时票据 */
+  ticket: string
+  /** 
+   * 有效期（秒）
+   * @default 7200
+   */
+  expires_in: number
+}
+
+/**
+ * 获取sdk临时票据
+ * @param data GetTicketDTO
+ * @returns GetTicketVO
+ * 
+ * @see https://developers.weixin.qq.com/doc/service/api/webdev/jssdk/api_getticket.html
+ */
+export function getTicket(data: GetTicketDTO) {
+  return requestGet<GetTicketVO>('/cgi-bin/ticket/getticket', data)
+}

package/src/server/cgi-bin/ticket/index.ts

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

package/src/server/index.ts

@@ -0,0 +1,2 @@
+export * from './cgi-bin'
+export * from './cgi-bin/message/template'

package/src/server/types/response.ts

@@ -0,0 +1,4 @@
+export interface WechatResponse {
+  errcode: number
+  errmsg: string
+}

package/src/server/utils/request.ts

@@ -0,0 +1,25 @@
+import { requestGetBase, requestPostBase } from '../../utils/request'
+import { getToken } from './token'
+
+async function urlAddToken(url: string) {
+  if (url.includes('?')) {
+    url += '&'
+  }
+  url += `access_token=${await getToken()}`
+  return url
+}
+
+export async function requestGet<T>(
+  url: string,
+  params: Record<string, any>,
+  options?: RequestInit
+) {
+  return requestGetBase<T>(await urlAddToken(url), params, options)
+}
+export async function requestPost<T>(
+  url: string,
+  data: Record<string, any>,
+  options?: RequestInit
+) {
+  return requestPostBase<T>(await urlAddToken(url), data, options)
+}

package/src/server/utils/token.ts

@@ -0,0 +1,21 @@
+import { getStableAccessToken } from '../cgi-bin/getStableAccessToken'
+import { getConfig } from '../../utils/config'
+
+let token = '',
+  expires = 0
+
+export async function getToken() {
+  const { appId, appSecret } = getConfig()
+  const now = Date.now()
+  if (expires < now) {
+    const resToken = await getStableAccessToken({
+      appid: appId,
+      secret: appSecret,
+      grant_type: 'client_credential'
+    })
+    token = resToken.access_token
+    // 设置过期时间，留出5%的缓冲时间
+    expires = now + resToken.expires_in * 950
+  }
+  return token
+}

package/src/sns/getUserInfo.ts

@@ -0,0 +1,49 @@
+import { snsAccessToken } from './snsAccessToken'
+import { snsUserInfo } from './snsUserInfo'
+
+/**
+ * 获取微信用户信息
+ * @param {WeixinGetUserInfoDTO} params - 获取微信用户信息参数
+ * @returns {Promise<SnsUserInfo>} 用户信息
+ */
+export async function getSnsUserInfo(code: string) {
+  // 通过code换取网页授权access_token
+  // const { code } = params
+  // const accessToken: WeixinAccessToken = await OpenMpSnsAccessTokenApi.getSnsAccessToken(
+  //   code,
+  //   appid
+  // )
+  // console.log('accessToken:', accessToken)
+
+  // // 拉取用户信息(需scope为 snsapi_userinfo)
+  // const { access_token, openid } = accessToken
+  // const userInfo: TableUser = await OpenMpSnsAccessTokenApi.getUserInfo(
+  //   access_token,
+  //   openid,
+  //   Lang.ZH_CN
+  // )
+
+  // if (userInfo.openid) {
+  //   // 3. 使用user.ts中的函数保存用户信息
+  //   saveUser(userInfo)
+  //   return userInfo
+  // } else {
+  //   throw new Error('获取用户信息失败')
+  // }
+  // 1. 获取access_token和openid
+  const tokenData = await snsAccessToken(code)
+  const { access_token, openid } = tokenData
+
+  if (!openid) {
+    throw new Error('获取openid失败')
+  }
+
+  // 2. 获取用户信息
+  const userInfo = await snsUserInfo({ access_token, openid })
+  if (userInfo.openid) {
+    // 3. 使用user.ts中的函数保存用户信息
+    return userInfo
+  } else {
+    throw new Error('获取用户信息失败')
+  }
+}

package/src/sns/index.ts

@@ -0,0 +1,3 @@
+export * from './snsAccessToken'
+export * from './snsUserInfo'
+export * from './getUserInfo'

package/src/sns/snsAccessToken.ts

@@ -0,0 +1,47 @@
+import { getConfig } from '../utils/config'
+import { requestGetBase } from '../utils/request'
+
+/**
+ * 获取微信用户信息参数
+ * @interface WeixinGetUserInfoDTO
+ */
+export interface WeixinGetUserInfoDTO {
+  /** 授权码 */
+  code: string
+  /** 重定向后会带上 state 参数，开发者可以填写任意参数值，最多 128 字节 */
+  state?: string
+}
+
+/**
+ * 微信访问令牌接口
+ */
+export interface SnsAccessTokenVO {
+  /** 访问令牌 */
+  access_token: string
+  /** 过期时间(秒) */
+  expires_in: number
+  /** 刷新令牌 */
+  refresh_token: string
+  /** 用户openid */
+  openid: string
+  /** 授权作用域 */
+  scope: string
+}
+
+/**
+ * 获取微信访问令牌
+ * @param code 授权码
+ * @returns 微信访问令牌信息
+ * 
+ * @see https://developers.weixin.qq.com/doc/service/api/webdev/access/api_snsaccesstoken.html
+ */
+export async function snsAccessToken(code: string) {
+  const { appId, appSecret } = getConfig()
+  // 通过code换取网页授权access_token
+  return requestGetBase<SnsAccessTokenVO>('/sns/oauth2/access_token', {
+    appid: appId,
+    secret: appSecret,
+    code,
+    grant_type: 'authorization_code'
+  })
+}

package/src/sns/snsUserInfo.ts

@@ -0,0 +1,49 @@
+import { requestGetBase } from '../utils/request'
+import { SnsAccessTokenVO } from './snsAccessToken'
+
+export interface SnsUserInfoDTO extends Pick<SnsAccessTokenVO, 'access_token' | 'openid'> {
+  /**
+   * 语言
+   * @default zh_CN
+   */
+  lang?: 'zh_CN' | 'zh_TW' | 'en'
+}
+
+export interface SnsUserInfoVO {
+  /** 用户的微信openid */
+  openid?: string
+  /** 用户昵称 */
+  nickname?: string
+  /** 性别 0-未知 1-男 2-女 */
+  sex?: 0 | 1 | 2
+  /** 用户语言 */
+  language?: string
+  /** 用户所在城市 */
+  city?: string
+  /** 用户所在省份 */
+  province?: string
+  /** 用户所在国家 */
+  country?: string
+  /** 用户头像URL */
+  headimgurl?: string
+  /** 用户特权信息 */
+  privilege?: any[]
+  /** 用户在开放平台的唯一标识符 */
+  unionid?: string
+}
+/**
+ * 获取授权用户信息
+ * @param data SnsUserInfoDTO
+ * @returns SnsUserInfoVO
+ * 
+ * @see https://developers.weixin.qq.com/doc/service/api/webdev/access/api_snsuserinfo.html
+ */
+export async function snsUserInfo(data: SnsUserInfoDTO) {
+  const { access_token, openid, lang = 'zh_CN' } = data
+  // 2. 获取用户信息
+  return requestGetBase<SnsUserInfoVO>(`/sns/userinfo`, {
+    access_token: access_token,
+    openid: openid,
+    lang: lang
+  })
+}

package/src/types/wechat-api.d.ts

@@ -0,0 +1,164 @@
+declare module 'wechat-api' {
+  // export interface WeixinGetJssdkConfigDTO {
+  //   /** 当前页面URL */
+  //   url: string
+  //   /** 需要使用的JS API列表 */
+  //   jsApiList?: string[]
+  //   /** 是否开启调试模式 */
+  //   debug?: boolean
+  //   /** 微信硬件开发用 */
+  //   beta?: boolean
+  // }
+
+  // /**
+  //  * 微信JS-SDK配置接口
+  //  */
+  // export interface WeixinGetJssdkConfigVO {
+  //   /** 开启调试模式，调用的所有API的返回值会在客户端alert出来，若要查看传入的参数，可以在PC端打开，参数信息会通过log打出，仅在PC端时才会打印 */
+  //   debug: boolean
+  //   /** 微信硬件开发用 */
+  //   beta?: boolean
+  //   /** 必填，公众号的唯一标识 */
+  //   appId: string
+  //   /** 必填，生成签名的时间戳 */
+  //   timestamp: string
+  //   /** 必填，生成签名的随机串 */
+  //   nonceStr: string
+  //   /** 必填，签名 */
+  //   signature: string
+  //   /** 必填，需要使用的JS接口列表 */
+  //   jsApiList: string[]
+  // }
+
+  /** 微信API错误码 */
+  export enum WechatErrorCode {
+    /** -1 */
+    SYSTEM_ERROR = -1,
+    /** 40001 */
+    INVALID_CREDENTIAL = 40001,
+    /** 40003 */
+    INVALID_OPENID = 40003,
+    /** 40008 */
+    INVALID_MESSAGE_TYPE = 40008,
+    /** 40013 */
+    INVALID_APPID = 40013,
+    /** 40036 */
+    INVALID_TEMPLATE_ID_SIZE = 40036,
+    /** 40037 */
+    INVALID_TEMPLATE_ID = 40037,
+    /** 40039 */
+    INVALID_URL_SIZE = 40039,
+    /** 40249 */
+    FORBID_MARKETING_CONTENT = 40249,
+    /** 43116 */
+    TEMPLATE_RESTRICTED = 43116,
+    /** 47003 */
+    PARAM_FORMAT_ERROR = 47003
+  }
+
+  /** 微信API错误码映射 */
+  export type WechatErrorMessage = {
+    [WechatErrorCode.SYSTEM_ERROR]: string
+    [WechatErrorCode.INVALID_CREDENTIAL]: string
+    [WechatErrorCode.INVALID_OPENID]: string
+    [WechatErrorCode.INVALID_MESSAGE_TYPE]: string
+    [WechatErrorCode.INVALID_APPID]: string
+    [WechatErrorCode.INVALID_TEMPLATE_ID_SIZE]: string
+    [WechatErrorCode.INVALID_TEMPLATE_ID]: string
+    [WechatErrorCode.INVALID_URL_SIZE]: string
+    [WechatErrorCode.FORBID_MARKETING_CONTENT]: string
+    [WechatErrorCode.TEMPLATE_RESTRICTED]: string
+    [WechatErrorCode.PARAM_FORMAT_ERROR]: string
+  }
+
+  /** 微信API错误码描述映射 */
+  export const WechatErrorMessages: WechatErrorMessage = {
+    [WechatErrorCode.SYSTEM_ERROR]: '系统繁忙，此时请开发者稍候再试',
+    [WechatErrorCode.INVALID_CREDENTIAL]: 'access_token isinvalid or not latest',
+    [WechatErrorCode.INVALID_OPENID]: '不合法的 OpenID',
+    [WechatErrorCode.INVALID_MESSAGE_TYPE]: '不合法的消息类型',
+    [WechatErrorCode.INVALID_APPID]: '不合法的 AppID',
+    [WechatErrorCode.INVALID_TEMPLATE_ID_SIZE]: '不合法的 template_id 长度',
+    [WechatErrorCode.INVALID_TEMPLATE_ID]: '不合法的 template_id',
+    [WechatErrorCode.INVALID_URL_SIZE]: '不合法的 URL 长度',
+    [WechatErrorCode.FORBID_MARKETING_CONTENT]: '禁止发送营销内容',
+    [WechatErrorCode.TEMPLATE_RESTRICTED]: '模板被限制下发',
+    [WechatErrorCode.PARAM_FORMAT_ERROR]: '参数格式错误'
+  }
+  export interface WechatAPICallbackResult {
+    errcode: 0
+    errmsg: 'ok'
+    msgid: number
+  }
+  export interface WechatAPICallbackError {
+    errcode: number
+    errmsg: string
+  }
+  export type WechatAPICallback<T = WechatAPICallbackError> = (err: WechatAPICallbackError, result: T) => void
+
+  export default class WechatAPI {
+    /**
+     * 初始化
+     * @param appId appId
+     * @param appSecret 秘钥
+     */
+    constructor(appId: string, appSecret: string)
+    getAccessToken(callback: WechatAPICallback): void
+
+    getJsConfig(
+      params: WeixinGetJssdkConfigDTO,
+      callback: WechatAPICallback<WeixinGetJssdkConfigVO>
+    ): void
+
+    /**
+     * 发送模板消息
+     * 详细细节: https://developers.weixin.qq.com/doc/service/api/notify/template/api_sendtemplatemessage.html
+     * Examples:
+     * ```
+     * var templateId: '模板id';
+     * // URL置空，则在发送后,点击模板消息会进入一个空白页面（ios）, 或无法点击（android）
+     * var url: 'http://weixin.qq.com/download';
+     * var data = {
+     *    "first": {
+     *      "value":"恭喜你购买成功！",
+     *      "color":"#173177"
+     *    },
+     *    "keyword1":{
+     *      "value":"巧克力",
+     *      "color":"#173177"
+     *    },
+     *    "keyword2": {
+     *      "value":"39.8元",
+     *      "color":"#173177"
+     *    },
+     *    "keyword3": {
+     *      "value":"2014年9月22日",
+     *      "color":"#173177"
+     *    },
+     *    "remark":{
+     *      "value":"欢迎再次购买！",
+     *      "color":"#173177"
+     *    }
+     * };
+     * api.sendTemplate('openid', templateId, dest, data, callback);
+     * ```
+     * Callback:
+     *
+     * - `err`, 调用失败时得到的异常
+     * - `result`, 调用正常时得到的对象
+     *
+     * @param {String} openid 用户的openid
+     * @param {String} templateId 模板ID
+     * @param {Object} dest 跳转目的地置空，则在发送后，点击模板消息会进入一个空白页面（ios），或无法点击（android）
+     * @param {Object} data 渲染模板的数据
+     * @param {Function} callback 回调函数
+     */
+    sendTemplate(
+      openid: string,
+      templateId: string,
+      dest: string | { url: string; miniprogram: string },
+      data: Record<string, { value: string; color?: string }>,
+      callback: WechatAPICallback
+    )
+  }
+}

package/src/utils/config.ts

@@ -0,0 +1,35 @@
+// 微信配置
+export let appId = ''
+export let appSecret = ''
+
+/** WechatAPI实例 */
+// let api: WechatAPI
+// export function createApi() {
+//   getConfig()
+//   if (!api) {
+//     api = new WechatAPI(appId, appSecret)
+//   }
+//   return api
+// }
+
+export interface WechatConfig {
+  /** 微信公众号appid */
+  appId: string
+  /** 微信公众号appsecret */
+  appSecret: string
+}
+
+export function setConfig(config: WechatConfig) {
+  appId = config.appId
+  appSecret = config.appSecret
+}
+
+export function getConfig(): WechatConfig {
+  if (!appId || !appSecret) {
+    throw new Error('请先调用setConfig配置appId/appSecret')
+  }
+  return {
+    appId,
+    appSecret
+  }
+}

package/src/utils/promise.ts

@@ -0,0 +1,14 @@
+export function usePromiseWithResolvers<T>() {
+  let resolve: (value: T) => void = () => {},
+    reject: (reason?: any) => void= () => {}
+  const promise = new Promise<T>((_resolve, _reject) => {
+    resolve = _resolve
+    reject = _reject
+  })
+
+  return {
+    promise,
+    resolve,
+    reject
+  }
+}

package/src/utils/request.ts

@@ -0,0 +1,20 @@
+import { baseDemain } from '../constants'
+export function requestGetBase<T>(
+  url: string,
+  params: Record<string, any>,
+  options: RequestInit = {}
+) {
+  const urlParams = new URLSearchParams(params)
+  return requestBase<T>(`${url}?${urlParams}`, { ...options, method: 'GET' })
+}
+export function requestPostBase<T>(
+  url: string,
+  data: Record<string, any>,
+  options: RequestInit = {}
+) {
+  return requestBase<T>(url, { ...options, method: 'POST', body: JSON.stringify(data) })
+}
+export async function requestBase<T>(url: string, options: RequestInit = {}) {
+  const res = await fetch(`${baseDemain}${url}`, options)
+  return (await res.json()) as T
+}

package/src/utils/string.ts

@@ -0,0 +1,33 @@
+/*!
+ * 生成随机字符串
+ */
+export const createNonceStr = function () {
+  return Math.random().toString(36).substr(2, 15)
+}
+
+/*!
+ * 生成时间戳
+ */
+export const createTimestamp = function () {
+  return Math.round(new Date().getTime() / 1000) + ''
+}
+
+/*!
+ * 排序查询字符串
+ */
+export const raw = function (args: Record<string, string | number>) {
+  var keys = Object.keys(args)
+  keys = keys.sort()
+  var newArgs: typeof args = {}
+  keys.forEach(function (key) {
+    newArgs[key.toLowerCase()] = args[key]
+  })
+
+  var string = ''
+  var newKeys = Object.keys(newArgs)
+  for (var i = 0; i < newKeys.length; i++) {
+    var k = newKeys[i]
+    string += '&' + k + '=' + newArgs[k]
+  }
+  return string.substr(1)
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES6",
+    "module": "CommonJS",
+    "declaration": true,
+    "sourceMap": true,
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["index.ts", "src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

package/tsup.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig({
+  entry: ['src/index.ts'],
+  outDir: 'dist',
+  format: ['cjs', 'esm', 'iife'],
+  globalName:'wechat',
+  dts: true,
+  sourcemap: true,
+  clean: true,
+})