@metamask/snaps-rpc-methods 5.0.0 → 6.0.0

package/dist/esm/permitted/updateInterface.js

@@ -0,0 +1,60 @@
+import { rpcErrors } from '@metamask/rpc-errors';
+import { ComponentStruct } from '@metamask/snaps-sdk';
+import { StructError, create, object, string } from 'superstruct';
+const hookNames = {
+    updateInterface: true
+};
+export const updateInterfaceHandler = {
+    methodNames: [
+        'snap_updateInterface'
+    ],
+    implementation: getUpdateInterfaceImplementation,
+    hookNames
+};
+const UpdateInterfaceParametersStruct = object({
+    id: string(),
+    ui: ComponentStruct
+});
+/**
+ * The `snap_updateInterface` method implementation.
+ *
+ * @param req - The JSON-RPC request object.
+ * @param res - The JSON-RPC response object.
+ * @param _next - The `json-rpc-engine` "next" callback. Not used by this
+ * function.
+ * @param end - The `json-rpc-engine` "end" callback.
+ * @param hooks - The RPC method hooks.
+ * @param hooks.updateInterface - The function to update the interface.
+ * @returns Nothing.
+ */ async function getUpdateInterfaceImplementation(req, res, _next, end, { updateInterface }) {
+    const { params } = req;
+    try {
+        const validatedParams = getValidatedParams(params);
+        const { id, ui } = validatedParams;
+        await updateInterface(id, ui);
+        res.result = null;
+    } catch (error) {
+        return end(error);
+    }
+    return end();
+}
+/**
+ * Validate the updateInterface method `params` and returns them cast to the correct
+ * type. Throws if validation fails.
+ *
+ * @param params - The unvalidated params object from the method request.
+ * @returns The validated updateInterface method parameter object.
+ */ function getValidatedParams(params) {
+    try {
+        return create(params, UpdateInterfaceParametersStruct);
+    } catch (error) {
+        if (error instanceof StructError) {
+            throw rpcErrors.invalidParams({
+                message: `Invalid params: ${error.message}.`
+            });
+        }
+        /* istanbul ignore next */ throw rpcErrors.internal();
+    }
+}
+
+//# sourceMappingURL=updateInterface.js.map

