complexqa_frontend_core 1.15.1 → 1.16.1

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

@@ -0,0 +1,632 @@
+import { clone_object, echo, in_array, is_array } from "../../utils/utils.js";
+
+/**
+ * Базовый абстрактный класс для всех типов
+ *
+ * @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;
+	attribute_name_translate_matrix = {
+		en: {},
+		ru: {}
+	}
+
+	enum_value_translate_matrix = 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 (14/03/2026)
+	 * @return {string|false}
+	 */
+	get_primary_key_value()
+	{
+		if (this.get_primary_key())
+		{
+			return this[ this.get_primary_key() ];
+		}
+		else
+		{
+			return false;
+		}
+	}
+
+
+	/**
+	 *
+	 * @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 ] !== undefined)
+				{
+					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.1.0 (14/03/2026)
+	 *
+	 * @param {string} attribute_name
+	 * @param {string} lang
+	 *
+	 * @return {string}
+	 */
+	get_attribute_name_translate(attribute_name, lang)
+	{
+		let response = attribute_name;
+
+		if (!lang)
+		{
+			lang = 'en';
+		}
+
+		if (this.attribute_name_translate_matrix?.[ lang ]?.[ attribute_name ])
+		{
+			response = this.attribute_name_translate_matrix?.[ lang ]?.[ attribute_name ];
+		}
+
+		return response;
+	}
+
+
+	/**
+	 *
+	 * @version			v.1.0 (05/04/2026)
+	 * @returns {*}
+	 */
+	get_enum_value_translate(attribute, value, lang)
+	{
+		let response = value;
+
+		if (!lang)
+		{
+			lang = 'en';
+		}
+
+		if (this.enum_value_translate_matrix?.[ attribute ]?.[ lang ]?.[ value ])
+		{
+			response = this.enum_value_translate_matrix?.[ attribute ]?.[ lang ]?.[ value ];
+		}
+
+		return response;
+	}
+
+	/***********************************************/
+
+	/**
+	 * Возвращаем "имя", то есть значение атрибута, который является именем
+	 *
+	 * @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('Error #249-2215 - element has no 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('Error #259-2215 - element has no 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 })
+			}
+		});
+	}
+
+
+	/**
+	 * Обновление 1 атрибута у 1 элемента
+	 *
+	 * @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('Error #345-2215 - element has no 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 })
+			}
+		});
+	}
+
+
+	/**
+	 * Массив свойств у 1 элемента
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 * @param {number} 	element_id
+	 * @param {array}  	payload array<key->value>
+	 * @returns {Promise<void>}
+	 */
+	async update_properties(element_id, payload, callback)
+	{
+		alert('Error #272-001 Not implemented method');
+	}
+
+
+	/**
+	 * 1 свойство и массива элементов
+	 *
+	 * @version			v.0.1 (07/07/2026)
+	 *
+	 * @param {array<number>} 					element_ids
+	 * @param {string} 							key
+	 * @param {any}  							value в зависимости от типа
+	 * @param {object|typeFunctionCallback} 	callback
+	 *
+	 * @returns {Promise<void>}
+	 */
+	async update_property_mass(element_ids, key, value, callback)
+	{
+		if (!this.api_key)
+		{
+			throw new Error('Error #471-2598 - element has no api_key');
+		}
+
+		let payload = {
+			element_ids: element_ids,
+			key        : key,
+			value      : value,
+		};
+
+		if (typeof callback?.before === 'function')
+		{
+			callback?.before({ payload });
+		}
+
+		/**
+		 * {Api} ApiService
+		 */
+		return ApiService[ this.api_key ].update_property_mass(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 delete(element = false, callback = {})
+	{
+		if (!this.api_key)
+		{
+			throw new Error('Error #404-2215 - element has no api_key');
+		}
+
+		if (!element)
+		{
+			element = this;
+		}
+
+		if (!window.confirm("Submit delete"))
+		{
+			return false;
+		}
+
+		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 })
+			}
+		});
+	}
+
+
+	/**
+	 *
+	 * @version			v.1.0 (07/03/2026)
+	 */
+	async delete_mass(element_ids, callback = {})
+	{
+
+	}
+
+
+	/**
+	 *
+	 * @version			v.1.0 (07/03/2026)
+	 */
+	async clone_element(element = false, callback = {})
+	{
+		if (!this.api_key)
+		{
+			throw new Error('Error #463-2215 - element has no api_key');
+		}
+
+		if (!element)
+		{
+			element = this;
+		}
+
+		let payload = {};
+
+		payload[ this.get_primary_key() ] = element[ this.get_primary_key() ];
+
+
+		/**
+		 * {Api} ApiService
+		 */
+		return ApiService[ this.api_key ].clone_element(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.1.0 (07/03/2026)
+	 */
+	async clone_element_mass(element_ids, callback = {})
+	{
+
+	}
+}