complexqa_frontend_core 1.31.5 → 2.0.0

package/README.md

@@ -0,0 +1,83 @@
+# complexqa_frontend_core 2.x
+
+Операционный SDK ComplexQA: доменные модели (`type*`), REST-фасад `Api`, поиск (`typeFOR` / `typeFilter`), сессия (`UserService`, `TeamService`), файлы (`FileAppService`).
+
+Слой таблиц, меню и chrome i18n живёт в хосте `web_app`, не в этом пакете.
+
+Node.js: `>=22.22.2`.
+
+## Установка
+
+```bash
+npm install complexqa_frontend_core
+```
+
+## Инициализация `Api` и инъекция в типы
+
+`new Api(...)` сам вызывает `bootstrap_type_api({ api_service })`. После этого методы экземпляра `type*` (`create()`, `search` через клиент, `delete()`) ходят в фасад без глобала `window.ApiService`.
+
+```js
+import { Api, typeBug, typeFOR, typeFilter, FileAppService } from 'complexqa_frontend_core';
+
+const api = new Api({
+	host_api: 'team-slug.webapp.complexqa.com',
+	stage: 'production',
+	frontend_host: 'frontend.complexqa.com',
+	general_domain: 'webapp.complexqa.com',
+});
+
+FileAppService.bootstrap({
+	file_app_url: 'https://file-app.complexqa.com',
+	api_service: api,
+});
+```
+
+Для тестов или скрипта без конструктора `Api` тот же канал явно:
+
+```js
+import { bootstrap_type_api, typeBug } from 'complexqa_frontend_core';
+
+bootstrap_type_api({
+	api_service: {
+		bug: { create: async (payload) => ({ response: payload, payload }) },
+	},
+});
+
+await new typeBug().create({ bug_title: 'From mock' });
+```
+
+`delete()` не вызывает `window.confirm`. Подтверждение - опциональный `callback.confirm`.
+
+## Модель и поиск
+
+```js
+import { typeBug, typeFOR, typeFilter } from 'complexqa_frontend_core';
+
+const bug = new typeBug({
+	bug_id: 1,
+	bug_title: 'Login',
+	project_id: 10,
+	team_id: 2,
+});
+
+bug.get_pure_data();
+bug.get_attribute_name_translate('bug_title', 'ru');
+
+const query = new typeFOR({
+	filters: [
+		new typeFilter({
+			object: { attribute: 'bug_status' },
+			operator: 'eq',
+			value: 'OPEN',
+		}),
+	],
+});
+```
+
+Пример в репозитории: `examples/search-create.mjs`.
+
+## Публичные экспорты 2.x
+
+Список имён: `tests/fixtures/public-exports.json`. Нет `TableConfiguration`, `TableBaseConfig`, `App`, `DeveloperService`, конфига редактора.
+
+Остаётся: `Api`, `UserService`, `TeamService`, `FileAppService`, `type*` сущностей, `typeFOR` / `typeFilter`, каталог autotest step, лимиты text document, `bootstrap_type_api`.

package/package.json

@@ -1,18 +1,35 @@
 {
   "name": "complexqa_frontend_core",
-  "version": "1.31.5",
+  "version": "2.0.0",
   "description": "core of web ",
   "type": "module",
   "exports": {
-    ".": "./publish/index.js"
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./src/index.js",
+      "default": "./src/index.js"
+    },
+    "./developer": {
+      "types": "./types/services/DeveloperService.d.ts",
+      "import": "./src/services/DeveloperService.js",
+      "default": "./src/services/DeveloperService.js"
+    }
   },
   "files": [
-    "./publish"
+    "src",
+    "types",
+    "!src/dev.entry.js"
   ],
