@snabcentr/client-core 3.7.0 → 4.0.0

package/auth/index.d.ts

@@ -1,3 +0,0 @@
-export * from './interfaces';
-export * from './tokens';
-export * from './services';

package/auth/interfaces/index.d.ts

@@ -1,5 +0,0 @@
-export * from './sc-i-login';
-export * from './sc-i-phone-login';
-export * from './sc-i-token';
-export * from './sc-i-auth-token';
-export * from './sc-i-api-error-response';

package/auth/interfaces/sc-i-api-error-response.d.ts

@@ -1,13 +0,0 @@
-/**
- * Данные об ошибках валидации API запросов.
- */
-export interface ScIApiErrorResponse {
-    /**
-     * Обобщённое сообщение об ошибке.
-     */
-    message: string;
-    /**
-     * Подробное описание каждой ошибки. Содержит список полей с детальным описанием ошибок валидации для каждого поля.
-     */
-    errors?: Record<string, string[]>;
-}

package/auth/interfaces/sc-i-auth-token.d.ts

@@ -1,14 +0,0 @@
-import { IToken } from './sc-i-token';
-/**
- * Модель данных ключей аутентификации.
- */
-export interface IAuthToken {
-    /**
-     * Данные о ключе доступа.
-     */
-    access: IToken;
-    /**
-     * Данные об одноразовом ключе для обновления ключа доступа.
-     */
-    refresh: IToken;
-}

package/auth/interfaces/sc-i-login.d.ts

@@ -1,13 +0,0 @@
-/**
- * Модель учётных данных пользователя для аутентификации.
- */
-export interface ILogin {
-    /**
-     * Логин.
-     */
-    login: string;
-    /**
-     * Пароль.
-     */
-    password: string;
-}

package/auth/interfaces/sc-i-phone-login.d.ts

@@ -1,13 +0,0 @@
-/**
- * Модель учётных данных пользователя для аутентификации по номеру телефона.
- */
-export interface IPhoneLogin {
-    /**
-     * Номер телефона.
-     */
-    phone: string;
-    /**
-     * Код подтверждения.
-     */
-    verificationCode: string;
-}

package/auth/interfaces/sc-i-token.d.ts

@@ -1,13 +0,0 @@
-/**
- * Модель данных ключа со сроком действия.
- */
-export interface IToken {
-    /**
-     * Ключ доступа.
-     */
-    token: string;
-    /**
-     * Дата и время завершения срока действия ключа.
-     */
-    expiredAt: Date;
-}

package/auth/services/index.d.ts

@@ -1,2 +0,0 @@
-export * from './sc-token.service';
-export * from './sc-auth.service';

package/auth/services/sc-auth.service.d.ts

@@ -1,78 +0,0 @@
-import { HttpClient } from '@angular/common/http';
-import { Observable } from 'rxjs';
-import { ScIApiKeys } from '../../config/sc-i-api-keys';
-import { ScIUrls } from '../../config/sc-i-urls';
-import { ScUserMetrikaService } from '../../user-metrika';
-import { IAuthToken, ILogin, IPhoneLogin, IToken } from '../interfaces';
-import { ScTokenService } from './sc-token.service';
-import * as i0 from "@angular/core";
-/**
- * Сервис аутентификации пользователей.
- */
-export declare class ScAuthService {
-    private readonly http;
-    private readonly urls;
-    private readonly apiKeys;
-    private readonly tokenService;
-    private readonly userMetrikaService;
-    /**
-     * {@link ReplaySubject} для событийной модели сервиса аутентификации.
-     */
-    private authSubject;
-    /**
-     * Признак, что скрипт выполняется на сервере.
-     */
-    private readonly isServer;
-    /**
-     * Ограничивает жизнь подписок из конструктора инжектором (актуально для unit-тестов).
-     */
-    private readonly destroyRef;
-    /**
-     * Инициализирует экземпляр класса {@link ScAuthService}.
-     *
-     * @param http HTTP-клиент.
-     * @param urls Список ссылок на разделы backend'a.
-     * @param apiKeys Заголовки ключей доступа к API.
-     * @param tokenService Сервис ключей аутентификации.
-     * @param userMetrikaService Сервис для сбора метрик о действиях пользователей.
-     */
-    constructor(http: HttpClient, urls: ScIUrls, apiKeys: ScIApiKeys, tokenService: ScTokenService, userMetrikaService: ScUserMetrikaService);
-    /**
-     * Возвращает {@link Observable} состояния аутентификации, чтобы реагировать на изменения.
-     */
-    getAuthChange(): Observable<boolean>;
-    /**
-     * Возвращает {@link Observable} запроса аутентификации пользователя.
-     *
-     * @param user Данные для аутентификации пользователя по email.
-     */
-    getSignIn$(user: ILogin): Observable<IAuthToken>;
-    /**
-     * Возвращает {@link Observable} запроса аутентификации пользователя.
-     *
-     * @param user Данные для аутентификации пользователя по номеру телефона.
-     */
-    getSignIn$(user: IPhoneLogin): Observable<IAuthToken>;
-    /**
-     * Возвращает {@link Observable} запроса завершения аутентификации пользователя.
-     *
-     * @param removeAuthToken Признак, что необходимо удалить ключ аутентификации.
-     */
-    getSignOut$(removeAuthToken?: boolean): Observable<undefined>;
-    /**
-     * Выполняет запрос завершения аутентификации пользователя.
-     */
-    signOut(): void;
-    /**
-     * Возвращает {@link Observable} запроса повторной аутентификации пользователя и обновления ключа аутентификации.
-     *
-     * @param refreshTokens Ключи доступа к API, и обновления сессии доступа к API. Если ключи не переданы, берёт их из {@link Storage}.
-     */
-    getRefreshToken$(refreshTokens?: IAuthToken): Observable<IAuthToken>;
-    /**
-     * Возвращает {@link Observable} запроса получения гостевого ключа.
-     */
-    getGuestToken$(): Observable<IToken>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ScAuthService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ScAuthService>;
-}

