@Gapi/Sequelize

@Gapi Sequelize module @StrongTyped

For questions/issues you can write ticket here

This module is intended to be used with GAPI

Installation and basic examples:

To install this Gapi module, run:

1$ npm install @gapi/sequelize --save

Consuming gapi-sequelize

Import inside AppModule or CoreModule

1
2import { Module } from '@rxdi/core';
3import { SequelizeModule } from '@gapi/sequelize';
4
5@Module({
6    imports: [
7        SequelizeModule.forRoot({
8            dialect: 'postgres',
9            host: process.env.DB_HOST || '',
10            port: process.env.DB_PORT || 5432,
11            username: process.env.DB_USERNAME || '',
12            password: process.env.DB_PASSWORD || '',
13            database: process.env.DB_NAME || 'your-database',
14            storage: ':memory:',
15            logging: false,
16            modelPaths: [process.cwd() + '/src/models'],
17            force: false
18        })
19    ]
20})
21export class CoreModule { }

Create folder root/src/models and put this testing User Typescript-Sequelize Model with Uppercase name example: "User.ts"

1
2import {
3    Table,
4    Column,
5    Model,
6    CreatedAt,
7    UpdatedAt,
8    DeletedAt,
9    PrimaryKey,
10    AutoIncrement,
11    HasMany,
12    DataType,
13    BelongsToMany
14} from 'sequelize-typescript';
15
16export interface UserSettings {
17    sidebar: boolean;
18}
19
20@Table
21export class User extends Model<User> {
22
23    @PrimaryKey
24    @AutoIncrement
25    @Column
26    id: number;
27
28    @Column
29    name: string;
30
31    @Column({
32        type: DataType.ENUM({ values: ['ADMIN', 'USER'] })
33    })
34    type: 'ADMIN' | 'USER';
35
36    @Column({
37        type: DataType.JSONB,
38        allowNull: true
39    })
40    settings: UserSettings;
41
42
43    @CreatedAt
44    creationDate: Date;
45
46    @UpdatedAt
47    updatedOn: Date;
48
49    @DeletedAt
50    deletionDate: Date;
51
52}
53

Final use this class inside your services the following way

1import { Service } from "@rxdi/core";
2import { UserType } from "../types/user.type";
3import { User } from '../../../models/User';
4
5@Service()
6export class AnotherService {
7    trimFirstLetter(username: string): string {
8        return username.charAt(1);
9    }
10}
11
12@Service()
13export class UserService {
14    constructor(
15        private anotherService: AnotherService
16    ) { }
17
18    async findUser(id: number): Promise<User> {
19        return await User.findOne({ where: { id: id } });
20    }
21
22    async addUser(user: User): Promise<User> {
23        return await User.create(user);
24    }
25
26    async deleteUser(id: number) {
27        return await User.destroy({ where: { id: id } });
28    }
29
30    async updateUser(user: User) {
31        return await User.update(user, {
32            where: {
33                id: user.id
34            }
35        })
36    }
37
38}
39

Advanced getting sequelize instance to manage your sequelize connection

1import { Service } from '@rxdi/core';
2import { SequelizeService } from '@gapi/sequelize';
3
4@Service()
5export class SequelizePrivateService extends SequelizeService implements SequelizeService {
6    sequelize: Sequelize;
7    constructor() {
8        super({
9            dialect: 'postgres',
10            host: process.env.DB_HOST || '',
11            port: process.env.DB_PORT || '5432',
12            username: process.env.DB_USERNAME || '',
13            password: process.env.DB_PASSWORD || '',
14            name: process.env.DB_NAME || 'your-database',
15            storage: ':memory:',
16            logging: false,
17            modelPaths: [process.cwd() + '/src/models'],
18            force: false
19        })
20    }
21}
22

Next import SequelizePrivateService inside Core or AppModule

1import { Module } from '@rxdi/core';
2import { SequelizeModule } from '@gapi/sequelize';
3import { SequelizePrivateService } from './services/sequelize/sequelize.service.ts';
4
5@Module({
6    services: [SequelizePrivateService]
7})
8export class CoreModule { }
9

TODO: Better documentation...

Enjoy ! :)