@up-im/medotvet_sdk 0.0.1

package/dist/api/push.d.ts

@@ -0,0 +1,54 @@
+import { ApiAbstract } from "./abstract";
+import { iPagingItems } from "../interfaces/iPagingItems";
+import { iPush } from "../interfaces/iPush";
+import { iFilter } from "../interfaces/iFilter";
+import { iAppStore } from "../interfaces/iAppStore";
+export declare class ApiPush extends ApiAbstract {
+    /**
+     * список пушей
+     * * @param {number} page - отсчет страниц с первой, чтобы не было путаницы
+     */
+    getList<Keys extends keyof iPush>({ page, filters, select, }: {
+        page: number;
+        filters?: iFilter<iPush>;
+        select: Keys[];
+    }): Promise<iPagingItems<Pick<iPush, Keys>, {
+        [key: string]: unknown;
+    } | undefined>>;
+    /**
+     * количество непрочитанных пушей
+     */
+    countNew(): Promise<{
+        totalItems: number;
+    }>;
+    /**
+     * Пометить пуш просмотренным
+     * * @param {number} props.pushId - id пуша
+     */
+    view({ pushId }: {
+        pushId: number;
+    }): Promise<void>;
+    /**
+     * Пометить все пуши просмотренными
+     */
+    viewAll(): Promise<void>;
+    /**
+     * добавления токена для пуш уведомления
+     * * @param {number} props.token - сумма выплаты
+     * * @param {number} props.appStore - магазин приложений
+     */
+    register(props: {
+        token: string;
+        appStore: iAppStore;
+    }): Promise<void>;
+    /**
+     * отписка от пуш уведомлений
+     */
+    unsubscribe(): Promise<void>;
+    /**
+     * статус подписки на пуш уведомления
+     */
+    isSubscribed(): Promise<{
+        subscribed: boolean;
+    }>;
+}

package/dist/api/push.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiPush = void 0;
+const abstract_1 = require("./abstract");
+const apiRoute_1 = require("../http/apiRoute");
+const apiError_1 = require("../http/apiError");
+class ApiPush extends abstract_1.ApiAbstract {
+    /**
+     * список пушей
+     * * @param {number} page - отсчет страниц с первой, чтобы не было путаницы
+     */
+    async getList({ page = 1, filters, select, }) {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        return await this.fetcher({
+            route: (0, apiRoute_1.apiRoutePushList)({
+                page,
+                filters,
+                sorters: ["id desc"],
+                select
+            }),
+            options: { addToken: true }
+        });
+    }
+    /**
+     * количество непрочитанных пушей
+     */
+    async countNew() {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        return await this.fetcher({
+            route: apiRoute_1.apiRoutePushCountNew,
+            options: { addToken: true }
+        });
+    }
+    /**
+     * Пометить пуш просмотренным
+     * * @param {number} props.pushId - id пуша
+     */
+    async view({ pushId }) {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        await this.fetcher({
+            route: apiRoute_1.apiRoutePushView,
+            postBody: { id: pushId },
+            options: { addToken: true }
+        });
+    }
+    /**
+     * Пометить все пуши просмотренными
+     */
+    async viewAll() {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        await this.fetcher({
+            route: apiRoute_1.apiRoutePushViewAll,
+            postBody: { view: true },
+            options: { addToken: true }
+        });
+    }
+    /**
+     * добавления токена для пуш уведомления
+     * * @param {number} props.token - сумма выплаты
+     * * @param {number} props.appStore - магазин приложений
+     */
+    async register(props) {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        await this.fetcher({
+            route: apiRoute_1.apiRoutePushRegister,
+            postBody: props,
+            options: { addToken: true }
+        });
+    }
+    /**
+     * отписка от пуш уведомлений
+     */
+    async unsubscribe() {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        await this.fetcher({
+            route: apiRoute_1.apiRoutePushUnsubscribe,
+            postBody: { unsubscribe: 1 },
+            options: { addToken: true }
+        });
+    }
+    /**
+     * статус подписки на пуш уведомления
+     */
+    async isSubscribed() {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        return await this.fetcher({
+            route: apiRoute_1.apiRoutePushIsSubscribed,
+            options: { addToken: true }
+        });
+    }
+}
+exports.ApiPush = ApiPush;

package/dist/api/receipt.d.ts

