Require project environment in SDK (#14679)

* Require project environment in SDK

* Refactor environment check into its own method

* Define a new type for project environment

* Fix comment and update CHANGELOG.md

* Fix linter errors

* Fix linter errors

* Update package lock

* Update gitignore

* Add eslint config

* Apply eslint

* Apply linter suggestions

* Fix markdown syntax errors

* Fix tests

* Update pnpm lock

* Remove pnpm lock changes

* Remove eslint configs

* Undo eslint change

* Revert reversion of eslint changes

Author: bzwrk

.gitignore

@@ -16,3 +16,5 @@ docs/.vuepress/dist
 
 ./package-lock.json
 components/**/package-lock.json
+/packages/evals/
+/packages/sdk/examples/.next/

packages/sdk/CHANGELOG.md

@@ -1,12 +1,21 @@
 <!-- markdownlint-disable MD024 -->
 # Changelog
 
+## [1.0.5] - 2024-11-18
+
+### Changed
+
+- The backend client used to default to `production` if the environment was not
+specified. Now `environment` is a required argument for `createBackendClient`
+and must be one of `production` or `development`.  
+
 ## [1.0.4] - 2024-11-15
 
 ### Changed
 
 - Improved the docs of the `getAccountById` method in the backend client to
   clarify the behavior of the new argument.
+
 - Fixed the exported `HTTPAuthType` enum so that it can be used by the consumers
   of the SDK.
 

packages/sdk/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/sdk",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Pipedream SDK",
   "main": "dist/server/index.js",
   "module": "dist/server/index.js",

packages/sdk/package.json

@@ -10,6 +10,7 @@ import {
 
 const projectId = "proj_abc123";
 const clientParams: BackendClientOpts = {
+  environment: "production",
   credentials: {
     clientId: "test-client-id",
     clientSecret: "test-client-secret",
@@ -175,6 +176,7 @@ describe("BackendClient", () => {
             clientId: "test-client-id",
             clientSecret: "test-client-secret",
           },
+          environment: "production",
           projectId,
         },
       );
@@ -677,6 +679,7 @@ describe("BackendClient", () => {
             clientId: "test-client-id",
             clientSecret: "test-client-secret",
           },
+          environment: "production",
           projectId: "proj_abc123",
         },
       );

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

@@ -16,6 +16,11 @@ export type OAuthCredentials = {
   clientSecret: string;
 };
 
+/**
+ * The environment in which the server client is running.
+ */
+export type ProjectEnvironment = "development" | "production";
+
 /**
  * Options for creating a server-side client.
  * This is used to configure the BackendClient instance.
@@ -25,7 +30,7 @@ export type BackendClientOpts = {
    * The environment in which the server client is running (e.g., "production",
    * "development").
    */
-  environment?: string;
+  environment?: ProjectEnvironment;
 
   /**
    * The credentials to use for authentication against the Pipedream API.
@@ -353,7 +358,8 @@ export class BackendClient {
    * @param opts - The options for configuring the server client.
    */
   constructor(opts: BackendClientOpts) {
-    this.environment = opts.environment ?? "production";
+    this.ensureValidEnvironment(opts.environment);
+    this.environment = opts.environment!;
 
     this.projectId = opts.projectId;
     if (!this.projectId) {
@@ -370,6 +376,15 @@ export class BackendClient {
     this.oauthClient = this.newOauthClient(opts.credentials, this.baseApiUrl);
   }
 
+  private ensureValidEnvironment(environment?: string) {
+    if (!environment || ![
+      "development",
+      "production",
+    ].includes(environment)) {
+      throw new Error("Project environment is required. Supported environments are development and production.");
+    }
+  }
+
   private newOauthClient(
     {
       clientId,