@metamask/snaps-rpc-methods 11.0.0 → 11.1.1

package/dist/permissions.d.mts

@@ -0,0 +1,17 @@
+import type { PermissionConstraint, PermissionSpecificationConstraint } from "@metamask/permission-controller";
+import type { SnapPermissions } from "@metamask/snaps-utils";
+/**
+ * Map initial permissions as defined in a Snap manifest to something that can
+ * be processed by the PermissionsController. Each caveat mapping function
+ * should return a valid permission caveat value.
+ *
+ * This function does not validate the caveat values, since that is done by
+ * the PermissionsController itself, upon requesting the permissions.
+ *
+ * @param initialPermissions - The initial permissions to process.
+ * @returns The processed permissions.
+ */
+export declare function processSnapPermissions(initialPermissions: SnapPermissions): Record<string, Pick<PermissionConstraint, 'caveats'>>;
+export declare const buildSnapEndowmentSpecifications: (excludedEndowments: string[]) => Record<string, PermissionSpecificationConstraint>;
+export declare const buildSnapRestrictedMethodSpecifications: (excludedPermissions: string[], hooks: Record<string, unknown>) => Record<string, PermissionSpecificationConstraint>;
+//# sourceMappingURL=permissions.d.mts.map

package/dist/permissions.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.d.mts","sourceRoot":"","sources":["../src/permissions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,iCAAiC,EAClC,wCAAwC;AACzC,OAAO,KAAK,EAAE,eAAe,EAAE,8BAA8B;AAa7D;;;;;;;;;;GAUG;AACH,wBAAgB,sBAAsB,CACpC,kBAAkB,EAAE,eAAe,GAClC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC,CAmBvD;AAED,eAAO,MAAM,gCAAgC,uBACvB,MAAM,EAAE,sDAStB,CAAC;AAET,eAAO,MAAM,uCAAuC,wBAC7B,MAAM,EAAE,SACtB,OAAO,MAAM,EAAE,OAAO,CAAC,sDAexB,CAAC"}

package/dist/permissions.mjs

@@ -1,44 +1,49 @@
-import {
-  buildSnapEndowmentSpecifications,
-  buildSnapRestrictedMethodSpecifications,
-  processSnapPermissions
-} from "./chunk-GEJDXRTL.mjs";
-import "./chunk-V3KRSCUK.mjs";
-import "./chunk-TE4W25CA.mjs";
-import "./chunk-JWDQUKKU.mjs";
-import "./chunk-K3UL5RVN.mjs";
-import "./chunk-FJ7COFRJ.mjs";
-import "./chunk-PIAWDTWO.mjs";
-import "./chunk-I2P65KBQ.mjs";
-import "./chunk-VYII7C3J.mjs";
-import "./chunk-LR7UR4YU.mjs";
-import "./chunk-2RDYC42U.mjs";
-import "./chunk-AMMJ744B.mjs";
-import "./chunk-FM4LNQR7.mjs";
-import "./chunk-Z6YFGWHN.mjs";
-import "./chunk-TQCUJQHY.mjs";
-import "./chunk-LXJBBRQ4.mjs";
-import "./chunk-VVBTXSID.mjs";
-import "./chunk-W33UWNA2.mjs";
-import "./chunk-TAXLFFV4.mjs";
-import "./chunk-HOECEYMT.mjs";
-import "./chunk-DTZF746A.mjs";
-import "./chunk-ODN35VOK.mjs";
-import "./chunk-4D2B2UQ6.mjs";
-import "./chunk-57BL7O2P.mjs";
-import "./chunk-33LLA2MH.mjs";
-import "./chunk-PIRQCNBJ.mjs";
-import "./chunk-TG63GBK3.mjs";
-import "./chunk-TT4DP2YW.mjs";
-import "./chunk-23XDKQW2.mjs";
-import "./chunk-O66NZFSD.mjs";
-import "./chunk-3WCLDJAS.mjs";
-import "./chunk-KSTF5JYB.mjs";
-import "./chunk-ZH3FC55E.mjs";
-import "./chunk-CD4OUHO5.mjs";
-export {
-  buildSnapEndowmentSpecifications,
-  buildSnapRestrictedMethodSpecifications,
-  processSnapPermissions
-};
+import { hasProperty } from "@metamask/utils";
+import { endowmentCaveatMappers, endowmentPermissionBuilders } from "./endowments/index.mjs";
+import { caveatMappers, restrictedMethodPermissionBuilders } from "./restricted/index.mjs";
+import { selectHooks } from "./utils.mjs";
+/**
+ * Map initial permissions as defined in a Snap manifest to something that can
+ * be processed by the PermissionsController. Each caveat mapping function
+ * should return a valid permission caveat value.
+ *
+ * This function does not validate the caveat values, since that is done by
+ * the PermissionsController itself, upon requesting the permissions.
+ *
+ * @param initialPermissions - The initial permissions to process.
+ * @returns The processed permissions.
+ */
+export function processSnapPermissions(initialPermissions) {
+    return Object.fromEntries(Object.entries(initialPermissions).map(([initialPermission, value]) => {
+        if (hasProperty(caveatMappers, initialPermission)) {
+            return [initialPermission, caveatMappers[initialPermission](value)];
+        }
+        else if (hasProperty(endowmentCaveatMappers, initialPermission)) {
+            return [
+                initialPermission,
+                endowmentCaveatMappers[initialPermission](value),
+            ];
+        }
+        // If we have no mapping, this may be a non-snap permission, return as-is
+        return [
+            initialPermission,
+            value,
+        ];
+    }));
+}
+export const buildSnapEndowmentSpecifications = (excludedEndowments) => Object.values(endowmentPermissionBuilders).reduce((allSpecifications, { targetName, specificationBuilder }) => {
+    if (!excludedEndowments.includes(targetName)) {
+        allSpecifications[targetName] = specificationBuilder({});
+    }
+    return allSpecifications;
+}, {});
+export const buildSnapRestrictedMethodSpecifications = (excludedPermissions, hooks) => Object.values(restrictedMethodPermissionBuilders).reduce((specifications, { targetName, specificationBuilder, methodHooks }) => {
+    if (!excludedPermissions.includes(targetName)) {
+        specifications[targetName] = specificationBuilder({
+            // @ts-expect-error The selectHooks type is wonky
+            methodHooks: selectHooks(hooks, methodHooks),
+        });
+    }
+    return specifications;
+}, {});
 //# sourceMappingURL=permissions.mjs.map

