Migrating to the 1.0 SDK

Create an OAuth client

Follow the instructions here to create an OAuth client.

Update your SDK version

Change the @pipedream/sdk version in your package.json:

{
  "dependencies": {
    "@pipedream/sdk": "^1.0.0"
  }
}

Then run

npm install

Update your project key references to use your OAuth client

You may have been referencing project keys in environment variables or other config. Replace these with references to the OAuth client you created in step 1.

For example, process.env.PIPEDREAM_PROJECT_KEY should be replaced with process.env.PIPEDREAM_OAUTH_CLIENT_ID, and process.env.PIPEDREAM_PROJECT_SECRET should be replaced with process.env.PIPEDREAM_OAUTH_CLIENT_SECRET.

Update your SDK code

Frontend client

You’ll need to make two changes to your frontend client code:

1. Replace references to @pipedream/sdk/browser. Instead, import directly from @pipedream/sdk.
2. Change the createClient method to createFrontendClient.

import { createFrontendClient } from "@pipedream/sdk/browser"
const pd = createFrontendClient()

Backend client

You’ll need to make three changes to your backend code:

1. Change the createClient method to createBackendClient.
2. Pass your OAuth client ID and secret to the createBackendClient method, removing references to project keys.
3. Change any token create method references from connectTokenCreate to createConnectToken.

import { createBackendClient, HTTPAuthType } from "@pipedream/sdk/server";
 
// These secrets should be saved securely and passed to your environment
const pd = createBackendClient({
  credentials: {
    clientId: "YOUR_CLIENT_ID",
    clientSecret: "YOUR_CLIENT_SECRET",
  },
});

import { createBackendClient } from "@pipedream/sdk/server";
 
// These secrets should be saved securely and passed to your environment
const pd = createBackendClient({
  credentials: {
    clientId: "YOUR_CLIENT_ID",
    clientSecret: "YOUR_CLIENT_SECRET",
  },
});