feat(sdk): typing improvements -- configurableProp.withLabel, app.featured_weight, docs (1.5.1)

Author: tjk

packages/sdk/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 # Changelog
 
+## [1.5.1] - 2025-04-15
+
+### Added
+
+- `withLabel` to `BaseConfigurableProp` type definition
+- documentation describing various fields in `BaseConfigurableProp`
+- `featured_weight` to `App` type definition now that API returns this value
+
 ## [1.5.0] - 2025-04-08
 
 ### Added

packages/sdk/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pipedream/sdk",
   "type": "module",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "Pipedream SDK",
   "main": "./dist/server.js",
   "module": "./dist/server.js",

packages/sdk/src/shared/component.ts

@@ -1,17 +1,57 @@
 // eslint-disable @typescript-eslint/no-explicit-any
 type BaseConfigurableProp = {
+  /**
+   * When building `configuredProps`, make sure to use this field as the key when
+   * setting the prop value.
+   */
   name: string;
   type: string;
 
   // XXX don't actually apply to all, fix
+
+  /**
+   * 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;
+
   description?: string;
   optional?: boolean;
   disabled?: boolean;
+
+  /**
+   * If true, should not expose this prop to the user.
+   */
   hidden?: boolean;
+
+  /**
+   * If true, call `configureComponent` for this prop to load remote options.
+   * It is safe, and preferred, given a returned list of
+   * { label: string; value: any } objects to set the prop
+   * value to { __lv: { label: string; value: any } }. This way, on load, you
+   * can access label for the value without necessarily reloading these options.
+   */
   remoteOptions?: boolean;
+
+  /**
+   * If true, calls to `configureComponent` for this prop support receiving a
+   * `query` parameter to filter remote options.
+   */
   useQuery?: boolean;
+
+  /**
+   * If true, after setting a value for this prop, a call to `reloadComponentProps` is
+   * required as the component has dynamic configurable props dependent on this
+   * one.
+   */
   reloadProps?: boolean;
+
+  /**
+   * If true, you must save the configured prop value as a "label-value" object
+   * which should look like: { __lv: { label: string; value: any } }
+   * because the execution needs to access the label.
+   */
+  withLabel?: boolean;
 };
 
 // XXX fix duplicating mapping to value type here and with PropValue

packages/sdk/src/shared/index.ts

@@ -109,6 +109,11 @@ export type App = AppInfo & {
    * Categories associated with the app.
    */
   categories: string[];
+
+  /**
+   * A rough directional ordering of app popularity, subject to changes by Pipedream.
+   */
+  featured_weight: number
 };
 
 /**