d5-userscript-types 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+---
+
+## [1.1.0] — 2026-04-09
+
+### Added
+- `index.js`: runtime constants layer exporting all D5 enum constants (`D5TitlePosition`, `DecorDisplayType`, `ToolBarViewType`, `FormViewMode`, `FormCreateMode`, `FormToolBarButtons``) as frozen plain objects. Downstream user script projects can now `import {FormCreateMode} from 'd5-userscript-types'` and receive real runtime values instead of `undefined`.
+- `"main": "./index.js"` field in `package.json` so CJS-style imports resolve to the runtime constants file.
+
+> **Maintainer note:** `index.js` and `index.d.ts` are manually maintained in parallel. When adding or modifying an enum member, both files must be updated in the same release.
+
+---
+
+## [1.0.0] — 2026-04-08
+

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "d5-userscript-types",
+  "version": "1.1.0",
+  "description": "Public TypeScript declarations and runtime enum constants for D5 user-script API",
+  "license": "MIT",
+  "private": false,
+  "scripts": {
+    "clean": "rimraf publish",
+    "prepublishOnly": "yarn clean",
+    "prepack": "yarn compile",
+    "compile": "tsup"
+  },
+  "main": "publish/d5-userscript-types.js",
+  "module": "publish/d5-userscript-types.js",
+  "types": "publish/d5-userscript-types.d.mts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": {
+        "default": "./publish/d5-userscript-types.d.mts"
+      },
+      "default": "./publish/d5-userscript-types.js"
+    }
+  },
+  "files": [
+    "publish",
+    "CHANGELOG.md"
+  ],
+  "devDependencies": {
+    "rimraf": "5.0.5",
+    "tsup": "8.5.0"
+  }
+}

package/publish/d5-userscript-types.d.mts

@@ -0,0 +1,816 @@
+interface CustomDialogButton {
+    text: string;
+    value: any;
+    onClick: () => void;
+}
+interface IApplication {
+    name: string;
+    title: string;
+    version: string;
+}
+type DialogButton = 'ok' | 'cancel' | 'yes' | 'no' | 'copy' | CustomDialogButton;
+type Language = 'ua' | 'ru' | 'en';
+declare enum D5TitlePosition {
+    Top = 0,
+    Left = 1,
+    Right = 2,
+    OnBorder = 3,
+    Floating = 4
+}
+declare enum DecorDisplayType {
+    LABEL = 0,
+    IMAGE = 1,
+    ICON = 2,
+    LINK = 3,
+    HTML = 4,
+    FILE_VIEWER = 5,
+    LINE = 6
+}
+declare enum ToolBarViewType {
+    NONE = 0,
+    TOP_AND_CONTEXT = 1,
+    TOP = 2,
+    CONTEXT = 3
+}
+interface D5CurrentUser {
+    readonly userID: number;
+    readonly login: string;
+    readonly fullName: string;
+}
+interface UserStorage {
+    getStorageItem: (key: string) => string | null;
+    setStorageItem: (key: string, value: any) => void;
+    removeStorageItem: (key: string) => void;
+    clearStorage: () => void;
+}
+declare enum FormViewMode {
+    FULL_SCREEN = 1,
+    MODAL = 2,
+    IN_NEW_WINDOW = 3
+}
+declare enum FormCreateMode {
+    ADD = "add",
+    ADD_CHILD = "addChild",
+    EDIT = "edit",
+    MULTI_EDIT = "multiEdit",
+    FILTER_MODAL = "filterModal",
+    REPORT = "report",
+    FORM_SELECT = "formSelect",
+    LIST = "listForm",
+    TREE = "treeForm",
+    FREE = "freeForm"
+}
+declare enum FormToolBarButtons {
+    SAVE = "save",
+    CLOSE = "close",
+    APPLY = "apply",
+    SELECT = "select",
+    SAVE_CLOSE = "saveClose",
+    CANCEL = "cancel",
+    SaveAndCreateOneMore = "saveAndCreateOneMore"
+}
+interface CloseFormResolveOptions {
+    button: FormToolBarButtons;
+    userData: any;
+}
+interface OpeningFormOptions {
+    createMode?: FormCreateMode;
+    id?: number | string | Array<number | string>;
+    viewMode?: FormViewMode;
+}
+/**
+ * Base interface of all the layout items are passed to user script.
+ */
+interface BaseItem {
+    readonly name: string;
+    readonly id: number;
+    readonly groupID: number | null;
+    order: number;
+    isVisible: boolean;
+}
+type ILanguage = {
+    id: number;
+    code: string;
+    title: string;
+};
+/**
+ * Base interface for fields, filters and decorations
+ */
+interface BaseControl extends BaseItem {
+    isReadOnly: boolean;
+}
+interface D5Core {
+    currentUser: D5CurrentUser;
+    languages: ILanguage[];
+    userLocalStorage: UserStorage;
+    userSessionStorage: UserStorage;
+    lang(): Language;
+    numberPrompt(title: string, defaultValue?: number): Promise<number | undefined>;
+    stringPrompt(title: string, defaultValue?: string): Promise<string | undefined>;
+    datePrompt(title: string, defaultValue?: Date | string): Promise<Date | string | undefined>;
+    dateRangePrompt(title: string, defaultValue?: Array<Date | string>): Promise<Array<Date | string> | undefined>;
+    getApplications(): IApplication[];
+    getApplication(name: string): IApplication | null;
+    getFormStorageData(key: string): Promise<any>;
+    setFormStorageData(key: string, value: any): Promise<void>;
+    removeFormStorageData(key: string): Promise<void>;
+    /**
+     * Stores user data in the storage with optional encryption.
+     *
+     * @param {Record<string, any>} data - The user data to be stored.
+     * @param {boolean} [encrypt=false] - Indicates whether the data should be encrypted before storage.
+     * @param {string} [salt] - An optional salt value used if encryption is enabled. If not provided, the application name will be taken .
+     * @return {Promise<void>} A promise that resolves when the data is successfully stored.
+     */
+    userStorageSet(data: Record<string, any>, encrypt?: boolean, salt?: string): Promise<void>;
+    /**
+     * Retrieves user storage data based on the provided property and optional salt.
+     *
+     * @param {string} property - The key of the user data to retrieve.
+     * @param {string} [salt=''] - If the data were encrypted with user-defined salt, then the same salt must be provided.
+     * @return {Promise<any>} A promise that resolves with the retrieved user data.
+     */
+    userStorageGet(property: string, salt?: string): Promise<any>;
+    /**
+     * Removes a specified property from the user storage.
+     *
+     * @param {string} property - The key representing the property to be removed from the user storage.
+     * @return {Promise<void>} A promise that resolves when the property has been successfully removed.
+     */
+    userStorageRemove(property: string | string[]): Promise<void>;
+    enumPrompt(title: string, dataSource: Record<string | number, string | number>[], { isMultiSelect, defaultValue, widget }: {
+        isMultiSelect?: boolean;
+        defaultValue?: number | number[];
+        widget?: 'listSelector' | 'lookup';
+    }): Promise<any | undefined>;
+    showWarningDialog(text: string, buttons?: DialogButton[], title?: string): Promise<DialogButton | string>;
+    showInfoDialog(text: string, buttons?: DialogButton[], title?: string): Promise<DialogButton | string>;
+    showErrorDialog(text: string, buttons?: DialogButton[], title?: string): Promise<DialogButton | string>;
+    showSuccessDialog(text: string, buttons?: DialogButton[], title?: string): Promise<DialogButton | string>;
+    showCustomDialog(text: string, buttons?: DialogButton[], title?: string): Promise<DialogButton | string>;
+    showConfirmDialog(text: string, buttons?: DialogButton[], title?: string): Promise<DialogButton | string>;
+    formatNumber(value: string | number, format: string): string;
+    formatDate(value: Date | string, format: string): string;
+    hideLoader(): void;
+    showLoader(): void;
+    showInfo(msg: string, title?: string, messageTimeout?: number): void;
+    showWarning(msg: string, title?: string, messageTimeout?: number): void;
+    showSuccess(msg: string, title?: string, messageTimeout?: number): void;
+    showError(msg: string, title?: string, messageTimeout?: number): void;
+    /**
+     * Якщо передано filePath, то ще додає хеш збірки для кешування ресурсу
+     * @example
+     * core.resourcePath('myapp');
+     * core.resourcePath('myapp', '/path/img.png') // .../path/img.png?hash=123456
+     * core.resourcePath('myapp', '/path/img.png?param=1') // .../path/img.png?param=1&hash=123456
+     */
+    resourcePath(application: string, filePath?: string): string;
+    /**
+     * Повертає хеш збірки застосунку
+     */
+    buildHash(application: string): string;
+    /**
+     * navigate - метод который служит для перерисовки текущей страницы без ее перезагрузки.
+     * @param {string} url - часть роута, например: /subsystem/92
+     */
+    navigate(url: string): void;
+    /**
+     * newTab и newWindow работают по принципу window.open (это просто алиасы).
+     * Для переброса по текущему домену приложения url обязательно нужно начинать с #, например: #/subsystem/92.
+     * Для перехода на стороннюю страницу нужно указывать абсолютный путь.
+     * @param {string} url
+     */
+    newTab(url: string): void;
+    currentSubsystemName(): string;
+    currentSubsystemTitle(): string;
+    newWindow(url: string): void;
+    /**
+     * Делает запрос на сервер. Если сервер возвращает ошибку, то возвращаем полносью весь объект.
+     * @param {string} objectName - имя объекта
+     * @param {'List' | 'Ins' | 'Mod' | 'Del'} objectOperation - операция запроса
+     * @param {Object} requestBody - тело запроса
+     * @param {boolean} [plainResponse] - если true, то возвращает полный ответ такой как отдает сервер.
+     */
+    execObjectOperation(objectName: string, objectOperation: string, requestBody: Record<string, any>, plainResponse?: boolean): Promise<any>;
+    /**
+     * Делает запрос на получение данных (List). Возвращает список значенией по запрашиваемому объекту
+     * @param {string} objectName - имя объекта
+     * @param {Object} requestBody - тело запроса
+     */
+    loadObjectCollection(objectName: string, requestBody: Record<string, any>): Promise<any>;
+    /**
+     * Делает запрос на получение данных (List). Возвращает список всех значений по запрашиваемому объекту.
+     * Делает постраничный запрос, пока страницы не закончатся на сервере.
+     * Возвращает массив объектов, которые нужно итерировать с помощью for await... of
+     * @param objectName
+     * @param requestBody
+     */
+    objectCollectionIterator(objectName: string, requestBody: Record<string, any>): AsyncGenerator<Object[]>;
+    /** Открывает в текущем окне Полноэкранную форму по Name. Бросает исключение если форма не найдена.
+     * @param {number | string} formName - Name формы которую нужно открыть.
+     * @param {OpeningFormOptions} options
+     * @param {*} [userData] - любые данные которые передаются в форму и будут дальше передаваться во все
+     *  события. Пользователь сам управляет что это может быть
+     */
+    openFullScreen(formName: string, options?: OpeningFormOptions, userData?: any): Promise<unknown>;
+    /**
+     * Открывает Модальную форму по Name. Возвращает промис по закрытию. Бросает исключение если форма не найдена.
+     * @param {number | string} formName - Name формы которую нужно открыть.
+     * @param {OpeningFormOptions} options
+     * @param {*} [userData] - любые данные которые передаются в форму и будут дальше передаваться во все
+     *  события. Пользователь сам управляет что это может быть
+     */
+    openModal(formName: string, options?: OpeningFormOptions, userData?: any): Promise<CloseFormResolveOptions>;
+    /**
+     * Открывает Модальную или Полноэкранную(в текущем окне) форму по ID или Name, в зависимости от options.viewMode.
+     * Бросает исключение если форма не найдена.
+     * @param {number | string} form - ID | Name формы которую нужно открыть.
+     * @param {OpeningFormOptions} options
+     * @param {*} [userData] - любые данные которые передаются в форму и будут дальше передаваться во все
+     *  события. Пользователь сам управляет что это может быть
+     */
+    openForm(form: number | string, options?: OpeningFormOptions, userData?: any): void;
+    /**
+     * Инициализация словаря переводов.
+     * @param dictionary
+     * @example Пример строки перевода
+     * { ...
+     *  "ru": {"key": 'some text {0} {1}'}
+     *   ...
+     * }
+     *
+     *  core.t('key', ['test1', 'test2']); // 'some text test1 test2'
+     */
+    initTranslation(dictionary: Record<'ru' | 'ua' | 'en', Record<string, string>>): void;
+    /**
+     * Переводит и форматирует строку из словаря переводов согласно текущего языка приложения.
+     * @param msgKey
+     * @param params
+     *
+     * @example
+     *  {
+     *    ...
+     *    "myKey": 'some text with {0}'
+     *    ...
+     *  }
+     *  t('myKey', ['placeholder text']) // 'some text with placeholder text'
+     */
+    t(msgKey: string, params?: string[]): string;
+}
+interface BaseDataSource {
+    refreshData(): Promise<boolean>;
+    data: Record<string, any> | Record<string, any>[];
+}
+interface ListDataSource extends BaseDataSource {
+    rowsPerPage: number | 'all' | undefined;
+    readonly rowsData: Record<string, any>[];
+    readonly rowsCount: number;
+    disabled: boolean;
+}
+interface D5FormDecorationElement extends BaseItem {
+    title: string;
+    lineCount: number;
+    displayType: DecorDisplayType;
+    displayCustomParam: string;
+    readonly parentGroup: D5FormGroup | undefined;
+    text: string;
+}
+interface IBaseDynamicItem<Item> {
+    field(name: string): Item | undefined;
+    insertField(_: {
+        name: string;
+        title?: string;
+        value?: any;
+    }): void;
+    removeField(name: string): void;
+    fields: Item[];
+    name: string;
+}
+interface ID5Column {
+    isRequired: boolean;
+    isVisible: boolean;
+    isCustomizable: boolean;
+    isReadOnly: boolean;
+    readonly name: string;
+    title: string;
+    readonly isBaseMultiField: boolean | undefined;
+    readonly isDynamicColumn: boolean | undefined;
+    readonly groupID: number | null;
+    fixedToLeft: boolean;
+    lineCount: number;
+    datasource: any;
+    filter: any;
+    operationsParams: Record<string, any> | null;
+    displayValue: string | undefined;
+    value: any;
+    iconColor: string;
+    iconSize: string;
+    sortOrder: 'asc' | 'desc' | undefined;
+    sortIndex: number | undefined;
+    summaryValue: number;
+}
+interface D5DynamicColumn extends IBaseDynamicItem<ID5Column> {
+}
+interface D5DynamicFormField extends IBaseDynamicItem<D5FormField> {
+}
+interface D5FormField extends BaseControl {
+    title: string;
+    isShowTitle: boolean;
+    datasource: any;
+    /**
+     * Тип поля. string - 0, number - 1, date - 2, boolean - 3, nested - 4.
+     */
+    fieldType: number;
+    exportAsSVG?: () => Promise<string | null>;
+    /**
+     * Зберігає пароль поточного поля до менеджера облікових даних браузера.
+     * Використовує Credential Management API (PasswordCredential).
+     *
+     * Ідентифікатор облікового запису генерується автоматично
+     * з ідентифікатора форми та імені поля.
+     *
+     * @param {string} name - Ім'я користувача або відображуване ім'я для облікового запису.
+     * @returns {Promise<void>}
+     * @throws {Error} Якщо тип відображення поля не є "password".
+     */
+    savePassword(name: string): Promise<void>;
+    /**
+     * Используется для экспорта данных в виде объекта File.
+     * Разрешается использовать только для компонент с типом File и установленным признаком IsFile.
+     * @link https://developer.mozilla.org/en-US/docs/Web/API/File
+     */
+    exportAsFile?: () => File | null;
+    titlePosition: D5TitlePosition;
+    isRequired: boolean;
+    lineCount: number;
+    value: string | number | boolean | any;
+    displayValue: string;
+    operationsParams: Record<string, any> | null;
+    color: string;
+    fontSize: string;
+    readonly parentField: D5FormField | undefined;
+    readonly parentGroup: D5FormGroup | undefined;
+    filter: Record<string, any> | null;
+}
+type FilterOperations = '=' | '<>' | '<' | '>' | '<=' | '>=' | 'contains' | 'between' | 'isanyof' | 'isnotanyof' | 'isblank' | 'isnotblank';
+interface D5FormFilterField extends BaseControl {
+    title: string;
+    isRequired: boolean;
+    isShowTitle: boolean;
+    isCustomizable: boolean;
+    titlePosition: D5TitlePosition;
+    /**
+     * Тип поля. string - 0, number - 1, date - 2, boolean - 3, nested - 4.
+     */
+    fieldType: number;
+    value: string | number | boolean | any;
+    displayValue: string;
+    operationsParams: Record<string, any> | null;
+    filter: Record<string, any> | null;
+    operation: FilterOperations;
+    defaultValue: any;
+    defaultOperation: FilterOperations;
+    readonly parentGroup: D5FormGroup | undefined;
+    /**
+     * Only for Enums
+     */
+    datasource: [];
+    /**
+     * Value as API object
+     */
+    valueAsObject: Record<any, any>;
+    isBlank: boolean;
+}
+/**
+ * Base interface for groups
+ */
+interface D5FormGroup extends BaseItem {
+    title: string;
+    isCollapsed: boolean;
+    isShowTitle: boolean;
+    isActive: boolean;
+    isDisabled: boolean;
+    colorScheme: D5ColorScheme | null;
+    stylingMode: D5StylingMode | null;
+    readonly parentGroup: D5FormGroup | undefined;
+}
+type ColorScheme = 'default' | 'primary' | 'success' | 'danger' | 'warning' | 'main scheme';
+type ReplaceSubFormArgs = {
+    name: string;
+    formName: string;
+    masterFieldName?: string;
+    detailFieldName?: string;
+    nestedFieldName?: string;
+    relationType?: number;
+    order: number;
+};
+type AddSubFormArgs = ReplaceSubFormArgs & {
+    groupName?: string;
+    groupID?: number;
+};
+interface D5ColorScheme {
+    /**
+     * Метод getCurrent() класса ColorScheme - возвращает текущие значение.
+     * Может быть - default | primary | success | danger | warning | main scheme
+     */
+    getCurrent(): ColorScheme;
+    /**
+     * Метод setDefault() класса ColorScheme - устанавливает значение default.
+     */
+    setDefault(): void;
+    /**
+     * Метод setPrimary() класса ColorScheme - устанавливает значение primary.
+     */
+    setPrimary(): void;
+    /**
+     * Метод setSuccess() класса ColorScheme - устанавливает значение success.
+     */
+    setSuccess(): void;
+    /**
+     * Метод setDanger() класса ColorScheme - устанавливает значение danger.
+     */
+    setDanger(): void;
+    /**
+     * Метод setWarning() класса ColorScheme - устанавливает значение warning.
+     */
+    setWarning(): void;
+    /**
+     * Метод setMainScheme() класса ColorScheme - устанавливает значение main scheme.
+     */
+    setMainScheme(): void;
+}
+type StylingMode = 'none' | 'outlined' | 'contained';
+interface D5StylingMode {
+    /**
+     * Метод getCurrent() класса StylingMode - возвращает текущие значение. Может быть - none | outlined | contained
+     */
+    getCurrent(): StylingMode;
+    /**
+     * Метод setNone() класса StylingMode - устанавливает значение none.
+     */
+    setNone(): void;
+    /**
+     * Метод setOutlined() класса StylingMode - устанавливает значение outlined.
+     */
+    setOutlined(): void;
+    /**
+     * Метод setContained() класса StylingMode - устанавливает значение contained.
+     */
+    setContained(): void;
+}
+/**
+ * Base interface for buttons
+ */
+interface D5FormButton extends BaseItem {
+    title: string;
+    isDisabled: boolean;
+    isPressed: boolean;
+    isEditButtonByDefault: boolean;
+    icon: string;
+    readonly actionForm: string | null;
+    colorScheme: D5ColorScheme | null;
+    stylingMode: D5StylingMode | null;
+    readonly parentField: D5FormField | undefined;
+    readonly parentGroup: D5FormGroup | undefined;
+}
+interface D5BaseForm {
+    readonly id: string;
+    readonly name: string;
+    readonly applicationName: string;
+    readonly objectName: string;
+    readonly keyField: string;
+    readonly parentField: string | undefined;
+    subFormName: string | undefined;
+    title: string;
+    insOperation: string;
+    modOperation: string;
+    delOperation: string;
+    listOperation: string;
+    operationsParams: any;
+    /**
+     * Пользовательские данные формы. Задаются из пользовательского скрипта. Передаются по ссылке.
+     */
+    userData?: any;
+    readonly buttons: Array<D5FormButton>;
+    /**
+     * @param name - Sys_Forms.Sys_FormButtons.Name
+     */
+    button: (name: string) => D5FormButton | undefined;
+    readonly groups: Array<D5FormGroup>;
+    group: (name: string) => D5FormGroup | undefined;
+    readonly decorationElements: Array<D5FormDecorationElement>;
+    decorationElement: (name: string) => D5FormDecorationElement | undefined;
+    readonly subForms: Array<D5BaseForm>;
+    subForm: (name: string) => D5BaseForm | undefined;
+    parentForm: D5BaseForm | undefined;
+    /**
+     * @param {boolean} [silentMode=false] - если true, то закрывает форму не вызывая диалоговые окна с подтверждением.
+     */
+    close(silentMode: boolean): void;
+    removeSubForm: (subFormName: string) => void;
+    replaceSubForm: (options: ReplaceSubFormArgs, destSubFormName: string) => void;
+    addSubForm: (options: AddSubFormArgs) => void;
+    autoRefreshTimeout: number;
+    isAutoRefresh: boolean;
+    isShowTitle: boolean;
+    isModified: boolean;
+    isSilentClosing: boolean;
+    navigateToElement(layoutItem: BaseControl | D5BaseForm): void;
+    setFocus(layoutItem: BaseControl | D5BaseForm): void;
+    /**
+     * Возвращает строку - текущий язык приложения, например ua, ru, en
+     */
+    lang(): Language;
+    /**
+     * Метод, который открывает панель фильтрации, без параметров.
+     */
+    showFilter(): void;
+    /**
+     * Метод, который открывает панель фильтра(смарт папки). Без параметров.
+     */
+    showFilterDockPanel(): void;
+    /**
+     * Метод, который открывает панель редактирования с правой стороны. Без параметров.
+     */
+    showEditDockPanel(): void;
+    disabled: boolean;
+}
+/**
+ * Base interface for new button
+ */
+interface NewButtonProps {
+    name: string;
+    clickEvent: string;
+    groupName?: string;
+    order?: number;
+    title?: string;
+    colorScheme: number;
+    dockingSide: number;
+    icon?: string;
+}
+interface D5Column {
+    order: number;
+    isRequired: boolean;
+    isVisible: boolean;
+    isCustomizable: boolean;
+    isReadOnly: boolean;
+    readonly name: string;
+    title: string;
+    readonly isBaseMultiField: boolean | undefined;
+    readonly isDynamicColumn: boolean | undefined;
+    readonly groupID: number | null;
+    fixedToLeft: boolean;
+    lineCount: number;
+    datasource: any;
+    filter: any;
+    value: any;
+}
+interface D5ListForm extends D5BaseForm {
+    datasource: ListDataSource;
+    filterField(name: string): D5FormFilterField | undefined;
+    readonly filterFields: Array<D5FormFilterField>;
+    toolBarViewType: ToolBarViewType;
+    readonly fields: Array<D5Column | D5DynamicColumn>;
+    isFixedOrder: boolean;
+    readonly subsystemName: string | undefined;
+    field(name: string): D5Column | D5DynamicColumn | undefined;
+    /** Создает урл текущей формы с установленным фильтром.
+     */
+    filterUrl(): Promise<string | null>;
+    /** Створює нову кнопку в тулбарі і контекстному меню
+     * @param name - ім'я нової кнопки
+     * @param clickEvent - назва eventName
+     * @param groupName - назва групи
+     * @param colorScheme - кольорова схема кнопки
+     * @param dockingSide - сторона відображення кнопки в тулбарі
+     * @param order - порядок розсташування кнопки
+     * @param title - заголовок кнопки
+     * @param icon - іконка
+     */
+    addButton(props: NewButtonProps): void;
+    /** Видаляє тільки ті кнопки, які були створенні в клієнтських скріптах.
+     * @param name - назва кнопки
+     */
+    removeButton(name: string): void;
+    /**
+     * Обновляет записи по указанным ключам. Добавляет новые записи, удаляет ненайденные.
+     * @param keys
+     * @param [useFilter]
+     */
+    refreshRecords(keys: Array<string | number>, useFilter?: boolean): Promise<void>;
+    /**
+     * Добавляет сортировку для форм типа Таблицы или Дерева.
+     * @param sorting
+     */
+    setSorting(sorting: string[] | null): void;
+    /**
+     * Метод, который открывает форму отчета в другой вкладке.
+     * @param reportName
+     * @param userData
+     */
+    openReportGroup(reportName: string, userData?: any): void;
+}
+interface D5USEvent {
+    cancel: boolean;
+    resolve: () => void;
+    reject: () => void;
+}
+interface D5Row {
+    readonly data: Record<string, any>;
+    readonly key: string | number;
+}
+interface D5Cell {
+    rowIndex: number;
+    columnIndex: number;
+    cellValue: any;
+}
+interface D5TableForm extends D5ListForm {
+    readonly focusedRow: D5Row;
+    readonly focusedCell: D5Cell;
+    readonly rows: D5Row[];
+    readonly selectedRows: D5Row[];
+    /**
+     *  Выделяет строки таблицы.
+     *  @param keys - массив ключей, может быть пустым, если нужно снять выделение.
+     */
+    selectRowKeys(keys: Array<string | number>): void;
+    /**
+     * Удаляет строки в таблице по ключам.
+     * @param keys
+     * @param remote
+     */
+    delRows(keys: string[] | number[], remote?: boolean): void;
+    /**
+     * Заменяет строку в таблице по ключу.
+     * @param key
+     * @param newRow
+     * @param remote
+     */
+    editRow(key: string | number, newRow: Record<string, any>, remote?: boolean): void;
+    /**
+     * Добавляет строку в таблице.
+     * @param newRow
+     * @param remote
+     */
+    addRow(newRow: Record<string, any>, remote?: boolean): void;
+    /**
+     * Фиксирует заданные колонки влево.
+     * @param keys
+     */
+    fixColumnsToLeft(keys: string[] | number[]): void;
+}
+interface D5TreeForm extends D5ListForm {
+    selectedNodes: D5Row[];
+    focusedNode: D5Row;
+    readonly focusedCell: D5Cell;
+    nodes: D5Row[];
+    /**
+     *  Выделяет строки дерева.
+     *  @param keys - массив ключей, может быть пустым, если нужно снять выделение.
+     */
+    selectNodeKeys(keys: Array<string | number>): void;
+    /**
+     * Удаляет строки в дереве по ключам.
+     * @param keys
+     * @param remote
+     */
+    delNodes(keys: string[] | number[], remote?: boolean): void;
+    /**
+     * Заменяет строку в дереве по ключу.
+     * @param key
+     * @param newRow
+     * @param remote
+     */
+    editNode(key: string | number, newRow: Record<string, any>, remote?: boolean): void;
+    /**
+     * Добавляет строку в дереве.
+     * @param newRow
+     * @param remote
+     */
+    addNode(newRow: Record<string, any>, remote?: boolean): void;
+    /**
+     * Раскрывает все родительские ноды и выделяет запись с ид nodeId.
+     */
+    navigateToNode(nodeId: string | number): void;
+    collapseRow(nodeIds: []): void;
+    expandRow(nodeIds: []): void;
+    collapseAll(): void;
+    expandAll(): void;
+    /**
+     * Фиксирует заданные колонки влево.
+     * @param keys
+     */
+    fixColumnsToLeft(keys: string[] | number[]): void;
+}
+/**
+ * Типу форми редагування
+ */
+interface D5Form extends D5BaseForm {
+    /**
+     * @param silentMode - если равен true то нотивикейшены из приложения вызываться не будут
+     * @param operation
+     * @throws Error
+     */
+    save: (silentMode: boolean, operation: 'Ins' | 'Mod') => Promise<Response | true>;
+    /**
+     * Установка заголовка кнопки сохранить
+     */
+    saveButtonTitle: string;
+    /**
+     * Установка кастомного сообщения при сохранении
+     */
+    saveSuccessMessage: string;
+    /**
+     * Режим открываемой формы редактирования
+     */
+    createMode: FormCreateMode;
+    /**
+     * Текст под заголовком открываемой формы редактирования
+     */
+    subTitle: string;
+    filterField(name: string): D5FormFilterField | undefined;
+    readonly filterFields: Array<D5FormFilterField>;
+    /**
+     * Ключевые значения
+     */
+    keyValue: string[] | number[];
+    /**
+     * Возвращает массив данных из выделеных строк которые редактируются
+     */
+    readonly rowsData: any[];
+    /**
+     * Возвращает массив данных из выделенных строк которые редактируются
+     */
+    readonly rows: any[];
+    /**
+     * Возвращает значение свойства readOnly формы редактирования
+     */
+    get readOnly(): boolean;
+    /**
+     * Возвращает или устанавливает значение операции вставки
+     */
+    insOperation: string;
+    /**
+     * Возвращает или устанавливает значение операции модификации
+     */
+    modOperation: string;
+    /**
+     * Форма со значением readOnly === true открывается только для просмотра
+     * @param value
+     */
+    set readOnly(value: boolean);
+    /**
+     * Обновляет значения в таблице и во всех вложенных таблицах
+     */
+    refresh(): void;
+    datasource: BaseDataSource;
+    readonly fields: Array<D5FormField>;
+    /**
+     * @param name - Sys_Forms.Sys_FormFields.Name
+     */
+    field: (name: string) => D5FormField | undefined;
+}
+interface D5SchedulerResource {
+    filter: Record<string, any> | null;
+    isGroup: boolean;
+    name: string;
+    datasource: Record<string, any>[];
+}
+interface SysFormSchedulerResources {
+    dataSource: Record<string, any>[];
+    FormID: number;
+    GroupOrder: number;
+    ID: number;
+    IsGroup: number;
+    ResourcesColorFieldName: string;
+    ResourcesNameFieldName: string;
+    ResourcesSortFieldName: string;
+    ResourcesObjectName: string;
+    SchedulerResourceFieldName: string;
+    SchedulerResourceFieldTitle: string;
+}
+interface D5Kanban extends D5BaseForm {
+}
+interface D5Scheduler extends Omit<D5ListForm, 'isFixedOrder' | 'refreshRecords' | 'setSorting' | 'openReportGroup'> {
+    readonly datasource: any;
+    readonly resources: D5SchedulerResource[];
+    startDayHour: number;
+    endDayHour: number;
+    selectedItems: Record<string, any>[];
+    resource(name: string): D5SchedulerResource | undefined;
+    addResource(resource: SysFormSchedulerResources): void;
+}
+interface D5TileList extends D5BaseForm {
+    selectedTiles: Record<string, any>[];
+}
+interface D5ListView extends D5BaseForm {
+    selectedItems: Record<string, any>[];
+    /**
+     * Асинхронный метод. Обновляет строки в компоненте, по заданным ключам.
+     * @param keys
+     * @param [useFilter]
+     */
+    refreshRecords(keys: Array<string | number>, useFilter?: boolean): Promise<void>;
+}
+
+export { type AddSubFormArgs, type BaseControl, type BaseDataSource, type BaseItem, type CloseFormResolveOptions, type ColorScheme, type CustomDialogButton, type D5BaseForm, type D5Cell, type D5ColorScheme, type D5Column, type D5Core, type D5CurrentUser, type D5DynamicColumn, type D5DynamicFormField, type D5Form, type D5FormButton, type D5FormDecorationElement, type D5FormField, type D5FormFilterField, type D5FormGroup, type D5Kanban, type D5ListForm, type D5ListView, type D5Row, type D5Scheduler, type D5SchedulerResource, type D5StylingMode, type D5TableForm, type D5TileList, D5TitlePosition, type D5TreeForm, type D5USEvent, DecorDisplayType, type DialogButton, type FilterOperations, FormCreateMode, FormToolBarButtons, FormViewMode, type IApplication, type IBaseDynamicItem, type ID5Column, type ILanguage, type Language, type ListDataSource, type NewButtonProps, type OpeningFormOptions, type ReplaceSubFormArgs, type StylingMode, type SysFormSchedulerResources, ToolBarViewType, type UserStorage };

package/publish/d5-userscript-types.js

@@ -0,0 +1,69 @@
+// src/index.ts
+var D5TitlePosition = /* @__PURE__ */ ((D5TitlePosition2) => {
+  D5TitlePosition2[D5TitlePosition2["Top"] = 0] = "Top";
+  D5TitlePosition2[D5TitlePosition2["Left"] = 1] = "Left";
+  D5TitlePosition2[D5TitlePosition2["Right"] = 2] = "Right";
+  D5TitlePosition2[D5TitlePosition2["OnBorder"] = 3] = "OnBorder";
+  D5TitlePosition2[D5TitlePosition2["Floating"] = 4] = "Floating";
+  return D5TitlePosition2;
+})(D5TitlePosition || {});
+Object.freeze(D5TitlePosition);
+var DecorDisplayType = /* @__PURE__ */ ((DecorDisplayType2) => {
+  DecorDisplayType2[DecorDisplayType2["LABEL"] = 0] = "LABEL";
+  DecorDisplayType2[DecorDisplayType2["IMAGE"] = 1] = "IMAGE";
+  DecorDisplayType2[DecorDisplayType2["ICON"] = 2] = "ICON";
+  DecorDisplayType2[DecorDisplayType2["LINK"] = 3] = "LINK";
+  DecorDisplayType2[DecorDisplayType2["HTML"] = 4] = "HTML";
+  DecorDisplayType2[DecorDisplayType2["FILE_VIEWER"] = 5] = "FILE_VIEWER";
+  DecorDisplayType2[DecorDisplayType2["LINE"] = 6] = "LINE";
+  return DecorDisplayType2;
+})(DecorDisplayType || {});
+Object.freeze(DecorDisplayType);
+var ToolBarViewType = /* @__PURE__ */ ((ToolBarViewType2) => {
+  ToolBarViewType2[ToolBarViewType2["NONE"] = 0] = "NONE";
+  ToolBarViewType2[ToolBarViewType2["TOP_AND_CONTEXT"] = 1] = "TOP_AND_CONTEXT";
+  ToolBarViewType2[ToolBarViewType2["TOP"] = 2] = "TOP";
+  ToolBarViewType2[ToolBarViewType2["CONTEXT"] = 3] = "CONTEXT";
+  return ToolBarViewType2;
+})(ToolBarViewType || {});
+Object.freeze(ToolBarViewType);
+var FormViewMode = /* @__PURE__ */ ((FormViewMode2) => {
+  FormViewMode2[FormViewMode2["FULL_SCREEN"] = 1] = "FULL_SCREEN";
+  FormViewMode2[FormViewMode2["MODAL"] = 2] = "MODAL";
+  FormViewMode2[FormViewMode2["IN_NEW_WINDOW"] = 3] = "IN_NEW_WINDOW";
+  return FormViewMode2;
+})(FormViewMode || {});
+Object.freeze(FormViewMode);
+var FormCreateMode = /* @__PURE__ */ ((FormCreateMode2) => {
+  FormCreateMode2["ADD"] = "add";
+  FormCreateMode2["ADD_CHILD"] = "addChild";
+  FormCreateMode2["EDIT"] = "edit";
+  FormCreateMode2["MULTI_EDIT"] = "multiEdit";
+  FormCreateMode2["FILTER_MODAL"] = "filterModal";
+  FormCreateMode2["REPORT"] = "report";
+  FormCreateMode2["FORM_SELECT"] = "formSelect";
+  FormCreateMode2["LIST"] = "listForm";
+  FormCreateMode2["TREE"] = "treeForm";
+  FormCreateMode2["FREE"] = "freeForm";
+  return FormCreateMode2;
+})(FormCreateMode || {});
+Object.freeze(FormCreateMode);
+var FormToolBarButtons = /* @__PURE__ */ ((FormToolBarButtons2) => {
+  FormToolBarButtons2["SAVE"] = "save";
+  FormToolBarButtons2["CLOSE"] = "close";
+  FormToolBarButtons2["APPLY"] = "apply";
+  FormToolBarButtons2["SELECT"] = "select";
+  FormToolBarButtons2["SAVE_CLOSE"] = "saveClose";
+  FormToolBarButtons2["CANCEL"] = "cancel";
+  FormToolBarButtons2["SaveAndCreateOneMore"] = "saveAndCreateOneMore";
+  return FormToolBarButtons2;
+})(FormToolBarButtons || {});
+Object.freeze(FormToolBarButtons);
+export {
+  D5TitlePosition,
+  DecorDisplayType,
+  FormCreateMode,
+  FormToolBarButtons,
+  FormViewMode,
+  ToolBarViewType
+};