@metamask/profile-sync-controller 0.5.0 → 0.7.0

package/CHANGELOG.md

@@ -7,6 +7,54 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.7.0]
+
+### Changed
+
+- update subpath exports to use new .d.cts definition files. ([#4709](https://github.com/MetaMask/core/pull/4709))
+- move profile-sync-sdk snap methods to snap auth class ([#4708](https://github.com/MetaMask/core/pull/4708))
+  - move and validate `connectSnap` and `isSnapConnected` methods to only be available for SRP auth.
+
+### Removed
+
+- test: remove unused test mock ([#4703](https://github.com/MetaMask/core/pull/4703))
+
+## [0.6.0]
+
+### Added
+
+- Add network synchronisation logic ([#4694](https://github.com/MetaMask/core/pull/4694), [#4687](https://github.com/MetaMask/core/pull/4687), [#4685](https://github.com/MetaMask/core/pull/4685), [#4684](https://github.com/MetaMask/core/pull/4684))
+- Add a `canSync` check for account synchronisation ([#4690](https://github.com/MetaMask/core/pull/4690))
+- Add `onAccountAdded` and `onAccountNameUpdated` events to `UserStorageController` ([#4707](https://github.com/MetaMask/core/pull/4707))
+
+### Changed
+
+- Bump `@metamask/snaps-sdk` from `^6.1.1` to `^6.5.0` ([#4689](https://github.com/MetaMask/core/pull/4689))
+- Bump `@metamask/snaps-utils` from `^7.8.1` to `^8.1.1` ([#4689](https://github.com/MetaMask/core/pull/4689))
+- Bump peer dependency `@metamask/snaps-controllers` from `^9.3.0` to `^9.7.0` ([#4689](https://github.com/MetaMask/core/pull/4689))
+
+### Removed
+
+- **BREAKING:** Remove `getAccountByAddress` action ([#4693](https://github.com/MetaMask/core/pull/4693))
+
+### Fixed
+
+- Produce and export ESM-compatible TypeScript type declaration files in addition to CommonJS-compatible declaration files ([#4648](https://github.com/MetaMask/core/pull/4648))
+  - Previously, this package shipped with only one variant of type declaration
+    files, and these files were only CommonJS-compatible, and the `exports`
+    field in `package.json` linked to these files. This is an anti-pattern and
+    was rightfully flagged by the
+    ["Are the Types Wrong?"](https://arethetypeswrong.github.io/) tool as
+    ["masquerading as CJS"](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseCJS.md).
+    All of the ATTW checks now pass.
+- Remove chunk files ([#4648](https://github.com/MetaMask/core/pull/4648)).
+  - Previously, the build tool we used to generate JavaScript files extracted
+    common code to "chunk" files. While this was intended to make this package
+    more tree-shakeable, it also made debugging more difficult for our
+    development teams. These chunk files are no longer present.
+- Remove extra slash when constructing user storage url ([#4702](https://github.com/MetaMask/core/pull/4702))
+- Await encryption promise ([#4705](https://github.com/MetaMask/core/pull/4705))
+
 ## [0.5.0]
 
 ### Added
@@ -149,7 +197,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@0.5.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@0.7.0...HEAD
+[0.7.0]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@0.6.0...@metamask/profile-sync-controller@0.7.0
+[0.6.0]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@0.5.0...@metamask/profile-sync-controller@0.6.0
 [0.5.0]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@0.4.0...@metamask/profile-sync-controller@0.5.0
 [0.4.0]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@0.3.0...@metamask/profile-sync-controller@0.4.0
 [0.3.0]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@0.2.1...@metamask/profile-sync-controller@0.3.0

package/auth/mocks/package.json

@@ -4,6 +4,6 @@
   "description": "",
   "license": "MIT",
   "sideEffects": false,
-  "main": "../../dist/controllers/authentication/__fixtures__/index.js",
-  "types": "../../dist/types/controllers/authentication/__fixtures__/index.d.ts"
+  "main": "../../dist/controllers/authentication/__fixtures__/index.cjs",
+  "types": "../../dist/controllers/authentication/__fixtures__/index.d.cts"
 }

package/auth/package.json

@@ -4,6 +4,6 @@
   "description": "",
   "license": "MIT",
   "sideEffects": false,
-  "main": "../dist/controllers/authentication/index.js",
-  "types": "../dist/types/controllers/authentication/index.d.ts"
+  "main": "../dist/controllers/authentication/index.cjs",
+  "types": "../dist/controllers/authentication/index.d.cts"
 }

package/dist/controllers/authentication/AuthenticationController.cjs

@@ -0,0 +1,211 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _AuthenticationController_instances, _AuthenticationController_metametrics, _AuthenticationController_isUnlocked, _AuthenticationController_keyringController, _AuthenticationController_registerMessageHandlers, _AuthenticationController_assertLoggedIn, _AuthenticationController_performAuthenticationFlow, _AuthenticationController_hasValidSession, _AuthenticationController__snapPublicKeyCache, _AuthenticationController_snapGetPublicKey, _AuthenticationController__snapSignMessageCache, _AuthenticationController_snapSignMessage;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultState = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const auth_snap_requests_1 = require("./auth-snap-requests.cjs");
+const services_1 = require("./services.cjs");
+const THIRTY_MIN_MS = 1000 * 60 * 30;
+const controllerName = 'AuthenticationController';
+exports.defaultState = {
+    isSignedIn: false,
+};
+const metadata = {
+    isSignedIn: {
+        persist: true,
+        anonymous: true,
+    },
+    sessionData: {
+        persist: true,
+        anonymous: false,
+    },
+};
+/**
+ * Controller that enables authentication for restricted endpoints.
+ * Used for Global Profile Syncing and Notifications
+ */
+class AuthenticationController extends base_controller_1.BaseController {
+    constructor({ messenger, state, metametrics, }) {
+        super({
+            messenger,
+            metadata,
+            name: controllerName,
+            state: { ...exports.defaultState, ...state },
+        });
+        _AuthenticationController_instances.add(this);
+        _AuthenticationController_metametrics.set(this, void 0);
+        _AuthenticationController_isUnlocked.set(this, false);
+        _AuthenticationController_keyringController.set(this, {
+            setupLockedStateSubscriptions: () => {
+                const { isUnlocked } = this.messagingSystem.call('KeyringController:getState');
+                __classPrivateFieldSet(this, _AuthenticationController_isUnlocked, isUnlocked, "f");
+                this.messagingSystem.subscribe('KeyringController:unlock', () => {
+                    __classPrivateFieldSet(this, _AuthenticationController_isUnlocked, true, "f");
+                });
+                this.messagingSystem.subscribe('KeyringController:lock', () => {
+                    __classPrivateFieldSet(this, _AuthenticationController_isUnlocked, false, "f");
+                });
+            },
+        });
+        _AuthenticationController__snapPublicKeyCache.set(this, void 0);
+        _AuthenticationController__snapSignMessageCache.set(this, {});
+        if (!metametrics) {
+            throw new Error('`metametrics` field is required');
+        }
+        __classPrivateFieldSet(this, _AuthenticationController_metametrics, metametrics, "f");
+        __classPrivateFieldGet(this, _AuthenticationController_keyringController, "f").setupLockedStateSubscriptions();
+        __classPrivateFieldGet(this, _AuthenticationController_instances, "m", _AuthenticationController_registerMessageHandlers).call(this);
+    }
+    async performSignIn() {
+        const { accessToken } = await __classPrivateFieldGet(this, _AuthenticationController_instances, "m", _AuthenticationController_performAuthenticationFlow).call(this);
+        return accessToken;
+    }
+    performSignOut() {
+        __classPrivateFieldGet(this, _AuthenticationController_instances, "m", _AuthenticationController_assertLoggedIn).call(this);
+        this.update((state) => {
+            state.isSignedIn = false;
+            state.sessionData = undefined;
+        });
+    }
+    async getBearerToken() {
+        __classPrivateFieldGet(this, _AuthenticationController_instances, "m", _AuthenticationController_assertLoggedIn).call(this);
+        if (__classPrivateFieldGet(this, _AuthenticationController_instances, "m", _AuthenticationController_hasValidSession).call(this, this.state.sessionData)) {
+            return this.state.sessionData.accessToken;
+        }
+        const { accessToken } = await __classPrivateFieldGet(this, _AuthenticationController_instances, "m", _AuthenticationController_performAuthenticationFlow).call(this);
+        return accessToken;
+    }
+    /**
+     * Will return a session profile.
+     * Throws if a user is not logged in.
+     *
+     * @returns profile for the session.
+     */
+    async getSessionProfile() {
+        __classPrivateFieldGet(this, _AuthenticationController_instances, "m", _AuthenticationController_assertLoggedIn).call(this);
+        if (__classPrivateFieldGet(this, _AuthenticationController_instances, "m", _AuthenticationController_hasValidSession).call(this, this.state.sessionData)) {
+            return this.state.sessionData.profile;
+        }
+        const { profile } = await __classPrivateFieldGet(this, _AuthenticationController_instances, "m", _AuthenticationController_performAuthenticationFlow).call(this);
+        return profile;
+    }
+    isSignedIn() {
+        return this.state.isSignedIn;
+    }
+}
+_AuthenticationController_metametrics = new WeakMap(), _AuthenticationController_isUnlocked = new WeakMap(), _AuthenticationController_keyringController = new WeakMap(), _AuthenticationController__snapPublicKeyCache = new WeakMap(), _AuthenticationController__snapSignMessageCache = new WeakMap(), _AuthenticationController_instances = new WeakSet(), _AuthenticationController_registerMessageHandlers = function _AuthenticationController_registerMessageHandlers() {
+    this.messagingSystem.registerActionHandler('AuthenticationController:getBearerToken', this.getBearerToken.bind(this));
+    this.messagingSystem.registerActionHandler('AuthenticationController:getSessionProfile', this.getSessionProfile.bind(this));
+    this.messagingSystem.registerActionHandler('AuthenticationController:isSignedIn', this.isSignedIn.bind(this));
+    this.messagingSystem.registerActionHandler('AuthenticationController:performSignIn', this.performSignIn.bind(this));
+    this.messagingSystem.registerActionHandler('AuthenticationController:performSignOut', this.performSignOut.bind(this));
+}, _AuthenticationController_assertLoggedIn = function _AuthenticationController_assertLoggedIn() {
+    if (!this.state.isSignedIn) {
+        throw new Error(`${controllerName}: Unable to call method, user is not authenticated`);
+    }
+}, _AuthenticationController_performAuthenticationFlow = async function _AuthenticationController_performAuthenticationFlow() {
+    try {
+        // 1. Nonce
+        const publicKey = await __classPrivateFieldGet(this, _AuthenticationController_instances, "m", _AuthenticationController_snapGetPublicKey).call(this);
+        const nonce = await (0, services_1.getNonce)(publicKey);
+        if (!nonce) {
+            throw new Error(`Unable to get nonce`);
+        }
+        // 2. Login
+        const rawMessage = (0, services_1.createLoginRawMessage)(nonce, publicKey);
+        const signature = await __classPrivateFieldGet(this, _AuthenticationController_instances, "m", _AuthenticationController_snapSignMessage).call(this, rawMessage);
+        const loginResponse = await (0, services_1.login)(rawMessage, signature, {
+            metametricsId: await __classPrivateFieldGet(this, _AuthenticationController_metametrics, "f").getMetaMetricsId(),
+            agent: __classPrivateFieldGet(this, _AuthenticationController_metametrics, "f").agent,
+        });
+        if (!loginResponse?.token) {
+            throw new Error(`Unable to login`);
+        }
+        const profile = {
+            identifierId: loginResponse.profile.identifier_id,
+            profileId: loginResponse.profile.profile_id,
+        };
+        // 3. Trade for Access Token
+        const accessToken = await (0, services_1.getAccessToken)(loginResponse.token, __classPrivateFieldGet(this, _AuthenticationController_metametrics, "f").agent);
+        if (!accessToken) {
+            throw new Error(`Unable to get Access Token`);
+        }
+        // Update Internal State
+        this.update((state) => {
+            state.isSignedIn = true;
+            const expiresIn = new Date();
+            expiresIn.setTime(expiresIn.getTime() + THIRTY_MIN_MS);
+            state.sessionData = {
+                profile,
+                accessToken,
+                expiresIn: expiresIn.toString(),
+            };
+        });
+        return {
+            profile,
+            accessToken,
+        };
+    }
+    catch (e) {
+        console.error('Failed to authenticate', e);
+        const errorMessage = e instanceof Error ? e.message : JSON.stringify(e ?? '');
+        throw new Error(`${controllerName}: Failed to authenticate - ${errorMessage}`);
+    }
+}, _AuthenticationController_hasValidSession = function _AuthenticationController_hasValidSession(sessionData) {
+    if (!sessionData) {
+        return false;
+    }
+    const prevDate = Date.parse(sessionData.expiresIn);
+    if (isNaN(prevDate)) {
+        return false;
+    }
+    const currentDate = new Date();
+    const diffMs = Math.abs(currentDate.getTime() - prevDate);
+    return THIRTY_MIN_MS > diffMs;
+}, _AuthenticationController_snapGetPublicKey = 
+/**
+ * Returns the auth snap public key.
+ *
+ * @returns The snap public key.
+ */
+async function _AuthenticationController_snapGetPublicKey() {
+    if (__classPrivateFieldGet(this, _AuthenticationController__snapPublicKeyCache, "f")) {
+        return __classPrivateFieldGet(this, _AuthenticationController__snapPublicKeyCache, "f");
+    }
+    if (!__classPrivateFieldGet(this, _AuthenticationController_isUnlocked, "f")) {
+        throw new Error('#snapGetPublicKey - unable to call snap, wallet is locked');
+    }
+    const result = (await this.messagingSystem.call('SnapController:handleRequest', (0, auth_snap_requests_1.createSnapPublicKeyRequest)()));
+    __classPrivateFieldSet(this, _AuthenticationController__snapPublicKeyCache, result, "f");
+    return result;
+}, _AuthenticationController_snapSignMessage = 
+/**
+ * Signs a specific message using an underlying auth snap.
+ *
+ * @param message - A specific tagged message to sign.
+ * @returns A Signature created by the snap.
+ */
+async function _AuthenticationController_snapSignMessage(message) {
+    if (__classPrivateFieldGet(this, _AuthenticationController__snapSignMessageCache, "f")[message]) {
+        return __classPrivateFieldGet(this, _AuthenticationController__snapSignMessageCache, "f")[message];
+    }
+    if (!__classPrivateFieldGet(this, _AuthenticationController_isUnlocked, "f")) {
+        throw new Error('#snapSignMessage - unable to call snap, wallet is locked');
+    }
+    const result = (await this.messagingSystem.call('SnapController:handleRequest', (0, auth_snap_requests_1.createSnapSignMessageRequest)(message)));
+    __classPrivateFieldGet(this, _AuthenticationController__snapSignMessageCache, "f")[message] = result;
+    return result;
+};
+exports.default = AuthenticationController;
+//# sourceMappingURL=AuthenticationController.cjs.map

package/dist/controllers/authentication/AuthenticationController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthenticationController.cjs","sourceRoot":"","sources":["../../../src/controllers/authentication/AuthenticationController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAMA,+DAA2D;AAQ3D,iEAG8B;AAC9B,6CAKoB;AAEpB,MAAM,aAAa,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,CAAC;AAErC,MAAM,cAAc,GAAG,0BAA0B,CAAC;AA8BrC,QAAA,YAAY,GAAkC;IACzD,UAAU,EAAE,KAAK;CAClB,CAAC;AACF,MAAM,QAAQ,GAAiD;IAC7D,UAAU,EAAE;QACV,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,IAAI;KAChB;IACD,WAAW,EAAE;QACX,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;CACF,CAAC;AA0DF;;;GAGG;AACH,MAAqB,wBAAyB,SAAQ,gCAIrD;IAsBC,YAAY,EACV,SAAS,EACT,KAAK,EACL,WAAW,GASZ;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ;YACR,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE,EAAE,GAAG,oBAAY,EAAE,GAAG,KAAK,EAAE;SACrC,CAAC,CAAC;;QAvCL,wDAA8B;QAE9B,+CAAc,KAAK,EAAC;QAEpB,sDAAqB;YACnB,6BAA6B,EAAE,GAAG,EAAE;gBAClC,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9C,4BAA4B,CAC7B,CAAC;gBACF,uBAAA,IAAI,wCAAe,UAAU,MAAA,CAAC;gBAE9B,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,0BAA0B,EAAE,GAAG,EAAE;oBAC9D,uBAAA,IAAI,wCAAe,IAAI,MAAA,CAAC;gBAC1B,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,wBAAwB,EAAE,GAAG,EAAE;oBAC5D,uBAAA,IAAI,wCAAe,KAAK,MAAA,CAAC;gBAC3B,CAAC,CAAC,CAAC;YACL,CAAC;SACF,EAAC;QAsMF,gEAAyC;QA4BzC,0DAA+D,EAAE,EAAC;QA5MhE,IAAI,CAAC,WAAW,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;SACpD;QAED,uBAAA,IAAI,yCAAgB,WAAW,MAAA,CAAC;QAEhC,uBAAA,IAAI,mDAAmB,CAAC,6BAA6B,EAAE,CAAC;QACxD,uBAAA,IAAI,8FAAyB,MAA7B,IAAI,CAA2B,CAAC;IAClC,CAAC;IAiCM,KAAK,CAAC,aAAa;QACxB,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,uBAAA,IAAI,gGAA2B,MAA/B,IAAI,CAA6B,CAAC;QAChE,OAAO,WAAW,CAAC;IACrB,CAAC;IAEM,cAAc;QACnB,uBAAA,IAAI,qFAAgB,MAApB,IAAI,CAAkB,CAAC;QAEvB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC;YACzB,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;QAChC,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,cAAc;QACzB,uBAAA,IAAI,qFAAgB,MAApB,IAAI,CAAkB,CAAC;QAEvB,IAAI,uBAAA,IAAI,sFAAiB,MAArB,IAAI,EAAkB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;YACjD,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC;SAC3C;QAED,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,uBAAA,IAAI,gGAA2B,MAA/B,IAAI,CAA6B,CAAC;QAChE,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,iBAAiB;QAC5B,uBAAA,IAAI,qFAAgB,MAApB,IAAI,CAAkB,CAAC;QAEvB,IAAI,uBAAA,IAAI,sFAAiB,MAArB,IAAI,EAAkB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;YACjD,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC;SACvC;QAED,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,uBAAA,IAAI,gGAA2B,MAA/B,IAAI,CAA6B,CAAC;QAC5D,OAAO,OAAO,CAAC;IACjB,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;IAC/B,CAAC;CAmJF;;IAzNG,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,yCAAyC,EACzC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAC/B,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,4CAA4C,EAC5C,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAClC,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,qCAAqC,EACrC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAC3B,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,wCAAwC,EACxC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAC9B,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,yCAAyC,EACzC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAC/B,CAAC;AACJ,CAAC;IAiDC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE;QAC1B,MAAM,IAAI,KAAK,CACb,GAAG,cAAc,oDAAoD,CACtE,CAAC;KACH;AACH,CAAC,wDAED,KAAK;IAIH,IAAI;QACF,WAAW;QACX,MAAM,SAAS,GAAG,MAAM,uBAAA,IAAI,uFAAkB,MAAtB,IAAI,CAAoB,CAAC;QACjD,MAAM,KAAK,GAAG,MAAM,IAAA,mBAAQ,EAAC,SAAS,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;SACxC;QAED,WAAW;QACX,MAAM,UAAU,GAAG,IAAA,gCAAqB,EAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC3D,MAAM,SAAS,GAAG,MAAM,uBAAA,IAAI,sFAAiB,MAArB,IAAI,EAAkB,UAAU,CAAC,CAAC;QAC1D,MAAM,aAAa,GAAG,MAAM,IAAA,gBAAK,EAAC,UAAU,EAAE,SAAS,EAAE;YACvD,aAAa,EAAE,MAAM,uBAAA,IAAI,6CAAa,CAAC,gBAAgB,EAAE;YACzD,KAAK,EAAE,uBAAA,IAAI,6CAAa,CAAC,KAAK;SAC/B,CAAC,CAAC;QACH,IAAI,CAAC,aAAa,EAAE,KAAK,EAAE;YACzB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;SACpC;QAED,MAAM,OAAO,GAAmB;YAC9B,YAAY,EAAE,aAAa,CAAC,OAAO,CAAC,aAAa;YACjD,SAAS,EAAE,aAAa,CAAC,OAAO,CAAC,UAAU;SAC5C,CAAC;QAEF,4BAA4B;QAC5B,MAAM,WAAW,GAAG,MAAM,IAAA,yBAAc,EACtC,aAAa,CAAC,KAAK,EACnB,uBAAA,IAAI,6CAAa,CAAC,KAAK,CACxB,CAAC;QACF,IAAI,CAAC,WAAW,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;SAC/C;QAED,wBAAwB;QACxB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC;YACxB,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;YAC7B,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,aAAa,CAAC,CAAC;YACvD,KAAK,CAAC,WAAW,GAAG;gBAClB,OAAO;gBACP,WAAW;gBACX,SAAS,EAAE,SAAS,CAAC,QAAQ,EAAE;aAChC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO;YACL,OAAO;YACP,WAAW;SACZ,CAAC;KACH;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,CAAC,KAAK,CAAC,wBAAwB,EAAE,CAAC,CAAC,CAAC;QAC3C,MAAM,YAAY,GAChB,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QAC3D,MAAM,IAAI,KAAK,CACb,GAAG,cAAc,8BAA8B,YAAY,EAAE,CAC9D,CAAC;KACH;AACH,CAAC,iGAGC,WAAoC;IAEpC,IAAI,CAAC,WAAW,EAAE;QAChB,OAAO,KAAK,CAAC;KACd;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IACnD,IAAI,KAAK,CAAC,QAAQ,CAAC,EAAE;QACnB,OAAO,KAAK,CAAC;KACd;IAED,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC;IAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,QAAQ,CAAC,CAAC;IAE1D,OAAO,aAAa,GAAG,MAAM,CAAC;AAChC,CAAC;AAID;;;;GAIG;AACH,KAAK;IACH,IAAI,uBAAA,IAAI,qDAAqB,EAAE;QAC7B,OAAO,uBAAA,IAAI,qDAAqB,CAAC;KAClC;IAED,IAAI,CAAC,uBAAA,IAAI,4CAAY,EAAE;QACrB,MAAM,IAAI,KAAK,CACb,2DAA2D,CAC5D,CAAC;KACH;IAED,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAC7C,8BAA8B,EAC9B,IAAA,+CAA0B,GAAE,CAC7B,CAAW,CAAC;IAEb,uBAAA,IAAI,iDAAwB,MAAM,MAAA,CAAC;IAEnC,OAAO,MAAM,CAAC;AAChB,CAAC;AAID;;;;;GAKG;AACH,KAAK,oDAAkB,OAA6B;IAClD,IAAI,uBAAA,IAAI,uDAAuB,CAAC,OAAO,CAAC,EAAE;QACxC,OAAO,uBAAA,IAAI,uDAAuB,CAAC,OAAO,CAAC,CAAC;KAC7C;IAED,IAAI,CAAC,uBAAA,IAAI,4CAAY,EAAE;QACrB,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAC;KACH;IAED,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAC7C,8BAA8B,EAC9B,IAAA,iDAA4B,EAAC,OAAO,CAAC,CACtC,CAAW,CAAC;IAEb,uBAAA,IAAI,uDAAuB,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC;IAE9C,OAAO,MAAM,CAAC;AAChB,CAAC;kBArRkB,wBAAwB","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedControllerMessenger,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type {\n  KeyringControllerGetStateAction,\n  KeyringControllerLockEvent,\n  KeyringControllerUnlockEvent,\n} from '@metamask/keyring-controller';\nimport type { HandleSnapRequest } from '@metamask/snaps-controllers';\n\nimport {\n  createSnapPublicKeyRequest,\n  createSnapSignMessageRequest,\n} from './auth-snap-requests';\nimport {\n  createLoginRawMessage,\n  getAccessToken,\n  getNonce,\n  login,\n} from './services';\n\nconst THIRTY_MIN_MS = 1000 * 60 * 30;\n\nconst controllerName = 'AuthenticationController';\n\n// State\ntype SessionProfile = {\n  identifierId: string;\n  profileId: string;\n};\n\ntype SessionData = {\n  /** profile - anonymous profile data for the given logged in user */\n  profile: SessionProfile;\n  /** accessToken - used to make requests authorized endpoints */\n  accessToken: string;\n  /** expiresIn - string date to determine if new access token is required  */\n  expiresIn: string;\n};\n\ntype MetaMetricsAuth = {\n  getMetaMetricsId: () => string | Promise<string>;\n  agent: 'extension' | 'mobile';\n};\n\nexport type AuthenticationControllerState = {\n  /**\n   * Global isSignedIn state.\n   * Can be used to determine if \"Profile Syncing\" is enabled.\n   */\n  isSignedIn: boolean;\n  sessionData?: SessionData;\n};\nexport const defaultState: AuthenticationControllerState = {\n  isSignedIn: false,\n};\nconst metadata: StateMetadata<AuthenticationControllerState> = {\n  isSignedIn: {\n    persist: true,\n    anonymous: true,\n  },\n  sessionData: {\n    persist: true,\n    anonymous: false,\n  },\n};\n\n// Messenger Actions\ntype CreateActionsObj<Controller extends keyof AuthenticationController> = {\n  [K in Controller]: {\n    type: `${typeof controllerName}:${K}`;\n    handler: AuthenticationController[K];\n  };\n};\ntype ActionsObj = CreateActionsObj<\n  | 'performSignIn'\n  | 'performSignOut'\n  | 'getBearerToken'\n  | 'getSessionProfile'\n  | 'isSignedIn'\n>;\nexport type Actions =\n  | ActionsObj[keyof ActionsObj]\n  | AuthenticationControllerGetStateAction;\nexport type AuthenticationControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  AuthenticationControllerState\n>;\nexport type AuthenticationControllerPerformSignIn = ActionsObj['performSignIn'];\nexport type AuthenticationControllerPerformSignOut =\n  ActionsObj['performSignOut'];\nexport type AuthenticationControllerGetBearerToken =\n  ActionsObj['getBearerToken'];\nexport type AuthenticationControllerGetSessionProfile =\n  ActionsObj['getSessionProfile'];\nexport type AuthenticationControllerIsSignedIn = ActionsObj['isSignedIn'];\n\nexport type AuthenticationControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    AuthenticationControllerState\n  >;\n\nexport type Events = AuthenticationControllerStateChangeEvent;\n\n// Allowed Actions\nexport type AllowedActions =\n  | HandleSnapRequest\n  | KeyringControllerGetStateAction;\n\nexport type AllowedEvents =\n  | KeyringControllerLockEvent\n  | KeyringControllerUnlockEvent;\n\n// Messenger\nexport type AuthenticationControllerMessenger = RestrictedControllerMessenger<\n  typeof controllerName,\n  Actions | AllowedActions,\n  Events | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Controller that enables authentication for restricted endpoints.\n * Used for Global Profile Syncing and Notifications\n */\nexport default class AuthenticationController extends BaseController<\n  typeof controllerName,\n  AuthenticationControllerState,\n  AuthenticationControllerMessenger\n> {\n  #metametrics: MetaMetricsAuth;\n\n  #isUnlocked = false;\n\n  #keyringController = {\n    setupLockedStateSubscriptions: () => {\n      const { isUnlocked } = this.messagingSystem.call(\n        'KeyringController:getState',\n      );\n      this.#isUnlocked = isUnlocked;\n\n      this.messagingSystem.subscribe('KeyringController:unlock', () => {\n        this.#isUnlocked = true;\n      });\n\n      this.messagingSystem.subscribe('KeyringController:lock', () => {\n        this.#isUnlocked = false;\n      });\n    },\n  };\n\n  constructor({\n    messenger,\n    state,\n    metametrics,\n  }: {\n    messenger: AuthenticationControllerMessenger;\n    state?: AuthenticationControllerState;\n    /**\n     * Not using the Messaging System as we\n     * do not want to tie this strictly to extension\n     */\n    metametrics: MetaMetricsAuth;\n  }) {\n    super({\n      messenger,\n      metadata,\n      name: controllerName,\n      state: { ...defaultState, ...state },\n    });\n\n    if (!metametrics) {\n      throw new Error('`metametrics` field is required');\n    }\n\n    this.#metametrics = metametrics;\n\n    this.#keyringController.setupLockedStateSubscriptions();\n    this.#registerMessageHandlers();\n  }\n\n  /**\n   * Constructor helper for registering this controller's messaging system\n   * actions.\n   */\n  #registerMessageHandlers(): void {\n    this.messagingSystem.registerActionHandler(\n      'AuthenticationController:getBearerToken',\n      this.getBearerToken.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'AuthenticationController:getSessionProfile',\n      this.getSessionProfile.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'AuthenticationController:isSignedIn',\n      this.isSignedIn.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'AuthenticationController:performSignIn',\n      this.performSignIn.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'AuthenticationController:performSignOut',\n      this.performSignOut.bind(this),\n    );\n  }\n\n  public async performSignIn(): Promise<string> {\n    const { accessToken } = await this.#performAuthenticationFlow();\n    return accessToken;\n  }\n\n  public performSignOut(): void {\n    this.#assertLoggedIn();\n\n    this.update((state) => {\n      state.isSignedIn = false;\n      state.sessionData = undefined;\n    });\n  }\n\n  public async getBearerToken(): Promise<string> {\n    this.#assertLoggedIn();\n\n    if (this.#hasValidSession(this.state.sessionData)) {\n      return this.state.sessionData.accessToken;\n    }\n\n    const { accessToken } = await this.#performAuthenticationFlow();\n    return accessToken;\n  }\n\n  /**\n   * Will return a session profile.\n   * Throws if a user is not logged in.\n   *\n   * @returns profile for the session.\n   */\n  public async getSessionProfile(): Promise<SessionProfile> {\n    this.#assertLoggedIn();\n\n    if (this.#hasValidSession(this.state.sessionData)) {\n      return this.state.sessionData.profile;\n    }\n\n    const { profile } = await this.#performAuthenticationFlow();\n    return profile;\n  }\n\n  public isSignedIn(): boolean {\n    return this.state.isSignedIn;\n  }\n\n  #assertLoggedIn(): void {\n    if (!this.state.isSignedIn) {\n      throw new Error(\n        `${controllerName}: Unable to call method, user is not authenticated`,\n      );\n    }\n  }\n\n  async #performAuthenticationFlow(): Promise<{\n    profile: SessionProfile;\n    accessToken: string;\n  }> {\n    try {\n      // 1. Nonce\n      const publicKey = await this.#snapGetPublicKey();\n      const nonce = await getNonce(publicKey);\n      if (!nonce) {\n        throw new Error(`Unable to get nonce`);\n      }\n\n      // 2. Login\n      const rawMessage = createLoginRawMessage(nonce, publicKey);\n      const signature = await this.#snapSignMessage(rawMessage);\n      const loginResponse = await login(rawMessage, signature, {\n        metametricsId: await this.#metametrics.getMetaMetricsId(),\n        agent: this.#metametrics.agent,\n      });\n      if (!loginResponse?.token) {\n        throw new Error(`Unable to login`);\n      }\n\n      const profile: SessionProfile = {\n        identifierId: loginResponse.profile.identifier_id,\n        profileId: loginResponse.profile.profile_id,\n      };\n\n      // 3. Trade for Access Token\n      const accessToken = await getAccessToken(\n        loginResponse.token,\n        this.#metametrics.agent,\n      );\n      if (!accessToken) {\n        throw new Error(`Unable to get Access Token`);\n      }\n\n      // Update Internal State\n      this.update((state) => {\n        state.isSignedIn = true;\n        const expiresIn = new Date();\n        expiresIn.setTime(expiresIn.getTime() + THIRTY_MIN_MS);\n        state.sessionData = {\n          profile,\n          accessToken,\n          expiresIn: expiresIn.toString(),\n        };\n      });\n\n      return {\n        profile,\n        accessToken,\n      };\n    } catch (e) {\n      console.error('Failed to authenticate', e);\n      const errorMessage =\n        e instanceof Error ? e.message : JSON.stringify(e ?? '');\n      throw new Error(\n        `${controllerName}: Failed to authenticate - ${errorMessage}`,\n      );\n    }\n  }\n\n  #hasValidSession(\n    sessionData: SessionData | undefined,\n  ): sessionData is SessionData {\n    if (!sessionData) {\n      return false;\n    }\n\n    const prevDate = Date.parse(sessionData.expiresIn);\n    if (isNaN(prevDate)) {\n      return false;\n    }\n\n    const currentDate = new Date();\n    const diffMs = Math.abs(currentDate.getTime() - prevDate);\n\n    return THIRTY_MIN_MS > diffMs;\n  }\n\n  #_snapPublicKeyCache: string | undefined;\n\n  /**\n   * Returns the auth snap public key.\n   *\n   * @returns The snap public key.\n   */\n  async #snapGetPublicKey(): Promise<string> {\n    if (this.#_snapPublicKeyCache) {\n      return this.#_snapPublicKeyCache;\n    }\n\n    if (!this.#isUnlocked) {\n      throw new Error(\n        '#snapGetPublicKey - unable to call snap, wallet is locked',\n      );\n    }\n\n    const result = (await this.messagingSystem.call(\n      'SnapController:handleRequest',\n      createSnapPublicKeyRequest(),\n    )) as string;\n\n    this.#_snapPublicKeyCache = result;\n\n    return result;\n  }\n\n  #_snapSignMessageCache: Record<`metamask:${string}`, string> = {};\n\n  /**\n   * Signs a specific message using an underlying auth snap.\n   *\n   * @param message - A specific tagged message to sign.\n   * @returns A Signature created by the snap.\n   */\n  async #snapSignMessage(message: `metamask:${string}`): Promise<string> {\n    if (this.#_snapSignMessageCache[message]) {\n      return this.#_snapSignMessageCache[message];\n    }\n\n    if (!this.#isUnlocked) {\n      throw new Error(\n        '#snapSignMessage - unable to call snap, wallet is locked',\n      );\n    }\n\n    const result = (await this.messagingSystem.call(\n      'SnapController:handleRequest',\n      createSnapSignMessageRequest(message),\n    )) as string;\n\n    this.#_snapSignMessageCache[message] = result;\n\n    return result;\n  }\n}\n"]}

package/dist/{types/controllers/authentication/AuthenticationController.d.ts → controllers/authentication/AuthenticationController.d.cts}

@@ -1,7 +1,7 @@
-import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedControllerMessenger } from '@metamask/base-controller';
-import { BaseController } from '@metamask/base-controller';
-import type { KeyringControllerGetStateAction, KeyringControllerLockEvent, KeyringControllerUnlockEvent } from '@metamask/keyring-controller';
-import type { HandleSnapRequest } from '@metamask/snaps-controllers';
+import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedControllerMessenger } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { KeyringControllerGetStateAction, KeyringControllerLockEvent, KeyringControllerUnlockEvent } from "@metamask/keyring-controller";
+import type { HandleSnapRequest } from "@metamask/snaps-controllers";
 declare const controllerName = "AuthenticationController";
 type SessionProfile = {
     identifierId: string;
@@ -75,4 +75,4 @@ export default class AuthenticationController extends BaseController<typeof cont
     isSignedIn(): boolean;
 }
 export {};
-//# sourceMappingURL=AuthenticationController.d.ts.map
+//# sourceMappingURL=AuthenticationController.d.cts.map

package/dist/controllers/authentication/AuthenticationController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthenticationController.d.cts","sourceRoot":"","sources":["../../../src/controllers/authentication/AuthenticationController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,6BAA6B,EAE9B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,+BAA+B,EAC/B,0BAA0B,EAC1B,4BAA4B,EAC7B,qCAAqC;AACtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAoC;AAerE,QAAA,MAAM,cAAc,6BAA6B,CAAC;AAGlD,KAAK,cAAc,GAAG;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,KAAK,WAAW,GAAG;IACjB,oEAAoE;IACpE,OAAO,EAAE,cAAc,CAAC;IACxB,+DAA+D;IAC/D,WAAW,EAAE,MAAM,CAAC;IACpB,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,gBAAgB,EAAE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACjD,KAAK,EAAE,WAAW,GAAG,QAAQ,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B,CAAC;AACF,eAAO,MAAM,YAAY,EAAE,6BAE1B,CAAC;AAaF,KAAK,gBAAgB,CAAC,UAAU,SAAS,MAAM,wBAAwB,IAAI;KACxE,CAAC,IAAI,UAAU,GAAG;QACjB,IAAI,EAAE,GAAG,OAAO,cAAc,IAAI,CAAC,EAAE,CAAC;QACtC,OAAO,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC;KACtC;CACF,CAAC;AACF,KAAK,UAAU,GAAG,gBAAgB,CAC9B,eAAe,GACf,gBAAgB,GAChB,gBAAgB,GAChB,mBAAmB,GACnB,YAAY,CACf,CAAC;AACF,MAAM,MAAM,OAAO,GACf,UAAU,CAAC,MAAM,UAAU,CAAC,GAC5B,sCAAsC,CAAC;AAC3C,MAAM,MAAM,sCAAsC,GAAG,wBAAwB,CAC3E,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AACF,MAAM,MAAM,qCAAqC,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;AAChF,MAAM,MAAM,sCAAsC,GAChD,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAC/B,MAAM,MAAM,sCAAsC,GAChD,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAC/B,MAAM,MAAM,yCAAyC,GACnD,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAClC,MAAM,MAAM,kCAAkC,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;AAE1E,MAAM,MAAM,wCAAwC,GAClD,0BAA0B,CACxB,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEJ,MAAM,MAAM,MAAM,GAAG,wCAAwC,CAAC;AAG9D,MAAM,MAAM,cAAc,GACtB,iBAAiB,GACjB,+BAA+B,CAAC;AAEpC,MAAM,MAAM,aAAa,GACrB,0BAA0B,GAC1B,4BAA4B,CAAC;AAGjC,MAAM,MAAM,iCAAiC,GAAG,6BAA6B,CAC3E,OAAO,cAAc,EACrB,OAAO,GAAG,cAAc,EACxB,MAAM,GAAG,aAAa,EACtB,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,wBAAyB,SAAQ,cAAc,CAClE,OAAO,cAAc,EACrB,6BAA6B,EAC7B,iCAAiC,CAClC;;gBAsBa,EACV,SAAS,EACT,KAAK,EACL,WAAW,GACZ,EAAE;QACD,SAAS,EAAE,iCAAiC,CAAC;QAC7C,KAAK,CAAC,EAAE,6BAA6B,CAAC;QACtC;;;WAGG;QACH,WAAW,EAAE,eAAe,CAAC;KAC9B;IAiDY,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAKtC,cAAc,IAAI,IAAI;IAShB,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;IAW9C;;;;;OAKG;IACU,iBAAiB,IAAI,OAAO,CAAC,cAAc,CAAC;IAWlD,UAAU,IAAI,OAAO;CAqJ7B"}

package/dist/controllers/authentication/AuthenticationController.d.mts

@@ -0,0 +1,78 @@
+import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedControllerMessenger } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { KeyringControllerGetStateAction, KeyringControllerLockEvent, KeyringControllerUnlockEvent } from "@metamask/keyring-controller";
+import type { HandleSnapRequest } from "@metamask/snaps-controllers";
+declare const controllerName = "AuthenticationController";
+type SessionProfile = {
+    identifierId: string;
+    profileId: string;
+};
+type SessionData = {
+    /** profile - anonymous profile data for the given logged in user */
+    profile: SessionProfile;
+    /** accessToken - used to make requests authorized endpoints */
+    accessToken: string;
+    /** expiresIn - string date to determine if new access token is required  */
+    expiresIn: string;
+};
+type MetaMetricsAuth = {
+    getMetaMetricsId: () => string | Promise<string>;
+    agent: 'extension' | 'mobile';
+};
+export type AuthenticationControllerState = {
+    /**
+     * Global isSignedIn state.
+     * Can be used to determine if "Profile Syncing" is enabled.
+     */
+    isSignedIn: boolean;
+    sessionData?: SessionData;
+};
+export declare const defaultState: AuthenticationControllerState;
+type CreateActionsObj<Controller extends keyof AuthenticationController> = {
+    [K in Controller]: {
+        type: `${typeof controllerName}:${K}`;
+        handler: AuthenticationController[K];
+    };
+};
+type ActionsObj = CreateActionsObj<'performSignIn' | 'performSignOut' | 'getBearerToken' | 'getSessionProfile' | 'isSignedIn'>;
+export type Actions = ActionsObj[keyof ActionsObj] | AuthenticationControllerGetStateAction;
+export type AuthenticationControllerGetStateAction = ControllerGetStateAction<typeof controllerName, AuthenticationControllerState>;
+export type AuthenticationControllerPerformSignIn = ActionsObj['performSignIn'];
+export type AuthenticationControllerPerformSignOut = ActionsObj['performSignOut'];
+export type AuthenticationControllerGetBearerToken = ActionsObj['getBearerToken'];
+export type AuthenticationControllerGetSessionProfile = ActionsObj['getSessionProfile'];
+export type AuthenticationControllerIsSignedIn = ActionsObj['isSignedIn'];
+export type AuthenticationControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, AuthenticationControllerState>;
+export type Events = AuthenticationControllerStateChangeEvent;
+export type AllowedActions = HandleSnapRequest | KeyringControllerGetStateAction;
+export type AllowedEvents = KeyringControllerLockEvent | KeyringControllerUnlockEvent;
+export type AuthenticationControllerMessenger = RestrictedControllerMessenger<typeof controllerName, Actions | AllowedActions, Events | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+/**
+ * Controller that enables authentication for restricted endpoints.
+ * Used for Global Profile Syncing and Notifications
+ */
+export default class AuthenticationController extends BaseController<typeof controllerName, AuthenticationControllerState, AuthenticationControllerMessenger> {
+    #private;
+    constructor({ messenger, state, metametrics, }: {
+        messenger: AuthenticationControllerMessenger;
+        state?: AuthenticationControllerState;
+        /**
+         * Not using the Messaging System as we
+         * do not want to tie this strictly to extension
+         */
+        metametrics: MetaMetricsAuth;
+    });
+    performSignIn(): Promise<string>;
+    performSignOut(): void;
+    getBearerToken(): Promise<string>;
+    /**
+     * Will return a session profile.
+     * Throws if a user is not logged in.
+     *
+     * @returns profile for the session.
+     */
+    getSessionProfile(): Promise<SessionProfile>;
+    isSignedIn(): boolean;
+}
+export {};
+//# sourceMappingURL=AuthenticationController.d.mts.map

package/dist/controllers/authentication/AuthenticationController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthenticationController.d.mts","sourceRoot":"","sources":["../../../src/controllers/authentication/AuthenticationController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,6BAA6B,EAE9B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,+BAA+B,EAC/B,0BAA0B,EAC1B,4BAA4B,EAC7B,qCAAqC;AACtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAoC;AAerE,QAAA,MAAM,cAAc,6BAA6B,CAAC;AAGlD,KAAK,cAAc,GAAG;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,KAAK,WAAW,GAAG;IACjB,oEAAoE;IACpE,OAAO,EAAE,cAAc,CAAC;IACxB,+DAA+D;IAC/D,WAAW,EAAE,MAAM,CAAC;IACpB,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,gBAAgB,EAAE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACjD,KAAK,EAAE,WAAW,GAAG,QAAQ,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B,CAAC;AACF,eAAO,MAAM,YAAY,EAAE,6BAE1B,CAAC;AAaF,KAAK,gBAAgB,CAAC,UAAU,SAAS,MAAM,wBAAwB,IAAI;KACxE,CAAC,IAAI,UAAU,GAAG;QACjB,IAAI,EAAE,GAAG,OAAO,cAAc,IAAI,CAAC,EAAE,CAAC;QACtC,OAAO,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC;KACtC;CACF,CAAC;AACF,KAAK,UAAU,GAAG,gBAAgB,CAC9B,eAAe,GACf,gBAAgB,GAChB,gBAAgB,GAChB,mBAAmB,GACnB,YAAY,CACf,CAAC;AACF,MAAM,MAAM,OAAO,GACf,UAAU,CAAC,MAAM,UAAU,CAAC,GAC5B,sCAAsC,CAAC;AAC3C,MAAM,MAAM,sCAAsC,GAAG,wBAAwB,CAC3E,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AACF,MAAM,MAAM,qCAAqC,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;AAChF,MAAM,MAAM,sCAAsC,GAChD,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAC/B,MAAM,MAAM,sCAAsC,GAChD,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAC/B,MAAM,MAAM,yCAAyC,GACnD,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAClC,MAAM,MAAM,kCAAkC,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;AAE1E,MAAM,MAAM,wCAAwC,GAClD,0BAA0B,CACxB,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEJ,MAAM,MAAM,MAAM,GAAG,wCAAwC,CAAC;AAG9D,MAAM,MAAM,cAAc,GACtB,iBAAiB,GACjB,+BAA+B,CAAC;AAEpC,MAAM,MAAM,aAAa,GACrB,0BAA0B,GAC1B,4BAA4B,CAAC;AAGjC,MAAM,MAAM,iCAAiC,GAAG,6BAA6B,CAC3E,OAAO,cAAc,EACrB,OAAO,GAAG,cAAc,EACxB,MAAM,GAAG,aAAa,EACtB,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,wBAAyB,SAAQ,cAAc,CAClE,OAAO,cAAc,EACrB,6BAA6B,EAC7B,iCAAiC,CAClC;;gBAsBa,EACV,SAAS,EACT,KAAK,EACL,WAAW,GACZ,EAAE;QACD,SAAS,EAAE,iCAAiC,CAAC;QAC7C,KAAK,CAAC,EAAE,6BAA6B,CAAC;QACtC;;;WAGG;QACH,WAAW,EAAE,eAAe,CAAC;KAC9B;IAiDY,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAKtC,cAAc,IAAI,IAAI;IAShB,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;IAW9C;;;;;OAKG;IACU,iBAAiB,IAAI,OAAO,CAAC,cAAc,CAAC;IAWlD,UAAU,IAAI,OAAO;CAqJ7B"}