feat: update providers api

Author: crashmax-dev

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
 
@@ -19,8 +19,9 @@ pnpm add stenodb
 | 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 storages (localStorage, sessionStorage) |
-| [@stenodb/nest](./packages/nest) | [![](https://img.shields.io/npm/v/@stenodb/nest)](https://npm.im/@stenodb/nest) | Nest.js module |
+| [@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
 
@@ -75,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()
@@ -160,7 +161,7 @@ export class UsersService implements OnModuleInit {
   constructor(private readonly stenoService: StenoService) {}
 
   async onModuleInit(): Promise<void> {
-    this.usersProvider = await this.stenoService.createAsync(
+    this.usersProvider = await this.stenoService.create(
       'users',
       Users,
       new Users(

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/src/app.service.ts

@@ -9,11 +9,13 @@ export class UsersService implements OnModuleInit {
   constructor(private readonly stenoService: StenoService) {}
 
   async onModuleInit(): Promise<void> {
-    this.usersProvider = await this.stenoService.createAsync(
+    this.usersProvider = await this.stenoService.create(
       'users',
       Users,
       initialUsersData
     )
+
+    await this.usersProvider.read()
   }
 
   get users(): CreateUserDto[] {

examples/with-node-lodash/src/index.ts

@@ -4,7 +4,7 @@ import { fileURLToPath } from 'node:url'
 import { AsyncAdapter, NodeProvider } from '@stenodb/node'
 import lodash from 'lodash'
 import { User, Users } from './entities.js'
-import type { Steno } from '@stenodb/node/types'
+import type { Steno } from '@stenodb/node'
 
 export class NodeWithLodash<T> {
   chain: lodash.ExpChain<T>
@@ -33,11 +33,10 @@ export class NodeWithLodash<T> {
 const path = resolve(dirname(fileURLToPath(import.meta.url)), '..', 'database')
 const initialData = new Users(new User(1, 'John Doe'))
 const adapter = new AsyncAdapter('users', Users, initialData)
-const provider = new NodeProvider(path)
+const provider = new NodeProvider({ path })
 
-const database = new NodeWithLodash(provider.createAsync(adapter))
+const database = new NodeWithLodash(await provider.create(adapter))
 await database.read()
-await database.write()
 
 function findUserById(id: number) {
   return database.chain.get('users').find({ id }).value()

examples/with-node/src/index.ts

@@ -18,9 +18,9 @@ const logger = createLogger({
 
 const initialData = new Users(new User('John Doe'))
 const adapter = new AsyncAdapter('users', Users, initialData)
-const provider = new NodeProvider(path, { logger })
+const provider = new NodeProvider({ path, logger })
 
-const database = provider.createAsync(adapter)
+const database = await provider.create(adapter)
 await database.read()
 const post = new Post('Hello world')
 database.data?.users[0]?.addPost(post)

packages/browser/src/provider/BrowserProvider.ts

@@ -1,19 +1,16 @@
 import { StorageProvider } from './StorageProvider.js'
 import type { Steno } from '../types.js'
-import type { CreateLogger } from '@stenodb/logger'
 
 export class BrowserProvider {
-  #options: Steno.BrowserProviderOptions | undefined
-  #logger: CreateLogger
+  #options: Steno.BrowserProviderOptions
 
-  constructor(options?: Steno.BrowserProviderOptions) {
+  constructor(options: Steno.BrowserProviderOptions = {}) {
     this.#options = options
-    this.#logger = options?.logger
   }
 
   private registerAdapterModules<T>(adapter: Steno.BrowserAdapter<T>) {
-    if (!this.#logger) return
-    const logger = this.#logger(adapter.name)
+    if (!this.#options?.logger) return
+    const logger = this.#options.logger(adapter.name)
     adapter.registerLogger(logger)
   }
 

packages/nest/README.md

@@ -76,7 +76,7 @@ export class UsersService implements OnModuleInit {
   constructor(private readonly stenoService: StenoService) {}
 
   async onModuleInit(): Promise<void> {
-    this.usersProvider = await this.stenoService.createAsync(
+    this.usersProvider = await this.stenoService.create(
       'users',
       Users,
       new Users(

packages/nest/src/config.ts

@@ -1,12 +1,12 @@
 import { ConfigurableModuleBuilder } from '@nestjs/common'
-import type { StenoOptions } from './types.js'
+import type { Steno } from '@stenodb/node'
 
 export const {
   ConfigurableModuleClass,
   MODULE_OPTIONS_TOKEN,
   OPTIONS_TYPE,
   ASYNC_OPTIONS_TYPE
-} = new ConfigurableModuleBuilder<StenoOptions>()
+} = new ConfigurableModuleBuilder<Steno.NodeProviderOptions>()
   .setExtras({ isGlobal: false }, (definition, extras) => ({
     ...definition,
     global: extras.isGlobal

packages/nest/src/index.ts

@@ -1,3 +1,3 @@
 export * from './stenodb.module.js'
 export * from './stenodb.service.js'
-export * from './types.js'
+export { Steno } from '@stenodb/node'

packages/nest/src/stenodb.service.ts

@@ -1,37 +1,22 @@
 import { Inject, Injectable } from '@nestjs/common'
-import { AsyncAdapter, NodeProvider, SyncAdapter } from '@stenodb/node'
+import { AsyncAdapter, NodeProvider } from '@stenodb/node'
 import { MODULE_OPTIONS_TOKEN, OPTIONS_TYPE } from './config.js'
 import type { Steno } from '@stenodb/node'
 
 @Injectable()
 export class StenoService {
   private readonly provider: NodeProvider
 
-  constructor(
-    @Inject(MODULE_OPTIONS_TOKEN) private readonly options: typeof OPTIONS_TYPE
-  ) {
-    this.provider = new NodeProvider(options.path)
+  constructor(@Inject(MODULE_OPTIONS_TOKEN) options: typeof OPTIONS_TYPE) {
+    this.provider = new NodeProvider(options)
   }
 
   async create<T>(
-    name: string,
+    fileName: string,
     entity: Steno.Entity<T>,
     initialData?: T
   ): Promise<Steno.NodeProvider<T>> {
-    const adapter = new SyncAdapter(name, entity, initialData)
-    const db = await this.provider.create(adapter)
-    db.read()
-    return db
-  }
-
-  async createAsync<T>(
-    name: string,
-    entity: Steno.Entity<T>,
-    initialData?: T
-  ): Promise<Steno.NodeProvider<T>> {
-    const adapter = new AsyncAdapter(name, entity, initialData)
-    const db = await this.provider.createAsync(adapter)
-    await db.read()
-    return db
+    const adapter = new AsyncAdapter(fileName, entity, initialData)
+    return await this.provider.create(adapter)
   }
 }