complexqa_frontend_core 2.3.1 → 2.4.1

package/src/types/family_elements/checklist/typeChecklistBase.js

@@ -0,0 +1,63 @@
+import { familyTestDocumentation } from "../../core/1_familyTestDocumentation.js";
+
+
+/**
+ * Базовый класс заголовка чек-листа и результата чек-листа.
+ * Одна таблица, тип записи - checklist_type. Только общие поля.
+ *
+ * Данные из конструктора раскладывают рабочие классы (typeChecklist, typeChecklistResult):
+ * поля наследника инициализируются после super(), поэтому раскладка здесь была бы перезаписана.
+ *
+ * @version			v.0.1 (30/09/2026)
+ */
+export class typeChecklistBase extends familyTestDocumentation
+{
+	checklist_id;
+	checklist_type;
+	team_id;
+	project_id;
+	checklist_title;
+	checklist_description;
+	checklist_status;
+	assigned_to;
+	created_at;
+	updated_at;
+
+	primary_key = 'checklist_id';
+
+	structure_scheme = {
+		checklist_id         : 'integer | require',
+		checklist_type       : 'string | enum | require',
+		team_id              : 'integer | require',
+		project_id           : 'integer | require',
+		checklist_title      : 'string | optional',
+		checklist_description: 'string | StringHtml | optional',
+		checklist_status     : 'string | enum | require',
+		assigned_to          : 'integer | typeUser | optional',
+		created_at           : 'timestamp | require',
+		updated_at           : 'timestamp | optional',
+	};
+
+	/** @type {Record<string, string[]>} */
+	available_enum_values = {
+		checklist_type: [ 'CHECKLIST', 'CHECKLIST_RESULT' ],
+	};
+
+
+	/**
+	 * @param {object|false|undefined} data
+	 */
+	constructor(data = false)
+	{
+		super();
+	}
+
+
+	/**
+	 * @returns {string}
+	 */
+	get_element_name()
+	{
+		return this.checklist_title;
+	}
+}

package/src/types/family_elements/checklist/typeChecklistFolder.js

@@ -0,0 +1,97 @@
+import { is_object } from "../../../utils/utils.js";
+import { familyTestDocumentation } from "../../core/1_familyTestDocumentation.js";
+import { register_type_class } from "../../core/type_class_resolver.js";
+import { typeChecklistFolder_i18n } from "../../element_translate/typeChecklistFolder.i18n.js";
+import _ from 'underscore';
+
+
+/**
+ * Папка чек-листов. Дерево через parent_checklist_folder_id. Результаты в папках не лежат.
+ *
+ * @version			v.0.1 (30/09/2026)
+ */
+export class typeChecklistFolder extends familyTestDocumentation
+{
+	checklist_folder_id;
+	project_id;
+	team_id;
+	parent_checklist_folder_id;
+	checklist_folder_name;
+	created_at;
+	updated_at;
+
+	primary_key = 'checklist_folder_id';
+	api_key     = 'checklist_folder';
+
+	structure_scheme = {
+		checklist_folder_id       : 'integer | require',
+		project_id                : 'integer | require',
+		team_id                   : 'integer | require',
+		parent_checklist_folder_id: 'integer | optional',
+		checklist_folder_name     : 'string | optional',
+		created_at                : 'timestamp | require',
+		updated_at                : 'timestamp | optional',
+	};
+
+	create_scheme = [
+		'project_id',
+		'parent_checklist_folder_id',
+		'checklist_folder_name',
+	];
+
+	attribute_name_translate_matrix = typeChecklistFolder_i18n.attribute_name_translate_matrix;
+
+
+	/**
+	 * @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;
+	}
+
+
+	/**
+	 * @returns {string}
+	 */
+	get_element_name()
+	{
+		return this.checklist_folder_name || '';
+	}
+
+
+	/**
+	 * FK checklist_folder_id на листинге чек-листа: ячейка берёт checklist_folder_name.
+	 *
+	 * @returns {object}
+	 */
+	get_reference_meta()
+	{
+		return {
+			type_token   : 'typeChecklistFolder',
+			api_namespace: '',
+			api_key      : this.api_key,
+			primary_key  : this.primary_key,
+			label_key    : 'checklist_folder_name',
+			search       : {
+				attribute: 'checklist_folder_name',
+				operator : 'LIKE',
+			},
+		};
+	}
+}
+
+register_type_class('typeChecklistFolder', typeChecklistFolder);

package/src/types/family_elements/checklist/typeChecklistItem.js

