pui9-docgen 1.16.4

package/package.json

@@ -0,0 +1,59 @@
+{
+	"name": "pui9-docgen",
+	"description": "PUI9 Documents Generation Component",
+	"author": {
+		"name": "Prodevelop S.L."
+	},
+	"version": "1.16.4",
+	"license": "Copyright",
+	"main": "dist/pui9-docgen.common.js",
+	"scripts": {
+		"serve": "vue-cli-service serve",
+		"build-bundle": "vue-cli-service build --target lib --name pui9-docgen ./src/index.js",
+		"prepare": "npm run build-bundle",
+		"lint": "vue-cli-service lint"
+	},
+	"devDependencies": {
+		"@vue/cli-plugin-babel": "4.5.13",
+		"@vue/cli-plugin-eslint": "4.5.13",
+		"@vue/cli-service": "4.5.13",
+		"autoprefixer": "9.8.6",
+		"babel-eslint": "10.1.0",
+		"core-js": "3.17.2",
+		"css-loader": "0.28.11",
+		"eslint": "6.8.0",
+		"eslint-plugin-vue": "6.2.2",
+		"postcss-css-variables": "0.18.0",
+		"postcss-import": "12.0.1",
+		"postcss-loader": "4.1.0",
+		"postcss-nested": "4.2.3",
+		"postcss-url": "8.0.0",
+		"stylus": "0.54.8",
+		"stylus-loader": "3.0.2",
+		"vue": "2.6.14",
+		"vue-template-compiler": "2.6.14"
+	},
+	"eslintConfig": {
+		"root": true,
+		"env": {
+			"node": true
+		},
+		"extends": [
+			"plugin:vue/essential",
+			"eslint:recommended"
+		],
+		"parserOptions": {
+			"parser": "babel-eslint"
+		},
+		"rules": {}
+	},
+	"browserslist": [
+		"> 1%",
+		"last 2 versions"
+	],
+	"files": [
+		"dist/*",
+		"src/*",
+		"*.json"
+	]
+}

package/src/components/puidocgen/PuiDocgenTemplateActions.js

