@metamask/snaps-simulation 1.5.0 → 2.0.0

package/dist/methods/hooks/index.d.cts

@@ -1,6 +1,7 @@
 export * from "./get-preferences.cjs";
+export * from "./interface.cjs";
 export * from "./notifications.cjs";
+export * from "./permitted/index.cjs";
 export * from "./request-user-approval.cjs";
 export * from "./state.cjs";
-export * from "./interface.cjs";
 //# sourceMappingURL=index.d.cts.map

package/dist/methods/hooks/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../../src/methods/hooks/index.ts"],"names":[],"mappings":"AAAA,sCAAkC;AAClC,oCAAgC;AAChC,4CAAwC;AACxC,4BAAwB;AACxB,gCAA4B"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../../src/methods/hooks/index.ts"],"names":[],"mappings":"AAAA,sCAAkC;AAClC,gCAA4B;AAC5B,oCAAgC;AAChC,sCAA4B;AAC5B,4CAAwC;AACxC,4BAAwB"}

package/dist/methods/hooks/index.d.mts

@@ -1,6 +1,7 @@
 export * from "./get-preferences.mjs";
+export * from "./interface.mjs";
 export * from "./notifications.mjs";
+export * from "./permitted/index.mjs";
 export * from "./request-user-approval.mjs";
 export * from "./state.mjs";
-export * from "./interface.mjs";
 //# sourceMappingURL=index.d.mts.map

package/dist/methods/hooks/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/methods/hooks/index.ts"],"names":[],"mappings":"AAAA,sCAAkC;AAClC,oCAAgC;AAChC,4CAAwC;AACxC,4BAAwB;AACxB,gCAA4B"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/methods/hooks/index.ts"],"names":[],"mappings":"AAAA,sCAAkC;AAClC,gCAA4B;AAC5B,oCAAgC;AAChC,sCAA4B;AAC5B,4CAAwC;AACxC,4BAAwB"}

package/dist/methods/hooks/index.mjs

@@ -1,6 +1,7 @@
 export * from "./get-preferences.mjs";
+export * from "./interface.mjs";
 export * from "./notifications.mjs";
+export * from "./permitted/index.mjs";
 export * from "./request-user-approval.mjs";
 export * from "./state.mjs";
-export * from "./interface.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/methods/hooks/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/methods/hooks/index.ts"],"names":[],"mappings":"AAAA,sCAAkC;AAClC,oCAAgC;AAChC,4CAAwC;AACxC,4BAAwB;AACxB,gCAA4B","sourcesContent":["export * from './get-preferences';\nexport * from './notifications';\nexport * from './request-user-approval';\nexport * from './state';\nexport * from './interface';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/methods/hooks/index.ts"],"names":[],"mappings":"AAAA,sCAAkC;AAClC,gCAA4B;AAC5B,oCAAgC;AAChC,sCAA4B;AAC5B,4CAAwC;AACxC,4BAAwB","sourcesContent":["export * from './get-preferences';\nexport * from './interface';\nexport * from './notifications';\nexport * from './permitted';\nexport * from './request-user-approval';\nexport * from './state';\n"]}

package/dist/methods/hooks/notifications.cjs

@@ -36,11 +36,24 @@ exports.getShowNativeNotificationImplementation = getShowNativeNotificationImple
  * @param _snapId - The ID of the Snap that created the notification.
  * @param options - The notification options.
  * @param options.message - The message to show in the notification.
+ * @param options.title - The title to show in the notification.
+ * @param options.content - The JSX content to show in the notification.
+ * @param options.footerLink - The footer to show in the notification.
  * @yields Adds the notification to the store.
  * @returns `null`.
  */
-function* showInAppNotificationImplementation(_snapId, { message }) {
-    yield (0, effects_1.put)((0, store_1.addNotification)({ id: (0, toolkit_1.nanoid)(), type: snaps_sdk_1.NotificationType.InApp, message }));
+function* showInAppNotificationImplementation(_snapId, { message, title, content, footerLink }) {
+    if (content) {
+        yield (0, effects_1.put)((0, store_1.setInterface)({ type: 'Notification', id: content }));
+    }
+    yield (0, effects_1.put)((0, store_1.addNotification)({
+        id: (0, toolkit_1.nanoid)(),
+        type: snaps_sdk_1.NotificationType.InApp,
+        message,
+        title,
+        content,
+        footerLink,
+    }));
     return null;
 }
 /**

package/dist/methods/hooks/notifications.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"notifications.cjs","sourceRoot":"","sources":["../../../src/methods/hooks/notifications.ts"],"names":[],"mappings":";;;AACA,mDAAuD;AACvD,8CAA0C;AAE1C,gDAAyC;AAGzC,iDAA8C;AAE9C;;;;;;;;GAQG;AACH,QAAQ,CAAC,CAAC,oCAAoC,CAC5C,OAAe,EACf,EAAE,OAAO,EAAgB;IAEzB,MAAM,IAAA,aAAG,EACP,IAAA,uBAAe,EAAC,EAAE,EAAE,EAAE,IAAA,gBAAM,GAAE,EAAE,IAAI,EAAE,4BAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAC1E,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,SAAgB,uCAAuC,CACrD,OAAwB;IAExB,OAAO,KAAK,EACV,GAAG,IAA6D,EAChE,EAAE;QACF,OAAO,MAAM,OAAO,CAClB,oCAAoC,EACpC,GAAG,IAAI,CACR,CAAC,SAAS,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAXD,0FAWC;AAED;;;;;;;;GAQG;AACH,QAAQ,CAAC,CAAC,mCAAmC,CAC3C,OAAe,EACf,EAAE,OAAO,EAAgB;IAEzB,MAAM,IAAA,aAAG,EACP,IAAA,uBAAe,EAAC,EAAE,EAAE,EAAE,IAAA,gBAAM,GAAE,EAAE,IAAI,EAAE,4BAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,CACzE,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,SAAgB,sCAAsC,CACpD,OAAwB;IAExB,OAAO,KAAK,EACV,GAAG,IAA4D,EAC/D,EAAE;QACF,OAAO,MAAM,OAAO,CAClB,mCAAmC,EACnC,GAAG,IAAI,CACR,CAAC,SAAS,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAXD,wFAWC","sourcesContent":["import type { NotifyParams } from '@metamask/snaps-sdk';\nimport { NotificationType } from '@metamask/snaps-sdk';\nimport { nanoid } from '@reduxjs/toolkit';\nimport type { SagaIterator } from 'redux-saga';\nimport { put } from 'redux-saga/effects';\n\nimport type { RunSagaFunction } from '../../store';\nimport { addNotification } from '../../store';\n\n/**\n * Show a native notification to the user.\n *\n * @param _snapId - The ID of the Snap that created the notification.\n * @param options - The notification options.\n * @param options.message - The message to show in the notification.\n * @yields Adds the notification to the store.\n * @returns `null`.\n */\nfunction* showNativeNotificationImplementation(\n  _snapId: string,\n  { message }: NotifyParams,\n): SagaIterator {\n  yield put(\n    addNotification({ id: nanoid(), type: NotificationType.Native, message }),\n  );\n\n  return null;\n}\n\n/**\n * Get a method that can be used to show a native notification.\n *\n * @param runSaga - A function to run a saga outside the usual Redux flow.\n * @returns A method that can be used to show a native notification.\n */\nexport function getShowNativeNotificationImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return async (\n    ...args: Parameters<typeof showNativeNotificationImplementation>\n  ) => {\n    return await runSaga(\n      showNativeNotificationImplementation,\n      ...args,\n    ).toPromise();\n  };\n}\n\n/**\n * Show an in-app notification to the user.\n *\n * @param _snapId - The ID of the Snap that created the notification.\n * @param options - The notification options.\n * @param options.message - The message to show in the notification.\n * @yields Adds the notification to the store.\n * @returns `null`.\n */\nfunction* showInAppNotificationImplementation(\n  _snapId: string,\n  { message }: NotifyParams,\n): SagaIterator<null> {\n  yield put(\n    addNotification({ id: nanoid(), type: NotificationType.InApp, message }),\n  );\n\n  return null;\n}\n\n/**\n * Get a method that can be used to show an in-app notification.\n *\n * @param runSaga - A function to run a saga outside the usual Redux flow.\n * @returns A method that can be used to show an in-app notification.\n */\nexport function getShowInAppNotificationImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return async (\n    ...args: Parameters<typeof showInAppNotificationImplementation>\n  ) => {\n    return await runSaga(\n      showInAppNotificationImplementation,\n      ...args,\n    ).toPromise();\n  };\n}\n"]}
+{"version":3,"file":"notifications.cjs","sourceRoot":"","sources":["../../../src/methods/hooks/notifications.ts"],"names":[],"mappings":";;;AACA,mDAAuD;AACvD,8CAA0C;AAE1C,gDAAyC;AAGzC,iDAA4D;AAE5D;;;;;;;;GAQG;AACH,QAAQ,CAAC,CAAC,oCAAoC,CAC5C,OAAe,EACf,EAAE,OAAO,EAAgB;IAEzB,MAAM,IAAA,aAAG,EACP,IAAA,uBAAe,EAAC,EAAE,EAAE,EAAE,IAAA,gBAAM,GAAE,EAAE,IAAI,EAAE,4BAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAC1E,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,SAAgB,uCAAuC,CACrD,OAAwB;IAExB,OAAO,KAAK,EACV,GAAG,IAA6D,EAChE,EAAE;QACF,OAAO,MAAM,OAAO,CAClB,oCAAoC,EACpC,GAAG,IAAI,CACR,CAAC,SAAS,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAXD,0FAWC;AAUD;;;;;;;;;;;GAWG;AACH,QAAQ,CAAC,CAAC,mCAAmC,CAC3C,OAAe,EACf,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAA2B;IAEhE,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,IAAA,aAAG,EAAC,IAAA,oBAAY,EAAC,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,IAAA,aAAG,EACP,IAAA,uBAAe,EAAC;QACd,EAAE,EAAE,IAAA,gBAAM,GAAE;QACZ,IAAI,EAAE,4BAAgB,CAAC,KAAK;QAC5B,OAAO;QACP,KAAK;QACL,OAAO;QACP,UAAU;KACX,CAAC,CACH,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,SAAgB,sCAAsC,CACpD,OAAwB;IAExB,OAAO,KAAK,EACV,GAAG,IAA4D,EAC/D,EAAE;QACF,OAAO,MAAM,OAAO,CAClB,mCAAmC,EACnC,GAAG,IAAI,CACR,CAAC,SAAS,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAXD,wFAWC","sourcesContent":["import type { NotifyParams } from '@metamask/snaps-sdk';\nimport { NotificationType } from '@metamask/snaps-sdk';\nimport { nanoid } from '@reduxjs/toolkit';\nimport type { SagaIterator } from 'redux-saga';\nimport { put } from 'redux-saga/effects';\n\nimport type { RunSagaFunction } from '../../store';\nimport { addNotification, setInterface } from '../../store';\n\n/**\n * Show a native notification to the user.\n *\n * @param _snapId - The ID of the Snap that created the notification.\n * @param options - The notification options.\n * @param options.message - The message to show in the notification.\n * @yields Adds the notification to the store.\n * @returns `null`.\n */\nfunction* showNativeNotificationImplementation(\n  _snapId: string,\n  { message }: NotifyParams,\n): SagaIterator {\n  yield put(\n    addNotification({ id: nanoid(), type: NotificationType.Native, message }),\n  );\n\n  return null;\n}\n\n/**\n * Get a method that can be used to show a native notification.\n *\n * @param runSaga - A function to run a saga outside the usual Redux flow.\n * @returns A method that can be used to show a native notification.\n */\nexport function getShowNativeNotificationImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return async (\n    ...args: Parameters<typeof showNativeNotificationImplementation>\n  ) => {\n    return await runSaga(\n      showNativeNotificationImplementation,\n      ...args,\n    ).toPromise();\n  };\n}\n\ntype InAppNotificationParams = {\n  type: NotificationType;\n  message: string;\n  title?: string | undefined;\n  content?: string | undefined;\n  footerLink?: { text: string; href: string } | undefined;\n};\n\n/**\n * Show an in-app notification to the user.\n *\n * @param _snapId - The ID of the Snap that created the notification.\n * @param options - The notification options.\n * @param options.message - The message to show in the notification.\n * @param options.title - The title to show in the notification.\n * @param options.content - The JSX content to show in the notification.\n * @param options.footerLink - The footer to show in the notification.\n * @yields Adds the notification to the store.\n * @returns `null`.\n */\nfunction* showInAppNotificationImplementation(\n  _snapId: string,\n  { message, title, content, footerLink }: InAppNotificationParams,\n): SagaIterator<null> {\n  if (content) {\n    yield put(setInterface({ type: 'Notification', id: content }));\n  }\n\n  yield put(\n    addNotification({\n      id: nanoid(),\n      type: NotificationType.InApp,\n      message,\n      title,\n      content,\n      footerLink,\n    }),\n  );\n\n  return null;\n}\n\n/**\n * Get a method that can be used to show an in-app notification.\n *\n * @param runSaga - A function to run a saga outside the usual Redux flow.\n * @returns A method that can be used to show an in-app notification.\n */\nexport function getShowInAppNotificationImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return async (\n    ...args: Parameters<typeof showInAppNotificationImplementation>\n  ) => {\n    return await runSaga(\n      showInAppNotificationImplementation,\n      ...args,\n    ).toPromise();\n  };\n}\n"]}

