@metamask/profile-sync-controller 0.5.0 → 0.6.0

package/dist/controllers/user-storage/network-syncing/types.cjs

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toNetworkConfiguration = exports.toRemoteNetworkConfiguration = void 0;
+const toRemoteNetworkConfiguration = (network) => {
+    return {
+        ...network,
+        v: '1',
+    };
+};
+exports.toRemoteNetworkConfiguration = toRemoteNetworkConfiguration;
+const toNetworkConfiguration = (network) => {
+    const { v: _v, d: _d, ...originalNetwork } = network;
+    return originalNetwork;
+};
+exports.toNetworkConfiguration = toNetworkConfiguration;
+//# sourceMappingURL=types.cjs.map

package/dist/controllers/user-storage/network-syncing/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/network-syncing/types.ts"],"names":[],"mappings":";;;AAmBO,MAAM,4BAA4B,GAAG,CAC1C,OAA6B,EACD,EAAE;IAC9B,OAAO;QACL,GAAG,OAAO;QACV,CAAC,EAAE,GAAG;KACP,CAAC;AACJ,CAAC,CAAC;AAPW,QAAA,4BAA4B,gCAOvC;AAEK,MAAM,sBAAsB,GAAG,CACpC,OAAmC,EACb,EAAE;IACxB,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,eAAe,EAAE,GAAG,OAAO,CAAC;IACrD,OAAO,eAAe,CAAC;AACzB,CAAC,CAAC;AALW,QAAA,sBAAsB,0BAKjC","sourcesContent":["import type { NetworkConfiguration as _NetworkConfiguration } from '@metamask/network-controller';\n\n// TODO - replace shim once we update NetworkController type\nexport type NetworkConfiguration = _NetworkConfiguration & {\n  lastUpdatedAt?: number;\n};\n\nexport type RemoteNetworkConfiguration = NetworkConfiguration & {\n  /**\n   * `version` property. Enables future versioning of the `NetworkConfiguration` shape\n   */\n  v: '1';\n  /**\n   * isDeleted property, used for soft deletion & for correct syncing\n   * (delete vs upload network)\n   */\n  d?: boolean;\n};\n\nexport const toRemoteNetworkConfiguration = (\n  network: NetworkConfiguration,\n): RemoteNetworkConfiguration => {\n  return {\n    ...network,\n    v: '1',\n  };\n};\n\nexport const toNetworkConfiguration = (\n  network: RemoteNetworkConfiguration,\n): NetworkConfiguration => {\n  const { v: _v, d: _d, ...originalNetwork } = network;\n  return originalNetwork;\n};\n"]}

package/dist/controllers/user-storage/network-syncing/types.d.cts

@@ -0,0 +1,18 @@
+import type { NetworkConfiguration as _NetworkConfiguration } from "@metamask/network-controller";
+export type NetworkConfiguration = _NetworkConfiguration & {
+    lastUpdatedAt?: number;
+};
+export type RemoteNetworkConfiguration = NetworkConfiguration & {
+    /**
+     * `version` property. Enables future versioning of the `NetworkConfiguration` shape
+     */
+    v: '1';
+    /**
+     * isDeleted property, used for soft deletion & for correct syncing
+     * (delete vs upload network)
+     */
+    d?: boolean;
+};
+export declare const toRemoteNetworkConfiguration: (network: NetworkConfiguration) => RemoteNetworkConfiguration;
+export declare const toNetworkConfiguration: (network: RemoteNetworkConfiguration) => NetworkConfiguration;
+//# sourceMappingURL=types.d.cts.map

package/dist/controllers/user-storage/network-syncing/types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/network-syncing/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,IAAI,qBAAqB,EAAE,qCAAqC;AAGlG,MAAM,MAAM,oBAAoB,GAAG,qBAAqB,GAAG;IACzD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,oBAAoB,GAAG;IAC9D;;OAEG;IACH,CAAC,EAAE,GAAG,CAAC;IACP;;;OAGG;IACH,CAAC,CAAC,EAAE,OAAO,CAAC;CACb,CAAC;AAEF,eAAO,MAAM,4BAA4B,YAC9B,oBAAoB,KAC5B,0BAKF,CAAC;AAEF,eAAO,MAAM,sBAAsB,YACxB,0BAA0B,KAClC,oBAGF,CAAC"}

package/dist/controllers/user-storage/network-syncing/types.d.mts

@@ -0,0 +1,18 @@
+import type { NetworkConfiguration as _NetworkConfiguration } from "@metamask/network-controller";
+export type NetworkConfiguration = _NetworkConfiguration & {
+    lastUpdatedAt?: number;
+};
+export type RemoteNetworkConfiguration = NetworkConfiguration & {
+    /**
+     * `version` property. Enables future versioning of the `NetworkConfiguration` shape
+     */
+    v: '1';
+    /**
+     * isDeleted property, used for soft deletion & for correct syncing
+     * (delete vs upload network)
+     */
+    d?: boolean;
+};
+export declare const toRemoteNetworkConfiguration: (network: NetworkConfiguration) => RemoteNetworkConfiguration;
+export declare const toNetworkConfiguration: (network: RemoteNetworkConfiguration) => NetworkConfiguration;
+//# sourceMappingURL=types.d.mts.map

