galbe 0.10.1 → 0.12.0

package/.prettierrc

@@ -1,6 +1,6 @@
 tabWidth: 2
 useTabs: false
-trailingComma: none
+trailingComma: es5
 semi: false
 singleQuote: true
 bracketSpacing: true

package/README.md

@@ -20,6 +20,9 @@ cd app
 bun install && bun dev
 ```
 
+The Galbe CLI ships with the package. You can invoke it with `bunx galbe` or
+install it globally using `bun install -g galbe`.
+
 ## Documentation
 
 The detailed documentation is available at [galbe.dev](https://galbe.dev).

package/bin/commands/generate/client.ts

@@ -5,7 +5,7 @@ import { Command, Option } from 'commander'
 import { resolve, extname } from 'path'
 import { rm } from 'fs/promises'
 import { transformSync } from '@swc/core'
-import { CWD, fmtList, instanciateRoutes, silentExec } from '../../util'
+import { CWD, fmtList, instanciateRoutes, silentExec, abbreviateVar } from '../../util'
 import { $T, Galbe, GalbeCLICommand, Method, Route, STResponse } from '../../../src'
 import { walkRoutes } from '../../../src/util'
 import { schemaToTypeStr, Optional, STSchema } from '../../../src/schema'
@@ -36,7 +36,7 @@ export default (cmd: Command) => {
       let pckg: any = {}
       try {
         pckg = await Bun.file(resolve(CWD, 'package.json')).json()
-      } catch (e) { }
+      } catch (e) {}
 
       let error = null
       Bun.write(Bun.stdout, '💻 \x1b[1;30mBuilding \x1b[36mGalbe\x1b[0m\x1b[1;30m client\x1b[0m')
@@ -63,7 +63,7 @@ export default (cmd: Command) => {
         patch: [],
         delete: [],
         options: [],
-        head: []
+        head: [],
       }
       const types: Record<string, STResponse> = {}
       let commands: GalbeCLICommand[] = []
@@ -75,7 +75,7 @@ export default (cmd: Command) => {
       walkRoutes(g.router.routes, r => {
         let meta = metaRoutes?.[r.path]?.[r.method]
         let [_, summary, description] = meta?.head?.match(/^([^\n]*)\n\n(.*)/) || []
-        if(!summary) description = meta?.head
+        if (!summary) description = meta?.head
         let route = {
           ...r,
           ...(meta?.operationId ? { alias: meta?.operationId } : {}),
@@ -89,36 +89,51 @@ export default (cmd: Command) => {
                 {
                   ...(r.schema?.params?.[m?.[1]]
                     ? {
-                      type: schemaToTypeStr(r.schema.params[m[1]]),
-                      ...(r.schema.params[m[1]]?.description
-                        ? { description: r.schema.params[m[1]].description as string }
-                        : {})
-                    }
-                    : { type: 'string' })
-                }
+                        type: schemaToTypeStr(r.schema.params[m[1]]),
+                        ...(r.schema.params[m[1]]?.description
+                          ? { description: r.schema.params[m[1]].description as string }
+                          : {}),
+                      }
+                    : { type: 'string' }),
+                },
               ])
             ) || {},
+          contentTypes: Object.keys(r.schema.body || { default: '' })
+            .map(s => `'${s}'`)
+            .join('|'),
           schemas: {
             ...(r.schema.headers ? { headers: schemaToTypeStr($T.object(r.schema.headers)) } : {}),
             ...(r.schema.query ? { query: schemaToTypeStr($T.object(r.schema.query)) } : {}),
-            ...(r.schema.body ? { body: schemaToTypeStr(r.schema.body) } : {}),
+            ...(r.schema.body
+              ? {
+                  body: `{${Object.entries(r.schema.body)
+                    .map(([ct, s]) => `${ct}: ${schemaToTypeStr(s)}`)
+                    .join(';')}}`,
+                }
+              : {}),
             ...(r.schema.response
               ? {
-                response: Object.fromEntries(
-                  Object.entries(r.schema.response).map(([k, v]) => [k === 'default' ? '"default"' : k, schemaToTypeStr(v as STSchema)])
-                )
-              }
-              : {})
-          }
+                  response: Object.fromEntries(
+                    Object.entries(r.schema.response).map(([k, v]) => [
+                      k === 'default' ? '"default"' : k,
+                      schemaToTypeStr(v as STSchema),
+                    ])
+                  ),
+                }
+              : {}),
+          },
         }
-        Object.values(r.schema.response || {}).filter(s => s?.id).forEach(s => {
-          //@ts-ignore
-          types[s.id] = schemaToTypeStr(s)
-        })
+        Object.values(r.schema.response || {})
+          .filter(s => s?.id)
+          .forEach(s => {
+            //@ts-ignore
+            types[s.id] = schemaToTypeStr(s)
+          })
         routes[r.method.toLocaleLowerCase()].push(route)
         if (target === 'cli' && meta?.operationId)
           commands.push({
             name: meta.operationId,
+            tags: meta?.tags ? (Array.isArray(meta.tags) ? meta.tags : [meta.tags]) : [],
             description: route.summary || route.description,
             route,
             arguments:
@@ -127,7 +142,7 @@ export default (cmd: Command) => {
                   return {
                     name: k,
                     type: p.type === 'boolean' ? '' : `<${p.type}>`,
-                    description: p?.description || ''
+                    description: p?.description || '',
                   }
                 }
               ) || [],
@@ -136,12 +151,12 @@ export default (cmd: Command) => {
                 let type = schemaToTypeStr({ ...o, [Optional]: false })
                 return {
                   name: k,
-                  short: k[0],
+                  short: abbreviateVar(k),
                   type: type === 'boolean' ? '' : `<${type}>`,
                   description: o?.description || '',
-                  default: o.default
+                  default: o.default,
                 }
-              }) || []
+              }) || [],
           })
       })
 
@@ -167,11 +182,11 @@ export default (cmd: Command) => {
           filled = transformSync(filled, {
             jsc: {
               parser: {
-                syntax: 'typescript'
+                syntax: 'typescript',
               },
               preserveAllComments: true,
-              target: 'esnext'
-            }
+              target: 'esnext',
+            },
           }).code
         }
 
@@ -182,6 +197,19 @@ export default (cmd: Command) => {
         // Plugin CLI hook
         if (commands) for (let p of g.plugins) if (p.cli) await p.cli(commands)
 
+        const tags = commands.reduce(
+          (p, c) => {
+            if (c.tags.length)
+              for (const t of c.tags) {
+                if (!(t in p)) p[t] = []
+                p[t].push(c)
+              }
+            else p[''].push(c)
+            return p
+          },
+          { '': [] as GalbeCLICommand[] }
+        )
+
         let filled = file.replaceAll(/\/\*\%([\s\S]*?)\%\*\//g, (_match, p) => {
           let idt = p.match(/^\n*([ \t]*)/, p)?.[1] || ''
           const script = new Script(p)
@@ -190,7 +218,7 @@ export default (cmd: Command) => {
             name: pckg?.name || 'Galbe app CLI',
             description: pckg?.description || '',
             version: pckg?.version || '0.1.0',
-            commands
+            tags,
           }
           createContext(sandbox)
           let res = script.runInNewContext(sandbox)

package/bin/commands/generate/code/openapi.parser.ts

@@ -3,6 +3,7 @@ import { transformSync } from '@swc/core'
 import { resolve, relative, dirname } from 'path'
 import { load as ymlLoad } from 'js-yaml'
 import { OpenAPIV3 } from 'openapi-types'
+import { inferBodyType } from '../../../../src/util'
 
 type SchemaEntry = {
   key: string
@@ -72,7 +73,7 @@ const serialize = (obj: any) => {
   return JSON.stringify(obj, (k, value) => {
     if (k === 'pattern' && value) return `/${value}/`
     return value
-  }).replace(/"\/(.*)\/([gimsuy]*)"/g, '/$1/$2');
+  }).replace(/"\/(.*)\/([gimsuy]*)"/g, '/$1/$2')
 }
 
 const writeCodeFile = async (path: string, content: string, target: 'js' | 'ts') => {
@@ -80,11 +81,11 @@ const writeCodeFile = async (path: string, content: string, target: 'js' | 'ts')
     content = transformSync(content, {
       jsc: {
         parser: {
-          syntax: 'typescript'
+          syntax: 'typescript',
         },
         preserveAllComments: true,
-        target: 'esnext'
-      }
+        target: 'esnext',
+      },
     }).code
   }
   await Bun.write(`${path}.${target}`, content)
@@ -99,7 +100,8 @@ const parseOapiSchema = (
     return `$T.any(${details && Object.keys(details).length ? JSON.stringify(details) : ''})`
   }
   //@ts-ignore
-  if (os?.$ref) return `%ref:${os.$ref}%`
+  const ref: string | undefined = os?.$ref
+  if (ref) return `%ref:${ref}%`
   os = os as OpenAPIV3.SchemaObject
   let options: typeof details & {
     min?: number
@@ -115,30 +117,51 @@ const parseOapiSchema = (
   } = {
     ...details,
     title: os.title,
-    description: details.description || os.description
+    description: details.description || os.description,
   }
-  if(!os?.type) return `$T.any(${details && Object.keys(details).length ? JSON.stringify(details) : ''})`
+
   let resp = ''
   let hasOptions = Object.values(options).some(v => !!v)
   let optArg = hasOptions ? serialize(options) : ''
-  let anyOf = os.oneOf || os.anyOf || os.allOf
+  let anyOf = os.oneOf || os.anyOf
+  let allOf = os.allOf
   let required = os.required
   let nullable = os.nullable
 
-  if (anyOf?.length) {
+  if (os.discriminator) {
+    const propName = os.discriminator.propertyName
+    const mapEntries = Object.entries(os.discriminator.mapping || {})
+    resp = `$T.union([${mapEntries
+      .map(
+        ([k, s]) =>
+          `$T.intersection([$T.object({\"${propName}\":$T.literal(\"${k}\")}),${parseOapiSchema({
+            $ref: s,
+          })}])`
+      )
+      .join(',')}], ${serialize(options)})`
+  } else if (anyOf?.length) {
     if (anyOf.length === 1) resp = parseOapiSchema(anyOf[0] as OpenAPIV3.SchemaObject, details, extra)
     else {
       resp = `$T.union([${anyOf.map(s => parseOapiSchema(s as OpenAPIV3.SchemaObject)).join(',')}], ${serialize(
         options
       )})`
     }
+  } else if (allOf?.length) {
+    if (allOf.length === 1) resp = parseOapiSchema(allOf[0] as OpenAPIV3.SchemaObject, details, extra)
+    else {
+      resp = `$T.intersection([${allOf.map(s => parseOapiSchema(s as OpenAPIV3.SchemaObject)).join(',')}], ${serialize(
+        options
+      )})`
+    }
+  } else if (!os?.type) {
+    return `$T.any(${details && Object.keys(details).length ? JSON.stringify(details) : ''})`
   } else if (os.type === 'boolean') resp = `$T.boolean(${hasOptions ? serialize(options) : ''})`
   else if (os.type === 'number') {
     let { max, min, exclusiveMax, exclusiveMin } = {
       max: os.maximum !== undefined && !os.exclusiveMaximum ? os.maximum : undefined,
       min: os.minimum !== undefined && !os.exclusiveMinimum ? os.minimum : undefined,
       exclusiveMax: os.maximum !== undefined && os.exclusiveMaximum ? os.maximum : undefined,
-      exclusiveMin: os.minimum !== undefined && os.exclusiveMinimum ? os.minimum : undefined
+      exclusiveMin: os.minimum !== undefined && os.exclusiveMinimum ? os.minimum : undefined,
     }
     options = { ...options, min, max, exclusiveMax, exclusiveMin }
     hasOptions = Object.values(options).some(v => !!v)
@@ -169,14 +192,14 @@ const parseOapiSchema = (
     resp = `$T.array(${parseOapiSchema(os?.items)}, ${optArg})`
   } else if (os.type === 'object') {
     let props = Object.entries(os?.properties || {})
-    .map(([k, v]) => `"${k}":${parseOapiSchema(v)}`)
-    .join(',')
+      .map(([k, v]) => `"${k}":${parseOapiSchema(v)}`)
+      .join(',')
     if (extra?.media === 'multipart/form-data') {
-      resp = `$T.multipartForm({${props}}${optArg ? `, ${optArg}`:''})`
+      resp = `$T.multipartForm({${props}}${optArg ? `, ${optArg}` : ''})`
     } else if (extra?.media === 'application/x-www-form-urlencoded') {
-      resp = `$T.urlForm({${props}}${optArg ? `, ${optArg}`:''})`
+      resp = `$T.object({${props}}${optArg ? `, ${optArg}` : ''})`
     } else {
-      resp = `$T.object({${props}}${optArg ? `, ${optArg}`:''})`
+      resp = `$T.object({${props}}${optArg ? `, ${optArg}` : ''})`
     }
   } else throw new Error(`Unknown schema type ${JSON.stringify(os)}`)
 
@@ -195,20 +218,17 @@ const buildSchemaIndex = (def: OpenAPIV3.Document) => {
     let dependsOn = new Set<string>()
     if (kind === 'schemas') schema = parseOapiSchema(s, { id: k })
     else if (kind === 'requestBodies' || kind === 'responses') {
-      let schemas=[] as string[]
-      if(!!s.content){
-
+      let schemas = [] as string[]
+      if (!!s.content) {
         schemas = [
           ...new Set(
-            Object.entries((s as OpenAPIV3.RequestBodyObject)?.content || {null:{}}).map(([media, v]) => {
+            Object.entries((s as OpenAPIV3.RequestBodyObject)?.content || { null: {} }).map(([media, v]) => {
               return parseOapiSchema(v.schema, { id: k }, { media })
             })
-          )
+          ),
         ]
       } else {
-        schemas = [
-          parseOapiSchema(undefined, {id: k, ...s})
-        ]
+        schemas = [parseOapiSchema(undefined, { id: k, ...s })]
       }
       schema = schemas.length <= 0 ? '' : schemas.length === 1 ? schemas[0] : `$T.union([${schemas.join(',')}])`
     }
@@ -222,7 +242,7 @@ const buildSchemaIndex = (def: OpenAPIV3.Document) => {
       prefix: '',
       schema,
       dependsOn,
-      usedBy: new Set()
+      usedBy: new Set(),
     }
   }
   for (let [k, v] of Object.entries(def.components?.schemas || {})) initSchema(k, v, 'schemas')
@@ -246,7 +266,7 @@ const parseEndpointDef = (method: string, path: string, def?: OpenAPIV3.Operatio
 
   let meta = '/**\n'
   if (def.summary) meta += ` * ${def.summary}\n *\n`
-  if (def.description) meta += ` * ${def.description.replace('\n', '\n * ')}\n`
+  if (def.description) meta += ` * ${def.description.replace(/\n/g, '\n * ')}\n`
   if (def.operationId) meta += ` * @operationId ${def.operationId}\n`
   if (def.externalDocs) meta += ` * @externalDocs ${def.externalDocs}\n`
   if (def.tags) meta += ` * @tags ${def.tags.join(' ')}\n`
@@ -259,9 +279,13 @@ const parseEndpointDef = (method: string, path: string, def?: OpenAPIV3.Operatio
     // @ts-ignore: TODO handle refs cases
     if (_p.$ref) continue
     let p = _p as OpenAPIV3.ParameterObject
-    let o = (s: string) => (p.in !== 'path' && !p.required && !/^\$T.optional\(.*\)$/.test(s) ? `$T.optional(${s})` : s)
+    let o = (s: string) => {
+      const [isOptional, so] = [...(s.match(/^\$T.optional\((.*)\)$/) || [])]
+      s = so ?? s
+      return p.in !== 'path' && !p.required && !isOptional ? `$T.optional(${s})` : s
+    }
     sp[p.in][p.name] = o(
-      unref(parseOapiSchema(p.schema, {description: p.description }), m => {
+      unref(parseOapiSchema(p.schema, { description: p.description }), m => {
         let l = m.split('/')
         imports[l[l.length - 1]] = m
         return l[l.length - 1]
@@ -272,7 +296,7 @@ const parseEndpointDef = (method: string, path: string, def?: OpenAPIV3.Operatio
   let [schemaParams, schemaQuery, schemaHeaders] = [
     { g: 'params', o: 'path' },
     { g: 'query', o: 'query' },
-    { g: 'headers', o: 'header' }
+    { g: 'headers', o: 'header' },
   ].map(({ g, o }) =>
     Object.keys(sp[o]).length
       ? `  ${g}: {${Object.entries(sp[o])
@@ -282,7 +306,7 @@ const parseEndpointDef = (method: string, path: string, def?: OpenAPIV3.Operatio
   )
 
   let body = ''
-  if(!['get', 'delete', 'options', 'head'].includes(method)){
+  if (!['get', 'delete', 'options', 'head'].includes(method)) {
     let _rb = def?.requestBody as OpenAPIV3.ReferenceObject
     if (_rb?.$ref) {
       body = unref(`  body: %ref:${_rb.$ref}%`, m => {
@@ -295,16 +319,17 @@ const parseEndpointDef = (method: string, path: string, def?: OpenAPIV3.Operatio
       let o = (s: string) => (!rb?.required ? `$T.optional(${s})` : s)
       let bs = [
         ...new Set(
-          Object.entries(rb?.content || {null:{}}).map(([media, v]) =>
+          Object.entries(rb?.content || { null: {} }).map(([media, v]) => [
+            media,
             unref(parseOapiSchema(v.schema, undefined, { media }), m => {
               let l = m.split('/')
               imports[l[l.length - 1]] = m
               return l[l.length - 1]
-            })
-          )
-        )
+            }),
+          ])
+        ),
       ]
-      body = bs.length === 1 ? `  body: ${o(bs[0])}` : bs.length > 1 ? `  body: ${o(`$T.union([${bs.join(',')}])`)}` : ''
+      body = bs.length ? `  body: {${bs.map(([k, v]) => `"${inferBodyType(k)}":${o(v)}`).join(',')}}` : ''
     }
   }
 
@@ -316,11 +341,13 @@ const parseEndpointDef = (method: string, path: string, def?: OpenAPIV3.Operatio
       let s: string = Number.isInteger(Number(status)) ? status : 'default'
 
       //@ts-ignore
-      let rootRef = sv?.$ref ? unref(parseOapiSchema(sv), m => {
-        let l = m.split('/')
-        imports[l[l.length - 1]] = m
-        return l[l.length - 1]
-      }) : null
+      let rootRef = sv?.$ref
+        ? unref(parseOapiSchema(sv), m => {
+            let l = m.split('/')
+            imports[l[l.length - 1]] = m
+            return l[l.length - 1]
+          })
+        : null
       if (rootRef) {
         return [s, [rootRef]]
       }
@@ -351,12 +378,12 @@ const parseEndpointDef = (method: string, path: string, def?: OpenAPIV3.Operatio
     schema: {
       name: schemaName,
       imports,
-      def: schema.length ? `{\n${schema.join(',\n')}\n}` : ''
+      def: schema.length ? `{\n${schema.join(',\n')}\n}` : '',
     },
     endpoint: {
       meta,
-      def: endpoint
-    }
+      def: endpoint,
+    },
   }
 }
 
@@ -383,7 +410,7 @@ const parseEndpoints = (def: OpenAPIV3.Document) => {
         scope,
         path,
         schema,
-        endpoint
+        endpoint,
       }
     }
   }
