@lark-apaas/fullstack-nestjs-core 1.0.15-alpha.2 → 1.0.15-alpha.21

package/dist/index.d.cts

@@ -1,9 +1,14 @@
 import { NestModule, DynamicModule, MiddlewareConsumer, NestMiddleware } from '@nestjs/common';
+import { HttpClientConfig, PlatformPluginOptions } from '@lark-apaas/http-client';
 import { NestExpressApplication } from '@nestjs/platform-express';
 export { DevToolsModule, DevToolsOptions, DevToolsV2Module, DevToolsV2Options } from '@lark-apaas/nestjs-openapi-devtools';
 import { Request, Response, NextFunction } from 'express';
+import { PlatformHttpClient } from '@lark-apaas/nestjs-common';
 export * from '@lark-apaas/nestjs-authnpaas';
 export * from '@lark-apaas/nestjs-datapaas';
+export * from '@lark-apaas/nestjs-observable';
+export * from '@lark-apaas/nestjs-trigger';
+export { CanRole } from '@lark-apaas/nestjs-authzpaas';
 
 declare global {
   namespace Express {
@@ -20,7 +25,11 @@ declare global {
         appId?: string;
         loginUrl?: string;
         userType?: string;
-      };
+        env?: 'preview' | 'runtime';
+        userName?: string; // 默认中文名
+        userNameEn?: string; // 冗余一份英文名
+        userNameI18n?: Record<string, string>; // 带多语的用户名
+      },
       csrfToken?: string;
     }
   }
