@metamask-previews/profile-controller 0.0.0-preview-2848be6

package/dist/ProfileController.js

@@ -0,0 +1,241 @@
+import { BaseController } from '@metamask/base-controller';
+const controllerName = 'ProfileController';
+// === STATE ===
+const profileControllerMetadata = {
+    profile: {
+        includeInStateLogs: true,
+        persist: true,
+        includeInDebugSnapshot: false,
+        usedInUi: true,
+    },
+    xProfile: {
+        includeInStateLogs: false,
+        persist: true,
+        includeInDebugSnapshot: false,
+        usedInUi: true,
+    },
+};
+/**
+ * Returns the default initial state for ProfileController.
+ *
+ * @returns A ProfileControllerState with empty profile fields and no X profile.
+ */
+export function getDefaultProfileControllerState() {
+    return {
+        profile: {
+            profileId: '',
+            username: '',
+            displayName: '',
+            bio: '',
+            linkedAddresses: [],
+            avatarUrl: '',
+            tradingPrivacy: 'public',
+            connectedToX: false,
+            createdAt: '',
+            updatedAt: '',
+        },
+    };
+}
+const MESSENGER_EXPOSED_METHODS = [
+    'getProfile',
+    'getXProfile',
+    'createProfile',
+    'replaceProfile',
+    'updateProfile',
+    'deleteProfile',
+    'checkUsernameAvailability',
+    'connectX',
+    'fetchAndUpdateXAccount',
+];
+// === CONTROLLER ===
+/** Manages MetaMask profile state and delegates API operations to ProfileService. */
+export class ProfileController extends BaseController {
+    /**
+     * Creates a new ProfileController instance.
+     *
+     * @param options - Constructor options.
+     * @param options.messenger - The messenger scoped to ProfileController.
+     * @param options.state - Optional partial initial state to merge with defaults.
+     */
+    constructor({ messenger, state, }) {
+        super({
+            messenger,
+            name: controllerName,
+            metadata: profileControllerMetadata,
+            state: {
+                ...getDefaultProfileControllerState(),
+                ...state,
+            },
+        });
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Returns true if a profile has been created and exists in state.
+     *
+     * @returns True if a profile exists, false otherwise.
+     */
+    #hasProfile() {
+        return this.state.profile.profileId !== '';
+    }
+    /**
+     * Returns the profile ID from state, throwing if no profile exists yet.
+     *
+     * @returns The current profile ID.
+     * @throws If no profile has been created.
+     */
+    #getProfileIdOrThrow() {
+        const { profileId } = this.state.profile;
+        if (!profileId) {
+            throw new Error('ProfileController: no profile found in state');
+        }
+        return profileId;
+    }
+    /**
+     * Maps an API response to a MetaMask profile.
+     *
+     * @param response - The API response to map.
+     * @returns The mapped MetaMask profile.
+     */
+    #mapApiResponseToProfile(response) {
+        return {
+            profileId: response.profile_id,
+            username: response.username,
+            displayName: response.display_name,
+            bio: response.bio ?? '',
+            linkedAddresses: response.linked_addresses,
+            avatarUrl: response.avatar_url ?? '',
+            tradingPrivacy: response.trading_privacy,
+            connectedToX: response.connected_to_x,
+            createdAt: response.created_at,
+            updatedAt: response.updated_at,
+        };
+    }
+    /**
+     * Maps an API response to an X profile.
+     *
+     * @param response - The API response to map.
+     * @returns The mapped X profile.
+     */
+    #mapXResponseToXProfile(response) {
+        return {
+            xUserId: response.x_user_id,
+            xProfileUrl: response.x_profile_url,
+            username: response.username,
+            displayName: response.display_name,
+            avatarUrl: response.avatar_url,
+            createdAt: response.created_at,
+            updatedAt: response.updated_at,
+        };
+    }
+    /**
+     * Returns the current MetaMask profile from state, or undefined if none has been created.
+     *
+     * @returns The MetaMask profile, or undefined.
+     */
+    getProfile() {
+        if (!this.#hasProfile()) {
+            return undefined;
+        }
+        return this.state.profile;
+    }
+    /**
+     * Returns the currently linked X profile from state, or undefined if none has been connected.
+     *
+     * @returns The X profile, or undefined.
+     */
+    getXProfile() {
+        return this.state.xProfile;
+    }
+    /**
+     * Creates a new MetaMask profile, updates state, and returns the created profile.
+     * If the user had previously connected X, also updates xProfile in state.
+     *
+     * @param params - The profile creation parameters.
+     * @returns The created MetaMask profile.
+     */
+    async createProfile(params) {
+        const response = await this.messenger.call('ProfileService:createProfile', params);
+        const mapped = this.#mapApiResponseToProfile(response);
+        this.update((state) => {
+            state.profile = mapped;
+            if (response.x_profile) {
+                state.xProfile = this.#mapXResponseToXProfile(response.x_profile);
+            }
+        });
+        return mapped;
+    }
+    /**
+     * Fully replaces the current profile and updates state.
+     *
+     * @param input - The replacement profile data.
+     * @throws If no profile has been created yet.
+     */
+    async replaceProfile(input) {
+        const profileId = this.#getProfileIdOrThrow();
+        const response = await this.messenger.call('ProfileService:replaceProfile', profileId, input);
+        this.update((state) => {
+            state.profile = this.#mapApiResponseToProfile(response);
+        });
+    }
+    /**
+     * Partially updates the current profile and updates state.
+     *
+     * @param input - The fields to update.
+     * @throws If no profile has been created yet.
+     */
+    async updateProfile(input) {
+        const profileId = this.#getProfileIdOrThrow();
+        const response = await this.messenger.call('ProfileService:updateProfile', profileId, input);
+        this.update((state) => {
+            state.profile = this.#mapApiResponseToProfile(response);
+        });
+    }
+    /**
+     * Deletes the current profile and resets state, including clearing any linked X profile.
+     *
+     * @throws If no profile has been created yet.
+     */
+    async deleteProfile() {
+        const profileId = this.#getProfileIdOrThrow();
+        await this.messenger.call('ProfileService:deleteProfile', profileId);
+        this.update((state) => {
+            state.profile = getDefaultProfileControllerState().profile;
+            state.xProfile = undefined;
+        });
+    }
+    /**
+     * Checks whether a username is available.
+     *
+     * @param username - The username to check.
+     * @returns Availability details including validity and normalized form.
+     */
+    async checkUsernameAvailability(username) {
+        return await this.messenger.call('ProfileService:checkUsernameAvailability', username);
+    }
+    /**
+     * Completes the X OAuth PKCE flow, updates xProfile in state, and returns the X profile.
+     *
+     * @param params - The parameters for the X OAuth PKCE flow.
+     * @param params.code - The OAuth authorization code from the X redirect.
+     * @param params.state - The state parameter returned by the X redirect.
+     * @returns The linked X profile.
+     */
+    async connectX(params) {
+        const response = await this.messenger.call('ProfileService:connectX', params);
+        return this.#mapXResponseToXProfile(response);
+    }
+    /**
+     * Fetches the X account linked to the current profile, updates state, and returns the X profile.
+     *
+     * @returns The linked X profile.
+     */
+    async fetchAndUpdateXAccount() {
+        const response = await this.messenger.call('ProfileService:getXAccount');
+        const mapped = this.#mapXResponseToXProfile(response);
+        this.update((state) => {
+            state.xProfile = mapped;
+        });
+        return mapped;
+    }
+}
+//# sourceMappingURL=ProfileController.js.map