@@ -0,0 +1,34 @@
+import { ApiAbstract } from "./abstract";
+import { iReceiptAddProps } from "../interfaces/iReceiptAddProps";
+import { iReceipt } from "../interfaces/iReceipt";
+import { iPagingItems } from "../interfaces/iPagingItems";
+export declare class ApiReceipt extends ApiAbstract {
+    /**
+     * регистрация чека
+     * @param {number} props.fn: ФД
+     * @param {number} props.fd: ФД
+     * @param {number} props.fp: ФП
+     * @param {number} props.sum: Сумма чека
+     * @param {keyof iReceipt} props.t Дата в формате 20240715T1322 (как в QR коде)
+     * @param {AbortSignal} signal
+     */
+    add(props: iReceiptAddProps, signal: AbortSignal | null | undefined): Promise<iReceipt>;
+    /**
+     * список чеков
+     * @param {number} props.page - страница, отсчет с первой, чтобы не было путаницы
+     * @param {keyof iReceipt} props.select - выбор полей ответа
+     */
+    getList<Keys extends keyof Omit<iReceipt, "products">>({ page, select, }: {
+        page: number;
+        select: Keys[];
+    }): Promise<iPagingItems<Pick<Omit<iReceipt, "products">, Keys>, {
+        [key: string]: unknown;
+    } | undefined>>;
+    /**
+     * один чек с товарами внутри
+     * * @param {number} id - id чека
+     */
+    getOne({ id }: {
+        id: number;
+    }): Promise<iReceipt>;
+}

package/dist/api/receipt.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiReceipt = void 0;
+const abstract_1 = require("./abstract");
+const apiRoute_1 = require("../http/apiRoute");
+const apiError_1 = require("../http/apiError");
+class ApiReceipt extends abstract_1.ApiAbstract {
+    /**
+     * регистрация чека
+     * @param {number} props.fn: ФД
+     * @param {number} props.fd: ФД
+     * @param {number} props.fp: ФП
+     * @param {number} props.sum: Сумма чека
+     * @param {keyof iReceipt} props.t Дата в формате 20240715T1322 (как в QR коде)
+     * @param {AbortSignal} signal
+     */
+    async add(props, signal) {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        const data = await this.fetcher({
+            route: apiRoute_1.apiRouteReceiptAdd,
+            postBody: props,
+            options: {
+                addToken: true,
+                signal
+            }
+        });
+        return data.receipt;
+    }
+    /**
+     * список чеков
+     * @param {number} props.page - страница, отсчет с первой, чтобы не было путаницы
+     * @param {keyof iReceipt} props.select - выбор полей ответа
+     */
+    async getList({ page = 1, select, }) {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        return await this.fetcher({
+            route: (0, apiRoute_1.apiRouteReceiptList)({
+                page,
+                sorters: ["id desc"],
+                select: select?.filter(it => it != "payments" && it != "cashback_sum")
+            }),
+            options: { addToken: true }
+        });
+    }
+    /**
+     * один чек с товарами внутри
+     * * @param {number} id - id чека
+     */
+    async getOne({ id }) {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        return (await this.fetcher({
+            route: (0, apiRoute_1.apiRouteReceiptItem)(id),
+            options: { addToken: true }
+        })).item;
+    }
+}
+exports.ApiReceipt = ApiReceipt;

package/dist/api/stat.d.ts

@@ -0,0 +1,21 @@
+import { ApiAbstract } from "./abstract";
+import { iUserStat } from "../interfaces/iUserStat";
+import { apiStatEvents } from "../interfaces/apiStatEvents";
+export declare class ApiStat extends ApiAbstract {
+    /**
+     * добавление события открытия товара, бренда, статьи
+     * @param {number} props.itemId - id элемента
+     * @param {AddViewEvent} props.event - тип события
+     */
+    add({ itemId, event, }: {
+        itemId: number;
+        event: typeof apiStatEvents[number];
+    }): Promise<void>;
+    /**
+     * получения события просмотра презентации или прохождения квиза
+     * @param {number} props.sku - массив id акции (не товара) до 50 элементов.
+     */
+    getEvent(props: {
+        sku: number[];
+    }): Promise<iUserStat[]>;
+}

