zentao-api 0.1.0 → 0.2.0-beta.2

package/dist/types/index.d.ts

@@ -0,0 +1,296 @@
+import type { ZentaoClient } from '../client/index.js';
+/** 创建 {@link ZentaoClient} 时使用的配置。 */
+export interface ZentaoClientOptions {
+    /** 禅道站点根地址，例如 `https://zentao.example.com`；SDK 会自动拼接 `/api.php/v2`。 */
+    baseUrl: string;
+    /** 禅道 API Token；未提供时可稍后通过 {@link ZentaoClient.login} 获取并写入实例。 */
+    token?: string;
+    /** 默认请求超时时间，单位毫秒。 */
+    timeout?: number;
+    /** 是否跳过 TLS 证书验证；仅 Node.js 运行时支持，浏览器中会抛错。 */
+    insecure?: boolean;
+}
+/** SDK 进程级全局默认选项，供高阶 {@link request} 调用复用。 */
+export interface GlobalOptions {
+    /** 默认客户端；通常由 `ZentaoClient.init()` 设置。 */
+    client?: ZentaoClient;
+    /** 默认每页记录数，会映射到模块动作的 `recPerPage` 参数。 */
+    recPerPage?: string;
+    /** 默认限制返回列表数量，只影响 SDK 归一化后的 `data`。 */
+    limit?: string;
+    /** 默认请求超时时间，优先级低于单次请求选项。 */
+    timeout?: number;
+    /** 默认 TLS 跳过证书验证选项；仅 Node.js 运行时支持。 */
+    insecure?: boolean;
+    /** 是否在登录成功后把账号、Token 和配置持久化为本地 profile。 */
+    persistProfiles?: boolean;
+}
+/** SDK 支持的 HTTP 方法。 */
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE';
+/** `ZentaoClient.request()` 的单次请求选项。 */
+export interface ClientRequestOptions {
+    /** HTTP 方法，默认 `GET`。 */
+    method?: HttpMethod;
+    /** JSON 请求体；`GET` 请求会忽略该字段。 */
+    body?: Record<string, unknown>;
+    /** URL 查询参数；`undefined` 值会被跳过。 */
+    query?: Record<string, string | number | boolean | undefined>;
+    /** 单次请求超时时间，优先级高于全局和客户端默认值。 */
+    timeout?: number;
+    /** 单次请求 TLS 跳过证书验证选项；仅 Node.js 运行时支持。 */
+    insecure?: boolean;
+}
+/** 高阶 `request("moduleName/methodName")` 的单次调用选项。 */
+export interface RequestOptions {
+    /** 本次调用使用的客户端；优先级高于全局客户端。 */
+    client?: ZentaoClient;
+    /** 本次调用使用的每页记录数，优先级高于全局 `recPerPage`。 */
+    recPerPage?: string;
+    /** 本次调用限制返回列表数量，优先级高于全局 `limit`。 */
+    limit?: string;
+    /** 本次调用超时时间。 */
+    timeout?: number;
+    /** 本次调用 TLS 跳过证书验证选项；仅 Node.js 运行时支持。 */
+    insecure?: boolean;
+}
+/** 高阶 `request()` 归一化后的返回数据。 */
+export interface ResponseData {
+    /** 禅道服务端状态；非标准响应会按成功响应包装到 `data`。 */
+    status: 'success' | 'fail';
+    /** 禅道服务端返回的消息。 */
+    message?: string;
+    /** 根据模块动作 `resultGetter` 提取后的业务数据。 */
+    data?: any;
+    /** 统一分页信息。 */
+    pager?: {
+        /** 总记录数。 */
+        total: number;
+        /** 当前页码。 */
+        page: number;
+        /** 每页记录数。 */
+        recPerPage: number;
+    };
+}
+/** 禅道 API 原始分页结构。 */
+export interface Pager {
+    /** 总记录数。 */
+    recTotal: number;
+    /** 每页记录数。 */
+    recPerPage: number;
+    /** 总页数，部分接口不返回。 */
+    pageTotal?: number;
+    /** 当前页码。 */
+    pageID: number;
+}
+/** 禅道 API 通用响应结构，允许携带任意业务字段。 */
+export interface ApiResponse {
+    /** 服务端返回状态。 */
+    status: 'success' | 'fail';
+    /** 服务端消息，可能是字符串、对象或数组。 */
+    message?: unknown;
+    /** 其他业务字段。 */
+    [key: string]: unknown;
+}
+/** 禅道 API 列表响应结构。 */
+export interface ApiListResponse extends ApiResponse {
+    /** 原始分页信息。 */
+    pager?: Pager;
+}
+/** 登录接口响应结构。 */
+export interface LoginResponse extends ApiResponse {
+    /** 登录成功后返回的 API Token。 */
+    token?: string;
+    /** 部分禅道环境会随登录响应返回用户信息。 */
+    user?: Record<string, unknown>;
+    /** 部分禅道环境会随登录响应返回服务端配置。 */
+    serverConfig?: ServerConfig;
+}
+/** 禅道 `?mode=getconfig` 返回的服务端配置。 */
+export interface ServerConfig {
+    version: string;
+    systemMode: string;
+    sprintConcept: string;
+    requestType: string;
+    requestFix: string;
+    moduleVar: string;
+    methodVar: string;
+    viewVar: string;
+    sessionVar: string;
+}
+/** 保存到本地 profile 中的客户端偏好配置。 */
+export interface ZentaoProfileConfig {
+    /** 默认输出格式，供 CLI 等上层应用复用。 */
+    defaultOutputFormat?: 'markdown' | 'json' | 'raw';
+    /** 界面语言。 */
+    lang?: string;
+    /** 默认分页大小。 */
+    defaultRecPerPage?: number;
+    /** 是否跳过 TLS 证书验证；仅 Node.js 运行时支持。 */
+    insecure?: boolean;
+    /** 是否将对象属性中的 HTML 转换为 Markdown。 */
+    htmlToMarkdown?: boolean;
+    /** 请求超时时间，单位毫秒。 */
+    timeout?: number;
+    /** 是否在批量操作出错时停止执行后续操作。 */
+    batchFailFast?: boolean;
+    /** JSON 格式化时是否添加缩进。 */
+    jsonPretty?: boolean;
+    /** 模块级分页偏好。 */
+    pagers?: Record<string, number>;
+    /** 允许上层应用保存自定义配置。 */
+    [key: string]: unknown;
+}
+/** 本地持久化的禅道账号 profile。 */
+export interface ZentaoProfile {
+    /** 禅道站点根地址，不包含 `/api.php/v2`。 */
+    server: string;
+    /** 用户账号。 */
+    account: string;
+    /** 禅道 API Token。 */
+    token: string;
+    /** 登录验证通过后得到的用户信息。 */
+    user?: Record<string, unknown>;
+    /** 登录时间。 */
+    loginTime?: string;
+    /** 最后使用时间。 */
+    lastUsedTime?: string;
+    /** 禅道服务端配置。 */
+    serverConfig?: ServerConfig;
+    /** 客户端自定义配置。 */
+    config?: ZentaoProfileConfig;
+    /** 允许上层应用保存额外字段。 */
+    [key: string]: unknown;
+}
+/** 运行时返回的 profile，会额外带上 `account@server` 形式的 key。 */
+export interface ZentaoProfileRecord extends ZentaoProfile {
+    key: string;
+}
+/** 本地 profile 存储文件或浏览器 localStorage 中的 JSON 结构。 */
+export interface ZentaoProfilesStore {
+    /** 当前使用的 profile key。 */
+    currentProfile?: string;
+    /** 保存的 profile 列表。 */
+    profiles: ZentaoProfile[];
+}
+/** 模块动作类型：基础 CRUD 或自定义动作。 */
+export type ModuleActionType = 'list' | 'get' | 'create' | 'update' | 'delete' | 'action';
+/** 模块动作使用的 HTTP 方法；兼容生成定义中的小写方法。 */
+export type ModuleActionMethod = HttpMethod | Lowercase<HttpMethod>;
+/** 模块动作名称，允许除基础动作外的自定义名称。 */
+export type ModuleActionName = ModuleActionType | (string & {});
+/** 模块动作参数可选项。 */
+export type ModuleActionParamOption = {
+    value: unknown;
+    label: string;
+};
+/** 模块动作的查询参数定义。 */
+export interface ModuleActionParam {
+    /** 参数名称。 */
+    name: string;
+    /** 参数说明。 */
+    description?: string;
+    /** 是否必填。 */
+    required?: boolean;
+    /** 未显式传入时使用的默认值。 */
+    defaultValue?: unknown;
+    /** 参数值类型，用于基础类型转换。 */
+    type?: 'string' | 'number' | 'boolean';
+    /** 参数可选值。 */
+    options?: ModuleActionParamOption[];
+}
+/** 模块动作结果形态。 */
+export type ModuleActionResultType = 'text' | 'object' | 'list';
+/** 列表分页信息别名。 */
+export type ListPagerInfo = Pager;
+/** 模块动作请求体定义。 */
+export interface ModuleActionRequestBody {
+    /** 请求体类型。 */
+    type?: 'object' | 'string';
+    /** 请求体是否必填。 */
+    required?: boolean;
+    /** OpenAPI 风格 schema，用于从 params 组装 body。 */
+    schema: Record<string, unknown>;
+    /** 请求体示例。 */
+    example?: unknown;
+}
+/** 模块动作响应定义。 */
+export interface ModuleActionResponse {
+    /** 响应说明。 */
+    description?: string;
+    /** 响应 schema。 */
+    schema: Record<string, unknown>;
+    /** 响应示例。 */
+    example?: unknown;
+}
+/** 模块动作渲染目标类型；保留给 CLI 等上层应用使用。 */
+export type ModuleActionResultRenderType = 'markdown' | 'json' | 'raw';
+/** 模块动作自定义渲染函数类型；SDK 本身不直接渲染终端输出。 */
+export type ModuleActionResultRender = (result: unknown, type: ModuleActionResultRenderType, action: ModuleAction) => string;
+/** 从原始响应中提取分页字段时使用的字段映射。 */
+export interface ModuleActionPagerGetterMap {
+    /** 当前页码字段名。 */
+    pageID: string;
+    /** 每页记录数字段名。 */
+    recPerPage: string;
+    /** 总记录数字段名。 */
+    recTotal: string;
+}
+/** 禅道模块中的单个 API 动作定义。 */
+export interface ModuleAction {
+    /** 动作名称，例如 `list`、`get`、`close`。 */
+    name: ModuleActionName;
+    /** 动作类型，决定高阶 request 的路径/参数解析策略。 */
+    type: ModuleActionType;
+    /** 面向用户展示的动作名称。 */
+    display?: string;
+    /** 动作说明。 */
+    description?: string;
+    /** HTTP 方法。 */
+    method: ModuleActionMethod;
+    /** API 路径模板，可包含 `{productID}` 等路径参数。 */
+    path: string;
+    /** 路径参数定义；字符串为说明，对象可携带默认值和可选项。 */
+    pathParams?: Record<string, string | Omit<ModuleActionParam, 'name'>>;
+    /** 查询参数定义。 */
+    params?: ModuleActionParam[];
+    /** 请求体定义。 */
+    requestBody?: ModuleActionRequestBody;
+    /** 结果形态。 */
+    resultType: ModuleActionResultType;
+    /** 从原始响应中提取分页信息的位置或函数。 */
+    pagerGetter?: string | ModuleActionPagerGetterMap | ((data: unknown, params: Record<string, unknown>) => ListPagerInfo);
+    /** 从原始响应中提取业务数据的位置或函数。 */
+    resultGetter?: string | Record<string, string> | ((data: unknown, params: Record<string, unknown>) => unknown);
+    /** 供上层应用使用的渲染配置。 */
+    render?: string | ModuleActionResultRender | Record<ModuleActionResultRenderType, ModuleActionResultRender>;
+}
+/** 内置模块名称，同时允许用户扩展自定义模块名。 */
+export type ModuleName = 'user' | 'program' | 'product' | 'project' | 'execution' | 'productplan' | 'story' | 'epic' | 'requirement' | 'bug' | 'testcase' | 'task' | 'feedback' | 'ticket' | 'system' | 'build' | 'testtask' | 'release' | 'file' | (string & {});
+/** 禅道模块定义，由多个动作组成。 */
+export interface ModuleDefinition {
+    /** 模块名称，例如 `product`、`bug`。 */
+    name: ModuleName;
+    /** 面向用户展示的模块名称。 */
+    display?: string;
+    /** 模块说明。 */
+    description?: string;
+    /** 模块支持的动作集合。 */
+    actions: ModuleAction[];
+}
+/** 将模块动作和参数解析后的可执行请求描述。 */
+export interface ResolvedModuleCommand {
+    /** 模块名称。 */
+    module: string;
+    /** 匹配到的动作定义。 */
+    action: ModuleAction;
+    /** 原始调用参数。 */
+    params: Record<string, unknown>;
+    /** 已替换路径参数后的 API 路径。 */
+    path: string;
+    /** 已组装的查询参数。 */
+    query?: Record<string, string | number>;
+    /** 已组装的请求体。 */
+    data?: Record<string, unknown>;
+    /** 从 `id` 或 `{module}ID` 推断出的对象 ID。 */
+    id?: number;
+}