package/auth/services/sc-token.service.d.ts

@@ -1,79 +0,0 @@
-import { HttpRequest } from '@angular/common/http';
-import { Observable } from 'rxjs';
-import { ScIApiKeys } from '../../config';
-import { IAuthToken, IToken } from '../interfaces';
-import * as i0 from "@angular/core";
-/**
- * Сервис для работы с ключами аутентификации.
- */
-export declare class ScTokenService {
-    private readonly event$;
-    private readonly storageService;
-    private readonly guestStorageKey;
-    private readonly accessAuthStorageKey;
-    private readonly refreshAuthStorageKey;
-    private readonly isBrowser;
-    private readonly storage?;
-    /**
-     * {@link Observable} ключа доступа гостя к API в {@link Storage}.
-     */
-    readonly guestToken$: Observable<string | null>;
-    /**
-     * {@link Observable} ключа доступа пользователя к API в {@link Storage}.
-     */
-    readonly accessAuthToken$: Observable<string | null>;
-    private readonly apiKeys;
-    /**
-     * Инициализирует экземпляр класса {@link ScTokenService}.
-     *
-     * @param event$ {@link Observable} Событие изменения в {@link Storage}.
-     * @param apiKeys Заголовки ключей доступа к API.
-     * @param storageService Сервис для работы с {@link Storage} и внедрению его через DI.
-     * @param guestStorageKey Токен, указывающий ключ токена доступа гостя к API в {@link Storage}.
-     * @param accessAuthStorageKey Ключ доступа пользователя к API в {@link Storage}.
-     * @param refreshAuthStorageKey Ключ обновления ключа доступа к API в {@link Storage}.
-     * @param isBrowser Признак, что скрипт выполняется в браузере.
-     * @param storage Хранилище {@link Storage}.
-     */
-    constructor(event$: Observable<StorageEvent>, apiKeys: ScIApiKeys | null, storageService: Storage, guestStorageKey: string, accessAuthStorageKey: string, refreshAuthStorageKey: string, isBrowser: boolean, storage?: Storage | undefined);
-    /**
-     * Возвращает ключ доступа к API.
-     */
-    getAccessToken(): string | null;
-    /**
-     * Возвращает одноразовый ключ для обновления ключа доступа.
-     */
-    getRefreshToken(): string | null;
-    /**
-     * Устанавливает ключ доступа пользователя к API или ресурсу.
-     *
-     * @param token Ключ доступа пользователя к API или ресурсу.
-     */
-    setAuthToken(token: IAuthToken): void;
-    /**
-     * Удаляет ключ доступа пользователя к API или ресурсу.
-     */
-    removeAuthToken(): void;
-    /**
-     * Возвращает ключ доступа пользователя к API или ресурсу в роли Гостя.
-     */
-    getGuestToken(): string | null;
-    /**
-     * Устанавливает ключ доступа пользователя к API или ресурсу в роли Гостя.
-     *
-     * @param tokenObject Ключ доступа пользователя к API или ресурсу в роли Гостя.
-     */
-    setGuestToken(tokenObject: IToken): void;
-    /**
-     * Удаляет ключ доступа пользователя к API или ресурсу в роли Гостя.
-     */
-    removeGuestToken(): void;
-    /**
-     * Добавляет в запрос заголовок для аутентификации пользователя или Гостя.
-     *
-     * @param request Данные запроса.
-     */
-    addAuthHeader(request: HttpRequest<any>): HttpRequest<any>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ScTokenService, [null, { optional: true; }, null, null, null, null, null, { optional: true; }]>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ScTokenService>;
-}

