Generate TypeScript Types with Supabase Management API API on New Package Version from npm API

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

Trigger workflow on

New Package Version from the npm API

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#

This integration creates a workflow with a npm trigger and Supabase Management API action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Package Version trigger
1. Connect your npm account
2. Configure timer
3. Configure Package
Configure the Generate TypeScript Types action
1. Connect your Supabase Management API account
2. Select a Project Reference
3. Optional- Configure Included Schemas
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Package Version on npm

Description:Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)

Version:0.0.1

Key:npm-new-package-version

View on GitHub

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import app from "../../npm.app.mjs";

export default {
  key: "npm-new-package-version",
  name: "New Package Version",
  description: "Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      default: "@pipedream/platform",
    },
  },
  async run() {
    const {
      app,
      packageName,
    } = this;

    const response = await app.getPackageMetadata({
      debug: true,
      packageName,
    });

    const { "dist-tags": { latest: latestVersion } } = response;

    this.$emit(response, {
      id: latestVersion,
      summary: `New Package Version ${latestVersion}`,
      ts: Date.parse(response.modified),
    });
  },
};

Trigger 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
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

Action#

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

Action 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;
  },
};

Action Configuration#

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

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

Action 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: