@lark-apaas/fullstack-nestjs-core 1.0.17-alpha.1 → 1.1.0

package/dist/index.cjs

@@ -34,6 +34,8 @@ var index_exports = {};
 __export(index_exports, {
   CsrfMiddleware: () => CsrfMiddleware,
   CsrfTokenMiddleware: () => CsrfTokenMiddleware,
+  DevToolsModule: () => import_nestjs_openapi_devtools2.DevToolsModule,
+  DevToolsV2Module: () => import_nestjs_openapi_devtools2.DevToolsV2Module,
   PlatformModule: () => PlatformModule,
   UserContextMiddleware: () => UserContextMiddleware,
   ViewContextMiddleware: () => ViewContextMiddleware,
@@ -373,22 +375,39 @@ PlatformModule = _ts_decorate5([
 // src/setup.ts
 var import_nestjs_logger2 = require("@lark-apaas/nestjs-logger");
 var import_cookie_parser = __toESM(require("cookie-parser"), 1);
-async function configureApp(app) {
+var import_nestjs_openapi_devtools = require("@lark-apaas/nestjs-openapi-devtools");
+var defaultPerms = {
+  disableSwagger: false
+};
+async function configureApp(app, perms = defaultPerms) {
   app.useLogger(app.get(import_nestjs_logger2.AppLogger));
   app.flushLogs();
   app.use((0, import_cookie_parser.default)());
   const globalPrefix = process.env.CLIENT_BASE_PATH ?? "";
   app.setGlobalPrefix(globalPrefix);
+  if (process.env.NODE_ENV !== "production" && perms.disableSwagger !== true) {
+    try {
+      await import_nestjs_openapi_devtools.DevToolsV2Module.mount(app, {
+        basePath: process.env.CLIENT_BASE_PATH,
+        docsPath: "/api_docs"
+      });
+    } catch (err) {
+      console.error("[OpenAPI] OpenAPI \u751F\u6210\u5931\u8D25:", err);
+    }
+  }
 }
 __name(configureApp, "configureApp");
 
 // src/index.ts
+var import_nestjs_openapi_devtools2 = require("@lark-apaas/nestjs-openapi-devtools");
 __reExport(index_exports, require("@lark-apaas/nestjs-authnpaas"), module.exports);
 __reExport(index_exports, require("@lark-apaas/nestjs-datapaas"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   CsrfMiddleware,
   CsrfTokenMiddleware,
+  DevToolsModule,
+  DevToolsV2Module,
   PlatformModule,
   UserContextMiddleware,
   ViewContextMiddleware,

package/dist/index.d.cts

@@ -1,5 +1,6 @@
 import { NestModule, DynamicModule, MiddlewareConsumer, NestMiddleware } from '@nestjs/common';
 import { NestExpressApplication } from '@nestjs/platform-express';
+export { DevToolsModule, DevToolsOptions, DevToolsV2Module, DevToolsV2Options } from '@lark-apaas/nestjs-openapi-devtools';
 import { Request, Response, NextFunction } from 'express';
 export * from '@lark-apaas/nestjs-authnpaas';
 export * from '@lark-apaas/nestjs-datapaas';
@@ -49,7 +50,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;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { NestModule, DynamicModule, MiddlewareConsumer, NestMiddleware } from '@nestjs/common';
 import { NestExpressApplication } from '@nestjs/platform-express';
+export { DevToolsModule, DevToolsOptions, DevToolsV2Module, DevToolsV2Options } from '@lark-apaas/nestjs-openapi-devtools';
 import { Request, Response, NextFunction } from 'express';
 export * from '@lark-apaas/nestjs-authnpaas';
 export * from '@lark-apaas/nestjs-datapaas';
@@ -49,7 +50,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;

package/dist/index.js

@@ -333,21 +333,38 @@ PlatformModule = _ts_decorate5([
 // src/setup.ts
 import { AppLogger as AppLogger2 } from "@lark-apaas/nestjs-logger";
 import cookieParser from "cookie-parser";
-async function configureApp(app) {
+import { DevToolsV2Module } from "@lark-apaas/nestjs-openapi-devtools";
+var defaultPerms = {
+  disableSwagger: false
+};
+async function configureApp(app, perms = defaultPerms) {
   app.useLogger(app.get(AppLogger2));
   app.flushLogs();
   app.use(cookieParser());
   const globalPrefix = process.env.CLIENT_BASE_PATH ?? "";
   app.setGlobalPrefix(globalPrefix);
+  if (process.env.NODE_ENV !== "production" && perms.disableSwagger !== true) {
+    try {
+      await DevToolsV2Module.mount(app, {
+        basePath: process.env.CLIENT_BASE_PATH,
+        docsPath: "/api_docs"
+      });
+    } catch (err) {
+      console.error("[OpenAPI] OpenAPI \u751F\u6210\u5931\u8D25:", err);
+    }
+  }
 }
 __name(configureApp, "configureApp");
 
 // src/index.ts
+import { DevToolsModule, DevToolsV2Module as DevToolsV2Module2 } from "@lark-apaas/nestjs-openapi-devtools";
 export * from "@lark-apaas/nestjs-authnpaas";
 export * from "@lark-apaas/nestjs-datapaas";
 export {
   CsrfMiddleware,
   CsrfTokenMiddleware,
+  DevToolsModule,
+  DevToolsV2Module2 as DevToolsV2Module,
   PlatformModule,
   UserContextMiddleware,
   ViewContextMiddleware,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lark-apaas/fullstack-nestjs-core",
-  "version": "1.0.17-alpha.1",
+  "version": "1.1.0",
   "description": "FullStack Nestjs Core",
   "type": "module",
   "main": "./dist/index.js",
@@ -41,6 +41,7 @@
     "@lark-apaas/nestjs-authnpaas": "^1.0.1",
     "@lark-apaas/nestjs-datapaas": "^1.0.5",
     "@lark-apaas/nestjs-logger": "^1.0.2",
+    "@lark-apaas/nestjs-openapi-devtools": "^1.0.7",
     "cookie-parser": "^1.4.7"
   },
   "devDependencies": {