Merge pull request #18 from crashmax-dev/fastify-plugin

feat(packages): add `@stenodb/fastify`

Author: crashmax-dev

examples/with-fastify/nodemon.json

@@ -0,0 +1,8 @@
+{
+ "watch": [
+ "src"
+ ],
+ "ignore": ["database", "dist"],
+ "exec": "cross-env TS_NODE_TRANSPILE_ONLY=true NODE_ENV=development node --no-warnings --loader ts-node/esm --enable-source-maps --trace-warnings --inspect=0.0.0.0:9234 --nolazy src/index.ts",
+ "ext": "ts"
+}

examples/with-fastify/package.json

@@ -0,0 +1,20 @@
+{
+ "name": "with-fastify",
+ "type": "module",
+ "private": true,
+ "scripts": {
+ "start": "pnpm build && node dist/index.js",
+ "dev": "nodemon",
+ "build": "rm -rf dist && tsc"
+ },
+ "dependencies": {
+ "@stenodb/fastify": "workspace:*",
+ "class-transformer": "0.5.1",
+ "class-validator": "0.14.0",
+ "fastify": "4.13.0",
+ "reflect-metadata": "0.1.13"
+ },
+ "devDependencies": {
+ "@types/node": "18.11.19"
+ }
+}

examples/with-fastify/src/api/posts/posts.controller.ts

@@ -0,0 +1,61 @@
+import { Post } from '../../dto/posts.dto.js'
+import { User } from '../../dto/users.dto.js'
+import {
+ userIdAndPostIdParamsSchema,
+ userIdParamsSchema
+} from './posts.schema.js'
+import type { UserService } from '../users/users.service.js'
+import type { FastifyInstance } from 'fastify'
+
+export function postsController(
+ fastify: FastifyInstance,
+ service: UserService
+): void {
+ fastify.get('/', () => {
+ return service.userPosts
+ })
+
+ fastify.get<{ Params: { userId: number } }>(
+ '/:userId',
+ { schema: userIdParamsSchema },
+ (request, reply) => {
+ const user = service.findUserById(request.params.userId)
+ if (!user) return reply.status(404).send('User not found')
+ return user.posts
+ }
+ )
+
+ fastify.get<{ Params: { userId: number; postId: number } }>(
+ '/:userId/:postId',
+ { schema: userIdAndPostIdParamsSchema },
+ (request, reply) => {
+ const { userId, postId } = request.params
+ const user = service.findUserById(userId)
+ if (!user) return reply.status(404).send('User not found')
+
+ const post = user.findPost(postId)
+ if (!post) return reply.status(404).send('Post not found')
+
+ return post
+ }
+ )
+
+ fastify.post<{ Body: Post; Params: User }>(
+ '/:userId',
+ { schema: userIdParamsSchema },
+ async (request, reply) => {
+ const user = service.findUserById(request.params.userId)
+ if (!user) return reply.status(404).send('User not found')
+
+ const post = new Post(
+ user.postsLastId + 1,
+ request.body.subject,
+ new Date()
+ )
+ user.addPost(post)
+ await service.write()
+
+ return post
+ }
+ )
+}

examples/with-fastify/src/api/posts/posts.schema.ts

@@ -0,0 +1,16 @@
+export const userIdParamsSchema = {
+ params: {
+ userId: {
+ $ref: 'User#/properties/userId'
+ }
+ }
+}
+
+export const userIdAndPostIdParamsSchema = {
+ params: {
+ ...userIdParamsSchema.params,
+ postId: {
+ $ref: 'Post#/properties/postId'
+ }
+ }
+}

examples/with-fastify/src/api/users/users.controller.ts

@@ -0,0 +1,52 @@
+import { User } from '../../dto/users.dto.js'
+import { userIdParamsSchema } from '../posts/posts.schema.js'
+import { userBodySchema, userResponseSchema } from './users.schema.js'
+import type { UserService } from './users.service.js'
+import type { FastifyInstance } from 'fastify'
+
+export function userController(
+ fastify: FastifyInstance,
+ service: UserService
+): void {
+ fastify.get('/', () => {
+ return service.users
+ })
+
+ fastify.get<{ Params: User }>(
+ '/:userId',
+ {
+ schema: userIdParamsSchema
+ },
+ (request, reply) => {
+ const user = service.findUserById(request.params.userId)
+ if (!user) return reply.status(404).send('User not found')
+
+ return {
+ id: user.userId,
+ username: user.username,
+ age: user.age
+ }
+ }
+ )
+
+ fastify.post<{ Body: User }>(
+ '/',
+ { schema: userBodySchema },
+ async (request, reply) => {
+ const { username, age } = request.body
+ const newUser = service.addUser(username, age)
+ if (!newUser) return reply.status(400).send('Username exist')
+ return newUser
+ }
+ )
+
+ fastify.delete<{ Params: User }>(
+ '/:userId',
+ { schema: userResponseSchema },
+ async (request, reply) => {
+ const user = await service.deleteUser(request.params.userId)
+ if (!user) return reply.status(404).send('User not found')
+ return user
+ }
+ )
+}

examples/with-fastify/src/api/users/users.schema.ts

@@ -0,0 +1,9 @@
+export const userBodySchema = {
+ body: { $ref: 'User' }
+}
+
+export const userResponseSchema = {
+ response: {
+ 200: { $ref: 'User' }
+ }
+}

