@metamask-previews/profile-sync-controller 20.0.0-preview-988fbb56 → 20.0.0-preview-afb9460

package/dist/shared/storage-schema.d.mts

@@ -1,41 +1,17 @@
 /**
  * The User Storage Endpoint requires a feature name and a namespace key.
- * Developers can provide additional features and keys by extending these types below.
- *
- * Adding ALLOW_ARBITRARY_KEYS as the first key in the array allows for any key to be used for this feature.
- * This can be useful for features where keys are not deterministic (eg. accounts addresses).
+ * Any user storage path should be in the form of `feature.key`.
  */
-declare const ALLOW_ARBITRARY_KEYS: "ALLOW_ARBITRARY_KEYS";
-export declare const USER_STORAGE_FEATURE_NAMES: {
-    readonly notifications: "notifications";
-    readonly accounts: "accounts_v2";
-    readonly networks: "networks";
-    readonly addressBook: "addressBook";
-};
-export type UserStorageFeatureNames = (typeof USER_STORAGE_FEATURE_NAMES)[keyof typeof USER_STORAGE_FEATURE_NAMES];
-export declare const USER_STORAGE_SCHEMA: {
-    readonly notifications: readonly ["notification_settings"];
-    readonly accounts_v2: readonly ["ALLOW_ARBITRARY_KEYS"];
-    readonly networks: readonly ["ALLOW_ARBITRARY_KEYS"];
-    readonly addressBook: readonly ["ALLOW_ARBITRARY_KEYS"];
-};
-type UserStorageSchema = typeof USER_STORAGE_SCHEMA;
-export type UserStorageFeatureKeys<Feature extends UserStorageFeatureNames> = UserStorageSchema[Feature][0] extends typeof ALLOW_ARBITRARY_KEYS ? string : UserStorageSchema[Feature][number];
-type UserStorageFeatureAndKey = {
-    feature: UserStorageFeatureNames;
-    key: UserStorageFeatureKeys<UserStorageFeatureNames>;
-};
-export type UserStoragePathWithFeatureOnly = UserStorageFeatureNames;
-export type UserStoragePathWithFeatureAndKey = {
-    [K in UserStorageFeatureNames]: `${K}.${UserStorageFeatureKeys<K>}`;
-}[UserStoragePathWithFeatureOnly];
 /**
- * The below types are mainly used for the SDK.
- * These exist so that the SDK can be used with arbitrary feature names and keys.
- *
- * We only type enforce feature names and keys when using UserStorageController.
- * This is done so we don't end up with magic strings within the applications.
+ * Helper object that contains the feature names used in the controllers and SDK.
+ * Developers don't need to add new feature names to this object anymore, as the schema enforcement has been deprecated.
  */
+export declare const USER_STORAGE_FEATURE_NAMES: {
+    notifications: string;
+    accounts: string;
+    networks: string;
+    addressBook: string;
+};
 export type UserStorageGenericFeatureName = string;
 export type UserStorageGenericFeatureKey = string;
 export type UserStorageGenericPathWithFeatureAndKey = `${UserStorageGenericFeatureName}.${UserStorageGenericFeatureKey}`;
@@ -44,9 +20,7 @@ type UserStorageGenericFeatureAndKey = {
     feature: UserStorageGenericFeatureName;
     key: UserStorageGenericFeatureKey;
 };
-export declare const getFeatureAndKeyFromPath: <T extends boolean>(path: T extends true ? UserStoragePathWithFeatureAndKey : `${string}.${string}`, options?: {
-    validateAgainstSchema: T;
-}) => T extends true ? UserStorageFeatureAndKey : UserStorageGenericFeatureAndKey;
+export declare const getFeatureAndKeyFromPath: (path: UserStorageGenericPathWithFeatureAndKey) => UserStorageGenericFeatureAndKey;
 /**
  * Constructs a unique entry path for a user.
  * This can be done due to the uniqueness of the storage key (no users will share the same storage key).
@@ -54,13 +28,8 @@ export declare const getFeatureAndKeyFromPath: <T extends boolean>(path: T exten
  *
  * @param path - string in the form of `${feature}.${key}` that matches schema
  * @param storageKey - users storage key
- * @param options - options object
- * @param options.validateAgainstSchema - whether to validate the path against the schema.
- * This defaults to true, and should only be set to false when using the SDK with arbitrary feature names and keys.
  * @returns path to store entry
  */
