quasar-ui-danx 0.4.12 → 0.4.14

package/src/helpers/formats.ts

@@ -1,4 +1,5 @@
 import { DateTime, IANAZone } from "luxon";
+import { parse as parseYAML, stringify as stringifyYAML } from "yaml";
 import { ActionTargetItem, fDateOptions } from "../types";
 import { isJSON } from "./utils";
 
@@ -335,10 +336,59 @@ export function fJSON(string: string | object) {
 	}
 }
 
-export function fMarkdownJSON(string: string | object): string {
-	if (isJSON(string)) {
-		return `\`\`\`json\n${fJSON(string)}\n\`\`\``;
+/**
+ * Convert markdown formatted string into a valid JSON object
+ */
+export function parseMarkdownJSON(string: string | object): object | null | false {
+	if (!string) return null;
+	if (typeof string === "object") return string as object;
+
+	try {
+		return JSON.parse(parseMarkdownCode(string));
+	} catch (e) {
+		return false;
+	}
+}
+
+export function parseMarkdownYAML(string: string): object | null | false {
+	if (!string) return null;
+
+	try {
+		return parseYAML(parseMarkdownCode(string)) || (string ? undefined : null);
+	} catch (e) {
+		return false;
+	}
+}
+
+/**
+ * Parse a markdown formatted string and return the code block content
+ */
+export function parseMarkdownCode(string: string): string {
+	return string.replace(/^```[a-z0-9]{1,6}\s/, "").replace(/```$/, "");
+}
+
+/**
+ * Convert a JSON object or string of code into a markdown formatted JSON string
+ * ie: a valid JSON string with a ```json prefix and ``` postfix
+ */
+export function fMarkdownCode(type: string, string: string | object): string {
+	if (typeof string === "object" || isJSON(string)) {
+		switch (type) {
+			case "yaml":
+				string = stringifyYAML(string);
+				break;
+			case "ts":
+				string = "";
+				break;
+			default:
+				string = fJSON(string);
+		}
 	}
-	// @ts-expect-error Guaranteed to only allow strings here using isJSON check
-	return string;
+
+	const regex = new RegExp(`\`\`\`${type}`, "g");
+	if (!((string || "") as string).match(regex)) {
+		return `\`\`\`${type}\n${string}\n\`\`\``;
+	}
+
+	return string as string;
 }

package/src/helpers/objectStore.ts

@@ -1,3 +1,4 @@
+import { uid } from "quasar";
 import { ShallowReactive, shallowReactive } from "vue";
 import { TypedObject } from "../types";
 
@@ -12,6 +13,9 @@ export function storeObject<T extends TypedObject>(newObject: T): ShallowReactiv
 	const type = newObject.__type;
 	if (!id || !type) return shallowReactive(newObject);
 
+	if (!newObject.__id) {
+		newObject.__id = uid();
+	}
 	if (!newObject.__timestamp) {
 		newObject.__timestamp = newObject.updated_at || 0;
 	}
@@ -34,6 +38,9 @@ export function storeObject<T extends TypedObject>(newObject: T): ShallowReactiv
 			for (const index in value) {
 				newObject[key][index] = storeObject(value[index]);
 			}
+		} else if (value?.__type) {
+			// @ts-expect-error newObject[key] is guaranteed to be a TypedObject
+			newObject[key] = storeObject(value);
 		}
 	}
 

package/src/helpers/request.ts

