@codexsploitx/schemaapi 1.1.8 → 1.1.9

package/dist/cli/commands/audit.d.ts

@@ -0,0 +1 @@
+export declare function handleAudit(args: string[]): void;

package/dist/cli.js

@@ -6865,7 +6865,7 @@ function loadSchemaApi() {
         return {};
     }
 }
-function loadContractsModule(contractsDir) {
+function loadContractsModule$1(contractsDir) {
     const cwd = process.cwd();
     const baseDir = path__namespace.join(cwd, contractsDir || "contracts");
     const candidates = ["index.js", "index.cjs", "index.ts"];
@@ -6925,7 +6925,7 @@ function generateDocs(config) {
     if (adapter || contractsDir) {
         console.log(`Using config: adapter=${adapter || "unknown"}, contractsDir=${contractsDir}`);
     }
-    const contractsModule = loadContractsModule(contractsDir);
+    const contractsModule = loadContractsModule$1(contractsDir);
     if (!contractsModule) {
         console.error(`Could not find contracts entry in ${contractsDir}. Expected index.js or index.cjs`);
         return;
@@ -7099,6 +7099,88 @@ function handleGenerate(args) {
     }
 }
 
+function loadContractsModule(contractsDir) {
+    const cwd = process.cwd();
+    const baseDir = path__namespace.join(cwd, contractsDir);
+    const candidates = ["index.js", "index.cjs", "index.ts"];
+    for (const file of candidates) {
+        const fullPath = path__namespace.join(baseDir, file);
+        if (fs__namespace.existsSync(fullPath)) {
+            try {
+                // We use require/import to load the contract objects
+                // In a real TS environment, we might need ts-node/register if loading .ts directly
+                // But assuming the user has compiled code or we are running in a compatible env:
+                if (file.endsWith('.ts')) {
+                    require('ts-node/register');
+                }
+                return require(fullPath);
+            }
+            catch (error) {
+                console.error(`Failed to load contracts module at ${fullPath}:`, (error && error.message) || error);
+                return null;
+            }
+        }
+    }
+    return null;
+}
+function handleAudit(args) {
+    const config = loadConfig();
+    const contractsDir = config?.contractsDir || "contracts";
+    console.log(`🔍 Starting SchemaApi Audit in directory: ${contractsDir}`);
+    const contractsModule = loadContractsModule(contractsDir);
+    if (!contractsModule) {
+        console.error(`❌ Could not find contracts entry in ${contractsDir}. Make sure index.ts/js exists and exports your contracts.`);
+        return;
+    }
+    let totalIssues = 0;
+    const candidates = Object.values(contractsModule).filter((value) => value &&
+        typeof value === "object" &&
+        typeof value.docs === "function" // Duck typing for Contract
+    );
+    if (candidates.length === 0) {
+        console.warn("⚠️  No contracts found exported in the entry file.");
+        return;
+    }
+    candidates.forEach((contract, index) => {
+        const docs = contract.docs(); // This returns the contract structure
+        const routes = docs.routes || [];
+        console.log(`\n📄 Contract #${index + 1}: Found ${routes.length} routes`);
+        routes.forEach((route) => {
+            const issues = [];
+            const method = route.method;
+            const pathStr = route.path;
+            const fullRoute = `${method} ${pathStr}`;
+            // 1. Security Check: Roles
+            if (!route.roles || route.roles.length === 0) {
+                issues.push(`⚠️  [Security] No roles defined. Endpoint is public? Consider adding explicit roles or 'public'.`);
+            }
+            // 2. Validation Check: Params
+            // Basic check: if path has :param, schema should have it
+            const pathParams = (pathStr.match(/:[a-zA-Z0-9_]+/g) || []).map((p) => p.substring(1));
+            if (pathParams.length > 0) ;
+            // 3. Completeness: Errors
+            if (!route.errors || Object.keys(route.errors).length === 0) {
+                issues.push(`ℹ️  [Best Practice] No error status codes defined. Clients won't know what errors to expect.`);
+            }
+            if (issues.length > 0) {
+                console.log(`  🔸 ${fullRoute}`);
+                issues.forEach(issue => console.log(`     ${issue}`));
+                totalIssues += issues.length;
+            }
+            else {
+                console.log(`  ✅ ${fullRoute}`);
+            }
+        });
+    });
+    console.log(`\n🏁 Audit complete.`);
+    if (totalIssues > 0) {
+        console.log(`Found ${totalIssues} potential issues.`);
+    }
+    else {
+        console.log(`No obvious issues found. Great job! 🎉`);
+    }
+}
+
 async function cli(args) {
     const command = args[0];
     switch (command) {
@@ -7109,7 +7191,7 @@ async function cli(args) {
             handleGenerate(args.slice(1));
             break;
         case 'audit':
-            console.log('Running SchemaApi audit');
+            handleAudit(args.slice(1));
             break;
         case 'adapters':
             console.log(`