package/dist/types/index.js

@@ -0,0 +1 @@
+export {};

package/dist/utils/index.d.ts

@@ -0,0 +1,6 @@
+/** 判断值是否为普通对象（非数组、非 null）。 */
+export declare function isRecord(value: unknown): value is Record<string, unknown>;
+/** 将用户传入的站点根地址规范化，兼容误传入 `/api.php/v2` 的场景。 */
+export declare function normalizeSiteUrl(baseUrl: string): string;
+export declare function getNestedValue(obj: unknown, path: string): unknown;
+export declare function asArray<T>(value: T | T[]): T[];

package/dist/utils/index.js

@@ -0,0 +1,26 @@
+import { ZentaoError } from '../misc/errors.js';
+/** 判断值是否为普通对象（非数组、非 null）。 */
+export function isRecord(value) {
+    return Boolean(value) && typeof value === 'object' && !Array.isArray(value);
+}
+/** 将用户传入的站点根地址规范化，兼容误传入 `/api.php/v2` 的场景。 */
+export function normalizeSiteUrl(baseUrl) {
+    const trimmed = baseUrl.trim().replace(/\/+$/, '');
+    if (!trimmed)
+        throw new ZentaoError('E_INVALID_BASE_URL');
+    return trimmed.replace(/\/api\.php\/v2$/i, '');
+}
+export function getNestedValue(obj, path) {
+    const keys = path.split('.');
+    let current = obj;
+    for (const key of keys) {
+        if (current === null || current === undefined || typeof current !== 'object') {
+            return undefined;
+        }
+        current = current[key];
+    }
+    return current;
+}
+export function asArray(value) {
+    return Array.isArray(value) ? value : [value];
+}

