Generate TypeScript Types with Supabase Management API API

Pipedream makes it easy to connect APIs for Supabase Management API and 2,700+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Generate TypeScript Types with the Supabase Management API API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Generate TypeScript Types with the Supabase Management API API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Generate TypeScript Types action
1. Connect your Supabase Management API account
2. Select a Project Reference
3. Optional- Configure Included Schemas
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Generate TypeScript Types with Supabase Management API API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Supabase Management API

Try it

Generate TypeScript Types with Supabase Management API API on New Submission from Typeform API

Typeform + Supabase Management API

Try it

Generate TypeScript Types with Supabase Management API API on New Submission (Instant) from Jotform API

Jotform + Supabase Management API

Try it

Generate TypeScript Types with Supabase Management API API on New Scheduled Tasks from Pipedream API

Pipedream + Supabase Management API

Try it

Generate TypeScript Types with Supabase Management API API on New Download Counts from npm API

npm + Supabase Management API

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Generate TypeScript Types on Supabase Management API

Description:Generates TypeScript types based on the current database schema for a specified Supabase project. [See the documentation](https://supabase.com/docs/reference/api/v1-generate-typescript-types)

Version:0.0.1

Key:supabase_management_api-generate-typescript-types

View on GitHub

Code#

import supabaseManagementApi from "../../supabase_management_api.app.mjs";

export default {
  key: "supabase_management_api-generate-typescript-types",
  name: "Generate TypeScript Types",
  description: "Generates TypeScript types based on the current database schema for a specified Supabase project. [See the documentation](https://supabase.com/docs/reference/api/v1-generate-typescript-types)",
  version: "0.0.1",
  type: "action",
  props: {
    supabaseManagementApi,
    projectRef: {
      propDefinition: [
        supabaseManagementApi,
        "projectRef",
      ],
    },
    includedSchemas: {
      type: "boolean",
      label: "Included Schemas",
      description: "Schemas to be included in the TypeScript types generation",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.supabaseManagementApi.generateTypescriptTypes({
      $,
      projectRef: this.projectRef,
      params: {
        include_schemas: this.includeSchemas,
      },
    });
    $.export("$summary", `Successfully generated TypeScript types for project ${this.projectRef}`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Supabase Management API	`supabaseManagementApi`	`app`	This component uses the Supabase Management API app.
Project Reference	`projectRef`	`string`	Select a value from the drop down menu.
Included Schemas	`includedSchemas`	`boolean`	Schemas to be included in the TypeScript types generation

Authentication#

Supabase Management API uses OAuth authentication. When you connect your Supabase Management API account, Pipedream will open a popup window where you can sign into Supabase Management API and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Supabase Management API API.

Pipedream requests the following authorization scopes when you connect your account: