# @ty-ras-extras/typed-sql-io-ts

> Execute SQL queries in `fp-ts` style, exposing compile-time and runtime validation for both input and output of the queries.

Latest version **2.0.0** (published 2023-08-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ty-ras-extras/typed-sql-io-ts
pnpm add @ty-ras-extras/typed-sql-io-ts
yarn add @ty-ras-extras/typed-sql-io-ts
bun add @ty-ras-extras/typed-sql-io-ts
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2023-08-09 |
| First published | 2023-01-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 85 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Stanislav Muhametsin |
| Maintainers | staz |

## Links

- npm: https://www.npmjs.com/package/@ty-ras-extras/typed-sql-io-ts
- Repository: https://github.com/ty-ras/extras-io-ts
- Homepage: https://github.com/ty-ras/extras-io-ts#readme
- Issues: https://github.com/ty-ras/extras-io-ts/issues
- npm.io page: https://npm.io/package/@ty-ras-extras/typed-sql-io-ts

## Recent versions

- 2.0.0 (latest) — 2023-08-09
- 1.0.2 — 2023-05-27
- 1.0.1 — 2023-05-27
- 1.0.0 — 2023-05-26
- 0.13.2 — 2023-02-21
- 0.13.1 — 2023-01-22
- 0.13.0 — 2023-01-09

## README

# Typesafe REST API Specification Extras - Typed SQL Query Execution With IO-TS

[![Coverage](https://codecov.io/gh/ty-ras/extras-io-ts/branch/main/graph/badge.svg?flag=typed-sql)](https://codecov.io/gh/ty-ras/extras-io-ts)

This folder contains `@ty-ras-extras/typed-sql-io-ts` library which exposes API to create callbacks which will execute SQL queries against a parametrizable client.
These callbacks will expose the input signature at compile-time utilizing custom template functions, as well as compile-time types for query result.
In addition to that, the callbacks will perform runtime validation using [`io-ts`](https://github.com/gcanti/io-ts) library on inputs to the query, as well as output of the query execution rows returned by client.

The callbacks are built in such way that they are easy to use with [`fp-ts`](https://github.com/gcanti/fp-ts) `pipe` and `flow`:

| ![Animation of Usage of the Library](https://raw.githubusercontent.com/ty-ras/extras-io-ts/main/typed-sql/doc/usage-demo.gif) |
| :---------------------------------------------------------------------------------------------------------------------------: |
|       Short animation about how the library can be used. Notice that now `executeSQLQuery` is renamed to `prepareSQL`.        |

In the demo above, the final SQL query that would be sent to PostgreSQL server, would have been parameterized query `SELECT payload FROM things WHERE id = $1`, and the `id` parameter visible as second argument after `client` would be passed as a parameter.
Thus, even though it looks like the parameters are embedded in query and are a risk for SQL injection, they are not embedded in the query, and instead are sent separately, and there is no risk for SQL injection.

Furthermore, the call to `sql.prepareSQL` captures all the names and types of input parameters, thus allowing intellisense to auto-complete the query parameters.
The returned rows of the query are then validated to contain only one row using `sql.validateRows` and `sql.one` invocation, again extracting the compile-time return type of the query for intellisense and other benefits.
All the input parameters and query output rows are also validated to adher to their corresponding types at **runtime** using `io-ts` library, seen in the demo as import alias `t`.

---
_Source: https://npm.io/package/@ty-ras-extras/typed-sql-io-ts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._