Merge pull request #14 from crashmax-dev/nest-module

feat(package): add `@stenodb/nest`

Author: crashmax-dev

.gitignore

@@ -4,5 +4,19 @@
 .env
 .DS_Store
 **/database
+**/db
 **/logs
 **/temp
+
+# Tests
+**/coverage
+**/.nyc_output
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "packages/writer"]
+	path = packages/writer
+	url = https://github.com/yoloforks/steno
+	branch = main

README.md

@@ -1,6 +1,6 @@
 # stenodb [![](https://img.shields.io/npm/v/stenodb)](https://www.npmjs.org/package/stenodb)
 
-> ✍ Easy to use local JSON database. Ready to use in browser (localStorage, sessionStorage) and Node.js.
+> ✍ Easy to use local JSON database.
 
 ## Install
 
@@ -16,16 +16,15 @@ yarn add stenodb
 pnpm add stenodb
 ```
 
-| Package | Version | Platform |
+| Package | Version | Description |
 | ------- | ------ | ----------- |
 | [@stenodb/node](./packages/node) | [![](https://img.shields.io/npm/v/@stenodb/node)](https://npm.im/@stenodb/node) | Node.js |
-| [@stenodb/browser](./packages/browser) | [![](https://img.shields.io/npm/v/@stenodb/browser)](https://npm.im/@stenodb/browser) | Browser |
+| [@stenodb/browser](./packages/browser) | [![](https://img.shields.io/npm/v/@stenodb/browser)](https://npm.im/@stenodb/browser) | Browser (localStorage, sessionStorage) |
+| [@stenodb/nest](./packages/nest) | [![](https://img.shields.io/npm/v/@stenodb/nest)](https://npm.im/@stenodb/nest) | Nest.js |
+| [@stenodb/logger](./packages/logger) | [![](https://img.shields.io/npm/v/@stenodb/logger)](https://npm.im/@stenodb/logger) | Logger |
 
 ## Usage
 
-> **Warning**\
-> stenodb is a pure ESM package. If you're having trouble using it in your project, please [read this](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
-
 ### Database entities
 ```typescript
 // entities.ts
@@ -77,7 +76,7 @@ import { Users, User, Post } from './entities.js'
 const path = resolve(dirname(fileURLToPath(import.meta.url)), '..', 'database')
 const initialData = new Users(new User('John Doe'))
 const adapter = new AsyncAdapter('users', Users, initialData)
-const provider = new NodeProvider(path)
+const provider = new NodeProvider({ path })
 const database = provider.createAsync(adapter)
 
 await database.read()
@@ -86,6 +85,7 @@ await database.write()
 ```
 
 ### `@stenodb/browser`
+
 ```typescript
 import 'reflect-metadata'
 import { LocalStorage, BrowserProvider } from '@stenodb/browser'
