@wshcmx/types 10.0.0

package/lib/global_settings/index.d.ts

@@ -0,0 +1,278 @@
+// TODO: need ref
+declare namespace global_settings {
+  var first_install: boolean;
+  var branch_code: unknown;
+  var skk_code: string;
+  var old_skk_code: string;
+  var smtp_server: string;
+  var default_exchange_server_id: number | null;
+  var settings: {
+    default_web_design_id: number,
+    web_designs: unknown,
+    portal_base_url: string,
+    use_personal_chat_global_policy: boolean,
+    personal_chat_confirmation_required: boolean,
+    max_message_in_block_count: number,
+    use_queue_in_chat: boolean,
+    auth_check_eval: string,
+    auth_site_access_failed_eval: string,
+    login_case_sensitive: boolean,
+    login_domen_sensitive: boolean,
+    use_auth_session: boolean,
+    auth_session_life_time: number,
+    template_cache_type: unknown,
+    use_web_rules: true,
+    web_rules: {
+      exclude_path_list: string
+    },
+    default_file_source_id: number,
+    search_in_trash: boolean,
+    check_sid: boolean,
+    disp_wellcome_screen: boolean,
+    disp_anonymous_polls: boolean,
+    check_user_required_fields: boolean,
+    required_fields: unknown,
+    web_api_settings: {
+      use_api: boolean,
+      access_person_id: number,
+      allowed_ip: string,
+      filters: unknown
+    },
+    mobile: {
+      document_reader: {
+        menu_code: string,
+        days_credentials_update: unknown,
+        use_favorites: boolean,
+        use_search: boolean,
+        confirmation: string,
+        use_update_stamp: boolean,
+        cs_p: string
+      }
+    },
+    default_contact_type_id: number,
+    default_contact_result_id: number,
+    allow_self_register: boolean,
+    self_register_group_id: unknown,
+    web_banned_self_register: boolean,
+    self_register_disp_custom_elems: boolean,
+    self_register_disp_subs: boolean,
+    self_register_org_id: unknown,
+    self_register_subdivision_id: unknown,
+    self_register_position_name: string,
+    self_register_use_position_commons: boolean,
+    eval_post_registration_script: boolean,
+    post_registration_script: string,
+    eval_prev_registration_script: boolean,
+    prev_registration_script: string,
+    script_create_login: boolean,
+    script_create_password: boolean,
+    vclass_hosts: unknown,
+    library: {
+      options: {
+        ignore_before_first: boolean
+      },
+      cut_markers: unknown
+    },
+    save_exchange_data_files: boolean,
+    auto_exchange_data: boolean,
+    exchange_period: number,
+    url_exchange_results: string,
+    password_format: string,
+    password_auto_rebuild: boolean,
+    pass_validation_formula: string,
+    fill_path_subs: boolean,
+    check_access_on_lists: boolean,
+    save_deleted_in_trash: boolean,
+    fill_path_places: boolean,
+    show_creator_editor_name: boolean,
+    show_creator_in_reports: boolean,
+    save_person_change_log: boolean,
+    script_evaluation_cutoff: number,
+    max_report_visible_rows: number,
+    default_currency: string,
+    default_cost_center_id: number,
+    default_expense_item_id: number,
+    cost_center_priority: string,
+    timezone_id: unknown,
+    auto_select_status_edu_plan: boolean,
+    soft_kill_before_regenerate: boolean,
+    check_wf_access_assessment: boolean,
+    own_org: {
+      name: string,
+      phone: string,
+      email: XmlElem<string>,
+      smtp_server: string,
+      use_smtp_authenticate: boolean,
+      smtp_login: string,
+      smtp_password: string,
+      after_send_action: string,
+      sent_save_hours: number,
+      send_attempt_num: number
+    },
+    default_lng: string,
+    lngs: unknown,
+    recruitment: {
+      default_request_type_id: number,
+      estaff_server_url: string,
+      estaff_login: string,
+      estaff_password: string,
+      estaff_subdivisions_script: string
+    },
+    delete_unused_resource: boolean,
+    admin_not_auth: boolean,
+    default_event_result_type_id: unknown,
+    disp_log_web_request: boolean,
+    log_web_request_rec_unloged: boolean,
+    web_request_logging_str: string,
+    disp_log_debug: boolean,
+    disp_log_mail_trans: boolean,
+    declare_odbc_commant_timeout: number,
+    event_settings: {
+      send_type: string,
+      send_collaborators: boolean,
+      send_bosses: boolean,
+      send_lectors: boolean,
+      send_tutors: boolean,
+      send_event_preparations: boolean,
+      show_result_fields: boolean
+    },
+    not_use_doc_contains: boolean,
+    email_empty_create_notification: boolean,
+    show_all_persons: boolean,
+    websoft_plugin_server: {
+      url: string,
+      login: string,
+      password: string
+    },
+    disp_social_block: boolean,
+    social_avatar_priority: string,
+    portal_tracking_type: string,
+    external_web_players: {
+      ext_x_lite_grid: boolean,
+      ext_hardcore_source: boolean,
+      openurl_eq_openwindow: boolean
+    },
+    key_position_threat_script: string,
+    ppm_matrix: {
+      rows: unknown
+    },
+    statistics: {
+      calculate_statistics: boolean,
+      calculation_period: number
+    },
+    script_queues: {
+      enable_queues: boolean,
+      running_period: number,
+      clear_period: number
+    },
+    digital_signature_control: string,
+    use_time_stamp_server: boolean,
+    time_stamp_server_address: string,
+    use_profiling: boolean,
+    default_tenancy_template_id: number,
+    default_webinar_system_id: number,
+    lds_url_pattern: string,
+    outstaff: {
+      periods: unknown,
+      materials: unknown,
+      outstaff_boss_types: unknown,
+      boss_type_id: number
+    },
+    send_learning_additional_info: boolean,
+    set_st_category: boolean,
+    use_queue_learnings: boolean,
+    project: {
+      options: {
+        use_custom_project_status: boolean,
+        use_custom_project_icon: boolean
+      },
+      project_status_types: object,
+      project_icon_script: string
+    },
+    project_task: {
+      options: {
+        use_custom_project_task_status: boolean,
+        use_custom_project_task_icon: boolean
+      },
+      project_task_status_types: unknown,
+      project_task_icon_script: string
+    },
+    server_agent_time_start: boolean,
+    cl: {
+      use_constants: boolean,
+      use_cache: boolean,
+      access_setting: string
+    },
+    knowlcntrl: {
+      default_expert_id: unknown
+    },
+    brute_password_check: boolean,
+    brute_password_count: unknown,
+    brute_password_period: unknown,
+    lds: {
+      brute_password_check: boolean,
+      brute_password_count: unknown,
+      brute_password_period: unknown
+    },
+    design_vscode_save_default: string,
+    design_vscode_access: string;
+  };
+  var interface_mode: string;
+  var disp_pers: boolean;
+  var disp_pers_settings: boolean;
+  var disp_sub: boolean;
+  var disp_outstaff: boolean;
+  var disp_comp_ben: boolean;
+  var disp_comp_ben_settings: boolean;
+  var disp_dist: boolean;
+  var disp_dist_settings: boolean;
+  var disp_test: boolean;
+  var disp_test_adv: boolean;
+  var disp_test_settings: boolean;
+  var disp_web: boolean;
+  var disp_fin: boolean;
+  var disp_edu: boolean;
+  var disp_edu_settings: boolean;
+  var disp_ass: boolean;
+  var disp_prop: boolean;
+  var disp_admin: boolean;
+  var disp_exs: boolean;
+  var disp_secur: boolean;
+  var disp_recr: boolean;
+  var disp_pwt: boolean;
+  var disp_knowlcntrl: boolean;
+  var disp_knowlcntrl_settings: boolean;
+  var disp_career: boolean;
+  var disp_dnoffice: boolean;
+  var disp_vclass: boolean;
+  var disp_courselab: boolean;
+  var disp_library: boolean;
+  var disp_crm: boolean;
+  var disp_crm_settings: boolean;
+  var disp_game: boolean;
+  var disp_mtenancy: boolean;
+  var disp_prize: boolean;
+  var disp_chatbots: boolean;
+  var disp_mobile: boolean;
+  var disp_proctoring: boolean;
+  var disp_crmsale: boolean;
+  var disp_wiki: boolean;
+  var disp_collaborator_schedule: boolean;
+  var disp_calendar_items: boolean;
+  var disp_project_management: boolean;
+  var disp_continuity: boolean;
+  var disp_courselab_server: boolean;
+  var update_exist_package_obj: boolean;
+  var customer: string;
+  var courses_path: string;
+  var web_path: string;
+  var debug: boolean;
+  var is_demo: boolean;
+  var object_deleted_str: string;
+  var curator_boss_type_id: string;
+  var tutor_boss_type_id: string;
+  var project_manager_type_id: string;
+  var default_contact_type_id: string;
+  var default_contact_result_id: string;
+  var install_stamp: string;
+}

