@epie/bi-crud 2.0.1

package/index.d.ts

@@ -0,0 +1,479 @@
+declare type fun = () => void;
+
+declare namespace Crud {
+	type Options = Array<{ label: string; value?: any; [key: string]: any }>;
+}
+
+declare type Browser = {
+	screen: string;
+	isMini: boolean;
+};
+
+declare namespace ClAdvSearch {
+	interface Props {
+		items: ClForm.Item[];
+		title?: string;
+		size?: string | number;
+		op?: Array<"clear" | "reset" | "close" | "save">;
+		onSearch?(data: any, event: { next(params: any): void; close(): void }): void;
+	}
+
+	interface Ref extends ClForm.Ref {}
+}
+
+declare namespace ClContextMenu {
+	interface Item {
+		label: string;
+		icon?: string;
+		prefixIcon?: string;
+		suffixIcon?: string;
+		ellipsis?: boolean;
+		disabled?: boolean;
+		hidden?: boolean;
+		children?: Item[];
+		showChildren?: boolean;
+		callback?(done: fun): void;
+		[key: string]: any;
+	}
+
+	interface Event {
+		pageX: number;
+		pageY: number;
+		[key: string]: any;
+	}
+
+	interface Options {
+		hover?:
+			| boolean
+			| {
+					target?: string;
+					className?: string;
+			  };
+		list: Item[];
+	}
+
+	interface Ref {
+		open(event: Event, options: Options): Ref;
+		close(): void;
+	}
+}
+
+declare namespace ClCrud {
+	interface Dict {
+		api?: {
+			list?: string;
+			add?: string;
+			update?: string;
+			delete?: string;
+			info?: string;
+			page?: string;
+		};
+		pagination?: {
+			page?: string;
+			size?: string;
+		};
+		search?: {
+			keyWord?: string;
+			query?: string;
+		};
+		sort?: {
+			order?: string;
+			prop?: string;
+		};
+		label?: {
+			add?: string;
+			delete?: string;
+			multiDelete?: string;
+			update?: string;
+			refresh?: string;
+			advSearch?: string;
+		};
+	}
+
+	interface Permission {
+		page?: boolean;
+		list?: boolean;
+		add?: boolean;
+		delete?: boolean;
+		update?: boolean;
+		info?: boolean;
+		[key: string]: any;
+	}
+
+	interface Service {
+		page: {
+			params: {
+				page?: number;
+				size?: number;
+				keyWord?: string;
+				[key: string]: any;
+			};
+			result: {
+				list: any[];
+				pagination?: {
+					total?: number;
+					page?: number;
+					size?: number;
+				};
+				[key: string]: any;
+			};
+			request(params?: Service["page"]["params"]): Promise<Service["page"]["result"]>;
+		};
+		delete: {
+			params: { ids?: Array<string | number>; [key: string]: any };
+			request(params: Service["delete"]["params"]): Promise<any>;
+		};
+		info: {
+			params: { id?: string | number; [key: string]: any };
+			request(params: Service["info"]["params"]): Promise<any>;
+		};
+		upsert: {
+			request(params: any): Promise<any>;
+		};
+		list: {
+			request(params: any): Promise<any[]>;
+		};
+		api: {
+			page?(params?: any): Promise<any>;
+			list?(params?: any): Promise<any>;
+			add?(params?: any): Promise<any>;
+			update?(params?: any): Promise<any>;
+			info?(params?: any): Promise<any>;
+			delete?(params?: any): Promise<any>;
+			[key: string]: any;
+		};
+	}
+
+	interface Props {
+		service: Service["api"] | "test";
+		permission?: Permission;
+		dict?: Dict;
+		onRefresh?(
+			params: Service["page"]["params"],
+			event: {
+				done: fun;
+				next: Service["page"]["request"];
+				render: (list: any[], pagination?: Service["page"]["result"]["pagination"]) => void;
+			}
+		): void;
+		onDelete?(
+			selection: any[],
+			event: {
+				next: Service["delete"]["request"];
+			}
+		): void;
+	}
+
+	interface Ref {
+		name: string;
+		routePath: string;
+		permission: Permission;
+		dict: Dict;
+		service: Service["api"];
+		loading: boolean;
+		params: any;
+		selection: any[];
+		Table: ClTable.Ref;
+		set(key: "dict" | "style" | "service" | "permission", value: any): void;
+		done(): void;
+		getParams(): any;
+		getPermission(key?: string): boolean;
+		rowAdd(): any;
+		rowEdit(data: any): any;
+		rowAppend(data?: any): any;
+		rowClose(): any;
+		rowDelete(...selection: any[]): void;
+		proxy(name: string, data?: any[]): any;
+		refresh: Service["page"]["request"];
+	}
+
+	interface Provide extends Ref {
+		[key: string]: any;
+	}
+}
+
+declare namespace ElementPlus {
+	type Size = "large" | "default" | "small";
+
+	interface FormProps {
+		inline?: boolean;
+		labelPosition?: "left" | "right" | "top";
+		labelWidth?: string | number;
+		labelSuffix?: string;
+		hideRequiredAsterisk?: boolean;
+		showMessage?: boolean;
+		inlineMessage?: boolean;
+		statusIcon?: boolean;
+		validateOnRuleChange?: boolean;
+		size?: Size;
+	}
+}
+
+declare interface EmitterItem {
+	name: string;
+	callback(data: any, events: { refresh(params: any): void; crudList: ClCrud.Ref[] }): void;
+}
+
+declare interface Emitter {
+	list: EmitterItem[];
+	init(events: any): void;
+	emit(name: string, data?: any): void;
+	on(name: string, callback: any): void;
+}
+
+declare namespace ClForm {
+	interface Item {
+		type?: "tabs";
+		prop?: string;
+		props?: {
+			labels?: Array<{ label: string; value: string; name?: string }>;
+			justify?: "left" | "center" | "right";
+			color?: string;
+			mergeProp?: boolean;
+			labelWidth?: string;
+			error?: string;
+			showMessage?: boolean;
+			inlineMessage?: boolean;
+			size?: "medium" | "default" | "small";
+			[key: string]: any;
+		};
+		hook?: Hook.Form;
+		group?: string;
+		collapse?: boolean;
+		value?: any;
+		label?: string | { text?: string; icon?: string; tip?: string };
+		span?: number;
+		flex?: boolean;
+		hidden?:
+			| boolean
+			| ((data: { scope: any; isEdit: boolean; isAdd: boolean }) => boolean)
+			| ":isAdd"
+			| ":isEdit"
+			| `@${string}`;
+		prepend?: Render.Options;
+		component?: Render.Options;
+		append?: Render.Options;
+		rules?: any;
+		required?: boolean;
+	}
+
+	interface Options {
+		title?: string;
+		width?: string;
+		props?: ElementPlus.FormProps;
+		items: Item[];
+		form?: any;
+		on?: {
+			open?(form: any): void;
+			close?(done: fun): void;
+			submit?(data: any, event: { close: fun; done: fun }): void;
+		};
+		op?: {
+			hidden?: boolean;
+			saveButtonText?: string;
+			closeButtonText?: string;
+			buttons?: Array<"close" | "save" | Render.OpButton>;
+		};
+		dialog?: {
+			title?: string;
+			width?: string;
+			hideHeader?: boolean;
+			controls?: Array<"fullscreen" | "close">;
+			[key: string]: any;
+		};
+		[key: string]: any;
+	}
+
+	interface Ref {
+		form: any;
+		open(options: Options): void;
+		close(): void;
+		done(): void;
+		clear(): void;
+		reset(): void;
+		showLoading(): void;
+		hideLoading(): void;
+		setData(prop: string, value: any): void;
+		bindForm(data: any): void;
+		setOptions(prop: string, list: Array<{ label: string; value?: any }>): void;
+		setProps(prop: string, value: any): void;
+		getForm(prop?: string): any;
+		setForm(prop: string, value: any): void;
+		showItem(props: string[] | string): void;
+		hideItem(props: string[] | string): void;
+		toggleItem(prop: string, flag?: boolean): void;
+		resetFields(): void;
+		clearValidate(props?: string[] | string): void;
+		validateField(
+			props: string[] | string,
+			callback: (isValid: boolean, invalidFields: any[]) => void
+		): Promise<void>;
+		validate(callback: (isValid: boolean, invalidFields: any[]) => void): Promise<void>;
+		changeTab(value: any, valid?: boolean): Promise<any>;
+		setTitle(value: string): void;
+		submit(callback?: (data: any) => void): void;
+	}
+}
+
+declare namespace Hook {
+	type fn = ({ value: any, form: { [key]: string }, prop: string, [key]: string }) => any;
+
+	type FormPipe =
+		| "number"
+		| "string"
+		| "split"
+		| "join"
+		| "boolean"
+		| "booleanNumber"
+		| "datetimerange"
+		| FormPipe[]
+		| fn;
+
+	type Form =
+		| string
+		| {
+				bind?: FormPipe;
+				submit?: FormPipe;
+		  };
+}
+
+declare namespace Render {
+	type OpButton =
+		| `slot-${string}`
+		| { label: string; type?: string; onClick({ scope }: any): void };
+
+	interface Options {
+		name?: string;
+
+		options?:
+			| Array<{
+					label: string;
+					value?: any;
+					[key: string]: any;
+			  }>
+			| fun;
+
+		props?: any;
+
+		vm?: any;
+
+		[key: string]: any;
+	}
+}
+
+declare namespace ClTable {
+	type Dict =
+		| Array<{
+				label: string;
+				value?: any;
+				type?: "success" | "warning" | "info" | "danger";
+				size?: "medium" | "default" | "small";
+				effect?: "dark" | "light" | "plain";
+				color?: string;
+		  }>
+		| Ref<Dict>;
+
+	interface Column {
+		type?: "index" | "selection" | "expand" | "op";
+		hidden?: boolean;
+		component?: Render.Options;
+		dict?: Dict;
+		buttons?: Array<"edit" | "delete" | Render.OpButton>;
+		align?: "left" | "center" | "right";
+		label?: string;
+		className?: string;
+		prop?: string;
+		width?: number;
+		minWidth?: number | string;
+		renderHeader?: ({ column, $index }) => any;
+		sortable?: boolean | "desc" | "descending" | "ascending" | "asc" | "custom" | string;
+		sortMethod?: fun;
+		sortBy?: string | ((row: any, index: number) => any) | any[];
+		resizable?: {
+			type: boolean;
+			default: true;
+		};
+		columnKey?: string;
+		headerAlign?: string;
+		showOverflowTooltip?: boolean;
+		fixed?: boolean | string;
+		formatter?: (row: any, column: any, value: any, index: number) => any;
+		selectable?: (row: any, index) => boolean;
+		reserveSelection?: boolean;
+		filterMethod?: fun;
+		filteredValue?: unknown[];
+		filters?: unknown[];
+		filterPlacement?: string;
+		filterMultiple?: {
+			type: boolean;
+			default: true;
+		};
+		index?: ((index: number) => number) | number;
+		sortOrders?: unknown[];
+		children?: Column[];
+	}
+
+	interface Props {
+		columns?: Column[];
+		contextMenu?:
+			| boolean
+			| Array<
+					| ClContextMenu.Item
+					| ((row: any) => ClContextMenu.Item)
+					| "refresh"
+					| "check"
+					| "update"
+					| "edit"
+					| "delete"
+					| "order-desc"
+					| "order-asc"
+			  >;
+	}
+
+	interface Ref {
+		selection: any[];
+		data: any[];
+		columns: Column[];
+		reBuild(cb: fn): void;
+		setColumns(columns: Column[]): void;
+		showColumn(prop: string | string[], status?: boolean): void;
+		hideColumn(prop: string | string[]): void;
+		changeSort(prop: string, order: string): void;
+		clearSelection(): void;
+		getSelectionRows(): any[];
+		toggleRowSelection(row: any, selected?: any[]): void;
+		toggleAllSelection(): void;
+		toggleRowExpansion(row: any, expanded?: any[]): void;
+		setCurrentRow(row: any): void;
+		clearSort(): void;
+		clearFilter(columnKeys: string[]): void;
+		doLayout(): void;
+		sort(prop: string, order: string): void;
+		scrollTo(position: { top?: number; left?: number }): void;
+		setScrollTop(top: number): void;
+		setScrollLeft(left: number): void;
+	}
+}
+
+declare namespace ClUpsert {
+	interface Props {
+		items: ClForm.Item[];
+		props?: ClForm.Options["props"];
+		sync?: boolean;
+		op?: ClForm.Options["op"];
+		dialog?: ClForm.Options["dialog"];
+		onOpen?(isEdit: boolean, data: any): void;
+		onClose?(done: fun): void;
+		onInfo?(
+			data: ClCrud.Service["info"]["params"],
+			event: { close: fun; done(data: any): void; next: ClCrud.Service["info"]["request"] }
+		): void;
+		onSubmit?(
+			isEdit: boolean,
+			data: any,
+			event: { close: fun; done: fun; next: ClCrud.Service["upsert"]["request"] }
+		): void;
+	}
+
+	interface Ref extends ClForm.Ref {}
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@epie/bi-crud",
+  "version": "2.0.1",
+  "private": false,
+  "main": "./dist/index.umd.min.js",
+  "typings": "types/index.d.ts",
+  "scripts": {
+    "serve": "vue-cli-service serve",
+    "build": "vue-cli-service build",
+    "lint": "vue-cli-service lint",
+    "report": "vue-cli-service build --report --target lib --name index ./src/index.ts",
+    "crud": "tsc && yarn build --target lib --name index ./src/index.ts"
+  },
+  "dependencies": {
+    "array.prototype.flat": "^1.2.4",
+    "core-js": "^3.21.1",
+    "element-plus": "^2.2.6",
+    "merge": "^2.1.1",
+    "mitt": "^3.0.0",
+    "vue": "^3.2.37"
+  },
+  "devDependencies": {
+    "@types/array.prototype.flat": "^1.2.1",
+    "@types/clone-deep": "^4.0.1",
+    "@vue/cli-plugin-babel": "^5.0.1",
+    "@vue/cli-plugin-typescript": "^5.0.3",
+    "@vue/cli-service": "^5.0.3",
+    "@vue/compiler-sfc": "^3.2.31",
+    "node-sass": "^7.0.1",
+    "prettier": "^2.4.1",
+    "sass-loader": "^12.6.0",
+    "typescript": "^4.6.2"
+  },
+  "files": [
+    "dist",
+    "types",
+    "index.d.ts"
+  ]
+}

