fix: support sequelize 5/6

Author: jedwards1211

README.md

@@ -39,9 +39,9 @@ const User = sequelize.define('User', {
 
 const lock = true
 
-sequelize.query(...sql`SELECT ${User.attributes.name} FROM ${User}
-WHERE ${User.attributes.birthday} = ${new Date('2346-7-11')} AND
-  ${User.attributes.active} = ${true}
+sequelize.query(...sql`SELECT ${User.rawAttributes.name} FROM ${User}
+WHERE ${User.rawAttributes.birthday} = ${new Date('2346-7-11')} AND
+  ${User.rawAttributes.active} = ${true}
   ${lock ? sql`FOR UPDATE` : sql``}then(console.log);
 // => [ [ { name: 'Jimbob' } ], Statement { sql: 'SELECT "name" FROM "Users" WHERE "birthday" = $1 AND "active" = $2 FOR UPDATE' } ]
 ```
@@ -74,9 +74,9 @@ async function getUsersInOrganization(organizationId, where = {}) {
       // Using a sequelize include clause to do this kind of sucks tbh
       id: {
         [Op.in]: Sequelize.literal(sql.escape`
-        SELECT ${OrganizationMember.attributes.userId}
+        SELECT ${OrganizationMember.rawAttributes.userId}
         FROM ${OrganizationMember}
-        WHERE ${OrganizationMember.attributes.organizationId} = ${organizationId}
+        WHERE ${OrganizationMember.rawAttributes.organizationId} = ${organizationId}
       `),
       },
       // SELECT "userId" FROM "OrganizationMembers" WHERE "organizationId" = 2
@@ -97,7 +97,7 @@ Creates arguments for `sequelize.query`.
 
 Will be interpolated to the model's `tableName`.
 
-#### Model attribute (e.g. `User.attributes.id`)
+#### Model attribute (e.g. `User.rawAttributes.id`)
 
 Will be interpolated to the column name for the attribute
 
@@ -131,7 +131,7 @@ Creates a raw SQL string with all expressions in the template escaped.
 
 Will be interpolated to the model's `tableName`.
 
-#### Model attribute (e.g. `User.attributes.id`)
+#### Model attribute (e.g. `User.rawAttributes.id`)
 
 Will be interpolated to the column name for the attribute
 
@@ -180,7 +180,7 @@ const users = [
 const { escape, values } = sql.with(sequelize)
 escape`
 INSERT INTO ${User}
-  ${User.attributes.name}, ${User.attributes.birthday}
+  ${User.rawAttributes.name}, ${User.rawAttributes.birthday}
   VALUES ${users.map(({ name, birthday }) => values`(${name}, ${birthday})`)}
 `
 // returns `INSERT INTO "Users" "name", "birthday" VALUES ('Jim', 'Jan 1 2020'), ('Bob', 'Jan 2 1986')`
@@ -209,7 +209,7 @@ const User = sequelize.define('User', {
 async function insertUser(user) {
   const { query } = sql.with(sequelize)
   await query`
-    INSERT INTO ${User} ${User.attributes.name} VALUES (${user.name});
+    INSERT INTO ${User} ${User.rawAttributes.name} VALUES (${user.name});
   `({ transaction })
 }
 ```

package.json

@@ -120,7 +120,7 @@
     "prettier-eslint": "^8.8.2",
     "rimraf": "^2.6.0",
     "semantic-release": "^17.1.1",
-    "sequelize": "^4.39.0"
+    "sequelize": "^6.3.5"
   },
   "dependencies": {
     "@babel/runtime": "^7.1.5"
@@ -144,6 +144,6 @@
     }
   },
   "peerDependencies": {
-    "sequelize": "^4.39.0"
+    "sequelize": "^4.39.0 || ^5.0.0 || ^6.0.0"
   }
 }

src/index.js

@@ -15,6 +15,13 @@ class ValuesRow {
   }
 }
 
