@wshcmx/types 10.0.0 → 11.0.0-rc.1

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

@@ -1,130 +1,443 @@
 interface WorkspaceConfigDocumentThemeBlockTheme {
-  theme_id: XmlElem<string, typeof common.workspace_themes>;
+  theme_id: XmlElem<string | null, typeof common.workspace_themes>;
 }
 
 interface WorkspaceConfigDocumentThemeBlock {
-  default_theme_id: XmlElem<string, typeof common.workspace_themes>;
-  themes: XmlMultiElem<WorkspaceConfigDocumentThemeBlockTheme>;
+  /** Тема по умолчанию */
+  default_theme_id: XmlElem<string | null, typeof common.workspace_themes>;
+  themes: XmlMultiElem<WorkspaceConfigDocumentThemeBlockTheme | null>;
 }
 
 interface WorkspaceConfigDocumentConversationBlockCollaboratorInfo {
+  /**
+   * Телефон
+   * @default false
+   */
   phone: XmlElem<boolean>;
+  /**
+   * Электронная почта
+   * @default false
+   */
   email: XmlElem<boolean>;
+  /**
+   * Должность
+   * @default false
+   */
   position: XmlElem<boolean>;
+  /**
+   * Подразделение
+   * @default false
+   */
   subdivision: XmlElem<boolean>;
+  /**
+   * Дата рождения (без года)
+   * @default false
+   */
   birth_date: XmlElem<boolean>;
 }
 
 interface WorkspaceConfigDocumentConversationBlockGroupConversation {
+  /**
+   * Разрешить выходить из групповых разговоров
+   * @default false
+   */
   allow_exit: XmlElem<boolean>;
+  /**
+   * Разрешить управлять участниками в групповых разговорах
+   * @default false
+   */
   allow_change_participant: XmlElem<boolean>;
+  /**
+   * Разрешить менять названия групповых разговоров организатору
+   * @default false
+   */
   allow_change_name: XmlElem<boolean>;
+  /**
+   * Разрешить всегда менять названия групповых разговоров
+   * @default false
+   */
   allow_always_change_name: XmlElem<boolean>;
+  /**
+   * Разрешить менять иконки групповых разговоров организатору
+   * @default false
+   */
   allow_change_icon: XmlElem<boolean>;
+  /**
+   * Разрешить всегда менять иконки групповых разговоров
+   * @default false
+   */
   allow_always_change_icon: XmlElem<boolean>;
 }
 
 interface WorkspaceConfigDocumentConversationBlockChat {
+  /**
+   * Разрешить писать сообщения
+   * @default false
+   */
   allow_write_message: XmlElem<boolean>;
+  /**
+   * Разрешить реакции на сообщения
+   * @default false
+   */
   allow_reaction: XmlElem<boolean>;
+  /**
+   * Разрешить редактировать свои сообщения
+   * @default false
+   */
   allow_edit_message: XmlElem<boolean>;
+  /**
+   * Разрешить удалять свои сообщения у себя
+   * @default false
+   */
   allow_hide_message_for_yourself: XmlElem<boolean>;
+  /**
+   * Разрешить удалять свои сообщения у всех
+   * @default false
+   */
   allow_hide_message: XmlElem<boolean>;
+  /**
+   * Разрешить пересылать сообщения
+   * @default false
+   */
   allow_forward: XmlElem<boolean>;
+  /**
+   * Разрешить отправлять сообщения со сроком ознакомления
+   * @default false
+   */
   allow_write_message_with_aquaint: XmlElem<boolean>;
+  /**
+   * Разрешить отправлять аудиосообщения
+   * @default false
+   */
   allow_write_audio_message: XmlElem<boolean>;
+  /**
+   * Разрешить вставлять в чат картинки из буфера обмена
+   * @default false
+   */
   allow_insert_images_from_clipboard: XmlElem<boolean>;
+  /**
+   * Разрешить отправлять в чат картинки
+   * @default false
+   */
   allow_insert_images: XmlElem<boolean>;
+  /**
+   * Разрешить отправлять в чат файлы
+   * @default false
+   */
   allow_insert_files: XmlElem<boolean>;
-  max_message_length: XmlElem<number>;
+  /**
+   * Максимальная длина сообщения
+   * @default 1000
+   */
+  max_message_length: XmlElem<number | null>;
 }
 
 interface WorkspaceConfigDocumentConversationBlockCall {
+  /**
+   * Разрешить микрофон
+   * @default false
+   */
   allow_microphone: XmlElem<boolean>;
+  /**
+   * Разрешить трансляцию экрана
+   * @default false
+   */
   allow_screen_broadcast: XmlElem<boolean>;
+  /**
+   * Разрешить камеру
+   * @default false
+   */
   allow_camera: XmlElem<boolean>;
+  /**
+   * Показывать сообщения о присоединении к групповому звонку
+   * @default false
+   */
   show_message_member_connect_call: XmlElem<boolean>;
-  video_format_id: XmlElem<string, typeof common.video_formats>;
-  limit_participant: XmlElem<number>;
-  reserve_bitrate: XmlElem<boolean>;
-  max_incoming_bitrate: XmlElem<number>;
-  max_outgoing_bitrate: XmlElem<number>;
-  pagesize: XmlElem<number>;
-  use_audio_options: XmlElem<boolean>;
-  audio_max_entries: XmlElem<number>;
-  audio_min_threshold: XmlElem<number>;
-  audio_interval: XmlElem<number>;
+  /** Максимально допустимое разрешение камеры */
+  video_format_id: XmlElem<string | null, typeof common.video_formats>;
+  /** Максимальное число участников в звонке */
+  limit_participant: XmlElem<number | null>;
+  /**
+   * Резервировать полосу пропускания для звонка
+   * @default false
+   */
+  reserve_bitrate: XmlElem<boolean | null>;
+  /** Лимит входящего трафика для участника звонка */
+  max_incoming_bitrate: XmlElem<number | null>;
+  /** Лимит исходящего трафика для участника звонка */
+  max_outgoing_bitrate: XmlElem<number | null>;
+  /** Число участников на странице по умолчанию */
+  pagesize: XmlElem<number | null>;
+  /**
+   * Выделять выступающего
+   * @default false
+   */
+  use_audio_options: XmlElem<boolean | null>;
+  /**
+   * Максимальное число выступающих для выделения
+   * @default 1
+   */
+  audio_max_entries: XmlElem<number | null>;
+  /**
+   * Порог для определения выступающих
+   * @default 80
+   */
+  audio_min_threshold: XmlElem<number | null>;
+  /**
+   * Интервал между проверками выступающих (в мс)
+   * @default 1000
+   */
+  audio_interval: XmlElem<number | null>;
+  /**
+   * Разрешить записывать звонки
+   * @default false
+   */
+  allow_write: XmlElem<boolean>;
+  /**
+   * Разрешить расшифровывать звонки
+   * @default false
+   */
+  allow_recognition: XmlElem<boolean>;
+  /**
+   * Разрешить автоматическое формирование резюме по звонку
+   * @default false
+   */
+  allow_summary: XmlElem<boolean>;
 }
 
 interface WorkspaceConfigDocumentConversationBlockWebinar {
-  limit_tutor: XmlElem<number>;
-  limit_participant: XmlElem<number>;
-  reserve_bitrate: XmlElem<boolean>;
-  max_incoming_bitrate: XmlElem<number>;
-  max_outgoing_bitrate: XmlElem<number>;
-  use_audio_options: XmlElem<boolean>;
-  audio_max_entries: XmlElem<number>;
-  audio_min_threshold: XmlElem<number>;
-  audio_interval: XmlElem<number>;
+  /** Максимальное число ведущих вебинара */
+  limit_tutor: XmlElem<number | null>;
+  /** Максимальное число участников вебинара */
+  limit_participant: XmlElem<number | null>;
+  /**
+   * Резервировать полосу пропускания для вебинара
+   * @default false
+   */
+  reserve_bitrate: XmlElem<boolean | null>;
+  /** Лимит входящего трафика для участника вебинара */
+  max_incoming_bitrate: XmlElem<number | null>;
+  /** Лимит исходящего трафика для участника вебинара */
+  max_outgoing_bitrate: XmlElem<number | null>;
+  /**
+   * Выделять выступающего
+   * @default false
+   */
+  use_audio_options: XmlElem<boolean | null>;
+  /**
+   * Максимальное число выступающих для выделения
+   * @default 1
+   */
+  audio_max_entries: XmlElem<number | null>;
+  /**
+   * Порог для определения выступающих
+   * @default 80
+   */
+  audio_min_threshold: XmlElem<number | null>;
+  /**
+   * Интервал между проверками выступающих (в мс)
+   * @default 1000
+   */
+  audio_interval: XmlElem<number | null>;
+  /** Максимально допустимое разрешение камеры */
+  video_format_id: XmlElem<string | null, typeof common.video_formats>;
+  /** Максимально допустимое разрешение трансляции экрана */
+  screen_format_id: XmlElem<string | null, typeof common.video_formats>;
 }
 
 interface WorkspaceConfigDocumentConversationBlock {
+  /**
+   * Показывать раздел Разговоры
+   * @default false
+   */
   show_conversation: XmlElem<boolean>;
+  /**
+   * Разрешить создавать разговоры
+   * @default false
+   */
   allow_create_conversation: XmlElem<boolean>;
+  /**
+   * Разрешить создавать разговоры
+   * @default false
+   */
   allow_create_call: XmlElem<boolean>;
+  /**
+   * Разрешить расширенный поиск разговоров
+   * @default false
+   */
   allow_advanced_search: XmlElem<boolean>;
-  collaborator_visible_type_id: XmlElem<string, typeof common.conversation_visible_types>;
-  collaborator_info: XmlElem<WorkspaceConfigDocumentConversationBlockCollaboratorInfo>;
-  group_conversation: XmlElem<WorkspaceConfigDocumentConversationBlockGroupConversation>;
-  chat: XmlElem<WorkspaceConfigDocumentConversationBlockChat>;
-  call: XmlElem<WorkspaceConfigDocumentConversationBlockCall>;
-  webinar: XmlElem<WorkspaceConfigDocumentConversationBlockWebinar>;
+  /**
+   * Выбор собеседников
+   * @default participant
+   */
+  collaborator_visible_type_id: XmlElem<string | null, typeof common.conversation_visible_types>;
+  collaborator_info: XmlElem<WorkspaceConfigDocumentConversationBlockCollaboratorInfo | null>;
+  group_conversation: XmlElem<WorkspaceConfigDocumentConversationBlockGroupConversation | null>;
+  chat: XmlElem<WorkspaceConfigDocumentConversationBlockChat | null>;
+  call: XmlElem<WorkspaceConfigDocumentConversationBlockCall | null>;
+  webinar: XmlElem<WorkspaceConfigDocumentConversationBlockWebinar | null>;
 }
 
 interface WorkspaceConfigDocumentCalendarBlock {
+  /**
+   * Показывать раздел Календарь
+   * @default false
+   */
   show_calendar: XmlElem<boolean>;
+  /**
+   * Показывать вебинары
+   * @default false
+   */
   show_event: XmlElem<boolean>;
+  /**
+   * Показывать звонки
+   * @default false
+   */
   show_call: XmlElem<boolean>;
+  /**
+   * Разрешить создавать вебинары
+   * @default false
+   */
   allow_create_event: XmlElem<boolean>;
+  /**
+   * Разрешить создавать звонки
+   * @default false
+   */
   allow_create_call: XmlElem<boolean>;
+  /**
+   * Разрешить удалять вебинары
+   * @default false
+   */
   allow_delete_event: XmlElem<boolean>;
+  /**
+   * Разрешить удалять звонки
+   * @default false
+   */
   allow_delete_call: XmlElem<boolean>;
 }
 
 interface WorkspaceConfigDocumentTaskBlockTaskType {
-  task_type_id: XmlElem<number, TaskTypeCatalogDocumentTopElem>;
+  task_type_id: XmlElem<number | null, TaskTypeCatalogDocumentTopElem>;
 }
 
 interface WorkspaceConfigDocumentTaskBlock {
+  /**
+   * Показывать раздел Задачи
+   * @default false
+   */
   show_task: XmlElem<boolean>;
+  /**
+   * Разрешить создавать задачи
+   * @default false
+   */
   allow_create_task: XmlElem<boolean>;
+  /**
+   * Разрешить редактировать задачи исполнителю
+   * @default false
+   */
   allow_edit_task_executor: XmlElem<boolean>;
+  /**
+   * Разрешить менять статус задачи исполнителю
+   * @default false
+   */
   allow_change_status_task_executor: XmlElem<boolean>;
+  /**
+   * Разрешить удалять задачи автору
+   * @default false
+   */
   allow_delete_task_assigner: XmlElem<boolean>;
+  /**
+   * Разрешить удалять задачи исполнителю
+   * @default false
+   */
   allow_delete_task_executor: XmlElem<boolean>;
-  task_types: XmlMultiElem<WorkspaceConfigDocumentTaskBlockTaskType>;
+  /**
+   * Показывать email в списке сотрудников
+   * @default false
+   */
+  show_email: XmlElem<boolean>;
+  task_types: XmlMultiElem<WorkspaceConfigDocumentTaskBlockTaskType | null>;
+}
+
+interface WorkspaceConfigDocumentWikiBlock {
+  /**
+   * Показывать раздел Пространства знаний
+   * @default false
+   */
+  show_wiki: XmlElem<boolean>;
+  /**
+   * Разрешить создавать пространства знаний
+   * @default false
+   */
+  allow_create_wiki: XmlElem<boolean>;
+  /** Название личного пространства */
+  personal_wiki_name: XmlElem<string | null>;
+  /** Текст при отсутствии личного пространства */
+  personal_wiki_text: XmlElem<string | null>;
+}
+
+interface WorkspaceConfigDocumentServiceBlock {
+  /**
+   * Показывать Сервисы
+   * @default false
+   */
+  show_service: XmlElem<boolean>;
+}
+
+interface WorkspaceConfigDocumentApplicationBlock {
+  /**
+   * Показывать Приложения
+   * @default false
+   */
+  show_application: XmlElem<boolean>;
 }
 
 interface WorkspaceConfigDocumentTimeTrackerBlock {
+  /**
+   * Показывать Учет времени
+   * @default false
+   */
   show_time_tracker: XmlElem<boolean>;
 }
 
 type WorkspaceConfigDocumentTopElem = XmlTopElem &
 ObjectCodeNameBase & {
   Doc: WorkspaceConfigDocument;
+  /**
+   * WorkSpace активен
+   * @default false
+   */
   is_enabled: XmlElem<boolean>;
-  theme_block: XmlElem<WorkspaceConfigDocumentThemeBlock>;
-  labels_file_url: XmlElem<string>;
-  portal_title: XmlElem<string>;
-  favicon_id: XmlElem<number, ResourceCatalogDocumentTopElem>;
-  conversation_block: XmlElem<WorkspaceConfigDocumentConversationBlock>;
-  calendar_block: XmlElem<WorkspaceConfigDocumentCalendarBlock>;
-  task_block: XmlElem<WorkspaceConfigDocumentTaskBlock>;
-  time_tracker_block: XmlElem<WorkspaceConfigDocumentTimeTrackerBlock>;
-  doc_info: XmlElem<DocInfoBase>;
+  theme_block: XmlElem<WorkspaceConfigDocumentThemeBlock | null>;
+  /** Файл с надписями */
+  labels_file_url: XmlElem<string | null>;
+  /** Заголовок портала */
+  portal_title: XmlElem<string | null>;
+  /** Значок веб-сайта (favicon) */
+  favicon_id: XmlElem<number | null, ResourceCatalogDocumentTopElem>;
+  conversation_block: XmlElem<WorkspaceConfigDocumentConversationBlock | null>;
+  calendar_block: XmlElem<WorkspaceConfigDocumentCalendarBlock | null>;
+  task_block: XmlElem<WorkspaceConfigDocumentTaskBlock | null>;
+  wiki_block: XmlElem<WorkspaceConfigDocumentWikiBlock | null>;
+  service_block: XmlElem<WorkspaceConfigDocumentServiceBlock | null>;
+  application_block: XmlElem<WorkspaceConfigDocumentApplicationBlock | null>;
+  time_tracker_block: XmlElem<WorkspaceConfigDocumentTimeTrackerBlock | null>;
+  /** Информация об объекте */
+  doc_info: XmlElem<DocInfoBase | null>;
+  /**
+   * Является системным
+   * @default false
+   */
   is_std: XmlElem<boolean>;
+  /**
+   * Измененный
+   * @default false
+   */
   changed: XmlElem<boolean>;
-  access: XmlElem<AccessDocBase>;
+  /** Доступ */
+  access: XmlElem<AccessDocBase | null>;
+  /** @temp */
+  view: XmlElem<unknown | null>;
 };
 
 type WorkspaceConfigDocument = XmlDocument & {

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

@@ -1,14 +1,42 @@
 type WorkspaceConfigCatalogDocumentTopElem = XmlTopElem &
 ObjectCodeNameBase & {
+  /**
+   * WorkSpace активен
+   * @default false
+   */
   is_enabled: XmlElem<boolean>;
-  labels_file_url: XmlElem<string>;
-  default_theme_id: XmlElem<string, typeof common.workspace_themes>;
+  /** Файл с надписями */
+  labels_file_url: XmlElem<string | null>;
+  /** Тема по умолчанию */
+  default_theme_id: XmlElem<string | null, typeof common.workspace_themes>;
+  /**
+   * Показывать раздел Разговоры
+   * @default false
+   */
   show_conversation: XmlElem<boolean>;
+  /**
+   * Показывать раздел Календарь
+   * @default false
+   */
   show_calendar: XmlElem<boolean>;
+  /**
+   * Показывать раздел Задачи
+   * @default false
+   */
   show_task: XmlElem<boolean>;
-  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>;
   OnBuild(): void;
 };

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

@@ -0,0 +1,78 @@
+interface BmMessageRecipient {
+  /** Сотрудник */
+  person_id: XmlElem<number | null, CollaboratorCatalogDocumentTopElem>;
+  /**
+   * Статус
+   * @default not_read
+   */
+  state_id: XmlElem<string | null, typeof common.message_states>;
+}
+
+interface BmMessageDispRole {
+  id: XmlElem<string | null>;
+}
+
+interface BmMessageReply {
+  message_id: XmlElem<string | null>;
+  /** Блок отвечаемого сообщения */
+  block_message_id: XmlElem<number | null, BlockMessageCatalogDocumentTopElem>;
+}
+
+interface BmMessageForward {
+  message_id: XmlElem<string | null>;
+  /** Блок пересылаемого сообщения */
+  block_message_id: XmlElem<number | null, BlockMessageCatalogDocumentTopElem>;
+  /** Разговор пересылаемого сообщения */
+  conversation_id: XmlElem<number | null, ConversationCatalogDocumentTopElem>;
+}
+
+interface BmMessageView {
+  /**
+   * @temp
+   * @default catalogs
+   */
+  tab_select: XmlElem<string>;
+}
+
+interface BmMessage extends ObjectTypeBase, FileListBase, CatalogListBase {
+  id: XmlElem<string | null>;
+  /** Текст сообщения */
+  text: XmlElem<string | null>;
+  /**
+   * Есть новая реакция
+   * @default false
+   */
+  new_reaction: XmlElem<boolean>;
+  /**
+   * Тип
+   * @default message
+   */
+  type_id: XmlElem<string | null, typeof common.message_types>;
+  /** @default undefined */
+  check_link: XmlElem<string | null>;
+  /**
+   * Статус
+   * @default active
+   */
+  state_id: XmlElem<string | null, typeof common.conversation_message_states>;
+  /** Дата создания */
+  create_date: XmlElem<Date | null>;
+  /** Дата редактирования */
+  edit_date: XmlElem<Date | null>;
+  /** Адресаты */
+  recipients: XmlMultiElem<BmMessageRecipient | null>;
+  disp_roles: XmlMultiElem<BmMessageDispRole | null>;
+  /** Данные по отвечаемому сообщению */
+  reply: XmlElem<BmMessageReply | null>;
+  /** Данные по пересылаемому сообщению */
+  forward: XmlElem<BmMessageForward | null>;
+  /**
+   * Настройки сообщения неактивны
+   * @default false
+   */
+  disabled_data: XmlElem<boolean>;
+  /** Настройки сообщения */
+  data: XmlElem<string | null>;
+  /** @temp */
+  view: XmlElem<BmMessageView | null>;
+}

package/lib/xmldocument/index.d.ts

@@ -55,7 +55,7 @@ interface XmlDocument {
 
   /**
    * Если для формы документа установлен параметр USE-LAST-SAVED-DATA="1",
-   * то данный атрибут доступен в методе {@link OnSave}() документа.
+   * то данный атрибут доступен в методе {@link OnSave} документа.
    * Он устанавливается в соответствии с предыдущей сохраненной копией
    * корневого элемента документа.
    * Атрибут используется, если нужно сравнить предыдущее значение
@@ -114,7 +114,7 @@ interface XmlDocument {
   /**
    * Свойство {@link TempData} содержит объект, в котором можно хранить произвольные данные.
    * Данные хранятся только на время, пока открыт документ.
-   * Может быть использовано, в частности, для передачи данных между {@link OnBeforeSave}() и {@link OnSave}().
+   * Может быть использовано, в частности, для передачи данных между {@link OnBeforeSave} и {@link OnSave}.
    * {@link TempData} представляет из себя стандартный объект в режиме совместимости.
    */
   TempData: Object;
@@ -190,11 +190,11 @@ interface XmlDocument {
    * Устаревший метод.
    * В новой объектной модели используется метод DefaultDb.OpenNewObjectDoc(),
    * который сразу и создает новый объектный документ, и присваивает ему id и url.
-   * Также в новой объектной модели используется метод {@link BindToDbObjectType}().
-   * @param {string | DefaultDb} [database] - Имя базы.
+   * Также в новой объектной модели используется метод {@link BindToDbObjectType}.
+   * @param {string | typeof DefaultDb} [database] - Имя базы.
    * @param {number} [docId=0] - Id объекта.
    */
-  BindToDb(database?: string | DefaultDb, docId?: number): undefined;
+  BindToDb(database?: string | typeof DefaultDb, docId?: number): undefined;
 
   /**
    * Преобразует документ (как правило, вновь созданный) в объектный
@@ -238,7 +238,7 @@ interface XmlDocument {
   FindExtDataElemByFieldID(extID: number): XmlElem<number>;
 
   /**
-   * Дает сигнал потоку, запущенному через {@link EvalThread}() относительно данного документа,
+   * Дает сигнал потоку, запущенному через {@link EvalThread} относительно данного документа,
    * прекратить исполнение.
    *
    * Вызов данного метода не означает, что поток завершится мгновенно,
@@ -333,11 +333,7 @@ interface XmlDocument {
   /**
    * Возвращает элемент документа с полным путем относительно документа.
    * @param {string} path - Путь к элементу (включая корневой элемент).
-   * @param {XmlElem}
-   * @example
-   * ```
-   * doc.SubElem("person.view.last_state_id")
-   * ```
+   * @example doc.SubElem("person.view.last_state_id")
    */
   SubElem<T extends XmlElem<unknown>>(path: string): T;
 
@@ -346,7 +342,6 @@ interface XmlDocument {
    * Если аргумент совпадает с именем дочернего элемента, выдается дочерний элемент.
    * Редко используемая функция.
    * @param {string} elemName - Имя элемента.
-   * @param {XmlElem}
    */
   TopOrChildElem<T extends XmlElem<unknown>>(elemName: string): T;