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

package/dist/index.global.js

@@ -76,6 +76,27 @@ var PerkPushPlus = (function (exports) {
     [11 /* WX_PUSHER */]: "WxPusher",
     [12 /* CUSTOM */]: "\u81EA\u5B9A\u4E49"
   };
+  var FormStatus = /* @__PURE__ */ ((FormStatus2) => {
+    FormStatus2[FormStatus2["DRAFT"] = 0] = "DRAFT";
+    FormStatus2[FormStatus2["COLLECTING"] = 1] = "COLLECTING";
+    FormStatus2[FormStatus2["STOPPED"] = 2] = "STOPPED";
+    return FormStatus2;
+  })(FormStatus || {});
+  var FormStatusDescription = {
+    [0 /* DRAFT */]: "\u8349\u7A3F",
+    [1 /* COLLECTING */]: "\u6536\u96C6\u4E2D",
+    [2 /* STOPPED */]: "\u5DF2\u505C\u6B62"
+  };
+  var SharePerm = /* @__PURE__ */ ((SharePerm2) => {
+    SharePerm2[SharePerm2["CLOSED"] = 0] = "CLOSED";
+    SharePerm2[SharePerm2["VIEW"] = 1] = "VIEW";
+    return SharePerm2;
+  })(SharePerm || {});
+  var ShareLogin = /* @__PURE__ */ ((ShareLogin2) => {
+    ShareLogin2[ShareLogin2["ANONYMOUS"] = 0] = "ANONYMOUS";
+    ShareLogin2[ShareLogin2["REQUIRED"] = 1] = "REQUIRED";
+    return ShareLogin2;
+  })(ShareLogin || {});
   var ErrorCode = /* @__PURE__ */ ((ErrorCode3) => {
     ErrorCode3[ErrorCode3["OK"] = 200] = "OK";
     ErrorCode3[ErrorCode3["NOT_LOGIN"] = 302] = "NOT_LOGIN";
@@ -355,6 +376,26 @@ var PerkPushPlus = (function (exports) {
       }
       return parseApiResponse(resp);
     }
+    /**
+     * 执行带二进制请求体的请求并返回原始 ApiResponse（不进行 code 校验）。
+     * 用于 multipart 上传等场景。
+     */
+    async executeRaw(method, path, headers, body) {
+      const url = this.resolveUrl(path);
+      const resp = await callExecuteRaw(this.http, {
+        method,
+        url,
+        headers: headers != null ? headers : void 0,
+        body
+      });
+      if (!isSuccessfulHttpStatus(resp.statusCode)) {
+        throw new PushPlusError(
+          `PushPlus \u63A5\u53E3 HTTP \u8C03\u7528\u5931\u8D25: status=${resp.statusCode}, body=${resp.body}`,
+          resp.statusCode
+        );
+      }
+      return parseApiResponse(resp);
+    }
     /** 执行请求并直接返回 data；非 200 抛出异常。 */
     async executeForData(method, path, headers, body) {
       var _a;
@@ -485,6 +526,39 @@ var PerkPushPlus = (function (exports) {
         (_b = resp.code) != null ? _b : -1
       );
     }
+    /** 以 multipart 上传文件（自动携带 access-key；code=401 时刷新后重试一次）。 */
+    executeOpenMultipart(path, multipart) {
+      return this.executeOpenRaw("POST", path, multipart.body, {
+        "Content-Type": multipart.contentType
+      });
+    }
+    /**
+     * 执行带二进制 body 的开放接口请求；当返回 code=401 时自动刷新 key 并重试一次。
+     */
+    async executeOpenRaw(method, path, body, extraHeaders) {
+      var _a, _b;
+      const headers = { ...await this.headersWithAccessKey(), ...extraHeaders != null ? extraHeaders : {} };
+      const resp = await this.executeRaw(method, path, headers, body);
+      if (isApiSuccess(resp)) {
+        return resp.data;
+      }
+      if (resp.code === _OpenAbstractApi.CODE_ACCESS_KEY_INVALID) {
+        this.accessKeyManager.invalidate();
+        const retryHeaders = { ...await this.headersWithAccessKey(), ...extraHeaders != null ? extraHeaders : {} };
+        const retry = await this.executeRaw(method, path, retryHeaders, body);
+        if (isApiSuccess(retry)) {
+          return retry.data;
+        }
+        throw new PushPlusError(
+          `PushPlus \u5F00\u653E\u63A5\u53E3\u4E1A\u52A1\u5931\u8D25(\u91CD\u8BD5\u540E): code=${retry.code}, msg=${retry.msg}`,
+          (_a = retry.code) != null ? _a : -1
+        );
+      }
+      throw new PushPlusError(
+        `PushPlus \u5F00\u653E\u63A5\u53E3\u4E1A\u52A1\u5931\u8D25: code=${resp.code}, msg=${resp.msg}`,
+        (_b = resp.code) != null ? _b : -1
+      );
+    }
   };
   _OpenAbstractApi.HEADER_ACCESS_KEY = "access-key";
   /** PushPlus AccessKey 失效相关的业务码（用于触发自动重试）。 */
@@ -547,6 +621,301 @@ var PerkPushPlus = (function (exports) {
     }
   };
 
+  // src/multipart.ts
+  function buildFileMultipart(fileName, contentType, fileBytes) {
+    if (fileBytes == null || fileBytes.byteLength === 0) {
+      throw new PushPlusError("\u4E0A\u4F20\u6587\u4EF6\u5185\u5BB9\u4E0D\u80FD\u4E3A\u7A7A");
+    }
+    const safeName = fileName && fileName.trim() ? fileName : "file";
+    const mime = contentType && contentType.trim() ? contentType : "application/octet-stream";
+    const boundary = "----PushPlusBoundary" + randomBoundarySuffix();
+    const crlf = "\r\n";
+    const enc = new TextEncoder();
+    const head = enc.encode(
+      `--${boundary}${crlf}Content-Disposition: form-data; name="file"; filename="${escapeFileName(safeName)}"${crlf}Content-Type: ${mime}${crlf}${crlf}`
+    );
+    const tail = enc.encode(`${crlf}--${boundary}--${crlf}`);
+    const body = new Uint8Array(head.byteLength + fileBytes.byteLength + tail.byteLength);
+    body.set(head, 0);
+    body.set(fileBytes, head.byteLength);
+    body.set(tail, head.byteLength + fileBytes.byteLength);
+    return { contentType: `multipart/form-data; boundary=${boundary}`, body };
+  }
+  async function toFileBytes(file) {
+    if (file instanceof Uint8Array) {
+      return file;
+    }
+    if (file instanceof ArrayBuffer) {
+      return new Uint8Array(file);
+    }
+    if (typeof Blob !== "undefined" && file instanceof Blob) {
+      const ab = await file.arrayBuffer();
+      return new Uint8Array(ab);
+    }
+    throw new PushPlusError(`\u4E0D\u652F\u6301\u7684\u4E0A\u4F20\u6587\u4EF6\u7C7B\u578B: ${Object.prototype.toString.call(file)}`);
+  }
+  function escapeFileName(name) {
+    return name.replace(/"/g, "_").replace(/\r/g, " ").replace(/\n/g, " ");
+  }
+  function randomBoundarySuffix() {
+    let s = "";
+    for (let i = 0; i < 32; i++) {
+      s += Math.floor(Math.random() * 16).toString(16);
+    }
+    return s;
+  }
+
+  // src/api/doc-api.ts
+  var DocApi = class extends OpenAbstractApi {
+    constructor(config, http, mgr) {
+      super(config, http, mgr);
+    }
+    /** 我的文档分页。 */
+    list(query) {
+      return this.executeOpen(
+        "POST",
+        "/push/api/open/doc/list",
+        query != null ? query : {}
+      );
+    }
+    /** 创建空白文档。 */
+    create(title) {
+      return this.executeOpen("POST", "/push/api/open/doc/create", { title });
+    }
+    /**
+     * 导入 Word（.docx）创建文档。
+     *
+     * 标题默认取文件名；创建后默认关闭分享，需再调用 publish 才会同步到分享页。
+     */
+    async importWord(file, fileName = "document.docx") {
+      const bytes = await toFileBytes(file);
+      const name = fileName && fileName.trim() ? fileName : "document.docx";
+      return this.executeOpenMultipart(
+        "/push/api/open/doc/import",
+        buildFileMultipart(name, guessDocxContentType(name), bytes)
+      );
+    }
+    /** 获取文档元信息与 HTML 草稿正文。 */
+    content(docCode) {
+      return this.executeOpen(
+        "GET",
+        this.appendQuery("/push/api/open/doc/content", { docCode })
+      );
+    }
+    /** 保存 HTML 草稿（不影响分享页，需再 publish）。 */
+    saveContent(docCode, content) {
+      return this.executeOpen("POST", "/push/api/open/doc/saveContent", { docCode, content });
+    }
+    /** 将草稿同步为分享页快照。 */
+    publish(docCode) {
+      return this.executeOpen(
+        "POST",
+        this.appendQuery("/push/api/open/doc/publish", { docCode })
+      );
+    }
+    /** 重命名。 */
+    async rename(docCode, title) {
+      await this.executeOpen("POST", "/push/api/open/doc/rename", { docCode, title });
+    }
+    /** 删除文档。 */
+    async delete(docCode) {
+      await this.executeOpen(
+        "POST",
+        this.appendQuery("/push/api/open/doc/delete", { docCode })
+      );
+    }
+    /**
+     * 更新分享设置。
+     *
+     * @param sharePerm 0 关闭 / 1 开启（仅可查看）
+     * @param shareLogin 0 免登录 / 1 需登录；不传则沿用原值
+     */
+    updateShare(docCode, sharePerm, shareLogin) {
+      const body = { docCode, sharePerm };
+      if (shareLogin != null) body.shareLogin = shareLogin;
+      return this.executeOpen("POST", "/push/api/open/doc/updateShare", body);
+    }
+  };
+  function guessDocxContentType(name) {
+    return name.toLowerCase().endsWith(".docx") ? "application/vnd.openxmlformats-officedocument.wordprocessingml.document" : "application/octet-stream";
+  }
+
+  // src/api/excel-api.ts
+  var ExcelApi = class extends OpenAbstractApi {
+    constructor(config, http, mgr) {
+      super(config, http, mgr);
+    }
+    /** 我的表格分页。 */
+    list(query) {
+      return this.executeOpen(
+        "POST",
+        "/push/api/open/excel/list",
+        query != null ? query : {}
+      );
+    }
+    /** 创建空白表格。 */
+    create(title) {
+      return this.executeOpen("POST", "/push/api/open/excel/create", { title });
+    }
+    /**
+     * 导入 Excel（.xlsx / .xls）创建表格。
+     *
+     * 标题默认取文件名；创建后默认关闭分享，需再调用 publish 才会同步到分享页。
+     */
+    async importExcel(file, fileName = "workbook.xlsx") {
+      const bytes = await toFileBytes(file);
+      const name = fileName && fileName.trim() ? fileName : "workbook.xlsx";
+      return this.executeOpenMultipart(
+        "/push/api/open/excel/import",
+        buildFileMultipart(name, guessExcelContentType(name), bytes)
+      );
+    }
+    /** 获取表格元信息与整表 JSON 草稿。 */
+    content(docCode) {
+      return this.executeOpen(
+        "GET",
+        this.appendQuery("/push/api/open/excel/content", { docCode })
+      );
+    }
+    /**
+     * 整表覆盖保存草稿。
+     *
+     * `content` 可为 JSON 字符串，或工作簿对象（SDK 会序列化）。
+     */
+    saveContent(docCode, content) {
+      return this.executeOpen("POST", "/push/api/open/excel/saveContent", {
+        docCode,
+        content: stringifyJsonContent(content)
+      });
+    }
+    /**
+     * 从指定起始单元格起，按二维数组向右向下写入（草稿）。
+     *
+     * @param range 起始单元格，如 A1
+     * @param values 外层为行、内层为列
+     * @param sheetName 工作表名称；不传则写入活动表 / 第一张表
+     */
+    writeCells(docCode, range, values, sheetName) {
+      const body = { docCode, range, values };
+      if (sheetName != null) body.sheetName = sheetName;
+      return this.executeOpen("POST", "/push/api/open/excel/writeCells", body);
+    }
+    /** 将草稿同步为分享页快照。 */
+    publish(docCode) {
+      return this.executeOpen(
+        "POST",
+        this.appendQuery("/push/api/open/excel/publish", { docCode })
+      );
+    }
+    /** 重命名。 */
+    async rename(docCode, title) {
+      await this.executeOpen("POST", "/push/api/open/excel/rename", { docCode, title });
+    }
+    /** 删除表格。 */
+    async delete(docCode) {
+      await this.executeOpen(
+        "POST",
+        this.appendQuery("/push/api/open/excel/delete", { docCode })
+      );
+    }
+    /**
+     * 更新分享设置。
+     *
+     * @param sharePerm 0 关闭 / 1 开启（仅可查看）
+     * @param shareLogin 0 免登录 / 1 需登录；不传则沿用原值
+     */
+    updateShare(docCode, sharePerm, shareLogin) {
+      const body = { docCode, sharePerm };
+      if (shareLogin != null) body.shareLogin = shareLogin;
+      return this.executeOpen("POST", "/push/api/open/excel/updateShare", body);
+    }
+  };
+  function stringifyJsonContent(content) {
+    if (typeof content === "string") {
+      return content;
+    }
+    try {
+      return JSON.stringify(content);
+    } catch (e) {
+      throw new PushPlusError(`\u5E8F\u5217\u5316\u8868\u683C\u5185\u5BB9\u5931\u8D25: ${e.message}`, -1, { cause: e });
+    }
+  }
+  function guessExcelContentType(name) {
+    const lower = name.toLowerCase();
+    if (lower.endsWith(".xlsx")) {
+      return "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
+    }
+    if (lower.endsWith(".xls")) {
+      return "application/vnd.ms-excel";
+    }
+    return "application/octet-stream";
+  }
+
+  // src/api/form-api.ts
+  var FormApi = class extends OpenAbstractApi {
+    constructor(config, http, mgr) {
+      super(config, http, mgr);
+    }
+    /** 我的表单分页。 */
+    list(query) {
+      return this.executeOpen(
+        "POST",
+        "/push/api/open/form/list",
+        query != null ? query : {}
+      );
+    }
+    /** 创建空白表单（草稿）。 */
+    create(title) {
+      return this.executeOpen("POST", "/push/api/open/form/create", { title });
+    }
+    /** 基于已有表单复制一份新草稿。 */
+    copy(id) {
+      return this.executeOpen(
+        "POST",
+        this.appendQuery("/push/api/open/form/copy", { id })
+      );
+    }
+    /** 保存表单设计（仅更新草稿；已发布需再调用 publish）。 */
+    async save(req) {
+      await this.executeOpen("POST", "/push/api/open/form/save", req);
+    }
+    /** 表单详情（含草稿题目、主题、设置）。 */
+    detail(id) {
+      return this.executeOpen(
+        "GET",
+        this.appendQuery("/push/api/open/form/detail", { id })
+      );
+    }
+    /** 草稿与发布快照的题目差异。 */
+    publishDiff(id) {
+      return this.executeOpen(
+        "GET",
+        this.appendQuery("/push/api/open/form/publishDiff", { id })
+      );
+    }
+    /** 发布表单，开始收集。 */
+    publish(id) {
+      return this.executeOpen(
+        "POST",
+        this.appendQuery("/push/api/open/form/publish", { id })
+      );
+    }
+    /** 停止收集。 */
+    async stop(id) {
+      await this.executeOpen(
+        "POST",
+        this.appendQuery("/push/api/open/form/stop", { id })
+      );
+    }
+    /** 删除表单（不可恢复）。 */
+    async delete(id) {
+      await this.executeOpen(
+        "POST",
+        this.appendQuery("/push/api/open/form/delete", { id })
+      );
+    }
+  };
+
   // src/api/friend-api.ts
   var FriendApi = class extends OpenAbstractApi {
     constructor(config, http, mgr) {
@@ -576,6 +945,40 @@ var PerkPushPlus = (function (exports) {
     async editRemark(id, remark) {
       await this.executeOpen("POST", "/api/open/friend/editRemark", { id, remark });
     }
+    /**
+     * 5. 将好友加入黑名单。
+     *
+     * 加入后将解除双方好友关系，对方无法再添加你。不能将自己加入黑名单，仅可将已有好友加入黑名单。
+     *
+     * @param friendId 好友 id（好友列表中的 friendId 字段）
+     */
+    async addBlacklist(friendId) {
+      await this.executeOpen(
+        "POST",
+        this.appendQuery("/api/open/friend/addBlacklist", { friendId })
+      );
+    }
+    /** 6. 好友黑名单列表。 */
+    blacklistList(query) {
+      return this.executeOpen(
+        "POST",
+        "/api/open/friend/blacklistList",
+        query != null ? query : {}
+      );
+    }
+    /**
+     * 7. 解除好友黑名单。
+     *
+     * 解除后不会自动恢复好友关系，需重新扫码添加。
+     *
+     * @param id 黑名单记录 ID（黑名单列表中的 id 字段）
+     */
+    async removeBlacklist(id) {
+      await this.executeOpen(
+        "POST",
+        this.appendQuery("/api/open/friend/removeBlacklist", { id })
+      );
+    }
   };
 
   // src/api/image-api.ts
@@ -624,7 +1027,7 @@ var PerkPushPlus = (function (exports) {
       }
       const fileName = options.fileName || "file";
       const contentType = options.contentType || guessContentTypeByName(fileName) || "application/octet-stream";
-      const boundary = "----PushPlusBoundary" + randomBoundarySuffix();
+      const boundary = "----PushPlusBoundary" + randomBoundarySuffix2();
       const body = buildMultipartBody(boundary, uploadToken, fileName, contentType, bytes);
       const resp = await callExecuteRaw(this.http, {
         method: "POST",
@@ -710,7 +1113,7 @@ var PerkPushPlus = (function (exports) {
     const crlf = "\r\n";
     const enc = new TextEncoder();
     const head = enc.encode(
-      `--${boundary}${crlf}Content-Disposition: form-data; name="token"${crlf}${crlf}${uploadToken}${crlf}--${boundary}${crlf}Content-Disposition: form-data; name="file"; filename="${escapeFileName(fileName)}"${crlf}Content-Type: ${contentType}${crlf}${crlf}`
+      `--${boundary}${crlf}Content-Disposition: form-data; name="token"${crlf}${crlf}${uploadToken}${crlf}--${boundary}${crlf}Content-Disposition: form-data; name="file"; filename="${escapeFileName2(fileName)}"${crlf}Content-Type: ${contentType}${crlf}${crlf}`
     );
     const tail = enc.encode(`${crlf}--${boundary}--${crlf}`);
     const out = new Uint8Array(head.byteLength + fileBytes.byteLength + tail.byteLength);
@@ -719,7 +1122,7 @@ var PerkPushPlus = (function (exports) {
     out.set(tail, head.byteLength + fileBytes.byteLength);
     return out;
   }
-  function escapeFileName(name) {
+  function escapeFileName2(name) {
     return name.replace(/"/g, "_").replace(/\r/g, " ").replace(/\n/g, " ");
   }
   function guessContentTypeByName(name) {
@@ -732,7 +1135,7 @@ var PerkPushPlus = (function (exports) {
     if (lower.endsWith(".svg")) return "image/svg+xml";
     return null;
   }
-  function randomBoundarySuffix() {
+  function randomBoundarySuffix2() {
     let s = "";
     for (let i = 0; i < 32; i++) {
       s += Math.floor(Math.random() * 16).toString(16);
@@ -1075,6 +1478,42 @@ var PerkPushPlus = (function (exports) {
     async editRemark(id, remark) {
       await this.executeOpen("POST", "/api/open/topicUser/editRemark", { id, remark });
     }
+    /**
+     * 4. 将订阅人加入黑名单。
+     *
+     * 加入后将移出群组，对方无法再加入该群组。积分群组不支持黑名单。不能将自己加入黑名单。
+     *
+     * @param topicRelationId 用户编号（订阅人列表中的 id 字段）
+     */
+    async addBlacklist(topicRelationId) {
+      const path = this.appendQuery("/api/open/topicUser/addBlacklist", { topicRelationId });
+      await this.executeOpen("POST", path);
+    }
+    /**
+     * 5. 订阅人黑名单列表。
+     *
+     * `query.params.topicId` 必填。
+     */
+    blacklistList(query) {
+      return this.executeOpen(
+        "POST",
+        "/api/open/topicUser/blacklistList",
+        query
+      );
+    }
+    /**
+     * 6. 解除订阅人黑名单。
+     *
+     * 解除后不会自动恢复群组订阅，对方可重新加入该群组。
+     *
+     * @param id 黑名单记录 ID（黑名单列表中的 id 字段）
+     */
+    async removeBlacklist(id) {
+      await this.executeOpen(
+        "POST",
+        this.appendQuery("/api/open/topicUser/removeBlacklist", { id })
+      );
+    }
   };
 
   // src/api/user-api.ts
@@ -1139,7 +1578,7 @@ var PerkPushPlus = (function (exports) {
       logRequest: (_g = cfg.logRequest) != null ? _g : false,
       rateLimitGuardEnabled: (_h = cfg.rateLimitGuardEnabled) != null ? _h : true,
       rateLimitCooldownMs: (_i = cfg.rateLimitCooldownMs) != null ? _i : 0,
-      userAgent: (_j = cfg.userAgent) != null ? _j : `@perk-net/perk-pushplus-sdk/1.1.1`
+      userAgent: (_j = cfg.userAgent) != null ? _j : `@perk-net/perk-pushplus-sdk/1.2.1`
     };
   }
 
@@ -1234,6 +1673,9 @@ var PerkPushPlus = (function (exports) {
       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);
+      this.form = new FormApi(this.config, this.httpRequester, this.accessKeyManager);
+      this.doc = new DocApi(this.config, this.httpRequester, this.accessKeyManager);
+      this.excel = new ExcelApi(this.config, this.httpRequester, this.accessKeyManager);
     }
     /** 与 Java SDK 风格一致的 Builder 入口。 */
     static builder() {
@@ -1477,8 +1919,13 @@ var PerkPushPlus = (function (exports) {
   exports.ChannelApi = ChannelApi;
   exports.ClawBotApi = ClawBotApi;
   exports.DEFAULT_BASE_URL = DEFAULT_BASE_URL;
+  exports.DocApi = DocApi;
   exports.ErrorCode = ErrorCode;
+  exports.ExcelApi = ExcelApi;
   exports.FetchHttpRequester = FetchHttpRequester;
+  exports.FormApi = FormApi;
+  exports.FormStatus = FormStatus;
+  exports.FormStatusDescription = FormStatusDescription;
   exports.FriendApi = FriendApi;
   exports.ImageApi = ImageApi;
   exports.MessageApi = MessageApi;
@@ -1495,6 +1942,8 @@ var PerkPushPlus = (function (exports) {
   exports.SendStatus = SendStatus;
   exports.SendStatusDescription = SendStatusDescription;
   exports.SettingApi = SettingApi;
+  exports.ShareLogin = ShareLogin;
+  exports.SharePerm = SharePerm;
   exports.Template = Template;
   exports.TopicApi = TopicApi;
   exports.TopicUserApi = TopicUserApi;