feat: allow more than two states (#37)

Co-authored-by: Richard Herman <[email protected]>

CHANGELOG.md

@@ -11,7 +11,7 @@
 
 # Change Log
 
-## vNext
+## Unreleased
 
 ### ✨ New
 
@@ -32,6 +32,7 @@
 
 -   Update layout and manifest references to propagate from [`@elgato/schemas`](https://github.com/elgatosf/schemas).
 -   Localization lookup will now return the key if the resource is not defined.
+-   Update `State` type to allow for more than two states.
 
 ### ➡️ Migration
 

src/api/events/__tests__/action.test.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { Coordinates, WillAppear, WillDisappear } from "..";
+import { Coordinates, WillAppear, WillDisappear, type State } from "..";
 import { Expect, TypesAreEqual } from "../../../../tests/utils";
 import { Settings } from "../../__mocks__/events";
 
@@ -21,7 +21,7 @@ describe("action event types", () => {
 							readonly controller: "Encoder" | "Keypad";
 							readonly coordinates: Coordinates;
 							settings: Settings;
-							readonly state?: 0 | 1;
+							readonly state?: State;
 						};
 				  }
 				| {
@@ -33,7 +33,7 @@ describe("action event types", () => {
 							readonly isInMultiAction: true;
 							readonly controller: "Keypad";
 							settings: Settings;
-							readonly state?: 0 | 1;
+							readonly state?: State;
 						};
 				  }
 			>
@@ -57,7 +57,7 @@ describe("action event types", () => {
 							readonly controller: "Encoder" | "Keypad";
 							readonly coordinates: Coordinates;
 							settings: Settings;
-							readonly state?: 0 | 1;
+							readonly state?: State;
 						};
 				  }
 				| {
@@ -69,7 +69,7 @@ describe("action event types", () => {
 							readonly isInMultiAction: true;
 							readonly controller: "Keypad";
 							settings: Settings;
-							readonly state?: 0 | 1;
+							readonly state?: State;
 						};
 				  }
 			>

src/api/events/action.ts

@@ -177,4 +177,4 @@ export type Coordinates = {
 /**
  * Possible states an action can be in. This only applies to actions that have multiple states defined in the plugin's manifest.json file.
  */
-export type State = 0 | 1;
+export type State = number;