@perk-net/perk-pushplus-sdk 1.2.1 → 1.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@perk-net/perk-pushplus-sdk",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "pushplus(推送加) 官方接口 JavaScript/TypeScript SDK，可在 Node.js 与浏览器中使用",
   "keywords": [
     "pushplus",

package/src/api/qqbot-api.ts

@@ -0,0 +1,75 @@
+import { AccessKeyManager } from '../access-key-manager';
+import { ResolvedPushPlusConfig } from '../config';
+import { HttpRequester } from '../http';
+import {
+  PageQuery,
+  PageResult,
+  QqBotBindInfo,
+  QqBotBindLink,
+  QqBotItem,
+  QqBotSaveRequest,
+  QqGroupItem,
+} from '../models';
+import { OpenAbstractApi } from './open-base';
+
+/** 发送到 QQ 群，目前渠道配置仅支持该类型。 */
+const SEND_TYPE_QQ_GROUP = 2;
+
+/**
+ * 开放接口 - QQ 机器人（文档「九. QQ机器人接口」）。
+ */
+export class QqBotApi extends OpenAbstractApi {
+  constructor(config: ResolvedPushPlusConfig, http: HttpRequester, mgr: AccessKeyManager) {
+    super(config, http, mgr);
+  }
+
+  /** 1. 获取绑定链接与绑定码；refresh 为 true 时旧绑定码失效并重新生成。 */
+  getBindLink(refresh = false): Promise<QqBotBindLink> {
+    const path = refresh
+      ? this.appendQuery('/api/open/qqBot/getBindLink', { refresh: true })
+      : '/api/open/qqBot/getBindLink';
+    return this.executeOpen<QqBotBindLink>('GET', path);
+  }
+
+  /** 2. 查询绑定状态。 */
+  botInfo(): Promise<QqBotBindInfo> {
+    return this.executeOpen<QqBotBindInfo>('GET', '/api/open/qqBot/botInfo');
+  }
+
+  /** 3. 解绑 QQ 机器人。 */
+  async unbind(): Promise<void> {
+    await this.executeOpen<unknown>('GET', '/api/open/qqBot/unbind');
+  }
+
+  /** 4. 获取机器人已加入的 QQ 群列表。 */
+  async groupList(): Promise<QqGroupItem[]> {
+    return (await this.executeOpen<QqGroupItem[]>('GET', '/api/open/qqBot/groupList')) ?? [];
+  }
+
+  /** 5. 获取 QQ 机器人渠道配置列表。 */
+  list(q?: PageQuery): Promise<PageResult<QqBotItem>> {
+    return this.executeOpen<PageResult<QqBotItem>>('POST', '/api/open/qqBot/list', q ?? {});
+  }
+
+  /** 6. 新增渠道配置，用于把消息发送到指定 QQ 群；发给自己无需创建配置。 */
+  async add(req: QqBotSaveRequest): Promise<void> {
+    await this.executeOpen<unknown>('POST', '/api/open/qqBot/add', withDefaultSendType(req));
+  }
+
+  /** 7. 修改渠道配置；配置编码不可修改。 */
+  async edit(req: QqBotSaveRequest): Promise<void> {
+    await this.executeOpen<unknown>('POST', '/api/open/qqBot/edit', withDefaultSendType(req));
+  }
+
+  /** 8. 删除渠道配置。 */
+  async delete(id: number): Promise<void> {
+    await this.executeOpen<unknown>(
+      'DELETE',
+      this.appendQuery('/api/open/qqBot/delete', { id }),
+    );
+  }
+}
+
+function withDefaultSendType(req: QqBotSaveRequest): QqBotSaveRequest {
+  return { ...req, sendType: req.sendType ?? SEND_TYPE_QQ_GROUP };
+}

package/src/client.ts

@@ -11,6 +11,7 @@ import { MessageApi } from './api/message-api';
 import { MessageTokenApi } from './api/message-token-api';
 import { OpenMessageApi } from './api/open-message-api';
 import { PreApi } from './api/pre-api';
+import { QqBotApi } from './api/qqbot-api';
 import { SettingApi } from './api/setting-api';
 import { TopicApi } from './api/topic-api';
 import { TopicUserApi } from './api/topic-user-api';
@@ -67,6 +68,7 @@ export class PushPlusClient {
   readonly webhook: WebhookApi;
   readonly channel: ChannelApi;
   readonly clawBot: ClawBotApi;
+  readonly qqBot: QqBotApi;
   readonly setting: SettingApi;
   readonly pre: PreApi;
   readonly image: ImageApi;
@@ -92,6 +94,7 @@ export class PushPlusClient {
     this.webhook = new WebhookApi(this.config, this.httpRequester, this.accessKeyManager);
     this.channel = new ChannelApi(this.config, this.httpRequester, this.accessKeyManager);
     this.clawBot = new ClawBotApi(this.config, this.httpRequester, this.accessKeyManager);
+    this.qqBot = new QqBotApi(this.config, this.httpRequester, this.accessKeyManager);
     this.setting = new SettingApi(this.config, this.httpRequester, this.accessKeyManager);
     this.pre = new PreApi(this.config, this.httpRequester, this.accessKeyManager);
     this.image = new ImageApi(this.config, this.httpRequester, this.accessKeyManager);

package/src/enums.ts

@@ -22,6 +22,8 @@ export enum Channel {
   APP = 'app',
   /** 微信 ClawBot。 */
   CLAWBOT = 'clawbot',
+  /** QQ 机器人；不带 option 发给自己，option 填配置编码则发到对应 QQ 群。 */
+  QQ = 'qq',
 }
 
 /**

package/src/index.ts

@@ -88,6 +88,12 @@ export type {
   ClawBotInfo,
   ClawBotMessage,
   ClawBotQrCode,
+  QqBotBindLink,
+  QqBotBindInfo,
+  QqBotInfo,
+  QqBotItem,
+  QqBotSaveRequest,
+  QqGroupItem,
   MpItem,
   CpItem,
   MailItem,
@@ -142,6 +148,7 @@ export { FriendApi } from './api/friend-api';
 export { WebhookApi } from './api/webhook-api';
 export { ChannelApi } from './api/channel-api';
 export { ClawBotApi } from './api/clawbot-api';
+export { QqBotApi } from './api/qqbot-api';
 export { SettingApi } from './api/setting-api';
 export { PreApi } from './api/pre-api';
 export {

package/src/models.ts

@@ -270,6 +270,7 @@ export interface SendCount {
   cpSendCount?: number;
   webhookSendCount?: number;
   mailSendCount?: number;
+  qqBotSendCount?: number;
 }
 
 export interface UserLimitTime {
@@ -518,6 +519,82 @@ export interface ClawBotQrCode {
   qrcode?: string;
 }
 
+/* ============================== 开放接口 - QQ 机器人 ============================== */
+
+export interface QqBotBindLink {
+  /** 带参分享链接，用于生成扫码二维码；已绑定用户再次获取时可能为空。 */
+  url?: string;
+  /** 绑定码。已是好友时扫码收不到加好友事件，需私聊发送该码；认领 QQ 群也用此码。 */
+  bindCode?: string;
+  /** 有效期秒数，默认 300。 */
+  expireSeconds?: number;
+  /** 为当前用户分配的官方机器人 appId。 */
+  botAppId?: string;
+  botName?: string;
+  botAvatar?: string;
+}
+
+export interface QqBotInfo {
+  botId?: string;
+  username?: string;
+  avatar?: string;
+  appId?: string;
+  /** 官方分享链接，可用于拉机器人进群。 */
+  shareUrl?: string;
+}
+
+export interface QqBotBindInfo {
+  /** 0-未绑定，1-已绑定。 */
+  isBind?: number;
+  /** 1-可接收，0-用户已关闭单聊接收。 */
+  receiveStatus?: number;
+  createTime?: string;
+  botInfo?: QqBotInfo;
+}
+
+export interface QqGroupItem {
+  /** 群编号；新增渠道配置时作为 qqGroupId 使用。 */
+  id?: number;
+  groupOpenId?: string;
+  groupRemark?: string;
+  /** 1-在群，2-群消息接收关闭。 */
+  status?: number;
+  /** 群名称，接口未授权时为空。 */
+  groupName?: string;
+  groupFingerMemo?: string;
+  groupClassText?: string;
+  groupTags?: string[];
+  groupMemberNum?: number;
+  createTime?: string;
+}
+
+export interface QqBotItem {
+  id?: number;
+  qqName?: string;
+  /** 配置编码；发送消息时作为 option 传入。 */
+  qqCode?: string;
+  /** 2-发到 QQ 群。 */
+  sendType?: number;
+  qqGroupId?: number;
+  groupRemark?: string;
+  groupOpenId?: string;
+  groupName?: string;
+  updateTime?: string;
+}
+
+export interface QqBotSaveRequest {
+  /** 修改时必填。 */
+  id?: number;
+  /** 配置名称，必填，最多 64 个字符。 */
+  qqName?: string;
+  /** 配置编码，新增必填；仅支持字母、数字、下划线和中划线，创建后不可修改。 */
+  qqCode?: string;
+  /** 发送类型；留空时 SDK 自动填 2（发到 QQ 群）。 */
+  sendType?: number;
+  /** QQ 群编号，必填，取自 groupList 返回的 id。 */
+  qqGroupId?: number;
+}
+
 /* ============================== 开放接口 - channel ============================== */
 
 export interface MpItem {