@longzai-intelligence-transport/http-adapter-nestjs 0.1.0 → 0.1.2

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import { ApiResponse, HttpMethod, HttpMethod as HttpMethod$1, InferRouteBody, InferRouteFullResponse, InferRouteParams, InferRouteQuery, InferRouteResponse, InferRouteResponse as InferRouteResponse$1, InferRouteReturn, RouteDefinition, RouteDefinition as RouteDefinition$1, RouteGroup, RouteGroup as RouteGroup$1, createTypedEmpty, createTypedResponse } from "@longzai-intelligence-transport/http-core";
+import { StreamableFile } from "@nestjs/common";
+import { ApiResponse, HttpMethod, HttpMethod as HttpMethod$1, InferRouteBody, InferRouteFullResponse, InferRouteParams, InferRouteQuery, InferRouteResponse, InferRouteResponse as InferRouteResponse$1, InferRouteReturn, RouteDefinition, RouteDefinition as RouteDefinition$1, RouteGroup, RouteGroup as RouteGroup$1, StreamResponseRoute, createTypedEmpty, createTypedResponse } from "@longzai-intelligence-transport/http-core";
 import { ZodType, core } from "zod";
 
 //#region src/decorators/api-route.decorator.d.ts
@@ -373,6 +374,37 @@ declare function getTypeName(def: core.$ZodTypeDef): string | undefined;
  */
 declare function getDef(schema: core.$ZodType): core.$ZodTypeDef;
 //#endregion
+//#region src/utils/stream-response.util.d.ts
+/**
+ * 流式路由响应类型映射（NestJS adapter）
+ *
+ * 将 core 层的 BinaryStreamMarker 映射为 NestJS 的 StreamableFile。
+ * 非流式路由（JsonResponseRoute）映射为 never，保证 typedStream 错用编译报错。
+ *
+ * @typeParam R - 路由定义类型
+ */
+type InferStreamRouteResponse<R extends RouteDefinition$1> = R extends StreamResponseRoute ? StreamableFile : never;
+/**
+ * 类型安全的流式响应函数类型
+ *
+ * 接受 StreamableFile 并透传返回，与 core 层 createTypedStream 的 BinaryStreamMarker 占位对应。
+ *
+ * @typeParam R - 路由定义类型
+ */
+type TypedStreamFunction<R extends RouteDefinition$1> = (stream: InferStreamRouteResponse<R>) => InferStreamRouteResponse<R>;
+/**
+ * 创建类型安全的流式响应函数
+ *
+ * 工厂模式：创建时绑定路由定义，返回的函数接受 StreamableFile 并透传。
+ * 仅对 StreamResponseRoute 有效；传入 JsonResponseRoute 时函数参数类型为 never，
+ * 调用 typedStream(streamableFile) 会编译报错，形成错用保护。
+ *
+ * @typeParam R - 路由定义类型
+ * @param _route - 路由定义（创建时绑定，用于类型约束）
+ * @returns 流式响应函数，接受 StreamableFile 并透传
+ */
+declare function createTypedStream<R extends RouteDefinition$1>(_route: R): TypedStreamFunction<R>;
+//#endregion
 //#region src/utils/handler.utils.d.ts
 /**
  * defineHandler 返回值类型
@@ -396,6 +428,10 @@ type HandlerBindings<R extends RouteDefinition$1> = {
    * 类型安全空响应函数
    */
   readonly typedEmpty: () => ApiResponse<void>;
+  /**
+   * 类型安全流式响应函数（透传 StreamableFile，仅对流式路由有效）
+   */
+  readonly typedStream: TypedStreamFunction<R>;
 };
 /**
  * 一次性合成 Handler 所需的全部绑定
@@ -426,4 +462,4 @@ type HandlerBindings<R extends RouteDefinition$1> = {
  */
 declare function defineHandler<R extends RouteDefinition$1>(route: R): HandlerBindings<R>;
 //#endregion
