@profcomff/api-uilib 2024.10.22 → 2025.3.1

package/README.md

@@ -18,7 +18,7 @@ pnpm install @profcomff/api-uilib
 Используйте для совершения запросов к <https://api.test.profcomff.com> и <https://api.profcomff.com>.
 
 ```ts
-import { createClient } from "@profcomff/api-uilib";
+import { createClient, setupAuth } from "@profcomff/api-uilib";
 
 // Setup client with base API path
 // You can use environment `import.meta.env.VITE_API_URL` for example

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@profcomff/api-uilib",
-  "version": "2024.10.22",
+  "version": "2025.03.01",
   "description": "API wrappers, autogenerated from openapi.json files",
   "main": "./src/index.ts",
   "types": "./src/index.d.ts",

package/src/openapi/auth.ts

@@ -38,6 +38,106 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/auth/authentic": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         *  Unregister
+         * @description Отключает для пользователя метод входа
+         */
+        delete: operations["_unregister_authentic_delete"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/auth/authentic/auth_url": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         *  Auth Url
+         * @description URL на который происходит редирект из приложения для авторизации на стороне провайдера
+         */
+        get: operations["_auth_url_authentic_auth_url_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/auth/authentic/login": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         *  Login
+         * @description Вход в пользователя с помощью аккаунта Authentic
+         */
+        post: operations["_login_authentic_login_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/auth/authentic/redirect_url": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         *  Redirect Url
+         * @description URL на который происходит редирект после завершения входа на стороне провайдера
+         */
+        get: operations["_redirect_url_authentic_redirect_url_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/auth/authentic/registration": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         *  Register
+         * @description Создает аккаунт или привязывает существующий
+         */
+        post: operations["_register_authentic_registration_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/auth/coder/{user_id}/link": {
         parameters: {
             query?: never;
@@ -1135,7 +1235,7 @@ export interface paths {
         post?: never;
         /**
          * Delete User
-         * @description Scopes: `["auth.user.delete"]`
+         * @description Scopes: `["auth.user.delete"]` or `["auth.user.selfdelete"]` for self delete
          */
         delete: operations["delete_user_user__user_id__delete"];
         options?: never;
@@ -1381,6 +1481,17 @@ export interface components {
             user_id: number;
         };
         /** OauthResponseSchema */
+        auth_backend__auth_plugins__authentic__AuthenticAuth__OauthResponseSchema: {
+            /** Code */
+            code?: string | null;
+            /** Id Token */
+            id_token?: string | null;
+            /** Scopes */
+            scopes?: string[] | null;
+            /** Session Name */
+            session_name?: string | null;
+        };
+        /** OauthResponseSchema */
         auth_backend__auth_plugins__github__GithubAuth__OauthResponseSchema: {
             /** Code */
             code?: string | null;
@@ -1466,6 +1577,8 @@ export interface components {
             expires?: string | null;
             /** Id */
             id: number;
+            /** Is Unbounded */
+            is_unbounded?: boolean | null;
             /**
              * Last Activity
              * Format: date-time
@@ -1634,6 +1747,8 @@ export interface components {
         SessionPost: {
             /** Expires */
             expires?: string | null;
+            /** Is Unbounded */
+            is_unbounded?: boolean | null;
             /**
              * Scopes
              * @default []
@@ -1803,6 +1918,132 @@ export interface operations {
             };
         };
     };
+    _unregister_authentic_delete: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": unknown;
+                };
+            };
+        };
+    };
+    _auth_url_authentic_auth_url_get: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UrlSchema"];
+                };
+            };
+        };
+    };
+    _login_authentic_login_post: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["auth_backend__auth_plugins__authentic__AuthenticAuth__OauthResponseSchema"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["auth_backend__auth_method__session__Session"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    _redirect_url_authentic_redirect_url_get: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UrlSchema"];
+                };
+            };
+        };
+    };
+    _register_authentic_registration_post: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["auth_backend__auth_plugins__authentic__AuthenticAuth__OauthResponseSchema"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["auth_backend__auth_method__session__Session"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     _get_link_coder__user_id__link_get: {
         parameters: {
             query?: never;

package/src/openapi/rating.ts

@@ -25,14 +25,19 @@ export interface paths {
          *
          *     `lecturer_id` - вернет все комментарии для преподавателя с конкретным id, по дефолту возвращает вообще все аппрувнутые комментарии.
          *
+         *     `user_id` - вернет все комментарии пользователя с конкретным id
+         *
          *     `unreviewed` - вернет все непроверенные комментарии, если True. По дефолту False.
          */
         get: operations["get_comments_comment_get"];
         put?: never;
         /**
          * Create Comment
-         * @description Создает комментарий к преподавателю в базе данных RatingAPI
+         * @description Scopes: `["rating.comment.import"]`
+         *     Создает комментарий к преподавателю в базе данных RatingAPI
          *     Для создания комментария нужно быть авторизованным
+         *
+         *     Для возможности создания комментария с указанием времени создания и изменения необходим скоуп ["rating.comment.import"]
          */
         post: operations["create_comment_comment_post"];
         delete?: never;
@@ -76,6 +81,27 @@ export interface paths {
         patch: operations["review_comment_comment__uuid__patch"];
         trace?: never;
     };
+    "/rating/comment/import": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Import Comments
+         * @description Scopes: `["rating.comment.import"]`
+         *     Создает комментарии в базе данных RatingAPI
+         */
+        post: operations["import_comments_comment_import_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/rating/lecturer": {
         parameters: {
             query?: never;
@@ -85,22 +111,28 @@ export interface paths {
         };
         /**
          * Get Lecturers
-         * @description Scopes: `["rating.lecturer.read"]`
-         *
-         *     `limit` - максимальное количество возвращаемых преподавателей
+         * @description `limit` - максимальное количество возвращаемых преподавателей
          *
          *     `offset` - нижняя граница получения преподавателей, т.е. если по дефолту первым возвращается преподаватель с условным номером N, то при наличии ненулевого offset будет возвращаться преподаватель с номером N + offset
          *
-         *     `order_by` - возможные значения `'general'`.
-         *     Если передано `'general'` - возвращается список преподавателей отсортированных по общей оценке
+         *     `order_by` - возможные значения `"mark_kindness", "mark_freebie", "mark_clarity", "mark_general", "last_name"`.
+         *     Если передано `'last_name'` - возвращается список преподавателей отсортированных по алфавиту по фамилиям
+         *     Если передано `'mark_...'` - возвращается список преподавателей отсортированных по конкретной оценке
          *
          *     `info` - возможные значения `'comments'`, `'mark'`.
          *     Если передано `'comments'`, то возвращаются одобренные комментарии к преподавателю.
          *     Если передано `'mark'`, то возвращаются общие средние оценки, а также суммарная средняя оценка по всем одобренным комментариям.
          *
          *     `subject`
-         *     Если передано `subject` - возвращает всех преподавателей, для которых переданное значение совпадает с их предметом преподавания.
+         *     Если передано `subject` - возвращает всех преподавателей, для которых переданное значение совпадает с одним из их предметов преподавания.
          *     Также возвращает всех преподавателей, у которых есть комментарий с совпадающим с данным subject.
+         *
+         *     `name`
+         *     Поле для ФИО. Если передано `name` - возвращает всех преподователей, для которых нашлись совпадения с переданной строкой
+         *
+         *     `asc_order`
+         *     Если передано true, сортировать в порядке возрастания
+         *     Иначе - в порядке убывания
          */
         get: operations["get_lecturers_lecturer_get"];
         put?: never;
@@ -170,10 +202,12 @@ export interface components {
             mark_clarity: number;
             /** Mark Freebie */
             mark_freebie: number;
+            /** Mark General */
+            mark_general: number;
             /** Mark Kindness */
             mark_kindness: number;
             /** Subject */
-            subject: string;
+            subject?: string | null;
             /** Text */
             text: string;
             /**
@@ -181,6 +215,8 @@ export interface components {
              * Format: date-time
              */
             update_ts: string;
+            /** User Id */
+            user_id?: number | null;
             /**
              * Uuid
              * Format: uuid
@@ -201,8 +237,44 @@ export interface components {
             /** Total */
             total: number;
         };
+        /** CommentImport */
+        CommentImport: {
+            /** Create Ts */
+            create_ts?: string | null;
+            /**
+             * Is Anonymous
+             * @default true
+             */
+            is_anonymous: boolean;
+            /** Lecturer Id */
+            lecturer_id: number;
+            /** Mark Clarity */
+            mark_clarity: number;
+            /** Mark Freebie */
+            mark_freebie: number;
+            /** Mark Kindness */
+            mark_kindness: number;
+            /** Subject */
+            subject?: string | null;
+            /** Text */
+            text: string;
+            /** Update Ts */
+            update_ts?: string | null;
+        };
+        /** CommentImportAll */
+        CommentImportAll: {
+            /** Comments */
+            comments: components["schemas"]["CommentImport"][];
+        };
         /** CommentPost */
         CommentPost: {
+            /** Create Ts */
+            create_ts?: string | null;
+            /**
+             * Is Anonymous
+             * @default true
+             */
+            is_anonymous: boolean;
             /** Mark Clarity */
             mark_clarity: number;
             /** Mark Freebie */
@@ -213,6 +285,8 @@ export interface components {
             subject: string;
             /** Text */
             text: string;
+            /** Update Ts */
+            update_ts?: string | null;
         };
         /** HTTPValidationError */
         HTTPValidationError: {
@@ -241,8 +315,8 @@ export interface components {
             mark_kindness?: number | null;
             /** Middle Name */
             middle_name: string;
-            /** Subject */
-            subject?: string | null;
+            /** Subjects */
+            subjects?: string[] | null;
             /** Timetable Id */
             timetable_id: number;
         };
@@ -270,8 +344,6 @@ export interface components {
             last_name?: string | null;
             /** Middle Name */
             middle_name?: string | null;
-            /** Subject */
-            subject?: string | null;
             /** Timetable Id */
             timetable_id?: number | null;
         };
@@ -285,10 +357,8 @@ export interface components {
             last_name: string;
             /** Middle Name */
             middle_name: string;
-            /** Subject */
-            subject?: string | null;
             /** Timetable Id */
-            timetable_id: number;
+            timetable_id?: number | null;
         };
         /** StatusResponseModel */
         StatusResponseModel: {
@@ -325,6 +395,7 @@ export interface operations {
                 offset?: number;
                 order_by?: "create_ts"[];
                 unreviewed?: boolean;
+                user_id?: number | null;
             };
             header?: never;
             path?: never;
@@ -482,13 +553,48 @@ export interface operations {
             };
         };
     };
+    import_comments_comment_import_post: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CommentImportAll"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CommentGetAll"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     get_lecturers_lecturer_get: {
         parameters: {
             query?: {
+                asc_order?: boolean;
                 info?: ("comments" | "mark")[];
                 limit?: number;
+                name?: string;
                 offset?: number;
-                order_by?: ("general" | "")[];
+                order_by?: "mark_kindness" | "mark_freebie" | "mark_clarity" | "mark_general" | "last_name";
                 subject?: string;
             };
             header?: never;

package/src/openapi/userdata.ts

@@ -21,6 +21,8 @@ export interface paths {
          * Create Category
          * @description Создать категорию пользовательских данных. Получить категорию можно будет со скоупами, имена которых в category_inp.scopes
          *     Ручка обновит документацию
+         *
+         *     Scopes: `["userdata.category.create"]`
          */
         post: operations["create_category_category_post"];
         delete?: never;
@@ -45,6 +47,8 @@ export interface paths {
         /**
          * Create Param
          * @description Создать поле внутри категории. Ответ на пользовательские данные будет такой {..., category: {...,param: '', ...}}
+         *
+         *     Scopes: `["userdata.param.create"]`
          */
         post: operations["create_param_category__category_id__param_post"];
         delete?: never;
@@ -70,6 +74,8 @@ export interface paths {
         /**
          * Delete Param
          * @description Удалить параметр внутри категории
+         *
+         *     Scopes: `["userdata.param.delete"]`
          */
         delete: operations["delete_param_category__category_id__param__id__delete"];
         options?: never;
@@ -77,6 +83,8 @@ export interface paths {
         /**
          * Patch Param
          * @description Обновить параметр внутри категории
+         *
+         *     Scopes: `["userdata.param.update"]`
          */
         patch: operations["patch_param_category__category_id__param__id__patch"];
         trace?: never;
@@ -98,6 +106,8 @@ export interface paths {
         /**
          * Delete Category
          * @description Удалить категорию
+         *
+         *     Scopes: `["userdata.category.delete"]`
          */
         delete: operations["delete_category_category__id__delete"];
         options?: never;
@@ -105,6 +115,8 @@ export interface paths {
         /**
          * Patch Category
          * @description Обновить категорию
+         *
+         *     Scopes: `["userdata.category.update"]`
          */
         patch: operations["patch_category_category__id__patch"];
         trace?: never;
@@ -125,6 +137,8 @@ export interface paths {
         /**
          * Create Source
          * @description Создать источник данных
+         *
+         *     Scopes: `["userdata.source.create"]`
          */
         post: operations["create_source_source_post"];
         delete?: never;
@@ -150,6 +164,8 @@ export interface paths {
         /**
          * Delete Source
          * @description Удалить источник данных
+         *
+         *     Scopes: `["userdata.source.delete"]`
          */
         delete: operations["delete_source_source__id__delete"];
         options?: never;
@@ -157,10 +173,35 @@ export interface paths {
         /**
          * Patch Source
          * @description Обновить источник данных
+         *
+         *     Scopes: `["userdata.source.update"]`
          */
         patch: operations["patch_source_source__id__patch"];
         trace?: never;
     };
+    "/userdata/user": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Users Info
+         * @description Получить информацию о пользователях.
+         *     :param users: список id юзеров, про которых нужно вернуть информацию
+         *     :param categories: список id категорий, параметры которых нужно вернуть
+         *     :return: список данных о пользователях и данных категориях
+         */
+        get: operations["get_users_info_user_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/userdata/user/{id}": {
         parameters: {
             query?: never;
@@ -189,7 +230,7 @@ export interface paths {
          *     Чтобы обновить от имени админиа, надо иметь скоуп `userdata.info.admin`
          *     Чтобы обновить неизменяемую информацию надо обладать скоупом `userdata.info.update`
          *     Для обновления своей информации(источник `user`) не нужны скоупы на обновление соответствующих категорий
-         *     Для обновления чужой информации от имени админа(источник  `admin`)
+         *     Для обновления чужой информации от имени админа(источник `admin`)
          *     нужны скоупы на обновление всех указанных в теле запроса категорий пользовательских данных данных
          */
         post: operations["update_user_user__id__post"];
@@ -234,6 +275,17 @@ export interface components {
             /** Update Scope */
             update_scope?: string | null;
         };
+        /** ExtendedUserInfo */
+        ExtendedUserInfo: {
+            /** Category */
+            category: string;
+            /** Param */
+            param: string;
+            /** User Id */
+            user_id: number;
+            /** Value */
+            value?: string | null;
+        };
         /** HTTPValidationError */
         HTTPValidationError: {
             /** Detail */
@@ -252,6 +304,13 @@ export interface components {
             /** Name */
             name: string;
             type: components["schemas"]["ViewType"];
+            /** Validation */
+            validation?: string | null;
+            /**
+             * Visible In User Response
+             * @default true
+             */
+            visible_in_user_response: boolean;
         };
         /** ParamPatch */
         ParamPatch: {
@@ -262,6 +321,13 @@ export interface components {
             /** Name */
             name?: string | null;
             type?: components["schemas"]["ViewType"] | null;
+            /** Validation */
+            validation?: string | null;
+            /**
+             * Visible In User Response
+             * @default true
+             */
+            visible_in_user_response: boolean;
         };
         /** ParamPost */
         ParamPost: {
@@ -272,6 +338,13 @@ export interface components {
             /** Name */
             name: string;
             type: components["schemas"]["ViewType"];
+            /** Validation */
+            validation?: string | null;
+            /**
+             * Visible In User Response
+             * @default true
+             */
+            visible_in_user_response: boolean;
         };
         /** SourceGet */
         SourceGet: {
@@ -326,6 +399,11 @@ export interface components {
             /** Source */
             source: string;
         };
+        /** UsersInfoGet */
+        UsersInfoGet: {
+            /** Items */
+            items: components["schemas"]["ExtendedUserInfo"][];
+        };
         /** ValidationError */
         ValidationError: {
             /** Location */
@@ -830,9 +908,44 @@ export interface operations {
             };
         };
     };
+    get_users_info_user_get: {
+        parameters: {
+            query: {
+                additional_data?: number[];
+                categories: number[];
+                users: number[];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UsersInfoGet"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     get_user_info_user__id__get: {
         parameters: {
-            query?: never;
+            query?: {
+                additional_data?: number[];
+            };
             header?: never;
             path: {
                 id: number;