package/dist/esm/permitted/updateInterface.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/permitted/updateInterface.ts"],"sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type {\n  Component,\n  UpdateInterfaceParams,\n  UpdateInterfaceResult,\n  JsonRpcRequest,\n} from '@metamask/snaps-sdk';\nimport { ComponentStruct } from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\nimport { StructError, create, object, string } from 'superstruct';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<UpdateInterfaceMethodHooks> = {\n  updateInterface: true,\n};\n\nexport type UpdateInterfaceMethodHooks = {\n  /**\n   * @param id - The interface ID.\n   * @param ui - The UI components.\n   */\n  updateInterface: (id: string, ui: Component) => Promise<void>;\n};\n\nexport const updateInterfaceHandler: PermittedHandlerExport<\n  UpdateInterfaceMethodHooks,\n  UpdateInterfaceParameters,\n  UpdateInterfaceResult\n> = {\n  methodNames: ['snap_updateInterface'],\n  implementation: getUpdateInterfaceImplementation,\n  hookNames,\n};\n\nconst UpdateInterfaceParametersStruct = object({\n  id: string(),\n  ui: ComponentStruct,\n});\n\nexport type UpdateInterfaceParameters = InferMatching<\n  typeof UpdateInterfaceParametersStruct,\n  UpdateInterfaceParams\n>;\n\n/**\n * The `snap_updateInterface` method implementation.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.updateInterface - The function to update the interface.\n * @returns Nothing.\n */\nasync function getUpdateInterfaceImplementation(\n  req: JsonRpcRequest<UpdateInterfaceParameters>,\n  res: PendingJsonRpcResponse<UpdateInterfaceResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { updateInterface }: UpdateInterfaceMethodHooks,\n): Promise<void> {\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { id, ui } = validatedParams;\n\n    await updateInterface(id, ui);\n    res.result = null;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the updateInterface method `params` and returns them cast to the correct\n * type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @returns The validated updateInterface method parameter object.\n */\nfunction getValidatedParams(params: unknown): UpdateInterfaceParameters {\n  try {\n    return create(params, UpdateInterfaceParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"],"names":["rpcErrors","ComponentStruct","StructError","create","object","string","hookNames","updateInterface","updateInterfaceHandler","methodNames","implementation","getUpdateInterfaceImplementation","UpdateInterfaceParametersStruct","id","ui","req","res","_next","end","params","validatedParams","getValidatedParams","result","error","invalidParams","message","internal"],"mappings":"AAEA,SAASA,SAAS,QAAQ,uBAAuB;AAOjD,SAASC,eAAe,QAAQ,sBAAsB;AAGtD,SAASC,WAAW,EAAEC,MAAM,EAAEC,MAAM,EAAEC,MAAM,QAAQ,cAAc;AAIlE,MAAMC,YAA2D;IAC/DC,iBAAiB;AACnB;AAUA,OAAO,MAAMC,yBAIT;IACFC,aAAa;QAAC;KAAuB;IACrCC,gBAAgBC;IAChBL;AACF,EAAE;AAEF,MAAMM,kCAAkCR,OAAO;IAC7CS,IAAIR;IACJS,IAAIb;AACN;AAOA;;;;;;;;;;;CAWC,GACD,eAAeU,iCACbI,GAA8C,EAC9CC,GAAkD,EAClDC,KAAc,EACdC,GAA6B,EAC7B,EAAEX,eAAe,EAA8B;IAE/C,MAAM,EAAEY,MAAM,EAAE,GAAGJ;IAEnB,IAAI;QACF,MAAMK,kBAAkBC,mBAAmBF;QAE3C,MAAM,EAAEN,EAAE,EAAEC,EAAE,EAAE,GAAGM;QAEnB,MAAMb,gBAAgBM,IAAIC;QAC1BE,IAAIM,MAAM,GAAG;IACf,EAAE,OAAOC,OAAO;QACd,OAAOL,IAAIK;IACb;IAEA,OAAOL;AACT;AAEA;;;;;;CAMC,GACD,SAASG,mBAAmBF,MAAe;IACzC,IAAI;QACF,OAAOhB,OAAOgB,QAAQP;IACxB,EAAE,OAAOW,OAAO;QACd,IAAIA,iBAAiBrB,aAAa;YAChC,MAAMF,UAAUwB,aAAa,CAAC;gBAC5BC,SAAS,CAAC,gBAAgB,EAAEF,MAAME,OAAO,CAAC,CAAC,CAAC;YAC9C;QACF;QACA,wBAAwB,GACxB,MAAMzB,UAAU0B,QAAQ;IAC1B;AACF"}

package/dist/esm/restricted/dialog.js

@@ -1,8 +1,9 @@
 import { PermissionType, SubjectType } from '@metamask/permission-controller';
 import { rpcErrors } from '@metamask/rpc-errors';
-import { DialogType, ComponentStruct, enumValue } from '@metamask/snaps-sdk';
-import { validateComponentLinks } from '@metamask/snaps-utils';
-import { create, enums, object, optional, size, string, StructError, type, union } from 'superstruct';
+import { DialogType, ComponentStruct, enumValue, union } from '@metamask/snaps-sdk';
+import { createUnion } from '@metamask/snaps-utils';
+import { hasProperty } from '@metamask/utils';
+import { create, enums, object, optional, size, string, type } from 'superstruct';
 const methodName = 'snap_dialog';
 const PlaceholderStruct = optional(size(string(), 1, 40));
 /**
@@ -31,8 +32,8 @@ const PlaceholderStruct = optional(size(string(), 1, 40));
 };
 const methodHooks = {
     showDialog: true,
-    isOnPhishingList: true,
-    maybeUpdatePhishingList: true
+    createInterface: true,
+    getInterface: true
 };
 export const dialogBuilder = Object.freeze({
     targetName: methodName,
@@ -48,19 +49,44 @@ const BaseParamsStruct = type({
         DialogType.Prompt
     ])
 });
-const AlertParametersStruct = object({
+const AlertParametersWithContentStruct = object({
     type: enumValue(DialogType.Alert),
     content: ComponentStruct
 });
-const ConfirmationParametersStruct = object({
+const AlertParametersWithIdStruct = object({
+    type: enumValue(DialogType.Alert),
+    id: string()
+});
+const AlertParametersStruct = union([
+    AlertParametersWithContentStruct,
+    AlertParametersWithIdStruct
+]);
+const ConfirmationParametersWithContentStruct = object({
     type: enumValue(DialogType.Confirmation),
     content: ComponentStruct
 });
-const PromptParametersStruct = object({
+const ConfirmationParametersWithIdStruct = object({
+    type: enumValue(DialogType.Confirmation),
+    id: string()
+});
+const ConfirmationParametersStruct = union([
+    ConfirmationParametersWithContentStruct,
+    ConfirmationParametersWithIdStruct
+]);
+const PromptParametersWithContentStruct = object({
     type: enumValue(DialogType.Prompt),
     content: ComponentStruct,
     placeholder: PlaceholderStruct
 });
+const PromptParametersWithIdStruct = object({
+    type: enumValue(DialogType.Prompt),
+    id: string(),
+    placeholder: PlaceholderStruct
+});
+const PromptParametersStruct = union([
+    PromptParametersWithContentStruct,
+    PromptParametersWithIdStruct
+]);
 const DialogParametersStruct = union([
     AlertParametersStruct,
     ConfirmationParametersStruct,
@@ -77,21 +103,30 @@ const structs = {
  * @param hooks - The RPC method hooks.
  * @param hooks.showDialog - A function that shows the specified dialog in the
  * MetaMask UI and returns the appropriate value for the dialog type.
- * @param hooks.isOnPhishingList - A function that checks a link against the
- * phishing list and return true if it's in, otherwise false.
- * @param hooks.maybeUpdatePhishingList - A function that updates the phishing list if needed.
+ * @param hooks.createInterface - A function that creates the interface in SnapInterfaceController.
+ * @param hooks.getInterface - A function that gets an interface from SnapInterfaceController.
  * @returns The method implementation which return value depends on the dialog
  * type, valid return types are: string, boolean, null.
- */ export function getDialogImplementation({ showDialog, isOnPhishingList, maybeUpdatePhishingList }) {
+ */ export function getDialogImplementation({ showDialog, createInterface, getInterface }) {
     return async function dialogImplementation(args) {
         const { params, context: { origin } } = args;
         const validatedType = getValidatedType(params);
         const validatedParams = getValidatedParams(params, structs[validatedType]);
-        const { content } = validatedParams;
-        await maybeUpdatePhishingList();
-        validateComponentLinks(content, isOnPhishingList);
         const placeholder = validatedParams.type === DialogType.Prompt ? validatedParams.placeholder : undefined;
-        return showDialog(origin, validatedType, content, placeholder);
+        if (hasProperty(validatedParams, 'content')) {
+            const id = await createInterface(origin, validatedParams.content);
+            return showDialog(origin, validatedType, id, placeholder);
+        }
+        // Verify that the passed interface ID is valid.
+        // This will throw if the interface ID is invalid (not created by the snap or doesn't exist)
+        try {
+            getInterface(origin, validatedParams.id);
+        } catch (error) {
+            throw rpcErrors.invalidParams({
+                message: `Invalid params: ${error.message}`
+            });
+        }
+        return showDialog(origin, validatedType, validatedParams.id, placeholder);
     };
 }
 /**
@@ -118,20 +153,11 @@ const structs = {
  * @returns The validated confirm method parameter object.
  */ function getValidatedParams(params, struct) {
     try {
-        return create(params, struct);
+        return createUnion(params, struct, 'type');
     } catch (error) {
-        if (error instanceof StructError) {
-            const { key, type: errorType } = error;
-            if (key === 'placeholder' && errorType === 'never') {
-                throw rpcErrors.invalidParams({
-                    message: 'Invalid params: Alerts or confirmations may not specify a "placeholder" field.'
-                });
-            }
-            throw rpcErrors.invalidParams({
-                message: `Invalid params: ${error.message}.`
-            });
-        }
-        /* istanbul ignore next */ throw rpcErrors.internal();
+        throw rpcErrors.invalidParams({
+            message: `Invalid params: ${error.message}`
+        });
     }
 }
 

package/dist/esm/restricted/dialog.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/restricted/dialog.ts"],"sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  RestrictedMethodOptions,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { DialogType, ComponentStruct, enumValue } from '@metamask/snaps-sdk';\nimport type { DialogParams, EnumToUnion, Component } from '@metamask/snaps-sdk';\nimport { validateComponentLinks } from '@metamask/snaps-utils';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport type { NonEmptyArray } from '@metamask/utils';\nimport type { Infer, Struct } from 'superstruct';\nimport {\n  create,\n  enums,\n  object,\n  optional,\n  size,\n  string,\n  StructError,\n  type,\n  union,\n} from 'superstruct';\n\nimport { type MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_dialog';\n\nconst PlaceholderStruct = optional(size(string(), 1, 40));\n\nexport type Placeholder = Infer<typeof PlaceholderStruct>;\n\ntype ShowDialog = (\n  snapId: string,\n  type: EnumToUnion<DialogType>,\n  content: Component,\n  placeholder?: Placeholder,\n) => Promise<null | boolean | string>;\n\ntype MaybeUpdatePhisingList = () => Promise<void>;\ntype IsOnPhishingList = (url: string) => boolean;\n\nexport type DialogMethodHooks = {\n  /**\n   * @param snapId - The ID of the Snap that created the alert.\n   * @param type - The dialog type.\n   * @param content - The dialog custom UI.\n   * @param placeholder - The placeholder for the Prompt dialog input.\n   */\n  showDialog: ShowDialog;\n\n  maybeUpdatePhishingList: MaybeUpdatePhisingList;\n\n  /**\n   * @param url - The URL to check against the phishing list.\n   */\n  isOnPhishingList: IsOnPhishingList;\n};\n\ntype DialogSpecificationBuilderOptions = {\n  allowedCaveats?: Readonly<NonEmptyArray<string>> | null;\n  methodHooks: DialogMethodHooks;\n};\n\ntype DialogSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.RestrictedMethod;\n  targetName: typeof methodName;\n  methodImplementation: ReturnType<typeof getDialogImplementation>;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n}>;\n\n/**\n * The specification builder for the `snap_dialog` permission. `snap_dialog`\n * lets the Snap display one of the following dialogs to the user:\n * - An alert, for displaying information.\n * - A confirmation, for accepting or rejecting some action.\n * - A prompt, for inputting some information.\n *\n * @param options - The specification builder options.\n * @param options.allowedCaveats - The optional allowed caveats for the\n * permission.\n * @param options.methodHooks - The RPC method hooks needed by the method\n * implementation.\n * @returns The specification for the `snap_dialog` permission.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.RestrictedMethod,\n  DialogSpecificationBuilderOptions,\n  DialogSpecification\n> = ({\n  allowedCaveats = null,\n  methodHooks,\n}: DialogSpecificationBuilderOptions) => {\n  return {\n    permissionType: PermissionType.RestrictedMethod,\n    targetName: methodName,\n    allowedCaveats,\n    methodImplementation: getDialogImplementation(methodHooks),\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nconst methodHooks: MethodHooksObject<DialogMethodHooks> = {\n  showDialog: true,\n  isOnPhishingList: true,\n  maybeUpdatePhishingList: true,\n};\n\nexport const dialogBuilder = Object.freeze({\n  targetName: methodName,\n  specificationBuilder,\n  methodHooks,\n} as const);\n\n// Note: We use `type` here instead of `object` because `type` does not validate\n// the keys of the object, which is what we want.\nconst BaseParamsStruct = type({\n  type: enums([DialogType.Alert, DialogType.Confirmation, DialogType.Prompt]),\n});\n\nconst AlertParametersStruct = object({\n  type: enumValue(DialogType.Alert),\n  content: ComponentStruct,\n});\n\nconst ConfirmationParametersStruct = object({\n  type: enumValue(DialogType.Confirmation),\n  content: ComponentStruct,\n});\n\nconst PromptParametersStruct = object({\n  type: enumValue(DialogType.Prompt),\n  content: ComponentStruct,\n  placeholder: PlaceholderStruct,\n});\n\nconst DialogParametersStruct = union([\n  AlertParametersStruct,\n  ConfirmationParametersStruct,\n  PromptParametersStruct,\n]);\n\nexport type DialogParameters = InferMatching<\n  typeof DialogParametersStruct,\n  DialogParams\n>;\n\nconst structs = {\n  [DialogType.Alert]: AlertParametersStruct,\n  [DialogType.Confirmation]: ConfirmationParametersStruct,\n  [DialogType.Prompt]: PromptParametersStruct,\n};\n\n/**\n * Builds the method implementation for `snap_dialog`.\n *\n * @param hooks - The RPC method hooks.\n * @param hooks.showDialog - A function that shows the specified dialog in the\n * MetaMask UI and returns the appropriate value for the dialog type.\n * @param hooks.isOnPhishingList - A function that checks a link against the\n * phishing list and return true if it's in, otherwise false.\n * @param hooks.maybeUpdatePhishingList - A function that updates the phishing list if needed.\n * @returns The method implementation which return value depends on the dialog\n * type, valid return types are: string, boolean, null.\n */\nexport function getDialogImplementation({\n  showDialog,\n  isOnPhishingList,\n  maybeUpdatePhishingList,\n}: DialogMethodHooks) {\n  return async function dialogImplementation(\n    args: RestrictedMethodOptions<DialogParameters>,\n  ): Promise<boolean | null | string> {\n    const {\n      params,\n      context: { origin },\n    } = args;\n\n    const validatedType = getValidatedType(params);\n    const validatedParams = getValidatedParams(params, structs[validatedType]);\n\n    const { content } = validatedParams;\n\n    await maybeUpdatePhishingList();\n\n    validateComponentLinks(content, isOnPhishingList);\n\n    const placeholder =\n      validatedParams.type === DialogType.Prompt\n        ? validatedParams.placeholder\n        : undefined;\n\n    return showDialog(origin, validatedType, content, placeholder);\n  };\n}\n\n/**\n * Get the validated type of the dialog parameters. Throws an error if the type\n * is invalid.\n *\n * @param params - The parameters to validate.\n * @returns The validated type of the dialog parameters.\n */\nfunction getValidatedType(params: unknown): DialogType {\n  try {\n    return create(params, BaseParamsStruct).type;\n  } catch (error) {\n    throw rpcErrors.invalidParams({\n      message: `The \"type\" property must be one of: ${Object.values(\n        DialogType,\n      ).join(', ')}.`,\n    });\n  }\n}\n\n/**\n * Validates the confirm method `params` and returns them cast to the correct\n * type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @param struct - The struct to validate the params against.\n * @returns The validated confirm method parameter object.\n */\nfunction getValidatedParams(\n  params: unknown,\n  struct: Struct<any>,\n): DialogParameters {\n  try {\n    return create(params, struct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      const { key, type: errorType } = error;\n\n      if (key === 'placeholder' && errorType === 'never') {\n        throw rpcErrors.invalidParams({\n          message:\n            'Invalid params: Alerts or confirmations may not specify a \"placeholder\" field.',\n        });\n      }\n\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"],"names":["PermissionType","SubjectType","rpcErrors","DialogType","ComponentStruct","enumValue","validateComponentLinks","create","enums","object","optional","size","string","StructError","type","union","methodName","PlaceholderStruct","specificationBuilder","allowedCaveats","methodHooks","permissionType","RestrictedMethod","targetName","methodImplementation","getDialogImplementation","subjectTypes","Snap","showDialog","isOnPhishingList","maybeUpdatePhishingList","dialogBuilder","Object","freeze","BaseParamsStruct","Alert","Confirmation","Prompt","AlertParametersStruct","content","ConfirmationParametersStruct","PromptParametersStruct","placeholder","DialogParametersStruct","structs","dialogImplementation","args","params","context","origin","validatedType","getValidatedType","validatedParams","getValidatedParams","undefined","error","invalidParams","message","values","join","struct","key","errorType","internal"],"mappings":"AAKA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAC9E,SAASC,SAAS,QAAQ,uBAAuB;AACjD,SAASC,UAAU,EAAEC,eAAe,EAAEC,SAAS,QAAQ,sBAAsB;AAE7E,SAASC,sBAAsB,QAAQ,wBAAwB;AAI/D,SACEC,MAAM,EACNC,KAAK,EACLC,MAAM,EACNC,QAAQ,EACRC,IAAI,EACJC,MAAM,EACNC,WAAW,EACXC,IAAI,EACJC,KAAK,QACA,cAAc;AAIrB,MAAMC,aAAa;AAEnB,MAAMC,oBAAoBP,SAASC,KAAKC,UAAU,GAAG;AA2CrD;;;;;;;;;;;;;CAaC,GACD,MAAMM,uBAIF,CAAC,EACHC,iBAAiB,IAAI,EACrBC,WAAW,EACuB;IAClC,OAAO;QACLC,gBAAgBrB,eAAesB,gBAAgB;QAC/CC,YAAYP;QACZG;QACAK,sBAAsBC,wBAAwBL;QAC9CM,cAAc;YAACzB,YAAY0B,IAAI;SAAC;IAClC;AACF;AAEA,MAAMP,cAAoD;IACxDQ,YAAY;IACZC,kBAAkB;IAClBC,yBAAyB;AAC3B;AAEA,OAAO,MAAMC,gBAAgBC,OAAOC,MAAM,CAAC;IACzCV,YAAYP;IACZE;IACAE;AACF,GAAY;AAEZ,gFAAgF;AAChF,iDAAiD;AACjD,MAAMc,mBAAmBpB,KAAK;IAC5BA,MAAMN,MAAM;QAACL,WAAWgC,KAAK;QAAEhC,WAAWiC,YAAY;QAAEjC,WAAWkC,MAAM;KAAC;AAC5E;AAEA,MAAMC,wBAAwB7B,OAAO;IACnCK,MAAMT,UAAUF,WAAWgC,KAAK;IAChCI,SAASnC;AACX;AAEA,MAAMoC,+BAA+B/B,OAAO;IAC1CK,MAAMT,UAAUF,WAAWiC,YAAY;IACvCG,SAASnC;AACX;AAEA,MAAMqC,yBAAyBhC,OAAO;IACpCK,MAAMT,UAAUF,WAAWkC,MAAM;IACjCE,SAASnC;IACTsC,aAAazB;AACf;AAEA,MAAM0B,yBAAyB5B,MAAM;IACnCuB;IACAE;IACAC;CACD;AAOD,MAAMG,UAAU;IACd,CAACzC,WAAWgC,KAAK,CAAC,EAAEG;IACpB,CAACnC,WAAWiC,YAAY,CAAC,EAAEI;IAC3B,CAACrC,WAAWkC,MAAM,CAAC,EAAEI;AACvB;AAEA;;;;;;;;;;;CAWC,GACD,OAAO,SAAShB,wBAAwB,EACtCG,UAAU,EACVC,gBAAgB,EAChBC,uBAAuB,EACL;IAClB,OAAO,eAAee,qBACpBC,IAA+C;QAE/C,MAAM,EACJC,MAAM,EACNC,SAAS,EAAEC,MAAM,EAAE,EACpB,GAAGH;QAEJ,MAAMI,gBAAgBC,iBAAiBJ;QACvC,MAAMK,kBAAkBC,mBAAmBN,QAAQH,OAAO,CAACM,cAAc;QAEzE,MAAM,EAAEX,OAAO,EAAE,GAAGa;QAEpB,MAAMtB;QAENxB,uBAAuBiC,SAASV;QAEhC,MAAMa,cACJU,gBAAgBtC,IAAI,KAAKX,WAAWkC,MAAM,GACtCe,gBAAgBV,WAAW,GAC3BY;QAEN,OAAO1B,WAAWqB,QAAQC,eAAeX,SAASG;IACpD;AACF;AAEA;;;;;;CAMC,GACD,SAASS,iBAAiBJ,MAAe;IACvC,IAAI;QACF,OAAOxC,OAAOwC,QAAQb,kBAAkBpB,IAAI;IAC9C,EAAE,OAAOyC,OAAO;QACd,MAAMrD,UAAUsD,aAAa,CAAC;YAC5BC,SAAS,CAAC,oCAAoC,EAAEzB,OAAO0B,MAAM,CAC3DvD,YACAwD,IAAI,CAAC,MAAM,CAAC,CAAC;QACjB;IACF;AACF;AAEA;;;;;;;CAOC,GACD,SAASN,mBACPN,MAAe,EACfa,MAAmB;IAEnB,IAAI;QACF,OAAOrD,OAAOwC,QAAQa;IACxB,EAAE,OAAOL,OAAO;QACd,IAAIA,iBAAiB1C,aAAa;YAChC,MAAM,EAAEgD,GAAG,EAAE/C,MAAMgD,SAAS,EAAE,GAAGP;YAEjC,IAAIM,QAAQ,iBAAiBC,cAAc,SAAS;gBAClD,MAAM5D,UAAUsD,aAAa,CAAC;oBAC5BC,SACE;gBACJ;YACF;YAEA,MAAMvD,UAAUsD,aAAa,CAAC;gBAC5BC,SAAS,CAAC,gBAAgB,EAAEF,MAAME,OAAO,CAAC,CAAC,CAAC;YAC9C;QACF;QAEA,wBAAwB,GACxB,MAAMvD,UAAU6D,QAAQ;IAC1B;AACF"}
+{"version":3,"sources":["../../../src/restricted/dialog.ts"],"sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  RestrictedMethodOptions,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport {\n  DialogType,\n  ComponentStruct,\n  enumValue,\n  union,\n} from '@metamask/snaps-sdk';\nimport type {\n  DialogParams,\n  EnumToUnion,\n  Component,\n  InterfaceState,\n  SnapId,\n} from '@metamask/snaps-sdk';\nimport { createUnion } from '@metamask/snaps-utils';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport { hasProperty, type NonEmptyArray } from '@metamask/utils';\nimport type { Infer, Struct } from 'superstruct';\nimport {\n  create,\n  enums,\n  object,\n  optional,\n  size,\n  string,\n  type,\n} from 'superstruct';\n\nimport { type MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_dialog';\n\nconst PlaceholderStruct = optional(size(string(), 1, 40));\n\nexport type Placeholder = Infer<typeof PlaceholderStruct>;\n\ntype ShowDialog = (\n  snapId: string,\n  type: EnumToUnion<DialogType>,\n  id: string,\n  placeholder?: Placeholder,\n) => Promise<null | boolean | string>;\n\ntype CreateInterface = (snapId: string, content: Component) => Promise<string>;\ntype GetInterface = (\n  snapId: string,\n  id: string,\n) => { content: Component; snapId: SnapId; state: InterfaceState };\n\nexport type DialogMethodHooks = {\n  /**\n   * @param snapId - The ID of the Snap that created the alert.\n   * @param type - The dialog type.\n   * @param id - The interface ID.\n   * @param placeholder - The placeholder for the Prompt dialog input.\n   */\n  showDialog: ShowDialog;\n\n  /**\n   * @param snapId - The Snap ID creating the interface.\n   * @param content - The content of the interface.\n   */\n  createInterface: CreateInterface;\n  /**\n   * @param snapId - The SnapId requesting the interface.\n   * @param id - The interface ID.\n   */\n  getInterface: GetInterface;\n};\n\ntype DialogSpecificationBuilderOptions = {\n  allowedCaveats?: Readonly<NonEmptyArray<string>> | null;\n  methodHooks: DialogMethodHooks;\n};\n\ntype DialogSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.RestrictedMethod;\n  targetName: typeof methodName;\n  methodImplementation: ReturnType<typeof getDialogImplementation>;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n}>;\n\n/**\n * The specification builder for the `snap_dialog` permission. `snap_dialog`\n * lets the Snap display one of the following dialogs to the user:\n * - An alert, for displaying information.\n * - A confirmation, for accepting or rejecting some action.\n * - A prompt, for inputting some information.\n *\n * @param options - The specification builder options.\n * @param options.allowedCaveats - The optional allowed caveats for the\n * permission.\n * @param options.methodHooks - The RPC method hooks needed by the method\n * implementation.\n * @returns The specification for the `snap_dialog` permission.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.RestrictedMethod,\n  DialogSpecificationBuilderOptions,\n  DialogSpecification\n> = ({\n  allowedCaveats = null,\n  methodHooks,\n}: DialogSpecificationBuilderOptions) => {\n  return {\n    permissionType: PermissionType.RestrictedMethod,\n    targetName: methodName,\n    allowedCaveats,\n    methodImplementation: getDialogImplementation(methodHooks),\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nconst methodHooks: MethodHooksObject<DialogMethodHooks> = {\n  showDialog: true,\n  createInterface: true,\n  getInterface: true,\n};\n\nexport const dialogBuilder = Object.freeze({\n  targetName: methodName,\n  specificationBuilder,\n  methodHooks,\n} as const);\n\n// Note: We use `type` here instead of `object` because `type` does not validate\n// the keys of the object, which is what we want.\nconst BaseParamsStruct = type({\n  type: enums([DialogType.Alert, DialogType.Confirmation, DialogType.Prompt]),\n});\n\nconst AlertParametersWithContentStruct = object({\n  type: enumValue(DialogType.Alert),\n  content: ComponentStruct,\n});\nconst AlertParametersWithIdStruct = object({\n  type: enumValue(DialogType.Alert),\n  id: string(),\n});\n\nconst AlertParametersStruct = union([\n  AlertParametersWithContentStruct,\n  AlertParametersWithIdStruct,\n]);\n\nconst ConfirmationParametersWithContentStruct = object({\n  type: enumValue(DialogType.Confirmation),\n  content: ComponentStruct,\n});\n\nconst ConfirmationParametersWithIdStruct = object({\n  type: enumValue(DialogType.Confirmation),\n  id: string(),\n});\n\nconst ConfirmationParametersStruct = union([\n  ConfirmationParametersWithContentStruct,\n  ConfirmationParametersWithIdStruct,\n]);\n\nconst PromptParametersWithContentStruct = object({\n  type: enumValue(DialogType.Prompt),\n  content: ComponentStruct,\n  placeholder: PlaceholderStruct,\n});\n\nconst PromptParametersWithIdStruct = object({\n  type: enumValue(DialogType.Prompt),\n  id: string(),\n  placeholder: PlaceholderStruct,\n});\n\nconst PromptParametersStruct = union([\n  PromptParametersWithContentStruct,\n  PromptParametersWithIdStruct,\n]);\n\nconst DialogParametersStruct = union([\n  AlertParametersStruct,\n  ConfirmationParametersStruct,\n  PromptParametersStruct,\n]);\n\nexport type DialogParameters = InferMatching<\n  typeof DialogParametersStruct,\n  DialogParams\n>;\n\nconst structs = {\n  [DialogType.Alert]: AlertParametersStruct,\n  [DialogType.Confirmation]: ConfirmationParametersStruct,\n  [DialogType.Prompt]: PromptParametersStruct,\n};\n\n/**\n * Builds the method implementation for `snap_dialog`.\n *\n * @param hooks - The RPC method hooks.\n * @param hooks.showDialog - A function that shows the specified dialog in the\n * MetaMask UI and returns the appropriate value for the dialog type.\n * @param hooks.createInterface - A function that creates the interface in SnapInterfaceController.\n * @param hooks.getInterface - A function that gets an interface from SnapInterfaceController.\n * @returns The method implementation which return value depends on the dialog\n * type, valid return types are: string, boolean, null.\n */\nexport function getDialogImplementation({\n  showDialog,\n  createInterface,\n  getInterface,\n}: DialogMethodHooks) {\n  return async function dialogImplementation(\n    args: RestrictedMethodOptions<DialogParameters>,\n  ): Promise<boolean | null | string> {\n    const {\n      params,\n      context: { origin },\n    } = args;\n\n    const validatedType = getValidatedType(params);\n    const validatedParams = getValidatedParams(params, structs[validatedType]);\n\n    const placeholder =\n      validatedParams.type === DialogType.Prompt\n        ? validatedParams.placeholder\n        : undefined;\n\n    if (hasProperty(validatedParams, 'content')) {\n      const id = await createInterface(\n        origin,\n        validatedParams.content as Component,\n      );\n      return showDialog(origin, validatedType, id, placeholder);\n    }\n\n    // Verify that the passed interface ID is valid.\n    // This will throw if the interface ID is invalid (not created by the snap or doesn't exist)\n    try {\n      getInterface(origin, validatedParams.id);\n    } catch (error) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}`,\n      });\n    }\n\n    return showDialog(origin, validatedType, validatedParams.id, placeholder);\n  };\n}\n\n/**\n * Get the validated type of the dialog parameters. Throws an error if the type\n * is invalid.\n *\n * @param params - The parameters to validate.\n * @returns The validated type of the dialog parameters.\n */\nfunction getValidatedType(params: unknown): DialogType {\n  try {\n    return create(params, BaseParamsStruct).type;\n  } catch (error) {\n    throw rpcErrors.invalidParams({\n      message: `The \"type\" property must be one of: ${Object.values(\n        DialogType,\n      ).join(', ')}.`,\n    });\n  }\n}\n\n/**\n * Validates the confirm method `params` and returns them cast to the correct\n * type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @param struct - The struct to validate the params against.\n * @returns The validated confirm method parameter object.\n */\nfunction getValidatedParams(\n  params: unknown,\n  struct: Struct<any, any>,\n): DialogParameters {\n  try {\n    return createUnion(params, struct, 'type');\n  } catch (error) {\n    throw rpcErrors.invalidParams({\n      message: `Invalid params: ${error.message}`,\n    });\n  }\n}\n"],"names":["PermissionType","SubjectType","rpcErrors","DialogType","ComponentStruct","enumValue","union","createUnion","hasProperty","create","enums","object","optional","size","string","type","methodName","PlaceholderStruct","specificationBuilder","allowedCaveats","methodHooks","permissionType","RestrictedMethod","targetName","methodImplementation","getDialogImplementation","subjectTypes","Snap","showDialog","createInterface","getInterface","dialogBuilder","Object","freeze","BaseParamsStruct","Alert","Confirmation","Prompt","AlertParametersWithContentStruct","content","AlertParametersWithIdStruct","id","AlertParametersStruct","ConfirmationParametersWithContentStruct","ConfirmationParametersWithIdStruct","ConfirmationParametersStruct","PromptParametersWithContentStruct","placeholder","PromptParametersWithIdStruct","PromptParametersStruct","DialogParametersStruct","structs","dialogImplementation","args","params","context","origin","validatedType","getValidatedType","validatedParams","getValidatedParams","undefined","error","invalidParams","message","values","join","struct"],"mappings":"AAKA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAC9E,SAASC,SAAS,QAAQ,uBAAuB;AACjD,SACEC,UAAU,EACVC,eAAe,EACfC,SAAS,EACTC,KAAK,QACA,sBAAsB;AAQ7B,SAASC,WAAW,QAAQ,wBAAwB;AAEpD,SAASC,WAAW,QAA4B,kBAAkB;AAElE,SACEC,MAAM,EACNC,KAAK,EACLC,MAAM,EACNC,QAAQ,EACRC,IAAI,EACJC,MAAM,EACNC,IAAI,QACC,cAAc;AAIrB,MAAMC,aAAa;AAEnB,MAAMC,oBAAoBL,SAASC,KAAKC,UAAU,GAAG;AAkDrD;;;;;;;;;;;;;CAaC,GACD,MAAMI,uBAIF,CAAC,EACHC,iBAAiB,IAAI,EACrBC,WAAW,EACuB;IAClC,OAAO;QACLC,gBAAgBrB,eAAesB,gBAAgB;QAC/CC,YAAYP;QACZG;QACAK,sBAAsBC,wBAAwBL;QAC9CM,cAAc;YAACzB,YAAY0B,IAAI;SAAC;IAClC;AACF;AAEA,MAAMP,cAAoD;IACxDQ,YAAY;IACZC,iBAAiB;IACjBC,cAAc;AAChB;AAEA,OAAO,MAAMC,gBAAgBC,OAAOC,MAAM,CAAC;IACzCV,YAAYP;IACZE;IACAE;AACF,GAAY;AAEZ,gFAAgF;AAChF,iDAAiD;AACjD,MAAMc,mBAAmBnB,KAAK;IAC5BA,MAAML,MAAM;QAACP,WAAWgC,KAAK;QAAEhC,WAAWiC,YAAY;QAAEjC,WAAWkC,MAAM;KAAC;AAC5E;AAEA,MAAMC,mCAAmC3B,OAAO;IAC9CI,MAAMV,UAAUF,WAAWgC,KAAK;IAChCI,SAASnC;AACX;AACA,MAAMoC,8BAA8B7B,OAAO;IACzCI,MAAMV,UAAUF,WAAWgC,KAAK;IAChCM,IAAI3B;AACN;AAEA,MAAM4B,wBAAwBpC,MAAM;IAClCgC;IACAE;CACD;AAED,MAAMG,0CAA0ChC,OAAO;IACrDI,MAAMV,UAAUF,WAAWiC,YAAY;IACvCG,SAASnC;AACX;AAEA,MAAMwC,qCAAqCjC,OAAO;IAChDI,MAAMV,UAAUF,WAAWiC,YAAY;IACvCK,IAAI3B;AACN;AAEA,MAAM+B,+BAA+BvC,MAAM;IACzCqC;IACAC;CACD;AAED,MAAME,oCAAoCnC,OAAO;IAC/CI,MAAMV,UAAUF,WAAWkC,MAAM;IACjCE,SAASnC;IACT2C,aAAa9B;AACf;AAEA,MAAM+B,+BAA+BrC,OAAO;IAC1CI,MAAMV,UAAUF,WAAWkC,MAAM;IACjCI,IAAI3B;IACJiC,aAAa9B;AACf;AAEA,MAAMgC,yBAAyB3C,MAAM;IACnCwC;IACAE;CACD;AAED,MAAME,yBAAyB5C,MAAM;IACnCoC;IACAG;IACAI;CACD;AAOD,MAAME,UAAU;IACd,CAAChD,WAAWgC,KAAK,CAAC,EAAEO;IACpB,CAACvC,WAAWiC,YAAY,CAAC,EAAES;IAC3B,CAAC1C,WAAWkC,MAAM,CAAC,EAAEY;AACvB;AAEA;;;;;;;;;;CAUC,GACD,OAAO,SAASxB,wBAAwB,EACtCG,UAAU,EACVC,eAAe,EACfC,YAAY,EACM;IAClB,OAAO,eAAesB,qBACpBC,IAA+C;QAE/C,MAAM,EACJC,MAAM,EACNC,SAAS,EAAEC,MAAM,EAAE,EACpB,GAAGH;QAEJ,MAAMI,gBAAgBC,iBAAiBJ;QACvC,MAAMK,kBAAkBC,mBAAmBN,QAAQH,OAAO,CAACM,cAAc;QAEzE,MAAMV,cACJY,gBAAgB5C,IAAI,KAAKZ,WAAWkC,MAAM,GACtCsB,gBAAgBZ,WAAW,GAC3Bc;QAEN,IAAIrD,YAAYmD,iBAAiB,YAAY;YAC3C,MAAMlB,KAAK,MAAMZ,gBACf2B,QACAG,gBAAgBpB,OAAO;YAEzB,OAAOX,WAAW4B,QAAQC,eAAehB,IAAIM;QAC/C;QAEA,gDAAgD;QAChD,4FAA4F;QAC5F,IAAI;YACFjB,aAAa0B,QAAQG,gBAAgBlB,EAAE;QACzC,EAAE,OAAOqB,OAAO;YACd,MAAM5D,UAAU6D,aAAa,CAAC;gBAC5BC,SAAS,CAAC,gBAAgB,EAAEF,MAAME,OAAO,CAAC,CAAC;YAC7C;QACF;QAEA,OAAOpC,WAAW4B,QAAQC,eAAeE,gBAAgBlB,EAAE,EAAEM;IAC/D;AACF;AAEA;;;;;;CAMC,GACD,SAASW,iBAAiBJ,MAAe;IACvC,IAAI;QACF,OAAO7C,OAAO6C,QAAQpB,kBAAkBnB,IAAI;IAC9C,EAAE,OAAO+C,OAAO;QACd,MAAM5D,UAAU6D,aAAa,CAAC;YAC5BC,SAAS,CAAC,oCAAoC,EAAEhC,OAAOiC,MAAM,CAC3D9D,YACA+D,IAAI,CAAC,MAAM,CAAC,CAAC;QACjB;IACF;AACF;AAEA;;;;;;;CAOC,GACD,SAASN,mBACPN,MAAe,EACfa,MAAwB;IAExB,IAAI;QACF,OAAO5D,YAAY+C,QAAQa,QAAQ;IACrC,EAAE,OAAOL,OAAO;QACd,MAAM5D,UAAU6D,aAAa,CAAC;YAC5BC,SAAS,CAAC,gBAAgB,EAAEF,MAAME,OAAO,CAAC,CAAC;QAC7C;IACF;AACF"}

package/dist/types/endowments/caveats/generic.d.ts

@@ -0,0 +1,19 @@
+import type { PermissionConstraint, PermissionValidatorConstraint } from '@metamask/permission-controller';
+import type { Json } from '@metamask/utils';
+export declare type CaveatMapperReturnValue = Pick<PermissionConstraint, 'caveats'>;
+export declare type CaveatMapperFunction = (value: Json) => CaveatMapperReturnValue;
+/**
+ * Create a generic permission validator that validates the presence of certain caveats.
+ *
+ * This validator only validates the types of the caveats, not the values.
+ *
+ * @param caveatsToValidate - A list of objects that represent caveats.
+ * @param caveatsToValidate.type - The string defining the caveat type.
+ * @param caveatsToValidate.optional - An optional boolean flag that defines
+ * whether the caveat is optional or not.
+ * @returns A function that validates a permission.
+ */
+export declare function createGenericPermissionValidator(caveatsToValidate: {
+    type: string;
+    optional?: boolean;
+}[]): PermissionValidatorConstraint;

package/dist/types/endowments/caveats/index.d.ts

@@ -0,0 +1,2 @@
+export * from './generic';
+export * from './requestTime';

package/dist/types/endowments/caveats/requestTime.d.ts

@@ -0,0 +1,29 @@
+import type { CaveatSpecificationConstraint, PermissionConstraint } from '@metamask/permission-controller';
+import { SnapCaveatType } from '@metamask/snaps-utils';
+import type { Json } from '@metamask/utils';
+import type { CaveatMapperFunction, CaveatMapperReturnValue } from './generic';
+/**
+ * Map a raw value from the `initialPermissions` to a caveat specification.
+ * Note that this function does not do any validation, that's handled by the
+ * PermissionsController when the permission is requested.
+ *
+ * @param value - The raw value from the `initialPermissions`.
+ * @returns The caveat specification.
+ */
+export declare function getMaxRequestTimeCaveatMapper(value: Json): CaveatMapperReturnValue;
+/**
+ * Creates a wrapping caveat mapper that creates the `maxRequestTime` caveat
+ * and merges it with any other caveats created by the mapper function.
+ *
+ * @param mapper - Another caveat mapper function.
+ * @returns The caveat specification.
+ */
+export declare function createMaxRequestTimeMapper(mapper: CaveatMapperFunction): CaveatMapperFunction;
+/**
+ * Getter function to get the {@link MaxRequestTime} caveat value from a permission if specified.
+ *
+ * @param permission - The permission to get the caveat value from.
+ * @returns The caveat value if present, otherwise null.
+ */
+export declare function getMaxRequestTimeCaveat(permission?: PermissionConstraint): number | null;
+export declare const maxRequestTimeCaveatSpecifications: Record<SnapCaveatType.MaxRequestTime, CaveatSpecificationConstraint>;

package/dist/types/endowments/cronjob.d.ts

@@ -0,0 +1,51 @@
+import type { PermissionSpecificationBuilder, PermissionConstraint, Caveat, CaveatSpecificationConstraint } from '@metamask/permission-controller';
+import { PermissionType } from '@metamask/permission-controller';
+import type { CronjobSpecification } from '@metamask/snaps-utils';
+import { SnapCaveatType } from '@metamask/snaps-utils';
+import type { Json, NonEmptyArray } from '@metamask/utils';
+import { SnapEndowments } from './enum';
+declare const permissionName = SnapEndowments.Cronjob;
+export declare const cronjobEndowmentBuilder: Readonly<{
+    readonly targetName: SnapEndowments.Cronjob;
+    readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, any, {
+        permissionType: PermissionType.Endowment;
+        targetName: typeof permissionName;
+        endowmentGetter: (_options?: any) => undefined;
+        allowedCaveats: Readonly<NonEmptyArray<string>> | null;
+    }>;
+}>;
+/**
+ * Map a raw value from the `initialPermissions` to a caveat specification.
+ * Note that this function does not do any validation, that's handled by the
+ * PermissionsController when the permission is requested.
+ *
+ * @param value - The raw value from the `initialPermissions`.
+ * @returns The caveat specification.
+ */
+export declare function getCronjobCaveatMapper(value: Json): Pick<PermissionConstraint, 'caveats'>;
+/**
+ * Getter function to get the cronjobs from a permission.
+ *
+ * This does basic validation of the caveat, but does not validate the type or
+ * value of the namespaces object itself, as this is handled by the
+ * `PermissionsController` when the permission is requested.
+ *
+ * @param permission - The permission to get the keyring namespaces from.
+ * @returns The cronjobs, or `null` if the permission does not have a
+ * cronjob caveat.
+ */
+export declare function getCronjobCaveatJobs(permission?: PermissionConstraint): CronjobSpecification[] | null;
+/**
+ * Validate the cronjob specification values associated with a caveat.
+ * This validates that the value is a non-empty array with valid
+ * cronjob expression and request object.
+ *
+ * @param caveat - The caveat to validate.
+ * @throws If the value is invalid.
+ */
+export declare function validateCronjobCaveat(caveat: Caveat<string, any>): void;
+/**
+ * Caveat specification for the Cronjob.
+ */
+export declare const cronjobCaveatSpecifications: Record<SnapCaveatType.SnapCronjob, CaveatSpecificationConstraint>;
+export {};

package/dist/types/endowments/enum.d.ts

@@ -0,0 +1,13 @@
+export declare enum SnapEndowments {
+    NetworkAccess = "endowment:network-access",
+    SignatureInsight = "endowment:signature-insight",
+    TransactionInsight = "endowment:transaction-insight",
+    Cronjob = "endowment:cronjob",
+    EthereumProvider = "endowment:ethereum-provider",
+    Rpc = "endowment:rpc",
+    WebAssemblyAccess = "endowment:webassembly",
+    NameLookup = "endowment:name-lookup",
+    LifecycleHooks = "endowment:lifecycle-hooks",
+    Keyring = "endowment:keyring",
+    HomePage = "endowment:page-home"
+}

package/dist/types/endowments/ethereum-provider.d.ts

@@ -0,0 +1,14 @@
+import type { PermissionSpecificationBuilder } from '@metamask/permission-controller';
+import { PermissionType } from '@metamask/permission-controller';
+import { SnapEndowments } from './enum';
+declare const permissionName = SnapEndowments.EthereumProvider;
+export declare const ethereumProviderEndowmentBuilder: Readonly<{
+    readonly targetName: SnapEndowments.EthereumProvider;
+    readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, any, {
+        permissionType: PermissionType.Endowment;
+        targetName: typeof permissionName;
+        endowmentGetter: (_options?: any) => ['ethereum'];
+        allowedCaveats: null;
+    }>;
+}>;
+export {};

package/dist/types/endowments/home-page.d.ts

@@ -0,0 +1,15 @@
+import type { PermissionSpecificationBuilder, EndowmentGetterParams } from '@metamask/permission-controller';
+import { PermissionType } from '@metamask/permission-controller';
+import type { NonEmptyArray } from '@metamask/utils';
+import { SnapEndowments } from './enum';
+declare const permissionName = SnapEndowments.HomePage;
+export declare const homePageEndowmentBuilder: Readonly<{
+    readonly targetName: SnapEndowments.HomePage;
+    readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, any, {
+        permissionType: PermissionType.Endowment;
+        targetName: typeof permissionName;
+        endowmentGetter: (_options?: EndowmentGetterParams) => undefined;
+        allowedCaveats: Readonly<NonEmptyArray<string>> | null;
+    }>;
+}>;
+export {};

package/dist/types/endowments/index.d.ts

@@ -0,0 +1,131 @@
+import type { PermissionConstraint } from '@metamask/permission-controller';
+import { HandlerType } from '@metamask/snaps-utils';
+import type { Json } from '@metamask/utils';
+export declare const endowmentPermissionBuilders: {
+    readonly "endowment:network-access": Readonly<{
+        readonly targetName: import("./enum").SnapEndowments.NetworkAccess;
+        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
+            permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
+            targetName: import("./enum").SnapEndowments.NetworkAccess;
+            endowmentGetter: (_options?: any) => ["fetch", "Request", "Headers", "Response"];
+            allowedCaveats: null;
+        }>;
+    }>;
+    readonly "endowment:transaction-insight": Readonly<{
+        readonly targetName: import("./enum").SnapEndowments.TransactionInsight;
+        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
+            permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
+            targetName: import("./enum").SnapEndowments.TransactionInsight;
+            endowmentGetter: (_options?: import("@metamask/permission-controller").EndowmentGetterParams | undefined) => undefined;
+            allowedCaveats: readonly [string, ...string[]] | null;
+            validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
+        }>;
+    }>;
+    readonly "endowment:cronjob": Readonly<{
+        readonly targetName: import("./enum").SnapEndowments.Cronjob;
+        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
+            permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
+            targetName: import("./enum").SnapEndowments.Cronjob;
+            endowmentGetter: (_options?: any) => undefined;
+            allowedCaveats: readonly [string, ...string[]] | null;
+        }>;
+    }>;
+    readonly "endowment:ethereum-provider": Readonly<{
+        readonly targetName: import("./enum").SnapEndowments.EthereumProvider;
+        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
+            permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
+            targetName: import("./enum").SnapEndowments.EthereumProvider;
+            endowmentGetter: (_options?: any) => ["ethereum"];
+            allowedCaveats: null;
+        }>;
+    }>;
+    readonly "endowment:rpc": Readonly<{
+        readonly targetName: import("./enum").SnapEndowments.Rpc;
+        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, {}, {
+            permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
+            targetName: import("./enum").SnapEndowments.Rpc;
+            endowmentGetter: (_options?: any) => undefined;
+            allowedCaveats: readonly [string, ...string[]] | null;
+            validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
+            subjectTypes: readonly import("@metamask/permission-controller").SubjectType[];
+        }>;
+    }>;
+    readonly "endowment:webassembly": Readonly<{
+        readonly targetName: import("./enum").SnapEndowments.WebAssemblyAccess;
+        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
+            permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
+            targetName: import("./enum").SnapEndowments.WebAssemblyAccess;
+            endowmentGetter: (_options?: any) => ["WebAssembly"];
+            allowedCaveats: null;
+        }>;
+    }>;
+    readonly "endowment:name-lookup": Readonly<{
+        readonly targetName: import("./enum").SnapEndowments.NameLookup;
+        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
+            permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
+            targetName: import("./enum").SnapEndowments.NameLookup;
+            endowmentGetter: (_options?: import("@metamask/permission-controller").EndowmentGetterParams | undefined) => undefined;
+            allowedCaveats: readonly [string, ...string[]] | null;
+            validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
+        }>;
+    }>;
+    readonly "endowment:lifecycle-hooks": Readonly<{
+        readonly targetName: import("./enum").SnapEndowments.LifecycleHooks;
+        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
+            permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
+            targetName: import("./enum").SnapEndowments.LifecycleHooks;
+            endowmentGetter: (_options?: import("@metamask/permission-controller").EndowmentGetterParams | undefined) => undefined;
+            allowedCaveats: readonly [string, ...string[]] | null;
+        }>;
+    }>;
+    readonly "endowment:keyring": Readonly<{
+        readonly targetName: import("./enum").SnapEndowments.Keyring;
+        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
+            permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
+            targetName: import("./enum").SnapEndowments.Keyring;
+            endowmentGetter: (_options?: import("@metamask/permission-controller").EndowmentGetterParams | undefined) => undefined;
+            allowedCaveats: readonly [string, ...string[]] | null;
+            validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
+            subjectTypes: readonly import("@metamask/permission-controller").SubjectType[];
+        }>;
+    }>;
+    readonly "endowment:page-home": Readonly<{
+        readonly targetName: import("./enum").SnapEndowments.HomePage;
+        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
+            permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
+            targetName: import("./enum").SnapEndowments.HomePage;
+            endowmentGetter: (_options?: import("@metamask/permission-controller").EndowmentGetterParams | undefined) => undefined;
+            allowedCaveats: readonly [string, ...string[]] | null;
+        }>;
+    }>;
+    readonly "endowment:signature-insight": Readonly<{
+        readonly targetName: import("./enum").SnapEndowments.SignatureInsight;
+        readonly specificationBuilder: import("@metamask/permission-controller").PermissionSpecificationBuilder<import("@metamask/permission-controller").PermissionType.Endowment, any, {
+            permissionType: import("@metamask/permission-controller").PermissionType.Endowment;
+            targetName: import("./enum").SnapEndowments.SignatureInsight;
+            endowmentGetter: (_options?: import("@metamask/permission-controller").EndowmentGetterParams | undefined) => undefined;
+            allowedCaveats: readonly [string, ...string[]] | null;
+            validator: import("@metamask/permission-controller").PermissionValidatorConstraint;
+        }>;
+    }>;
+};
+export declare const endowmentCaveatSpecifications: {
+    maxRequestTime: import("@metamask/permission-controller").CaveatSpecificationConstraint;
+    signatureOrigin: import("@metamask/permission-controller").CaveatSpecificationConstraint;
+    keyringOrigin: import("@metamask/permission-controller").CaveatSpecificationConstraint;
+    chainIds: import("@metamask/permission-controller").CaveatSpecificationConstraint;
+    lookupMatchers: import("@metamask/permission-controller").CaveatSpecificationConstraint;
+    rpcOrigin: import("@metamask/permission-controller").CaveatSpecificationConstraint;
+    transactionOrigin: import("@metamask/permission-controller").CaveatSpecificationConstraint;
+    snapCronjob: import("@metamask/permission-controller").CaveatSpecificationConstraint;
+};
+export declare const endowmentCaveatMappers: Record<string, (value: Json) => Pick<PermissionConstraint, 'caveats'>>;
+export declare const handlerEndowments: Record<HandlerType, string | null>;
+export * from './enum';
+export { getRpcCaveatOrigins } from './rpc';
+export { getSignatureOriginCaveat } from './signature-insight';
+export { getTransactionOriginCaveat } from './transaction-insight';
+export { getChainIdsCaveat, getLookupMatchersCaveat } from './name-lookup';
+export { getKeyringCaveatOrigins } from './keyring';
+export { getMaxRequestTimeCaveat } from './caveats';
+export { getCronjobCaveatJobs } from './cronjob';

package/dist/types/endowments/keyring.d.ts

@@ -0,0 +1,39 @@
+import type { CaveatSpecificationConstraint, EndowmentGetterParams, PermissionConstraint, PermissionSpecificationBuilder, PermissionValidatorConstraint } from '@metamask/permission-controller';
+import { PermissionType, SubjectType } from '@metamask/permission-controller';
+import type { KeyringOrigins } from '@metamask/snaps-utils';
+import { SnapCaveatType } from '@metamask/snaps-utils';
+import type { Json, NonEmptyArray } from '@metamask/utils';
+import { SnapEndowments } from './enum';
+declare const permissionName = SnapEndowments.Keyring;
+export declare const keyringEndowmentBuilder: Readonly<{
+    readonly targetName: SnapEndowments.Keyring;
+    readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, any, {
+        permissionType: PermissionType.Endowment;
+        targetName: typeof permissionName;
+        endowmentGetter: (_options?: EndowmentGetterParams) => undefined;
+        allowedCaveats: Readonly<NonEmptyArray<string>> | null;
+        validator: PermissionValidatorConstraint;
+        subjectTypes: readonly SubjectType[];
+    }>;
+}>;
+/**
+ * Map a raw value from the `initialPermissions` to a caveat specification.
+ * Note that this function does not do any validation, that's handled by the
+ * PermissionsController when the permission is requested.
+ *
+ * @param value - The raw value from the `initialPermissions`.
+ * @returns The caveat specification.
+ */
+export declare function getKeyringCaveatMapper(value: Json): Pick<PermissionConstraint, 'caveats'>;
+/**
+ * Getter function to get the {@link KeyringOrigins} caveat value from a
+ * permission.
+ *
+ * @param permission - The permission to get the caveat value from.
+ * @returns The caveat value.
+ * @throws If the permission does not have a valid {@link KeyringOrigins}
+ * caveat.
+ */
+export declare function getKeyringCaveatOrigins(permission?: PermissionConstraint): KeyringOrigins | null;
+export declare const keyringCaveatSpecifications: Record<SnapCaveatType.KeyringOrigin, CaveatSpecificationConstraint>;
+export {};

package/dist/types/endowments/lifecycle-hooks.d.ts

@@ -0,0 +1,15 @@
+import type { PermissionSpecificationBuilder, EndowmentGetterParams } from '@metamask/permission-controller';
+import { PermissionType } from '@metamask/permission-controller';
+import type { NonEmptyArray } from '@metamask/utils';
+import { SnapEndowments } from './enum';
+declare const permissionName = SnapEndowments.LifecycleHooks;
+export declare const lifecycleHooksEndowmentBuilder: Readonly<{
+    readonly targetName: SnapEndowments.LifecycleHooks;
+    readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, any, {
+        permissionType: PermissionType.Endowment;
+        targetName: typeof permissionName;
+        endowmentGetter: (_options?: EndowmentGetterParams) => undefined;
+        allowedCaveats: Readonly<NonEmptyArray<string>> | null;
+    }>;
+}>;
+export {};