package/dist/controllers/user-storage/network-syncing/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/network-syncing/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,IAAI,qBAAqB,EAAE,qCAAqC;AAGlG,MAAM,MAAM,oBAAoB,GAAG,qBAAqB,GAAG;IACzD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,oBAAoB,GAAG;IAC9D;;OAEG;IACH,CAAC,EAAE,GAAG,CAAC;IACP;;;OAGG;IACH,CAAC,CAAC,EAAE,OAAO,CAAC;CACb,CAAC;AAEF,eAAO,MAAM,4BAA4B,YAC9B,oBAAoB,KAC5B,0BAKF,CAAC;AAEF,eAAO,MAAM,sBAAsB,YACxB,0BAA0B,KAClC,oBAGF,CAAC"}

package/dist/controllers/user-storage/network-syncing/types.mjs

@@ -0,0 +1,11 @@
+export const toRemoteNetworkConfiguration = (network) => {
+    return {
+        ...network,
+        v: '1',
+    };
+};
+export const toNetworkConfiguration = (network) => {
+    const { v: _v, d: _d, ...originalNetwork } = network;
+    return originalNetwork;
+};
+//# sourceMappingURL=types.mjs.map

package/dist/controllers/user-storage/network-syncing/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/network-syncing/types.ts"],"names":[],"mappings":"AAmBA,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,OAA6B,EACD,EAAE;IAC9B,OAAO;QACL,GAAG,OAAO;QACV,CAAC,EAAE,GAAG;KACP,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,OAAmC,EACb,EAAE;IACxB,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,eAAe,EAAE,GAAG,OAAO,CAAC;IACrD,OAAO,eAAe,CAAC;AACzB,CAAC,CAAC","sourcesContent":["import type { NetworkConfiguration as _NetworkConfiguration } from '@metamask/network-controller';\n\n// TODO - replace shim once we update NetworkController type\nexport type NetworkConfiguration = _NetworkConfiguration & {\n  lastUpdatedAt?: number;\n};\n\nexport type RemoteNetworkConfiguration = NetworkConfiguration & {\n  /**\n   * `version` property. Enables future versioning of the `NetworkConfiguration` shape\n   */\n  v: '1';\n  /**\n   * isDeleted property, used for soft deletion & for correct syncing\n   * (delete vs upload network)\n   */\n  d?: boolean;\n};\n\nexport const toRemoteNetworkConfiguration = (\n  network: NetworkConfiguration,\n): RemoteNetworkConfiguration => {\n  return {\n    ...network,\n    v: '1',\n  };\n};\n\nexport const toNetworkConfiguration = (\n  network: RemoteNetworkConfiguration,\n): NetworkConfiguration => {\n  const { v: _v, d: _d, ...originalNetwork } = network;\n  return originalNetwork;\n};\n"]}

package/dist/controllers/user-storage/schema.cjs

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createEntryPath = exports.isPathWithFeatureAndKey = exports.getFeatureAndKeyFromPath = exports.USER_STORAGE_SCHEMA = void 0;
+const encryption_1 = require("./encryption/index.cjs");
+/**
+ * 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).
+ */
+const ALLOW_ARBITRARY_KEYS = 'ALLOW_ARBITRARY_KEYS';
+exports.USER_STORAGE_SCHEMA = {
+    notifications: ['notificationSettings'],
+    accounts: [ALLOW_ARBITRARY_KEYS],
+    networks: [ALLOW_ARBITRARY_KEYS], // keyed by chains/networks
+};
+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 (!(feature in exports.USER_STORAGE_SCHEMA)) {
+        throw new Error(`user-storage - invalid feature provided: ${feature}`);
+    }
+    const validFeature = exports.USER_STORAGE_SCHEMA[feature];
+    if (!validFeature.includes(key) &&
+        !validFeature.includes(ALLOW_ARBITRARY_KEYS)) {
+        const validKeys = exports.USER_STORAGE_SCHEMA[feature].join(', ');
+        throw new Error(`user-storage - invalid key provided for this feature: ${key}. Valid keys: ${validKeys}`);
+    }
+    return { feature, key };
+};
+exports.getFeatureAndKeyFromPath = getFeatureAndKeyFromPath;
+const isPathWithFeatureAndKey = (path) => {
+    const pathRegex = /^\w+\.\w+$/u;
+    return pathRegex.test(path);
+};
+exports.isPathWithFeatureAndKey = isPathWithFeatureAndKey;
+/**
+ * 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).
+ * The users entry is a unique hash that cannot be reversed.
+ *
+ * @param path - string in the form of `${feature}.${key}` that matches schema
+ * @param storageKey - users storage key
+ * @returns path to store entry
+ */
+function createEntryPath(path, storageKey) {
+    const { feature, key } = (0, exports.getFeatureAndKeyFromPath)(path);
+    const hashedKey = (0, encryption_1.createSHA256Hash)(key + storageKey);
+    return `${feature}/${hashedKey}`;
+}
+exports.createEntryPath = createEntryPath;
+//# sourceMappingURL=schema.cjs.map

