feat: switch to typescript

.editorconfig

@@ -6,4 +6,4 @@ end_of_line = lf
 indent_size = 2
 indent_style = space
 insert_final_newline = true
-trim_trailing_whitespace = true
+trim_trailing_whitespace = true

.eslintrc

@@ -1,7 +1,66 @@
 {
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
   "extends": [
     "canonical",
-    "canonical/flowtype"
+    "canonical/typescript"
   ],
-  "root": true
+  "ignorePatterns": [
+    "dist",
+    "node_modules",
+    "coverage"
+  ],
+  "overrides": [
+    {
+      "files": "*.d.ts",
+      "rules": {
+        "filenames/match-regex": 0,
+        "import/no-default-export": 0,
+        "import/unambiguous": 0
+      }
+    }
+  ],
+  "root": true,
+  "rules": {
+    "@typescript-eslint/ban-ts-comment": 0,
+    "@typescript-eslint/no-empty-function": 0,
+    "@typescript-eslint/no-explicit-any": 0,
+    "@typescript-eslint/no-non-null-assertion": 1,
+    "@typescript-eslint/no-unused-vars": 1,
+    "@typescript-eslint/prefer-ts-expect-error": 1,
+    "@typescript-eslint/array-type": 0,
+    "@typescript-eslint/require-array-sort-compare": 0,
+    "import/no-cycle": 0,
+    "import/no-default-export": 0,
+    "import/no-unresolved": 0,
+    "linebreak-style": 0,
+    "no-continue": 0,
+    "no-extra-parens": 0,
+    "no-restricted-syntax": 0,
+    "no-undef": 0,
+    "no-unused-expressions": [
+      2,
+      {
+        "allowTaggedTemplates": true
+      }
+    ],
+    "no-unused-vars": 0,
+    "object-curly-newline": [
+      2,
+      {
+        "ExportDeclaration": {
+          "minProperties": 1,
+          "multiline": true
+        },
+        "ImportDeclaration": {
+          "minProperties": 1,
+          "multiline": true
+        }
+      }
+    ],
+    "require-await": 0,
+    "unicorn/numeric-separators-style": 0,
+    "unicorn/prevent-abbreviations": 0
+  }
 }

.gitignore

@@ -3,12 +3,11 @@ dist
 node_modules
 *.log
 .*
-!.babelrc
 !.editorconfig
 !.eslintignore
 !.eslintrc
-!.flowconfig
 !.gitignore
 !.npmignore
 !.travis.yml
 !.README
+yarn.lock

.npmignore

@@ -2,4 +2,4 @@ test
 coverage
 .*
 *.log
-!.flowconfig
+!.flowconfig

package.json

@@ -5,50 +5,40 @@
     "url": "http://gajus.com"
   },
   "ava": {
-    "babel": {
-      "compileAsTests": [
-        "test/helpers/**/*"
-      ]
-    },
+    "extensions": [
+      "ts"
+    ],
     "files": [
       "test/slonik-sql-tag-raw/**/*"
     ],
     "require": [
-      "@babel/register"
-    ]
+      "ts-node/register/transpile-only"
+    ],
+    "timeout": "30s"
   },
   "dependencies": {
-    "lodash": "^4.17.15",
-    "roarr": "^2.15.2",
-    "serialize-error": "^6.0.0"
+    "lodash": "^4.17.20",
+    "roarr": "^4.0.1",
+    "serialize-error": "^8.0.0"
   },
   "peerDependencies": {
     "slonik": ">=22.4.4"
   },
   "description": "Slonik SQL tag for constructing dynamic queries.",
   "devDependencies": {
-    "@ava/babel": "^1.0.1",
-    "@babel/cli": "^7.8.4",
-    "@babel/core": "^7.9.0",
-    "@babel/plugin-transform-flow-strip-types": "^7.9.0",
-    "@babel/preset-env": "^7.9.0",
-    "@babel/register": "^7.9.0",
-    "ava": "^3.5.0",
-    "babel-plugin-istanbul": "^6.0.0",
-    "babel-plugin-macros": "^2.8.0",
-    "babel-plugin-transform-export-default-name": "^2.0.4",
-    "coveralls": "^3.0.11",
-    "eslint": "^6.8.0",
-    "eslint-config-canonical": "^19.0.3",
-    "flow-bin": "^0.121.0",
-    "flow-copy-source": "^2.0.9",
-    "husky": "^4.2.3",
-    "inline-loops.macro": "^1.2.2",
-    "nyc": "^15.0.0",
-    "semantic-release": "^17.0.4",
+    "@types/lodash": "^4.14.168",
+    "@types/sinon": "^9.0.10",
+    "ava": "^3.15.0",
+    "coveralls": "^3.1.0",
+    "eslint": "^7.18.0",
+    "eslint-config-canonical": "^25.8.9",
+    "husky": "^4.3.8",
+    "nyc": "^15.1.0",
+    "semantic-release": "^17.3.6",
     "sinon": "^9.0.1",
-    "slonik": "^22.4.4",
-    "eslint-plugin-flowtype": "^5.2.0"
+    "slonik": "^23.5.4",
+    "ts-node": "^9.1.1",
+    "typescript": "^4.1.3"
   },
   "engines": {
     "node": ">=10.0"
@@ -67,23 +57,24 @@
   ],
   "license": "BSD-3-Clause",
   "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "name": "slonik-sql-tag-raw",
   "nyc": {
     "all": true,
     "exclude": [
       "src/bin",
-      "src/queries/*.js"
+      "src/queries/*.ts",
+      "**/*.d.ts"
     ],
     "include": [
-      "src/**/*.js"
+      "src/**/*.ts"
     ],
-    "instrument": false,
     "reporter": [
       "html",
       "text-summary"
     ],
     "require": [
-      "@babel/register"
+      "ts-node/register/transpile-only"
     ],
     "silent": true,
     "sourceMap": false
@@ -93,9 +84,11 @@
     "url": "https://github.com/gajus/slonik-sql-tag-raw"
   },
   "scripts": {
-    "build": "rm -fr ./dist && NODE_ENV=production babel ./src --out-dir ./dist --copy-files --source-maps && flow-copy-source src dist",
-    "lint": "eslint ./src ./test && flow",
-    "test": "NODE_ENV=test nyc ava --verbose --serial"
+    "build": "rm -fr ./dist && tsc -p tsconfig.lib.json",
+    "eslint": "eslint --ext '.ts'",
+    "lint": "npm run eslint ./src ./test && npm run type-check",
+    "test": "NODE_ENV=test nyc ava --verbose",
+    "type-check": "tsc -p ."
   },
   "version": "1.0.1"
 }

