@metamask/snaps-sdk 6.1.0 → 6.2.0

package/dist/types/types/methods/get-preferences.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The request parameters for the `snap_getPreferences` method.
+ *
+ * This method does not accept any parameters.
+ */
+export type GetPreferencesParams = never;
+/**
+ * The result returned by the `snap_getPreferences` method.
+ *
+ * It is the user selected preferences from the MetaMask extension.
+ */
+export type GetPreferencesResult = {
+    locale: string;
+    currency: string;
+};

package/dist/types/types/methods/get-snaps.d.ts

@@ -5,12 +5,12 @@ import type { Snap, SnapId } from '../snap';
  *
  * This method does not accept any parameters.
  */
-export declare type GetSnapsParams = never;
+export type GetSnapsParams = never;
 /**
  * The result returned by the `wallet_getSnaps` method.
  *
  * It consists of a map of Snap IDs to either the Snap object or an error.
  */
-export declare type GetSnapsResult = Record<SnapId, {
+export type GetSnapsResult = Record<SnapId, {
     error: JsonRpcError;
 } | Snap>;

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

@@ -8,6 +8,7 @@ export * from './get-entropy';
 export * from './get-file';
 export * from './get-interface-state';
 export * from './get-locale';
+export * from './get-preferences';
 export * from './get-snaps';
 export * from './invoke-keyring';
 export * from './invoke-snap';

package/dist/types/types/methods/invoke-keyring.d.ts

@@ -6,9 +6,9 @@ import type { InvokeSnapParams } from './invoke-snap';
  * @property snapId - The ID of the snap to invoke.
  * @property request - The JSON-RPC request to send to the snap.
  */
-export declare type InvokeKeyringParams = InvokeSnapParams;
+export type InvokeKeyringParams = InvokeSnapParams;
 /**
  * The result returned by the `wallet_invokeKeyring` method, which is the result
  * returned by the Snap.
  */
-export declare type InvokeKeyringResult = Json;
+export type InvokeKeyringResult = Json;

package/dist/types/types/methods/invoke-snap.d.ts

@@ -5,7 +5,7 @@ import type { Json } from '@metamask/utils';
  * @property snapId - The ID of the Snap to invoke.
  * @property request - The JSON-RPC request to send to the Snap.
  */
-export declare type InvokeSnapParams = {
+export type InvokeSnapParams = {
     snapId: string;
     request: Record<string, Json>;
 };
@@ -13,4 +13,4 @@ export declare type InvokeSnapParams = {
  * The result returned by the `wallet_invokeSnap` method, which is the result
  * returned by the Snap.
  */
-export declare type InvokeSnapResult = Json;
+export type InvokeSnapResult = Json;

package/dist/types/types/methods/manage-accounts.d.ts

@@ -5,7 +5,7 @@ import type { Json } from '@metamask/utils';
  * @property method - The method to call on the Snap.
  * @property params - The optional parameters to pass to the Snap method.
  */
-export declare type ManageAccountsParams = {
+export type ManageAccountsParams = {
     method: string;
 } | {
     method: string;
@@ -15,4 +15,4 @@ export declare type ManageAccountsParams = {
  * The result returned by the `snap_manageAccounts` method, which is the result
  * returned by the Snap.
  */
-export declare type ManageAccountsResult = Json;
+export type ManageAccountsResult = Json;

package/dist/types/types/methods/manage-state.d.ts

@@ -17,7 +17,7 @@ export declare enum ManageStateOperation {
  * be used if the extension is unlocked, while unencrypted state can be used
  * whether the extension is locked or unlocked.
  */
-export declare type ClearStateOperation = {
+export type ClearStateOperation = {
     operation: EnumToUnion<ManageStateOperation.ClearState>;
     encrypted?: boolean;
 };
@@ -30,7 +30,7 @@ export declare type ClearStateOperation = {
  * be used if the extension is unlocked, while unencrypted state can be used
  * whether the extension is locked or unlocked.
  */
-export declare type GetStateOperation = {
+export type GetStateOperation = {
     operation: EnumToUnion<ManageStateOperation.GetState>;
     encrypted?: boolean;
 };
@@ -45,7 +45,7 @@ export declare type GetStateOperation = {
  * whether the extension is locked or unlocked.
  * @property newState - The new state to set.
  */
-export declare type UpdateStateOperation = {
+export type UpdateStateOperation = {
     operation: EnumToUnion<ManageStateOperation.UpdateState>;
     encrypted?: boolean;
     newState: Record<string, Json>;
@@ -59,11 +59,11 @@ export declare type UpdateStateOperation = {
  * @property newState - The new state to set. Only applicable for the `set`
  * operation.
  */
-export declare type ManageStateParams = ClearStateOperation | GetStateOperation | UpdateStateOperation;
+export type ManageStateParams = ClearStateOperation | GetStateOperation | UpdateStateOperation;
 /**
  * The result returned by the `snap_manageState` method.
  *
  * If the operation is `get`, the result is the state. Otherwise, the result is
  * `null`.
  */
-export declare type ManageStateResult = Record<string, Json> | null;
+export type ManageStateResult = Record<string, Json> | null;

package/dist/types/types/methods/methods.d.ts

@@ -9,6 +9,7 @@ import type { GetEntropyParams, GetEntropyResult } from './get-entropy';
 import type { GetFileParams, GetFileResult } from './get-file';
 import type { GetInterfaceStateParams, GetInterfaceStateResult } from './get-interface-state';
 import type { GetLocaleParams, GetLocaleResult } from './get-locale';
+import type { GetPreferencesParams, GetPreferencesResult } from './get-preferences';
 import type { GetSnapsParams, GetSnapsResult } from './get-snaps';
 import type { InvokeKeyringParams, InvokeKeyringResult } from './invoke-keyring';
 import type { InvokeSnapParams, InvokeSnapResult } from './invoke-snap';
@@ -22,7 +23,7 @@ import type { UpdateInterfaceParams, UpdateInterfaceResult } from './update-inte
  * The methods that are available to the Snap. Each method is a tuple of the
  * request parameters and the result returned by the method.
  */
-export declare type SnapMethods = {
+export type SnapMethods = {
     snap_dialog: [DialogParams, DialogResult];
     snap_getBip32Entropy: [GetBip32EntropyParams, GetBip32EntropyResult];
     snap_getBip32PublicKey: [GetBip32PublicKeyParams, GetBip32PublicKeyResult];
@@ -31,6 +32,7 @@ export declare type SnapMethods = {
     snap_getEntropy: [GetEntropyParams, GetEntropyResult];
     snap_getFile: [GetFileParams, GetFileResult];
     snap_getLocale: [GetLocaleParams, GetLocaleResult];
+    snap_getPreferences: [GetPreferencesParams, GetPreferencesResult];
     snap_manageAccounts: [ManageAccountsParams, ManageAccountsResult];
     snap_manageState: [ManageStateParams, ManageStateResult];
     snap_notify: [NotifyParams, NotifyResult];
@@ -69,4 +71,4 @@ export declare type SnapMethods = {
  *   },
  * });
  */
-export declare type RequestFunction = <MethodName extends keyof SnapMethods>(request: Method<MethodName, SnapMethods[MethodName][0]>) => Promise<SnapMethods[MethodName][1]>;
+export type RequestFunction = <MethodName extends keyof SnapMethods>(request: Method<MethodName, SnapMethods[MethodName][0]>) => Promise<SnapMethods[MethodName][1]>;

package/dist/types/types/methods/notify.d.ts

@@ -15,7 +15,7 @@ export declare enum NotificationType {
  * @property type - The type of notification to display.
  * @property message - The message to display in the notification.
  */
-export declare type NotifyParams = {
+export type NotifyParams = {
     type: EnumToUnion<NotificationType>;
     message: string;
 };
@@ -24,4 +24,4 @@ export declare type NotifyParams = {
  *
  * This method does not return anything.
  */
-export declare type NotifyResult = null;
+export type NotifyResult = null;

package/dist/types/types/methods/request-snaps.d.ts

@@ -5,7 +5,7 @@ import type { Snap } from '../snap';
  *
  * It consists of a map of Snap IDs to optional version strings to request.
  */
-export declare type RequestSnapsParams = Record<string, {
+export type RequestSnapsParams = Record<string, {
     version?: string;
 }>;
 /**
@@ -13,6 +13,6 @@ export declare type RequestSnapsParams = Record<string, {
  *
  * It consists of a map of Snap IDs to either the Snap object or an error.
  */
-export declare type RequestSnapsResult = Record<string, {
+export type RequestSnapsResult = Record<string, {
     error: JsonRpcError;
 } | Snap>;

package/dist/types/types/methods/resolve-interface.d.ts

@@ -5,11 +5,11 @@ import type { Json } from '@metamask/utils';
  * @property id - The interface id.
  * @property value - The value to resolve the interface with.
  */
-export declare type ResolveInterfaceParams = {
+export type ResolveInterfaceParams = {
     id: string;
     value: Json;
 };
 /**
  * The result returned by the `snap_resolveInterface` method.
  */
-export declare type ResolveInterfaceResult = null;
+export type ResolveInterfaceResult = null;

package/dist/types/types/methods/update-interface.d.ts

@@ -5,11 +5,11 @@ import type { ComponentOrElement } from '..';
  * @property id - The interface id.
  * @property ui - The components to display in the interface.
  */
-export declare type UpdateInterfaceParams = {
+export type UpdateInterfaceParams = {
     id: string;
     ui: ComponentOrElement;
 };
 /**
  * The result returned by the `snap_updateInterface` method.
  */
-export declare type UpdateInterfaceResult = null;
+export type UpdateInterfaceResult = null;

package/dist/types/types/permissions.d.ts

@@ -1,12 +1,12 @@
 import type { SupportedCurve } from '@metamask/key-tree';
 import type { JsonRpcRequest } from '@metamask/utils';
 import type { ChainId } from './caip';
-export declare type EmptyObject = Record<string, never>;
-export declare type Cronjob = {
+export type EmptyObject = Record<string, never>;
+export type Cronjob = {
     expression: string;
     request: Omit<JsonRpcRequest, 'jsonrpc' | 'id'>;
 };
-export declare type NameLookupMatchers = {
+export type NameLookupMatchers = {
     tlds: string[];
 } | {
     schemes: string[];
@@ -14,17 +14,17 @@ export declare type NameLookupMatchers = {
     tlds: string[];
     schemes: string[];
 };
-export declare type Bip32Entropy = {
+export type Bip32Entropy = {
     curve: SupportedCurve;
     path: string[];
 };
-export declare type Bip44Entropy = {
+export type Bip44Entropy = {
     coinType: number;
 };
-export declare type RequestedSnap = {
+export type RequestedSnap = {
     version?: string;
 };
-export declare type InitialPermissions = Partial<{
+export type InitialPermissions = Partial<{
     'endowment:cronjob': {
         jobs: Cronjob[];
         maxRequestTime?: number;

package/dist/types/types/provider.d.ts

@@ -1,14 +1,14 @@
 import type { BaseProvider } from '@metamask/providers';
 import type { RequestFunction } from './methods';
-declare type BaseProviderInstance = InstanceType<typeof BaseProvider>;
+type BaseProviderInstance = InstanceType<typeof BaseProvider>;
 /**
  * The `window.ethereum` provider for Snaps.
  */
-export declare type SnapsEthereumProvider = Pick<BaseProviderInstance, 'request'>;
+export type SnapsEthereumProvider = Pick<BaseProviderInstance, 'request'>;
 /**
  * The `window.snap` provider.
  */
-export declare type SnapsProvider = {
+export type SnapsProvider = {
     request: RequestFunction;
 };
 export {};

package/dist/types/types/snap.d.ts

@@ -1,8 +1,8 @@
 import type { SemVerVersion, Opaque } from '@metamask/utils';
 import type { InitialPermissions } from './permissions';
-export declare type SnapId = Opaque<string, typeof snapIdSymbol>;
+export type SnapId = Opaque<string, typeof snapIdSymbol>;
 declare const snapIdSymbol: unique symbol;
-export declare type Snap = {
+export type Snap = {
     id: SnapId;
     initialPermissions: InitialPermissions;
     version: SemVerVersion;

package/dist/types/ui/builder.d.ts

@@ -7,7 +7,7 @@ import type { NodeType } from './nodes';
  *
  * @internal
  */
-declare type NodeBuilder<Node extends Component, Keys extends (keyof Node)[]> = Omit<Node, 'type'> extends Record<string, never> ? (...args: []) => Node : (...args: [Omit<Node, 'type'>] | NodeArrayType<Node, Keys>) => Node;
+type NodeBuilder<Node extends Component, Keys extends (keyof Node)[]> = Omit<Node, 'type'> extends Record<string, never> ? (...args: []) => Node : (...args: [Omit<Node, 'type'>] | NodeArrayType<Node, Keys>) => Node;
 /**
  * Map from an array of node keys to the corresponding array type.
  *
@@ -18,7 +18,7 @@ declare type NodeBuilder<Node extends Component, Keys extends (keyof Node)[]> =
  * type NodeArray = NodeArrayType<Node, Keys>; // [string, number, boolean]
  * @internal
  */
-declare type NodeArrayType<Node extends Component, Keys extends (keyof Node)[]> = {
+type NodeArrayType<Node extends Component, Keys extends (keyof Node)[]> = {
     [Key in keyof Keys]: Node[Keys[Key]];
 };
 /**

package/dist/types/ui/components/address.d.ts

@@ -13,7 +13,7 @@ export declare const AddressStruct: import("@metamask/superstruct").Struct<{
  * @property type - The type of the node. Must be the string `address`.
  * @property value - The address in hexadecimal, including 0x.
  */
-export declare type Address = Infer<typeof AddressStruct>;
+export type Address = Infer<typeof AddressStruct>;
 /**
  * Create an {@link Address} node.
  *

package/dist/types/ui/components/button.d.ts

@@ -30,7 +30,7 @@ export declare const ButtonStruct: import("@metamask/superstruct").Struct<{
  * @property buttonType - The type of the button, must be either 'button' or 'submit'.
  * @property name - An optional name to identify the button.
  */
-export declare type Button = Infer<typeof ButtonStruct>;
+export type Button = Infer<typeof ButtonStruct>;
 /**
  * Create a {@link Button} node.
  *

package/dist/types/ui/components/copyable.d.ts

@@ -20,7 +20,7 @@ export declare const CopyableStruct: import("@metamask/superstruct").Struct<{
  * are only displayed to the user after clicking on the component. Defaults to
  * false.
  */
-export declare type Copyable = Infer<typeof CopyableStruct>;
+export type Copyable = Infer<typeof CopyableStruct>;
 /**
  * Create a {@link Copyable} component.
  *

package/dist/types/ui/components/divider.d.ts

@@ -8,7 +8,7 @@ export declare const DividerStruct: import("@metamask/superstruct").Struct<{
 /**
  * A divider node, that renders a line between other nodes.
  */
-export declare type Divider = Infer<typeof DividerStruct>;
+export type Divider = Infer<typeof DividerStruct>;
 /**
  * Create a {@link Divider} node.
  *

package/dist/types/ui/components/form.d.ts

@@ -18,7 +18,7 @@ export declare const FormComponentStruct: import("@metamask/superstruct").Struct
 /**
  * The subset of nodes allowed as children in the {@link Form} node.
  */
-export declare type FormComponent = Infer<typeof FormComponentStruct>;
+export type FormComponent = Infer<typeof FormComponentStruct>;
 export declare const FormStruct: import("@metamask/superstruct").Struct<{
     type: NodeType.Form;
     name: string;
@@ -77,7 +77,7 @@ export declare const FormStruct: import("@metamask/superstruct").Struct<{
  * @property children - The children of the node. Only {@link FormComponent} nodes are allowed.
  * @property name - The form name used to identify it.
  */
-export declare type Form = Infer<typeof FormStruct>;
+export type Form = Infer<typeof FormStruct>;
 /**
  * Create a {@link Form} node.
  *

package/dist/types/ui/components/heading.d.ts

@@ -15,7 +15,7 @@ export declare const HeadingStruct: import("@metamask/superstruct").Struct<{
  * @property value - The text content of the node, either as plain text, or as a
  * markdown string.
  */
-export declare type Heading = Infer<typeof HeadingStruct>;
+export type Heading = Infer<typeof HeadingStruct>;
 /**
  * Create a {@link Heading} node.
  *

package/dist/types/ui/components/image.d.ts

@@ -13,7 +13,7 @@ export declare const ImageStruct: import("@metamask/superstruct").Struct<{
  * @property type - The type of the node. Must be the string `image`.
  * @property value - The SVG image to be rendered.
  */
-export declare type Image = Infer<typeof ImageStruct>;
+export type Image = Infer<typeof ImageStruct>;
 /**
  * Create an {@link Image} node.
  *

package/dist/types/ui/components/input.d.ts

@@ -37,7 +37,7 @@ export declare const InputStruct: import("@metamask/superstruct").Struct<{
  * @property label - An optional input label.
  * @property error - An optional error text.
  */
-export declare type Input = Infer<typeof InputStruct>;
+export type Input = Infer<typeof InputStruct>;
 /**
  * Create a {@link Input} node.
  *

package/dist/types/ui/components/panel.d.ts

@@ -222,7 +222,7 @@ export declare const ParentStruct: Struct<{
  * @property children - The children of the node
  * @internal
  */
-export declare type Parent = Infer<typeof ParentStruct>;
+export type Parent = Infer<typeof ParentStruct>;
 /**
  * @internal
  */
@@ -234,7 +234,7 @@ export declare const PanelStruct: Struct<Panel>;
  * @property value - The text content of the node, either as plain text, or as a
  * markdown string.
  */
-export declare type Panel = {
+export type Panel = {
     type: NodeType.Panel;
     children: Component[];
 };
@@ -402,4 +402,4 @@ export declare const ComponentStruct: Struct<{
 /**
  * All supported component types.
  */
-export declare type Component = Infer<typeof ComponentStruct>;
+export type Component = Infer<typeof ComponentStruct>;

package/dist/types/ui/components/row.d.ts

@@ -45,7 +45,7 @@ export declare const RowStruct: import("@metamask/superstruct").Struct<{
  * on one side of the row.
  * @property variant - Optional variant for styling.
  */
-export declare type Row = Infer<typeof RowStruct>;
+export type Row = Infer<typeof RowStruct>;
 /**
  * Create a {@link Row} node.
  *

package/dist/types/ui/components/spinner.d.ts

@@ -9,7 +9,7 @@ export declare const SpinnerStruct: import("@metamask/superstruct").Struct<{
  * A spinner node, that renders a spinner, either as a full-screen overlay, or
  * inline when nested inside a {@link Panel}.
  */
-export declare type Spinner = Infer<typeof SpinnerStruct>;
+export type Spinner = Infer<typeof SpinnerStruct>;
 /**
  * Create a {@link Spinner} node.
  *

package/dist/types/ui/components/text.d.ts

@@ -18,7 +18,7 @@ export declare const TextStruct: import("@metamask/superstruct").Struct<{
  * @property markdown - A flag to enable/disable markdown, if nothing is specified
  * markdown will be enabled.
  */
-export declare type Text = Infer<typeof TextStruct>;
+export type Text = Infer<typeof TextStruct>;
 /**
  * Create a {@link Text} node.
  *

package/dist/types/ui/nodes.d.ts

@@ -33,7 +33,7 @@ export declare const NodeStruct: import("@metamask/superstruct").Struct<{
  * node types.
  * @internal
  */
-export declare type Node = Infer<typeof NodeStruct>;
+export type Node = Infer<typeof NodeStruct>;
 /**
  * @internal
  */
@@ -53,4 +53,4 @@ export declare const LiteralStruct: import("@metamask/superstruct").Struct<{
  * node type.
  * @internal
  */
-export declare type Literal = Infer<typeof LiteralStruct>;
+export type Literal = Infer<typeof LiteralStruct>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-sdk",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"
@@ -60,7 +60,7 @@
   },
   "dependencies": {
     "@metamask/key-tree": "^9.1.2",
-    "@metamask/providers": "17.0.0",
+    "@metamask/providers": "^17.1.2",
     "@metamask/rpc-errors": "^6.3.1",
     "@metamask/superstruct": "^3.1.0",
     "@metamask/utils": "^9.1.0"
@@ -95,7 +95,7 @@
     "rimraf": "^4.1.2",
     "ts-jest": "^29.1.1",
     "tsup": "^8.0.1",
-    "typescript": "~4.8.4"
+    "typescript": "~5.0.4"
   },
   "engines": {
     "node": "^18.16 || >=20"