complexqa_frontend_core 1.0.9 → 1.0.10

package/publish/types/family_elements/typeTeam.js

@@ -0,0 +1,105 @@
+import { familyGeneralElement } from "./0_familyGeneralElement";
+import { is_object } from "../../utils/utils";
+
+
+/**
+ * @version			v.0.1 (23/06/2024)
+ */
+export 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() {}
+}

package/publish/types/family_elements/typeTeamMember.js

@@ -0,0 +1,58 @@
+import { familyGeneralElement } from "./0_familyGeneralElement";
+import { is_object } from "../../utils/utils";
+
+
+/**
+ * @version			v.0.2 (11/11/2024)
+ */
+export 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;
+	}
+}

package/publish/types/family_elements/typeTeamUserRole.js

@@ -0,0 +1,56 @@
+import { familyGeneralElement } from "./0_familyGeneralElement";
+import { is_object } from "../../utils/utils";
+
+/**
+ * Роль пользователя в команде
+ * Должно стать часть team management
+ *
+ * Один пользователь может иметь много ролей (разработчик, тестировщик, ...)
+ *
+ * @version			v.0.1 (07/07/2024)
+ */
+export 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;
+	}
+}

package/publish/types/family_elements/typeTestCase.js

@@ -0,0 +1,98 @@
+import { familyGeneralElement } from "./0_familyGeneralElement";
+import { echo, is_object } from "../../utils/utils";
+
+
+/**
+ *
+ * @version			v.0.2 (10/12/2024)
+ */
+export 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';
+	api_key     = 'test_case';
+
+	// @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 (05/06/2025)
+	 *
+	 * @returns {string}
+	 */
+	get_element_name()
+	{
+		return this.test_case_title;
+	}
+
+
+}

package/publish/types/family_elements/typeTestCaseStep.js

@@ -0,0 +1,87 @@
+import { familyGeneralElement } from "./0_familyGeneralElement";
+import { is_object } from "../../utils/utils";
+
+
+/**
+ *
+ * @version			v.1.1 (26/05/2024)
+ */
+export class typeTestCaseStep extends familyGeneralElement
+{
+	test_case_step_id;
+	test_case_step_type;
+	team_id;					// foreign key
+	test_case_id;				// relations
+	sort_order;
+	step_text;
+	step_element;
+	step_element_action;
+	step_excepted_result;
+
+	primary_key = 'test_case_step_id';
+	api_key     = 'test_case_step';
+
+	structure_scheme = {
+		test_case_step_id   : 'integer | require',
+		test_case_step_type : 'string | enum | optional',
+		team_id             : 'integer | require',
+		test_case_id        : 'integer | require',
+		sort_order          : 'integer | optional',
+		step_text           : 'string | optional',
+		step_element        : 'string | optional',
+		step_element_action : 'string | optional',
+		step_excepted_result: 'string | optional',
+	};
+
+
+	available_enum_values = {
+		test_case_step_type: [ 'TEST_CASE_STEP', 'TEST_CASE_PRESTEP' ],
+	};
+
+
+	/******************************************************************************************/
+	/******************************************************************************************/
+	/******************************************************************************************/
+
+
+	/**
+	 *
+	 * @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 (05/06/2025)
+	 *
+	 * @returns {string}
+	 */
+	get_element_name()
+	{
+		return this.test_suite_name;
+	}
+}

package/publish/types/family_elements/typeTestPlan.js

@@ -0,0 +1,35 @@
+import { familyGeneralElement } from "./0_familyGeneralElement";
+import { is_object } from "../../utils/utils";
+
+
+/**
+ * Нужен ли этот тип?
+ *
+ * @version			v.0.1 (26/05/2024)
+ */
+export 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;
+	}
+}

package/publish/types/family_elements/typeTestRun.js

@@ -0,0 +1,56 @@
+import { familyGeneralElement } from "./0_familyGeneralElement";
+import { is_object } from "../../utils/utils";
+
+/**
+ * Коллекция тестов для работы, она же parent для typeTestRunResult
+ *
+ * Содержит ссылки на коллекцию тест кейсов
+ *
+ * @version			v.0.2 (21/01/2025)
+ */
+export 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;
+	}
+}

package/publish/types/family_elements/typeTestRunResult.js

@@ -0,0 +1,72 @@
+import { familyGeneralElement } from "./0_familyGeneralElement";
+import { is_object } from "../../utils/utils";
+
+/**
+ * 1 результат по каждому тест кейсу
+ *
+ * отчет смотрим по testRuns
+ *
+ * @version			v.0.4 (10/12/2024)
+ */
+export 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;
+	}
+}

package/publish/types/family_elements/typeTestSuite.js

@@ -0,0 +1,75 @@
+import { familyGeneralElement } from "./0_familyGeneralElement";
+import { echo, is_object } from "../../utils/utils";
+
+/**
+ * Структурная коллекция тестов
+ *
+ * @version			v.1.1 (23/06/2024)
+ */
+export class typeTestSuite extends familyGeneralElement
+{
+	test_suite_id;
+	project_id;
+	//functional_id; // пока убрал, думаю, что можно без этого всё сделать
+	test_suite_name;
+	test_suite_description;
+	team_id;
+	created_at;
+	updated_at;
+
+	primary_key = 'test_suite_id';
+	api_key     = 'test_suite';
+
+	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',
+		created_at            : 'timestamp | require',
+		updated_at            : 'timestamp | optional',
+	};
+
+
+	/**
+	 *
+	 * @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 (05/06/2025)
+	 *
+	 * @returns {string}
+	 */
+	get_element_name()
+	{
+		return this.test_suite_name;
+	}
+
+}

package/publish/types/family_elements/typeUser.js

@@ -0,0 +1,56 @@
+import { familyGeneralElement } from "./0_familyGeneralElement";
+import { is_object } from "../../utils/utils";
+
+
+/**
+ * @version			v.0.1 (23/06/2024)
+ */
+export 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;
+	}
+}