complexqa_frontend_core 1.0.0

package/publish/complexqa_frontend_core.js

@@ -0,0 +1,2991 @@
+/**
+ * Прототип идеи, пока не уверен, что именно так надо
+ *
+ * @version			v.0.1 (25/06/2024)
+ */
+class App
+{
+
+	init_options = false;
+
+	/**
+	 *
+	 * @version			v.0.1 (25/06/2024)
+	 */
+	constructor(init_options)
+	{
+
+		if (this.constructor._instance)
+		{
+			return this.constructor._instance;
+		}
+
+		this.init_options          = init_options;
+		this.constructor._instance = this;
+
+		this.#bootstrap();
+
+		return this.constructor._instance;
+	}
+
+	/**
+	 *
+	 * @version			v.0.1 (25/06/2024)
+	 */
+	#bootstrap()
+	{
+		this.service = {};
+		this.service.translate = new serviceTranslate();
+	}
+}
+
+/**
+ * Общие методы для всех типизированных элементов
+ *
+ * @version			v.2.0 (24/11/2024)
+ */
+class ApiAbstractElementClass
+{
+
+	init_options;
+	element_class_instance;
+	dev_stage_config;
+	parent_app;
+	host_api;
+	stage         = 'production';
+	module_prefix = false;
+	api_prefix    = 'web_api';
+	method;
+	headers;
+
+
+	/**
+	 *
+	 * @version			v.0.1 (27/06/2024)
+	 * @param options
+	 */
+	constructor(options)
+	{
+		if (options?.init_options)
+		{
+			this.init_options = options?.init_options;
+		}
+		if (options?.stage)
+		{
+			this.stage = options?.stage;
+		}
+		if (options?.dev_stage_config)
+		{
+			this.dev_stage_config = options?.dev_stage_config;
+		}
+		if (options?.parent_app)
+		{
+			this.parent_app = options?.parent_app;
+		}
+		if (options?.host_api)
+		{
+			this.host_api = options?.host_api;
+		}
+	}
+
+
+	set_element_class_instance(element_class_instance)
+	{
+		this.element_class_instance = element_class_instance;
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 * @param {object|typeFOR} 		payload
+	 * @param {array} 				payload.filter
+	 * @param {?object|undefined} 	payload.object
+	 * @param {?object|undefined} 	payload.response
+	 */
+	async search(payload)
+	{
+		if (!this.module_prefix)
+		{
+			throw new Error('Error #10-1152 in ApiAbstractClass');
+		}
+
+		if (this.stage === 'development')
+		{
+			let response = await this.#mock_search(payload);
+			return {
+				response: response,
+				payload : payload
+			};
+		}
+
+		let url = `/${ this.api_prefix }/${ this.module_prefix }/search`;
+
+		payload      = this.#handle_request_payload(payload);
+		let response = this.#api_request(url, payload);
+		response     = this.#handle_response(response);
+
+		return {
+			response: response,
+			payload : payload
+		};
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (27/06/2024)
+	 * @param payload
+	 * @returns {Promise<array>}
+	 */
+	async #mock_search(payload)
+	{
+		// @todo - дописать
+		if (this.dev_stage_config.api_response_search_element_count > 0 && this.dev_stage_config.api_response_search_element_count < 999)
+		{
+
+		}
+		else
+		{
+			throw new Error('Error #100-154');
+		}
+
+		let model    = new this.element_class_instance();
+		let response = model.get_random_demo_data(this.dev_stage_config.api_response_search_element_count)
+
+		return response;
+
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 * @param payload
+	 */
+	async find(payload)
+	{
+		if (!this.module_prefix)
+		{
+			throw new Error('Error #10-1152 in ApiAbstractClass');
+		}
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 * @param payload
+	 */
+	async create(payload)
+	{
+		if (!this.module_prefix)
+		{
+			throw new Error('Error #10-1152 in ApiAbstractClass');
+		}
+
+		if (this.stage === 'development')
+		{
+			return {
+				response: payload,
+				payload : payload
+			};
+		}
+
+		let url = `/${ this.api_prefix }/${ this.module_prefix }/create`;
+
+		payload      = this.#handle_request_payload(payload);
+		let response = this.#api_request(url, payload);
+		response     = this.#handle_response(response);
+
+		return {
+			response: response,
+			payload : payload
+		};
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 * @param payload
+	 */
+	async update(payload)
+	{
+		if (!this.module_prefix)
+		{
+			throw new Error('Error #10-1152 in ApiAbstractClass');
+		}
+
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 * @param payload
+	 */
+	async update_property(payload)
+	{
+		if (!this.module_prefix)
+		{
+			throw new Error('Error #10-1152 in ApiAbstractClass');
+		}
+
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 * @param payload
+	 */
+	async delete(payload)
+	{
+		if (!this.module_prefix)
+		{
+			throw new Error('Error #10-1152 in ApiAbstractClass');
+		}
+
+	}
+
+
+	/******************************************************************************************/
+	/******************************************************************************************/
+
+	/******************************************************************************************/
+
+	#handle_request_payload(payload)
+	{
+		return this.#object_replace_null_recursively(payload);
+	}
+
+	#object_replace_null_recursively(object)
+	{
+		let result = clone_object(object);
+		for (let key in result)
+		{
+			if (result[ key ] === null)
+			{
+				result[ key ] = 'NULL';
+			}
+			else if (( result[ key ]?.constructor === Object ) || ( result[ key ]?.constructor === Array ))
+			{
+				result[ key ] = this.#object_replace_null_recursively(result[ key ]);
+			}
+		}
+
+		return result;
+	}
+
+
+	/**
+	 *
+	 * @param url
+	 * @param payload
+	 * @param method
+	 * @returns {Promise<Promise<axios.AxiosResponse<any>> | *>}
+	 * @version			v.0.2 (26/01/2025)
+	 */
+	async #api_request(url, payload, method = 'POST')
+	{
+		let request_params;
+		if (!payload)
+		{
+			request_params = {};
+		}
+		else
+		{
+			request_params = clone_object(payload)
+		}
+
+		request_params = this.#mixin_service_params(request_params);
+
+		console.log({payload, request_params});
+
+
+		if (this.host_api)
+		{
+			url = 'https://' + this.host_api + url;
+		}
+
+		let request_options = {
+			method : method,
+			headers: this.headers,
+			url    : url
+		};
+
+		if (this.method === 'get')
+		{
+			request_options.paramsSerializer = this.object_to_string;
+			request_options.params           = request_params;
+		}
+		else
+		{
+			request_options.data = (request_params);
+		}
+
+		let config = {};
+
+		return axios(request_options, config);
+	}
+
+
+	/**
+	 *
+	 * @param object
+	 * @returns {string}
+	 */
+	object_to_string(object)
+	{
+		let result = qs.stringify(object, { array_format: 'indices' });
+
+		return result;
+	}
+
+
+	#mixin_service_params(params)
+	{
+		params.client = 'webapp';
+		return params;
+	}
+
+
+	/**
+	 *
+	 * @param {} response
+	 * @returns {Promise<any>}
+	 * @version			v.0.1 (01/06/2024)
+	 */
+	#handle_response(response)
+	{
+		response = response.then((api_response) =>
+		{
+			let error_payload = {
+				api_response: api_response?.data?.api_response,
+				api_code    : api_response?.data?.api_code,
+				api_result  : api_response?.data?.api_result,
+				api_error   : api_response?.data?.api_error
+			};
+
+			if (api_response?.data?.api_error?.adapted_message)
+			{
+				error_payload.message = api_response.data.api_error.adapted_message
+				throw new ApiException(error_payload);
+			}
+			else if (api_response?.data?.api_code)
+			{
+				let api_code = api_response.data.api_code;
+
+				if (( api_code >= 200 ) && ( api_code <= 299 ))
+				{
+					if (is_array(api_response?.data) && this.element_class_instance)
+					{
+						let result = api_response?.data.map((row) =>
+						{
+							return new this.element_class_instance(row);
+						});
+
+						return result;
+					}
+					else
+					{
+						return api_response?.data;
+					}
+				}
+				else if (api_response?.data?.api_result === false)
+				{
+					throw new ApiException(error_payload);
+				}
+				else
+				{
+					throw new ApiException(error_payload);
+				}
+			}
+			else
+			{
+				return api_response?.data;
+			}
+		})
+			.catch((error) =>
+			{
+
+				echo({ app: this });
+				console.error(error);
+				if (error instanceof ApiException)
+				{
+					throw error;
+				}
+
+
+				throw new ApiException({ error: error });
+			});
+
+		return response;
+	}
+}
+
+/**
+ *
+ * @version			v.0.1 (24/11/2024)
+ */
+class FunctionalApi extends ApiAbstractElementClass
+{
+	module_prefix = 'functional';
+
+	constructor(options)
+	{
+		super(options);
+		this.set_element_class_instance(typeFunctional);
+	}
+}
+/**
+ * Обертка над axios
+ * @version			v.0.3 (26/01/2025)
+ */
+class Api
+{
+	/**
+	 * Режим работы
+	 *
+	 * @type {string} development || production || tests
+	 */
+	stage            = 'development';
+	dev_stage_config = {
+		generate_error                   : false,
+		api_response_delay               : 3500,
+		api_response_search_element_count: 8,
+	};
+
+	init_options;
+
+	test_plan;
+	/**
+	 * {ProjectApi} project
+	 */
+	project;
+	service;
+
+	host_api = false;
+
+
+	/**
+	 *
+	 * @version			v.0.3 (26/01/2025)
+	 */
+	constructor(init_options)
+	{
+
+		if (this.constructor._instance)
+		{
+			return this.constructor._instance;
+		}
+
+
+		if (init_options.host_api)
+		{
+			// @todo validate
+			this.host_api = init_options.host_api;
+		}
+		else
+		{
+			// подумать
+			this.host_api = 'complexqa.localhost';
+		}
+
+		if (init_options.stage)
+		{
+			// @todo validate
+			this.stage = init_options.stage;
+		}
+
+		if (init_options.dev_stage_config)
+		{
+			// @todo validate
+			this.dev_stage_config = init_options.dev_stage_config;
+		}
+
+		this.init_options          = init_options;
+		this.constructor._instance = this;
+
+
+		this.#bootstrap();
+		return this.constructor._instance;
+	}
+
+
+	/**
+	 *
+	 * @param stage
+	 */
+	set_stage(stage)
+	{
+		this.stage = stage;
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (25/06/2024)
+	 */
+	#bootstrap()
+	{
+		let payload = {
+			init_options    : this.init_options,
+			stage           : this.stage,
+			dev_stage_config: this.dev_stage_config,
+			host_api: this.host_api,
+			parent_app      : this
+		};
+
+		//echo({payload});
+
+		this.test_plan = new TestPlanApi(payload);
+		this.project   = new ProjectApi(payload);
+		this.service   = new ServiceApi(payload);
+	}
+}
+/**
+ *
+ * @version			v.0.1 (15/06/2024)
+ */
+class ProjectApi extends ApiAbstractElementClass
+{
+	module_prefix = 'project';
+
+	constructor(options)
+	{
+		super(options);
+		this.set_element_class_instance(typeProject);
+	}
+}
+
+// тут нужен свой класс, не для типов
+class ServiceApi
+{
+	module_prefix = '--';
+
+	constructor(options)
+	{
+	}
+
+
+	/**
+	 *
+	 * @returns {Promise<*[]>}
+	 */
+	async translate_get_dictionaries()
+	{
+		return [];
+	}
+}
+
+/**
+ *
+ * @version			v.0.1 (24/11/2024)
+ */
+class TeamMemberApi extends ApiAbstractElementClass
+{
+	module_prefix = 'team_member';
+
+	constructor(options)
+	{
+		super(options);
+		this.set_element_class_instance(typeTeamMember);
+	}
+}
+
+/**
+ *
+ * @version			v.0.1 (24/11/2024)
+ */
+class TestCaseApi extends ApiAbstractElementClass
+{
+	module_prefix = 'test_case';
+
+	constructor(options)
+	{
+		super(options);
+		this.set_element_class_instance(typeTestCase);
+	}
+}
+
+/**
+ *
+ * @version			v.0.1 (24/11/2024)
+ */
+class TestCaseStepApi extends ApiAbstractElementClass
+{
+	module_prefix = 'test_case_step';
+
+	constructor(options)
+	{
+		super(options);
+		this.set_element_class_instance(typeTestCaseStep);
+	}
+}
+
+/**
+ *
+ * @version			v.0.1 (26/05/2024)
+ */
+class TestPlanApi extends ApiAbstractElementClass
+{
+	module_prefix = 'test_plan';
+
+	constructor(options)
+	{
+		super(options);
+		this.set_element_class_instance(typeTestPlan);
+	}
+}
+class TestRunApi extends ApiAbstractElementClass
+{
+	module_prefix = 'test_run';
+
+	constructor(options)
+	{
+		super(options);
+		this.set_element_class_instance(typeTestRun);
+	}
+}
+
+/**
+ *
+ * @version			v.0.1 (24/11/2024)
+ */
+class TestRunResultApi extends ApiAbstractElementClass
+{
+	module_prefix = 'test_run_result';
+
+	constructor(options)
+	{
+		super(options);
+		this.set_element_class_instance(typeTestRunResult);
+	}
+}
+
+/**
+ *
+ * @version			v.0.1 (24/11/2024)
+ */
+class TestSuiteApi extends ApiAbstractElementClass
+{
+	module_prefix = 'test_suite';
+
+	constructor(options)
+	{
+		super(options);
+		this.set_element_class_instance(typeTestSuite);
+	}
+}
+class ApiException extends Error
+{
+	/**
+	 * Сообщение об ошибке
+	 * @type {string}
+	 */
+	#message = '';
+	/**
+	 * Нативная ошибка
+	 * @type {null|Error}
+	 */
+	#error   = null;
+
+
+	api_response = null;
+	api_code     = null;
+	api_result   = null;
+	api_error    = null;
+
+
+	constructor(options)
+	{
+		super();
+
+		if (options.message)
+		{
+			this.#message = options.message;
+		}
+
+		if (options.error instanceof Error)
+		{
+			this.#error = options.error;
+		}
+
+
+		if (options?.api_response)
+		{
+			this.api_response = options?.api_response;
+		}
+
+		if (options?.api_code)
+		{
+			this.api_code = options?.api_code;
+		}
+
+		if (options?.api_result)
+		{
+			this.api_result = options?.api_result;
+		}
+
+		if (options?.api_error)
+		{
+			this.api_error = options?.api_error;
+		}
+	}
+
+
+	get_message()
+	{
+		if (this.#error instanceof Error)
+		{
+			return this.#error.message;
+		}
+		else
+		{
+			return this.#message;
+		}
+	}
+}
+/**
+ *
+ * @version			v.0.1 (25/06/2024)
+ */
+class abstractService
+{
+	init_options = false;
+
+
+	/**
+	 *
+	 * @param init_options
+	 */
+	constructor(init_options = false)
+	{
+		/*if (this.constructor._instance)
+		{
+			return this.constructor._instance;
+		}
+
+		this.init_options = init_options;
+
+		this.constructor._instance = this;*/
+	}
+
+	/*#bootstrap()
+	{
+
+	}*/
+}
+/**
+ *
+ * @version			v.0.1 (25/06/2024)
+ */
+class serviceTranslate extends abstractService
+{
+	#language           = 'en';
+	#available_language = [ 'ru', 'en' ];
+	#dictionary         = false; // может сделать сторадж отдельно и static ?
+	#vendor_instance;
+
+
+	/**
+	 *
+	 * @version			v.0.1 (25/06/2024)
+	 * @param {?object} init_options
+	 * @returns {serviceTranslate}
+	 */
+	constructor(init_options = false)
+	{
+		super(init_options);
+
+		if (init_options?.language)
+		{
+			if (in_array(init_options?.language, this.#available_language))
+			{
+				this.#language = init_options?.language;
+			}
+			else
+			{
+				echo({ init_options });
+				throw new Error('Unsupported language');
+			}
+		}
+
+		if (this.constructor._instance)
+		{
+			return this.constructor._instance;
+		}
+
+		this.init_options          = init_options;
+		this.constructor._instance = this;
+
+		this.#bootstrap();
+
+		return this.constructor._instance;
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (25/06/2024)
+	 * @param api_response
+	 */
+	#api_response_parser(api_response)
+	{
+
+		// заготовка
+		return api_response;
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (25/06/2024)
+	 */
+	async #bootstrap()
+	{
+		this.#dictionary = await Api.service.translate_get_dictionaries();
+
+		let normalize_response = this.#api_response_parser(this.#dictionary);
+
+
+		await i18next.init({
+			lng      : this.#language,
+			debug    : false,
+			resources: normalize_response
+		});
+
+		this.#vendor_instance = i18next;
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (25/06/2024)
+	 * @param group
+	 * @param key
+	 */
+	get(group, key)
+	{
+		return this.#vendor_instance.t(group + '.' + key);
+	}
+}
+/*
+/!**
+ *
+ * @version          v.1.0 (18/11/2024)
+ *!/
+class UserService extends abstractService
+{
+
+	static #current_user_id  = '-1';
+	static #user_name        = '';
+	static #current_team_id  = '';
+	static #user_teams       = [ -1 ];
+	static #roles            = [ 'user' ];
+	static #current_language = 'en';
+
+
+	/!**
+	 *
+	 *
+	 * @version          v.1.0 (18/11/2024)
+	 *
+	 * @param init_options
+	 * @returns {*}
+	 *!/
+	/!**
+	 *
+	 *
+	 * @version          v.1.0 (18/11/2024)
+	 *
+	 * @param init_options
+	 * @returns {*}
+	 *!/
+	constructor(init_options = false)
+	{
+		super();
+		if (this.constructor._instance)
+		{
+			return this.constructor._instance;
+		}
+
+		this.init_options = init_options;
+
+		this.constructor._instance = this;
+		super();
+	}
+
+	static get_current_user_id()
+	{
+		return UserService.#current_user_id;
+	}
+
+	static get_user_name()
+	{
+		return UserService.#user_name;
+	}
+
+	static get_current_team_id()
+	{
+		return UserService.#current_team_id;
+	}
+
+	static get_user_teams()
+	{
+		return UserService.#user_teams;
+	}
+
+	static get_roles()
+	{
+		return UserService.#roles;
+	}
+
+	static get_current_language()
+	{
+		return UserService.#current_language;
+	}
+}*/
+
+/**
+ *
+ * @param {object} object
+ * @returns {object}
+ */
+function clone_object(object)
+{
+	// @todo use deep clone
+	// @todo add validation
+	return JSON.parse(JSON.stringify(object));
+}
+
+/**
+ *
+ * @param {string|number|array|object} text
+ */
+function echo(text)
+{
+	console.log(text);
+}
+
+
+/**
+ *
+ * @param {string|number|array|object} data
+ */
+function echo_table(...data)
+{
+	if (is_array(data))
+	{
+		data.map((row) =>
+		{
+			console.table(row);
+		});
+	}
+	else
+	{
+		echo(data);
+	}
+}
+
+/**
+ *
+ *
+ * @param {*}		data
+ * @param {boolean} strict_mode
+ * @returns {boolean}
+ */
+function is_array(data, strict_mode = false)
+{
+	if (strict_mode)
+	{
+		if (data instanceof Array)
+		{
+			return true;
+		}
+		else
+		{
+			return false;
+		}
+	}
+	else
+	{
+		if (data instanceof Array && data?.length > 0)
+		{
+			return true;
+		}
+		else
+		{
+			return false;
+		}
+	}
+}
+
+
+/**
+ *
+ *
+ * @param {*}		value
+ * @returns {boolean}
+ */
+function is_object(value)
+{
+	return _.isObject(value);
+}
+
+
+/**
+ *
+ *
+ * @param {*}		value
+ * @returns {boolean}
+ */
+function is_string(value)
+{
+	let response = false;
+	if (typeof value === 'string')
+	{
+		response = true;
+	}
+
+	return response;
+}
+
+
+/**
+ * Проверяем на число, не строго (!)
+ * @param {*}		value
+ * @returns {boolean}
+ */
+function is_number(value)
+{
+	let response = false;
+
+	if (typeof ( value ) === 'number')
+	{
+		response = true;
+	}
+	else if (value === false)
+	{
+		response = false;
+	}
+	else if (typeof ( value ) === "string" && (!isNaN( value )))
+	{
+		response = true;
+	}
+
+	return response
+}
+
+
+/**
+ * Возвращает количество элементов массива или false, если передан не массив
+ *
+ * @param {array} array массив
+ * @returns {number|false} количество элементов массива
+ */
+function count(array)
+{
+	let response = false;
+	if (array instanceof Array)
+	{
+		response = array?.length;
+	}
+	else
+	{
+		response = false;
+	}
+
+	return response;
+}
+
+
+/**
+ *
+ * @param {string|number} 	value
+ * @param {array} 			array
+ * @param {boolean} 		strict
+ * @returns {boolean}
+ */
+function in_array(value, array, strict = false)
+{
+	if (!is_array(array))
+	{
+		return false;
+	}
+	let response = false;
+
+	if (strict)
+	{
+		response = array.find(element =>
+		{
+			return element === value;
+		});
+	}
+	else
+	{
+		response = array.find(element =>
+		{
+			return element == value;
+		});
+	}
+
+	return Boolean(response);
+}
+
+function cls()
+{
+	console.clear();
+}
+/**
+ * Базовый абстрактный класс для всех типов
+ *
+ * @version			v.0.1 (26/05/2024)
+ */
+class familyGeneralElement
+{
+	primary_key           = false;
+	create_scheme         = false;
+	structure_scheme      = false;
+	available_enum_values = 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 (26/05/2024)
+	 * @param id
+	 */
+	async find(id = false)
+	{
+		// или передаем ID, или используем вложенный
+		// возвращаем инстанс себя же
+		alert('Error #267-001 Not implemented method');
+	}
+
+	/**
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 */
+	async create()
+	{}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 */
+	async update()
+	{
+		alert('Error #272-001 Not implemented method');
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 */
+	async update_property(key, value, callback)
+	{
+		alert('Error #272-001 Not implemented method');
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 */
+	async update_properties()
+	{
+		alert('Error #272-001 Not implemented method');
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 * @param element
+	 * @param callback
+	 * @returns {Promise<boolean>}
+	 */
+	async delete(element, callback)
+	{
+		alert('Error #267-001 Not implemented method');
+		return false;
+	}
+}
+/**
+ * Заготовка - логи действий
+ *
+ * @version			v.0.1 (15/10/2024)
+ */
+class typeActionLog
+{
+
+}
+
+/**
+ *
+ * @version			v.0.1 (23/06/2024)
+ */
+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()
+	{
+
+	}
+
+
+}
+
+/**
+ * @version			v.0.2 (25/01/2025)
+ */
+class typeFunctionalGroup extends familyGeneralElement
+{
+	functional_group_id;
+	project_id;							// foreign key
+	team_id;							// foreign key
+	parent_id;							// для организации вложенности
+	functional_group_name;
+	functional_group_description;
+	//functional_group_status;			// enum (active + archive ??)
+	created_at;
+	updated_at;
+
+	primary_key = 'functional_group_id';
+
+	structure_scheme = {
+		functional_group_id         : 'integer | require',
+		functional_group_name       : 'string | max:90 | require',
+		functional_group_description: 'string | max:250 | optional',
+		project_id                  : 'integer | require',
+		team_id                     : 'integer | require',
+		parent_id                   : 'integer | optional',
+		functional_group_status     : 'integer | enum | require',
+		created_at       : 'timestamp | require',
+		updated_at       : 'timestamp | optional',
+	};
+
+	available_enum_values = {
+		functional_group_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()
+	{
+
+	}
+
+
+}
+/**
+ *
+ * @version			v.0.2 (15/06/2024)
+ */
+class typeMilestone extends familyGeneralElement
+{
+	milestone_id;				// primary AI
+	milestone_name;
+	milestone_description;
+	milestone_status;			// enum
+	milestone_start_date;
+	milestone_end_date;
+	team_id;					// foreign key
+	project_id;					// foreign key
+
+
+	primary_key = 'milestone_id';
+
+	structure_scheme = {
+		milestone_id         : 'integer | require',
+		milestone_name       : 'string | require',
+		milestone_description: 'string | optional',
+		milestone_status     : 'string | enum | require',
+		company_id           : 'integer | require',
+		milestone_start_date : 'date | require',
+		milestone_end_date   : 'date | optional',
+		project_id           : 'integer | require',
+	};
+
+	available_enum_values = {
+		milestone_status: [ 'ACTUAL', 'COMPLETED', 'PLANNED' ]
+	};
+
+	/**
+	 *
+	 * @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()
+	{
+
+	}
+
+
+}
+
+/**
+ *
+ * @version			v.0.2 (15/06/2024)
+ */
+class typeProject extends familyGeneralElement
+{
+	project_id;					// primary
+	project_name;
+	project_description;		// some comment
+	project_status; 			// enum
+	team_id; 					// foreign key + owner
+	reference_document_ids;		// IDS документов по функционалу (к примеру confluence)
+	// хосты/домены будут отдельно храниться, их может быть множество
+
+	primary_key = 'project_id';
+
+	structure_scheme = {
+		project_id            : 'integer | require',
+		project_name          : 'string | require',
+		project_description   : 'string | optional',
+		project_status        : 'string | enum | require',
+		company_id            : 'integer | require',
+		reference_document_ids: 'array | reference | optional',
+	};
+
+	available_enum_values = {
+		project_status: [ 'OPEN', 'CLOSED', 'PLANNED' ]
+	};
+
+
+	/**
+	 *
+	 * @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;
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (02/07/2024)
+	 * @returns {array<typeProject>}
+	 * @param {number} count
+	 */
+	get_random_demo_data(count)
+	{
+		// @todo validations
+		let response = [];
+
+		for (let i = 0; i < count; i++)
+		{
+			response.push(new MockDataTypeProject());
+		}
+
+
+		return response;
+	}
+
+
+	/******************************************************************************************/
+	/*********************************** general **********************************************/
+	/******************************************************************************************/
+
+	/**
+	 *
+	 * @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.0.1 (26/01/2025)
+	 */
+	async create(payload, callback)
+	{
+		if (typeof callback?.before === 'function')
+		{
+			callback?.before({ payload });
+		}
+
+		payload = this.normalize_payload(payload);
+
+
+		/**
+		 * {Api} ApiService
+		 */
+		ApiService.project.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.0.1 (07/07/2024)
+	 */
+	async update()
+	{
+
+	}
+
+
+	/**
+	 *
+	 * @version			v.0.1 (07/07/2024)
+	 */
+	async delete()
+	{
+
+	}
+
+
+	/******************************************************************************************/
+	/**************************** работа с участниками проекта ********************************/
+	/******************************************************************************************/
+
+	// member = user + role
+
+	member_add() {}
+
+	member_update() {}
+
+	member_delete() {}
+
+	member_get() {}
+
+
+}
+/**
+ * (идея) - у проекта должна быть тестовая документация
+ *
+ * @see https://vladislaveremeev.gitbook.io/qa_bible/testovaya-dokumentaciya-i-artefakty-test-deliverablestest-artifacts/vidy-testovoi-dokumentacii
+ *
+ * @version			v.0.2 (07/07/2024)
+ */
+class typeProjectDocument extends familyGeneralElement
+{
+	project_document_id;
+	project_id;
+	project_document_type;
+	// где и как храним файлы?
+	// nextcloud integration?
+
+
+
+	available_enum_values = {
+		project_document_type: [ 'QUALITY_POLICY', 'TEST_POLICY', 'PROJECT_DESCRIPTION', 'TEST_PLAN', 'DOCUMENT' ],
+	};
+
+
+	/**
+	 *
+	 * @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()
+	{
+
+	}
+}
+/**
+ * Тестовые аккаунты
+ *
+ * У каждого проекта свои коллекции
+ * (идея)
+ *
+ * @version			v.0.1 (30/06/2024)
+ */
+class typeProjectTestAccount extends familyGeneralElement
+{
+	test_account_id;
+	project_id;
+	site;
+	authentication_type;
+	login;
+	password; // как будем хранить?
+	comment;
+
+	primary_key = 'test_account_id';
+
+	structure_scheme = {
+		test_account_id    : 'integer | require',
+		project_id         : 'integer | require',
+		authentication_type: 'enum | require',
+		site               : 'string | require',
+		login              : 'string | require',
+		password           : 'string | optional',
+		comment            : 'string | optional',
+	};
+
+	available_enum_values = {
+		authentication_type: [ 'FORMS' ] // другие пока нет автоматизации не особо нужны
+	};
+
+	/**
+	 *
+	 * @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;
+	}
+}
+/**
+ * Тестовые данные
+ * Какая-то коллекция, созданная для тестирования и ввода
+ *
+ * У каждого проекта свои коллекции
+ *
+ * (идея)
+ * @version			v.0.1 (30/06/2024)
+ */
+class typeProjectTestData extends familyGeneralElement
+{
+	// как храним? json или какие-то структуры? [key->value] ?
+	test_data_id;
+	project_id;
+
+
+	primary_key = 'test_data_id';
+
+	/**
+	 *
+	 * @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;
+	}
+}
+/**
+ * Роли в проекте
+ * @version			v.0.1 (07/07/2024)
+ */
+class typeProjectUserRole extends familyGeneralElement
+{
+	// строго определенный список
+	// без возможности создания иных
+	// если роль не указана - то ADMINISTRATOR
+
+	role_slug;
+	role_description;
+	project_id;
+	user_id;
+
+	primary_key = 'role_slug';
+
+	structure_scheme = {
+		role_slug       : 'string | require',
+		role_description: 'string | optional',
+		project_id      : 'integer | require',
+		user_id         : 'integer | require',
+	};
+
+	available_enum_values = {
+		role_slug: [ 'ROOT', 'ADMINISTRATOR', 'LEAD', 'QA_ENGINEER' ]
+		// ?? Системные администраторы, Разработчики, Тестировщики
+	};
+
+
+	/**
+	 *
+	 * @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;
+	}
+}
+
+/**
+ * @version			v.2.0 (07/07/2024)
+ */
+class typeTask extends familyGeneralElement
+{
+	task_id;
+	team_id;					// foreign key
+	task_performer_id;			// foreign key	// @todo переименовать с общепринятой практикой
+	task_initiator_id;			// foreign key // @todo переименовать с общепринятой практикой
+	task_type;					// enum => сделать тест, выполнить тест, итд (!не дублирует предмет задания - тут тип + действие)
+	task_status;				// enum
+	project_id;					// foreign key (денормализация) (а надо ли)
+	task_subject_element_type;	// предмет задания
+	task_subject_id;			// ID предмета задания (изначально его может не быть)
+
+
+	primary_key = 'task_id';
+
+	structure_scheme = {
+		task_id                  : 'integer | require',
+		team_id                  : 'integer | require',
+		task_performer_id        : 'integer | require',
+		task_initiator_id        : 'integer | require',
+		task_type                : 'string | enum | require',
+		task_status              : 'string | enum | require',
+		project_id               : 'integer | require',
+		task_subject_element_type: 'string | enum | require',
+		task_subject_id          : 'integer | optional',
+	};
+
+	available_enum_values = {
+		task_status: [ 'OPEN', 'IN_PROGRESS', 'DONE', 'CANCELLED' ],
+		// тут будет много, все надо перечислить, чтобы просто по каждой описать свой код
+		// и не все комбинации action + element доступны и могут существовать
+		task_type  : [
+			'CREATE_PROJECT_DOCUMENT',
+			'CREATE_FUNCTIONAL',
+			'CREATE_TESTCASE',
+			'CREATE_TEST_RUN',
+			'RUN_TEST_RUN'
+		],
+		task_subject_element_type: [
+			'PROJECT',
+			'PROJECT_DOCUMENT',
+			'TEST_SUITE',
+			'TEST_CASE',
+			'TEST_RUN',
+			'TEST_RESULT',
+		],
+	};
+
+
+	/**
+	 *
+	 * @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;
+	}
+}
+
+/**
+ * @version			v.0.1 (23/06/2024)
+ */
+class typeTeam extends familyGeneralElement
+{
+	team_id;		//
+	team_status;	// enum
+	team_type;		// enum
+	team_country_code;	// (закон о перс данных и иные) как минимум статистика
+	team_name;
+	_team_price_id	// foreign key (тариф)
+	team_root_user_id;	// foreign key
+	created_at;
+	updated_at;
+	// тут где-то могут быть тарифы
+
+
+	primary_key = 'team_id';
+
+	structure_scheme = {
+		team_id          : 'integer | require',
+		team_status      : 'string | enum | require',
+		team_type        : 'string | enum | require',
+		team_country_code: 'string | country_code | require',
+		team_name        : 'string | require',
+		team_price_id    : 'integer | require',
+		team_root_user_id: 'integer | require',
+		created_at       : 'timestamp | require',
+		updated_at       : 'timestamp | optional',
+	};
+
+
+	available_enum_values = {
+		team_status: [ 'PENDING', 'APPROVED', 'BANNED', 'FROZEN', 'TRIAL' ],
+		team_type  : [ 'PERSONAL', 'ORGANIZATION', 'SCHOOL' ],
+	};
+
+
+	/**
+	 *
+	 * @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()
+	{}
+
+
+	/******************************************************************************************/
+	/*********************** работа с администраторами компании *******************************/
+
+	/******************************************************************************************/
+
+	adminstator_add() {}
+
+	adminstator_update() {}
+
+	adminstator_delete() {}
+
+	adminstators_get() {}
+
+
+	/******************************************************************************************/
+	/************************* работа с сотрудниками компании *********************************/
+
+	/******************************************************************************************/
+
+	user_add() {}
+
+	user_update() {}
+
+	user_delete() {}
+
+	users_get() {}
+}
+
+/**
+ * @version			v.0.2 (11/11/2024)
+ */
+class typeTeamMember extends familyGeneralElement
+{
+	team_member_id;
+	team_id;
+	user_id;
+	team_member_status;
+	member_role;
+	created_at;
+	updated_at;
+
+
+	primary_key = 'team_member_id';
+
+	structure_scheme = {
+		team_member_id    : 'integer | require',
+		team_id           : 'integer | require',
+		user_id           : 'integer | require',
+		team_member_status: 'string | enum | require',
+		member_role: 'string | enum | require',
+		created_at        : 'timestamp | require',
+		updated_at        : 'timestamp | optional',
+	};
+
+	available_enum_values = {
+		team_member_status: [ 'PENDING', 'ACCEPTED', 'BANNED', 'REJECTED' ],
+		member_role  : [ 'ROOT', 'ADMINISTRATOR', 'MEMBER' ]
+	};
+
+
+	/**
+	 *
+	 * @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;
+	}
+}
+/**
+ * Роль пользователя в команде
+ * Должно стать часть team management
+ *
+ * Один пользователь может иметь много ролей (разработчик, тестировщик, ...)
+ *
+ * @version			v.0.1 (07/07/2024)
+ */
+class typeTeamUserRole extends familyGeneralElement
+{
+	// @todo - все не актуально, поменять
+	role_slug;
+	role_description;
+	team_id;
+	user_id;
+
+	primary_key = 'role_slug';
+
+	structure_scheme = {
+		role_slug       : 'string | require',
+		role_description: 'string | optional',
+		team_id         : 'integer | require',
+		user_id         : 'integer | require',
+	};
+
+	/*available_enum_values = {
+	// эти роли вынесены
+		role_slug: [ 'ROOT', 'ADMINISTRATOR', 'MEMBER' ]
+	};
+*/
+
+	/**
+	 *
+	 * @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;
+	}
+}
+
+/**
+ *
+ * @version			v.0.2 (10/12/2024)
+ */
+class typeTestCase extends familyGeneralElement
+{
+	test_case_id;
+	test_suite_id;					// foreign key
+	project_id;						// foreign key
+	team_id;						// foreign key // secure - access
+	functional_id;					// foreign key
+	test_case_title;				// text 90
+	test_case_preconditions;		// text (взято у рельсов)
+	test_case_mission;				// text (взято у рельсов)
+	test_case_goals;				// text (взято у рельсов)
+	test_case_description;			// text 250
+	test_case_time_to_execute; 		// время выполнения (в секундах) (оценочное) (для планирования работ)
+	test_case_complexity; 			// enum (для планирования работ)
+	test_case_importance;			// enum (для планирования работ)
+	test_case_steps; 				// pseudo //  foreign key - relations
+	test_case_presteps;				// pseudo //  foreign key - relations
+	_attachments;					// typeAttachments - <relations>
+	preconditions;					// text
+	excepted_result;				// text // ?? <goals>
+	created_at;
+	updated_at;
+
+
+	primary_key = 'test_case_id';
+
+	// @todo - довнести
+	structure_scheme = {
+		test_case_id             : 'integer | require',
+		test_suite_id            : 'integer | require',
+		project_id               : 'integer | require',
+		team_id                  : 'integer | require',
+		functional_id            : 'integer | optional',
+		test_case_title           : 'string | require',
+		test_case_descriptions   : 'string | require',
+		test_case_time_to_execute: 'integer |  optional',
+		test_case_complexity     : 'string | enum | optional',
+		test_case_importance     : 'string | enum | optional',
+		created_at       : 'timestamp | require',
+		updated_at       : 'timestamp | optional',
+	};
+
+	available_enum_values = {
+		test_case_complexity: [ 'LOW', 'NORMAL', 'HIGH' ],
+		test_case_importance: [ 'LOW', 'NORMAL', 'HIGH' ],
+	};
+
+
+	/**
+	 *
+	 * @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()
+	{
+
+	}
+
+
+}
+
+/**
+ *
+ * @version			v.0.1 (26/05/2024)
+ */
+class typeTestCaseStep extends familyGeneralElement
+{
+	test_case_step_id;
+	test_case_step_type;
+	team_id;					// foreign key
+	test_case_id;				// relations
+	step_text;
+
+	primary_key = 'test_case_step_id';
+
+	available_enum_values = {
+		test_case_step_type: [ 'TEST_CASE_STEP', 'TEST_CASE_PRESTEP' ],
+	};
+}
+
+/**
+ * Нужен ли этот тип?
+ *
+ * @version			v.0.1 (26/05/2024)
+ */
+class typeTestPlan  extends familyGeneralElement
+{
+
+
+	/**
+	 *
+	 * @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;
+	}
+}
+/**
+ * Коллекция тестов для работы, она же parent для typeTestRunResult
+ *
+ * Содержит ссылки на коллекцию тест кейсов
+ *
+ * @version			v.0.2 (21/01/2025)
+ */
+class typeTestRun extends familyGeneralElement
+{
+	test_run_id;
+	test_run_name;
+	test_run_description;
+	milestone_id; /// ??
+	assigned_to;
+	test_case_ids; // массив тестов на запуск
+	test_run_status;
+	test_case_summary_statistic; // массив [key->value] по статусам вложенных тест-кейсов для визуализации
+	// typeTestRunResult.test_result_status : 'PASSED', 'FAILED', 'SKIPPED', 'BLOCKED', 'RETEST'
+
+
+	created_at;
+	updated_at;
+	completed_at;
+
+	// логи запуска, окончания - отдельно
+	primary_key = 'test_run_id';
+
+	available_enum_values = {
+		test_run_status: [ 'PENDING', 'IN_PROGRESS', 'COMPLETED', 'CLOSED' ],
+	};
+
+	/**
+	 *
+	 * @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;
+	}
+}
+/**
+ * 1 результат по каждому тест кейсу
+ *
+ * отчет смотрим по testRuns
+ *
+ * @version			v.0.4 (10/12/2024)
+ */
+class typeTestRunResult extends familyGeneralElement
+{
+	test_run_result_id;
+	test_case_id;
+	test_run_id;
+	test_result_status;
+	task_id; 						// надо ли?
+	project_id;
+	functional_id; 					// надо ли?
+	milestone_id;
+	elapsed_time; 	// фактическое время выполнения
+	reference_defects_ids; 			// list of IDs in user bug tracker / include sentry ids
+
+	created_at;
+	updated_at;
+	completed_at;
+
+
+	// тут нужен ещё контекст выполнения (банально список браузеров)
+
+	primary_key = 'test_run_result_id';
+
+	structure_scheme = {
+		test_result_id            : 'integer | require',
+		test_case_id              : 'integer | require',
+		test_run_id               : 'integer | require',
+		test_result_status        : 'string | enum | require',
+		task_id                   : 'integer | require',
+		project_id                : 'integer |  require',
+		functional_id             : 'integer | optional',
+		milestone_id              : 'integer | optional',
+		test_run_result_to_execute: 'time | optional',
+		reference_defects_ids     : 'array | reference | optional',
+	};
+
+	available_enum_values = {
+		test_result_status: [ 'PASSED', 'FAILED', 'SKIPPED', 'BLOCKED', 'RETEST' ]
+	};
+
+
+	/**
+	 *
+	 * @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;
+	}
+}
+/**
+ * Структурная коллекция тестов
+ *
+ * @version			v.0.1 (23/06/2024)
+ */
+class typeTestSuite extends familyGeneralElement
+{
+	test_suite_id;
+	project_id;
+	functional_id;
+	test_suite_name;
+	test_suite_description;
+	team_id;
+
+	primary_key = 'test_suite_id';
+
+	structure_scheme = {
+		test_suite_id         : 'integer | require',
+		project_id            : 'integer | require',
+		functional_id         : 'integer | optional',
+		test_suite_name       : 'string | protected | require',
+		test_suite_description: 'string |  require',
+		team_id               : 'integer | require',
+	};
+
+
+	/**
+	 *
+	 * @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()
+	{
+
+	}
+
+
+}
+
+/**
+ * @version			v.0.1 (23/06/2024)
+ */
+class typeUser extends familyGeneralElement
+{
+	user_id;
+	country;
+	user_name;
+	user_password; // не доступно на фронте
+	user_status;
+	user_email;
+	user_phone;
+
+	primary_key = 'user_id';
+
+	structure_scheme = {
+		user_id          : 'integer | require',
+		country          : 'string | enum | require',
+		user_name        : 'string | require',
+		user_password    : 'string | protected | require',
+		user_status      : 'string | enum|  require',
+		user_email       : 'string | email | require',
+		user_phone_number: 'string | phone_number | optional',
+	};
+
+	available_enum_values = {
+		user_status: [ 'PENDING', 'APPROVED', 'BANNED', 'FROZEN', 'BLOCKED' ]
+	};
+
+
+	/**
+	 *
+	 * @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;
+	}
+}
+/**
+ * базовый тип для всех служебных типов
+ * @version			v.0.1 (26/05/2024)
+ */
+class familyService
+{
+	//
+}
+/**
+ *
+ * @version			v.0.1 (26/01/2025)
+ */
+class typeFOR extends familyService
+{
+	filter;
+	object;
+	response;
+
+	/**
+	 *
+	 * @version			v.0.1 (26/01/2025)
+	 * @param data
+	 * @returns {typeFOR}
+	 */
+	constructor(data = false)
+	{
+		super();
+
+		if (data && typeof data === 'object')
+		{
+			_.mapObject(data, (value, key) =>
+			{
+				if (this.hasOwnProperty(key))
+				{
+					this [ key ] = value;
+				}
+			});
+		}
+
+		return this;
+	}
+}
+/**
+ * Описание стандартного колбека типового для методов
+ *
+ * @version			v.0.1 (26/05/2024)
+ */
+class typeFunctionCallback extends familyService
+{
+	before;
+	success;
+	error;
+	final;
+	destroy;
+
+
+	/**
+	 *
+	 * @version			v.0.1 (26/05/2024)
+	 * @param {object|false} data
+	 * @return {typeFunctionCallback}
+	 */
+	constructor(data = false)
+	{
+		super();
+
+		if (data && typeof data === 'object')
+		{
+			_.mapObject(data, (value, key) =>
+			{
+				if (this.hasOwnProperty(key))
+				{
+					this [ key ] = value;
+				}
+			});
+		}
+
+		return this;
+	}
+}
+/**
+ * Уведомления
+ * Как будто это абстрактный интерфейс
+ * А внутри уже разные настроенные пользователем методы
+ *
+ */
+class typeNotification extends familyService
+{
+
+	// пока не понятно
+
+	/**
+	 *
+	 * @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;
+	}
+}
+/**
+ *
+ * @version			v.0.1 (02/07/2024)
+ */
+class abstractMockData
+{
+	mock_data_type = 'correct';
+
+	constructor(mock_data_type = 'correct')
+	{
+		this.mock_data_type = mock_data_type;
+	}
+}
+
+/**
+ * @version			v.0.1 (02/07/2024)
+ */
+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;
+	}
+}