uapi-browser-sdk 0.1.15 → 0.1.17

package/dist/src/index.d.ts

@@ -8,6 +8,8 @@ export interface UapiClientOptions {
 type RequestOptions = {
     disableCache?: boolean;
 };
+type RequestBodyPayload = Record<string, unknown> | FormData;
+export type BrowserUpload = Blob | File;
 export type GetClipzyGetResponse = Internal.GetClipzyGet200Response;
 export interface GetClipzyGetArgs {
     /** 为 true 时会自动附加 `_t` 时间戳，绕过服务端缓存。 */
@@ -122,7 +124,7 @@ export interface GetGameSteamSummaryArgs {
     id?: string;
     /** 用户的 Steam ID3 格式标识符。传统的 Steam ID 格式，形如 STEAM_X:Y:Z。 */
     id3?: string;
-    /** 你的 Steam Web API Key。这是一个可选参数，如果提供，它将覆盖我们在后端配置的全局Key。这为你提供了更大的灵活性，但请务必注意Key的保密，不要在前端暴露。 */
+    /** 这个接口可以传的访问凭证。此参数选填，如果传入，将优先使用您提供的值。请注意妥善保管，不要把它写进公开的前端代码中。 */
     key?: string;
 }
 export type GetAvatarGravatarResponse = ArrayBuffer;
@@ -144,7 +146,40 @@ export interface GetAvatarGravatarArgs {
     /** 头像分级。可选值：`g`, `pg`, `r`, `x`。 */
     r?: string;
 }
-export type GetImageBingDailyResponse = ArrayBuffer;
+export type GetImageBingDailyResponse = ArrayBuffer | Internal.FormatJson;
+export interface GetImageBingDailyArgs {
+    /** 为 true 时会自动附加 `_t` 时间戳，绕过服务端缓存。 */
+    disableCache?: boolean;
+    /** Same as `disableCache`. Kept for compatibility. */
+    "disable_cache"?: boolean;
+    /** 手动指定缓存穿透时间戳。传入后会原样带到查询参数中。 */
+    _t?: string | number;
+    /** 壁纸日期，格式是 `YYYY-MM-DD`。不传时返回当天壁纸。 */
+    date?: string;
+    /** 返回图片的目标分辨率。可以传 `4k` 或 `1080`，不传时默认是 `4k`。 */
+    resolution?: string;
+    /** 响应格式。可以传 `image`、`json` 或 `redirect`。不传时默认是 `image`。 */
+    format?: string;
+}
+export type GetImageBingDailyHistoryResponse = Internal.GetImageBingDailyHistory200Response;
+export interface GetImageBingDailyHistoryArgs {
+    /** 为 true 时会自动附加 `_t` 时间戳，绕过服务端缓存。 */
+    disableCache?: boolean;
+    /** Same as `disableCache`. Kept for compatibility. */
+    "disable_cache"?: boolean;
+    /** 手动指定缓存穿透时间戳。传入后会原样带到查询参数中。 */
+    _t?: string | number;
+    /** 壁纸日期，格式是 `YYYY-MM-DD`。传了以后会按日期精确查询，并且忽略 `page` 和 `page_size`。 */
+    date?: string;
+    /** 返回图片的目标分辨率。可以传 `4k` 或 `1080`，不传时默认是 `4k`。 */
+    resolution?: string;
+    /** 分页页码，必须是正整数。不传时默认是 `1`。只有在不传 `date` 时才生效。 */
+    page?: number;
+    /** 每页条数，必须是正整数。不传时默认是 `30`，最大是 `100`。只有在不传 `date` 时才生效。 */
+    pageSize?: number;
+    /** Same as `pageSize`. Kept for compatibility. */
+    "page_size"?: number;
+}
 export type GetImageMotouResponse = ArrayBuffer;
 export interface GetImageMotouArgs {
     /** 为 true 时会自动附加 `_t` 时间戳，绕过服务端缓存。 */
@@ -205,7 +240,42 @@ export interface PostImageCompressArgs {
     /** 输出图片格式，可以是 'png' 或 'jpeg'。 */
     format?: string;
     /** 支持PNG, JPG, JPEG等常见图片格式。文件大小不超过15MB。 */
-    file: string;
+    file: BrowserUpload;
+}
+export type PostImageDecodeResponse = ArrayBuffer;
+export interface PostImageDecodeArgs {
+    /** 为 true 时会自动附加 `_t` 时间戳，绕过服务端缓存。 */
+    disableCache?: boolean;
+    /** Same as `disableCache`. Kept for compatibility. */
+    "disable_cache"?: boolean;
+    /** 手动指定缓存穿透时间戳。传入后会原样带到查询参数中。 */
+    _t?: string | number;
+    /** 目标宽度，单位是像素。可以单独传，也可以和 `height` 一起传。与 `max_width`、`max_height` 互斥。 */
+    width?: number;
+    /** 目标高度，单位是像素。可以单独传，也可以和 `width` 一起传。与 `max_width`、`max_height` 互斥。 */
+    height?: number;
+    /** 最大宽度，单位是像素。只有在不传 `width`、`height` 时才生效，会按原比例缩放。 */
+    maxWidth?: number;
+    /** Same as `maxWidth`. Kept for compatibility. */
+    "max_width"?: number;
+    /** 最大高度，单位是像素。只有在不传 `width`、`height` 时才生效，会按原比例缩放。 */
+    maxHeight?: number;
+    /** Same as `maxHeight`. Kept for compatibility. */
+    "max_height"?: number;
+    /** 输出格式。可以传 `bmp`、`rgb565` 或 `rgb888`，不传时默认是 `bmp`。 */
+    format?: string;
+    /** BMP 输出的颜色模式。只有在 `format=bmp` 时才生效，可以传 `RGB565` 或 `RGB888`，不传时默认是 `RGB888`。 */
+    colorMode?: string;
+    /** Same as `colorMode`. Kept for compatibility. */
+    "color_mode"?: string;
+    /** 缩放模式。可以传 `contain`、`cover` 或 `fill`，不传时默认是 `contain`。当传 `cover` 或 `fill` 时，`width` 和 `height` 都要传。 */
+    fit?: string;
+    /** 背景色。可以传 `black`、`white` 或 `#RRGGBB`，不传时默认是 `black`。 */
+    background?: string;
+    /** 要处理的图片文件。这个接口适合直接上传 JPG、JPEG、PNG、WebP、BMP 等常见格式。 */
+    file?: BrowserUpload;
+    /** 要处理的图片链接。适合不方便直接上传文件时使用。 */
+    url?: string;
 }
 export type PostImageFrombase64Response = Internal.PostImageFrombase64200Response;
 export interface PostImageFrombase64Args {
@@ -231,7 +301,7 @@ export interface PostImageMotouArgs {
     /** Same as `bgColor`. Kept for compatibility. */
     "bg_color"?: string;
     /** 上传的图片文件。支持JPG、PNG、GIF等常见格式。 */
-    file?: string;
+    file?: BrowserUpload;
     /** 图片的URL地址。如果提供此项，将优先使用该URL的图片。 */
     imageUrl?: string;
     /** Same as `imageUrl`. Kept for compatibility. */
@@ -246,10 +316,43 @@ export interface PostImageNsfwArgs {
     /** 手动指定缓存穿透时间戳。传入后会原样带到查询参数中。 */
     _t?: string | number;
     /** 要检测的图片文件。支持 JPG、JPEG、PNG、GIF、WebP 格式，最大 20MB。 */
-    file?: string;
+    file?: BrowserUpload;
     /** 图片的 URL 地址。如果同时提供 file 和 url，将优先使用 file。 */
     url?: string;
 }
+export type PostImageOcrResponse = Internal.PostImageOcr200Response;
+export interface PostImageOcrArgs {
+    /** 为 true 时会自动附加 `_t` 时间戳，绕过服务端缓存。 */
+    disableCache?: boolean;
+    /** Same as `disableCache`. Kept for compatibility. */
+    "disable_cache"?: boolean;
+    /** 手动指定缓存穿透时间戳。传入后会原样带到查询参数中。 */
+    _t?: string | number;
+    /** 是否开启额外的文字方向校正。请传 `true` 或 `false`，不传时默认是 `false`。 */
+    enableCls?: string;
+    /** Same as `enableCls`. Kept for compatibility. */
+    "enable_cls"?: string;
+    /** 待识别的图片文件。支持 JPG、JPEG、PNG、BMP、GIF、WebP 等常见格式，最大不超过 10MB。请勿与 url 或 image_base64 同时提交。 */
+    file?: BrowserUpload;
+    /** 图片的 Base64 字符串。可以传完整 Data URI，也可以只传纯 Base64 内容。请勿与 file 或 url 同时提交。 */
+    imageBase64?: string;
+    /** Same as `imageBase64`. Kept for compatibility. */
+    "image_base64"?: string;
+    /** 自定义图片文件名。传链接或纯 Base64 时建议一起传，便于保留或推断扩展名。 */
+    imageName?: string;
+    /** Same as `imageName`. Kept for compatibility. */
+    "image_name"?: string;
+    /** 是否返回文字坐标信息。请传 `true` 或 `false`，不传时默认是 `true`。 */
+    needLocation?: string;
+    /** Same as `needLocation`. Kept for compatibility. */
+    "need_location"?: string;
+    /** 是否额外返回整理后的 Markdown 文本。请传 `true` 或 `false`，不传时默认是 `false`。 */
+    returnMarkdown?: string;
+    /** Same as `returnMarkdown`. Kept for compatibility. */
+    "return_markdown"?: string;
+    /** 公网可直接访问的图片地址。请勿与 file 或 image_base64 同时提交。 */
+    url?: string;
+}
 export type PostImageSpeechlessResponse = ArrayBuffer;
 export interface PostImageSpeechlessArgs {
     /** 为 true 时会自动附加 `_t` 时间戳，绕过服务端缓存。 */
@@ -284,7 +387,7 @@ export interface PostImageSvgArgs {
     /** JPEG 图像的压缩质量（1-100）。仅当 `format` 为 `jpeg` 或 `jpg` 时有效。 */
     quality?: number;
     /** 支持SVG文件 */
-    file?: string;
+    file?: BrowserUpload;
 }
 export type GetHistoryProgrammerResponse = Internal.GetHistoryProgrammer200Response;
 export interface GetHistoryProgrammerArgs {
@@ -351,6 +454,10 @@ export interface GetMiscHolidayCalendarArgs {
     nearbyLimit?: number;
     /** Same as `nearbyLimit`. Kept for compatibility. */
     "nearby_limit"?: number;
+    /** 传 true 时，会过滤今天之前已经过去的节日。默认 false。 */
+    excludePast?: boolean;
+    /** Same as `excludePast`. Kept for compatibility. */
+    "exclude_past"?: boolean;
 }
 export type GetMiscHotboardResponse = Internal.GetMiscHotboard200Response;
 export interface GetMiscHotboardArgs {
@@ -376,8 +483,6 @@ export interface GetMiscHotboardArgs {
     "time_end"?: number;
     /** 搜索模式下最大返回条数，默认 50，最大 200。 */
     limit?: number;
-    /** 设为 true 时列出所有可用的历史数据源，忽略其他参数。 */
-    sources?: boolean;
 }
 export type GetMiscLunartimeResponse = Internal.GetMiscLunartime200Response;
 export interface GetMiscLunartimeArgs {
@@ -473,6 +578,8 @@ export interface GetMiscTrackingQueryArgs {
     "carrier_code"?: string;
     /** 收件人手机尾号，4位数字（可选）。部分快递公司需要验证手机尾号才能查询详细物流信息。 */
     phone?: string;
+    /** 使用这个参数可以获得完整的物流信息。但会消耗34积分/一次（不过缓存命中半价）。因为成本实在太贵了，否则非常非常亏说是 */
+    full?: boolean;
 }
 export type GetMiscWeatherResponse = Internal.GetMiscWeather200Response;
 export interface GetMiscWeatherArgs {
@@ -563,7 +670,7 @@ export interface GetNetworkIpinfoArgs {
     _t?: string | number;
     /** 你需要查询的公网IP地址或域名（支持IPv4和IPv6）。 */
     ip: string;
-    /** 查询的数据源。如果留空，将使用默认的数据库。如果设置为 `commercial`，将调用商业级API，返回更详细的地理位置信息，但响应时间可能会稍长。 */
+    /** 查询结果类型。不传时返回标准结果；如果设置为 `commercial`，将返回更完整的地理位置信息，但响应时间可能会稍长。 */
     source?: string;
 }
 export type GetNetworkMyipResponse = Internal.GetNetworkMyip200Response;
@@ -574,7 +681,7 @@ export interface GetNetworkMyipArgs {
     "disable_cache"?: boolean;
     /** 手动指定缓存穿透时间戳。传入后会原样带到查询参数中。 */
     _t?: string | number;
-    /** 查询的数据源。如果留空，将使用默认的数据库。如果设置为 `commercial`，将调用商业级API，返回更详细的地理位置信息，但响应时间可能会稍长。 */
+    /** 查询结果类型。不传时返回标准结果；如果设置为 `commercial`，将返回更完整的地理位置信息，但响应时间可能会稍长。 */
     source?: string;
 }
 export type GetNetworkPingResponse = Internal.GetNetworkPing200Response;
@@ -722,6 +829,25 @@ export interface GetGithubRepoArgs {
     /** 目标仓库的标识，格式为 `owner/repo`。 */
     repo: string;
 }
+export type GetGithubUserResponse = Internal.GetGithubUser200Response;
+export interface GetGithubUserArgs {
+    /** 为 true 时会自动附加 `_t` 时间戳，绕过服务端缓存。 */
+    disableCache?: boolean;
+    /** Same as `disableCache`. Kept for compatibility. */
+    "disable_cache"?: boolean;
+    /** 手动指定缓存穿透时间戳。传入后会原样带到查询参数中。 */
+    _t?: string | number;
+    /** GitHub 用户名（必需符合 GitHub 命名规范：仅限字母、数字、连字符，最长 39 位）。 */
+    user: string;
+    /** 是否获取最近一年的贡献活动数据（如贡献图、时间线）。传入 true 开启，其他值均视为不开启。 */
+    activity?: boolean;
+    /** 活动数据范围。可选 all 或 organization。只有开启 activity 时才有意义。 */
+    activityScope?: string;
+    /** Same as `activityScope`. Kept for compatibility. */
+    "activity_scope"?: string;
+    /** 组织登录名。如果传入此参数，会自动视为开启 organization 级别的贡献查询，切勿再同时传 activity_scope=all。 */
+    org?: string;
+}
 export type GetSocialBilibiliArchivesResponse = Internal.GetSocialBilibiliArchives200Response;
 export interface GetSocialBilibiliArchivesArgs {
     /** 为 true 时会自动附加 `_t` 时间戳，绕过服务端缓存。 */
@@ -867,7 +993,7 @@ export interface PostTextAesDecryptArgs {
     /** 密钥，长度必须为16、24或32字节，对应AES-128/192/256。 */
     key: string;
     /** 16字节的IV/Nonce，必须为16个字符 */
-    nonce: string;
+    nonce?: string;
     /** Base64编码的密文。 */
     text: string;
 }
@@ -976,6 +1102,38 @@ export interface PostTextConvertArgs {
     /** 目标格式类型 */
     to: string;
 }
+export type PostTextMarkdownToHtmlResponse = Internal.PostTextMarkdownToHtml200Response;
+export interface PostTextMarkdownToHtmlArgs {
+    /** 为 true 时会自动附加 `_t` 时间戳，绕过服务端缓存。 */
+    disableCache?: boolean;
+    /** Same as `disableCache`. Kept for compatibility. */
+    "disable_cache"?: boolean;
+    /** 手动指定缓存穿透时间戳。传入后会原样带到查询参数中。 */
+    _t?: string | number;
+    /** 响应格式。传 `json` 时返回 JSON 包裹的 HTML 片段；传 `html` 时直接返回 `text/html`，并且响应内容会自动带完整的网页结构，适合浏览器预览或直接保存为网页文件。默认是 `json`。 */
+    format?: string;
+    /** 是否开启安全模式，过滤掉用户输入中的风险脚本。默认是 `true`。 */
+    sanitize?: boolean;
+    /** 原始 Markdown 字符串，最大不超过 1MB。 */
+    text: string;
+}
+export type PostTextMarkdownToPdfResponse = ArrayBuffer;
+export interface PostTextMarkdownToPdfArgs {
+    /** 为 true 时会自动附加 `_t` 时间戳，绕过服务端缓存。 */
+    disableCache?: boolean;
+    /** Same as `disableCache`. Kept for compatibility. */
+    "disable_cache"?: boolean;
+    /** 手动指定缓存穿透时间戳。传入后会原样带到查询参数中。 */
+    _t?: string | number;
+    /** PDF 的纸张大小。可选 `A4` 或 `Letter`，默认是 `A4`。 */
+    paperSize?: string;
+    /** Same as `paperSize`. Kept for compatibility. */
+    "paper_size"?: string;
+    /** 原始 Markdown 字符串，最大不超过 1MB。 */
+    text: string;
+    /** PDF 的排版主题。可选 `github`、`minimal`、`light`、`dark`，默认是 `github`。 */
+    theme?: string;
+}
 export type PostTextMd5Response = Internal.GetTextMd5200Response;
 export interface PostTextMd5Args {
     /** 为 true 时会自动附加 `_t` 时间戳，绕过服务端缓存。 */
@@ -1168,10 +1326,6 @@ export interface PostSearchAggregateArgs {
     timeRange?: string;
     /** Same as `timeRange`. Kept for compatibility. */
     "time_range"?: string;
-    /** 请求超时时间（毫秒），范围 1000-30000 */
-    timeoutMs?: number;
-    /** Same as `timeoutMs`. Kept for compatibility. */
-    "timeout_ms"?: number;
 }
 export declare class UapiClient {
     private baseURL;
@@ -1212,7 +1366,7 @@ export declare class UapiClient {
     readonly "智能搜索": ZhiNengSouSuoApi;
     constructor(baseURL: string, tokenOrOptions?: string | UapiClientOptions, maybeOptions?: UapiClientOptions);
     get lastResponseMeta(): ResponseMeta | undefined;
-    _request(method: string, path: string, params?: Record<string, unknown>, body?: Record<string, unknown>, headers?: Record<string, string>, responseKind?: 'json' | 'text' | 'arrayBuffer', requestOptions?: RequestOptions): Promise<any>;
+    _request(method: string, path: string, params?: Record<string, unknown>, body?: RequestBodyPayload, headers?: Record<string, string>, responseKind?: 'json' | 'text' | 'arrayBuffer', requestOptions?: RequestOptions): Promise<any>;
 }
 export declare class ClipzyZaiXianJianTieBanApi {
     private c;
@@ -1257,8 +1411,10 @@ export declare class ImageApi {
     constructor(c: UapiClient);
     /** 获取Gravatar头像 */
     getAvatarGravatar(args?: GetAvatarGravatarArgs): Promise<GetAvatarGravatarResponse>;
-    /** 必应壁纸 */
-    getImageBingDaily(): Promise<GetImageBingDailyResponse>;
+    /** 获取必应每日壁纸 */
+    getImageBingDaily(args?: GetImageBingDailyArgs): Promise<GetImageBingDailyResponse>;
+    /** 查询必应壁纸历史 */
+    getImageBingDailyHistory(args?: GetImageBingDailyHistoryArgs): Promise<GetImageBingDailyHistoryResponse>;
     /** 生成摸摸头GIF (QQ号) */
     getImageMotou(args: GetImageMotouArgs): Promise<GetImageMotouResponse>;
     /** 生成二维码 */
@@ -1267,12 +1423,16 @@ export declare class ImageApi {
     getImageTobase64(args: GetImageTobase64Args): Promise<GetImageTobase64Response>;
     /** 无损压缩图片 */
     postImageCompress(args: PostImageCompressArgs): Promise<PostImageCompressResponse>;
+    /** 解码并缩放图片 */
+    postImageDecode(args: PostImageDecodeArgs): Promise<PostImageDecodeResponse>;
     /** 通过Base64编码上传图片 */
     postImageFrombase64(args: PostImageFrombase64Args): Promise<PostImageFrombase64Response>;
     /** 生成摸摸头GIF */
     postImageMotou(args: PostImageMotouArgs): Promise<PostImageMotouResponse>;
     /** 图片敏感检测 */
     postImageNsfw(args: PostImageNsfwArgs): Promise<PostImageNsfwResponse>;
+    /** 通用 OCR 文字识别 */
+    postImageOcr(args: PostImageOcrArgs): Promise<PostImageOcrResponse>;
     /** 生成你们怎么不说话了表情包 */
     postImageSpeechless(args: PostImageSpeechlessArgs): Promise<PostImageSpeechlessResponse>;
     /** SVG转图片 */
@@ -1359,6 +1519,8 @@ export declare class SocialApi {
     constructor(c: UapiClient);
     /** 查询 GitHub 仓库 */
     getGithubRepo(args: GetGithubRepoArgs): Promise<GetGithubRepoResponse>;
+    /** 查询 GitHub 用户信息 */
+    getGithubUser(args: GetGithubUserArgs): Promise<GetGithubUserResponse>;
     /** 查询 B站投稿 */
     getSocialBilibiliArchives(args: GetSocialBilibiliArchivesArgs): Promise<GetSocialBilibiliArchivesResponse>;
     /** 查询 B站直播间 */
@@ -1403,6 +1565,10 @@ export declare class TextApi {
     postTextBase64Encode(args: PostTextBase64EncodeArgs): Promise<PostTextBase64EncodeResponse>;
     /** 格式转换 */
     postTextConvert(args: PostTextConvertArgs): Promise<PostTextConvertResponse>;
+    /** Markdown 转 HTML */
+    postTextMarkdownToHtml(args: PostTextMarkdownToHtmlArgs): Promise<PostTextMarkdownToHtmlResponse>;
+    /** Markdown 转 PDF */
+    postTextMarkdownToPdf(args: PostTextMarkdownToPdfArgs): Promise<PostTextMarkdownToPdfResponse>;
     /** MD5 哈希 (POST) */
     postTextMd5(args: PostTextMd5Args): Promise<PostTextMd5Response>;
     /** MD5 校验 */