package/dist/methods/hooks/notifications.d.cts

@@ -1,4 +1,5 @@
 import type { NotifyParams } from "@metamask/snaps-sdk";
+import { NotificationType } from "@metamask/snaps-sdk";
 import type { RunSagaFunction } from "../../store/index.cjs";
 /**
  * Get a method that can be used to show a native notification.
@@ -7,11 +8,22 @@ import type { RunSagaFunction } from "../../store/index.cjs";
  * @returns A method that can be used to show a native notification.
  */
 export declare function getShowNativeNotificationImplementation(runSaga: RunSagaFunction): (_snapId: string, args_1: NotifyParams) => Promise<any>;
+type InAppNotificationParams = {
+    type: NotificationType;
+    message: string;
+    title?: string | undefined;
+    content?: string | undefined;
+    footerLink?: {
+        text: string;
+        href: string;
+    } | undefined;
+};
 /**
  * Get a method that can be used to show an in-app notification.
  *
  * @param runSaga - A function to run a saga outside the usual Redux flow.
  * @returns A method that can be used to show an in-app notification.
  */
-export declare function getShowInAppNotificationImplementation(runSaga: RunSagaFunction): (_snapId: string, args_1: NotifyParams) => Promise<any>;
+export declare function getShowInAppNotificationImplementation(runSaga: RunSagaFunction): (_snapId: string, args_1: InAppNotificationParams) => Promise<any>;
+export {};
 //# sourceMappingURL=notifications.d.cts.map

