Generating Types
How to generate types for your API and Supabase libraries.
Supabase APIs are generated from your database, which means that we can use database introspection to generate type-safe API definitions.
Generating types using Supabase CLI#
The Supabase CLI is a single binary Go application that provides everything you need to setup a local development environment.
You can install the CLI via npm or other supported package managers. The minimum required version of the CLI is v1.8.1.
_10npm i supabase@">=1.8.1" --save-dev
Login with your Personal Access Token:
_10npx supabase login
Generate types for your project to produce the types/supabase.ts file:
_10npx supabase gen types typescript --project-id "$PROJECT_REF" --schema public > types/supabase.ts
After you have generated your types, you can use them in src/index.ts
_13import { NextApiRequest, NextApiResponse } from 'next'_13import { createClient } from '@supabase/supabase-js'_13import { Database } from '../types/supabase'_13_13const supabase = createClient<Database>(_13 process.env.NEXT_PUBLIC_SUPABASE_URL,_13 process.env.SUPABASE_SECRET_KEY_13)_13_13export default async (req: NextApiRequest, res: NextApiResponse) => {_13 const allOnlineUsers = await supabase.from('users').select('*').eq('status', 'ONLINE')_13 res.status(200).json(allOnlineUsers)_13}
Update types automatically with GitHub Actions#
One way to keep your type definitions in sync with your database is to set up a GitHub action that runs on a schedule.
Add the script above to your package.json to run it using npm run update-types
_10"update-types": "npx supabase gen types typescript --project-id \"$PROJECT_REF\" > types/supabase.ts"
Create a file .github/workflows/update-types.yml with the following snippet to define the action along with the environment variables. This script will commit new type changes to your repo every night.
_39name: Update database types_39_39on:_39 schedule:_39 # sets the action to run daily. You can modify this to run the action more or less frequently_39 - cron: '0 0 * * *'_39_39jobs:_39 update:_39 runs-on: ubuntu-latest_39 env:_39 SUPABASE_ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}_39 PROJECT_REF: <your-project-id>_39 steps:_39 - uses: actions/checkout@v2_39 with:_39 persist-credentials: false_39 fetch-depth: 0_39 - uses: actions/setup-node@v2.1.5_39 with:_39 node-version: 16_39 - run: npm run update-types_39 - name: check for file changes_39 id: git_status_39 run: |_39 echo "::set-output name=status::$(git status -s)"_39 - name: Commit files_39 if: ${{contains(steps.git_status.outputs.status, ' ')}}_39 run: |_39 git add types/database/index.ts_39 git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"_39 git config --local user.name "github-actions[bot]"_39 git commit -m "Update database types" -a_39 - name: Push changes_39 if: ${{contains(steps.git_status.outputs.status, ' ')}}_39 uses: ad-m/github-push-action@master_39 with:_39 github_token: ${{ secrets.GITHUB_TOKEN }}_39 branch: ${{ github.ref }}
Alternatively, you can use a community-supported GitHub action: generate-supabase-db-types-github-action.