@metamask-previews/profile-controller 0.0.0-stage → 1.0.0-preview-cecad39eb

package/dist/ProfileService.d.ts

@@ -0,0 +1,310 @@
+import { BaseDataService } from '@metamask/base-data-service';
+import type { CreateServicePolicyOptions, DataServiceCacheUpdatedEvent, DataServiceGranularCacheUpdatedEvent, DataServiceInvalidateQueriesAction } from '@metamask/base-data-service';
+import type { Messenger } from '@metamask/messenger';
+import type { AuthenticationController } from '@metamask/profile-sync-controller';
+import type { Infer } from '@metamask/superstruct';
+import type { ProfileServiceMethodActions } from './ProfileService-method-action-types.js';
+export declare const serviceName = "ProfileService";
+/** Human-readable error messages for each ProfileService operation. */
+export declare const ProfileServiceErrorMessage: {
+    readonly GET_PROFILE_FAILED: 'ProfileService: failed to fetch profile';
+    readonly CREATE_PROFILE_FAILED: 'ProfileService: failed to create profile';
+    readonly REPLACE_PROFILE_FAILED: 'ProfileService: failed to replace profile';
+    readonly UPDATE_PROFILE_FAILED: 'ProfileService: failed to update profile';
+    readonly DELETE_PROFILE_FAILED: 'ProfileService: failed to delete profile';
+    readonly CHECK_USERNAME_AVAILABILITY_FAILED: 'ProfileService: failed to check username availability';
+    readonly GET_X_AUTH_URL_FAILED: 'ProfileService: failed to get X authentication URL';
+    readonly CONNECT_X_FAILED: 'ProfileService: failed to connect X account';
+    readonly GET_X_ACCOUNT_FAILED: 'ProfileService: failed to get X account';
+};
+declare const ProfileApiResponseStruct: import("@metamask/superstruct").Struct<{
+    profile_id: string;
+    username: string;
+    display_name: string;
+    bio: string | null;
+    linked_addresses: `${string}:${string}:${string}`[];
+    avatar_url: string | null;
+    trading_privacy: "private" | "public";
+    connected_to_x: boolean;
+    created_at: string;
+    updated_at: string;
+}, {
+    profile_id: import("@metamask/superstruct").Struct<string, null>;
+    username: import("@metamask/superstruct").Struct<string, null>;
+    display_name: import("@metamask/superstruct").Struct<string, null>;
+    bio: import("@metamask/superstruct").Struct<string | null, null>;
+    linked_addresses: import("@metamask/superstruct").Struct<`${string}:${string}:${string}`[], import("@metamask/superstruct").Struct<`${string}:${string}:${string}`, null>>;
+    avatar_url: import("@metamask/superstruct").Struct<string | null, null>;
+    trading_privacy: import("@metamask/superstruct").Struct<"private" | "public", {
+        private: "private";
+        public: "public";
+    }>;
+    connected_to_x: import("@metamask/superstruct").Struct<boolean, null>;
+    created_at: import("@metamask/superstruct").Struct<string, null>;
+    updated_at: import("@metamask/superstruct").Struct<string, null>;
+}>;
+declare const UsernameAvailabilityResponseStruct: import("@metamask/superstruct").Struct<{
+    username: string;
+    available: boolean;
+    valid: boolean;
+    normalized: string;
+    errors: {
+        code: string;
+        message: string;
+    }[];
+}, {
+    username: import("@metamask/superstruct").Struct<string, null>;
+    available: import("@metamask/superstruct").Struct<boolean, null>;
+    valid: import("@metamask/superstruct").Struct<boolean, null>;
+    normalized: import("@metamask/superstruct").Struct<string, null>;
+    errors: import("@metamask/superstruct").Struct<{
+        code: string;
+        message: string;
+    }[], import("@metamask/superstruct").Struct<{
+        code: string;
+        message: string;
+    }, {
+        code: import("@metamask/superstruct").Struct<string, null>;
+        message: import("@metamask/superstruct").Struct<string, null>;
+    }>>;
+}>;
+declare const XAuthUrlResponseStruct: import("@metamask/superstruct").Struct<{
+    url: string;
+    state: string;
+}, {
+    url: import("@metamask/superstruct").Struct<string, null>;
+    state: import("@metamask/superstruct").Struct<string, null>;
+}>;
+declare const XConnectResponseStruct: import("@metamask/superstruct").Struct<{
+    x_user_id: string;
+    x_profile_url: string;
+    username: string;
+    display_name: string;
+    avatar_url: string;
+    created_at: string;
+    updated_at: string;
+}, {
+    x_user_id: import("@metamask/superstruct").Struct<string, null>;
+    x_profile_url: import("@metamask/superstruct").Struct<string, null>;
+    username: import("@metamask/superstruct").Struct<string, null>;
+    display_name: import("@metamask/superstruct").Struct<string, null>;
+    avatar_url: import("@metamask/superstruct").Struct<string, null>;
+    created_at: import("@metamask/superstruct").Struct<string, null>;
+    updated_at: import("@metamask/superstruct").Struct<string, null>;
+}>;
+declare const CreateProfileResponseStruct: import("@metamask/superstruct").Struct<{
+    profile_id: string;
+    username: string;
+    display_name: string;
+    bio: string | null;
+    linked_addresses: `${string}:${string}:${string}`[];
+    avatar_url: string | null;
+    trading_privacy: "private" | "public";
+    connected_to_x: boolean;
+    created_at: string;
+    updated_at: string;
+} & {
+    x_profile?: {
+        x_user_id: string;
+        x_profile_url: string;
+        username: string;
+        display_name: string;
+        avatar_url: string;
+        created_at: string;
+        updated_at: string;
+    } | undefined;
+}, null>;
+declare const ConnectXParamsStruct: import("@metamask/superstruct").Struct<{
+    code: string;
+    state: string;
+}, {
+    code: import("@metamask/superstruct").Struct<string, null>;
+    state: import("@metamask/superstruct").Struct<string, null>;
+}>;
+declare const CreateProfileParamsStruct: import("@metamask/superstruct").Struct<{
+    profile_id: string;
+    username: string;
+    display_name: string;
+    bio?: string | null | undefined;
+    linked_addresses: `${string}:${string}:${string}`[];
+    avatar_url?: string | undefined;
+    trading_privacy: "private" | "public";
+}, {
+    profile_id: import("@metamask/superstruct").Struct<string, null>;
+    username: import("@metamask/superstruct").Struct<string, null>;
+    display_name: import("@metamask/superstruct").Struct<string, null>;
+    bio: import("@metamask/superstruct").Struct<string | null | undefined, null>;
+    linked_addresses: import("@metamask/superstruct").Struct<`${string}:${string}:${string}`[], import("@metamask/superstruct").Struct<`${string}:${string}:${string}`, null>>;
+    avatar_url: import("@metamask/superstruct").Struct<string | undefined, null>;
+    trading_privacy: import("@metamask/superstruct").Struct<"private" | "public", {
+        private: "private";
+        public: "public";
+    }>;
+}>;
+declare const ReplaceProfileParamsStruct: import("@metamask/superstruct").Struct<{
+    username: string;
+    display_name: string;
+    bio?: string | null | undefined;
+    linked_addresses: `${string}:${string}:${string}`[];
+    avatar_url?: string | undefined;
+    trading_privacy: "private" | "public";
+}, {
+    username: import("@metamask/superstruct").Struct<string, null>;
+    display_name: import("@metamask/superstruct").Struct<string, null>;
+    bio: import("@metamask/superstruct").Struct<string | null | undefined, null>;
+    linked_addresses: import("@metamask/superstruct").Struct<`${string}:${string}:${string}`[], import("@metamask/superstruct").Struct<`${string}:${string}:${string}`, null>>;
+    avatar_url: import("@metamask/superstruct").Struct<string | undefined, null>;
+    trading_privacy: import("@metamask/superstruct").Struct<"private" | "public", {
+        private: "private";
+        public: "public";
+    }>;
+}>;
+declare const UpdateProfileParamsStruct: import("@metamask/superstruct").Struct<{
+    username?: string | undefined;
+    display_name?: string | undefined;
+    bio?: string | null | undefined;
+    linked_addresses?: `${string}:${string}:${string}`[] | undefined;
+    avatar_url?: string | undefined;
+    trading_privacy?: "private" | "public" | undefined;
+}, {
+    username: import("@metamask/superstruct").Struct<string | undefined, null>;
+    display_name: import("@metamask/superstruct").Struct<string | undefined, null>;
+    bio: import("@metamask/superstruct").Struct<string | null | undefined, null>;
+    linked_addresses: import("@metamask/superstruct").Struct<`${string}:${string}:${string}`[] | undefined, import("@metamask/superstruct").Struct<`${string}:${string}:${string}`, null>>;
+    avatar_url: import("@metamask/superstruct").Struct<string | undefined, null>;
+    trading_privacy: import("@metamask/superstruct").Struct<"private" | "public" | undefined, {
+        private: "private";
+        public: "public";
+    }>;
+}>;
+/** The shape of a profile returned by the MetaMask Profile API. */
+export type ProfileApiResponse = Infer<typeof ProfileApiResponseStruct>;
+/** The response shape for createProfile — includes an optional linked X profile if the user had already connected X. */
+export type CreateProfileResponse = Infer<typeof CreateProfileResponseStruct>;
+/** The response shape for a username availability check. */
+export type UsernameAvailabilityResponse = Infer<typeof UsernameAvailabilityResponseStruct>;
+/** The response shape returned when connecting or fetching an X account. */
+export type XConnectResponse = Infer<typeof XConnectResponseStruct>;
+/** The response shape returned when requesting the X OAuth authentication URL. */
+export type XAuthUrlResponse = Infer<typeof XAuthUrlResponseStruct>;
+/** Alias for {@link XConnectResponse} returned when fetching the linked X account. */
+export type XAccountResponse = XConnectResponse;
+/** Parameters for creating a new MetaMask profile. */
+export type CreateProfileParams = Infer<typeof CreateProfileParamsStruct>;
+/** Parameters for fully replacing an existing MetaMask profile (PUT). */
+export type ReplaceProfileParams = Infer<typeof ReplaceProfileParamsStruct>;
+/** Parameters for partially updating an existing MetaMask profile (PATCH). */
+export type UpdateProfileParams = Infer<typeof UpdateProfileParamsStruct>;
+/** Parameters for completing the X OAuth PKCE flow. */
+export type ConnectXParams = Infer<typeof ConnectXParamsStruct>;
+/** Union of all actions exposed by ProfileService, including cache invalidation. */
+export type ProfileServiceActions = ProfileServiceMethodActions | DataServiceInvalidateQueriesAction<typeof serviceName>;
+/** Event emitted when the ProfileService query cache is updated. */
+export type ProfileServiceCacheUpdatedEvent = DataServiceCacheUpdatedEvent<typeof serviceName>;
+/** Event emitted with per-query granularity when the ProfileService cache is updated. */
+export type ProfileServiceGranularCacheUpdatedEvent = DataServiceGranularCacheUpdatedEvent<typeof serviceName>;
+/** Union of all events emitted by ProfileService. */
+export type ProfileServiceEvents = ProfileServiceCacheUpdatedEvent | ProfileServiceGranularCacheUpdatedEvent;
+type AllowedActions = AuthenticationController.AuthenticationControllerGetBearerTokenAction;
+type AllowedEvents = never;
+/** Messenger type for ProfileService, scoped to its actions and events. */
+export type ProfileServiceMessenger = Messenger<typeof serviceName, ProfileServiceActions | AllowedActions, ProfileServiceEvents | AllowedEvents>;
+/** Communicates with the MetaMask Profile API and exposes all operations via the messenger. */
+export declare class ProfileService extends BaseDataService<typeof serviceName, ProfileServiceMessenger> {
+    #private;
+    /**
+     * Creates a new ProfileService instance.
+     *
+     * @param options - Constructor options.
+     * @param options.messenger - The messenger scoped to ProfileService.
+     * @param options.baseUrl - Base URL for the MetaMask Profile API.
+     * @param options.policyOptions - Optional service policy configuration.
+     */
+    constructor({ messenger, baseUrl, policyOptions, }: {
+        messenger: ProfileServiceMessenger;
+        baseUrl: string;
+        policyOptions?: CreateServicePolicyOptions;
+    });
+    /**
+     * 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.
+     */
+    getProfile(profileId: string): Promise<ProfileApiResponse>;
+    /**
+     * 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.
+     */
+    createProfile(params: CreateProfileParams): Promise<CreateProfileResponse>;
+    /**
+     * 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.
+     */
+    replaceProfile(profileId: string, params: ReplaceProfileParams): Promise<ProfileApiResponse>;
+    /**
+     * 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.
+     */
+    updateProfile(profileId: string, params: UpdateProfileParams): Promise<ProfileApiResponse>;
+    /**
+     * 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.
+     */
+    deleteProfile(profileId: string): Promise<void>;
+    /**
+     * 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.
+     */
+    checkUsernameAvailability(username: string): Promise<UsernameAvailabilityResponse>;
+    /**
+     * 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.
+     */
+    getXAuthUrl(): Promise<XAuthUrlResponse>;
+    /**
+     * 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.
+     */
+    connectX(params: ConnectXParams): Promise<XConnectResponse>;
+    /**
+     * 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.
+     */
+    getXAccount(): Promise<XAccountResponse>;
+}
+export {};
+//# sourceMappingURL=ProfileService.d.ts.map

