.toSQL() return SqlNative[] should be a logic bug instead of type definition bug

[loynoir]

Environment

Knex version: 2.4.2
Database + version: pg any
OS: any

@lorefnon

Bug

Brief

.toSQL() return SqlNative[]

• some may consider this as type definition bug
• I prefer consider this as logic bug

And because .toSQL() return SqlNative[], .toSQL().toNative() got error.

Actual

> var reproduceSql = (require('knex')({ client: 'pg' })
  .schema.createTable('users', function (table) {
    table.increments()
    table.string('name')
    table.timestamps()
  })
  .toSQL())
[
  {
    sql: 'create table "users" ("id" serial primary key, "name" varchar(255), "created_at" timestamptz, "updated_at" timestamptz)',
    bindings: []
  }
]
> var reproduceSqlNative = reproduceSql.toNative()
Uncaught TypeError: reproduceSql.toNative is not a function

Expected

> var reproduceSql = (require('knex')({ client: 'pg' })
  .schema.createTable('users', function (table) {
    table.increments()
    table.string('name')
    table.timestamps()
  })
  .toSQL())
// no error, and `reproduceSql` is type `Sql`

> var reproduceSqlNative = reproduceSql.toNative()
 // no error, and `reproduceSqlNative` is type `SqlNative`
{
  sql: 'create table "users" ("id" serial primary key, "name" varchar(255), "created_at" timestamptz, "updated_at" timestamptz)',
  bindings: []
}

Additional

• Would be nice to cover all .toSQL().toNative() cases in tests.

• If developers don't think .toSQL() return SqlNative[] is bug, would be nice to have document on how to build very clean sql code like below ❤️❤️❤️

  interface SqlNative {
    bindings: readonly Value[];
    sql: string;
  }

Related

#5369