@profcomff/api-uilib 2024.11.24 → 2025.4.15

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.11.24",
+  "version": "2025.04.15",
   "description": "API wrappers, autogenerated from openapi.json files",
   "main": "./src/index.ts",
   "types": "./src/index.d.ts",

package/src/openapi/auth.ts

@@ -1577,6 +1577,8 @@ export interface components {
             expires?: string | null;
             /** Id */
             id: number;
+            /** Is Unbounded */
+            is_unbounded?: boolean | null;
             /**
              * Last Activity
              * Format: date-time
@@ -1745,6 +1747,8 @@ export interface components {
         SessionPost: {
             /** Expires */
             expires?: string | null;
+            /** Is Unbounded */
+            is_unbounded?: boolean | null;
             /**
              * Scopes
              * @default []

package/src/openapi/rating.ts

@@ -66,6 +66,26 @@ export interface paths {
         delete: operations["delete_comment_comment__uuid__delete"];
         options?: never;
         head?: never;
+        /**
+         * Update Comment
+         * @description Позволяет изменить свой неанонимный комментарий
+         */
+        patch: operations["update_comment_comment__uuid__patch"];
+        trace?: never;
+    };
+    "/rating/comment/{uuid}/review": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
         /**
          * Review Comment
          * @description Scopes: `["rating.comment.review"]`
@@ -75,7 +95,28 @@ export interface paths {
          *     `approved` - комментарий одобрен и возвращается при запросе лектора
          *     `dismissed` - комментарий отклонен, не отображается в запросе лектора
          */
