btglr/better-supabase-types

Better Supabase Types

A CLI tool to add exports for your supabase tables. It will add type exports at the bottom of a new typescript file of every table you have. This tool can help remove the need to make a type for their rows manually.

Before 📉

import { Database } from './src/schema.ts';

type Todo = Database['public']['Tables']['Todo']['Row'];

const todos: Todo[] = [];

After 📈

import { Todo } from './src/newSchema.ts';

const todos: Todo[] = [];

Usage 🔨

1. First have your supabase typescript file generated Supabase Docs

npx supabase gen types typescript --linked --schema public > ./src/schema.ts

2. Run the better-supabase-types command (you can also use a config file):

npx better-supabase-types -i ./src/schema.ts -o ./src/newSchema.ts

Overwrite input file ↩️

If you would like to overwrite the input file with the better types output, you must supply the force flag (-f) to the generate command:

npx better-supabase-types -i ./src/schema.ts -f

Using Prettier Config 🎨

If your project uses prettier this tool will automattically read it from your .prettierrc file! In the case that your prettier config file is not in the root of your project or is named .prettierrc, you can supply a value to the flag like this:

npx better-supabase-types -i ./src/schema.ts -o ./src/newSchema.ts -p ./configs/.prettierrc.yaml

Creating singular model type names from plural table names

If you use the common naming pattern of having plural table names, it can be confusing when the model type is also a plural, as it gives the impression that it represents more than one record. You can ask better-supabase-types to transform the model type name into the singular form (using the pluralize library) with the singular flag (-s). By default this is set to false (turned off).

npx better-supabase-types -i ./src/schema.ts -o ./src/newSchema.ts -s

Example schema output with the singular flag turned on:

export type Account = Database['public']['Tables']['accounts']['Row'];
export type InsertAccount = Database['public']['Tables']['accounts']['Insert'];
export type UpdateAccount = Database['public']['Tables']['accounts']['Update'];

Config file ⚙

You can also use a config named .betterrc.json:

{
  "input": "./src/schema.ts",
  "force": true,
  "singular": true
}

package.json 📦

You can also put your config file in your package.json file:

{
  "name": "better-supabase-types",
  "...": "...",
  "betterConfig": {
    "input": "./schema.ts",
    "output": "./newSchema.ts"
  }
}

Contributions ➕

Please contribute to this if you find any bugs or want any additions. This is my first public package so please bear with me if there are any issues.

Thanks 🙏

Big thanks to Barry for making the Supabase React Query Codegen tool to help me understand on how to read the supabase type file.