package/dist/permissions.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"permissions.mjs","sourceRoot":"","sources":["../src/permissions.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,wBAAwB;AAE9C,OAAO,EACL,sBAAsB,EACtB,2BAA2B,EAC5B,+BAAqB;AACtB,OAAO,EACL,aAAa,EACb,kCAAkC,EACnC,+BAAqB;AACtB,OAAO,EAAE,WAAW,EAAE,oBAAgB;AAEtC;;;;;;;;;;GAUG;AACH,MAAM,UAAU,sBAAsB,CACpC,kBAAmC;IAEnC,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,iBAAiB,EAAE,KAAK,CAAC,EAAE,EAAE;QACpE,IAAI,WAAW,CAAC,aAAa,EAAE,iBAAiB,CAAC,EAAE,CAAC;YAClD,OAAO,CAAC,iBAAiB,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QACtE,CAAC;aAAM,IAAI,WAAW,CAAC,sBAAsB,EAAE,iBAAiB,CAAC,EAAE,CAAC;YAClE,OAAO;gBACL,iBAAiB;gBACjB,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC;aACjD,CAAC;QACJ,CAAC;QAED,yEAAyE;QACzE,OAAO;YACL,iBAAiB;YACjB,KAA8C;SAC/C,CAAC;IACJ,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAC9C,kBAA4B,EAC5B,EAAE,CACF,MAAM,CAAC,MAAM,CAAC,2BAA2B,CAAC,CAAC,MAAM,CAE/C,CAAC,iBAAiB,EAAE,EAAE,UAAU,EAAE,oBAAoB,EAAE,EAAE,EAAE;IAC5D,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAC7C,iBAAiB,CAAC,UAAU,CAAC,GAAG,oBAAoB,CAAC,EAAE,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,iBAAiB,CAAC;AAC3B,CAAC,EAAE,EAAE,CAAC,CAAC;AAET,MAAM,CAAC,MAAM,uCAAuC,GAAG,CACrD,mBAA6B,EAC7B,KAA8B,EAC9B,EAAE,CACF,MAAM,CAAC,MAAM,CAAC,kCAAkC,CAAC,CAAC,MAAM,CAEtD,CAAC,cAAc,EAAE,EAAE,UAAU,EAAE,oBAAoB,EAAE,WAAW,EAAE,EAAE,EAAE;IACtE,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9C,cAAc,CAAC,UAAU,CAAC,GAAG,oBAAoB,CAAC;YAChD,iDAAiD;YACjD,WAAW,EAAE,WAAW,CACtB,KAAK,EACL,WAAW,CACoC;SAClD,CAAC,CAAC;IACL,CAAC;IACD,OAAO,cAAc,CAAC;AACxB,CAAC,EAAE,EAAE,CAAC,CAAC","sourcesContent":["import type {\n  PermissionConstraint,\n  PermissionSpecificationConstraint,\n} from '@metamask/permission-controller';\nimport type { SnapPermissions } from '@metamask/snaps-utils';\nimport { hasProperty } from '@metamask/utils';\n\nimport {\n  endowmentCaveatMappers,\n  endowmentPermissionBuilders,\n} from './endowments';\nimport {\n  caveatMappers,\n  restrictedMethodPermissionBuilders,\n} from './restricted';\nimport { selectHooks } from './utils';\n\n/**\n * Map initial permissions as defined in a Snap manifest to something that can\n * be processed by the PermissionsController. Each caveat mapping function\n * should return a valid permission caveat value.\n *\n * This function does not validate the caveat values, since that is done by\n * the PermissionsController itself, upon requesting the permissions.\n *\n * @param initialPermissions - The initial permissions to process.\n * @returns The processed permissions.\n */\nexport function processSnapPermissions(\n  initialPermissions: SnapPermissions,\n): Record<string, Pick<PermissionConstraint, 'caveats'>> {\n  return Object.fromEntries(\n    Object.entries(initialPermissions).map(([initialPermission, value]) => {\n      if (hasProperty(caveatMappers, initialPermission)) {\n        return [initialPermission, caveatMappers[initialPermission](value)];\n      } else if (hasProperty(endowmentCaveatMappers, initialPermission)) {\n        return [\n          initialPermission,\n          endowmentCaveatMappers[initialPermission](value),\n        ];\n      }\n\n      // If we have no mapping, this may be a non-snap permission, return as-is\n      return [\n        initialPermission,\n        value as Pick<PermissionConstraint, 'caveats'>,\n      ];\n    }),\n  );\n}\n\nexport const buildSnapEndowmentSpecifications = (\n  excludedEndowments: string[],\n) =>\n  Object.values(endowmentPermissionBuilders).reduce<\n    Record<string, PermissionSpecificationConstraint>\n  >((allSpecifications, { targetName, specificationBuilder }) => {\n    if (!excludedEndowments.includes(targetName)) {\n      allSpecifications[targetName] = specificationBuilder({});\n    }\n    return allSpecifications;\n  }, {});\n\nexport const buildSnapRestrictedMethodSpecifications = (\n  excludedPermissions: string[],\n  hooks: Record<string, unknown>,\n) =>\n  Object.values(restrictedMethodPermissionBuilders).reduce<\n    Record<string, PermissionSpecificationConstraint>\n  >((specifications, { targetName, specificationBuilder, methodHooks }) => {\n    if (!excludedPermissions.includes(targetName)) {\n      specifications[targetName] = specificationBuilder({\n        // @ts-expect-error The selectHooks type is wonky\n        methodHooks: selectHooks<typeof hooks, keyof typeof methodHooks>(\n          hooks,\n          methodHooks,\n        ) as Pick<typeof hooks, keyof typeof methodHooks>,\n      });\n    }\n    return specifications;\n  }, {});\n"]}

package/dist/permitted/createInterface.cjs

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createInterfaceHandler = void 0;
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const snaps_sdk_1 = require("@metamask/snaps-sdk");
+const superstruct_1 = require("@metamask/superstruct");
+const hookNames = {
+    createInterface: true,
+};
+exports.createInterfaceHandler = {
+    methodNames: ['snap_createInterface'],
+    implementation: getCreateInterfaceImplementation,
+    hookNames,
+};
+const CreateInterfaceParametersStruct = (0, superstruct_1.object)({
+    ui: snaps_sdk_1.ComponentOrElementStruct,
+    context: (0, superstruct_1.optional)(snaps_sdk_1.InterfaceContextStruct),
+});
+/**
+ * The `snap_createInterface` 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.createInterface - The function to create the interface.
+ * @returns Nothing.
+ */
+async function getCreateInterfaceImplementation(req, res, _next, end, { createInterface }) {
+    const { params } = req;
+    try {
+        const validatedParams = getValidatedParams(params);
+        const { ui, context } = validatedParams;
+        res.result = await createInterface(ui, context);
+    }
+    catch (error) {
+        return end(error);
+    }
+    return end();
+}
+/**
+ * Validate the createInterface 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 createInterface method parameter object.
+ */
+function getValidatedParams(params) {
+    try {
+        return (0, superstruct_1.create)(params, CreateInterfaceParametersStruct);
+    }
+    catch (error) {
+        if (error instanceof superstruct_1.StructError) {
+            throw rpc_errors_1.rpcErrors.invalidParams({
+                message: `Invalid params: ${error.message}.`,
+            });
+        }
+        /* istanbul ignore next */
+        throw rpc_errors_1.rpcErrors.internal();
+    }
+}
+//# sourceMappingURL=createInterface.cjs.map

package/dist/permitted/createInterface.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"createInterface.cjs","sourceRoot":"","sources":["../../src/permitted/createInterface.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AAQjD,mDAG6B;AAE7B,uDAA8E;AAK9E,MAAM,SAAS,GAAkD;IAC/D,eAAe,EAAE,IAAI;CACtB,CAAC;AAaW,QAAA,sBAAsB,GAI/B;IACF,WAAW,EAAE,CAAC,sBAAsB,CAAC;IACrC,cAAc,EAAE,gCAAgC;IAChD,SAAS;CACV,CAAC;AAEF,MAAM,+BAA+B,GAAG,IAAA,oBAAM,EAAC;IAC7C,EAAE,EAAE,oCAAwB;IAC5B,OAAO,EAAE,IAAA,sBAAQ,EAAC,kCAAsB,CAAC;CAC1C,CAAC,CAAC;AAOH;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,gCAAgC,CAC7C,GAA8C,EAC9C,GAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,EAAE,eAAe,EAA8B;IAE/C,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;QAExC,GAAG,CAAC,MAAM,GAAG,MAAM,eAAe,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,+BAA+B,CAAC,CAAC;IACzD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","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  CreateInterfaceParams,\n  CreateInterfaceResult,\n  JsonRpcRequest,\n  ComponentOrElement,\n  InterfaceContext,\n} from '@metamask/snaps-sdk';\nimport {\n  ComponentOrElementStruct,\n  InterfaceContextStruct,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport { StructError, create, object, optional } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type { MethodHooksObject } from '../utils';\n\nconst hookNames: MethodHooksObject<CreateInterfaceMethodHooks> = {\n  createInterface: true,\n};\n\nexport type CreateInterfaceMethodHooks = {\n  /**\n   * @param ui - The UI components.\n   * @returns The unique identifier of the interface.\n   */\n  createInterface: (\n    ui: ComponentOrElement,\n    context?: InterfaceContext,\n  ) => Promise<string>;\n};\n\nexport const createInterfaceHandler: PermittedHandlerExport<\n  CreateInterfaceMethodHooks,\n  CreateInterfaceParameters,\n  CreateInterfaceResult\n> = {\n  methodNames: ['snap_createInterface'],\n  implementation: getCreateInterfaceImplementation,\n  hookNames,\n};\n\nconst CreateInterfaceParametersStruct = object({\n  ui: ComponentOrElementStruct,\n  context: optional(InterfaceContextStruct),\n});\n\nexport type CreateInterfaceParameters = InferMatching<\n  typeof CreateInterfaceParametersStruct,\n  CreateInterfaceParams\n>;\n\n/**\n * The `snap_createInterface` 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.createInterface - The function to create the interface.\n * @returns Nothing.\n */\nasync function getCreateInterfaceImplementation(\n  req: JsonRpcRequest<CreateInterfaceParameters>,\n  res: PendingJsonRpcResponse<CreateInterfaceResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  { createInterface }: CreateInterfaceMethodHooks,\n): Promise<void> {\n  const { params } = req;\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { ui, context } = validatedParams;\n\n    res.result = await createInterface(ui, context);\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the createInterface 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 createInterface method parameter object.\n */\nfunction getValidatedParams(params: unknown): CreateInterfaceParameters {\n  try {\n    return create(params, CreateInterfaceParametersStruct);\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"]}

