galbe 0.14.0 → 0.15.1

package/bin/commands/generate/code.ts

@@ -2,7 +2,8 @@ import { $ } from 'bun'
 import { devNull } from 'os'
 import { Command, Option } from 'commander'
 import { resolve, relative, extname } from 'path'
-import { exists, readFile } from 'fs/promises'
+import { readFile } from 'fs/promises'
+import { existsSync } from 'fs'
 
 import { CWD, fmtList, fmtVal } from '../../util'
 import { applyPlan, planFromOapi, type GenerationPlan } from './code/openapi.parser'
@@ -114,10 +115,17 @@ export default (cmd: Command) => {
       const outDir = resolve(CWD, out)
 
       // Compute per-scope merge result.
-      const mergeResults: { scopeKey: string; content: string; added: RouteId[]; updated: RouteId[]; removed: RouteId[]; stale: RouteId[] }[] = []
+      const mergeResults: {
+        scopeKey: string
+        content: string
+        added: RouteId[]
+        updated: RouteId[]
+        removed: RouteId[]
+        stale: RouteId[]
+      }[] = []
       for (const scope of plan.scopes) {
         const routePath = resolve(outDir, `${scope.routeFile}.${target}`)
-        const existing = (await exists(routePath)) ? await readFile(routePath, 'utf-8') : null
+        const existing = existsSync(routePath) ? await readFile(routePath, 'utf-8') : null
         const r = mergeRouteFile(existing, scope, mergeOpts)
         mergeResults.push({ scopeKey: scope.scopeKey, ...r })
       }

package/bin/commands/generate/model.ts

@@ -125,7 +125,7 @@ export default (cmd: Command) => {
           FROM information_schema.tables
           WHERE table_schema = '${schema}'
           AND table_type = 'BASE TABLE'`)
-        tables = r.map(r => r.table_name)
+        tables = r.map((r: Record<string, string>) => r.table_name)
       }
 
       for (const tableName of tables) {
@@ -133,7 +133,7 @@ export default (cmd: Command) => {
           FROM information_schema.columns
           WHERE table_schema = '${schema}' AND table_name = '${tableName}'`)
         types[tableName] = `type ${toPascalCase(tableName)} = {\n${t
-          .map(r => `  ${r.column_name}: ${TYPE_MAP?.[r.data_type] ?? 'any'}${r.is_nullable ? ' | null' : ''}`)
+          .map((r: Record<string, string>) => `  ${r.column_name}: ${TYPE_MAP?.[r.data_type] ?? 'any'}${r.is_nullable ? ' | null' : ''}`)
           .join(';\n')}\n}`
       }
 

package/bin/res/client.runtime.ts