-export declare function createEntryPath<T extends boolean>(path: T extends true ? UserStoragePathWithFeatureAndKey : UserStorageGenericPathWithFeatureAndKey, storageKey: string, options?: {
-    validateAgainstSchema: T;
-}): string;
+export declare function createEntryPath(path: UserStorageGenericPathWithFeatureAndKey, storageKey: string): string;
 export {};
 //# sourceMappingURL=storage-schema.d.mts.map

package/dist/shared/storage-schema.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"storage-schema.d.mts","sourceRoot":"","sources":["../../src/shared/storage-schema.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,QAAA,MAAM,oBAAoB,wBAAkC,CAAC;AAE7D,eAAO,MAAM,0BAA0B;;;;;CAK7B,CAAC;AAEX,MAAM,MAAM,uBAAuB,GACjC,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,OAAO,0BAA0B,CAAC,CAAC;AAE/E,eAAO,MAAM,mBAAmB;;;;;CAKtB,CAAC;AAEX,KAAK,iBAAiB,GAAG,OAAO,mBAAmB,CAAC;AAEpD,MAAM,MAAM,sBAAsB,CAAC,OAAO,SAAS,uBAAuB,IACxE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,OAAO,oBAAoB,GAC7D,MAAM,GACN,iBAAiB,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzC,KAAK,wBAAwB,GAAG;IAC9B,OAAO,EAAE,uBAAuB,CAAC;IACjC,GAAG,EAAE,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;CACtD,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG,uBAAuB,CAAC;AACrE,MAAM,MAAM,gCAAgC,GAAG;KAC5C,CAAC,IAAI,uBAAuB,GAAG,GAAG,CAAC,IAAI,sBAAsB,CAAC,CAAC,CAAC,EAAE;CACpE,CAAC,8BAA8B,CAAC,CAAC;AAElC;;;;;;GAMG;AAEH,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAAC;AACnD,MAAM,MAAM,4BAA4B,GAAG,MAAM,CAAC;AAClD,MAAM,MAAM,uCAAuC,GACjD,GAAG,6BAA6B,IAAI,4BAA4B,EAAE,CAAC;AACrE,MAAM,MAAM,qCAAqC,GAC/C,6BAA6B,CAAC;AAEhC,KAAK,+BAA+B,GAAG;IACrC,OAAO,EAAE,6BAA6B,CAAC;IACvC,GAAG,EAAE,4BAA4B,CAAC;CACnC,CAAC;AAEF,eAAO,MAAM,wBAAwB;;iFAqDpC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,OAAO,EAC/C,IAAI,EAAE,CAAC,SAAS,IAAI,GAChB,gCAAgC,GAChC,uCAAuC,EAC3C,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE;IACP,qBAAqB,EAAE,CAAC,CAAC;CACa,GACvC,MAAM,CAKR"}
+{"version":3,"file":"storage-schema.d.mts","sourceRoot":"","sources":["../../src/shared/storage-schema.ts"],"names":[],"mappings":"AAEA;;;GAGG;AAEH;;;GAGG;AACH,eAAO,MAAM,0BAA0B;;;;;CAKtC,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAAC;AACnD,MAAM,MAAM,4BAA4B,GAAG,MAAM,CAAC;AAClD,MAAM,MAAM,uCAAuC,GACjD,GAAG,6BAA6B,IAAI,4BAA4B,EAAE,CAAC;AACrE,MAAM,MAAM,qCAAqC,GAC/C,6BAA6B,CAAC;AAEhC,KAAK,+BAA+B,GAAG;IACrC,OAAO,EAAE,6BAA6B,CAAC;IACvC,GAAG,EAAE,4BAA4B,CAAC;CACnC,CAAC;AAEF,eAAO,MAAM,wBAAwB,SAC7B,uCAAuC,KAC5C,+BAYF,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,uCAAuC,EAC7C,UAAU,EAAE,MAAM,GACjB,MAAM,CAKR"}

package/dist/shared/storage-schema.mjs