package/dist/ProfileController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProfileController.js","sourceRoot":"","sources":["../src/ProfileController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AA6B3D,MAAM,cAAc,GAAG,mBAAmB,CAAC;AA4F3C,gBAAgB;AAEhB,MAAM,yBAAyB,GAAG;IAChC,OAAO,EAAE;QACP,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,IAAI;KACf;IACD,QAAQ,EAAE;QACR,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,IAAI;KACf;CAC8C,CAAC;AAElD;;;;GAIG;AACH,MAAM,UAAU,gCAAgC;IAC9C,OAAO;QACL,OAAO,EAAE;YACP,SAAS,EAAE,EAAE;YACb,QAAQ,EAAE,EAAE;YACZ,WAAW,EAAE,EAAE;YACf,GAAG,EAAE,EAAE;YACP,eAAe,EAAE,EAAE;YACnB,SAAS,EAAE,EAAE;YACb,cAAc,EAAE,QAAQ;YACxB,YAAY,EAAE,KAAK;YACnB,SAAS,EAAE,EAAE;YACb,SAAS,EAAE,EAAE;SACd;KACF,CAAC;AACJ,CAAC;AAED,MAAM,yBAAyB,GAAG;IAChC,YAAY;IACZ,aAAa;IACb,eAAe;IACf,gBAAgB;IAChB,eAAe;IACf,eAAe;IACf,2BAA2B;IAC3B,UAAU;IACV,wBAAwB;CAChB,CAAC;AAEX,qBAAqB;AAErB,qFAAqF;AACrF,MAAM,OAAO,iBAAkB,SAAQ,cAItC;IACC;;;;;;OAMG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,SAAS;YACT,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,yBAAyB;YACnC,KAAK,EAAE;gBACL,GAAG,gCAAgC,EAAE;gBACrC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,KAAK,EAAE,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,oBAAoB;QAClB,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;QACzC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAClE,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACH,wBAAwB,CAAC,QAA4B;QACnD,OAAO;YACL,SAAS,EAAE,QAAQ,CAAC,UAAU;YAC9B,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,WAAW,EAAE,QAAQ,CAAC,YAAY;YAClC,GAAG,EAAE,QAAQ,CAAC,GAAG,IAAI,EAAE;YACvB,eAAe,EAAE,QAAQ,CAAC,gBAAgB;YAC1C,SAAS,EAAE,QAAQ,CAAC,UAAU,IAAI,EAAE;YACpC,cAAc,EAAE,QAAQ,CAAC,eAAe;YACxC,YAAY,EAAE,QAAQ,CAAC,cAAc;YACrC,SAAS,EAAE,QAAQ,CAAC,UAAU;YAC9B,SAAS,EAAE,QAAQ,CAAC,UAAU;SAC/B,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,uBAAuB,CAAC,QAA0B;QAChD,OAAO;YACL,OAAO,EAAE,QAAQ,CAAC,SAAS;YAC3B,WAAW,EAAE,QAAQ,CAAC,aAAa;YACnC,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,WAAW,EAAE,QAAQ,CAAC,YAAY;YAClC,SAAS,EAAE,QAAQ,CAAC,UAAU;YAC9B,SAAS,EAAE,QAAQ,CAAC,UAAU;YAC9B,SAAS,EAAE,QAAQ,CAAC,UAAU;SAC/B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,UAAU;QACR,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,aAAa,CAAC,MAA2B;QAC7C,MAAM,QAAQ,GAA0B,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAC/D,8BAA8B,EAC9B,MAAM,CACP,CAAC;QACF,MAAM,MAAM,GAAG,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;QACvD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC;YACvB,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;gBACvB,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YACpE,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAC,KAA2B;QAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC9C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACxC,+BAA+B,EAC/B,SAAS,EACT,KAAK,CACN,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,KAA0B;QAC5C,MAAM,SAAS,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC9C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACxC,8BAA8B,EAC9B,SAAS,EACT,KAAK,CACN,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa;QACjB,MAAM,SAAS,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC9C,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,8BAA8B,EAAE,SAAS,CAAC,CAAC;QACrE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,OAAO,GAAG,gCAAgC,EAAE,CAAC,OAAO,CAAC;YAC3D,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,yBAAyB,CAC7B,QAAgB;QAEhB,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAC9B,0CAA0C,EAC1C,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,QAAQ,CAAC,MAAuC;QACpD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACxC,yBAAyB,EACzB,MAAM,CACP,CAAC;QACF,OAAO,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,sBAAsB;QAC1B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QACzE,MAAM,MAAM,GAAG,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;QACtD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,QAAQ,GAAG,MAAM,CAAC;QAC1B,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;CACF","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport type { CaipAccountId } from '@metamask/utils';\n\nimport type { ProfileControllerMethodActions } from './ProfileController-method-action-types.js';\nimport type {\n  ProfileServiceCheckUsernameAvailabilityAction,\n  ProfileServiceConnectXAction,\n  ProfileServiceCreateProfileAction,\n  ProfileServiceDeleteProfileAction,\n  ProfileServiceGetXAccountAction,\n  ProfileServiceReplaceProfileAction,\n  ProfileServiceUpdateProfileAction,\n} from './ProfileService-method-action-types.js';\nimport type {\n  CreateProfileParams,\n  CreateProfileResponse,\n  ProfileApiResponse,\n  ReplaceProfileParams,\n  UpdateProfileParams,\n  UsernameAvailabilityResponse,\n  XConnectResponse,\n} from './ProfileService.js';\n\nconst controllerName = 'ProfileController';\n\n// === TYPES ===\n\n/** Representation of a profile stored in controller state. */\nexport type Profile = {\n  /** The canonical profile ID connected to the profile. */\n  profileId: string;\n  /** The username for the profile. */\n  username: string;\n  /** The display name for the profile. */\n  displayName: string;\n  /** The bio for the profile. */\n  bio: string;\n  /** The linked addresses for the profile. */\n  linkedAddresses: CaipAccountId[];\n  /** The avatar URL for the profile. */\n  avatarUrl: string;\n  /** Whether the profile's trading activity is visible to the public. */\n  tradingPrivacy: 'public' | 'private';\n  /** Whether the profile is connected to X. */\n  connectedToX: boolean;\n  /** The date and time the profile was created. */\n  createdAt: string;\n  /** The date and time the profile was updated. */\n  updatedAt: string;\n};\n\n/** Representation of a linked X (Twitter) profile stored in controller state. */\nexport type XProfile = {\n  /** The unique identifier for the X profile. This is the user ID of the X profile. */\n  xUserId: string;\n  /** The URL for the X profile. */\n  xProfileUrl: string;\n  /** The username for the X profile. */\n  username: string;\n  /** The display name for the X profile. */\n  displayName: string;\n  /** The avatar URL for the X profile. */\n  avatarUrl: string;\n  /** The date and time the X profile was created. */\n  createdAt: string;\n  /** The date and time the X profile was updated. */\n  updatedAt: string;\n};\n\n/** State managed by ProfileController. */\nexport type ProfileControllerState = {\n  profile: Profile;\n  xProfile?: XProfile;\n};\n\n// === MESSENGER ===\n\n/** The `ProfileController:getState` action type. */\nexport type ProfileControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  ProfileControllerState\n>;\n\n/** Union of all actions exposed by ProfileController. */\nexport type ProfileControllerActions =\n  | ProfileControllerGetStateAction\n  | ProfileControllerMethodActions;\n\n/** The `ProfileController:stateChanged` event type. */\nexport type ProfileControllerChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  ProfileControllerState\n>;\n\n/** Union of all events emitted by ProfileController. */\nexport type ProfileControllerEvents = ProfileControllerChangeEvent;\n\ntype AllowedActions =\n  | ProfileServiceCreateProfileAction\n  | ProfileServiceReplaceProfileAction\n  | ProfileServiceUpdateProfileAction\n  | ProfileServiceDeleteProfileAction\n  | ProfileServiceCheckUsernameAvailabilityAction\n  | ProfileServiceConnectXAction\n  | ProfileServiceGetXAccountAction;\n\nexport type AllowedEvents = never;\n\n/** Messenger type for ProfileController, scoped to its actions, events, and allowed service calls. */\nexport type ProfileControllerMessenger = Messenger<\n  typeof controllerName,\n  ProfileControllerActions | AllowedActions,\n  ProfileControllerEvents | AllowedEvents\n>;\n\n// === STATE ===\n\nconst profileControllerMetadata = {\n  profile: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: false,\n    usedInUi: true,\n  },\n  xProfile: {\n    includeInStateLogs: false,\n    persist: true,\n    includeInDebugSnapshot: false,\n    usedInUi: true,\n  },\n} satisfies StateMetadata<ProfileControllerState>;\n\n/**\n * Returns the default initial state for ProfileController.\n *\n * @returns A ProfileControllerState with empty profile fields and no X profile.\n */\nexport function getDefaultProfileControllerState(): ProfileControllerState {\n  return {\n    profile: {\n      profileId: '',\n      username: '',\n      displayName: '',\n      bio: '',\n      linkedAddresses: [],\n      avatarUrl: '',\n      tradingPrivacy: 'public',\n      connectedToX: false,\n      createdAt: '',\n      updatedAt: '',\n    },\n  };\n}\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'getProfile',\n  'getXProfile',\n  'createProfile',\n  'replaceProfile',\n  'updateProfile',\n  'deleteProfile',\n  'checkUsernameAvailability',\n  'connectX',\n  'fetchAndUpdateXAccount',\n] as const;\n\n// === CONTROLLER ===\n\n/** Manages MetaMask profile state and delegates API operations to ProfileService. */\nexport class ProfileController extends BaseController<\n  typeof controllerName,\n  ProfileControllerState,\n  ProfileControllerMessenger\n> {\n  /**\n   * Creates a new ProfileController instance.\n   *\n   * @param options - Constructor options.\n   * @param options.messenger - The messenger scoped to ProfileController.\n   * @param options.state - Optional partial initial state to merge with defaults.\n   */\n  constructor({\n    messenger,\n    state,\n  }: {\n    messenger: ProfileControllerMessenger;\n    state?: Partial<ProfileControllerState>;\n  }) {\n    super({\n      messenger,\n      name: controllerName,\n      metadata: profileControllerMetadata,\n      state: {\n        ...getDefaultProfileControllerState(),\n        ...state,\n      },\n    });\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Returns true if a profile has been created and exists in state.\n   *\n   * @returns True if a profile exists, false otherwise.\n   */\n  #hasProfile(): boolean {\n    return this.state.profile.profileId !== '';\n  }\n\n  /**\n   * Returns the profile ID from state, throwing if no profile exists yet.\n   *\n   * @returns The current profile ID.\n   * @throws If no profile has been created.\n   */\n  #getProfileIdOrThrow(): string {\n    const { profileId } = this.state.profile;\n    if (!profileId) {\n      throw new Error('ProfileController: no profile found in state');\n    }\n    return profileId;\n  }\n\n  /**\n   * Maps an API response to a MetaMask profile.\n   *\n   * @param response - The API response to map.\n   * @returns The mapped MetaMask profile.\n   */\n  #mapApiResponseToProfile(response: ProfileApiResponse): Profile {\n    return {\n      profileId: response.profile_id,\n      username: response.username,\n      displayName: response.display_name,\n      bio: response.bio ?? '',\n      linkedAddresses: response.linked_addresses,\n      avatarUrl: response.avatar_url ?? '',\n      tradingPrivacy: response.trading_privacy,\n      connectedToX: response.connected_to_x,\n      createdAt: response.created_at,\n      updatedAt: response.updated_at,\n    };\n  }\n\n  /**\n   * Maps an API response to an X profile.\n   *\n   * @param response - The API response to map.\n   * @returns The mapped X profile.\n   */\n  #mapXResponseToXProfile(response: XConnectResponse): XProfile {\n    return {\n      xUserId: response.x_user_id,\n      xProfileUrl: response.x_profile_url,\n      username: response.username,\n      displayName: response.display_name,\n      avatarUrl: response.avatar_url,\n      createdAt: response.created_at,\n      updatedAt: response.updated_at,\n    };\n  }\n\n  /**\n   * Returns the current MetaMask profile from state, or undefined if none has been created.\n   *\n   * @returns The MetaMask profile, or undefined.\n   */\n  getProfile(): Profile | undefined {\n    if (!this.#hasProfile()) {\n      return undefined;\n    }\n    return this.state.profile;\n  }\n\n  /**\n   * Returns the currently linked X profile from state, or undefined if none has been connected.\n   *\n   * @returns The X profile, or undefined.\n   */\n  getXProfile(): XProfile | undefined {\n    return this.state.xProfile;\n  }\n\n  /**\n   * Creates a new MetaMask profile, updates state, and returns the created profile.\n   * If the user had previously connected X, also updates xProfile in state.\n   *\n   * @param params - The profile creation parameters.\n   * @returns The created MetaMask profile.\n   */\n  async createProfile(params: CreateProfileParams): Promise<Profile> {\n    const response: CreateProfileResponse = await this.messenger.call(\n      'ProfileService:createProfile',\n      params,\n    );\n    const mapped = this.#mapApiResponseToProfile(response);\n    this.update((state) => {\n      state.profile = mapped;\n      if (response.x_profile) {\n        state.xProfile = this.#mapXResponseToXProfile(response.x_profile);\n      }\n    });\n    return mapped;\n  }\n\n  /**\n   * Fully replaces the current profile and updates state.\n   *\n   * @param input - The replacement profile data.\n   * @throws If no profile has been created yet.\n   */\n  async replaceProfile(input: ReplaceProfileParams): Promise<void> {\n    const profileId = this.#getProfileIdOrThrow();\n    const response = await this.messenger.call(\n      'ProfileService:replaceProfile',\n      profileId,\n      input,\n    );\n    this.update((state) => {\n      state.profile = this.#mapApiResponseToProfile(response);\n    });\n  }\n\n  /**\n   * Partially updates the current profile and updates state.\n   *\n   * @param input - The fields to update.\n   * @throws If no profile has been created yet.\n   */\n  async updateProfile(input: UpdateProfileParams): Promise<void> {\n    const profileId = this.#getProfileIdOrThrow();\n    const response = await this.messenger.call(\n      'ProfileService:updateProfile',\n      profileId,\n      input,\n    );\n    this.update((state) => {\n      state.profile = this.#mapApiResponseToProfile(response);\n    });\n  }\n\n  /**\n   * Deletes the current profile and resets state, including clearing any linked X profile.\n   *\n   * @throws If no profile has been created yet.\n   */\n  async deleteProfile(): Promise<void> {\n    const profileId = this.#getProfileIdOrThrow();\n    await this.messenger.call('ProfileService:deleteProfile', profileId);\n    this.update((state) => {\n      state.profile = getDefaultProfileControllerState().profile;\n      state.xProfile = undefined;\n    });\n  }\n\n  /**\n   * Checks whether a username is available.\n   *\n   * @param username - The username to check.\n   * @returns Availability details including validity and normalized form.\n   */\n  async checkUsernameAvailability(\n    username: string,\n  ): Promise<UsernameAvailabilityResponse> {\n    return await this.messenger.call(\n      'ProfileService:checkUsernameAvailability',\n      username,\n    );\n  }\n\n  /**\n   * Completes the X OAuth PKCE flow, updates xProfile in state, and returns the X profile.\n   *\n   * @param params - The parameters for the X OAuth PKCE flow.\n   * @param params.code - The OAuth authorization code from the X redirect.\n   * @param params.state - The state parameter returned by the X redirect.\n   * @returns The linked X profile.\n   */\n  async connectX(params: { code: string; state: string }): Promise<XProfile> {\n    const response = await this.messenger.call(\n      'ProfileService:connectX',\n      params,\n    );\n    return this.#mapXResponseToXProfile(response);\n  }\n\n  /**\n   * Fetches the X account linked to the current profile, updates state, and returns the X profile.\n   *\n   * @returns The linked X profile.\n   */\n  async fetchAndUpdateXAccount(): Promise<XProfile> {\n    const response = await this.messenger.call('ProfileService:getXAccount');\n    const mapped = this.#mapXResponseToXProfile(response);\n    this.update((state) => {\n      state.xProfile = mapped;\n    });\n    return mapped;\n  }\n}\n"]}

