quasar-ui-danx 0.4.41 → 0.4.43

package/src/helpers/routes.ts

@@ -1,36 +1,99 @@
-import { storeObject } from "../helpers";
-import { ListControlsRoutes } from "../types";
+import { storeObject, storeObjects } from "../helpers";
+import { ActionTargetItem, ApplyActionResponse, ListControlsRoutes, PagedItems } from "../types";
 import { downloadFile } from "./downloadPdf";
 import { request } from "./request";
 
 export function useActionRoutes(baseUrl: string, extend?: object): ListControlsRoutes {
 	return {
-		list(pager?, options?) {
-			return request.post(`${baseUrl}/list`, pager, options);
+		/**
+		 *  Loads a paged item list from the server
+		 */
+		async list(pager?, options?) {
+			options = {
+				...options,
+				ignoreAbort: true
+			};
+			const response = await request.post(`${baseUrl}/list`, pager, options) as PagedItems;
+
+			if (response.data) {
+				response.data = storeObjects(response.data);
+			}
+
+			return response;
 		},
+		/**
+		 * Loads a summary from the server
+		 */
 		summary(filter, options?) {
+			options = {
+				...options,
+				ignoreAbort: true
+			};
 			return request.post(`${baseUrl}/summary`, { filter }, options);
 		},
-		details(target, fields, options?) {
-			options = options || {};
-			fields && (options.params = { fields });
-			return request.get(`${baseUrl}/${target.id}/details`, options);
-		},
-		async detailsAndStore(target, fields, options?) {
-			options = options || {};
+		/**
+		 *  Loads a single item from the server.
+		 *  Optionally pass in the desired fields to load (otherwise it will load all default fields)
+		 */
+		async details(target, fields, options?) {
+			options = {
+				...options,
+				ignoreAbort: true
+			};
 			fields && (options.params = { fields });
 			const item = await request.get(`${baseUrl}/${target.id}/details`, options);
 			return storeObject(item);
 		},
+		/**
+		 *  Loads field options from the server
+		 */
 		fieldOptions(options?) {
 			return request.get(`${baseUrl}/field-options`, options);
 		},
-		applyAction(action, target, data, options?) {
-			return request.post(`${baseUrl}/${target ? target.id : "new"}/apply-action`, { action, data }, options);
+		/**
+		 *  Applies an action to a target item on the server to save to the DB and return the updated result
+		 */
+		async applyAction(action, target, data, options?) {
+			options = {
+				...options,
+				ignoreAbort: true,
+				headers: {
+					...options?.headers,
+					// @ts-expect-error This header is fine
+					"X-Timestamp": Date.now()
+				}
+			};
+			data = data || {};
+			const response = await request.post(`${baseUrl}/${target ? target.id : "new"}/apply-action`, {
+				action,
+				data
+			}, options) as ApplyActionResponse;
+
+			// Store the response item in the reactive store if it is set
+			if (response.item) {
+				response.item = storeObject(response.item);
+			}
+
+			// Store the result item in the reactive store if it is set as an ActionTargetItem
+			if (response.result?.__type && response.result?.id) {
+				response.result = storeObject(response.result as ActionTargetItem);
+			}
+
+			return response;
 		},
+		/**
+		 *  Applies an action to multiple target items on the server to save to the DB and return the updated result
+		 */
 		batchAction(action, targets, data, options?) {
+			options = {
+				...options,
+				ignoreAbort: true
+			};
 			return request.post(`${baseUrl}/batch-action`, { action, filter: { id: targets.map(r => r.id) }, data }, options);
 		},
+		/**
+		 *  Exports a list of items to a CSV file
+		 */
 		export(filter, name) {
 			return downloadFile(`${baseUrl}/export`, name || "export.csv", { filter });
 		},

package/src/types/actions.d.ts

@@ -34,6 +34,7 @@ export interface ActionOptions<T = ActionTargetItem> {
 	debounce?: number;
 	useInputFromConfirm?: boolean;
 	optimistic?: boolean | ((action: ActionOptions<T>, target: T | null, input: any) => void);
+	optimisticDelete?: boolean;
 	vnode?: (target: ActionTarget<T>, data: any) => VNode | any;
 	enabled?: (target: ActionTarget<T>) => boolean;
 	batchEnabled?: (targets: T[]) => boolean;

package/src/types/controls.d.ts

@@ -27,11 +27,9 @@ export interface ListControlsRoutes<T = ActionTargetItem> {
 
 	details?(target: T, fields?: ControlsFieldsList, options?: RequestCallOptions): Promise<T>;
 
-	detailsAndStore?(target: T, fields?: ControlsFieldsList, options?: RequestCallOptions): Promise<T>;
-
 	more?(pager: ListControlsPagination, options?: RequestCallOptions): Promise<T[]>;
 
-	fieldOptions?(filter?: AnyObject, options?: RequestCallOptions): Promise<AnyObject>;
+	fieldOptions?(options?: RequestCallOptions): Promise<AnyObject>;
 
 	applyAction?(action: string | ResourceAction | ActionOptions, target: T | null, data?: object, options?: RequestCallOptions): Promise<AnyObject>;
 
@@ -121,3 +119,9 @@ export interface ListController<T = ActionTargetItem> {
 	applyFilterFromUrl: (url: string, filters?: Ref<FilterGroup[]> | null) => void;
 	getFieldOptions: (field: string) => any[];
 }
+
+export interface ApplyActionResponse<T = ActionTargetItem> {
+	item?: T;
+	result?: T | AnyObject;
+	success: boolean;
+}

package/src/types/requests.d.ts

@@ -31,6 +31,7 @@ export interface RequestOptions {
 
 export interface RequestCallOptions extends RequestInit {
 	abortOn?: string;
+	ignoreAbort?: boolean;
 	params?: AnyObject;
 }