-
Notifications
You must be signed in to change notification settings - Fork 22
update iframe stamper to have methods to refresh an embedded key #571
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
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit ee90d60:
|
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.
Let's add a changelog? Other than that: 🚀
packages/iframe-stamper/src/index.ts
Outdated
// Event sent by the parent to reset the iframe's embedded key. | ||
// Value: none |
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.
Worth adding a comment here to say that this doesn't actually reset the key, it simply clears it.
packages/iframe-stamper/src/index.ts
Outdated
GetEmbeddedPublicKey = "GET_EMBEDDED_PUBLIC_KEY", | ||
// Event sent by the parent to reset the iframe's embedded key. | ||
// Value: none | ||
ResetEmbeddedKey = "RESET_EMBEDDED_KEY", |
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.
What do you think about naming this ClearEmbeddedKey
instead? That'll make the comment more understandable, and SDK clients won't need to comment their code to explain that ResetEmbeddedKey
actually only clears it. We stop the bleeding here :D
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.
love it!
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.
🥇
Summary & Motivation
$title
Accompying
tkhq/frames
change (with demo vid): tkhq/frames#67How I Tested These Changes
Screen.Recording.2025-04-03.at.12.36.11.PM.mov
Did you add a changeset?
If updating one of our packages, you'll likely need to add a changeset to your PR. To do so, run
pnpm changeset
.pnpm changeset
will generate a file where you should write a human friendly message about the changes. Note how this (example) includes the package name (should be auto added by the command) along with the type of semver change (major.minor.patch) (which you should set).These changes will be used at release time to determine what packages to publish and how to bump their version. For more context see this comment.