package/dist/ProfileService-method-action-types.d.ts

@@ -0,0 +1,117 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+import type { ProfileService } from './ProfileService.js';
+/**
+ * Fetches a profile by its identifier.
+ *
+ * @param profileId - The profile identifier to fetch.
+ * @returns The profile data from the API.
+ * @throws {HttpError} If the API returns a non-2xx response.
+ * @throws {StructError} If the response does not match the expected shape.
+ */
+export type ProfileServiceGetProfileAction = {
+    type: `ProfileService:getProfile`;
+    handler: ProfileService['getProfile'];
+};
+/**
+ * Creates a new MetaMask profile.
+ *
+ * @param params - The profile creation parameters.
+ * @returns The created profile data.
+ * @throws {HttpError} If the API returns a non-2xx response.
+ * @throws {StructError} If the response do not match the expected shape.
+ */
+export type ProfileServiceCreateProfileAction = {
+    type: `ProfileService:createProfile`;
+    handler: ProfileService['createProfile'];
+};
+/**
+ * Fully replaces an existing profile (PUT).
+ *
+ * @param profileId - The identifier of the profile to replace.
+ * @param params - The replacement profile data.
+ * @returns The updated profile data.
+ * @throws {HttpError} If the API returns a non-2xx response.
+ * @throws {StructError} If the response do not match the expected shape.
+ */
+export type ProfileServiceReplaceProfileAction = {
+    type: `ProfileService:replaceProfile`;
+    handler: ProfileService['replaceProfile'];
+};
+/**
+ * Partially updates an existing profile (PATCH).
+ *
+ * @param profileId - The identifier of the profile to update.
+ * @param params - The fields to update.
+ * @returns The updated profile data.
+ * @throws {HttpError} If the API returns a non-2xx response.
+ * @throws {StructError} If the response do not match the expected shape.
+ */
+export type ProfileServiceUpdateProfileAction = {
+    type: `ProfileService:updateProfile`;
+    handler: ProfileService['updateProfile'];
+};
+/**
+ * Deletes a profile by its identifier.
+ *
+ * @param profileId - The identifier of the profile to delete.
+ * @returns The result of the mutation.
+ * @throws {HttpError} If the API returns a non-2xx response.
+ */
+export type ProfileServiceDeleteProfileAction = {
+    type: `ProfileService:deleteProfile`;
+    handler: ProfileService['deleteProfile'];
+};
+/**
+ * Checks whether a username is available.
+ *
+ * @param username - The username to check.
+ * @returns Availability details including validity and normalized form.
+ * @throws {HttpError} If the API returns a non-2xx response.
+ * @throws {StructError} If the response does not match the expected shape.
+ */
+export type ProfileServiceCheckUsernameAvailabilityAction = {
+    type: `ProfileService:checkUsernameAvailability`;
+    handler: ProfileService['checkUsernameAvailability'];
+};
+/**
+ * Fetches the X OAuth PKCE authorization URL and its associated state parameter.
+ *
+ * @returns An object containing the authorization URL and the state token.
+ * @throws {HttpError} If the API returns a non-2xx response.
+ * @throws {StructError} If the response does not match the expected shape.
+ */
+export type ProfileServiceGetXAuthUrlAction = {
+    type: `ProfileService:getXAuthUrl`;
+    handler: ProfileService['getXAuthUrl'];
+};
+/**
+ * Completes the X OAuth PKCE flow and links the X account to the profile.
+ *
+ * @param params - The OAuth callback code and state from the X redirect.
+ * @returns The linked X account data.
+ * @throws {HttpError} If the API returns a non-2xx response.
+ * @throws {StructError} If the response does not match the expected shape.
+ */
+export type ProfileServiceConnectXAction = {
+    type: `ProfileService:connectX`;
+    handler: ProfileService['connectX'];
+};
+/**
+ * Fetches the X account currently linked to the authenticated profile.
+ *
+ * @returns The linked X account data.
+ * @throws {HttpError} If the API returns a non-2xx response.
+ * @throws {StructError} If the response does not match the expected shape.
+ */
+export type ProfileServiceGetXAccountAction = {
+    type: `ProfileService:getXAccount`;
+    handler: ProfileService['getXAccount'];
+};
+/**
+ * Union of all ProfileService action types.
+ */
+export type ProfileServiceMethodActions = ProfileServiceGetProfileAction | ProfileServiceCreateProfileAction | ProfileServiceReplaceProfileAction | ProfileServiceUpdateProfileAction | ProfileServiceDeleteProfileAction | ProfileServiceCheckUsernameAvailabilityAction | ProfileServiceGetXAuthUrlAction | ProfileServiceConnectXAction | ProfileServiceGetXAccountAction;
+//# sourceMappingURL=ProfileService-method-action-types.d.ts.map

package/dist/ProfileService-method-action-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProfileService-method-action-types.d.ts","sourceRoot":"","sources":["../src/ProfileService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D;;;;;;;GAOG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;CACvC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,cAAc,CAAC,eAAe,CAAC,CAAC;CAC1C,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,cAAc,CAAC,gBAAgB,CAAC,CAAC;CAC3C,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,cAAc,CAAC,eAAe,CAAC,CAAC;CAC1C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,cAAc,CAAC,eAAe,CAAC,CAAC;CAC1C,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,6CAA6C,GAAG;IAC1D,IAAI,EAAE,0CAA0C,CAAC;IACjD,OAAO,EAAE,cAAc,CAAC,2BAA2B,CAAC,CAAC;CACtD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,cAAc,CAAC,aAAa,CAAC,CAAC;CACxC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,yBAAyB,CAAC;IAChC,OAAO,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;CACrC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,cAAc,CAAC,aAAa,CAAC,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GACnC,8BAA8B,GAC9B,iCAAiC,GACjC,kCAAkC,GAClC,iCAAiC,GACjC,iCAAiC,GACjC,6CAA6C,GAC7C,+BAA+B,GAC/B,4BAA4B,GAC5B,+BAA+B,CAAC"}

package/dist/ProfileService-method-action-types.js