package/dist/ProfileService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProfileService.d.ts","sourceRoot":"","sources":["../src/ProfileService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EACV,0BAA0B,EAC1B,4BAA4B,EAC5B,oCAAoC,EACpC,kCAAkC,EACnC,MAAM,6BAA6B,CAAC;AAErC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAYlF,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAInD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AAE3F,eAAO,MAAM,WAAW,mBAAmB,CAAC;AAM5C,uEAAuE;AACvE,eAAO,MAAM,0BAA0B;aACrC,kBAAkB,EAAE,yCAAyC;aAC7D,qBAAqB,EAAE,0CAA0C;aACjE,sBAAsB,EAAE,2CAA2C;aACnE,qBAAqB,EAAE,0CAA0C;aACjE,qBAAqB,EAAE,0CAA0C;aACjE,kCAAkC,EAChC,uDAAuD;aACzD,qBAAqB,EAAE,oDAAoD;aAC3E,gBAAgB,EAAE,6CAA6C;aAC/D,oBAAoB,EAAE,yCAAyC;CACvD,CAAC;AAQX,QAAA,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;EAW5B,CAAC;AAOH,QAAA,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;EAMtC,CAAC;AAEH,QAAA,MAAM,sBAAsB;;;;;;EAG1B,CAAC;AAEH,QAAA,MAAM,sBAAsB;;;;;;;;;;;;;;;;EAQ1B,CAAC;AAEH,QAAA,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;QAG/B,CAAC;AAEH,QAAA,MAAM,oBAAoB;;;;;;EAGxB,CAAC;AAEH,QAAA,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;EAQ7B,CAAC;AAEH,QAAA,MAAM,0BAA0B;;;;;;;;;;;;;;;;;EAO9B,CAAC;AAEH,QAAA,MAAM,yBAAyB;;;;;;;;;;;;;;;;;EAO7B,CAAC;AAkBH,mEAAmE;AACnE,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAExE,wHAAwH;AACxH,MAAM,MAAM,qBAAqB,GAAG,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAE9E,4DAA4D;AAC5D,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAC9C,OAAO,kCAAkC,CAC1C,CAAC;AAEF,4EAA4E;AAC5E,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEpE,kFAAkF;AAClF,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEpE,sFAAsF;AACtF,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,CAAC;AAEhD,sDAAsD;AACtD,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE1E,yEAAyE;AACzE,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE5E,8EAA8E;AAC9E,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE1E,uDAAuD;AACvD,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAMhE,oFAAoF;AACpF,MAAM,MAAM,qBAAqB,GAC7B,2BAA2B,GAC3B,kCAAkC,CAAC,OAAO,WAAW,CAAC,CAAC;AAE3D,oEAAoE;AACpE,MAAM,MAAM,+BAA+B,GAAG,4BAA4B,CACxE,OAAO,WAAW,CACnB,CAAC;AAEF,yFAAyF;AACzF,MAAM,MAAM,uCAAuC,GACjD,oCAAoC,CAAC,OAAO,WAAW,CAAC,CAAC;AAE3D,qDAAqD;AACrD,MAAM,MAAM,oBAAoB,GAC5B,+BAA+B,GAC/B,uCAAuC,CAAC;AAE5C,KAAK,cAAc,GACjB,wBAAwB,CAAC,4CAA4C,CAAC;AAExE,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B,2EAA2E;AAC3E,MAAM,MAAM,uBAAuB,GAAG,SAAS,CAC7C,OAAO,WAAW,EAClB,qBAAqB,GAAG,cAAc,EACtC,oBAAoB,GAAG,aAAa,CACrC,CAAC;AAMF,+FAA+F;AAC/F,qBAAa,cAAe,SAAQ,eAAe,CACjD,OAAO,WAAW,EAClB,uBAAuB,CACxB;;IAOC;;;;;;;OAOG;IACH,YAAY,EACV,SAAS,EACT,OAAO,EACP,aAAa,GACd,EAAE;QACD,SAAS,EAAE,uBAAuB,CAAC;QACnC,OAAO,EAAE,MAAM,CAAC;QAChB,aAAa,CAAC,EAAE,0BAA0B,CAAC;KAC5C,EAQA;IA8ED;;;;;;;OAOG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAY/D;IAED;;;;;;;OAOG;IACG,aAAa,CACjB,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,qBAAqB,CAAC,CAWhC;IAED;;;;;;;;OAQG;IACG,cAAc,CAClB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,kBAAkB,CAAC,CAc7B;IAED;;;;;;;;OAQG;IACG,aAAa,CACjB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,kBAAkB,CAAC,CAc7B;IAED;;;;;;OAMG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CASpD;IAED;;;;;;;OAOG;IACG,yBAAyB,CAC7B,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,4BAA4B,CAAC,CAevC;IAED;;;;;;OAMG;IACG,WAAW,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAS7C;IAED;;;;;;;OAOG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAWhE;IAED;;;;;;OAMG;IACG,WAAW,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAU7C;CACF"}