package/dist/controllers/user-storage/schema.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.cjs","sourceRoot":"","sources":["../../../src/controllers/user-storage/schema.ts"],"names":[],"mappings":";;;AAAA,uDAAgD;AAEhD;;;;;;GAMG;AACH,MAAM,oBAAoB,GAAG,sBAA+B,CAAC;AAEhD,QAAA,mBAAmB,GAAG;IACjC,aAAa,EAAE,CAAC,sBAAsB,CAAC;IACvC,QAAQ,EAAE,CAAC,oBAAoB,CAAC;IAChC,QAAQ,EAAE,CAAC,oBAAoB,CAAC,EAAE,2BAA2B;CACrD,CAAC;AAoBJ,MAAM,wBAAwB,GAAG,CACtC,IAAsC,EACZ,EAAE;IAC5B,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,CAGpC,CAAC;IAEF,IAAI,CAAC,CAAC,OAAO,IAAI,2BAAmB,CAAC,EAAE;QACrC,MAAM,IAAI,KAAK,CAAC,4CAA4C,OAAO,EAAE,CAAC,CAAC;KACxE;IAED,MAAM,YAAY,GAAG,2BAAmB,CAAC,OAAO,CAAsB,CAAC;IAEvE,IACE,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC;QAC3B,CAAC,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAC5C;QACA,MAAM,SAAS,GAAG,2BAAmB,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE1D,MAAM,IAAI,KAAK,CACb,yDAAyD,GAAG,iBAAiB,SAAS,EAAE,CACzF,CAAC;KACH;IAED,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;AAC1B,CAAC,CAAC;AAlCW,QAAA,wBAAwB,4BAkCnC;AAEK,MAAM,uBAAuB,GAAG,CACrC,IAAY,EAC8B,EAAE;IAC5C,MAAM,SAAS,GAAG,aAAa,CAAC;IAEhC,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC;AANW,QAAA,uBAAuB,2BAMlC;AAEF;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAC7B,IAAsC,EACtC,UAAkB;IAElB,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,IAAA,gCAAwB,EAAC,IAAI,CAAC,CAAC;IACxD,MAAM,SAAS,GAAG,IAAA,6BAAgB,EAAC,GAAG,GAAG,UAAU,CAAC,CAAC;IAErD,OAAO,GAAG,OAAO,IAAI,SAAS,EAAE,CAAC;AACnC,CAAC;AARD,0CAQC","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_SCHEMA = {\n  notifications: ['notificationSettings'],\n  accounts: [ALLOW_ARBITRARY_KEYS], // keyed by account addresses\n  networks: [ALLOW_ARBITRARY_KEYS], // keyed by chains/networks\n} as const;\n\ntype UserStorageSchema = typeof USER_STORAGE_SCHEMA;\n\ntype UserStorageFeatures = keyof UserStorageSchema;\ntype UserStorageFeatureKeys<Feature extends UserStorageFeatures> =\n  UserStorageSchema[Feature][0] extends typeof ALLOW_ARBITRARY_KEYS\n    ? string\n    : UserStorageSchema[Feature][number];\n\ntype UserStorageFeatureAndKey = {\n  feature: UserStorageFeatures;\n  key: UserStorageFeatureKeys<UserStorageFeatures>;\n};\n\nexport type UserStoragePathWithFeatureOnly = keyof UserStorageSchema;\nexport type UserStoragePathWithFeatureAndKey = {\n  [K in UserStorageFeatures]: `${K}.${UserStorageFeatureKeys<K>}`;\n}[UserStoragePathWithFeatureOnly];\n\nexport const getFeatureAndKeyFromPath = (\n  path: UserStoragePathWithFeatureAndKey,\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 (\n    !validFeature.includes(key) &&\n    !validFeature.includes(ALLOW_ARBITRARY_KEYS)\n  ) {\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\nexport const isPathWithFeatureAndKey = (\n  path: string,\n): path is UserStoragePathWithFeatureAndKey => {\n  const pathRegex = /^\\w+\\.\\w+$/u;\n\n  return pathRegex.test(path);\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: UserStoragePathWithFeatureAndKey,\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/dist/{types/controllers/user-storage/schema.d.ts → controllers/user-storage/schema.d.cts}

@@ -9,6 +9,7 @@ declare const ALLOW_ARBITRARY_KEYS: "ALLOW_ARBITRARY_KEYS";
 export declare const USER_STORAGE_SCHEMA: {
     readonly notifications: readonly ["notificationSettings"];
     readonly accounts: readonly ["ALLOW_ARBITRARY_KEYS"];
+    readonly networks: readonly ["ALLOW_ARBITRARY_KEYS"];
 };
 type UserStorageSchema = typeof USER_STORAGE_SCHEMA;
 type UserStorageFeatures = keyof UserStorageSchema;
@@ -34,4 +35,4 @@ export declare const isPathWithFeatureAndKey: (path: string) => path is UserStor
  */
 export declare function createEntryPath(path: UserStoragePathWithFeatureAndKey, storageKey: string): string;
 export {};
-//# sourceMappingURL=schema.d.ts.map
+//# sourceMappingURL=schema.d.cts.map

package/dist/controllers/user-storage/schema.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.cts","sourceRoot":"","sources":["../../../src/controllers/user-storage/schema.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,QAAA,MAAM,oBAAoB,wBAAkC,CAAC;AAE7D,eAAO,MAAM,mBAAmB;;;;CAItB,CAAC;AAEX,KAAK,iBAAiB,GAAG,OAAO,mBAAmB,CAAC;AAEpD,KAAK,mBAAmB,GAAG,MAAM,iBAAiB,CAAC;AACnD,KAAK,sBAAsB,CAAC,OAAO,SAAS,mBAAmB,IAC7D,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,mBAAmB,CAAC;IAC7B,GAAG,EAAE,sBAAsB,CAAC,mBAAmB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG,MAAM,iBAAiB,CAAC;AACrE,MAAM,MAAM,gCAAgC,GAAG;KAC5C,CAAC,IAAI,mBAAmB,GAAG,GAAG,CAAC,IAAI,sBAAsB,CAAC,CAAC,CAAC,EAAE;CAChE,CAAC,8BAA8B,CAAC,CAAC;AAElC,eAAO,MAAM,wBAAwB,SAC7B,gCAAgC,KACrC,wBAgCF,CAAC;AAEF,eAAO,MAAM,uBAAuB,SAC5B,MAAM,6CAKb,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,gCAAgC,EACtC,UAAU,EAAE,MAAM,GACjB,MAAM,CAKR"}

package/dist/controllers/user-storage/schema.d.mts

@@ -0,0 +1,38 @@
+/**
+ * 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).
+ */
+declare const ALLOW_ARBITRARY_KEYS: "ALLOW_ARBITRARY_KEYS";
+export declare const USER_STORAGE_SCHEMA: {
+    readonly notifications: readonly ["notificationSettings"];
+    readonly accounts: readonly ["ALLOW_ARBITRARY_KEYS"];
+    readonly networks: readonly ["ALLOW_ARBITRARY_KEYS"];
+};
+type UserStorageSchema = typeof USER_STORAGE_SCHEMA;
+type UserStorageFeatures = keyof UserStorageSchema;
+type UserStorageFeatureKeys<Feature extends UserStorageFeatures> = UserStorageSchema[Feature][0] extends typeof ALLOW_ARBITRARY_KEYS ? string : UserStorageSchema[Feature][number];
+type UserStorageFeatureAndKey = {
+    feature: UserStorageFeatures;
+    key: UserStorageFeatureKeys<UserStorageFeatures>;
+};
+export type UserStoragePathWithFeatureOnly = keyof UserStorageSchema;
+export type UserStoragePathWithFeatureAndKey = {
+    [K in UserStorageFeatures]: `${K}.${UserStorageFeatureKeys<K>}`;
+}[UserStoragePathWithFeatureOnly];
+export declare const getFeatureAndKeyFromPath: (path: UserStoragePathWithFeatureAndKey) => UserStorageFeatureAndKey;
+export declare const isPathWithFeatureAndKey: (path: string) => path is UserStoragePathWithFeatureAndKey;
+/**
+ * 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).
+ * The users entry is a unique hash that cannot be reversed.
+ *
+ * @param path - string in the form of `${feature}.${key}` that matches schema
+ * @param storageKey - users storage key
+ * @returns path to store entry
+ */
+export declare function createEntryPath(path: UserStoragePathWithFeatureAndKey, storageKey: string): string;
+export {};
+//# sourceMappingURL=schema.d.mts.map

package/dist/controllers/user-storage/schema.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.mts","sourceRoot":"","sources":["../../../src/controllers/user-storage/schema.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,QAAA,MAAM,oBAAoB,wBAAkC,CAAC;AAE7D,eAAO,MAAM,mBAAmB;;;;CAItB,CAAC;AAEX,KAAK,iBAAiB,GAAG,OAAO,mBAAmB,CAAC;AAEpD,KAAK,mBAAmB,GAAG,MAAM,iBAAiB,CAAC;AACnD,KAAK,sBAAsB,CAAC,OAAO,SAAS,mBAAmB,IAC7D,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,mBAAmB,CAAC;IAC7B,GAAG,EAAE,sBAAsB,CAAC,mBAAmB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG,MAAM,iBAAiB,CAAC;AACrE,MAAM,MAAM,gCAAgC,GAAG;KAC5C,CAAC,IAAI,mBAAmB,GAAG,GAAG,CAAC,IAAI,sBAAsB,CAAC,CAAC,CAAC,EAAE;CAChE,CAAC,8BAA8B,CAAC,CAAC;AAElC,eAAO,MAAM,wBAAwB,SAC7B,gCAAgC,KACrC,wBAgCF,CAAC;AAEF,eAAO,MAAM,uBAAuB,SAC5B,MAAM,6CAKb,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,gCAAgC,EACtC,UAAU,EAAE,MAAM,GACjB,MAAM,CAKR"}

package/dist/controllers/user-storage/schema.mjs

@@ -1,18 +1,50 @@
-import {
-  USER_STORAGE_SCHEMA,
-  createEntryPath,
-  getFeatureAndKeyFromPath,
-  isPathWithFeatureAndKey
-} from "../../chunk-2VEMA6OE.mjs";
-import "../../chunk-KHASG4H3.mjs";
-import "../../chunk-COBJUBZE.mjs";
-import "../../chunk-H25EBXG5.mjs";
-import "../../chunk-76VRE4BI.mjs";
-import "../../chunk-U5UIDVOO.mjs";
-export {
-  USER_STORAGE_SCHEMA,
-  createEntryPath,
-  getFeatureAndKeyFromPath,
-  isPathWithFeatureAndKey
+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).
+ */
+const ALLOW_ARBITRARY_KEYS = 'ALLOW_ARBITRARY_KEYS';
+export const USER_STORAGE_SCHEMA = {
+    notifications: ['notificationSettings'],
+    accounts: [ALLOW_ARBITRARY_KEYS],
+    networks: [ALLOW_ARBITRARY_KEYS], // keyed by chains/networks
 };
+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 (!(feature in USER_STORAGE_SCHEMA)) {
+        throw new Error(`user-storage - invalid feature provided: ${feature}`);
+    }
+    const validFeature = USER_STORAGE_SCHEMA[feature];
+    if (!validFeature.includes(key) &&
+        !validFeature.includes(ALLOW_ARBITRARY_KEYS)) {
+        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 };
+};
+export const isPathWithFeatureAndKey = (path) => {
+    const pathRegex = /^\w+\.\w+$/u;
+    return pathRegex.test(path);
+};
+/**
+ * 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).
+ * The users entry is a unique hash that cannot be reversed.
+ *
+ * @param path - string in the form of `${feature}.${key}` that matches schema
+ * @param storageKey - users storage key
+ * @returns path to store entry
+ */
+export function createEntryPath(path, storageKey) {
+    const { feature, key } = getFeatureAndKeyFromPath(path);
+    const hashedKey = createSHA256Hash(key + storageKey);
+    return `${feature}/${hashedKey}`;
+}
 //# sourceMappingURL=schema.mjs.map

