@snabcentr/common-lib 2.13.2 → 2.15.0

package/dist/src/user-regions/classes/user-region-short-info.d.ts

@@ -0,0 +1,18 @@
+import { NamedIdentity } from '../../system/classes/named-identity';
+import { IUserRegionShortInfo } from '../interfaces/i-user-region-short-info';
+/**
+ * Краткие данные о регионе пользователя.
+ */
+export declare class UserRegionShortInfo extends NamedIdentity implements IUserRegionShortInfo {
+    /**
+     * @inheritDoc
+     */
+    abbr: string;
+    /**
+     * Инициализирует экземпляр класса {@link UserRegionShortInfo}.
+     *
+     * @param data Данные для первоначальной инициализации.
+     */
+    constructor(data?: Partial<IUserRegionShortInfo>);
+}
+//# sourceMappingURL=user-region-short-info.d.ts.map

package/dist/src/user-regions/classes/user-region-short-info.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-region-short-info.d.ts","sourceRoot":"","sources":["../../../../src/user-regions/classes/user-region-short-info.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,sDAAsD,CAAC;AAE5F;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,aAAc,YAAW,oBAAoB;IAClF;;OAEG;IACI,IAAI,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;gBACgB,IAAI,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC;CAK1D"}

package/dist/src/user-regions/classes/user-region.d.ts

@@ -0,0 +1,24 @@
+import { ICityWithRegionAndCountry } from '../../references/interfaces/i-city-with-region-and-country';
+import { UserRegionShortInfo } from './user-region-short-info';
+import { IUserRegion } from '../interfaces/i-user-region';
+import { IUserRegionEmployee } from '../interfaces/i-user-region-employee';
+/**
+ * Полные данные о регионе пользователя.
+ */
+export declare class UserRegion extends UserRegionShortInfo implements IUserRegion {
+    /**
+     * @inheritDoc
+     */
+    cities: ICityWithRegionAndCountry[];
+    /**
+     * @inheritDoc
+     */
+    users: IUserRegionEmployee[];
+    /**
+     * Инициализирует экземпляр класса {@link UserRegion}.
+     *
+     * @param data Данные для первоначальной инициализации.
+     */
+    constructor(data?: Partial<IUserRegion>);
+}
+//# sourceMappingURL=user-region.d.ts.map

package/dist/src/user-regions/classes/user-region.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-region.d.ts","sourceRoot":"","sources":["../../../../src/user-regions/classes/user-region.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,yBAAyB,EAAE,MAAM,0DAA0D,CAAC;AAErG,OAAO,EAAE,mBAAmB,EAAE,MAAM,iDAAiD,CAAC;AACtF,OAAO,EAAE,WAAW,EAAE,MAAM,2CAA2C,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oDAAoD,CAAC;AAEzF;;GAEG;AACH,qBAAa,UAAW,SAAQ,mBAAoB,YAAW,WAAW;IACtE;;OAEG;IACI,MAAM,EAAE,yBAAyB,EAAE,CAAC;IAE3C;;OAEG;IACI,KAAK,EAAE,mBAAmB,EAAE,CAAC;IAEpC;;;;OAIG;gBACgB,IAAI,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC;CAMjD"}

package/dist/src/user-regions/classes/user-regions-list-filters.d.ts

@@ -0,0 +1,30 @@
+import { PaginationFiltersBase } from '../../pagination/filters/pagination-filters-base';
+import { IUserRegionsListFilters } from '../interfaces/i-user-regions-list-filters';
+/**
+ * Данные о параметрах фильтрации списка регионов пользователей.
+ */
+export declare class UserRegionsListFilters extends PaginationFiltersBase implements IUserRegionsListFilters {
+    /**
+     * @inheritDoc
+     */
+    id?: string;
+    /**
+     * @inheritDoc
+     */
+    name?: string;
+    /**
+     * @inheritDoc
+     */
+    abbr?: string;
+    /**
+     * Инициализирует экземпляр класса {@link UserRegionsListFilters}.
+     *
+     * @param data Данные для первоначальной инициализации.
+     */
+    constructor(data?: IUserRegionsListFilters);
+    /**
+     * @inheritDoc
+     */
+    resetFilterValue(key: string): this;
+}
+//# sourceMappingURL=user-regions-list-filters.d.ts.map

