Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
79 commits
Select commit Hold shift + click to select a range
f1e68a0
feat(profile-controller): scaffold package
hmalik88 Sep 24, 2026
4f66f52
feat(profile-controller): remove index test file
hmalik88 Sep 24, 2026
7122118
feat(profile-controller): add method action types
hmalik88 Sep 24, 2026
098fc11
feat(profile-controller): add exports to index file
hmalik88 Sep 24, 2026
98cd1ce
feat(profile-controller): add profile controller and service
hmalik88 Sep 28, 2026
58c1be7
feat(profile-controller): add input validation, fix types and tsconfi…
hmalik88 Sep 28, 2026
da7da87
feat(profile-controller): add useGetProfile and useCheckUsernameAvail…
hmalik88 Sep 28, 2026
8af5baa
docs(profile-controller): add JSDoc to public API
hmalik88 Sep 28, 2026
a837255
refactor(profile-controller): rename vars and update logic
hmalik88 Sep 28, 2026
ce8fe23
chore(profile-controller): update action types
hmalik88 Sep 28, 2026
34bb997
feat(profile-controller): remove profileId params from controller mut…
hmalik88 Sep 28, 2026
439ac53
fix(profile-controller): restore JSDoc on #hasProfile, correct return…
hmalik88 Sep 29, 2026
fa1d4b5
feat(profile-controller): include x_profile in createProfile response…
hmalik88 Sep 29, 2026
1704a05
chore(profile-controller): update changelog entries
hmalik88 Sep 29, 2026
442943f
fix(profile-controller): apply code review fixes to service and contr…
hmalik88 Sep 29, 2026
a378f49
Merge remote-tracking branch 'origin/main' into hm/add-profile-contro…
hmalik88 Sep 29, 2026
19ce0e8
chore: update lockfile for profile-controller dependencies
hmalik88 Sep 29, 2026
b18887a
chore: update README
hmalik88 Sep 29, 2026
5637f4e
fix(profile-controller): update action types
hmalik88 Sep 29, 2026
17680a9
fix(profile-controller): update tsconfigs
hmalik88 Sep 29, 2026
f13cf5a
chore: add profile-controller to teams.json
hmalik88 Sep 29, 2026
3e21f9d
fix(profile-controller): resolve lint errors
hmalik88 Sep 29, 2026
f0f42a0
fix(profile-controller): return null from deleteProfile mutationFn to…
hmalik88 Sep 29, 2026
e9687d6
fix(profile-controller): lint fix
hmalik88 Sep 29, 2026
0b5426b
chore: update CODEOWNERS
hmalik88 Sep 29, 2026
71768c2
chore(profile-controller): align deps
hmalik88 Sep 29, 2026
defbe71
fix(profile-controller): add casts
hmalik88 Sep 29, 2026
dcd8b7e
chore: update CODEOWNERS
hmalik88 Sep 29, 2026
4ca4f64
chore: update README
hmalik88 Sep 29, 2026
b673db4
fix(profile-controller): lint fix
hmalik88 Sep 29, 2026
05b41fe
chore: add profile controller to core tsconfig
hmalik88 Sep 29, 2026
9a49480
fix(profile-controller): fix import in action types
hmalik88 Sep 29, 2026
9718464
refactor(profile-controller): remove casts
hmalik88 Sep 29, 2026
367b3e9
chore(profile-controller): fix constraints, CODEOWNERS, and update te…
hmalik88 Sep 29, 2026
5d511a6
chore: add codeowners
hmalik88 Sep 29, 2026
5feed3c
fix(profile-controller): regenerate action types
hmalik88 Sep 29, 2026
98ec920
chore: add profile-controller to codeowners.ts
hmalik88 Sep 29, 2026
f775851
fix(profile-controller): update imports
hmalik88 Sep 29, 2026
e8e3851
refactor(profile-controller): update method name
hmalik88 Sep 29, 2026
8008b45
test(profile-controller): fix method names
hmalik88 Sep 29, 2026
db05174
chore(profile-controller): bump jest to match monorepo version
hmalik88 Sep 29, 2026
34e5f91
fix(profile-controller): fix errors
hmalik88 Sep 29, 2026
18cf934
Merge remote-tracking branch 'origin/main' into hm/add-profile-contro…
hmalik88 Sep 29, 2026
0306318
fix: update yarn.lock
hmalik88 Sep 29, 2026
dc2bec6
fix(profile-controller): correct lint:tsconfigs script extension
hmalik88 Sep 29, 2026
d9d3e1d
Merge remote-tracking branch 'origin/main' into hm/add-profile-contro…
hmalik88 Sep 29, 2026
b365183
fix(profile-controller): add --esm flag to messenger-action-types scr…
hmalik88 Sep 29, 2026
ec421d1
refactor(profile-controller): apply code review
hmalik88 Sep 29, 2026
11afbe6
Merge remote-tracking branch 'origin/main' into hm/add-profile-contro…
hmalik88 Sep 29, 2026
2464e36
fix(profile-controller): remove negated conditions
hmalik88 Sep 29, 2026
6ebdcf7
fix(profile-controller): make #fetch generic
hmalik88 Sep 29, 2026
f2f8406
fix(profile-controller): fix cast
hmalik88 Sep 29, 2026
225a483
fix(profile-controller): lint fix
hmalik88 Sep 29, 2026
c24a089
refactor(profile-controller): use #fetch in deleteProfile
hmalik88 Sep 29, 2026
93bc496
fix(profile-controller): add bracket after if
hmalik88 Sep 29, 2026
a7fa022
refactor(profile-controller): add debounce to react query hook
hmalik88 Sep 29, 2026
65d14eb
fix(profile-controller): make linked_addresses and trading_privacy re…
hmalik88 Sep 29, 2026
ae0ff8a
refactor(profile-controller): apply code review
hmalik88 Sep 29, 2026
2e04828
fix(profile-controller): regenerate action type
hmalik88 Sep 29, 2026
b94a42d
refactor(profile-controller): use sensitive struct
hmalik88 Sep 29, 2026
78d5608
fix(profile-controller): fix lint issues
hmalik88 Sep 29, 2026
59d431a
Merge remote-tracking branch 'origin/main' into hm/add-profile-contro…
hmalik88 Sep 29, 2026
63002e8
fix(profile-controller): more lint fixes
hmalik88 Sep 29, 2026
d6ca5be
fix(profile-controller): update JSDocs
hmalik88 Sep 29, 2026
a887801
fix(profile-controller): fix action types
hmalik88 Sep 29, 2026
e27fe83
Merge remote-tracking branch 'origin/main' into hm/add-profile-contro…
hmalik88 Sep 29, 2026
5307c10
chore(profile-controller): replace tsx
hmalik88 Sep 29, 2026
7e139aa
fix(profile-controller): fix syntax
hmalik88 Sep 29, 2026
f2cff72
chore(profile-controller): update license
hmalik88 Sep 29, 2026
55e6c19
refactor(profile-controller): remove getXAuthUrl method
hmalik88 Sep 29, 2026
b72723a
refactor(profile-controller): add overloads for #fetch
hmalik88 Sep 29, 2026
210abed
refactor(profile-controller): use searchParams
hmalik88 Sep 29, 2026
dc46832
refactor(profile-controller): remove hooks
hmalik88 Sep 29, 2026
519973e
fix(profile-controller): update test
hmalik88 Sep 29, 2026
6f2d3f6
chore: update README
hmalik88 Sep 29, 2026
f73fd0a
fix(profile-controller): remove deleted action from index.ts
hmalik88 Sep 29, 2026
1164672
fix(profile-controller): fix lint issues in controller test file
hmalik88 Sep 29, 2026
07b479a
fix(profile-controller): remove react data query from tsconfig
hmalik88 Sep 29, 2026
c3f38ae
fix(profile-controller): remove stale changelog entry
hmalik88 Sep 29, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -536,6 +536,13 @@
/packages/preferences-controller/tsconfig.* @MetaMask/core-platform
/packages/preferences-controller/typedoc.json @MetaMask/core-platform

