npm - galbe - Versions diffs - 0.12.0 → 0.12.2 - Mend

galbe 0.12.0 → 0.12.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (42) hide show

package/bin/commands/generate/code/openapi.parser.ts +2 -2
package/package.json +6 -1
package/.github/ISSUE_TEMPLATE/bug_report.md +0 -35
package/.github/ISSUE_TEMPLATE/feature_request.md +0 -23
package/.github/workflows/build_test.yml +0 -17
package/.github/workflows/deploy_website.yml +0 -20
package/.github/workflows/release.yml +0 -39
package/.prettierrc +0 -10
package/bun.lock +0 -904
package/bunfig.toml +0 -2
package/docs/CONTRIBUTING.md +0 -105
package/docs/cli.md +0 -343
package/docs/configuration.md +0 -80
package/docs/context.md +0 -104
package/docs/error-handler.md +0 -54
package/docs/getting-started.md +0 -164
package/docs/handler.md +0 -119
package/docs/hooks.md +0 -90
package/docs/plugins.md +0 -146
package/docs/router.md +0 -10
package/docs/routes.md +0 -133
package/docs/schemas.md +0 -327
package/test/hooks.test.ts +0 -200
package/test/parser.test.ts +0 -1358
package/test/plugins.test.ts +0 -239
package/test/requests.test.ts +0 -917
package/test/resources/image.png +0 -0
package/test/resources/object.badSyntax.json +0 -8
package/test/resources/object.json +0 -8
package/test/resources/object.missing.json +0 -6
package/test/resources/static/chameleon.png +0 -0
package/test/resources/static/index.html +0 -13
package/test/resources/static/sub/index.html +0 -13
package/test/resources/static/sub/other.html +0 -13
package/test/resources/test.route.comment.ts +0 -58
package/test/resources/test.route.empty.ts +0 -9
package/test/responses.test.ts +0 -483
package/test/routeFiles.test.ts +0 -239
package/test/router.test.ts +0 -231
package/test/test.utils.ts +0 -109
package/test/types.test.ts +0 -909
package/tsconfig.json +0 -23

package/test/resources/image.png DELETED Viewed

Binary file

package/test/resources/object.badSyntax.json DELETED Viewed

@@ -1,8 +0,0 @@
-{
-    "string": "test"
-    "number": 3.14,
-    "bool": true,
-    "arrayStr": ["un", "deux", "trois"],
-    "arrayNumber": [0],
-    "arrayBool": [true, false]
-}

package/test/resources/object.json DELETED Viewed

@@ -1,8 +0,0 @@
-{
-    "string": "test",
-    "number": 3.14,
-    "bool": true,
-    "arrayStr": ["un", "deux", "trois"],
-    "arrayNumber": [0],
-    "arrayBool": [true, false]
-}

package/test/resources/object.missing.json DELETED Viewed

@@ -1,6 +0,0 @@
-{
-    "string": "test",
-    "number": 3.14,
-    "bool": true,
-    "arrayNumber": [0]
-}

package/test/resources/static/chameleon.png DELETED Viewed

Binary file

package/test/resources/static/index.html DELETED Viewed

@@ -1,13 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8" />
-  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Galbe test</title>
-  <!-- <link rel="stylesheet" href="styles.css" /> -->
-</head>
-<body>
-  <h1>Bonjour</h1>
-  <p>This is a test page.</p>
-</body>
-</html>

package/test/resources/static/sub/index.html DELETED Viewed

@@ -1,13 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8" />
-  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Galbe test: sub page</title>
-  <!-- <link rel="stylesheet" href="styles.css" /> -->
-</head>
-<body>
-  <h1>Hello</h1>
-  <p>This is a sub test page.</p>
-</body>
-</html>

package/test/resources/static/sub/other.html DELETED Viewed

@@ -1,13 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8" />
-  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Galbe test: other page</title>
-  <!-- <link rel="stylesheet" href="styles.css" /> -->
-</head>
-<body>
-  <h1>Hola</h1>
-  <p>This is another test page.</p>
-</body>
-</html>

package/test/resources/test.route.comment.ts DELETED Viewed