package/dist/methods/hooks/notifications.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"notifications.d.cts","sourceRoot":"","sources":["../../../src/methods/hooks/notifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,4BAA4B;AAMxD,OAAO,KAAK,EAAE,eAAe,EAAE,8BAAoB;AAuBnD;;;;;GAKG;AACH,wBAAgB,uCAAuC,CACrD,OAAO,EAAE,eAAe,2DAUzB;AAsBD;;;;;GAKG;AACH,wBAAgB,sCAAsC,CACpD,OAAO,EAAE,eAAe,2DAUzB"}
+{"version":3,"file":"notifications.d.cts","sourceRoot":"","sources":["../../../src/methods/hooks/notifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,4BAA4B;AACxD,OAAO,EAAE,gBAAgB,EAAE,4BAA4B;AAKvD,OAAO,KAAK,EAAE,eAAe,EAAE,8BAAoB;AAuBnD;;;;;GAKG;AACH,wBAAgB,uCAAuC,CACrD,OAAO,EAAE,eAAe,2DAUzB;AAED,KAAK,uBAAuB,GAAG;IAC7B,IAAI,EAAE,gBAAgB,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,UAAU,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;CACzD,CAAC;AAoCF;;;;;GAKG;AACH,wBAAgB,sCAAsC,CACpD,OAAO,EAAE,eAAe,sEAUzB"}

package/dist/methods/hooks/notifications.d.mts

@@ -1,4 +1,5 @@
 import type { NotifyParams } from "@metamask/snaps-sdk";
+import { NotificationType } from "@metamask/snaps-sdk";
 import type { RunSagaFunction } from "../../store/index.mjs";
 /**
  * Get a method that can be used to show a native notification.
@@ -7,11 +8,22 @@ import type { RunSagaFunction } from "../../store/index.mjs";
  * @returns A method that can be used to show a native notification.
  */
 export declare function getShowNativeNotificationImplementation(runSaga: RunSagaFunction): (_snapId: string, args_1: NotifyParams) => Promise<any>;
+type InAppNotificationParams = {
+    type: NotificationType;
+    message: string;
+    title?: string | undefined;
+    content?: string | undefined;
+    footerLink?: {
+        text: string;
+        href: string;
+    } | undefined;
+};
 /**
  * Get a method that can be used to show an in-app notification.
  *
  * @param runSaga - A function to run a saga outside the usual Redux flow.
  * @returns A method that can be used to show an in-app notification.
  */
-export declare function getShowInAppNotificationImplementation(runSaga: RunSagaFunction): (_snapId: string, args_1: NotifyParams) => Promise<any>;
+export declare function getShowInAppNotificationImplementation(runSaga: RunSagaFunction): (_snapId: string, args_1: InAppNotificationParams) => Promise<any>;
+export {};
 //# sourceMappingURL=notifications.d.mts.map

package/dist/methods/hooks/notifications.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"notifications.d.mts","sourceRoot":"","sources":["../../../src/methods/hooks/notifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,4BAA4B;AAMxD,OAAO,KAAK,EAAE,eAAe,EAAE,8BAAoB;AAuBnD;;;;;GAKG;AACH,wBAAgB,uCAAuC,CACrD,OAAO,EAAE,eAAe,2DAUzB;AAsBD;;;;;GAKG;AACH,wBAAgB,sCAAsC,CACpD,OAAO,EAAE,eAAe,2DAUzB"}
+{"version":3,"file":"notifications.d.mts","sourceRoot":"","sources":["../../../src/methods/hooks/notifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,4BAA4B;AACxD,OAAO,EAAE,gBAAgB,EAAE,4BAA4B;AAKvD,OAAO,KAAK,EAAE,eAAe,EAAE,8BAAoB;AAuBnD;;;;;GAKG;AACH,wBAAgB,uCAAuC,CACrD,OAAO,EAAE,eAAe,2DAUzB;AAED,KAAK,uBAAuB,GAAG;IAC7B,IAAI,EAAE,gBAAgB,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,UAAU,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;CACzD,CAAC;AAoCF;;;;;GAKG;AACH,wBAAgB,sCAAsC,CACpD,OAAO,EAAE,eAAe,sEAUzB"}

package/dist/methods/hooks/notifications.mjs

@@ -2,7 +2,7 @@ import { NotificationType } from "@metamask/snaps-sdk";
 import $reduxjstoolkit from "@reduxjs/toolkit";
 const { nanoid } = $reduxjstoolkit;
 import { put } from "redux-saga/effects";
-import { addNotification } from "../../store/index.mjs";
+import { addNotification, setInterface } from "../../store/index.mjs";
 /**
  * Show a native notification to the user.
  *
@@ -33,11 +33,24 @@ export function getShowNativeNotificationImplementation(runSaga) {
  * @param _snapId - The ID of the Snap that created the notification.
  * @param options - The notification options.
  * @param options.message - The message to show in the notification.
+ * @param options.title - The title to show in the notification.
+ * @param options.content - The JSX content to show in the notification.
+ * @param options.footerLink - The footer to show in the notification.
  * @yields Adds the notification to the store.
  * @returns `null`.
  */
-function* showInAppNotificationImplementation(_snapId, { message }) {
-    yield put(addNotification({ id: nanoid(), type: NotificationType.InApp, message }));
+function* showInAppNotificationImplementation(_snapId, { message, title, content, footerLink }) {
+    if (content) {
+        yield put(setInterface({ type: 'Notification', id: content }));
+    }
+    yield put(addNotification({
+        id: nanoid(),
+        type: NotificationType.InApp,
+        message,
+        title,
+        content,
+        footerLink,
+    }));
     return null;
 }
 /**

package/dist/methods/hooks/notifications.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"notifications.mjs","sourceRoot":"","sources":["../../../src/methods/hooks/notifications.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,4BAA4B;;;AAGvD,OAAO,EAAE,GAAG,EAAE,2BAA2B;AAGzC,OAAO,EAAE,eAAe,EAAE,8BAAoB;AAE9C;;;;;;;;GAQG;AACH,QAAQ,CAAC,CAAC,oCAAoC,CAC5C,OAAe,EACf,EAAE,OAAO,EAAgB;IAEzB,MAAM,GAAG,CACP,eAAe,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,gBAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAC1E,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uCAAuC,CACrD,OAAwB;IAExB,OAAO,KAAK,EACV,GAAG,IAA6D,EAChE,EAAE;QACF,OAAO,MAAM,OAAO,CAClB,oCAAoC,EACpC,GAAG,IAAI,CACR,CAAC,SAAS,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,QAAQ,CAAC,CAAC,mCAAmC,CAC3C,OAAe,EACf,EAAE,OAAO,EAAgB;IAEzB,MAAM,GAAG,CACP,eAAe,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,CACzE,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sCAAsC,CACpD,OAAwB;IAExB,OAAO,KAAK,EACV,GAAG,IAA4D,EAC/D,EAAE;QACF,OAAO,MAAM,OAAO,CAClB,mCAAmC,EACnC,GAAG,IAAI,CACR,CAAC,SAAS,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import type { NotifyParams } from '@metamask/snaps-sdk';\nimport { NotificationType } from '@metamask/snaps-sdk';\nimport { nanoid } from '@reduxjs/toolkit';\nimport type { SagaIterator } from 'redux-saga';\nimport { put } from 'redux-saga/effects';\n\nimport type { RunSagaFunction } from '../../store';\nimport { addNotification } from '../../store';\n\n/**\n * Show a native notification to the user.\n *\n * @param _snapId - The ID of the Snap that created the notification.\n * @param options - The notification options.\n * @param options.message - The message to show in the notification.\n * @yields Adds the notification to the store.\n * @returns `null`.\n */\nfunction* showNativeNotificationImplementation(\n  _snapId: string,\n  { message }: NotifyParams,\n): SagaIterator {\n  yield put(\n    addNotification({ id: nanoid(), type: NotificationType.Native, message }),\n  );\n\n  return null;\n}\n\n/**\n * Get a method that can be used to show a native notification.\n *\n * @param runSaga - A function to run a saga outside the usual Redux flow.\n * @returns A method that can be used to show a native notification.\n */\nexport function getShowNativeNotificationImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return async (\n    ...args: Parameters<typeof showNativeNotificationImplementation>\n  ) => {\n    return await runSaga(\n      showNativeNotificationImplementation,\n      ...args,\n    ).toPromise();\n  };\n}\n\n/**\n * Show an in-app notification to the user.\n *\n * @param _snapId - The ID of the Snap that created the notification.\n * @param options - The notification options.\n * @param options.message - The message to show in the notification.\n * @yields Adds the notification to the store.\n * @returns `null`.\n */\nfunction* showInAppNotificationImplementation(\n  _snapId: string,\n  { message }: NotifyParams,\n): SagaIterator<null> {\n  yield put(\n    addNotification({ id: nanoid(), type: NotificationType.InApp, message }),\n  );\n\n  return null;\n}\n\n/**\n * Get a method that can be used to show an in-app notification.\n *\n * @param runSaga - A function to run a saga outside the usual Redux flow.\n * @returns A method that can be used to show an in-app notification.\n */\nexport function getShowInAppNotificationImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return async (\n    ...args: Parameters<typeof showInAppNotificationImplementation>\n  ) => {\n    return await runSaga(\n      showInAppNotificationImplementation,\n      ...args,\n    ).toPromise();\n  };\n}\n"]}
+{"version":3,"file":"notifications.mjs","sourceRoot":"","sources":["../../../src/methods/hooks/notifications.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,4BAA4B;;;AAGvD,OAAO,EAAE,GAAG,EAAE,2BAA2B;AAGzC,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,8BAAoB;AAE5D;;;;;;;;GAQG;AACH,QAAQ,CAAC,CAAC,oCAAoC,CAC5C,OAAe,EACf,EAAE,OAAO,EAAgB;IAEzB,MAAM,GAAG,CACP,eAAe,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,gBAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAC1E,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uCAAuC,CACrD,OAAwB;IAExB,OAAO,KAAK,EACV,GAAG,IAA6D,EAChE,EAAE;QACF,OAAO,MAAM,OAAO,CAClB,oCAAoC,EACpC,GAAG,IAAI,CACR,CAAC,SAAS,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAUD;;;;;;;;;;;GAWG;AACH,QAAQ,CAAC,CAAC,mCAAmC,CAC3C,OAAe,EACf,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAA2B;IAEhE,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,GAAG,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,GAAG,CACP,eAAe,CAAC;QACd,EAAE,EAAE,MAAM,EAAE;QACZ,IAAI,EAAE,gBAAgB,CAAC,KAAK;QAC5B,OAAO;QACP,KAAK;QACL,OAAO;QACP,UAAU;KACX,CAAC,CACH,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sCAAsC,CACpD,OAAwB;IAExB,OAAO,KAAK,EACV,GAAG,IAA4D,EAC/D,EAAE;QACF,OAAO,MAAM,OAAO,CAClB,mCAAmC,EACnC,GAAG,IAAI,CACR,CAAC,SAAS,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import type { NotifyParams } from '@metamask/snaps-sdk';\nimport { NotificationType } from '@metamask/snaps-sdk';\nimport { nanoid } from '@reduxjs/toolkit';\nimport type { SagaIterator } from 'redux-saga';\nimport { put } from 'redux-saga/effects';\n\nimport type { RunSagaFunction } from '../../store';\nimport { addNotification, setInterface } from '../../store';\n\n/**\n * Show a native notification to the user.\n *\n * @param _snapId - The ID of the Snap that created the notification.\n * @param options - The notification options.\n * @param options.message - The message to show in the notification.\n * @yields Adds the notification to the store.\n * @returns `null`.\n */\nfunction* showNativeNotificationImplementation(\n  _snapId: string,\n  { message }: NotifyParams,\n): SagaIterator {\n  yield put(\n    addNotification({ id: nanoid(), type: NotificationType.Native, message }),\n  );\n\n  return null;\n}\n\n/**\n * Get a method that can be used to show a native notification.\n *\n * @param runSaga - A function to run a saga outside the usual Redux flow.\n * @returns A method that can be used to show a native notification.\n */\nexport function getShowNativeNotificationImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return async (\n    ...args: Parameters<typeof showNativeNotificationImplementation>\n  ) => {\n    return await runSaga(\n      showNativeNotificationImplementation,\n      ...args,\n    ).toPromise();\n  };\n}\n\ntype InAppNotificationParams = {\n  type: NotificationType;\n  message: string;\n  title?: string | undefined;\n  content?: string | undefined;\n  footerLink?: { text: string; href: string } | undefined;\n};\n\n/**\n * Show an in-app notification to the user.\n *\n * @param _snapId - The ID of the Snap that created the notification.\n * @param options - The notification options.\n * @param options.message - The message to show in the notification.\n * @param options.title - The title to show in the notification.\n * @param options.content - The JSX content to show in the notification.\n * @param options.footerLink - The footer to show in the notification.\n * @yields Adds the notification to the store.\n * @returns `null`.\n */\nfunction* showInAppNotificationImplementation(\n  _snapId: string,\n  { message, title, content, footerLink }: InAppNotificationParams,\n): SagaIterator<null> {\n  if (content) {\n    yield put(setInterface({ type: 'Notification', id: content }));\n  }\n\n  yield put(\n    addNotification({\n      id: nanoid(),\n      type: NotificationType.InApp,\n      message,\n      title,\n      content,\n      footerLink,\n    }),\n  );\n\n  return null;\n}\n\n/**\n * Get a method that can be used to show an in-app notification.\n *\n * @param runSaga - A function to run a saga outside the usual Redux flow.\n * @returns A method that can be used to show an in-app notification.\n */\nexport function getShowInAppNotificationImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return async (\n    ...args: Parameters<typeof showInAppNotificationImplementation>\n  ) => {\n    return await runSaga(\n      showInAppNotificationImplementation,\n      ...args,\n    ).toPromise();\n  };\n}\n"]}

package/dist/methods/hooks/permitted/index.cjs

@@ -0,0 +1,18 @@
+"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("./state.cjs"), exports);
+//# sourceMappingURL=index.cjs.map

package/dist/methods/hooks/permitted/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../../../src/methods/hooks/permitted/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAAwB","sourcesContent":["export * from './state';\n"]}

package/dist/methods/hooks/permitted/index.d.cts

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

package/dist/methods/hooks/permitted/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../../../src/methods/hooks/permitted/index.ts"],"names":[],"mappings":"AAAA,4BAAwB"}

package/dist/methods/hooks/permitted/index.d.mts

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

package/dist/methods/hooks/permitted/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../../src/methods/hooks/permitted/index.ts"],"names":[],"mappings":"AAAA,4BAAwB"}

package/dist/methods/hooks/permitted/index.mjs

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

package/dist/methods/hooks/permitted/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../../src/methods/hooks/permitted/index.ts"],"names":[],"mappings":"AAAA,4BAAwB","sourcesContent":["export * from './state';\n"]}

package/dist/methods/hooks/permitted/state.cjs

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPermittedClearSnapStateMethodImplementation = exports.getPermittedUpdateSnapStateMethodImplementation = exports.getPermittedGetSnapStateMethodImplementation = void 0;
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const effects_1 = require("redux-saga/effects");
+const store_1 = require("../../../store/index.cjs");
+/**
+ * Get the Snap state from the store.
+ *
+ * @param encrypted - Whether to get the encrypted or unencrypted state.
+ * Defaults to encrypted state.
+ * @returns The state of the Snap.
+ * @yields Selects the state from the store.
+ */
+function* getSnapStateImplementation(encrypted) {
+    const state = yield (0, effects_1.select)((0, store_1.getState)(encrypted));
+    // TODO: Use actual decryption implementation
+    return (0, snaps_utils_1.parseJson)(state);
+}
+/**
+ * Get the implementation of the `getSnapState` hook.
+ *
+ * @param runSaga - The function to run a saga outside the usual Redux flow.
+ * @returns The implementation of the `getSnapState` hook.
+ */
+function getPermittedGetSnapStateMethodImplementation(runSaga) {
+    return async (...args) => {
+        return await runSaga(getSnapStateImplementation, ...args).toPromise();
+    };
+}
+exports.getPermittedGetSnapStateMethodImplementation = getPermittedGetSnapStateMethodImplementation;
+/**
+ * Update the Snap state in the store.
+ *
+ * @param newState - The new state.
+ * @param encrypted - Whether to update the encrypted or unencrypted state.
+ * Defaults to encrypted state.
+ * @yields Puts the new state in the store.
+ */
+function* updateSnapStateImplementation(newState, encrypted) {
+    // TODO: Use actual encryption implementation
+    yield (0, effects_1.put)((0, store_1.setState)({ state: JSON.stringify(newState), encrypted }));
+}
+/**
+ * Get the implementation of the `updateSnapState` hook.
+ *
+ * @param runSaga - The function to run a saga outside the usual Redux flow.
+ * @returns The implementation of the `updateSnapState` hook.
+ */
+function getPermittedUpdateSnapStateMethodImplementation(runSaga) {
+    return async (...args) => {
+        return await runSaga(updateSnapStateImplementation, ...args).toPromise();
+    };
+}
+exports.getPermittedUpdateSnapStateMethodImplementation = getPermittedUpdateSnapStateMethodImplementation;
+/**
+ * Clear the Snap state in the store.
+ *
+ * @param encrypted - Whether to clear the encrypted or unencrypted state.
+ * Defaults to encrypted state.
+ * @yields Puts the new state in the store.
+ */
+function* clearSnapStateImplementation(encrypted) {
+    yield (0, effects_1.put)((0, store_1.clearState)({ encrypted }));
+}
+/**
+ * Get the implementation of the `clearSnapState` hook.
+ *
+ * @param runSaga - The function to run a saga outside the usual Redux flow.
+ * @returns The implementation of the `clearSnapState` hook.
+ */
+function getPermittedClearSnapStateMethodImplementation(runSaga) {
+    return async (...args) => {
+        runSaga(clearSnapStateImplementation, ...args).result();
+    };
+}
+exports.getPermittedClearSnapStateMethodImplementation = getPermittedClearSnapStateMethodImplementation;
+//# sourceMappingURL=state.cjs.map

package/dist/methods/hooks/permitted/state.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.cjs","sourceRoot":"","sources":["../../../../src/methods/hooks/permitted/state.ts"],"names":[],"mappings":";;;AAAA,uDAAkD;AAGlD,gDAAiD;AAGjD,oDAAgE;AAEhE;;;;;;;GAOG;AACH,QAAQ,CAAC,CAAC,0BAA0B,CAAC,SAAkB;IACrD,MAAM,KAAK,GAAG,MAAM,IAAA,gBAAM,EAAC,IAAA,gBAAQ,EAAC,SAAS,CAAC,CAAC,CAAC;IAChD,6CAA6C;IAC7C,OAAO,IAAA,uBAAS,EAAC,KAAK,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;GAKG;AACH,SAAgB,4CAA4C,CAC1D,OAAwB;IAExB,OAAO,KAAK,EAAE,GAAG,IAAmD,EAAE,EAAE;QACtE,OAAO,MAAM,OAAO,CAAC,0BAA0B,EAAE,GAAG,IAAI,CAAC,CAAC,SAAS,EAAE,CAAC;IACxE,CAAC,CAAC;AACJ,CAAC;AAND,oGAMC;AAED;;;;;;;GAOG;AACH,QAAQ,CAAC,CAAC,6BAA6B,CACrC,QAA8B,EAC9B,SAAkB;IAElB,6CAA6C;IAC7C,MAAM,IAAA,aAAG,EAAC,IAAA,gBAAQ,EAAC,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;AACtE,CAAC;AAED;;;;;GAKG;AACH,SAAgB,+CAA+C,CAC7D,OAAwB;IAExB,OAAO,KAAK,EAAE,GAAG,IAAsD,EAAE,EAAE;QACzE,OAAO,MAAM,OAAO,CAAC,6BAA6B,EAAE,GAAG,IAAI,CAAC,CAAC,SAAS,EAAE,CAAC;IAC3E,CAAC,CAAC;AACJ,CAAC;AAND,0GAMC;AAED;;;;;;GAMG;AACH,QAAQ,CAAC,CAAC,4BAA4B,CAAC,SAAkB;IACvD,MAAM,IAAA,aAAG,EAAC,IAAA,kBAAU,EAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;AACvC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,8CAA8C,CAC5D,OAAwB;IAExB,OAAO,KAAK,EAAE,GAAG,IAAqD,EAAE,EAAE;QACxE,OAAO,CAAC,4BAA4B,EAAE,GAAG,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;IAC1D,CAAC,CAAC;AACJ,CAAC;AAND,wGAMC","sourcesContent":["import { parseJson } from '@metamask/snaps-utils';\nimport type { Json } from '@metamask/utils';\nimport type { SagaIterator } from 'redux-saga';\nimport { put, select } from 'redux-saga/effects';\n\nimport type { RunSagaFunction } from '../../../store';\nimport { clearState, getState, setState } from '../../../store';\n\n/**\n * Get the Snap state from the store.\n *\n * @param encrypted - Whether to get the encrypted or unencrypted state.\n * Defaults to encrypted state.\n * @returns The state of the Snap.\n * @yields Selects the state from the store.\n */\nfunction* getSnapStateImplementation(encrypted: boolean): SagaIterator<string> {\n  const state = yield select(getState(encrypted));\n  // TODO: Use actual decryption implementation\n  return parseJson(state);\n}\n\n/**\n * Get the implementation of the `getSnapState` hook.\n *\n * @param runSaga - The function to run a saga outside the usual Redux flow.\n * @returns The implementation of the `getSnapState` hook.\n */\nexport function getPermittedGetSnapStateMethodImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return async (...args: Parameters<typeof getSnapStateImplementation>) => {\n    return await runSaga(getSnapStateImplementation, ...args).toPromise();\n  };\n}\n\n/**\n * Update the Snap state in the store.\n *\n * @param newState - The new state.\n * @param encrypted - Whether to update the encrypted or unencrypted state.\n * Defaults to encrypted state.\n * @yields Puts the new state in the store.\n */\nfunction* updateSnapStateImplementation(\n  newState: Record<string, Json>,\n  encrypted: boolean,\n): SagaIterator<void> {\n  // TODO: Use actual encryption implementation\n  yield put(setState({ state: JSON.stringify(newState), encrypted }));\n}\n\n/**\n * Get the implementation of the `updateSnapState` hook.\n *\n * @param runSaga - The function to run a saga outside the usual Redux flow.\n * @returns The implementation of the `updateSnapState` hook.\n */\nexport function getPermittedUpdateSnapStateMethodImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return async (...args: Parameters<typeof updateSnapStateImplementation>) => {\n    return await runSaga(updateSnapStateImplementation, ...args).toPromise();\n  };\n}\n\n/**\n * Clear the Snap state in the store.\n *\n * @param encrypted - Whether to clear the encrypted or unencrypted state.\n * Defaults to encrypted state.\n * @yields Puts the new state in the store.\n */\nfunction* clearSnapStateImplementation(encrypted: boolean): SagaIterator<void> {\n  yield put(clearState({ encrypted }));\n}\n\n/**\n * Get the implementation of the `clearSnapState` hook.\n *\n * @param runSaga - The function to run a saga outside the usual Redux flow.\n * @returns The implementation of the `clearSnapState` hook.\n */\nexport function getPermittedClearSnapStateMethodImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return async (...args: Parameters<typeof clearSnapStateImplementation>) => {\n    runSaga(clearSnapStateImplementation, ...args).result();\n  };\n}\n"]}

package/dist/methods/hooks/permitted/state.d.cts

@@ -0,0 +1,24 @@
+import type { Json } from "@metamask/utils";
+import type { RunSagaFunction } from "../../../store/index.cjs";
+/**
+ * Get the implementation of the `getSnapState` hook.
+ *
+ * @param runSaga - The function to run a saga outside the usual Redux flow.
+ * @returns The implementation of the `getSnapState` hook.
+ */
+export declare function getPermittedGetSnapStateMethodImplementation(runSaga: RunSagaFunction): (encrypted: boolean) => Promise<any>;
+/**
+ * Get the implementation of the `updateSnapState` hook.
+ *
+ * @param runSaga - The function to run a saga outside the usual Redux flow.
+ * @returns The implementation of the `updateSnapState` hook.
+ */
+export declare function getPermittedUpdateSnapStateMethodImplementation(runSaga: RunSagaFunction): (newState: Record<string, Json>, encrypted: boolean) => Promise<any>;
+/**
+ * Get the implementation of the `clearSnapState` hook.
+ *
+ * @param runSaga - The function to run a saga outside the usual Redux flow.
+ * @returns The implementation of the `clearSnapState` hook.
+ */
+export declare function getPermittedClearSnapStateMethodImplementation(runSaga: RunSagaFunction): (encrypted: boolean) => Promise<void>;
+//# sourceMappingURL=state.d.cts.map

package/dist/methods/hooks/permitted/state.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.d.cts","sourceRoot":"","sources":["../../../../src/methods/hooks/permitted/state.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAI5C,OAAO,KAAK,EAAE,eAAe,EAAE,iCAAuB;AAiBtD;;;;;GAKG;AACH,wBAAgB,4CAA4C,CAC1D,OAAO,EAAE,eAAe,wCAKzB;AAkBD;;;;;GAKG;AACH,wBAAgB,+CAA+C,CAC7D,OAAO,EAAE,eAAe,wEAKzB;AAaD;;;;;GAKG;AACH,wBAAgB,8CAA8C,CAC5D,OAAO,EAAE,eAAe,yCAKzB"}

package/dist/methods/hooks/permitted/state.d.mts

@@ -0,0 +1,24 @@
+import type { Json } from "@metamask/utils";
+import type { RunSagaFunction } from "../../../store/index.mjs";
+/**
+ * Get the implementation of the `getSnapState` hook.
+ *
+ * @param runSaga - The function to run a saga outside the usual Redux flow.
+ * @returns The implementation of the `getSnapState` hook.
+ */
+export declare function getPermittedGetSnapStateMethodImplementation(runSaga: RunSagaFunction): (encrypted: boolean) => Promise<any>;
+/**
+ * Get the implementation of the `updateSnapState` hook.
+ *
+ * @param runSaga - The function to run a saga outside the usual Redux flow.
+ * @returns The implementation of the `updateSnapState` hook.
+ */
+export declare function getPermittedUpdateSnapStateMethodImplementation(runSaga: RunSagaFunction): (newState: Record<string, Json>, encrypted: boolean) => Promise<any>;
+/**
+ * Get the implementation of the `clearSnapState` hook.
+ *
+ * @param runSaga - The function to run a saga outside the usual Redux flow.
+ * @returns The implementation of the `clearSnapState` hook.
+ */
+export declare function getPermittedClearSnapStateMethodImplementation(runSaga: RunSagaFunction): (encrypted: boolean) => Promise<void>;
+//# sourceMappingURL=state.d.mts.map

package/dist/methods/hooks/permitted/state.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.d.mts","sourceRoot":"","sources":["../../../../src/methods/hooks/permitted/state.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAI5C,OAAO,KAAK,EAAE,eAAe,EAAE,iCAAuB;AAiBtD;;;;;GAKG;AACH,wBAAgB,4CAA4C,CAC1D,OAAO,EAAE,eAAe,wCAKzB;AAkBD;;;;;GAKG;AACH,wBAAgB,+CAA+C,CAC7D,OAAO,EAAE,eAAe,wEAKzB;AAaD;;;;;GAKG;AACH,wBAAgB,8CAA8C,CAC5D,OAAO,EAAE,eAAe,yCAKzB"}

package/dist/methods/hooks/permitted/state.mjs

@@ -0,0 +1,72 @@
+import { parseJson } from "@metamask/snaps-utils";
+import { put, select } from "redux-saga/effects";
+import { clearState, getState, setState } from "../../../store/index.mjs";
+/**
+ * Get the Snap state from the store.
+ *
+ * @param encrypted - Whether to get the encrypted or unencrypted state.
+ * Defaults to encrypted state.
+ * @returns The state of the Snap.
+ * @yields Selects the state from the store.
+ */
+function* getSnapStateImplementation(encrypted) {
+    const state = yield select(getState(encrypted));
+    // TODO: Use actual decryption implementation
+    return parseJson(state);
+}
+/**
+ * Get the implementation of the `getSnapState` hook.
+ *
+ * @param runSaga - The function to run a saga outside the usual Redux flow.
+ * @returns The implementation of the `getSnapState` hook.
+ */
+export function getPermittedGetSnapStateMethodImplementation(runSaga) {
+    return async (...args) => {
+        return await runSaga(getSnapStateImplementation, ...args).toPromise();
+    };
+}
+/**
+ * Update the Snap state in the store.
+ *
+ * @param newState - The new state.
+ * @param encrypted - Whether to update the encrypted or unencrypted state.
+ * Defaults to encrypted state.
+ * @yields Puts the new state in the store.
+ */
+function* updateSnapStateImplementation(newState, encrypted) {
+    // TODO: Use actual encryption implementation
+    yield put(setState({ state: JSON.stringify(newState), encrypted }));
+}
+/**
+ * Get the implementation of the `updateSnapState` hook.
+ *
+ * @param runSaga - The function to run a saga outside the usual Redux flow.
+ * @returns The implementation of the `updateSnapState` hook.
+ */
+export function getPermittedUpdateSnapStateMethodImplementation(runSaga) {
+    return async (...args) => {
+        return await runSaga(updateSnapStateImplementation, ...args).toPromise();
+    };
+}
+/**
+ * Clear the Snap state in the store.
+ *
+ * @param encrypted - Whether to clear the encrypted or unencrypted state.
+ * Defaults to encrypted state.
+ * @yields Puts the new state in the store.
+ */
+function* clearSnapStateImplementation(encrypted) {
+    yield put(clearState({ encrypted }));
+}
+/**
+ * Get the implementation of the `clearSnapState` hook.
+ *
+ * @param runSaga - The function to run a saga outside the usual Redux flow.
+ * @returns The implementation of the `clearSnapState` hook.
+ */
+export function getPermittedClearSnapStateMethodImplementation(runSaga) {
+    return async (...args) => {
+        runSaga(clearSnapStateImplementation, ...args).result();
+    };
+}
+//# sourceMappingURL=state.mjs.map

package/dist/methods/hooks/permitted/state.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.mjs","sourceRoot":"","sources":["../../../../src/methods/hooks/permitted/state.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,8BAA8B;AAGlD,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,2BAA2B;AAGjD,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,iCAAuB;AAEhE;;;;;;;GAOG;AACH,QAAQ,CAAC,CAAC,0BAA0B,CAAC,SAAkB;IACrD,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;IAChD,6CAA6C;IAC7C,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,4CAA4C,CAC1D,OAAwB;IAExB,OAAO,KAAK,EAAE,GAAG,IAAmD,EAAE,EAAE;QACtE,OAAO,MAAM,OAAO,CAAC,0BAA0B,EAAE,GAAG,IAAI,CAAC,CAAC,SAAS,EAAE,CAAC;IACxE,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,QAAQ,CAAC,CAAC,6BAA6B,CACrC,QAA8B,EAC9B,SAAkB;IAElB,6CAA6C;IAC7C,MAAM,GAAG,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;AACtE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,+CAA+C,CAC7D,OAAwB;IAExB,OAAO,KAAK,EAAE,GAAG,IAAsD,EAAE,EAAE;QACzE,OAAO,MAAM,OAAO,CAAC,6BAA6B,EAAE,GAAG,IAAI,CAAC,CAAC,SAAS,EAAE,CAAC;IAC3E,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,QAAQ,CAAC,CAAC,4BAA4B,CAAC,SAAkB;IACvD,MAAM,GAAG,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;AACvC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,8CAA8C,CAC5D,OAAwB;IAExB,OAAO,KAAK,EAAE,GAAG,IAAqD,EAAE,EAAE;QACxE,OAAO,CAAC,4BAA4B,EAAE,GAAG,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;IAC1D,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import { parseJson } from '@metamask/snaps-utils';\nimport type { Json } from '@metamask/utils';\nimport type { SagaIterator } from 'redux-saga';\nimport { put, select } from 'redux-saga/effects';\n\nimport type { RunSagaFunction } from '../../../store';\nimport { clearState, getState, setState } from '../../../store';\n\n/**\n * Get the Snap state from the store.\n *\n * @param encrypted - Whether to get the encrypted or unencrypted state.\n * Defaults to encrypted state.\n * @returns The state of the Snap.\n * @yields Selects the state from the store.\n */\nfunction* getSnapStateImplementation(encrypted: boolean): SagaIterator<string> {\n  const state = yield select(getState(encrypted));\n  // TODO: Use actual decryption implementation\n  return parseJson(state);\n}\n\n/**\n * Get the implementation of the `getSnapState` hook.\n *\n * @param runSaga - The function to run a saga outside the usual Redux flow.\n * @returns The implementation of the `getSnapState` hook.\n */\nexport function getPermittedGetSnapStateMethodImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return async (...args: Parameters<typeof getSnapStateImplementation>) => {\n    return await runSaga(getSnapStateImplementation, ...args).toPromise();\n  };\n}\n\n/**\n * Update the Snap state in the store.\n *\n * @param newState - The new state.\n * @param encrypted - Whether to update the encrypted or unencrypted state.\n * Defaults to encrypted state.\n * @yields Puts the new state in the store.\n */\nfunction* updateSnapStateImplementation(\n  newState: Record<string, Json>,\n  encrypted: boolean,\n): SagaIterator<void> {\n  // TODO: Use actual encryption implementation\n  yield put(setState({ state: JSON.stringify(newState), encrypted }));\n}\n\n/**\n * Get the implementation of the `updateSnapState` hook.\n *\n * @param runSaga - The function to run a saga outside the usual Redux flow.\n * @returns The implementation of the `updateSnapState` hook.\n */\nexport function getPermittedUpdateSnapStateMethodImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return async (...args: Parameters<typeof updateSnapStateImplementation>) => {\n    return await runSaga(updateSnapStateImplementation, ...args).toPromise();\n  };\n}\n\n/**\n * Clear the Snap state in the store.\n *\n * @param encrypted - Whether to clear the encrypted or unencrypted state.\n * Defaults to encrypted state.\n * @yields Puts the new state in the store.\n */\nfunction* clearSnapStateImplementation(encrypted: boolean): SagaIterator<void> {\n  yield put(clearState({ encrypted }));\n}\n\n/**\n * Get the implementation of the `clearSnapState` hook.\n *\n * @param runSaga - The function to run a saga outside the usual Redux flow.\n * @returns The implementation of the `clearSnapState` hook.\n */\nexport function getPermittedClearSnapStateMethodImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return async (...args: Parameters<typeof clearSnapStateImplementation>) => {\n    runSaga(clearSnapStateImplementation, ...args).result();\n  };\n}\n"]}

package/dist/methods/specifications.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"specifications.cjs","sourceRoot":"","sources":["../../src/methods/specifications.ts"],"names":[],"mappings":";;;AACA,mEAIqC;AAErC,uDAA2D;AAK3D,+CAGqB;AACrB,6CAUiB;AAkBjB;;;;;GAKG;AACH,SAAgB,OAAO,CAAC,MAAe;IACrC,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC;AACtB,CAAC;AAFD,0BAEC;AAED;;;;;;GAMG;AACH,SAAgB,YAAY,CAAC,MAAgB;IAC3C,OAAO,KAAK,IAAI,EAAE,CAAC,MAAM,CAAC;AAC5B,CAAC;AAFD,oCAEC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,2BAA2B,CAAC,EAC1C,mBAAmB,EACnB,KAAK,EACL,OAAO,EACP,OAAO,GAC4B;IACnC,OAAO;QACL,GAAG,IAAA,oDAAgC,EAAC,oCAAwB,CAAC;QAC7D,GAAG,IAAA,2DAAuC,EAAC,qCAAyB,EAAE;YACpE,gBAAgB;YAChB,GAAG,KAAK;YAER,wBAAwB;YACxB,cAAc,EAAE,IAAA,6CAAqC,EAAC,OAAO,CAAC;YAC9D,cAAc,EAAE,IAAA,6CAAqC,EAAC,OAAO,CAAC;YAC9D,YAAY,EAAE,IAAA,2CAAmC,EAAC,OAAO,CAAC;YAC1D,gBAAgB,EAAE,YAAY,CAAC,IAAI,CAAC;YAEpC,+DAA+D;YAC/D,gBAAgB,EAAE,OAAO,CAAC,KAAK,CAAC;YAEhC,uBAAuB,EAAE,YAAY,EAAE;YACvC,mBAAmB,EAAE,IAAA,4CAAoC,EAAC,OAAO,CAAC;YAClE,qBAAqB,EAAE,IAAA,8CAAsC,EAAC,OAAO,CAAC;YACtE,sBAAsB,EAAE,IAAA,+CAAuC,EAAC,OAAO,CAAC;YACxE,eAAe,EAAE,IAAA,8CAAsC,EAAC,OAAO,CAAC;YAChE,eAAe,EAAE,IAAA,wCAAgC,EAAC,mBAAmB,CAAC;YACtE,YAAY,EAAE,IAAA,qCAA6B,EAAC,mBAAmB,CAAC;SACjE,CAAC;KACH,CAAC;AACJ,CAAC;AA9BD,kEA8BC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,aAAa,CACjC,oBAAiD,EACjD,MAAc;IAEd,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,+CAA2B,CAAC,CAAC,MAAM,CAEzE,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE;QAClC,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC;QAClC,IAAI,oBAAoB,CAAC,aAAa,CAAC,MAAM,EAAE,cAAc,CAAC,EAAE,CAAC;YAC/D,MAAM,UAAU,GAAG,MAAM,oBAAoB,CAAC,aAAa,CACzD,MAAM,EACN,cAAc,CACf,CAAC;YAEF,IAAI,UAAU,EAAE,CAAC;gBACf,OAAO,WAAW,CAAC,MAAM,CAAC,UAAsB,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IAExB,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,gCAAkB,EAAE,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AACjE,CAAC;AAvBD,sCAuBC","sourcesContent":["import type { GenericPermissionController } from '@metamask/permission-controller';\nimport {\n  endowmentPermissionBuilders,\n  buildSnapEndowmentSpecifications,\n  buildSnapRestrictedMethodSpecifications,\n} from '@metamask/snaps-rpc-methods';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport { DEFAULT_ENDOWMENTS } from '@metamask/snaps-utils';\n\nimport type { RootControllerMessenger } from '../controllers';\nimport type { SimulationOptions } from '../options';\nimport type { RunSagaFunction } from '../store';\nimport {\n  EXCLUDED_SNAP_ENDOWMENTS,\n  EXCLUDED_SNAP_PERMISSIONS,\n} from './constants';\nimport {\n  getGetPreferencesMethodImplementation,\n  getClearSnapStateMethodImplementation,\n  getGetSnapStateMethodImplementation,\n  getUpdateSnapStateMethodImplementation,\n  getShowInAppNotificationImplementation,\n  getShowNativeNotificationImplementation,\n  getCreateInterfaceImplementation,\n  getGetInterfaceImplementation,\n  getRequestUserApprovalImplementation,\n} from './hooks';\n\nexport type PermissionSpecificationsHooks = {\n  /**\n   * A hook that returns the user's secret recovery phrase.\n   *\n   * @returns The user's secret recovery phrase.\n   */\n  getMnemonic: () => Promise<Uint8Array>;\n};\n\nexport type GetPermissionSpecificationsOptions = {\n  controllerMessenger: RootControllerMessenger;\n  hooks: PermissionSpecificationsHooks;\n  runSaga: RunSagaFunction;\n  options: SimulationOptions;\n};\n\n/**\n * Get a function which resolves with the specified result.\n *\n * @param result - The result to return.\n * @returns The function implementation.\n */\nexport function resolve(result: unknown) {\n  return () => result;\n}\n\n/**\n * Get a function which resolves with the specified result.\n *\n * @param result - The result to return. If not specified, the function will\n * resolve with `undefined`.\n * @returns The function implementation.\n */\nexport function asyncResolve(result?: unknown) {\n  return async () => result;\n}\n\n/**\n * Get the permission specifications for the Snap.\n *\n * @param options - The options.\n * @param options.controllerMessenger - The controller messenger.\n * @param options.hooks - The hooks.\n * @param options.runSaga - The function to run a saga outside the usual Redux\n * flow.\n * @param options.options - The simulation options.\n * @returns The permission specifications for the Snap.\n */\nexport function getPermissionSpecifications({\n  controllerMessenger,\n  hooks,\n  runSaga,\n  options,\n}: GetPermissionSpecificationsOptions) {\n  return {\n    ...buildSnapEndowmentSpecifications(EXCLUDED_SNAP_ENDOWMENTS),\n    ...buildSnapRestrictedMethodSpecifications(EXCLUDED_SNAP_PERMISSIONS, {\n      // Shared hooks.\n      ...hooks,\n\n      // Snaps-specific hooks.\n      clearSnapState: getClearSnapStateMethodImplementation(runSaga),\n      getPreferences: getGetPreferencesMethodImplementation(options),\n      getSnapState: getGetSnapStateMethodImplementation(runSaga),\n      getUnlockPromise: asyncResolve(true),\n\n      // TODO: Allow the user to specify the result of this function.\n      isOnPhishingList: resolve(false),\n\n      maybeUpdatePhishingList: asyncResolve(),\n      requestUserApproval: getRequestUserApprovalImplementation(runSaga),\n      showInAppNotification: getShowInAppNotificationImplementation(runSaga),\n      showNativeNotification: getShowNativeNotificationImplementation(runSaga),\n      updateSnapState: getUpdateSnapStateMethodImplementation(runSaga),\n      createInterface: getCreateInterfaceImplementation(controllerMessenger),\n      getInterface: getGetInterfaceImplementation(controllerMessenger),\n    }),\n  };\n}\n\n/**\n * Get the endowments for the Snap.\n *\n * @param permissionController - The permission controller.\n * @param snapId - The ID of the Snap.\n * @returns The endowments for the Snap.\n */\nexport async function getEndowments(\n  permissionController: GenericPermissionController,\n  snapId: SnapId,\n) {\n  const allEndowments = await Object.keys(endowmentPermissionBuilders).reduce<\n    Promise<string[]>\n  >(async (promise, permissionName) => {\n    const accumulator = await promise;\n    if (permissionController.hasPermission(snapId, permissionName)) {\n      const endowments = await permissionController.getEndowments(\n        snapId,\n        permissionName,\n      );\n\n      if (endowments) {\n        return accumulator.concat(endowments as string[]);\n      }\n    }\n\n    return accumulator;\n  }, Promise.resolve([]));\n\n  return [...new Set([...DEFAULT_ENDOWMENTS, ...allEndowments])];\n}\n"]}
+{"version":3,"file":"specifications.cjs","sourceRoot":"","sources":["../../src/methods/specifications.ts"],"names":[],"mappings":";;;AACA,mEAIqC;AAErC,uDAA2D;AAK3D,+CAGqB;AACrB,6CAUiB;AAkBjB;;;;;GAKG;AACH,SAAgB,OAAO,CAAC,MAAe;IACrC,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC;AACtB,CAAC;AAFD,0BAEC;AAED;;;;;;GAMG;AACH,SAAgB,YAAY,CAAO,MAAa;IAC9C,OAAO,KAAK,IAAI,EAAE,CAAC,MAAM,CAAC;AAC5B,CAAC;AAFD,oCAEC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,2BAA2B,CAAC,EAC1C,mBAAmB,EACnB,KAAK,EACL,OAAO,EACP,OAAO,GAC4B;IACnC,OAAO;QACL,GAAG,IAAA,oDAAgC,EAAC,oCAAwB,CAAC;QAC7D,GAAG,IAAA,2DAAuC,EAAC,qCAAyB,EAAE;YACpE,gBAAgB;YAChB,GAAG,KAAK;YAER,wBAAwB;YACxB,cAAc,EAAE,IAAA,6CAAqC,EAAC,OAAO,CAAC;YAC9D,cAAc,EAAE,IAAA,6CAAqC,EAAC,OAAO,CAAC;YAC9D,YAAY,EAAE,IAAA,2CAAmC,EAAC,OAAO,CAAC;YAC1D,gBAAgB,EAAE,YAAY,CAAC,IAAI,CAAC;YAEpC,+DAA+D;YAC/D,gBAAgB,EAAE,OAAO,CAAC,KAAK,CAAC;YAEhC,uBAAuB,EAAE,YAAY,EAAE;YACvC,mBAAmB,EAAE,IAAA,4CAAoC,EAAC,OAAO,CAAC;YAClE,qBAAqB,EAAE,IAAA,8CAAsC,EAAC,OAAO,CAAC;YACtE,sBAAsB,EAAE,IAAA,+CAAuC,EAAC,OAAO,CAAC;YACxE,eAAe,EAAE,IAAA,8CAAsC,EAAC,OAAO,CAAC;YAChE,eAAe,EAAE,IAAA,wCAAgC,EAAC,mBAAmB,CAAC;YACtE,YAAY,EAAE,IAAA,qCAA6B,EAAC,mBAAmB,CAAC;SACjE,CAAC;KACH,CAAC;AACJ,CAAC;AA9BD,kEA8BC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,aAAa,CACjC,oBAAiD,EACjD,MAAc;IAEd,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,+CAA2B,CAAC,CAAC,MAAM,CAEzE,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE;QAClC,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC;QAClC,IAAI,oBAAoB,CAAC,aAAa,CAAC,MAAM,EAAE,cAAc,CAAC,EAAE,CAAC;YAC/D,MAAM,UAAU,GAAG,MAAM,oBAAoB,CAAC,aAAa,CACzD,MAAM,EACN,cAAc,CACf,CAAC;YAEF,IAAI,UAAU,EAAE,CAAC;gBACf,OAAO,WAAW,CAAC,MAAM,CAAC,UAAsB,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IAExB,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,gCAAkB,EAAE,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AACjE,CAAC;AAvBD,sCAuBC","sourcesContent":["import type { GenericPermissionController } from '@metamask/permission-controller';\nimport {\n  endowmentPermissionBuilders,\n  buildSnapEndowmentSpecifications,\n  buildSnapRestrictedMethodSpecifications,\n} from '@metamask/snaps-rpc-methods';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport { DEFAULT_ENDOWMENTS } from '@metamask/snaps-utils';\n\nimport type { RootControllerMessenger } from '../controllers';\nimport type { SimulationOptions } from '../options';\nimport type { RunSagaFunction } from '../store';\nimport {\n  EXCLUDED_SNAP_ENDOWMENTS,\n  EXCLUDED_SNAP_PERMISSIONS,\n} from './constants';\nimport {\n  getGetPreferencesMethodImplementation,\n  getClearSnapStateMethodImplementation,\n  getGetSnapStateMethodImplementation,\n  getUpdateSnapStateMethodImplementation,\n  getShowInAppNotificationImplementation,\n  getShowNativeNotificationImplementation,\n  getCreateInterfaceImplementation,\n  getGetInterfaceImplementation,\n  getRequestUserApprovalImplementation,\n} from './hooks';\n\nexport type PermissionSpecificationsHooks = {\n  /**\n   * A hook that returns the user's secret recovery phrase.\n   *\n   * @returns The user's secret recovery phrase.\n   */\n  getMnemonic: () => Promise<Uint8Array>;\n};\n\nexport type GetPermissionSpecificationsOptions = {\n  controllerMessenger: RootControllerMessenger;\n  hooks: PermissionSpecificationsHooks;\n  runSaga: RunSagaFunction;\n  options: SimulationOptions;\n};\n\n/**\n * Get a function which resolves with the specified result.\n *\n * @param result - The result to return.\n * @returns The function implementation.\n */\nexport function resolve(result: unknown) {\n  return () => result;\n}\n\n/**\n * Get a function which resolves with the specified result.\n *\n * @param result - The result to return. If not specified, the function will\n * resolve with `undefined`.\n * @returns The function implementation.\n */\nexport function asyncResolve<Type>(result?: Type) {\n  return async () => result;\n}\n\n/**\n * Get the permission specifications for the Snap.\n *\n * @param options - The options.\n * @param options.controllerMessenger - The controller messenger.\n * @param options.hooks - The hooks.\n * @param options.runSaga - The function to run a saga outside the usual Redux\n * flow.\n * @param options.options - The simulation options.\n * @returns The permission specifications for the Snap.\n */\nexport function getPermissionSpecifications({\n  controllerMessenger,\n  hooks,\n  runSaga,\n  options,\n}: GetPermissionSpecificationsOptions) {\n  return {\n    ...buildSnapEndowmentSpecifications(EXCLUDED_SNAP_ENDOWMENTS),\n    ...buildSnapRestrictedMethodSpecifications(EXCLUDED_SNAP_PERMISSIONS, {\n      // Shared hooks.\n      ...hooks,\n\n      // Snaps-specific hooks.\n      clearSnapState: getClearSnapStateMethodImplementation(runSaga),\n      getPreferences: getGetPreferencesMethodImplementation(options),\n      getSnapState: getGetSnapStateMethodImplementation(runSaga),\n      getUnlockPromise: asyncResolve(true),\n\n      // TODO: Allow the user to specify the result of this function.\n      isOnPhishingList: resolve(false),\n\n      maybeUpdatePhishingList: asyncResolve(),\n      requestUserApproval: getRequestUserApprovalImplementation(runSaga),\n      showInAppNotification: getShowInAppNotificationImplementation(runSaga),\n      showNativeNotification: getShowNativeNotificationImplementation(runSaga),\n      updateSnapState: getUpdateSnapStateMethodImplementation(runSaga),\n      createInterface: getCreateInterfaceImplementation(controllerMessenger),\n      getInterface: getGetInterfaceImplementation(controllerMessenger),\n    }),\n  };\n}\n\n/**\n * Get the endowments for the Snap.\n *\n * @param permissionController - The permission controller.\n * @param snapId - The ID of the Snap.\n * @returns The endowments for the Snap.\n */\nexport async function getEndowments(\n  permissionController: GenericPermissionController,\n  snapId: SnapId,\n) {\n  const allEndowments = await Object.keys(endowmentPermissionBuilders).reduce<\n    Promise<string[]>\n  >(async (promise, permissionName) => {\n    const accumulator = await promise;\n    if (permissionController.hasPermission(snapId, permissionName)) {\n      const endowments = await permissionController.getEndowments(\n        snapId,\n        permissionName,\n      );\n\n      if (endowments) {\n        return accumulator.concat(endowments as string[]);\n      }\n    }\n\n    return accumulator;\n  }, Promise.resolve([]));\n\n  return [...new Set([...DEFAULT_ENDOWMENTS, ...allEndowments])];\n}\n"]}

package/dist/methods/specifications.d.cts

@@ -31,7 +31,7 @@ export declare function resolve(result: unknown): () => unknown;
  * resolve with `undefined`.
  * @returns The function implementation.
  */
-export declare function asyncResolve(result?: unknown): () => Promise<unknown>;
+export declare function asyncResolve<Type>(result?: Type): () => Promise<Type | undefined>;
 /**
  * Get the permission specifications for the Snap.
  *

package/dist/methods/specifications.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"specifications.d.cts","sourceRoot":"","sources":["../../src/methods/specifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,wCAAwC;AAMnF,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAGlD,OAAO,KAAK,EAAE,uBAAuB,EAAE,2BAAuB;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,uBAAmB;AACpD,OAAO,KAAK,EAAE,eAAe,EAAE,2BAAiB;AAiBhD,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;;OAIG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,mBAAmB,EAAE,uBAAuB,CAAC;IAC7C,KAAK,EAAE,6BAA6B,CAAC;IACrC,OAAO,EAAE,eAAe,CAAC;IACzB,OAAO,EAAE,iBAAiB,CAAC;CAC5B,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,iBAEtC;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,MAAM,CAAC,EAAE,OAAO,0BAE5C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,2BAA2B,CAAC,EAC1C,mBAAmB,EACnB,KAAK,EACL,OAAO,EACP,OAAO,GACR,EAAE,kCAAkC;;EAyBpC;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,CACjC,oBAAoB,EAAE,2BAA2B,EACjD,MAAM,EAAE,MAAM,qBAqBf"}
+{"version":3,"file":"specifications.d.cts","sourceRoot":"","sources":["../../src/methods/specifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,wCAAwC;AAMnF,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAGlD,OAAO,KAAK,EAAE,uBAAuB,EAAE,2BAAuB;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,uBAAmB;AACpD,OAAO,KAAK,EAAE,eAAe,EAAE,2BAAiB;AAiBhD,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;;OAIG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,mBAAmB,EAAE,uBAAuB,CAAC;IAC7C,KAAK,EAAE,6BAA6B,CAAC;IACrC,OAAO,EAAE,eAAe,CAAC;IACzB,OAAO,EAAE,iBAAiB,CAAC;CAC5B,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,iBAEtC;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,IAAI,mCAE/C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,2BAA2B,CAAC,EAC1C,mBAAmB,EACnB,KAAK,EACL,OAAO,EACP,OAAO,GACR,EAAE,kCAAkC;;EAyBpC;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,CACjC,oBAAoB,EAAE,2BAA2B,EACjD,MAAM,EAAE,MAAM,qBAqBf"}

package/dist/methods/specifications.d.mts

@@ -31,7 +31,7 @@ export declare function resolve(result: unknown): () => unknown;
  * resolve with `undefined`.
  * @returns The function implementation.
  */
-export declare function asyncResolve(result?: unknown): () => Promise<unknown>;
+export declare function asyncResolve<Type>(result?: Type): () => Promise<Type | undefined>;
 /**
  * Get the permission specifications for the Snap.
  *

package/dist/methods/specifications.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"specifications.d.mts","sourceRoot":"","sources":["../../src/methods/specifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,wCAAwC;AAMnF,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAGlD,OAAO,KAAK,EAAE,uBAAuB,EAAE,2BAAuB;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,uBAAmB;AACpD,OAAO,KAAK,EAAE,eAAe,EAAE,2BAAiB;AAiBhD,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;;OAIG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,mBAAmB,EAAE,uBAAuB,CAAC;IAC7C,KAAK,EAAE,6BAA6B,CAAC;IACrC,OAAO,EAAE,eAAe,CAAC;IACzB,OAAO,EAAE,iBAAiB,CAAC;CAC5B,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,iBAEtC;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,MAAM,CAAC,EAAE,OAAO,0BAE5C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,2BAA2B,CAAC,EAC1C,mBAAmB,EACnB,KAAK,EACL,OAAO,EACP,OAAO,GACR,EAAE,kCAAkC;;EAyBpC;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,CACjC,oBAAoB,EAAE,2BAA2B,EACjD,MAAM,EAAE,MAAM,qBAqBf"}
+{"version":3,"file":"specifications.d.mts","sourceRoot":"","sources":["../../src/methods/specifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,wCAAwC;AAMnF,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAGlD,OAAO,KAAK,EAAE,uBAAuB,EAAE,2BAAuB;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,uBAAmB;AACpD,OAAO,KAAK,EAAE,eAAe,EAAE,2BAAiB;AAiBhD,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;;OAIG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,mBAAmB,EAAE,uBAAuB,CAAC;IAC7C,KAAK,EAAE,6BAA6B,CAAC;IACrC,OAAO,EAAE,eAAe,CAAC;IACzB,OAAO,EAAE,iBAAiB,CAAC;CAC5B,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,iBAEtC;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,IAAI,mCAE/C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,2BAA2B,CAAC,EAC1C,mBAAmB,EACnB,KAAK,EACL,OAAO,EACP,OAAO,GACR,EAAE,kCAAkC;;EAyBpC;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,CACjC,oBAAoB,EAAE,2BAA2B,EACjD,MAAM,EAAE,MAAM,qBAqBf"}