package/dist/src/user-regions/classes/user-regions-list-filters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-regions-list-filters.d.ts","sourceRoot":"","sources":["../../../../src/user-regions/classes/user-regions-list-filters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,gDAAgD,CAAC;AACvF,OAAO,EAAE,uBAAuB,EAAE,MAAM,yDAAyD,CAAC;AAElG;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,qBAAsB,YAAW,uBAAuB;IAChG;;OAEG;IACI,EAAE,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACI,IAAI,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACI,IAAI,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;gBACgB,IAAI,CAAC,EAAE,uBAAuB;IAQjD;;OAEG;IACI,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;CAc7C"}

package/dist/src/user-regions/index.d.ts

@@ -0,0 +1,4 @@
+export * from './interfaces';
+export * from './classes';
+export * from './providers';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/user-regions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/user-regions/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC"}

package/dist/src/user-regions/interfaces/i-user-region-employee.d.ts

@@ -0,0 +1,16 @@
+import { ISalesDirection } from '../../references/interfaces/i-sales-direction';
+import { IUserShortInfo } from '../../user/interfaces/i-user-short-info';
+/**
+ * Данные о закреплении сотрудника за регионом пользователей по направлению продаж.
+ */
+export interface IUserRegionEmployee {
+    /**
+     * Данные о сотруднике.
+     */
+    user: IUserShortInfo;
+    /**
+     * Направление продаж, по которому сотрудник закреплён за регионом.
+     */
+    salesDirection: ISalesDirection;
+}
+//# sourceMappingURL=i-user-region-employee.d.ts.map

package/dist/src/user-regions/interfaces/i-user-region-employee.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-user-region-employee.d.ts","sourceRoot":"","sources":["../../../../src/user-regions/interfaces/i-user-region-employee.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6CAA6C,CAAC;AAC9E,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,cAAc,EAAE,eAAe,CAAC;CACnC"}

package/dist/src/user-regions/interfaces/i-user-region-save-data.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Данные для создания или изменения региона пользователей.
+ */
+export interface IUserRegionSaveData {
+    /**
+     * Название региона.
+     */
+    name: string;
+    /**
+     * Сокращённое название региона.
+     */
+    abbr: string;
+    /**
+     * Полный список идентификаторов городов региона.
+     */
+    cities: number[];
+}
+//# sourceMappingURL=i-user-region-save-data.d.ts.map

package/dist/src/user-regions/interfaces/i-user-region-save-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-user-region-save-data.d.ts","sourceRoot":"","sources":["../../../../src/user-regions/interfaces/i-user-region-save-data.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;CACpB"}

package/dist/src/user-regions/interfaces/i-user-region-short-info.d.ts

@@ -0,0 +1,11 @@
+import { INamedIdentity } from '../../system/interfaces/i-named-identity';
+/**
+ * Краткие данные о регионе пользователя.
+ */
+export interface IUserRegionShortInfo extends INamedIdentity {
+    /**
+     * Сокращённое название региона.
+     */
+    abbr: string;
+}
+//# sourceMappingURL=i-user-region-short-info.d.ts.map

package/dist/src/user-regions/interfaces/i-user-region-short-info.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-user-region-short-info.d.ts","sourceRoot":"","sources":["../../../../src/user-regions/interfaces/i-user-region-short-info.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,wCAAwC,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IACxD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CAChB"}

package/dist/src/user-regions/interfaces/i-user-region.d.ts

@@ -0,0 +1,17 @@
+import { ICityWithRegionAndCountry } from '../../references/interfaces/i-city-with-region-and-country';
+import { IUserRegionEmployee } from './i-user-region-employee';
+import { IUserRegionShortInfo } from './i-user-region-short-info';
+/**
+ * Полные данные о регионе пользователя.
+ */
+export interface IUserRegion extends IUserRegionShortInfo {
+    /**
+     * Список городов, закреплённых за регионом.
+     */
+    cities: ICityWithRegionAndCountry[];
+    /**
+     * Список сотрудников, закреплённых за регионом.
+     */
+    users: IUserRegionEmployee[];
+}
+//# sourceMappingURL=i-user-region.d.ts.map