@@ -1,58 +0,0 @@
-import type { Galbe } from '../../src'
-import { $T } from '../../src'
-/**
- * description
- * multiline
- * @tag test
- * ok
- */
-export default (g: Galbe) => {
-  /**
-   * This part
-   * here
-   * @tags tag1, tag2, tag3
-   * @summary short summary
-   * @description longer description example
-   * @deprecated
-   * @param {path} param1 description
-   * @param  {query} param2 description
-   */
-  g.get('/test/:param1', _ => {})
-  // Comment between enpoints
-  /**
-   * @tags tag1, tag2, tag3
-   * @summary short summary
-   * @description longer description example
-   * @body body descripton
-   */
-  g.post('/test', { body: $T.object({ foo: $T.string() }) }, _ => {})
-  /**
-   * @tags tag1, tag2
-   * @other Hello Mom!
-   */
-  g.put('/test', { body: $T.object({ foo: $T.string() }) }, [() => {}], _ => {})
-  /**
-   * patch method
-   */
-  g.patch('/test', _ => {})
-  /**
-   * options method
-   */
-  g.options('/test', _ => {})
-  /**
-   * delete method
-   */
-  g.delete('/test', _ => {})
-  /**
-   * head method
-   */
-  g.head('/test', _ => {})
-}

package/test/resources/test.route.empty.ts DELETED Viewed

@@ -1,9 +0,0 @@
-import type { Galbe } from '../../src'
-export default (g: Galbe) => {
-  g.get('/one', _ => {})
-  // Comment between enpoints
-  g.post('/two', _ => {})
-  g.put('/three', _ => {})
-}

package/test/responses.test.ts DELETED Viewed

