@longzai-intelligence-transport/http-preset-browser 0.1.0 → 0.1.1

package/dist/index.d.ts

@@ -1,5 +1,103 @@
-import { CsrfProvider, HttpClient, TokenProvider } from "@longzai-intelligence-transport/http-core";
+import { CreateApiFunction, CsrfProvider, HttpClient, InferRouteParams, InferRouteQuery, RouteDefinition, StreamResponseRoute, TokenProvider } from "@longzai-intelligence-transport/http-core";
 
+//#region src/stream-api-client.d.ts
+/**
+ * 流式路由响应类型映射（浏览器场景：Blob）
+ *
+ * 将 core 层的 BinaryStreamMarker 映射为浏览器的 Blob。
+ * 非流式路由映射为 never。
+ *
+ * @typeParam TRoute - 路由定义类型
+ */
+type InferStreamRouteResponse<TRoute extends RouteDefinition> = TRoute extends StreamResponseRoute ? Blob : never;
+/**
+ * 流式下载函数签名
+ *
+ * 参数与 core GET 函数一致（基于 InferRouteParams / InferRouteQuery），
+ * 返回 Promise<Blob>。
+ *
+ * @typeParam TRoute - 路由定义类型
+ */
+type StreamDownloadFunction<TRoute extends RouteDefinition> = InferRouteParams<TRoute> extends undefined ? InferRouteQuery<TRoute> extends undefined ? () => Promise<InferStreamRouteResponse<TRoute>> : (query?: InferRouteQuery<TRoute>) => Promise<InferStreamRouteResponse<TRoute>> : InferRouteQuery<TRoute> extends undefined ? (params: InferRouteParams<TRoute>) => Promise<InferStreamRouteResponse<TRoute>> : (params: InferRouteParams<TRoute>, query?: InferRouteQuery<TRoute>) => Promise<InferStreamRouteResponse<TRoute>>;
+/**
+ * 浏览器 API mapped type
+ *
+ * 流式路由映射为 StreamDownloadFunction，JSON 路由映射为 core CreateApiFunction。
+ *
+ * @typeParam TRoutes - 路由定义集合类型
+ */
+type BrowserApi<TRoutes extends Record<string, RouteDefinition>> = { [K in keyof TRoutes]: TRoutes[K] extends StreamResponseRoute ? StreamDownloadFunction<TRoutes[K]> : CreateApiFunction<TRoutes[K]> };
+/**
+ * 流式 fetch 配置
+ *
+ * 从 BrowserPresetConfig 提取流式 fetch 所需的配置项。
+ */
+type StreamFetchConfig = {
+  /**
+   * API 基础 URL
+   */
+  baseUrl: string;
+  /**
+   * 自定义请求头
+   */
+  headers?: Record<string, string>;
+  /**
+   * Token 提供者（用于 Authorization 头）
+   */
+  tokenProvider?: TokenProvider;
+  /**
+   * CSRF 提供者（用于 X-CSRF-Token 头）
+   */
+  csrfProvider?: CsrfProvider;
+  /**
+   * 自定义 fetch 函数（依赖注入，测试时可 mock）
+   *
+   * 省略时用全局 fetch。
+   */
+  fetch?: typeof fetch;
+};
+/**
+ * 创建流式下载函数
+ *
+ * 工厂模式：创建时绑定路由定义与配置，返回的函数发起 fetch 请求并返回 Blob。
+ * 错误路径（4xx/5xx）按 JSON 解析 ApiResponse 错误信封抛出。
+ *
+ * @typeParam TRoute - 流式路由定义类型
+ * @param route - 流式路由定义
+ * @param config - 流式 fetch 配置
+ * @returns 流式下载函数，返回 Promise<Blob>
+ * @throws {@link Error} 类型断言失败时抛出
+ */
+declare function createStreamDownloadFunction<TRoute extends StreamResponseRoute>(route: TRoute, config: StreamFetchConfig): StreamDownloadFunction<TRoute>;
+/**
+ * 创建浏览器 API 客户端 factory
+ *
+ * 返回的 factory 接受 routes 集合，生成 BrowserApi：
+ * - JSON 路由：复用 core createApiClientFactory，走 HttpClient.request（JSON 解析 + safeParse）
+ * - 流式路由：走独立的 fetch + blob 路径，返回 Promise<Blob>
+ *
+ * @param client - core HttpClient（用于 JSON 路由）
+ * @param streamConfig - 流式 fetch 配置（baseUrl / headers / tokenProvider / csrfProvider）
+ * @returns API factory，接受 routes 返回 BrowserApi
+ * @throws {@link Error} 类型断言失败时抛出
+ *
+ * @example
+ *   ```typescript
+ *   const factory = createBrowserApiClientFactory(client, {
+ *     baseUrl: '/api',
+ *     tokenProvider: { getToken: () => localStorage.getItem('token') },
+ *   });
+ *   const api = factory(orderRoutes);
+ *
+ *   // JSON 路由：Promise<ApiResponse<Order>>
+ *   const order = await api.detail({ id: '123' });
+ *
+ *   // 流式路由：Promise<Blob>
+ *   const blob = await api.downloadExport({ taskId: 'abc' });
+ *   ```
+ */
+declare function createBrowserApiClientFactory(client: HttpClient, streamConfig: StreamFetchConfig): <TRoutes extends Record<string, RouteDefinition>>(routes: TRoutes) => BrowserApi<TRoutes>;
+//#endregion
 //#region src/index.d.ts
 /**
  * Browser 预设配置
@@ -65,5 +163,15 @@ type BrowserPresetConfig = {
  * @returns HTTP 客户端实例
  */
 declare function createBrowserHttpClient(config: BrowserPresetConfig): HttpClient;
