AppId -> AppNameSlug

Correcting external user ID method.

Correcting API request base method to handle authType

Author: dylburger

packages/sdk/src/browser/index.ts

@@ -20,19 +20,10 @@ type CreateBrowserClientOpts = {
 };
 
 /**
- * A unique identifier for an app.
+ * The name slug for an app, a unique, human-readable identifier like "github" or "google_sheets".
+ * Find this in the Authentication section for any app's page at https://pipedream.com/apps
  */
-type AppId = string;
-
-/**
- * Object representing an app to start connecting with.
- */
-type StartConnectApp = {
-  /**
-   * The unique identifier of the app.
-   */
-  id: AppId;
-};
+type AppNameSlug = string;
 
 /**
  * The result of a successful connection.
@@ -61,7 +52,7 @@ type StartConnectOpts = {
   /**
    * The app to connect to, either as an ID or an object containing the ID.
    */
-  app: AppId | StartConnectApp;
+  app: AppNameSlug;
 
   /**
    * The OAuth app ID to connect to.

packages/sdk/src/server/__tests__/server.test.ts

@@ -21,18 +21,6 @@ describe("ServerClient", () => {
       const client = createClient(params);
       expect(client).toBeInstanceOf(ServerClient);
     });
-
-    it("should mock the createClient method with a project object and return a ServerClient instance", () => {
-      const params = {
-        project: {
-          publicKey: "test-public-key",
-          secretKey: "test-secret",
-        },
-      };
-
-      const client = createClient(params);
-      expect(client).toBeInstanceOf(ServerClient);
-    });
   });
 
   describe("makeRequest", () => {
@@ -576,7 +564,7 @@ describe("ServerClient", () => {
   });
 
   describe("invokeWorkflow", () => {
-    it("should invoke a workflow with provided URL and body", async () => {
+    it("should invoke a workflow with provided URL and body, with no auth type", async () => {
       // Create a mock oauthClient
       const getTokenMock = jest.fn().mockResolvedValue({
         token: {
@@ -592,10 +580,8 @@ describe("ServerClient", () => {
       // Inject the mock oauthClient into the ServerClient instance
       const client = new ServerClient(
         {
-          project: {
-            publicKey: "test-public-key",
-            secretKey: "test",
-          },
+          publicKey: "test-public-key",
+          secretKey: "test",
           oauth: {
             clientId: "test-client-id",
             clientSecret: "test-client-secret",
@@ -632,7 +618,8 @@ describe("ServerClient", () => {
             foo: "bar",
           }),
           headers: expect.objectContaining({
-            Authorization: "Bearer mocked-oauth-token",
+            "Content-Type": "application/json",
+            "X-PD-Environment": "production",
           }),
         }),
       );
@@ -667,10 +654,8 @@ describe("ServerClient", () => {
 
       const client = new ServerClient(
         {
-          project: {
-            publicKey: "test-public-key",
-            secretKey: "test",
-          },
+          publicKey: "test-public-key",
+          secretKey: "test",
           oauth: {
             clientId: "test-client-id",
             clientSecret: "test-client-secret",
@@ -738,10 +723,8 @@ describe("ServerClient", () => {
       } as unknown as ClientCredentials;
       client = new ServerClient(
         {
-          project: {
-            publicKey: "test-public-key",
-            secretKey: "test",
-          },
+          publicKey: "test-public-key",
+          secretKey: "test",
           oauth: {
             clientId: "test-client-id",
             clientSecret: "test-client-secret",
@@ -751,7 +734,7 @@ describe("ServerClient", () => {
       );
     });
 
-    it("should include externalUserId and publicKey headers", async () => {
+    it("should include externalUserId and environment headers", async () => {
       fetchMock.mockResponseOnce(
         JSON.stringify({
           result: "workflow-response",
@@ -778,7 +761,7 @@ describe("ServerClient", () => {
         expect.objectContaining({
           headers: expect.objectContaining({
             "X-PD-External-User-ID": "external-user-id",
-            "X-PD-Project-Public-Key": "test-public-key",
+            "X-PD-Environment": "production",
           }),
         }),
       );
@@ -791,18 +774,6 @@ describe("ServerClient", () => {
         },
       })).rejects.toThrow("External user ID is required");
     });
-
-    it("should throw error when publicKey is missing", async () => {
-      const clientWithoutPublicKey = new ServerClient({
-        secretKey: "test-secret-key",
-      });
-
-      await expect(clientWithoutPublicKey.invokeWorkflowForExternalUser("https://example.com/workflow", "external-user-id", {
-        body: {
-          foo: "bar",
-        },
-      })).rejects.toThrow("Project public key is required to map the external user ID to the correct project");
-    });
   });
 
 });

packages/sdk/src/server/index.ts

@@ -7,9 +7,13 @@ import {
   ClientCredentials,
 } from "simple-oauth2";
 
-export type ProjectKeys = {
-  publicKey: string;
-  secretKey: string;
+export type Project = {
+  id: string;
+};
+
+export type ProjectEnvironment = {
+  project: Project;
+  environment: string;
 };
 
 export type PipedreamOAuthClient = {
@@ -34,6 +38,11 @@ export type CreateServerClientOpts = {
    */
   secretKey?: string;
 
