-
Notifications
You must be signed in to change notification settings - Fork 22
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
Export parameter keys (@W-15676813@) #158
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vmarta
commented
Jun 6, 2024
Comment on lines
+180
to
+184
"maxSize": "48 kB" | ||
}, | ||
{ | ||
"path": "commerce-sdk-isomorphic-with-deps.tgz", | ||
"maxSize": "400 kB" | ||
"maxSize": "410 kB" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
alexvuong
approved these changes
Jun 6, 2024
joeluong-sfcc
approved these changes
Jun 6, 2024
static readonly paramKeys = { | ||
{{#each encodes.endPoints}} | ||
{{#each operations}} | ||
{{{name}}}: [ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice way to also include the endpoint names
Merged
26 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR exports the parameter keys for each API method, so that a client like
commerce-sdk-react
will be able to rely on them (and no longer hardcoding those param keys).For an example on how to consume the exported parameter keys, please see SalesforceCommerceCloud/pwa-kit#1812
Note: this PR is for the parameter keys (not its Typescript types). So we're exporting the list/array.
Previous PR: #157
How to test-drive
In this case, I worked with 2 separate repos: this commerce-sdk-isomorphic (exports the parameter keys) and the pwa-kit (to consume those keys).
So first of all, let's build the commerce-sdk-isomorphic to get its minified output:
yarn install
yarn run renderTemplates
yarn run build:lib
Once we've gotten those minified scripts, we need to somehow use them in the pwa-kit repo. I've tried
npm link
but gotten an error. I'm not sure how tonpm link
properly within a monorepo like ours. Anyways, I manually created a symlink instead, like this: