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

feat: add optional validateAgainstSchema option when creating user storage entry paths #5326

Merged
merged 2 commits into from
Feb 14, 2025

Conversation

mathieuartu
Copy link
Contributor

Explanation

This PR adds a new validateAgainstSchema option when creating user storage entry paths.
This defaults to true, but can be relaxed to false when using the SDK.
SDK users should use the feature and key names they decide to use, and Controller users should follow the internal schema.

References

Related to: https://consensyssoftware.atlassian.net/browse/IDENTITY-31

Changelog

@metamask/profile-sync-controller

  • ADDED: Optional validateAgainstSchema option when creating user storage entry paths

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've highlighted breaking changes using the "BREAKING" category above as appropriate
  • I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

@mathieuartu mathieuartu added the team-identity Identity Team changes. https://github.com/orgs/MetaMask/teams/identity label Feb 13, 2025
@mathieuartu mathieuartu self-assigned this Feb 13, 2025
@mathieuartu mathieuartu marked this pull request as ready for review February 14, 2025 08:31
@mathieuartu mathieuartu requested review from a team as code owners February 14, 2025 08:31
@mathieuartu mathieuartu changed the title feat: add new validateAgainstSchema feature and key validation option feat: add optional validateAgainstSchema option when creating user storage entry paths Feb 14, 2025
@mathieuartu mathieuartu merged commit 3f8fd98 into main Feb 14, 2025
133 checks passed
@mathieuartu mathieuartu deleted the feat/relax-types-user-storage-paths-sdk branch February 14, 2025 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team-identity Identity Team changes. https://github.com/orgs/MetaMask/teams/identity
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants