complexqa_frontend_core 1.0.9 → 1.0.10

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "complexqa_frontend_core",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "description": "core of web ",
   "type": "module",
   "exports": {
-    ".": "./publish_module/index.js"
+    ".": "./publish/index.js"
   },
   "files": [
-    "publish_module/"
+    "publish/"
   ],
 
   "scripts": {

package/publish/api/api_abstract_element_class.js

@@ -0,0 +1,426 @@
+import { clone_object, echo, is_array } from "../utils/utils";
+import axios from "axios";
+import * as qs from "query-string/base";
+import { ApiException } from "../exceptions/ApiException";
+
+/**
+ * Общие методы для всех типизированных элементов
+ *
+ * @version			v.2.0 (24/11/2024)
+ */
+export 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');
+		}
+
+		if (this.stage === 'development')
+		{
+			return {
+				response: payload,
+				payload : payload
+			};
+		}
+
+		let url = `/${ this.api_prefix }/${ this.module_prefix }/update_property`;
+
+		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 delete(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 }/delete`;
+
+		payload      = this.#handle_request_payload(payload);
+		let response = this.#api_request(url, payload);
+		response     = this.#handle_response(response);
+
+		return {
+			response: response,
+			payload : payload
+		};
+	}
+
+
+	/******************************************************************************************/
+	/******************************************************************************************/
+
+	/******************************************************************************************/
+
+	#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;
+	}
+}

package/publish/api/functional_api.js

@@ -0,0 +1,18 @@
+import { ApiAbstractElementClass } from "./api_abstract_element_class";
+import { typeFunctional } from "../types/family_elements/typeFunctional";
+
+
+/**
+ *
+ * @version			v.0.1 (24/11/2024)
+ */
+export class FunctionalApi extends ApiAbstractElementClass
+{
+	module_prefix = 'functional';
+
+	constructor(options)
+	{
+		super(options);
+		this.set_element_class_instance(typeFunctional);
+	}
+}

package/publish/api/index.js

@@ -0,0 +1,114 @@
+import { TestPlanApi } from "./test_plan_api";
+import { ProjectApi } from "./project_api";
+import { ServiceApi } from "./service_api";
+import { TestCaseApi } from "./test_case_api";
+import { TestSuiteApi } from "./test_suite_api";
+
+/**
+ * Обертка над axios
+ * @version			v.0.3 (26/01/2025)
+ */
+export 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);
+		this.test_case = new TestCaseApi(payload);
+		this.test_suite = new TestSuiteApi(payload);
+	}
+}

package/publish/api/project_api.js

@@ -0,0 +1,17 @@
+import { ApiAbstractElementClass } from "./api_abstract_element_class";
+import { typeProject } from "../types/family_elements/typeProject";
+
+/**
+ *
+ * @version			v.0.1 (15/06/2024)
+ */
+export class ProjectApi extends ApiAbstractElementClass
+{
+	module_prefix = 'project';
+
+	constructor(options)
+	{
+		super(options);
+		this.set_element_class_instance(typeProject);
+	}
+}

package/publish/api/service_api.js

@@ -0,0 +1,20 @@
+
+// тут нужен свой класс, не для типов
+export class ServiceApi
+{
+	module_prefix = '--';
+
+	constructor(options)
+	{
+	}
+
+
+	/**
+	 *
+	 * @returns {Promise<*[]>}
+	 */
+	async translate_get_dictionaries()
+	{
+		return [];
+	}
+}

package/publish/api/team_member_api.js

@@ -0,0 +1,18 @@
+import { ApiAbstractElementClass } from "./api_abstract_element_class";
+import { typeTeamMember } from "../types/family_elements/typeTeamMember";
+
+
+/**
+ *
+ * @version			v.0.1 (24/11/2024)
+ */
+export class TeamMemberApi extends ApiAbstractElementClass
+{
+	module_prefix = 'team_member';
+
+	constructor(options)
+	{
+		super(options);
+		this.set_element_class_instance(typeTeamMember);
+	}
+}

package/publish/api/test_case_api.js

@@ -0,0 +1,18 @@
+import { ApiAbstractElementClass } from "./api_abstract_element_class";
+import { typeTestCase } from "../types/family_elements/typeTestCase";
+
+
+/**
+ *
+ * @version			v.0.1 (24/11/2024)
+ */
+export class TestCaseApi extends ApiAbstractElementClass
+{
+	module_prefix = 'test_case';
+
+	constructor(options)
+	{
+		super(options);
+		this.set_element_class_instance(typeTestCase);
+	}
+}

package/publish/api/test_case_step_api.js

@@ -0,0 +1,18 @@
+import { typeTestCaseStep } from "../types/family_elements/typeTestCaseStep";
+import { ApiAbstractElementClass } from "./api_abstract_element_class";
+
+
+/**
+ *
+ * @version			v.0.1 (24/11/2024)
+ */
+export class TestCaseStepApi extends ApiAbstractElementClass
+{
+	module_prefix = 'test_case_step';
+
+	constructor(options)
+	{
+		super(options);
+		this.set_element_class_instance(typeTestCaseStep);
+	}
+}

package/publish/api/test_plan_api.js

@@ -0,0 +1,18 @@
+import { ApiAbstractElementClass } from "./api_abstract_element_class";
+import { typeTestPlan } from "../types/family_elements/typeTestPlan";
+
+
+/**
+ *
+ * @version			v.0.1 (26/05/2024)
+ */
+export class TestPlanApi extends ApiAbstractElementClass
+{
+	module_prefix = 'test_plan';
+
+	constructor(options)
+	{
+		super(options);
+		this.set_element_class_instance(typeTestPlan);
+	}
+}

package/publish/api/test_run_api.js

@@ -0,0 +1,13 @@
+import { ApiAbstractElementClass } from "./api_abstract_element_class";
+import { typeTestRun } from "../types/family_elements/typeTestRun";
+
+export class TestRunApi extends ApiAbstractElementClass
+{
+	module_prefix = 'test_run';
+
+	constructor(options)
+	{
+		super(options);
+		this.set_element_class_instance(typeTestRun);
+	}
+}