@wshcmx/types 11.0.0-beta1 → 11.0.9

package/lib/screenitem/index.d.ts

@@ -1,6 +1,199 @@
 type ScreenItem = {
+  /**
+   * Работает только для элементов типа SELECTOR, и возвращает элемент, который в этот SELECTOR сейчас загружен.
+   */
+  ActiveElem: ScreenItem;
 
+  /**
+   * Возвращает объект, содрежащий экранное окружение для данного элемента.
+   * Экранное окружение содрежит переменные всех LOOP, внутри которых данный элемент не находится.
+   * Используется, например, для определения, к какому элементу относится выделенная строка в списке.
+   * @example curElem = List.SelRow.Env.ListElem;
+   */
+  Env: XmlElem<unknown>;
+
+  /**
+   * Узкоспециализированный, редко используемый атрибут.
+   * Возвращает true, если у экранного элемента в форме описаны CHECK-VALUE-ACTION или SET-VALUE-ACTION, и false, если нет.
+   * Используется для построения сложных элементов управления, например object_selector, где нужно решить,
+   * делать или не делать обновление экрана.
+   */
+  HasSetValueAction: boolean;
+
+  /**
+   * Возвращает url картинки, определенной в том или ином элементе экрана.
+   * @example <ROW IMAGE-URL-EXPR="ListElem.ImageUrl" DELETE-ACTION="">
+   */
+  ImageUrl: string;
+
+  /**
+   * Возвращает true, если ENABLE-EXPR возрващает true, и false - если нет.
+   * Если атрибута ENABLE-EXPR нет у данного элемента, то IsEnabled всегда возвращает true.
+   * @example
+   * ```
+   * <EDIT SOURCE="Ps" ENABLE-EXPR="GetSampleItem().IsEnabled" DIR-PATH="1"/>
+   * <EDIT SOURCE="Ps.length" WIDTH="6zr" UPDATE-ACTION="Parent.ExecUpdateAction();" ENABLE-EXPR="Parent.IsEnabled"/>
+   * ```
+   */
+  IsEnabled: boolean;
+
+  /**
+   * Работает только для элемента типа LOOP, и возвращает массив элементов, который используется для организации цикла.
+   * Массив, который вычисляется в атрибуте EXPR.
+   */
+  LoopArray: unknown[];
+
+  /**
+   * Возвращает имя (NAME) элемента.
+   */
+  Name: string;
+
+  /**
+   * Родительский элемент данного элемента экрана.
+   */
+  Parent: ScreenItem | typeof Screen;
+
+  /**
+   * Возвращает корневой объект элемента экрана.
+   */
+  Ps: XmElem<unknown>;
+
+  /**
+   * Узкоспециализированный, редко используемый атрибут.
+   */
+  PsStrict: unknown;
+
+  /**
+   * Возвращает экран, к которому относится данный элемент.
+   */
+  Screen: typeof Screen;
+
+  /**
+   * Возвращает источник (SOURCE) элемента.
+   */
+  Source: unknown;
+
+  /**
+   * Возвращает описание местоположения элемента экранной формы данного элемента экрана в исходном коде, например "x-app://rcr/vacancy.xms, line 218".
+   * Обычно используется в отладочных целях, либо для выдачи сообщения об ошибке.
+   */
+  SourceDesc: string;
+
+  /**
+   * Возвращает заголовок (LABEL-TITLE или LABEL-TITLE-EXPR) элемента.
+   */
+  Title: string;
+
+  /**
+   * Возваращает тип (TYPE) элемента.
+   */
+  Type: string;
+
+  /**
+   * Вызывает принудительное выполнение кода, описанного у элемента в атрибуте UPDATE-ACTION.
+   */
+  ExecUpdateAction(): unknown;
+
+  /**
+   * Находит вышестоящий элемент (любого уровня) с заданным типом. Если такого элемента нет - возвращется undefined.
+   * @param {string} strType - Тип элемента.
+   */
+  FindOptUpperItemByType(strType: string): ScreenItem | undefined;
+
+  /**
+   * Возвращает подчиненный элемент (любого уровня вложенности) с указанным именем.
+   * Если элемент не найден - возвращается ошибка.
+   * @param {string} itemName - Наименование элемента.
+   * @returns {ScreenItem} - Элемент экрана.
+   */
+  FindSubItem(itemName: string): ScreenItem | never;
+
+  /**
+   * @experimental
+   * Экспериментальный метод.
+   */
+  FindSubItemByKey(): unknown;
+
+  /**
+   * Возвращает подчиненный элемент (любого уровня вложенности) с указанным значением атрибута SOURCE.
+   * Если элемент не найден - возвращается ошибка.
+   * @param {strig} strSoure - Значение атрибута SOURCE.
+   */
+  FindSubItemBySource(strSoure: string): unknown | never;
+
+  /**
+   * Возвращает подчиненный элемент (любого уровня вложенности) с указанным типом.
+   * Если элемент не найден - возвращается ошибка.
+   * @param {string} strType - Тип элемента.
+   * @example var label = GetSampleItem().FindSubItemByType("LABEL");
+   */
+  FindSubItemByType(strType: string): ScreenItem | never;
+
+  /**
+   * Работает только у элементов типа HYPER, осуществляет вставку заданной строки текста в текущую позицию курсора.
+   * @param {string} str - Строка для вставки.
+   */
+  InsertHtml(str: string): unknown;
+
+  /**
+   * Работает только у элементов типа EDIT, осуществляет вставку заданной строки текста в текущую позицию курсора.
+   * @param {string} strTxt - Cтрока для вставки.
+   * @example edit.InsertText("<%=" + ListElem.value + "%>");
+   */
+  InsertText(strTxt: string): unknown;
+
+  /**
+   * Возвращает true, если у элмента PASSIVE="1", и false - если нет.
+   * Если атрибута PASSIVE нет у данного элемента, то IsPassive возвращает true.
+   */
+  IsPassive(): boolean;
+
+  /**
+   * Возвращает true, если READ-ONLY или READ-ONLY-EXPR возрващает true, и false - если нет.
+   * Если атрибутов READ-ONLY и READ-ONLY-EXPR нет у данного элемента, то IsReadOnly всегда возвращает true.
+   * @example
+   * ```
+   * <BUTTON IMAGE-URL="//base_pict/dots.ico" STD-MARGINS="0" ACTION="Ps = Screen.AskColor(Ps); Ps.Doc.SetChanged(true);" ENABLE-EXPR="! GetSampleItem().IsReadOnly"/>
+   * ```
+   */
+  IsReadOnly(): boolean;
+
+  /**
+   * @experimental
+   * Экспериментальный метод.
+   */
+  MakeReport(): unknown;
+
+  /**
+   * Работает только для элемента типа EDIT с атибутом RICH-EDIT, устанавливает флаг измененности.
+   * @param {boolean} isChanged - Значение флага измененности.
+   */
+  SetChanged(isChanged: boolean): unknown;
+
+  /**
+   * Устанавливает экранный фокус на данный элемент экрана.
+   * Работает на тех элементах, на которые можно ставить фокус.
+   */
+  SetFocus(): unknown;
+
+  /**
+   * Вызывает изменение значение источника (SOURCE) у элемента.
+   * @param value - Новое заначение источника
+   * @example GetSampleItem().SetSourceValue(newValue);
+   */
+  SetSourceValue(value: unknown): void;
+
+  /**
+   * @experimental
+   * Экспериментальный метод.
+   */
+  UpdateStyle(): unknown;
+
+  /**
+   * @experimental
+   * Экспериментальный метод.
+   */
+  UpdateText(): unknown;
 };
 