+function getQueryGeneratorCompat(value: any): QueryGenerator {
+  const { queryGenerator, QueryGenerator } = value
+  if (queryGenerator) return queryGenerator
+  if (QueryGenerator) return QueryGenerator
+  throw new Error(`failed to get queryGenerator on ${value}`)
+}
+
 function isValuesArray(expression: any): boolean {
   if (!Array.isArray(expression)) return false
   for (let i = 0; i < expression.length; i++) {
@@ -50,16 +57,13 @@ function sql(
       )
       if (Array.isArray(options.bind)) bind.push(...options.bind)
     } else if (expression && expression.prototype instanceof Model) {
-      const { QueryGenerator, tableName } = (expression: any)
-      queryGenerator = QueryGenerator
-      parts.push(QueryGenerator.quoteTable(tableName))
+      const { tableName } = (expression: any)
+      queryGenerator = getQueryGeneratorCompat(expression)
+      parts.push(queryGenerator.quoteTable(tableName))
     } else if (expression && expression.type instanceof Sequelize.ABSTRACT) {
-      const {
-        field,
-        Model: { QueryGenerator },
-      } = (expression: any)
-      queryGenerator = QueryGenerator
-      parts.push(QueryGenerator.quoteIdentifier(field))
+      const { field, Model } = (expression: any)
+      queryGenerator = getQueryGeneratorCompat(Model)
+      parts.push(queryGenerator.quoteIdentifier(field))
     } else {
       bind.push(expression)
       parts.push(`$${bind.length}`)
@@ -89,11 +93,11 @@ function findQueryGenerator(
     ) {
       return (expression: any)[queryGeneratorSymbol]
     } else if (expression && expression.prototype instanceof Model) {
-      return (expression: any).QueryGenerator
+      return getQueryGeneratorCompat(expression)
     } else if (expression && expression.type instanceof Sequelize.ABSTRACT) {
-      return (expression: any).Model.QueryGenerator
+      return getQueryGeneratorCompat((expression: any).Model)
     } else if (expression instanceof Sequelize) {
-      return expression.getQueryInterface().QueryGenerator
+      return getQueryGeneratorCompat(expression.getQueryInterface())
     }
   }
   throw new Error(
@@ -177,7 +181,7 @@ sql.with = (sequelize: Sequelize) => ({
     strings: $ReadOnlyArray<string>,
     ...expressions: $ReadOnlyArray<mixed>
   ): string =>
-    escapeSql(() => sequelize.getQueryInterface().QueryGenerator)(
+    escapeSql(() => getQueryGeneratorCompat(sequelize.getQueryInterface()))(
       strings,
       ...expressions
     ),
@@ -186,7 +190,7 @@ sql.with = (sequelize: Sequelize) => ({
     ...expressions: $ReadOnlyArray<mixed>
   ): ValuesRow =>
     new ValuesRow(
-      escapeSql(() => sequelize.getQueryInterface().QueryGenerator)(
+      escapeSql(() => getQueryGeneratorCompat(sequelize.getQueryInterface()))(
         strings,
         ...expressions
       )
@@ -196,7 +200,7 @@ sql.with = (sequelize: Sequelize) => ({
     ...expressions: $ReadOnlyArray<mixed>
   ): Literal =>
     Sequelize.literal(
-      escapeSql(() => sequelize.getQueryInterface().QueryGenerator)(
+      escapeSql(() => getQueryGeneratorCompat(sequelize.getQueryInterface()))(
         strings,
         ...expressions
       )

test/index.js

@@ -18,10 +18,10 @@ describe(`sql`, function() {
 
   it(`works`, function() {
     expect(sql`
-SELECT ${User.attributes.name} ${Sequelize.literal('FROM')} ${User}
-WHERE ${User.attributes.birthday} = ${new Date('2346-7-11')} AND
-  ${sql`${User.attributes.name} LIKE ${'a%'} AND`}${sql``}
-  ${User.attributes.id} = ${1}
+SELECT ${User.rawAttributes.name} ${Sequelize.literal('FROM')} ${User}
+WHERE ${User.rawAttributes.birthday} = ${new Date('2346-7-11')} AND
+  ${sql`${User.rawAttributes.name} LIKE ${'a%'} AND`}${sql``}
+  ${User.rawAttributes.id} = ${1}
     `).to.deep.equal([
       `SELECT "name" FROM "Users" WHERE "birthday" = $1 AND "name" LIKE $2 AND "id" = $3`,
       {
@@ -48,7 +48,7 @@ WHERE ${User.attributes.birthday} = ${new Date('2346-7-11')} AND
     ]
     expect(sql`
     INSERT INTO ${User}
-      ${User.attributes.name}, ${User.attributes.birthday}
+      ${User.rawAttributes.name}, ${User.rawAttributes.birthday}
       VALUES ${users.map(
         ({ name, birthday }) => values`(${name}, ${birthday})`
       )}
@@ -71,10 +71,10 @@ describe(`sql.escape`, function() {
     })
 
     expect(sql.escape`
-SELECT ${User.attributes.id} ${Sequelize.literal('FROM')} ${User}
-WHERE ${User.attributes.name} LIKE ${'and%'} AND
-  ${sql`${User.attributes.name} LIKE ${'a%'} AND`}${sql``}
-  ${User.attributes.id} = ${1}
+SELECT ${User.rawAttributes.id} ${Sequelize.literal('FROM')} ${User}
+WHERE ${User.rawAttributes.name} LIKE ${'and%'} AND
+  ${sql`${User.rawAttributes.name} LIKE ${'a%'} AND`}${sql``}
+  ${User.rawAttributes.id} = ${1}
     `).to.deep.equal(`SELECT "id" FROM "Users"
 WHERE "name" LIKE 'and%' AND
   "name" LIKE 'a%' AND