@@ -0,0 +1,6 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+export {};
+//# sourceMappingURL=ProfileService-method-action-types.js.map

package/dist/ProfileService-method-action-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProfileService-method-action-types.js","sourceRoot":"","sources":["../src/ProfileService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { ProfileService } from './ProfileService.js';\n\n/**\n * Fetches a profile by its identifier.\n *\n * @param profileId - The profile identifier to fetch.\n * @returns The profile data from the API.\n * @throws {HttpError} If the API returns a non-2xx response.\n * @throws {StructError} If the response does not match the expected shape.\n */\nexport type ProfileServiceGetProfileAction = {\n  type: `ProfileService:getProfile`;\n  handler: ProfileService['getProfile'];\n};\n\n/**\n * Creates a new MetaMask profile.\n *\n * @param params - The profile creation parameters.\n * @returns The created profile data.\n * @throws {HttpError} If the API returns a non-2xx response.\n * @throws {StructError} If the response do not match the expected shape.\n */\nexport type ProfileServiceCreateProfileAction = {\n  type: `ProfileService:createProfile`;\n  handler: ProfileService['createProfile'];\n};\n\n/**\n * Fully replaces an existing profile (PUT).\n *\n * @param profileId - The identifier of the profile to replace.\n * @param params - The replacement profile data.\n * @returns The updated profile data.\n * @throws {HttpError} If the API returns a non-2xx response.\n * @throws {StructError} If the response do not match the expected shape.\n */\nexport type ProfileServiceReplaceProfileAction = {\n  type: `ProfileService:replaceProfile`;\n  handler: ProfileService['replaceProfile'];\n};\n\n/**\n * Partially updates an existing profile (PATCH).\n *\n * @param profileId - The identifier of the profile to update.\n * @param params - The fields to update.\n * @returns The updated profile data.\n * @throws {HttpError} If the API returns a non-2xx response.\n * @throws {StructError} If the response do not match the expected shape.\n */\nexport type ProfileServiceUpdateProfileAction = {\n  type: `ProfileService:updateProfile`;\n  handler: ProfileService['updateProfile'];\n};\n\n/**\n * Deletes a profile by its identifier.\n *\n * @param profileId - The identifier of the profile to delete.\n * @returns The result of the mutation.\n * @throws {HttpError} If the API returns a non-2xx response.\n */\nexport type ProfileServiceDeleteProfileAction = {\n  type: `ProfileService:deleteProfile`;\n  handler: ProfileService['deleteProfile'];\n};\n\n/**\n * Checks whether a username is available.\n *\n * @param username - The username to check.\n * @returns Availability details including validity and normalized form.\n * @throws {HttpError} If the API returns a non-2xx response.\n * @throws {StructError} If the response does not match the expected shape.\n */\nexport type ProfileServiceCheckUsernameAvailabilityAction = {\n  type: `ProfileService:checkUsernameAvailability`;\n  handler: ProfileService['checkUsernameAvailability'];\n};\n\n/**\n * Fetches the X OAuth PKCE authorization URL and its associated state parameter.\n *\n * @returns An object containing the authorization URL and the state token.\n * @throws {HttpError} If the API returns a non-2xx response.\n * @throws {StructError} If the response does not match the expected shape.\n */\nexport type ProfileServiceGetXAuthUrlAction = {\n  type: `ProfileService:getXAuthUrl`;\n  handler: ProfileService['getXAuthUrl'];\n};\n\n/**\n * Completes the X OAuth PKCE flow and links the X account to the profile.\n *\n * @param params - The OAuth callback code and state from the X redirect.\n * @returns The linked X account data.\n * @throws {HttpError} If the API returns a non-2xx response.\n * @throws {StructError} If the response does not match the expected shape.\n */\nexport type ProfileServiceConnectXAction = {\n  type: `ProfileService:connectX`;\n  handler: ProfileService['connectX'];\n};\n\n/**\n * Fetches the X account currently linked to the authenticated profile.\n *\n * @returns The linked X account data.\n * @throws {HttpError} If the API returns a non-2xx response.\n * @throws {StructError} If the response does not match the expected shape.\n */\nexport type ProfileServiceGetXAccountAction = {\n  type: `ProfileService:getXAccount`;\n  handler: ProfileService['getXAccount'];\n};\n\n/**\n * Union of all ProfileService action types.\n */\nexport type ProfileServiceMethodActions =\n  | ProfileServiceGetProfileAction\n  | ProfileServiceCreateProfileAction\n  | ProfileServiceReplaceProfileAction\n  | ProfileServiceUpdateProfileAction\n  | ProfileServiceDeleteProfileAction\n  | ProfileServiceCheckUsernameAvailabilityAction\n  | ProfileServiceGetXAuthUrlAction\n  | ProfileServiceConnectXAction\n  | ProfileServiceGetXAccountAction;\n"]}