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

package/dist/ProfileService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProfileService.js","sourceRoot":"","sources":["../src/ProfileService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAO9D,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAGvD,OAAO,EACL,KAAK,EACL,OAAO,EACP,KAAK,EACL,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,MAAM,EACN,IAAI,IAAI,UAAU,GACnB,MAAM,uBAAuB,CAAC;AAG/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAItD,MAAM,CAAC,MAAM,WAAW,GAAG,gBAAgB,CAAC;AAE5C,8EAA8E;AAC9E,iBAAiB;AACjB,8EAA8E;AAE9E,uEAAuE;AACvE,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,kBAAkB,EAAE,yCAAyC;IAC7D,qBAAqB,EAAE,0CAA0C;IACjE,sBAAsB,EAAE,2CAA2C;IACnE,qBAAqB,EAAE,0CAA0C;IACjE,qBAAqB,EAAE,0CAA0C;IACjE,kCAAkC,EAChC,uDAAuD;IACzD,qBAAqB,EAAE,oDAAoD;IAC3E,gBAAgB,EAAE,6CAA6C;IAC/D,oBAAoB,EAAE,yCAAyC;CACvD,CAAC;AAEX,8EAA8E;AAC9E,sBAAsB;AACtB,8EAA8E;AAE9E,MAAM,oBAAoB,GAAG,KAAK,CAAC,CAAC,QAAQ,EAAE,SAAS,CAAU,CAAC,CAAC;AAEnE,MAAM,wBAAwB,GAAG,UAAU,CAAC;IAC1C,UAAU,EAAE,MAAM,EAAE;IACpB,QAAQ,EAAE,MAAM,EAAE;IAClB,YAAY,EAAE,MAAM,EAAE;IACtB,GAAG,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IACvB,gBAAgB,EAAE,KAAK,CAAC,mBAAmB,CAAC;IAC5C,UAAU,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC9B,eAAe,EAAE,oBAAoB;IACrC,cAAc,EAAE,OAAO,EAAE;IACzB,UAAU,EAAE,MAAM,EAAE;IACpB,UAAU,EAAE,MAAM,EAAE;CACrB,CAAC,CAAC;AAEH,MAAM,+BAA+B,GAAG,UAAU,CAAC;IACjD,IAAI,EAAE,MAAM,EAAE;IACd,OAAO,EAAE,MAAM,EAAE;CAClB,CAAC,CAAC;AAEH,MAAM,kCAAkC,GAAG,UAAU,CAAC;IACpD,QAAQ,EAAE,MAAM,EAAE;IAClB,SAAS,EAAE,OAAO,EAAE;IACpB,KAAK,EAAE,OAAO,EAAE;IAChB,UAAU,EAAE,MAAM,EAAE;IACpB,MAAM,EAAE,KAAK,CAAC,+BAA+B,CAAC;CAC/C,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,UAAU,CAAC;IACxC,GAAG,EAAE,SAAS,CAAC,MAAM,EAAE,CAAC;IACxB,KAAK,EAAE,SAAS,CAAC,MAAM,EAAE,CAAC;CAC3B,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,UAAU,CAAC;IACxC,SAAS,EAAE,MAAM,EAAE;IACnB,aAAa,EAAE,MAAM,EAAE;IACvB,QAAQ,EAAE,MAAM,EAAE;IAClB,YAAY,EAAE,MAAM,EAAE;IACtB,UAAU,EAAE,MAAM,EAAE;IACpB,UAAU,EAAE,MAAM,EAAE;IACpB,UAAU,EAAE,MAAM,EAAE;CACrB,CAAC,CAAC;AAEH,MAAM,2BAA2B,GAAG,YAAY,CAAC;IAC/C,wBAAwB;IACxB,UAAU,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,sBAAsB,CAAC,EAAE,CAAC;CAC5D,CAAC,CAAC;AAEH,MAAM,oBAAoB,GAAG,UAAU,CAAC;IACtC,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,CAAC;IACzB,KAAK,EAAE,SAAS,CAAC,MAAM,EAAE,CAAC;CAC3B,CAAC,CAAC;AAEH,MAAM,yBAAyB,GAAG,UAAU,CAAC;IAC3C,UAAU,EAAE,MAAM,EAAE;IACpB,QAAQ,EAAE,MAAM,EAAE;IAClB,YAAY,EAAE,MAAM,EAAE;IACtB,GAAG,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IACjC,gBAAgB,EAAE,KAAK,CAAC,mBAAmB,CAAC;IAC5C,UAAU,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC9B,eAAe,EAAE,oBAAoB;CACtC,CAAC,CAAC;AAEH,MAAM,0BAA0B,GAAG,UAAU,CAAC;IAC5C,QAAQ,EAAE,MAAM,EAAE;IAClB,YAAY,EAAE,MAAM,EAAE;IACtB,GAAG,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IACjC,gBAAgB,EAAE,KAAK,CAAC,mBAAmB,CAAC;IAC5C,UAAU,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC9B,eAAe,EAAE,oBAAoB;CACtC,CAAC,CAAC;AAEH,MAAM,yBAAyB,GAAG,UAAU,CAAC;IAC3C,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC5B,YAAY,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAChC,GAAG,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IACjC,gBAAgB,EAAE,QAAQ,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACtD,UAAU,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC9B,eAAe,EAAE,QAAQ,CAAC,oBAAoB,CAAC;CAChD,CAAC,CAAC;AAEH,8EAA8E;AAC9E,QAAQ;AACR,8EAA8E;AAE9E,MAAM,yBAAyB,GAAG;IAChC,YAAY;IACZ,eAAe;IACf,gBAAgB;IAChB,eAAe;IACf,eAAe;IACf,2BAA2B;IAC3B,aAAa;IACb,UAAU;IACV,aAAa;CACL,CAAC;AAqEX,8EAA8E;AAC9E,UAAU;AACV,8EAA8E;AAE9E,+FAA+F;AAC/F,MAAM,OAAO,cAAe,SAAQ,eAGnC;IACU,QAAQ,CAAS;IAE1B,IAAI,MAAM;QACR,OAAO,GAAG,IAAI,CAAC,QAAQ,KAAK,CAAC;IAC/B,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,EACV,SAAS,EACT,OAAO,EACP,aAAa,GAKd;QACC,KAAK,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC;QACvD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe;QACnB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACrC,yCAAyC,CAC1C,CAAC;QACF,OAAO,EAAE,aAAa,EAAE,UAAU,KAAK,EAAE,EAAE,CAAC;IAC9C,CAAC;IA4BD,KAAK,CAAC,MAAM,CACV,QAAgB,EAChB,EACE,MAAM,GAAG,KAAK,EACd,KAAK,EACL,IAAI,EACJ,YAAY,GAMb;QAED,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QACjD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,QAAQ,EAAE,CAAC,CAAC;QAClD,IAAI,YAAY,EAAE,CAAC;YACjB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;gBACxD,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE;YAC3C,GAAG,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;YACvC,OAAO,EAAE;gBACP,GAAG,WAAW;gBACd,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC;aACtE;YACD,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;SAC9D,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,KAAK,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACvE,CAAC;QACD,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAiB,CAAC;IACjD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,UAAU,CAAC,SAAiB;QAChC,OAAO,IAAI,CAAC,UAAU,CAAC;YACrB,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,aAAa,EAAE,SAAS,CAAC;YAChD,cAAc,EAAE,wBAAwB;YACxC,OAAO,EAAE,KAAK,IAAI,EAAE,CAClB,IAAI,CAAC,MAAM,CACT,YAAY,kBAAkB,CAAC,SAAS,CAAC,EAAE,EAC3C;gBACE,KAAK,EAAE,0BAA0B,CAAC,kBAAkB;aACrD,CACF;SACJ,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,aAAa,CACjB,MAA2B;QAE3B,OAAO,IAAI,CAAC,eAAe,CAAC;YAC1B,WAAW,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,gBAAgB,CAAC;YAC3C,cAAc,EAAE,2BAA2B;YAC3C,UAAU,EAAE,KAAK,IAAI,EAAE,CACrB,IAAI,CAAC,MAAM,CAAwB,UAAU,EAAE;gBAC7C,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,0BAA0B,CAAC,qBAAqB;gBACvD,IAAI,EAAE,MAAM;aACb,CAAC;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,cAAc,CAClB,SAAiB,EACjB,MAA4B;QAE5B,OAAO,IAAI,CAAC,eAAe,CAAC;YAC1B,WAAW,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,iBAAiB,EAAE,SAAS,CAAC;YACvD,cAAc,EAAE,wBAAwB;YACxC,UAAU,EAAE,KAAK,IAAI,EAAE,CACrB,IAAI,CAAC,MAAM,CACT,YAAY,kBAAkB,CAAC,SAAS,CAAC,EAAE,EAC3C;gBACE,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,0BAA0B,CAAC,sBAAsB;gBACxD,IAAI,EAAE,MAAM;aACb,CACF;SACJ,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,aAAa,CACjB,SAAiB,EACjB,MAA2B;QAE3B,OAAO,IAAI,CAAC,eAAe,CAAC;YAC1B,WAAW,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,gBAAgB,EAAE,SAAS,CAAC;YACtD,cAAc,EAAE,wBAAwB;YACxC,UAAU,EAAE,KAAK,IAAI,EAAE,CACrB,IAAI,CAAC,MAAM,CACT,YAAY,kBAAkB,CAAC,SAAS,CAAC,EAAE,EAC3C;gBACE,MAAM,EAAE,OAAO;gBACf,KAAK,EAAE,0BAA0B,CAAC,qBAAqB;gBACvD,IAAI,EAAE,MAAM;aACb,CACF;SACJ,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,aAAa,CAAC,SAAiB;QACnC,OAAO,IAAI,CAAC,eAAe,CAAC;YAC1B,WAAW,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,gBAAgB,EAAE,SAAS,CAAC;YACtD,UAAU,EAAE,KAAK,IAAI,EAAE,CACrB,IAAI,CAAC,MAAM,CAAC,YAAY,kBAAkB,CAAC,SAAS,CAAC,EAAE,EAAE;gBACvD,MAAM,EAAE,QAAQ;gBAChB,KAAK,EAAE,0BAA0B,CAAC,qBAAqB;aACxD,CAAC;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,yBAAyB,CAC7B,QAAgB;QAEhB,OAAO,IAAI,CAAC,UAAU,CAAC;YACrB,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,4BAA4B,EAAE,QAAQ,CAAC;YAC9D,SAAS,EAAE,CAAC;YACZ,cAAc,EAAE,kCAAkC;YAClD,OAAO,EAAE,KAAK,IAAI,EAAE,CAClB,IAAI,CAAC,MAAM,CACT,gCAAgC,EAChC;gBACE,KAAK,EACH,0BAA0B,CAAC,kCAAkC;gBAC/D,YAAY,EAAE,EAAE,QAAQ,EAAE;aAC3B,CACF;SACJ,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW;QACf,OAAO,IAAI,CAAC,eAAe,CAAC;YAC1B,WAAW,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,cAAc,CAAC;YACzC,cAAc,EAAE,sBAAsB;YACtC,UAAU,EAAE,KAAK,IAAI,EAAE,CACrB,IAAI,CAAC,MAAM,CAAmB,+BAA+B,EAAE;gBAC7D,KAAK,EAAE,0BAA0B,CAAC,qBAAqB;aACxD,CAAC;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,QAAQ,CAAC,MAAsB;QACnC,OAAO,IAAI,CAAC,eAAe,CAAC;YAC1B,WAAW,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,WAAW,CAAC;YACtC,cAAc,EAAE,sBAAsB;YACtC,UAAU,EAAE,KAAK,IAAI,EAAE,CACrB,IAAI,CAAC,MAAM,CAAmB,oBAAoB,EAAE;gBAClD,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,0BAA0B,CAAC,gBAAgB;gBAClD,IAAI,EAAE,MAAM;aACb,CAAC;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW;QACf,OAAO,IAAI,CAAC,UAAU,CAAC;YACrB,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,cAAc,CAAC;YACtC,SAAS,EAAE,CAAC;YACZ,cAAc,EAAE,sBAAsB;YACtC,OAAO,EAAE,KAAK,IAAI,EAAE,CAClB,IAAI,CAAC,MAAM,CAAmB,oBAAoB,EAAE;gBAClD,KAAK,EAAE,0BAA0B,CAAC,oBAAoB;aACvD,CAAC;SACL,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import { BaseDataService } from '@metamask/base-data-service';\nimport type {\n  CreateServicePolicyOptions,\n  DataServiceCacheUpdatedEvent,\n  DataServiceGranularCacheUpdatedEvent,\n  DataServiceInvalidateQueriesAction,\n} from '@metamask/base-data-service';\nimport { HttpError } from '@metamask/controller-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport type { AuthenticationController } from '@metamask/profile-sync-controller';\nimport {\n  array,\n  boolean,\n  enums,\n  intersection,\n  nullable,\n  optional,\n  sensitive,\n  string,\n  type as structType,\n} from '@metamask/superstruct';\nimport type { Infer } from '@metamask/superstruct';\nimport type { Json } from '@metamask/utils';\nimport { CaipAccountIdStruct } from '@metamask/utils';\n\nimport type { ProfileServiceMethodActions } from './ProfileService-method-action-types.js';\n\nexport const serviceName = 'ProfileService';\n\n// ---------------------------------------------------------------------------\n// Error messages\n// ---------------------------------------------------------------------------\n\n/** Human-readable error messages for each ProfileService operation. */\nexport const ProfileServiceErrorMessage = {\n  GET_PROFILE_FAILED: 'ProfileService: failed to fetch profile',\n  CREATE_PROFILE_FAILED: 'ProfileService: failed to create profile',\n  REPLACE_PROFILE_FAILED: 'ProfileService: failed to replace profile',\n  UPDATE_PROFILE_FAILED: 'ProfileService: failed to update profile',\n  DELETE_PROFILE_FAILED: 'ProfileService: failed to delete profile',\n  CHECK_USERNAME_AVAILABILITY_FAILED:\n    'ProfileService: failed to check username availability',\n  GET_X_AUTH_URL_FAILED: 'ProfileService: failed to get X authentication URL',\n  CONNECT_X_FAILED: 'ProfileService: failed to connect X account',\n  GET_X_ACCOUNT_FAILED: 'ProfileService: failed to get X account',\n} as const;\n\n// ---------------------------------------------------------------------------\n// Superstruct schemas\n// ---------------------------------------------------------------------------\n\nconst TradingPrivacyStruct = enums(['public', 'private'] as const);\n\nconst ProfileApiResponseStruct = structType({\n  profile_id: string(),\n  username: string(),\n  display_name: string(),\n  bio: nullable(string()),\n  linked_addresses: array(CaipAccountIdStruct),\n  avatar_url: nullable(string()),\n  trading_privacy: TradingPrivacyStruct,\n  connected_to_x: boolean(),\n  created_at: string(),\n  updated_at: string(),\n});\n\nconst UsernameAvailabilityErrorStruct = structType({\n  code: string(),\n  message: string(),\n});\n\nconst UsernameAvailabilityResponseStruct = structType({\n  username: string(),\n  available: boolean(),\n  valid: boolean(),\n  normalized: string(),\n  errors: array(UsernameAvailabilityErrorStruct),\n});\n\nconst XAuthUrlResponseStruct = structType({\n  url: sensitive(string()),\n  state: sensitive(string()),\n});\n\nconst XConnectResponseStruct = structType({\n  x_user_id: string(),\n  x_profile_url: string(),\n  username: string(),\n  display_name: string(),\n  avatar_url: string(),\n  created_at: string(),\n  updated_at: string(),\n});\n\nconst CreateProfileResponseStruct = intersection([\n  ProfileApiResponseStruct,\n  structType({ x_profile: optional(XConnectResponseStruct) }),\n]);\n\nconst ConnectXParamsStruct = structType({\n  code: sensitive(string()),\n  state: sensitive(string()),\n});\n\nconst CreateProfileParamsStruct = structType({\n  profile_id: string(),\n  username: string(),\n  display_name: string(),\n  bio: optional(nullable(string())),\n  linked_addresses: array(CaipAccountIdStruct),\n  avatar_url: optional(string()),\n  trading_privacy: TradingPrivacyStruct,\n});\n\nconst ReplaceProfileParamsStruct = structType({\n  username: string(),\n  display_name: string(),\n  bio: optional(nullable(string())),\n  linked_addresses: array(CaipAccountIdStruct),\n  avatar_url: optional(string()),\n  trading_privacy: TradingPrivacyStruct,\n});\n\nconst UpdateProfileParamsStruct = structType({\n  username: optional(string()),\n  display_name: optional(string()),\n  bio: optional(nullable(string())),\n  linked_addresses: optional(array(CaipAccountIdStruct)),\n  avatar_url: optional(string()),\n  trading_privacy: optional(TradingPrivacyStruct),\n});\n\n// ---------------------------------------------------------------------------\n// Types\n// ---------------------------------------------------------------------------\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'getProfile',\n  'createProfile',\n  'replaceProfile',\n  'updateProfile',\n  'deleteProfile',\n  'checkUsernameAvailability',\n  'getXAuthUrl',\n  'connectX',\n  'getXAccount',\n] as const;\n\n/** The shape of a profile returned by the MetaMask Profile API. */\nexport type ProfileApiResponse = Infer<typeof ProfileApiResponseStruct>;\n\n/** The response shape for createProfile — includes an optional linked X profile if the user had already connected X. */\nexport type CreateProfileResponse = Infer<typeof CreateProfileResponseStruct>;\n\n/** The response shape for a username availability check. */\nexport type UsernameAvailabilityResponse = Infer<\n  typeof UsernameAvailabilityResponseStruct\n>;\n\n/** The response shape returned when connecting or fetching an X account. */\nexport type XConnectResponse = Infer<typeof XConnectResponseStruct>;\n\n/** The response shape returned when requesting the X OAuth authentication URL. */\nexport type XAuthUrlResponse = Infer<typeof XAuthUrlResponseStruct>;\n\n/** Alias for {@link XConnectResponse} returned when fetching the linked X account. */\nexport type XAccountResponse = XConnectResponse;\n\n/** Parameters for creating a new MetaMask profile. */\nexport type CreateProfileParams = Infer<typeof CreateProfileParamsStruct>;\n\n/** Parameters for fully replacing an existing MetaMask profile (PUT). */\nexport type ReplaceProfileParams = Infer<typeof ReplaceProfileParamsStruct>;\n\n/** Parameters for partially updating an existing MetaMask profile (PATCH). */\nexport type UpdateProfileParams = Infer<typeof UpdateProfileParamsStruct>;\n\n/** Parameters for completing the X OAuth PKCE flow. */\nexport type ConnectXParams = Infer<typeof ConnectXParamsStruct>;\n\n// ---------------------------------------------------------------------------\n// Messenger types\n// ---------------------------------------------------------------------------\n\n/** Union of all actions exposed by ProfileService, including cache invalidation. */\nexport type ProfileServiceActions =\n  | ProfileServiceMethodActions\n  | DataServiceInvalidateQueriesAction<typeof serviceName>;\n\n/** Event emitted when the ProfileService query cache is updated. */\nexport type ProfileServiceCacheUpdatedEvent = DataServiceCacheUpdatedEvent<\n  typeof serviceName\n>;\n\n/** Event emitted with per-query granularity when the ProfileService cache is updated. */\nexport type ProfileServiceGranularCacheUpdatedEvent =\n  DataServiceGranularCacheUpdatedEvent<typeof serviceName>;\n\n/** Union of all events emitted by ProfileService. */\nexport type ProfileServiceEvents =\n  | ProfileServiceCacheUpdatedEvent\n  | ProfileServiceGranularCacheUpdatedEvent;\n\ntype AllowedActions =\n  AuthenticationController.AuthenticationControllerGetBearerTokenAction;\n\ntype AllowedEvents = never;\n\n/** Messenger type for ProfileService, scoped to its actions and events. */\nexport type ProfileServiceMessenger = Messenger<\n  typeof serviceName,\n  ProfileServiceActions | AllowedActions,\n  ProfileServiceEvents | AllowedEvents\n>;\n\n// ---------------------------------------------------------------------------\n// Service\n// ---------------------------------------------------------------------------\n\n/** Communicates with the MetaMask Profile API and exposes all operations via the messenger. */\nexport class ProfileService extends BaseDataService<\n  typeof serviceName,\n  ProfileServiceMessenger\n> {\n  readonly #baseUrl: string;\n\n  get #v1Url(): string {\n    return `${this.#baseUrl}/v1`;\n  }\n\n  /**\n   * Creates a new ProfileService instance.\n   *\n   * @param options - Constructor options.\n   * @param options.messenger - The messenger scoped to ProfileService.\n   * @param options.baseUrl - Base URL for the MetaMask Profile API.\n   * @param options.policyOptions - Optional service policy configuration.\n   */\n  constructor({\n    messenger,\n    baseUrl,\n    policyOptions,\n  }: {\n    messenger: ProfileServiceMessenger;\n    baseUrl: string;\n    policyOptions?: CreateServicePolicyOptions;\n  }) {\n    super({ name: serviceName, messenger, policyOptions });\n    this.#baseUrl = baseUrl;\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Gets the authentication headers for the request.\n   *\n   * @returns The authentication headers.\n   */\n  async #getAuthHeaders(): Promise<Record<string, string>> {\n    const token = await this.messenger.call(\n      'AuthenticationController:getBearerToken',\n    );\n    return { Authorization: `Bearer ${token}` };\n  }\n\n  /**\n   * Executes an authenticated HTTP request and returns the parsed JSON response.\n   *\n   * @param endpoint - The path relative to the v1 base URL.\n   * @param options - Request options.\n   * @param options.method - The HTTP method. Defaults to 'GET'.\n   * @param options.error - The error message to use if the response is not OK.\n   * @param options.json - Optional JSON body. If provided, sets Content-Type and serializes as body.\n   * @returns The parsed JSON response.\n   * @throws {HttpError} If the response is not a 2xx status code.\n   */\n  async #fetch(\n    endpoint: string,\n    options: { method: 'DELETE'; error: string },\n  ): Promise<null>;\n\n  async #fetch<ResponseType extends Json>(\n    endpoint: string,\n    options: {\n      method?: string;\n      error: string;\n      json?: unknown;\n      searchParams?: Record<string, string>;\n    },\n  ): Promise<ResponseType>;\n\n  async #fetch<ResponseType extends Json>(\n    endpoint: string,\n    {\n      method = 'GET',\n      error,\n      json,\n      searchParams,\n    }: {\n      method?: string;\n      error: string;\n      json?: unknown;\n      searchParams?: Record<string, string>;\n    },\n  ): Promise<ResponseType | null> {\n    const authHeaders = await this.#getAuthHeaders();\n    const url = new URL(`${this.#v1Url}/${endpoint}`);\n    if (searchParams) {\n      for (const [key, value] of Object.entries(searchParams)) {\n        url.searchParams.append(key, value);\n      }\n    }\n    const response = await fetch(url.toString(), {\n      ...(method === 'GET' ? {} : { method }),\n      headers: {\n        ...authHeaders,\n        ...(json === undefined ? {} : { 'Content-Type': 'application/json' }),\n      },\n      ...(json === undefined ? {} : { body: JSON.stringify(json) }),\n    });\n    if (!response.ok) {\n      throw new HttpError(response.status, `${error}: ${response.status}`);\n    }\n    if (method === 'DELETE') {\n      return null;\n    }\n    return (await response.json()) as ResponseType;\n  }\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   */\n  async getProfile(profileId: string): Promise<ProfileApiResponse> {\n    return this.fetchQuery({\n      queryKey: [`${this.name}:getProfile`, profileId],\n      responseStruct: ProfileApiResponseStruct,\n      queryFn: async () =>\n        this.#fetch<ProfileApiResponse>(\n          `profiles/${encodeURIComponent(profileId)}`,\n          {\n            error: ProfileServiceErrorMessage.GET_PROFILE_FAILED,\n          },\n        ),\n    });\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   */\n  async createProfile(\n    params: CreateProfileParams,\n  ): Promise<CreateProfileResponse> {\n    return this.executeMutation({\n      mutationKey: [`${this.name}:createProfile`],\n      responseStruct: CreateProfileResponseStruct,\n      mutationFn: async () =>\n        this.#fetch<CreateProfileResponse>('profiles', {\n          method: 'POST',\n          error: ProfileServiceErrorMessage.CREATE_PROFILE_FAILED,\n          json: params,\n        }),\n    });\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   */\n  async replaceProfile(\n    profileId: string,\n    params: ReplaceProfileParams,\n  ): Promise<ProfileApiResponse> {\n    return this.executeMutation({\n      mutationKey: [`${this.name}:replaceProfile`, profileId],\n      responseStruct: ProfileApiResponseStruct,\n      mutationFn: async () =>\n        this.#fetch<ProfileApiResponse>(\n          `profiles/${encodeURIComponent(profileId)}`,\n          {\n            method: 'PUT',\n            error: ProfileServiceErrorMessage.REPLACE_PROFILE_FAILED,\n            json: params,\n          },\n        ),\n    });\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   */\n  async updateProfile(\n    profileId: string,\n    params: UpdateProfileParams,\n  ): Promise<ProfileApiResponse> {\n    return this.executeMutation({\n      mutationKey: [`${this.name}:updateProfile`, profileId],\n      responseStruct: ProfileApiResponseStruct,\n      mutationFn: async () =>\n        this.#fetch<ProfileApiResponse>(\n          `profiles/${encodeURIComponent(profileId)}`,\n          {\n            method: 'PATCH',\n            error: ProfileServiceErrorMessage.UPDATE_PROFILE_FAILED,\n            json: params,\n          },\n        ),\n    });\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   */\n  async deleteProfile(profileId: string): Promise<void> {\n    return this.executeMutation({\n      mutationKey: [`${this.name}:deleteProfile`, profileId],\n      mutationFn: async () =>\n        this.#fetch(`profiles/${encodeURIComponent(profileId)}`, {\n          method: 'DELETE',\n          error: ProfileServiceErrorMessage.DELETE_PROFILE_FAILED,\n        }),\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   * @throws {HttpError} If the API returns a non-2xx response.\n   * @throws {StructError} If the response does not match the expected shape.\n   */\n  async checkUsernameAvailability(\n    username: string,\n  ): Promise<UsernameAvailabilityResponse> {\n    return this.fetchQuery({\n      queryKey: [`${this.name}:checkUsernameAvailability`, username],\n      staleTime: 0,\n      responseStruct: UsernameAvailabilityResponseStruct,\n      queryFn: async () =>\n        this.#fetch<UsernameAvailabilityResponse>(\n          'profiles/username/availability',\n          {\n            error:\n              ProfileServiceErrorMessage.CHECK_USERNAME_AVAILABILITY_FAILED,\n            searchParams: { username },\n          },\n        ),\n    });\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   */\n  async getXAuthUrl(): Promise<XAuthUrlResponse> {\n    return this.executeMutation({\n      mutationKey: [`${this.name}:getXAuthUrl`],\n      responseStruct: XAuthUrlResponseStruct,\n      mutationFn: async () =>\n        this.#fetch<XAuthUrlResponse>('profiles/x/authentication-url', {\n          error: ProfileServiceErrorMessage.GET_X_AUTH_URL_FAILED,\n        }),\n    });\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   */\n  async connectX(params: ConnectXParams): Promise<XConnectResponse> {\n    return this.executeMutation({\n      mutationKey: [`${this.name}:connectX`],\n      responseStruct: XConnectResponseStruct,\n      mutationFn: async () =>\n        this.#fetch<XConnectResponse>('profiles/x/connect', {\n          method: 'POST',\n          error: ProfileServiceErrorMessage.CONNECT_X_FAILED,\n          json: params,\n        }),\n    });\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   */\n  async getXAccount(): Promise<XAccountResponse> {\n    return this.fetchQuery({\n      queryKey: [`${this.name}:getXAccount`],\n      staleTime: 0,\n      responseStruct: XConnectResponseStruct,\n      queryFn: async () =>\n        this.#fetch<XConnectResponse>('profiles/x/account', {\n          error: ProfileServiceErrorMessage.GET_X_ACCOUNT_FAILED,\n        }),\n    });\n  }\n}\n"]}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export type { Profile, XProfile, ProfileControllerState, ProfileControllerGetStateAction, ProfileControllerActions, ProfileControllerChangeEvent, ProfileControllerEvents, ProfileControllerMessenger, } from './ProfileController.js';
+export { ProfileController, getDefaultProfileControllerState, } from './ProfileController.js';
+export type { ProfileControllerCheckUsernameAvailabilityAction, ProfileControllerConnectXAction, ProfileControllerCreateProfileAction, ProfileControllerDeleteProfileAction, ProfileControllerGetProfileAction, ProfileControllerFetchAndUpdateXAccountAction, ProfileControllerGetXProfileAction, ProfileControllerReplaceProfileAction, ProfileControllerUpdateProfileAction, } from './ProfileController-method-action-types.js';
+export type { ProfileApiResponse, CreateProfileResponse, CreateProfileParams, ReplaceProfileParams, UpdateProfileParams, ConnectXParams, UsernameAvailabilityResponse, XAuthUrlResponse, XConnectResponse, XAccountResponse, ProfileServiceActions, ProfileServiceEvents, ProfileServiceMessenger, } from './ProfileService.js';
+export { ProfileService, ProfileServiceErrorMessage, } from './ProfileService.js';
+export type { ProfileServiceCheckUsernameAvailabilityAction, ProfileServiceConnectXAction, ProfileServiceCreateProfileAction, ProfileServiceDeleteProfileAction, ProfileServiceGetProfileAction, ProfileServiceGetXAccountAction, ProfileServiceGetXAuthUrlAction, ProfileServiceReplaceProfileAction, ProfileServiceUpdateProfileAction, } from './ProfileService-method-action-types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,OAAO,EACP,QAAQ,EACR,sBAAsB,EACtB,+BAA+B,EAC/B,wBAAwB,EACxB,4BAA4B,EAC5B,uBAAuB,EACvB,0BAA0B,GAC3B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,iBAAiB,EACjB,gCAAgC,GACjC,MAAM,wBAAwB,CAAC;AAChC,YAAY,EACV,gDAAgD,EAChD,+BAA+B,EAC/B,oCAAoC,EACpC,oCAAoC,EACpC,iCAAiC,EACjC,6CAA6C,EAC7C,kCAAkC,EAClC,qCAAqC,EACrC,oCAAoC,GACrC,MAAM,4CAA4C,CAAC;AACpD,YAAY,EACV,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,mBAAmB,EACnB,cAAc,EACd,4BAA4B,EAC5B,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,GACxB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,cAAc,EACd,0BAA0B,GAC3B,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EACV,6CAA6C,EAC7C,4BAA4B,EAC5B,iCAAiC,EACjC,iCAAiC,EACjC,8BAA8B,EAC9B,+BAA+B,EAC/B,+BAA+B,EAC/B,kCAAkC,EAClC,iCAAiC,GAClC,MAAM,yCAAyC,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { ProfileController, getDefaultProfileControllerState, } from './ProfileController.js';
+export { ProfileService, ProfileServiceErrorMessage, } from './ProfileService.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAUA,OAAO,EACL,iBAAiB,EACjB,gCAAgC,GACjC,MAAM,wBAAwB,CAAC;AA2BhC,OAAO,EACL,cAAc,EACd,0BAA0B,GAC3B,MAAM,qBAAqB,CAAC","sourcesContent":["export type {\n  Profile,\n  XProfile,\n  ProfileControllerState,\n  ProfileControllerGetStateAction,\n  ProfileControllerActions,\n  ProfileControllerChangeEvent,\n  ProfileControllerEvents,\n  ProfileControllerMessenger,\n} from './ProfileController.js';\nexport {\n  ProfileController,\n  getDefaultProfileControllerState,\n} from './ProfileController.js';\nexport type {\n  ProfileControllerCheckUsernameAvailabilityAction,\n  ProfileControllerConnectXAction,\n  ProfileControllerCreateProfileAction,\n  ProfileControllerDeleteProfileAction,\n  ProfileControllerGetProfileAction,\n  ProfileControllerFetchAndUpdateXAccountAction,\n  ProfileControllerGetXProfileAction,\n  ProfileControllerReplaceProfileAction,\n  ProfileControllerUpdateProfileAction,\n} from './ProfileController-method-action-types.js';\nexport type {\n  ProfileApiResponse,\n  CreateProfileResponse,\n  CreateProfileParams,\n  ReplaceProfileParams,\n  UpdateProfileParams,\n  ConnectXParams,\n  UsernameAvailabilityResponse,\n  XAuthUrlResponse,\n  XConnectResponse,\n  XAccountResponse,\n  ProfileServiceActions,\n  ProfileServiceEvents,\n  ProfileServiceMessenger,\n} from './ProfileService.js';\nexport {\n  ProfileService,\n  ProfileServiceErrorMessage,\n} from './ProfileService.js';\nexport type {\n  ProfileServiceCheckUsernameAvailabilityAction,\n  ProfileServiceConnectXAction,\n  ProfileServiceCreateProfileAction,\n  ProfileServiceDeleteProfileAction,\n  ProfileServiceGetProfileAction,\n  ProfileServiceGetXAccountAction,\n  ProfileServiceGetXAuthUrlAction,\n  ProfileServiceReplaceProfileAction,\n  ProfileServiceUpdateProfileAction,\n} from './ProfileService-method-action-types.js';\n"]}