@@ -0,0 +1,47 @@
+import { is_object } from "../../../utils/utils.js";
+import { typeChecklistItemBase } from "./typeChecklistItemBase.js";
+import { typeChecklistItem_i18n } from "../../element_translate/typeChecklistItem.i18n.js";
+import _ from 'underscore';
+
+
+/**
+ * Пункт чек-листа. Статуса нет.
+ *
+ * @version			v.0.1 (30/09/2026)
+ */
+export class typeChecklistItem extends typeChecklistItemBase
+{
+	checklist_type = 'CHECKLIST';
+
+	api_key = 'checklist_item';
+
+	attribute_name_translate_matrix = typeChecklistItem_i18n.attribute_name_translate_matrix;
+
+	create_scheme = [
+		'checklist_id',
+		'item_text',
+		'sort_order',
+	];
+
+
+	/**
+	 * @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/src/types/family_elements/checklist/typeChecklistItemBase.js

@@ -0,0 +1,58 @@
+import { familyTestDocumentation } from "../../core/1_familyTestDocumentation.js";
+
+
+/**
+ * Базовый класс строки: пункт чек-листа и отметка результата.
+ * Одна таблица, тип записи - checklist_type (равен типу родителя). Только общие поля.
+ *
+ * Данные из конструктора раскладывают рабочие классы (typeChecklistItem, typeChecklistResultItem).
+ *
+ * @version			v.0.1 (30/09/2026)
+ */
+export class typeChecklistItemBase extends familyTestDocumentation
+{
+	checklist_item_id;
+	checklist_id;
+	checklist_type;
+	team_id;
+	sort_order;
+	item_text;
+	created_at;
+	updated_at;
+
+	primary_key = 'checklist_item_id';
+
+	structure_scheme = {
+		checklist_item_id: 'integer | require',
+		checklist_id     : 'integer | require',
+		checklist_type   : 'string | enum | require',
+		team_id          : 'integer | require',
+		sort_order       : 'integer | optional',
+		item_text        : 'string | optional',
+		created_at       : 'timestamp | require',
+		updated_at       : 'timestamp | optional',
+	};
+
+	/** @type {Record<string, string[]>} */
+	available_enum_values = {
+		checklist_type: [ 'CHECKLIST', 'CHECKLIST_RESULT' ],
+	};
+
+
+	/**
+	 * @param {object|false|undefined} data
+	 */
+	constructor(data = false)
+	{
+		super();
+	}
+
+
+	/**
+	 * @returns {string}
+	 */
+	get_element_name()
+	{
+		return this.item_text;
+	}
+}

package/src/types/family_elements/checklist/typeChecklistResult.js

@@ -0,0 +1,80 @@
+import { is_object } from "../../../utils/utils.js";
+import { typeChecklistBase } from "./typeChecklistBase.js";
+import { typeChecklistResult_i18n } from "../../element_translate/typeChecklistResult.i18n.js";
+import _ from 'underscore';
+
+
+/**
+ * Результат чек-листа: копия чек-листа на момент прохождения.
+ * checklist_title и checklist_description - копия, не меняются.
+ * checklist_status вычисляется из отметок на бэкенде.
+ * Создается из чек-листа в статусе READY с хотя бы одним пунктом.
+ *
+ * @version			v.0.1 (30/09/2026)
+ */
+export class typeChecklistResult extends typeChecklistBase
+{
+	checklist_type = 'CHECKLIST_RESULT';
+	initial_checklist_id;
+	execution_context_id;
+	checklist_comment;
+	completed_at;
+	checklist_items;				// pseudo // relations - typeChecklistResultItem
+
+	api_key = 'checklist_result';
+
+	structure_scheme = {
+		...this.structure_scheme,
+		initial_checklist_id: 'integer | optional',
+		execution_context_id: 'integer | require',
+		checklist_comment   : 'string | StringHtml | optional',
+		completed_at        : 'timestamp | optional',
+	};
+
+	create_scheme = [
+		'initial_checklist_id',
+		'execution_context_id',
+		'assigned_to',
+	];
+
+	/** @type {Record<string, string[]>} */
+	available_enum_values = {
+		...this.available_enum_values,
+		checklist_status: [ 'PENDING', 'IN_PROGRESS', 'PASSED', 'FAILED', 'BLOCKED', 'SKIPPED' ],
+	};
+
+	/** @type {Record<string, string>} */
+	status_color = {
+		PENDING    : '#C4B040',
+		IN_PROGRESS: '#546E7A',
+		PASSED     : '#009688',
+		FAILED     : '#E66565',
+		BLOCKED    : '#FD9A4F',
+		SKIPPED    : '#90A4AE',
+	};
+
+	attribute_name_translate_matrix = typeChecklistResult_i18n.attribute_name_translate_matrix;
+	enum_value_translate_matrix = typeChecklistResult_i18n.enum_value_translate_matrix;
+
+
+	/**
+	 * @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/src/types/family_elements/checklist/typeChecklistResultItem.js

@@ -0,0 +1,69 @@
+import { is_object } from "../../../utils/utils.js";
+import { typeChecklistItemBase } from "./typeChecklistItemBase.js";
+import { typeChecklistResultItem_i18n } from "../../element_translate/typeChecklistResultItem.i18n.js";
+import _ from 'underscore';
+
+
+/**
+ * Отметка результата: копия пункта + статус + комментарий.
+ * item_text и sort_order - копия, не меняются. Меняются только item_status и item_comment.
+ * Создается бэкендом при создании результата.
+ *
+ * @version			v.0.1 (30/09/2026)
+ */
+export class typeChecklistResultItem extends typeChecklistItemBase
+{
+	checklist_type = 'CHECKLIST_RESULT';
+	item_status;
+	item_comment;
+
+	api_key = 'checklist_result_item';
+
+	structure_scheme = {
+		...this.structure_scheme,
+		item_status : 'string | enum | require',
+		item_comment: 'string | StringHtml | optional',
+	};
+
+	create_scheme = [];
+
+	/** @type {Record<string, string[]>} */
+	available_enum_values = {
+		...this.available_enum_values,
+		item_status: [ 'PENDING', 'PASSED', 'FAILED', 'BLOCKED', 'SKIPPED' ],
+	};
+
+	/** @type {Record<string, string>} */
+	status_color = {
+		PENDING: '#C4B040',
+		PASSED : '#009688',
+		FAILED : '#E66565',
+		BLOCKED: '#FD9A4F',
+		SKIPPED: '#90A4AE',
+	};
+
+	attribute_name_translate_matrix = typeChecklistResultItem_i18n.attribute_name_translate_matrix;
+	enum_value_translate_matrix = typeChecklistResultItem_i18n.enum_value_translate_matrix;
+
+
+	/**
+	 * @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/src/types/family_elements/typeCustomProperty.js

@@ -64,7 +64,7 @@ export class typeCustomProperty extends familyTestDocumentation
 		'sort_order',
 	];
 
-	/** @type {Record<string, string[]>} */
+	/** @type {Record<string, string[]>} */
 	available_enum_values = {
 		element_type: typeCustomProperty.get_element_type_values(),
 		value_type  : typeCustomProperty.get_value_type_values(),
@@ -90,6 +90,8 @@ export class typeCustomProperty extends familyTestDocumentation
 			'test_account',
 			'execution_context',
 			'text_document',
+			'checklist_id',
+			'checklist_result_id',
 		];
 	}
 

package/src/types/family_elements/typeProject.js

@@ -179,6 +179,17 @@ export class typeProject extends familyGeneralElement
 	}
 
 
+	/**
+	 * @param {number|false} [project_id]
+	 * @param {object} [callback]
+	 * @returns {Promise<any>}
+	 */
+	async get_checklist_structure(project_id = false, callback = {})
+	{
+		return this._get_project_structure('get_checklist_structure', project_id, callback);
+	}
+
+
 	/**
 	 *
 	 * @version			v.0.1 (05/06/2025)

package/src/types/family_events/familyEvent.js

@@ -70,6 +70,11 @@ export class familyEvent extends familyGeneralElement
 			'execution_context',
 			'browser_tools_util_execution',
 			'browser_tools_screenshot_multi',
+			'checklist',
+			'checklist_result',
+			'checklist_item',
+			'checklist_result_item',
+			'checklist_folder',
 		];
 	}
 }

package/src/types/family_relation/typeBugRelation.js

@@ -37,6 +37,11 @@ export class typeBugRelation extends familyRelation
 			primary_key: 'execution_context_id',
 			api_key    : 'execution_context'
 		},
+		checklist_id: {
+			type_token : 'typeChecklistResult',
+			primary_key: 'checklist_id',
+			api_key    : 'checklist_result'
+		},
 	};
 
 	structure_scheme = {

package/src/types/family_relation/typeTagRelation.js

@@ -84,6 +84,16 @@ export class typeTagRelation extends familyRelation
 			primary_key: 'object_repository_folder_id',
 			api_key    : 'object_repository_folder',
 		},
+		checklist_id: {
+			type_token : 'typeChecklist',
+			primary_key: 'checklist_id',
+			api_key    : 'checklist',
+		},
+		checklist_result_id: {
+			type_token : 'typeChecklistResult',
+			primary_key: 'checklist_id',
+			api_key    : 'checklist_result',
+		},
 	};
 
 	structure_scheme = {

package/types/api/project_api.d.ts

@@ -49,5 +49,16 @@ export class ProjectApi extends ApiAbstractElementClass {
         response: any;
         payload: any;
     }>;
+    /**
+     *
+     * All checklists + folders
+     *
+     * @version        v.1.0 (01/10/2026)
+     * @param payload
+     */
+    get_checklist_structure(payload: any): Promise<{
+        response: any;
+        payload: any;
+    }>;
 }
 import { ApiAbstractElementClass } from "./api_abstract_element_class.js";

package/types/types/family_elements/typeProject.d.ts

@@ -187,6 +187,12 @@ export class typeProject extends familyGeneralElement {
      * @returns {Promise<any>}
      */
     get_text_document_structure(project_id?: number | false, callback?: object): Promise<any>;
+    /**
+     * @param {number|false} [project_id]
+     * @param {object} [callback]
+     * @returns {Promise<any>}
+     */
+    get_checklist_structure(project_id?: number | false, callback?: object): Promise<any>;
     /**
      *
      * @version			v.0.1 (05/06/2025)