add response value to getActionStatus

Author: Marcisbee

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 2.8.0
+
+### Feature
+* Allow to read action response/return value from `getActionStatus` function.
+
 ## 2.7.0
 
 ### Feature
@@ -23,7 +28,7 @@
 ## 2.5.0
 
 ### Feature
-* Allows deep inheritence.
+* Allows deep inheritance.
 
 ## 2.4.4
 

deno.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://jsr.io/schema/config-file.v1.json",
   "name": "@exome/exome",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "publish": {
     "include": ["LICENSE", "README.md", "deno.json", "package.json", "src", "logo"],
     "exclude": ["src/**/*.test.ts"]

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "exome",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "State manager for deeply nested states",
   "main": "./dist/exome.js",
   "module": "./dist/exome.mjs",

package.json

@@ -136,5 +136,41 @@ const { getActionStatus } = proxyquire
 		assert.equal(String(test1.status.error), "Error: Poop");
 	});
 
+	test("returns response", async () => {
+		class TestStore extends Exome {
+			public get status() {
+				return getActionStatus(this, "run");
+			}
+			public async run() {
+				return "Poop";
+			}
+		}
+		const test1 = new TestStore();
+
+		// biome-ignore lint/suspicious/noSelfCompare: it's a getter, not pointless!
+		assert.ok(test1.status === test1.status);
+
+		assert.snapshot(
+			JSON.stringify(test1.status),
+			`{"loading":false,"error":false}`,
+		);
+
+		const promise = test1.run();
+
+		assert.snapshot(
+			JSON.stringify(test1.status),
+			`{"loading":true,"error":false}`,
+		);
+
+		try {
+			await promise;
+		} catch (_) {}
+
+		assert.snapshot(
+			JSON.stringify(test1.status),
+			`{"loading":false,"error":false,"response":"Poop"}`,
+		);
+	});
+
 	test.run();
 }

src/utils.test.ts

@@ -3,9 +3,10 @@
  */
 import { type Exome, addMiddleware, getExomeId, update } from "exome";
 
-interface ActionStatus<E = any> {
+interface ActionStatus<E = any, R = any> {
 	loading: boolean;
 	error: false | E;
+	response: void | R;
 	unsubscribe: () => void;
 }
 
@@ -14,10 +15,10 @@ const actionStatusCache: Record<string, ActionStatus> = {};
 /**
  * Subscribes to specific action in specific instance and returns satus about that action.
  */
-export function getActionStatus<E = Error, T extends Exome = any>(
+export function getActionStatus<E = Error, T extends Exome = any, R = any>(
 	store: T,
 	action: keyof T,
-): ActionStatus<E> {
+): ActionStatus<E, R> {
 	const key = getExomeId(store) + ":" + (action as string);
 	let cached = actionStatusCache[key];
 
@@ -28,6 +29,7 @@ export function getActionStatus<E = Error, T extends Exome = any>(
 	cached = actionStatusCache[key] = {
 		loading: false,
 		error: false,
+		response: undefined,
 		unsubscribe() {
 			unsubscribe();
 			actionStatusCache[key] = undefined as any;
@@ -45,16 +47,18 @@ export function getActionStatus<E = Error, T extends Exome = any>(
 		const currentActionIndex = actionIndex;
 		cached.loading = true;
 		cached.error = false;
+		cached.response = undefined;
 
 		update(instance);
 
-		return (error) => {
+		return (error, response) => {
 			if (currentActionIndex !== actionIndex || !cached) {
 				return;
 			}
 
 			cached.loading = false;
 			cached.error = error || false;
+			cached.response = response || undefined;
 
 			update(instance);
 		};