@oiyo/framework 0.5.0 → 0.6.0

package/dist/index-BGIDoS5A.d.cts

@@ -1,362 +0,0 @@
-/**
- * @oiyo/framework v0.5.0
- * Copyright (c) 2026 skiyee. All rights reserved.
- * Commercial software. See LICENSE for terms.
- * Official site: https://oiyo.js.org
- */
-//#region src/oiyo/http/utils/emitter.d.ts
-type EmitterListener = (...arg: unknown[]) => void;
-declare abstract class Emitter {
-  private listeners;
-  constructor();
-  on(id: string, listener: EmitterListener): void;
-  off(id: string, listener: EmitterListener): void;
-  protected emit(id: string, ...args: unknown[]): void;
-  remove(id: string): void;
-}
-//#endregion
-//#region src/oiyo/http/abort.d.ts
-type OnabortListener = () => void;
-declare class HttpAbortSignal extends Emitter {
-  protected _aborted: boolean;
-  protected _reason: unknown;
-  protected _onabortListener: OnabortListener | null;
-  get aborted(): boolean;
-  get reason(): unknown;
-  protected _abort(reason: unknown): void;
-  throwIfAborted(): void;
-}
-declare class HttpAborter {
-  private readonly _signal;
-  constructor();
-  get signal(): HttpAbortSignal;
-  abort(reason?: unknown): void;
-}
-/**
- * 创建一个中断信标。
- *
- * @example
- * const aborter = createHttpAborter()
- * http.request('/pet/1', { signal: aborter.signal })
- * aborter.abort()
- */
-declare function createHttpAborter(): HttpAborter;
-//#endregion
-//#region src/oiyo/http/types/utils.d.ts
-type Prettify<T> = { [K in keyof T]: T[K]; } & {};
-type MaybePromise<T> = T | Promise<T>;
-//#endregion
-//#region src/oiyo/http/types/body.d.ts
-interface ResponseBodyTypeMap {
-  text: string;
-  arrayBuffer: ArrayBuffer;
-}
-type ResponseBodyType = Prettify<keyof ResponseBodyTypeMap | 'json'>;
-type MappedResponseBodyType<TRBType extends ResponseBodyType, TRBJsonType = any> = TRBType extends keyof ResponseBodyTypeMap ? ResponseBodyTypeMap[TRBType] : TRBJsonType;
-//#endregion
-//#region src/oiyo/http/types/uni.d.ts
-interface UniAppOnHeadersData {
-  header: Record<string, string>;
-}
-type UniAppRequestOptions = Omit<UniNamespace.RequestOptions, 'url' | 'data' | 'header' | 'method' | 'timeout' | 'responseType' | 'success' | 'fail' | 'complete'>;
-interface UniAppRequestChunkData {
-  data: ArrayBuffer;
-}
-type UniAppRequestResponse<TRBody = any> = Prettify<Omit<UniNamespace.RequestSuccessCallbackResult, 'data'> & {
-  data: TRBody;
-}>;
-type UniAppUploadOptions = Omit<UniNamespace.UploadFileOption, 'url' | 'header' | 'formData' | 'timeout' | 'success' | 'fail' | 'complete'>;
-interface UniAppUploadOnProgressData extends UniNamespace.OnProgressUpdateResult {}
-type UniAppUploadResponse<TRBody = any> = Prettify<Omit<UniNamespace.UploadFileSuccessCallbackResult, 'data'> & {
-  data: TRBody;
-}>;
-type UniAppDownloadBodyType = 'json';
-type UniAppDownloadBody = Prettify<Pick<UniNamespace.DownloadSuccessData, 'tempFilePath'>>;
-type UniAppDownloadOptions = Omit<UniNamespace.DownloadFileOption, 'url' | 'header' | 'timeout' | 'success' | 'fail' | 'complete'>;
-interface UniAppDownloadOnProgressData extends UniNamespace.OnProgressDownloadResult {}
-type UniAppDownloadResponse<TRBody = any> = Prettify<Omit<UniNamespace.DownloadSuccessData, keyof UniAppDownloadBody> & {
-  data: TRBody;
-}>;
-//#endregion
-//#region src/oiyo/http/types/response.d.ts
-type HttpRequestResult<TRBody = any, TRBType extends ResponseBodyType = ResponseBodyType> = MappedResponseBodyType<TRBType, TRBody>;
-type HttpUploadResult<TRBody = any, TRBType extends ResponseBodyType = ResponseBodyType> = MappedResponseBodyType<TRBType, TRBody>;
-type HttpDownloadResult<TRBody extends UniAppDownloadBody = UniAppDownloadBody, TRBType extends UniAppDownloadBodyType = 'json'> = MappedResponseBodyType<TRBType, TRBody>;
-type HttpRequestResponse<TRBody = any, TRBType extends ResponseBodyType = ResponseBodyType> = UniAppRequestResponse<MappedResponseBodyType<TRBType, TRBody>>;
-type HttpUploadResponse<TRBody = any, TRBType extends ResponseBodyType = ResponseBodyType> = UniAppUploadResponse<MappedResponseBodyType<TRBType, TRBody>>;
-type HttpDownloadResponse<TRBody extends UniAppDownloadBody = UniAppDownloadBody, TRBType extends UniAppDownloadBodyType = 'json'> = UniAppDownloadResponse<MappedResponseBodyType<TRBType, TRBody>>;
-type HttpResponse<T = any> = HttpRequestResponse<T> | HttpUploadResponse<T> | HttpDownloadResponse;
-//#endregion
-//#region src/oiyo/http/types/options.d.ts
-/**
- * 所有传输方式共享的基础选项。
- */
-interface HttpCommonOptions<TRBType extends ResponseBodyType = ResponseBodyType> {
-  /**
-   * 传输动作
-   * @description 常用于钩子中
-   * @protected
-   */
-  _action?: 'request' | 'upload' | 'download';
-  /** 与相对 url 进行拼接的基础地址 */
-  baseURL?: string;
-  method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'TRACE' | 'CONNECT';
-  /** 传输过程中所需的请求头 */
-  headers?: Record<string, string>;
-  /** 与完整传输地址进行拼接的查询参数 */
-  query?: Record<string, any>;
-  body?: any;
-  timeout?: number;
-  /**
-   * 为 true 时返回完整响应对象（statusCode / header / data ...），
-   * 否则只返回精炼后的 data。
-   */
-  raw?: boolean;
-  responseType?: TRBType;
-  parseResponse?: (responseText: string) => any;
-  /**
-   * 重试的响应状态码
-   * @default [408, 409, 425, 429, 500, 502, 503, 504]
-   */
-  retryStatusCodes?: number[];
-  /**
-   * 是否基于重试响应状态码进行重试
-   * @default 1
-   */
-  retry?: number | false;
-  /**
-   * 重试延迟时间，单位 ms
-   * @default 0
-   */
-  retryDelay?: number;
-  /**
-   * 判定响应是否走 `onResponseSuccess`；未通过则走 `onResponseError` 并 reject。
-   * @default (status) => status >= 200 && status < 300
-   */
-  validateStatus?: (status: number) => boolean;
-  /**
-   * 中断信号，由 `createHttpAborter()` 创建。
-   * 信号触发后传输会被中断；已中断的信号会让传输立即中断。
-   */
-  signal?: HttpAbortSignal;
-  /**
-   * 监听响应头（对应 task.onHeadersReceived）。
-   */
-  onHeaders?: (data: UniAppOnHeadersData, off: () => void) => void;
-}
-interface HttpRequestOptions<TRBType extends ResponseBodyType = ResponseBodyType> extends HttpCommonOptions<TRBType>, UniAppRequestOptions {
-  _action?: 'request';
-  /**
-   * 传输方法
-   * @default - 'GET'
-   */
-  method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'TRACE' | 'CONNECT';
-  /**
-   * 监听流式数据，对应原生 task.onChunkReceived
-   * @description 调用 `off()` 将关闭流式数据监听
-   */
-  onChunk?: (data: UniAppRequestChunkData, off: () => void) => void;
-}
-interface HttpUploadOptions<TRBType extends ResponseBodyType = ResponseBodyType> extends HttpCommonOptions<TRBType>, UniAppUploadOptions {
-  _action?: 'upload';
-  /**
-   * 传输方法，强制 POST
-   * @default - 'POST'
-   */
-  method?: 'POST';
-  /**
-   * 监听上传进度，对应原生 task.onProgressUpdate
-   * @description 调用 `off()` 将关闭上传进度监听
-   */
-  onProgress?: (data: UniAppUploadOnProgressData, off: () => void) => void;
-}
-interface HttpDownloadOptions<TRBType extends UniAppDownloadBodyType = 'json'> extends HttpCommonOptions<TRBType>, UniAppDownloadOptions {
-  _action?: 'download';
-  /**
-   * 传输方法，强制 GET
-   * @default - 'GET'
-   */
-  method?: 'GET';
-  /**
-   * 监听下载进度，对应原生 task.onProgressUpdate
-   * @description 调用 `off()` 将关闭下载进度监听
-   */
-  onProgress?: (data: UniAppDownloadOnProgressData, off: () => void) => void;
-}
-/**
- * 传输地址
- */
-type HttpURL = string;
-/**
- * 传输属性
- */
-type HttpOptions = HttpRequestOptions | HttpUploadOptions | HttpDownloadOptions;
-/**
- * 传输拦截器
- */
-interface HttpHooks<TOptions, TResponse> {
-  /**
-   * 请求前置拦截器
-   * - 传输状态: 发起失败
-   * - 触发条件: 网络发出前
-   * - 接受返回值: options、void、Error
-   */
-  onBeforeRequest?: (context: {
-    url: HttpURL;
-    options: TOptions;
-  }) => MaybePromise<TOptions | void>;
-  /**
-   * 请求错误拦截器
-   * - 传输状态: 发起失败
-   * - 触发条件: 发前抛错、传输 fail、主动 abort 等
-   * - Error类: HttpError、Error...
-   * - 接受返回值: any (抛出的值将由调用方所接受)
-   */
-  onRequestError?: (context: {
-    error: Error;
-    url: HttpURL;
-    options: TOptions;
-  }) => MaybePromise<unknown>;
-  /**
-   * 响应成功拦截器
-   * - 传输状态: 已响应
-   * - 触发条件: `validateStatus` 通过（默认 2xx）
-   * - 接受返回值: 原响应值结构 (HttpResponse)、void
-   */
-  onResponseSuccess?: (context: {
-    response: TResponse;
-    url: HttpURL;
-    options: TOptions;
-  }) => MaybePromise<TResponse | void>;
-  /**
-   * 响应错误拦截器
-   * - 传输状态: 已响应
-   * - 触发条件: `validateStatus` 未通过
-   * - Error类: HttpError、Error
-   * - 接受返回值: any (抛出的值将由调用方所接受)
-   */
-  onResponseError?: (context: {
-    error: Error;
-    response: TResponse;
-    url: HttpURL;
-    options: TOptions;
-  }) => MaybePromise<unknown>;
-}
-interface HttpConfig extends HttpCommonOptions, HttpHooks<HttpOptions, HttpResponse> {}
-//#endregion
-//#region src/oiyo/http/types/core.d.ts
-interface HttpRequest {
-  <TRBody = any, TRBType extends ResponseBodyType = 'json'>(url: HttpURL, options: HttpRequestOptions<TRBType> & {
-    raw: true;
-  }): Promise<HttpRequestResponse<TRBody, TRBType>>;
-  <TRBody = any, TRBType extends ResponseBodyType = 'json'>(url: HttpURL, options?: HttpRequestOptions<TRBType>): Promise<HttpRequestResult<TRBody, TRBType>>;
-}
-interface HttpUpload {
-  <TRBody = any, TRBType extends ResponseBodyType = 'json'>(url: HttpURL, options: HttpUploadOptions<TRBType> & {
-    raw: true;
-  }): Promise<HttpUploadResponse<TRBody, TRBType>>;
-  <TRBody = any, TRBType extends ResponseBodyType = 'json'>(url: HttpURL, options?: HttpUploadOptions<TRBType>): Promise<HttpUploadResult<TRBody, TRBType>>;
-}
-interface HttpDownload {
-  <TRBody extends UniAppDownloadBody = UniAppDownloadBody, TRBType extends UniAppDownloadBodyType = UniAppDownloadBodyType>(url: HttpURL, options: HttpDownloadOptions<TRBType> & {
-    raw: true;
-  }): Promise<HttpDownloadResponse<TRBody, TRBType>>;
-  <TRBody extends UniAppDownloadBody = UniAppDownloadBody, TRBType extends UniAppDownloadBodyType = UniAppDownloadBodyType>(url: HttpURL, options?: HttpDownloadOptions<TRBType>): Promise<HttpDownloadResult<TRBody, TRBType>>;
-}
-//#endregion
-//#region src/oiyo/http/core.d.ts
-interface Http {
-  /**
-   * 发起请求
-   *
-   * @example
-   * const data = await http.request<IUserInfoRes>('/user/info')
-   * // data 是精炼后的数据，同 `IUserInfoRes` 结构的值
-   *
-   * const response = await http.request<IUserInfoRes>('/user/info', { raw: true })
-   * // response 是源响应数据，你必须通过 response.data 才能拿到同 `IUserInfoRes` 结构的值
-   */
-  request: HttpRequest;
-  /**
-   * 文件上传
-   *
-   * @example
-   * const data = await http.upload<IUploadRes>('/upload', { name: 'file', filePath, body: { category: 'avatar' } })
-   * // data 是精炼后的数据，同 `IUploadRes` 结构的值
-   *
-   * const response = await http.upload<IUploadRes>('/upload', { raw: true, name: 'file', filePath, body: { category: 'avatar' } })
-   * // response 是源响应数据，你必须通过 response.data 才能拿到同 `IUploadRes` 结构的值
-   */
-  upload: HttpUpload;
-  /**
-   * 文件下载
-   *
-   * @example
-   * const data = await http.download('/file/report.pdf')
-   * // data.tempFilePath 可以直接获取到临时文件路径
-   *
-   * const response = await http.download('/file/report.pdf', { raw: true })
-   * // response 是源响应数据，你必须通过 response.data.tempFilePath 才能拿到
-   */
-  download: HttpDownload;
-  /**
-   * 基于当前配置派生一个新实例。
-   *
-   * @example
-   * // 作为实例源
-   * const client = http.create({ ... })
-   *
-   * // 派生鉴权/订单专用实例，它们都会继承与 client 中的配置
-   * const authClient = client.create({...})
-   * const orderClient = client.create({...})
-   */
-  create: (config: HttpConfig) => Http;
-}
-declare function createHttp(globalConfig?: HttpConfig): Http;
-/**
- * 请求层
- *
- * @docs https://oiyo.js.org/docs/manual/data/http
- * @example
- * // 发起请求
- * const data = await http.request<IUserInfoRes>('/user/info')
- *
- * // 文件上传
- * const data = await http.upload<IUploadRes>('/upload', { name: 'file', filePath, body: { category: 'avatar' } })
- *
- * // 文件下载
- * const { tempFilePath } = await http.download('/file/report.pdf')
- *
- * // 中断进行中的请求
- * const aborter = createHttpAborter()
- * http.request('/pet/1', { signal: aborter.signal })
- * aborter.abort()
- *
- * // 派生一个新实例（覆盖超时等配置，公共实例的钩子会一并串联执行）
- * const longTimeoutClient = http.create({ timeout: 120000 })
- */
-declare const http: Http;
-//#endregion
-//#region src/oiyo/http/error.d.ts
-declare class HttpError<TB = any> extends Error {
-  /** 调用方在传输过程中主动中止  */
-  static readonly ABORT = "ABORT";
-  /** 调用方无法发起传输行为：网络错误、跨域、超时等 */
-  static readonly FAIL = "FAIL";
-  /** 响应的 HTTP 状态码未通过 `validateStatus`（默认非 2xx） */
-  static readonly STATUS = "STATUS";
-  readonly url?: HttpURL;
-  readonly options?: HttpOptions;
-  readonly response?: HttpResponse<TB>;
-  readonly statusCode?: number;
-  readonly statusMessage?: string;
-  readonly data?: TB;
-  constructor(options: {
-    name: string;
-    message: string;
-    cause?: unknown;
-  });
-}
-declare function isHttpError(error: unknown): error is HttpError;
-//#endregion
-export { HttpCommonOptions as a, HttpOptions as c, HttpDownloadResponse as d, HttpRequestResponse as f, createHttpAborter as g, ResponseBodyType as h, http as i, HttpRequestOptions as l, HttpUploadResponse as m, isHttpError as n, HttpConfig as o, HttpResponse as p, createHttp as r, HttpDownloadOptions as s, HttpError as t, HttpUploadOptions as u };