galbe 0.8.0 → 0.9.1

package/bin/res/cli.template.js

@@ -31,17 +31,17 @@ const fmtRes = (r, p = false) => {
   if (typeof r === 'object') {
     try {
       let resp = fmtObject(r, p, 2)
-      return process.stdout.write(`${resp}\n`)
+      return Bun.write(Bun.stdout, `${resp}\n`)
     } catch (err) {
       console.error(err)
-      return process.stdout.write(`${r}\n`)
+      return Bun.write(Bun.stdout, `${r}\n`)
     }
   }
-  if (!p) return process.stdout.write(`${r}\n`)
-  if (typeof r === 'boolean') return process.stdout.write(`${ansi(p, '38;2;255;128;0', r)}\n`)
-  if (typeof r === 'number') return process.stdout.write(`${ansi(p, '38;2;10;180;220', r)}\n`)
-  if (typeof r === 'string') return process.stdout.write(`${ansi(p, '38;2;125;170;0', r)}\n`)
-  return process.stdout.write(`${r}\n`)
+  if (!p) return Bun.write(Bun.stdout, `${r}\n`)
+  if (typeof r === 'boolean') return Bun.write(Bun.stdout, `${ansi(p, '38;2;255;128;0', r)}\n`)
+  if (typeof r === 'number') return Bun.write(Bun.stdout, `${ansi(p, '38;2;10;180;220', r)}\n`)
+  if (typeof r === 'string') return Bun.write(Bun.stdout, `${ansi(p, '38;2;125;170;0', r)}\n`)
+  return Bun.write(Bun.stdout, `${r}\n`)
 }
 
 const fetchApi = async (method, path, props) => {
@@ -84,9 +84,9 @@ const fetchApi = async (method, path, props) => {
     let isJson = res.headers.get('content-type') === 'application/json'
     if (isJson) fmtRes(await res.json(), format.has('p'))
     else if (res.headers.get('content-type')?.match(/^text\//)) fmtRes(await res.text(), format.has('p'))
-    else process.stdout.write(await res.arrayBuffer())
+    else Bun.write(Bun.stdout, await res.arrayBuffer())
   }
-  if (format.has('t')) process.stdout.write(`${(endTime / 1_000_000).toFixed(2)}ms\n`)
+  if (format.has('t')) Bun.write(Bun.stdout, `${(endTime / 1_000_000).toFixed(2)}ms\n`)
   process.exit(res.ok ? 0 : 1)
 }
 
@@ -100,7 +100,7 @@ const formatDefault = def =>
     : def ?? 'undefined';
 
 result = commands.map(c=>{
-  let args = c.arguments.map(a=>`.argument("${a.name}", "${a.description || a.name+' argument' || ''}")`)
+  let args = c.arguments.map(a=>`.argument("${a.name}", "${JSON.stringify(a.description).slice(1,-1) || a.name+' argument' || ''}")`)
   let optionsBase = [
     {name: '%format', short:'%f', type: '[string]', description: 'response format [\'s\',\'h\',\'b\',\'t\',\'p\']', default:["s","b","p"]},
     {name: '%header', short:'%h', type: '<string...>', description: 'request header formated as headerName=headerValue', default:[]},
@@ -108,12 +108,12 @@ result = commands.map(c=>{
     {name: '%body', short:'%b', type: '<string>', description: 'request body', default:''},
     {name: '%bodyFile', short:'%bf', type: '<path>', description: 'request body file', default:''}
   ]
-  let options = [...optionsBase,...(c.options||[])].map(o=>`.addOption(new Option("-${o.short}, --${o.name} ${o.type}", "${o.description}").default(${formatDefault(o.default)}))`)
-  let action = `.action(async (${c.arguments.map(a=>`${a.name},`)} props) => {
+  let options = [...optionsBase,...(c.options||[])].map(o=>`.addOption(new Option("-${o.short}, --${o.name} ${o.type}", "${JSON.stringify(o.description).slice(1,-1)}").default(${formatDefault(o.default)}))`)
+  let action = `.action(async (${c.arguments.map(a=>`${a.name},`).join('')} props) => {
     ${c.action ? ';('+c.action.toString()+')(props)' : ''}
     return await fetchApi("${c.route.method.toUpperCase()}",\`${c.route.pathT}\`, props)
   })`
-  return `program.command("${c.name}").description("${c.description}")${args.join('')}${options.join('')}${action}`
+  return `program.command("${c.name}").description("${JSON.stringify(c.description).slice(1,-1)}")${args.join('')}${options.join('')}${action}`
 })
 %*/
 

package/bin/res/client.template.ts

@@ -6,8 +6,8 @@ export type GalbeClientConfig = {
 export const Kind = Symbol.for('json.string')
 type Json<T> = { T: T }
 
-interface GR<S extends number = number, B = any, OKS extends number = OKStatusCode> {
-  status: S
+interface GR<S extends number | 'default' = 'default', B = any, OKS extends number = OKStatusCode> {
+  status: Exclude<S, "default">
   ok: S extends OKS ? true : false
   redirected: boolean
   statusText: string
@@ -18,16 +18,16 @@ interface GR<S extends number = number, B = any, OKS extends number = OKStatusCo
     stream?: ST
   ) => B extends Uint8Array
     ? ST extends true
-      ? Promise<AsyncGenerator<Uint8Array, void, unknown>>
-      : B extends Json<infer T>
-      ? Promise<T>
-      : Promise<B>
+    ? Promise<AsyncGenerator<Uint8Array, void, unknown>>
+    : B extends Json<infer T>
+    ? Promise<T>
+    : Promise<B>
     : B extends string
     ? ST extends true
-      ? Promise<AsyncGenerator<string, void, unknown>>
-      : B extends Json<infer T>
-      ? Promise<T>
-      : Promise<B>
+    ? Promise<AsyncGenerator<string, void, unknown>>
+    : B extends Json<infer T>
+    ? Promise<T>
+    : Promise<B>
     : B extends Json<infer T>
     ? Promise<T>
     : Promise<B>
@@ -35,9 +35,9 @@ interface GR<S extends number = number, B = any, OKS extends number = OKStatusCo
 
 export type OKStatusCode = 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226
 // prettier-ignore
-export type HttpStatusCode = 100|101|102|103|OKStatusCode|300|301|302|303|304|305|307|308|400|401|402|403|404|405|406|407|408|409|410|411|412|413|414|415|416|417|418|421|422|423|424|426|428|429|431|451|500|501|502|503|504|505|506|507|508|510|511
+export type HttpStatusCode = 100 | 101 | 102 | 103 | OKStatusCode | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511
 type PGR<
-  S extends number = number,
+  S extends number | 'default' = 'default',
   B = any,
   O extends number = 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226
 > = Promise<GR<S, B, O>>
@@ -54,9 +54,15 @@ const DEFAULT_HEADERS = {
   'user-agent': 'Galbe//*%(()=>version)()%*/'
 }
 
+// Typescript types
+/*%
+Object.entries(types).map(([tk, t])=>{
+  return `export type ${tk} = ${t}`
+})
+%*/
+
 export default class GalbeClient {
   config?: GalbeClientConfig
-
   /*%
   Object.entries(routes).map(([method, list])=>{
     return`${method} = {\n${list.map( r => {
@@ -66,7 +72,7 @@ export default class GalbeClient {
         ''
       let oks = Object.keys(r.schemas?.response||{}).filter(s=>s>=200&&s<300)
       let responses = Object.keys(r.schemas?.response||{}).length ?
-        `${Object.entries(r.schemas.response).map(([k,v])=>`PGR<${k},${v}${oks?.length?`,${oks.join('|')}`:''}>`).join('|')}|PGR<Exclude<HttpStatusCode,${Object.keys(r.schemas.response).join('|')}>,any${oks?.length?`,${oks.join('|')}`:''}>`: 
+        `${Object.entries(r.schemas.response).filter(([s,_])=>s!=='"default"').map(([k,v])=>`PGR<${k},${v}${oks?.length?`,${oks.join('|')}`:''}>`).join('|')}|PGR<Exclude<HttpStatusCode,${Object.keys(r.schemas.response).filter(s=>s!=='"default"').join('|')}>,${'"default"' in r.schemas.response ? r.schemas.response['"default"'] : 'any'}${oks?.length?`,${oks.join('|')}`:''}>`: 
         `PGR<HttpStatusCode,any${oks?.length?`,${oks.join('|')}`:',any'}>`
       return `  '${r.path}':(${p.length?p.map(([k,v])=>`${k}:${v.type}`).join(',')+', ':''}options:RequestOptions${schemas}={})=>this.fetch(\`${r.pathT}\`,{...options,method:'${r.method.toUpperCase()}'}) as ${responses}`
     }).join(',\n')}\n}`
@@ -155,9 +161,13 @@ export default class GalbeClient {
         ''
       let oks = Object.keys(r.schemas?.response||{}).filter(s=>s>=200&&s<300)
       let responses = Object.keys(r.schemas?.response||{}).length ?
-        `${Object.entries(r.schemas.response).map(([k,v])=>`PGR<${k},${v}${oks?.length?`,${oks.join('|')}`:''}>`).join('|')}|PGR<Exclude<HttpStatusCode,${Object.keys(r.schemas.response).join('|')}>,any${oks?.length?`,${oks.join('|')}`:''}>`: 
+        `${Object.entries(r.schemas.response).filter(([s,_])=>s!=='"default"').map(([k,v])=>`PGR<${k},${v}${oks?.length?`,${oks.join('|')}`:''}>`).join('|')}|PGR<Exclude<HttpStatusCode,${Object.keys(r.schemas.response).filter(s=>s!=='"default"').join('|')}>,${'"default"' in r.schemas.response ? r.schemas.response['"default"'] : 'any'}${oks?.length?`,${oks.join('|')}`:''}>`: 
         `PGR<HttpStatusCode,any${oks?.length?`,${oks.join('|')}`:',any'}>`
-      return `${r.alias}(${p.length ? p.map(([k,v])=>`${k}: ${v.type}`).join(', ')+', ':''}options: RequestOptions${schemas} = {}){return this.fetch(\`${r.pathT}\`, {...options, method: '${r.method.toUpperCase()}'}) as ${responses}}\n`
+      let summary = r.summary ? `   * ${r.summary || ''}\n   *\n` : ''
+      let description = r.description ? `   * ${r.description.replace(/\n/g,'\n   * ')}` : ''
+      let params = Object.entries(r.schema.params || {}).map( ([k,v])=>`\n   * @param ${k} - ${v.description?.replace(/\n/g,'\n     ')}` ).join('')
+      let query = Object.entries(r.schema.query || {}).map( ([k,v])=>`\n   * @param options.query.${k} - ${v.description?.replace(/\n/g,'\n     ')}` ).join('')
+      return `/**\n${summary}${description}\n   *${params}${query}\n   *\/\n  ${r.alias}(${p.length ? p.map(([k,v])=>`${k}: ${v.type}`).join(', ')+', ':''}options: RequestOptions${schemas} = {}){return this.fetch(\`${r.pathT}\`, {...options, method: '${r.method.toUpperCase()}'}) as ${responses}}\n`
     }).join('  ')
   })
   %*/

package/bin/util.ts

@@ -2,7 +2,7 @@ import { relative } from 'path'
 import { watch } from 'chokidar'
 import { Galbe, Route } from '../src'
 import { logRoute, walkRoutes } from '../src/util'
-import { RouteMeta, defineRoutes } from '../src/routes'
+import { GalbeProxy, RouteMeta, defineRoutes } from '../src/routes'
 
 export { default as pckg } from '../package.json'
 
@@ -22,7 +22,7 @@ export const silentExec = async (fn: () => any) => {
   let consoleMock = Object.fromEntries(
     Object.entries(console)
       .filter(([_, v]) => typeof v === 'function')
-      .map(([k, _]) => [k, () => {}])
+      .map(([k, _]) => [k, () => { }])
   )
   const _console = console
   const _processStdoutWrite = process.stdout.write
@@ -30,9 +30,9 @@ export const silentExec = async (fn: () => any) => {
   //@ts-ignore
   global.console = consoleMock
   //@ts-ignore
-  process.stdout.write = function () {}
+  process.stdout.write = function () { }
   //@ts-ignore
-  process.stderr.write = function () {}
+  process.stderr.write = function () { }
   const r = await fn()
   global.console = _console
   process.stdout.write = _processStdoutWrite
@@ -65,29 +65,32 @@ export const instanciateRoutes = async (g: Galbe) => {
     hasMainRoutes = true
     logRoute(r)
   })
-  if (hasMainRoutes) process.stdout.write('\n')
+  if (hasMainRoutes) Bun.write(Bun.stdout, '\n')
   // Route Files Analysis
   let routes: Record<string, { route?: Route; meta?: RouteMeta; error?: any }[]> = {}
   let errors: Record<string, any> = {}
-  await defineRoutes({ routes: g?.config?.routes }, g, ({ type, route, error, filepath, meta }) => {
+
+  const proxy = new GalbeProxy(g, ({ type, route, error, filepath, meta }) => {
+    if (meta?.ignore || meta?.hide) return
     if (!filepath) return
     if (!(filepath in routes)) routes[filepath] = []
     if (type === 'add' && route && filepath) routes[filepath].push({ route, meta })
     if (type === 'error') errors[filepath] = error
   })
+  await defineRoutes({ routes: g?.config?.routes }, proxy)
   for (let [fp, e] of Object.entries(routes)) {
     console.log(`\x1b\[0;36m    ${relative(CWD, fp)}\x1b[0m`)
     let maxPathLength = e.reduce((p, c) => {
       return Math.max(p, c.route?.path.length || 0)
     }, 0)
     for (let r of e) {
-      if (r.route) logRoute(r.route, r.meta, { maxPathLength })
+      if (r.route && !r.meta?.ignore && !r.meta?.hide) logRoute(r.route, r.meta, { maxPathLength })
     }
     if (errors?.[fp]) {
       console.log(`\x1b\[0;31m    Error:\x1b[0m`)
       console.log(errors?.[fp])
     }
-    process.stdout.write('\n')
+    console.log("")
   }
   console.log('\x1b[1;30m\x1b[32mdone\x1b[0m\n')
 }