uapi-browser-sdk 0.1.0

package/.editorconfig

@@ -0,0 +1,6 @@
+root = true
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

package/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: release
+on:
+  push:
+    tags: ['v*.*.*']
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm run build || npm run test --if-present
+      - name: Publish to npm
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true

package/.github/workflows/test.yml

@@ -0,0 +1,11 @@
+name: test
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with: { node-version: '20' }
+      - run: npm ci || npm i
+      - run: npm run build

package/README.md

@@ -0,0 +1,65 @@
+# uapi-browser-sdk
+
+![Banner](./banner.png)
+
+[![Browser TS](https://img.shields.io/badge/TypeScript-ES2020-3178C6?style=flat-square&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
+[![Docs](https://img.shields.io/badge/Docs-uapis.cn-2EAE5D?style=flat-square)](https://uapis.cn/)
+
+> [!NOTE]
+> 所有接口的 Browser (TypeScript) 示例都可以在 [UApi](https://uapis.cn/docs/introduction) 的接口文档页面，向下滚动至 **快速启动** 区块后直接复制。
+
+## 快速开始
+
+```bash
+npm i uapi-browser-sdk
+```
+
+```ts
+import { UapiClient } from 'uapi-browser-sdk'
+
+const client = new UapiClient('https://uapis.cn/api/v1')
+const result = await client.social.getSocialQqUserinfo({ qq: '10001' })
+console.log(result)
+```
+
+## 特性
+
+现在你不再需要反反复复的查阅文档了。
+
+只需在 IDE 中键入 `client.`，所有核心模块——如 `social`、`game`、`image`——即刻同步展现。进一步输入即可直接定位到 `getSocialQqUserinfo` 这样的具体方法，其名称与文档的 `operationId` 严格保持一致，确保了开发过程的直观与高效。
+
+所有方法签名只接受真实且必需的参数。当你在构建请求时，TypeScript 会即时提示 `qq`、`username` 等键名，这彻底杜绝了在对象字面量中因键名拼写错误而导致的运行时错误。
+
+针对 401、404、429 等标准 HTTP 响应，SDK 已将其统一映射为 `UapiError`。错误对象自带 `code`、`status` 与 `details` 字段，确保你在浏览器日志中能第一时间准确、快速地诊断问题。
+
+SDK 采用原生 `fetch`，自动补上 `Authorization` 头且不依赖任何 Node.js API；需要自定义超时或重试时，只要包装 `_request` 或替换调用处即可。
+
+如果你需要查看字段细节或内部逻辑，仓库中的 `./internal` 目录同步保留了由 `openapi-generator` 生成的完整结构体，随时可供参考。
+
+## 错误模型概览
+
+| HTTP 状态码 | SDK 错误类型 | 附加信息                                     |
+|-------------|-------------|----------------------------------------------|
+| 401/403     | `UapiError` | `code`、`status`、`details`                  |
+| 404         | `UapiError` | `code`、`status`                             |
+| 400         | `UapiError` | `code`、`status`、`details`                  |
+| 429         | `UapiError` | `code`、`status`、`retry_after_seconds`      |
+| 5xx         | `UapiError` | `code`、`status`                             |
+
+## 其他 SDK
+
+| 语言        | 仓库地址                                                     |
+|-------------|--------------------------------------------------------------|
+| Go          | https://github.com/AxT-Team/uapi-go-sdk                      |
+| Python      | https://github.com/AxT-Team/uapi-python-sdk                  |
+| TypeScript| https://github.com/AxT-Team/uapi-typescript-sdk           |
+| Browser (TypeScript/JavaScript)（当前）| https://github.com/AxT-Team/uapi-browser-sdk        |
+| Java        | https://github.com/AxT-Team/uapi-java-sdk                    |
+| PHP         | https://github.com/AxT-Team/uapi-php-sdk                     |
+| C#          | https://github.com/AxT-Team/uapi-csharp-sdk                  |
+| C++         | https://github.com/AxT-Team/uapi-cpp-sdk                     |
+| Rust        | https://github.com/AxT-Team/uapi-rust-sdk                    |
+
+## 文档
+
+访问 [UApi文档首页](https://uapis.cn/docs/introduction) 并选择任意接口，向下滚动到 **快速启动** 区块即可看到最新的 Browser (TypeScript) 示例代码。

package/dist/index.d.ts

@@ -0,0 +1,170 @@
+export declare class UapiError extends Error {
+    code: string;
+    status: number;
+    details?: any | undefined;
+    constructor(code: string, status: number, details?: any | undefined);
+}
+export declare class UapiClient {
+    private baseURL;
+    private token?;
+    constructor(baseURL: string, token?: string | undefined);
+    clipzyZaiXianJianTieBan: ClipzyZaiXianJianTieBanApi;
+    convert: ConvertApi;
+    daily: DailyApi;
+    game: GameApi;
+    image: ImageApi;
+    misc: MiscApi;
+    network: NetworkApi;
+    poem: PoemApi;
+    random: RandomApi;
+    social: SocialApi;
+    status: StatusApi;
+    text: TextApi;
+    translate: TranslateApi;
+    webparse: WebparseApi;
+    minGanCiShiBie: MinGanCiShiBieApi;
+    zhiNengSouSuo: ZhiNengSouSuoApi;
+    _request(method: string, path: string, params?: Record<string, any>, body?: any): Promise<any>;
+}
+declare class ClipzyZaiXianJianTieBanApi {
+    private c;
+    constructor(c: UapiClient);
+    getClipzyGet(args?: any): Promise<any>;
+    getClipzyRaw(args?: any): Promise<any>;
+    postClipzyStore(args?: any): Promise<any>;
+}
+declare class ConvertApi {
+    private c;
+    constructor(c: UapiClient);
+    getConvertUnixtime(args?: any): Promise<any>;
+    postConvertJson(args?: any): Promise<any>;
+}
+declare class DailyApi {
+    private c;
+    constructor(c: UapiClient);
+    getDailyNewsImage(args?: any): Promise<any>;
+}
+declare class GameApi {
+    private c;
+    constructor(c: UapiClient);
+    getGameEpicFree(args?: any): Promise<any>;
+    getGameMinecraftHistoryid(args?: any): Promise<any>;
+    getGameMinecraftServerstatus(args?: any): Promise<any>;
+    getGameMinecraftUserinfo(args?: any): Promise<any>;
+    getGameSteamSummary(args?: any): Promise<any>;
+}
+declare class ImageApi {
+    private c;
+    constructor(c: UapiClient);
+    getAvatarGravatar(args?: any): Promise<any>;
+    getImageBingDaily(args?: any): Promise<any>;
+    getImageMotou(args?: any): Promise<any>;
+    getImageQrcode(args?: any): Promise<any>;
+    getImageTobase64(args?: any): Promise<any>;
+    postImageCompress(args?: any): Promise<any>;
+    postImageFrombase64(args?: any): Promise<any>;
+    postImageMotou(args?: any): Promise<any>;
+    postImageSpeechless(args?: any): Promise<any>;
+    postImageSvg(args?: any): Promise<any>;
+}
+declare class MiscApi {
+    private c;
+    constructor(c: UapiClient);
+    getHistoryProgrammer(args?: any): Promise<any>;
+    getHistoryProgrammerToday(args?: any): Promise<any>;
+    getMiscHotboard(args?: any): Promise<any>;
+    getMiscPhoneinfo(args?: any): Promise<any>;
+    getMiscRandomnumber(args?: any): Promise<any>;
+    getMiscTimestamp(args?: any): Promise<any>;
+    getMiscTrackingCarriers(args?: any): Promise<any>;
+    getMiscTrackingDetect(args?: any): Promise<any>;
+    getMiscTrackingQuery(args?: any): Promise<any>;
+    getMiscWeather(args?: any): Promise<any>;
+    getMiscWorldtime(args?: any): Promise<any>;
+}
+declare class NetworkApi {
+    private c;
+    constructor(c: UapiClient);
+    getNetworkDns(args?: any): Promise<any>;
+    getNetworkIcp(args?: any): Promise<any>;
+    getNetworkIpinfo(args?: any): Promise<any>;
+    getNetworkMyip(args?: any): Promise<any>;
+    getNetworkPing(args?: any): Promise<any>;
+    getNetworkPingmyip(args?: any): Promise<any>;
+    getNetworkPortscan(args?: any): Promise<any>;
+    getNetworkUrlstatus(args?: any): Promise<any>;
+    getNetworkWhois(args?: any): Promise<any>;
+    getNetworkWxdomain(args?: any): Promise<any>;
+}
+declare class PoemApi {
+    private c;
+    constructor(c: UapiClient);
+    getSaying(args?: any): Promise<any>;
+}
+declare class RandomApi {
+    private c;
+    constructor(c: UapiClient);
+    getAnswerbookAsk(args?: any): Promise<any>;
+    getRandomImage(args?: any): Promise<any>;
+    getRandomString(args?: any): Promise<any>;
+    postAnswerbookAsk(args?: any): Promise<any>;
+}
+declare class SocialApi {
+    private c;
+    constructor(c: UapiClient);
+    getGithubRepo(args?: any): Promise<any>;
+    getSocialBilibiliArchives(args?: any): Promise<any>;
+    getSocialBilibiliLiveroom(args?: any): Promise<any>;
+    getSocialBilibiliReplies(args?: any): Promise<any>;
+    getSocialBilibiliUserinfo(args?: any): Promise<any>;
+    getSocialBilibiliVideoinfo(args?: any): Promise<any>;
+    getSocialQqGroupinfo(args?: any): Promise<any>;
+    getSocialQqUserinfo(args?: any): Promise<any>;
+}
+declare class StatusApi {
+    private c;
+    constructor(c: UapiClient);
+    getStatusRatelimit(args?: any): Promise<any>;
+    getStatusUsage(args?: any): Promise<any>;
+}
+declare class TextApi {
+    private c;
+    constructor(c: UapiClient);
+    getTextMd5(args?: any): Promise<any>;
+    postTextAesDecrypt(args?: any): Promise<any>;
+    postTextAesEncrypt(args?: any): Promise<any>;
+    postTextAnalyze(args?: any): Promise<any>;
+    postTextBase64Decode(args?: any): Promise<any>;
+    postTextBase64Encode(args?: any): Promise<any>;
+    postTextMd5(args?: any): Promise<any>;
+    postTextMd5Verify(args?: any): Promise<any>;
+}
+declare class TranslateApi {
+    private c;
+    constructor(c: UapiClient);
+    getAiTranslateLanguages(args?: any): Promise<any>;
+    postAiTranslate(args?: any): Promise<any>;
+    postTranslateText(args?: any): Promise<any>;
+}
+declare class WebparseApi {
+    private c;
+    constructor(c: UapiClient);
+    getWebTomarkdownAsyncStatus(args?: any): Promise<any>;
+    getWebparseExtractimages(args?: any): Promise<any>;
+    getWebparseMetadata(args?: any): Promise<any>;
+    postWebTomarkdownAsync(args?: any): Promise<any>;
+}
+declare class MinGanCiShiBieApi {
+    private c;
+    constructor(c: UapiClient);
+    getSensitiveWordAnalyzeQuery(args?: any): Promise<any>;
+    postSensitiveWordAnalyze(args?: any): Promise<any>;
+    postSensitiveWordQuickCheck(args?: any): Promise<any>;
+}
+declare class ZhiNengSouSuoApi {
+    private c;
+    constructor(c: UapiClient);
+    getSearchEngines(args?: any): Promise<any>;
+    postSearchAggregate(args?: any): Promise<any>;
+}
+export {};