package/types/components/add-btn.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, () => false | JSX.Element, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
+export default _default;

package/types/components/adv-btn.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, () => JSX.Element, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
+export default _default;

package/types/components/adv-search.d.ts

@@ -0,0 +1,48 @@
+/// <reference types="../index" />
+import { PropType } from "vue";
+declare const _default: import("vue").DefineComponent<{
+    items: {
+        type: PropType<ClForm.Item[]>;
+        default: () => never[];
+    };
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+    size: {
+        type: (NumberConstructor | StringConstructor)[];
+        default: string;
+    };
+    op: {
+        type: ArrayConstructor;
+        default: () => string[];
+    };
+    onSearch: FunctionConstructor;
+}, any, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("reset" | "clear")[], "reset" | "clear", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    items: {
+        type: PropType<ClForm.Item[]>;
+        default: () => never[];
+    };
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+    size: {
+        type: (NumberConstructor | StringConstructor)[];
+        default: string;
+    };
+    op: {
+        type: ArrayConstructor;
+        default: () => string[];
+    };
+    onSearch: FunctionConstructor;
+}>> & {
+    onReset?: ((...args: any[]) => any) | undefined;
+    onClear?: ((...args: any[]) => any) | undefined;
+}, {
+    title: string;
+    size: string | number;
+    items: ClForm.Item[];
+    op: unknown[];
+}>;
+export default _default;

