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

package/src/models.ts

@@ -426,6 +426,19 @@ export interface TopicUserListQuery {
   params?: Record<string, unknown>;
 }
 
+/** 群组订阅人黑名单列表项。 */
+export interface TopicUserBlacklistItem {
+  /** 黑名单记录 ID；解除黑名单时使用。 */
+  id?: number;
+  /** 被拉黑用户 ID。 */
+  userId?: number;
+  nickName?: string;
+  openId?: string;
+  headImgUrl?: string;
+  /** 拉黑时间。 */
+  createTime?: string;
+}
+
 /* ============================== 开放接口 - webhook ============================== */
 
 export interface WebhookItem {
@@ -474,6 +487,18 @@ export interface FriendQrCode {
   qrCodeImgUrl?: string;
 }
 
+/** 好友黑名单列表项。 */
+export interface FriendBlacklistItem {
+  /** 黑名单记录 ID；解除黑名单时使用。 */
+  id?: number;
+  /** 被拉黑好友 ID。 */
+  friendId?: number;
+  nickName?: string;
+  headImgUrl?: string;
+  /** 拉黑时间。 */
+  createTime?: string;
+}
+
 /* ============================== 开放接口 - clawbot ============================== */
 
 export interface ClawBotInfo {
@@ -658,3 +683,193 @@ export interface ImageItem {
   /** 创建时间。 */
   createTime?: string;
 }
+
+/* ============================== 开放接口 - form（push 表单） ============================== */
+
+/** 我的表单分页查询。官方结构为 `{current, pageSize, params:{keyword, status}}`。 */
+export interface FormListQuery {
+  /** 当前所在分页数，默认 1。 */
+  current?: number;
+  /** 每页大小，默认 20，最大 50。 */
+  pageSize?: number;
+  params?: {
+    /** 按标题关键词搜索。 */
+    keyword?: string;
+    /** 表单状态：0草稿 / 1收集中 / 2已停止。 */
+    status?: number;
+    [key: string]: unknown;
+  };
+}
+
+/** 表单封面页配置。 */
+export interface FormCover {
+  enabled?: boolean;
+  image?: string;
+  buttonText?: string;
+}
+
+/** 表单主题外观。 */
+export interface FormTheme {
+  primaryColor?: string;
+  backgroundColor?: string;
+  headerImage?: string;
+  backgroundImage?: string;
+  cover?: FormCover;
+}
+
+/** 表单收集 / 展示设置。 */
+export interface FormSettings {
+  endTime?: string | null;
+  maxResponses?: number | null;
+  oncePerUser?: boolean;
+  allowAnonymous?: boolean;
+  password?: string;
+  showQuestionNumber?: boolean;
+  onePerPage?: boolean;
+  showPrevButton?: boolean;
+  hideTitle?: boolean;
+  hideCopyright?: boolean;
+  hideAd?: boolean;
+  showOutline?: boolean;
+  thankText?: string;
+  redirectEnabled?: boolean;
+  redirectUrl?: string;
+  allowEdit?: boolean;
+}
+
+/**
+ * 表单题目。不同题型字段不同，除常用字段外可携带任意扩展属性。
+ *
+ * type 常用取值：input / textarea / radio / checkbox / select / number / date / rate 等。
+ */
+export interface FormItem {
+  id?: string;
+  type?: string;
+  alias?: string;
+  label?: string;
+  description?: string;
+  required?: boolean;
+  placeholder?: string;
+  options?: unknown[];
+  rows?: unknown[];
+  columns?: unknown[];
+  allowOther?: boolean;
+  [key: string]: unknown;
+}
+
+/** 表单列表项 / 创建、复制结果（不含题目明细）。 */
+export interface FormListItem {
+  id?: number;
+  formCode?: string;
+  fillUrl?: string;
+  title?: string;
+  description?: string;
+  status?: number;
+  responseCount?: number;
+  publishTime?: string;
+  createTime?: string;
+  updateTime?: string;
+}
+
+/** 保存表单设计请求。 */
+export interface FormSaveRequest {
+  id: number;
+  title: string;
+  description?: string;
+  items?: FormItem[];
+  theme?: FormTheme;
+  settings?: FormSettings;
+}
+
+/** 表单详情（含草稿题目、主题、设置）。 */
+export interface FormDetail extends FormListItem {
+  items?: FormItem[];
+  theme?: FormTheme;
+  settings?: FormSettings;
+  publishDirty?: boolean;
+}
+
+/** 草稿题目与发布快照差异。 */
+export interface FormPublishDiff {
+  dirty?: boolean;
+  breaking?: boolean;
+  responseCount?: number;
+  added?: string[];
+  removed?: string[];
+  typeChanged?: string[];
+  optionChanged?: string[];
+}
+
+/** 发布表单结果。 */
+export interface FormPublishResult {
+  id?: number;
+  formCode?: string;
+  fillUrl?: string;
+  title?: string;
+  status?: number;
+  previousStatus?: number;
+  publishDirty?: boolean;
+  publishTime?: string;
+}
+
+/* ============================== 开放接口 - doc / excel 共用查询 ============================== */
+
+/** 文档 / 表格分页查询。官方结构为 `{current, pageSize, params:{keyword, shareEnabled}}`。 */
+export interface DocListQuery {
+  /** 当前所在分页数，默认 1。 */
+  current?: number;
+  /** 每页大小，默认 20，最大 50。 */
+  pageSize?: number;
+  params?: {
+    keyword?: string;
+    /** true 时仅返回已开启分享的记录。 */
+    shareEnabled?: boolean;
+    [key: string]: unknown;
+  };
+}
+
+/** 文档 / 表格列表项。 */
+export interface DocListItem {
+  docCode?: string;
+  shareUrl?: string;
+  title?: string;
+  sharePerm?: number;
+  shareLogin?: number;
+  perm?: number;
+  published?: boolean;
+  publishTime?: string;
+  createTime?: string;
+  updateTime?: string;
+}
+
+/** 文档信息（不含正文）。 */
+export interface DocVo extends DocListItem {
+  publishDirty?: boolean;
+}
+
+/** 文档内容（HTML 草稿）。 */
+export interface DocContent extends DocVo {
+  content?: string;
+}
+
+/** 表格信息（不含正文）。与文档结构相同，独立类型便于区分。 */
+export interface ExcelVo extends DocListItem {
+  publishDirty?: boolean;
+}
+
+/** 表格内容（整表 JSON 字符串草稿）。 */
+export interface ExcelContent extends ExcelVo {
+  /** 整表草稿 JSON 字符串。 */
+  content?: string;
+}
+
+/** 按区域写入单元格请求。 */
+export interface ExcelWriteCellsRequest {
+  docCode: string;
+  /** 工作表名称；不传则写入活动表 / 第一张表。 */
+  sheetName?: string;
+  /** 起始单元格，如 A1。 */
+  range: string;
+  /** 二维数组，外层为行、内层为列。 */
+  values: unknown[][];
+}

package/src/multipart.ts

@@ -0,0 +1,62 @@
+import { PushPlusError } from './exception';
+
+/** 二进制文件输入。 */
+export type FileInput = Uint8Array | ArrayBuffer | Blob;
+
+export interface FileMultipart {
+  contentType: string;
+  body: Uint8Array;
+}
+
+/** 构造仅含一个 file 字段的 multipart/form-data 请求体。 */
+export function buildFileMultipart(
+  fileName: string,
+  contentType: string | undefined,
+  fileBytes: Uint8Array,
+): FileMultipart {
+  if (fileBytes == null || fileBytes.byteLength === 0) {
+    throw new PushPlusError('上传文件内容不能为空');
+  }
+  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 };
+}
+
+export async function toFileBytes(file: FileInput): Promise<Uint8Array> {
+  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(`不支持的上传文件类型: ${Object.prototype.toString.call(file)}`);
+}
+
+function escapeFileName(name: string): string {
+  return name.replace(/"/g, '_').replace(/\r/g, ' ').replace(/\n/g, ' ');
+}
+
+function randomBoundarySuffix(): string {
+  let s = '';
+  for (let i = 0; i < 32; i++) {
+    s += Math.floor(Math.random() * 16).toString(16);
+  }
+  return s;
+}