Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sandromaglione/supabase-ts
Use supabase with Functional Programming and fp-ts
https://github.com/sandromaglione/supabase-ts
fp-ts functional-programming io-ts javascript supabase supabase-js typescript
Last synced: 8 days ago
JSON representation
Use supabase with Functional Programming and fp-ts
- Host: GitHub
- URL: https://github.com/sandromaglione/supabase-ts
- Owner: SandroMaglione
- License: mit
- Created: 2021-09-17T12:57:38.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2021-11-27T15:54:50.000Z (almost 3 years ago)
- Last Synced: 2024-10-12T02:41:18.810Z (about 1 month ago)
- Topics: fp-ts, functional-programming, io-ts, javascript, supabase, supabase-js, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/supabase-ts
- Size: 218 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# `supabase-ts`
What happens when the type of the response from a supabase request is different from expected? We don't want our app to crash, do we?
Welcome `supabase-ts`!
Make request to [supabase](https://supabase.io/) using the power of [fp-ts](https://gcanti.github.io/fp-ts/), [io-ts](https://gcanti.github.io/io-ts/), and parsing.
Use [supabase](https://supabase.io/) with Functional Programming and [fp-ts](https://gcanti.github.io/fp-ts/).
## Getting started
```shell
npm install supabase-ts
```
Extend your usual `SupabaseClient` using `createClientIO` from `supabase-ts`.
`createClientIO` accepts two generic types:
- A union of `string` with the names of all the tables/views of your database. `supabase-ts` will enforce the correct table names, no more typos!
- The default request error type
```ts
import { createClient } from '@supabase/supabase-js';
import { createClientIO } from 'supabase-ts';
// Enforce tables and views names
type SupabaseTable = 'table1' | 'table2';
type SupabaseView = 'view1' | 'view2';
// Define default request error type
type ErrorMessage = string;
const supabaseClient = createClient('URL', 'KEY');
export const supabase = createClientIO(supabaseClient);
```
Use the exported `supabase` client to perform requests:
- `requestListWithValidation`: Perform a request to supabase and return a list of values.
- `requestSingleWithValidation`: Perform a request to supabase and return a single value.
For every request you must provide an [`io-ts`](https://github.com/gcanti/io-ts) type used to validate the response from supabase. `supabase-ts` will make sure that the shape of the return data respects the defined schema from `io-ts`.
```ts
const schema = t.type({ name: t.string });
type Schema = t.TypeOf;
const tableValidated = {
name: 'table1', // Required to be `string` from `SupabaseTable | SupabaseView`!
schema,
} as const; // Required to be `const` for type-safety
const responseList: TE.TaskEither =
supabaseClientIO.requestListWithValidation(tableValidated)(
(query) => query.select(),
{
// Handle all possible errors
onNoDataError: () => '',
onRequestError: () => '',
onValidationError: () => '',
}
);
const responseSingle: TE.TaskEither =
supabaseClientIO.requestSingleWithValidation(tableValidated)(
(query) => query.select(),
{
// Handle all possible errors
onZeroData: () => '',
onNoDataError: () => '',
onRequestError: () => '',
onValidationError: () => '',
}
);
```
## 📃 Versioning
- `v0.2.1` - 27 November 2021
- `v0.1.3` - 24 September 2021
- `v0.1.2` - 18 September 2021
- `v0.1.1` - 17 September 2021
- `v0.1.0` - 17 September 2021
## 😀 Support
Currently the best way to support me would be to follow me on my [**Twitter**](https://twitter.com/SandroMaglione).
Another option (or `Option`) would be to buy me a coffee.
## 👀 License
MIT License, see the [LICENSE.md](https://github.com/SandroMaglione/supabase-ts/blob/main/LICENSE) file for details.