@up-im/medotvet_sdk 0.0.3 → 0.0.4

package/README.md

@@ -132,5 +132,233 @@ const client = createClient({
 ### promocode
 - `activate(code)` — активировать промокод, ответ `{ sum }`; требует токен.
 
+### test (верификационный тест по специальности)
+- `getQuestions()` — получить вопросы для теста верификации. Вопросы
+	выбираются на основе специализаций пользователя (по 4 на каждую).
+	Возвращает `{ questions: iTestQuestionForUser[] }`.
+- `submit(answers: iTestUserAnswer[])` — отправить результаты теста.
+	`answers` — массив ответов с полями `specialization`, `questionIndex`,
+	`answer_indices`, `answer_time?`. Возвращает `{ success, passed, message }`.
+- `getResults()` — получить результаты последнего теста. Возвращает
+	`{ hasResults, message?, testDate?, results?, passed? }`. Если
+	`hasResults=false` — тест ещё не проходился.
+- `getStatus()` — проверить статус прохождения теста. Возвращает
+	`{ testPassed, testDate, canTakeTest }`. `canTakeTest` всегда `true` —
+	тест можно проходить неограниченно.
+
 ### geoIp
-- `detect()` — определить город по IP.
+- `detect()` — определить город по IP.
+
+---
+
+## Модели данных
+
+### iUser
+```ts
+interface iUser {
+  id: number
+  register_date: string | null
+  role: UserRoleValue // 0-пользователь, 1-модератор, 2-админ
+  phone: string | null
+  phone_confirm: boolean
+  email: string | null
+  email_confirm: boolean
+  firstname: string
+  lastname: string
+  middlename: string
+  photo: string
+  city: iCity | null
+  specialization: number[] | null // специализации врача
+  birthdate: string | null
+  workplace_type: number | null // тип учреждения (ID)
+  workplace_name: string | null // название учреждения
+  diploma_status: DiplomaStatusValue // 1-не загружен, 2-проверка, 3-принят, 4-отклонён
+  diploma_files: string[] | null
+  diploma_reject_reason: string | null
+  test_status: number | null // 1-не пройден, 2-пройден (TestStatus)
+  ref: iUserData | null // пригласивший пользователь
+  my_ref_code: string | null // рефкод для приглашения других
+  agreement: boolean | null
+}
+```
+
+### iSurvey
+```ts
+interface iSurvey {
+  id: number
+  node: number
+  title: string
+  partner: number | null
+  budget: number
+  budget_min: number
+  date_start: string | null
+  date_end: string | null
+  reward_base: number // базовое вознаграждение (50%)
+  reward_max: number // макс. вознаграждение (100%)
+  questions: iSurveyQuestion[] | null
+  slots: number // всего мест
+  slots_taken?: number // занято мест
+  specialization: iRefItem[] | null // {id, title}[]
+  city: iRefItem[] | null // только эти города
+  city_not: iRefItem[] | null // кроме этих городов
+  promo_title: string
+  promo_subtitle: string
+  promo_image: string
+  promo_text: string
+  promo_disclaimer: string
+  text: string
+  text_full: string
+  public: boolean
+  priority?: number // 1-4 для спецразмещения
+}
+```
+
+### iUserSurvey
+```ts
+const UserSurveyStatus = {
+  queue: 0,       // в очереди
+  in_progress: 1, // в процессе
+  success: 2,     // завершён
+  cancelled: 3,   // отменён
+  timeout: 4      // таймаут
+} as const
+
+interface iUserSurvey {
+  id: number
+  reg_date: string
+  user: number
+  survey: number
+  status: UserSurveyStatusValue
+  date_start: string | null
+  date_end: string | null
+  timeout_at: string | null
+  survey_title?: string
+  reward_base?: number
+  reward_max?: number
+}
+```
+
+### iPayment
+```ts
+interface iPayment {
+  id: number
+  reg_date: string
+  status: PaymentStatusValue // 1-ожидание, 2-завершено, 3-ошибка, 4-отмена
+  pay_type: PaymentTypeValue // 1-начисление, 2-выплата
+  title: string
+  receipt: number | null
+  receipt_product: number | null
+  catalog: number | null
+  sku: number | null
+  shop: number | null
+  cashback_level: 0 | 1 | 2 | 3
+  max_cashback_level: null | 0 | 1 | 2 | 3
+  payout_type: PayoutTypeValue | null // 1-СБП, 2-карта
+  last_error: string
+  price: number // >0 начисление, <0 списание
+}
+```
+
+### iBalance
+```ts
+interface iBalance {
+  accrued: number  // всего начислено
+  paid: number     // всего выплачено
+  invite_user: number // начислено от рефералов
+  balance: number  // текущий баланс
+}
+```
+
+### iPush
+```ts
+interface iPush {
+  id: number
+  reg_date: string
+  send_date: string | null
+  user: number
+  status: PushStatusValue // 1-ожидание, 2-отправлено, 3-ошибка
+  mailing: number | null
+  priority: number
+  title: string
+  text: string
+  route: string
+  view: boolean
+}
+```
+
+### iMessage (чат)
+```ts
+interface iMessageIncome {
+  route: "/message"
+  id: number
+  date: Date
+  from_user_id: number
+  from_user_name: string
+  text: string
+  file: string | undefined
+  view: 0 | 1
+}
+```
+
+### Test interfaces
+```ts
+// Вопрос теста для пользователя
+interface iTestQuestionForUser {
+  specialization: number
+  questionIndex: number
+  question: string
+  answers: { title: string }[]
+}
+
+// Ответ пользователя
+interface iTestUserAnswer {
+  specialization: number
+  questionIndex: number
+  answer_indices: number[] // индексы выбранных ответов
+  answer_time?: number // время ответа в секундах
+}
+
+// Результаты по специализациям
+interface iTestResultBySpecialization {
+  [specializationId: number]: {
+    correct: number
+    total: number
+  }
+}
+
+// Статус теста
+const TestStatus = {
+  not_passed: 1,
+  passed: 2,
+} as const
+```
+
+### DiplomaStatus
+```ts
+const DiplomaStatus = {
+  not_uploaded: 1, // не загружен
+  pending: 2,      // на проверке
+  verified: 3,     // верифицирован
+  rejected: 4,     // отклонён
+} as const
+```
+
+### iBanner
+```ts
+interface iBanner {
+  banner_id: number
+  sku_id: number
+  image: string
+  adv_info: string
+}
+```
+
+### iEnv
+```ts
+interface iEnv {
+  referrer_cashback_percent: number
+  referrer_register_bonus: number
+  root_catalog_id: number
+  payout_min_price: number
+}
+```

package/dist/api/index.d.ts

@@ -8,6 +8,7 @@ import { ApiPromocode } from "./promocode";
 import { ApiPush } from "./push";
 import { ApiSurvey } from "./survey";
 import { ApiStat } from "./stat";
+import { ApiTest } from "./test";
 import { ApiUser } from "./user";
 export declare function createClient({ host, wsHost, storage }: {
     host: string;
@@ -24,4 +25,5 @@ export declare function createClient({ host, wsHost, storage }: {
     bookmarks: ApiBookmarks;
     push: ApiPush;
     promocode: ApiPromocode;
+    test: ApiTest;
 };

package/dist/api/index.js

@@ -12,6 +12,7 @@ const promocode_1 = require("./promocode");
 const push_1 = require("./push");
 const survey_1 = require("./survey");
 const stat_1 = require("./stat");
+const test_1 = require("./test");
 const user_2 = require("./user");
 function createClient({ host, wsHost, storage }) {
     const userStorage = new user_1.UserStorage(storage || default_1.storageDefault);
@@ -27,5 +28,6 @@ function createClient({ host, wsHost, storage }) {
         bookmarks: new bookmarks_1.ApiBookmarks(constructorProps),
         push: new push_1.ApiPush(constructorProps),
         promocode: new promocode_1.ApiPromocode(constructorProps),
+        test: new test_1.ApiTest(constructorProps),
     };
 }

package/dist/api/test.d.ts

@@ -0,0 +1,41 @@
+import { iTestQuestionForUser, iTestUserAnswer } from "../interfaces/iTestQuestion";
+import { iTestResultBySpecialization } from "../interfaces/iTestResult";
+import { ApiAbstract } from "./abstract";
+export declare class ApiTest extends ApiAbstract {
+    /**
+     * Получить вопросы для теста верификации
+     * Вопросы выбираются на основе специализаций пользователя (по 4 на каждую)
+     */
+    getQuestions(): Promise<{
+        questions: iTestQuestionForUser[];
+    }>;
+    /**
+     * Отправить результаты теста
+     * @param answers - массив ответов пользователя
+     * @returns { success, passed, message } - результат прохождения теста
+     */
+    submit(answers: iTestUserAnswer[]): Promise<{
+        success: boolean;
+        passed: boolean;
+        message: string;
+    }>;
+    /**
+     * Получить результаты последнего теста пользователя
+     */
+    getResults(): Promise<{
+        hasResults: boolean;
+        message?: string;
+        testDate?: Date;
+        results?: iTestResultBySpecialization;
+        passed?: boolean;
+    }>;
+    /**
+     * Проверить статус прохождения теста
+     * @returns testPassed - прошел ли тест, testDate - дата прохождения, canTakeTest - можно ли пройти тест
+     */
+    getStatus(): Promise<{
+        testPassed: boolean;
+        testDate: Date | null;
+        canTakeTest: boolean;
+    }>;
+}

package/dist/api/test.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiTest = void 0;
+const apiError_1 = require("../http/apiError");
+const apiRoute_1 = require("../http/apiRoute");
+const abstract_1 = require("./abstract");
+class ApiTest extends abstract_1.ApiAbstract {
+    /**
+     * Получить вопросы для теста верификации
+     * Вопросы выбираются на основе специализаций пользователя (по 4 на каждую)
+     */
+    async getQuestions() {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        return await this.fetcher({
+            route: apiRoute_1.apiRouteTestQuestions,
+            options: { addToken: true }
+        });
+    }
+    /**
+     * Отправить результаты теста
+     * @param answers - массив ответов пользователя
+     * @returns { success, passed, message } - результат прохождения теста
+     */
+    async submit(answers) {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        return await this.fetcher({
+            route: apiRoute_1.apiRouteTestSubmit,
+            postBody: { answers },
+            options: { addToken: true }
+        });
+    }
+    /**
+     * Получить результаты последнего теста пользователя
+     */
+    async getResults() {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        return await this.fetcher({
+            route: apiRoute_1.apiRouteTestResults,
+            options: { addToken: true }
+        });
+    }
+    /**
+     * Проверить статус прохождения теста
+     * @returns testPassed - прошел ли тест, testDate - дата прохождения, canTakeTest - можно ли пройти тест
+     */
+    async getStatus() {
+        if (!await this.userStorage.isAuth())
+            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
+        return await this.fetcher({
+            route: apiRoute_1.apiRouteTestStatus,
+            options: { addToken: true }
+        });
+    }
+}
+exports.ApiTest = ApiTest;

package/dist/http/apiRoute.d.ts

@@ -96,3 +96,7 @@ export declare const apiRoutePushView = "/push/view";
 export declare const apiRoutePushViewAll = "/push/view_all";
 export declare const apiRouteChatUnread = "/chat/unread";
 export declare const apiRoutePromocodeActivate = "/promocode/activate";
+export declare const apiRouteTestQuestions = "/test/questions";
+export declare const apiRouteTestSubmit = "/test/submit";
+export declare const apiRouteTestResults = "/test/results";
+export declare const apiRouteTestStatus = "/test/status";

package/dist/http/apiRoute.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.apiRoutePushRegister = exports.apiRoutePushCountNew = exports.apiRoutePushList = exports.apiRouteBannerGetRand = exports.apiRouteBookmarksCount = exports.apiRouteBookmarksRemove = exports.apiRouteBookmarksAdd = exports.apiRouteBookmarksGet = exports.apiRouteStatGet = exports.apiRouteStatAdd = exports.apiRouteViewAdd = exports.apiRoutePaymentVerificationStatus = exports.apiRoutePaymentVerificationUrl = exports.apiRoutePaymentBalance = exports.apiRoutePaymentList = exports.apiRoutePaymentAdd = exports.apiRouteSurveyHistory = exports.apiRouteSurveyCancel = exports.apiRouteSurveySaveAnswer = exports.apiRouteSurveyStart = exports.apiRouteSurveyItem = exports.apiRouteSurveyList = exports.apiRouteUserDiplomaStatus = exports.apiRouteUserDiplomaUpload = exports.apiRouteUserSetRef = exports.apiRouteUserDelete = exports.apiRouteUserLogout = exports.apiRouteUserUploadPhoto = exports.apiRouteUserEdit = exports.apiRouteUserLoginWithCode = exports.apiRouteUserRefresh = exports.apiRouteUserGetMe = exports.apiRouteGeoDetect = exports.apiRouteBasketMoveToDraft = exports.apiRouteBasketMutate = exports.apiRouteBasketGet = exports.apiRouteBasketTotal = exports.apiRouteNodeGeneratedLinks = exports.apiRouteNodeById = exports.apiRouteNode = exports.apiRouteNodeList = exports.apiRouteNodeTreeContentByFilters = exports.apiRouteNodeTree = exports.apiRouteItemById = exports.apiRouteItem = exports.apiRouteFilters = exports.apiRouteList = exports.apiRouteGetCloudVersion = exports.apiRouteCheckAppVersion = exports.apiRouteEnv = void 0;
-exports.apiRoutePromocodeActivate = exports.apiRouteChatUnread = exports.apiRoutePushViewAll = exports.apiRoutePushView = exports.apiRoutePushIsSubscribed = exports.apiRoutePushUnsubscribe = void 0;
+exports.apiRouteTestStatus = exports.apiRouteTestResults = exports.apiRouteTestSubmit = exports.apiRouteTestQuestions = exports.apiRoutePromocodeActivate = exports.apiRouteChatUnread = exports.apiRoutePushViewAll = exports.apiRoutePushView = exports.apiRoutePushIsSubscribed = exports.apiRoutePushUnsubscribe = void 0;
 const queryString_1 = require("../utils/queryString");
 exports.apiRouteEnv = "/env";
 const apiRouteCheckAppVersion = (appStore, appVersion) => `/env/check_app_version/${appStore}/${appVersion}`;
@@ -195,3 +195,8 @@ exports.apiRoutePushView = '/push/view';
 exports.apiRoutePushViewAll = '/push/view_all';
 exports.apiRouteChatUnread = '/chat/unread';
 exports.apiRoutePromocodeActivate = '/promocode/activate';
+// test
+exports.apiRouteTestQuestions = '/test/questions';
+exports.apiRouteTestSubmit = '/test/submit';
+exports.apiRouteTestResults = '/test/results';
+exports.apiRouteTestStatus = '/test/status';

package/dist/interfaces/iUserSurvey.d.ts

@@ -1,17 +1,10 @@
-export declare enum UserSurveyStatus {
-    queue = 0,// в очереди (создан, но не начат)
-    in_progress = 1,// в процессе прохождения
-    success = 2,// успешно завершен
-    cancelled = 3,// отменен пользователем
-    timeout = 4
-}
-export type UserSurveyStatusKeys = keyof typeof UserSurveyStatus;
+import { UserSurveyStatusValue } from "./userSurveyStatus";
 export interface iUserSurvey {
     id: number;
     reg_date: string;
     user: number;
     survey: number;
-    status: typeof UserSurveyStatus[UserSurveyStatusKeys];
+    status: UserSurveyStatusValue;
     date_start: string | null;
     date_end: string | null;
     timeout_at: string | null;

package/dist/interfaces/iUserSurvey.js

@@ -1,11 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserSurveyStatus = void 0;
-var UserSurveyStatus;
-(function (UserSurveyStatus) {
-    UserSurveyStatus[UserSurveyStatus["queue"] = 0] = "queue";
-    UserSurveyStatus[UserSurveyStatus["in_progress"] = 1] = "in_progress";
-    UserSurveyStatus[UserSurveyStatus["success"] = 2] = "success";
-    UserSurveyStatus[UserSurveyStatus["cancelled"] = 3] = "cancelled";
-    UserSurveyStatus[UserSurveyStatus["timeout"] = 4] = "timeout"; // таймаут (не завершен за 1 час)
-})(UserSurveyStatus || (exports.UserSurveyStatus = UserSurveyStatus = {}));

package/dist/interfaces/userSurveyStatus.d.ts

@@ -0,0 +1,9 @@
+export declare const UserSurveyStatus: {
+    readonly queue: 0;
+    readonly in_progress: 1;
+    readonly success: 2;
+    readonly cancelled: 3;
+    readonly timeout: 4;
+};
+export type UserSurveyStatusKeys = keyof typeof UserSurveyStatus;
+export type UserSurveyStatusValue = typeof UserSurveyStatus[UserSurveyStatusKeys];

package/dist/interfaces/userSurveyStatus.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserSurveyStatus = void 0;
+exports.UserSurveyStatus = {
+    queue: 0, // в очереди (создан, но не начат)
+    in_progress: 1, // в процессе прохождения
+    success: 2, // успешно завершен
+    cancelled: 3, // отменен пользователем
+    timeout: 4 // таймаут (не завершен за 1 час)
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@up-im/medotvet_sdk",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "",
   "main": "dist/index.js",
   "scripts": {

package/src/api/index.ts

@@ -10,6 +10,7 @@ import { ApiPromocode } from "./promocode";
 import { ApiPush } from "./push";
 import { ApiSurvey } from "./survey";
 import { ApiStat } from "./stat";
+import { ApiTest } from "./test";
 import { ApiUser } from "./user";
 
 export function createClient({
@@ -34,5 +35,6 @@ export function createClient({
         bookmarks: new ApiBookmarks(constructorProps),
         push: new ApiPush(constructorProps),
         promocode: new ApiPromocode(constructorProps),
+        test: new ApiTest(constructorProps),
     }
 }

package/src/api/test.ts

@@ -0,0 +1,78 @@
+import { ApiError } from "../http/apiError"
+import {
+	apiRouteTestQuestions,
+	apiRouteTestSubmit,
+	apiRouteTestResults,
+	apiRouteTestStatus
+} from "../http/apiRoute"
+import { iTestQuestionForUser, iTestUserAnswer } from "../interfaces/iTestQuestion"
+import { iTestResultBySpecialization } from "../interfaces/iTestResult"
+import { ApiAbstract } from "./abstract"
+
+export class ApiTest extends ApiAbstract {
+	/**
+	 * Получить вопросы для теста верификации
+	 * Вопросы выбираются на основе специализаций пользователя (по 4 на каждую)
+	 */
+	async getQuestions() {
+		if (!await this.userStorage.isAuth()) throw new ApiError(401, "Пользователь не авторизован")
+		return await this.fetcher<{
+			questions: iTestQuestionForUser[]
+		}>({
+			route: apiRouteTestQuestions,
+			options: { addToken: true }
+		})
+	}
+
+	/**
+	 * Отправить результаты теста
+	 * @param answers - массив ответов пользователя
+	 * @returns { success, passed, message } - результат прохождения теста
+	 */
+	async submit(answers: iTestUserAnswer[]) {
+		if (!await this.userStorage.isAuth()) throw new ApiError(401, "Пользователь не авторизован")
+		return await this.fetcher<{
+			success: boolean
+			passed: boolean
+			message: string
+		}>({
+			route: apiRouteTestSubmit,
+			postBody: { answers },
+			options: { addToken: true }
+		})
+	}
+
+	/**
+	 * Получить результаты последнего теста пользователя
+	 */
+	async getResults() {
+		if (!await this.userStorage.isAuth()) throw new ApiError(401, "Пользователь не авторизован")
+		return await this.fetcher<{
+			hasResults: boolean
+			message?: string
+			testDate?: Date
+			results?: iTestResultBySpecialization
+			passed?: boolean
+		}>({
+			route: apiRouteTestResults,
+			options: { addToken: true }
+		})
+	}
+
+	/**
+	 * Проверить статус прохождения теста
+	 * @returns testPassed - прошел ли тест, testDate - дата прохождения, canTakeTest - можно ли пройти тест
+	 */
+	async getStatus() {
+		if (!await this.userStorage.isAuth()) throw new ApiError(401, "Пользователь не авторизован")
+		return await this.fetcher<{
+			testPassed: boolean
+			testDate: Date | null
+			canTakeTest: boolean
+		}>({
+			route: apiRouteTestStatus,
+			options: { addToken: true }
+		})
+	}
+}
+

package/src/http/apiRoute.ts

@@ -231,4 +231,10 @@ export const apiRoutePushViewAll = '/push/view_all'
 
 export const apiRouteChatUnread = '/chat/unread'
 
-export const apiRoutePromocodeActivate = '/promocode/activate'
+export const apiRoutePromocodeActivate = '/promocode/activate'
+
+// test
+export const apiRouteTestQuestions = '/test/questions'
+export const apiRouteTestSubmit = '/test/submit'
+export const apiRouteTestResults = '/test/results'
+export const apiRouteTestStatus = '/test/status'

package/src/interfaces/iUserSurvey.ts

@@ -1,19 +1,11 @@
-export enum UserSurveyStatus {
-	queue = 0, // в очереди (создан, но не начат)
-	in_progress = 1, // в процессе прохождения
-	success = 2, // успешно завершен
-	cancelled = 3, // отменен пользователем
-	timeout = 4 // таймаут (не завершен за 1 час)
-}
-
-export type UserSurveyStatusKeys = keyof typeof UserSurveyStatus
+import { UserSurveyStatusValue } from "./userSurveyStatus"
 
 export interface iUserSurvey {
 	id: number
 	reg_date: string
 	user: number
 	survey: number
-	status: typeof UserSurveyStatus[UserSurveyStatusKeys]
+	status: UserSurveyStatusValue
 	date_start: string | null
 	date_end: string | null
 	timeout_at: string | null

package/src/interfaces/userSurveyStatus.ts

@@ -0,0 +1,10 @@
+export const UserSurveyStatus = {
+	queue: 0, // в очереди (создан, но не начат)
+	in_progress: 1, // в процессе прохождения
+	success: 2, // успешно завершен
+	cancelled: 3, // отменен пользователем
+	timeout: 4 // таймаут (не завершен за 1 час)
+} as const
+
+export type UserSurveyStatusKeys = keyof typeof UserSurveyStatus
+export type UserSurveyStatusValue = typeof UserSurveyStatus[UserSurveyStatusKeys]