-        patch: operations["review_comment_comment__uuid__patch"];
+        patch: operations["review_comment_comment__uuid__review_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": {
@@ -91,7 +132,7 @@ export interface paths {
          *
          *     `offset` - нижняя граница получения преподавателей, т.е. если по дефолту первым возвращается преподаватель с условным номером N, то при наличии ненулевого offset будет возвращаться преподаватель с номером N + offset
          *
-         *     `order_by` - возможные значения `"mark_kindness", "mark_freebie", "mark_clarity", "mark_general", "last_name"`.
+         *     `order_by` - возможные значения `"mark_weighted", "mark_kindness", "mark_freebie", "mark_clarity", "mark_general", "last_name"`.
          *     Если передано `'last_name'` - возвращается список преподавателей отсортированных по алфавиту по фамилиям
          *     Если передано `'mark_...'` - возвращается список преподавателей отсортированных по конкретной оценке
          *
@@ -183,7 +224,7 @@ export interface components {
             /** Mark Kindness */
             mark_kindness: number;
             /** Subject */
-            subject: string;
+            subject?: string | null;
             /** Text */
             text: string;
             /**
@@ -213,8 +254,134 @@ export interface components {
             /** Total */
             total: number;
         };
+        /** CommentGetAllWithAllInfo */
+        CommentGetAllWithAllInfo: {
+            /**
+             * Comments
+             * @default []
+             */
+            comments: components["schemas"]["CommentGetWithAllInfo"][];
+            /** Limit */
+            limit: number;
+            /** Offset */
+            offset: number;
+            /** Total */
+            total: number;
+        };
+        /** CommentGetAllWithStatus */
+        CommentGetAllWithStatus: {
+            /**
+             * Comments
+             * @default []
+             */
+            comments: components["schemas"]["CommentGetWithStatus"][];
+            /** Limit */
+            limit: number;
+            /** Offset */
+            offset: number;
+            /** Total */
+            total: number;
+        };
+        /** CommentGetWithAllInfo */
+        CommentGetWithAllInfo: {
+            /** Approved By */
+            approved_by?: number | null;
+            /**
+             * Create Ts
+             * Format: date-time
+             */
+            create_ts: string;
+            /** Lecturer Id */
+            lecturer_id: number;
+            /** Mark Clarity */
+            mark_clarity: number;
+            /** Mark Freebie */
+            mark_freebie: number;
+            /** Mark General */
+            mark_general: number;
+            /** Mark Kindness */
+            mark_kindness: number;
+            review_status: components["schemas"]["ReviewStatus"];
+            /** Subject */
+            subject?: string | null;
+            /** Text */
+            text: string;
+            /**
+             * Update Ts
+             * Format: date-time
+             */
+            update_ts: string;
+            /** User Id */
+            user_id?: number | null;
+            /**
+             * Uuid
+             * Format: uuid
+             */
+            uuid: string;
+        };
+        /** CommentGetWithStatus */
+        CommentGetWithStatus: {
+            /**
+             * Create Ts
+             * Format: date-time
+             */
+            create_ts: string;
+            /** Lecturer Id */
+            lecturer_id: number;
+            /** Mark Clarity */
+            mark_clarity: number;
+            /** Mark Freebie */
+            mark_freebie: number;
+            /** Mark General */
+            mark_general: number;
+            /** Mark Kindness */
+            mark_kindness: number;
+            review_status: components["schemas"]["ReviewStatus"];
+            /** Subject */
+            subject?: string | null;
+            /** Text */
+            text: string;
+            /**
+             * Update Ts
+             * Format: date-time
+             */
+            update_ts: string;
+            /** User Id */
+            user_id?: number | null;
+            /**
+             * Uuid
+             * Format: uuid
+             */
+            uuid: string;
+        };
+        /** CommentImport */
+        CommentImport: {
+            /** Create Ts */
+            create_ts?: string | null;
+            /** 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
@@ -230,6 +397,21 @@ export interface components {
             subject: string;
             /** Text */
             text: string;
+            /** Update Ts */
+            update_ts?: string | null;
+        };
+        /** CommentUpdate */
+        CommentUpdate: {
+            /** Mark Clarity */
+            mark_clarity?: number;
+            /** Mark Freebie */
+            mark_freebie?: number;
+            /** Mark Kindness */
+            mark_kindness?: number;
+            /** Subject */
+            subject?: string;
+            /** Text */
+            text?: string;
         };
         /** HTTPValidationError */
         HTTPValidationError: {
@@ -256,6 +438,8 @@ export interface components {
             mark_general?: number | null;
             /** Mark Kindness */
             mark_kindness?: number | null;
+            /** Mark Weighted */
+            mark_weighted?: number | null;
             /** Middle Name */
             middle_name: string;
             /** Subjects */
@@ -301,8 +485,13 @@ export interface components {
             /** Middle Name */
             middle_name: string;
             /** Timetable Id */
-            timetable_id: number;
+            timetable_id?: number | null;
         };
+        /**
+         * ReviewStatus
+         * @enum {string}
+         */
+        ReviewStatus: "approved" | "pending" | "dismissed";
         /** StatusResponseModel */
         StatusResponseModel: {
             /** Message */
@@ -352,7 +541,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["CommentGetAll"];
+                    "application/json": components["schemas"]["CommentGetAll"] | components["schemas"]["CommentGetAllWithAllInfo"] | components["schemas"]["CommentGetAllWithStatus"];
                 };
             };
             /** @description Validation Error */
@@ -463,7 +652,42 @@ export interface operations {
             };
         };
     };
-    review_comment_comment__uuid__patch: {
+    update_comment_comment__uuid__patch: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                uuid: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CommentUpdate"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CommentGet"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    review_comment_comment__uuid__review_patch: {
         parameters: {
             query?: {
                 review_status?: "approved" | "dismissed";
@@ -482,7 +706,40 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["CommentGet"];
+                    "application/json": components["schemas"]["CommentGetWithAllInfo"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    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 */
@@ -504,7 +761,7 @@ export interface operations {
                 limit?: number;
                 name?: string;
                 offset?: number;
-                order_by?: "mark_kindness" | "mark_freebie" | "mark_clarity" | "mark_general" | "last_name";
+                order_by?: "mark_weighted" | "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;