package/dist/ProfileService.js

@@ -0,0 +1,327 @@
+import { BaseDataService } from '@metamask/base-data-service';
+import { HttpError } from '@metamask/controller-utils';
+import { array, boolean, enums, intersection, nullable, optional, sensitive, string, type as structType, } from '@metamask/superstruct';
+import { CaipAccountIdStruct } from '@metamask/utils';
+export const serviceName = 'ProfileService';
+// ---------------------------------------------------------------------------
+// Error messages
+// ---------------------------------------------------------------------------
+/** Human-readable error messages for each ProfileService operation. */
+export const ProfileServiceErrorMessage = {
+    GET_PROFILE_FAILED: 'ProfileService: failed to fetch profile',
+    CREATE_PROFILE_FAILED: 'ProfileService: failed to create profile',
+    REPLACE_PROFILE_FAILED: 'ProfileService: failed to replace profile',
+    UPDATE_PROFILE_FAILED: 'ProfileService: failed to update profile',
+    DELETE_PROFILE_FAILED: 'ProfileService: failed to delete profile',
+    CHECK_USERNAME_AVAILABILITY_FAILED: 'ProfileService: failed to check username availability',
+    GET_X_AUTH_URL_FAILED: 'ProfileService: failed to get X authentication URL',
+    CONNECT_X_FAILED: 'ProfileService: failed to connect X account',
+    GET_X_ACCOUNT_FAILED: 'ProfileService: failed to get X account',
+};
+// ---------------------------------------------------------------------------
+// Superstruct schemas
+// ---------------------------------------------------------------------------
+const TradingPrivacyStruct = enums(['public', 'private']);
+const ProfileApiResponseStruct = structType({
+    profile_id: string(),
+    username: string(),
+    display_name: string(),
+    bio: nullable(string()),
+    linked_addresses: array(CaipAccountIdStruct),
+    avatar_url: nullable(string()),
+    trading_privacy: TradingPrivacyStruct,
+    connected_to_x: boolean(),
+    created_at: string(),
+    updated_at: string(),
+});
+const UsernameAvailabilityErrorStruct = structType({
+    code: string(),
+    message: string(),
+});
+const UsernameAvailabilityResponseStruct = structType({
+    username: string(),
+    available: boolean(),
+    valid: boolean(),
+    normalized: string(),
+    errors: array(UsernameAvailabilityErrorStruct),
+});
+const XAuthUrlResponseStruct = structType({
+    url: sensitive(string()),
+    state: sensitive(string()),
+});
+const XConnectResponseStruct = structType({
+    x_user_id: string(),
+    x_profile_url: string(),
+    username: string(),
+    display_name: string(),
+    avatar_url: string(),
+    created_at: string(),
+    updated_at: string(),
+});
+const CreateProfileResponseStruct = intersection([
+    ProfileApiResponseStruct,
+    structType({ x_profile: optional(XConnectResponseStruct) }),
+]);
+const ConnectXParamsStruct = structType({
+    code: sensitive(string()),
+    state: sensitive(string()),
+});
+const CreateProfileParamsStruct = structType({
+    profile_id: string(),
+    username: string(),
+    display_name: string(),
+    bio: optional(nullable(string())),
+    linked_addresses: array(CaipAccountIdStruct),
+    avatar_url: optional(string()),
+    trading_privacy: TradingPrivacyStruct,
+});
+const ReplaceProfileParamsStruct = structType({
+    username: string(),
+    display_name: string(),
+    bio: optional(nullable(string())),
+    linked_addresses: array(CaipAccountIdStruct),
+    avatar_url: optional(string()),
+    trading_privacy: TradingPrivacyStruct,
+});
+const UpdateProfileParamsStruct = structType({
+    username: optional(string()),
+    display_name: optional(string()),
+    bio: optional(nullable(string())),
+    linked_addresses: optional(array(CaipAccountIdStruct)),
+    avatar_url: optional(string()),
+    trading_privacy: optional(TradingPrivacyStruct),
+});
+// ---------------------------------------------------------------------------
+// Types
+// ---------------------------------------------------------------------------
+const MESSENGER_EXPOSED_METHODS = [
+    'getProfile',
+    'createProfile',
+    'replaceProfile',
+    'updateProfile',
+    'deleteProfile',
+    'checkUsernameAvailability',
+    'getXAuthUrl',
+    'connectX',
+    'getXAccount',
+];
+// ---------------------------------------------------------------------------
+// Service
+// ---------------------------------------------------------------------------
+/** Communicates with the MetaMask Profile API and exposes all operations via the messenger. */
+export class ProfileService extends BaseDataService {
+    #baseUrl;
+    get #v1Url() {
+        return `${this.#baseUrl}/v1`;
+    }
+    /**
+     * Creates a new ProfileService instance.
+     *
+     * @param options - Constructor options.
+     * @param options.messenger - The messenger scoped to ProfileService.
+     * @param options.baseUrl - Base URL for the MetaMask Profile API.
+     * @param options.policyOptions - Optional service policy configuration.
+     */
+    constructor({ messenger, baseUrl, policyOptions, }) {
+        super({ name: serviceName, messenger, policyOptions });
+        this.#baseUrl = baseUrl;
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Gets the authentication headers for the request.
+     *
+     * @returns The authentication headers.
+     */
+    async #getAuthHeaders() {
+        const token = await this.messenger.call('AuthenticationController:getBearerToken');
+        return { Authorization: `Bearer ${token}` };
+    }
+    async #fetch(endpoint, { method = 'GET', error, json, searchParams, }) {
+        const authHeaders = await this.#getAuthHeaders();
+        const url = new URL(`${this.#v1Url}/${endpoint}`);
+        if (searchParams) {
+            for (const [key, value] of Object.entries(searchParams)) {
+                url.searchParams.append(key, value);
+            }
+        }
+        const response = await fetch(url.toString(), {
+            ...(method === 'GET' ? {} : { method }),
+            headers: {
+                ...authHeaders,
+                ...(json === undefined ? {} : { 'Content-Type': 'application/json' }),
+            },
+            ...(json === undefined ? {} : { body: JSON.stringify(json) }),
+        });
+        if (!response.ok) {
+            throw new HttpError(response.status, `${error}: ${response.status}`);
+        }
+        if (method === 'DELETE') {
+            return null;
+        }
+        return (await response.json());
+    }
+    /**
+     * 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.
+     */
+    async getProfile(profileId) {
+        return this.fetchQuery({
+            queryKey: [`${this.name}:getProfile`, profileId],
+            responseStruct: ProfileApiResponseStruct,
+            queryFn: async () => this.#fetch(`profiles/${encodeURIComponent(profileId)}`, {
+                error: ProfileServiceErrorMessage.GET_PROFILE_FAILED,
+            }),
+        });
+    }
+    /**
+     * 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.
+     */
+    async createProfile(params) {
+        return this.executeMutation({
+            mutationKey: [`${this.name}:createProfile`],
+            responseStruct: CreateProfileResponseStruct,
+            mutationFn: async () => this.#fetch('profiles', {
+                method: 'POST',
+                error: ProfileServiceErrorMessage.CREATE_PROFILE_FAILED,
+                json: params,
+            }),
+        });
+    }
+    /**
+     * 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.
+     */
+    async replaceProfile(profileId, params) {
+        return this.executeMutation({
+            mutationKey: [`${this.name}:replaceProfile`, profileId],
+            responseStruct: ProfileApiResponseStruct,
+            mutationFn: async () => this.#fetch(`profiles/${encodeURIComponent(profileId)}`, {
+                method: 'PUT',
+                error: ProfileServiceErrorMessage.REPLACE_PROFILE_FAILED,
+                json: params,
+            }),
+        });
+    }
+    /**
+     * 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.
+     */
+    async updateProfile(profileId, params) {
+        return this.executeMutation({
+            mutationKey: [`${this.name}:updateProfile`, profileId],
+            responseStruct: ProfileApiResponseStruct,
+            mutationFn: async () => this.#fetch(`profiles/${encodeURIComponent(profileId)}`, {
+                method: 'PATCH',
+                error: ProfileServiceErrorMessage.UPDATE_PROFILE_FAILED,
+                json: params,
+            }),
+        });
+    }
+    /**
+     * 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.
+     */
+    async deleteProfile(profileId) {
+        return this.executeMutation({
+            mutationKey: [`${this.name}:deleteProfile`, profileId],
+            mutationFn: async () => this.#fetch(`profiles/${encodeURIComponent(profileId)}`, {
+                method: 'DELETE',
+                error: ProfileServiceErrorMessage.DELETE_PROFILE_FAILED,
+            }),
+        });
+    }
+    /**
+     * 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.
+     */
+    async checkUsernameAvailability(username) {
+        return this.fetchQuery({
+            queryKey: [`${this.name}:checkUsernameAvailability`, username],
+            staleTime: 0,
+            responseStruct: UsernameAvailabilityResponseStruct,
+            queryFn: async () => this.#fetch('profiles/username/availability', {
+                error: ProfileServiceErrorMessage.CHECK_USERNAME_AVAILABILITY_FAILED,
+                searchParams: { username },
+            }),
+        });
+    }
+    /**
+     * 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.
+     */
+    async getXAuthUrl() {
+        return this.executeMutation({
+            mutationKey: [`${this.name}:getXAuthUrl`],
+            responseStruct: XAuthUrlResponseStruct,
+            mutationFn: async () => this.#fetch('profiles/x/authentication-url', {
+                error: ProfileServiceErrorMessage.GET_X_AUTH_URL_FAILED,
+            }),
+        });
+    }
+    /**
+     * 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.
+     */
+    async connectX(params) {
+        return this.executeMutation({
+            mutationKey: [`${this.name}:connectX`],
+            responseStruct: XConnectResponseStruct,
+            mutationFn: async () => this.#fetch('profiles/x/connect', {
+                method: 'POST',
+                error: ProfileServiceErrorMessage.CONNECT_X_FAILED,
+                json: params,
+            }),
+        });
+    }
+    /**
+     * 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.
+     */
+    async getXAccount() {
+        return this.fetchQuery({
+            queryKey: [`${this.name}:getXAccount`],
+            staleTime: 0,
+            responseStruct: XConnectResponseStruct,
+            queryFn: async () => this.#fetch('profiles/x/account', {
+                error: ProfileServiceErrorMessage.GET_X_ACCOUNT_FAILED,
+            }),
+        });
+    }
+}
+//# sourceMappingURL=ProfileService.js.map