complexqa_frontend_core 1.0.9 → 1.0.10

package/publish/types/family_elements/0_familyGeneralElement.js

@@ -0,0 +1,439 @@
+import { clone_object, echo, in_array, is_array } from "../../utils/utils";
+
+/**
+ * Базовый абстрактный класс для всех типов
+ *
+ * @version			v.0.2 (12/06/2025)
+ */
+export class familyGeneralElement
+{
+	primary_key           = false;
+	create_scheme         = false;
+	structure_scheme      = false;
+	available_enum_values = false;
+	api_key               = false;
+
+
+	/***********************************************/
+	/***********************************************/
+
+	/***********************************************/
+
+	/**
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 * @return {string|false}
+	 */
+	get_primary_key()
+	{
+		if (this.primary_key)
+		{
+			return this.primary_key;
+		}
+		else
+		{
+			throw new Error('familyGeneralElement has no primary_key. Error #01-01');
+		}
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (27/06/2024)
+	 * @returns {array<familyGeneralElement>}
+	 * @param {number} count
+	 */
+	get_random_demo_data(count)
+	{
+		// @todo validations
+		let response = [];
+		for (let i = 0; i < count; i++)
+		{
+			response.push(this.get_demo_row());
+		}
+		// получаем массив сгенерированных элементов,
+		// в том числе - с незаполненными данными (корректная обработка)
+
+		// контроль пересечения primary key
+		// прототип идеи
+		// @todo - дописать
+		return response;
+	}
+
+	/**
+	 *
+	 * @returns {familyGeneralElement}
+	 */
+	get_demo_row()
+	{
+		return this;
+	}
+
+	/**
+	 *
+	 * @version			v.0.2 (15/06/2024)
+	 * @param {string} attribute
+	 */
+	get_available_enum_values(attribute)
+	{
+		let response = false;
+		if (this.structure_scheme?.[ attribute ])
+		{
+			// выбрасывать исключения?
+			return false;
+		}
+
+		let rules = this.get_attribute_structure_scheme(attribute);
+		if (!rules)
+		{
+			return false;
+		}
+		if (!in_array('enum', rules))
+		{
+			return false;
+		}
+
+		if (this.available_enum_values?.[ attribute ])
+		{
+			response = this.available_enum_values?.[ attribute ];
+		}
+
+		return response;
+	}
+
+
+	/**
+	 *
+	 * @param attribute
+	 * @returns {array|false}
+	 */
+	get_attribute_structure_scheme(attribute)
+	{
+		let response = false;
+		if (this.structure_scheme[ attribute ])
+		{
+			let scheme = clone_object(this.structure_scheme[ attribute ]);
+
+			if (scheme)
+			{
+				scheme = scheme.split('|');
+				if (is_array(scheme))
+				{
+					response = [];
+					scheme.map((row) =>
+					{
+						response.push(row.trim());
+					});
+				}
+			}
+		}
+
+		return response;
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 */
+	get_data()
+	{
+		return this.get_pure_data();
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 */
+	get_pure_data()
+	{
+		let response = false;
+		if (this.structure_scheme)
+		{
+			response = {};
+			_.mapObject(this.structure_scheme, (value, attribute) =>
+			{
+				if (this[ attribute ])
+				{
+					response [ attribute ] = this[ attribute ];
+				}
+			});
+		}
+
+		return response;
+	}
+
+
+	/**
+	 * @todo - сделать нормализация по create scheme с валидацией
+	 *
+	 * @version			v.0.1 (26/01/2025)
+	 *
+	 * @param payload
+	 * @returns {*}
+	 */
+	normalize_payload(payload)
+	{
+
+		return payload;
+	}
+
+
+	get_editable_attributes() {}
+
+	is_editable_attribute(attribute) {}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 * @param {string} attribute_name
+	 * @return {string}
+	 */
+	get_attribute_name_translate(attribute_name)
+	{
+		return attribute_name;
+	}
+
+	/***********************************************/
+
+	/**
+	 * Возвращаем "имя", то есть значение атрибута, который является именем
+	 *
+	 * @version			v.0.1 (05/06/2025)
+	 */
+	get_element_name()
+	{
+		alert('Error #205-001 Not implemented method');
+	}
+
+	/***********************************************/
+	/***********************************************/
+
+	/***********************************************/
+
+	/**
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 * @param id
+	 */
+	async find(id = false)
+	{
+		// или передаем ID, или используем вложенный
+		// возвращаем инстанс себя же
+		alert('Error #267-001 Not implemented method');
+	}
+
+
+	/**
+	 *
+	 * @param {familyGeneralElement|object} 			payload
+	 *
+	 * @param {typeFunctionCallback|object|false} 		callback
+	 *
+	 * @param {?function} 								callback.before
+	 * @param {?function} 								callback.success
+	 * @param {?function} 								callback.error
+	 * @param {?function} 								callback.final
+	 *
+	 * @version			v.2.0 (12/06/2025)
+	 */
+	async create(payload, callback)
+	{
+		if (!this.api_key)
+		{
+			throw new Error('element has not api_key');
+		}
+
+		if (typeof callback?.before === 'function')
+		{
+			callback?.before({ payload });
+		}
+
+		payload = this.normalize_payload(payload);
+
+
+		/**
+		 * {Api} ApiService
+		 */
+		return ApiService[this.api_key].create(payload).then((response) =>
+		{
+			if (typeof callback?.success === 'function')
+			{
+				callback?.success({ response, payload })
+			}
+		}).catch((error) =>
+		{
+			echo({ error });
+			if (typeof callback?.error === 'function')
+			{
+				callback?.error({ error, payload })
+			}
+		}).finally((response) =>
+		{
+			if (typeof callback?.final === 'function')
+			{
+				callback?.final({ response, payload })
+			}
+		});
+	}
+
+
+
+	/**
+	 *
+	 * @version			v.2.0 (12/06/2025)
+	 */
+	async update(payload, callback)
+	{
+		if (!this.api_key)
+		{
+			throw new Error('element has not api_key');
+		}
+
+		if (typeof callback?.before === 'function')
+		{
+			callback?.before({ payload });
+		}
+
+		payload = this.normalize_payload(payload);
+
+
+		/**
+		 * {Api} ApiService
+		 */
+		return ApiService[this.api_key].update(payload).then((response) =>
+		{
+			if (typeof callback?.success === 'function')
+			{
+				callback?.success({ response, payload })
+			}
+		}).catch((error) =>
+		{
+			echo({ error });
+			if (typeof callback?.error === 'function')
+			{
+				callback?.error({ error, payload })
+			}
+		}).finally((response) =>
+		{
+			if (typeof callback?.final === 'function')
+			{
+				callback?.final({ response, payload })
+			}
+		});
+	}
+
+
+
+	/**
+	 *
+	 * @version			v.2.0 (12/06/2025)
+	 * @param key
+	 * @param value
+	 * @param callback
+	 * @returns {Promise<>}
+	 */
+	async update_property(key, value, callback)
+	{
+		if (!this.api_key)
+		{
+			throw new Error('element has not api_key');
+		}
+
+		let payload = {
+			key         : key,
+			value       : value,
+		};
+		payload[this.get_primary_key()] = this[this.get_primary_key()];
+
+		if (typeof callback?.before === 'function')
+		{
+			callback?.before({ payload });
+		}
+
+		/**
+		 * {Api} ApiService
+		 */
+		return ApiService[this.api_key].update_property(payload).then((response) =>
+		{
+			if (typeof callback?.success === 'function')
+			{
+				callback?.success({ response, payload })
+			}
+		}).catch((error) =>
+		{
+			echo({ error });
+			if (typeof callback?.error === 'function')
+			{
+				callback?.error({ error, payload })
+			}
+		}).finally((response) =>
+		{
+			if (typeof callback?.final === 'function')
+			{
+				callback?.final({ response, payload })
+			}
+		});
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 */
+	async update_properties()
+	{
+		alert('Error #272-001 Not implemented method');
+	}
+
+
+
+	/**
+	 *
+	 * @version			v.2.0 (12/06/2025)
+	 */
+	async delete(element = false, callback = {})
+	{
+		if (!this.api_key)
+		{
+			throw new Error('element has not api_key');
+		}
+
+		if (!element)
+		{
+			element = this;
+		}
+
+		let payload = {};
+
+		payload[this.get_primary_key()] = element[this.get_primary_key()];
+
+		if (typeof callback?.before === 'function')
+		{
+			callback?.before({ payload });
+		}
+
+		return ApiService[this.api_key].delete(payload).then((response) =>
+		{
+			if (typeof callback?.success === 'function')
+			{
+				callback?.success({ response, payload })
+			}
+		}).catch((error) =>
+		{
+			echo({ error });
+			if (typeof callback?.error === 'function')
+			{
+				callback?.error({ error, payload })
+			}
+		}).finally((response) =>
+		{
+			if (typeof callback?.final === 'function')
+			{
+				callback?.final({ response, payload })
+			}
+		});
+	}
+}

package/publish/types/family_elements/mock_data/abstract_mock_data.js

@@ -0,0 +1,13 @@
+/**
+ *
+ * @version			v.0.1 (02/07/2024)
+ */
+export class abstractMockData
+{
+	mock_data_type = 'correct';
+
+	constructor(mock_data_type = 'correct')
+	{
+		this.mock_data_type = mock_data_type;
+	}
+}

package/publish/types/family_elements/mock_data/mock_data_typeProject.js

@@ -0,0 +1,88 @@
+import { abstractMockData } from "./abstract_mock_data";
+import { count, is_object } from "../../../utils/utils";
+
+
+/**
+ * @version			v.0.1 (02/07/2024)
+ */
+export class MockDataTypeProject extends abstractMockData
+{
+	correct = [ {
+		project_id         : 11,
+		project_name       : 'Demo Project #11',
+		project_description: 'Description – это мета тег, представляющий собой описание. Он находится под заголовком (title) и ссылкой на сайт. Целью тега является вывод страницы в топ. Это в свою очередь привлечет больше целевых пользователей. Можно составить description самостоятельно.',
+		project_status     : 'OPEN',
+		team_id            : 0,
+	}, {
+		project_id         : 22,
+		project_name       : 'Demo Project #22',
+		project_description: 'Однако есть риск допустить ошибку. Если использовать не те фразы и длину предложения, то успеха не достичь.',
+		project_status     : 'OPEN',
+		team_id            : 0,
+	}, {
+		project_id         : 33,
+		project_name       : 'Perspective project № 1',
+		project_description: 'Чтобы сделать онлайн контент план, нужно ввести тематику блога. На основании данных генератор подберет темы.',
+		project_status     : 'PLANNED',
+		team_id            : 0,
+	}, {
+		project_id         : 44,
+		project_name       : 'Perspective project № 2',
+		project_description: 'Укажите любые детали вашей веб-страницы: вставьте сам текст или укажите тему/ключевые слова;',
+		project_status     : 'PLANNED',
+		team_id            : 0,
+	}, {
+		project_id         : 55,
+		project_name       : 'Closed project № 1',
+		project_description: 'Протестируйте бесплатно',
+		project_status     : 'PLANNED',
+		team_id            : 0,
+	}, {
+		project_id         : 66,
+		project_name       : 'Closed project № 1',
+		project_description: 'Создать теги онлайн можно бесплатно. Для этого вставьте всю информацию в специальную форму. Генератор быстро сформирует результат. Вы сможете убедиться в его скорости и эффективности. Создатель тегов – быстрый и удобный сервис.',
+		project_status     : 'PLANNED',
+		team_id            : 0,
+	},
+	];
+
+	static last_index = {
+		correct: 0
+	};
+
+
+	/**
+	 *
+	 * @version			v.0.1 (02/07/2024)
+	 * @param mock_data_type
+	 */
+	constructor(mock_data_type = 'correct')
+	{
+		super();
+
+		let response = false;
+		if (mock_data_type === 'correct')
+		{
+			if (is_object(this.correct[ MockDataTypeProject.last_index[ mock_data_type ] ]))
+			{
+				response = this.correct[ MockDataTypeProject.last_index[ mock_data_type ] ];
+			}
+			else
+			{
+				MockDataTypeProject.last_index[ mock_data_type ] = 0;
+				response = this.correct[ MockDataTypeProject.last_index[ mock_data_type ] ];
+			}
+		}
+
+		if (count(this[ mock_data_type ]) >= MockDataTypeProject.last_index[ mock_data_type ])
+		{
+			MockDataTypeProject.last_index[ mock_data_type ]++;
+		}
+		else
+		{
+			MockDataTypeProject.last_index[ mock_data_type ] = 0;
+		}
+
+		return response;
+	}
+}

package/publish/types/family_elements/typeActionLog.js

@@ -0,0 +1,9 @@
+/**
+ * Заготовка - логи действий
+ *
+ * @version			v.0.1 (15/10/2024)
+ */
+export class typeActionLog
+{
+
+}

package/publish/types/family_elements/typeFunctional.js

@@ -0,0 +1,96 @@
+import { familyGeneralElement } from "./0_familyGeneralElement";
+import { is_object } from "../../utils/utils";
+
+
+/**
+ *
+ * @version			v.0.1 (23/06/2024)
+ */
+export class typeFunctional extends familyGeneralElement
+{
+	functional_id;
+	project_id;					// foreign key
+	functional_group_id;		// foreign key
+	team_id;					// foreign key
+	functional_name;
+	functional_description;
+	reference_document_ids;		// IDS документов по функционалу (к примеру confluence)
+	created_at;
+	updated_at;
+
+	primary_key = 'functional_id';
+
+	structure_scheme = {
+		functional_id         : 'integer | require',
+		project_id            : 'integer | require',
+		functional_group_id   : 'integer | require',
+		team_id               : 'integer | require',
+		functional_name       : 'string | max:90 | require',
+		functional_description: 'string | max:2500 | optional',
+		reference_document_ids: 'array | reference | optional',
+		created_at            : 'timestamp | require',
+		updated_at            : 'timestamp | optional',
+	};
+
+	available_enum_values = {
+		functional_status: [ 'не идей. нужен ли тут статус' ]
+	};
+
+
+	/**
+	 *
+	 * @param {object|false|undefined} data
+	 */
+	constructor(data = false)
+	{
+		super();
+
+		if (data && is_object(data))
+		{
+			_.mapObject(data, (value, key) =>
+			{
+				if (this.hasOwnProperty(key))
+				{
+					this [ key ] = value;
+				}
+			});
+		}
+
+		return this;
+	}
+
+
+	/******************************************************************************************/
+	/*********************************** general **********************************************/
+
+	/******************************************************************************************/
+
+	/**
+	 *
+	 * @version			v.0.1 (07/07/2024)
+	 */
+	async create()
+	{}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (07/07/2024)
+	 */
+	async update()
+	{
+
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (07/07/2024)
+	 */
+	async delete()
+	{
+
+	}
+
+
+}