+  "types": "./types/index.d.ts",
+  "engines": {
+    "node": ">=22.22.2"
+  },
   "scripts": {
     "test": "jest --config ../jest.config.cjs",
+    "build": "node --input-type=module -e \"import('./src/index.js').then(() => console.log('build ok'))\"",
     "build:dev": "rollup -c rollup.dev.config.js",
-    "build_package": "rollup -c rollup.config.js"
+    "pack-smoke": "node ../scripts/pack-smoke.mjs",
+    "types": "tsc -p tsconfig.types.json"
   },
   "repository": {
     "type": "git",
@@ -25,37 +42,24 @@
   },
   "homepage": "https://gitlab.com/test_software/frontend_core#readme",
   "dependencies": {
-    "@babel/plugin-proposal-class-properties": "^7.18.6",
-    "@babel/plugin-proposal-optional-chaining": "^7.21.0",
-    "@babel/plugin-transform-modules-commonjs": "^7.24.7",
-    "@babel/plugin-transform-runtime": "^7.27.4",
     "axios": "^1.13.0",
-    "gulp": "^5.0.0",
-    "gulp-babel": "^8.0.0",
-    "gulp-concat": "^2.6.1",
-    "gulp-if": "^3.0.0",
-    "gulp-jest": "^4.0.4",
-    "gulp-requirejs": "^1.4.0",
-    "gulp-rollup": "^2.17.0",
-    "gulp-strip-import-export": "^1.0.0",
-    "gulp-uncomment": "^0.3.0",
-    "i18next": "^23.16.8",
     "query-string": "^9.3.1",
-    "uglify-js": "^3.19.3",
     "underscore": "^1.13.6"
   },
   "devDependencies": {
-    "@rollup/plugin-inject": "^5.0.5",
-    "@rollup/plugin-node-resolve": "^16.0.3",
     "@babel/core": "^7.29.0",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/plugin-proposal-optional-chaining": "^7.21.0",
+    "@babel/plugin-transform-modules-commonjs": "^7.24.7",
+    "@babel/plugin-transform-runtime": "^7.27.4",
     "@babel/preset-env": "^7.29.5",
-    "babel": "^6.23.0",
+    "@rollup/plugin-inject": "^5.0.5",
+    "@rollup/plugin-node-resolve": "^16.0.3",
     "babel-jest": "^30.4.1",
-    "babel-plugin-module-resolver-standalone": "^0.0.2",
-    "gulp-uglify": "^3.0.2",
+    "gulp": "^5.0.0",
+    "gulp-if": "^3.0.0",
     "jest": "^30.4.2",
-    "requirejs-babel": "^0.0.9",
     "rollup": "^4.55.1",
-    "rollup-plugin-dts": "^6.2.3"
+    "typescript": "~5.7.3"
   }
 }

package/{publish → src}/api/api_abstract_class.js

@@ -1,5 +1,8 @@
+import axios from 'axios';
+import qs from 'query-string';
 import { ApiException } from "../exceptions/ApiException.js";
-import { clone_object, echo, is_array } from "../utils/utils.js";
+import { clone_object, echo, is_array, is_object } from "../utils/utils.js";
+import { UserService } from "../services/UserService.js";
 
 /**
  *
@@ -13,6 +16,7 @@ export class ApiAbstractClass
 	parent_app;
 	host_api;
 	stage         = 'production';
+	/** @type {string|false} */
 	module_prefix = false;
 	api_prefix    = '';
 	method;
