@hustle-together/api-dev-tools 3.11.1 → 3.12.2

package/scripts/extract-parameters.ts

@@ -17,8 +17,8 @@
  * @generated by @hustle-together/api-dev-tools v3.0
  */
 
-import fs from 'fs';
-import path from 'path';
+import fs from "fs";
+import path from "path";
 
 // ============================================
 // Types
@@ -26,7 +26,7 @@ import path from 'path';
 
 interface ParameterDefinition {
   name: string;
-  location: 'query' | 'body' | 'header' | 'path';
+  location: "query" | "body" | "header" | "path";
   type: string;
   required: boolean;
   description?: string;
@@ -62,7 +62,11 @@ interface ParameterMatrix {
 // File Discovery
 // ============================================
 
-function findFiles(baseDir: string, pattern: RegExp, exclude: string[] = ['node_modules', '.git', 'dist']): string[] {
+function findFiles(
+  baseDir: string,
+  pattern: RegExp,
+  exclude: string[] = ["node_modules", ".git", "dist"],
+): string[] {
   const files: string[] = [];
 
   function walk(dir: string) {
@@ -120,7 +124,10 @@ function extractFromZodSchema(content: string): ParameterDefinition[] {
   return params;
 }
 
-function parseZodChain(name: string, chain: string): ParameterDefinition | null {
+function parseZodChain(
+  name: string,
+  chain: string,
+): ParameterDefinition | null {
   // Determine base type
   const typeMatch = chain.match(/z\.(\w+)/);
   if (!typeMatch) return null;
@@ -129,13 +136,13 @@ function parseZodChain(name: string, chain: string): ParameterDefinition | null
 
   const param: ParameterDefinition = {
     name,
-    location: 'body', // Default, will be refined based on context
+    location: "body", // Default, will be refined based on context
     type: mapZodType(baseType),
-    required: true
+    required: true,
   };
 
   // Check for optional
-  if (chain.includes('.optional()') || chain.includes('.nullable()')) {
+  if (chain.includes(".optional()") || chain.includes(".nullable()")) {
     param.required = false;
   }
 
@@ -151,18 +158,18 @@ function parseZodChain(name: string, chain: string): ParameterDefinition | null
     try {
       param.default = JSON.parse(defaultMatch[1].replace(/'/g, '"'));
     } catch {
-      param.default = defaultMatch[1].replace(/['"]/g, '');
+      param.default = defaultMatch[1].replace(/['"]/g, "");
     }
     param.required = false; // Has default = not required
   }
 
   // Extract enum values
-  if (baseType === 'enum') {
+  if (baseType === "enum") {
     const enumMatch = chain.match(/z\.enum\s*\(\s*\[([^\]]+)\]/);
     if (enumMatch) {
       param.enum = enumMatch[1]
-        .split(',')
-        .map(s => s.trim().replace(/['"`]/g, ''));
+        .split(",")
+        .map((s) => s.trim().replace(/['"`]/g, ""));
     }
   }
 
@@ -182,16 +189,16 @@ function parseZodChain(name: string, chain: string): ParameterDefinition | null
 
 function mapZodType(zodType: string): string {
   const typeMap: Record<string, string> = {
-    'string': 'string',
-    'number': 'number',
-    'boolean': 'boolean',
-    'array': 'array',
-    'object': 'object',
-    'enum': 'enum',
-    'literal': 'literal',
-    'union': 'union',
-    'date': 'string (ISO date)',
-    'coerce': 'coerced'
+    string: "string",
+    number: "number",
+    boolean: "boolean",
+    array: "array",
+    object: "object",
+    enum: "enum",
+    literal: "literal",
+    union: "union",
+    date: "string (ISO date)",
+    coerce: "coerced",
   };
   return typeMap[zodType] || zodType;
 }
@@ -200,7 +207,10 @@ function mapZodType(zodType: string): string {
 // Route File Extractor
 // ============================================
 
-function extractFromRouteFile(content: string, existingParams: ParameterDefinition[]): ParameterDefinition[] {
+function extractFromRouteFile(
+  content: string,
+  existingParams: ParameterDefinition[],
+): ParameterDefinition[] {
   const params: ParameterDefinition[] = [];
 
   // Extract query parameters from searchParams usage
@@ -209,12 +219,15 @@ function extractFromRouteFile(content: string, existingParams: ParameterDefiniti
   let match;
   while ((match = queryParamRegex.exec(content)) !== null) {
     const name = match[1];
-    if (!existingParams.some(p => p.name === name) && !params.some(p => p.name === name)) {
+    if (
+      !existingParams.some((p) => p.name === name) &&
+      !params.some((p) => p.name === name)
+    ) {
       params.push({
         name,
-        location: 'query',
-        type: 'string',
-        required: false // Query params are typically optional
+        location: "query",
+        type: "string",
+        required: false, // Query params are typically optional
       });
     }
   }
@@ -224,12 +237,15 @@ function extractFromRouteFile(content: string, existingParams: ParameterDefiniti
   const headerRegex = /headers\.get\s*\(\s*['"`]([^'"`]+)['"`]\s*\)/g;
   while ((match = headerRegex.exec(content)) !== null) {
     const name = match[1];
-    if (!existingParams.some(p => p.name === name) && !params.some(p => p.name === name)) {
+    if (
+      !existingParams.some((p) => p.name === name) &&
+      !params.some((p) => p.name === name)
+    ) {
       params.push({
         name,
-        location: 'header',
-        type: 'string',
-        required: false
+        location: "header",
+        type: "string",
+        required: false,
       });
     }
   }
@@ -239,12 +255,15 @@ function extractFromRouteFile(content: string, existingParams: ParameterDefiniti
   const pathParamRegex = /params\.(\w+)|{\s*(\w+)\s*}\s*=\s*params/g;
   while ((match = pathParamRegex.exec(content)) !== null) {
     const name = match[1] || match[2];
-    if (!existingParams.some(p => p.name === name) && !params.some(p => p.name === name)) {
+    if (
+      !existingParams.some((p) => p.name === name) &&
+      !params.some((p) => p.name === name)
+    ) {
       params.push({
         name,
-        location: 'path',
-        type: 'string',
-        required: true // Path params are always required
+        location: "path",
+        type: "string",
+        required: true, // Path params are always required
       });
     }
   }
@@ -268,7 +287,7 @@ function extractTestedParams(content: string): string[] {
     const bodyContent = match[1];
     const paramNames = bodyContent.match(/(\w+)\s*:/g);
     if (paramNames) {
-      paramNames.forEach(p => testedParams.add(p.replace(':', '').trim()));
+      paramNames.forEach((p) => testedParams.add(p.replace(":", "").trim()));
     }
   }
 
@@ -292,7 +311,7 @@ function extractTestedParams(content: string): string[] {
 // ============================================
 
 function extractAllParameters(baseDir: string): ParameterMatrix {
-  console.log('🔍 Scanning for parameter sources...');
+  console.log("🔍 Scanning for parameter sources...");
 
   // Find files
   const schemaFiles = findFiles(baseDir, /schema.*\.ts$|schemas?\/.*\.ts$/);
@@ -307,7 +326,7 @@ function extractAllParameters(baseDir: string): ParameterMatrix {
 
   // Process schema files
   for (const schemaFile of schemaFiles) {
-    const content = fs.readFileSync(schemaFile, 'utf-8');
+    const content = fs.readFileSync(schemaFile, "utf-8");
     const params = extractFromZodSchema(content);
 
     if (params.length > 0) {
@@ -315,20 +334,25 @@ function extractAllParameters(baseDir: string): ParameterMatrix {
 
       // Determine endpoint from file path
       const pathParts = relativePath.split(path.sep);
-      const apiIndex = pathParts.findIndex(p => p === 'api');
-      let endpoint = '/api/unknown';
+      const apiIndex = pathParts.findIndex((p) => p === "api");
+      let endpoint = "/api/unknown";
 
       if (apiIndex >= 0) {
-        endpoint = '/' + pathParts.slice(apiIndex).join('/').replace(/\/schema.*\.ts$/, '');
+        endpoint =
+          "/" +
+          pathParts
+            .slice(apiIndex)
+            .join("/")
+            .replace(/\/schema.*\.ts$/, "");
       }
 
       const existing = endpointsMap.get(endpoint) || {
         endpoint,
-        method: 'POST',
+        method: "POST",
         parameters: [],
         sourceFiles: [],
         testedParameters: [],
-        untestedParameters: []
+        untestedParameters: [],
       };
 
       existing.parameters.push(...params);
@@ -342,30 +366,33 @@ function extractAllParameters(baseDir: string): ParameterMatrix {
 
   // Process route files
   for (const routeFile of routeFiles) {
-    const content = fs.readFileSync(routeFile, 'utf-8');
+    const content = fs.readFileSync(routeFile, "utf-8");
     const relativePath = path.relative(baseDir, routeFile);
 
     // Determine endpoint
     const pathParts = relativePath.split(path.sep);
-    const apiIndex = pathParts.findIndex(p => p === 'api');
-    let endpoint = '/api/unknown';
+    const apiIndex = pathParts.findIndex((p) => p === "api");
+    let endpoint = "/api/unknown";
 
     if (apiIndex >= 0) {
-      endpoint = '/' + pathParts.slice(apiIndex, -1).join('/');
+      endpoint = "/" + pathParts.slice(apiIndex, -1).join("/");
     }
 
     const existing = endpointsMap.get(endpoint) || {
       endpoint,
-      method: 'GET',
+      method: "GET",
       parameters: [],
       sourceFiles: [],
       testedParameters: [],
-      untestedParameters: []
+      untestedParameters: [],
     };
 
     // Determine method
-    if (content.includes('export async function POST') || content.includes('export const POST')) {
-      existing.method = 'POST';
+    if (
+      content.includes("export async function POST") ||
+      content.includes("export const POST")
+    ) {
+      existing.method = "POST";
     }
 
     const routeParams = extractFromRouteFile(content, existing.parameters);
@@ -384,7 +411,7 @@ function extractAllParameters(baseDir: string): ParameterMatrix {
 
   // Process test files to find tested parameters
   for (const testFile of testFiles) {
-    const content = fs.readFileSync(testFile, 'utf-8');
+    const content = fs.readFileSync(testFile, "utf-8");
     const relativePath = path.relative(baseDir, testFile);
 
     // Determine endpoint from test file
@@ -396,7 +423,9 @@ function extractAllParameters(baseDir: string): ParameterMatrix {
 
     if (existing) {
       const testedParams = extractTestedParams(content);
-      existing.testedParameters = [...new Set([...existing.testedParameters, ...testedParams])];
+      existing.testedParameters = [
+        ...new Set([...existing.testedParameters, ...testedParams]),
+      ];
 
       console.log(`\n🧪 Test: ${relativePath}`);
       console.log(`   Found ${testedParams.length} tested parameters`);
@@ -407,9 +436,11 @@ function extractAllParameters(baseDir: string): ParameterMatrix {
   let totalParams = 0;
   let testedParams = 0;
 
-  const endpoints = Array.from(endpointsMap.values()).map(ep => {
-    const allParamNames = ep.parameters.map(p => p.name);
-    ep.untestedParameters = allParamNames.filter(p => !ep.testedParameters.includes(p));
+  const endpoints = Array.from(endpointsMap.values()).map((ep) => {
+    const allParamNames = ep.parameters.map((p) => p.name);
+    ep.untestedParameters = allParamNames.filter(
+      (p) => !ep.testedParameters.includes(p),
+    );
 
     totalParams += ep.parameters.length;
     testedParams += ep.testedParameters.length;
@@ -418,14 +449,15 @@ function extractAllParameters(baseDir: string): ParameterMatrix {
   });
 
   return {
-    version: '3.0.0',
+    version: "3.0.0",
     generatedAt: new Date().toISOString(),
     endpoints,
     coverage: {
       totalParameters: totalParams,
       testedParameters: testedParams,
-      coveragePercent: totalParams > 0 ? Math.round((testedParams / totalParams) * 100) : 0
-    }
+      coveragePercent:
+        totalParams > 0 ? Math.round((testedParams / totalParams) * 100) : 0,
+    },
   };
 }
 
@@ -436,12 +468,18 @@ function extractAllParameters(baseDir: string): ParameterMatrix {
 function main() {
   const args = process.argv.slice(2);
   const baseDir = args[0] || process.cwd();
-  const outputPath = args[1] || path.join(baseDir, 'src', 'app', 'api-test', 'parameter-matrix.json');
+  const outputPath =
+    args[1] ||
+    path.join(baseDir, "src", "app", "api-test", "parameter-matrix.json");
 
-  console.log('═══════════════════════════════════════════════════════════════');
-  console.log('  📊 Parameter Matrix Extractor');
-  console.log('  @hustle-together/api-dev-tools v3.0');
-  console.log('═══════════════════════════════════════════════════════════════');
+  console.log(
+    "═══════════════════════════════════════════════════════════════",
+  );
+  console.log("  📊 Parameter Matrix Extractor");
+  console.log("  @hustle-together/api-dev-tools v3.0");
+  console.log(
+    "═══════════════════════════════════════════════════════════════",
+  );
   console.log(`\n📁 Base directory: ${baseDir}`);
   console.log(`📄 Output file: ${outputPath}\n`);
 
@@ -456,22 +494,26 @@ function main() {
   // Write matrix
   fs.writeFileSync(outputPath, JSON.stringify(matrix, null, 2));
 
-  console.log('\n═══════════════════════════════════════════════════════════════');
-  console.log('  ✅ Parameter matrix generated successfully!');
-  console.log('═══════════════════════════════════════════════════════════════');
+  console.log(
+    "\n═══════════════════════════════════════════════════════════════",
+  );
+  console.log("  ✅ Parameter matrix generated successfully!");
+  console.log(
+    "═══════════════════════════════════════════════════════════════",
+  );
   console.log(`\n📊 Coverage Summary:`);
   console.log(`   • Total parameters: ${matrix.coverage.totalParameters}`);
   console.log(`   • Tested parameters: ${matrix.coverage.testedParameters}`);
   console.log(`   • Coverage: ${matrix.coverage.coveragePercent}%`);
 
   // List untested parameters
-  const untested = matrix.endpoints.flatMap(ep =>
-    ep.untestedParameters.map(p => `${ep.endpoint}: ${p}`)
+  const untested = matrix.endpoints.flatMap((ep) =>
+    ep.untestedParameters.map((p) => `${ep.endpoint}: ${p}`),
   );
 
   if (untested.length > 0) {
     console.log(`\n⚠️  Untested parameters (${untested.length}):`);
-    untested.slice(0, 10).forEach(p => console.log(`   • ${p}`));
+    untested.slice(0, 10).forEach((p) => console.log(`   • ${p}`));
     if (untested.length > 10) {
       console.log(`   ... and ${untested.length - 10} more`);
     }