Models

📝 Generics Models

Generic models is a library that allows you to create models to manage generics repository, this library is based on the Sequelizer library and also in Typegoose.

📦 Installation

Note

You need to install your ODM/ORM library, for example: @typegoose/typegoose or sequelize to use this library.

npm

npm install @gnx-utilities/models

pnpm

pnpm add @gnx-utilities/models

yarn

yarn add @gnx-utilities/models

bun

bun add @gnx-utilities/models

📖 Usage

Caution

Typegoose needs some configuration to work properly, fallow the example below to configure it.

Important

On prop decorator, you need to add the type property to the decorator, this is because the @typegoose/typegoose library needs to know the type of the property.

Sequelize

import { SequelizeBaseEntity } from '@gnx-utilities/models'
import { SequelizeService } from '@gnx-utilities/services'
import { DataTypes, Sequelize } from 'sequelize'
import type { UUID } from 'node:crypto'

const sequelize = new Sequelize({
  dialect: 'sqlite',
  storage: './db/test.sqlite'
})

class User extends SequelizeBaseEntity {
  declare id: UUID
  declare firstName: string
  declare lastName: string
  declare email: string
}

User.init(
  {
    id: { type: DataTypes.UUID, primaryKey: true, defaultValue: DataTypes.UUIDV4 },
    firstName: { type: DataTypes.STRING },
    lastName: { type: DataTypes.STRING },
    email: { type: DataTypes.STRING },
    isDeleted: { type: DataTypes.BOOLEAN, defaultValue: false }
  },
  { sequelize, modelName: 'person' }
)


class UserService extends SequelizeService<User> {
  constructor () {
    super(User)
  }
}

const userService = new UserService()

const user = await userService.create({
  entity: { firstName: 'John', lastName: 'Doe' }
})

console.log(user.firstName) // John

Typegoose

import { TypegooseBaseEntity } from '@gnx-utilities/models'
import { TypegooseService } from '@gnx-utilities/services'
import { getModelForClass, prop } from '@typegoose/typegoose'

const uri =
'mongodb://localhost:27017/?readPreference=primary&ssl=false&directConnection=true'

const connection = async (): Promise<void> => {
  await connect(uri, { dbName: 'test' })
}

class User extends TypegooseBaseEntity {
  @prop({ type: String })
  declare firstName: string

  @prop({ type: String })
  declare lastName: string

  @prop({ type: String })
  declare email: string
}

const UserModel = getModelForClass(User)

class UserService extends TypegooseService<User> {
  constructor () {
    super(UserModel)
  }
}

const userService = new UserService()

const user = await userService.create({
  entity: { firstName: 'John', lastName: 'Doe' }
})

console.log(user.firstName) // John