package/dist/{types/permitted/createInterface.d.ts → permitted/createInterface.d.cts}

@@ -1,6 +1,6 @@
-import type { PermittedHandlerExport } from '@metamask/permission-controller';
-import type { CreateInterfaceParams, CreateInterfaceResult, ComponentOrElement, InterfaceContext } from '@metamask/snaps-sdk';
-import { type InferMatching } from '@metamask/snaps-utils';
+import type { PermittedHandlerExport } from "@metamask/permission-controller";
+import type { CreateInterfaceParams, CreateInterfaceResult, ComponentOrElement, InterfaceContext } from "@metamask/snaps-sdk";
+import { type InferMatching } from "@metamask/snaps-utils";
 export type CreateInterfaceMethodHooks = {
     /**
      * @param ui - The UI components.
@@ -10,55 +10,61 @@ export type CreateInterfaceMethodHooks = {
 };
 export declare const createInterfaceHandler: PermittedHandlerExport<CreateInterfaceMethodHooks, CreateInterfaceParameters, CreateInterfaceResult>;
 declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").Struct<{
-    ui: import("@metamask/snaps-sdk").Panel | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ButtonProps, "Button"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CheckboxProps, "Checkbox"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FormProps, "Form"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FileInputProps, "FileInput"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").InputProps, "Input"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").DropdownProps, "Dropdown"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoldProps, "Bold"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ItalicProps, "Italic"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AddressProps, "Address"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoxProps, "Box"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CardProps, "Card"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ContainerProps, "Container"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CopyableProps, "Copyable"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Divider"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").LinkProps, "Link"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").RowProps, "Row"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Spinner"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TextProps, "Text"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TooltipProps, "Tooltip"> | {
-        value: string;
+    ui: import("@metamask/snaps-sdk").Panel | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ButtonProps, "Button"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CheckboxProps, "Checkbox"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FormProps, "Form"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FileInputProps, "FileInput"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").InputProps, "Input"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").DropdownProps, "Dropdown"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SelectorProps, "Selector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoldProps, "Bold"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ItalicProps, "Italic"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AddressProps, "Address"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoxProps, "Box"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CardProps, "Card"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ContainerProps, "Container"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CopyableProps, "Copyable"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Divider"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").IconProps, "Icon"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").LinkProps, "Link"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").RowProps, "Row"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SectionProps, "Section"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Spinner"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TextProps, "Text"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TooltipProps, "Tooltip"> | {
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
+        value: string;
         sensitive?: boolean | undefined;
     } | {
         type: import("@metamask/snaps-sdk").NodeType.Divider;
     } | {
-        value: string;
         type: import("@metamask/snaps-sdk").NodeType.Heading;
-    } | {
         value: string;
+    } | {
         type: import("@metamask/snaps-sdk").NodeType.Image;
+        value: string;
     } | {
         type: import("@metamask/snaps-sdk").NodeType.Spinner;
     } | {
-        value: string;
         type: import("@metamask/snaps-sdk").NodeType.Text;
+        value: string;
         markdown?: boolean | undefined;
     } | {
-        value: `0x${string}`;
         type: import("@metamask/snaps-sdk").NodeType.Address;
+        value: `0x${string}`;
     } | {
+        type: import("@metamask/snaps-sdk").NodeType.Row;
         value: {
-            value: string;
             type: import("@metamask/snaps-sdk").NodeType.Image;
-        } | {
             value: string;
+        } | {
             type: import("@metamask/snaps-sdk").NodeType.Text;
+            value: string;
             markdown?: boolean | undefined;
         } | {
-            value: `0x${string}`;
             type: import("@metamask/snaps-sdk").NodeType.Address;
+            value: `0x${string}`;
         };
-        type: import("@metamask/snaps-sdk").NodeType.Row;
-        label: string;
+        label: string; /**
+         * Validate the createInterface 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 createInterface method parameter object.
+         */
         variant?: "default" | "warning" | "critical" | undefined;
     } | {
         type: import("@metamask/snaps-sdk").NodeType.Input;
         name: string;
-        value?: string | undefined;
         error?: string | undefined;
-        label?: string | undefined;
         inputType?: "number" | "text" | "password" | undefined;
+        value?: string | undefined;
+        label?: string | undefined;
         placeholder?: string | undefined;
     } | {
-        value: string;
         type: import("@metamask/snaps-sdk").NodeType.Button;
-        name?: string | undefined;
+        value: string;
         variant?: "primary" | "secondary" | undefined;
+        name?: string | undefined;
         buttonType?: "button" | "submit" | undefined;
     } | {
         type: import("@metamask/snaps-sdk").NodeType.Form;
@@ -66,19 +72,22 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
         children: ({
             type: import("@metamask/snaps-sdk").NodeType.Input;
             name: string;
-            value?: string | undefined;
             error?: string | undefined;
-            label?: string | undefined;
             inputType?: "number" | "text" | "password" | undefined;
+            value?: string | undefined;
+            label?: string | undefined;
             placeholder?: string | undefined;
         } | {
-            value: string;
             type: import("@metamask/snaps-sdk").NodeType.Button;
-            name?: string | undefined;
+            value: string;
             variant?: "primary" | "secondary" | undefined;
+            name?: string | undefined;
             buttonType?: "button" | "submit" | undefined;
         })[];
     } | import("@metamask/snaps-sdk/jsx").SnapElement<{
+        src: string;
+        alt?: string | undefined;
+    }, "Image"> | import("@metamask/snaps-sdk/jsx").SnapElement<{
         name: string;
         value?: string | undefined;
         children: import("@metamask/snaps-sdk/jsx").SnapsChildren<import("@metamask/snaps-sdk/jsx").SnapElement<{
@@ -87,61 +96,64 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
         }, "Radio">>;
     }, "RadioGroup"> | import("@metamask/snaps-sdk/jsx").SnapElement<{
         children: import("@metamask/snaps-sdk/jsx").StringElement;
-    }, "Heading"> | import("@metamask/snaps-sdk/jsx").SnapElement<{
-        src: string;
-        alt?: string | undefined;
-    }, "Image">;
+    }, "Heading">;
     context?: Record<string, import("@metamask/snaps-sdk").Json> | undefined;
 }, {
-    ui: import("@metamask/superstruct").Struct<import("@metamask/snaps-sdk").Panel | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ButtonProps, "Button"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CheckboxProps, "Checkbox"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FormProps, "Form"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FileInputProps, "FileInput"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").InputProps, "Input"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").DropdownProps, "Dropdown"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoldProps, "Bold"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ItalicProps, "Italic"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AddressProps, "Address"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoxProps, "Box"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CardProps, "Card"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ContainerProps, "Container"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CopyableProps, "Copyable"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Divider"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").LinkProps, "Link"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").RowProps, "Row"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Spinner"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TextProps, "Text"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TooltipProps, "Tooltip"> | {
-        value: string;
+    ui: import("@metamask/superstruct").Struct<import("@metamask/snaps-sdk").Panel | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ButtonProps, "Button"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CheckboxProps, "Checkbox"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FormProps, "Form"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FileInputProps, "FileInput"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").InputProps, "Input"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").DropdownProps, "Dropdown"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SelectorProps, "Selector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoldProps, "Bold"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ItalicProps, "Italic"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AddressProps, "Address"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoxProps, "Box"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CardProps, "Card"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ContainerProps, "Container"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CopyableProps, "Copyable"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Divider"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").IconProps, "Icon"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").LinkProps, "Link"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").RowProps, "Row"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SectionProps, "Section"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Spinner"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TextProps, "Text"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TooltipProps, "Tooltip"> | {
         type: import("@metamask/snaps-sdk").NodeType.Copyable;
+        value: string;
         sensitive?: boolean | undefined;
     } | {
         type: import("@metamask/snaps-sdk").NodeType.Divider;
     } | {
-        value: string;
         type: import("@metamask/snaps-sdk").NodeType.Heading;
-    } | {
         value: string;
+    } | {
         type: import("@metamask/snaps-sdk").NodeType.Image;
+        value: string;
     } | {
         type: import("@metamask/snaps-sdk").NodeType.Spinner;
     } | {
-        value: string;
         type: import("@metamask/snaps-sdk").NodeType.Text;
+        value: string;
         markdown?: boolean | undefined;
     } | {
-        value: `0x${string}`;
         type: import("@metamask/snaps-sdk").NodeType.Address;
+        value: `0x${string}`;
     } | {
+        type: import("@metamask/snaps-sdk").NodeType.Row;
         value: {
-            value: string;
             type: import("@metamask/snaps-sdk").NodeType.Image;
-        } | {
             value: string;
+        } | {
             type: import("@metamask/snaps-sdk").NodeType.Text;
+            value: string;
             markdown?: boolean | undefined;
         } | {
-            value: `0x${string}`;
             type: import("@metamask/snaps-sdk").NodeType.Address;
+            value: `0x${string}`;
         };
-        type: import("@metamask/snaps-sdk").NodeType.Row;
-        label: string;
+        label: string; /**
+         * Validate the createInterface 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 createInterface method parameter object.
+         */
         variant?: "default" | "warning" | "critical" | undefined;
     } | {
         type: import("@metamask/snaps-sdk").NodeType.Input;
         name: string;
-        value?: string | undefined;
         error?: string | undefined;
-        label?: string | undefined;
         inputType?: "number" | "text" | "password" | undefined;
+        value?: string | undefined;
+        label?: string | undefined;
         placeholder?: string | undefined;
     } | {
-        value: string;
         type: import("@metamask/snaps-sdk").NodeType.Button;
-        name?: string | undefined;
+        value: string;
         variant?: "primary" | "secondary" | undefined;
+        name?: string | undefined;
         buttonType?: "button" | "submit" | undefined;
     } | {
         type: import("@metamask/snaps-sdk").NodeType.Form;
@@ -149,19 +161,22 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
         children: ({
             type: import("@metamask/snaps-sdk").NodeType.Input;
             name: string;
-            value?: string | undefined;
             error?: string | undefined;
-            label?: string | undefined;
             inputType?: "number" | "text" | "password" | undefined;
+            value?: string | undefined;
+            label?: string | undefined;
             placeholder?: string | undefined;
         } | {
-            value: string;
             type: import("@metamask/snaps-sdk").NodeType.Button;
-            name?: string | undefined;
+            value: string;
             variant?: "primary" | "secondary" | undefined;
+            name?: string | undefined;
             buttonType?: "button" | "submit" | undefined;
         })[];
     } | import("@metamask/snaps-sdk/jsx").SnapElement<{
+        src: string;
+        alt?: string | undefined;
+    }, "Image"> | import("@metamask/snaps-sdk/jsx").SnapElement<{
         name: string;
         value?: string | undefined;
         children: import("@metamask/snaps-sdk/jsx").SnapsChildren<import("@metamask/snaps-sdk/jsx").SnapElement<{
@@ -170,11 +185,9 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
         }, "Radio">>;
     }, "RadioGroup"> | import("@metamask/snaps-sdk/jsx").SnapElement<{
         children: import("@metamask/snaps-sdk/jsx").StringElement;
-    }, "Heading"> | import("@metamask/snaps-sdk/jsx").SnapElement<{
-        src: string;
-        alt?: string | undefined;
-    }, "Image">, null>;
+    }, "Heading">, null>;
     context: import("@metamask/superstruct").Struct<Record<string, import("@metamask/snaps-sdk").Json> | undefined, null>;
 }>;
 export type CreateInterfaceParameters = InferMatching<typeof CreateInterfaceParametersStruct, CreateInterfaceParams>;
 export {};
+//# sourceMappingURL=createInterface.d.cts.map

package/dist/permitted/createInterface.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createInterface.d.cts","sourceRoot":"","sources":["../../src/permitted/createInterface.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EAErB,kBAAkB,EAClB,gBAAgB,EACjB,4BAA4B;AAK7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAU3D,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;OAGG;IACH,eAAe,EAAE,CACf,EAAE,EAAE,kBAAkB,EACtB,OAAO,CAAC,EAAE,gBAAgB,KACvB,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CACzD,0BAA0B,EAC1B,yBAAyB,EACzB,qBAAqB,CAKtB,CAAC;AAEF,QAAA,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBA4CrC;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBANH;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA/CD,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,aAAa,CACnD,OAAO,+BAA+B,EACtC,qBAAqB,CACtB,CAAC"}