@@ -29,6 +38,13 @@ declare global {
 /**
  * PlatformModule 配置选项
  */
+
+interface PlatformHttpClientOptions {
+    /** HttpClient 基础配置（超时、headers 等） */
+    config?: Omit<HttpClientConfig, 'platform'>;
+    /** 平台插件配置（默认启用） */
+    platform?: PlatformPluginOptions;
+}
 interface PlatformModuleOptions {
     /**
      * 是否启用 CSRF 保护
@@ -40,6 +56,10 @@ interface PlatformModuleOptions {
      * 默认: '/api/*'
      */
     csrfRoutes?: string | string[];
+    /**
+     * 平台 HttpClient 配置
+     */
+    httpClient?: PlatformHttpClientOptions;
 }
 
 declare class PlatformModule implements NestModule {
@@ -51,7 +71,16 @@ declare class PlatformModule implements NestModule {
     configure(consumer: MiddlewareConsumer): void;
 }
 
-declare function configureApp(app: NestExpressApplication): Promise<void>;
+/**
+ * 初始化应用的基础能力（中间件、过滤器、Swagger 等）。
+ *
+ * @param app NestExpressApplication 实例
+ * @param perms 配置项
+ * @param perms.disableSwagger 是否禁用 Swagger（默认：false）
+ */
+declare function configureApp(app: NestExpressApplication, perms?: {
+    disableSwagger?: boolean;
+}): Promise<void>;
 
 interface CsrfTokenOptions {
     cookieKey?: string;
@@ -81,7 +110,22 @@ declare class UserContextMiddleware implements NestMiddleware {
 }
 
 declare class ViewContextMiddleware implements NestMiddleware {
-    use(req: Request, res: Response, next: NextFunction): void;
+    private readonly client;
+    private readonly logger;
+    constructor(client: PlatformHttpClient);
+    private getAppInfo;
+    use(req: Request, res: Response, next: NextFunction): Promise<void>;
+}
+
+/**
+ * API 404 响应格式
+ */
+interface ApiNotFoundResponse {
+    code: number;
+    message: string;
+    error: string;
+    path: string;
+    timestamp: string;
 }
 
-export { CsrfMiddleware, CsrfTokenMiddleware, PlatformModule, type PlatformModuleOptions, UserContextMiddleware, ViewContextMiddleware, configureApp };
+export { type ApiNotFoundResponse, CsrfMiddleware, CsrfTokenMiddleware, type PlatformHttpClientOptions, PlatformModule, type PlatformModuleOptions, UserContextMiddleware, ViewContextMiddleware, configureApp };

package/dist/index.d.ts

@@ -1,9 +1,14 @@
 import { NestModule, DynamicModule, MiddlewareConsumer, NestMiddleware } from '@nestjs/common';
+import { HttpClientConfig, PlatformPluginOptions } from '@lark-apaas/http-client';
 import { NestExpressApplication } from '@nestjs/platform-express';
 export { DevToolsModule, DevToolsOptions, DevToolsV2Module, DevToolsV2Options } from '@lark-apaas/nestjs-openapi-devtools';
 import { Request, Response, NextFunction } from 'express';
+import { PlatformHttpClient } from '@lark-apaas/nestjs-common';
 export * from '@lark-apaas/nestjs-authnpaas';
 export * from '@lark-apaas/nestjs-datapaas';
+export * from '@lark-apaas/nestjs-observable';
+export * from '@lark-apaas/nestjs-trigger';
+export { CanRole } from '@lark-apaas/nestjs-authzpaas';
 
 declare global {
   namespace Express {
@@ -20,7 +25,11 @@ declare global {
         appId?: string;
         loginUrl?: string;
         userType?: string;
-      };
+        env?: 'preview' | 'runtime';
+        userName?: string; // 默认中文名
+        userNameEn?: string; // 冗余一份英文名
+        userNameI18n?: Record<string, string>; // 带多语的用户名
+      },
       csrfToken?: string;
     }
   }
@@ -29,6 +38,13 @@ declare global {
 /**
  * PlatformModule 配置选项
  */
+
+interface PlatformHttpClientOptions {
+    /** HttpClient 基础配置（超时、headers 等） */
+    config?: Omit<HttpClientConfig, 'platform'>;
+    /** 平台插件配置（默认启用） */
+    platform?: PlatformPluginOptions;
+}
 interface PlatformModuleOptions {
     /**
      * 是否启用 CSRF 保护
@@ -40,6 +56,10 @@ interface PlatformModuleOptions {
      * 默认: '/api/*'
      */
     csrfRoutes?: string | string[];
+    /**
+     * 平台 HttpClient 配置
+     */
+    httpClient?: PlatformHttpClientOptions;
 }
 
 declare class PlatformModule implements NestModule {
@@ -51,7 +71,16 @@ declare class PlatformModule implements NestModule {
     configure(consumer: MiddlewareConsumer): void;
 }
 
-declare function configureApp(app: NestExpressApplication): Promise<void>;
+/**
+ * 初始化应用的基础能力（中间件、过滤器、Swagger 等）。
+ *
+ * @param app NestExpressApplication 实例
+ * @param perms 配置项
+ * @param perms.disableSwagger 是否禁用 Swagger（默认：false）
+ */
+declare function configureApp(app: NestExpressApplication, perms?: {
+    disableSwagger?: boolean;
+}): Promise<void>;
 
 interface CsrfTokenOptions {
     cookieKey?: string;
@@ -81,7 +110,22 @@ declare class UserContextMiddleware implements NestMiddleware {
 }
 
 declare class ViewContextMiddleware implements NestMiddleware {
-    use(req: Request, res: Response, next: NextFunction): void;
+    private readonly client;
+    private readonly logger;
+    constructor(client: PlatformHttpClient);
+    private getAppInfo;
+    use(req: Request, res: Response, next: NextFunction): Promise<void>;
+}
+
+/**
+ * API 404 响应格式
+ */
+interface ApiNotFoundResponse {
+    code: number;
+    message: string;
+    error: string;
+    path: string;
+    timestamp: string;
 }
 
-export { CsrfMiddleware, CsrfTokenMiddleware, PlatformModule, type PlatformModuleOptions, UserContextMiddleware, ViewContextMiddleware, configureApp };
+export { type ApiNotFoundResponse, CsrfMiddleware, CsrfTokenMiddleware, type PlatformHttpClientOptions, PlatformModule, type PlatformModuleOptions, UserContextMiddleware, ViewContextMiddleware, configureApp };