Rewrite with typescript (#6)

* rewrite in typescript (wip)

* add build to gitignore

* fix bug

* fix bug (bis)

* update jest config

* update helpers

* update tests

* remove pg.js and sql.js

* update build script

* include right files when publishing

* improve scripts

* remove types folder

* remove types folder (bis)

* clean stuff

* clean stuff (bis)

* fix linter

* fix linting issues

* remove dtslint in circleci

* simplify things

* fix tests

* better types/interfaces

* update readme

* fix yarn run lint

* add IPGQueryable

* fix tests

* move expression counter into SqlContainer

.circleci/config.yml

@@ -24,7 +24,6 @@ jobs:
       - restore-cache:
           key: yarn-packages-{{ checksum "yarn.lock" }}
       - run: yarn
-      - run: yarn dtslint --installAll
       - save-cache:
           key: yarn-packages-{{ checksum "yarn.lock" }}
           paths:
@@ -39,12 +38,6 @@ jobs:
       - attach_workspace: *attach_environment
       - run: yarn run lint
 
-  dtslint:
-    <<: *defaults
-    steps:
-      - attach_workspace: *attach_environment
-      - run: yarn run dtslint
-
   test:
     <<: *defaults
     steps:
@@ -63,10 +56,6 @@ workflows:
           requires:
             - setup
 
-      - dtslint:
-          requires:
-            - setup
-
       - test:
           requires:
             - setup

.gitignore

@@ -1,2 +1,5 @@
 node_modules
-coverage
+coverage
+
+*.d.ts
+*.js

lib/utils.ts

@@ -0,0 +1,34 @@
+export class SqlContainer {
+  public readonly chains: ReadonlyArray<string>
+  public readonly expressions: any[]
+  public readonly count: number
+  constructor(
+    chains: ReadonlyArray<string>,
+    expressions: any[],
+    count: number
+  ) {
+    this.chains = chains
+    this.expressions = expressions
+    this.count = count
+  }
+}
+
+export type TemplateLiteralFunc<T> = (
+  chains: ReadonlyArray<string>,
+  ...expressions: any[]
+) => T
+
+export interface IPGQueryConfig {
+  _sql?: SqlContainer
+  text: string
+  values: any[]
+}
+
+export interface IPGQueryResult {
+  rowCount: number
+  rows: any[]
+}
+
+export interface IPGQueryable {
+  readonly query: (query: IPGQueryConfig) => Promise<IPGQueryResult>
+}

package.json

@@ -2,6 +2,7 @@
   "name": "@sequencework/sql",
   "version": "2.0.1",
   "main": "sql.js",
+  "types": "sql.d.ts",
   "license": "MIT",
   "description": "Javascript tag to format SQL template literals",
   "keywords": [
@@ -12,55 +13,62 @@
   ],
   "files": [
     "sql.js",
+    "sql.d.ts",
     "pg.js",
-    "types/index.d.ts"
+    "pg.d.ts"
   ],
-  "types": "types",
   "scripts": {
+    "build": "tsc",
+    "clean": "rimraf pg.js pg.d.ts sql.js sql.d.ts lib/**/*.js lib/**/*.d.ts coverage",
     "test": "jest",
-    "prettier": "prettier --write '**/*.{js,json,css,md}' --ignore-path .gitignore",
-    "lint": "eslint '**/*.js' --ignore-path .gitignore",
-    "dtslint": "dtslint types"
+    "prettier": "prettier --write '**/*.{ts,js,json,css,md}' --ignore-path .gitignore",
+    "lint": "tslint *.ts **/*.ts"
   },
   "devDependencies": {
-    "@sequencework/eslint-config": "^0.0.7",
+    "@types/jest": "^23.3.2",
     "codecov": "3.1.0",
-    "dtslint": "^0.3.0",
-    "eslint": "5.4.0",
     "husky": "1.0.0-rc.13",
     "jest": "^23.5.0",
     "lint-staged": "7.2.2",
-    "prettier": "1.14.2"
+    "prettier": "1.14.2",
+    "rimraf": "^2.6.2",
+    "ts-jest": "^23.1.4",
+    "tslint": "^5.11.0",
+    "tslint-config-prettier": "^1.15.0",
+    "typescript": "^3.0.3"
   },
   "dependencies": {},
+  "jest": {
+    "collectCoverage": true,
+    "transform": {
+      "^.+\\.ts$": "ts-jest"
+    },
+    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.ts$",
+    "moduleFileExtensions": [
+      "ts",
+      "js",
+      "json",
+      "node"
+    ]
+  },
   "husky": {
     "hooks": {
       "pre-commit": "lint-staged"
     }
   },
-  "jest": {
-    "collectCoverage": true
-  },
   "prettier": {
     "printWidth": 80,
     "tabWidth": 2,
     "singleQuote": true,
     "semi": false
   },
-  "eslintConfig": {
-    "extends": "@sequencework"
-  },
   "lint-staged": {
-    "*.js": [
-      "prettier --write",
-      "eslint",
-      "git add"
-    ],
-    "*.{json,css,md}": [
+    "*.ts": [
       "prettier --write",
+      "tslint",
       "git add"
     ],
-    "*.ts": [
+    "*.{ts,js,json,css,md}": [
       "prettier --write",
       "git add"
     ]

pg.ts

@@ -0,0 +1,40 @@
+import {
+  IPGQueryable,
+  IPGQueryConfig,
+  IPGQueryResult,
+  TemplateLiteralFunc
+} from './lib/utils'
+import _sql = require('./sql')
+
+type PGSqlHelper<T> = (db: IPGQueryable) => TemplateLiteralFunc<Promise<T>>
+
+type PGSql = TemplateLiteralFunc<IPGQueryConfig> & {
+  query: PGSqlHelper<IPGQueryResult>
+  many: PGSqlHelper<any[]>
+  one: PGSqlHelper<any>
+  count: PGSqlHelper<number>
+}
+
+const sql = ((chains, ...expressions) => _sql(chains, ...expressions)) as PGSql
+
+sql.query = db => (chains, ...expressions) =>
+  db.query(_sql(chains, ...expressions))
+
+sql.one = db => async (chains, ...expressions) => {
+  const {
+    rows: [row]
+  } = await db.query(_sql(chains, ...expressions))
+  return row
+}
+
+sql.many = db => async (chains, ...expressions) => {
+  const { rows } = await db.query(_sql(chains, ...expressions))
+  return rows
+}
+
+sql.count = db => async (chains, ...expressions) => {
+  const { rowCount } = await db.query(_sql(chains, ...expressions))
+  return rowCount
+}
+
+export = sql

readme.md

@@ -11,7 +11,7 @@ Transforms a template literal in an object that can be read by [node-postgres](h
 
 ### Features
 
-- [Typescript friendly](#usage-with-typescript)
+- Written in [Typescript](#usage-with-typescript)
 - Lightweight (less than 50 lines of code)
 - Fully tested (100% coverage)
 - Works with **nested sql tags**

sql.js → sql.ts

@@ -1,4 +1,10 @@
-const sqlText = (count, chains, expressions) => {
+import { IPGQueryConfig, SqlContainer, TemplateLiteralFunc } from './lib/utils'
+
+function sqlText(
+  count: number,
+  chains: ReadonlyArray<string>,
+  expressions: any[]
+): IPGQueryConfig {
   let text = chains[0]
   const values = []
 
@@ -33,17 +39,7 @@ const sqlText = (count, chains, expressions) => {
   }
 }
 
-const sql = (chains, ...expressions) => {
-  const { _sql, text, values } = sqlText(1, chains, expressions)
-  return { _sql, text, values }
-}
-
-class SqlContainer {
-  constructor(chains, expressions, count) {
-    this.chains = chains
-    this.expressions = expressions
-    this.count = count
-  }
-}
+const sql: TemplateLiteralFunc<IPGQueryConfig> = (chains, ...expressions) =>
+  sqlText(1, chains, expressions)
 
-module.exports = sql
+export = sql

test/pg.test.js → test/pg.test.ts

@@ -1,7 +1,8 @@
-const sql = require('../pg')
+import { IPGQueryable } from '../lib/utils'
+import sql = require('../pg')
 
 const sampleBooks = ['book1', 'book2']
-const db = {
+const db: IPGQueryable = {
   query: async ({ text, values }) => {
     if (text === 'select * from books') {
       return { rows: sampleBooks, rowCount: sampleBooks.length }
@@ -10,6 +11,11 @@ const db = {
   }
 }
 
+test('sql should return the query config', async () => {
+  const queryConfig = sql`select * from books`
+  expect(queryConfig._sql).toBeTruthy()
+})
+
 test("sql.query should return pg's query result", async () => {
   const { rows, rowCount } = await sql.query(db)`select * from books`
   expect(rows).toBe(sampleBooks)

test/sql.test.js → test/sql.test.ts

@@ -1,4 +1,4 @@
-const sql = require('../sql')
+import sql = require('../sql')
 
 const trimSpaces = str => str.trim().replace(/\s+/g, ' ')
 

tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "commonjs",
+    "declaration": true
+  },
+  "files": ["sql.ts", "pg.ts"]
+}

tslint.json

@@ -0,0 +1,6 @@
+{
+  "extends": ["tslint:recommended", "tslint-config-prettier"],
+  "rules": {
+    "variable-name": false
+  }
+}