Add tests and docs

MetaMask · Mar 1, 2024 · 255d810 · 255d810
1 parent c813f09
commit 255d810
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/packages/snaps-execution-environments/src/common/validation.test.ts b/packages/snaps-execution-environments/src/common/validation.test.ts
@@ -165,6 +165,14 @@ describe('assertIsOnUserInputRequestArguments', () => {
         value: { foo: 'bar' },
       },
     },
+    {
+      id: 'foo',
+      event: {
+        type: UserInputEventType.InputChangeEvent,
+        name: 'input',
+        value: 'bar',
+      },
+    },
   ])('does not throw for a valid user input param object', (value) => {
     expect(() => assertIsOnUserInputRequestArguments(value)).not.toThrow();
   });

diff --git a/packages/snaps-sdk/src/types/handlers/user-input.test.ts b/packages/snaps-sdk/src/types/handlers/user-input.test.ts
@@ -2,8 +2,9 @@ import { UserInputEventType } from './user-input';
 
 describe('UserInputEventType', () => {
   it('has the correct values', () => {
-    expect(Object.values(UserInputEventType)).toHaveLength(2);
+    expect(Object.values(UserInputEventType)).toHaveLength(3);
     expect(UserInputEventType.ButtonClickEvent).toBe('ButtonClickEvent');
     expect(UserInputEventType.FormSubmitEvent).toBe('FormSubmitEvent');
+    expect(UserInputEventType.InputChangeEvent).toBe('InputChangeEvent');
   });
 });
diff --git a/packages/snaps-sdk/src/types/handlers/user-input.ts b/packages/snaps-sdk/src/types/handlers/user-input.ts
@@ -11,10 +11,11 @@ import {
 
 /**
  * The type of user input event fired.
- * Currently only two events are supported:
+ * Currently only three events are supported:
  *
  * - `ButtonClickEvent` - A button has been clicked in the UI.
  * - `FormSubmitEvent` - A Form has been submitted in the UI.
+ * - `InputChangeEvent` - The value of an input field has changed in the UI.
  */
 export enum UserInputEventType {
   ButtonClickEvent = 'ButtonClickEvent',