### profile-controller
/packages/profile-controller @MetaMask/accounts-engineers
/packages/profile-controller/CHANGELOG.md @MetaMask/accounts-engineers @MetaMask/core-platform
/packages/profile-controller/package.json @MetaMask/accounts-engineers @MetaMask/core-platform
/packages/profile-controller/tsconfig.* @MetaMask/accounts-engineers @MetaMask/core-platform
/packages/profile-controller/typedoc.json @MetaMask/accounts-engineers @MetaMask/core-platform

### profile-metrics-controller
/packages/profile-metrics-controller @MetaMask/extension-platform @MetaMask/mobile-platform
/packages/profile-metrics-controller/CHANGELOG.md @MetaMask/core-platform @MetaMask/extension-platform @MetaMask/mobile-platform
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ yarn skills --reset # clear saved local selection
- [`@metamask/platform-api-docs`](packages/platform-api-docs)
- [`@metamask/polling-controller`](packages/polling-controller)
- [`@metamask/preferences-controller`](packages/preferences-controller)
- [`@metamask/profile-controller`](packages/profile-controller)
- [`@metamask/profile-metrics-controller`](packages/profile-metrics-controller)
- [`@metamask/profile-sync-controller`](packages/profile-sync-controller)
- [`@metamask/ramps-controller`](packages/ramps-controller)
Expand Down Expand Up @@ -224,6 +225,7 @@ linkStyle default opacity:0.5
platform_api_docs(["@metamask/platform-api-docs"]);
polling_controller(["@metamask/polling-controller"]);
preferences_controller(["@metamask/preferences-controller"]);
profile_controller(["@metamask/profile-controller"]);
profile_metrics_controller(["@metamask/profile-metrics-controller"]);
profile_sync_controller(["@metamask/profile-sync-controller"]);
ramps_controller(["@metamask/ramps-controller"]);
Expand Down Expand Up @@ -611,6 +613,12 @@ linkStyle default opacity:0.5
polling_controller --> messenger;
preferences_controller --> base_controller;
preferences_controller --> messenger;
profile_controller --> base_controller;
profile_controller --> base_data_service;
profile_controller --> controller_utils;
profile_controller --> messenger;
profile_controller --> profile_sync_controller;
profile_controller --> utils;
profile_metrics_controller --> accounts_controller;
profile_metrics_controller --> base_controller;
profile_metrics_controller --> controller_utils;
Expand Down
3 changes: 3 additions & 0 deletions codeowners.ts
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,9 @@ const config = {
'preferences-controller': {
teams: ['@MetaMask/core-platform'],
},
'profile-controller': {
teams: ['@MetaMask/accounts-engineers'],
},
'profile-metrics-controller': {
teams: ['@MetaMask/mobile-platform', '@MetaMask/extension-platform'],
},
Expand Down
5 changes: 5 additions & 0 deletions oxlint-suppressions.json
Original file line number Diff line number Diff line change
Expand Up @@ -4976,6 +4976,11 @@
"count": 1
}
},
"packages/profile-controller/jest.config.cjs": {
"import/unambiguous": {
"count": 1
}
},
"packages/profile-metrics-controller/jest.config.cjs": {
"import/unambiguous": {
"count": 1
Expand Down
15 changes: 15 additions & 0 deletions packages/profile-controller/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added

- Add `ProfileController` for managing user profile state, exposing `getMetaMaskProfile`, `getXprofile`, `createProfile`, `replaceProfile`, `updateProfile`, `deleteProfile`, `checkUsernameAvailability`, `getXAuthUrl`, `connectX`, and `getXAccount` via the messenger ([#10558](https://github.com/MetaMask/core/pull/10558))
- Add `ProfileService` for communicating with the MetaMask Profile API, exposing `getProfile`, `createProfile`, `replaceProfile`, `updateProfile`, `deleteProfile`, `checkUsernameAvailability`, `getXAuthUrl`, `connectX`, and `getXAccount` via the messenger, with superstruct validation on all inputs and responses ([#10558](https://github.com/MetaMask/core/pull/10558))

[Unreleased]: https://github.com/MetaMask/core/
6 changes: 6 additions & 0 deletions packages/profile-controller/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
This project is licensed under either of

* MIT license ([LICENSE.MIT](LICENSE.MIT))
* Apache License, Version 2.0 ([LICENSE.APACHE2](LICENSE.APACHE2))

at your option.
201 changes: 201 additions & 0 deletions packages/profile-controller/LICENSE.APACHE2
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2026 MetaMask

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
21 changes: 21 additions & 0 deletions packages/profile-controller/LICENSE.MIT
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 MetaMask

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
15 changes: 15 additions & 0 deletions packages/profile-controller/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# `@metamask/profile-controller`

Controller for managing user profile data including username, bio, avatar, and linked accounts via the MetaMask Profile API.

## Installation

`yarn add @metamask/profile-controller`

or

`npm install @metamask/profile-controller`

## Contributing

This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).
26 changes: 26 additions & 0 deletions packages/profile-controller/jest.config.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
/*
* For a detailed explanation regarding each configuration property and type check, visit:
* https://jestjs.io/docs/configuration
*/

const merge = require('deepmerge');
const path = require('path');

const baseConfig = require('../../jest.config.packages.cjs');

const displayName = path.basename(__dirname);

module.exports = merge(baseConfig, {
// The display name when running multiple projects
displayName,

// An object that configures minimum threshold enforcement for coverage results
coverageThreshold: {
global: {
branches: 100,
functions: 100,
lines: 100,
statements: 100,
},
},
});
Loading
Loading