zentao-api 0.1.0 → 0.2.0-beta.2

package/dist/zentao-request-builder.d.ts

@@ -1,120 +0,0 @@
-import { Method } from 'axios';
-import { ZentaoApiResult, ZentaoRequestParams } from './types';
-import Zentao from './zentao';
-/**
- * 禅道请求构建类
- * @internal
- */
-export default class ZentaoRequestBuilder {
-    /**
-     * 禅道请求实例
-     */
-    readonly zentao: Zentao;
-    /**
-     * 模块名
-     */
-    readonly moduleName: string;
-    _methodName: string;
-    _params?: ZentaoRequestParams;
-    _data?: string | Record<string, any>;
-    _fields?: string[];
-    _resultConvertor?: (remoteData: any, result: ZentaoApiResult) => ZentaoApiResult;
-    _url?: string;
-    _name?: string;
-    /**
-     * 创建一个禅道请求构建实例
-     * @param zentao 禅道请求实例
-     * @param moduleName 方法名
-     * @param methodName 模块名
-     * @param params 请求参数
-     */
-    constructor(zentao: Zentao, moduleName: string, methodName?: string, params?: ZentaoRequestParams);
-    /**
-     * 获取方法名
-     */
-    get methodName(): string;
-    /**
-     * 获取请求参数
-     */
-    get params(): string | import("./types").ZentaoRequestParamPair[] | string[] | Record<string, any> | undefined;
-    /**
-     * 获取请求数据
-     */
-    get data(): string | Record<string, any> | undefined;
-    /**
-     * 获取结果属性过滤列表
-     */
-    get fields(): string[] | undefined;
-    /**
-     * 获取请求名称
-     */
-    get name(): string | undefined;
-    /**
-     * 获取自定义请求地址
-     */
-    get url(): string | undefined;
-    /**
-     * 获取结果转换函数
-     */
-    get resultConvertor(): ((remoteData: any, result: ZentaoApiResult) => ZentaoApiResult) | undefined;
-    /**
-     * 设置方法名
-     * @param name 方法名
-     * @returns 禅道请求构建实例自身
-     */
-    method(name: string): ZentaoRequestBuilder;
-    /**
-     * 设置方法名，是方法 `method(name)` 的别名
-     * @param name 方法名
-     * @returns 禅道请求构建实例自身
-     * @alias method
-     */
-    f(name: string): ZentaoRequestBuilder;
-    /**
-     * 设置请求参数
-     * @param params 要设置的参数
-     * @returns 禅道请求构建实例自身
-     */
-    withParams(params: ZentaoRequestParams): ZentaoRequestBuilder;
-    /**
-     * 追加请求参数
-     * @param params 要追加的参数
-     * @returns 禅道请求构建实例自身
-     */
-    appendParams(params: ZentaoRequestParams): ZentaoRequestBuilder;
-    /**
-     * 设置请求名称
-     * @param name 名称
-     * @returns 禅道请求构建实例自身
-     */
-    named(name: string): ZentaoRequestBuilder;
-    /**
-     * 设置结果转换函数
-     * @param converter 结果转换函数
-     * @returns 禅道请求构建实例自身
-     */
-    useConverter(converter: (remoteData: any, result: ZentaoApiResult) => ZentaoApiResult): ZentaoRequestBuilder;
-    /**
-     * 过滤需要返回的属性列表
-     * @param fields 设置仅返回的属性名称列表
-     * @returns 禅道请求构建实例自身
-     */
-    filterFields(...fields: Array<string | string[] | undefined>): ZentaoRequestBuilder;
-    /**
-     * 发起 GET 请求
-     * @returns 请求结果
-     */
-    get(): Promise<ZentaoApiResult>;
-    /**
-     * 发起 POST 请求
-     * @param data 要提交的数据
-     * @returns 请求结果
-     */
-    post(data?: string | Record<string, any>): Promise<ZentaoApiResult>;
-    /**
-     * 发起 HTTP 请求，可以指定请求方式
-     * @param method 请求方式，默认为 GET
-     * @returns 请求结果
-     */
-    request(method?: Method): Promise<ZentaoApiResult>;
-}

package/dist/zentao.d.ts