@@ -1,483 +0,0 @@
-import { expect, test, describe, beforeAll } from 'bun:test'
-import { Galbe, $T, type Context } from '../src'
-import { decoder } from './test.utils'
-const port = 7359
-const UUID_RGX = '[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}'
-function* genTxt(text: string) {
-  const words = text.split(' ')
-  for (const w of words) yield w
-}
-const rsTxt = (text: string) => {
-  return new ReadableStream({
-    async start(controller) {
-      const words = text.split(' ')
-      for (const w of words) controller.enqueue(w)
-      controller.close()
-    },
-  })
-}
-const handleResp = (ctx: Context) => ctx.body
-describe('responses', () => {
-  beforeAll(async () => {
-    const galbe = new Galbe()
-    galbe.post(
-      '/none',
-      {
-        body: { json: $T.optional($T.object($T.any())) },
-        query: { text: $T.optional($T.string()), stream: $T.optional($T.string()) },
-      },
-      ctx => {
-        if (ctx.query.text) {
-          if (ctx.query.stream === 'generatorFunction') return genTxt(ctx.query.text)
-          if (ctx.query.stream === 'readableStream') return rsTxt(ctx.query.text)
-          else return ctx.query.text
-        } else if (ctx.body) return ctx.body
-        return null
-      }
-    )
-    galbe.post('', { response: { test: '' } }, () => {})
-    galbe.post('/ba', { response: { 200: $T.byteArray() } }, handleResp)
-    galbe.post('/bool', { response: { 200: $T.boolean() } }, handleResp)
-    galbe.post('/num', { response: { 200: $T.number() } }, handleResp)
-    galbe.post('/str', { response: { 200: $T.string() } }, handleResp)
-    galbe.post('/json/bool', { response: { 200: $T.json($T.boolean()) } }, handleResp)
-    galbe.post('/json/num', { response: { 200: $T.json($T.number()) } }, handleResp)
-    galbe.post('/json/str', { response: { 200: $T.json($T.string()) } }, handleResp)
-    galbe.post('/json/obj', { response: { 200: $T.json($T.object()) } }, handleResp)
-    galbe.post('/arr', { response: { 200: $T.array() } }, handleResp)
-    galbe.post('/obj', { response: { 200: $T.object($T.any()) } }, handleResp)
-    galbe.post('/stream/ba', { response: { 200: $T.stream($T.byteArray()) } }, ctx =>
-      ctx.body ? genTxt(ctx.body) : ''
-    )
-    galbe.post('/stream/str', { response: { 200: $T.stream($T.string()) } }, ctx => (ctx.body ? genTxt(ctx.body) : 42))
-    await galbe.listen(port)
-  })
-  test('response, no schema, string', async () => {
-    const reqTxt = 'Hello Mom!'
-    let resp = await fetch(`http://localhost:${port}/none?text=${reqTxt}`, {
-      method: 'POST',
-    })
-    const body = await resp.text()
-    expect(resp.status).toBe(200)
-    expect(resp.headers.get('content-type')).toBe('text/plain')
-    expect(body).toBe(reqTxt)
-  })
-  test('response, no schema, object', async () => {
-    const reqBody = { foo: 'bar' }
-    let resp = await fetch(`http://localhost:${port}/none`, {
-      method: 'POST',
-      body: JSON.stringify(reqBody),
-      headers: {
-        'content-type': 'application/json',
-      },
-    })
-    const body = await resp.json()
-    expect(resp.status).toBe(200)
-    expect(resp.headers.get('content-type')).toBe('application/json')
-    expect(body).toEqual(reqBody)
-  })
-  test('response, no schema, stream', async () => {
-    const reqTxt = 'Hello Mom!'
-    const cases = [{ stream: 'generatorFunction' }, { stream: 'readableStream' }]
-    for (const c of cases) {
-      let resp = await fetch(`http://localhost:${port}/none?text=${reqTxt}&stream=${c.stream}`, {
-        method: 'POST',
-        headers: {
-          'content-type': 'application/json',
-        },
-      })
-      const reader = resp.body?.getReader()
-      let body = ''
-      while (reader) {
-        const { value, done } = await reader.read()
-        if (done) break
-        body += decoder.decode(value)
-      }
-      expect(resp.status).toBe(200)
-      expect(resp.headers.get('content-type')).toBe('text/event-stream')
-      expect(body).toMatch(new RegExp(`id:${UUID_RGX}\ndata:Hello\n\nid:${UUID_RGX}\ndata:Mom!\n\n`))
-    }
-  })
-  test('response, ba, validation OK', async () => {
-    let bodyStr = 'Hello mom!'
-    let reqBody = new TextEncoder().encode(bodyStr)
-    let resp = await fetch(`http://localhost:${port}/ba`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'application/octet-stream',
-      },
-    })
-    const reader = resp.body?.getReader()
-    let body = new Uint8Array()
-    while (reader) {
-      const { value, done } = await reader.read()
-      if (done) break
-      let buff = new Uint8Array(body.length + value.length)
-      buff.set(body)
-      buff.set(value, body.length)
-      body = buff
-    }
-    expect(resp.status).toBe(200)
-    expect(resp.headers.get('content-type')).toBe('application/octet-stream')
-    //@ts-ignore
-    expect(body).toEqual(reqBody)
-  })
-  test('response, ba, validation error', async () => {
-    let bodyStr = 'Hello mom!'
-    let resp = await fetch(`http://localhost:${port}/ba`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'text/plain',
-      },
-    })
-    expect(resp.status).toBe(500)
-  })
-  test('response, bool, validation OK', async () => {
-    let bodyStr = 'true'
-    let reqBody = true
-    let resp = await fetch(`http://localhost:${port}/bool`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'application/json',
-      },
-    })
-    const body = await resp.json()
-    expect(resp.status).toBe(200)
-    expect(resp.headers.get('content-type')).toBe('application/json')
-    expect(body).toEqual(reqBody)
-  })
-  test('response, bool, validation error', async () => {
-    let bodyStr = 'true'
-    let resp = await fetch(`http://localhost:${port}/bool`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'text/plain',
-      },
-    })
-    expect(resp.status).toBe(500)
-  })
-  test('response, num, validation OK', async () => {
-    let bodyStr = '42'
-    let reqBody = 42
-    let resp = await fetch(`http://localhost:${port}/num`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'application/json',
-      },
-    })
-    const body = await resp.json()
-    expect(resp.status).toBe(200)
-    expect(resp.headers.get('content-type')).toBe('application/json')
-    expect(body).toEqual(reqBody)
-  })
-  test('response, num, validation error', async () => {
-    let bodyStr = '"test"'
-    let resp = await fetch(`http://localhost:${port}/num`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'application/json',
-      },
-    })
-    expect(resp.status).toBe(500)
-  })
-  test('response, str, validation OK', async () => {
-    let bodyStr = 'Hello Mom!'
-    let resp = await fetch(`http://localhost:${port}/str`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'text/plain',
-      },
-    })
-    const body = await resp.text()
-    expect(resp.status).toBe(200)
-    expect(resp.headers.get('content-type')).toBe('text/plain')
-    expect(body).toEqual(bodyStr)
-  })
-  test('response, json bool, validation OK', async () => {
-    let bodyStr = 'false'
-    let reqBody = false
-    let resp = await fetch(`http://localhost:${port}/json/bool`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'application/json',
-      },
-    })
-    const body = await resp.json()
-    expect(resp.status).toBe(200)
-    expect(resp.headers.get('content-type')).toBe('application/json')
-    expect(body).toEqual(reqBody)
-  })
-  test('response, json bool, validation error', async () => {
-    let bodyStr = '3.14'
-    let resp = await fetch(`http://localhost:${port}/json/bool`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'application/json',
-      },
-    })
-    expect(resp.status).toBe(500)
-  })
-  test('response, json num, validation OK', async () => {
-    let bodyStr = '42'
-    let reqBody = 42
-    let resp = await fetch(`http://localhost:${port}/json/num`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'application/json',
-      },
-    })
-    const body = await resp.json()
-    expect(resp.status).toBe(200)
-    expect(resp.headers.get('content-type')).toBe('application/json')
-    expect(body).toEqual(reqBody)
-  })
-  test('response, json num, validation error', async () => {
-    let bodyStr = '"Hi"'
-    let resp = await fetch(`http://localhost:${port}/json/bool`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'application/json',
-      },
-    })
-    expect(resp.status).toBe(500)
-  })
-  test('response, json str, validation OK', async () => {
-    let bodyStr = '"Hello Mom!"'
-    let reqBody = 'Hello Mom!'
-    let resp = await fetch(`http://localhost:${port}/json/str`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'application/json',
-      },
-    })
-    const body = await resp.json()
-    expect(resp.status).toBe(200)
-    expect(resp.headers.get('content-type')).toBe('application/json')
-    expect(body).toEqual(reqBody)
-  })
-  test('response, json str, validation error', async () => {
-    let bodyStr = '3.14'
-    let resp = await fetch(`http://localhost:${port}/json/str`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'application/json',
-      },
-    })
-    expect(resp.status).toBe(500)
-  })
-  test('response, array, validation OK', async () => {
-    let bodyStr = '[false, "one", 2]'
-    let reqBody = [false, 'one', 2]
-    let resp = await fetch(`http://localhost:${port}/arr`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'application/json',
-      },
-    })
-    const body = await resp.json()
-    expect(resp.status).toBe(200)
-    expect(resp.headers.get('content-type')).toBe('application/json')
-    expect(body).toEqual(reqBody)
-  })
-  test('response, array, validation error', async () => {
-    let bodyStr = '0'
-    let resp = await fetch(`http://localhost:${port}/arr`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'application/json',
-      },
-    })
-    expect(resp.status).toBe(500)
-  })
-  test('response, object, validation OK', async () => {
-    let bodyStr = '{"str":"str", "num":0, "arr":[1,2,3], "nested": {"foo":"bar"}}'
-    let reqBody = { str: 'str', num: 0, arr: [1, 2, 3], nested: { foo: 'bar' } }
-    let resp = await fetch(`http://localhost:${port}/obj`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'application/json',
-      },
-    })
-    const body = await resp.json()
-    expect(resp.status).toBe(200)
-    expect(resp.headers.get('content-type')).toBe('application/json')
-    expect(body).toEqual(reqBody)
-  })
-  test('response, object, validation error', async () => {
-    let bodyStr = '"This"'
-    let resp = await fetch(`http://localhost:${port}/obj`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'application/json',
-      },
-    })
-    expect(resp.status).toBe(500)
-  })
-  test('response, stream ba, validation OK', async () => {
-    let bodyStr = 'Hello Mom!'
-    let resp = await fetch(`http://localhost:${port}/stream/ba`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'text/plain',
-      },
-    })
-    const reader = resp.body?.getReader()
-    let body = ''
-    while (reader) {
-      const { value, done } = await reader.read()
-      if (done) break
-      body += decoder.decode(value)
-    }
-    expect(resp.status).toBe(200)
-    expect(resp.headers.get('content-type')).toBe('text/event-stream')
-    expect(body).toMatch(new RegExp(`id:${UUID_RGX}\ndata:Hello\n\nid:${UUID_RGX}\ndata:Mom!\n\n`))
-  })
-  test('response, stream ba, validation error', async () => {
-    let bodyStr = ''
-    let resp = await fetch(`http://localhost:${port}/stream/ba`, {
-      method: 'POST',
-      body: bodyStr,
-    })
-    expect(resp.status).toBe(500)
-  })
-  test('response, stream str, validation OK', async () => {
-    let bodyStr = 'Hello Mom!'
-    let resp = await fetch(`http://localhost:${port}/stream/str`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'text/plain',
-      },
-    })
-    const reader = resp.body?.getReader()
-    let body = ''
-    while (reader) {
-      const { value, done } = await reader.read()
-      if (done) break
-      body += decoder.decode(value)
-    }
-    expect(resp.status).toBe(200)
-    expect(resp.headers.get('content-type')).toBe('text/event-stream')
-    expect(body).toMatch(new RegExp(`id:${UUID_RGX}\ndata:Hello\n\nid:${UUID_RGX}\ndata:Mom!\n\n`))
-  })
-  test('response, stream str, validation error', async () => {
-    let bodyStr = '0'
-    let resp = await fetch(`http://localhost:${port}/stream/str`, {
-      method: 'POST',
-      body: bodyStr,
-      headers: {
-        'content-type': 'application/json',
-      },
-    })
-    expect(resp.status).toBe(500)
-  })
-})