package/auth/tokens/index.d.ts

@@ -1,3 +0,0 @@
-export * from './sc-access-auth-token-storage-key';
-export * from './sc-guest-token-storage-key';
-export * from './sc-refresh-auth-token-storage-key';

package/auth/tokens/sc-access-auth-token-storage-key.d.ts

@@ -1,5 +0,0 @@
-import { InjectionToken } from '@angular/core';
-/**
- * Токен, указывающий ключ токена доступа пользователя к API в {@link Storage}.
- */
-export declare const SC_ACCESS_AUTH_TOKEN_STORAGE_KEY: InjectionToken<string>;

package/auth/tokens/sc-guest-token-storage-key.d.ts

@@ -1,5 +0,0 @@
-import { InjectionToken } from '@angular/core';
-/**
- * Токен, указывающий ключ токена доступа гостя к API в {@link Storage}.
- */
-export declare const SC_GUEST_TOKEN_STORAGE_KEY: InjectionToken<string>;

package/auth/tokens/sc-refresh-auth-token-storage-key.d.ts

@@ -1,5 +0,0 @@
-import { InjectionToken } from '@angular/core';
-/**
- * Токен, указывающий ключ для обновления ключа доступа к API в {@link Storage}.
- */
-export declare const SC_REFRESH_AUTH_TOKEN_STORAGE_KEY: InjectionToken<string>;

package/banners/dto/index.d.ts

@@ -1,2 +0,0 @@
-export * from './sc-i-banner';
-export * from './sc-banner';

package/banners/dto/sc-banner.d.ts

@@ -1,56 +0,0 @@
-import { ScIBanner } from './sc-i-banner';
-/**
- * Данные баннера.
- */
-export declare class ScBanner implements ScIBanner {
-    /**
-     * Идентификатор баннера.
-     */
-    id: number;
-    /**
-     * Местоположения баннера на странице пользователя.
-     */
-    location: string;
-    /**
-     * Тип медиафайла.
-     */
-    mediaType: 'image' | 'video';
-    /**
-     * Относительный путь к медиафайлу баннера.
-     */
-    mediaFile: string;
-    /**
-     * Относительный путь к медиафайлу баннера в формате WebP.
-     */
-    mediaFileWebp?: string;
-    /**
-     * Заголовок баннера.
-     */
-    title: string;
-    /**
-     * Ссылка, на которую должен вести баннер.
-     */
-    url: string;
-    /**
-     * Ширина баннера в px.
-     */
-    width: number;
-    /**
-     * Высота баннера в px.
-     */
-    height: number;
-    /**
-     * Инициализирует экземпляр класса {@link ScBanner}.
-     *
-     * @param data Данные для инициализации.
-     */
-    constructor(data: ScIBanner);
-    /**
-     * Возвращает признак того, что баннер является изображением.
-     */
-    get isImage(): boolean;
-    /**
-     * Возвращает признак того, что баннер является видео.
-     */
-    get isVideo(): boolean;
-}

package/banners/dto/sc-i-banner.d.ts

@@ -1,41 +0,0 @@
-/**
- * Данные баннера.
- */
-export interface ScIBanner {
-    /**
-     * Идентификатор баннера.
-     */
-    id: number;
-    /**
-     * Местоположения баннера на странице пользователя.
-     */
-    location: string;
-    /**
-     * Тип медиафайла.
-     */
-    mediaType: 'image' | 'video';
-    /**
-     * Относительный путь к медиафайлу баннера.
-     */
-    mediaFile: string;
-    /**
-     * Относительный путь к медиафайлу баннера в формате WebP.
-     */
-    mediaFileWebp?: string;
-    /**
-     * Заголовок баннера.
-     */
-    title: string;
-    /**
-     * Ссылка, на которую должен вести баннер.
-     */
-    url: string;
-    /**
-     * Ширина баннера в px.
-     */
-    width: number;
-    /**
-     * Высота баннера в px.
-     */
-    height: number;
-}