package/dist/controllers/user-storage/schema.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"schema.mjs","sourceRoot":"","sources":["../../../src/controllers/user-storage/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,+BAAqB;AAEhD;;;;;;GAMG;AACH,MAAM,oBAAoB,GAAG,sBAA+B,CAAC;AAE7D,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,aAAa,EAAE,CAAC,sBAAsB,CAAC;IACvC,QAAQ,EAAE,CAAC,oBAAoB,CAAC;IAChC,QAAQ,EAAE,CAAC,oBAAoB,CAAC,EAAE,2BAA2B;CACrD,CAAC;AAoBX,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,IAAsC,EACZ,EAAE;IAC5B,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,CAGpC,CAAC;IAEF,IAAI,CAAC,CAAC,OAAO,IAAI,mBAAmB,CAAC,EAAE;QACrC,MAAM,IAAI,KAAK,CAAC,4CAA4C,OAAO,EAAE,CAAC,CAAC;KACxE;IAED,MAAM,YAAY,GAAG,mBAAmB,CAAC,OAAO,CAAsB,CAAC;IAEvE,IACE,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC;QAC3B,CAAC,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAC5C;QACA,MAAM,SAAS,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE1D,MAAM,IAAI,KAAK,CACb,yDAAyD,GAAG,iBAAiB,SAAS,EAAE,CACzF,CAAC;KACH;IAED,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;AAC1B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,IAAY,EAC8B,EAAE;IAC5C,MAAM,SAAS,GAAG,aAAa,CAAC;IAEhC,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAC7B,IAAsC,EACtC,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 * 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_SCHEMA = {\n  notifications: ['notificationSettings'],\n  accounts: [ALLOW_ARBITRARY_KEYS], // keyed by account addresses\n  networks: [ALLOW_ARBITRARY_KEYS], // keyed by chains/networks\n} as const;\n\ntype UserStorageSchema = typeof USER_STORAGE_SCHEMA;\n\ntype UserStorageFeatures = keyof UserStorageSchema;\ntype UserStorageFeatureKeys<Feature extends UserStorageFeatures> =\n  UserStorageSchema[Feature][0] extends typeof ALLOW_ARBITRARY_KEYS\n    ? string\n    : UserStorageSchema[Feature][number];\n\ntype UserStorageFeatureAndKey = {\n  feature: UserStorageFeatures;\n  key: UserStorageFeatureKeys<UserStorageFeatures>;\n};\n\nexport type UserStoragePathWithFeatureOnly = keyof UserStorageSchema;\nexport type UserStoragePathWithFeatureAndKey = {\n  [K in UserStorageFeatures]: `${K}.${UserStorageFeatureKeys<K>}`;\n}[UserStoragePathWithFeatureOnly];\n\nexport const getFeatureAndKeyFromPath = (\n  path: UserStoragePathWithFeatureAndKey,\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 (\n    !validFeature.includes(key) &&\n    !validFeature.includes(ALLOW_ARBITRARY_KEYS)\n  ) {\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\nexport const isPathWithFeatureAndKey = (\n  path: string,\n): path is UserStoragePathWithFeatureAndKey => {\n  const pathRegex = /^\\w+\\.\\w+$/u;\n\n  return pathRegex.test(path);\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: UserStoragePathWithFeatureAndKey,\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/dist/controllers/user-storage/services.cjs

@@ -0,0 +1,119 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.upsertUserStorage = exports.getUserStorageAllFeatureEntries = exports.getUserStorage = exports.USER_STORAGE_ENDPOINT = exports.USER_STORAGE_API = void 0;
+const loglevel_1 = __importDefault(require("loglevel"));
+const env_1 = require("../../sdk/env.cjs");
+const encryption_1 = __importDefault(require("./encryption/index.cjs"));
+const schema_1 = require("./schema.cjs");
+const ENV_URLS = (0, env_1.getEnvUrls)(env_1.Env.PRD);
+exports.USER_STORAGE_API = ENV_URLS.userStorageApiUrl;
+exports.USER_STORAGE_ENDPOINT = `${exports.USER_STORAGE_API}/api/v1/userstorage`;
+/**
+ * User Storage Service - Get Storage Entry.
+ *
+ * @param opts - User Storage Options
+ * @returns The storage entry, or null if fails to find entry
+ */
+async function getUserStorage(opts) {
+    try {
+        const { bearerToken, path, storageKey, nativeScryptCrypto } = opts;
+        const encryptedPath = (0, schema_1.createEntryPath)(path, storageKey);
+        const url = new URL(`${exports.USER_STORAGE_ENDPOINT}/${encryptedPath}`);
+        const userStorageResponse = await fetch(url.toString(), {
+            headers: {
+                'Content-Type': 'application/json',
+                Authorization: `Bearer ${bearerToken}`,
+            },
+        });
+        // Acceptable error - since indicates entry does not exist.
+        if (userStorageResponse.status === 404) {
+            return null;
+        }
+        if (userStorageResponse.status !== 200) {
+            throw new Error('Unable to get User Storage');
+        }
+        const userStorage = await userStorageResponse.json();
+        const encryptedData = userStorage?.Data ?? null;
+        if (!encryptedData) {
+            return null;
+        }
+        const decryptedData = await encryption_1.default.decryptString(encryptedData, opts.storageKey, nativeScryptCrypto);
+        return decryptedData;
+    }
+    catch (e) {
+        loglevel_1.default.error('Failed to get user storage', e);
+        return null;
+    }
+}
+exports.getUserStorage = getUserStorage;
+/**
+ * User Storage Service - Get all storage entries for a specific feature.
+ *
+ * @param opts - User Storage Options
+ * @returns The storage entry, or null if fails to find entry
+ */
+async function getUserStorageAllFeatureEntries(opts) {
+    try {
+        const { bearerToken, path, nativeScryptCrypto } = opts;
+        const url = new URL(`${exports.USER_STORAGE_ENDPOINT}/${path}`);
+        const userStorageResponse = await fetch(url.toString(), {
+            headers: {
+                'Content-Type': 'application/json',
+                Authorization: `Bearer ${bearerToken}`,
+            },
+        });
+        // Acceptable error - since indicates feature does not exist.
+        if (userStorageResponse.status === 404) {
+            return null;
+        }
+        if (userStorageResponse.status !== 200) {
+            throw new Error('Unable to get User Storage');
+        }
+        const userStorage = await userStorageResponse.json();
+        if (!Array.isArray(userStorage)) {
+            return null;
+        }
+        const decryptedData = userStorage?.flatMap((entry) => {
+            if (!entry.Data) {
+                return [];
+            }
+            return encryption_1.default.decryptString(entry.Data, opts.storageKey, nativeScryptCrypto);
+        });
+        return (await Promise.allSettled(decryptedData))
+            .map((d) => (d.status === 'fulfilled' ? d.value : undefined))
+            .filter((d) => d !== undefined);
+    }
+    catch (e) {
+        loglevel_1.default.error('Failed to get user storage', e);
+        return null;
+    }
+}
+exports.getUserStorageAllFeatureEntries = getUserStorageAllFeatureEntries;
+/**
+ * User Storage Service - Set Storage Entry.
+ *
+ * @param data - data to store
+ * @param opts - storage options
+ */
+async function upsertUserStorage(data, opts) {
+    const { bearerToken, path, storageKey, nativeScryptCrypto } = opts;
+    const encryptedData = await encryption_1.default.encryptString(data, opts.storageKey, nativeScryptCrypto);
+    const encryptedPath = (0, schema_1.createEntryPath)(path, storageKey);
+    const url = new URL(`${exports.USER_STORAGE_ENDPOINT}/${encryptedPath}`);
+    const res = await fetch(url.toString(), {
+        method: 'PUT',
+        headers: {
+            'Content-Type': 'application/json',
+            Authorization: `Bearer ${bearerToken}`,
+        },
+        body: JSON.stringify({ data: encryptedData }),
+    });
+    if (!res.ok) {
+        throw new Error('user-storage - unable to upsert data');
+    }
+}
+exports.upsertUserStorage = upsertUserStorage;
+//# sourceMappingURL=services.cjs.map

package/dist/controllers/user-storage/services.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"services.cjs","sourceRoot":"","sources":["../../../src/controllers/user-storage/services.ts"],"names":[],"mappings":";;;;;;AAAA,wDAA2B;AAE3B,2CAAgD;AAChD,wEAAsC;AAKtC,yCAA2C;AAG3C,MAAM,QAAQ,GAAG,IAAA,gBAAU,EAAC,SAAG,CAAC,GAAG,CAAC,CAAC;AAExB,QAAA,gBAAgB,GAAW,QAAQ,CAAC,iBAAiB,CAAC;AACtD,QAAA,qBAAqB,GAAG,GAAG,wBAAgB,qBAAqB,CAAC;AAiC9E;;;;;GAKG;AACI,KAAK,UAAU,cAAc,CAClC,IAAwB;IAExB,IAAI;QACF,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC;QAEnE,MAAM,aAAa,GAAG,IAAA,wBAAe,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QACxD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,6BAAqB,IAAI,aAAa,EAAE,CAAC,CAAC;QAEjE,MAAM,mBAAmB,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE;YACtD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,aAAa,EAAE,UAAU,WAAW,EAAE;aACvC;SACF,CAAC,CAAC;QAEH,2DAA2D;QAC3D,IAAI,mBAAmB,CAAC,MAAM,KAAK,GAAG,EAAE;YACtC,OAAO,IAAI,CAAC;SACb;QAED,IAAI,mBAAmB,CAAC,MAAM,KAAK,GAAG,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;SAC/C;QAED,MAAM,WAAW,GACf,MAAM,mBAAmB,CAAC,IAAI,EAAE,CAAC;QACnC,MAAM,aAAa,GAAG,WAAW,EAAE,IAAI,IAAI,IAAI,CAAC;QAEhD,IAAI,CAAC,aAAa,EAAE;YAClB,OAAO,IAAI,CAAC;SACb;QAED,MAAM,aAAa,GAAG,MAAM,oBAAU,CAAC,aAAa,CAClD,aAAa,EACb,IAAI,CAAC,UAAU,EACf,kBAAkB,CACnB,CAAC;QAEF,OAAO,aAAa,CAAC;KACtB;IAAC,OAAO,CAAC,EAAE;QACV,kBAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,CAAC,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;KACb;AACH,CAAC;AA5CD,wCA4CC;AAED;;;;;GAKG;AACI,KAAK,UAAU,+BAA+B,CACnD,IAAyC;IAEzC,IAAI;QACF,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC;QACvD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,6BAAqB,IAAI,IAAI,EAAE,CAAC,CAAC;QAExD,MAAM,mBAAmB,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE;YACtD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,aAAa,EAAE,UAAU,WAAW,EAAE;aACvC;SACF,CAAC,CAAC;QAEH,6DAA6D;QAC7D,IAAI,mBAAmB,CAAC,MAAM,KAAK,GAAG,EAAE;YACtC,OAAO,IAAI,CAAC;SACb;QAED,IAAI,mBAAmB,CAAC,MAAM,KAAK,GAAG,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;SAC/C;QAED,MAAM,WAAW,GACf,MAAM,mBAAmB,CAAC,IAAI,EAAE,CAAC;QAEnC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;YAC/B,OAAO,IAAI,CAAC;SACb;QAED,MAAM,aAAa,GAAG,WAAW,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACnD,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;gBACf,OAAO,EAAE,CAAC;aACX;YAED,OAAO,oBAAU,CAAC,aAAa,CAC7B,KAAK,CAAC,IAAI,EACV,IAAI,CAAC,UAAU,EACf,kBAAkB,CACnB,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;aAC7C,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;aAC5D,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;KAChD;IAAC,OAAO,CAAC,EAAE;QACV,kBAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,CAAC,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;KACb;AACH,CAAC;AAjDD,0EAiDC;AAED;;;;;GAKG;AACI,KAAK,UAAU,iBAAiB,CACrC,IAAY,EACZ,IAAwB;IAExB,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC;IAEnE,MAAM,aAAa,GAAG,MAAM,oBAAU,CAAC,aAAa,CAClD,IAAI,EACJ,IAAI,CAAC,UAAU,EACf,kBAAkB,CACnB,CAAC;IACF,MAAM,aAAa,GAAG,IAAA,wBAAe,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IACxD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,6BAAqB,IAAI,aAAa,EAAE,CAAC,CAAC;IAEjE,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE;QACtC,MAAM,EAAE,KAAK;QACb,OAAO,EAAE;YACP,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,UAAU,WAAW,EAAE;SACvC;QACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;KAC9C,CAAC,CAAC;IAEH,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE;QACX,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;KACzD;AACH,CAAC;AA1BD,8CA0BC","sourcesContent":["import log from 'loglevel';\n\nimport { Env, getEnvUrls } from '../../sdk/env';\nimport encryption from './encryption';\nimport type {\n  UserStoragePathWithFeatureAndKey,\n  UserStoragePathWithFeatureOnly,\n} from './schema';\nimport { createEntryPath } from './schema';\nimport type { NativeScrypt } from './UserStorageController';\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 for a feature entry.\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 GetUserStorageAllFeatureEntriesResponse = {\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 UserStorageBaseOptions = {\n  bearerToken: string;\n  storageKey: string;\n  nativeScryptCrypto?: NativeScrypt;\n};\n\nexport type UserStorageOptions = UserStorageBaseOptions & {\n  path: UserStoragePathWithFeatureAndKey;\n};\n\nexport type UserStorageAllFeatureEntriesOptions = UserStorageBaseOptions & {\n  path: UserStoragePathWithFeatureOnly;\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, nativeScryptCrypto } = 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 = await encryption.decryptString(\n      encryptedData,\n      opts.storageKey,\n      nativeScryptCrypto,\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 - Get all storage entries for a specific feature.\n *\n * @param opts - User Storage Options\n * @returns The storage entry, or null if fails to find entry\n */\nexport async function getUserStorageAllFeatureEntries(\n  opts: UserStorageAllFeatureEntriesOptions,\n): Promise<string[] | null> {\n  try {\n    const { bearerToken, path, nativeScryptCrypto } = opts;\n    const url = new URL(`${USER_STORAGE_ENDPOINT}/${path}`);\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 feature 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: GetUserStorageAllFeatureEntriesResponse | null =\n      await userStorageResponse.json();\n\n    if (!Array.isArray(userStorage)) {\n      return null;\n    }\n\n    const decryptedData = userStorage?.flatMap((entry) => {\n      if (!entry.Data) {\n        return [];\n      }\n\n      return encryption.decryptString(\n        entry.Data,\n        opts.storageKey,\n        nativeScryptCrypto,\n      );\n    });\n\n    return (await Promise.allSettled(decryptedData))\n      .map((d) => (d.status === 'fulfilled' ? d.value : undefined))\n      .filter((d): d is string => d !== undefined);\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, nativeScryptCrypto } = opts;\n\n  const encryptedData = await encryption.encryptString(\n    data,\n    opts.storageKey,\n    nativeScryptCrypto,\n  );\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/{types/controllers/user-storage/services.d.ts → controllers/user-storage/services.d.cts}

@@ -1,5 +1,5 @@
-import type { UserStoragePathWithFeatureAndKey, UserStoragePathWithFeatureOnly } from './schema';
-import type { NativeScrypt } from './UserStorageController';
+import type { UserStoragePathWithFeatureAndKey, UserStoragePathWithFeatureOnly } from "./schema.cjs";
+import type { NativeScrypt } from "./UserStorageController.cjs";
 export declare const USER_STORAGE_API: string;
 export declare const USER_STORAGE_ENDPOINT: string;
 /**
@@ -16,14 +16,13 @@ export type GetUserStorageAllFeatureEntriesResponse = {
 export type UserStorageBaseOptions = {
     bearerToken: string;
     storageKey: string;
+    nativeScryptCrypto?: NativeScrypt;
 };
 export type UserStorageOptions = UserStorageBaseOptions & {
     path: UserStoragePathWithFeatureAndKey;
-    nativeScryptCrypto?: NativeScrypt;
 };
 export type UserStorageAllFeatureEntriesOptions = UserStorageBaseOptions & {
     path: UserStoragePathWithFeatureOnly;
-    nativeScryptCrypto?: NativeScrypt;
 };
 /**
  * User Storage Service - Get Storage Entry.
@@ -46,4 +45,4 @@ export declare function getUserStorageAllFeatureEntries(opts: UserStorageAllFeat
  * @param opts - storage options
  */
 export declare function upsertUserStorage(data: string, opts: UserStorageOptions): Promise<void>;
-//# sourceMappingURL=services.d.ts.map
+//# sourceMappingURL=services.d.cts.map

package/dist/controllers/user-storage/services.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"services.d.cts","sourceRoot":"","sources":["../../../src/controllers/user-storage/services.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,gCAAgC,EAChC,8BAA8B,EAC/B,qBAAiB;AAElB,OAAO,KAAK,EAAE,YAAY,EAAE,oCAAgC;AAI5D,eAAO,MAAM,gBAAgB,EAAE,MAAmC,CAAC;AACnE,eAAO,MAAM,qBAAqB,QAA2C,CAAC;AAE9E;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IAEnC,SAAS,EAAE,MAAM,CAAC;IAElB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,uCAAuC,GAAG;IAEpD,SAAS,EAAE,MAAM,CAAC;IAElB,IAAI,EAAE,MAAM,CAAC;CACd,EAAE,CAAC;AAEJ,MAAM,MAAM,sBAAsB,GAAG;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,CAAC,EAAE,YAAY,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,sBAAsB,GAAG;IACxD,IAAI,EAAE,gCAAgC,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG,sBAAsB,GAAG;IACzE,IAAI,EAAE,8BAA8B,CAAC;CACtC,CAAC;AAEF;;;;;GAKG;AACH,wBAAsB,cAAc,CAClC,IAAI,EAAE,kBAAkB,GACvB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CA0CxB;AAED;;;;;GAKG;AACH,wBAAsB,+BAA+B,CACnD,IAAI,EAAE,mCAAmC,GACxC,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CA+C1B;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,kBAAkB,GACvB,OAAO,CAAC,IAAI,CAAC,CAuBf"}

package/dist/controllers/user-storage/services.d.mts

@@ -0,0 +1,48 @@
+import type { UserStoragePathWithFeatureAndKey, UserStoragePathWithFeatureOnly } from "./schema.mjs";
+import type { NativeScrypt } from "./UserStorageController.mjs";
+export declare const USER_STORAGE_API: string;
+export declare const USER_STORAGE_ENDPOINT: string;
+/**
+ * This is the Server Response shape for a feature entry.
+ */
+export type GetUserStorageResponse = {
+    HashedKey: string;
+    Data: string;
+};
+export type GetUserStorageAllFeatureEntriesResponse = {
+    HashedKey: string;
+    Data: string;
+}[];
+export type UserStorageBaseOptions = {
+    bearerToken: string;
+    storageKey: string;
+    nativeScryptCrypto?: NativeScrypt;
+};
+export type UserStorageOptions = UserStorageBaseOptions & {
+    path: UserStoragePathWithFeatureAndKey;
+};
+export type UserStorageAllFeatureEntriesOptions = UserStorageBaseOptions & {
+    path: UserStoragePathWithFeatureOnly;
+};
+/**
+ * User Storage Service - Get Storage Entry.
+ *
+ * @param opts - User Storage Options
+ * @returns The storage entry, or null if fails to find entry
+ */
+export declare function getUserStorage(opts: UserStorageOptions): Promise<string | null>;
+/**
+ * User Storage Service - Get all storage entries for a specific feature.
+ *
+ * @param opts - User Storage Options
+ * @returns The storage entry, or null if fails to find entry
+ */
+export declare function getUserStorageAllFeatureEntries(opts: UserStorageAllFeatureEntriesOptions): Promise<string[] | null>;
+/**
+ * User Storage Service - Set Storage Entry.
+ *
+ * @param data - data to store
+ * @param opts - storage options
+ */
+export declare function upsertUserStorage(data: string, opts: UserStorageOptions): Promise<void>;
+//# sourceMappingURL=services.d.mts.map

package/dist/controllers/user-storage/services.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"services.d.mts","sourceRoot":"","sources":["../../../src/controllers/user-storage/services.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,gCAAgC,EAChC,8BAA8B,EAC/B,qBAAiB;AAElB,OAAO,KAAK,EAAE,YAAY,EAAE,oCAAgC;AAI5D,eAAO,MAAM,gBAAgB,EAAE,MAAmC,CAAC;AACnE,eAAO,MAAM,qBAAqB,QAA2C,CAAC;AAE9E;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IAEnC,SAAS,EAAE,MAAM,CAAC;IAElB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,uCAAuC,GAAG;IAEpD,SAAS,EAAE,MAAM,CAAC;IAElB,IAAI,EAAE,MAAM,CAAC;CACd,EAAE,CAAC;AAEJ,MAAM,MAAM,sBAAsB,GAAG;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,CAAC,EAAE,YAAY,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,sBAAsB,GAAG;IACxD,IAAI,EAAE,gCAAgC,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG,sBAAsB,GAAG;IACzE,IAAI,EAAE,8BAA8B,CAAC;CACtC,CAAC;AAEF;;;;;GAKG;AACH,wBAAsB,cAAc,CAClC,IAAI,EAAE,kBAAkB,GACvB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CA0CxB;AAED;;;;;GAKG;AACH,wBAAsB,+BAA+B,CACnD,IAAI,EAAE,mCAAmC,GACxC,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CA+C1B;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,kBAAkB,GACvB,OAAO,CAAC,IAAI,CAAC,CAuBf"}