package/dist/version.d.ts

@@ -0,0 +1,2 @@
+export declare const BUILD: string;
+export declare const VERSION: string;

package/dist/version.js

@@ -0,0 +1,4 @@
+const fallbackBuild = "2026-05-11T13:46:14.715Z";
+const fallbackVersion = "0.2.0-beta.2";
+export const BUILD = typeof __ZENTAO_API_BUILD__ === 'string' ? __ZENTAO_API_BUILD__ : fallbackBuild;
+export const VERSION = typeof __ZENTAO_API_VERSION__ === 'string' ? __ZENTAO_API_VERSION__ : fallbackVersion;

package/package.json

@@ -1,93 +1,69 @@
 {
   "name": "zentao-api",
-  "description": "JavaScript client libary for ZenTao SDK http://www.zentao.net/book/api/setting-369.html",
-  "version": "0.1.0",
-  "author": "Catouse <catouse@gmail.com> https://github.com/catouse",
-  "homepage": "https://github.com/catouse/zentao-api#readme",
+  "version": "0.2.0-beta.2",
+  "type": "module",
+  "description": "Browser and Node.js SDK for ZenTao API",
   "license": "MIT",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "author": "Sun Hao <sunhao@chandao.com>",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/catouse/zentao-api.git"
+    "url": "https://github.com/catouse/zentao-api"
   },