package/lib/http_request/index.d.ts

@@ -0,0 +1,222 @@
+interface IRequestAuthObject {
+  id: XmlElem<number>;
+  login: XmlElem<string>;
+  access_role_id: XmlElem<number, AccessRoleBase>;
+}
+
+/**
+ * Объект Request доступен на сервере xHttp.exe при вызове кода веб-страницы.
+ * Обозначает соответствующий HTTP-запрос к странице.
+ */
+interface Request {
+  /**
+   * Экспериментальный атрибут. Возвращает массив стандартный объектов типа Object,
+   * содержащий копии данных всех действующих web-сессий (объектов Session).
+   * Копируются только поля, содержащие скалярные значения, поля,
+   * содержащие объекты, копируются как undefined.
+   */
+  AllSessions: Session[];
+
+  /**
+   * Возвращает логин пользователя авторизованного запроса.
+   * Если запрос не авторизованный, или атрибут вызывается до авторизации,
+   * возвращается пустая строка.
+   */
+  AuthLogin: string;
+
+  /**
+   * Возвращает объект, соответствующий пользователю авторизованного запроса
+   * от клиентской части (SpXml.exe).
+   */
+  AuthObject: XmlElem<IRequestAuthObject>;
+
+  /**
+   * Возвращает пароль пользователя авторизованного запроса (для basic-авторизации).
+   * Если запрос не авторизованный, или атрибут вызывается до авторизации,
+   * или используется метод авторизации без передачи пароля в открытом виде,
+   * возвращается пустая строка.
+   */
+  AuthPassword: string;
+
+  /**
+   * Возвращает Id пользователя авторизованного запроса.
+   * Для запросов от клиентской части (SpXml.exe) переменная
+   * устанавливается автоматически исходя из результата вызова {@link OnCheckAuth}().
+   * Для запросов к Web-страницы переменная может быть установлена
+   * вручную авторизационным кодом Web-страницы.
+   *
+   * При сохранении на сервере документа, содержащего элемент, содержимое переменной
+   * автоматически записывается в поля creation.user_id и modification.user_id
+   * структуры doc_info, если такие поля присутствуют в документе.
+   */
+  AuthUserID: number;
+
+  /**
+   * Возвращает тело HTTP-запроса в виде строки.
+   */
+  Body: string;
+
+  /**
+   * Возвращает содержимое web-формы запроса, передаваемого через метод POST,
+   * разобранное по полям, в виде стандартного объекта javascript Object.
+   * Если запрос не содержит web-форму, атрибут возвращает ошибку.
+   */
+  Form: Object;
+
+  /**
+   * Возвращает список полей заголовка HTTP-запроса в виде стандартного объекта
+   * javascript Object.
+   */
+  Header: Object;
+
+  /**
+   * Возвращает метод ('GET' или 'POST') текущего HTTP-запроса.
+   */
+  Method: string;
+
+  /**
+   * Возвращает стандартный объект javascript Object, содержащий объединенный
+   * набор полей из атрибутов Form и QueryString.
+   */
+  Query: Object;
+
+  /**
+   * Возвращает содержимое строки параметров url запроса, разобранное по полям,
+   * в виде стандартного объекта javascript Object. Если url не содержит параметров,
+   * возвращаемый пустой объект.
+   */
+  QueryString: Object;
+
+  /**
+   * Возвращает IP адрес, с которого отправлен запрос, в виде строки.
+   */
+  RemoteIP: string;
+
+  /**
+   * Более современный эквивалент атрибута ContentType объекта Response.
+   * Атрибут доступен как на чтение так и на запись.
+   * Содержит значение заголовка "Content-Type" ответа на текущий запрос. HTTP.
+   * Если заголовок уже был отправлен, попытка изменения атрибута возвращает ошибку.
+   */
+  RespContentType: string;
+
+  /**
+   * Возвращает объект типа Stream, в который можно писать данные ответа HTTP.
+   * Если заголовок ответа еще не был отправлен к моменту первого обращения
+   * к атрибуту, отправляется ответ HTTP 200.
+   */
+  RespStream: Stream;
+
+  /**
+   * Возвращает объект Session, привязанный к текущему запросу.
+   * Если в коде Web-страницы объект Session доступен через глобальную
+   * переменную с таким же именем, то, например, внутри {@link OnWebRequest}()
+   * единственный способ получить ссылку на этот объект - это обратиться
+   * через Request.Session.
+   */
+  Session: Session;
+
+  /**
+   * Возвращает запрашиваемый url текущего HTTP-запроса.
+   */
+  Url: string;
+
+  /**
+   * Возвращает хост (адрес сервера и, если есть - порт) запрашиваемого
+   * url текущего HTTP-запроса. Данный атрибут доступен также на запись,
+   * что используется, как правило, внутри вызова {@link OnWebRequest}() для
+   * внутреннего перенаправления старых url на новые.
+   */
+  UrlHost: string;
+
+  /**
+   * Возвращает строку параметров (param1=value1&param2=value2&...)
+   * запрашиваемого url текущего HTTP-запроса. Данный атрибут доступен
+   * также на запись, что используется, как правило, внутри вызова {@link OnWebRequest}()
+   * для внутреннего перенаправления старых url на новые.
+   */
+  UrlParam: string;
+
+  /**
+   * Возвращает путь запрашиваемого url текущего HTTP-запроса.
+   * Данный атрибут доступен также на запись, что используется,
+   * как правило, внутри вызова {@link OnWebRequest}() для внутреннего
+   * перенаправления старых url на новые.
+   */
+  UrlPath: string;
+
+  /**
+   * Добавляет или заменяет поле заголовка HTTP-ответа. Если заголовок уже был отправлен, метод возвращает ошибку.
+   * @param {string} fieldName - Имя поля.
+   * @param {string} fieldValue - Значение поля.
+   * @param {boolean} replaceExisting - Заменить существующее.
+   * Заменить значение существующего поля с таким же именем, если есть.
+   * Необязательный аргумент, по умолчанию равен true.
+   */
+  AddRespHeader(fieldName: string, fieldValue: string, replaceExisting?: boolean): void;
+
+  /**
+   * Вызывает проверку авторизации запроса по стандартному методу авторизации
+   * для рабочего места (через вызов OnCheckAuth).
+   */
+  CheckLdsAuth(): void;
+
+  /**
+   * Выполняет код указанного фрагмента Web-страницы с записью результата
+   * в текущий HTTP-ответ. Метод используется для включений фрагментов,
+   * общих для различных видов страниц.
+   * @param {string} path - Путь к включаемому фрагменту.
+   * Если указан относительный путь (что как правило и делается),
+   * путь считается относительно родительской к текущей странице директории.
+   * @param {boolean} allowSubCancel - Разрешать завершение код с отменой (Bool).
+   * Если true, то в случае, если код фрагмента завершается исключением типа {@link Cancel}(),
+   * метод все равно завершается успешно. Необязательный аргумент,
+   * по умолчанию равен false. Используется, для удобства завершения фрагментов
+   * кода через функцию {@link Cancel}(), поскольку использовать return непосредственно
+   * в коде фрагмента страницы невозможно.
+   */
+  Execute(path: string, allowSubCancel?: boolean): void;
+
+  /**
+   * Вызывает отправку статуса HTTP 404 "Not found" (объект не найден).
+   * Если заголовок уже был отправлен, метод возвращает ошибку.
+   */
+  HandleNotFound(): void;
+
+  /**
+   * Вызывает отправку статуса HTTP 301 "Object Moved" (постоянное перенаправление).
+   * Если заголовок уже был отправлен, метод возвращает ошибку.
+   * @param {string} redirectUrl - Url, на которое происходит перенаправление.
+   */
+  PermanentRedirect(redirectUrl: string): void;
+
+  /**
+   * Вызывает отправку статуса HTTP 302 "Object Moved" (перенаправление).
+   * Если заголовок уже был отправлен, метод возвращает ошибку.
+   * @param {string} redirectUrl - Url, на которое происходит перенаправление.
+   */
+  Redirect(redirectUrl: string): void;
+
+  /**
+   * Возвращает статус HTTP-ответа. Если заголовок уже был отправлен,
+   * метод возвращает ошибку.
+   * @param {number} statusCode - Трехзначный код статуса.
+   * @param {string} statusDesc - Наименование статуса.
+   * @example Request.SetRespStatus( 500, 'Invalid server state' );
+   */
+  SetRespStatus(statusCode: number, statusDesc: string): void;
+
+  /**
+   * Используется для проверки авторизации внутри Web-страницы.
+   * Вызывает отправку статуса HTTP 401 "Authorization required".
+   * Код Web-страницы обычно вызывает данный метод, если Request.AuthLogin
+   * возвращает пустую строку, либо указаны неверные авторизационные данные.
+   * Если заголовок уже был отправлен, метод возвращает ошибку.
+   * @param {string} options - Список опций вида 'name1=value1;name2=value2;...'.
+   * Допустимые значения: basic=1, ntlm=1 - разрешенные виды авторизации.
+   */
+  SetWrongAuth(options: string): void;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+declare const Request: Request;

package/lib/http_response/index.d.ts

@@ -0,0 +1,136 @@
+/**
+ * Объект Response доступен на сервере xHttp.exe при вызове кода веб-страницы.
+ * Обозначает ответ сервера к соответствующему HTTP-запросу к странице.
+ * В современных приложениях объект Response использовать не рекомендуется,
+ * поскольку он доступен только в ASP-коде страницы, но не доступен, например, в коде {@link OnWebRequest}().
+ * Вместо этого, рекомендуется использовать аналогичные методы объекта Request,
+ * которые позже были перенесены из объекта Response.
+ */
+interface Response {
+  /**
+   * Более старый эквивалент атрибута RespContentType объекта Request.
+   * Атрибут доступен как на чтение так и на запись.
+   * Содержит значение заголовка "Content-Type" ответа на текущий запрос. HTTP.
+   * Если заголовок уже был отправлен, попытка изменения атрибута возвращает ошибку.
+   * @returns String.
+   */
+  ContentType: string;
+
+  /**
+   * Возвращает исходный объект Request, к которому относится данный объект.
+   */
+  OrigRequest: Request;
+
+  /**
+   * Более старый эквивалент атрибута RespStream объекта Request.
+   * Возвращает объект типа Stream, в который можно писать данные ответа HTTP.
+   * Если заголовок ответа еще не был отправлен к моменту первого обращения к атрибуту,
+   * отправляется ответ HTTP 200.
+   */
+  Stream: Stream;
+
+  /**
+   * Атрибут доступен как на чтение так и на запись.
+   * Содержит текущее значение режима записи тела ответа.
+   * Допустимые значения: "buffered" - при записи тела ответа маленькими порциями,
+   * данные накапливаются до определенной величины, и после этого большими
+   * частями отправляются по сети. Данное значение устанавливается по умолчанию
+   * для ASP-страниц.
+   * "direct" - записываемый данные сразу отправляются в сеть.
+   * Используется в очень редких случаях, как правило при отправке бинарных данных.
+   * "single - данные накапливаются в буфере до завершения формирования
+   * полного тела ответа, после чего целиком отправляются в сеть.
+   * Используется, как правило при отправке формализованных данных
+   * (например XML), с тем, чтобы в случае возникновения ошибки была возможность
+   * сформировать ответ HTTP 500, что было бы невозможно, если часть данных уже
+   * была отправлена вместе с кодом HTTP 200.
+   */
+  WriteMode: string;
+
+  /**
+   * Более старый эквивалент метода {@link AddRespHeader}() объекта Request.
+   * Добавляет или заменяет поле заголовка HTTP-ответа.
+   * Если заголовок уже был отправлен, метод возвращает ошибку.
+   * @param {string} fieldName - Имя поля.
+   * @param {string} fieldValue - Значение поля.
+   * @param {boolean} replaceExisting - Заменить существующее.
+   * Заменить значение существующего поля с таким же именем, если есть.
+   * Необязательный аргумент, по умолчанию равен true.
+   */
+  AddHeader(fieldName: string, fieldValue: string, replaceExisting?: boolean): void;
+
+  /**
+   * Выполняет проверку по условию поля If-Modified-Since HTTP-запроса
+   * для заданной даты модификации файла. Если поле If-Modified-Since
+   * присутствует в запросе и его значение меньше либо равно заданной дате,
+   * метод возвращает ошибку HTTP 304 Not modified и завершается с
+   * исключением типа {@link Cancel}(), в противном случае метод не производит никаких действий.
+   * Метод обычно используется для скриптов, возвращающих файлы,
+   * хранящиеся вне файловой системы, например внутри базы данных приложения.
+   * @param {Date} date - Дата последнего изменения файла.
+   */
+  CheckModified(date: Date): void;
+
+  /**
+   * Отправляет содержимое файла, как если бы файл был запрошен напрямую.
+   * При этом отправляется правильный Content-Type и Last-Modified.
+   * @param {string} filePath - Путь к файлу или url файла.
+   */
+  HandleStaticFile(filePath: string): void;
+
+  /**
+   * Более старый эквивалент метода {@link Redirect}() объекта Request.
+   * Вызывает отправку статуса HTTP 302 "Object Moved" (перенаправление).
+   * Если заголовок уже был отправлен, метод возвращает ошибку.
+   * @param {string} redirectUrl - Url, на которое происходит перенаправление.
+   */
+  Redirect(redirectUrl: string): void;
+
+  /**
+   * Более старый эквивалент метода {@link SetRespStatus}() объекта {@link Request}.
+   * Возвращает статус HTTP-ответа. Если заголовок уже был отправлен,
+   * метод возвращает ошибку.
+   * @param {number} statusCode - Трехзначный код статуса.
+   * @param {string} statusDesc - Наименование статуса.
+   * Response.SetRespStatus( 500, 'Invalid server state' );.
+   */
+  SetRespStatus(statusCode: number, statusDesc: string): void;
+
+  /**
+   * Более старый эквивалент метода {@link SetWrongAuth}() объекта {@link Request}.
+   * Используется для проверки авторизации внутри Web-страницы.
+   * Вызывает отправку статуса HTTP 401 "Authorization required".
+   * Код Web-страницы обычно вызывает данный метод, если Request.AuthLogin
+   * возвращает пустую строку, либо указаны неверные авторизационные данные.
+   * Если заголовок уже был отправлен, метод возвращает ошибку.
+   * @param {string} options - Список опций вида 'name1=value1;name2=value2;...'.
+   * Допустимые значения: basic=1, ntlm=1 - разрешенные виды авторизации.
+   */
+  SetWrongAuth(options: string): void;
+
+  /**
+   * Записывает содержимое строки в тело HTTP-ответа.
+   * Содержимое предварительно накапливается в буфере,
+   * либо немедленно отправляется в сеть в зависимости от значение атрибута {@link WriteMode}.
+   * Именно в это метод транслируется конструкция вида <%=xxx%> в ASP-подобных страницах.
+   * @param {T} payload - Строка с данными.
+   * @param {boolean} encode - Маскировать передаваемые данные по правилам HTML (Bool).
+   * Необязательный атрибут, по умолчанию false.
+   */
+  Write<T>(payload: T, encode?: boolean): void;
+
+  /**
+   * Записывает содержимое бинарного объекта в тело HTTP-ответа.
+   * Содержимое предварительно накапливается в буфере, либо немедленно
+   * отправляется в сеть в зависимости от значение атрибута WriteMode.
+   * Данный метод используется редко по сравнению с методом {@link Write}(),
+   * особенно после того, как объекты XmlElem типа "string" и "binary"
+   * стали вести себя одинаково.
+   * @param {string|Binary} data - Объект типа XmlElem типа "string" и "binary",
+   * либо объект типа Binary (Object).
+   */
+  WriteBinary(data: XmlElem<string> | Binary): void;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+declare const Response: Response;