@re-ai/inner-tool-sdk - npm Package Compare versions

Comparing version 0.4.0 to 0.4.1

dist/interfaces/wechat.d.ts

 import { RPCClientResponseResult } from "../types/rpc";
-import { WechatMiniCode2SessionResult, WechatMiniGetPhoneNumberResult, WechatMiniQrCodeGetParams, WechatMiniQrCodeGetResult, WechatMiniQrCodeGetType } from "../types/wechat";
+import { WechatMiniCode2SessionResult, WechatMiniGetPhoneNumberResult, WechatMiniQrCodeGetParams, WechatMiniQrCodeGetResult, WechatMiniQrCodeGetType, WechatPubTemplateMsgParams, WechatPubTemplateMsgResult } from "../types/wechat";
 export interface WechatRPCInterface {
@@ -16,19 +16,31 @@ /**
     /**
-  * 通过代码获取微信小程序用户手机号。
-  *
-  * 该函数发送一个RPC请求，用以获取微信小程序用户绑定的手机号。
-  * 主要用于在小程序中进行用户身份验证和绑定用户手机号。
-  *
-  * @param code 用户授权后获取的code，用于换取用户手机号。
-  * @returns 返回一个Promise，解析为包含手机号信息的结果对象。
-  */
+    * 通过代码获取微信小程序用户手机号。
+    *
+    * 该函数发送一个RPC请求，用以获取微信小程序用户绑定的手机号。
+    * 主要用于在小程序中进行用户身份验证和绑定用户手机号。
+    *
+    * @param code 用户授权后获取的code，用于换取用户手机号。
+    * @returns 返回一个Promise，解析为包含手机号信息的结果对象。
+    */
     miniGetPhoneNumber(code: string): Promise<RPCClientResponseResult<WechatMiniGetPhoneNumberResult>>;
     /**
-   * 获取小程序二维码。
-   *
-   * @param type 二维码类型，默认为"default"。
-   * @param params 二维码参数，根据不同的类型，可以是不同的参数对象。
-   * @returns 返回一个Promise，解析为包含二维码图片的Buffer。
-   */
+     * 获取小程序二维码。
+     *
+     * @param type 二维码类型，默认为"default"。
+     * @param params 二维码参数，根据不同的类型，可以是不同的参数对象。
+     * @returns 返回一个Promise，解析为包含二维码图片的Buffer。
+     */
     miniQrCodeGet(type: WechatMiniQrCodeGetType, params: WechatMiniQrCodeGetParams): Promise<RPCClientResponseResult<WechatMiniQrCodeGetResult>>;
+    /**
+    * 发送微信公众号模板消息
+    *
+    * 本函数通过调用接口发送模板消息到微信公众号，用于实现向用户发送重要通知或提醒的功能
+    * 它需要传入一个符合WechatPubTemplateMsgParams接口的对象作为参数，该对象包含了发送模板消息所需的所有信息
+    * 函数返回一个Promise对象，Promise的结果是RPCClientResponseResult<WechatPubTemplateMsgResult>类型，
+    * 它包含了服务器对于此次发送请求的响应结果，包括是否成功以及可能的错误信息
+    *
+    * @param params WechatPubTemplateMsgParams类型的对象，包含了模板消息的必要信息，如接收者、消息内容等
+    * @returns 返回一个Promise，解析为RPCClientResponseResult<WechatPubTemplateMsgResult>类型，表示服务器的响应结果
+    */
+    pubTemplateMsgSend(params: WechatPubTemplateMsgParams): Promise<RPCClientResponseResult<WechatPubTemplateMsgResult>>;
 }

dist/services/WechatService.d.ts

 import { WechatRPCInterface } from "../interfaces/wechat";
 import { RPCClient } from "../libs/RPCClient";
 import { RPCClientOptions, RPCClientResponseResult } from "../types/rpc";
-import { WechatMiniCode2SessionResult, WechatMiniGetPhoneNumberResult, WechatMiniQrCodeGetParams, WechatMiniQrCodeGetResult, WechatMiniQrCodeGetType } from "../types/wechat";
+import { WechatMiniCode2SessionResult, WechatMiniGetPhoneNumberResult, WechatMiniQrCodeGetParams, WechatMiniQrCodeGetResult, WechatMiniQrCodeGetType, WechatPubTemplateMsgParams, WechatPubTemplateMsgResult } from "../types/wechat";
 export declare class WechatRPCService extends RPCClient implements WechatRPCInterface {
@@ -10,2 +10,3 @@ constructor(options?: RPCClientOptions);
     miniQrCodeGet(type: WechatMiniQrCodeGetType, params: WechatMiniQrCodeGetParams): Promise<RPCClientResponseResult<WechatMiniQrCodeGetResult>>;
+    pubTemplateMsgSend(params: WechatPubTemplateMsgParams): Promise<RPCClientResponseResult<WechatPubTemplateMsgResult>>;
 }

