Configurable props must have a name (#72)

* Mark the `name` field of configurable props as required
* Rename and export the `PipedreamClient` args

---------

Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
Co-authored-by: Jay Vercellone <[email protected]>

Author: fern-api[bot]

MIGRATE.md

@@ -835,7 +835,7 @@ incrementally without breaking your existing codebase. To do this, you can
 install the new SDK with an alias:
 
 ```bash
-npm install @pipedream/sdk-v2@npm:@pipedream/sdk@^2.0.0-rc.5 --save
+npm install @pipedream/sdk-v2@npm:@pipedream/sdk@^2.0.0-rc.6 --save
 ```
 
 Then, in your code, you can import the new SDK with the alias:

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pipedream/sdk",
-    "version": "2.0.0-rc.5",
+    "version": "2.0.0-rc.6",
     "private": false,
     "repository": "github:PipedreamHQ/pipedream-sdk-typescript",
     "type": "commonjs",

src/Client.ts

@@ -73,8 +73,8 @@ export class PipedreamClient {
                     "x-pd-environment": _options?.projectEnvironment,
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@pipedream/sdk",
-                    "X-Fern-SDK-Version": "2.0.0-rc.5",
-                    "User-Agent": "@pipedream/sdk/2.0.0-rc.5",
+                    "X-Fern-SDK-Version": "2.0.0-rc.6",
+                    "User-Agent": "@pipedream/sdk/2.0.0-rc.6",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

src/api/types/ConfigurableProp.ts

@@ -7,7 +7,7 @@
  */
 export interface ConfigurableProp {
     /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */
-    name?: string;
+    name: string;
     type?: string;
     /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */
     label?: string;

src/api/types/ConfigurablePropAlert.ts

@@ -9,7 +9,7 @@ export interface ConfigurablePropAlert {
     /** The content of the alert, which can include HTML or plain text. */
     content?: string;
     /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */
-    name?: string;
+    name: string;
     /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */
     label?: string;
     /** A description of the prop, shown to the user when configuring the component. */

src/api/types/ConfigurablePropAny.ts

@@ -5,7 +5,7 @@
 export interface ConfigurablePropAny {
     type?: "any";
     /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */
-    name?: string;
+    name: string;
     /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */
     label?: string;
     /** A description of the prop, shown to the user when configuring the component. */

src/api/types/ConfigurablePropApp.ts

@@ -7,7 +7,7 @@ export interface ConfigurablePropApp {
     /** The name slug of the app, e.g. 'github', 'slack', etc. This is used to identify the app for which the account is being configured. */
     app?: string;
     /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */
-    name?: string;
+    name: string;
     /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */
     label?: string;
     /** A description of the prop, shown to the user when configuring the component. */

src/api/types/ConfigurablePropBoolean.ts

@@ -5,7 +5,7 @@
 export interface ConfigurablePropBoolean {
     type?: "boolean";
     /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */
-    name?: string;
+    name: string;
     /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */
     label?: string;
     /** A description of the prop, shown to the user when configuring the component. */

src/api/types/ConfigurablePropDiscord.ts

@@ -5,7 +5,7 @@
 export interface ConfigurablePropDiscord {
     type?: "$.discord.channel";
     /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */
-    name?: string;
+    name: string;
     /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */
     label?: string;
     /** A description of the prop, shown to the user when configuring the component. */

src/api/types/ConfigurablePropInteger.ts

@@ -9,7 +9,7 @@ export interface ConfigurablePropInteger {
     /** The maximum value for this integer prop. */
     max?: number;
     /** When building `configuredProps`, make sure to use this field as the key when setting the prop value */
-    name?: string;
+    name: string;
     /** Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. */
     label?: string;
     /** A description of the prop, shown to the user when configuring the component. */