quasar-ui-danx 0.4.1 → 0.4.3

package/src/types/controls.d.ts

@@ -0,0 +1,99 @@
+import { ComputedRef, Ref, ShallowRef } from "vue";
+import { ActionTargetItem } from "./actions";
+import { LabelValueItem } from "./shared";
+
+export interface ListControlsFilter {
+	[key: string]: object | object[] | null | undefined | string | number | boolean;
+}
+
+export interface FilterableField {
+	name: string;
+	label: string;
+	type: string;
+	options?: string[] | number[] | LabelValueItem[];
+	inline?: boolean;
+}
+
+export interface FilterGroup {
+	name?: string;
+	flat?: boolean;
+	fields: FilterableField[];
+}
+
+export interface ListControlsRoutes {
+	list: (pager: object) => Promise<ActionTargetItem[]>;
+	details?: (item: object) => Promise<ActionTargetItem> | null;
+	summary?: (filter: object | null) => Promise<object> | null;
+	fieldOptions?: (filter: object | null) => Promise<object> | null;
+	more?: (pager: object) => Promise<ActionTargetItem[]> | null;
+	export: (filter?: ListControlsFilter) => Promise<void>;
+}
+
+export interface ListControlsOptions {
+	label?: string,
+	routes: ListControlsRoutes;
+	urlPattern?: RegExp | null;
+	filterDefaults?: Record<string, object>;
+	refreshFilters?: boolean;
+}
+
+export interface ListControlsPagination {
+	__sort?: object[] | null;
+	sortBy?: string | null;
+	descending?: boolean;
+	page?: number;
+	rowsNumber?: number;
+	rowsPerPage?: number;
+}
+
+export interface PagedItems {
+	data: ActionTargetItem[] | undefined;
+	meta: {
+		total: number;
+		last_page?: number;
+	} | undefined;
+}
+
+export interface ActionController {
+	name: string;
+	label: string;
+	pagedItems: Ref<PagedItems | null>;
+	activeFilter: Ref<ListControlsFilter>;
+	globalFilter: Ref<ListControlsFilter>;
+	filterActiveCount: ComputedRef<number>;
+	showFilters: Ref<boolean>;
+	summary: ShallowRef<object | null>;
+	selectedRows: ShallowRef<ActionTargetItem[]>;
+	isLoadingList: Ref<boolean>;
+	isLoadingFilters: Ref<boolean>;
+	isLoadingSummary: Ref<boolean>;
+	pager: ComputedRef<{
+		perPage: number;
+		page: number;
+		filter: ListControlsFilter;
+		sort: object[] | undefined;
+	}>;
+	pagination: ShallowRef<ListControlsPagination>;
+	activeItem: ShallowRef<ActionTargetItem | null>;
+	activePanel: ShallowRef<string | null>;
+
+	// Actions
+	initialize: () => void;
+	resetPaging: () => void;
+	setPagination: (updated: 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>;
+	getActiveItemDetails: () => Promise<void>;
+	refreshAll: () => Promise<void[]>;
+	exportList: (filter?: ListControlsFilter) => Promise<void>;
+	setActiveItem: (item: ActionTargetItem | null) => void;
+	getNextItem: (offset: number) => Promise<void>;
+	activatePanel: (item: ActionTargetItem | null, panel: string) => void;
+	setActiveFilter: (filter?: ListControlsFilter) => void;
+	applyFilterFromUrl: (url: string, filters?: Ref<FilterGroup[]> | null) => void;
+	getFieldOptions: (field: string) => any[];
+}

package/src/types/dialogs.d.ts

@@ -0,0 +1,32 @@
+import { ActionTargetItem } from "./actions";
+
+export interface DialogLayoutProps {
+	modelValue?: string | boolean | object;
+	title?: string;
+	titleClass?: string;
+	subtitle?: string;
+	content?: string;
+	backdropDismiss?: boolean;
+	maximized?: boolean;
+	fullWidth?: boolean;
+	fullHeight?: boolean;
+	contentClass?: string;
+}
+
+export interface ConfirmDialogProps extends DialogLayoutProps {
+	disabled?: boolean;
+	isSaving?: boolean;
+	closeOnConfirm?: boolean;
+	hideConfirm?: boolean;
+	confirmText?: string;
+	cancelText?: string;
+	confirmClass?: string;
+	contentClass?: string;
+}
+
+export interface ConfirmActionDialogProps extends ConfirmDialogProps {
+	action: string,
+	label?: string,
+	target: ActionTargetItem | ActionTargetItem[]
+	message?: string,
+}

package/src/types/fields.d.ts

@@ -0,0 +1,20 @@
+import { QInputProps } from "quasar";
+import { FormField } from "./forms";
+
+export interface TextFieldProps {
+	modelValue?: string,
+	field?: FormField,
+	type?: QInputProps["type"],
+	label?: string,
+	labelClass?: string,
+	parentClass?: string,
+	inputClass?: string,
+	allowOverMax?: boolean,
+	maxLength?: number;
+	autogrow?: boolean;
+	noLabel?: boolean;
+	showName?: boolean;
+	disabled?: boolean;
+	readonly?: boolean;
+	debounce?: string | number;
+}

package/src/types/files.d.ts

@@ -0,0 +1,54 @@
+export interface FileUploadOptions {
+	directory?: string,
+	createPresignedUpload?: ((path: string, name: string, mime?: string) => Promise<UploadedFile>) | null;
+	completePresignedUpload?: ((fileId: string) => Promise<UploadedFile>) | null;
+}
+
+export interface XHRFileUpload {
+	file: UploadedFile;
+	xhr?: XMLHttpRequest | null;
+	formData: FormData;
+	isComplete: boolean;
+	body?: FormData | UploadedFile | string;
+}
+
+export interface UploadedFile {
+	id: string,
+	resource_id?: string;
+	name: string,
+	size: number,
+	type: string;
+	mimeType?: string;
+	mime?: string;
+	progress?: number;
+	location?: string;
+	blobUrl?: string;
+	url?: string;
+}
+
+export interface FileUploadCompleteCallbackParams {
+	file?: UploadedFile | null;
+	uploadedFile?: UploadedFile | null;
+}
+
+export interface FileUploadAllCompleteCallbackParams {
+	files: XHRFileUpload[];
+}
+
+export interface FileUploadProgressCallbackParams {
+	file?: UploadedFile | null;
+	progress: number;
+}
+
+export interface FileUploadErrorCallbackParams {
+	e: InputEvent;
+	file: UploadedFile;
+	error: any;
+}
+
+export type FileUploadCompleteCallback = (params: FileUploadCompleteCallbackParams) => void
+export type FileUploadAllCompleteCallback = (params: FileUploadAllCompleteCallbackParams) => void
+export type FileUploadProgressCallback = (params: FileUploadProgressCallbackParams) => void
+export type FileUploadErrorCallback = (params: FileUploadErrorCallbackParams) => void
+export type OnFilesChangeCallback = (files: UploadedFile[]) => void;
+export type VoidCallback = () => void;

package/src/types/formats.d.ts

@@ -0,0 +1,4 @@
+export interface fDateOptions {
+	format?: string,
+	empty?: string
+}

package/src/{components/ActionTable/Form/form.d.ts → types/forms.d.ts}

@@ -10,10 +10,16 @@ export interface FormField {
 	type?: string;
 	name: string;
 	label: string;
+	placeholder?: string;
 	vnode?: ((props) => VNode | any);
 	component?: any;
+	clearable?: boolean;
 	required?: boolean;
 	required_group?: string;
+	toggleIndeterminate?: boolean;
+	inline?: boolean;
+	maxLength?: number;
+	minLength?: number;
 	options?: FormFieldOption[];
 }
 

package/src/types/index.d.ts

@@ -0,0 +1,12 @@
+export * from "./actions";
+export * from "./config";
+export * from "./controls";
+export * from "./dialogs";
+export * from "./fields";
+export * from "./files";
+export * from "./formats";
+export * from "./forms";
+export * from "./requests";
+export * from "./shared";
+export * from "./tables";
+

package/src/types/requests.d.ts

@@ -0,0 +1,13 @@
+export interface HttpResponse {
+	headers: any;
+	data?: any;
+	ok?: boolean;
+
+	blob(): any;
+}
+
+export interface RequestOptions {
+	baseUrl?: string;
+	headers?: object;
+	onUnauthorized?: (response) => object;
+}

package/src/types/shared.d.ts

@@ -0,0 +1,15 @@
+export type AnyObject = { [key: string]: any };
+
+export interface TypedObject {
+	id?: string | number;
+	name?: string;
+	__type: string;
+	__timestamp?: number;
+
+	[key: string]: TypedObject[] | any;
+}
+
+export interface LabelValueItem {
+	label: string;
+	value: string | number | boolean;
+}

package/src/types/tables.d.ts

@@ -0,0 +1,27 @@
+import { VNode } from "vue";
+import { ActionOptions } from "./actions";
+
+export interface TableColumn {
+	actionMenu?: ActionOptions[],
+	align?: string,
+	category?: string,
+	class?: string | object,
+	field?: string,
+	format?: (value: any, options: any) => any,
+	innerClass?: string | object,
+	style?: string | object,
+	headerStyle?: string | object,
+	isSavingRow?: boolean | (() => boolean),
+	label: string,
+	maxWidth?: number,
+	minWidth?: number,
+	name: string,
+	onClick?: (target: any) => void,
+	required?: boolean,
+	resizeable?: boolean,
+	sortable?: boolean,
+	sortBy?: string,
+	sortByExpression?: string,
+	titleColumns?: () => string[],
+	vnode?: () => VNode | any,
+}

package/types/index.d.ts

@@ -1 +1 @@
-export * from "../src/components/ActionTable/Form/form.d.ts";
+export * from "../src/types";