-/* eslint-disable @typescript-eslint/no-redeclare */
 declare const ScreenItem: ScreenItem;

package/lib/server_agent_env/index.d.ts

@@ -1,23 +1,23 @@
 /**
  * Объект параметров агента.
  */
-declare var Param: Object;
+declare let Param: Object;
 /**
  * Id объекта над которым выполняется агент.
  */
-declare var OBJECT_ID: number;
-declare var OBJECTS_ID_STR: string;
+declare let OBJECT_ID: number;
+declare let OBJECTS_ID_STR: string;
 /**
  * Флаг исполнения кода на клиенте.
  */
-declare var LdsIsClient: boolean;
+declare let LdsIsClient: boolean;
 /**
  * Флаг исполнения кода на сервере.
  */
-declare var LdsIsServer: boolean;
+declare let LdsIsServer: boolean;
 
-declare var oData: unknown;
+declare let oData: unknown;
 
-declare const LdsCurUserID: number;
+declare let LdsCurUserID: number;
 
-declare const curParams: Object;
+declare let curParams: Object;

package/lib/spxml_unibridge_provider/index.d.ts

@@ -518,9 +518,3 @@ declare class SPXMLUnibridgeProvider {
   GetDataCache(distributed: boolean): unknown; // IDataCache
   Dispose(): void;
 }
-
-declare type SPXMLUnibridgeTool = XmlElem<{
-  Object: {
-    provider: SPXMLUnibridgeProvider;
-  }
-}>;

package/lib/stream/index.d.ts

@@ -47,5 +47,4 @@ interface StreamConstructor {
   (): Stream;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-redeclare
 declare const Stream: StreamConstructor;

package/lib/string/index.d.ts

@@ -29,8 +29,7 @@ interface String {
 
   /**
    * Создание строки из кода символа.
-   * @param substring
-   * @param startPosition
+   * @param {number} code - Код символа.
    */
   fromCharCode(code: number): string;
 
@@ -104,5 +103,4 @@ interface StringConstructor {
   fromCharCode(charCode: number): string;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-redeclare
 declare const String: StringConstructor;

package/lib/tagreader/index.d.ts

@@ -1,4 +1,3 @@
-
 /**
  * Объект TagReader предназначен для последовательного чтения содержимого в формате HTML (реже - XML).
  * В каждый определенный момент `TagReader` указывает на некотрый текщий тэг, до которого дошло чтение.
@@ -207,5 +206,4 @@ interface TagReaderConstructor {
   (data: string): TagReader;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-redeclare
 declare const TagReader: TagReaderConstructor;

package/lib/thread/index.d.ts

@@ -34,6 +34,17 @@ interface Thread {
    * ```
    */
   EvalCodeUrl(url: string): unknown;
+
+  /**
+   * Запускает в потоке указанный код после завершения выполнения кода, запущенного методом {@link EvalCode}
+   * @example 
+   * ```
+   * const thread = new Thread;
+   * thread.EvalCode("lib_backup.run_backup()");
+   * thread.SetPostCode("if ((tools.sys_db_capability & tools.UNI_CAP_BASIC) != 0) tools.spxml_unibridge.Object.provider.CleanUpThreadResources()");
+   * ```
+   */
+  SetPostCode(code: string): void;
 }
 
 interface ThreadConstructor {
@@ -47,5 +58,4 @@ interface ThreadConstructor {
  * поскольку существует более удобный способ запyска потока через метод {@link EvalThread}()
  * объекта XmlDoc, предлагающий концепцию класса, содержажего атрибуты и методы.
  */
-// eslint-disable-next-line @typescript-eslint/no-redeclare
 declare const Thread: ThreadConstructor;