feat: enable serialization of enumerable and actions (#79)

* feat: add reflective serialization of objects with getters * feat: enable serialization of enumerable * feat: enable serialization of action instances * fix: linting * test: add tests for KeyAction and DialAction serialization --------- Co-authored-by: Richard Herman <[email protected]>
elgatosf · Jan 17, 2025 · 7d0cd10 · 7d0cd10
1 parent e7bdd5f
commit 7d0cd10
Show file tree

Hide file tree

Showing 7 changed files with 137 additions and 0 deletions.
diff --git a/src/common/__tests__/enumerable.test.ts b/src/common/__tests__/enumerable.test.ts
@@ -813,4 +813,24 @@ describe("Enumerable", () => {
 			expect(res).toHaveLength(0);
 		});
 	});
+
+	/**
+	 * Provides assertions for {@link Enumerable.toJSON}.
+	 */
+	test("toJSON", () => {
+		const arr = ["One", "Two"];
+		const enumerable = new Enumerable(arr);
+
+		expect(JSON.stringify(arr)).toEqual(JSON.stringify(enumerable));
+	});
+
+	/**
+	 * Provides assertions for {@link Enumerable.toString}.
+	 */
+	test("toString", () => {
+		const arr = ["One", "Two"];
+		const enumerable = new Enumerable(arr);
+
+		expect(arr.toString()).toEqual(enumerable.toString());
+	});
 });
diff --git a/src/common/enumerable.ts b/src/common/enumerable.ts
@@ -339,4 +339,20 @@ export class Enumerable<T> implements IterableIterator<T> {
 	public toArray(): T[] {
 		return Array.from(this);
 	}
+
+	/**
+	 * Converts this iterator to serializable collection.
+	 * @returns The serializable collection of items.
+	 */
+	public toJSON(): T[] {
+		return this.toArray();
+	}
+
+	/**
+	 * Converts this iterator to a string.
+	 * @returns The string.
+	 */
+	public toString(): string {
+		return `${this.toArray()}`;
+	}
 }
diff --git a/src/plugin/actions/__tests__/dial.test.ts b/src/plugin/actions/__tests__/dial.test.ts
@@ -88,6 +88,39 @@ describe("DialAction", () => {
 		expect(() => new DialAction(keypadSource)).toThrow();
 	});
 
+	/**
+	 * Asserts {@link DialAction.toJSON} includes properties.
+	 */
+	it("JSON has properties", () => {
+		// Array.
+		const action = new DialAction({
+			action: "action1",
+			context: "com.test.action.one",
+			device: "dev1",
+			event: "willAppear",
+			payload: {
+				controller: "Encoder",
+				settings: {},
+				isInMultiAction: false,
+				coordinates: {
+					column: 1,
+					row: 2,
+				},
+			},
+		});
+
+		// Act.
+		const jsonStr = JSON.stringify(action);
+		const jsonObj: DialAction = JSON.parse(jsonStr);
+
+		// Assert.
+		expect(jsonObj.controllerType).toBe(action.controllerType);
+		expect(jsonObj.coordinates).toStrictEqual(action.coordinates);
+		expect(jsonObj.device).toStrictEqual({ id: action.device.id });
+		expect(jsonObj.id).toBe(action.id);
+		expect(jsonObj.manifestId).toBe(action.manifestId);
+	});
+
 	describe("sending", () => {
 		let action!: DialAction;
 		beforeAll(() => (action = new DialAction(source)));

diff --git a/src/plugin/actions/__tests__/key.test.ts b/src/plugin/actions/__tests__/key.test.ts
@@ -118,6 +118,40 @@ describe("KeyAction", () => {
 		expect(action.coordinates).toBeUndefined();
 	});
 
+	/**
+	 * Asserts {@link KeyAction.toJSON} includes properties.
+	 */
+	it("JSON has properties", () => {
+		// Array.
+		const action = new KeyAction({
+			action: "action1",
+			context: "com.test.action.one",
+			device: "dev1",
+			event: "willAppear",
+			payload: {
+				controller: "Keypad",
+				settings: {},
+				isInMultiAction: false,
+				coordinates: {
+					column: 1,
+					row: 2,
+				},
+			},
+		});
+
+		// Act.
+		const jsonStr = JSON.stringify(action);
+		const jsonObj: KeyAction = JSON.parse(jsonStr);
+
+		// Assert.
+		expect(jsonObj.controllerType).toBe(action.controllerType);
+		expect(jsonObj.coordinates).toStrictEqual(action.coordinates);
+		expect(jsonObj.device).toStrictEqual({ id: action.device.id });
+		expect(jsonObj.id).toBe(action.id);
+		expect(jsonObj.isInMultiAction).toBe(action.isInMultiAction());
+		expect(jsonObj.manifestId).toBe(action.manifestId);
+	});
+
 	describe("sending", () => {
 		let action!: KeyAction;
 		beforeAll(() => (action = new KeyAction(source)));

diff --git a/src/plugin/actions/context.ts b/src/plugin/actions/context.ts
@@ -65,4 +65,17 @@ export class ActionContext {
 	public get manifestId(): string {
 		return this.#source.action;
 	}
+
+	/**
+	 * Converts this instance to a serializable object.
+	 * @returns The serializable object.
+	 */
+	public toJSON(): object {
+		return {
+			controllerType: this.controllerType,
+			device: this.device,
+			id: this.id,
+			manifestId: this.manifestId,
+		};
+	}
 }
diff --git a/src/plugin/actions/dial.ts b/src/plugin/actions/dial.ts
@@ -114,6 +114,16 @@ export class DialAction<T extends JsonObject = JsonObject> extends Action<T> {
 			payload: descriptions || {},
 		});
 	}
+
+	/**
+	 * @inheritdoc
+	 */
+	public override toJSON(): object {
+		return {
+			...super.toJSON(),
+			coordinates: this.coordinates,
+		};
+	}
 }
 
 /**

diff --git a/src/plugin/actions/key.ts b/src/plugin/actions/key.ts
@@ -115,6 +115,17 @@ export class KeyAction<T extends JsonObject = JsonObject> extends Action<T> {
 			context: this.id,
 		});
 	}
+
+	/**
+	 * @inheritdoc
+	 */
+	public override toJSON(): object {
+		return {
+			...super.toJSON(),
+			coordinates: this.coordinates,
+			isInMultiAction: this.isInMultiAction(),
+		};
+	}
 }
 
 /**