+/**
+ * 从 BrowserPresetConfig 创建 API factory（便捷封装）
+ *
+ * 内部调用 createBrowserHttpClient + createBrowserApiClientFactory，
+ * 对流式路由返回 Promise<Blob>，对 JSON 路由复用 core factory。
+ *
+ * @param config - 浏览器预设配置
+ * @returns API factory，接受 routes 返回 BrowserApi
+ */
+declare function createBrowserApiFactory(config: BrowserPresetConfig): <TRoutes extends Record<string, import("@longzai-intelligence-transport/http-core").RouteDefinition>>(routes: TRoutes) => BrowserApi<TRoutes>;
 //#endregion
-export { type BrowserPresetConfig, createBrowserHttpClient };
+export { type BrowserApi, type BrowserPresetConfig, type InferStreamRouteResponse, type StreamDownloadFunction, type StreamFetchConfig, createBrowserApiClientFactory, createBrowserApiFactory, createBrowserHttpClient, createStreamDownloadFunction };

package/dist/index.js

@@ -1 +1 @@
-import{createAuthTokenInterceptor as e,createCsrfInterceptor as t,createHttpClient as n,createLoggingInterceptor as r}from"@longzai-intelligence-transport/http-core";function i(i){let{baseUrl:a,tokenProvider:o,csrfProvider:s,enableLogging:c=import.meta.env?.DEV??!1,logLevel:l=`debug`,timeout:u,headers:d,onUnauthorized:f}=i,p=[],m=[];if(o&&p.push(e(o)),s&&p.push(t(s)),c){let e=r({level:l});p.push(e.request),m.push(e.response)}return n({baseUrl:a,timeout:u,headers:d,requestInterceptors:p,responseInterceptors:m,onUnauthorized:f})}export{i as createBrowserHttpClient};
+import{buildPath as e,createApiClientFactory as t,createAuthTokenInterceptor as n,createCsrfInterceptor as r,createHttpClient as i,createLoggingInterceptor as a,isStreamRoute as o,isType as s}from"@longzai-intelligence-transport/http-core";function c(t,n){let r=async(r,i)=>{let a=n.baseUrl+e(t.path,r,i),o={...n.headers};if(n.tokenProvider){let e=await n.tokenProvider.getToken();e!==null&&(o.Authorization=`Bearer ${e}`)}if(n.csrfProvider){let e=await n.csrfProvider.getToken();e!==null&&(o[`X-CSRF-Token`]=e)}let s=await(n.fetch??fetch)(a,{headers:o});if(!s.ok)throw await s.json();return s.blob()};if(s(r))return r;throw Error(`流式下载函数构建失败`)}function l(e,n){let r=t(e);return e=>{let t={...r(e)};for(let[r,i]of Object.entries(e))i&&o(i)&&(t[r]=c(i,n));if(s(t))return t;throw Error(`API 客户端构建失败`)}}function u(e){let{baseUrl:t,tokenProvider:o,csrfProvider:s,enableLogging:c=import.meta.env?.DEV??!1,logLevel:l=`debug`,timeout:u,headers:d,onUnauthorized:f}=e,p=[],m=[];if(o&&p.push(n(o)),s&&p.push(r(s)),c){let e=a({level:l});p.push(e.request),m.push(e.response)}return i({baseUrl:t,timeout:u,headers:d,requestInterceptors:p,responseInterceptors:m,onUnauthorized:f})}function d(e){return l(u(e),{baseUrl:e.baseUrl,headers:e.headers,tokenProvider:e.tokenProvider,csrfProvider:e.csrfProvider})}export{l as createBrowserApiClientFactory,d as createBrowserApiFactory,u as createBrowserHttpClient,c as createStreamDownloadFunction};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@longzai-intelligence-transport/http-preset-browser",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "keywords": [
     "browser",
     "http",
@@ -36,7 +36,7 @@
     "clean": "rimraf dist out .cache"
   },
   "dependencies": {
-    "@longzai-intelligence-transport/http-core": "0.1.0"
+    "@longzai-intelligence-transport/http-core": "0.1.1"
   },
   "devDependencies": {
     "zod": "^4.4.3"