package/dist/src/user-regions/interfaces/i-user-region.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-user-region.d.ts","sourceRoot":"","sources":["../../../../src/user-regions/interfaces/i-user-region.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,0DAA0D,CAAC;AACrG,OAAO,EAAE,mBAAmB,EAAE,MAAM,oDAAoD,CAAC;AACzF,OAAO,EAAE,oBAAoB,EAAE,MAAM,sDAAsD,CAAC;AAE5F;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,oBAAoB;IACrD;;OAEG;IACH,MAAM,EAAE,yBAAyB,EAAE,CAAC;IAEpC;;OAEG;IACH,KAAK,EAAE,mBAAmB,EAAE,CAAC;CAChC"}

package/dist/src/user-regions/interfaces/i-user-regions-list-filters.d.ts

@@ -0,0 +1,19 @@
+import { IPaginationFiltersBase } from '../../pagination/filters/i-pagination-filters-base';
+/**
+ * Данные о параметрах фильтрации списка регионов пользователей.
+ */
+export interface IUserRegionsListFilters extends IPaginationFiltersBase {
+    /**
+     * Идентификатор региона.
+     */
+    id?: string;
+    /**
+     * Название региона.
+     */
+    name?: string;
+    /**
+     * Сокращённое название региона.
+     */
+    abbr?: string;
+}
+//# sourceMappingURL=i-user-regions-list-filters.d.ts.map

package/dist/src/user-regions/interfaces/i-user-regions-list-filters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-user-regions-list-filters.d.ts","sourceRoot":"","sources":["../../../../src/user-regions/interfaces/i-user-regions-list-filters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,kDAAkD,CAAC;AAE1F;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,sBAAsB;IACnE;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/src/user-regions/interfaces/index.d.ts

@@ -0,0 +1,6 @@
+export * from './i-user-region';
+export * from './i-user-region-employee';
+export * from './i-user-region-save-data';
+export * from './i-user-region-short-info';
+export * from './i-user-regions-list-filters';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/user-regions/interfaces/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/user-regions/interfaces/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,+BAA+B,CAAC"}

package/dist/src/user-regions/providers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './user-region-provider';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/user-regions/providers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/user-regions/providers/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC"}

package/dist/src/user-regions/providers/user-region-provider.d.ts

@@ -0,0 +1,93 @@
+import { IPaginatedResponse } from '../../pagination/interfaces/i-paginated-response';
+import { BasePaginationProvider } from '../../pagination/providers/base-pagination-provider';
+import { IFilterGroup } from '../../table-data/interfaces/i-filter-group';
+import { IPaginationRequestParams } from '../../table-data/interfaces/i-pagination-request-params';
+import { ISortRequestParams } from '../../table-data/interfaces/i-sort-request-params';
+import { IUserRegion } from '../interfaces/i-user-region';
+import { IUserRegionEmployee } from '../interfaces/i-user-region-employee';
+import { IUserRegionSaveData } from '../interfaces/i-user-region-save-data';
+import { IUserRegionShortInfo } from '../interfaces/i-user-region-short-info';
+import { IFieldValidationResultData } from '../../validation/interfaces/i-field-validation-result-data';
+/**
+ * Предоставляет механизмы получения/управления регионами пользователей.
+ */
+export declare class UserRegionProvider extends BasePaginationProvider {
+    /**
+     * Возвращает список регионов пользователей.
+     *
+     * @param filters Параметры фильтрации данных.
+     * @param sortParams Параметры сортировки.
+     * @param paginationParams Параметры пагинации.
+     *
+     * @see /doc/api/internal#/operations/api_internal_user_region_get_list
+     */
+    getRegionsList(filters?: IFilterGroup, sortParams?: ISortRequestParams[] | ISortRequestParams, paginationParams?: IPaginationRequestParams): Promise<IPaginatedResponse<IUserRegionShortInfo>>;
+    /**
+     * Возвращает полные данные о регионе пользователей.
+     *
+     * @param regionId Идентификатор региона.
+     *
+     * @see /doc/api/internal#/operations/api_internal_user_region_get
+     */
+    getRegion(regionId: number): Promise<IUserRegion>;
+    /**
+     * Создаёт новый регион пользователей.
+     *
+     * @param data Данные для создания региона.
+     * @param validationFieldResultData Список полей, для которых необходимо
+     *                                  установить данные об ошибках валидации
+     *                                  в случае ошибок в запросах.
+     *
+     * @see /doc/api/internal#/operations/api_internal_user_region_create
+     */
+    createRegion(data: IUserRegionSaveData, validationFieldResultData?: Record<string, IFieldValidationResultData>): Promise<IUserRegion>;
+    /**
+     * Изменяет данные о регионе пользователей.
+     *
+     * @param regionId Идентификатор региона.
+     * @param data Данные для изменения региона.
+     * @param validationFieldResultData Список полей, для которых необходимо
+     *                                  установить данные об ошибках валидации
+     *                                  в случае ошибок в запросах.
+     *
+     * @see /doc/api/internal#/operations/api_internal_user_region_change
+     */
+    updateRegion(regionId: number, data: IUserRegionSaveData, validationFieldResultData?: Record<string, IFieldValidationResultData>): Promise<IUserRegion>;
+    /**
+     * Удаляет регион пользователей.
+     *
+     * @param regionId Идентификатор региона.
+     *
+     * @see /doc/api/internal#/operations/api_internal_user_region_delete
+     */
+    removeRegion(regionId: number): Promise<void>;
+    /**
+     * Возвращает список сотрудников, закреплённых за регионом.
+     *
+     * @param regionId Идентификатор региона.
+     *
+     * @see /doc/api/internal#/operations/api_internal_user_region_user_get_list
+     */
+    getRegionEmployees(regionId: number): Promise<IUserRegionEmployee[]>;
+    /**
+     * Закрепляет сотрудника за регионом по указанному направлению продаж.
+     *
+     * @param regionId Идентификатор региона.
+     * @param userId Идентификатор сотрудника.
+     * @param salesDirectionId Идентификатор направления продаж.
+     *
+     * @see /doc/api/internal#/operations/api_internal_user_region_user_add
+     */
+    attachRegionEmployee(regionId: number, userId: number, salesDirectionId: number): Promise<IUserRegionEmployee>;
+    /**
+     * Открепляет сотрудника от региона по указанному направлению продаж.
+     *
+     * @param regionId Идентификатор региона.
+     * @param userId Идентификатор сотрудника.
+     * @param salesDirectionId Идентификатор направления продаж.
+     *
+     * @see /doc/api/internal#/operations/api_internal_user_region_user_delete
+     */
+    detachRegionEmployee(regionId: number, userId: number, salesDirectionId: number): Promise<void>;
+}
+//# sourceMappingURL=user-region-provider.d.ts.map