@@ -399,7 +426,7 @@ const writeFiles = async (
   const typeMap = {
     schemas: 'commons',
     requestBodies: 'requests',
-    responses: 'responses'
+    responses: 'responses',
   }
   const parseSchemasToFile = (
     schemas: Record<string, SchemaEntry>,
@@ -436,7 +463,7 @@ const writeFiles = async (
   const sMaps = [
     { g: 'commons', o: 'schemas' },
     { g: 'requests', o: 'requestBodies' },
-    { g: 'responses', o: 'responses' }
+    { g: 'responses', o: 'responses' },
   ] as const
   for (let { g, o } of sMaps) {
     let s = parseSchemasToFile(

package/bin/res/cli.template.js

@@ -4,7 +4,7 @@ import { program, Option } from 'commander'
 import { resolve } from 'path'
 
 const DEFAULT_HEADERS = {
-  'user-agent': 'Galbe//*%(()=>version)()%*//cli'
+  'user-agent': 'Galbe//*%(()=>version)()%*//cli',
 }
 const ansi = (p, c, str) => (p ? `\x1b[${c}m${str}\x1b[0m` : str)
 
@@ -73,9 +73,9 @@ const fetchApi = async (method, path, props) => {
     headers: {
       ...DEFAULT_HEADERS,
       ...(bodyFile ? { 'content-type': 'application/octet-stream' } : {}),
-      ...(headers || {})
+      ...(headers || {}),
     },
-    ...(body ? { body } : {})
+    ...(body ? { body } : {}),
   })
   let endTime = Bun.nanoseconds() - startTime
   if (format.has('s')) fmtRes(res.status, format.has('p'))
@@ -99,21 +99,23 @@ const formatDefault = def =>
     ? `[${def.map(d => formatDefault(d)).join(',')}]`
     : def ?? 'undefined';
 
-result = commands.map(c=>{
-  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:[]},
-    {name: '%query', short:'%q', type: '<string...>', description: 'query param formated as paramName=paramValue', default:[]},
-    {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}", "${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("${JSON.stringify(c.description).slice(1,-1)}")${args.join('')}${options.join('')}${action}`
+result = Object.entries(tags).map(([tag, commands])=>{
+  return (tag?`const _${tag} = program.command('${tag}');\n`:'')+commands.map(c=>{
+    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:[]},
+      {name: '%query', short:'%q', type: '<string...>', description: 'query param formated as paramName=paramValue', default:[]},
+      {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}", "${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 `${tag?`_${tag}`:'program'}.command("${c.name}").description("${JSON.stringify(c.description).slice(1,-1)}")${args.join('')}${options.join('')}${action}`
+  }).join(';\n')
 })
 %*/