@wshcmx/types 10.0.0 → 11.0.0-rc.1

package/lib/database/index.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Объект, обозначающий базу данных приложения.
+ * Обычно доступен в единственном экземпляре через глобальную переменную {@link DefaultDb}.
+ */
+interface Database {
+    Name: string;
+    UseObjectTypes: boolean;
+    UseSqlStorage: boolean;
+    UseFtV2: boolean;
+    SqlConnection: never;
+    IsShared: boolean;
+    /** /WebsoftServer/wt_data. */
+    StorageDirectory: string;
+    ObjectForms: unknown[];
+    SharedDocs: Object;
+    // HostDir: T;
+    RegisterObjectType(urlScheme: string, object: Object): void;
+    RegisterCatalog(urlScheme: string): never | undefined;
+    OpenObjectDoc<T extends XmlDocument>(catalogName: string, id: number): T;
+    OpenNewObjectDoc<T extends XmlDocument>(objectName: string): T;
+    DeleteObjectDoc(objectName: string, objectId: number, bool?: boolean): void;
+    ChangeObjectFields(arg: object): object;
+    UpdateObjectSecondaryData(arg: object): object;
+
+    /**
+     * Возвращает объект типа XmlForm с формой данных объекта базы с заданным именем.
+     * @param {string} objectName - Имя объекта.
+     * @example DefaultDb.GetObjectForm("vacancy");
+     * @see {@link GetOptObjectForm}
+     */
+    GetObjectForm<T>(objectName: string): T;
+
+    /**
+     * Возвращает url формы данных объекта базы с заданным именем.
+     * @param {string} objectName - Имя объекта.
+     * @example DefaultDb.GetObjectFormUrl("vacancy");
+     * @see {@link GetObjectForm}
+     */
+    GetObjectFormUrl<T>(objectName: string): T;
+
+    /**
+     * Возвращает объект типа XmlForm с формой данных объекта базы с заданным именем.
+     * Если объект с данным именем не зарегистрирован в структуре базы данных, возвращает undefined.
+     * @param {string} objectName - Имя объекта.
+     * @example DefaultDb.GetObjectForm("vacancy");
+     * @see {@link GetObjectForm}
+     */
+    GetOptObjectForm<T>(objectName: string): T;
+
+    GetOptCatalog<T>(catalogName: string): T;
+    GetRecordPrimaryObjectUrl(object: object): string;
+    RunSql(cmd: string): unknown;
+}
+
+ 
+declare const Database: Database;
+
+declare const DefaultDb: Database;

package/lib/date/index.d.ts

