@wshcmx/types 10.0.0 → 11.0.0-beta1

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

@@ -16,12 +16,16 @@ interface CourseDocumentPart {
   code: XmlElem<string | null>;
   /** Название */
   name: XmlElem<string | null>;
-  /** Тип раздела */
+  /**
+   * Тип раздела
+   * @default lesson
+   */
   type: XmlElem<string, typeof common.course_part_types>;
   /** Максимальный балл */
   max_score: XmlElem<number | null>;
   /** Проходной балл */
   mastery_score: XmlElem<number | null>;
+  /** Относительный проходной балл */
   mastery_score_relative: XmlElem<number | null>;
   url: XmlElem<string | null>;
   /** Учебный модуль */
@@ -34,25 +38,46 @@ interface CourseDocumentPart {
   win_width: XmlElem<number | null>;
   /** Высота */
   win_height: XmlElem<number | null>;
-  /** Отображать scrolling */
+  /**
+   * Отображать scrolling
+   * @default false
+   */
   disp_scrolling: XmlElem<boolean>;
-  /** Возможно изменять размер */
+  /**
+   * Возможно изменять размер
+   * @default false
+   */
   resizable: XmlElem<boolean>;
-  /** Обязательный раздел */
+  /**
+   * Обязательный раздел
+   * @default true
+   */
   is_mandatory: XmlElem<boolean>;
-  /** Видимый раздел */
+  /**
+   * Видимый раздел
+   * @default true
+   */
   is_visible: XmlElem<boolean>;
   /** Максимальное время на модуль */
   max_time_allowed: XmlElem<string | null>;
   /** Действие по наступлению лимита времени */
   time_limit_action: XmlElem<string | null>;
-  /** Установка статуса */
+  /**
+   * Установка статуса
+   * @default course
+   */
   set_status_side: XmlElem<string>;
-  /** Коэффициент итоговой оценки */
+  /**
+   * Коэффициент итоговой оценки
+   * @default 1.0
+   */
   score_factor: XmlElem<number>;
   /** Тест */
   assessment_id: XmlElem<number | null, AssessmentCatalogDocumentTopElem>;
-  /** Количество попыток */
+  /**
+   * Количество попыток
+   * @default 1
+   */
   attempts_num: XmlElem<number>;
   /** День планируемого начала обучения */
   start_day: XmlElem<number | null>;
@@ -62,14 +87,37 @@ interface CourseDocumentPart {
   activity_id: XmlElem<number | null, ActivityCatalogDocumentTopElem>;
   activity_states: XmlMultiElem<CourseDocumentPartActivityState | null>;
   object_id: XmlElem<number | null>;
+  /** Представление */
   cl_module_view: XmlElem<string | null>;
   /** Доступ после завершения разделов */
   completed_parent_parts: XmlMultiElem<CourseDocumentPartCompletedParentPart | null>;
   view: XmlElem<ViewConditionsBase | null>;
   launch: XmlElem<ViewConditionsBase | null>;
+  /** Протокол */
   cl_module_protocol: XmlElem<string | null>;
 }
 
+interface CourseDocumentView extends DescBase {
+  /**
+   * @temp
+   * @default 0
+   */
+  part_index: XmlElem<number>;
+  /** @temp */
+  filter: XmlElem<AuFtFilter | null>;
+  /**
+   * @temp
+   * Классификатор
+   */
+  knowledge_classifier_id: XmlElem<number | null>;
+  /**
+   * @temp
+   * Сортировать по
+   * @default name
+   */
+  knowledge_sort_type_id: XmlElem<string | null>;
+}
+
 type CourseDocumentTopElem = XmlTopElem &
 ObjectCodeNameBase &
 EstimationLevelsBase &
@@ -86,64 +134,123 @@ AdminAccessBase & {
   Doc: CourseDocument;
   /** Описание */
   desc: XmlElem<string | null>;
+  /** @default publish */
   status: XmlElem<string, typeof common.course_test_states>;
   /** Ширина окна электронного курса */
   win_width: XmlElem<number | null>;
   /** Высота окна электронного курса */
   win_height: XmlElem<number | null>;
+  /**
+   * Отображать скроллбар
+   * @default false
+   */
   disp_scrolling: XmlElem<boolean>;
-  /** Возможно изменять размер */
+  /**
+   * Возможно изменять размер
+   * @default false
+   */
   resizable: XmlElem<boolean>;
+  /** @default fix */
   struct_type: XmlElem<string>;
   /** Ссылка на файл библиотеки функций */
   library_url: XmlElem<string | null>;
   /** Разделы электронного курса */
   parts: XmlMultiElem<CourseDocumentPart | null>;
+  /** @default active_learning */
   course_finish_redirect: XmlElem<string>;
   course_finish_redirect_url: XmlElem<string | null>;
   /** Базовый url */
   base_url: XmlElem<string | null>;
+  /**
+   * Тип плеера курсов
+   * @default player
+   */
   view_type: XmlElem<string>;
   /** Проходной балл */
   mastery_score: XmlElem<number | null>;
-  /** Максимальный балл */
+  /**
+   * Максимальный балл
+   * @default 0
+   */
   max_score: XmlElem<number>;
-  /** Способ расчета итоговой оценки */
+  /**
+   * Способ расчета итоговой оценки
+   * @default score
+   */
   score_sum_type: XmlElem<string>;
-  /** Формула итоговой оценки */
+  /**
+   * Формула итоговой оценки
+   * @default score
+   */
   score_sum_eval: XmlElem<string>;
-  /** Разрешить самостоятельное назначение курса */
+  /**
+   * Разрешить самостоятельное назначение курса
+   * @default true
+   */
   yourself_start: XmlElem<boolean>;
-  /** Разрешить завершать курс, если не все главы пройдены или не набран проходной балл */
+  /**
+   * Разрешить завершать курс, если не все главы пройдены или не набран проходной балл
+   * @default false
+   */
   finish_without_mastery_score: XmlElem<boolean>;
-  /** Завершать курс, если пройдены все главы курса или набран проходной балл */
+  /**
+   * Завершать курс, если пройдены все главы курса или набран проходной балл
+   * @default false
+   */
   auto_finish: XmlElem<boolean>;
-  /** Не использовать локальное расположение данного курса */
+  /**
+   * Не использовать локальное расположение данного курса
+   * @default false
+   */
   ignor_location: XmlElem<boolean>;
-  /** Возможен запуск завершенного курса без сохранения новых результатов */
+  /**
+   * Возможен запуск завершенного курса без сохранения новых результатов
+   * @default false
+   */
   start_after_finish: XmlElem<boolean>;
-  /** Не передавать в адресе запускаемого модуля информацию */
+  /**
+   * Не передавать в адресе запускаемого модуля информацию
+   * @default true
+   */
   no_url_info: XmlElem<boolean>;
-  /** Открывать описание раздела с типом папка */
+  /**
+   * Открывать описание раздела с типом папка
+   * @default false
+   */
   disp_folder_desc: XmlElem<boolean>;
   /** Продолжительность */
   duration: XmlElem<number | null>;
-  /** Не кодировать данные модулей при запуска курса */
+  /**
+   * Не кодировать данные модулей при запуска курса
+   * @default false
+   */
   no_encoding_core_lesson: XmlElem<boolean | null>;
-  /** Не отправлять стандартные уведомления о назначении */
+  /**
+   * Не отправлять стандартные уведомления о назначении
+   * @default false
+   */
   not_use_default_notification: XmlElem<boolean | null>;
   /** Тип отзыва по умолчанию */
   default_response_type_id: XmlElem<number | null, ResponseTypeCatalogDocumentTopElem>;
-  /** Обязательное заполнение отзыва */
+  /**
+   * Обязательное заполнение отзыва
+   * @default false
+   */
   mandatory_fill_response: XmlElem<boolean>;
-  /** Отображать отзывы */
+  /**
+   * Отображать отзывы
+   * @default false
+   */
   allow_disp_response: XmlElem<boolean>;
   /** Электронный курс */
   cl_course_id: XmlElem<number | null, ClCourseCatalogDocumentTopElem>;
   version: XmlElem<string | null>;
   /** Стоимость записи на электронный курс */
   price: XmlElem<number | null>;
-  /** Доступный для Personal WebSoft HCM */
+  /**
+   * Доступный для Personal WebSoft HCM
+   * @default false
+   */
   pwt_disp: XmlElem<boolean>;
   import_type: XmlElem<string | null>;
   /** Обучающая организация */
@@ -156,6 +263,8 @@ AdminAccessBase & {
   doc_info: XmlElem<DocInfoBase | null>;
   /** Комментарий */
   comment: XmlElem<string | null>;
+  /** @temp */
+  view: XmlElem<CourseDocumentView | null>;
   get_part_code(): string;
   Width(code: string): number;
   Height(code: string): number;
@@ -166,7 +275,7 @@ AdminAccessBase & {
   GetPartUrl(code: unknown, index: unknown): string;
   get_info(): null | Object;
   /** Категория */
-  role_id: XmlMultiElemObject<number | null>;
+  role_id: XmlMultiElemObject<number | null, RoleCatalogDocumentTopElem>;
 };
 
 type CourseDocument = XmlDocument & {

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

@@ -8,7 +8,10 @@ AdminAccessBase & {
   name: XmlElem<string | null>;
   /** Ресурс базы */
   resource_id: XmlElem<number | null, ResourceCatalogDocumentTopElem>;
-  /** Статус */
+  /**
+   * Статус
+   * @default publish
+   */
   status: XmlElem<string, typeof common.course_test_states>;
   /** Стоимость курса */
   price: XmlElem<number | null>;
@@ -16,12 +19,15 @@ AdminAccessBase & {
   mastery_score: XmlElem<number | null>;
   /** Максимальный балл */
   max_score: XmlElem<number | null>;
-  /** Может быть назначен самостоятельно */
+  /**
+   * Может быть назначен самостоятельно
+   * @default true
+   */
   yourself_start: XmlElem<boolean>;
   /** Продолжительность в днях */
   duration: XmlElem<number | null>;
   /** Категория */
-  role_id: XmlMultiElemObject<number | null>;
+  role_id: XmlMultiElemObject<number | null, RoleCatalogDocumentTopElem>;
   /** Эксперт курса */
   person_id: XmlElem<number | null, CollaboratorCatalogDocumentTopElem>;
   /** Электронный курс */
@@ -32,12 +38,25 @@ AdminAccessBase & {
   base_url: XmlElem<string | null>;
   /** Тип отзыва по умолчанию */
   default_response_type_id: XmlElem<number | null, ResponseTypeCatalogDocumentTopElem>;
-  /** Обязательное заполнение отзыва */
+  /**
+   * Обязательное заполнение отзыва
+   * @default false
+   */
   mandatory_fill_response: XmlElem<boolean>;
-  /** Отображать отзывы */
+  /**
+   * Отображать отзывы
+   * @default false
+   */
   allow_disp_response: XmlElem<boolean>;
-  /** Отображать в списке Персонального WebSoft HCMa */
+  /**
+   * Отображать в списке Персонального WebSoft HCMa
+   * @default false
+   */
   pwt_disp: XmlElem<boolean>;
+  /**
+   * Тип плеера курсов
+   * @default player
+   */
   view_type: XmlElem<string>;
   /** Дата модификации */
   modification_date: XmlElem<Date | null>;
@@ -47,6 +66,7 @@ AdminAccessBase & {
   app_instance_id: XmlElem<string | null>;
   /** Значения карты знаний */
   knowledge_parts: XmlElem<string | null>;
+  /** ID тегов */
   tags: XmlElem<string | null>;
   /** Эксперты */
   experts: XmlElem<string | null>;

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

@@ -16,29 +16,50 @@ AdminAccessBase & {
   desc: XmlElem<string | null>;
   /** Внешний ID */
   eid: XmlElem<string | null>;
-  /** Тип раздела */
+  /**
+   * Тип раздела
+   * @default lesson
+   */
   type: XmlElem<string>;
   /** Максимальный балл */
   max_score: XmlElem<number | null>;
   /** Проходной балл */
   mastery_score: XmlElem<number | null>;
+  /** Относительный проходной балл */
   mastery_score_relative: XmlElem<number | null>;
   url: XmlElem<string | null>;
   /** Тест */
   assessment_id: XmlElem<number | null, AssessmentCatalogDocumentTopElem>;
-  /** Количество попыток */
+  /**
+   * Количество попыток
+   * @default 1
+   */
   attempts_num: XmlElem<number>;
-  /** Установка статуса */
+  /**
+   * Установка статуса
+   * @default course
+   */
   set_status_side: XmlElem<string>;
-  /** Ширина окна электронного курса */
+  /**
+   * Ширина окна электронного курса
+   * @default 1018
+   */
   win_width: XmlElem<number | null>;
-  /** Высота окна электронного курса */
+  /**
+   * Высота окна электронного курса
+   * @default 682
+   */
   win_height: XmlElem<number | null>;
-  /** Отображать scrolling */
+  /**
+   * Отображать scrolling
+   * @default false
+   */
   disp_scrolling: XmlElem<boolean>;
   version: XmlElem<string | null>;
   import_type: XmlElem<string | null, typeof common.course_import_types>;
+  /** @default 0 */
   activation_count: XmlElem<number | null>;
+  /** @default 0 */
   launch_count: XmlElem<number | null>;
   cmi5: XmlElem<CourseModuleDocumentCmi5 | null>;
   /** Доступ */
@@ -47,8 +68,10 @@ AdminAccessBase & {
   doc_info: XmlElem<DocInfoBase | null>;
   /** Комментарий */
   comment: XmlElem<string | null>;
+  /** @temp */
+  view: XmlElem<DescBase | null>;
   /** Категория */
-  role_id: XmlMultiElemObject<number | null>;
+  role_id: XmlMultiElemObject<number | null, RoleCatalogDocumentTopElem>;
 };
 
 type CourseModuleDocument = XmlDocument & {

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

@@ -12,9 +12,10 @@ AdminAccessBase & {
   activation_count: XmlElem<number | null>;
   launch_count: XmlElem<number | null>;
   /** Категория */
-  role_id: XmlMultiElemObject<number | null>;
+  role_id: XmlMultiElemObject<number | null, RoleCatalogDocumentTopElem>;
   /** Значения карты знаний */
   knowledge_parts: XmlElem<string | null>;
+  /** ID тегов */
   tags: XmlElem<string | null>;
   /** Эксперты */
   experts: XmlElem<string | null>;

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

@@ -1,3 +1,19 @@
+interface CovenantDocumentEducationMethodIdSd {
+  name: XmlElem<string | null>;
+}
+
+interface CovenantDocumentEducationMethodId {
+  sd: XmlElem<CovenantDocumentEducationMethodIdSd | null>;
+}
+
+interface CovenantDocumentView {
+  /**
+   * @temp
+   * @default common
+   */
+  selector: XmlElem<string>;
+}
+
 type CovenantDocumentTopElem = XmlTopElem &
 MsPersonSdBase &
 CostCurrencyBase &
@@ -27,7 +43,7 @@ CustomElemsBase & {
   /** Процент удержания */
   proc_deduct: XmlElem<number | null>;
   /** Учебная программа */
-  education_method_id: XmlElem<number | null, EducationMethodCatalogDocumentTopElem>;
+  education_method_id: XmlElem<CovenantDocumentEducationMethodId | null, EducationMethodCatalogDocumentTopElem>;
   /** Обучающая организация */
   education_org_id: XmlElem<number | null, EducationOrgCatalogDocumentTopElem>;
   /** Мероприятие */
@@ -40,6 +56,8 @@ CustomElemsBase & {
   status_id: XmlElem<string | null, typeof common.covenant_status_types>;
   /** Информация об объекте */
   doc_info: XmlElem<DocInfoBase | null>;
+  /** @temp */
+  view: XmlElem<CovenantDocumentView | null>;
 };
 
 type CovenantDocument = XmlDocument & {

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

@@ -5,12 +5,16 @@ type CredentialDocumentTopElem = XmlTopElem & {
   code: XmlElem<string | null>;
   /** Название */
   name: XmlElem<string | null>;
-  /** Тип */
+  /**
+   * Тип
+   * @default basic
+   */
   type: XmlElem<string>;
   /** Логин */
   login: XmlElem<string | null>;
   /** Пароль */
   password: XmlElem<string | null>;
+  /** Профиль безопасности */
   remote_security_profile_id: XmlElem<number | null, RemoteSecurityProfileCatalogDocumentTopElem>;
   /** Комментарий */
   comment: XmlElem<string | null>;

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

@@ -1,3 +1,13 @@
+interface CustomAdminTemplateDocumentView {
+  /**
+   * @temp
+   * @default common
+   */
+  selector: XmlElem<string>;
+  /** @default true */
+  form_name_correct: XmlElem<boolean | null>;
+}
+
 type CustomAdminTemplateDocumentTopElem = XmlTopElem &
 ExecCodeBase &
 WebVariablesBase & {
@@ -17,12 +27,22 @@ WebVariablesBase & {
   comment: XmlElem<string | null>;
   /** Информация об объекте */
   doc_info: XmlElem<DocInfoBase | null>;
-  /** Измененный */
+  /** @temp */
+  view: XmlElem<CustomAdminTemplateDocumentView | null>;
+  /** @temp */
+  converter: XmlElem<boolean | null>;
+  /**
+   * Измененный
+   * @default false
+   */
   changed: XmlElem<boolean>;
-  /** Является системным */
+  /**
+   * Является системным
+   * @default false
+   */
   is_std: XmlElem<boolean>;
   /** Категория */
-  role_id: XmlMultiElemObject<number | null>;
+  role_id: XmlMultiElemObject<number | null, RoleCatalogDocumentTopElem>;
 };
 
 type CustomAdminTemplateDocument = XmlDocument & {

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

@@ -8,12 +8,18 @@ type CustomAdminTemplateCatalogDocumentTopElem = XmlTopElem & {
   category: XmlElem<string | null>;
   /** Название формы */
   form_name: XmlElem<string | null>;
-  /** Измененный */
+  /**
+   * Измененный
+   * @default false
+   */
   changed: XmlElem<boolean>;
-  /** Является системным */
+  /**
+   * Является системным
+   * @default false
+   */
   is_std: XmlElem<boolean>;
   /** Категория */
-  role_id: XmlMultiElemObject<number | null>;
+  role_id: XmlMultiElemObject<number | null, RoleCatalogDocumentTopElem>;
   /** Дата модификации */
   modification_date: XmlElem<Date | null>;
   /** Код сервера */

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

@@ -1,25 +1,53 @@
 interface CustomChatbotTemplateDocumentIncludeCustomChatbotTemplate {
-  include_custom_chatbot_template_id: XmlElem<number, CustomChatbotTemplateCatalogDocumentTopElem>;
+  include_custom_chatbot_template_id: XmlElem<number | null, CustomChatbotTemplateCatalogDocumentTopElem>;
+}
+
+interface CustomChatbotTemplateDocumentView extends DescBase {
+  /**
+   * @temp
+   * @default common
+   */
+  selector: XmlElem<string>;
 }
 
 type CustomChatbotTemplateDocumentTopElem = XmlTopElem &
 ExecCodeBase &
 MsParametersBase & {
   Doc: CustomChatbotTemplateDocument;
-  id: XmlElem<number>;
-  code: XmlElem<string>;
-  name: XmlElem<string>;
-  eval_str: XmlElem<string>;
-  url: XmlElem<string>;
+  id: XmlElem<number | null>;
+  /** Код */
+  code: XmlElem<string | null>;
+  /** Название */
+  name: XmlElem<string | null>;
+  /** Код */
+  eval_str: XmlElem<string | null>;
+  /** Ссылка на шаблон */
+  url: XmlElem<string | null>;
+  /** @default custom_chatbot_template */
   out_type: XmlElem<string, typeof common.chatbot_out_types>;
-  include_custom_chatbot_templates: XmlMultiElem<CustomChatbotTemplateDocumentIncludeCustomChatbotTemplate>;
-  access: XmlElem<AccessDocBase>;
-  desc: XmlElem<string>;
-  comment: XmlElem<string>;
-  doc_info: XmlElem<DocInfoBase>;
+  include_custom_chatbot_templates: XmlMultiElem<CustomChatbotTemplateDocumentIncludeCustomChatbotTemplate | null>;
+  /** Доступ */
+  access: XmlElem<AccessDocBase | null>;
+  /** Описание */
+  desc: XmlElem<string | null>;
+  /** Комментарий */
+  comment: XmlElem<string | null>;
+  /** Информация об объекте */
+  doc_info: XmlElem<DocInfoBase | null>;
+  /**
+   * Является системным
+   * @default false
+   */
   is_std: XmlElem<boolean>;
+  /**
+   * Измененный
+   * @default false
+   */
   changed: XmlElem<boolean>;
-  role_id: XmlMultiElemObject<number>;
+  /** @temp */
+  view: XmlElem<CustomChatbotTemplateDocumentView | null>;
+  /** Категория */
+  role_id: XmlMultiElemObject<number | null, RoleCatalogDocumentTopElem>;
 };
 
 type CustomChatbotTemplateDocument = XmlDocument & {

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

@@ -1,13 +1,27 @@
 type CustomChatbotTemplateCatalogDocumentTopElem = XmlTopElem & {
-  id: XmlElem<number>;
-  code: XmlElem<string>;
-  name: XmlElem<string>;
-  url: XmlElem<string>;
+  id: XmlElem<number | null>;
+  /** Код */
+  code: XmlElem<string | null>;
+  /** Название */
+  name: XmlElem<string | null>;
+  /** Ссылка на шаблон */
+  url: XmlElem<string | null>;
+  /** @default custom_chatbot_template */
   out_type: XmlElem<string, typeof common.chatbot_out_types>;
-  modification_date: XmlElem<Date>;
-  app_instance_id: XmlElem<string>;
+  /** Дата модификации */
+  modification_date: XmlElem<Date | null>;
+  /** Код сервера */
+  app_instance_id: XmlElem<string | null>;
+  /**
+   * Является системным
+   * @default false
+   */
   is_std: XmlElem<boolean>;
+  /**
+   * Измененный
+   * @default false
+   */
   changed: XmlElem<boolean>;
-  role_id: XmlMultiElemObject<number>;
+  role_id: XmlMultiElemObject<number | null, RoleCatalogDocumentTopElem>;
   OnBuild(): void;
 };