package/types/components/context-menu/context-menu.d.ts

@@ -0,0 +1,44 @@
+import type { PropType } from "vue";
+declare const _default: import("vue").DefineComponent<{
+    visible: BooleanConstructor;
+    options: {
+        type: PropType<ClContextMenu.Item[]>;
+        default: () => {};
+    };
+    event: ObjectConstructor;
+}, {
+    refs: any;
+    visible2: import("vue").Ref<boolean>;
+    ids: import("vue").Ref<string>;
+    style: any;
+    list: import("vue").Ref<{
+        label: string;
+        icon?: string | undefined;
+        prefixIcon?: string | undefined;
+        suffixIcon?: string | undefined;
+        ellipsis?: boolean | undefined;
+        disabled?: boolean | undefined;
+        hidden?: boolean | undefined;
+        children?: any[] | undefined;
+        showChildren?: boolean | undefined;
+        callback?: ((done: fun) => void) | undefined;
+    }[]>;
+    setRefs: (index: number) => (el: HTMLElement) => void;
+    open: (event: any, options?: any) => {
+        close: () => void;
+    };
+    close: () => void;
+    rowClick: (e: any, item: any, id: string) => any;
+    stopDefault: (e: any) => void;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    visible: BooleanConstructor;
+    options: {
+        type: PropType<ClContextMenu.Item[]>;
+        default: () => {};
+    };
+    event: ObjectConstructor;
+}>>, {
+    visible: boolean;
+    options: ClContextMenu.Item[];
+}>;
+export default _default;