@@ -45,7 +45,7 @@ export const request: RequestApi = {
 			// If the request was aborted too late, but there was still another request that was made after the current,
 			// then abort the current request with an abort flag
 			if (timestamp < request.abortControllers[abortKey].timestamp) {
-				throw new Error("Request was aborted due to a newer request being made: " + timestamp + " < " + request.abortControllers[abortKey].timestamp);
+				return { abort: true };
 			}
 
 			// Otherwise, the current is the most recent request, so we can delete the abort controller

package/src/helpers/routes.ts

@@ -1,3 +1,4 @@
+import { storeObject } from "../helpers";
 import { ListControlsRoutes } from "../types";
 import { downloadFile } from "./downloadPdf";
 import { request } from "./request";
@@ -13,6 +14,10 @@ export function useActionRoutes(baseUrl: string): ListControlsRoutes {
 		details(target) {
 			return request.get(`${baseUrl}/${target.id}/details`);
 		},
+		async detailsAndStore(target) {
+			const item = await request.get(`${baseUrl}/${target.id}/details`);
+			return storeObject(item);
+		},
 		fieldOptions() {
 			return request.get(`${baseUrl}/field-options`);
 		},

package/src/helpers/utils.ts

@@ -91,12 +91,12 @@ export function incrementName(name: string) {
  * Check if a string is a valid JSON object. If an object is passed, always return true
  */
 export function isJSON(string: string | object) {
-	if (!string) {
-		return false;
-	}
 	if (typeof string === "object") {
 		return true;
 	}
+	if (!string) {
+		return false;
+	}
 	try {
 		JSON.parse(string);
 		return true;

package/src/types/actions.d.ts

@@ -6,13 +6,14 @@ export interface ActionPanel {
 	label: string;
 	category?: string;
 	class?: string | object;
-	enabled?: boolean | (() => boolean);
-	tabVnode?: (activePanel: string | number) => VNode | any;
-	vnode: (activePanel: string) => VNode | any;
+	enabled?: boolean | ((activeItem: ActionTargetItem) => boolean);
+	tabVnode?: (activeItem: ActionTargetItem | null | undefined, activePanel: string | number) => VNode | any;
+	vnode: (activeItem: ActionTargetItem | null | undefined) => VNode | any;
 }
 
 export interface ActionTargetItem extends TypedObject {
 	isSaving?: boolean;
+	updated_at?: string;
 }
 
 export type ActionTarget = ActionTargetItem[] | ActionTargetItem | null;
@@ -41,10 +42,6 @@ export interface ActionOptions {
 	onFinish?: (result: any, targets: ActionTarget, input: any) => any;
 }
 
-export interface ActionOptionsPartial extends ActionOptions {
-	name?: string;
-}
-
 export interface ResourceAction extends ActionOptions {
 	isApplying: boolean;
 	trigger: (target?: ActionTarget, input?: any) => Promise<any>;

package/src/types/config.d.ts

@@ -1,11 +1,13 @@
 import { QNotifyCreateOptions } from "quasar";
+import { Router } from "vue-router";
 import { FileUploadOptions } from "./files";
 import { RequestOptions } from "./requests";
 
 export interface DanxOptions {
 	tinyMceApiKey?: string;
 	fileUpload?: FileUploadOptions;
-	request?: RequestOptions,
+	request?: RequestOptions;
+	router?: Router;
 	flashMessages?: {
 		default?: QNotifyCreateOptions;
 		success?: QNotifyCreateOptions;

package/src/types/controls.d.ts

@@ -1,5 +1,4 @@
 import { ComputedRef, Ref, ShallowRef } from "vue";
-import { Router } from "vue-router";
 import { ActionTargetItem } from "./actions";
 import { AnyObject, LabelValueItem } from "./shared";
 
@@ -29,6 +28,8 @@ export interface ListControlsRoutes {
 
 	details?(target: ActionTargetItem): Promise<ActionTargetItem>;
 
+	detailsAndStore?(target: ActionTargetItem): Promise<ActionTargetItem>;
+
 	more?(pager: ListControlsPagination): Promise<ActionTargetItem[]>;
 
 	fieldOptions?(filter?: AnyObject): Promise<AnyObject>;
@@ -67,10 +68,6 @@ export interface PagedItems {
 	} | undefined;
 }
 
-export interface ListControlsInitializeOptions {
-	vueRouter?: Router;
-}
-
 export interface ActionController {
 	name: string;
 	label: string;
@@ -95,15 +92,16 @@ export interface ActionController {
 	activePanel: ShallowRef<string | null>;
 
 	// Actions
-	initialize: (options: ListControlsInitializeOptions) => void;
+	initialize: () => void;
 	resetPaging: () => void;
-	setPagination: (updated: ListControlsPagination) => void;
+	setPagination: (updated: Partial<ListControlsPagination>) => void;
 	setSelectedRows: (selection: ActionTargetItem[]) => void;
 	clearSelectedRows: () => void;
 	loadList: (filter?: ListControlsFilter) => Promise<void>;
 	loadSummary: (filter?: ListControlsFilter) => Promise<void>;
 	loadListAndSummary: (filter?: ListControlsFilter) => Promise<void>;
 	loadMore: (index: number, perPage?: number) => Promise<boolean>;
+	loadFieldOptions: () => Promise<void>;
 	getActiveItemDetails: () => Promise<void>;
 	refreshAll: () => Promise<void[]>;
 	exportList: (filter?: ListControlsFilter) => Promise<void>;

package/src/types/forms.d.ts

@@ -1,4 +1,5 @@
 import { VNode } from "vue";
+import { AnyObject } from "./shared";
 
 export interface FormFieldOption {
 	value: string;
@@ -11,11 +12,13 @@ export interface FormField {
 	name: string;
 	label: string;
 	placeholder?: string;
-	vnode?: ((props) => VNode | any);
+	enabled?: boolean | ((input: AnyObject) => boolean);
+	vnode?: ((field: FormFieldOption, input?: AnyObject) => VNode | any);
 	component?: any;
 	clearable?: boolean;
 	required?: boolean;
 	required_group?: string;
+	default_value?: any;
 	toggleIndeterminate?: boolean;
 	inline?: boolean;
 	maxLength?: number;
@@ -35,3 +38,19 @@ export interface FormFieldValue {
 	value: any,
 	variation?: string
 }
+
+export interface RenderedFormProps {
+	values?: FormFieldValue[] | object | null;
+	form: Form;
+	noLabel?: boolean;
+	showName?: boolean;
+	disable?: boolean;
+	readonly?: boolean;
+	saving?: boolean;
+	clearable?: boolean;
+	emptyValue?: string | number | boolean;
+	canModifyVariations?: boolean;
+	fieldClass?: string;
+	savingClass?: string;
+	savedAt?: string;
+}

package/src/types/shared.d.ts

@@ -5,6 +5,7 @@ export interface TypedObject {
 	name?: string;
 	__type: string;
 	__timestamp?: number;
+	__id?: string;
 
 	[key: string]: TypedObject[] | any;
 }