feat: register schemas

Author: crashmax-dev

examples/with-fastify/package.json

@@ -10,6 +10,7 @@
   "dependencies": {
     "@stenodb/fastify": "workspace:*",
     "class-transformer": "0.5.1",
+    "class-validator": "0.14.0",
     "fastify": "4.13.0",
     "reflect-metadata": "0.1.13"
   },

examples/with-fastify/src/entities.ts

@@ -1,4 +1,5 @@
-import { Type } from 'class-transformer'
+import { Exclude, Type } from 'class-transformer'
+import { IsNumber, IsString, Length, MaxLength } from 'class-validator'
 
 export class Users {
   @Type(() => User)
@@ -10,13 +11,20 @@ export class Users {
 }
 
 export class User {
+  @IsString()
+  @Length(3, 20)
   username: string
 
+  @IsNumber()
+  age: number
+
+  @Exclude()
   @Type(() => Post)
   posts: Post[]
 
-  constructor(username: string, ...posts: Post[]) {
+  constructor(username: string, age: number, ...posts: Post[]) {
     this.username = username
+    this.age = age
     this.posts = posts
   }
 
@@ -26,6 +34,8 @@ export class User {
 }
 
 export class Post {
+  @IsString()
+  @MaxLength(128)
   title: string
 
   constructor(title: string) {

examples/with-fastify/src/index.ts

@@ -6,19 +6,21 @@ import Fastify from 'fastify'
 import { Post, User, Users } from './entities.js'
 
 const fastify = Fastify()
-const path = resolve(dirname(fileURLToPath(import.meta.url)), '..', 'db')
 
-fastify.register(FastifySteno, { path })
+fastify.register(FastifySteno, {
+  path: resolve(dirname(fileURLToPath(import.meta.url)), '..', 'db'),
+  entities: [User, Post]
+})
 
-fastify.get('/', async (req, rep) => {
-  const users = fastify.steno.get<Users>('users')
-  return users?.data
+fastify.post('/', { schema: { body: fastify.getSchema('User') } }, (req) => {
+  return {
+    body: req.body,
+    schema: req.routeSchema
+  }
 })
 
 fastify.listen({ host: '0.0.0.0', port: 3000 }, async (err, address) => {
   if (err) throw err
-
-  await fastify.steno.create('users', Users, new Users(new User('John')))
-
+  console.log(fastify.getSchemas())
   console.log(address)
 })

examples/with-nest/package.json

@@ -24,8 +24,8 @@
     "@nestjs/platform-express": "^9.0.0",
     "@stenodb/nest": "workspace:*",
     "class-transformer": "0.5.1",
-    "class-validator": "^0.14.0",
-    "reflect-metadata": "^0.1.13",
+    "class-validator": "0.14.0",
+    "reflect-metadata": "0.1.13",
     "rimraf": "^3.0.2",
     "rxjs": "^7.2.0"
   },

packages/fastify/package.json

@@ -21,6 +21,7 @@
   },
   "dependencies": {
     "@stenodb/node": "workspace:3.3.2",
+    "class-validator-jsonschema": "5.0.0",
     "fastify-plugin": "4.5.0"
   },
   "devDependencies": {

packages/fastify/src/index.ts

@@ -1,44 +1,10 @@
-import { AsyncAdapter, NodeProvider } from '@stenodb/node'
 import fp from 'fastify-plugin'
-import type { Steno } from '@stenodb/node'
-import type { FastifyInstance } from 'fastify'
-import './types.js'
+import { StenoPlugin } from './plugin.js'
 
-function fastifyPlugin(
-  fastify: FastifyInstance,
-  options: Steno.NodeProviderOptions,
-  next: () => void
-) {
-  const database = new Map<string, Steno.NodeProvider<unknown>>()
-  const provider = new NodeProvider(options)
-
-  async function createDatabase<T>(
-    name: string,
-    entity: Steno.Entity<T>,
-    initialData?: T
-  ): Promise<void> {
-    const adapter = new AsyncAdapter(name, entity, initialData)
-    const db = await provider.create(adapter)
-    await db.read()
-    database.set(name, db)
-  }
-
-  function getDatabase<T>(name: string): Steno.NodeProvider<T> | undefined {
-    return database.get(name) as Steno.NodeProvider<T>
-  }
-
-  fastify.decorate('steno', {
-    create: createDatabase,
-    get: getDatabase
-  })
-
-  next()
-}
-
-const FastifySteno = fp(fastifyPlugin, {
+const FastifySteno = fp(StenoPlugin.createInstance, {
   name: '@stenodb/fastify',
   fastify: '4.x'
 })
 
 export { FastifySteno }
-export default fastifyPlugin
+export default StenoPlugin.createInstance

packages/fastify/src/plugin.ts

@@ -0,0 +1,45 @@
+import { NodeProvider } from '@stenodb/node'
+import { targetConstructorToSchema } from 'class-validator-jsonschema'
+import type { Steno } from '@stenodb/node'
+import type { IOptions } from 'class-validator-jsonschema/build/options'
+import type { FastifyInstance } from 'fastify'
+
+export interface StenoOptions extends Steno.NodeProviderOptions {
+  entities: Steno.Entity<any>[]
+}
+
+export class StenoPlugin {
+  #fastify: FastifyInstance
+  #options: StenoOptions
+  #provider: NodeProvider
+
+  constructor(
+    fastify: FastifyInstance,
+    options: StenoOptions,
+    next: () => void
+  ) {
+    this.#fastify = fastify
+    this.#options = options
+    this.#provider = new NodeProvider(options)
+
+    this.#fastify.decorate('steno', {})
+    this.registerSchemas()
+
+    next()
+  }
+
+  static createInstance(
+    fastify: FastifyInstance,
+    options: StenoOptions,
+    next: () => void
+  ): StenoPlugin {
+    return new StenoPlugin(fastify, options, next)
+  }
+
+  private registerSchemas(options?: IOptions): void {
+    for (const entity of this.#options.entities) {
+      const schema = targetConstructorToSchema(entity, options)
+      this.#fastify.addSchema({ ...schema, $id: entity.name })
+    }
+  }
+}