+  /**
+   * The environment in which the server client is running (e.g., "production", "development").
+   */
+  environment?: string;
+
   /**
    * @deprecated Use the `oauth` object instead.
    * The client ID of your workspace's OAuth application.
@@ -46,11 +55,6 @@ export type CreateServerClientOpts = {
    */
   oauthClientSecret?: string;
 
-  /**
-   * The project object, containing publicKey and secretKey.
-   */
-  project?: ProjectKeys;
-
   /**
    * The OAuth object, containing client ID and client secret.
    */
@@ -62,6 +66,15 @@ export type CreateServerClientOpts = {
   apiHost?: string;
 };
 
+/**
+ * Different types of ways customers can authorize requests to HTTP endpoints
+ */
+export enum HTTPAuthType {
+  None = "none",
+  StaticBearer = "static-bearer",
+  OAuth = "oauth"
+}
+
 /**
  * Options for creating a Connect token.
  */
@@ -136,7 +149,7 @@ export type ConnectParams = {
 /**
  * The authentication type for the app.
  */
-export enum AuthType {
+export enum AppAuthType {
   OAuth = "oauth",
   Keys = "keys",
   None = "none",
@@ -164,7 +177,7 @@ export type AppResponse = {
   /**
    * The authentication type used by the app.
    */
-  auth_type: AuthType;
+  auth_type: AppAuthType;
 
   /**
    * The URL to the app's logo.
@@ -322,6 +335,7 @@ export function createClient(opts: CreateServerClientOpts) {
 export class ServerClient {
   private secretKey?: string;
   private publicKey?: string;
+  private environment: string;
   private oauthClient?: ClientCredentials;
   private oauthToken?: AccessToken;
   private readonly baseURL: string;
@@ -336,12 +350,9 @@ export class ServerClient {
     opts: CreateServerClientOpts,
     oauthClient?: ClientCredentials,
   ) {
+    this.environment = opts.environment ?? "production";
     this.secretKey = opts.secretKey;
     this.publicKey = opts.publicKey;
-    if (opts.project) {
-      this.publicKey = opts.project.publicKey;
-      this.secretKey = opts.project.secretKey;
-    }
 
     const { apiHost = "api.pipedream.com" } = opts;
     this.baseURL = `https://${apiHost}/v1`;
@@ -460,8 +471,9 @@ export class ServerClient {
       }
     }
 
-    const headers = {
+    const headers: Record<string, string> = {
       ...customHeaders,
+      "X-PD-Environment": this.environment,
     };
 
     let processedBody: string | Buffer | URLSearchParams | FormData | null = null;
@@ -571,7 +583,8 @@ export class ServerClient {
   }
 
   /**
-   * Creates a new connect token.
+   * Creates a new Pipedream Connect token.
+   * See https://pipedream.com/docs/connect/quickstart#connect-to-the-pipedream-api-from-your-server-and-create-a-token
    *
    * @param opts - The options for creating the connect token.
    * @returns A promise resolving to the connect token response.
@@ -782,20 +795,35 @@ export class ServerClient {
    * console.log(response);
    * ```
    */
-  public async invokeWorkflow(url: string, opts: RequestOptions = {}): Promise<unknown> {
+  public async invokeWorkflow(url: string, opts: RequestOptions = {}, authType: HTTPAuthType = HTTPAuthType.None): Promise<unknown> {
     const {
       body,
       headers = {},
     } = opts;
 
+    let authHeader: string | undefined;
+    switch (authType) {
+    // It's expected that users will pass their own Authorization header in the static bearer case
+    case HTTPAuthType.StaticBearer:
+      authHeader = headers["Authorization"];
+      break;
+    case HTTPAuthType.OAuth:
+      authHeader = await this.oauthAuthorizationHeader();
+      break;
+    default:
+      break;
+    }
+
     return this.makeRequest("", {
       ...opts,
       baseURL: url,
       method: opts.method || "POST", // Default to POST if not specified
-      headers: {
-        ...headers,
-        "Authorization": await this.oauthAuthorizationHeader(),
-      },
+      headers: authHeader
+        ? {
+          ...headers,
+          "Authorization": authHeader,
+        }
+        : headers,
       body,
     });
   }
@@ -850,7 +878,6 @@ export class ServerClient {
       headers: {
         ...headers,
         "X-PD-External-User-ID": externalUserId,
-        "X-PD-Project-Public-Key": this.publicKey,
       },
     });
   }