@@ -1,43 +1,24 @@
 import { createSHA256Hash } from "./encryption/index.mjs";
 /**
  * The User Storage Endpoint requires a feature name and a namespace key.
- * Developers can provide additional features and keys by extending these types below.
- *
- * Adding ALLOW_ARBITRARY_KEYS as the first key in the array allows for any key to be used for this feature.
- * This can be useful for features where keys are not deterministic (eg. accounts addresses).
+ * Any user storage path should be in the form of `feature.key`.
+ */
+/**
+ * Helper object that contains the feature names used in the controllers and SDK.
+ * Developers don't need to add new feature names to this object anymore, as the schema enforcement has been deprecated.
  */
-const ALLOW_ARBITRARY_KEYS = 'ALLOW_ARBITRARY_KEYS';
 export const USER_STORAGE_FEATURE_NAMES = {
     notifications: 'notifications',
     accounts: 'accounts_v2',
     networks: 'networks',
     addressBook: 'addressBook',
 };
-export const USER_STORAGE_SCHEMA = {
-    [USER_STORAGE_FEATURE_NAMES.notifications]: ['notification_settings'],
-    [USER_STORAGE_FEATURE_NAMES.accounts]: [ALLOW_ARBITRARY_KEYS],
-    [USER_STORAGE_FEATURE_NAMES.networks]: [ALLOW_ARBITRARY_KEYS],
-    [USER_STORAGE_FEATURE_NAMES.addressBook]: [ALLOW_ARBITRARY_KEYS], // keyed by address_chainId
-};
-export const getFeatureAndKeyFromPath = (path, options = { validateAgainstSchema: true }) => {
+export const 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 (options.validateAgainstSchema) {
-        const featureToValidate = feature;
-        const keyToValidate = key;
-        if (!(featureToValidate in USER_STORAGE_SCHEMA)) {
-            throw new Error(`user-storage - invalid feature provided: ${featureToValidate}. Valid features: ${Object.keys(USER_STORAGE_SCHEMA).join(', ')}`);
-        }
-        const validFeature = USER_STORAGE_SCHEMA[featureToValidate];
-        if (!validFeature.includes(keyToValidate) &&
-            !validFeature.includes(ALLOW_ARBITRARY_KEYS)) {
-            const validKeys = USER_STORAGE_SCHEMA[featureToValidate].join(', ');
-            throw new Error(`user-storage - invalid key provided for this feature: ${keyToValidate}. Valid keys: ${validKeys}`);
-        }
-    }
     return { feature, key };
 };
 /**
@@ -47,13 +28,10 @@ export const getFeatureAndKeyFromPath = (path, options = { validateAgainstSchema
  *
  * @param path - string in the form of `${feature}.${key}` that matches schema
  * @param storageKey - users storage key
- * @param options - options object
- * @param options.validateAgainstSchema - whether to validate the path against the schema.
- * This defaults to true, and should only be set to false when using the SDK with arbitrary feature names and keys.
  * @returns path to store entry
  */