@@ -60,10 +64,7 @@ export class ApiAbstractClass
 	/**
 	 *
 	 * @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
+	 * @param {object|import('../types/family_service/typeFOR.js').typeFOR} payload
 	 */
 	async search(payload)
 	{
@@ -185,17 +186,28 @@ export class ApiAbstractClass
 
 		request_params = this.mixin_service_params(request_params);
 
-		//console.log({payload, request_params});
-
-
 		if (this.host_api)
 		{
-			url = 'https://' + this.host_api + url;
+			const page_hostname = (typeof window !== 'undefined' && window.location)
+				? window.location.hostname
+				: '';
+			const api_hostname = String(this.host_api).split(':')[0];
+			if (!page_hostname || page_hostname !== api_hostname)
+			{
+				url = 'https://' + this.host_api + url;
+			}
+		}
+
+		const headers = { ...(this.headers || {}) };
+		const csrf_token = UserService.get_csrf_token();
+		if (csrf_token)
+		{
+			headers['X-CSRF-TOKEN'] = csrf_token;
 		}
 
 		let request_options = {
 			method : method,
-			headers: this.headers,
+			headers: headers,
 			url    : url
 		};
 

package/{publish → src}/api/api_abstract_element_class.js

@@ -18,7 +18,7 @@ export class ApiAbstractElementClass extends ApiAbstractClass
 	 */
 	constructor(options)
 	{
-		super();
+		super(options);
 	}
 
 
@@ -149,6 +149,24 @@ export class ApiAbstractElementClass extends ApiAbstractClass
 			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`;
+
+		payload      = this.handle_request_payload(payload);
+		let response = this.api_request(url, payload);
+		response     = this.handle_response(response);
+
+		return {
+			response: response,
+			payload : payload
+		};
 	}
 
 

package/{publish → src}/api/autotest_case_api.js

@@ -1,5 +1,5 @@
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
-import { typeAutotestCase } from "../types/family_elements/typeAutotestCase";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
+import { typeAutotestCase } from "../types/family_elements/typeAutotestCase.js";
 
 
 /**

package/{publish → src}/api/autotest_result_api.js

@@ -1,5 +1,5 @@
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
-import { typeAutotestResult } from "../types/family_elements/typeAutotestResult";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
+import { typeAutotestResult } from "../types/family_elements/typeAutotestResult.js";
 
 
 /**

package/{publish → src}/api/autotest_run_api.js

@@ -1,5 +1,5 @@
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
-import { typeAutotestRun } from "../types/family_elements/typeAutotestRun";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
+import { typeAutotestRun } from "../types/family_elements/typeAutotestRun.js";
 
 
 /**

package/{publish → src}/api/autotest_step_api.js

@@ -1,5 +1,5 @@
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
-import { typeAutotestStep } from "../types/family_elements/typeAutotestStep";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
+import { typeAutotestStep } from "../types/family_elements/typeAutotestStep.js";
 
 
 /**

package/{publish → src}/api/autotest_suite_api.js

@@ -1,5 +1,5 @@
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
-import { typeAutotestSuite } from "../types/family_elements/typeAutotestSuite";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
+import { typeAutotestSuite } from "../types/family_elements/typeAutotestSuite.js";
 
 
 /**

package/{publish → src}/api/bug_api.js

@@ -1,4 +1,4 @@
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
 import { typeBug } from "../types/family_elements/typeBug.js";
 
 

package/{publish → src}/api/functional_api.js

@@ -1,5 +1,5 @@
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
-import { typeFunctional } from "../types/family_elements/typeFunctional";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
+import { typeFunctional } from "../types/family_elements/typeFunctional.js";
 
 
 /**

package/{publish → src}/api/index.js

@@ -1,8 +1,8 @@
-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";
+import { TestPlanApi } from "./test_plan_api.js";
+import { ProjectApi } from "./project_api.js";
+import { ServiceApi } from "./service_api.js";
+import { TestCaseApi } from "./test_case_api.js";
+import { TestSuiteApi } from "./test_suite_api.js";
 import { TestCaseStepApi } from "./test_case_step_api.js";
 import { TeamManagementApi } from "./team_management_api.js";
 import { TeamMemberApi } from "./team_member_api.js";
@@ -47,6 +47,7 @@ import { AutotestResultApi } from "./autotest_result_api.js";
 import { ObjectRepositoryFolderApi } from "./object_repository_folder_api.js";
 import { ObjectRepositoryPageApi } from "./object_repository_page_api.js";
 import { ObjectRepositoryElementApi } from "./object_repository_element_api.js";
+import { bootstrap_type_api } from "./typeApiBinding.js";
 
 /**
  * Обертка над axios
@@ -75,9 +76,13 @@ export class Api
 	project;
 	service;
 
+	/** @type {string|false} */
 	host_api       = false;
+	/** @type {string|false} */
 	frontend_host  = false;
+	/** @type {string|false} */
 	general_domain = false;
+	/** @type {string|false} */
 	site_section   = false;
 
 	/** @type {EventApi} */
@@ -139,6 +144,7 @@ export class Api
 		this.init_options          = init_options;
 		this.constructor._instance = this;
 
+		bootstrap_type_api({ api_service: this });
 
 		this.#bootstrap();
 		return this.constructor._instance;

package/{publish → src}/api/object_repository_element_api.js

@@ -1,5 +1,5 @@
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
-import { typeObjectRepositoryElement } from "../types/family_elements/typeObjectRepositoryElement";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
+import { typeObjectRepositoryElement } from "../types/family_elements/typeObjectRepositoryElement.js";
 
 
 /**

package/{publish → src}/api/object_repository_folder_api.js

@@ -1,5 +1,5 @@
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
-import { typeObjectRepositoryFolder } from "../types/family_elements/typeObjectRepositoryFolder";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
+import { typeObjectRepositoryFolder } from "../types/family_elements/typeObjectRepositoryFolder.js";
 
 
 /**

package/{publish → src}/api/object_repository_page_api.js

@@ -1,5 +1,5 @@
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
-import { typeObjectRepositoryPage } from "../types/family_elements/typeObjectRepositoryPage";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
+import { typeObjectRepositoryPage } from "../types/family_elements/typeObjectRepositoryPage.js";
 
 
 /**

package/{publish → src}/api/project_api.js

@@ -1,5 +1,5 @@
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
-import { typeProject } from "../types/family_elements/typeProject";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
+import { typeProject } from "../types/family_elements/typeProject.js";
 
 /**
  *

package/{publish → src}/api/public_text_document_api.js

@@ -15,7 +15,7 @@ export class PublicTextDocumentApi extends ApiAbstractClass
 	 * GET|POST /web_api/public/text_document/view
 	 *
 	 * @param {object} payload  token, password?
-	 * @returns {Promise<{payload: object, response: object}>}
+	 * @returns {Promise<{payload: any, response: any}>}
 	 */
 	async view(payload)
 	{
@@ -41,7 +41,7 @@ export class PublicTextDocumentApi extends ApiAbstractClass
 	 * POST /web_api/public/text_document/report
 	 *
 	 * @param {object} payload  token, reason, reporter_email, password?
-	 * @returns {Promise<{payload: object, response: object}>}
+	 * @returns {Promise<{payload: any, response: any}>}
 	 */
 	async report(payload)
 	{

package/{publish → src}/api/team_management_api.js

@@ -1,4 +1,4 @@
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
 import { typeTeam } from "../types/family_elements/typeTeam.js";
 
 

package/{publish → src}/api/team_member_api.js

@@ -1,5 +1,5 @@
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
-import { typeTeamMember } from "../types/family_elements/typeTeamMember";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
+import { typeTeamMember } from "../types/family_elements/typeTeamMember.js";
 
 
 /**

package/{publish → src}/api/test_case_api.js

@@ -1,5 +1,5 @@
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
-import { typeTestCase } from "../types/family_elements/typeTestCase";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
+import { typeTestCase } from "../types/family_elements/typeTestCase.js";
 
 
 /**

package/{publish → src}/api/test_case_step_api.js

@@ -1,5 +1,5 @@
-import { typeTestCaseStep } from "../types/family_elements/typeTestCaseStep";
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
+import { typeTestCaseStep } from "../types/family_elements/typeTestCaseStep.js";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
 
 
 /**

package/{publish → src}/api/test_plan_api.js

@@ -1,5 +1,5 @@
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
-import { typeTestPlan } from "../types/family_elements/typeTestPlan";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
+import { typeTestPlan } from "../types/family_elements/typeTestPlan.js";
 
 
 /**

package/{publish → src}/api/test_run_api.js

@@ -1,5 +1,5 @@
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
-import { typeTestRun } from "../types/family_elements/typeTestRun";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
+import { typeTestRun } from "../types/family_elements/typeTestRun.js";
 
 export class TestRunApi extends ApiAbstractElementClass
 {

package/{publish → src}/api/test_run_result_api.js

@@ -1,5 +1,5 @@
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
-import { typeTestRunResult } from "../types/family_elements/typeTestRunResult";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
+import { typeTestRunResult } from "../types/family_elements/typeTestRunResult.js";
 
 
 /**

package/{publish → src}/api/test_suite_api.js

@@ -1,5 +1,5 @@
-import { ApiAbstractElementClass } from "./api_abstract_element_class";
-import { typeTestSuite } from "../types/family_elements/typeTestSuite";
+import { ApiAbstractElementClass } from "./api_abstract_element_class.js";
+import { typeTestSuite } from "../types/family_elements/typeTestSuite.js";
 
 
 /**

package/{publish → src}/api/text_document_api.js

@@ -19,7 +19,7 @@ export class TextDocumentApi extends ApiAbstractElementClass
 	 * GET /web_api/text_document/list_project_images?project_id=
 	 *
 	 * @param {object} payload
-	 * @returns {Promise<{payload: object, response: object}>}
+	 * @returns {Promise<{payload: any, response: any}>}
 	 */
 	async list_project_images(payload)
 	{
@@ -40,7 +40,7 @@ export class TextDocumentApi extends ApiAbstractElementClass
 	 * GET /web_api/text_document/load_body?text_document_id=
 	 *
 	 * @param {object} payload
-	 * @returns {Promise<{payload: object, response: object}>}
+	 * @returns {Promise<{payload: any, response: any}>}
 	 */
 	async load_body(payload)
 	{
@@ -61,7 +61,7 @@ export class TextDocumentApi extends ApiAbstractElementClass
 	 * GET /web_api/text_document/list_versions?text_document_id=
 	 *
 	 * @param {object} payload
-	 * @returns {Promise<{payload: object, response: object}>}
+	 * @returns {Promise<{payload: any, response: any}>}
 	 */
 	async list_versions(payload)
 	{
@@ -82,7 +82,7 @@ export class TextDocumentApi extends ApiAbstractElementClass
 	 * POST /web_api/text_document/restore_version
 	 *
 	 * @param {object} payload
-	 * @returns {Promise<{payload: object, response: object}>}
+	 * @returns {Promise<{payload: any, response: any}>}
 	 */
 	async restore_version(payload)
 	{
@@ -103,7 +103,7 @@ export class TextDocumentApi extends ApiAbstractElementClass
 	 * POST /web_api/text_document/enforce_version_retention
 	 *
 	 * @param {object} payload
-	 * @returns {Promise<{payload: object, response: object}>}
+	 * @returns {Promise<{payload: any, response: any}>}
 	 */
 	async enforce_version_retention(payload)
 	{
@@ -124,7 +124,7 @@ export class TextDocumentApi extends ApiAbstractElementClass
 	 * GET /web_api/text_document/public_share_status?text_document_id=
 	 *
 	 * @param {object} payload
-	 * @returns {Promise<{payload: object, response: object}>}
+	 * @returns {Promise<{payload: any, response: any}>}
 	 */
 	async public_share_status(payload)
 	{
@@ -145,7 +145,7 @@ export class TextDocumentApi extends ApiAbstractElementClass
 	 * POST /web_api/text_document/create_public_share
 	 *
 	 * @param {object} payload
-	 * @returns {Promise<{payload: object, response: object}>}
+	 * @returns {Promise<{payload: any, response: any}>}
 	 */
 	async create_public_share(payload)
 	{
@@ -166,7 +166,7 @@ export class TextDocumentApi extends ApiAbstractElementClass
 	 * POST /web_api/text_document/revoke_public_share
 	 *
 	 * @param {object} payload
-	 * @returns {Promise<{payload: object, response: object}>}
+	 * @returns {Promise<{payload: any, response: any}>}
 	 */
 	async revoke_public_share(payload)
 	{
@@ -187,7 +187,7 @@ export class TextDocumentApi extends ApiAbstractElementClass
 	 * GET /web_api/text_document/public_share_analytics?text_document_id=
 	 *
 	 * @param {object} payload
-	 * @returns {Promise<{payload: object, response: object}>}
+	 * @returns {Promise<{payload: any, response: any}>}
 	 */
 	async public_share_analytics(payload)
 	{

package/src/api/typeApiBinding.js

@@ -0,0 +1,41 @@
+/**
+ * Явная инъекция фасада `Api` в слой типов.
+ * Без глобала `ApiService`. `new Api(...)` вызывает `bootstrap_type_api` сам.
+ */
+
+let api_service = false;
+
+/**
+ * @param {object} [options]
+ * @param {import('./index.js').Api|false} [options.api_service]
+ */
+export function bootstrap_type_api(options = {})
+{
+	if (Object.prototype.hasOwnProperty.call(options, 'api_service'))
+	{
+		api_service = options.api_service || false;
+	}
+}
+
+/**
+ * @returns {import('./index.js').Api}
+ */
+export function get_type_api_service()
+{
+	if (api_service)
+	{
+		return api_service;
+	}
+
+	if (typeof globalThis !== 'undefined' && globalThis.ApiService)
+	{
+		return globalThis.ApiService;
+	}
+
+	throw new Error('Api is not bootstrapped. Construct Api or call bootstrap_type_api({ api_service }).');
+}
+
+export function reset_type_api()
+{
+	api_service = false;
+}