mdt-client 31.3.20 → 31.3.21

package/types/services/IFilter.d.ts

@@ -1,322 +1,322 @@
-/**
- * Фильтр
- *
- * @default { "op": "eq", "p1": "", "p2": "" }
- */
-export declare type IFilter = IFilterItem | IFilterGroup | IFilterIn;
-export declare type FilterKeys = keyof IFilter | keyof IFilterItem | keyof IFilterGroup;
-export declare type FilterUserIdOp = "userId";
-export declare type FilterOp = "eq" | "ne" | "gt" | "ge" | "lt" | "le" | "startsWith" | "endsWith" | "contains" | "fulltext" | "equalTemplate" | "queryIn" | "notStartsWith" | "notContains" | "notEndsWith" | "null" | "notNull" | FilterUserIdOp | FilterInOperation;
-export declare type FilterGroupOp = "and" | "or";
-export declare type AnyFilterOp = FilterOp | FilterGroupOp;
-export interface QueryInValue {
-    table?: string;
-    field?: string;
-    args?: string;
-    filter?: IFilter;
-}
-/** Группировка фильтров */
-export interface IFilterGroup {
-    op: FilterGroupOp;
-    groups: IFilter[];
-    not?: boolean;
-}
-/** Фильтр */
-export interface IFilterItem {
-    op: FilterOp;
-    /** Поле, по которому происходит фильтрация */
-    p1: string;
-    /** Значение фильтра */
-    p2: string | number | Date | QueryInValue;
-    not?: boolean;
-    cast?: "date";
-}
-declare const filterInOp = "in";
-export declare type FilterInOperation = typeof filterInOp;
-/** Фильтр */
-export interface IFilterIn extends Omit<IFilterItem, "op" | "p2"> {
-    op: FilterInOperation;
-    p2: {
-        table: string;
-        field: string;
-        filter?: IFilter;
-        args?: QueryInArgs;
-    } | (string | Date)[];
-}
-export declare type QueryInArgs = ArgValue[] | {
-    [k: string]: ArgValue;
-};
-declare type ArgValue = any;
-export interface IFilterQueryIn extends Omit<IFilterIn, "op" | "p2"> {
-    op: FilterInOperation | "queryIn";
-    p2: QueryInValue;
-}
-export interface FilterSetterOptions {
-    fireEvents?: boolean;
-}
-export interface FilterConstructor {
-    new (): Filter;
-    /**
-     * Создает группу фильтров, где все условия должны быть выполнены
-     *
-     * @param groups Группа фильтров - указываются необходимые фильтры
-     *
-     * **Пример**
-     *
-     * Поле `Name` должно быть равно `Ivan` и поле `LastName` должно быть равно `Ivanov`
-     * ```js
-     * Filter.and(Filter.eq('Name', 'Ivan'), Filter.eq('LastName', 'Ivanov'))
-     * ```
-     */
-    and(...groups: IFilter[]): IFilterGroup;
-    /**
-     * Создает группу фильтров, где хотя бы одно условие должно быть выполнено
-     *
-     * @param groups Группа фильтров - указываются необходимые фильтры
-     *
-     * Поле `Name` должно быть равно `Ivan` или поле `Name` должно быть равно `Petr`
-     * **Пример**
-     *
-     * ```js
-     * Filter.or(Filter.eq('Name', 'Ivan'), Filter.eq('Name', 'Petr'))
-     * ```
-     */
-    or(...groups: IFilter[]): IFilterGroup;
-    /**
-     * Создает фильтр, который проверяет равенство значения поля заданному значению
-     *
-     * @param fieldPath Поле, по которому происходит фильтрация
-     * @param value Значение фильтра
-     *
-     * **Пример**
-     *
-     * Поле `Name` должно быть равно `Ivan`
-     * ```js
-     * Filter.eq('Name', 'Ivan')
-     * ```
-     */
-    eq(fieldPath: string, value: any): IFilterItem;
-    /**
-     * Создает фильтр, который проверяет неравенство значения поля заданному значению
-     *
-     * @param fieldPath Поле, по которому происходит фильтрация
-     * @param value Значение фильтра
-     *
-     * **Пример**
-     *
-     * Поле `Name` не должно быть равно `Ivan`
-     * ```js
-     * Filter.ne('Name', 'Ivan')
-     * ```
-     */
-    ne(fieldPath: string, value: any): IFilterItem;
-    /**
-     * Создает фильтр, который проверяет, что значение указанного поля больше заданного значения
-     *
-     * @param fieldPath Поле, по которому происходит фильтрация
-     * @param value Значение фильтра
-     *
-     * **Пример**
-     *
-     * Поле `SumOrder` должно быть больше `100000`
-     * ```js
-     * Filter.gt('SumOrder', 100000)
-     * ```
-     */
-    gt(fieldPath: string, value: any): IFilterItem;
-    /**
-     * Создает фильтр, который проверяет, что значение указанного поля больше или равно заданному значению
-     *
-     * @param fieldPath Поле, по которому происходит фильтрация
-     * @param value Значение фильтра
-     *
-     * **Пример**
-     *
-     * Поле `SumOrder` должно быть больше или равно `100000`
-     * ```js
-     * Filter.ge('SumOrder', 100000)
-     * ```
-     */
-    ge(fieldPath: string, value: any): IFilterItem;
-    /**
-     * Создает фильтр, который проверяет, что значение указанного поля меньше заданного значения
-     *
-     * @param fieldPath Поле, по которому происходит фильтрация
-     * @param value Значение фильтра
-     *
-     * **Пример**
-     *
-     * Поле `SumOrder` должно быть меньше `100000`
-     * ```js
-     * Filter.lt('SumOrder', 100000)
-     * ```
-     */
-    lt(fieldPath: string, value: any): IFilterItem;
-    /**
-     * Создает фильтр, который проверяет, что значение указанного поля меньше или равно заданному значению
-     *
-     * @param fieldPath Поле, по которому происходит фильтрация
-     * @param value Значение фильтра
-     *
-     * **Пример**
-     *
-     * Поле `SumOrder` должно быть меньше или равно `100000`
-     * ```js
-     * Filter.le('SumOrder', 100000)
-     * ```
-     */
-    le(fieldPath: string, value: any): IFilterItem;
-    /**
-     * Создает фильтр, который проверяет, начинается ли значение указанного поля с заданной подстроки
-     *
-     * @param fieldPath Поле, по которому происходит фильтрация
-     * @param value Подстрока, с которой должно начинаться значение
-     *
-     * **Пример**
-     *
-     * Поле `LastName` должно начинаться с `Al`
-     * ```js
-     * Filter.startsWith('LastName', 'Al')
-     * ```
-     */
-    startsWith(fieldPath: string, value: any): IFilterItem;
-    /**
-     * Создает фильтр, который проверяет, заканчивается ли значение указанного поля на заданную подстроку
-     *
-     * @param fieldPath Поле, по которому происходит фильтрация
-     * @param value Подстрока, с которой должно заканчиваться значение
-     *
-     * **Пример**
-     *
-     * Поле `LastName` должно заканчиваться на `ov`
-     * ```js
-     * Filter.endsWith('LastName', 'ov')
-     * ```
-     */
-    endsWith(fieldPath: string, value: any): IFilterItem;
-    /**
-     * Создает фильтр, который проверяет, содержит ли значение указанного поля заданную подстроку
-     *
-     * @param fieldPath Поле, по которому происходит фильтрация
-     * @param value Подстрока, которую должно содержать значение
-     *
-     * **Пример**
-     *
-     * Поле `LastName` должно содержать `an`
-     * ```js
-     * Filter.contains('LastName', 'an')
-     * ```
-     */
-    contains(fieldPath: string, value: any): IFilterItem;
-    /**
-     * Создает фильтр для полнотекстового поиска по указанному полю
-     *
-     * @param fieldPath Поле, по которому происходит фильтрация
-     * @param value Подстрока, которую должно содержать значение
-     *
-     * **Пример**
-     *
-     * Поле `Description` должно содержать `example`
-     * ```js
-     * Filter.fulltext('Description', 'example');
-     * ```
-     */
-    fulltext(fieldPath: string, value: any): IFilterItem;
-    /**
-     * Создает фильтр, который исключает значения, соответствующие указанному фильтру
-     *
-     * @param filter Фильтр
-     *
-     * **Пример**
-     *
-     * Поле `Name` должно содержать любое значение кроме `Ivan`
-     * ```js
-     * Filter.not(Filter.eq('Name', 'Ivan'))
-     * ```
-     */
-    not(filter: IFilterItem | IFilterIn): IFilterItem;
-    /**
-     * Фильтр, проверяющий, что поле содержит одно из перечисленных значений
-     *
-     * @param fieldPath Поле, по которому происходит фильтрация
-     * @param array Массив значений
-     *
-     * **Пример**
-     *
-     * Поле `Name` должно содержать либо значение `Ivan`, либо `Petr`
-     * ```js
-     * Filter.in('Name', ['Ivan', 'Petr'])
-     * ```
-     */
-    in(fieldPath: string, array: any[]): IFilterIn;
-    /**
-     * Строится фильтр для поля на основании значений из другой таблицы
-     * @param field Поле, по которому происходит фильтрация
-     * @param objectCode Код объекта, из которой берутся значения. Может быть таблицей, представлением, функцей и т.д.
-     * @param subField Поле, по которому происходит фильтрация в другой таблице
-     * @param filter Фильтр, который применяется к другой таблице
-     * @param args Аргументы для объекта (например для функции). Можно задать, например, в виде `{ Search: "Москва" }`.
-     *
-     * **Пример**
-     *
-     * Отфильтруется поле `Title` текущей таблицы по полю `Name` таблицы `mdt.Employee`, где поле `Name` равно `Ivan`
-     * ```js
-     * Filter.queryIn('Title', 'mdt.Employee', 'Name', Filter.eq('Name', 'Ivan'))
-     * ```
-     */
-    queryIn(field: string, objectCode: string, subField: string, filter?: IFilter, args?: any): IFilterIn;
-    /**
-     * Преобразует тип данных фильтра
-     *
-     * @param filter Фильтр
-     * @param cast Значение, к типу которого приводится фильтр
-     *
-     * **Пример**
-     *
-     * Значение поля `DateTime` приводится к типу `date` (`value` содержит значение типа `datetime`)
-     * ```js
-     * Filter.cast(Filter.eq('DateTime', value), 'date')
-     * ```
-     */
-    cast(filter: IFilter, cast: string): IFilter;
-    /**
-     * Проверка, что фильтр пустой
-     *
-     * **Пример**
-     *
-     * Проверка, что `filter` пустой
-     * ```js
-     * if (filter === Filter.empty) { ... }
-     * ```
-     */
-    empty: any;
-}
-export declare class Filter {
-    static empty: IFilter;
-    static isEmptyFilter(filter: IFilter): boolean;
-    static mergeFilters(orig: IFilter, filter: IFilter): IFilter;
-    static and(...groups: any[]): IFilterGroup;
-    static or(...groups: any[]): IFilterGroup;
-    static eq(p1: any, p2: any): IFilterItem;
-    static ne(p1: any, p2: any): IFilterItem;
-    static gt(p1: any, p2: any): IFilterItem;
-    static ge(p1: any, p2: any): IFilterItem;
-    static lt(p1: any, p2: any): IFilterItem;
-    static le(p1: any, p2: any): IFilterItem;
-    static startsWith(p1: any, p2: any): IFilterItem;
-    static endsWith(p1: any, p2: any): IFilterItem;
-    static contains(p1: any, p2: any): IFilterItem;
-    static fulltext(p1: any, p2: any): IFilterItem;
-    static not(f: any): IFilterItem;
-    static in(p1: any, ar: any): IFilterIn;
-    static queryIn(field: any, table: any, subField: any, filter?: any, args?: any): IFilterIn;
-    static cast(filter: any, cast: any): IFilter;
-    static equalTemplate(p1: any, p2: any): IFilter;
-    static isFilter(filter: unknown): filter is IFilter;
-    static isFilterGroup(filter: IFilter): filter is IFilterGroup;
-    static isFilterItem(filter: IFilter): filter is IFilterItem;
-    static isFilterIn(filter: IFilter): filter is IFilterIn;
-    static isFilterQueryIn(filter: IFilter): filter is IFilterQueryIn;
-    static getP2(filter: IFilter): string | number | QueryInValue | Date;
-}
-export {};
+/**
+ * Фильтр
+ *
+ * @default { "op": "eq", "p1": "", "p2": "" }
+ */
+export declare type IFilter = IFilterItem | IFilterGroup | IFilterIn;
+export declare type FilterKeys = keyof IFilter | keyof IFilterItem | keyof IFilterGroup;
+export declare type FilterUserIdOp = "userId";
+export declare type FilterOp = "eq" | "ne" | "gt" | "ge" | "lt" | "le" | "startsWith" | "endsWith" | "contains" | "fulltext" | "equalTemplate" | "queryIn" | "notStartsWith" | "notContains" | "notEndsWith" | "null" | "notNull" | FilterUserIdOp | FilterInOperation;
+export declare type FilterGroupOp = "and" | "or";
+export declare type AnyFilterOp = FilterOp | FilterGroupOp;
+export interface QueryInValue {
+    table?: string;
+    field?: string;
+    args?: string;
+    filter?: IFilter;
+}
+/** Группировка фильтров */
+export interface IFilterGroup {
+    op: FilterGroupOp;
+    groups: IFilter[];
+    not?: boolean;
+}
+/** Фильтр */
+export interface IFilterItem {
+    op: FilterOp;
+    /** Поле, по которому происходит фильтрация */
+    p1: string;
+    /** Значение фильтра */
+    p2: string | number | Date | QueryInValue;
+    not?: boolean;
+    cast?: "date";
+}
+declare const filterInOp = "in";
+export declare type FilterInOperation = typeof filterInOp;
+/** Фильтр */
+export interface IFilterIn extends Omit<IFilterItem, "op" | "p2"> {
+    op: FilterInOperation;
+    p2: {
+        table: string;
+        field: string;
+        filter?: IFilter;
+        args?: QueryInArgs;
+    } | (string | Date)[];
+}
+export declare type QueryInArgs = ArgValue[] | {
+    [k: string]: ArgValue;
+};
+declare type ArgValue = any;
+export interface IFilterQueryIn extends Omit<IFilterIn, "op" | "p2"> {
+    op: FilterInOperation | "queryIn";
+    p2: QueryInValue;
+}
+export interface FilterSetterOptions {
+    fireEvents?: boolean;
+}
+export interface FilterConstructor {
+    new (): Filter;
+    /**
+     * Создает группу фильтров, где все условия должны быть выполнены
+     *
+     * @param groups Группа фильтров - указываются необходимые фильтры
+     *
+     * **Пример**
+     *
+     * Поле `Name` должно быть равно `Ivan` и поле `LastName` должно быть равно `Ivanov`
+     * ```js
+     * Filter.and(Filter.eq('Name', 'Ivan'), Filter.eq('LastName', 'Ivanov'))
+     * ```
+     */
+    and(...groups: IFilter[]): IFilterGroup;
+    /**
+     * Создает группу фильтров, где хотя бы одно условие должно быть выполнено
+     *
+     * @param groups Группа фильтров - указываются необходимые фильтры
+     *
+     * Поле `Name` должно быть равно `Ivan` или поле `Name` должно быть равно `Petr`
+     * **Пример**
+     *
+     * ```js
+     * Filter.or(Filter.eq('Name', 'Ivan'), Filter.eq('Name', 'Petr'))
+     * ```
+     */
+    or(...groups: IFilter[]): IFilterGroup;
+    /**
+     * Создает фильтр, который проверяет равенство значения поля заданному значению
+     *
+     * @param fieldPath Поле, по которому происходит фильтрация
+     * @param value Значение фильтра
+     *
+     * **Пример**
+     *
+     * Поле `Name` должно быть равно `Ivan`
+     * ```js
+     * Filter.eq('Name', 'Ivan')
+     * ```
+     */
+    eq(fieldPath: string, value: any): IFilterItem;
+    /**
+     * Создает фильтр, который проверяет неравенство значения поля заданному значению
+     *
+     * @param fieldPath Поле, по которому происходит фильтрация
+     * @param value Значение фильтра
+     *
+     * **Пример**
+     *
+     * Поле `Name` не должно быть равно `Ivan`
+     * ```js
+     * Filter.ne('Name', 'Ivan')
+     * ```
+     */
+    ne(fieldPath: string, value: any): IFilterItem;
+    /**
+     * Создает фильтр, который проверяет, что значение указанного поля больше заданного значения
+     *
+     * @param fieldPath Поле, по которому происходит фильтрация
+     * @param value Значение фильтра
+     *
+     * **Пример**
+     *
+     * Поле `SumOrder` должно быть больше `100000`
+     * ```js
+     * Filter.gt('SumOrder', 100000)
+     * ```
+     */
+    gt(fieldPath: string, value: any): IFilterItem;
+    /**
+     * Создает фильтр, который проверяет, что значение указанного поля больше или равно заданному значению
+     *
+     * @param fieldPath Поле, по которому происходит фильтрация
+     * @param value Значение фильтра
+     *
+     * **Пример**
+     *
+     * Поле `SumOrder` должно быть больше или равно `100000`
+     * ```js
+     * Filter.ge('SumOrder', 100000)
+     * ```
+     */
+    ge(fieldPath: string, value: any): IFilterItem;
+    /**
+     * Создает фильтр, который проверяет, что значение указанного поля меньше заданного значения
+     *
+     * @param fieldPath Поле, по которому происходит фильтрация
+     * @param value Значение фильтра
+     *
+     * **Пример**
+     *
+     * Поле `SumOrder` должно быть меньше `100000`
+     * ```js
+     * Filter.lt('SumOrder', 100000)
+     * ```
+     */
+    lt(fieldPath: string, value: any): IFilterItem;
+    /**
+     * Создает фильтр, который проверяет, что значение указанного поля меньше или равно заданному значению
+     *
+     * @param fieldPath Поле, по которому происходит фильтрация
+     * @param value Значение фильтра
+     *
+     * **Пример**
+     *
+     * Поле `SumOrder` должно быть меньше или равно `100000`
+     * ```js
+     * Filter.le('SumOrder', 100000)
+     * ```
+     */
+    le(fieldPath: string, value: any): IFilterItem;
+    /**
+     * Создает фильтр, который проверяет, начинается ли значение указанного поля с заданной подстроки
+     *
+     * @param fieldPath Поле, по которому происходит фильтрация
+     * @param value Подстрока, с которой должно начинаться значение
+     *
+     * **Пример**
+     *
+     * Поле `LastName` должно начинаться с `Al`
+     * ```js
+     * Filter.startsWith('LastName', 'Al')
+     * ```
+     */
+    startsWith(fieldPath: string, value: any): IFilterItem;
+    /**
+     * Создает фильтр, который проверяет, заканчивается ли значение указанного поля на заданную подстроку
+     *
+     * @param fieldPath Поле, по которому происходит фильтрация
+     * @param value Подстрока, с которой должно заканчиваться значение
+     *
+     * **Пример**
+     *
+     * Поле `LastName` должно заканчиваться на `ov`
+     * ```js
+     * Filter.endsWith('LastName', 'ov')
+     * ```
+     */
+    endsWith(fieldPath: string, value: any): IFilterItem;
+    /**
+     * Создает фильтр, который проверяет, содержит ли значение указанного поля заданную подстроку
+     *
+     * @param fieldPath Поле, по которому происходит фильтрация
+     * @param value Подстрока, которую должно содержать значение
+     *
+     * **Пример**
+     *
+     * Поле `LastName` должно содержать `an`
+     * ```js
+     * Filter.contains('LastName', 'an')
+     * ```
+     */
+    contains(fieldPath: string, value: any): IFilterItem;
+    /**
+     * Создает фильтр для полнотекстового поиска по указанному полю
+     *
+     * @param fieldPath Поле, по которому происходит фильтрация
+     * @param value Подстрока, которую должно содержать значение
+     *
+     * **Пример**
+     *
+     * Поле `Description` должно содержать `example`
+     * ```js
+     * Filter.fulltext('Description', 'example');
+     * ```
+     */
+    fulltext(fieldPath: string, value: any): IFilterItem;
+    /**
+     * Создает фильтр, который исключает значения, соответствующие указанному фильтру
+     *
+     * @param filter Фильтр
+     *
+     * **Пример**
+     *
+     * Поле `Name` должно содержать любое значение кроме `Ivan`
+     * ```js
+     * Filter.not(Filter.eq('Name', 'Ivan'))
+     * ```
+     */
+    not(filter: IFilterItem | IFilterIn): IFilterItem;
+    /**
+     * Фильтр, проверяющий, что поле содержит одно из перечисленных значений
+     *
+     * @param fieldPath Поле, по которому происходит фильтрация
+     * @param array Массив значений
+     *
+     * **Пример**
+     *
+     * Поле `Name` должно содержать либо значение `Ivan`, либо `Petr`
+     * ```js
+     * Filter.in('Name', ['Ivan', 'Petr'])
+     * ```
+     */
+    in(fieldPath: string, array: any[]): IFilterIn;
+    /**
+     * Строится фильтр для поля на основании значений из другой таблицы
+     * @param field Поле, по которому происходит фильтрация
+     * @param objectCode Код объекта, из которой берутся значения. Может быть таблицей, представлением, функцей и т.д.
+     * @param subField Поле, по которому происходит фильтрация в другой таблице
+     * @param filter Фильтр, который применяется к другой таблице
+     * @param args Аргументы для объекта (например для функции). Можно задать, например, в виде `{ Search: "Москва" }`.
+     *
+     * **Пример**
+     *
+     * Отфильтруется поле `Title` текущей таблицы по полю `Name` таблицы `mdt.Employee`, где поле `Name` равно `Ivan`
+     * ```js
+     * Filter.queryIn('Title', 'mdt.Employee', 'Name', Filter.eq('Name', 'Ivan'))
+     * ```
+     */
+    queryIn(field: string, objectCode: string, subField: string, filter?: IFilter, args?: any): IFilterIn;
+    /**
+     * Преобразует тип данных фильтра
+     *
+     * @param filter Фильтр
+     * @param cast Значение, к типу которого приводится фильтр
+     *
+     * **Пример**
+     *
+     * Значение поля `DateTime` приводится к типу `date` (`value` содержит значение типа `datetime`)
+     * ```js
+     * Filter.cast(Filter.eq('DateTime', value), 'date')
+     * ```
+     */
+    cast(filter: IFilter, cast: string): IFilter;
+    /**
+     * Проверка, что фильтр пустой
+     *
+     * **Пример**
+     *
+     * Проверка, что `filter` пустой
+     * ```js
+     * if (filter === Filter.empty) { ... }
+     * ```
+     */
+    empty: any;
+}
+export declare class Filter {
+    static empty: IFilter;
+    static isEmptyFilter(filter: IFilter): boolean;
+    static mergeFilters(orig: IFilter, filter: IFilter): IFilter;
+    static and(...groups: any[]): IFilterGroup;
+    static or(...groups: any[]): IFilterGroup;
+    static eq(p1: any, p2: any): IFilterItem;
+    static ne(p1: any, p2: any): IFilterItem;
+    static gt(p1: any, p2: any): IFilterItem;
+    static ge(p1: any, p2: any): IFilterItem;
+    static lt(p1: any, p2: any): IFilterItem;
+    static le(p1: any, p2: any): IFilterItem;
+    static startsWith(p1: any, p2: any): IFilterItem;
+    static endsWith(p1: any, p2: any): IFilterItem;
+    static contains(p1: any, p2: any): IFilterItem;
+    static fulltext(p1: any, p2: any): IFilterItem;
+    static not(f: any): IFilterItem;
+    static in(p1: any, ar: any): IFilterIn;
+    static queryIn(field: any, table: any, subField: any, filter?: any, args?: any): IFilterIn;
+    static cast(filter: any, cast: any): IFilter;
+    static equalTemplate(p1: any, p2: any): IFilter;
+    static isFilter(filter: unknown): filter is IFilter;
+    static isFilterGroup(filter: IFilter): filter is IFilterGroup;
+    static isFilterItem(filter: IFilter): filter is IFilterItem;
+    static isFilterIn(filter: IFilter): filter is IFilterIn;
+    static isFilterQueryIn(filter: IFilter): filter is IFilterQueryIn;
+    static getP2(filter: IFilter): string | number | QueryInValue | Date;
+}
+export {};