@@ -0,0 +1,102 @@
+let selectedRegistry = null;
+
+const generateAction = {
+	id: 'generateAction',
+	selectionType: 'single',
+	label: 'puiaction.docgen.generate',
+	functionality: 'GEN_PUI_DOCGEN',
+	checkAvailability: function () {
+		return true;
+	},
+	runAction: function (action, model, registries) {
+		selectedRegistry = registries[0];
+
+		const data = { isAction: true, model: model, registry: selectedRegistry };
+		this.$puiEvents.$emit(`pui-modalDialogForm-puiDocgenTemplateParameters-${model.name}-show`, data);
+	}
+};
+
+const downloadTemplateAction = {
+	id: 'downloadTemplateAction',
+	selectionType: 'single',
+	label: 'puiaction.docgen.downloadtemplate',
+	functionality: 'WRITE_PUI_DOCGEN',
+	checkAvailability: function () {
+		return true;
+	},
+	runAction: function (action, model, registries) {
+		selectedRegistry = registries[0];
+		const title = this.$puiI18n.t('puiaction.notifyTitle') + ' > ' + this.$puiI18n.t(action.label);
+
+		this.$puiRequests.downloadFileRequest(
+			'get',
+			model.url.downloadTemplate,
+			{ id: selectedRegistry.id },
+			(response) => {
+				const link = document.createElement('a');
+				link.href = window.URL.createObjectURL(new window.Blob([response.data]));
+				link.download = selectedRegistry.filename;
+				link.click();
+
+				this.$puiEvents.$emit(`onPui-action-running-ended-${model.name}`);
+				selectedRegistry = null;
+			},
+			() => {
+				this.$puiEvents.$emit(`onPui-action-running-ended-${model.name}`);
+				const message = this.$puiI18n.t('puiaction.notifyError');
+				this.$puiNotify.error(message, title);
+			}
+		);
+	}
+};
+
+const downloadSampleTemplateAction = {
+	id: 'downloadSampleTemplateAction',
+	selectionType: 'general',
+	label: 'puiaction.docgen.downloadsampletemplate',
+	functionality: 'WRITE_PUI_DOCGEN',
+	checkAvailability: function () {
+		return true;
+	},
+	runAction: function (action, model) {
+		const title = this.$puiI18n.t('puiaction.notifyTitle') + ' > ' + this.$puiI18n.t(action.label);
+
+		this.$puiRequests.downloadFileRequest(
+			'get',
+			model.url.downloadSampleTemplate,
+			null,
+			(response) => {
+				const link = document.createElement('a');
+				link.href = window.URL.createObjectURL(new window.Blob([response.data]));
+				link.download = this.$puiUtils.getFilenameFromHeaders(response.headers);
+				link.click();
+
+				this.$puiEvents.$emit(`onPui-action-running-ended-${model.name}`);
+			},
+			() => {
+				this.$puiEvents.$emit(`onPui-action-running-ended-${model.name}`);
+				const message = this.$puiI18n.t('puiaction.notifyError');
+				this.$puiNotify.error(message, title);
+			}
+		);
+	}
+};
+
+const uploadNewTemplateAction = {
+	id: 'uploadNewTemplateAction',
+	selectionType: 'single',
+	label: 'puiaction.docgen.uploadnewtemplate',
+	functionality: 'WRITE_PUI_DOCGEN',
+	checkAvailability: function () {
+		return true;
+	},
+	runAction: function (action, model, registries) {
+		selectedRegistry = registries[0];
+		selectedRegistry.isAction = true;
+		this.$puiEvents.$emit('pui-modalDialogForm-uploadNewTemplate-' + model.name + '-show', selectedRegistry);
+	}
+};
+
+export default {
+	actions: [generateAction, downloadTemplateAction, downloadSampleTemplateAction, uploadNewTemplateAction]
+};

package/src/components/puidocgen/PuiDocgenTemplateFilter.vue

@@ -0,0 +1,113 @@
+<template>
+	<pui-field-set :title="title">
+		<h4 class="puidocgentemplate-subtitle">{{ subtitle }}</h4>
+		<pui-docgen-template-filter-group
+			v-if="columns.length > 0"
+			:ref="'group0'"
+			:columns="columns"
+			:groupName="'0'"
+			:rulesProp="filter ? filter.rules : undefined"
+			:groupOpProp="filter ? filter.groupOp : undefined"
+			:groupsProp="filter ? filter.groups : undefined"
+			:disabled="disabled"
+			:showSubgroupBtn="showSubgroupBtn"
+		></pui-docgen-template-filter-group>
+	</pui-field-set>
+</template>
+
+<script>
+import PuiDocgenTemplateFilterGroup from './PuiDocgenTemplateFilterGroup';
+
+export default {
+	name: 'PuiDocgenTemplateFilter',
+	components: {
+		PuiDocgenTemplateFilterGroup
+	},
+	data() {
+		return {
+			showSubgroupBtn: true
+		};
+	},
+	props: {
+		title: {
+			type: String,
+			required: true
+		},
+		subtitle: {
+			type: String,
+			required: true
+		},
+		filter: {
+			type: Object,
+			required: true
+		},
+		columns: {
+			type: Array,
+			required: true
+		},
+		disabled: {
+			type: Boolean,
+			required: true
+		}
+	},
+	methods: {
+		retrieveGroupsData() {
+			//
+			const isRule = function (name) {
+				return name.startsWith('rule');
+			};
+			let validFilter = true;
+			let almenosUnaRegla = false;
+			//funcion recursiva que recorre los subgrupos hasta el final mientras queden
+			const processGroup = (groupComponent, groupFilterObject) => {
+				for (var ruleOrGroup in groupComponent.$refs) {
+					if (isRule(ruleOrGroup) === true) {
+						almenosUnaRegla = true;
+						const ruleComponent = groupComponent.$refs[ruleOrGroup][0];
+						const rule = {
+							field: ruleComponent.field,
+							op: ruleComponent.op,
+							data: ruleComponent.data
+						};
+						if (!rule.field || !rule.op || (!rule.data && rule.op !== 'nn' && rule.op !== 'nu')) {
+							!this.destroying && this.$puiNotify.warning(this.$t('not-valid-rule-error'));
+							validFilter = false;
+							return;
+						}
+						if (rule.op === 'in' || rule.op === 'ni') {
+							rule.data = rule.data.split(',');
+						}
+						groupFilterObject.rules.push(rule);
+					} else {
+						//isGroup
+						const subgroupComponent = groupComponent.$refs[ruleOrGroup][0];
+						if (subgroupComponent instanceof Object) {
+							const group = {
+								groupOp: subgroupComponent.groupOp,
+								rules: [],
+								groups: []
+							};
+							groupFilterObject.groups.push(group);
+							processGroup(subgroupComponent, group);
+						}
+					}
+				}
+			};
+
+			const internalFilter = {
+				rules: [],
+				groups: [],
+				groupOp: this.$refs.group0.groupOp
+			};
+			//empezamos por el grupo 0
+			processGroup(this.$refs.group0, internalFilter);
+			if (almenosUnaRegla === false) {
+				return { groupOp: 'and', groups: [], rules: [] };
+			} else if (validFilter === true) {
+				return internalFilter;
+			}
+			return null;
+		}
+	}
+};
+</script>

