sequelize-typescript-decorators

This documents how I set up decorators and use them with sequelize (node JS ORM library) to reduce boilderplate

TODO's

• extract plumbing into a method and reuse it instead of having user of this library do it...
• add support for other adapters: SQLITE, PG, etc...
• deploy to npm modules instead of using github
• integrate with CI pipeline to build stuffs automatically
• add unit tests

Credentials

DB_URL=mysql://root:StrongP@assword@127.0.0.1:3306/my_database

How to use

Install it

To install from npm

npm install --save sequelize-typescript-decorators@^2

Then declare it in your model...

./models/schema.ts

import {
  Relationship,
  table,
  attribute,
  relationship,
} from 'sequelize-typescript-decorators';

import { DataTypes, Model } from 'sequelize';

@table('my_user')
export class User extends Model {
  static as = 'User';

  @attribute(User, {
    allowNull: false,
    primaryKey: true,
    autoIncrement: true,
  })
  public id!: number;

  @attribute(User, { allowNull: false })
  public password!: string;

  @attribute(User, { allowNull: false })
  public last_login!: Date;

  @attribute(User, { unique: true, allowNull: false })
  public email!: string;

  @attribute(User, {})
  public is_active!: boolean;

  @attribute(User, {})
  public is_canceled!: boolean;

  @attribute(User, {})
  public is_admin!: boolean;
}

@table('salesforcecredentials')
export class SalesforceCredential extends Model {
  static as = 'SalesforceCredential';

  @attribute(SalesforceCredential, {
    allowNull: false,
    primaryKey: true,
    autoIncrement: true,
  })
  public id!: number;

  @attribute(SalesforceCredential, { allowNull: false })
  public sf_id!: string;

  @attribute(SalesforceCredential, { allowNull: false })
  public issued_at!: string;

  @attribute(SalesforceCredential, { allowNull: false })
  public scope!: string;

  @attribute(SalesforceCredential, { allowNull: false })
  public instance_url!: string;

  @attribute(SalesforceCredential, { allowNull: false })
  public refresh_token!: string;

  @attribute(SalesforceCredential, { allowNull: false })
  public signature!: string;

  @attribute(SalesforceCredential, { allowNull: false })
  public access_token!: string;

  @attribute(SalesforceCredential, {})
  public has_rest_api_access!: boolean;

  @attribute(SalesforceCredential, { allowNull: false })
  public sf_username!: string;

  @attribute(SalesforceCredential, {})
  public sf_bcc_address!: string;

  @attribute(SalesforceCredential, { allowNull: false })
  public initial_touch_status!: string;

  @attribute(SalesforceCredential, {})
  public task_type!: string;

  @attribute(SalesforceCredential, { allowNull: false })
  @relationship(SalesforceCredential, {
    relationship: Relationship.hasOne,
    foreignModel: User,
  })
  public user_id!: number;

  // with association getter
  public readonly User?: User; // this is optional and only visible with includes
}

Plumbing it up

Note that db credentials should be stored in DB_URL in this format DB_URL=mysql://myuser:strongpassword@127.0.0.1:3306/my_db

./models/factory.ts

import { Sequelize } from 'sequelize';
import {
  initDatabase,
} from 'sequelize-typescript-decorators';
import * as AllModelMaps from './schema';

/**
 * this routine will initialize the database, please only run this once per all...
 */
export default async () => {
  const dbConnectionString = process.env.DB_URL || '';
  const sequelize = new Sequelize(dbConnectionString, {
    logging: false, // disable it for debugging
    define: {
      // Enforcing the table name to be equal to the model name
      freezeTableName: true,
      timestamps: false, // disable auto create createdAt and updatedAt
    },
  });

  const models = Object.keys(AllModelMaps).map((modelName) => AllModelMaps[modelName]);
  await(initDatabase(sequelize, models))
};

How to call it?

import * as AllModelMaps from './models/schema';
import initDatabase from './models/factory';

async function _doWork(){
  await initDatabase();

  const mockUserId = 1;
  const user = await AllModelMaps.User.findByPk(mockUserId, {
    include: [
      {
        model: AllModelMaps.SalesforceCredential,
        as: 'SalesforceCredential',
        required: true,
      },
    ],
  });
}
_doWork();

How to contribute?

Create PR against master.

Note on release pipeline

version="$(cat package.json  | jq .version)"
git tag $version
git push origin $version