@@ -0,0 +1,184 @@
+// Inlined into the generated client — no exports
+import type { BodyInit } from 'bun'
+
+type GalbeClientConfig = {
+  server?: { url?: string }
+  headers?: Record<string, string>
+  fetch?: (req: Request) => Promise<Response>
+}
+
+class GalbeClientError extends Error {
+  readonly status: number
+  readonly headers: Headers
+  readonly body: string
+  constructor(status: number, headers: Headers, body: string) {
+    super(`HTTP ${status}`)
+    this.name = 'GalbeClientError'
+    this.status = status
+    this.headers = headers
+    this.body = body
+  }
+}
+
+const _parseResponse = async (res: Response): Promise<any> => {
+  const ct = res.headers.get('content-type') ?? ''
+  if (ct.includes('application/json')) return res.json()
+  if (ct.includes('application/octet-stream')) return new Uint8Array(await res.arrayBuffer())
+  return res.text()
+}
+
+const _buildUrl = (base: string | undefined, path: string, query?: Record<string, any>): string => {
+  let url = `${base ?? ''}${path}`
+  if (query) {
+    const params = new URLSearchParams()
+    for (const [k, v] of Object.entries(query)) {
+      if (v === undefined || v === null) continue
+      if (Array.isArray(v)) for (const item of v) params.append(k, String(item))
+      else params.set(k, String(v))
+    }
+    const qs = params.toString()
+    if (qs) url += `?${qs}`
+  }
+  return url
+}
+
+const _formdata = (data: Record<string, string | string[] | Blob>): FormData => {
+  const form = new FormData()
+  for (const [k, v] of Object.entries(data)) {
+    if (Array.isArray(v)) for (const item of v) form.append(k, String(item))
+    else form.append(k, v instanceof Blob ? v : String(v))
+  }
+  return form
+}
+
+type _RequestOptions = {
+  query?: Record<string, any>
+  headers?: Record<string, string>
+  contentType?: string
+}
+
+const _doFetch = (
+  config: GalbeClientConfig,
+  method: string,
+  path: string,
+  body?: any,
+  options?: _RequestOptions
+): Promise<Response> => {
+  const url = _buildUrl(config.server?.url, path, options?.query)
+  let bodyInit: BodyInit | undefined
+  const bodyHeaders: Record<string, string> = {}
+
+  if (body !== undefined && body !== null) {
+    const ct = options?.contentType
+    if (ct === 'urlForm') {
+      bodyInit = new URLSearchParams(body).toString()
+      bodyHeaders['content-type'] = 'application/x-www-form-urlencoded'
+    } else if (ct === 'multipart') {
+      bodyInit = _formdata(body)
+    } else if (ct === 'byteArray' || body instanceof Uint8Array) {
+      bodyInit = body
+      bodyHeaders['content-type'] = 'application/octet-stream'
+    } else if (ct === 'text') {
+      bodyInit = String(body)
+      bodyHeaders['content-type'] = 'text/plain'
+    } else {
+      bodyInit = JSON.stringify(body)
+      bodyHeaders['content-type'] = 'application/json'
+    }
+  }
+
+  const req = new Request(url, {
+    method,
+    headers: { ...config.headers, ...bodyHeaders, ...options?.headers },
+    ...(bodyInit !== undefined ? { body: bodyInit } : {}),
+  })
+
+  return (config.fetch ?? fetch)(req)
+}
+
+class GalbeRequest<T, E = any> {
+  #promise: Promise<[Response, Response]>
+  #main?: Promise<T>
+
+  constructor(fetchPromise: Promise<Response>) {
+    this.#promise = fetchPromise.then(res => [res, res.clone()] as [Response, Response])
+  }
+
+  #getMain(): Promise<T> {
+    if (!this.#main) {
+      this.#main = this.#promise.then(async ([res]) => {
+        if (!res.ok) throw new GalbeClientError(res.status, res.headers, await res.text())
+        return _parseResponse(res) as T
+      })
+    }
+    return this.#main
+  }
+
+  then<R1 = T, R2 = never>(
+    onfulfilled?: ((value: T) => R1 | PromiseLike<R1>) | null,
+    onrejected?: ((reason: any) => R2 | PromiseLike<R2>) | null
+  ): Promise<R1 | R2> {
+    return this.#getMain().then(onfulfilled, onrejected)
+  }
+
+  catch<R = never>(onrejected?: ((reason: any) => R | PromiseLike<R>) | null): Promise<T | R> {
+    return this.#getMain().then(undefined, onrejected)
+  }
+
+  finally(onfinally?: (() => void) | null): Promise<T> {
+    return this.#getMain().finally(onfinally)
+  }
+
+  async safe(): Promise<{ ok: true; data: T } | { ok: false; error: E }> {
+    const [mainRes, cloneRes] = await this.#promise
+    if (mainRes.ok) {
+      return { ok: true, data: (await _parseResponse(cloneRes)) as T }
+    } else {
+      const body = await _parseResponse(cloneRes)
+      return { ok: false, error: { status: mainRes.status, headers: mainRes.headers, body } as E }
+    }
+  }
+}
+
+const _createRequest = <T, E = any>(
+  config: GalbeClientConfig,
+  method: string,
+  path: string,
+  body?: any,
+  options?: _RequestOptions
+): GalbeRequest<T, E> => new GalbeRequest<T, E>(_doFetch(config, method, path, body, options))
+
+const _createRawRequest = async (
+  config: GalbeClientConfig,
+  method: string,
+  path: string,
+  body?: any,
+  options?: _RequestOptions
+): Promise<any> => {
+  const res = await _doFetch(config, method, path, body, options)
+  return {
+    status: res.status,
+    ok: res.ok,
+    redirected: res.redirected,
+    statusText: res.statusText,
+    type: res.type,
+    url: res.url,
+    headers: res.headers,
+    body: {
+      json: () => res.json(),
+      text: () => res.text(),
+      byteArray: () => res.arrayBuffer().then((b: ArrayBuffer) => new Uint8Array(b)),
+      stream: (): AsyncGenerator<Uint8Array, void, unknown> => {
+        const reader = res.body?.getReader()
+        return (async function* () {
+          if (!reader) return
+          while (true) {
+            const { value, done } = await reader.read()
+            if (done) break
+            yield value!
+          }
+        })()
+      },
+    },
+  }
+}

