search

rockdai / sql-bricks

Transparent, Schemaless SQL Generation
http://csnw.github.io/sql-bricks
MIT License
213 stars 25 forks source link

TypeScript definitions are missing from the published package #122

Closed AndKiel closed 4 years ago

AndKiel commented 4 years ago

There is no sql-bricks.d.ts in the latest published package (2.0.5) despite it being in the repository.

@types/sql-bricks package still works, though.

prust commented 4 years ago

@AndKiel: The typescript definitions were contributed (see #109) on master, which is a pre-release version (package.json currently says 3.0.0-beta.2 on master). v2.0.5 does not have typescript definitions.

That said, 3.x hasn't diverged very much from 2.x yet, so most (perhaps all) of the definitions are correct, as you noticed. If you would be willing to create a pull request with this file added, targeting the 2.x branch, I would really appreciate it (and would merge it & publish as 2.0.6).

Update: See #92 for an overview of changes planned for 3.x. The item that is completed (#100) is a fairly deep "breaking" change, but it looks to me that the breakage will only affect libs that depend on sql-bricks (like sql-bricks-postgres/sqlite/mysql), not end-users directly -- particularly the defineClause() function. Since this API isn't included in sql-bricks.d.ts, it looks to me like sql-bricks.d.ts will currently work as-is on both 2.x and 3.x branches.

AndKiel commented 4 years ago

Okay, thanks. Since there seem not to be any issues with using current @types/sql-bricks with 2.0.5, this can probably be closed.