dist/services/WechatService.js

@@ -32,3 +32,10 @@ "use strict";
     }
+    async pubTemplateMsgSend(params) {
+        return await this._request(wechat_1.WechatRPCMethods.PUB_TEMPLATE_MSG_SEND, {
+            body: {
+                ...params
+            }
+        });
+    }
 }
 exports.WechatRPCService = WechatRPCService;

dist/types/wechat.d.ts

 export declare enum WechatRPCMethods {
     MINI_CODE2SESSION = "miniCode2Session",
     MINI_GETPHONENUMBER = "miniGetPhoneNumber",
-    MINI_QRCODE_GET = "miniQrCodeGet"
+    MINI_QRCODE_GET = "miniQrCodeGet",
+    PUB_TEMPLATE_MSG_SEND = "pubTemplateMsgSend"
 }
@@ -47,1 +48,21 @@ export type WechatMiniCode2SessionResult = {
 };
+export type WechatPubTemplateMsgParams = {
+    touser: string;
+    templateId: string;
+    data: {
+        [key: string]: {
+            value: string;
+            color?: string;
+        };
+    };
+    url?: string;
+    miniprogram?: {
+        appid: string;
+        pagepath: string;
+    };
+    pagepath?: string;
+    clientMsgId?: string;
+};
+export type WechatPubTemplateMsgResult = {
+    msgid: string;
+};

dist/types/wechat.js

@@ -9,2 +9,3 @@ "use strict";
     WechatRPCMethods["MINI_QRCODE_GET"] = "miniQrCodeGet";
+    WechatRPCMethods["PUB_TEMPLATE_MSG_SEND"] = "pubTemplateMsgSend";
 })(WechatRPCMethods || (exports.WechatRPCMethods = WechatRPCMethods = {}));