package/dist/api/stat.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiStat = void 0;
+const abstract_1 = require("./abstract");
+const apiRoute_1 = require("../http/apiRoute");
+const userStatEvent_1 = require("../interfaces/userStatEvent");
+const apiError_1 = require("../http/apiError");
+const itemType_1 = require("../interfaces/itemType");
+const viewEventType_1 = require("../interfaces/viewEventType");
+const apiStatEvents_1 = require("../interfaces/apiStatEvents");
+class ApiStat extends abstract_1.ApiAbstract {
+    /**
+     * добавление события открытия товара, бренда, статьи
+     * @param {number} props.itemId - id элемента
+     * @param {AddViewEvent} props.event - тип события
+     */
+    async add({ itemId, event, }) {
+        if (typeof itemId != "number" || itemId <= 0)
+            throw new apiError_1.ApiError(400, "ApiStat не корректный id элемента");
+        if (!apiStatEvents_1.apiStatEvents.includes(event))
+            throw new apiError_1.ApiError(400, "ApiStat Не правильный тип статистики");
+        const itemType = itemType_1.ItemType[event.split("/")[0]];
+        const eventType = viewEventType_1.ViewEventType[event.split("/")[1]];
+        if (!itemType)
+            throw new apiError_1.ApiError(400, `ApiStat Не верный тип элемента ${event.split("/")[0]} - ${itemType}`);
+        if (!eventType)
+            throw new apiError_1.ApiError(400, `ApiStat Не верный тип события ${event.split("/")[1]} - ${eventType}`);
+        //повышаем кэшбек - просмотр презентации
+        if (itemType == itemType_1.ItemType.CATALOG_SKU && eventType == viewEventType_1.ViewEventType.PRESENTATION_SUCCESS) {
+            await this.fetcher({
+                route: apiRoute_1.apiRouteStatAdd,
+                postBody: {
+                    sku: itemId,
+                    event: userStatEvent_1.UserStatEvent.presentation
+                },
+                options: { addToken: true }
+            });
+        }
+        //повышаем кэшбек - квиз
+        if (itemType == itemType_1.ItemType.CATALOG_SKU && eventType == viewEventType_1.ViewEventType.QUESTIONS_SUCCESS) {
+            await this.fetcher({
+                route: apiRoute_1.apiRouteStatAdd,
+                postBody: {
+                    sku: itemId,
+                    event: userStatEvent_1.UserStatEvent.quiz
+                },
+                options: { addToken: true }
+            });
+        }
+        await this.fetcher({
+            route: apiRoute_1.apiRouteViewAdd,
+            postBody: {
+                itemType,
+                itemId,
+                eventType
+            },
+            options: { addToken: true }
+        });
+    }
+    /**
+     * получения события просмотра презентации или прохождения квиза
+     * @param {number} props.sku - массив id акции (не товара) до 50 элементов.
+     */
+    async getEvent(props) {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        const data = await this.fetcher({
+            route: apiRoute_1.apiRouteStatGet,
+            postBody: props,
+            options: { addToken: true }
+        });
+        return data.items;
+    }
+}
+exports.ApiStat = ApiStat;

package/dist/api/survey.d.ts

