@metamask/profile-sync-controller 0.1.4 → 0.2.1

package/CHANGELOG.md

@@ -7,6 +7,44 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.1]
+
+### Added
+
+- unlock checks for when controller methods are called ([#4569](https://github.com/MetaMask/core/pull/4569))
+
+### Changed
+
+- **BREAKING** made `MOCK_ENCRYPTED_STORAGE_DATA` fixture a function to be lazily evaluated ([#4592](https://github.com/MetaMask/core/pull/4592))
+- Bump `typescript` from `~5.0.4` to `~5.1.6` ([#4576](https://github.com/MetaMask/core/pull/4576))
+
+## [0.2.0]
+
+### Added
+
+- Add and export object `USER_STORAGE_SCHEMA`, function `getFeatureAndKeyFromPath`, and type `UserStoragePath` ([#4543](https://github.com/MetaMask/core/pull/4543))
+- Add `connectSnap` method to the `JwtBearerAuth` class for connecting to snap after initializing the Profile Sync SDK ([#4560](https://github.com/MetaMask/core/pull/4560))
+
+### Changed
+
+- **BREAKING:** Enforce `UserStorageSchema` usage in all functions that get or set user storage ([#4543](https://github.com/MetaMask/core/pull/4543))
+  - Keeps user storage entries consistent, and improves DX for consumers of user storage.
+  - **BREAKING:** Remove `entryKey` function parameter from `performGetStorage` and `performSetStorage` methods of `UserStorageController`, and replace with `path` parameter of type `UserStoragePath`.
+  - **BREAKING:** Remove `entryKey` function parameter from `createEntryPath`, and replace with `path` parameter of type `UserStoragePath`.
+  - **BREAKING:** Remove `entryKey` property from type `UserStorageOptions`, and replace with `path` property of type `UserStoragePath`.
+- **BREAKING:** Bump peerDependency `@metamask/snaps-controllers` from `^8.1.1` to `^9.3.0` ([#3645](https://github.com/MetaMask/core/pull/3645))
+- Remove `@metamask/snaps-controllers` dependency [#4556](https://github.com/MetaMask/core/pull/4556)
+  - This was listed under `peerDependencies` already, so it was redundant as a dependency.
+- Widen `isProfileSyncingEnabled` property of the `UserStorageControllerState` type from `boolean` to `boolean | null` ([#4551](https://github.com/MetaMask/core/pull/4551))
+- Upgrade TypeScript version to `~5.0.4` and set `moduleResolution` option to `Node16` ([#3645](https://github.com/MetaMask/core/pull/3645))
+- Bump `@metamask/base-controller` from `^6.0.1` to `^6.0.2` ([#4544](https://github.com/MetaMask/core/pull/4544))
+- Bump `@metamask/snaps-sdk` from `^4.2.0` to `^6.1.1` ([#3645](https://github.com/MetaMask/core/pull/3645), [#4547](https://github.com/MetaMask/core/pull/4547))
+- Add new dependency `@metamask/snaps-utils` ([#3645](https://github.com/MetaMask/core/pull/3645), [#4547](https://github.com/MetaMask/core/pull/4547))
+
+### Removed
+
+- Remove object `USER_STORAGE_ENTRIES` and type `UserStorageEntryKeys` ([#4543](https://github.com/MetaMask/core/pull/4543))
+
 ## [0.1.4]
 
 ### Added
@@ -57,7 +95,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.1.4...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@0.2.1...HEAD
+[0.2.1]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@0.2.0...@metamask/profile-sync-controller@0.2.1
+[0.2.0]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@0.1.4...@metamask/profile-sync-controller@0.2.0
 [0.1.4]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@0.1.3...@metamask/profile-sync-controller@0.1.4
 [0.1.3]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@0.1.2...@metamask/profile-sync-controller@0.1.3
 [0.1.2]: https://github.com/MetaMask/core/compare/@metamask/profile-sync-controller@0.1.1...@metamask/profile-sync-controller@0.1.2

package/dist/{chunk-5SXXO4MV.js → chunk-3TE6M5TV.js}

@@ -1,6 +1,6 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-var _chunkB6CSNLGEjs = require('./chunk-B6CSNLGE.js');
+var _chunkSLHAVOTEjs = require('./chunk-SLHAVOTE.js');
 
 
 var _chunkAK7OTIWAjs = require('./chunk-AK7OTIWA.js');
@@ -15,12 +15,13 @@ var USER_STORAGE_API = ENV_URLS.userStorageApiUrl;
 var USER_STORAGE_ENDPOINT = `${USER_STORAGE_API}/api/v1/userstorage`;
 async function getUserStorage(opts) {
   try {
-    const path = _chunkB6CSNLGEjs.createEntryPath.call(void 0, opts.entryKey, opts.storageKey);
-    const url = new URL(`${USER_STORAGE_ENDPOINT}${path}`);
+    const { bearerToken, path, storageKey } = opts;
+    const encryptedPath = _chunkSLHAVOTEjs.createEntryPath.call(void 0, path, storageKey);
+    const url = new URL(`${USER_STORAGE_ENDPOINT}${encryptedPath}`);
     const userStorageResponse = await fetch(url.toString(), {
       headers: {
         "Content-Type": "application/json",
-        Authorization: `Bearer ${opts.bearerToken}`
+        Authorization: `Bearer ${bearerToken}`
       }
     });
     if (userStorageResponse.status === 404) {
@@ -45,14 +46,15 @@ async function getUserStorage(opts) {
   }
 }
 async function upsertUserStorage(data, opts) {
+  const { bearerToken, path, storageKey } = opts;
   const encryptedData = _chunkAK7OTIWAjs.encryption_default.encryptString(data, opts.storageKey);
-  const path = _chunkB6CSNLGEjs.createEntryPath.call(void 0, opts.entryKey, opts.storageKey);
-  const url = new URL(`${USER_STORAGE_ENDPOINT}${path}`);
+  const encryptedPath = _chunkSLHAVOTEjs.createEntryPath.call(void 0, path, storageKey);
+  const url = new URL(`${USER_STORAGE_ENDPOINT}${encryptedPath}`);
   const res = await fetch(url.toString(), {
     method: "PUT",
     headers: {
       "Content-Type": "application/json",
-      Authorization: `Bearer ${opts.bearerToken}`
+      Authorization: `Bearer ${bearerToken}`
     },
     body: JSON.stringify({ data: encryptedData })
   });
@@ -67,4 +69,4 @@ async function upsertUserStorage(data, opts) {
 
 
 exports.USER_STORAGE_API = USER_STORAGE_API; exports.USER_STORAGE_ENDPOINT = USER_STORAGE_ENDPOINT; exports.getUserStorage = getUserStorage; exports.upsertUserStorage = upsertUserStorage;
-//# sourceMappingURL=chunk-5SXXO4MV.js.map
+//# sourceMappingURL=chunk-3TE6M5TV.js.map

package/dist/chunk-3TE6M5TV.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/controllers/user-storage/services.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,OAAO,SAAS;AAOhB,IAAM,WAAW,0BAAkB;AAE5B,IAAM,mBAA2B,SAAS;AAC1C,IAAM,wBAAwB,GAAG,gBAAgB;AAwBxD,eAAsB,eACpB,MACwB;AACxB,MAAI;AACF,UAAM,EAAE,aAAa,MAAM,WAAW,IAAI;AAE1C,UAAM,gBAAgB,gBAAgB,MAAM,UAAU;AACtD,UAAM,MAAM,IAAI,IAAI,GAAG,qBAAqB,GAAG,aAAa,EAAE;AAE9D,UAAM,sBAAsB,MAAM,MAAM,IAAI,SAAS,GAAG;AAAA,MACtD,SAAS;AAAA,QACP,gBAAgB;AAAA,QAChB,eAAe,UAAU,WAAW;AAAA,MACtC;AAAA,IACF,CAAC;AAGD,QAAI,oBAAoB,WAAW,KAAK;AACtC,aAAO;AAAA,IACT;AAEA,QAAI,oBAAoB,WAAW,KAAK;AACtC,YAAM,IAAI,MAAM,4BAA4B;AAAA,IAC9C;AAEA,UAAM,cACJ,MAAM,oBAAoB,KAAK;AACjC,UAAM,gBAAgB,aAAa,QAAQ;AAE3C,QAAI,CAAC,eAAe;AAClB,aAAO;AAAA,IACT;AAEA,UAAM,gBAAgB,mBAAW;AAAA,MAC/B;AAAA,MACA,KAAK;AAAA,IACP;AAEA,WAAO;AAAA,EACT,SAAS,GAAG;AACV,QAAI,MAAM,8BAA8B,CAAC;AACzC,WAAO;AAAA,EACT;AACF;AAQA,eAAsB,kBACpB,MACA,MACe;AACf,QAAM,EAAE,aAAa,MAAM,WAAW,IAAI;AAE1C,QAAM,gBAAgB,mBAAW,cAAc,MAAM,KAAK,UAAU;AACpE,QAAM,gBAAgB,gBAAgB,MAAM,UAAU;AACtD,QAAM,MAAM,IAAI,IAAI,GAAG,qBAAqB,GAAG,aAAa,EAAE;AAE9D,QAAM,MAAM,MAAM,MAAM,IAAI,SAAS,GAAG;AAAA,IACtC,QAAQ;AAAA,IACR,SAAS;AAAA,MACP,gBAAgB;AAAA,MAChB,eAAe,UAAU,WAAW;AAAA,IACtC;AAAA,IACA,MAAM,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAAA,EAC9C,CAAC;AAED,MAAI,CAAC,IAAI,IAAI;AACX,UAAM,IAAI,MAAM,sCAAsC;AAAA,EACxD;AACF","sourcesContent":["import log from 'loglevel';\n\nimport { Env, getEnvUrls } from '../../sdk';\nimport encryption from './encryption';\nimport type { UserStoragePath } from './schema';\nimport { createEntryPath } from './schema';\n\nconst ENV_URLS = getEnvUrls(Env.PRD);\n\nexport const USER_STORAGE_API: string = ENV_URLS.userStorageApiUrl;\nexport const USER_STORAGE_ENDPOINT = `${USER_STORAGE_API}/api/v1/userstorage`;\n\n/**\n * This is the Server Response shape\n */\nexport type GetUserStorageResponse = {\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  HashedKey: string;\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  Data: string;\n};\n\nexport type UserStorageOptions = {\n  path: UserStoragePath;\n  bearerToken: string;\n  storageKey: string;\n};\n\n/**\n * User Storage Service - Get Storage Entry.\n *\n * @param opts - User Storage Options\n * @returns The storage entry, or null if fails to find entry\n */\nexport async function getUserStorage(\n  opts: UserStorageOptions,\n): Promise<string | null> {\n  try {\n    const { bearerToken, path, storageKey } = opts;\n\n    const encryptedPath = createEntryPath(path, storageKey);\n    const url = new URL(`${USER_STORAGE_ENDPOINT}${encryptedPath}`);\n\n    const userStorageResponse = await fetch(url.toString(), {\n      headers: {\n        'Content-Type': 'application/json',\n        Authorization: `Bearer ${bearerToken}`,\n      },\n    });\n\n    // Acceptable error - since indicates entry does not exist.\n    if (userStorageResponse.status === 404) {\n      return null;\n    }\n\n    if (userStorageResponse.status !== 200) {\n      throw new Error('Unable to get User Storage');\n    }\n\n    const userStorage: GetUserStorageResponse | null =\n      await userStorageResponse.json();\n    const encryptedData = userStorage?.Data ?? null;\n\n    if (!encryptedData) {\n      return null;\n    }\n\n    const decryptedData = encryption.decryptString(\n      encryptedData,\n      opts.storageKey,\n    );\n\n    return decryptedData;\n  } catch (e) {\n    log.error('Failed to get user storage', e);\n    return null;\n  }\n}\n\n/**\n * User Storage Service - Set Storage Entry.\n *\n * @param data - data to store\n * @param opts - storage options\n */\nexport async function upsertUserStorage(\n  data: string,\n  opts: UserStorageOptions,\n): Promise<void> {\n  const { bearerToken, path, storageKey } = opts;\n\n  const encryptedData = encryption.encryptString(data, opts.storageKey);\n  const encryptedPath = createEntryPath(path, storageKey);\n  const url = new URL(`${USER_STORAGE_ENDPOINT}${encryptedPath}`);\n\n  const res = await fetch(url.toString(), {\n    method: 'PUT',\n    headers: {\n      'Content-Type': 'application/json',\n      Authorization: `Bearer ${bearerToken}`,\n    },\n    body: JSON.stringify({ data: encryptedData }),\n  });\n\n  if (!res.ok) {\n    throw new Error('user-storage - unable to upsert data');\n  }\n}\n"]}

package/dist/{chunk-CSFHMILK.js → chunk-4DQF2YNS.js}

@@ -1,13 +1,13 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _chunkDDOYG42Ajs = require('./chunk-DDOYG42A.js');
+var _chunkJENTMRXOjs = require('./chunk-JENTMRXO.js');
 
 
-var _chunk5SXXO4MVjs = require('./chunk-5SXXO4MV.js');
+var _chunk3TE6M5TVjs = require('./chunk-3TE6M5TV.js');
 
 
-var _chunkB6CSNLGEjs = require('./chunk-B6CSNLGE.js');
+var _chunkSLHAVOTEjs = require('./chunk-SLHAVOTE.js');
 
 
 var _chunkAK7OTIWAjs = require('./chunk-AK7OTIWA.js');
@@ -22,11 +22,11 @@ var _chunkIGY2S5BCjs = require('./chunk-IGY2S5BC.js');
 // src/controllers/user-storage/index.ts
 var user_storage_exports = {};
 _chunkIGY2S5BCjs.__export.call(void 0, user_storage_exports, {
-  Controller: () => _chunkDDOYG42Ajs.UserStorageController,
+  Controller: () => _chunkJENTMRXOjs.UserStorageController,
   Encryption: () => _chunkT3FNDVE3js.encryption_default,
   Mocks: () => fixtures_exports,
   createSHA256Hash: () => _chunkT3FNDVE3js.createSHA256Hash,
-  defaultState: () => _chunkDDOYG42Ajs.defaultState
+  defaultState: () => _chunkJENTMRXOjs.defaultState
 });
 
 // src/controllers/user-storage/__fixtures__/index.ts
@@ -45,25 +45,22 @@ _chunkIGY2S5BCjs.__export.call(void 0, fixtures_exports, {
 var MOCK_STORAGE_KEY_SIGNATURE = "mockStorageKey";
 var MOCK_STORAGE_KEY = _chunkT3FNDVE3js.createSHA256Hash.call(void 0, MOCK_STORAGE_KEY_SIGNATURE);
 var MOCK_STORAGE_DATA = JSON.stringify({ hello: "world" });
-var MOCK_ENCRYPTED_STORAGE_DATA = _chunkAK7OTIWAjs.encryption_default.encryptString(
-  MOCK_STORAGE_DATA,
-  MOCK_STORAGE_KEY
-);
+var MOCK_ENCRYPTED_STORAGE_DATA = () => _chunkAK7OTIWAjs.encryption_default.encryptString(MOCK_STORAGE_DATA, MOCK_STORAGE_KEY);
 
 // src/controllers/user-storage/__fixtures__/mockResponses.ts
-var MOCK_USER_STORAGE_NOTIFICATIONS_ENDPOINT = `${_chunk5SXXO4MVjs.USER_STORAGE_ENDPOINT}${_chunkB6CSNLGEjs.createEntryPath.call(void 0, 
-  "notificationSettings",
+var MOCK_USER_STORAGE_NOTIFICATIONS_ENDPOINT = `${_chunk3TE6M5TVjs.USER_STORAGE_ENDPOINT}${_chunkSLHAVOTEjs.createEntryPath.call(void 0, 
+  "notifications.notificationSettings",
   MOCK_STORAGE_KEY
 )}`;
-var MOCK_GET_USER_STORAGE_RESPONSE = {
+var MOCK_GET_USER_STORAGE_RESPONSE = () => ({
   HashedKey: "HASHED_KEY",
-  Data: MOCK_ENCRYPTED_STORAGE_DATA
-};
+  Data: MOCK_ENCRYPTED_STORAGE_DATA()
+});
 var getMockUserStorageGetResponse = () => {
   return {
     url: MOCK_USER_STORAGE_NOTIFICATIONS_ENDPOINT,
     requestMethod: "GET",
-    response: MOCK_GET_USER_STORAGE_RESPONSE
+    response: MOCK_GET_USER_STORAGE_RESPONSE()
   };
 };
 var getMockUserStoragePutResponse = () => {
@@ -78,4 +75,4 @@ var getMockUserStoragePutResponse = () => {
 
 
 exports.fixtures_exports = fixtures_exports; exports.user_storage_exports = user_storage_exports;
-//# sourceMappingURL=chunk-CSFHMILK.js.map
+//# sourceMappingURL=chunk-4DQF2YNS.js.map

package/dist/chunk-4DQF2YNS.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/controllers/user-storage/index.ts","../src/controllers/user-storage/__fixtures__/index.ts","../src/controllers/user-storage/__fixtures__/mockStorage.ts","../src/controllers/user-storage/__fixtures__/mockResponses.ts"],"names":["encryption_default"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACEO,IAAM,6BAA6B;AACnC,IAAM,mBAAmB,iBAAiB,0BAA0B;AACpE,IAAM,oBAAoB,KAAK,UAAU,EAAE,OAAO,QAAQ,CAAC;AAI3D,IAAM,8BAA8B,MACzCA,oBAAW,cAAc,mBAAmB,gBAAgB;;;ACEvD,IAAM,2CAA2C,GAAG,qBAAqB,GAAG;AAAA,EACjF;AAAA,EACA;AACF,CAAC;AAED,IAAM,iCAAiC,OAA+B;AAAA,EACpE,WAAW;AAAA,EACX,MAAM,4BAA4B;AACpC;AAEO,IAAM,gCAAgC,MAAM;AACjD,SAAO;AAAA,IACL,KAAK;AAAA,IACL,eAAe;AAAA,IACf,UAAU,+BAA+B;AAAA,EAC3C;AACF;AAEO,IAAM,gCAAgC,MAAM;AACjD,SAAO;AAAA,IACL,KAAK;AAAA,IACL,eAAe;AAAA,IACf,UAAU;AAAA,EACZ;AACF","sourcesContent":["import Controller from './UserStorageController';\n\nexport { Controller };\nexport * from './UserStorageController';\nexport * from './encryption';\nexport * as Mocks from './__fixtures__';\n","export * from './mockResponses';\nexport * from './mockStorage';\n","import encryption, { createSHA256Hash } from '../encryption';\n\nexport const MOCK_STORAGE_KEY_SIGNATURE = 'mockStorageKey';\nexport const MOCK_STORAGE_KEY = createSHA256Hash(MOCK_STORAGE_KEY_SIGNATURE);\nexport const MOCK_STORAGE_DATA = JSON.stringify({ hello: 'world' });\n\n// NOTE - using encryption.encryptString directly in fixtures causes issues on mobile.\n// This is because this fixture is getting added in at run time. Will be improved once we support multiple exports\nexport const MOCK_ENCRYPTED_STORAGE_DATA = () =>\n  encryption.encryptString(MOCK_STORAGE_DATA, MOCK_STORAGE_KEY);\n","import { createEntryPath } from '../schema';\nimport type { GetUserStorageResponse } from '../services';\nimport { USER_STORAGE_ENDPOINT } from '../services';\nimport { MOCK_ENCRYPTED_STORAGE_DATA, MOCK_STORAGE_KEY } from './mockStorage';\n\ntype MockResponse = {\n  url: string;\n  requestMethod: 'GET' | 'POST' | 'PUT';\n  response: unknown;\n};\n\nexport const MOCK_USER_STORAGE_NOTIFICATIONS_ENDPOINT = `${USER_STORAGE_ENDPOINT}${createEntryPath(\n  'notifications.notificationSettings',\n  MOCK_STORAGE_KEY,\n)}`;\n\nconst MOCK_GET_USER_STORAGE_RESPONSE = (): GetUserStorageResponse => ({\n  HashedKey: 'HASHED_KEY',\n  Data: MOCK_ENCRYPTED_STORAGE_DATA(),\n});\n\nexport const getMockUserStorageGetResponse = () => {\n  return {\n    url: MOCK_USER_STORAGE_NOTIFICATIONS_ENDPOINT,\n    requestMethod: 'GET',\n    response: MOCK_GET_USER_STORAGE_RESPONSE(),\n  } satisfies MockResponse;\n};\n\nexport const getMockUserStoragePutResponse = () => {\n  return {\n    url: MOCK_USER_STORAGE_NOTIFICATIONS_ENDPOINT,\n    requestMethod: 'PUT',\n    response: null,\n  } satisfies MockResponse;\n};\n"]}

package/dist/{chunk-RT2GRG4S.mjs → chunk-7KMONAQI.mjs}

@@ -1,6 +1,6 @@
 import {
   JwtBearerAuth
-} from "./chunk-JFVONPMM.mjs";
+} from "./chunk-VYZPOR47.mjs";
 import {
   SIWEJwtBearerAuth
 } from "./chunk-BDO3VJEU.mjs";
@@ -20,7 +20,7 @@ import {
 import {
   STORAGE_URL,
   UserStorage
-} from "./chunk-AXWK4Y23.mjs";
+} from "./chunk-NPH5AHLH.mjs";
 import {
   Encryption,
   createSHA256Hash
@@ -76,4 +76,4 @@ __export(sdk_exports, {
 export {
   sdk_exports
 };
-//# sourceMappingURL=chunk-RT2GRG4S.mjs.map
+//# sourceMappingURL=chunk-7KMONAQI.mjs.map

package/dist/{chunk-LDEIUP6J.mjs → chunk-CJLDMVV3.mjs}

@@ -1,7 +1,7 @@
 import {
   AuthenticationController,
   defaultState
-} from "./chunk-Y7P3UH26.mjs";
+} from "./chunk-WWQ65CZY.mjs";
 import {
   AUTH_LOGIN_ENDPOINT,
   AUTH_NONCE_ENDPOINT,
@@ -83,4 +83,4 @@ export {
   fixtures_exports,
   authentication_exports
 };
-//# sourceMappingURL=chunk-LDEIUP6J.mjs.map
+//# sourceMappingURL=chunk-CJLDMVV3.mjs.map

package/dist/{chunk-2XGRQBXI.mjs → chunk-FU7PSGFP.mjs}

@@ -1,6 +1,6 @@
 import {
   createEntryPath
-} from "./chunk-AUFUOKJW.mjs";
+} from "./chunk-ILIZJQ6X.mjs";
 import {
   encryption_default
 } from "./chunk-5TOWF6UW.mjs";
@@ -15,12 +15,13 @@ var USER_STORAGE_API = ENV_URLS.userStorageApiUrl;
 var USER_STORAGE_ENDPOINT = `${USER_STORAGE_API}/api/v1/userstorage`;
 async function getUserStorage(opts) {
   try {
-    const path = createEntryPath(opts.entryKey, opts.storageKey);
-    const url = new URL(`${USER_STORAGE_ENDPOINT}${path}`);
+    const { bearerToken, path, storageKey } = opts;
+    const encryptedPath = createEntryPath(path, storageKey);
+    const url = new URL(`${USER_STORAGE_ENDPOINT}${encryptedPath}`);
     const userStorageResponse = await fetch(url.toString(), {
       headers: {
         "Content-Type": "application/json",
-        Authorization: `Bearer ${opts.bearerToken}`
+        Authorization: `Bearer ${bearerToken}`
       }
     });
     if (userStorageResponse.status === 404) {
@@ -45,14 +46,15 @@ async function getUserStorage(opts) {
   }
 }
 async function upsertUserStorage(data, opts) {
+  const { bearerToken, path, storageKey } = opts;
   const encryptedData = encryption_default.encryptString(data, opts.storageKey);
-  const path = createEntryPath(opts.entryKey, opts.storageKey);
-  const url = new URL(`${USER_STORAGE_ENDPOINT}${path}`);
+  const encryptedPath = createEntryPath(path, storageKey);
+  const url = new URL(`${USER_STORAGE_ENDPOINT}${encryptedPath}`);
   const res = await fetch(url.toString(), {
     method: "PUT",
     headers: {
       "Content-Type": "application/json",
-      Authorization: `Bearer ${opts.bearerToken}`
+      Authorization: `Bearer ${bearerToken}`
     },
     body: JSON.stringify({ data: encryptedData })
   });
@@ -67,4 +69,4 @@ export {
   getUserStorage,
   upsertUserStorage
 };
-//# sourceMappingURL=chunk-2XGRQBXI.mjs.map
+//# sourceMappingURL=chunk-FU7PSGFP.mjs.map

package/dist/chunk-FU7PSGFP.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/controllers/user-storage/services.ts"],"sourcesContent":["import log from 'loglevel';\n\nimport { Env, getEnvUrls } from '../../sdk';\nimport encryption from './encryption';\nimport type { UserStoragePath } from './schema';\nimport { createEntryPath } from './schema';\n\nconst ENV_URLS = getEnvUrls(Env.PRD);\n\nexport const USER_STORAGE_API: string = ENV_URLS.userStorageApiUrl;\nexport const USER_STORAGE_ENDPOINT = `${USER_STORAGE_API}/api/v1/userstorage`;\n\n/**\n * This is the Server Response shape\n */\nexport type GetUserStorageResponse = {\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  HashedKey: string;\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  Data: string;\n};\n\nexport type UserStorageOptions = {\n  path: UserStoragePath;\n  bearerToken: string;\n  storageKey: string;\n};\n\n/**\n * User Storage Service - Get Storage Entry.\n *\n * @param opts - User Storage Options\n * @returns The storage entry, or null if fails to find entry\n */\nexport async function getUserStorage(\n  opts: UserStorageOptions,\n): Promise<string | null> {\n  try {\n    const { bearerToken, path, storageKey } = opts;\n\n    const encryptedPath = createEntryPath(path, storageKey);\n    const url = new URL(`${USER_STORAGE_ENDPOINT}${encryptedPath}`);\n\n    const userStorageResponse = await fetch(url.toString(), {\n      headers: {\n        'Content-Type': 'application/json',\n        Authorization: `Bearer ${bearerToken}`,\n      },\n    });\n\n    // Acceptable error - since indicates entry does not exist.\n    if (userStorageResponse.status === 404) {\n      return null;\n    }\n\n    if (userStorageResponse.status !== 200) {\n      throw new Error('Unable to get User Storage');\n    }\n\n    const userStorage: GetUserStorageResponse | null =\n      await userStorageResponse.json();\n    const encryptedData = userStorage?.Data ?? null;\n\n    if (!encryptedData) {\n      return null;\n    }\n\n    const decryptedData = encryption.decryptString(\n      encryptedData,\n      opts.storageKey,\n    );\n\n    return decryptedData;\n  } catch (e) {\n    log.error('Failed to get user storage', e);\n    return null;\n  }\n}\n\n/**\n * User Storage Service - Set Storage Entry.\n *\n * @param data - data to store\n * @param opts - storage options\n */\nexport async function upsertUserStorage(\n  data: string,\n  opts: UserStorageOptions,\n): Promise<void> {\n  const { bearerToken, path, storageKey } = opts;\n\n  const encryptedData = encryption.encryptString(data, opts.storageKey);\n  const encryptedPath = createEntryPath(path, storageKey);\n  const url = new URL(`${USER_STORAGE_ENDPOINT}${encryptedPath}`);\n\n  const res = await fetch(url.toString(), {\n    method: 'PUT',\n    headers: {\n      'Content-Type': 'application/json',\n      Authorization: `Bearer ${bearerToken}`,\n    },\n    body: JSON.stringify({ data: encryptedData }),\n  });\n\n  if (!res.ok) {\n    throw new Error('user-storage - unable to upsert data');\n  }\n}\n"],"mappings":";;;;;;;;;;;AAAA,OAAO,SAAS;AAOhB,IAAM,WAAW,0BAAkB;AAE5B,IAAM,mBAA2B,SAAS;AAC1C,IAAM,wBAAwB,GAAG,gBAAgB;AAwBxD,eAAsB,eACpB,MACwB;AACxB,MAAI;AACF,UAAM,EAAE,aAAa,MAAM,WAAW,IAAI;AAE1C,UAAM,gBAAgB,gBAAgB,MAAM,UAAU;AACtD,UAAM,MAAM,IAAI,IAAI,GAAG,qBAAqB,GAAG,aAAa,EAAE;AAE9D,UAAM,sBAAsB,MAAM,MAAM,IAAI,SAAS,GAAG;AAAA,MACtD,SAAS;AAAA,QACP,gBAAgB;AAAA,QAChB,eAAe,UAAU,WAAW;AAAA,MACtC;AAAA,IACF,CAAC;AAGD,QAAI,oBAAoB,WAAW,KAAK;AACtC,aAAO;AAAA,IACT;AAEA,QAAI,oBAAoB,WAAW,KAAK;AACtC,YAAM,IAAI,MAAM,4BAA4B;AAAA,IAC9C;AAEA,UAAM,cACJ,MAAM,oBAAoB,KAAK;AACjC,UAAM,gBAAgB,aAAa,QAAQ;AAE3C,QAAI,CAAC,eAAe;AAClB,aAAO;AAAA,IACT;AAEA,UAAM,gBAAgB,mBAAW;AAAA,MAC/B;AAAA,MACA,KAAK;AAAA,IACP;AAEA,WAAO;AAAA,EACT,SAAS,GAAG;AACV,QAAI,MAAM,8BAA8B,CAAC;AACzC,WAAO;AAAA,EACT;AACF;AAQA,eAAsB,kBACpB,MACA,MACe;AACf,QAAM,EAAE,aAAa,MAAM,WAAW,IAAI;AAE1C,QAAM,gBAAgB,mBAAW,cAAc,MAAM,KAAK,UAAU;AACpE,QAAM,gBAAgB,gBAAgB,MAAM,UAAU;AACtD,QAAM,MAAM,IAAI,IAAI,GAAG,qBAAqB,GAAG,aAAa,EAAE;AAE9D,QAAM,MAAM,MAAM,MAAM,IAAI,SAAS,GAAG;AAAA,IACtC,QAAQ;AAAA,IACR,SAAS;AAAA,MACP,gBAAgB;AAAA,MAChB,eAAe,UAAU,WAAW;AAAA,IACtC;AAAA,IACA,MAAM,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAAA,EAC9C,CAAC;AAED,MAAI,CAAC,IAAI,IAAI;AACX,UAAM,IAAI,MAAM,sCAAsC;AAAA,EACxD;AACF;","names":[]}

package/dist/{chunk-P52TG263.js → chunk-FUPEFLXB.js}

@@ -1,5 +1,8 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
+var _chunkSLHAVOTEjs = require('./chunk-SLHAVOTE.js');
+
+
 
 var _chunkP4DUDLMYjs = require('./chunk-P4DUDLMY.js');
 
@@ -8,7 +11,6 @@ var _chunkSMKTWM6Ijs = require('./chunk-SMKTWM6I.js');
 
 
 
-
 var _chunkMBTBE4P5js = require('./chunk-MBTBE4P5.js');
 
 
@@ -16,7 +18,7 @@ var _chunkMBTBE4P5js = require('./chunk-MBTBE4P5.js');
 var _chunkIGY2S5BCjs = require('./chunk-IGY2S5BC.js');
 
 // src/sdk/user-storage.ts
-var STORAGE_URL = (env, feature, entry) => `${_chunkSMKTWM6Ijs.getEnvUrls.call(void 0, env).userStorageApiUrl}/api/v1/userstorage/${feature}/${entry}`;
+var STORAGE_URL = (env, encryptedPath) => `${_chunkSMKTWM6Ijs.getEnvUrls.call(void 0, env).userStorageApiUrl}/api/v1/userstorage/${encryptedPath}`;
 var _upsertUserStorage, upsertUserStorage_fn, _getUserStorage, getUserStorage_fn, _createEntryKey, createEntryKey_fn, _getAuthorizationHeader, getAuthorizationHeader_fn;
 var UserStorage = class {
   constructor(config, options) {
@@ -30,17 +32,11 @@ var UserStorage = class {
     this.config = config;
     this.options = options;
   }
-  async setItem(feature, key, value) {
-    if (!feature.trim() || !key.trim()) {
-      throw new (0, _chunkMBTBE4P5js.ValidationError)("feature or key cannot be empty strings");
-    }
-    await _chunkIGY2S5BCjs.__privateMethod.call(void 0, this, _upsertUserStorage, upsertUserStorage_fn).call(this, feature, key, value);
+  async setItem(path, value) {
+    await _chunkIGY2S5BCjs.__privateMethod.call(void 0, this, _upsertUserStorage, upsertUserStorage_fn).call(this, path, value);
   }
-  async getItem(feature, key) {
-    if (!feature.trim() || !key.trim()) {
-      throw new (0, _chunkMBTBE4P5js.ValidationError)("feature or key cannot be empty strings");
-    }
-    return _chunkIGY2S5BCjs.__privateMethod.call(void 0, this, _getUserStorage, getUserStorage_fn).call(this, feature, key);
+  async getItem(path) {
+    return _chunkIGY2S5BCjs.__privateMethod.call(void 0, this, _getUserStorage, getUserStorage_fn).call(this, path);
   }
   async getStorageKey() {
     const storageKey = await this.options.storage?.getStorageKey();
@@ -57,14 +53,13 @@ var UserStorage = class {
   }
 };
 _upsertUserStorage = new WeakSet();
-upsertUserStorage_fn = async function(feature, key, data) {
+upsertUserStorage_fn = async function(path, data) {
   try {
     const headers = await _chunkIGY2S5BCjs.__privateMethod.call(void 0, this, _getAuthorizationHeader, getAuthorizationHeader_fn).call(this);
     const storageKey = await this.getStorageKey();
     const encryptedData = _chunkP4DUDLMYjs.encryption_default.encryptString(data, storageKey);
-    const url = new URL(
-      STORAGE_URL(this.env, feature, _chunkIGY2S5BCjs.__privateMethod.call(void 0, this, _createEntryKey, createEntryKey_fn).call(this, key, storageKey))
-    );
+    const encryptedPath = _chunkSLHAVOTEjs.createEntryPath.call(void 0, path, storageKey);
+    const url = new URL(STORAGE_URL(this.env, encryptedPath));
     const response = await fetch(url.toString(), {
       method: "PUT",
       headers: {
@@ -85,18 +80,17 @@ upsertUserStorage_fn = async function(feature, key, data) {
   } catch (e) {
     const errorMessage = e instanceof Error ? e.message : JSON.stringify(e ?? "");
     throw new (0, _chunkMBTBE4P5js.UserStorageError)(
-      `failed to upsert user storage for feature '${feature}' and key '${key}'. ${errorMessage}`
+      `failed to upsert user storage for path '${path}'. ${errorMessage}`
     );
   }
 };
 _getUserStorage = new WeakSet();
-getUserStorage_fn = async function(feature, key) {
+getUserStorage_fn = async function(path) {
   try {
     const headers = await _chunkIGY2S5BCjs.__privateMethod.call(void 0, this, _getAuthorizationHeader, getAuthorizationHeader_fn).call(this);
     const storageKey = await this.getStorageKey();
-    const url = new URL(
-      STORAGE_URL(this.env, feature, _chunkIGY2S5BCjs.__privateMethod.call(void 0, this, _createEntryKey, createEntryKey_fn).call(this, key, storageKey))
-    );
+    const encryptedPath = _chunkSLHAVOTEjs.createEntryPath.call(void 0, path, storageKey);
+    const url = new URL(STORAGE_URL(this.env, encryptedPath));
     const response = await fetch(url.toString(), {
       headers: {
         "Content-Type": "application/json",
@@ -105,7 +99,7 @@ getUserStorage_fn = async function(feature, key) {
     });
     if (response.status === 404) {
       throw new (0, _chunkMBTBE4P5js.NotFoundError)(
-        `feature/key set not found for feature '${feature}' and key '${key}'.`
+        `feature/key set not found for path '${path}'.`
       );
     }
     if (!response.ok) {
@@ -122,7 +116,7 @@ getUserStorage_fn = async function(feature, key) {
     }
     const errorMessage = e instanceof Error ? e.message : JSON.stringify(e ?? "");
     throw new (0, _chunkMBTBE4P5js.UserStorageError)(
-      `failed to get user storage for feature '${feature}' and key '${key}'. ${errorMessage}`
+      `failed to get user storage for path '${path}'. ${errorMessage}`
     );
   }
 };
@@ -141,4 +135,4 @@ getAuthorizationHeader_fn = async function() {
 
 
 exports.STORAGE_URL = STORAGE_URL; exports.UserStorage = UserStorage;
-//# sourceMappingURL=chunk-P52TG263.js.map
+//# sourceMappingURL=chunk-FUPEFLXB.js.map

package/dist/chunk-FUPEFLXB.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/sdk/user-storage.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAQO,IAAM,cAAc,CAAC,KAAU,kBACpC,GAAG,WAAW,GAAG,EAAE,iBAAiB,uBAAuB,aAAa;AAT1E;AA8BO,IAAM,cAAN,MAAkB;AAAA,EAOvB,YAAY,QAA2B,SAA6B;AA6BpE,uBAAM;AAqCN,uBAAM;AA6CN;AAOA;AAAA;AAAA,uBAAM;AArHJ,SAAK,MAAM,OAAO;AAClB,SAAK,SAAS;AACd,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,MAAM,QAAQ,MAAuB,OAA8B;AACjE,UAAM,sBAAK,0CAAL,WAAwB,MAAM;AAAA,EACtC;AAAA,EAEA,MAAM,QAAQ,MAAwC;AACpD,WAAO,sBAAK,oCAAL,WAAqB;AAAA,EAC9B;AAAA,EAEA,MAAM,gBAAiC;AACrC,UAAM,aAAa,MAAM,KAAK,QAAQ,SAAS,cAAc;AAC7D,QAAI,YAAY;AACd,aAAO;AAAA,IACT;AAEA,UAAM,cAAc,MAAM,KAAK,OAAO,KAAK,eAAe;AAC1D,UAAM,sBAAsB,MAAM,KAAK,OAAO,KAAK;AAAA,MACjD,YAAY,YAAY,SAAS;AAAA,IACnC;AACA,UAAM,4BAA4B,iBAAiB,mBAAmB;AACtE,UAAM,KAAK,QAAQ,SAAS,cAAc,yBAAyB;AACnE,WAAO;AAAA,EACT;AA+FF;AA7FQ;AAAA,uBAAkB,eAAC,MAAuB,MAA6B;AAC3E,MAAI;AACF,UAAM,UAAU,MAAM,sBAAK,oDAAL;AACtB,UAAM,aAAa,MAAM,KAAK,cAAc;AAC5C,UAAM,gBAAgB,mBAAW,cAAc,MAAM,UAAU;AAC/D,UAAM,gBAAgB,gBAAgB,MAAM,UAAU;AAEtD,UAAM,MAAM,IAAI,IAAI,YAAY,KAAK,KAAK,aAAa,CAAC;AAExD,UAAM,WAAW,MAAM,MAAM,IAAI,SAAS,GAAG;AAAA,MAC3C,QAAQ;AAAA,MACR,SAAS;AAAA,QACP,gBAAgB;AAAA,QAChB,GAAG;AAAA,MACL;AAAA,MACA,MAAM,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAAA,IAC9C,CAAC;AAED,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,eAA6B,MAAM,SAAS,KAAK,EAAE,MAAM,OAAO;AAAA,QACpE,SAAS;AAAA,QACT,OAAO;AAAA,MACT,EAAE;AACF,YAAM,IAAI;AAAA,QACR,uBAAuB,aAAa,OAAO,YAAY,aAAa,KAAK;AAAA,MAC3E;AAAA,IACF;AAAA,EACF,SAAS,GAAG;AAEV,UAAM,eACJ,aAAa,QAAQ,EAAE,UAAU,KAAK,UAAU,KAAK,EAAE;AACzD,UAAM,IAAI;AAAA,MACR,2CAA2C,IAAI,MAAM,YAAY;AAAA,IACnE;AAAA,EACF;AACF;AAEM;AAAA,oBAAe,eAAC,MAAwC;AAC5D,MAAI;AACF,UAAM,UAAU,MAAM,sBAAK,oDAAL;AACtB,UAAM,aAAa,MAAM,KAAK,cAAc;AAC5C,UAAM,gBAAgB,gBAAgB,MAAM,UAAU;AAEtD,UAAM,MAAM,IAAI,IAAI,YAAY,KAAK,KAAK,aAAa,CAAC;AAExD,UAAM,WAAW,MAAM,MAAM,IAAI,SAAS,GAAG;AAAA,MAC3C,SAAS;AAAA,QACP,gBAAgB;AAAA,QAChB,GAAG;AAAA,MACL;AAAA,IACF,CAAC;AAED,QAAI,SAAS,WAAW,KAAK;AAC3B,YAAM,IAAI;AAAA,QACR,uCAAuC,IAAI;AAAA,MAC7C;AAAA,IACF;AAEA,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,eAAgB,MAAM,SAAS,KAAK;AAC1C,YAAM,IAAI;AAAA,QACR,uBAAuB,aAAa,OAAO,YAAY,aAAa,KAAK;AAAA,MAC3E;AAAA,IACF;AAEA,UAAM,EAAE,MAAM,cAAc,IAAI,MAAM,SAAS,KAAK;AACpD,WAAO,mBAAW,cAAc,eAAe,UAAU;AAAA,EAC3D,SAAS,GAAG;AACV,QAAI,aAAa,eAAe;AAC9B,YAAM;AAAA,IACR;AAGA,UAAM,eACJ,aAAa,QAAQ,EAAE,UAAU,KAAK,UAAU,KAAK,EAAE;AAEzD,UAAM,IAAI;AAAA,MACR,wCAAwC,IAAI,MAAM,YAAY;AAAA,IAChE;AAAA,EACF;AACF;AAEA;AAAA,oBAAe,SAAC,KAAa,YAA4B;AACvD,QAAM,YAAY,iBAAiB,MAAM,UAAU;AACnD,SAAO;AACT;AAIM;AAAA,4BAAuB,iBAAuC;AAClE,QAAM,cAAc,MAAM,KAAK,OAAO,KAAK,eAAe;AAC1D,SAAO,EAAE,eAAe,UAAU,WAAW,GAAG;AAClD","sourcesContent":["import type { UserStoragePath } from '../controllers/user-storage/schema';\nimport { createEntryPath } from '../controllers/user-storage/schema';\nimport type { IBaseAuth } from './authentication-jwt-bearer/types';\nimport encryption, { createSHA256Hash } from './encryption';\nimport type { Env } from './env';\nimport { getEnvUrls } from './env';\nimport { NotFoundError, UserStorageError } from './errors';\n\nexport const STORAGE_URL = (env: Env, encryptedPath: string) =>\n  `${getEnvUrls(env).userStorageApiUrl}/api/v1/userstorage/${encryptedPath}`;\n\nexport type UserStorageConfig = {\n  env: Env;\n  auth: Pick<IBaseAuth, 'getAccessToken' | 'getUserProfile' | 'signMessage'>;\n};\n\nexport type StorageOptions = {\n  getStorageKey: () => Promise<string | null>;\n  setStorageKey: (val: string) => Promise<void>;\n};\n\nexport type UserStorageOptions = {\n  storage?: StorageOptions;\n};\n\ntype ErrorMessage = {\n  message: string;\n  error: string;\n};\n\nexport class UserStorage {\n  protected config: UserStorageConfig;\n\n  protected options: UserStorageOptions;\n\n  protected env: Env;\n\n  constructor(config: UserStorageConfig, options: UserStorageOptions) {\n    this.env = config.env;\n    this.config = config;\n    this.options = options;\n  }\n\n  async setItem(path: UserStoragePath, value: string): Promise<void> {\n    await this.#upsertUserStorage(path, value);\n  }\n\n  async getItem(path: UserStoragePath): Promise<string> {\n    return this.#getUserStorage(path);\n  }\n\n  async getStorageKey(): Promise<string> {\n    const storageKey = await this.options.storage?.getStorageKey();\n    if (storageKey) {\n      return storageKey;\n    }\n\n    const userProfile = await this.config.auth.getUserProfile();\n    const storageKeySignature = await this.config.auth.signMessage(\n      `metamask:${userProfile.profileId}`,\n    );\n    const hashedStorageKeySignature = createSHA256Hash(storageKeySignature);\n    await this.options.storage?.setStorageKey(hashedStorageKeySignature);\n    return hashedStorageKeySignature;\n  }\n\n  async #upsertUserStorage(path: UserStoragePath, data: string): Promise<void> {\n    try {\n      const headers = await this.#getAuthorizationHeader();\n      const storageKey = await this.getStorageKey();\n      const encryptedData = encryption.encryptString(data, storageKey);\n      const encryptedPath = createEntryPath(path, storageKey);\n\n      const url = new URL(STORAGE_URL(this.env, encryptedPath));\n\n      const response = await fetch(url.toString(), {\n        method: 'PUT',\n        headers: {\n          'Content-Type': 'application/json',\n          ...headers,\n        },\n        body: JSON.stringify({ data: encryptedData }),\n      });\n\n      if (!response.ok) {\n        const responseBody: ErrorMessage = await response.json().catch(() => ({\n          message: 'unknown',\n          error: 'unknown',\n        }));\n        throw new Error(\n          `HTTP error message: ${responseBody.message}, error: ${responseBody.error}`,\n        );\n      }\n    } catch (e) {\n      /* istanbul ignore next */\n      const errorMessage =\n        e instanceof Error ? e.message : JSON.stringify(e ?? '');\n      throw new UserStorageError(\n        `failed to upsert user storage for path '${path}'. ${errorMessage}`,\n      );\n    }\n  }\n\n  async #getUserStorage(path: UserStoragePath): Promise<string> {\n    try {\n      const headers = await this.#getAuthorizationHeader();\n      const storageKey = await this.getStorageKey();\n      const encryptedPath = createEntryPath(path, storageKey);\n\n      const url = new URL(STORAGE_URL(this.env, encryptedPath));\n\n      const response = await fetch(url.toString(), {\n        headers: {\n          'Content-Type': 'application/json',\n          ...headers,\n        },\n      });\n\n      if (response.status === 404) {\n        throw new NotFoundError(\n          `feature/key set not found for path '${path}'.`,\n        );\n      }\n\n      if (!response.ok) {\n        const responseBody = (await response.json()) as ErrorMessage;\n        throw new Error(\n          `HTTP error message: ${responseBody.message}, error: ${responseBody.error}`,\n        );\n      }\n\n      const { Data: encryptedData } = await response.json();\n      return encryption.decryptString(encryptedData, storageKey);\n    } catch (e) {\n      if (e instanceof NotFoundError) {\n        throw e;\n      }\n\n      /* istanbul ignore next */\n      const errorMessage =\n        e instanceof Error ? e.message : JSON.stringify(e ?? '');\n\n      throw new UserStorageError(\n        `failed to get user storage for path '${path}'. ${errorMessage}`,\n      );\n    }\n  }\n\n  #createEntryKey(key: string, storageKey: string): string {\n    const hashedKey = createSHA256Hash(key + storageKey);\n    return hashedKey;\n  }\n\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  async #getAuthorizationHeader(): Promise<{ Authorization: string }> {\n    const accessToken = await this.config.auth.getAccessToken();\n    return { Authorization: `Bearer ${accessToken}` };\n  }\n}\n"]}

package/dist/chunk-ILIZJQ6X.mjs

@@ -0,0 +1,40 @@
+import {
+  createSHA256Hash
+} from "./chunk-K5UKU454.mjs";
+
+// src/controllers/user-storage/schema.ts
+var USER_STORAGE_SCHEMA = {
+  notifications: ["notificationSettings"]
+};
+var getFeatureAndKeyFromPath = (path) => {
+  const pathRegex = /^\w+\.\w+$/u;
+  if (!pathRegex.test(path)) {
+    throw new Error(
+      `user-storage - path is not in the correct format. Correct format: 'feature.key'`
+    );
+  }
+  const [feature, key] = path.split(".");
+  if (!(feature in USER_STORAGE_SCHEMA)) {
+    throw new Error(`user-storage - invalid feature provided: ${feature}`);
+  }
+  const validFeature = USER_STORAGE_SCHEMA[feature];
+  if (!validFeature.includes(key)) {
+    const validKeys = USER_STORAGE_SCHEMA[feature].join(", ");
+    throw new Error(
+      `user-storage - invalid key provided for this feature: ${key}. Valid keys: ${validKeys}`
+    );
+  }
+  return { feature, key };
+};
+function createEntryPath(path, storageKey) {
+  const { feature, key } = getFeatureAndKeyFromPath(path);
+  const hashedKey = createSHA256Hash(key + storageKey);
+  return `/${feature}/${hashedKey}`;
+}
+
+export {
+  USER_STORAGE_SCHEMA,
+  getFeatureAndKeyFromPath,
+  createEntryPath
+};
+//# sourceMappingURL=chunk-ILIZJQ6X.mjs.map

package/dist/chunk-ILIZJQ6X.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/controllers/user-storage/schema.ts"],"sourcesContent":["import { createSHA256Hash } from './encryption';\n\n/**\n * The User Storage Endpoint requires a feature name and a namespace key.\n * Developers can provide additional features and keys by extending these types below.\n */\n\nexport const USER_STORAGE_SCHEMA = {\n  notifications: ['notificationSettings'],\n} as const;\n\ntype UserStorageSchema = typeof USER_STORAGE_SCHEMA;\ntype UserStorageFeatures = keyof UserStorageSchema;\ntype UserStorageFeatureKeys<Feature extends UserStorageFeatures> =\n  UserStorageSchema[Feature][number];\n\ntype UserStorageFeatureAndKey = {\n  feature: UserStorageFeatures;\n  key: UserStorageFeatureKeys<UserStorageFeatures>;\n};\n\nexport type UserStoragePath = {\n  [K in keyof UserStorageSchema]: `${K}.${UserStorageSchema[K][number]}`;\n}[keyof UserStorageSchema];\n\nexport const getFeatureAndKeyFromPath = (\n  path: UserStoragePath,\n): UserStorageFeatureAndKey => {\n  const pathRegex = /^\\w+\\.\\w+$/u;\n\n  if (!pathRegex.test(path)) {\n    throw new Error(\n      `user-storage - path is not in the correct format. Correct format: 'feature.key'`,\n    );\n  }\n\n  const [feature, key] = path.split('.') as [\n    UserStorageFeatures,\n    UserStorageFeatureKeys<UserStorageFeatures>,\n  ];\n\n  if (!(feature in USER_STORAGE_SCHEMA)) {\n    throw new Error(`user-storage - invalid feature provided: ${feature}`);\n  }\n\n  const validFeature = USER_STORAGE_SCHEMA[feature] as readonly string[];\n\n  if (!validFeature.includes(key)) {\n    const validKeys = USER_STORAGE_SCHEMA[feature].join(', ');\n\n    throw new Error(\n      `user-storage - invalid key provided for this feature: ${key}. Valid keys: ${validKeys}`,\n    );\n  }\n\n  return { feature, key };\n};\n\n/**\n * Constructs a unique entry path for a user.\n * This can be done due to the uniqueness of the storage key (no users will share the same storage key).\n * The users entry is a unique hash that cannot be reversed.\n *\n * @param path - string in the form of `${feature}.${key}` that matches schema\n * @param storageKey - users storage key\n * @returns path to store entry\n */\nexport function createEntryPath(\n  path: UserStoragePath,\n  storageKey: string,\n): string {\n  const { feature, key } = getFeatureAndKeyFromPath(path);\n  const hashedKey = createSHA256Hash(key + storageKey);\n\n  return `/${feature}/${hashedKey}`;\n}\n"],"mappings":";;;;;AAOO,IAAM,sBAAsB;AAAA,EACjC,eAAe,CAAC,sBAAsB;AACxC;AAgBO,IAAM,2BAA2B,CACtC,SAC6B;AAC7B,QAAM,YAAY;AAElB,MAAI,CAAC,UAAU,KAAK,IAAI,GAAG;AACzB,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,QAAM,CAAC,SAAS,GAAG,IAAI,KAAK,MAAM,GAAG;AAKrC,MAAI,EAAE,WAAW,sBAAsB;AACrC,UAAM,IAAI,MAAM,4CAA4C,OAAO,EAAE;AAAA,EACvE;AAEA,QAAM,eAAe,oBAAoB,OAAO;AAEhD,MAAI,CAAC,aAAa,SAAS,GAAG,GAAG;AAC/B,UAAM,YAAY,oBAAoB,OAAO,EAAE,KAAK,IAAI;AAExD,UAAM,IAAI;AAAA,MACR,yDAAyD,GAAG,iBAAiB,SAAS;AAAA,IACxF;AAAA,EACF;AAEA,SAAO,EAAE,SAAS,IAAI;AACxB;AAWO,SAAS,gBACd,MACA,YACQ;AACR,QAAM,EAAE,SAAS,IAAI,IAAI,yBAAyB,IAAI;AACtD,QAAM,YAAY,iBAAiB,MAAM,UAAU;AAEnD,SAAO,IAAI,OAAO,IAAI,SAAS;AACjC;","names":[]}

package/dist/{chunk-DDOYG42A.js → chunk-JENTMRXO.js}

@@ -4,7 +4,7 @@ var _chunkYHGWG3EQjs = require('./chunk-YHGWG3EQ.js');
 
 
 
-var _chunk5SXXO4MVjs = require('./chunk-5SXXO4MV.js');
+var _chunk3TE6M5TVjs = require('./chunk-3TE6M5TV.js');
 
 
 var _chunkT3FNDVE3js = require('./chunk-T3FNDVE3.js');
@@ -12,6 +12,7 @@ var _chunkT3FNDVE3js = require('./chunk-T3FNDVE3.js');
 
 
 
+
 var _chunkIGY2S5BCjs = require('./chunk-IGY2S5BC.js');
 
 // src/controllers/user-storage/UserStorageController.ts
@@ -31,7 +32,7 @@ var metadata = {
     anonymous: false
   }
 };
-var _auth, _notificationServices, _registerMessageHandlers, registerMessageHandlers_fn, _assertProfileSyncingEnabled, assertProfileSyncingEnabled_fn, _getStorageKeyAndBearerToken, getStorageKeyAndBearerToken_fn, _createStorageKey, createStorageKey_fn, __snapSignMessageCache, _snapSignMessage, snapSignMessage_fn, _setIsProfileSyncingUpdateLoading, setIsProfileSyncingUpdateLoading_fn;
+var _auth, _notificationServices, _isUnlocked, _keyringController, _registerMessageHandlers, registerMessageHandlers_fn, _assertProfileSyncingEnabled, assertProfileSyncingEnabled_fn, _getStorageKeyAndBearerToken, getStorageKeyAndBearerToken_fn, _createStorageKey, createStorageKey_fn, __snapSignMessageCache, _snapSignMessage, snapSignMessage_fn, _setIsProfileSyncingUpdateLoading, setIsProfileSyncingUpdateLoading_fn;
 var UserStorageController = class extends _basecontroller.BaseController {
   constructor(params) {
     super({
@@ -102,8 +103,24 @@ var UserStorageController = class extends _basecontroller.BaseController {
         );
       }
     });
+    _chunkIGY2S5BCjs.__privateAdd.call(void 0, this, _isUnlocked, false);
+    _chunkIGY2S5BCjs.__privateAdd.call(void 0, this, _keyringController, {
+      setupLockedStateSubscriptions: () => {
+        const { isUnlocked } = this.messagingSystem.call(
+          "KeyringController:getState"
+        );
+        _chunkIGY2S5BCjs.__privateSet.call(void 0, this, _isUnlocked, isUnlocked);
+        this.messagingSystem.subscribe("KeyringController:unlock", () => {
+          _chunkIGY2S5BCjs.__privateSet.call(void 0, this, _isUnlocked, true);
+        });
+        this.messagingSystem.subscribe("KeyringController:lock", () => {
+          _chunkIGY2S5BCjs.__privateSet.call(void 0, this, _isUnlocked, false);
+        });
+      }
+    });
     _chunkIGY2S5BCjs.__privateAdd.call(void 0, this, __snapSignMessageCache, {});
     this.getMetaMetricsState = params.getMetaMetricsState;
+    _chunkIGY2S5BCjs.__privateGet.call(void 0, this, _keyringController).setupLockedStateSubscriptions();
     _chunkIGY2S5BCjs.__privateMethod.call(void 0, this, _registerMessageHandlers, registerMessageHandlers_fn).call(this);
   }
   async enableProfileSyncing() {
@@ -143,7 +160,7 @@ var UserStorageController = class extends _basecontroller.BaseController {
       }
       const isMetaMetricsParticipation = this.getMetaMetricsState();
       if (!isMetaMetricsParticipation) {
-        this.messagingSystem.call("AuthenticationController:performSignOut");
+        await _chunkIGY2S5BCjs.__privateGet.call(void 0, this, _auth).signOut();
       }
       _chunkIGY2S5BCjs.__privateMethod.call(void 0, this, _setIsProfileSyncingUpdateLoading, setIsProfileSyncingUpdateLoading_fn).call(this, false);
       this.update((state) => {
@@ -161,14 +178,14 @@ var UserStorageController = class extends _basecontroller.BaseController {
    * Allows retrieval of stored data. Data stored is string formatted.
    * Developers can extend the entry path and entry name through the `schema.ts` file.
    *
-   * @param entryKey - entry key that matches schema
+   * @param path - string in the form of `${feature}.${key}` that matches schema
    * @returns the decrypted string contents found from user storage (or null if not found)
    */
-  async performGetStorage(entryKey) {
+  async performGetStorage(path) {
     _chunkIGY2S5BCjs.__privateMethod.call(void 0, this, _assertProfileSyncingEnabled, assertProfileSyncingEnabled_fn).call(this);
     const { bearerToken, storageKey } = await _chunkIGY2S5BCjs.__privateMethod.call(void 0, this, _getStorageKeyAndBearerToken, getStorageKeyAndBearerToken_fn).call(this);
-    const result = await _chunk5SXXO4MVjs.getUserStorage.call(void 0, {
-      entryKey,
+    const result = await _chunk3TE6M5TVjs.getUserStorage.call(void 0, {
+      path,
       bearerToken,
       storageKey
     });
@@ -178,15 +195,15 @@ var UserStorageController = class extends _basecontroller.BaseController {
    * Allows storage of user data. Data stored must be string formatted.
    * Developers can extend the entry path and entry name through the `schema.ts` file.
    *
-   * @param entryKey - entry key that matches schema
+   * @param path - string in the form of `${feature}.${key}` that matches schema
    * @param value - The string data you want to store.
    * @returns nothing. NOTE that an error is thrown if fails to store data.
    */
-  async performSetStorage(entryKey, value) {
+  async performSetStorage(path, value) {
     _chunkIGY2S5BCjs.__privateMethod.call(void 0, this, _assertProfileSyncingEnabled, assertProfileSyncingEnabled_fn).call(this);
     const { bearerToken, storageKey } = await _chunkIGY2S5BCjs.__privateMethod.call(void 0, this, _getStorageKeyAndBearerToken, getStorageKeyAndBearerToken_fn).call(this);
-    await _chunk5SXXO4MVjs.upsertUserStorage.call(void 0, value, {
-      entryKey,
+    await _chunk3TE6M5TVjs.upsertUserStorage.call(void 0, value, {
+      path,
       bearerToken,
       storageKey
     });
@@ -204,6 +221,8 @@ var UserStorageController = class extends _basecontroller.BaseController {
 };
 _auth = new WeakMap();
 _notificationServices = new WeakMap();
+_isUnlocked = new WeakMap();
+_keyringController = new WeakMap();
 _registerMessageHandlers = new WeakSet();
 registerMessageHandlers_fn = function() {
   this.messagingSystem.registerActionHandler(
@@ -260,6 +279,11 @@ snapSignMessage_fn = async function(message) {
   if (_chunkIGY2S5BCjs.__privateGet.call(void 0, this, __snapSignMessageCache)[message]) {
     return _chunkIGY2S5BCjs.__privateGet.call(void 0, this, __snapSignMessageCache)[message];
   }
+  if (!_chunkIGY2S5BCjs.__privateGet.call(void 0, this, _isUnlocked)) {
+    throw new Error(
+      "#snapSignMessage - unable to call snap, wallet is locked"
+    );
+  }
   const result = await this.messagingSystem.call(
     "SnapController:handleRequest",
     _chunkYHGWG3EQjs.createSnapSignMessageRequest.call(void 0, message)
@@ -278,4 +302,4 @@ setIsProfileSyncingUpdateLoading_fn = function(isProfileSyncingUpdateLoading) {
 
 
 exports.defaultState = defaultState; exports.UserStorageController = UserStorageController;
-//# sourceMappingURL=chunk-DDOYG42A.js.map
+//# sourceMappingURL=chunk-JENTMRXO.js.map