@bpinternal/expresso
Advanced tools
Small wrapper above express that uses zod to add few features including auto documentation
Small wrapper above express that uses zod to add the following features:
import { z } from 'zod'
export const zError = z.object({ type: z.string(), code: z.number(), message: z.string() })
export const zSuccessResponse = z.object({ status: z.literal('success') })
export const zErrorResponse = z.object({ status: z.literal('error'), error: zError })
export const zCompileBody = z.object({ book: z.object({...}) })
export const zCompileSuccessResponse = zSuccessResponse.extend({ artifact_id: z.string() })
export const zCompileResponse = z.union([zCompileSuccessResponse, zErrorResponse])
export const userHeader = { ["x-user-id"]: z.string() }
import * as io from './io' // your zod schemas
import express from 'express'
import swaggerExpress from 'swagger-ui-express'
import * as xo from '@bpinternal/expresso'
const expressApp = express()
const router = new xo.JsonRouter({ info: { title: 'My XO Server', version: '0.1.0' }, bodySize: options.bodySize })
// This route is documented, validated and fully typed
router.post(
{
path: '/compile',
input: io.zCompileBody,
output: io.zCompileResponse,
headers: io.userHeader,
operationId: 'compileBook'
},
async (req, res, next) => {
try {
const { ['x-user-id']: x_user_id } = req.headers
const { book } = req.body
const artifactId = await app.compile(x_user_id, book)
res.send({ status: 'success', artifact_id: artifactId })
return next()
} catch (thrown) {
return next(thrown)
}
}
)
// This route is not documented but is still active. It shows the openapi spec content.
router.inner.get('/openapi.json', async (req, res, next) => {
try {
const { openapi } = router
const specs = openapi.getSpec()
res.send(specs)
return next()
} catch (thrown) {
return next(thrown)
}
})
// These will display the Swagger UI to interract with your backend
const { openapi } = router
router.inner.use('/', swaggerExpress.serve)
router.inner.get('/', swaggerExpress.setup(openapi.getSpec()))
expressApp.use('/', router.inner)
const redocHtml = (specUrl: string) => `<!DOCTYPE html>
<html>
<head>
<title>Redoc</title>
<!-- needed for adaptive design -->
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link
href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700"
rel="stylesheet"
/>
<!--
Redoc doesn't change outer page styles
-->
<style>
body {
margin: 0;
padding: 0;
}
</style>
</head>
<body>
<redoc
spec-url="${specUrl}"
></redoc>
<script src="https://unpkg.com/redoc@2.0.0-rc.72/bundles/redoc.standalone.js"></script>
</body>
</html>
`
router.inner.get('/redoc', async (req, res, next) => {
try {
res.send(redocHtml('/openapi.json'))
return next()
} catch (thrown) {
return next(thrown)
}
})
This package is published under the @bpinternal organization. All packages of this organization are meant to be used by the Botpress team internally and are not meant for our community. Since the packages are catered to our own use-cases, they might have less stable APIs, receive breaking changes without much warning, have minimal documentation and lack community-focused support. However, these packages were still left intentionally public for an important reason : We Love Open-Source. Therefore, if you wish to install or fork this package feel absolutly free to do it. We strongly recommend that you tag your versions properly.
The Botpress Engineering team.
FAQs
Small wrapper above express that uses zod to add few features including auto documentation
The npm package @bpinternal/expresso receives a total of 1 weekly downloads. As such, @bpinternal/expresso popularity was classified as not popular.
We found that @bpinternal/expresso demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.