Merge pull request #79 from kukoo1/feature-uri-connection-string

connect using URI connection string support

Author: RobinBuschmann

lib/interfaces/ISequelizeConfig.ts

@@ -5,7 +5,7 @@ export interface ISequelizeConfig extends Options {
   /**
    * Name of database
    */
-  name: string;
+  database: string;
 
   /**
    * Username of database

lib/interfaces/ISequelizeDbNameConfig.ts

@@ -0,0 +1,36 @@
+import {Options} from 'sequelize';
+
+/**
+ * This class is dedicated for deprecated "name" property.
+ * For congruence to Sequelize config, use "database" instead.
+ */
+export interface ISequelizeDbNameConfig extends Options {
+
+  /**
+   * Name of database
+   * @deprecated: name is deprecated. Use database instead.
+   */
+  name: string;
+
+  /**
+   * Username of database
+   */
+  username: string;
+
+  /**
+   * Password for database user
+   */
+  password: string;
+
+  /**
+   * Path to models, which should be loaded
+   */
+  modelPaths?: string[];
+
+  /**
+   * Makes it possible to use sequelize for validation only
+   * if set to true. For this configuration it is always false.
+   * See ISequelizeValidationOnlyConfig interface
+   */
+  validateOnly?: false;
+}

lib/interfaces/ISequelizeUriConfig.ts

@@ -0,0 +1,21 @@
+import {Options} from 'sequelize';
+
+export interface ISequelizeUriConfig extends Options {
+
+  /**
+   * Uri connection string to database
+   */
+  uri: string;
+
+  /**
+   * Path to models, which should be loaded
+   */
+  modelPaths?: string[];
+
+  /**
+   * Makes it possible to use sequelize for validation only
+   * if set to true. For this configuration it is always false.
+   * See ISequelizeValidationOnlyConfig interface
+   */
+  validateOnly?: false;
+}

lib/models/BaseSequelize.ts

@@ -2,6 +2,9 @@ import {Model} from "./Model";
 import {DEFAULT_DEFINE_OPTIONS, getModels} from "../services/models";
 import {getAssociations, processAssociation} from "../services/association";
 import {ISequelizeConfig} from "../interfaces/ISequelizeConfig";
+import {ISequelizeUriConfig} from "../interfaces/ISequelizeUriConfig";
+import {ISequelizeDbNameConfig} from "../interfaces/ISequelizeDbNameConfig";
+import {SequelizeConfig} from "../types/SequelizeConfig";
 import {resolveScopes} from "../services/scopes";
 import {installHooks} from "../services/hooks";
 import {ISequelizeValidationOnlyConfig} from "../interfaces/ISequelizeValidationOnlyConfig";
@@ -20,6 +23,14 @@ export abstract class BaseSequelize {
   throughMap: { [through: string]: any } = {};
   _: { [modelName: string]: (typeof Model) } = {};
 
+  static isISequelizeDbNameConfig(obj: any): obj is ISequelizeDbNameConfig {
+    return obj.hasOwnProperty("name") && obj.hasOwnProperty("username");
+  }
+
+  static isISequelizeUriConfig(obj: any): obj is ISequelizeUriConfig {
+    return obj.hasOwnProperty("uri");
+  }
+
   static extend(target: any): void {
 
     extend(target, this);
@@ -28,7 +39,7 @@ export abstract class BaseSequelize {
   /**
    * Prepares sequelize config passed to original sequelize constructor
    */
-  static prepareConfig(config: ISequelizeConfig | ISequelizeValidationOnlyConfig): ISequelizeConfig {
+  static prepareConfig(config: SequelizeConfig | ISequelizeValidationOnlyConfig): SequelizeConfig {
     if (!config.define) {
       config.define = {};
     }
@@ -38,13 +49,19 @@ export abstract class BaseSequelize {
 
       return this.getValidationOnlyConfig(config);
     }
-    return {...config as ISequelizeConfig};
+
+    if (BaseSequelize.isISequelizeDbNameConfig(config)) {
+      // @TODO: remove deprecated "name" property
+      return {...config, database: config.name} as ISequelizeConfig;
+    }
+
+    return {...config as SequelizeConfig};
   }
 
-  static getValidationOnlyConfig(config: ISequelizeConfig | ISequelizeValidationOnlyConfig): ISequelizeConfig {
+  static getValidationOnlyConfig(config: SequelizeConfig | ISequelizeValidationOnlyConfig): ISequelizeConfig {
     return {
       ...config,
-      name: '_name_',
+      database: '_name_',
       username: '_username_',
       password: '_password_',
       dialect: 'sqlite',
@@ -66,7 +83,7 @@ export abstract class BaseSequelize {
     models.forEach(model => this._[model.name] = model);
   }
 
-  init(config: ISequelizeConfig): void {
+  init(config: SequelizeConfig): void {
 
     if (config.modelPaths) this.addModels(config.modelPaths);
   }

lib/models/Sequelize.d.ts

@@ -1,15 +1,15 @@
-/// <reference types="sequelize" />
 import 'reflect-metadata';
 import * as SequelizeOrigin from 'sequelize';
 import {Model} from "./Model";
-import {ISequelizeConfig} from "../interfaces/ISequelizeConfig";
+import {SequelizeConfig} from "../types/SequelizeConfig";
 import {ISequelizeValidationOnlyConfig} from "../interfaces/ISequelizeValidationOnlyConfig";
 
 export declare class Sequelize extends SequelizeOrigin {
 
   _: {[modelName: string]: (typeof Model)};
 
-  constructor(config: ISequelizeConfig | ISequelizeValidationOnlyConfig);
+  constructor(config: SequelizeConfig | ISequelizeValidationOnlyConfig);
+  constructor(uri: string);
 
   addModels(models: Array<typeof Model>): void;
   addModels(modelPaths: string[]): void;

lib/models/v3/Sequelize.ts

@@ -1,40 +1,41 @@
 import 'reflect-metadata';
 import * as SequelizeOrigin from 'sequelize';
 import {Model} from "../Model";
-import {ISequelizeConfig} from "../../interfaces/ISequelizeConfig";
+import {SequelizeConfig} from "../../types/SequelizeConfig";
 import {getModelName, getAttributes, getOptions} from "../../services/models";
 import {PROPERTY_LINK_TO_ORIG} from "../../services/models";
 import {BaseSequelize} from "../BaseSequelize";
 import {Table} from "../../annotations/Table";
 import {ISequelizeAssociation} from "../../interfaces/ISequelizeAssociation";
 
-let preparedConfig;
-
 export class Sequelize extends SequelizeOrigin implements BaseSequelize {
 
   // to fix "$1" called with something that's not an instance of Sequelize.Model
   Model: any = Function;
 
   throughMap: { [through: string]: any } = {};
   _: { [modelName: string]: typeof Model } = {};
-  init: (config: ISequelizeConfig) => void;
+  init: (config: SequelizeConfig) => void;
   addModels: (models: Array<typeof Model> | string[]) => void;
   associateModels: (models: Array<typeof Model>) => void;
 
-  constructor(config: ISequelizeConfig) {
-    // a spread operator would be the more reasonable approach here,
-    // but this is currently not possible due to a bug by ts
-    // https://github.com/Microsoft/TypeScript/issues/4130
-    // TODO@robin probably make the constructor private and
-    // TODO       use a static factory function instead
+  constructor(config: SequelizeConfig | string) {
+
     super(
-      (preparedConfig = BaseSequelize.prepareConfig(config), preparedConfig.name),
-      preparedConfig.username,
-      preparedConfig.password,
-      preparedConfig
+      (typeof config === "string") ?
+        config : // URI string
+        BaseSequelize.isISequelizeUriConfig(config) ?
+          config.uri : // URI string from ISequelizeUriConfig
+          BaseSequelize.prepareConfig(config) // Config object (ISequelizeConfig)
     );
 
-    this.init(config);
+    if (BaseSequelize.isISequelizeUriConfig(config)) {
+      this.options = {...this.options, ...config};
+    }
+
+    if (typeof config !== "string") {
+      this.init(config);
+    }
   }
 
   getThroughModel(through: string): typeof Model {

lib/models/v4/Sequelize.ts

@@ -1,36 +1,37 @@
 import 'reflect-metadata';
 import * as OriginSequelize from 'sequelize';
 import {Model} from "../Model";
-import {ISequelizeConfig} from "../../interfaces/ISequelizeConfig";
+import {SequelizeConfig} from "../../types/SequelizeConfig";
 import {getModelName, getAttributes, getOptions} from "../../services/models";
 import {BaseSequelize} from "../BaseSequelize";
 import {Table} from "../../annotations/Table";
 import {ISequelizeAssociation} from "../../interfaces/ISequelizeAssociation";
 
-let preparedConfig;
-
 export class Sequelize extends OriginSequelize implements BaseSequelize {
 
   throughMap: {[through: string]: any} = {};
   _: {[modelName: string]: typeof Model} = {};
-  init: (config: ISequelizeConfig) => void;
-  addModels: (models: Array<typeof Model>|string[]) => void;
+  init: (config: SequelizeConfig) => void;
+  addModels: (models: Array<typeof Model> | string[]) => void;
   associateModels: (models: Array<typeof Model>) => void;
 
-  constructor(config: ISequelizeConfig) {
-    // a spread operator would be the more reasonable approach here,
-    // but this is currently not possible due to a bug by ts
-    // https://github.com/Microsoft/TypeScript/issues/4130
-    // TODO@robin probably make the constructor private and
-    // TODO       use a static factory function instead
+  constructor(config: SequelizeConfig | string) {
+
     super(
-      (preparedConfig = BaseSequelize.prepareConfig(config), preparedConfig.name),
-      preparedConfig.username,
-      preparedConfig.password,
-      preparedConfig
+      (typeof config === "string") ?
+        config : // URI string
+        BaseSequelize.isISequelizeUriConfig(config) ?
+          config.uri : // URI string from ISequelizeUriConfig
+          BaseSequelize.prepareConfig(config) // Config object (ISequelizeConfig)
     );
 
-    this.init(config);
+    if (BaseSequelize.isISequelizeUriConfig(config)) {
+      this.options = {...this.options, ...config};
+    }
+
+    if (typeof config !== "string") {
+      this.init(config);
+    }
   }
 
   getThroughModel(through: string): typeof Model {

lib/types/SequelizeConfig.ts

@@ -0,0 +1,5 @@
+import {ISequelizeConfig} from "../interfaces/ISequelizeConfig";
+import {ISequelizeUriConfig} from "../interfaces/ISequelizeUriConfig";
+import {ISequelizeDbNameConfig} from "../interfaces/ISequelizeDbNameConfig";
+
+export type SequelizeConfig = ISequelizeConfig | ISequelizeUriConfig | ISequelizeDbNameConfig;

package-lock.json

@@ -30,9 +30,10 @@
   "main": "index.js",
   "types": "index.d.ts",
   "dependencies": {
+    "@types/bluebird": "3.5.4",
     "@types/node": "6.0.41",
     "@types/reflect-metadata": "0.0.4",
-    "@types/sequelize": "4.0.68",
+    "@types/sequelize": "4.0.69",
     "es6-shim": "0.35.3"
   },
   "devDependencies": {