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

package/README.md

@@ -5,7 +5,7 @@
 - **同时支持 Node.js 与浏览器**：Node.js 18+ 使用内置 `fetch`，浏览器使用原生 `fetch`，无运行时依赖。
 - **三种产物**：CommonJS (`.cjs`) + ESModule (`.js`) + 浏览器 IIFE (`.global.js`)，可通过 npm / `<script>` 直接加载。
 - **完整 TypeScript 类型**：所有请求 / 响应 / 枚举 / 回调全部带类型声明。
-- **全部开放接口**：用户、消息、消息 token、群组、群组用户、好友、webhook、渠道、ClawBot、功能设置、预处理、图片服务（含一键上传到 PushPlus 图床）。
+- **全部开放接口**：用户、消息、消息 token、群组、群组用户、好友、webhook、渠道、ClawBot、功能设置、预处理、图片服务（含一键上传到 PushPlus 图床）、push 表单、push 文档、push 表格。
 - **AccessKey 自动管理**：缓存 + 过期前自动刷新；`code=401` 自动刷新并重试一次。
 - **本地限流守卫**：命中 `code=900` 后按 token 短路同 token 后续发送，避免被服务端长期封禁。
 - **Builder 链式 API**：与 Java/Python SDK 风格保持一致。
@@ -14,6 +14,9 @@
 > 接口文档：
 > - 消息接口：<https://www.pushplus.plus/doc/guide/api.html>
 > - 开放接口：<https://www.pushplus.plus/doc/guide/openApi.html>
+> - push 表单：<https://www.pushplus.plus/doc/ecosystem/form/>
+> - push 文档：<https://www.pushplus.plus/doc/ecosystem/doc/>
+> - push 表格：<https://www.pushplus.plus/doc/ecosystem/sheet/>
 
 ## 安装
 
@@ -182,6 +185,30 @@ const uploaded = await client.image.uploadBytes(bytes, { fileName: 'logo.png' })
 console.log(uploaded.url);                       // 直接拿到可访问的图片 URL
 const imgs = await client.image.list({ current: 1, pageSize: 10 });
 await client.image.delete(imgs.list[0].id);
+
+// push 表单
+const form = await client.form.create('用户满意度调查');
+await client.form.save({
+  id: form.id!,
+  title: '用户满意度调查',
+  items: [{ id: 'q_name', type: 'input', label: '您的姓名', required: true }],
+});
+const published = await client.form.publish(form.id!);
+console.log(published.fillUrl);
+
+// push 文档
+const doc = await client.doc.create('本周工作同步');
+await client.doc.saveContent(doc.docCode!, '<h1>本周工作同步</h1><p>需求评审。</p>');
+await client.doc.updateShare(doc.docCode!, 1, 0);
+await client.doc.publish(doc.docCode!);
+
+// push 表格
+const sheet = await client.excel.create('销售日报');
+await client.excel.writeCells(sheet.docCode!, 'A1', [
+  ['日期', '销售额'],
+  ['2026-08-13', 12800],
+], 'Sheet1');
+await client.excel.publish(sheet.docCode!);
 ```
 
 ### 图片服务

package/dist/index.cjs

@@ -75,6 +75,27 @@ var WebhookTypeDescription = {
   [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";
@@ -546,6 +567,218 @@ var ClawBotApi = class extends OpenAbstractApi {
   }
 };
 
+// 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 });
+  }
+  /** 获取文档元信息与 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);
+  }
+};
+
+// 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 });
+  }
+  /** 获取表格元信息与整表 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 });
+  }
+}
+
+// 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) {
@@ -1138,7 +1371,7 @@ function resolveConfig(input) {
     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.0`
   };
 }
 
@@ -1233,6 +1466,9 @@ var PushPlusClient = class _PushPlusClient {
     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() {
@@ -1476,8 +1712,13 @@ exports.Channel = Channel;
 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;
@@ -1494,6 +1735,8 @@ exports.SendRequestBuilder = SendRequestBuilder;
 exports.SendStatus = SendStatus;
 exports.SendStatusDescription = SendStatusDescription;
 exports.SettingApi = SettingApi;
+exports.ShareLogin = ShareLogin;
+exports.SharePerm = SharePerm;
 exports.Template = Template;
 exports.TopicApi = TopicApi;
 exports.TopicUserApi = TopicUserApi;