package/banners/index.d.ts

@@ -1,2 +0,0 @@
-export * from './dto';
-export * from './services/sc-banner.service';

package/banners/services/sc-banner.service.d.ts

@@ -1,22 +0,0 @@
-import { Observable } from 'rxjs';
-import { ScBanner } from '../dto/sc-banner';
-import * as i0 from "@angular/core";
-/**
- * Сервис для работы с баннерами.
- */
-export declare class ScBannerService {
-    /**
-     * HTTP-клиент.
-     */
-    private readonly http;
-    /**
-     * Список ссылок приложения.
-     */
-    private readonly urls;
-    /**
-     * Список баннеров.
-     */
-    readonly banners$: Observable<ScBanner[]>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ScBannerService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ScBannerService>;
-}

package/cart/classes/index.d.ts

@@ -1,2 +0,0 @@
-export * from './sc-sum';
-export * from './sc-cart';

package/cart/classes/sc-cart.d.ts

@@ -1,26 +0,0 @@
-import { ScOrderItem } from '../../order/classes/sc-order-item';
-import { ScICart } from '../internal';
-import { ScSum } from '.';
-/**
- * Данные о содержимом корзины.
- */
-export declare class ScCart {
-    /**
-     * Список позиций товаров/услуг в корзине.
-     */
-    items: ScOrderItem[];
-    /**
-     * Итоговая стоимость корзины в рублях.
-     */
-    resultSum: ScSum;
-    /**
-     * Список итоговых сумм по направлениям продаж.
-     */
-    directionsSum: Record<number, ScSum>;
-    /**
-     * Инициализирует экземпляр класса {@link ScCart}.
-     *
-     * @param data Данные для первоначальной инициализации.
-     */
-    constructor(data?: ScICart);
-}

package/cart/classes/sc-sum.d.ts

@@ -1,12 +0,0 @@
-/**
- * Данные об итоговой сумме.
- */
-export declare class ScSum {
-    rub: number;
-    /**
-     * Инициализирует экземпляр класса {@link ScSum}.
-     *
-     * @param rub Итоговая сумма в рублях.
-     */
-    constructor(rub?: number);
-}

package/cart/constants/index.d.ts

@@ -1 +0,0 @@
-export * from './sc-empty-cart';

package/cart/constants/sc-empty-cart.d.ts

@@ -1,7 +0,0 @@
-export declare const EMPTY_CART: {
-    items: never[];
-    result_sum: {
-        rub: number;
-    };
-    directions_sum: {};
-};

package/cart/index.d.ts

@@ -1,4 +0,0 @@
-export * from './constants';
-export * from './classes';
-export * from './internal';
-export * from './services';

package/cart/internal/index.d.ts

@@ -1 +0,0 @@
-export * from './sc-i-cart';

package/cart/internal/sc-i-cart.d.ts

@@ -1,19 +0,0 @@
-import { ScIOrderItem } from '../../order/internal/sc-i-order-item';
-import { ScSum } from '../classes';
-/**
- * Данные о содержимом корзины.
- */
-export interface ScICart {
-    /**
-     * Список позиций товаров/услуг в корзине.
-     */
-    items: ScIOrderItem[];
-    /**
-     * Итоговая стоимость корзины в рублях.
-     */
-    resultSum: ScSum;
-    /**
-     * Список итоговых сумм по направлениям продаж.
-     */
-    directionsSum: Record<number, ScSum>;
-}

package/cart/services/index.d.ts

@@ -1 +0,0 @@
-export * from './sc-cart.service';

package/cart/services/sc-cart.service.d.ts

