adorn-api 1.0.21 → 1.0.22

package/dist/cli.js

@@ -1632,6 +1632,14 @@ function analyzeQueryBuilderForSchema(methodDeclaration, checker, options = {})
   }
   return parseQueryBuilderChain(callChain, checker, options);
 }
+function analyzeQueryBuilderWithDetails(methodDeclaration, checker, options = {}, operationInfo) {
+  const schema = analyzeQueryBuilderForSchema(methodDeclaration, checker, options);
+  return {
+    detected: schema !== null,
+    schema,
+    ...operationInfo
+  };
+}
 function analyzeWithVariableTracking(body, checker, options) {
   let queryBuilderVar = null;
   let entityName = null;
@@ -1993,7 +2001,12 @@ function generateOpenAPI(controllers, checker, options = {}) {
     mode: "response"
   };
   const paths = {};
-  const { onProgress } = options;
+  const { onProgress, onQueryBuilderProgress } = options;
+  let totalOperations = 0;
+  for (const controller of controllers) {
+    totalOperations += controller.operations.length;
+  }
+  let currentOperation = 0;
   for (let i = 0; i < controllers.length; i++) {
     const controller = controllers[i];
     if (onProgress) {
@@ -2005,6 +2018,32 @@ function generateOpenAPI(controllers, checker, options = {}) {
         paths[fullPath] = {};
       }
       const method = operation.httpMethod.toLowerCase();
+      const analysisResult = analyzeQueryBuilderWithDetails(
+        operation.methodDeclaration,
+        checker,
+        {},
+        {
+          methodName: operation.operationId,
+          httpMethod: operation.httpMethod,
+          path: operation.path,
+          operationId: operation.operationId
+        }
+      );
+      if (onQueryBuilderProgress) {
+        currentOperation++;
+        onQueryBuilderProgress({
+          controller: controller.className,
+          operation: operation.operationId,
+          method: operation.httpMethod,
+          path: operation.path,
+          queryBuilderDetected: analysisResult.detected,
+          entityName: analysisResult.schema?.entityName,
+          selectedFields: analysisResult.schema?.selectedFields,
+          isPaged: analysisResult.schema?.isPaged,
+          current: currentOperation,
+          total: totalOperations
+        });
+      }
       paths[fullPath][method] = buildOperation(operation, ctx, controller.consumes);
     }
   }
@@ -4017,6 +4056,7 @@ async function buildCommand(args) {
   const verbose = args.includes("--verbose");
   const quiet = args.includes("--quiet");
   const split = args.includes("--split");
+  const showQueryBuilder = args.includes("--show-query-builder");
   const splitStrategyIndex = args.indexOf("--split-strategy");
   const splitStrategy = splitStrategyIndex !== -1 ? args[splitStrategyIndex + 1] : void 0;
   const splitThresholdIndex = args.indexOf("--split-threshold");
@@ -4077,6 +4117,12 @@ async function buildCommand(args) {
     }
   }
   progress.startPhase("openapi", "Generating OpenAPI schema");
+  const queryBuilderStats = {
+    totalOperations,
+    detected: 0,
+    fallback: 0,
+    operations: []
+  };
   const openapiSpinner = new Spinner("Processing schemas");
   if (!quiet) openapiSpinner.start();
   const openapi = generateOpenAPI(controllers, checker, {
@@ -4086,6 +4132,31 @@ async function buildCommand(args) {
       if (!quiet) {
         openapiSpinner.setStatus(`${message} (${current}/${total})`);
       }
+    },
+    onQueryBuilderProgress: (info) => {
+      if (info.queryBuilderDetected) {
+        queryBuilderStats.detected++;
+      } else {
+        queryBuilderStats.fallback++;
+      }
+      queryBuilderStats.operations.push({
+        operationId: info.operation,
+        method: info.method,
+        path: info.path,
+        detected: info.queryBuilderDetected,
+        entityName: info.entityName,
+        selectedFields: info.selectedFields,
+        isPaged: info.isPaged
+      });
+      if (showQueryBuilder || verbose) {
+        if (info.queryBuilderDetected) {
+          const fieldsStr = info.selectedFields && info.selectedFields.length > 0 ? ` [select: ${info.selectedFields.join(",")}]` : "";
+          const pagedStr = info.isPaged ? " (paged)" : "";
+          progress.verboseLog(`  \u2713 Query builder: ${info.method} ${info.path} \u2192 ${info.entityName}${fieldsStr}${pagedStr}`);
+        } else {
+          progress.verboseLog(`  \u25CB No query builder: ${info.method} ${info.path} \u2192 using full entity schema`);
+        }
+      }
     }
   });
   if (!quiet) {
@@ -4144,6 +4215,17 @@ async function buildCommand(args) {
     }
   }
   progress.completePhase("openapi", `Generated ${schemaCount} schema(s)${splitEnabled ? " (split into groups)" : ""}`);
+  if (showQueryBuilder && totalOperations > 0) {
+    log("");
+    log("Query Builder Analysis:");
+    log(`  Operations analyzed:    ${totalOperations}`);
+    log(`  Patterns detected:      ${queryBuilderStats.detected} (${Math.round(queryBuilderStats.detected / totalOperations * 100)}%)`);
+    log(`  Full schemas used:      ${queryBuilderStats.fallback} (${Math.round(queryBuilderStats.fallback / totalOperations * 100)}%)`);
+    if (queryBuilderStats.detected > 0) {
+      const totalFields = queryBuilderStats.operations.filter((op) => op.detected && op.selectedFields).reduce((sum, op) => sum + (op.selectedFields?.length || 0), 0);
+      log(`  Fields selected:        ${totalFields} total (avg ${Math.round(totalFields / queryBuilderStats.detected)} per query)`);
+    }
+  }
   progress.startPhase("manifest", "Generating manifest");
   const manifest = generateManifest(controllers, checker, ADORN_VERSION, validationMode);
   progress.completePhase("manifest");
@@ -4225,7 +4307,12 @@ async function buildCommand(args) {
     schemas: schemaCount,
     sourceFiles: projectSourceFiles.length,
     artifactsWritten: artifacts.map((a) => a.name),
-    splitEnabled
+    splitEnabled,
+    queryBuilder: {
+      detected: queryBuilderStats.detected,
+      fallback: queryBuilderStats.fallback,
+      total: totalOperations
+    }
   };
   progress.printSummary(stats);
   progress.printArtifacts(artifacts);
@@ -4253,30 +4340,32 @@ if (command === "build") {
   console.log(`
 adorn-api CLI v${ADORN_VERSION}
 
-Commands:
-  build     Generate OpenAPI and manifest from TypeScript source
-  clean     Remove generated artifacts
+ Commands:
+   build     Generate OpenAPI and manifest from TypeScript source
+   clean     Remove generated artifacts
 
- Options:
-  -p <path>                Path to tsconfig.json (default: ./tsconfig.json)
-  --output <dir>           Output directory (default: .adorn)
-  --if-stale               Only rebuild if artifacts are stale
-  --validation-mode <mode> Validation mode: none, ajv-runtime, precompiled (default: ajv-runtime)
-  --split                  Enable automatic schema splitting (default: disabled)
-  --split-strategy <mode>  Override splitting strategy: controller, dependency, size, auto (default: auto)
-  --split-threshold <num>  Schema count threshold for auto-split (default: 50)
-  --verbose                Show detailed progress information
-  --quiet                  Suppress non-essential output
+  Options:
+   -p <path>                Path to tsconfig.json (default: ./tsconfig.json)
+   --output <dir>           Output directory (default: .adorn)
+   --if-stale               Only rebuild if artifacts are stale
+   --validation-mode <mode> Validation mode: none, ajv-runtime, precompiled (default: ajv-runtime)
+   --split                  Enable automatic schema splitting (default: disabled)
+   --split-strategy <mode>  Override splitting strategy: controller, dependency, size, auto (default: auto)
+   --split-threshold <num>  Schema count threshold for auto-split (default: 50)
+   --verbose                Show detailed progress information
+   --quiet                  Suppress non-essential output
+   --show-query-builder     Show query builder inspection details and statistics
 
-Examples:
-  adorn-api build -p ./tsconfig.json --output .adorn
-  adorn-api build --if-stale
-  adorn-api build --validation-mode precompiled
-  adorn-api build --verbose
-  adorn-api build --split                 # Enable split mode
-  adorn-api build --split-strategy controller  # Force controller-based splitting
-  adorn-api build --split-threshold 100   # Increase threshold to 100
-  adorn-api clean
-  `);
+ Examples:
+   adorn-api build -p ./tsconfig.json --output .adorn
+   adorn-api build --if-stale
+   adorn-api build --validation-mode precompiled
+   adorn-api build --verbose
+   adorn-api build --show-query-builder  # Show query builder analysis details
+   adorn-api build --split                 # Enable split mode
+   adorn-api build --split-strategy controller  # Force controller-based splitting
+   adorn-api build --split-threshold 100   # Increase threshold to 100
+   adorn-api clean
+   `);
 }
 //# sourceMappingURL=cli.js.map