@@ -1,4 +1,4 @@
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 interface Date { }
 
 interface DateConstructor {
@@ -7,5 +7,7 @@ interface DateConstructor {
   (): Date;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-redeclare
+ 
 declare let Date: DateConstructor;
+/** Текущая дата системы время системы. */
+declare let CurDate: Date;

package/lib/error/index.d.ts

@@ -11,8 +11,6 @@ interface ErrorConstructor {
 /**
  * @param {string} str - Строка с текстом ошибки.
  * @returns String
- * UserError(str).
  */
-// eslint-disable-next-line @typescript-eslint/no-redeclare
+
 declare let Error: ErrorConstructor;
-declare let UserError: ErrorConstructor;

package/lib/eslint.config.js

@@ -0,0 +1,47 @@
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import jsdoc from "eslint-plugin-jsdoc";
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  tseslint.configs.recommended,
+  {
+    plugins: {
+      "jsdoc": jsdoc
+    },
+    rules: {
+      "@typescript-eslint/no-wrapper-object-types": "off",
+      "jsdoc/check-alignment": "error",
+      "jsdoc/check-indentation": "error",
+      "jsdoc/check-param-names": "error",
+      "jsdoc/check-property-names": "error",
+      "jsdoc/check-types": "error",
+      "jsdoc/no-blank-block-descriptions": "error",
+      "jsdoc/no-multi-asterisks": ["error", { "allowWhitespace": true }],
+      "jsdoc/require-asterisk-prefix": "error",
+      "jsdoc/require-description": "error",
+      "jsdoc/require-hyphen-before-param-description": "error",
+      "jsdoc/require-jsdoc": "error",
+      "jsdoc/require-param": "error",
+      "jsdoc/require-param-description": "error",
+      "jsdoc/require-param-name": "error",
+      "jsdoc/require-param-type": "error",
+      "jsdoc/check-access": "error",
+      "jsdoc/check-values": "error",
+      "jsdoc/empty-tags": "error",
+      "jsdoc/implements-on-classes": "error",
+      "jsdoc/multiline-blocks": "error",
+      "jsdoc/require-property": "error",
+      "jsdoc/require-property-description": "error",
+      "jsdoc/require-property-name": "error",
+      "jsdoc/require-property-type": "error",
+      "jsdoc/require-returns": "error",
+      "jsdoc/require-returns-check": "error",
+      "jsdoc/require-returns-description": "error",
+      "jsdoc/require-returns-type": "error",
+      "jsdoc/require-yields": "error",
+      "jsdoc/require-yields-check": "error",
+      "jsdoc/tag-lines": "error"
+    }
+  }
+);

package/lib/filestream/index.d.ts

@@ -10,5 +10,5 @@ interface FileStreamConstructor {
   new(url: string, options?: IFileStreamOptions): FileStream;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-redeclare
+ 
 declare const FileStream: FileStreamConstructor;

package/lib/function/index.d.ts

@@ -1,9 +1,10 @@
-/* eslint-disable @typescript-eslint/no-empty-interface */
+/* eslint-disable @typescript-eslint/no-empty-object-type */
+ 
 interface Function { }
 interface FunctionConstructor { }
 
 declare interface CallableFunction extends Function { }
 declare interface NewableFunction extends Function { }
 
-// eslint-disable-next-line @typescript-eslint/no-redeclare
+ 
 declare let Function: FunctionConstructor;

package/lib/global_settings/index.d.ts

@@ -1,12 +1,12 @@
 // 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: {
+  let first_install: boolean;
+  let branch_code: unknown;
+  let skk_code: string;
+  let old_skk_code: string;
+  let smtp_server: string;
+  let default_exchange_server_id: number | null;
+  let settings: {
     default_web_design_id: number,
     web_designs: unknown,
     portal_base_url: string,
@@ -217,62 +217,62 @@ declare namespace global_settings {
     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;
+  let interface_mode: string;
+  let disp_pers: boolean;
+  let disp_pers_settings: boolean;
+  let disp_sub: boolean;
+  let disp_outstaff: boolean;
+  let disp_comp_ben: boolean;
+  let disp_comp_ben_settings: boolean;
+  let disp_dist: boolean;
+  let disp_dist_settings: boolean;
+  let disp_test: boolean;
+  let disp_test_adv: boolean;
+  let disp_test_settings: boolean;
+  let disp_web: boolean;
+  let disp_fin: boolean;
+  let disp_edu: boolean;
+  let disp_edu_settings: boolean;
+  let disp_ass: boolean;
+  let disp_prop: boolean;
+  let disp_admin: boolean;
+  let disp_exs: boolean;
+  let disp_secur: boolean;
+  let disp_recr: boolean;
+  let disp_pwt: boolean;
+  let disp_knowlcntrl: boolean;
+  let disp_knowlcntrl_settings: boolean;
+  let disp_career: boolean;
+  let disp_dnoffice: boolean;
+  let disp_vclass: boolean;
+  let disp_courselab: boolean;
+  let disp_library: boolean;
+  let disp_crm: boolean;
+  let disp_crm_settings: boolean;
+  let disp_game: boolean;
+  let disp_mtenancy: boolean;
+  let disp_prize: boolean;
+  let disp_chatbots: boolean;
+  let disp_mobile: boolean;
+  let disp_proctoring: boolean;
+  let disp_crmsale: boolean;
+  let disp_wiki: boolean;
+  let disp_collaborator_schedule: boolean;
+  let disp_calendar_items: boolean;
+  let disp_project_management: boolean;
+  let disp_continuity: boolean;
+  let disp_courselab_server: boolean;
+  let update_exist_package_obj: boolean;
+  let customer: string;
+  let courses_path: string;
+  let web_path: string;
+  let debug: boolean;
+  let is_demo: boolean;
+  let object_deleted_str: string;
+  let curator_boss_type_id: string;
+  let tutor_boss_type_id: string;
+  let project_manager_type_id: string;
+  let default_contact_type_id: string;
+  let default_contact_result_id: string;
+  let install_stamp: string;
 }

package/lib/http_request/index.d.ts

@@ -168,7 +168,7 @@ interface Request {
    * @param {string} path - Путь к включаемому фрагменту.
    * Если указан относительный путь (что как правило и делается),
    * путь считается относительно родительской к текущей странице директории.
-   * @param {boolean} allowSubCancel - Разрешать завершение код с отменой (Bool).
+   * @param {boolean} allowSubCancel - Разрешать завершение код с отменой.
    * Если true, то в случае, если код фрагмента завершается исключением типа {@link Cancel}(),
    * метод все равно завершается успешно. Необязательный аргумент,
    * по умолчанию равен false. Используется, для удобства завершения фрагментов
@@ -218,5 +218,5 @@ interface Request {
   SetWrongAuth(options: string): void;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-redeclare
+
 declare const Request: Request;

package/lib/http_response/index.d.ts

@@ -2,7 +2,7 @@
  * Объект Response доступен на сервере xHttp.exe при вызове кода веб-страницы.
  * Обозначает ответ сервера к соответствующему HTTP-запросу к странице.
  * В современных приложениях объект Response использовать не рекомендуется,
- * поскольку он доступен только в ASP-коде страницы, но не доступен, например, в коде {@link OnWebRequest}().
+ * поскольку он доступен только в ASP-коде страницы, но не доступен, например, в коде {@link OnWebRequest}.
  * Вместо этого, рекомендуется использовать аналогичные методы объекта Request,
  * которые позже были перенесены из объекта Response.
  */
@@ -48,7 +48,7 @@ interface Response {
   WriteMode: string;
 
   /**
-   * Более старый эквивалент метода {@link AddRespHeader}() объекта Request.
+   * Более старый эквивалент метода {@link AddRespHeader} объекта Request.
    * Добавляет или заменяет поле заголовка HTTP-ответа.
    * Если заголовок уже был отправлен, метод возвращает ошибку.
    * @param {string} fieldName - Имя поля.
@@ -64,7 +64,7 @@ interface Response {
    * для заданной даты модификации файла. Если поле If-Modified-Since
    * присутствует в запросе и его значение меньше либо равно заданной дате,
    * метод возвращает ошибку HTTP 304 Not modified и завершается с
-   * исключением типа {@link Cancel}(), в противном случае метод не производит никаких действий.
+   * исключением типа {@link Cancel}, в противном случае метод не производит никаких действий.
    * Метод обычно используется для скриптов, возвращающих файлы,
    * хранящиеся вне файловой системы, например внутри базы данных приложения.
    * @param {Date} date - Дата последнего изменения файла.
@@ -79,7 +79,7 @@ interface Response {
   HandleStaticFile(filePath: string): void;
 
   /**
-   * Более старый эквивалент метода {@link Redirect}() объекта Request.
+   * Более старый эквивалент метода {@link Redirect} объекта Request.
    * Вызывает отправку статуса HTTP 302 "Object Moved" (перенаправление).
    * Если заголовок уже был отправлен, метод возвращает ошибку.
    * @param {string} redirectUrl - Url, на которое происходит перенаправление.
@@ -87,17 +87,17 @@ interface Response {
   Redirect(redirectUrl: string): void;
 
   /**
-   * Более старый эквивалент метода {@link SetRespStatus}() объекта {@link Request}.
+   * Более старый эквивалент метода {@link SetRespStatus} объекта {@link Request}.
    * Возвращает статус HTTP-ответа. Если заголовок уже был отправлен,
    * метод возвращает ошибку.
    * @param {number} statusCode - Трехзначный код статуса.
    * @param {string} statusDesc - Наименование статуса.
-   * Response.SetRespStatus( 500, 'Invalid server state' );.
+   * @example Response.SetRespStatus( 500, "Invalid server state");
    */
   SetRespStatus(statusCode: number, statusDesc: string): void;
 
   /**
-   * Более старый эквивалент метода {@link SetWrongAuth}() объекта {@link Request}.
+   * Более старый эквивалент метода {@link SetWrongAuth} объекта {@link Request}.
    * Используется для проверки авторизации внутри Web-страницы.
    * Вызывает отправку статуса HTTP 401 "Authorization required".
    * Код Web-страницы обычно вызывает данный метод, если Request.AuthLogin
@@ -114,7 +114,7 @@ interface Response {
    * либо немедленно отправляется в сеть в зависимости от значение атрибута {@link WriteMode}.
    * Именно в это метод транслируется конструкция вида <%=xxx%> в ASP-подобных страницах.
    * @param {T} payload - Строка с данными.
-   * @param {boolean} encode - Маскировать передаваемые данные по правилам HTML (Bool).
+   * @param {boolean} encode - Маскировать передаваемые данные по правилам HTML.
    * Необязательный атрибут, по умолчанию false.
    */
   Write<T>(payload: T, encode?: boolean): void;
@@ -123,14 +123,13 @@ interface Response {
    * Записывает содержимое бинарного объекта в тело HTTP-ответа.
    * Содержимое предварительно накапливается в буфере, либо немедленно
    * отправляется в сеть в зависимости от значение атрибута WriteMode.
-   * Данный метод используется редко по сравнению с методом {@link Write}(),
+   * Данный метод используется редко по сравнению с методом {@link Write},
    * особенно после того, как объекты XmlElem типа "string" и "binary"
    * стали вести себя одинаково.
-   * @param {string|Binary} data - Объект типа XmlElem типа "string" и "binary",
-   * либо объект типа Binary (Object).
+   * @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;

package/lib/listitem/index.d.ts

@@ -0,0 +1,66 @@
+type ListItem = {
+  /**
+   * Возвращает колонку (объект типа ScreenItem), по которой в данный момент осуществляется сортировка.
+   */
+  CurSortColumn: Object;
+
+  /**
+   * Возвращает true если в списке выделен хотя бы один элемент.
+   */
+  HasSel: boolean;
+
+  /**
+   * Возвращает true если в списке выделен только один элемент.
+   */
+  HasSingleSel: boolean;
+
+  /**
+   * Возвращает массив всех подэлементов типа ROW.
+   */
+  Rows: ScreenItem[];
+
+  /**
+   * Возвращает выделенный элемент.
+   */
+  SelRow: ScreenItem;
+
+  /**
+   * Возвращает массив выделенных объектов.
+   */
+  SelRows: ScreenItem[];
+
+  /**
+   * Сбрасывает все выделения строк в списке.
+   */
+  ClearSel(): unknown;
+
+  GetCurCodeSortInfo(): undefined;
+
+  /**
+   * Возвращает номер колонки (нумерация начинается с нуля), по которой в данный момент осуществляется сортировка.
+   * @returns {number}
+   */
+  GetCurSortColumnIndex(): number;
+
+  GetCurSortDir(): undefined;
+
+  GetCurXQuerySortInfo(): undefined;
+
+  /**
+   * Возвращает имя переменной в сокращенной записи LIST.
+   * По умолчанию - "ListElem".
+   * Для остальных списков возвращает undefined.
+   * @returns {string | undefined}
+   */
+  LoopVarName(): string | undefined;
+
+  /**
+   * Сдвигает выделение в списке на величину переданного аргумента.
+   * Если в списке нет выделенных строк, считает, что была выделена первая строка.
+   * Обычно используется, чтобы переместить выделения на следующую либо предыдущую строку (значение delta 1 или -1).
+   */
+  MoveSel(delta: number): unknown;
+};
+
+ 
+declare const ListItem: ListItem;

package/lib/math/index.d.ts

@@ -1,28 +1,28 @@
 interface Math {
   /**
    * Округление значения числового выражения к ближайшему целому.
-   * @param number - Число, округляемое до ближайшего целого (Real).
+   * @param {number} number - Число, округляемое до ближайшего целого.
    */
   round(number: number): number;
 
   /**
    * Возвращает квадратный корень числа .
-   * @param number - Числовое выражение (Real).
+   * @param {number} number - Числовое выражение.
    */
   sqrt(number: number): number;
 
   /**
    * Округляет аргумент до ближайшего большего целого.
-   * @param number - Числовое выражение (Real).
+   * @param {number} number - Числовое выражение.
    */
   ceil(number: number): number;
 
   /**
    * Возвращает абсолютное значение числа.
-   * @param number - Числовое выражение (Real).
+   * @param {number} number - Числовое выражение.
    */
   abs(number: number): number;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-redeclare
+
 declare const Math: Math;