package/bin/res/client.template.ts

@@ -110,7 +110,7 @@ export default class GalbeClient {
                 text: 'text/plain',
                 json: 'application/json',
                 urlForm: 'application/x-www-form-urlencoded',
-              }[options.contentType],
+              }[options.contentType as 'byteArray' | 'text' | 'json' | 'urlForm'],
             }
           : {}),
         ...(options?.headers || {}),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "galbe",
-  "version": "0.14.0",
+  "version": "0.15.1",
   "description": "Fast, lightweight and highly customizable JavaScript web framework based on Bun",
   "author": "Pierre Caillaud M (https://github.com/pierre-cm)",
   "type": "module",
@@ -35,11 +35,10 @@
   "scripts": {
     "test": "bun test",
     "typecheck": "tsc --noEmit --emitDeclarationOnly false",
-    "postinstall": "bun run ./scripts/postinstall.ts",
     "release": "release-it"
   },
   "devDependencies": {
-    "@types/bun": "^1.2.22",
+    "@types/bun": "latest",
     "openapi-types": "^12.1.3",
     "release-it": "^17.1.1"
   },

package/src/extras.ts

@@ -1,2 +1,2 @@
 export { OpenAPISerializer } from './extras/spec/openapi.serializer'
-export type { GalbeCLICommand, GalbeCLIOptions } from './types'
+export type { GalbeCLICommand, GalbeCLIOptions, GalbeClientRoute, GalbeClientOptions } from './types'

package/src/index.ts

@@ -35,7 +35,7 @@ const overloadDiscriminer = <
   P extends Partial<STParams<Path>>,
   Q extends STQuery,
   B extends STBody,
