Skip to content

Commit 0ce4e49

Browse files
committed
chore(sdk): configureComponent prevContext + context (1.5.5)
1 parent ceb196f commit 0ce4e49

File tree

4 files changed

+18
-7
lines changed

4 files changed

+18
-7
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.5.5] - 2025-04-25
6+
7+
### Changed
8+
9+
- Types and documentation around `configureComponent` `prevContext` and `context`.
10+
511
## [1.5.4] - 2025-04-25
612

713
### Added

packages/sdk/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@pipedream/sdk",
33
"type": "module",
4-
"version": "1.5.4",
4+
"version": "1.5.5",
55
"description": "Pipedream SDK",
66
"main": "./dist/server.js",
77
"module": "./dist/server.js",

packages/sdk/src/shared/index.ts

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,8 @@ export type PropOption = {
129129
value: string;
130130
};
131131

132+
type ConfigureComponentContext = Record<string, any>
133+
132134
/**
133135
* The response received after configuring a component's prop.
134136
*/
@@ -160,6 +162,12 @@ export type ConfigureComponentResponse = {
160162
* A list of errors that occurred during the configuration process.
161163
*/
162164
errors: string[];
165+
166+
/**
167+
* The context object resolved in the options execution (useful for pagination, etc.).
168+
* See {@link ConfigureComponentOpts.prevContext}.
169+
*/
170+
context?: ConfigureComponentContext
163171
};
164172

165173
/**
@@ -412,11 +420,10 @@ export type ConfigureComponentOpts = ExternalUserId & {
412420
page?: number;
413421

414422
/**
415-
* A string representing the context for the previous options
416-
* execution. Use with APIs that accept a token representing the last
417-
* record for pagination.
423+
* The context object from the previous options execution (useful for pagination, etc.).
424+
* See {@link ConfigureComponentResponse.context}.
418425
*/
419-
prevContext?: never;
426+
prevContext?: ConfigureComponentContext;
420427
};
421428

422429
/**

pnpm-lock.yaml

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

0 commit comments

Comments
 (0)