@wshcmx/types 10.0.0 → 11.0.0-beta1

package/lib/xml/kpi_profile_catalog/index.d.ts

@@ -8,13 +8,14 @@ AdminAccessBase & {
   /** Семейство */
   competence_profile_family_id: XmlElem<number | null, CompetenceProfileFamilyCatalogDocumentTopElem>;
   /** Категория */
-  role_id: XmlMultiElemObject<number | null>;
+  role_id: XmlMultiElemObject<number | null, RoleCatalogDocumentTopElem>;
   /** Родительски профиль KPI */
   parent_kpi_profile_id: XmlElem<number | null, KpiProfileCatalogDocumentTopElem>;
   /** КПЭ */
   kpi_id: XmlMultiElemObject<number | null, KpiCatalogDocumentTopElem>;
   /** Значения карты знаний */
   knowledge_parts: XmlElem<string | null>;
+  /** ID тегов */
   tags: XmlElem<string | null>;
   /** Эксперты */
   experts: XmlElem<string | null>;

package/lib/xml/kpi_value/index.d.ts

@@ -1,10 +1,11 @@
 interface KpiValueDocumentCustomDataHeaderColumn {
   title: XmlElem<string | null>;
+  /** @default string */
   type: XmlElem<string, typeof common.spxml_types>;
 }
 
 interface KpiValueDocumentCustomDataHeader {
-  column: XmlElem<KpiValueDocumentCustomDataHeaderColumn | null>;
+  column: XmlMultiElemObject<KpiValueDocumentCustomDataHeaderColumn | null>;
 }
 
 interface KpiValueDocumentCustomDataDataRowColumn {
@@ -16,7 +17,7 @@ interface KpiValueDocumentCustomDataDataRow {
 }
 
 interface KpiValueDocumentCustomDataData {
-  row: XmlElem<KpiValueDocumentCustomDataDataRow | null>;
+  row: XmlMultiElemObject<KpiValueDocumentCustomDataDataRow | null>;
 }
 
 interface KpiValueDocumentCustomData {
@@ -34,6 +35,14 @@ interface KpiValueDocumentWorkflowMatching {
   person_id: XmlElem<number | null, CollaboratorCatalogDocumentTopElem>;
 }
 
+interface KpiValueDocumentView {
+  /**
+   * @temp
+   * @default common
+   */
+  selector: XmlElem<string>;
+}
+
 type KpiValueDocumentTopElem = XmlTopElem &
 WorkflowDataBase &
 FileListBase &
@@ -76,7 +85,9 @@ AdminAccessBase & {
   comment: XmlElem<string | null>;
   /** Информация об объекте */
   doc_info: XmlElem<DocInfoBase | null>;
-  obtain_custom_data(kPITopElem: unknown, aData: unknown): unknown;
+  /** @temp */
+  view: XmlElem<KpiValueDocumentView | null>;
+  obtain_custom_data(kPITopElem: XmlTopElem, aData: unknown): unknown;
   calc_data(formula: string): unknown;
 };
 

package/lib/xml/learning/index.d.ts

@@ -3,6 +3,19 @@ interface LearningDocumentEvent {
   score: XmlElem<number | null>;
 }
 
+interface LearningDocumentView {
+  /**
+   * @temp
+   * @default 0
+   */
+  part_index: XmlElem<number>;
+  /**
+   * @temp
+   * @default result
+   */
+  result_tab_selector: XmlElem<string>;
+}
+
 type LearningDocumentTopElem = XmlTopElem &
 PersonFillingBase &
 CustomElemsBase &
@@ -34,7 +47,10 @@ AdminAccessBase & {
   education_plan_id: XmlElem<number | null, EducationPlanCatalogDocumentTopElem>;
   /** Разделы */
   parts: XmlMultiElem<LearningPartBase | null>;
-  /** Не кодировать данные модуля при запуске курса */
+  /**
+   * Не кодировать данные модуля при запуске курса
+   * @default false
+   */
   no_encoding_core_lesson: XmlElem<boolean | null>;
   /** Время модулей */
   time: XmlElem<number | null>;
@@ -43,7 +59,10 @@ AdminAccessBase & {
   /** Дата активации */
   start_usage_date: XmlElem<Date | null>;
   start_learning_date: XmlElem<Date | null>;
-  /** Назначен самостоятельно */
+  /**
+   * Назначен самостоятельно
+   * @default false
+   */
   is_self_enrolled: XmlElem<boolean>;
   /** Дата последнего посещ. */
   last_usage_date: XmlElem<Date | null>;
@@ -51,7 +70,10 @@ AdminAccessBase & {
   max_end_date: XmlElem<Date | null>;
   /** Базовый url */
   base_url: XmlElem<string | null>;
-  /** Максимальный балл */
+  /**
+   * Максимальный балл
+   * @default 0
+   */
   max_score: XmlElem<number>;
   /** Баллы */
   score: XmlElem<number | null>;
@@ -61,11 +83,17 @@ AdminAccessBase & {
   /** Незаконченный курс */
   active_learning_id: XmlElem<number | null, ActiveLearningCatalogDocumentTopElem>;
   active_learning_deleted: XmlElem<boolean | null>;
+  /**
+   * Использовать прокторинг
+   * @default false
+   */
   use_proctoring: XmlElem<boolean>;
   /** Комментарий */
   comment: XmlElem<string | null>;
   /** Информация об объекте */
   doc_info: XmlElem<DocInfoBase | null>;
+  /** @temp */
+  view: XmlElem<LearningDocumentView | null>;
 };
 
 type LearningDocument = XmlDocument & {

package/lib/xml/learning_catalog/index.d.ts

@@ -33,7 +33,10 @@ AdminAccessBase & {
   start_usage_date: XmlElem<Date | null>;
   /** Дата начала обучения */
   start_learning_date: XmlElem<Date | null>;
-  /** Назначен самостоятельно */
+  /**
+   * Назначен самостоятельно
+   * @default false
+   */
   is_self_enrolled: XmlElem<boolean>;
   /** Дата последнего посещ. */
   last_usage_date: XmlElem<Date | null>;
@@ -63,6 +66,10 @@ AdminAccessBase & {
   modification_user_id: XmlElem<number | null>;
   /** Код сервера */
   app_instance_id: XmlElem<string | null>;
+  /**
+   * Использовать прокторинг
+   * @default false
+   */
   use_proctoring: XmlElem<boolean>;
   OnBuild(): void;
 };

package/lib/xml/learning_part/index.d.ts

@@ -1,3 +1,16 @@
+interface LearningPartDocumentView {
+  /**
+   * @temp
+   * @default 0
+   */
+  part_index: XmlElem<number>;
+  /**
+   * @temp
+   * @default result
+   */
+  result_tab_selector: XmlElem<string>;
+}
+
 type LearningPartDocumentTopElem = XmlTopElem &
 CoreLessonBase &
 AnnalsObjectsBase & {
@@ -9,6 +22,8 @@ AnnalsObjectsBase & {
   learning_id: XmlElem<number | null>;
   /** Об объекте */
   doc_info: XmlElem<DocInfoBase | null>;
+  /** @temp */
+  view: XmlElem<LearningPartDocumentView | null>;
 };
 
 type LearningPartDocument = XmlDocument & {

package/lib/xml/learning_record/index.d.ts

@@ -1,7 +1,10 @@
 interface LearningRecordDocumentMediaRecord {
   id: XmlElem<string | null>;
+  /** Url */
   media_url: XmlElem<string | null>;
+  /** Номер потока */
   stream_number: XmlElem<number | null>;
+  /** Тип медиа потока */
   type_id: XmlElem<string | null>;
 }
 
@@ -23,7 +26,10 @@ interface LearningRecordDocumentResultComment {
   comment: XmlElem<string | null>;
   /** Комментарий */
   result_comment: XmlElem<string | null>;
-  /** Статус */
+  /**
+   * Статус
+   * @default active
+   */
   state_id: XmlElem<string | null, typeof common.learning_record_statuss>;
 }
 
@@ -43,9 +49,14 @@ interface LearningRecordDocumentViolation {
   person_id: XmlElem<number | null, CollaboratorCatalogDocumentTopElem>;
   /** Тип */
   type_id: XmlElem<string | null, typeof common.violation_types>;
-  /** Статус */
+  /**
+   * Статус
+   * @default active
+   */
   state_id: XmlElem<string | null, typeof common.violation_states>;
+  /** Номер потока */
   stream_number: XmlElem<number | null>;
+  /** Медиа поток */
   media_id: XmlElem<number | null>;
   interval: XmlElem<LearningRecordDocumentViolationInterval | null>;
 }
@@ -53,15 +64,26 @@ interface LearningRecordDocumentViolation {
 interface LearningRecordDocumentProctor {
   /** Сотрудник */
   proctor_id: XmlElem<number | null, CollaboratorCatalogDocumentTopElem>;
-  /** Статус */
+  /**
+   * Статус
+   * @default online
+   */
   state_id: XmlElem<string | null, typeof common.proctor_states>;
+  /**
+   * Предпочтительный проктор
+   * @default false
+   */
   is_prefer: XmlElem<boolean>;
+  /** Время последней активности */
   last_activity_date: XmlElem<Date | null>;
 }
 
 interface LearningRecordDocumentSession {
   id: XmlElem<string | null>;
-  /** Статус */
+  /**
+   * Статус
+   * @default active
+   */
   state_id: XmlElem<string | null, typeof common.proctoring_session_states>;
   /** Дата начала */
   start_date: XmlElem<Date | null>;
@@ -78,48 +100,82 @@ MsParametersBase & {
   id: XmlElem<number | null>;
   /** Код */
   code: XmlElem<string | null>;
-  /** Тип объекта */
+  /**
+   * Тип объекта
+   * @default test_learning
+   */
   object_type: XmlElem<string, typeof common.exchange_object_types>;
   /** Объект */
   object_id: XmlElem<number | null>;
   /** Название объекта */
   object_name: XmlElem<string | null>;
-  /** Тип объекта */
+  /**
+   * Тип объекта
+   * @default assessment
+   */
   proctoring_object_type: XmlElem<string, typeof common.exchange_object_types>;
   /** Объект */
   proctoring_object_id: XmlElem<number | null>;
   /** Название объекта */
   proctoring_object_name: XmlElem<string | null>;
-  /** Статус */
+  /**
+   * Статус
+   * @default active
+   */
   state_id: XmlElem<string | null, typeof common.learning_record_statuss>;
   /** Дата начала */
   start_date: XmlElem<Date | null>;
   /** Дата завершения */
   finish_date: XmlElem<Date | null>;
+  /**
+   * Запись закончена
+   * @default false
+   */
   is_finish_record: XmlElem<boolean>;
+  /**
+   * Статус проверки фото
+   * @default active
+   */
   check_foto_state_id: XmlElem<string | null, typeof common.learning_record_statuss>;
+  /** Количество фото не прошедших проверку */
   num_failed_checked_foto: XmlElem<number | null>;
   /** Комментарий */
   result_comment: XmlElem<string | null>;
   /** Сотрудник */
   person_id: XmlElem<number | null, CollaboratorCatalogDocumentTopElem>;
+  /** Система прокторинга */
   proctoring_system_id: XmlElem<number | null, ProctoringSystemCatalogDocumentTopElem>;
   /** Мероприятие */
   event_id: XmlElem<number | null, EventCatalogDocumentTopElem>;
+  /**
+   * Скачаны материалы прокторинга
+   * @default false
+   */
   download_materials: XmlElem<boolean>;
+  /**
+   * Количество запусков записи
+   * @default 0
+   */
   record_num: XmlElem<number | null>;
+  /** Дата запуска последней записи */
   start_record_date: XmlElem<Date | null>;
+  /** Записи медиа потока */
   media_records: XmlMultiElem<LearningRecordDocumentMediaRecord | null>;
+  /** Логирование */
   logs: XmlMultiElem<LearningRecordDocumentLog | null>;
+  /** Комментирование результатов */
   result_comments: XmlMultiElem<LearningRecordDocumentResultComment | null>;
+  /** Нарушения */
   violations: XmlMultiElem<LearningRecordDocumentViolation | null>;
+  /** Прокторы */
   proctors: XmlMultiElem<LearningRecordDocumentProctor | null>;
+  /** Сессии прокторинга */
   sessions: XmlMultiElem<LearningRecordDocumentSession | null>;
   /** Комментарий */
   comment: XmlElem<string | null>;
   /** Информация об объекте */
   doc_info: XmlElem<DocInfoBase | null>;
-  get_url_record(userTopElem: unknown, proctorId: number): unknown;
+  get_url_record(userTopElem: XmlTopElem, proctorId: number): unknown;
 };
 
 type LearningRecordDocument = XmlDocument & {

package/lib/xml/learning_record_catalog/index.d.ts

@@ -3,7 +3,10 @@ AdminAccessBase & {
   id: XmlElem<number | null>;
   /** Код */
   code: XmlElem<string | null>;
-  /** Тип объекта */
+  /**
+   * Тип объекта
+   * @default test_learning
+   */
   object_type: XmlElem<string, typeof common.exchange_object_types>;
   /** Объект */
   object_id: XmlElem<number | null>;
@@ -11,12 +14,16 @@ AdminAccessBase & {
   object_name: XmlElem<string | null>;
   /** Мероприятие */
   event_id: XmlElem<number | null, EventCatalogDocumentTopElem>;
-  /** Тип объекта */
+  /**
+   * Тип объекта
+   * @default assessment
+   */
   proctoring_object_type: XmlElem<string, typeof common.exchange_object_types>;
   /** Объект */
   proctoring_object_id: XmlElem<number | null>;
   /** Название объекта */
   proctoring_object_name: XmlElem<string | null>;
+  /** Система прокторинга */
   proctoring_system_id: XmlElem<number | null, ProctoringSystemCatalogDocumentTopElem>;
   /** Пользователь */
   person_id: XmlElem<number | null, CollaboratorCatalogDocumentTopElem>;
@@ -34,15 +41,34 @@ AdminAccessBase & {
   start_date: XmlElem<Date | null>;
   /** Дата завершения */
   finish_date: XmlElem<Date | null>;
+  /**
+   * Запись закончена
+   * @default false
+   */
   is_finish_record: XmlElem<boolean>;
+  /** Количество фото не прошедших проверку */
   num_failed_checked_foto: XmlElem<number | null>;
+  /**
+   * Статус проверки фото
+   * @default active
+   */
   check_foto_state_id: XmlElem<string | null, typeof common.learning_record_statuss>;
+  /**
+   * Скачаны материалы прокторинга
+   * @default false
+   */
   download_materials: XmlElem<boolean>;
   active_session_id: XmlElem<string | null>;
   /** Дата завершения */
   active_session_finish_date: XmlElem<Date | null>;
+  /** Прокторы */
   proctors_id: XmlMultiElemObject<number | null, CollaboratorCatalogDocumentTopElem>;
+  /** Все прокторы */
   archive_proctors_id: XmlMultiElemObject<number | null, CollaboratorCatalogDocumentTopElem>;
+  /**
+   * Предпочтительный проктор
+   * @default false
+   */
   is_prefer_proctor: XmlElem<boolean>;
   /** Дата модификации */
   modification_date: XmlElem<Date | null>;

package/lib/xml/learning_storage/index.d.ts

@@ -4,18 +4,28 @@ type LearningStorageDocumentTopElem = XmlTopElem & {
   code: XmlElem<string | null>;
   /** Название */
   name: XmlElem<string | null>;
+  /** @default false */
   std_auth: XmlElem<boolean>;
   auth_eval: XmlElem<string | null>;
+  /** @default login */
   auth_person_type: XmlElem<string>;
   auth_person_eval: XmlElem<string | null>;
   external_url: XmlElem<string | null>;
   login: XmlElem<string | null>;
   password: XmlElem<string | null>;
+  /** @default true */
   create_activity: XmlElem<boolean>;
+  /** @default false */
   use_extended_analytics: XmlElem<boolean>;
-  /** Является системным */
+  /**
+   * Является системным
+   * @default false
+   */
   is_std: XmlElem<boolean>;
-  /** Измененный */
+  /**
+   * Измененный
+   * @default false
+   */
   changed: XmlElem<boolean>;
   /** Доступ */
   access: XmlElem<AccessDocBase | null>;

package/lib/xml/learning_storage_catalog/index.d.ts

@@ -4,10 +4,17 @@ type LearningStorageCatalogDocumentTopElem = XmlTopElem & {
   code: XmlElem<string | null>;
   /** Название */
   name: XmlElem<string | null>;
+  /** Формировать расширенные данные для Центра Аналитики */
   use_extended_analytics: XmlElem<boolean | null>;
-  /** Является системным */
+  /**
+   * Является системным
+   * @default false
+   */
   is_std: XmlElem<boolean>;
-  /** Измененный */
+  /**
+   * Измененный
+   * @default false
+   */
   changed: XmlElem<boolean>;
   /** Дата модификации */
   modification_date: XmlElem<Date | null>;

package/lib/xml/learning_task/index.d.ts

@@ -4,6 +4,32 @@ interface LearningTaskDocumentExpert extends PersonFillingBase {
   person_id: XmlElem<number | null, CollaboratorCatalogDocumentTopElem>;
 }
 
+interface LearningTaskDocumentViewDuration {
+  /**
+   * @temp
+   * @default 0
+   */
+  hour: XmlElem<number | null>;
+  /**
+   * @temp
+   * @default 0
+   */
+  minute: XmlElem<number | null>;
+  /**
+   * @temp
+   * @default 0
+   */
+  second: XmlElem<number | null>;
+}
+
+interface LearningTaskDocumentView extends DescBase {
+  /**
+   * @temp
+   * Продолжительность выполнения
+   */
+  duration: XmlElem<LearningTaskDocumentViewDuration | null>;
+}
+
 type LearningTaskDocumentTopElem = XmlTopElem &
 ObjectCodeNameBase &
 FileListBase &
@@ -15,8 +41,17 @@ KnowledgePartsKpBase & {
   start_date: XmlElem<Date | null>;
   /** Дата завершения */
   finish_date: XmlElem<Date | null>;
+  /**
+   * Разрешить самостоятельное назначение
+   * @default true
+   */
   yourself_start: XmlElem<boolean>;
+  /**
+   * Использовать в мероприятиях
+   * @default false
+   */
   use_in_event: XmlElem<boolean>;
+  /** Продолжительность выполнения */
   duration: XmlElem<number | null>;
   experts: XmlMultiElem<LearningTaskDocumentExpert | null>;
   /** Комментарий */
@@ -25,8 +60,10 @@ KnowledgePartsKpBase & {
   desc: XmlElem<string | null>;
   /** Информация об объекте */
   doc_info: XmlElem<DocInfoBase | null>;
+  /** @temp */
+  view: XmlElem<LearningTaskDocumentView | null>;
   /** Категория */
-  role_id: XmlMultiElemObject<number | null>;
+  role_id: XmlMultiElemObject<number | null, RoleCatalogDocumentTopElem>;
 };
 
 type LearningTaskDocument = XmlDocument & {

package/lib/xml/learning_task_catalog/index.d.ts

@@ -11,8 +11,17 @@ AdminAccessBase & {
   start_date: XmlElem<Date | null>;
   /** Дата завершения */
   finish_date: XmlElem<Date | null>;
+  /**
+   * Разрешить самостоятельное назначение
+   * @default true
+   */
   yourself_start: XmlElem<boolean>;
+  /**
+   * Использовать в мероприятиях
+   * @default false
+   */
   use_in_event: XmlElem<boolean>;
+  /** Продолжительность выполнения */
   duration: XmlElem<number | null>;
   /** Дата модификации */
   modification_date: XmlElem<Date | null>;
@@ -21,7 +30,8 @@ AdminAccessBase & {
   /** Эксперт курса */
   experts_id: XmlMultiElemObject<number | null, CollaboratorCatalogDocumentTopElem>;
   /** Категория */
-  role_id: XmlMultiElemObject<number | null>;
+  role_id: XmlMultiElemObject<number | null, RoleCatalogDocumentTopElem>;
+  /** ID тегов */
   tags: XmlElem<string | null>;
   /** Значения карты знаний */
   knowledge_parts: XmlElem<string | null>;

package/lib/xml/learning_task_result/index.d.ts

@@ -1,7 +1,37 @@
 interface LearningTaskResultDocumentFile extends FileBase {
+  /**
+   * Файл эксперта
+   * @default false
+   */
   is_expert: XmlElem<boolean>;
 }
 
+interface LearningTaskResultDocumentViewDuration {
+  /**
+   * @temp
+   * @default 0
+   */
+  hour: XmlElem<number | null>;
+  /**
+   * @temp
+   * @default 0
+   */
+  minute: XmlElem<number | null>;
+  /**
+   * @temp
+   * @default 0
+   */
+  second: XmlElem<number | null>;
+}
+
+interface LearningTaskResultDocumentView extends DescBase {
+  /**
+   * @temp
+   * Продолжительность выполнения
+   */
+  duration: XmlElem<LearningTaskResultDocumentViewDuration | null>;
+}
+
 type LearningTaskResultDocumentTopElem = XmlTopElem &
 PersonFillingBase &
 AdminAccessBase &
@@ -10,11 +40,16 @@ CustomElemsBase & {
   id: XmlElem<number | null>;
   /** Код */
   code: XmlElem<string | null>;
+  /** Задание */
   learning_task_id: XmlElem<number | null, LearningTaskCatalogDocumentTopElem>;
+  /** Название задания */
   learning_task_name: XmlElem<string | null>;
   /** Сотрудник */
   person_id: XmlElem<number | null, CollaboratorCatalogDocumentTopElem>;
-  /** Статус */
+  /**
+   * Статус
+   * @default assign
+   */
   status_id: XmlElem<string | null, typeof common.learning_task_status_types>;
   /** Ответ */
   answer: XmlElem<string | null>;
@@ -37,18 +72,27 @@ CustomElemsBase & {
   /** План обучения */
   education_plan_id: XmlElem<number | null, EducationPlanCatalogDocumentTopElem>;
   active_learning_id: XmlElem<number | null, ActiveLearningCatalogDocumentTopElem>;
+  /** Продолжительность выполнения */
   duration: XmlElem<number | null>;
+  /**
+   * Просрочено
+   * @default false
+   */
   expired: XmlElem<boolean>;
+  /** Дата/время начала выполнения */
   start_execution_date: XmlElem<Date | null>;
+  /** Дата/время завершения выполнения */
   finish_execution_date: XmlElem<Date | null>;
   files: XmlMultiElem<LearningTaskResultDocumentFile | null>;
-  AddFile(fileId: number, docResource: unknown): void;
+  AddFile(fileId: number, resource: ResourceDocument): void;
   /** Комментарий */
   comment: XmlElem<string | null>;
   /** Описание */
   desc: XmlElem<string | null>;
   /** Информация об объекте */
   doc_info: XmlElem<DocInfoBase | null>;
+  /** @temp */
+  view: XmlElem<LearningTaskResultDocumentView | null>;
 };
 
 type LearningTaskResultDocument = XmlDocument & {

package/lib/xml/learning_task_result_catalog/index.d.ts

@@ -3,7 +3,9 @@ AdminAccessBase & {
   id: XmlElem<number | null>;
   /** Код */
   code: XmlElem<string | null>;
+  /** Задание */
   learning_task_id: XmlElem<number | null, LearningTaskCatalogDocumentTopElem>;
+  /** Название задания */
   learning_task_name: XmlElem<string | null>;
   /** Сотрудник */
   person_id: XmlElem<number | null, CollaboratorCatalogDocumentTopElem>;
@@ -13,7 +15,10 @@ AdminAccessBase & {
   expert_id: XmlElem<number | null, CollaboratorCatalogDocumentTopElem>;
   /** Мероприятие */
   event_id: XmlElem<number | null, EventCatalogDocumentTopElem>;
-  /** Статус */
+  /**
+   * Статус
+   * @default process
+   */
   status_id: XmlElem<string | null, typeof common.learning_task_status_types>;
   /** Оценка */
   mark: XmlElem<number | null>;
@@ -21,13 +26,20 @@ AdminAccessBase & {
   start_date: XmlElem<Date | null>;
   /** Дата завершения */
   finish_date: XmlElem<Date | null>;
+  /** Дата/время начала выполнения */
   start_execution_date: XmlElem<Date | null>;
+  /** Дата/время завершения выполнения */
   finish_execution_date: XmlElem<Date | null>;
   /** Планируемая дата начала */
   plan_start_date: XmlElem<Date | null>;
   /** Планируемая дата завершения */
   plan_end_date: XmlElem<Date | null>;
+  /** Продолжительность выполнения */
   duration: XmlElem<number | null>;
+  /**
+   * Просрочено
+   * @default false
+   */
   expired: XmlElem<boolean>;
   /** План обучения */
   education_plan_id: XmlElem<number | null, EducationPlanCatalogDocumentTopElem>;