UNPKG

@visulima/api-platform

Version:

Visulima API platform is a set of tools to build and consume web APIs

6 lines 11.6 kB
import {execSync}from'child_process';import {existsSync,statSync,rmSync,readdirSync,readFileSync}from'fs';import se,{cwd}from'process';import {normalize,basename,resolve,join,extname,parse,toNamespacedPath}from'@visulima/path';import y from'chalk';import {parseFile,jsDocumentCommentsToOpenApi,swaggerJsDocumentCommentsToOpenApi}from'@visulima/jsdoc-open-api';import {stat,readdir,realpath}from'fs/promises';import {toPath}from'@visulima/path/utils';var ie=(e,t)=>{if(t.length===0)throw new Error("must include at least one key to map");let r=e.toString();return t.forEach(o=>{r=o.optional?r.replace("(?:\\/([^\\/]+?))?\\",`/:${o.name}?`):r.replace("(?:([^\\/]+?))",`:${o.name}`);}),r.replace("/?(?=\\/|$)/i","").replace("/^","").replaceAll("\\","").replaceAll(/\/{2,}/gu,"/")},j=ie;var pe=(e,t)=>{if(typeof e=="string")return e;if(e.fast_slash)return "";if(e.fast_star)return "*";let r="";t.length>0&&(r=j(e,t));let o=/^\/\^((?:\\[$()*+./?[\\\]^{|}]|[^$()*+./?[\\\]^{|}])*)\$\//u.exec(e.toString().replace("\\/?","").replace("(?=\\/|$)","$"));return Array.isArray(o)&&o.length>1?o[1].replaceAll(/\\(.)/gu,"$1").slice(1):r?r.slice(1):e.toString()},L=pe;var ce=(e,t,r)=>{let o=e.route.stack.at(-1),s=t.map(i=>({in:"path",name:i.name,required:!i.optional})),a=e.route.stack.filter(i=>i.handle.metadata);if(a.length>1)throw new Error("Only one metadata middleware is allowed per route");let c=(r+e.route.path).replaceAll(/\/{2,}/gu,"/");return a.length===0?{method:o.method,path:c,pathParams:s}:{metadata:a[0].handle.metadata,method:o.method,path:c,pathParams:s}},$=(e,t,r,o)=>{if(o=[...o,...r.keys],r.name==="router"&&r.handle?.stack!==void 0)for(let s of r.handle.stack)t=t||"",$(e,`${t}/${L(r.regexp,r.keys)}`,s,o);!r.route||r.route.stack.length===0||e.push(ce(r,o,t));},le=e=>{let t=e._router||e.router,r=[];for(let o of t.stack)$(r,"",o,[]);return r},N=le;var me=e=>{let t=[];return N(e).forEach(r=>{t.push({file:"unknown",method:r.method.toUpperCase(),path:r.path,tags:[]});}),t},I=me;var C=e=>e.replaceAll(/ \(.*\)/gu,"").trim(),_=e=>e.trim().split(" ")[1].slice(1,-1),ue=e=>{let r=e.printRoutes().replaceAll(/[─│└├]/gu," ").trimEnd().split(` `),o=r.reduce((a,c,i)=>{let p=C(c);if(C(r[i-1]??"")===p){let k=a.filter(T=>T.index<i&&T.segment===p),{methods:F}=k.at(-1);return F!==null&&F.push(_(c)),a}let l=c.replaceAll(/ \(.*\)/gu,"").match(/ /gu);if(l===null)throw new Error("Invalid spaces");let n=l.length/4,d=c.includes("("),R=d?[_(c)]:null;return a.push({depth:n,index:i,isRoute:d,methods:R,segment:p}),a},[]),s=[];return o.filter(a=>a.isRoute).forEach(a=>{let i=[...o.filter(p=>p.index<a.index&&p.depth<a.depth).filter((p,m,l)=>!l.find(n=>n.depth===p.depth&&n.index>p.index)).map(p=>p.segment),a.segment].join("");if(a.methods===null)throw new Error("Invalid methods");a.methods.forEach(p=>{s.push({file:"unknown",method:p.toUpperCase(),path:i,tags:[]});});}),s},K=ue;var fe=e=>{let r=e._core.router.routes,o=[];return [...r.keys()].forEach(s=>{r.get(s).routes.forEach(a=>{o.push({file:"unknown",method:a.route.method.toUpperCase(),path:a.path,tags:[]});});}),o},M=fe;var de=e=>{let t=[];return e.middleware.filter(r=>r.router).flatMap(r=>r.router.stack).forEach(r=>{t.push({file:"unknown",method:r.methods.join("|").toUpperCase(),path:r.path,tags:[]});}),t},U=de;var H=/\.(js|ts|mjs|cjs)$/u,xe=(e,t,r=false)=>{e=toNamespacedPath(e);let o=toNamespacedPath(cwd()),s=[],a=parseFile(e,jsDocumentCommentsToOpenApi,r);s=[...s,...a.map(p=>p.spec)];let c=parseFile(e,swaggerJsDocumentCommentsToOpenApi,r);s=[...s,...c.map(p=>p.spec)];let i=[];return s.length===0?(readFileSync(e,"utf8").split(/\r?\n/u).forEach(m=>{let l=/[=aces|]+\s["'|](GET|POST|PUT|PATCH|HEAD|DELETE|OPTIONS)["'|]/u.exec(m);if(l){let[,n]=l;n==="GET"&&(n="GET|HEAD"),i.push({file:e.replace(`${o}/`,""),method:n,path:toNamespacedPath(e.replace(t,"").replace(H,"")),tags:[]});}}),i.length===0&&i.push({file:e.replace(`${o}/`,""),method:"GET|POST|PUT|PATCH|DELETE|HEAD|OPTIONS",path:toNamespacedPath(e.replace(t,"").replace(H,"")),tags:[]}),i):(s.forEach(p=>{Object.entries(p?.paths??{}).forEach(([l,n])=>{Object.entries(n).forEach(([R,k])=>{i.push({file:e.replace(`${o}/`,""),method:R.toUpperCase(),path:toNamespacedPath(l),tags:k.tags});});});}),i)},J=xe;var Se=Object.defineProperty,we=(e,t)=>Se(e,"name",{value:t,configurable:true}),Pe=Object.defineProperty,Re=we((e,t)=>Pe(e,"name",{value:t,configurable:true}),"n"),G=Re(e=>{if(!e||!(e instanceof URL)&&typeof e!="string")throw new TypeError("Path must be a non-empty string or URL.")},"assertValidFileOrDirectoryPath");var ke=Object.defineProperty,B=(e,t)=>ke(e,"name",{value:t,configurable:true}),ve=Object.defineProperty,be=B((e,t)=>ve(e,"name",{value:t,configurable:true}),"t"),E=class extends Error{static{B(this,"i");}static{be(this,"WalkError");}root;constructor(t,r){super(`${t instanceof Error?t.message:t} for path "${r}"`),this.cause=t,this.root=r;}get name(){return "WalkError"}set name(t){throw new Error("Cannot overwrite name of WalkError")}};var Ae=Object.defineProperty,X=(e,t)=>Ae(e,"name",{value:t,configurable:true}),De=Object.defineProperty,Oe=X((e,t)=>De(e,"name",{value:t,configurable:true}),"r"),v=Oe(e=>{let t=e.replace(/\.\*/g,".([^/]*)").replace(/\*\*/g,"(.*)").replace(/(?<!\.)\*(?!\*)/g,"([^/]*)").replace(/\?/g,"[^/]").replace(/\.(?!\*)/g,"\\.").replace(/\{/g,"(").replace(/\}/g,")").replace(/,/g,"|").replace(/\[!(.*?)\]/g,"[^$1]");return new RegExp(`^${t}$`)},"globToRegExp"),Fe=Object.defineProperty,Te=X((e,t)=>Fe(e,"name",{value:t,configurable:true}),"n"),x=Te((e,t,r,o)=>Array.isArray(t)&&t.length>0&&!t.some(s=>e.endsWith(s))||r&&!r.some(s=>s.test(e))?false:!o?.some(s=>s.test(e)),"walkInclude");var je=Object.defineProperty,q=(e,t)=>je(e,"name",{value:t,configurable:true}),Ue=Object.defineProperty,h=q((e,t)=>Ue(e,"name",{value:t,configurable:true}),"r"),We=h(async e=>{let t=normalize(e),r=basename(t),o=await stat(t);return {isDirectory:h(()=>o.isDirectory(),"isDirectory"),isFile:h(()=>o.isFile(),"isFile"),isSymbolicLink:h(()=>o.isSymbolicLink(),"isSymbolicLink"),name:r,path:t}},"_createWalkEntry");async function*S(e,{extensions:t,followSymlinks:r=false,includeDirs:o=true,includeFiles:s=true,includeSymlinks:a=true,match:c,maxDepth:i=Number.POSITIVE_INFINITY,skip:p}={}){if(G(e),i<0)return;let m=c?c.map(n=>typeof n=="string"?v(n):n):void 0,l=p?p.map(n=>typeof n=="string"?v(n):n):void 0;if(e=resolve(toPath(e)),o&&x(e,t,m,l)&&(yield await We(e)),!(i<1||!x(e,void 0,void 0,l)))try{for await(let n of await readdir(e,{withFileTypes:!0})){let d=join(e,n.name);if(n.isSymbolicLink())if(r)d=await realpath(d);else if(a&&x(d,t,m,l))yield {isDirectory:n.isDirectory,isFile:n.isFile,isSymbolicLink:n.isSymbolicLink,name:n.name,path:d};else continue;n.isSymbolicLink()||n.isDirectory()?yield*S(d,{extensions:t,followSymlinks:r,includeDirs:o,includeFiles:s,includeSymlinks:a,match:m,maxDepth:i-1,skip:l}):n.isFile()&&s&&x(d,t,m,l)&&(yield {isDirectory:h(()=>n.isDirectory(),"isDirectory"),isFile:h(()=>n.isFile(),"isFile"),isSymbolicLink:h(()=>n.isSymbolicLink(),"isSymbolicLink"),name:n.name,path:d});}}catch(n){throw n instanceof E?n:new E(n,e)}}q(S,"d");h(S,"walk");var He=Object.defineProperty,Je=(e,t)=>He(e,"name",{value:t,configurable:true}),Ge=Object.defineProperty,Be=Je((e,t)=>Ge(e,"name",{value:t,configurable:true}),"e"),b=Be(async(e,t={})=>{Array.isArray(t.extensions)||(t.extensions=["js","mjs","cjs","ts"]);let r=[];for await(let o of S(e,t))r.push(o.path);return r},"collect");var P=[".js",".ts",".mjs",".cjs"],z=e=>{let t=parse(e);for(;t.base&&t.root!==t.dir;){if(readdirSync(t.dir).find(s=>s==="package.json"))return t.dir;t=parse(t.dir);}return null},V=e=>{let t=`${e}/package.json`,{dependencies:r}=JSON.parse(readFileSync(t).toString());return r?.express?"express":r?.koa&&(r["@koa/router"]||r["koa-router"])?"koa":r?.next?"next":r?.["@hapi/hapi"]?"hapi":r?.fastify?"fastify":null},Q=(e,t)=>Object.keys(e).length===0?null:t==="hapi"?typeof e.app.app=="string"?e.app:e:e.app??e;var ee=e=>{try{return statSync(e).isDirectory()}catch{return false}},ze=async(e="")=>{let t=join(e,"pages/api");return !ee(t)&&(t=join(e,"src/pages/api"),!ee(t))?[]:b(t,{extensions:P,includeDirs:false})},te=ze;var A=async(e,t,r)=>{if(t==="express")return I(e);if(t==="koa")return U(e);if(t==="hapi")return M(e);if(t==="fastify")return K(e);if(t==="next"){let o=await te(e);if(o.length===0)throw new Error(`No API routes found, in "${e}".`);return o.flatMap(s=>J(s,e,r))}return null};var Ve=(e,t)=>{let r=new Map;return e.forEach(o=>{let s=t(o),a=r.get(s);a?a.push(o):r.set(s,[o]);}),r},re=Ve;var Qe=(e,t)=>{let r={ANY:y.redBright,DELETE:y.redBright,GET:y.blue,HEAD:y.hex("#6C7280"),OPTIONS:y.hex("#6C7280"),PATCH:y.yellow,POST:y.yellow,PUT:y.yellow},o;if(e==="GET|HEAD")o=`${y.blue("GET")}${y.grey("|HEAD")}`;else {let m=r[e](e);o=e==="GET"?`${m}${y.grey("|HEAD")}`:m;}let s=e==="GET"?6:14-e.length,a=Array.from({length:s}).fill(" ").join(""),c=process.stdout.columns-16-t.length-4,i=c>0?Array.from({length:c}).fill(".").join(""):"",p=t.split("/").map(m=>[":","["].includes(m[0]??"")?y.yellowBright(m):m).join("/");return ` ${o}${a}${p}${y.grey(i)}`},Ze=(e,t={})=>e.map(r=>{if(!(Array.isArray(t.methods)&&t.methods.includes(r.method)))return r.method==="GET|POST|PUT|PATCH|DELETE|HEAD|OPTIONS"&&(r.method="ANY"),Qe(r.method,r.path.replace("/pages",""))}).filter(Boolean),D=Ze;var rt=async(e,t,r={})=>{let o=join(se.cwd(),t);if(!existsSync(o))throw new Error("No such file, invalid path provided.");let s=z(o);if(!s)throw new Error("Please initialize local package.json.");if(e===void 0){let c=V(s);if(!c)throw new Error("Couldn't detect supported back-end framework.");e=c;}let a=null;if(e==="next")a=await A(o,"next",r.verbose??false);else {if(!statSync(o).isFile())throw new Error(`${o} is directory, but file expected.`);if(!P.includes(extname(o)))throw new Error("Please specify application .ts/.js/.mjs/.cjs file.");let c=`${s}/.env`;existsSync(c)&&(await import(`${s}/node_modules/dotenv/lib/main.js`)).config({path:c});let i=extname(o)===".ts",p=join(s,"node_modules/.bin/tsc");if(i&&!existsSync(p))throw new Error(`Please install typescript in ${s}`);try{if(i)try{execSync(`${p} --outDir framework-list >&2`,{cwd:s});}catch(n){console.log(`TSC compilation failed. Please resolve issues in your project. `),console.log(n),rmSync(join(s,"framework-list"),{recursive:!0});}let m=i?join(s,"framework-list",o.replace(s,"").replace(".ts",".js")):o,{default:l}=await import(m);a=await A(["AsyncFunction","Function"].includes(l.constructor.name)?await l():Q(l,e),e,r.verbose??!1);}finally{i&&rmSync(join(s,"framework-list"),{recursive:true});}}if(a===null)throw new Error(`Framework "${e}" is not supported.`);if(Array.isArray(r.includePaths)&&r.includePaths.length>0&&(a=r.includePaths.flatMap(c=>a.filter(i=>i.path.startsWith(c)))),Array.isArray(r.excludePaths)&&r.excludePaths.length>0&&(a=r.excludePaths.flatMap(c=>a.filter(i=>!i.path.startsWith(c)))),typeof r.group=="string"&&r.group!==""){console.log();let c=re(a,p=>r.group==="path"?p.path.replace("/pages","").split("/")[1]:p.tags[0]??"unsorted"),i=0;c.forEach((p,m)=>{i>0&&console.log();let l=(se.stdout.columns-16-m.length)/2,n=l>0?Array.from({length:l}).fill(" ").join(""):"";console.log(n+y.bold.underline(m)),D(p,r).forEach(d=>{console.log(d);}),i+=1;});}else console.log(),D(a,r).forEach(c=>{console.log(c);});console.log(` Listed ${y.greenBright(String(a.length))} HTTP ${a.length===1?"route":"routes"}. `);},kr=rt;export{kr as a};//# sourceMappingURL=chunk-ZT3FNDYC.mjs.map //# sourceMappingURL=chunk-ZT3FNDYC.mjs.map