@@ -0,0 +1,82 @@
+import { ApiAbstract } from "./abstract";
+import { iSurvey } from "../interfaces/iSurvey";
+import { iUserSurvey } from "../interfaces/iUserSurvey";
+import { iPagingItems } from "../interfaces/iPagingItems";
+export declare class ApiSurvey extends ApiAbstract {
+    /**
+     * Получить список доступных опросов
+     * @param {number} page - номер страницы (с 1)
+     * @param {keyof iSurvey} select - выбор полей ответа
+     * @param {boolean} bookmarks - только избранные опросы
+     */
+    getList<Keys extends keyof iSurvey>({ page, select, bookmarks, }: {
+        page: number;
+        select?: Keys[];
+        bookmarks?: boolean;
+    }): Promise<iPagingItems<Pick<iSurvey, Keys>, {
+        [key: string]: unknown;
+    } | undefined>>;
+    /**
+     * Получить список избранных опросов
+     * @param {number} page - номер страницы (с 1)
+     * @param {keyof iSurvey} select - выбор полей ответа
+     */
+    getBookmarks<Keys extends keyof iSurvey>({ page, select, }: {
+        page: number;
+        select?: Keys[];
+    }): Promise<iPagingItems<Pick<iSurvey, Keys>, {
+        [key: string]: unknown;
+    } | undefined>>;
+    /**
+     * Получить один опрос с вопросами
+     * @param {number} id - id опроса
+     */
+    getOne({ id }: {
+        id: number;
+    }): Promise<iSurvey>;
+    /**
+     * Начать прохождение опроса
+     * @param {number} surveyId - id опроса
+     * @param {AbortSignal} signal
+     */
+    start(surveyId: number, signal?: AbortSignal | null): Promise<{
+        success: boolean;
+        userSurvey: iUserSurvey;
+    }>;
+    /**
+     * Сохранить ответ на вопрос
+     * @param {number} userSurveyId - id прохождения опроса
+     * @param {number} questionIndex - индекс вопроса
+     * @param {number | number[] | string} answer - ответ (для single: number, для multiple: number[], для text: string)
+     * @param {AbortSignal} signal
+     */
+    saveAnswer({ userSurveyId, questionIndex, answer, signal }: {
+        userSurveyId: number;
+        questionIndex: number;
+        answer: number | number[] | string;
+        signal?: AbortSignal | null;
+    }): Promise<{
+        success: boolean;
+        completed: boolean;
+        next_question_index: number | null;
+        message: string;
+    }>;
+    /**
+     * Отменить прохождение опроса
+     * @param {number} userSurveyId - id прохождения опроса
+     * @param {AbortSignal} signal
+     */
+    cancel(userSurveyId: number, signal?: AbortSignal | null): Promise<{
+        success: boolean;
+        message: string;
+    }>;
+    /**
+     * Получить историю прохождений опросов пользователя
+     * @param {number} page - номер страницы (с 1)
+     */
+    getHistory({ page }?: {
+        page?: number;
+    }): Promise<iPagingItems<iUserSurvey, {
+        [key: string]: unknown;
+    } | undefined>>;
+}

package/dist/api/survey.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiSurvey = void 0;
+const abstract_1 = require("./abstract");
+const apiError_1 = require("../http/apiError");
+const apiRoute_1 = require("../http/apiRoute");
+class ApiSurvey extends abstract_1.ApiAbstract {
+    /**
+     * Получить список доступных опросов
+     * @param {number} page - номер страницы (с 1)
+     * @param {keyof iSurvey} select - выбор полей ответа
+     * @param {boolean} bookmarks - только избранные опросы
+     */
+    async getList({ page = 1, select, bookmarks, }) {
+        return await this.fetcher({
+            route: (0, apiRoute_1.apiRouteSurveyList)({
+                page,
+                sorters: ["priority asc", "id desc"],
+                select,
+                bookmarks
+            }),
+            options: { addToken: true }
+        });
+    }
+    /**
+     * Получить список избранных опросов
+     * @param {number} page - номер страницы (с 1)
+     * @param {keyof iSurvey} select - выбор полей ответа
+     */
+    async getBookmarks({ page = 1, select, }) {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        return await this.fetcher({
+            route: (0, apiRoute_1.apiRouteSurveyList)({
+                page,
+                sorters: ["priority desc", "id desc"],
+                select,
+                bookmarks: true
+            }),
+            options: { addToken: true }
+        });
+    }
+    /**
+     * Получить один опрос с вопросами
+     * @param {number} id - id опроса
+     */
+    async getOne({ id }) {
+        return (await this.fetcher({
+            route: (0, apiRoute_1.apiRouteSurveyItem)(id),
+            options: { addToken: true }
+        })).item;
+    }
+    /**
+     * Начать прохождение опроса
+     * @param {number} surveyId - id опроса
+     * @param {AbortSignal} signal
+     */
+    async start(surveyId, signal) {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        return await this.fetcher({
+            route: (0, apiRoute_1.apiRouteSurveyStart)(surveyId),
+            postBody: {},
+            options: {
+                addToken: true,
+                signal
+            }
+        });
+    }
+    /**
+     * Сохранить ответ на вопрос
+     * @param {number} userSurveyId - id прохождения опроса
+     * @param {number} questionIndex - индекс вопроса
+     * @param {number | number[] | string} answer - ответ (для single: number, для multiple: number[], для text: string)
+     * @param {AbortSignal} signal
+     */
+    async saveAnswer({ userSurveyId, questionIndex, answer, signal }) {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        return await this.fetcher({
+            route: (0, apiRoute_1.apiRouteSurveySaveAnswer)(userSurveyId),
+            postBody: {
+                question_index: questionIndex,
+                answer
+            },
+            options: {
+                addToken: true,
+                signal
+            }
+        });
+    }
+    /**
+     * Отменить прохождение опроса
+     * @param {number} userSurveyId - id прохождения опроса
+     * @param {AbortSignal} signal
+     */
+    async cancel(userSurveyId, signal) {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        return await this.fetcher({
+            route: (0, apiRoute_1.apiRouteSurveyCancel)(userSurveyId),
+            postBody: {},
+            options: {
+                addToken: true,
+                signal
+            }
+        });
+    }
+    /**
+     * Получить историю прохождений опросов пользователя
+     * @param {number} page - номер страницы (с 1)
+     */
+    async getHistory({ page = 1 } = {}) {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        return await this.fetcher({
+            route: (0, apiRoute_1.apiRouteSurveyHistory)({ page }),
+            options: { addToken: true }
+        });
+    }
+}
+exports.ApiSurvey = ApiSurvey;

