@lark-apaas/devtool-kits 1.2.19 → 1.2.21

package/dist/index.d.cts

@@ -1,6 +1,7 @@
 import { IncomingMessage, ServerResponse } from 'node:http';
-import { Router, RequestHandler, Application } from 'express';
-import { ServerResponse as ServerResponse$1, IncomingMessage as IncomingMessage$1 } from 'http';
+import { RequestHandler, Router, Application } from 'express';
+import * as t from '@babel/types';
+import { IncomingMessage as IncomingMessage$1, ServerResponse as ServerResponse$1 } from 'http';
 
 /**
  * 标准化基础路径，确保以 '/' 开头且不包含 trailing slash
@@ -165,12 +166,23 @@ type Middleware = RouteMiddleware | GlobalMiddleware;
 interface OpenapiMiddlewareOptions {
     /** Path to the openapi.json file */
     openapiFilePath: string;
+    /** Path to the OpenAPI spec source file (when set, serves /openapi/spec with /openapi/* filtered and $refs resolved) */
+    openapiSpecFilePath?: string;
     /** Enable source code enhancement */
     enableEnhancement?: boolean;
     /** Server directory for source code scanning (defaults to context.rootDir) */
     serverDir?: string;
 }
 
+/**
+ * Scan serverDir for NestJS controller files and extract all parameterized API routes.
+ * Synchronous — safe to call at preset config time (before bundling).
+ */
+declare function parseApiRoutes(serverDir: string): Array<{
+    method: string;
+    path: string;
+}>;
+
 /**
  * Creates OpenAPI middleware that serves enhanced openapi.json
  * Supports both rspack/webpack and Vite dev servers
@@ -271,4 +283,30 @@ declare function getQueryParam(req: AnyRequest, key: string): string | undefined
  */
 declare function registerMiddlewares(server: ExpressApp | ViteMiddleware, middlewares: Middleware[], options?: Partial<MiddlewareContext>): Promise<void>;
 
-export { type GlobalMiddleware, type Middleware, type MiddlewareContext, type Options, type RouteInfo, type RouteMiddleware, createCollectLogsMiddleware, createDevLogsMiddleware, createOpenapiMiddleware, getQuery, getQueryParam, handleDevProxyError, normalizeBasePath, parseAndGenerateNestResourceTemplate, postprocessDrizzleSchema, registerMiddlewares, sendError, sendJson, sendSuccess };
+interface PageRouteInfo {
+    path?: string;
+    index?: boolean;
+    [key: string]: unknown;
+}
+interface ParseRoutesOptions {
+    /** If true, prefix all routes with basePath. Default: true */
+    applyBasePath?: boolean;
+}
+declare function routeParserLog(level: 'log' | 'warn' | 'error' | 'info', message: string, ...args: unknown[]): void;
+declare function calculateFileHash(filePath: string): string | null;
+declare function isRouteComponent(openingElement: t.JSXOpeningElement): boolean;
+declare function evaluateTemplateLiteral(templateLiteral: t.TemplateLiteral): string;
+declare function extractPageRouteInfo(openingElement: t.JSXOpeningElement): PageRouteInfo;
+declare function buildFullPath(routeStack: PageRouteInfo[], currentRoute: PageRouteInfo): string | null;
+/**
+ * Parse routes from the app file at build time.
+ * @param appPath - Path to app.tsx (relative to cwd or absolute)
+ * @param basePath - Normalized base path prefix (e.g., '/my_plugin', or '' for no prefix)
+ * @param options - Parse options
+ * @returns Array of route definitions
+ */
+declare function parseRoutesFromFile(appPath: string, basePath: string, options?: ParseRoutesOptions): Array<{
+    path: string;
+}>;
+
+export { type GlobalMiddleware, type Middleware, type MiddlewareContext, type Options, type PageRouteInfo, type ParseRoutesOptions, type RouteInfo, type RouteMiddleware, buildFullPath, calculateFileHash, createCollectLogsMiddleware, createDevLogsMiddleware, createOpenapiMiddleware, evaluateTemplateLiteral, extractPageRouteInfo, getQuery, getQueryParam, handleDevProxyError, isRouteComponent, normalizeBasePath, parseAndGenerateNestResourceTemplate, parseApiRoutes, parseRoutesFromFile, postprocessDrizzleSchema, registerMiddlewares, routeParserLog, sendError, sendJson, sendSuccess };

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { IncomingMessage, ServerResponse } from 'node:http';
-import { Router, RequestHandler, Application } from 'express';
-import { ServerResponse as ServerResponse$1, IncomingMessage as IncomingMessage$1 } from 'http';
+import { RequestHandler, Router, Application } from 'express';
+import * as t from '@babel/types';
+import { IncomingMessage as IncomingMessage$1, ServerResponse as ServerResponse$1 } from 'http';
 
 /**
  * 标准化基础路径，确保以 '/' 开头且不包含 trailing slash
@@ -165,12 +166,23 @@ type Middleware = RouteMiddleware | GlobalMiddleware;
 interface OpenapiMiddlewareOptions {
     /** Path to the openapi.json file */
     openapiFilePath: string;