-export { type AnyRouteDefinition, ApiRoute, type HandlerBindings, type HttpMethod, type InferRouteBody, type InferRouteFullResponse, type InferRouteParams, type InferRouteQuery, type InferRouteResponse, type InferRouteReturn, type OpenApiSchema, PublicRoute, ROUTE_DEFINITION_KEY, RequireAuth, type RouteDefinition, type RouteGroup, TypedController, TypedRoute, createTypedEmpty, createTypedHandler, createTypedResponse, defineHandler, extractZodDescriptions, getDef, getTypeName, zodToOpenApi };
+export { type AnyRouteDefinition, ApiRoute, type HandlerBindings, type HttpMethod, type InferRouteBody, type InferRouteFullResponse, type InferRouteParams, type InferRouteQuery, type InferRouteResponse, type InferRouteReturn, type InferStreamRouteResponse, type OpenApiSchema, PublicRoute, ROUTE_DEFINITION_KEY, RequireAuth, type RouteDefinition, type RouteGroup, TypedController, TypedRoute, type TypedStreamFunction, createTypedEmpty, createTypedHandler, createTypedResponse, createTypedStream, defineHandler, extractZodDescriptions, getDef, getTypeName, zodToOpenApi };

package/dist/index.js

@@ -1 +1 @@
-import{Controller as e,Delete as t,Get as n,Patch as r,Post as i,Put as a,applyDecorators as o}from"@nestjs/common";import{ApiBearerAuth as s,ApiBody as c,ApiOperation as l,ApiParam as u,ApiQuery as d,ApiResponse as f,ApiTags as p}from"@nestjs/swagger";import{createTypedEmpty as m,createTypedEmpty as h,createTypedResponse as g,createTypedResponse as ee}from"@longzai-intelligence-transport/http-core";function _(e){return e.type}function v(e){return e._zod.def}function y(e,t){return t===`array`}function b(e,t){return t===`object`}function x(e,t){return t===`record`}function S(e,t){return t===`optional`||t===`nullable`}function C(e,t){return t==="default"}function w(e,t){return t===`enum`}function T(e,t){return t===`literal`}function E(e,t){return t===`union`}function D(e,t){return t===`intersection`}function O(e,t){return{type:`array`,items:e.element?t(e.element):{type:`object`}}}function k(e,t){let n={},r=[],i=e.shape;if(i)for(let[e,a]of Object.entries(i)){n[e]=t(a);let i=_(v(a));i!==`optional`&&i!==`nullable`&&r.push(e)}let a={type:`object`,properties:n};return r.length>0&&(a.required=r),a}function A(e,t){return{type:`object`,additionalProperties:e.valueType?t(e.valueType):!0}}function j(e,t){return{...e.innerType?t(e.innerType):{type:`object`},nullable:!0}}function M(e,t){let n=e.defaultValue;return{...e.innerType?t(e.innerType):{type:`object`},default:typeof n==`function`?n():n}}function N(e){return{type:`string`,enum:e.entries?Object.values(e.entries):[]}}function P(e){let t=e.values?.[0];return typeof t==`string`?{type:`string`,enum:[t]}:typeof t==`number`?{type:`number`,enum:[t]}:typeof t==`boolean`?{type:`boolean`,enum:[t]}:{type:`string`}}function F(e,t){return{oneOf:e.options?.map(e=>t(e))??[]}}function I(e,t){let n=[];return e.left&&n.push(t(e.left)),e.right&&n.push(t(e.right)),{allOf:n}}const te={string:{type:`string`},number:{type:`number`},int:{type:`number`},boolean:{type:`boolean`},date:{type:`string`,format:`date-time`}};function L(e){let t=v(e),n=_(t);return n?te[n]||(y(t,n)?O(t,L):b(t,n)?k(t,L):x(t,n)?A(t,L):S(t,n)?j(t,L):C(t,n)?M(t,L):w(t,n)?N(t):T(t,n)?P(t):E(t,n)?F(t,L):D(t,n)?I(t,L):{type:`object`}):{type:`object`}}function R(e){let t={},n=v(e),r=_(n);if(r&&b(n,r)&&n.shape)for(let[e,r]of Object.entries(n.shape)){let n=`description`in r&&typeof r.description==`string`?r.description:void 0;n&&(t[e]=n)}return t}const z=`route_definition`;function B(e,t){t!==!1&&e.push(s())}function V(e,t,n){let r=L(t);e.push(f({status:200,description:n??`成功`,schema:r}))}function H(e,t){if(t)for(let n of t)e.push(f({status:n.status,description:n.description,schema:{type:`object`,properties:{code:{type:`string`},message:{type:`string`},data:{type:`object`,nullable:!0}}}}))}function U(e,t){if(!t)return;let n=L(t);if(n.properties)for(let[t,r]of Object.entries(n.properties))e.push(u({name:t,schema:r,required:!0}))}function W(e,t){if(!t)return;let n=L(t);if(n.properties){let t=n.required||[];for(let[r,i]of Object.entries(n.properties))e.push(d({name:r,schema:i,required:t.includes(r)}))}}function G(e,t){t&&e.push(c({schema:L(t)}))}function K(e,t){let n=[];return B(n,t?.requireAuth),n.push(l({summary:e.summary,tags:e.tags})),V(n,e.response,t?.successDescription),H(n,t?.errorResponses),U(n,e.params),W(n,e.query),G(n,e.body),o(...n)}function q(){return s()}function J(){return o()}function Y(t){let n=[];return n.push(e(t.prefix)),t.tags&&t.tags.length>0&&n.push(p(...t.tags)),o(...n)}function X(e){if(e.basePath){let t=e.basePath.startsWith(`/`)?e.basePath:`/${e.basePath}`;return(e.path.endsWith(t)?e.path.slice(0,-t.length):e.path)||`/`}let t=e.path.lastIndexOf(`/`);return t>0?e.path.slice(0,t):e.path}function Z(e){return`prefix`in e&&typeof e.prefix==`string`}function Q(t){return()=>{let n=[],r=Z(t)?t.prefix:X(t);return n.push(e(r)),t.tags&&t.tags.length>0&&n.push(p(...t.tags)),o(...n)}}function ne(e){switch(e){case`GET`:return n;case`POST`:return i;case`PUT`:return a;case`PATCH`:return r;case`DELETE`:return t}}function $(e,t){return o(ne(e.method)(e.basePath??e.path),K(e,t))}function re(e){return{TypedHandler:Q(e),TypedHandle:()=>$(e),typedResponse:ee(e),typedEmpty:h(e)}}export{K as ApiRoute,J as PublicRoute,z as ROUTE_DEFINITION_KEY,q as RequireAuth,Y as TypedController,$ as TypedRoute,m as createTypedEmpty,Q as createTypedHandler,g as createTypedResponse,re as defineHandler,R as extractZodDescriptions,v as getDef,_ as getTypeName,L as zodToOpenApi};
+import{Controller as e,Delete as t,Get as n,Header as r,Patch as i,Post as a,Put as o,applyDecorators as s}from"@nestjs/common";import{ApiBearerAuth as c,ApiBody as l,ApiOperation as u,ApiParam as d,ApiQuery as f,ApiResponse as p,ApiTags as m}from"@nestjs/swagger";import{createTypedEmpty as ee,createTypedEmpty as h,createTypedResponse as te,createTypedResponse as ne}from"@longzai-intelligence-transport/http-core";function g(e){return e.type}function _(e){return e._zod.def}function v(e,t){return t===`array`}function y(e,t){return t===`object`}function b(e,t){return t===`record`}function x(e,t){return t===`optional`||t===`nullable`}function S(e,t){return t==="default"}function C(e,t){return t===`enum`}function w(e,t){return t===`literal`}function T(e,t){return t===`union`}function E(e,t){return t===`intersection`}function D(e,t){return{type:`array`,items:e.element?t(e.element):{type:`object`}}}function O(e,t){let n={},r=[],i=e.shape;if(i)for(let[e,a]of Object.entries(i)){n[e]=t(a);let i=g(_(a));i!==`optional`&&i!==`nullable`&&r.push(e)}let a={type:`object`,properties:n};return r.length>0&&(a.required=r),a}function k(e,t){return{type:`object`,additionalProperties:e.valueType?t(e.valueType):!0}}function A(e,t){return{...e.innerType?t(e.innerType):{type:`object`},nullable:!0}}function j(e,t){let n=e.defaultValue;return{...e.innerType?t(e.innerType):{type:`object`},default:typeof n==`function`?n():n}}function M(e){return{type:`string`,enum:e.entries?Object.values(e.entries):[]}}function N(e){let t=e.values?.[0];return typeof t==`string`?{type:`string`,enum:[t]}:typeof t==`number`?{type:`number`,enum:[t]}:typeof t==`boolean`?{type:`boolean`,enum:[t]}:{type:`string`}}function P(e,t){return{oneOf:e.options?.map(e=>t(e))??[]}}function F(e,t){let n=[];return e.left&&n.push(t(e.left)),e.right&&n.push(t(e.right)),{allOf:n}}const re={string:{type:`string`},number:{type:`number`},int:{type:`number`},boolean:{type:`boolean`},date:{type:`string`,format:`date-time`}};function I(e){let t=_(e),n=g(t);return n?re[n]||(v(t,n)?D(t,I):y(t,n)?O(t,I):b(t,n)?k(t,I):x(t,n)?A(t,I):S(t,n)?j(t,I):C(t,n)?M(t):w(t,n)?N(t):T(t,n)?P(t,I):E(t,n)?F(t,I):{type:`object`}):{type:`object`}}function L(e){let t={},n=_(e),r=g(n);if(r&&y(n,r)&&n.shape)for(let[e,r]of Object.entries(n.shape)){let n=`description`in r&&typeof r.description==`string`?r.description:void 0;n&&(t[e]=n)}return t}const R=`route_definition`;function z(e,t){t!==!1&&e.push(c())}function B(e,t,n){let r=I(t);e.push(p({status:200,description:n??`成功`,schema:r}))}function V(e,t){if(t)for(let n of t)e.push(p({status:n.status,description:n.description,schema:{type:`object`,properties:{code:{type:`string`},message:{type:`string`},data:{type:`object`,nullable:!0}}}}))}function H(e,t){if(!t)return;let n=I(t);if(n.properties)for(let[t,r]of Object.entries(n.properties))e.push(d({name:t,schema:r,required:!0}))}function U(e,t){if(!t)return;let n=I(t);if(n.properties){let t=n.required||[];for(let[r,i]of Object.entries(n.properties))e.push(f({name:r,schema:i,required:t.includes(r)}))}}function W(e,t){t&&e.push(l({schema:I(t)}))}function G(e,t){let n=[];if(z(n,t?.requireAuth),n.push(u({summary:e.summary,tags:e.tags})),e.responseType===`stream`){let t=e.stream.mimeType??`application/octet-stream`;n.push(p({status:200,content:{[t]:{schema:{type:`string`,format:`binary`}}},...e.stream.fileName?{headers:{"Content-Disposition":{schema:{type:`string`},description:`attachment; filename="${e.stream.fileName}"`}}}:{}}))}else B(n,e.response,t?.successDescription);return V(n,t?.errorResponses),H(n,e.params),U(n,e.query),W(n,e.body),s(...n)}function K(){return c()}function q(){return s()}function J(t){let n=[];return n.push(e(t.prefix)),t.tags&&t.tags.length>0&&n.push(m(...t.tags)),s(...n)}function Y(e){if(e.basePath){let t=e.basePath.startsWith(`/`)?e.basePath:`/${e.basePath}`;return(e.path.endsWith(t)?e.path.slice(0,-t.length):e.path)||`/`}let t=e.path.lastIndexOf(`/`);return t>0?e.path.slice(0,t):e.path}function X(e){return`prefix`in e&&typeof e.prefix==`string`}function Z(t){return()=>{let n=[],r=X(t)?t.prefix:Y(t);return n.push(e(r)),t.tags&&t.tags.length>0&&n.push(m(...t.tags)),s(...n)}}function ie(e){switch(e){case`GET`:return n;case`POST`:return a;case`PUT`:return o;case`PATCH`:return i;case`DELETE`:return t}}function Q(e,t){let n=[ie(e.method)(e.basePath??e.path),G(e,t)];if(e.responseType===`stream`){let t=e.stream.mimeType??`application/octet-stream`;n.push(r(`Content-Type`,t)),e.stream.fileName&&n.push(r(`Content-Disposition`,`attachment; filename="${e.stream.fileName}"`))}return s(...n)}function $(e){return e=>e}function ae(e){return{TypedHandler:Z(e),TypedHandle:()=>Q(e),typedResponse:ne(e),typedEmpty:h(e),typedStream:$(e)}}export{G as ApiRoute,q as PublicRoute,R as ROUTE_DEFINITION_KEY,K as RequireAuth,J as TypedController,Q as TypedRoute,ee as createTypedEmpty,Z as createTypedHandler,te as createTypedResponse,$ as createTypedStream,ae as defineHandler,L as extractZodDescriptions,_ as getDef,g as getTypeName,I as zodToOpenApi};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@longzai-intelligence-transport/http-adapter-nestjs",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "keywords": [
     "adapter",
     "decorator",
@@ -38,11 +38,12 @@
     "clean": "rimraf dist out .cache"
   },
   "dependencies": {
-    "@longzai-intelligence-transport/http-core": "0.1.0"
+    "@longzai-intelligence-transport/http-core": "0.1.2"
   },
   "devDependencies": {
     "@nestjs/common": "^11.1.26",
     "@nestjs/swagger": "^11.4.4",
+    "expect-type": "^1.3.0",
     "zod": "^4.4.3"
   },
   "peerDependencies": {