Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adrianmjim/nestjs-supabase-js
NestJS Supabase integration
https://github.com/adrianmjim/nestjs-supabase-js
auth authentication database module nestjs postgres storage supabase supabase-auth supabase-db supabase-js supabase-realtime supabase-storage
Last synced: 3 months ago
JSON representation
NestJS Supabase integration
- Host: GitHub
- URL: https://github.com/adrianmjim/nestjs-supabase-js
- Owner: Adrianmjim
- License: mit
- Created: 2024-02-16T19:31:52.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-05-28T06:41:34.000Z (7 months ago)
- Last Synced: 2024-05-28T08:38:39.519Z (7 months ago)
- Topics: auth, authentication, database, module, nestjs, postgres, storage, supabase, supabase-auth, supabase-db, supabase-js, supabase-realtime, supabase-storage
- Language: TypeScript
- Homepage:
- Size: 133 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://codecov.io/gh/Adrianmjim/nestjs-supabase-js)
[](https://npmjs.org/package/nestjs-supabase-js)
[](https://www.npmjs.com/package/nestjs-supabase-js)
## Description
The [Supabase](https://github.com/supabase/supabase-js) module for [NestJS](https://github.com/nestjs/nest).
## Installation
Install the dependencies via `npm`, `pnpm` or `yarn`:
npm:
```bash
$ npm i -s @nestjs/common @supabase/supabase-js nestjs-supabase-js
```
pnpm:
```bash
$ pnpm add @nestjs/common @supabase/supabase-js nestjs-supabase-js
```
yarn:
```bash
$ yarn add @nestjs/common @supabase/supabase-js nestjs-supabase-js
```
## Configuration
First, import the module into your NestJS application and configure it using the configuration key provided by Supabase.
```typescript
import { Module } from '@nestjs/common';
import { SupabaseModule } from 'nestjs-supabase-js';
@Module({
imports: [
SupabaseModule.forRoot({
supabaseKey: 'YOUR_SUPABASE_KEY',
supabaseUrl: 'YOUR_SUPABASE_URL',
}),
],
})
export class AppModule {}
```
Or, You can configure it asynchronously as follows:
```typescript
import { Module } from '@nestjs/common';
import { SupabaseModule } from 'nestjs-supabase-js';
@Module({
imports: [
SupabaseModule.forRootAsync({
imports: [],
inject: [],
useFactory: () => ({
supabaseKey: 'YOUR_SUPABASE_KEY',
supabaseUrl: 'YOUR_SUPABASE_URL',
}),
}),
],
})
export class AppModule {}
```
## Multiple connections
In certain situations, we will need to connect to different Supabase projects, with this module this is possible:
```typescript
import { Module } from '@nestjs/common';
import { SupabaseModule } from 'nestjs-supabase-js';
@Module({
imports: [
SupabaseModule.forRoot([
{
name: 'connection1',
supabaseConfig: {
supabaseKey: 'YOUR_SUPABASE_KEY',
supabaseUrl: 'YOUR_SUPABASE_URL',
},
},
{
name: 'connection2',
supabaseConfig: {
supabaseKey: 'YOUR_SUPABASE_KEY',
supabaseUrl: 'YOUR_SUPABASE_URL',
},
},
]),
],
})
export class AppModule {}
```
Or asynchronously:
```typescript
import { Module } from '@nestjs/common';
import { SupabaseModule } from 'nestjs-supabase-js';
@Module({
imports: [
SupabaseModule.forRootAsync({
imports: [],
inject: [],
useFactory: () => ([
{
name: 'connection1',
supabaseConfig: {
supabaseKey: 'YOUR_SUPABASE_KEY',
supabaseUrl: 'YOUR_SUPABASE_URL',
},
},
{
name: 'connection2',
supabaseConfig: {
supabaseKey: 'YOUR_SUPABASE_KEY',
supabaseUrl: 'YOUR_SUPABASE_URL',
},
},
]),
}),
],
})
export class AppModule {}
```
## Usage
First, inject the client into the module where you want to use it:
```typescript
import { Module } from '@nestjs/common';
import { SupabaseModule } from 'nestjs-supabase-js';
@Module({
imports: [
SupabaseModule.injectClient(),
],
})
export class CatModule {}
```
Or, for a specific connection:
```typescript
import { Module } from '@nestjs/common';
import { SupabaseModule } from 'nestjs-supabase-js';
@Module({
imports: [
SupabaseModule.injectClient('connection1', 'connection2'),
],
})
export class CatModule {}
```
Now you can use the Supabase client in any provider of your module:
```typescript
import { SupabaseClient } from '@supabase/supabase-js';
export class CatService {
constructor(private readonly supabaseClient: SupabaseClient) {}
public doSomething(): void {
}
}
```
Or, for a specific connection:
```typescript
import { SupabaseClient } from '@supabase/supabase-js';
import { InjectSupabaseClient } from 'nestjs-supabase-js';
export class CatService {
constructor(
@InjectSupabaseClient('connection1') private readonly supabaseClient1: SupabaseClient,
@InjectSupabaseClient('connection2') private readonly supabaseClient2: SupabaseClient,
) {}
public doSomething(): void {
}
}
```
It's also possible to use the InjectSupabaseClient decorator to inject the Supabase client when you don't want to explicitly type it with the client:
```typescript
import { SupabaseClient } from '@supabase/supabase-js';
import { InjectSupabaseClient } from 'nestjs-supabase-js';
export class CatService {
constructor(
@InjectSupabaseClient() private readonly supabaseClient: unknown,
) {}
public doSomething(): void {
}
}
```
## 🤝 Contributing [](https://github.com/adrianmjim/nestjs-supabase-js/issues)
Contributions, issues and feature requests are welcome.
## Authors
👤 **Adrián Martínez Jiménez**
- Github: [@adrianmjim](https://github.com/adrianmjim)
See also the list of contributors who [participated](https://github.com/adrianmjim/nestjs-supabase-js/contributors) in this project.
## Show Your Support
Please ⭐️ this repository if this project helped you!
## 📝 License
Copyright © 2024 [Adrián Martínez Jiménez](https://github.com/adrianmjim).
This project is licensed under the MIT License - see the [LICENSE file](LICENSE) for details.