-export function createEntryPath(path, storageKey, options = { validateAgainstSchema: true }) {
-    const { feature, key } = getFeatureAndKeyFromPath(path, options);
+export function createEntryPath(path, storageKey) {
+    const { feature, key } = getFeatureAndKeyFromPath(path);
     const hashedKey = createSHA256Hash(key + storageKey);
     return `${feature}/${hashedKey}`;
 }

package/dist/shared/storage-schema.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"storage-schema.mjs","sourceRoot":"","sources":["../../src/shared/storage-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,+BAAqB;AAEhD;;;;;;GAMG;AACH,MAAM,oBAAoB,GAAG,sBAA+B,CAAC;AAE7D,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,aAAa,EAAE,eAAe;IAC9B,QAAQ,EAAE,aAAa;IACvB,QAAQ,EAAE,UAAU;IACpB,WAAW,EAAE,aAAa;CAClB,CAAC;AAKX,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,CAAC,0BAA0B,CAAC,aAAa,CAAC,EAAE,CAAC,uBAAuB,CAAC;IACrE,CAAC,0BAA0B,CAAC,QAAQ,CAAC,EAAE,CAAC,oBAAoB,CAAC;IAC7D,CAAC,0BAA0B,CAAC,QAAQ,CAAC,EAAE,CAAC,oBAAoB,CAAC;IAC7D,CAAC,0BAA0B,CAAC,WAAW,CAAC,EAAE,CAAC,oBAAoB,CAAC,EAAE,2BAA2B;CACrF,CAAC;AAuCX,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,IAE2C,EAC3C,UAEI,EAAE,qBAAqB,EAAE,IAAS,EAAE,EAGN,EAAE;IACpC,MAAM,SAAS,GAAG,aAAa,CAAC;IAEhC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACzB,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF,CAAC;KACH;IAED,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEvC,IAAI,OAAO,CAAC,qBAAqB,EAAE;QACjC,MAAM,iBAAiB,GAAG,OAAkC,CAAC;QAC7D,MAAM,aAAa,GAAG,GAErB,CAAC;QAEF,IAAI,CAAC,CAAC,iBAAiB,IAAI,mBAAmB,CAAC,EAAE;YAC/C,MAAM,IAAI,KAAK,CACb,4CAA4C,iBAAiB,qBAAqB,MAAM,CAAC,IAAI,CAC3F,mBAAmB,CACpB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACf,CAAC;SACH;QAED,MAAM,YAAY,GAAG,mBAAmB,CACtC,iBAAiB,CACG,CAAC;QAEvB,IACE,CAAC,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC;YACrC,CAAC,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAC5C;YACA,MAAM,SAAS,GAAG,mBAAmB,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEpE,MAAM,IAAI,KAAK,CACb,yDAAyD,aAAa,iBAAiB,SAAS,EAAE,CACnG,CAAC;SACH;KACF;IAED,OAAO,EAAE,OAAO,EAAE,GAAG,EAEc,CAAC;AACtC,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAC7B,IAE2C,EAC3C,UAAkB,EAClB,UAEI,EAAE,qBAAqB,EAAE,IAAS,EAAE;IAExC,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,wBAAwB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACjE,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,GAAG,UAAU,CAAC,CAAC;IAErD,OAAO,GAAG,OAAO,IAAI,SAAS,EAAE,CAAC;AACnC,CAAC","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 * Adding ALLOW_ARBITRARY_KEYS as the first key in the array allows for any key to be used for this feature.\n * This can be useful for features where keys are not deterministic (eg. accounts addresses).\n */\nconst ALLOW_ARBITRARY_KEYS = 'ALLOW_ARBITRARY_KEYS' as const;\n\nexport const USER_STORAGE_FEATURE_NAMES = {\n  notifications: 'notifications',\n  accounts: 'accounts_v2',\n  networks: 'networks',\n  addressBook: 'addressBook',\n} as const;\n\nexport type UserStorageFeatureNames =\n  (typeof USER_STORAGE_FEATURE_NAMES)[keyof typeof USER_STORAGE_FEATURE_NAMES];\n\nexport const USER_STORAGE_SCHEMA = {\n  [USER_STORAGE_FEATURE_NAMES.notifications]: ['notification_settings'],\n  [USER_STORAGE_FEATURE_NAMES.accounts]: [ALLOW_ARBITRARY_KEYS], // keyed by account addresses\n  [USER_STORAGE_FEATURE_NAMES.networks]: [ALLOW_ARBITRARY_KEYS], // keyed by chains/networks\n  [USER_STORAGE_FEATURE_NAMES.addressBook]: [ALLOW_ARBITRARY_KEYS], // keyed by address_chainId\n} as const;\n\ntype UserStorageSchema = typeof USER_STORAGE_SCHEMA;\n\nexport type UserStorageFeatureKeys<Feature extends UserStorageFeatureNames> =\n  UserStorageSchema[Feature][0] extends typeof ALLOW_ARBITRARY_KEYS\n    ? string\n    : UserStorageSchema[Feature][number];\n\ntype UserStorageFeatureAndKey = {\n  feature: UserStorageFeatureNames;\n  key: UserStorageFeatureKeys<UserStorageFeatureNames>;\n};\n\nexport type UserStoragePathWithFeatureOnly = UserStorageFeatureNames;\nexport type UserStoragePathWithFeatureAndKey = {\n  [K in UserStorageFeatureNames]: `${K}.${UserStorageFeatureKeys<K>}`;\n}[UserStoragePathWithFeatureOnly];\n\n/**\n * The below types are mainly used for the SDK.\n * These exist so that the SDK can be used with arbitrary feature names and keys.\n *\n * We only type enforce feature names and keys when using UserStorageController.\n * This is done so we don't end up with magic strings within the applications.\n */\n\nexport type UserStorageGenericFeatureName = string;\nexport type UserStorageGenericFeatureKey = string;\nexport type UserStorageGenericPathWithFeatureAndKey =\n  `${UserStorageGenericFeatureName}.${UserStorageGenericFeatureKey}`;\nexport type UserStorageGenericPathWithFeatureOnly =\n  UserStorageGenericFeatureName;\n\ntype UserStorageGenericFeatureAndKey = {\n  feature: UserStorageGenericFeatureName;\n  key: UserStorageGenericFeatureKey;\n};\n\nexport const getFeatureAndKeyFromPath = <T extends boolean>(\n  path: T extends true\n    ? UserStoragePathWithFeatureAndKey\n    : UserStorageGenericPathWithFeatureAndKey,\n  options: {\n    validateAgainstSchema: T;\n  } = { validateAgainstSchema: true as T },\n): T extends true\n  ? UserStorageFeatureAndKey\n  : UserStorageGenericFeatureAndKey => {\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('.');\n\n  if (options.validateAgainstSchema) {\n    const featureToValidate = feature as UserStorageFeatureNames;\n    const keyToValidate = key as UserStorageFeatureKeys<\n      typeof featureToValidate\n    >;\n\n    if (!(featureToValidate in USER_STORAGE_SCHEMA)) {\n      throw new Error(\n        `user-storage - invalid feature provided: ${featureToValidate}. Valid features: ${Object.keys(\n          USER_STORAGE_SCHEMA,\n        ).join(', ')}`,\n      );\n    }\n\n    const validFeature = USER_STORAGE_SCHEMA[\n      featureToValidate\n    ] as readonly string[];\n\n    if (\n      !validFeature.includes(keyToValidate) &&\n      !validFeature.includes(ALLOW_ARBITRARY_KEYS)\n    ) {\n      const validKeys = USER_STORAGE_SCHEMA[featureToValidate].join(', ');\n\n      throw new Error(\n        `user-storage - invalid key provided for this feature: ${keyToValidate}. Valid keys: ${validKeys}`,\n      );\n    }\n  }\n\n  return { feature, key } as T extends true\n    ? UserStorageFeatureAndKey\n    : UserStorageGenericFeatureAndKey;\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 * @param options - options object\n * @param options.validateAgainstSchema - whether to validate the path against the schema.\n * This defaults to true, and should only be set to false when using the SDK with arbitrary feature names and keys.\n * @returns path to store entry\n */\nexport function createEntryPath<T extends boolean>(\n  path: T extends true\n    ? UserStoragePathWithFeatureAndKey\n    : UserStorageGenericPathWithFeatureAndKey,\n  storageKey: string,\n  options: {\n    validateAgainstSchema: T;\n  } = { validateAgainstSchema: true as T },\n): string {\n  const { feature, key } = getFeatureAndKeyFromPath(path, options);\n  const hashedKey = createSHA256Hash(key + storageKey);\n\n  return `${feature}/${hashedKey}`;\n}\n"]}
+{"version":3,"file":"storage-schema.mjs","sourceRoot":"","sources":["../../src/shared/storage-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,+BAAqB;AAEhD;;;GAGG;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,aAAa,EAAE,eAAe;IAC9B,QAAQ,EAAE,aAAa;IACvB,QAAQ,EAAE,UAAU;IACpB,WAAW,EAAE,aAAa;CAC3B,CAAC;AAcF,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,IAA6C,EACZ,EAAE;IACnC,MAAM,SAAS,GAAG,aAAa,CAAC;IAEhC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACzB,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF,CAAC;KACH;IAED,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEvC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAqC,CAAC;AAC7D,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAC7B,IAA6C,EAC7C,UAAkB;IAElB,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,wBAAwB,CAAC,IAAI,CAAC,CAAC;IACxD,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,GAAG,UAAU,CAAC,CAAC;IAErD,OAAO,GAAG,OAAO,IAAI,SAAS,EAAE,CAAC;AACnC,CAAC","sourcesContent":["import { createSHA256Hash } from './encryption';\n\n/**\n * The User Storage Endpoint requires a feature name and a namespace key.\n * Any user storage path should be in the form of `feature.key`.\n */\n\n/**\n * Helper object that contains the feature names used in the controllers and SDK.\n * Developers don't need to add new feature names to this object anymore, as the schema enforcement has been deprecated.\n */\nexport const USER_STORAGE_FEATURE_NAMES = {\n  notifications: 'notifications',\n  accounts: 'accounts_v2',\n  networks: 'networks',\n  addressBook: 'addressBook',\n};\n\nexport type UserStorageGenericFeatureName = string;\nexport type UserStorageGenericFeatureKey = string;\nexport type UserStorageGenericPathWithFeatureAndKey =\n  `${UserStorageGenericFeatureName}.${UserStorageGenericFeatureKey}`;\nexport type UserStorageGenericPathWithFeatureOnly =\n  UserStorageGenericFeatureName;\n\ntype UserStorageGenericFeatureAndKey = {\n  feature: UserStorageGenericFeatureName;\n  key: UserStorageGenericFeatureKey;\n};\n\nexport const getFeatureAndKeyFromPath = (\n  path: UserStorageGenericPathWithFeatureAndKey,\n): UserStorageGenericFeatureAndKey => {\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('.');\n\n  return { feature, key } as UserStorageGenericFeatureAndKey;\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: UserStorageGenericPathWithFeatureAndKey,\n  storageKey: string,\n): string {\n  const { feature, key } = getFeatureAndKeyFromPath(path);\n  const hashedKey = createSHA256Hash(key + storageKey);\n\n  return `${feature}/${hashedKey}`;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/profile-sync-controller",
-  "version": "20.0.0-preview-988fbb56",
+  "version": "20.0.0-preview-afb9460",
   "description": "The profile sync helps developers synchronize data across multiple clients and devices in a privacy-preserving way. All data saved in the user storage database is encrypted client-side to preserve privacy. The user storage provides a modular design, giving developers the flexibility to construct and manage their storage spaces in a way that best suits their needs",
   "keywords": [
     "MetaMask",

package/dist/controllers/user-storage/constants/index.cjs

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./traces.cjs"), exports);
-//# sourceMappingURL=index.cjs.map

package/dist/controllers/user-storage/constants/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/constants/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAAyB","sourcesContent":["export * from './traces';\n"]}

package/dist/controllers/user-storage/constants/index.d.cts

@@ -1,2 +0,0 @@
-export * from "./traces.cjs";
-//# sourceMappingURL=index.d.cts.map

package/dist/controllers/user-storage/constants/index.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/constants/index.ts"],"names":[],"mappings":"AAAA,6BAAyB"}

package/dist/controllers/user-storage/constants/index.d.mts

@@ -1,2 +0,0 @@
-export * from "./traces.mjs";
-//# sourceMappingURL=index.d.mts.map

package/dist/controllers/user-storage/constants/index.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/constants/index.ts"],"names":[],"mappings":"AAAA,6BAAyB"}

package/dist/controllers/user-storage/constants/index.mjs

@@ -1,2 +0,0 @@
-export * from "./traces.mjs";
-//# sourceMappingURL=index.mjs.map

package/dist/controllers/user-storage/constants/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/constants/index.ts"],"names":[],"mappings":"AAAA,6BAAyB","sourcesContent":["export * from './traces';\n"]}

package/dist/controllers/user-storage/constants/traces.cjs

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TraceName = void 0;
-/**
- * Trace names for UserStorage syncing operations
- */
-exports.TraceName = {
-    // Contact syncing traces
-    ContactSyncFull: 'Contact Sync Full',
-    ContactSyncSaveBatch: 'Contact Sync Save Batch',
-    ContactSyncUpdateRemote: 'Contact Sync Update Remote',
-    ContactSyncDeleteRemote: 'Contact Sync Delete Remote',
-    // Account syncing traces
-    AccountSyncFull: 'Account Sync Full',
-    AccountSyncSaveIndividual: 'Account Sync Save Individual',
-};
-//# sourceMappingURL=traces.cjs.map

package/dist/controllers/user-storage/constants/traces.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"traces.cjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/constants/traces.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,SAAS,GAAG;IACvB,yBAAyB;IACzB,eAAe,EAAE,mBAAmB;IACpC,oBAAoB,EAAE,yBAAyB;IAC/C,uBAAuB,EAAE,4BAA4B;IACrD,uBAAuB,EAAE,4BAA4B;IAErD,yBAAyB;IACzB,eAAe,EAAE,mBAAmB;IACpC,yBAAyB,EAAE,8BAA8B;CACjD,CAAC","sourcesContent":["/**\n * Trace names for UserStorage syncing operations\n */\nexport const TraceName = {\n  // Contact syncing traces\n  ContactSyncFull: 'Contact Sync Full',\n  ContactSyncSaveBatch: 'Contact Sync Save Batch',\n  ContactSyncUpdateRemote: 'Contact Sync Update Remote',\n  ContactSyncDeleteRemote: 'Contact Sync Delete Remote',\n\n  // Account syncing traces\n  AccountSyncFull: 'Account Sync Full',\n  AccountSyncSaveIndividual: 'Account Sync Save Individual',\n} as const;\n"]}

package/dist/controllers/user-storage/constants/traces.d.cts

@@ -1,12 +0,0 @@
-/**
- * Trace names for UserStorage syncing operations
- */
-export declare const TraceName: {
-    readonly ContactSyncFull: "Contact Sync Full";
-    readonly ContactSyncSaveBatch: "Contact Sync Save Batch";
-    readonly ContactSyncUpdateRemote: "Contact Sync Update Remote";
-    readonly ContactSyncDeleteRemote: "Contact Sync Delete Remote";
-    readonly AccountSyncFull: "Account Sync Full";
-    readonly AccountSyncSaveIndividual: "Account Sync Save Individual";
-};
-//# sourceMappingURL=traces.d.cts.map

package/dist/controllers/user-storage/constants/traces.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"traces.d.cts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/constants/traces.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,SAAS;;;;;;;CAUZ,CAAC"}

package/dist/controllers/user-storage/constants/traces.d.mts

@@ -1,12 +0,0 @@
-/**
- * Trace names for UserStorage syncing operations
- */
-export declare const TraceName: {
-    readonly ContactSyncFull: "Contact Sync Full";
-    readonly ContactSyncSaveBatch: "Contact Sync Save Batch";
-    readonly ContactSyncUpdateRemote: "Contact Sync Update Remote";
-    readonly ContactSyncDeleteRemote: "Contact Sync Delete Remote";
-    readonly AccountSyncFull: "Account Sync Full";
-    readonly AccountSyncSaveIndividual: "Account Sync Save Individual";
-};
-//# sourceMappingURL=traces.d.mts.map

package/dist/controllers/user-storage/constants/traces.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"traces.d.mts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/constants/traces.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,SAAS;;;;;;;CAUZ,CAAC"}

package/dist/controllers/user-storage/constants/traces.mjs

@@ -1,14 +0,0 @@
-/**
- * Trace names for UserStorage syncing operations
- */
-export const TraceName = {
-    // Contact syncing traces
-    ContactSyncFull: 'Contact Sync Full',
-    ContactSyncSaveBatch: 'Contact Sync Save Batch',
-    ContactSyncUpdateRemote: 'Contact Sync Update Remote',
-    ContactSyncDeleteRemote: 'Contact Sync Delete Remote',
-    // Account syncing traces
-    AccountSyncFull: 'Account Sync Full',
-    AccountSyncSaveIndividual: 'Account Sync Save Individual',
-};
-//# sourceMappingURL=traces.mjs.map

package/dist/controllers/user-storage/constants/traces.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"traces.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/constants/traces.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,yBAAyB;IACzB,eAAe,EAAE,mBAAmB;IACpC,oBAAoB,EAAE,yBAAyB;IAC/C,uBAAuB,EAAE,4BAA4B;IACrD,uBAAuB,EAAE,4BAA4B;IAErD,yBAAyB;IACzB,eAAe,EAAE,mBAAmB;IACpC,yBAAyB,EAAE,8BAA8B;CACjD,CAAC","sourcesContent":["/**\n * Trace names for UserStorage syncing operations\n */\nexport const TraceName = {\n  // Contact syncing traces\n  ContactSyncFull: 'Contact Sync Full',\n  ContactSyncSaveBatch: 'Contact Sync Save Batch',\n  ContactSyncUpdateRemote: 'Contact Sync Update Remote',\n  ContactSyncDeleteRemote: 'Contact Sync Delete Remote',\n\n  // Account syncing traces\n  AccountSyncFull: 'Account Sync Full',\n  AccountSyncSaveIndividual: 'Account Sync Save Individual',\n} as const;\n"]}