-  R extends STResponse
+  R extends STResponse,
 >(
   galbe: Galbe,
   method: M,
@@ -69,7 +69,7 @@ const galbeMethod = <
   P extends Partial<STParams<Path>>,
   Q extends STQuery,
   B extends STBody,
-  R extends STResponse
+  R extends STResponse,
 >(
   _galbe: Galbe,
   method: M,
@@ -130,7 +130,7 @@ export class Galbe {
   stopCb: (() => void)[] = []
   errorCb: ErrorHandler[] = []
   listening: boolean = false
-  server?: Server
+  server?: Server<any>
   plugins: GalbePlugin[] = []
   constructor(config?: GalbeConfig) {
     this.config = config ?? {}
@@ -186,7 +186,7 @@ export class Galbe {
     H extends STHeaders,
     Q extends STQuery,
     B extends STBody,
-    R extends STResponse
+    R extends STResponse,
   >(
     path: Path,
     arg2:
@@ -205,7 +205,7 @@ export class Galbe {
     H extends STHeaders,
     Q extends STQuery,
     B extends STBody,
-    R extends STResponse
+    R extends STResponse,
   >(
     path: Path,
     arg2:
@@ -223,7 +223,7 @@ export class Galbe {
     H extends STHeaders,
     Q extends STQuery,
     B extends STBody,
-    R extends STResponse
+    R extends STResponse,
   >(
     path: Path,
     arg2:
@@ -241,7 +241,7 @@ export class Galbe {
     H extends STHeaders,
     Q extends STQuery,
     B extends STBody,
-    R extends STResponse
+    R extends STResponse,
   >(
     path: Path,
     arg2:
@@ -259,7 +259,7 @@ export class Galbe {
     H extends STHeaders,
     Q extends STQuery,
     B extends STBody,
-    R extends STResponse
+    R extends STResponse,
   >(
     path: Path,
     arg2:
@@ -277,7 +277,7 @@ export class Galbe {
     H extends STHeaders,
     Q extends STQuery,
     B extends STBody,
-    R extends STResponse
+    R extends STResponse,
   >(
     path: Path,
     arg2:
@@ -295,7 +295,7 @@ export class Galbe {
     H extends STHeaders,
     Q extends STQuery,
     B extends STBody,
-    R extends STResponse
+    R extends STResponse,
   >(
     path: Path,
     arg2:

package/src/server.ts

@@ -171,7 +171,7 @@ export default async (galbe: Galbe, port?: number, hostname?: string) => {
 
         const parsedResponse = responseParser(response, context as Context, cookies, schema.response)
 
-        if (galbe.config?.responseValidator?.enabled !== false && schema.response)
+        if (galbe.config?.responseValidator?.enabled !== false && schema.response && !(response instanceof Response))
           validateResponse(response, schema.response, parsedResponse.status || 200)
 
         for (const p of pluginsCb.afterHandle) {

package/src/types.ts

@@ -1,4 +1,4 @@
-import type { ServeOptions, SocketAddress, TLSOptions, TLSServeOptions } from 'bun'
+import type { Serve, SocketAddress, TLSOptions } from 'bun'
 import type {
   STAny,
   STArray,
@@ -140,7 +140,7 @@ export type GalbeConfig = {
   basePath?: string
   /** Enable or disable TLS support. */
   tls?: TLSOptions
-  server?: Exclude<ServeOptions, 'port'> | TLSServeOptions
+  server?: Exclude<Serve.Options<any>, 'port'> | TLSOptions
   /** A Glob Pattern or a list of Glob patterns defining the route files to be analyzed by the Automatic Route Analyzer. */
   routes?: boolean | string | string[]
   router?: { cacheEnabled: boolean }
@@ -343,7 +343,7 @@ export class RequestError extends Error {
     const message =
       typeof options.payload === 'string'
         ? options.payload
-        : HttpStatus[status as keyof typeof HttpStatus] ?? 'Request Error'
+        : (HttpStatus[status as keyof typeof HttpStatus] ?? 'Request Error')
     super(message)
     this.name = new.target?.name ?? 'RequestError'
     this.status = status
@@ -484,5 +484,29 @@ export type GalbeCLIOptions = {
     args: Record<string, string>,
     options: Record<string, any>
   ) => MaybePromise<Request>
-  responseFormatter?: (res: Response) => MaybePromise<string>
+  responseFormatter?: (
+    res: Response,
+    command: GalbeCLICommand,
+    args: Record<string, string>,
+    options: Record<string, any>
+  ) => MaybePromise<string>
+}
+
+export type GalbeClientRoute = {
+  method: string
+  path: string
+  operationId: string
+  autoDerived: boolean
+  params: Record<string, { type: string; description?: string }>
+  query: Record<string, { type: string; optional: boolean; description?: string }>
+  headers: Record<string, { type: string; optional: boolean; description?: string }>
+  body: Record<string, STSchema> | null
+  response: STResponse | null
+  summary?: string
+  description?: string
+  tags: string[]
+}
+
+export type GalbeClientOptions = {
+  className?: string
 }

package/scripts/hooks/prepare-commit-msg

@@ -1,10 +0,0 @@
-#!/usr/bin/env bun
-
-const COMMIT_MSG = await Bun.file(Bun.argv[2]).text()
-const COMMIT_EMOJI = { feat: '✨', fix: '🔧', doc: '📚', chore: '🧹' }
-
-const newCommitMsg = COMMIT_MSG.replace(/^(feat|fix|doc|chore):(.*)/, (_, type, msg) => {
-  return `${COMMIT_EMOJI[type]} ${type}:${msg}`
-})
-
-await Bun.write(Bun.argv[2], newCommitMsg)

package/scripts/postinstall.ts

@@ -1,9 +0,0 @@
-import { $ } from 'bun'
-import { existsSync } from 'fs'
-
-if (existsSync('.git')) {
-  console.log('Setting up dev environment')
-  Bun.write('.git/hooks/prepare-commit-msg', Bun.file('scripts/hooks/prepare-commit-msg'))
-  await $`chmod +x .git/hooks/prepare-commit-msg`
-  console.log('done')
-}