Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v3.0.0 - @W-15675100@ #403

Merged
merged 8 commits into from
May 10, 2024
Merged

Release v3.0.0 - @W-15675100@ #403

merged 8 commits into from
May 10, 2024

Conversation

joeluong-sfcc
Copy link
Collaborator

@joeluong-sfcc joeluong-sfcc commented May 9, 2024

This PR Releases v2.16.0 of the commerce-sdk. Changes include:

  • Custom API support

This PR also pulls in the latest versions of all the RAMLs, and this was done by modifying RAML toolkit to pull in the latest version instead of the production instance version: https://github.com/SalesforceCommerceCloud/raml-toolkit/pull/223/files

Some headers were removed on certain endpoints such as:

  • X-RateLimit-Limit
  • X-RateLimit-Remaining
  • X-RateLimit-Reset
  • Retry-After

But since the SDKs don't consider the headers when generating typescript, these changes can be ignored

API changes

  • CDN
    • 1.0.29 --> 1.0.30
    • Text description changes
  • Orders
    • 1.3.9 --> 1.4.2
    • Exchange module updates
    • Location header added for endpoint updateOrderStatus
    • Headers removed
  • Shopper Baskets
    • 2.0.3 --> 2.0.7
    • Reverted this change as we need to first figure out how to support v2 in the SDK
  • Shopper orders
    • 0.3.5 --> 0.4.7
    • guestOrderLookup endpoint added
    • Exchange modules updated
    • Headers removed
  • Customers
    • 0.0.22 --> 0.0.28
    • CustomerGroupRule, CustomerGroup, and CustomerGroupSearchResult types added
    • searchCustomerGroup endpoint added
    • Headers removed
    • Exchange modules updated
  • Shopper Context
    • 0.0.23 --> 0.0.26
    • clientIp added onto response body
    • Exchange modules updated
  • Shopper customers
    • 0.0.43 --> 0.0.48
    • Removal of deprecated endpoints
      • invalidateCustomerAuth
      • authorizeCustomer
      • authorizeTrustedSystem
    • Addition to types
    • Exchange modules updated
    • Headers removed
  • Shopper SEO
    • 1.0.6 --> 1.0.8
    • Exchange modules updated
  • SLAS admin
    • 1.12.17 --> 1.12.18
    • Addition of property useWellKnown to response
    • Text description updates
  • Assignments
    • 1.0.20 --> 1.0.23
    • Exchange modules updated
    • Headers removed
  • Campaigns
    • 1.0.23 --> 1.0.26
    • Exchange modules updated
    • Headers removed
  • Coupons
    • 1.0.22 --> 1.0.26
    • redeemCoupon endpoint added
    • Exchange modules updated
    • Headers removed
  • Gift certificates
    • 1.0.24 --> 1.0.28
    • Exchange modules updated
    • Headers removed
  • Promotions
    • 1.0.19 --> 1.0.22
    • Exchange modules updated
    • Headers removed
  • Shopper gift certificates
    • 1.0.12 --> 1.0.15
    • Exchange modules updated
    • Headers removed
  • Shopper promotions
    • 1.0.21 --> 1.0.25
    • count renamed to limit on response object
      • This was updated 2 years ago, so although this is technically breaking, it’s probably better categorized as a bug fix
    • Exchange modules updated
    • Headers removed
  • Source Code Groups
    • 1.0.23 --> 1.0.26
    • Exchange modules updated
    • Headers removed
  • Catalogs
    • 0.0.27 --> 0.0.31
    • Exchange modules updated
    • Headers removed
  • Products
    • 0.0.28 --> 0.0.31
    • Headers removed
  • Shopper products
    • 0.0.25 --> 0.0.32
    • Addition to types
    • none enum added to expand query parameter
    • Headers removed
  • Shopper Stores
    • 1.0.13
    • API added

kevinxh
kevinxh previously approved these changes May 9, 2024
CHANGELOG.md Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we listing all the public changes mentioned in the PR description?

Example:
SLAS admin
1.12.17 --> 1.12.18
Addition of property useWellKnown to response

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, I've only added changes about the addition/removal of any endpoints. The summary above was meant as an aid for reviewing since there are a large amount of changes

@vmarta
Copy link

vmarta commented May 9, 2024

@joeluong-sfcc looks like the Custom API support is not merged yet: #402 That PR should be merged first, right?

@joeluong-sfcc
Copy link
Collaborator Author

@joeluong-sfcc looks like the Custom API support is not merged yet: #402 That PR should be merged first, right?

@vmarta Yes, that's correct. Once that gets merged into main, I'll merge those changes into this PR and resolve any conflicts

@@ -1,40 +0,0 @@
import { ShopperToken, stripBearer, ResponseError, getObjectFromResponse } from "@commerce-apps/core"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed this helper function for retrieving an access token using the deprecated Shopper Customers authorizeCustomer endpoint. Now that the endpoint is removed, we can remove this helper function. This shouldn't be breaking as this is no longer supported by the API and all customers have migrated to SLAS

c_validCustomParam: "custom_param",
})
.reply(200, MOCK_RESPONSE);

const response = await customersClient.authorizeCustomer(options);
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

had to update this unit test to use another endpoint as this deprecated endpoint is now removed

@joeluong-sfcc joeluong-sfcc changed the title Release v2.16.0 - @W-15675100@ Release v3.0.0 - @W-15675100@ May 10, 2024
@joeluong-sfcc joeluong-sfcc marked this pull request as ready for review May 10, 2024 17:53
@joeluong-sfcc joeluong-sfcc requested a review from a team as a code owner May 10, 2024 17:53
Copy link
Collaborator

@unandyala unandyala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@joeluong-sfcc joeluong-sfcc merged commit 01ae667 into main May 10, 2024
8 checks passed
@joeluong-sfcc joeluong-sfcc deleted the release/20240509 branch May 10, 2024 20:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants