Compare commits

...

4 Commits

Author SHA1 Message Date
e64d9ec31d feat(api): add user routes
All checks were successful
Build and Push Docker Image / build (push) Successful in 1m9s
2024-09-28 21:08:04 +02:00
5f70ab60ea feat(schema): add user openapi schema 2024-09-28 21:07:46 +02:00
eabd25c203 chore: use correct import for database package 2024-09-28 21:07:17 +02:00
0aafe00570 chore: add words to workspace 2024-09-28 21:06:45 +02:00
17 changed files with 499 additions and 7 deletions

6
.vscode/settings.json vendored Normal file
View File

@ -0,0 +1,6 @@
{
"cSpell.words": [
"hono",
"openapi"
]
}

1
apps/api/.env.example Normal file
View File

@ -0,0 +1 @@
POSTGRES_URL=postgres://postgres:postgres@localhost:5432/postgres

View File

@ -1,9 +1,15 @@
{
"name": "@boring.tools/api",
"scripts": {
"dev": "bun run --hot src/index.ts"
"dev": "bun run --hot src/index.ts",
"build": "bun build --entrypoints ./src/index.ts --outdir ../../build/api --target bun --splitting --sourcemap=linked",
"test": "bun test --preload ./src/index.ts"
},
"dependencies": {
"@boring.tools/database": "workspace:*",
"@boring.tools/schema": "workspace:*",
"@hono/clerk-auth": "^2.0.0",
"@hono/zod-openapi": "^0.16.2",
"hono": "^4.6.3"
},
"devDependencies": {

View File

@ -1,9 +1,33 @@
import { Hono } from 'hono'
import type { UserOutput } from '@boring.tools/schema'
import { OpenAPIHono, type z } from '@hono/zod-openapi'
import { cors } from 'hono/cors'
const app = new Hono()
import user from './user'
app.get('/', (c) => {
return c.text('Hello Hono!')
import { authentication } from './utils/authentication'
type User = z.infer<typeof UserOutput>
export type Variables = {
user: User
}
export const app = new OpenAPIHono<{ Variables: Variables }>()
app.use('*', cors())
app.use('/api/*', authentication)
app.route('/api/user', user)
app.doc('/openapi.json', {
openapi: '3.0.0',
info: {
version: '0.0.0',
title: 'boring.tools',
},
})
export default app
export default {
port: 3000,
fetch: app.fetch,
}

40
apps/api/src/user/get.ts Normal file
View File

@ -0,0 +1,40 @@
import { type UserSelect, db, user as userDb } from '@boring.tools/database'
import { UserOutput } from '@boring.tools/schema'
import { createRoute } from '@hono/zod-openapi'
import { eq } from 'drizzle-orm'
export const route = createRoute({
method: 'get',
path: '/',
responses: {
200: {
content: {
'application/json': { schema: UserOutput },
},
description: 'Return created commit',
},
400: {
description: 'Bad Request',
},
500: {
description: 'Internal Server Error',
},
},
})
export const func = async ({ user }: { user: UserSelect }) => {
const result = await db.query.user.findFirst({
where: eq(userDb.id, user.id),
})
if (!result) {
throw new Error('User not found')
}
return result
}
export default {
route,
func,
}

View File

@ -0,0 +1,34 @@
import { OpenAPIHono, type z } from '@hono/zod-openapi'
import { HTTPException } from 'hono/http-exception'
import type { Variables } from '..'
import get from './get'
import webhook from './webhook'
const app = new OpenAPIHono<{ Variables: Variables }>()
app.openapi(get.route, async (c) => {
try {
const user = c.get('user')
const result = await get.func({ user })
return c.json(result, 201)
} catch (error) {
if (error instanceof HTTPException) {
return c.json({ message: error.message }, error.status)
}
return c.json({ message: 'An unexpected error occurred' }, 500)
}
})
app.openapi(webhook.route, async (c) => {
try {
const result = await webhook.func({ payload: await c.req.json() })
return c.json(result, 200)
} catch (error) {
if (error instanceof HTTPException) {
return c.json({ message: error.message }, error.status)
}
return c.json({ message: 'An unexpected error occurred' }, 500)
}
})
export default app

View File

@ -0,0 +1,75 @@
import { db, user as userDb } from '@boring.tools/database'
import { UserOutput, UserWebhookInput } from '@boring.tools/schema'
import { createRoute, type z } from '@hono/zod-openapi'
import { HTTPException } from 'hono/http-exception'
export const route = createRoute({
method: 'post',
path: '/webhook',
request: {
body: {
content: {
'application/json': { schema: UserWebhookInput },
},
},
},
responses: {
200: {
content: {
'application/json': { schema: UserOutput },
},
description: 'Return updated changelog',
},
400: {
description: 'Bad Request',
},
500: {
description: 'Internal Server Error',
},
},
})
const userCreate = async ({
payload,
}: {
payload: z.infer<typeof UserWebhookInput>
}) => {
const data = {
id: payload.data.id,
name: `${payload.data.first_name} ${payload.data.last_name}`,
email: payload.data.email_addresses[0].email_address,
}
try {
await db
.insert(userDb)
.values({
...data,
})
.onConflictDoUpdate({
target: userDb.id,
set: data,
})
return true
} catch (error) {
return false
}
}
export const func = async ({
payload,
}: {
payload: z.infer<typeof UserWebhookInput>
}) => {
switch (payload.type) {
case 'user.created':
return userCreate({ payload })
default:
throw new HTTPException(404, { message: 'Webhook type not supported' })
}
}
export default {
route,
func,
}

View File

@ -0,0 +1,44 @@
import { accessToken, db } from '@boring.tools/database'
import { clerkMiddleware, getAuth } from '@hono/clerk-auth'
import { eq } from 'drizzle-orm'
import type { Context, Next } from 'hono'
import { some } from 'hono/combine'
import { HTTPException } from 'hono/http-exception'
const generatedToken = async (c: Context, next: Next) => {
const authHeader = c.req.header('Authorization')
if (!authHeader) {
throw new HTTPException(401, { message: 'Unauthorized' })
}
const token = authHeader.replace('Bearer ', '')
const accessTokenResult = await db.query.accessToken.findFirst({
where: eq(accessToken.token, token),
with: {
user: true,
},
})
if (!accessTokenResult) {
throw new HTTPException(401, { message: 'Unauthorized' })
}
c.set('user', accessTokenResult.user)
await next()
}
export const authentication = some(generatedToken, clerkMiddleware())
export const verifyAuthentication = (c: Context) => {
const auth = getAuth(c)
if (!auth?.userId) {
const accessTokenUser = c.get('user')
if (!accessTokenUser) {
throw new HTTPException(401, { message: 'Unauthorized' })
}
return accessTokenUser.id
}
return auth.userId
}

View File

@ -1,4 +1,4 @@
import { drizzle } from 'drizzle-orm/postgres-js'
import { drizzle } from 'drizzle-orm/node-postgres'
import { Client } from 'pg'
import * as schema from './schema'

175
packages/schema/.gitignore vendored Normal file
View File

@ -0,0 +1,175 @@
# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
# Logs
logs
_.log
npm-debug.log_
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*
# Caches
.cache
# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
# Runtime data
pids
_.pid
_.seed
*.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
*.lcov
# nyc test coverage
.nyc_output
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# Bower dependency directory (https://bower.io/)
bower_components
# node-waf configuration
.lock-wscript
# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release
# Dependency directories
node_modules/
jspm_packages/
# Snowpack dependency directory (https://snowpack.dev/)
web_modules/
# TypeScript cache
*.tsbuildinfo
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Optional stylelint cache
.stylelintcache
# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local
# parcel-bundler cache (https://parceljs.org/)
.parcel-cache
# Next.js build output
.next
out
# Nuxt.js build / generate output
.nuxt
dist
# Gatsby files
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public
# vuepress build output
.vuepress/dist
# vuepress v2.x temp and cache directory
.temp
# Docusaurus cache and generated files
.docusaurus
# Serverless directories
.serverless/
# FuseBox cache
.fusebox/
# DynamoDB Local files
.dynamodb/
# TernJS port file
.tern-port
# Stores VSCode versions used for testing VSCode extensions
.vscode-test
# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
# IntelliJ based IDEs
.idea
# Finder (MacOS) folder config
.DS_Store

15
packages/schema/README.md Normal file
View File

@ -0,0 +1,15 @@
# @boring.tools/schema
To install dependencies:
```bash
bun install
```
To run:
```bash
bun run src/index.ts
```
This project was created using `bun init` in bun v1.1.24. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.

View File

@ -0,0 +1,11 @@
{
"name": "@boring.tools/schema",
"module": "src/index.ts",
"type": "module",
"devDependencies": {
"@types/bun": "latest"
},
"peerDependencies": {
"typescript": "^5.0.0"
}
}

View File

@ -0,0 +1 @@
export * from './user'

View File

@ -0,0 +1,11 @@
import { z } from '@hono/zod-openapi'
export const UserOutput = z
.object({
id: z.string().openapi({
example: 'user_2metCkqOhUhHN1jEhLyh8wMODu7',
}),
name: z.string(),
email: z.string().email(),
})
.openapi('User')

View File

@ -0,0 +1,2 @@
export * from './base'
export * from './webhook'

View File

@ -0,0 +1,20 @@
import { z } from '@hono/zod-openapi'
export const UserWebhookInput = z.object({
data: z.object({
id: z.string(),
first_name: z.string(),
last_name: z.string(),
email_addresses: z.array(
z.object({
email_address: z.string(),
id: z.string(),
verification: z.object({
status: z.string(),
}),
}),
),
image_url: z.string(),
}),
type: z.string(),
})

View File

@ -0,0 +1,27 @@
{
"compilerOptions": {
// Enable latest features
"lib": ["ESNext", "DOM"],
"target": "ESNext",
"module": "ESNext",
"moduleDetection": "force",
"jsx": "react-jsx",
"allowJs": true,
// Bundler mode
"moduleResolution": "bundler",
"allowImportingTsExtensions": true,
"verbatimModuleSyntax": true,
"noEmit": true,
// Best practices
"strict": true,
"skipLibCheck": true,
"noFallthroughCasesInSwitch": true,
// Some stricter flags (disabled by default)
"noUnusedLocals": false,
"noUnusedParameters": false,
"noPropertyAccessFromIndexSignature": false
}
}