sqyrl 0.0.2

package/README.md

@@ -0,0 +1,54 @@
+# sqyrl
+
+<p align="center">
+  <img src="https://cdn.jsdelivr.net/gh/carderne/sqyrl@main/docs/logo.png" alt="sqyrl logo" width="200">
+</p>
+
+Sanitise agent-written SQL for multi-tenant DBs.
+
+## Quickstart
+
+```bash
+npm install sqyrl
+```
+
+```ts
+import { sqyrl } from "sqyrl";
+
+const sql = sqyrl(`SELECT id, name FROM public.users WHERE status = 'active' LIMIT 10`, {
+  schema: "public",
+  table: "users",
+  column: "tenant_id",
+  value: "acme",
+});
+
+console.log(sql);
+// SELECT id, name FROM public.users WHERE public.users.tenant_id = 'acme' AND status = 'active' LIMIT 10
+```
+
+`sqyrl` parses the SQL, enforces a mandatory equality filter on the given column as the outermost `AND` condition (so it cannot be short-circuited by agent-supplied `OR` clauses), and returns the sanitised SQL string.
+
+## Ideas
+
+- Inspiration: https://x.com/thomas_ankcorn/status/2033931057133748330
+- Grammar ideas: https://github.com/iamwilhelm/ohm-grammar-sql
+
+## Development
+
+Install dependencies:
+
+```bash
+vp install
+```
+
+Run the unit tests:
+
+```bash
+vp test
+```
+
+Build the library:
+
+```bash
+vp pack
+```

package/dist/index.d.mts

@@ -0,0 +1,78 @@
+//#region src/ast.d.ts
+interface SelectStatement {
+  type: "select";
+  columns: Column[];
+  from: TableRef;
+  where: WhereExpr | null;
+  limit: number | null;
+}
+type WhereExpr = WhereAnd | WhereOr | WhereComparison;
+interface WhereAnd {
+  type: "and";
+  left: WhereExpr;
+  right: WhereExpr;
+}
+interface WhereOr {
+  type: "or";
+  left: WhereExpr;
+  right: WhereExpr;
+}
+interface WhereComparison {
+  type: "comparison";
+  operator: "=";
+  column: ColumnRefNode;
+  value: string;
+}
+interface ColumnRefNode {
+  type: "column_ref";
+  table?: string;
+  name: string;
+}
+interface Column {
+  type: "wildcard" | "qualified_wildcard" | "qualified" | "simple";
+  table?: string;
+  name?: string;
+  alias?: string;
+}
+interface TableRef {
+  type: "table";
+  schema?: string;
+  name: string;
+  alias?: string;
+}
+//#endregion
+//#region src/output.d.ts
+declare function outputSql(ast: SelectStatement): string;
+//#endregion
+//#region src/parse.d.ts
+declare function parseSql(expr: string): SelectStatement;
+//#endregion
+//#region src/sanitise.d.ts
+declare function sanitiseSql({
+  ast,
+  schema,
+  table,
+  col,
+  value
+}: {
+  ast: SelectStatement;
+  schema: string;
+  table: string;
+  col: string;
+  value: string;
+}): SelectStatement;
+//#endregion
+//#region src/index.d.ts
+declare function sqyrl(expr: string, {
+  schema,
+  table,
+  column,
+  value
+}: {
+  schema: string;
+  table: string;
+  column: string;
+  value: string;
+}): string;
+//#endregion
+export { outputSql, parseSql, sanitiseSql, sqyrl };