@profcomff/api-uilib 2024.7.2-5.2 → 2024.7.25

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/README.md +5 -16
  2. package/package.json +2 -2
  3. package/src/openapi/achievement.ts +6 -50
  4. package/src/openapi/auth.ts +9 -9
  5. package/src/openapi/marketing.ts +1 -1
  6. package/src/openapi/pinger.ts +4 -4
  7. package/src/openapi/print.ts +1 -1
  8. package/src/openapi/services.ts +4 -4
  9. package/src/openapi/social.ts +2 -2
  10. package/src/openapi/timetable.ts +15 -15
  11. package/src/openapi/userdata.ts +5 -5
package/README.md CHANGED
@@ -8,22 +8,11 @@
8
8
  ## Использование
9
9
 
10
10
  ```ts
11
- import { createClient } from '@profcomff/api-uilib';
11
+ import { client } from @profcomff/api-uilib;
12
12
 
13
- // Setup client with base API path
14
- // You can use environment `import.meta.env.VITE_API_URL` for example
15
- const apiClient = createClient("https://api.test.profcomff.com");
16
-
17
- // Setup token for requests to API
18
- // It is optional, only for routes with authention
19
- setupAuth("myApiTokenHere");
20
-
21
- // Make request
22
- const me_with_scopes = await apiClient.GET("/auth/me", {
23
- params: {
24
- query: {
25
- info: ["session_scopes"]
26
- }
27
- }
13
+ const me = await client.GET('/auth/me', {
14
+ params: {
15
+ info: ["groups", "indirect_groups", "session_scopes", "user_scopes", "auth_methods"],
16
+ },
28
17
  });
29
18
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@profcomff/api-uilib",
3
- "version": "2024.07.25.2",
3
+ "version": "2024.07.25",
4
4
  "description": "API wrappers, autogenerated from openapi.json files",
5
5
  "main": "./src/index.ts",
6
6
  "types": "./src/index.d.ts",
@@ -18,6 +18,6 @@
18
18
  "openapi-fetch": "^0.10.2"
19
19
  },
20
20
  "scripts": {
21
- "generate": "openapi-typescript -c --alphabetize"
21
+ "generate": "openapi-typescript -c --alphabetize --path-params-as-types"
22
22
  }
23
23
  }
package/src/openapi/achievement.ts CHANGED
@@ -25,7 +25,7 @@ export interface paths {
25
25
  patch?: never;
26
26
  trace?: never;
27
27
  };
28
- "/achievement/{achievement_id}/reciever": {
28
+ [path: `/achievement/${integer}/reciever`]: {
29
29
  parameters: {
30
30
  query?: never;
31
31
  header?: never;
@@ -42,7 +42,7 @@ export interface paths {
42
42
  patch?: never;
43
43
  trace?: never;
44
44
  };
45
- "/achievement/{achievement_id}/reciever/{user_id}": {
45
+ [path: `/achievement/${integer}/reciever/${integer}`]: {
46
46
  parameters: {
47
47
  query?: never;
48
48
  header?: never;
@@ -66,7 +66,7 @@ export interface paths {
66
66
  patch?: never;
67
67
  trace?: never;
68
68
  };
69
- "/achievement/{id}": {
69
+ [path: `/achievement/${integer}`]: {
70
70
  parameters: {
71
71
  query?: never;
72
72
  header?: never;
@@ -77,11 +77,7 @@ export interface paths {
77
77
  get: operations["get_achievement_achievement__id__get"];
78
78
  put?: never;
79
79
  post?: never;
80
- /**
81
- * Delete Achievement
82
- * @description Нужны права на: `achievements.achievement.delete`
83
- */
84
- delete: operations["delete_achievement_achievement__id__delete"];
80
+ delete?: never;
85
81
  options?: never;
86
82
  head?: never;
87
83
  /**
@@ -91,7 +87,7 @@ export interface paths {
91
87
  patch: operations["edit_achievement_achievement__id__patch"];
92
88
  trace?: never;
93
89
  };
94
- "/achievement/{id}/picture": {
90
+ [path: `/achievement/${integer}/picture`]: {
95
91
  parameters: {
96
92
  query?: never;
97
93
  header?: never;
@@ -108,7 +104,7 @@ export interface paths {
108
104
  patch: operations["upload_picture_achievement__id__picture_patch"];
109
105
  trace?: never;
110
106
  };
111
- "/user/{user_id}": {
107
+ [path: `/user/${integer}`]: {
112
108
  parameters: {
113
109
  query?: never;
114
110
  header?: never;
@@ -202,15 +198,6 @@ export interface components {
202
198
  /** User Id */
203
199
  user_id: number;
204
200
  };
205
- /** StatusResponseModel */
206
- StatusResponseModel: {
207
- /** Message */
208
- message: string;
209
- /** Ru */
210
- ru: string;
211
- /** Status */
212
- status: string;
213
- };
214
201
  /** UserGet */
215
202
  UserGet: {
216
203
  /** Achievement */
@@ -415,37 +402,6 @@ export interface operations {
415
402
  };
416
403
  };
417
404
  };
418
- delete_achievement_achievement__id__delete: {
419
- parameters: {
420
- query?: never;
421
- header?: never;
422
- path: {
423
- id: number;
424
- };
425
- cookie?: never;
426
- };
427
- requestBody?: never;
428
- responses: {
429
- /** @description Successful Response */
430
- 200: {
431
- headers: {
432
- [name: string]: unknown;
433
- };
434
- content: {
435
- "application/json": components["schemas"]["StatusResponseModel"];
436
- };
437
- };
438
- /** @description Validation Error */
439
- 422: {
440
- headers: {
441
- [name: string]: unknown;
442
- };
443
- content: {
444
- "application/json": components["schemas"]["HTTPValidationError"];
445
- };
446
- };
447
- };
448
- };
449
405
  edit_achievement_achievement__id__patch: {
450
406
  parameters: {
451
407
  query?: never;
package/src/openapi/auth.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  */
5
5
 
6
6
  export interface paths {
7
- "/airflow/{user_id}/link": {
7
+ [path: `/airflow/${integer}/link`]: {
8
8
  parameters: {
9
9
  query?: never;
10
10
  header?: never;
@@ -38,7 +38,7 @@ export interface paths {
38
38
  patch?: never;
39
39
  trace?: never;
40
40
  };
41
- "/coder/{user_id}/link": {
41
+ [path: `/coder/${integer}/link`]: {
42
42
  parameters: {
43
43
  query?: never;
44
44
  header?: never;
@@ -445,7 +445,7 @@ export interface paths {
445
445
  patch?: never;
446
446
  trace?: never;
447
447
  };
448
- "/group/{id}": {
448
+ [path: `/group/${integer}`]: {
449
449
  parameters: {
450
450
  query?: never;
451
451
  header?: never;
@@ -597,7 +597,7 @@ export interface paths {
597
597
  patch?: never;
598
598
  trace?: never;
599
599
  };
600
- "/mailu/{user_id}/link": {
600
+ [path: `/mailu/${integer}/link`]: {
601
601
  parameters: {
602
602
  query?: never;
603
603
  header?: never;
@@ -860,7 +860,7 @@ export interface paths {
860
860
  patch?: never;
861
861
  trace?: never;
862
862
  };
863
- "/postgres/{user_id}/link": {
863
+ [path: `/postgres/${integer}/link`]: {
864
864
  parameters: {
865
865
  query?: never;
866
866
  header?: never;
@@ -918,7 +918,7 @@ export interface paths {
918
918
  patch?: never;
919
919
  trace?: never;
920
920
  };
921
- "/scope/{id}": {
921
+ [path: `/scope/${integer}`]: {
922
922
  parameters: {
923
923
  query?: never;
924
924
  header?: never;
@@ -965,7 +965,7 @@ export interface paths {
965
965
  patch?: never;
966
966
  trace?: never;
967
967
  };
968
- "/session/{id}": {
968
+ [path: `/session/${integer}`]: {
969
969
  parameters: {
970
970
  query?: never;
971
971
  header?: never;
@@ -982,7 +982,7 @@ export interface paths {
982
982
  patch: operations["update_session_session__id__patch"];
983
983
  trace?: never;
984
984
  };
985
- "/session/{token}": {
985
+ [path: `/session/${string}`]: {
986
986
  parameters: {
987
987
  query?: never;
988
988
  header?: never;
@@ -1119,7 +1119,7 @@ export interface paths {
1119
1119
  patch?: never;
1120
1120
  trace?: never;
1121
1121
  };
1122
- "/user/{user_id}": {
1122
+ [path: `/user/${integer}`]: {
1123
1123
  parameters: {
1124
1124
  query?: never;
1125
1125
  header?: never;
package/src/openapi/marketing.ts CHANGED
@@ -44,7 +44,7 @@ export interface paths {
44
44
  patch?: never;
45
45
  trace?: never;
46
46
  };
47
- "/v1/user/{id}": {
47
+ [path: `/v1/user/${integer}`]: {
48
48
  parameters: {
49
49
  query?: never;
50
50
  header?: never;
package/src/openapi/pinger.ts CHANGED
@@ -28,7 +28,7 @@ export interface paths {
28
28
  patch?: never;
29
29
  trace?: never;
30
30
  };
31
- "/alert/{id}": {
31
+ [path: `/alert/${integer}`]: {
32
32
  parameters: {
33
33
  query?: never;
34
34
  header?: never;
@@ -80,7 +80,7 @@ export interface paths {
80
80
  patch?: never;
81
81
  trace?: never;
82
82
  };
83
- "/fetcher/{id}": {
83
+ [path: `/fetcher/${integer}`]: {
84
84
  parameters: {
85
85
  query?: never;
86
86
  header?: never;
@@ -132,7 +132,7 @@ export interface paths {
132
132
  patch?: never;
133
133
  trace?: never;
134
134
  };
135
- "/metric/{id}": {
135
+ [path: `/metric/${integer}`]: {
136
136
  parameters: {
137
137
  query?: never;
138
138
  header?: never;
@@ -176,7 +176,7 @@ export interface paths {
176
176
  patch?: never;
177
177
  trace?: never;
178
178
  };
179
- "/receiver/{id}": {
179
+ [path: `/receiver/${integer}`]: {
180
180
  parameters: {
181
181
  query?: never;
182
182
  header?: never;
package/src/openapi/print.ts CHANGED
@@ -60,7 +60,7 @@ export interface paths {
60
60
  patch?: never;
61
61
  trace?: never;
62
62
  };
63
- "/file/{pin}": {
63
+ [path: `/file/${string}`]: {
64
64
  parameters: {
65
65
  query?: never;
66
66
  header?: never;
package/src/openapi/services.ts CHANGED
@@ -32,7 +32,7 @@ export interface paths {
32
32
  patch?: never;
33
33
  trace?: never;
34
34
  };
35
- "/category/{category_id}": {
35
+ [path: `/category/${integer}`]: {
36
36
  parameters: {
37
37
  query?: never;
38
38
  header?: never;
@@ -66,7 +66,7 @@ export interface paths {
66
66
  patch: operations["update_category_category__category_id__patch"];
67
67
  trace?: never;
68
68
  };
69
- "/category/{category_id}/button": {
69
+ [path: `/category/${integer}/button`]: {
70
70
  parameters: {
71
71
  query?: never;
72
72
  header?: never;
@@ -94,7 +94,7 @@ export interface paths {
94
94
  patch?: never;
95
95
  trace?: never;
96
96
  };
97
- "/category/{category_id}/button/{button_id}": {
97
+ [path: `/category/${integer}/button/${integer}`]: {
98
98
  parameters: {
99
99
  query?: never;
100
100
  header?: never;
@@ -128,7 +128,7 @@ export interface paths {
128
128
  patch: operations["update_button_category__category_id__button__button_id__patch"];
129
129
  trace?: never;
130
130
  };
131
- "/service/{button_id}": {
131
+ [path: `/service/${integer}`]: {
132
132
  parameters: {
133
133
  query?: never;
134
134
  header?: never;
package/src/openapi/social.ts CHANGED
@@ -69,7 +69,7 @@ export interface paths {
69
69
  patch?: never;
70
70
  trace?: never;
71
71
  };
72
- "/group/{group_id}": {
72
+ [path: `/group/${integer}`]: {
73
73
  parameters: {
74
74
  query?: never;
75
75
  header?: never;
@@ -148,7 +148,7 @@ export interface paths {
148
148
  patch?: never;
149
149
  trace?: never;
150
150
  };
151
- "/vk/{group_id}": {
151
+ [path: `/vk/${integer}`]: {
152
152
  parameters: {
153
153
  query?: never;
154
154
  header?: never;
package/src/openapi/timetable.ts CHANGED
@@ -22,7 +22,7 @@ export interface paths {
22
22
  patch?: never;
23
23
  trace?: never;
24
24
  };
25
- "/event/{event_id}/comment/": {
25
+ [path: `/event/${integer}/comment/`]: {
26
26
  parameters: {
27
27
  query?: never;
28
28
  header?: never;
@@ -40,7 +40,7 @@ export interface paths {
40
40
  patch?: never;
41
41
  trace?: never;
42
42
  };
43
- "/event/{event_id}/comment/{id}": {
43
+ [path: `/event/${integer}/comment/${integer}`]: {
44
44
  parameters: {
45
45
  query?: never;
46
46
  header?: never;
@@ -59,7 +59,7 @@ export interface paths {
59
59
  patch: operations["update_comment_event__event_id__comment__id__patch"];
60
60
  trace?: never;
61
61
  };
62
- "/event/{event_id}/comment/{id}/review/": {
62
+ [path: `/event/${integer}/comment/${integer}/review/`]: {
63
63
  parameters: {
64
64
  query?: never;
65
65
  header?: never;
@@ -76,7 +76,7 @@ export interface paths {
76
76
  patch?: never;
77
77
  trace?: never;
78
78
  };
79
- "/event/{event_id}/comment/review/": {
79
+ [path: `/event/${integer}/comment/review/`]: {
80
80
  parameters: {
81
81
  query?: never;
82
82
  header?: never;
@@ -93,7 +93,7 @@ export interface paths {
93
93
  patch?: never;
94
94
  trace?: never;
95
95
  };
96
- "/event/{id}": {
96
+ [path: `/event/${integer}`]: {
97
97
  parameters: {
98
98
  query?: never;
99
99
  header?: never;
@@ -148,7 +148,7 @@ export interface paths {
148
148
  patch?: never;
149
149
  trace?: never;
150
150
  };
151
- "/group/{id}": {
151
+ [path: `/group/${integer}`]: {
152
152
  parameters: {
153
153
  query?: never;
154
154
  header?: never;
@@ -185,7 +185,7 @@ export interface paths {
185
185
  patch?: never;
186
186
  trace?: never;
187
187
  };
188
- "/lecturer/{id}": {
188
+ [path: `/lecturer/${integer}`]: {
189
189
  parameters: {
190
190
  query?: never;
191
191
  header?: never;
@@ -204,7 +204,7 @@ export interface paths {
204
204
  patch: operations["patch_lecturer_lecturer__id__patch"];
205
205
  trace?: never;
206
206
  };
207
- "/lecturer/{lecturer_id}/comment/": {
207
+ [path: `/lecturer/${integer}/comment/`]: {
208
208
  parameters: {
209
209
  query?: never;
210
210
  header?: never;
@@ -222,7 +222,7 @@ export interface paths {
222
222
  patch?: never;
223
223
  trace?: never;
224
224
  };
225
- "/lecturer/{lecturer_id}/comment/{id}": {
225
+ [path: `/lecturer/${integer}/comment/${integer}`]: {
226
226
  parameters: {
227
227
  query?: never;
228
228
  header?: never;
@@ -241,7 +241,7 @@ export interface paths {
241
241
  patch: operations["update_comment_lecturer_lecturer__lecturer_id__comment__id__patch"];
242
242
  trace?: never;
243
243
  };
244
- "/lecturer/{lecturer_id}/comment/{id}/review/": {
244
+ [path: `/lecturer/${integer}/comment/${integer}/review/`]: {
245
245
  parameters: {
246
246
  query?: never;
247
247
  header?: never;
@@ -258,7 +258,7 @@ export interface paths {
258
258
  patch?: never;
259
259
  trace?: never;
260
260
  };
261
- "/lecturer/{lecturer_id}/comment/review/": {
261
+ [path: `/lecturer/${integer}/comment/review/`]: {
262
262
  parameters: {
263
263
  query?: never;
264
264
  header?: never;
@@ -275,7 +275,7 @@ export interface paths {
275
275
  patch?: never;
276
276
  trace?: never;
277
277
  };
278
- "/lecturer/{lecturer_id}/photo": {
278
+ [path: `/lecturer/${integer}/photo`]: {
279
279
  parameters: {
280
280
  query?: never;
281
281
  header?: never;
@@ -306,7 +306,7 @@ export interface paths {
306
306
  patch?: never;
307
307
  trace?: never;
308
308
  };
309
- "/lecturer/{lecturer_id}/photo/{id}": {
309
+ [path: `/lecturer/${integer}/photo/${integer}`]: {
310
310
  parameters: {
311
311
  query?: never;
312
312
  header?: never;
@@ -341,7 +341,7 @@ export interface paths {
341
341
  patch?: never;
342
342
  trace?: never;
343
343
  };
344
- "/lecturer/photo/review/{id}": {
344
+ [path: `/lecturer/photo/review/${integer}`]: {
345
345
  parameters: {
346
346
  query?: never;
347
347
  header?: never;
@@ -376,7 +376,7 @@ export interface paths {
376
376
  patch?: never;
377
377
  trace?: never;
378
378
  };
379
- "/room/{id}": {
379
+ [path: `/room/${integer}`]: {
380
380
  parameters: {
381
381
  query?: never;
382
382
  header?: never;
package/src/openapi/userdata.ts CHANGED
@@ -29,7 +29,7 @@ export interface paths {
29
29
  patch?: never;
30
30
  trace?: never;
31
31
  };
32
- "/category/{category_id}/param": {
32
+ [path: `/category/${integer}/param`]: {
33
33
  parameters: {
34
34
  query?: never;
35
35
  header?: never;
@@ -53,7 +53,7 @@ export interface paths {
53
53
  patch?: never;
54
54
  trace?: never;
55
55
  };
56
- "/category/{category_id}/param/{id}": {
56
+ [path: `/category/${integer}/param/${integer}`]: {
57
57
  parameters: {
58
58
  query?: never;
59
59
  header?: never;
@@ -81,7 +81,7 @@ export interface paths {
81
81
  patch: operations["patch_param_category__category_id__param__id__patch"];
82
82
  trace?: never;
83
83
  };
84
- "/category/{id}": {
84
+ [path: `/category/${integer}`]: {
85
85
  parameters: {
86
86
  query?: never;
87
87
  header?: never;
@@ -133,7 +133,7 @@ export interface paths {
133
133
  patch?: never;
134
134
  trace?: never;
135
135
  };
136
- "/source/{id}": {
136
+ [path: `/source/${integer}`]: {
137
137
  parameters: {
138
138
  query?: never;
139
139
  header?: never;
@@ -161,7 +161,7 @@ export interface paths {
161
161
  patch: operations["patch_source_source__id__patch"];
162
162
  trace?: never;
163
163
  };
164
- "/user/{id}": {
164
+ [path: `/user/${integer}`]: {
165
165
  parameters: {
166
166
  query?: never;
167
167
  header?: never;