feat: export query path (#98)

* Write module which exports the .sql queries path

* Expose file system helpers too

Co-authored-by: Misha Kaletsky <[email protected]>

Author: mmkal

readme.md

@@ -54,6 +54,15 @@ psql -c "
 psql -f node_modules/plv8-git/queries/create-git-functions.sql
 ```
 
+Or from javascript:
+
+```js
+const sqlClient = getSqlClient()
+
+const sql = require('plv8-git/queries').getGitFunctionsSql()
+await sqlClient.runRawSql(sql)
+```
+
 Note: for `create extension plv8` to work the plv8.control file must exist on your database system. You can use [the postgres-plv8 docker image](https://github.com/clkao/docker-postgres-plv8/tree/master/11-2) for development (or production, if you really want to deploy a containerised database to production). Amazon RDS instances [have the extension available](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html), as does [Azure Postgres 11](https://docs.microsoft.com/en-us/azure/postgresql/concepts-extensions#postgres-11-extensions).
 
 This will have created three postgres functions: `git_track`, `git_log` and `git_resolve`.

scripts/generate-queries.ts

@@ -83,9 +83,29 @@ export const getQuery = (js: string) => {
 
 export const write = (filesystem = fs) => {
   const sql = getQuery(filesystem.readFileSync(require.resolve('..')).toString())
-  const destPath = path.join(__dirname, '../queries/create-git-functions.sql')
-  filesystem.mkdirSync(path.dirname(destPath), {recursive: true})
-  filesystem.writeFileSync(destPath, sql, 'utf8')
+  const queriesDir = path.join(__dirname, '../queries')
+
+  filesystem.mkdirSync(queriesDir, {recursive: true})
+  filesystem.writeFileSync(path.join(queriesDir, 'create-git-functions.sql'), sql, 'utf8')
+  filesystem.writeFileSync(
+    path.join(queriesDir, 'index.js'),
+    `const path = require('path')\n` + //
+      `const fs = require('fs')\n\n` +
+      `exports.gitFunctionsPath = path.join(__dirname, 'create-git-functions.sql')\n\n` +
+      `exports.getGitFunctionsSql = () => fs.readFileSync(exports.createGitFunctionsPath, 'utf8')\n\n` +
+      `exports.getGitFunctionsSqlAsync = () => fs.promises.readFile(exports.createGitFunctionsPath, 'utf8')\n`,
+    'utf8',
+  )
+  filesystem.writeFileSync(
+    path.join(queriesDir, 'index.d.ts'),
+    `/** Path on filesystem to file containing git tracking SQL functions */\n` + //
+      `export const gitFunctionsPath: string\n\n` +
+      `/** Synchronously read the file system to return git tracking SQL functions as a string */\n` +
+      `export const getGitFunctionsSql: () => string\n\n` +
+      `/** Asynchronously read the file system to return git tracking SQL functions as a string */\n` +
+      `export const getGitFunctionsSqlAsync: () => Promise<string>\n`,
+    'utf8',
+  )
 }
 
 if (require.main === module) write()