+    /** Path to the OpenAPI spec source file (when set, serves /openapi/spec with /openapi/* filtered and $refs resolved) */
+    openapiSpecFilePath?: string;
     /** Enable source code enhancement */
     enableEnhancement?: boolean;
     /** Server directory for source code scanning (defaults to context.rootDir) */
     serverDir?: string;
 }
 
+/**
+ * Scan serverDir for NestJS controller files and extract all parameterized API routes.
+ * Synchronous — safe to call at preset config time (before bundling).
+ */
+declare function parseApiRoutes(serverDir: string): Array<{
+    method: string;
+    path: string;
+}>;
+
 /**
  * Creates OpenAPI middleware that serves enhanced openapi.json
  * Supports both rspack/webpack and Vite dev servers
@@ -271,4 +283,30 @@ declare function getQueryParam(req: AnyRequest, key: string): string | undefined
  */
 declare function registerMiddlewares(server: ExpressApp | ViteMiddleware, middlewares: Middleware[], options?: Partial<MiddlewareContext>): Promise<void>;
 
-export { type GlobalMiddleware, type Middleware, type MiddlewareContext, type Options, type RouteInfo, type RouteMiddleware, createCollectLogsMiddleware, createDevLogsMiddleware, createOpenapiMiddleware, getQuery, getQueryParam, handleDevProxyError, normalizeBasePath, parseAndGenerateNestResourceTemplate, postprocessDrizzleSchema, registerMiddlewares, sendError, sendJson, sendSuccess };
+interface PageRouteInfo {
+    path?: string;
+    index?: boolean;
+    [key: string]: unknown;
+}
+interface ParseRoutesOptions {
+    /** If true, prefix all routes with basePath. Default: true */
+    applyBasePath?: boolean;
+}
+declare function routeParserLog(level: 'log' | 'warn' | 'error' | 'info', message: string, ...args: unknown[]): void;
+declare function calculateFileHash(filePath: string): string | null;
+declare function isRouteComponent(openingElement: t.JSXOpeningElement): boolean;
+declare function evaluateTemplateLiteral(templateLiteral: t.TemplateLiteral): string;
+declare function extractPageRouteInfo(openingElement: t.JSXOpeningElement): PageRouteInfo;
+declare function buildFullPath(routeStack: PageRouteInfo[], currentRoute: PageRouteInfo): string | null;
+/**
+ * Parse routes from the app file at build time.
+ * @param appPath - Path to app.tsx (relative to cwd or absolute)
+ * @param basePath - Normalized base path prefix (e.g., '/my_plugin', or '' for no prefix)
+ * @param options - Parse options
+ * @returns Array of route definitions
+ */
+declare function parseRoutesFromFile(appPath: string, basePath: string, options?: ParseRoutesOptions): Array<{
+    path: string;
+}>;
+
+export { type GlobalMiddleware, type Middleware, type MiddlewareContext, type Options, type PageRouteInfo, type ParseRoutesOptions, type RouteInfo, type RouteMiddleware, buildFullPath, calculateFileHash, createCollectLogsMiddleware, createDevLogsMiddleware, createOpenapiMiddleware, evaluateTemplateLiteral, extractPageRouteInfo, getQuery, getQueryParam, handleDevProxyError, isRouteComponent, normalizeBasePath, parseAndGenerateNestResourceTemplate, parseApiRoutes, parseRoutesFromFile, postprocessDrizzleSchema, registerMiddlewares, routeParserLog, sendError, sendJson, sendSuccess };