@triptease/sql-template-postgres 0.18.16 → 0.21.22

package/README.md

@@ -0,0 +1,56 @@
+# Sql Template
+
+This is yet another SQL tagged template for Typescript/Javascript
+
+## Why another library?
+
+* Typescript first
+* Functional/Immutable
+* Super simple implementation (the main SQL function is [3 lines of code](https://github.com/triptease/sql-template/blob/master/sql-template/src/SQL.ts#L5))
+* Full escaping of identifiers and values
+* Plugable to any DB (currently only Postgres @triptease\sql-template-postgres )
+* Automatic support for prepareStatement naming (Postgres)
+
+## Installation
+
+```shell
+npm install @triptease\sql-template @triptease\sql-template-postgres
+```
+
+## Usage
+
+```javascript
+import {SQL, id} from "@triptease/sql-template";
+import {statement} from "@triptease/sql-template-postgres";
+
+client.query(statement(SQL`select * from ${id(table)} where name = ${name}`));
+```
+
+## Cheatsheet
+
+### Core (@triptease/sql-template) 
+
+| function                                       | Description                                                          |
+|------------------------------------------------|----------------------------------------------------------------------|
+| `SQL`                                          | The main function to create tagged templates for SQL (*DB agnostic*) |
+| `text` (alias `raw`)                           | Input raw SQL without any escaping (*use with care*)                 |
+ | `id` / `ids`                                   | Input dynamic identifiers into SQL (*escaped as needed*)             |
+ | `value` (optional) / `values` (alias `spread`) | Input one or more values into SQL (*escaped as needed*)              |
+
+
+### Postgres (@triptease/sql-template-postgres)
+
+| function                                       | Description                                                         |
+|------------------------------------------------|---------------------------------------------------------------------|
+| `statement`                                    | Converts DB agnostic `SQL` template into postgres statement         |
+| `prepareStatement`                             | Converts DB agnostic `SQL` template into postgres prepare statement |
+| `debugQuery`                                   | Used to debug a query (*use with care*)                             |
+
+*use with care -> Used incorrectly you can open yourself up to SQL injection*
+
+
+### Extending
+
+It is incredibly simple to extend to other DBs, have a look at the [postgres implementation](https://github.com/triptease/sql-template/blob/master/sql-template-postgres/src/index.ts#L17). 
+
+

package/index.d.ts

@@ -1,5 +1,5 @@
 import { QueryConfig } from "pg";
 import { Template } from '@triptease/sql-template';
 export declare function debugQuery(sql: Template): string;
-export declare function postgresSql(sql: Template): string;
-export declare function query(template: Template): QueryConfig;
+export declare function statement(template: Template): QueryConfig;
+export declare function prepareStatement(template: Template, name?: string): QueryConfig;

package/index.js

@@ -1,40 +1,52 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.query = exports.postgresSql = exports.debugQuery = void 0;
+exports.prepareStatement = exports.statement = exports.debugQuery = void 0;
 const pg_1 = require("pg");
+const crypto_1 = require("crypto");
 const sql_template_1 = require("@triptease/sql-template");
 const escapeIdentifier = pg_1.Client.prototype.escapeIdentifier;
 const escapeLiteral = pg_1.Client.prototype.escapeLiteral;
 function debugQuery(sql) {
-    return sql.expressions.flatMap(e => {
+    return sql.expressions.reduce((a, e) => {
         if (e instanceof sql_template_1.Text)
-            return [e.text];
+            return a + e.text;
         if (e instanceof sql_template_1.Identifier)
-            return [escapeIdentifier(e.identifier)];
+            return a + escapeIdentifier(e.identifier);
         if (e instanceof sql_template_1.Value)
-            return [typeof e.value === 'string' ? escapeLiteral(e.value) : e.value];
-        return [];
-    }).join('');
+            return a + (typeof e.value === 'string' ? escapeLiteral(e.value) : e.value);
+        return a;
+    }, '');
 }
 exports.debugQuery = debugQuery;
-function postgresSql(sql) {
+function toSql(sql) {
     let count = 1;
-    return sql.expressions.flatMap(e => {
+    return sql.expressions.reduce((a, e) => {
         if (e instanceof sql_template_1.Text)
-            return [e.text];
+            return a + e.text;
         if (e instanceof sql_template_1.Identifier)
-            return [escapeIdentifier(e.identifier)];
+            return a + escapeIdentifier(e.identifier);
         if (e instanceof sql_template_1.Value)
-            return '$' + count++;
-        return [];
-    }).join('');
+            return a + '$' + count++;
+        return a;
+    }, '');
 }
-exports.postgresSql = postgresSql;
-function query(template) {
+function statement(template) {
     return {
-        text: postgresSql(template),
+        text: toSql(template),
         values: template.expressions.flatMap(e => e instanceof sql_template_1.Value ? [e.value] : [])
     };
 }
-exports.query = query;
+exports.statement = statement;
+function hashSHA256(value) {
+    return (0, crypto_1.createHash)('sha256').update(value).digest('hex');
+}
+function prepareStatement(template, name) {
+    const { text, values } = statement(template);
+    return {
+        name: name !== null && name !== void 0 ? name : `urn:hash::sha256:${hashSHA256(text)}`,
+        text,
+        values
+    };
+}
+exports.prepareStatement = prepareStatement;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@triptease/sql-template-postgres",
-  "version": "0.18.16",
+  "version": "0.21.22",
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/triptease/sql-template.git"
@@ -20,12 +20,13 @@
     "*.d.ts"
   ],
   "dependencies": {
-    "@triptease/sql-template": "0.18.16",
+    "@triptease/sql-template": "0.21.22",
     "pg": "^8.7.1",
     "tslib": "^2.3.1"
   },
   "devDependencies": {
     "@types/pg": "^8.6.4"
   },
-  "scripts": {}
+  "scripts": {},
+  "readme": "# Sql Template\r\n\r\nThis is yet another SQL tagged template for Typescript/Javascript\r\n\r\n## Why another library?\r\n\r\n* Typescript first\r\n* Functional/Immutable\r\n* Super simple implementation (the main SQL function is [3 lines of code](https://github.com/triptease/sql-template/blob/master/sql-template/src/SQL.ts#L5))\r\n* Full escaping of identifiers and values\r\n* Plugable to any DB (currently only Postgres @triptease\\sql-template-postgres )\r\n* Automatic support for prepareStatement naming (Postgres)\r\n\r\n## Installation\r\n\r\n```shell\r\nnpm install @triptease\\sql-template @triptease\\sql-template-postgres\r\n```\r\n\r\n## Usage\r\n\r\n```javascript\r\nimport {SQL, id} from \"@triptease/sql-template\";\r\nimport {statement} from \"@triptease/sql-template-postgres\";\r\n\r\nclient.query(statement(SQL`select * from ${id(table)} where name = ${name}`));\r\n```\r\n\r\n## Cheatsheet\r\n\r\n### Core (@triptease/sql-template) \r\n\r\n| function                                       | Description                                                          |\r\n|------------------------------------------------|----------------------------------------------------------------------|\r\n| `SQL`                                          | The main function to create tagged templates for SQL (*DB agnostic*) |\r\n| `text` (alias `raw`)                           | Input raw SQL without any escaping (*use with care*)                 |\r\n | `id` / `ids`                                   | Input dynamic identifiers into SQL (*escaped as needed*)             |\r\n | `value` (optional) / `values` (alias `spread`) | Input one or more values into SQL (*escaped as needed*)              |\r\n\r\n\r\n### Postgres (@triptease/sql-template-postgres)\r\n\r\n| function                                       | Description                                                         |\r\n|------------------------------------------------|---------------------------------------------------------------------|\r\n| `statement`                                    | Converts DB agnostic `SQL` template into postgres statement         |\r\n| `prepareStatement`                             | Converts DB agnostic `SQL` template into postgres prepare statement |\r\n| `debugQuery`                                   | Used to debug a query (*use with care*)                             |\r\n\r\n*use with care -> Used incorrectly you can open yourself up to SQL injection*\r\n\r\n\r\n### Extending\r\n\r\nIt is incredibly simple to extend to other DBs, have a look at the [postgres implementation](https://github.com/triptease/sql-template/blob/master/sql-template-postgres/src/index.ts#L17). \r\n\r\n\r\n"
 }