-  "bugs": {
-    "url": "https://github.com/catouse/zentao-api/issues"
+  "keywords": [
+    "zentao",
+    "禅道",
+    "api",
+    "sdk",
+    "browser"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./browser": "./dist/browser/zentao-api.global.js",
+    "./package.json": "./package.json"
   },
   "files": [
     "dist",
-    "src"
+    "README.md",
+    "LICENSE"
   ],
-  "keywords": [
-    "ZenTao",
-    "API",
-    "Client",
-    "SDK"
-  ],
-  "engines": {
-    "node": ">=10"
-  },
   "scripts": {
-    "start": "tsdx watch",
-    "build": "tsdx build",
-    "test": "tsdx test",
-    "lint": "tsdx lint",
-    "prepare": "tsdx build",
-    "size": "size-limit",
-    "analyze": "size-limit --why",
-    "doc": "typedoc --out docs/ --theme default --excludePrivate --excludeProtected --excludeExternals src/"
+    "test": "bun test",
+    "test:real": "bun ./tests/real-env-runner.ts",
+    "test:coverage": "bun test --coverage",
+    "typecheck": "tsc --noEmit",
+    "typecheck:tests": "tsc -p tsconfig.test.json --noEmit",
+    "registry:check": "bun run scripts/update-registry.ts --check",
+    "build": "rm -rf dist && tsc -p tsconfig.json && bun run scripts/build-browser.ts",
+    "smoke:node": "node scripts/smoke-node.mjs",
+    "smoke:package": "bun run scripts/smoke-package.ts",
+    "docs:reference": "typedoc",
+    "docs:zentao-api": "bun run scripts/generate-zentao-api-docs.ts",
+    "docs:generate": "bun run docs:reference && bun run docs:zentao-api",
+    "docs:dev": "bun run docs:generate && vitepress dev docs",
+    "docs:build": "bun run docs:generate && vitepress build docs",
+    "docs:preview": "bun run docs:build && vitepress preview docs",
+    "check": "bun run test:coverage && bun run typecheck && bun run typecheck:tests && bun run registry:check && bun run build && bun run smoke:node && bun run smoke:package",
+    "prepublishOnly": "bun run check"
   },
-  "peerDependencies": {},
-  "husky": {
-    "hooks": {
-      "pre-commit": "tsdx lint"
-    }
-  },
-  "prettier": {
-    "printWidth": 80,
-    "semi": true,
-    "tabWidth": 4,
-    "singleQuote": true,
-    "trailingComma": "es5",
-    "bracketSpacing": false,
-    "useTabs": false
+  "dependencies": {
+    "turndown": "^7.2.0"
   },
-  "module": "dist/zentao-api.esm.js",
-  "size-limit": [
-    {
-      "path": "dist/zentao-api.cjs.production.min.js",
-      "limit": "10 KB"
-    },
-    {
-      "path": "dist/zentao-api.esm.js",
-      "limit": "10 KB"
-    }
-  ],
   "devDependencies": {
-    "@size-limit/preset-small-lib": "^4.9.2",
-    "@types/configstore": "^4.0.0",
-    "@types/md5": "^2.3.0",
-    "@typescript-eslint/eslint-plugin": "^4.17.0",
-    "@typescript-eslint/parser": "^4.17.0",
-    "husky": "^5.1.1",
-    "size-limit": "^4.9.2",
-    "tsdx": "^0.14.1",
-    "tslib": "^2.1.0",
-    "typedoc": "^0.20.30",
-    "typescript": "^4.2.3"
+    "@types/bun": "^1.3.13",
+    "@types/node": "^24.10.0",
+    "@types/turndown": "^5.0.5",
+    "typedoc": "^0.28.19",
+    "typedoc-plugin-markdown": "^4.11.0",
+    "typedoc-vitepress-theme": "^1.1.2",
+    "typescript": "^5.7.0",
+    "vitepress": "^1.6.4"
   },
-  "dependencies": {
-    "axios": "^0.21.1",
-    "configstore": "^5.0.1",
-    "form-data": "^4.0.0",
-    "kleur": "^4.1.4",
-    "md5": "^2.3.0"
-  },
-  "resolutions": {
-    "**/typescript": "^4.2.3",
-    "**/@typescript-eslint/eslint-plugin": "^4.17.0",
-    "**/@typescript-eslint/parser": "^4.17.0",
-    "**/jest": "^26.6.3",
-    "**/ts-jest": "^26.5.3"
+  "engines": {
+    "node": ">=18"
   }
 }

package/dist/types.d.ts

@@ -1,70 +0,0 @@
-import { Method } from 'axios';
-/**
- * 支持的禅道请求方式，影响 API 请求 URL 构建方式
- */
-export declare type ZentaoRequestType = 'PATH_INFO' | 'GET';
-/**
- * 禅道请求参数键值对
- */
-export declare type ZentaoRequestParamPair = any[];
-/**
- * 禅道请求参数
- */
-export declare type ZentaoRequestParams = Array<ZentaoRequestParamPair> | string[] | string | Record<string, any>;
-/**
- * 禅道 API 请求方式
- */
-export declare type ZentaoRequestMethod = Method;
-/**
- * 禅道 API 返回结果
- */
-export interface ZentaoApiResult {
-    /**
-     * 状态
-     *
-     * @remarks
-     * 如果为 `0` 则表示操作请求失败，如果为 `1`，表示操作请求成功
-     */
-    status: 0 | 1;
-    /**
-     * 服务器返回的描述结果的文本
-     */
-    msg?: any;
-    /**
-     * 请求结果数据
-     */
-    result?: any;
-}
-/**
- * 禅道 API 初始化选项
- */
-export interface ZentaoOptions {
-    /**
-     * 禅道服务器地址
-     */
-    readonly url: string;
-    /**
-     * 登录账号
-     */
-    readonly account: string;
-    /**
-     * 登录密码
-     */
-    readonly password: string;
-    /**
-     * 请求形式
-     */
-    readonly accessMode?: ZentaoRequestType;
-    /**
-     * 是否将 token 存储到本地，如果设置为 `false`，则每次创建新的 `Zentao` 实例都会在首次调用 API 之前重新获取 Token
-     */
-    readonly preserveToken?: boolean;
-    /**
-     * 当前 `Zentao` 实例名称
-     */
-    readonly sessionName?: string;
-    /**
-     * 如果设置为 `true`，则会在控制台输出详细日志
-     */
-    readonly debug?: boolean;
-}

package/dist/utils.d.ts

@@ -1,93 +0,0 @@
-import { ZentaoRequestParamPair, ZentaoRequestParams } from './types';
-/**
- * 创建一个 Date 对象
- * @param {Date|number|String} [date=null] 用于创建 Date 对象的日期时间表达值，如果留空则创建当前系统时间对象
- * @return {Date} 日期时间对象
- * @function
- */
-export declare const createDate: (date: Date | number | string) => Date;
-/**
- * 格式化日期时间值为字符串
- * @remarks
- * 所有可用的格式化参数有：
- * - `yyyy`，例如：'2018'，表示四位数字表示的年份
- * - `yy`，例如：'18'，表示两位数字表示的年份
- * - `MM`，例如：'07'，表示两位数字表示的月份，不足两位在起始用 0 填充
- * - `M`，例如：'10'，表示一位或两位数字表示的月份
- * - `dd`，例如：'05'，表示两位数字表示的日期，不足两位在起始用 0 填充
- * - `d`，例如：'5'，表示一位或两位数字表示的日期
- * - `hh`，例如：'08'，表示两位数字表示的小时，不足两位在起始用 0 填充
- * - `h`，例如：'8'，表示一位或两位数字表示的小时
- * - `mm`，例如：'3'，表示两位数字表示的分钟，不足两位在起始用 0 填充
- * - `m`，例如：'03'，表示一位或两位数字表示的分钟
- * - `ss`，例如：'5'，表示两位数字表示的秒数，不足两位在起始用 0 填充
- * - `s`，例如：'05'，表示一位或两位数字表示的秒数
- * - `S`，例如：'236'，表示毫秒数
- * - `SSS`，例如：'036'，表示毫秒数，不足3位在起始用 0 填充
- * @summary 格式化日期时间值为字符串
- * @param {Date|number|string} date 要格式化的日期时间表达值
- * @param {string} [format='yyyy-MM-dd hh:ss'] 格式化字符串
- * @return {string} 日期时间格式化文本
- * @function
- */
-export declare const formatDate: (date: Date | number | string, format?: string) => string;
-/**
- * 格式化禅道地址
- * @param url 禅道地址
- * @returns 格式化后的禅道地址
- * @example
- * // 以下例子都返回 `http://demo.zentao.net/`
- * formatZentaoUrl('http://demo.zentao.net');
- * formatZentaoUrl('http://demo.zentao.net');
- * formatZentaoUrl('http://demo.zentao.net/index.php');
- * formatZentaoUrl('demo.zentao.net');
- */
-export declare function formatZentaoUrl(url: string): string;
-/**
- * 创建一个新的对象，仅保留给定的原始对象上给定的属性
- * @param object 给定的原始对象
- * @param fields 要保留属性名称列表
- * @returns 新的对象
- * @example
- * const obj = {a: 1, b: 2, c: 3, d: 4};
- * slimmingObject(obj, ['b', 'c']); // 返回 `{b: 2, c: 3}`
- */
-export declare function slimmingObject(object: any, fields: string[]): any;
-/**
- * 格式化请求参数定义
- * @param params 要格式化的参数定义
- * @returns 格式化后的参数列表
- * @example
- * // 下面返回：`[['foo', 'bar'], ['hello', 'world']]`
- * normalizeRequestParams([['foo', 'bar'], ['hello', 'world']]);
- *
- * // 下面返回：`[['foo', 'bar'], ['hello', 'world']]`
- * normalizeRequestParams('foo=bar&hello=world');
- *
- * // 下面返回：`[['foo', 'bar'], ['hello', 'world']]`
- * normalizeRequestParams({foo: 'bar', hello: 'world'});
- *
- * // 下面返回：`[['', 'bar'], ['', 'world']]`
- * normalizeRequestParams(['foo', 'bar']);
- *
- * // 下面返回：`[['foo', 'bar'], ['', 'world']]`
- * normalizeRequestParams([['foo', 'bar'], 'bar']);
- */
-export declare function normalizeRequestParams(params?: ZentaoRequestParams): ZentaoRequestParamPair[];
-/**
- * 合并两个请求参数定义，并返回合并且格式化后的定义
- * @param params 参数定义
- * @param otherParams 要合并的其他参数定义
- * @returns 合并后的参数列表
- * @example
- * const params1 = {foo: 'bar', hello: 'world'};
- * const params2 = 'answer='42'';
- * const params3 = [['foo', 'ter'], ['say', 'hi']];
- *
- * // 以下返回 `[['foo', 'bar'], ['answer', '42']]`
- * mergeRequestParams(params1, params2);
- *
- * // 以下返回 `[['foo', ['bar', 'ter']], ['answer', '42'], ['hello', 'world'], ['say', 'hi']]`
- * mergeRequestParams(params1, params2, params3);
- */
-export declare function mergeRequestParams(params: ZentaoRequestParams, ...otherParams: ZentaoRequestParams[]): ZentaoRequestParamPair[];