Skip to content

Commit f7ecf2a

Browse files
committed
fix(sdk): correct return type of reloadComponentProps (1.1.5)
1 parent 13de766 commit f7ecf2a

File tree

4 files changed

+32
-13
lines changed

4 files changed

+32
-13
lines changed

packages/sdk/CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
# Changelog
44

5+
## [1.1.5] - 2025-01-14
6+
7+
### Changed
8+
9+
- Corrected the return type of `reloadComponentProps`
10+
511
## [1.1.4] - 2025-01-08
612

713
### Added

packages/sdk/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@pipedream/sdk",
3-
"version": "1.1.4",
3+
"version": "1.1.5",
44
"description": "Pipedream SDK",
55
"main": "dist/server/server/index.js",
66
"module": "dist/server/server/index.js",

packages/sdk/src/shared/index.ts

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ export type Account = {
276276
};
277277

278278
/**
279-
* The request options for reconfiguring a component's props when dealing with
279+
* The request options for reloading a component's props when dealing with
280280
* dynamic props.
281281
*/
282282
export type ReloadComponentPropsOpts = ExternalUserId & {
@@ -294,12 +294,30 @@ export type ReloadComponentPropsOpts = ExternalUserId & {
294294
configuredProps: ConfiguredProps<ConfigurableProps>;
295295

296296
/**
297-
* The ID of the last prop reconfiguration (or none when reconfiguring the
298-
* props for the first time).
297+
* The ID of the last prop reload (or none when reloading the props for the
298+
* first time).
299299
*/
300300
dynamicPropsId?: string;
301301
};
302302

303+
export type ReloadComponentPropsResponse = {
304+
// XXX observations
305+
306+
/**
307+
* A list of errors that occurred during the prop reloading process.
308+
*/
309+
errors: string[]
310+
311+
/**
312+
* Dynamic props object containing the dynamic props ID and the dynamic
313+
* configurable props for the component.
314+
*/
315+
dynamicProps: {
316+
id: string
317+
configurableProps: ConfigurableProps
318+
}
319+
}
320+
303321
/**
304322
* @deprecated Use `ReloadComponentPropsOpts` instead.
305323
*/
@@ -1030,7 +1048,7 @@ export abstract class BaseClient {
10301048
dynamic_props_id: opts.dynamicPropsId,
10311049
};
10321050

1033-
return this.makeConnectRequest<ConfiguredProps<ConfigurableProps>>(
1051+
return this.makeConnectRequest<ReloadComponentPropsResponse>(
10341052
"/components/props", {
10351053
// TODO trigger
10361054
method: "POST",

pnpm-lock.yaml

Lines changed: 3 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)