package/src/components/puidocgen/PuiDocgenTemplateFilterGroup.vue

@@ -0,0 +1,291 @@
+<template>
+	<v-layout wrap class="pb-1 pt-1 mb-1 puiDocgenTemplateFilterGroup" @mouseover.stop="showGroupBtns = true" @mouseout="showGroupBtns = false">
+		<v-flex xs12 v-if="isGroup0">
+			<v-toolbar height="48" class="elevation-0 bottomtoolbar pt-1 pb-1">
+				<v-btn v-if="disabled === false" class="btnAddGroup elevation-0" @click="addSubGroup()">
+					<v-icon small>fa fa-layer-group</v-icon>
+					<span>{{ $t('addGroup') }}</span>
+				</v-btn>
+				<v-spacer></v-spacer>
+			</v-toolbar>
+		</v-flex>
+		<v-flex xs12 v-if="(isGroup0 && groups.length > 1) || !isGroup0">
+			<v-layout wrap class="puiDocgenTemplateFilterGroup__groupOperator pt-1 pl-3">
+				<v-flex xs4 align-self-center>
+					<span>{{ $t('labelGroup') }}</span>
+				</v-flex>
+				<v-flex xs2>
+					<v-select
+						:label="$t('or')"
+						append-icon="fa fa-angle-down"
+						solo
+						flat
+						hide-details
+						:items="groupOperators"
+						v-model="groupOp"
+						:disabled="disabled"
+					></v-select>
+				</v-flex>
+			</v-layout>
+		</v-flex>
+		<v-layout v-if="!isGroup0" wrap>
+			<v-flex xs12>
+				<v-layout v-for="(rule, i) in rules" :key="i">
+					<v-flex xs11>
+						<pui-docgen-template-filter-rule
+							:ref="`rule${i}`"
+							:ruleIndex="i"
+							:columns="columns"
+							:fieldProp="rule.field"
+							:opProp="rule.op"
+							:dataProp="rule.data"
+							:group="groupName"
+							:ruleOperators="groupOperators"
+							:disabled="disabled"
+						></pui-docgen-template-filter-rule>
+					</v-flex>
+					<v-flex xs1 v-if="disabled === false">
+						<v-list-item>
+							<v-icon class="pointer" small @click.native="removeRule(i)">fa fa-trash-alt</v-icon>
+						</v-list-item>
+					</v-flex>
+				</v-layout>
+			</v-flex>
+		</v-layout>
+		<v-layout wrap v-if="groups.length > 0" class="full-width">
+			<pui-docgen-template-filter-group
+				v-for="(group, i) in groups"
+				:groupOperators="groupOperators"
+				:columns="columns"
+				:groupName="groupName + '-' + i"
+				:rulesProp="groupsProp ? groupsProp[i].rules : undefined"
+				:groupOpProp="groupsProp ? groupsProp[i].groupOp : undefined"
+				:groupsProp="groupsProp ? groupsProp[i].groups : undefined"
+				:ref="`group${i}`"
+				:key="i"
+				:disabled="disabled"
+				:showSubgroupBtn="showSubgroupBtn"
+			></pui-docgen-template-filter-group>
+		</v-layout>
+		<v-layout v-if="!isGroup0" wrap>
+			<v-flex xs12>
+				<v-toolbar height="32" class="elevation-0 puiDocgenTemplateFilterGroup__bottombar">
+					<v-btn v-if="disabled === false" class="btnGroup btnAddRule elevation-0 ml-3" @click="addRule()">
+						<v-icon small>far fa-plus</v-icon>
+						<span>{{ $t('addRule') }}</span>
+					</v-btn>
+					<v-btn v-if="showSubgroupBtn && disabled === false" class="btnGroup btnAddGroup elevation-0" @click="addSubGroup()">
+						<v-icon small>fa fa-layer-group</v-icon>
+						<span>{{ $t('addSubGroup') }}</span>
+					</v-btn>
+					<v-btn v-if="!isFirstGroup && disabled === false" class="btnGroup btnRemGroup elevation-0" @click="removeGroup()">
+						<v-icon small>fa fa-trash-alt</v-icon>
+						<span>{{ $t('removeGroup') }}</span>
+					</v-btn>
+					<v-spacer></v-spacer>
+				</v-toolbar>
+			</v-flex>
+		</v-layout>
+	</v-layout>
+</template>
+
+<script>
+import PuiDocgenTemplateFilterRule from './PuiDocgenTemplateFilterRule';
+
+export default {
+	name: 'PuiDocgenTemplateFilterGroup',
+	components: {
+		PuiDocgenTemplateFilterRule
+	},
+	props: {
+		columns: {
+			type: Array,
+			required: true
+		},
+		groupName: {
+			type: String
+		},
+		rulesProp: {
+			type: Array
+		},
+		groupOpProp: {
+			type: String
+		},
+		groupsProp: {
+			type: Array
+		},
+		disabled: {
+			type: Boolean,
+			default: false
+		},
+		showSubgroupBtn: {
+			type: Boolean
+		}
+	},
+	data() {
+		return {
+			rules: [],
+			groups: [],
+			groupOp: 'or',
+			showDeleteRule: null,
+			showGroupBtns: null,
+			groupOperators: [
+				{
+					text: 'and',
+					value: 'and'
+				},
+				{
+					text: 'or',
+					value: 'or'
+				}
+			]
+		};
+	},
+	computed: {
+		isFirstGroup() {
+			if (this.groups.length === 1) {
+				return true;
+			}
+			return false;
+		},
+		isGroup0() {
+			return this.groupName === '0';
+		}
+	},
+	created() {
+		this.translateGroupOperators();
+		if (this.groupOpProp && this.groupsProp && this.rulesProp) {
+			this.groupOp = this.groupOpProp;
+			this.groups = this.groupsProp;
+			this.rules = this.rulesProp;
+		}
+	},
+	mounted() {
+		this.$puiEvents.$on('reset-filtering', this.reset);
+		this.$puiEvents.$on(`groupRemoved-${this.groupName}`, this.onGroupRemoved);
+		if (!this.groupsProp && this.isGroup0 === true && !this.groupComp) {
+			this.addSubGroup();
+		} else if (!this.groupsProp && this.groupName === '0-0' && this.rules.length === 0) {
+			this.addRule();
+		}
+	},
+	destroyed() {
+		this.$puiEvents.$off('reset-filtering', this.reset);
+		this.$puiEvents.$off(`groupRemoved-${this.groupName}`);
+	},
+	methods: {
+		translateGroupOperators() {
+			for (let i = 0, length = this.groupOperators.length; i < length; i++) {
+				this.groupOperators[i].text = this.$t(this.groupOperators[i].text);
+			}
+		},
+		reset() {
+			this.rules = [];
+			this.groups = [];
+			for (var ruleOrGroup in this.$refs) {
+				delete this.$refs[ruleOrGroup];
+			}
+		},
+		addRule() {
+			this.rules.push({});
+		},
+		addSubGroup() {
+			this.groups.push({});
+		},
+		removeRule(i) {
+			this.rules.splice(i, 1);
+			delete this.$refs[`rule${i}`];
+		},
+		onGroupRemoved(i) {
+			this.groups.splice(i, 1);
+			delete this.$refs[`group${i}`];
+			if (this.isGroup0 && this.groupsProp) {
+				this.groups = this.groupsProp;
+			}
+		},
+		removeGroup() {
+			//Obtenemos el indice de grupo de sí mismo
+			const array = this.groupName.split('-');
+			//el indice de grupo es el numero más a la derecha del nombre (separados por -)
+			const index = array[array.length - 1];
+			//el nombre del padre es el groupName quitandole '-' + index
+			const parentGroupName = array.slice(0, -1).join('-') || array[0];
+			//publicamos el evento y el grupo padre se encargará de borrar este grupo
+			this.$puiEvents.$emit(`groupRemoved-${parentGroupName}`, index);
+		}
+	}
+};
+</script>
+
+<style lang="postcss" scoped>
+.dragger {
+	height: 24px !important;
+	width: 20px !important;
+	min-width: 20px !important;
+	padding-left: 3px !important;
+	padding-right: 3px !important;
+	color: var(--N-100) !important;
+	cursor: move !important;
+	&:hover {
+	}
+}
+.btnGroup {
+	height: 28px !important;
+	color: var(--N-500);
+	& span {
+		padding-left: 6px;
+	}
+}
+.puiDocgenTemplateFilterGroup {
+	background-color: var(--N-10);
+	border-radius: 5px;
+	&__groupOperator {
+		height: 50px;
+	}
+	&__bottombar {
+	}
+	& .bottomtoolbar {
+		background-color: transparent !important;
+	}
+	& .puiDocgenTemplateFilterGroup {
+		background-color: var(--N-0);
+		margin-left: 11px;
+		margin-right: 5px;
+		border-width: 1px;
+		border-style: solid;
+		border-color: var(--N-100);
+		& .v-toolbar,
+		.v-btn {
+			background-color: var(--N-0);
+		}
+
+		& .puiDocgenTemplateFilterGroup {
+			background-color: var(--N-10);
+			margin-left: 11px;
+			margin-right: 5px;
+			& .v-toolbar,
+			.v-btn {
+				background-color: var(--N-10);
+			}
+			& .puiDocgenTemplateFilterGroup {
+				background-color: var(--N-0);
+				margin-left: 11px;
+				margin-right: 5px;
+				& .v-toolbar,
+				.v-btn {
+					background-color: var(--N-0);
+				}
+				& .puiDocgenTemplateFilterGroup {
+					background-color: var(--N-10);
+					margin-left: 11px;
+					margin-right: 5px;
+					& .v-toolbar,
+					.v-btn {
+						background-color: var(--N-10);
+					}
+				}
+			}
+		}
+	}
+}
+</style>