package/dist/src/user-regions/providers/user-region-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-region-provider.d.ts","sourceRoot":"","sources":["../../../../src/user-regions/providers/user-region-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,EAAE,sBAAsB,EAAE,MAAM,mDAAmD,CAAC;AAC3F,OAAO,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AACxE,OAAO,EAAE,wBAAwB,EAAE,MAAM,uDAAuD,CAAC;AACjG,OAAO,EAAE,kBAAkB,EAAE,MAAM,iDAAiD,CAAC;AAIrF,OAAO,EAAE,WAAW,EAAE,MAAM,2CAA2C,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oDAAoD,CAAC;AACzF,OAAO,EAAE,mBAAmB,EAAE,MAAM,qDAAqD,CAAC;AAC1F,OAAO,EAAE,oBAAoB,EAAE,MAAM,sDAAsD,CAAC;AAC5F,OAAO,EAAE,0BAA0B,EAAE,MAAM,0DAA0D,CAAC;AAEtG;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,sBAAsB;IAC1D;;;;;;;;OAQG;IACI,cAAc,CACjB,OAAO,CAAC,EAAE,YAAY,EACtB,UAAU,CAAC,EAAE,kBAAkB,EAAE,GAAG,kBAAkB,EACtD,gBAAgB,CAAC,EAAE,wBAAwB,GAC5C,OAAO,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,CAAC;IAUpD;;;;;;OAMG;IACI,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAIxD;;;;;;;;;OASG;IACI,YAAY,CAAC,IAAI,EAAE,mBAAmB,EAAE,yBAAyB,GAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAIhJ;;;;;;;;;;OAUG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,yBAAyB,GAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAIlK;;;;;;OAMG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpD;;;;;;OAMG;IACI,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAM3E;;;;;;;;OAQG;IACI,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAIrH;;;;;;;;OAQG;IACI,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAQzG"}

package/package.json

@@ -4,7 +4,7 @@
     "keywords": [],
     "author": "Sergey S. Smirnov <dev@snabcentr.com>",
     "type": "module",
-    "version": "2.13.2",
+    "version": "2.15.0",
     "license": "ISC",
     "scripts": {
         "dev": "vite",