src/Logger.js → src/Logger.ts

@@ -1,5 +1,3 @@
-// @flow
-
 import Logger from 'roarr';
 
 export default Logger.child({

src/index.js → src/index.ts

@@ -1,5 +1,3 @@
-// @flow
-
 export {
   raw,
 } from './sqlTags';

src/sqlTags/index.ts

@@ -0,0 +1,3 @@
+export {
+  default as raw,
+} from './raw';

src/sqlTags/raw.ts

@@ -0,0 +1,22 @@
+import type {
+  SqlSqlTokenType,
+  ValueExpressionType,
+} from 'slonik';
+import type {
+  NamedParameterValuesType,
+} from '../types';
+import {
+  interpolatePositionalParameterReferences,
+  interpolateNamedParameterReferences,
+} from '../utilities';
+
+export default (
+  sql: string,
+  values?: NamedParameterValuesType | ReadonlyArray<ValueExpressionType>,
+): SqlSqlTokenType => {
+  if (Array.isArray(values)) {
+    return interpolatePositionalParameterReferences(sql, values as ValueExpressionType[]);
+  } else {
+    return interpolateNamedParameterReferences(sql, values as NamedParameterValuesType);
+  }
+};

src/types.js → src/types.ts

@@ -1,12 +1,10 @@
-// @flow
-
 import type {
   ValueExpressionType,
+  createSqlTokenSqlFragment,
 } from 'slonik';
 
 export type NamedParameterValuesType = {
   [key: string]: ValueExpressionType,
-  ...
 };
 
-export type PositionalParameterValuesType = $ReadOnlyArray<ValueExpressionType>;
+export type PrimitiveValueExpressionType = ReturnType<typeof createSqlTokenSqlFragment>['values'][number];

src/utilities/index.ts

@@ -0,0 +1,6 @@
+export {
+  default as interpolateNamedParameterReferences,
+} from './interpolateNamedParameterReferences';
+export {
+  default as interpolatePositionalParameterReferences,
+} from './interpolatePositionalParameterReferences';

src/utilities/interpolateNamedParameterReferences.js → src/utilities/interpolateNamedParameterReferences.ts

@@ -1,11 +1,12 @@
-// @flow
-
-import {
-  InvalidInputError,
-} from 'slonik';
 import {
   difference,
 } from 'lodash';
+import type {
+  SqlSqlTokenType,
+} from 'slonik';
+import {
+  InvalidInputError,
+} from 'slonik';
 import Logger from '../Logger';
 import type {
   NamedParameterValuesType,
@@ -27,7 +28,7 @@ const namedPlaceholderRegex = /[\s(,]:([_a-z]+)/g;
 export default (
   inputSql: string,
   inputValues: NamedParameterValuesType = {},
-) => {
+): SqlSqlTokenType => {
   const resultValues = [];
   const parameterNames = Object.keys(inputValues);
 
@@ -37,7 +38,7 @@ export default (
     resultValues.push(parameterValue);
   }
 
-  const usedParamterNames = [];
+  const usedParamterNames = [] as string[];
 
   const resultSql = inputSql.replace(namedPlaceholderRegex, (match, g1) => {
     if (!parameterNames.includes(g1)) {
@@ -48,7 +49,7 @@ export default (
 
     const parameterIndex = parameterNames.indexOf(g1) + 1;
 
-    return match.slice(0, -g1.length - 1) + '$' + parameterIndex;
+    return match.slice(0, -g1.length - 1) + `$${parameterIndex}`;
   });
 
   const unusedParameterNames = difference(parameterNames, usedParamterNames);