@@ -1,113 +0,0 @@
-import { Observable } from 'rxjs';
-import { ScUploadedFile } from '../../contacts/dto/sc-uploaded-file';
-import { ScOrder } from '../../order/classes/sc-order';
-import { ScOrderItem } from '../../order/classes/sc-order-item';
-import { ScINewOrderItemBase } from '../../order/internal/sc-i-new-order-item-base';
-import { ScIOrderEditorLoader } from '../../order/internal/sc-i-order-loader';
-import { ScOrderLoading } from '../../order/tokens/sc-order-loader.token';
-import { ScCart } from '../classes/sc-cart';
-import * as i0 from "@angular/core";
-/**
- * Данные о сервисе корзины.
- */
-export declare class ScCartService implements ScIOrderEditorLoader<ScOrderItem, ScCart> {
-    /**
-     * {@link ReplaySubject} для содержимого корзины.
-     */
-    private cartCachedItem$;
-    /**
-     * Признак, что скрипт выполняется в браузере.
-     */
-    private readonly isBrowser;
-    /**
-     * {@link Observable} данных о текущем пользователе.
-     */
-    private readonly user$;
-    /**
-     * HTTP-клиент.
-     */
-    private readonly http;
-    /**
-     * Список ссылок приложения.
-     */
-    private readonly urls;
-    /**
-     * Сервис для работы с UI.
-     */
-    private readonly uiService;
-    /**
-     * Сервис для работы со складами.
-     */
-    private readonly warehouseService;
-    /**
-     * Сервис для сбора метрик о действиях пользователей.
-     */
-    private readonly userMetrikaService;
-    /**
-     * Инициализирует экземпляр класса {@link ScCartService}.
-     */
-    constructor();
-    /**
-     * Создаёт запрос получения содержимого корзины и обновляет корзину, возвращая {@link Observable} содержимого корзины.
-     */
-    private getCartData$;
-    /**
-     * Возвращает полную информацию о корзине (контекст загрузчика).
-     */
-    get$(): Observable<ScCart | ScOrderLoading>;
-    /**
-     * Возвращает список элементов корзины.
-     */
-    getItems$(): Observable<ScOrderItem[] | ScOrderLoading>;
-    /**
-     * Добавляет продукт в корзину.
-     *
-     * @param data Данные добавляемого продукта.
-     */
-    addProduct$(data: ScINewOrderItemBase): Observable<ScCart>;
-    /**
-     * Изменяет продукт в корзине.
-     *
-     * @param id Идентификатор позиции.
-     * @param patch Частичные данные для обновления.
-     */
-    updateProduct$(id: string, patch: Omit<ScINewOrderItemBase, 'productId'>): Observable<ScCart>;
-    /**
-     * Удаляет продукт из корзины.
-     *
-     * @param item Удаляемая позиция.
-     */
-    deleteProduct$(item: ScOrderItem): Observable<ScCart>;
-    /**
-     * Создаёт запрос очистки корзины.
-     */
-    clearCart$(): Observable<undefined>;
-    /**
-     * Обновляет корзину.
-     */
-    updateCart(): void;
-    /**
-     * Возвращает {@link Observable} позиций в корзине с товарами, которые были удалены из прайс-лита и больше не продаются.
-     *
-     * @deprecated
-     */
-    getNullCartItems$(): Observable<ScOrderItem[] | ScOrderLoading>;
-    /**
-     * Возвращает объект {@link ScCart} корзины, созданный из объекта заказа.
-     *
-     * @param order Данные о заказе.
-     */
-    getCartByOrder(order: ScOrder): ScCart;
-    /**
-     * Возвращает пример CSV файла для добавления продуктов в корзину.
-     */
-    getCartCsvExample$(): Observable<Blob>;
-    /**
-     * Добавляет товары в корзину из файла CSV.
-     *
-     * @param file Загружаемый файл в формате base64.
-     */
-    addProductsFromCsv$(file: ScUploadedFile): Observable<ScCart>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ScCartService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ScCartService>;
-}

package/catalog/classes/index.d.ts

@@ -1,3 +0,0 @@
-export * from './sc-cached-data';
-export * from './sc-cached-item';
-export * from './sc-catalog-item';

package/catalog/classes/sc-cached-data.d.ts

@@ -1,25 +0,0 @@
-/**
- * Модель закэшированных данных.
- */
-export declare class ScCachedData<T> {
-    /**
-     * Время загрузки данных.
-     */
-    loadedAt: Date;
-    /**
-     * Кэшируемые данные.
-     */
-    data: T;
-    /**
-     * Инициализирует экземпляр класса {@link ScCachedData}.
-     *
-     * @param data данные, которые необходимо закэшировать.
-     */
-    constructor(data: T);
-    /**
-     * Возвращает признак того, что кэшированные данные актуальны.
-     *
-     * @param lifeTime Срок жизни данных в ms.
-     */
-    cachedDataIsActual(lifeTime: number): boolean;
-}