package/types/components/context-menu/index.d.ts

@@ -0,0 +1,55 @@
+/// <reference types="../index" />
+declare const ClContextMenu: import("vue").DefineComponent<{
+    show: BooleanConstructor;
+    options: {
+        type: ObjectConstructor;
+        default: () => {};
+    };
+    event: {
+        type: ObjectConstructor;
+        default: () => {};
+    };
+}, {
+    refs: any;
+    visible: import("vue").Ref<boolean>;
+    ids: import("vue").Ref<string>;
+    style: any;
+    list: import("vue").Ref<{
+        [x: string]: any;
+        label: string;
+        icon?: string | undefined;
+        prefixIcon?: string | undefined;
+        suffixIcon?: string | undefined;
+        ellipsis?: boolean | undefined;
+        disabled?: boolean | undefined;
+        hidden?: boolean | undefined;
+        children?: any[] | undefined;
+        showChildren?: boolean | undefined;
+        callback?: ((done: fun) => void) | undefined;
+    }[]>;
+    setRefs: (index: number) => (el: HTMLElement) => void;
+    open: (event: any, options?: any) => {
+        close: () => void;
+    };
+    close: () => void;
+    rowClick: (e: any, item: any, id: string) => any;
+    stopDefault: (e: any) => void;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    show: BooleanConstructor;
+    options: {
+        type: ObjectConstructor;
+        default: () => {};
+    };
+    event: {
+        type: ObjectConstructor;
+        default: () => {};
+    };
+}>>, {
+    options: Record<string, any>;
+    show: boolean;
+    event: Record<string, any>;
+}>;
+export declare const ContextMenu: {
+    open(event: any, options: ClContextMenu.Options): void;
+};
+export default ClContextMenu;

package/types/components/crud/helper.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="../index" />
+export declare function useHelper({ mitt, props, crud }: any): {
+    proxy: (name: string, data?: any[] | undefined) => void;
+    set: (key: string, value: any) => void;
+    on: (name: string, callback: fun) => void;
+    rowAdd: () => void;
+    rowEdit: (data: any) => void;
+    rowAppend: (data: any) => void;
+    rowDelete: (...selection: any[]) => void;
+    rowClose: () => void;
+    refresh: (params?: any) => Promise<unknown>;
+    getPermission: (key: "page" | "list" | "info" | "update" | "add" | "delete") => boolean;
+    paramsReplace: (params: any) => any;
+    getParams: () => Object;
+};