package/dist/api/user.d.ts

@@ -0,0 +1,80 @@
+import { iUserEditProps } from "../interfaces/iUserEditProps";
+import { iUser } from "../interfaces/iUser";
+import { DiplomaStatusValue } from "../interfaces/diplomaStatus";
+import { ApiAbstract } from "./abstract";
+export declare class ApiUser extends ApiAbstract {
+    /**
+     * получает пользователя из расшифрованного JWT токена без запроса на backend
+     */
+    get(): Promise<import("../interfaces/iUserData").iUserData | null>;
+    /**
+     * получает полную информацию о пользователе с сервера
+     */
+    getFull(): Promise<iUser>;
+    /**
+    * 1ый этап регистрации или авторизации
+    */
+    loginOrRegisterByPhone({ phone }: {
+        phone: string;
+    }): Promise<void>;
+    /**
+     * 2ой этап регистрации или авторизации - ввод кода подтверждения
+     */
+    loginOrRegisterByPhoneConfirm({ phone, code }: {
+        phone: string;
+        code: string;
+    }): Promise<import("../interfaces/iUserData").iUserData | null>;
+    /**
+    * Ввод реферального кода другого пользователя
+    * @param {string} props.ref - реферальный код
+    */
+    setRef({ ref }: {
+        ref: string;
+    }): Promise<void>;
+    /**
+    * редактирование пользователя
+    * если метод вернул false - то необходимо ввести код из email и передать его в data.email_code
+    * @param {string} props.email - опционально, для смены email. Если емейл не меняется то не передаем этот параметр или передаем пустую строку
+    * @param {number} props.city - id города
+    * @param {string} props.email_code - код отправленный на email. Первый раз метод вызывается без него, если метод вернул false необходимо вызвать повторно передав код из email
+    */
+    editUser(data: iUserEditProps): Promise<boolean>;
+    /**
+    * выход из ЛК
+    */
+    logout(): Promise<void>;
+    /**
+    * выход из ЛК (выход со всех устройств, на сервере будет удален refresh token, accessToken продолжит действовать остаток своего времени. Другие устройства разлогинет в течении 5 минут)
+    */
+    logoutAllDevice(): Promise<void>;
+    /**
+   * подписка на событие logout
+   */
+    onLogout: (callback: () => Promise<void>) => () => void;
+    /**
+     * удаление аккаунта пользователя, сделавшего запрос и всех связанных с ним сущностей (уведомлений, выплат, чеков, статистики и т.д.)
+     */
+    delete(): Promise<void>;
+    /**
+    * возвращает реф. код пользователя, который другие пользователя вводят при регистрации
+    */
+    getMyReferer(): Promise<string | null>;
+    /**
+     * Загрузить файлы диплома
+     * @param formData - FormData с файлами (ключ "diploma[]")
+     */
+    uploadDiploma(formData: FormData): Promise<{
+        success: boolean;
+        diploma_files: string[];
+        diploma_status: DiplomaStatusValue;
+    }>;
+    /**
+     * Получить статус диплома
+     * @returns diploma_status: 1-не загружен, 2-на проверке, 3-верифицирован, 4-отклонен
+     */
+    getDiplomaStatus(): Promise<{
+        diploma_status: DiplomaStatusValue;
+        diploma_files: string[];
+        diploma_reject_reason: string | null;
+    }>;
+}