@@ -101,6 +101,83 @@ storage.data?.users[0]?.addPost(new Post('Lorem ipsum'))
 storage.write()
 ```
 
+### `@stenodb/nest`
+
+```typescript
+// users.dto.ts
+import { Exclude, Type } from 'class-transformer'
+import { Length, Max, Min } from 'class-validator'
+
+export class Users {
+  @Type(() => CreateUserDto)
+  users: CreateUserDto[] = []
+
+  constructor(...users: CreateUserDto[]) {
+    this.users = users
+  }
+}
+
+export class CreateUserDto {
+  @Exclude({ toPlainOnly: true })
+  id: number
+
+  @Length(1, 20)
+  name: string
+
+  @Min(12)
+  @Max(100)
+  age: number
+
+  constructor(id: number, name: string, age: number) {
+    this.id = id
+    this.name = name
+    this.age = age
+  }
+}
+
+// app.module.ts
+import { resolve } from 'node:path'
+import { Module } from '@nestjs/common'
+import { StenoModule } from '@stenodb/nest'
+
+@Module({
+  imports: [
+    StenoModule.register({
+      path: resolve(process.cwd(), 'db')
+    })
+  ]
+})
+export class AppModule {}
+
+// users.service.ts
+import { Injectable, OnModuleInit } from '@nestjs/common'
+import { Steno, StenoService } from '@stenodb/nest'
+import { Users, CreateUserDto } from './users.dto'
+
+@Injectable()
+export class UsersService implements OnModuleInit {
+  private usersProvider: Steno.NodeProvider<Users>
+
+  constructor(private readonly stenoService: StenoService) {}
+
+  async onModuleInit(): Promise<void> {
+    this.usersProvider = await this.stenoService.create(
+      'users',
+      Users,
+      new Users(
+        new CreateUserDto(1, 'John', 22)
+      )
+    )
+
+    await this.usersProvider.read()
+  }
+
+  get users(): CreateUserDto[] {
+    return this.usersProvider.data.users
+  }
+}
+```
+
 ## Credits
 
 - [steno](https://github.com/typicode/steno) - Specialized fast async file writer.

examples/with-browser-lodash/src/storage.ts

@@ -1,7 +1,7 @@
 import { BrowserProvider, LocalStorage } from '@stenodb/browser'
-import { Steno } from '@stenodb/browser/types'
 import lodash from 'lodash'
 import { User, Users } from './entities.js'
+import type { Steno } from '@stenodb/browser'
 
 export class BrowserWithLodash<T> {
   chain: lodash.ExpChain<T>

examples/with-nest/nest-cli.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src"
+}

examples/with-nest/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "with-nest",
+  "version": "0.0.1",
+  "description": "",
+  "author": "",
+  "private": true,
+  "license": "UNLICENSED",
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "build": "nest build",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json"
+  },
+  "dependencies": {
+    "@nestjs/common": "^9.0.0",
+    "@nestjs/core": "^9.0.0",
+    "@nestjs/platform-express": "^9.0.0",
+    "@stenodb/nest": "workspace:*",
+    "class-transformer": "0.5.1",
+    "class-validator": "^0.14.0",
+    "reflect-metadata": "^0.1.13",
+    "rimraf": "^3.0.2",
+    "rxjs": "^7.2.0"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "^9.0.0",
+    "@nestjs/schematics": "^9.0.0",
+    "@nestjs/testing": "^9.0.0",
+    "@types/express": "^4.17.13",
+    "@types/jest": "28.1.8",
+    "@types/node": "^16.0.0",
+    "@types/supertest": "^2.0.11",
+    "jest": "28.1.3",
+    "source-map-support": "^0.5.20",
+    "supertest": "^6.1.3",
+    "ts-jest": "28.0.8",
+    "ts-loader": "^9.2.3",
+    "ts-node": "^10.0.0",
+    "tsconfig-paths": "4.1.0",
+    "typescript": "^4.7.4"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}

examples/with-nest/src/app.controller.spec.ts

@@ -0,0 +1,32 @@
+import { Test, TestingModule } from '@nestjs/testing'
+import { StenoModule } from '@stenodb/nest'
+import { resolve } from 'path'
+import { UsersController } from './app.controller'
+import { UsersService } from './app.service'
+import { initialUsersData } from './dto/users.dto'
+
+describe('UsersController', () => {
+  let usersController: UsersController
+
+  beforeEach(async () => {
+    const app: TestingModule = await Test.createTestingModule({
+      imports: [
+        StenoModule.register({
+          path: resolve(process.cwd(), 'db', 'users')
+        })
+      ],
+      controllers: [UsersController],
+      providers: [UsersService]
+    }).compile()
+
+    await app.init()
+
+    usersController = app.get<UsersController>(UsersController)
+  })
+
+  describe('root', () => {
+    it('should return initialUsersData', () => {
+      expect(usersController.getUsers()).toEqual(initialUsersData.users)
+    })
+  })
+})

examples/with-nest/src/app.controller.ts

@@ -0,0 +1,33 @@
+import { Body, Controller, Get, Param, Post } from '@nestjs/common'
+import { UsersService } from './app.service'
+import { CreateUserDto } from './dto/users.dto'
+
+@Controller('users')
+export class UsersController {
+  constructor(private readonly usersService: UsersService) {}
+
+  @Get()
+  getUsers() {
+    return this.usersService.users
+  }
+
+  @Get(':id')
+  getUserById(@Param('id') id: string) {
+    return this.usersService.findById(Number(id)) ?? {}
+  }
+
+  @Post()
+  async addUser(@Body() user: CreateUserDto) {
+    await this.usersService.add(user)
+  }
+
+  @Post('reset')
+  async resetUsers() {
+    await this.usersService.reset()
+  }
+
+  @Post('remove/:id')
+  async removeUser(@Param('id') id: string) {
+    await this.usersService.remove(Number(id))
+  }
+}

examples/with-nest/src/app.module.ts

@@ -0,0 +1,16 @@
+import { Module } from '@nestjs/common'
+import { StenoModule } from '@stenodb/nest'
+import { resolve } from 'path'
+import { UsersController } from './app.controller'
+import { UsersService } from './app.service'
+
+@Module({
+  imports: [
+    StenoModule.register({
+      path: resolve(process.cwd(), 'db')
+    })
+  ],
+  controllers: [UsersController],
+  providers: [UsersService]
+})
+export class AppModule {}

examples/with-nest/src/app.service.ts

@@ -0,0 +1,47 @@
+import { Injectable, OnModuleInit } from '@nestjs/common'
+import { Steno, StenoService } from '@stenodb/nest'
+import { CreateUserDto, initialUsersData, Users } from './dto/users.dto'
+
+@Injectable()
+export class UsersService implements OnModuleInit {
+  private usersProvider: Steno.NodeProvider<Users>
+
+  constructor(private readonly stenoService: StenoService) {}
+
+  async onModuleInit(): Promise<void> {
+    this.usersProvider = await this.stenoService.create(
+      'users',
+      Users,
+      initialUsersData
+    )
+
+    await this.usersProvider.read()
+  }
+
+  get users(): CreateUserDto[] {
+    return this.usersProvider.data.users
+  }
+
+  set users(users: CreateUserDto[]) {
+    this.usersProvider.data.users = users
+  }
+
+  async reset(): Promise<void> {
+    await this.usersProvider.reset()
+  }
+
+  findById(id: number): CreateUserDto {
+    return this.users.find((user) => user.id === id)
+  }
+
+  async add(user: CreateUserDto): Promise<void> {
+    user.id = this.users.at(-1).id + 1
+    this.users.push(user)
+    await this.usersProvider.write()
+  }
+
+  async remove(id: number): Promise<void> {
+    this.users = this.users.filter((user) => user.id !== id)
+    await this.usersProvider.write()
+  }
+}