package.json

 {
   "name": "@re-ai/inner-tool-sdk",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "ReAI内部接口sdk",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

src/interfaces/wechat.ts

 import { RPCClientResponseResult } from "../types/rpc";
-import { WechatMiniCode2SessionResult, WechatMiniGetPhoneNumberResult, WechatMiniQrCodeGetParams, WechatMiniQrCodeGetResult, WechatMiniQrCodeGetType } from "../types/wechat";
+import { WechatMiniCode2SessionResult, WechatMiniGetPhoneNumberResult, WechatMiniQrCodeGetParams, WechatMiniQrCodeGetResult, WechatMiniQrCodeGetType, WechatPubTemplateMsgParams, WechatPubTemplateMsgResult } from "../types/wechat";
 
 export interface WechatRPCInterface {
 
-    /**
-     * 将小程序的code转换为sessionData。
-     * 
-     * 此函数用于对接微信小程序的登录流程，通过小程序的code换取session_key及openid。
-     * code是小程序调用getAuthCode接口获取的，用于标识用户的一次登录行为。
-     * 通过这个函数，可以将code转换为session_key和openid，以便于后续的用户身份识别和会话管理。
-     * 
-     * @param jsCode 小程序调用getAuthCode接口获取的code。
-     * @returns 返回一个Promise，解析后的结果包含session_key和openid等信息。
-     */
-    miniCode2Session(jsCode: string): Promise<RPCClientResponseResult<WechatMiniCode2SessionResult>>
+  /**
+   * 将小程序的code转换为sessionData。
+   * 
+   * 此函数用于对接微信小程序的登录流程，通过小程序的code换取session_key及openid。
+   * code是小程序调用getAuthCode接口获取的，用于标识用户的一次登录行为。
+   * 通过这个函数，可以将code转换为session_key和openid，以便于后续的用户身份识别和会话管理。
+   * 
+   * @param jsCode 小程序调用getAuthCode接口获取的code。
+   * @returns 返回一个Promise，解析后的结果包含session_key和openid等信息。
+   */
+  miniCode2Session(jsCode: string): Promise<RPCClientResponseResult<WechatMiniCode2SessionResult>>
 
 
-    /**
+  /**
   * 通过代码获取微信小程序用户手机号。
@@ -28,5 +28,5 @@ *
   */
-    miniGetPhoneNumber(code: string): Promise<RPCClientResponseResult<WechatMiniGetPhoneNumberResult>>
+  miniGetPhoneNumber(code: string): Promise<RPCClientResponseResult<WechatMiniGetPhoneNumberResult>>
 
-    /**
+  /**
    * 获取小程序二维码。
@@ -38,3 +38,16 @@ *
    */
-    miniQrCodeGet(type: WechatMiniQrCodeGetType, params: WechatMiniQrCodeGetParams): Promise<RPCClientResponseResult<WechatMiniQrCodeGetResult>>
+  miniQrCodeGet(type: WechatMiniQrCodeGetType, params: WechatMiniQrCodeGetParams): Promise<RPCClientResponseResult<WechatMiniQrCodeGetResult>>
+
+  /**
+  * 发送微信公众号模板消息
+  * 
+  * 本函数通过调用接口发送模板消息到微信公众号，用于实现向用户发送重要通知或提醒的功能
+  * 它需要传入一个符合WechatPubTemplateMsgParams接口的对象作为参数，该对象包含了发送模板消息所需的所有信息
+  * 函数返回一个Promise对象，Promise的结果是RPCClientResponseResult<WechatPubTemplateMsgResult>类型，
+  * 它包含了服务器对于此次发送请求的响应结果，包括是否成功以及可能的错误信息
+  * 
+  * @param params WechatPubTemplateMsgParams类型的对象，包含了模板消息的必要信息，如接收者、消息内容等
+  * @returns 返回一个Promise，解析为RPCClientResponseResult<WechatPubTemplateMsgResult>类型，表示服务器的响应结果
+  */
+  pubTemplateMsgSend(params: WechatPubTemplateMsgParams): Promise<RPCClientResponseResult<WechatPubTemplateMsgResult>>;
 }

src/services/WechatService.ts

 import { WechatRPCInterface } from "../interfaces/wechat";
 import { RPCClient } from "../libs/RPCClient";
 import { RPCClientOptions, RPCClientResponseResult } from "../types/rpc";
-import { WechatMiniCode2SessionResult, WechatMiniGetPhoneNumberResult, WechatMiniQrCodeGetParams, WechatMiniQrCodeGetResult, WechatMiniQrCodeGetType, WechatRPCMethods } from "../types/wechat";
+import { WechatMiniCode2SessionResult, WechatMiniGetPhoneNumberResult, WechatMiniQrCodeGetParams, WechatMiniQrCodeGetResult, WechatMiniQrCodeGetType, WechatPubTemplateMsgParams, WechatPubTemplateMsgResult, WechatRPCMethods } from "../types/wechat";
 
@@ -35,2 +35,10 @@ export class WechatRPCService extends RPCClient implements WechatRPCInterface {
     }
+
+    async pubTemplateMsgSend(params: WechatPubTemplateMsgParams): Promise<RPCClientResponseResult<WechatPubTemplateMsgResult>> {
+        return await this._request<WechatPubTemplateMsgResult>(WechatRPCMethods.PUB_TEMPLATE_MSG_SEND, {
+            body: {
+                ...params
+            }
+        });
+    }
 }

src/types/wechat.ts

 export enum WechatRPCMethods {
     MINI_CODE2SESSION = "miniCode2Session",
     MINI_GETPHONENUMBER = "miniGetPhoneNumber",
-    MINI_QRCODE_GET = "miniQrCodeGet"
+    MINI_QRCODE_GET = "miniQrCodeGet",
+    PUB_TEMPLATE_MSG_SEND = "pubTemplateMsgSend"
 }
@@ -55,2 +56,24 @@
     buffer: string
+}
+
+export type WechatPubTemplateMsgParams = {
+    touser: string,
+    templateId: string,
+    data: {
+        [key: string]: {
+            value: string,
+            color?: string
+        }
+    },
+    url?: string,
+    miniprogram?: {
+        appid: string,
+        pagepath: string
+    },
+    pagepath?: string,
+    clientMsgId?: string
+}
+
+export type WechatPubTemplateMsgResult = {
+    msgid: string
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

248591

increased by1.54%

Lines of code

6298

increased by1.32%

No dependency changes