@@ -1,175 +0,0 @@
-import { AxiosResponse } from 'axios';
-import { ZentaoApiResult, ZentaoOptions, ZentaoRequestMethod, ZentaoRequestParamPair, ZentaoRequestParams, ZentaoRequestType } from './types';
-import ZentaoConfig from './zentao-config';
-import ZentaoRequestBuilder from './zentao-request-builder';
-/**
- * 禅道请求类
- *
- * @example
- * import { Zentao } from 'zentao-api';
- * const zentao = new Zentao({
- *     url: 'https://pro.demo.zentao.net/', account: 'demo', password: '123456'
- * });
- * // TODO: 使用 zentao 调用其他 API
- */
-export default class Zentao {
-    /**
-     * 当前服务器和登录账号标识字符串
-     */
-    private readonly _identifier;
-    /**
-     * 是否将 token 存储到本地，如果设置为 `false`，则每次创建新的 `Zentao` 实例都会在首次调用 API 之前重新获取 Token
-     */
-    private readonly _preserveToken;
-    /**
-     * 当前实例名称
-     */
-    private readonly _sessionName;
-    /**
-     * 禅道服务器地址
-     */
-    private readonly _url;
-    /**
-     * 登录账号
-     */
-    private readonly _account;
-    /**
-     * 登录密码
-     */
-    private readonly _password;
-    /**
-     * 如果设置为 `true`，则会在控制台输出详细日志
-     */
-    private _debug;
-    /**
-     * 禅道配置
-     */
-    private _config?;
-    /**
-     * 本地存储管理对象
-     */
-    private _store?;
-    /**
-     * 用户指定的请求方式
-     */
-    private _userRequestType?;
-    /**
-     * 构造一个禅道 API 请求对象
-     * @param {ZentaoOptions} [options] 选项，用于指定服务器地址、账号和密码以及 API 调用相关设置
-     * @example
-     * import { Zentao } from 'zentao-api';
-     * const zentao = new Zentao({
-     *     url: 'https://pro.demo.zentao.net/', // 禅道服务器地址
-     *     account: 'demo',                     // 用户账号
-     *     password: '123456',                  // 用户密码
-     *     accessMode: 'GET',                   // 请求方式
-     *     preserveToken: true,                 // 是否将 token 存储到本地，如果设置为 `false`，则每次创建新的 `Zentao` 实例都会在首次调用 API 之前重新获取 Token
-     *     debug: true,                         // 如果设置为 `true`，则会在控制台输出详细日志
-     * });
-     * // TODO: 使用 zentao 调用其他 API
-     */
-    constructor(options: ZentaoOptions);
-    /**
-     * 禅道服务器地址
-     */
-    get url(): string;
-    /**
-     * 当前实例名称
-     */
-    get sessionName(): string;
-    /**
-     * 当前服务器和账号标识
-     */
-    get identifier(): string;
-    /**
-     * 当前用户账号
-     */
-    get account(): string;
-    /**
-     * 登录密码
-     */
-    get password(): string;
-    /**
-     * 请求方式
-     */
-    get requestType(): ZentaoRequestType;
-    /**
-     * 当前用于验证的 Token 字符串
-     */
-    get token(): string;
-    /**
-     * 登录到禅道并更新用于请求 API 的 token，通常不需要手动调用此方法，在调用 API 时会自动判断 token 是否可用，如果不可用会自动调用此方法
-     *
-     * @returns 返回请求结果，当登录成功时，其中 `result` 字段为所登录的用户信息对象
-     * @example
-     * import { Zentao } from 'zentao-api';
-     * const zentao = new Zentao({
-     *     url: 'https://pro.demo.zentao.net/', account: 'demo', password: '123456'
-     * });
-     * const result = await zentao.login();
-     * const user = result.result; // 获取当前登录的用户对象
-     * console.log('当前登录的用户名称为：', user.realname);
-     */
-    login(): Promise<ZentaoApiResult>;
-    /**
-     * 获取禅道服务器配置
-     * @returns 禅道服务器配置
-     */
-    fetchConfig(): Promise<ZentaoConfig>;
-    /**
-     * 根据模块名创建一个禅道请求构建实例
-     * @param moduleName 模块名
-     * @param methodName 方法名
-     * @param params 请求参数
-     * @returns 禅道请求构建实例
-     */
-    module(moduleName: string, methodName?: string, params?: ZentaoRequestParams): ZentaoRequestBuilder;
-    /**
-     * 根据模块名创建一个禅道请求构建实例
-     * @param moduleName 模块名
-     * @param methodName 方法名
-     * @param params 请求参数
-     * @returns 禅道请求构建实例
-     * @alias module
-     */
-    m(moduleName: string, methodName?: string, params?: ZentaoRequestParams): ZentaoRequestBuilder;
-    /**
-     * 向禅道服务器发起请求
-     * @param moduleName 模块名
-     * @param methodName 方法名
-     * @param options 其他请求选项
-     * @returns 请求结果
-     */
-    request(moduleName: string, methodName?: string, options?: {
-        params?: ZentaoRequestParams;
-        data?: string | Record<string, any>;
-        name?: string;
-        method?: ZentaoRequestMethod;
-        url?: string;
-        resultConvertor?: (remoteData: any, result: ZentaoApiResult) => ZentaoApiResult;
-        fields?: string[];
-    }): Promise<ZentaoApiResult>;
-    /**
-     * 生成请求地址
-     * @param moduleName 模块名
-     * @param methodName 方法名
-     * @param params 其他参数
-     * @returns 请求地址
-     */
-    createUrl(moduleName: string, methodName?: string, params?: ZentaoRequestParamPair[]): string;
-    /**
-     * 输出 API 请求日志
-     * @param name 名称
-     * @param atrributes 日志属性对象
-     * @param others 其他日志内容
-     */
-    protected _log(name: string, atrributes: {
-        url?: string;
-        params?: ZentaoRequestParamPair[];
-        data?: string | Record<string, any>;
-        method?: string;
-        resp?: AxiosResponse;
-        result?: ZentaoApiResult;
-        error?: any;
-    }, ...others: any[]): void;
-}