examples/with-fastify/src/api/users/users.service.ts

@@ -0,0 +1,63 @@
+import { User, Users } from '../../dto/users.dto.js'
+import type { Steno } from '@stenodb/fastify'
+import type { FastifyInstance } from 'fastify'
+
+export class UserService {
+ #users: Steno.NodeProvider<Users>
+
+ constructor(private readonly fastify: FastifyInstance) {
+ this.#users = this.fastify.steno.get<Users>('users')!
+ }
+
+ get users(): User[] {
+ return this.#users.data!.users
+ }
+
+ get userPosts() {
+ return this.users.map((user) => {
+ return {
+ id: user.userId,
+ posts: user.posts
+ }
+ })
+ }
+
+ get userLastId(): number {
+ return this.users.at(-1)!.userId
+ }
+
+ async write(): Promise<void> {
+ await this.#users.write()
+ }
+
+ async addUser(username: string, age: number): Promise<User | null> {
+ if (this.findUserByName(username)) return null
+
+ const user = new User(this.userLastId + 1, username.toLowerCase(), age)
+ this.users.push(user)
+ await this.write()
+
+ return user
+ }
+
+ findUserById(userId: number): User | undefined {
+ return this.users.find((user) => user.userId === userId)
+ }
+
+ findUserByName(userName: string): User | undefined {
+ return this.users.find((user) => user.username == userName)
+ }
+
+ async deleteUser(userId: number): Promise<User | null> {
+ const user = this.findUserById(userId)
+ if (user) {
+ this.#users.data!.users = this.users.filter(
+ (user) => user.userId !== userId
+ )
+ await this.write()
+ return user
+ }
+
+ return null
+ }
+}

examples/with-fastify/src/dto/posts.dto.ts

@@ -0,0 +1,22 @@
+import { Exclude, Type } from 'class-transformer'
+import { IsNumber, IsString, Length } from 'class-validator'
+
+export class Post {
+ @Exclude({ toPlainOnly: true })
+ @IsNumber()
+ postId: number
+
+ @IsString()
+ @Length(1, 128)
+ subject: string
+
+ @Exclude({ toPlainOnly: true })
+ @Type(() => Date)
+ createdAt: Date
+
+ constructor(postId: number, subject: string, createdAt: Date) {
+ this.postId = postId
+ this.subject = subject
+ this.createdAt = createdAt
+ }
+}

examples/with-fastify/src/dto/users.dto.ts

@@ -0,0 +1,48 @@
+import { Exclude, Type } from 'class-transformer'
+import { IsNumber, IsString, Length } from 'class-validator'
+import { Post } from './posts.dto.js'
+
+export class Users {
+ @Type(() => User)
+ users: User[]
+
+ constructor(...users: User[]) {
+ this.users = users
+ }
+}
+
+export class User {
+ @Exclude({ toPlainOnly: true })
+ @IsNumber()
+ userId: number
+
+ @IsString()
+ @Length(3, 20)
+ username: string
+
+ @IsNumber()
+ age: number
+
+ @Exclude({ toPlainOnly: true })
+ @Type(() => Post)
+ posts: Post[]
+
+ constructor(userId: number, username: string, age: number, ...posts: Post[]) {
+ this.userId = userId
+ this.username = username
+ this.age = age
+ this.posts = posts
+ }
+
+ findPost(postId: number): Post | undefined {
+ return this.posts.find((post) => post.postId === postId)
+ }
+
+ addPost(post: Post) {
+ this.posts.push(post)
+ }
+
+ get postsLastId(): number {
+ return this.posts.at(-1)!.postId
+ }
+}

examples/with-fastify/src/index.ts

@@ -0,0 +1,63 @@
+import 'reflect-metadata'
+import { dirname, resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { AsyncAdapter, FastifySteno } from '@stenodb/fastify'
+import Fastify from 'fastify'
+import { postsController } from './api/posts/posts.controller.js'
+import { userController } from './api/users/users.controller.js'
+import { UserService } from './api/users/users.service.js'
+import { Post } from './dto/posts.dto.js'
+import { User, Users } from './dto/users.dto.js'
+
+const fastify = Fastify()
+
+const usersInitialData = new Users(
+ new User(1, 'john', 18, new Post(1, 'Lorem ipsum', new Date())),
+ new User(2, 'alice', 23)
+)
+
+const usersAdapter = new AsyncAdapter(
+ 'users',
+ Users,
+ usersInitialData
+)
+
+fastify.register(FastifySteno, {
+ path: resolve(dirname(fileURLToPath(import.meta.url)), '..', 'db'),
+ entities: [User, Post],
+ adapters: [usersAdapter]
+})
+
+fastify.register(
+ (instance, _, done) => {
+ const userService = new UserService(fastify)
+
+ instance.register(
+ (instance, _, done) => {
+ userController(instance, userService)
+ done()
+ },
+ { prefix: '/users' }
+ )
+
+ instance.register(
+ (instance, _, done) => {
+ postsController(instance, userService)
+ done()
+ },
+ { prefix: '/posts' }
+ )
+
+ done()
+ },
+ { prefix: '/api' }
+)
+
+fastify.get('/schemas', () => {
+ return fastify.getSchemas()
+})
+
+fastify.listen({ host: '0.0.0.0', port: 3000 }, (err, address) => {
+ if (err) throw err
+ console.log(address)
+})