From eb039ddeabfb0fa2518c0872c7c67bdcd37a2969 Mon Sep 17 00:00:00 2001 From: Jay Vercellone Date: Wed, 13 Nov 2024 09:24:54 -0800 Subject: [PATCH 1/5] Backend request improvements * Add the `fullResponse` flag as an option for `makeRequest` to return the raw HTTP response * Deprecate the `environment_name` field when creating a Connect token, in favour of the `environment` name in the client's constructor --- packages/sdk/package-lock.json | 4 ++-- packages/sdk/package.json | 2 +- packages/sdk/src/server/index.ts | 15 +++++++++++++++ 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/packages/sdk/package-lock.json b/packages/sdk/package-lock.json index b76751d1c47a2..85cd46020c050 100644 --- a/packages/sdk/package-lock.json +++ b/packages/sdk/package-lock.json @@ -1,12 +1,12 @@ { "name": "@pipedream/sdk", - "version": "1.0.0-rc.1", + "version": "1.0.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@pipedream/sdk", - "version": "1.0.0-rc.1", + "version": "1.0.1", "license": "SEE LICENSE IN LICENSE", "dependencies": { "simple-oauth2": "^5.1.0" diff --git a/packages/sdk/package.json b/packages/sdk/package.json index 008b282937167..3b7c49e47682a 100644 --- a/packages/sdk/package.json +++ b/packages/sdk/package.json @@ -1,6 +1,6 @@ { "name": "@pipedream/sdk", - "version": "1.0.0", + "version": "1.0.1", "description": "Pipedream SDK", "main": "dist/server/index.js", "module": "dist/server/index.js", diff --git a/packages/sdk/src/server/index.ts b/packages/sdk/src/server/index.ts index c83fb77d6bbeb..0616c32fefb21 100644 --- a/packages/sdk/src/server/index.ts +++ b/packages/sdk/src/server/index.ts @@ -87,6 +87,9 @@ export type ConnectTokenOpts = { /** * Specify the environment ("production" or "development") to use for the * account connection flow. Defaults to "production". + * + * @deprecated in favor of the `environment` field in `BackendClientOpts`. + * This field is completely ignored. */ environment_name?: string; }; @@ -292,6 +295,14 @@ interface RequestOptions extends Omit { * The body of the request. */ body?: Record | string | FormData | URLSearchParams | null; + + /** + * A flag to indicate that you want to get the full response object, not just + * the body. Note that when this flag is set, responses with unsuccessful HTTP + * statuses won't throw exceptions. Instead, you'll need to check the status + * code in the response object. Defaults to false. + */ + fullResponse?: boolean; } /** @@ -422,6 +433,7 @@ export class BackendClient { body, method = "GET", baseURL = this.baseApiUrl, + fullResponse = false, ...fetchOpts } = opts; @@ -472,6 +484,9 @@ export class BackendClient { } const response: Response = await fetch(url.toString(), requestOptions); + if (fullResponse) { + return response as unknown as T; + } if (!response.ok) { const errorBody = await response.text(); From 59824bf275f2326c5f3cbccacfb5cc0d554340af Mon Sep 17 00:00:00 2001 From: Jay Vercellone Date: Wed, 13 Nov 2024 09:38:35 -0800 Subject: [PATCH 2/5] Update changelog --- packages/sdk/CHANGELOG.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/packages/sdk/CHANGELOG.md b/packages/sdk/CHANGELOG.md index e02e531f4cdf7..d8e3c7cb731c5 100644 --- a/packages/sdk/CHANGELOG.md +++ b/packages/sdk/CHANGELOG.md @@ -1,6 +1,21 @@ # Changelog -## [1.0.0-rc.1] - 2024-11-01 +## [1.0.1] - 2024-11-13 + +### Changed + +- Deprecated the `environment_name` field in the `ConnectTokenOpts` type, as it + is no longer used by the SDK nor the Connect API. The environment name is now + exclusively determined by the `environment` field in the `BackendClientOpts` + type, read during the client creation. + +### Added + +- Added a new optional flag to `RequestOptions` called `fullResponse`, which + allows the user to get the full HTTP response object, including the headers + and status code. + +## [1.0.0] - 2024-11-01 ### Changed From 90b565893b26d93564f1f3993a0d9ec6ea999cf8 Mon Sep 17 00:00:00 2001 From: Jay Vercellone Date: Wed, 13 Nov 2024 09:40:43 -0800 Subject: [PATCH 3/5] Disable markdown lint rule for dup headers --- packages/sdk/CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/sdk/CHANGELOG.md b/packages/sdk/CHANGELOG.md index d8e3c7cb731c5..0cff3534c114c 100644 --- a/packages/sdk/CHANGELOG.md +++ b/packages/sdk/CHANGELOG.md @@ -1,3 +1,4 @@ + # Changelog ## [1.0.1] - 2024-11-13 From 04cf4a7e2306733e5f09dab8017573ec875c246f Mon Sep 17 00:00:00 2001 From: Jay Vercellone Date: Thu, 14 Nov 2024 09:03:51 -0800 Subject: [PATCH 4/5] Bump patch version --- packages/sdk/package-lock.json | 4 ++-- packages/sdk/package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/sdk/package-lock.json b/packages/sdk/package-lock.json index 85cd46020c050..b7c59eef29b5d 100644 --- a/packages/sdk/package-lock.json +++ b/packages/sdk/package-lock.json @@ -1,12 +1,12 @@ { "name": "@pipedream/sdk", - "version": "1.0.1", + "version": "1.0.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@pipedream/sdk", - "version": "1.0.1", + "version": "1.0.2", "license": "SEE LICENSE IN LICENSE", "dependencies": { "simple-oauth2": "^5.1.0" diff --git a/packages/sdk/package.json b/packages/sdk/package.json index 3b7c49e47682a..e56bb2c947e0a 100644 --- a/packages/sdk/package.json +++ b/packages/sdk/package.json @@ -1,6 +1,6 @@ { "name": "@pipedream/sdk", - "version": "1.0.1", + "version": "1.0.2", "description": "Pipedream SDK", "main": "dist/server/index.js", "module": "dist/server/index.js", From f25f4b0a7d800110c7ed3489180319d833f475cd Mon Sep 17 00:00:00 2001 From: Jay Vercellone Date: Thu, 14 Nov 2024 09:04:36 -0800 Subject: [PATCH 5/5] Update changelog --- packages/sdk/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/sdk/CHANGELOG.md b/packages/sdk/CHANGELOG.md index 0cff3534c114c..de87a18edcd2d 100644 --- a/packages/sdk/CHANGELOG.md +++ b/packages/sdk/CHANGELOG.md @@ -1,7 +1,7 @@ # Changelog -## [1.0.1] - 2024-11-13 +## [1.0.2] - 2024-11-14 ### Changed