@triptease/sql-template 0.20.21 → 0.24.25

package/Identifier.d.ts

@@ -1,7 +1,7 @@
 import { Expression } from "./Expression";
 import { Template } from "./Template";
 export declare class Identifier extends Expression {
-    identifier: string;
+    readonly identifier: string;
     constructor(identifier: string);
 }
 export declare function id(identifier: string): Identifier;

package/README.md

@@ -6,24 +6,51 @@ This is yet another SQL tagged template for Typescript/Javascript
 
 * Typescript first
 * Functional/Immutable
-* Super simple implementaion (the main SQL function is [3 lines of code](https://github.com/triptease/sql-template/blob/master/sql-template/src/SQL.ts#L5))
-* Plugable to any DB (currently has a Postgres function in @triptease\sql-template-postgres)
+* 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
 
-```
-npm install @triptease\sql-template @triptease\sql-template-postgres
+```shell
+npm install @triptease/sql-template @triptease/sql-template-postgres
 ```
 
 ## Usage
 
-```
-import {SQL} from "@triptease/sql-template";
+```javascript
+import {SQL, id} from "@triptease/sql-template";
 import {statement} from "@triptease/sql-template-postgres";
 
-pg.query(statement(SQL`select * from user where name = ${name}`));
-
+client.query(statement(SQL`select * from ${id(table)} where name = ${name}`));
 ```
 
-WIP more to come
+## 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/Template.d.ts

@@ -1,6 +1,6 @@
 import { Expression } from "./Expression";
 export declare class Template extends Expression {
-    expressions: Expression[];
-    constructor(expressions: Expression[]);
+    readonly expressions: ReadonlyArray<Expression>;
+    constructor(expressions: ReadonlyArray<Expression>);
 }
 export declare function template(...expressions: Expression[]): Template;

package/Text.d.ts

@@ -1,6 +1,6 @@
 import { Expression } from "./Expression";
 export declare class Text extends Expression {
-    text: string;
+    readonly text: string;
     constructor(text: string);
 }
 export declare function text(text: string): Text;

package/Value.d.ts

@@ -1,7 +1,7 @@
 import { Expression } from "./Expression";
 import { Template } from "./Template";
 export declare class Value extends Expression {
-    value: any;
+    readonly value: any;
     constructor(value: any);
 }
 export declare function value(value: any): Expression;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@triptease/sql-template",
-  "version": "0.20.21",
+  "version": "0.24.25",
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/triptease/sql-template.git"
@@ -23,5 +23,5 @@
     "tslib": "^2.3.1"
   },
   "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 implementaion (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* Plugable to any DB (currently has a Postgres function in @triptease\\sql-template-postgres)\r\n* Automatic support for prepareStatement naming (Postgres)\r\n\r\n## Installation\r\n\r\n```\r\nnpm install @triptease\\sql-template @triptease\\sql-template-postgres\r\n```\r\n\r\n## Usage\r\n\r\n```\r\nimport {SQL} from \"@triptease/sql-template\";\r\nimport {statement} from \"@triptease/sql-template-postgres\";\r\n\r\npg.query(statement(SQL`select * from user where name = ${name}`));\r\n\r\n```\r\n\r\nWIP more to come\r\n"
+  "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"
 }