package/package.json

@@ -1,6 +1,76 @@
 {
   "name": "@metamask-previews/profile-controller",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0-preview-cecad39eb",
+  "description": "Controller for managing user profile data including username, bio, avatar, and linked accounts via the MetaMask Profile API",
+  "keywords": [
+    "Ethereum",
+    "MetaMask"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/profile-controller#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "license": "(MIT OR Apache-2.0)",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "files": [
+    "dist/"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "build:all": "tsc --build tsconfig.build.json --verbose",
+    "build:clean": "yarn build:only-clean && yarn build",
+    "build:docs": "typedoc",
+    "build:only-clean": "rimraf './dist' './tsconfig.build.tsbuildinfo'",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/profile-controller",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/profile-controller",
+    "lint:tsconfigs": "node --import ../../scripts/resolver/register.ts --experimental-transform-types ../../scripts/lint-tsconfigs/lint-tsconfigs.ts",
+    "lint:tsconfigs:fix": "node --import ../../scripts/resolver/register.ts --experimental-transform-types ../../scripts/lint-tsconfigs/lint-tsconfigs.ts --fix",
+    "messenger-action-types:check": "node --import ../../scripts/resolver/register.ts --experimental-transform-types ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --esm --check",
+    "messenger-action-types:generate": "node --import ../../scripts/resolver/register.ts --experimental-transform-types ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --esm --generate",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
+    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
+    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
+  },
+  "dependencies": {
+    "@metamask/base-controller": "^10.0.0",
+    "@metamask/base-data-service": "^2.1.0",
+    "@metamask/controller-utils": "^13.0.0",
+    "@metamask/messenger": "^3.0.0",
+    "@metamask/profile-sync-controller": "^33.0.0",
+    "@metamask/superstruct": "^3.4.1",
+    "@metamask/utils": "^12.0.0"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^6.2.1",
+    "@types/jest": "^30.0.0",
+    "@typescript/native": "npm:typescript@^7.0.2",
+    "deepmerge": "^4.3.1",
+    "jest": "^30.5.2",
+    "rimraf": "^6.1.3",
+    "ts-jest": "^29.4.14",
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "npm:@typescript/typescript6@^6.0.2"
+  },
+  "engines": {
+    "node": "^22.14.0 || ^24"
+  }
 }