academe-kit 0.15.0 → 0.17.0
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.
- package/dist/index.cjs +22 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +747 -62
- package/dist/index.esm.js +22 -0
- package/dist/index.esm.js.map +1 -1
- package/dist/types/services/QuizService.d.ts +55 -0
- package/dist/types/services/userService.d.ts +48 -4
- package/dist/types/types/academe-api.d.ts +593 -7
- package/package.json +4 -2
|
@@ -21,6 +21,7 @@ type GetQuizzesParams = {
|
|
|
21
21
|
type GetQuizzesWithContextParams = paths['/quiz/with-context']['get']['parameters']['query'];
|
|
22
22
|
type GenerateQuizQuestionsBody = paths['/quiz/generate-questions']['post']['requestBody']['content']['application/json'];
|
|
23
23
|
type BulkCreateQuizQuestionsBody = paths['/quiz-questions/bulk']['post']['requestBody']['content']['application/json'];
|
|
24
|
+
type GenerateQuizExplanationsBody = NonNullable<paths['/quiz-questions/{id}/generate-explanations']['post']['requestBody']>['content']['application/json'];
|
|
24
25
|
type GetQuizQuestionsParams = paths['/quiz-questions']['get']['parameters']['query'];
|
|
25
26
|
type GetQuizQuestionAnswersParams = paths['/quiz-question-answers']['get']['parameters']['query'];
|
|
26
27
|
type GetQuizAttemptsParams = paths['/quiz-attempts']['get']['parameters']['query'];
|
|
@@ -167,6 +168,7 @@ export declare function createQuizService(apiClient: AcademeApiClient): {
|
|
|
167
168
|
options?: {
|
|
168
169
|
text?: string;
|
|
169
170
|
is_correct?: boolean;
|
|
171
|
+
explanation?: string;
|
|
170
172
|
}[];
|
|
171
173
|
}[];
|
|
172
174
|
};
|
|
@@ -496,6 +498,7 @@ export declare function createQuizService(apiClient: AcademeApiClient): {
|
|
|
496
498
|
options?: {
|
|
497
499
|
text?: string;
|
|
498
500
|
is_correct?: boolean;
|
|
501
|
+
explanation?: string;
|
|
499
502
|
}[];
|
|
500
503
|
}[];
|
|
501
504
|
};
|
|
@@ -527,10 +530,60 @@ export declare function createQuizService(apiClient: AcademeApiClient): {
|
|
|
527
530
|
options?: {
|
|
528
531
|
text?: string;
|
|
529
532
|
is_correct?: boolean;
|
|
533
|
+
explanation?: string;
|
|
530
534
|
}[];
|
|
531
535
|
}[];
|
|
532
536
|
};
|
|
533
537
|
}, `${string}/${string}`>>;
|
|
538
|
+
/**
|
|
539
|
+
* Generate the explanation of every answer of an existing question, with AI.
|
|
540
|
+
*
|
|
541
|
+
* Backfill das perguntas criadas antes de a explicação existir. Sobrescreve
|
|
542
|
+
* o que houver — confirme com o usuário antes de chamar.
|
|
543
|
+
*/
|
|
544
|
+
generateQuestionExplanations(id: string, body?: GenerateQuizExplanationsBody): Promise<import("openapi-fetch").FetchResponse<{
|
|
545
|
+
parameters: {
|
|
546
|
+
query?: never;
|
|
547
|
+
header?: never;
|
|
548
|
+
path: {
|
|
549
|
+
id: string;
|
|
550
|
+
};
|
|
551
|
+
cookie?: never;
|
|
552
|
+
};
|
|
553
|
+
requestBody?: {
|
|
554
|
+
content: {
|
|
555
|
+
"application/json": {
|
|
556
|
+
model?: string;
|
|
557
|
+
};
|
|
558
|
+
};
|
|
559
|
+
};
|
|
560
|
+
responses: {
|
|
561
|
+
200: {
|
|
562
|
+
headers: {
|
|
563
|
+
[name: string]: unknown;
|
|
564
|
+
};
|
|
565
|
+
content: {
|
|
566
|
+
"application/json": {
|
|
567
|
+
status?: string;
|
|
568
|
+
data?: components["schemas"]["QuizQuestion"];
|
|
569
|
+
};
|
|
570
|
+
};
|
|
571
|
+
};
|
|
572
|
+
400: components["responses"]["BadRequest"];
|
|
573
|
+
401: components["responses"]["Unauthorized"];
|
|
574
|
+
404: components["responses"]["NotFound"];
|
|
575
|
+
500: components["responses"]["ServerError"];
|
|
576
|
+
};
|
|
577
|
+
}, {
|
|
578
|
+
params: {
|
|
579
|
+
path: {
|
|
580
|
+
id: string;
|
|
581
|
+
};
|
|
582
|
+
};
|
|
583
|
+
body: {
|
|
584
|
+
model?: string;
|
|
585
|
+
};
|
|
586
|
+
}, `${string}/${string}`>>;
|
|
534
587
|
/**
|
|
535
588
|
* Update quiz question
|
|
536
589
|
*/
|
|
@@ -728,6 +781,7 @@ export declare function createQuizService(apiClient: AcademeApiClient): {
|
|
|
728
781
|
questionId: string;
|
|
729
782
|
answer: string;
|
|
730
783
|
isCorrect: boolean;
|
|
784
|
+
explanation?: string;
|
|
731
785
|
};
|
|
732
786
|
}, `${string}/${string}`>>;
|
|
733
787
|
/**
|
|
@@ -773,6 +827,7 @@ export declare function createQuizService(apiClient: AcademeApiClient): {
|
|
|
773
827
|
body: {
|
|
774
828
|
answer?: string;
|
|
775
829
|
isCorrect?: boolean;
|
|
830
|
+
explanation?: string;
|
|
776
831
|
};
|
|
777
832
|
}, `${string}/${string}`>>;
|
|
778
833
|
/**
|
|
@@ -203,14 +203,17 @@ export declare function createUserService(apiClient: AcademeApiClient): {
|
|
|
203
203
|
body: {
|
|
204
204
|
firstName: string;
|
|
205
205
|
lastName: string;
|
|
206
|
-
email
|
|
206
|
+
email?: string | null;
|
|
207
|
+
username?: string | null;
|
|
207
208
|
password: string;
|
|
208
209
|
phone?: string | null;
|
|
209
|
-
document
|
|
210
|
+
document?: string | null;
|
|
210
211
|
gender?: "male" | "female" | "other" | null;
|
|
211
212
|
birthdate?: string | null;
|
|
212
213
|
groupId?: string | null;
|
|
213
214
|
institutionId?: string | null;
|
|
215
|
+
institutionClassroomId?: string | null;
|
|
216
|
+
userCreationRequestsGroupId?: string | null;
|
|
214
217
|
seatCodeId?: string | null;
|
|
215
218
|
guardianId?: string | null;
|
|
216
219
|
guardian?: components["schemas"]["CreateGuardianInlineDto"];
|
|
@@ -248,20 +251,61 @@ export declare function createUserService(apiClient: AcademeApiClient): {
|
|
|
248
251
|
body: {
|
|
249
252
|
firstName: string;
|
|
250
253
|
lastName: string;
|
|
251
|
-
email
|
|
254
|
+
email?: string | null;
|
|
255
|
+
username?: string | null;
|
|
252
256
|
password: string;
|
|
253
257
|
phone?: string | null;
|
|
254
|
-
document
|
|
258
|
+
document?: string | null;
|
|
255
259
|
gender?: "male" | "female" | "other" | null;
|
|
256
260
|
birthdate?: string | null;
|
|
257
261
|
groupId?: string | null;
|
|
258
262
|
institutionId?: string | null;
|
|
263
|
+
institutionClassroomId?: string | null;
|
|
264
|
+
userCreationRequestsGroupId?: string | null;
|
|
259
265
|
seatCodeId?: string | null;
|
|
260
266
|
guardianId?: string | null;
|
|
261
267
|
guardian?: components["schemas"]["CreateGuardianInlineDto"];
|
|
262
268
|
avatarFileId?: string | null;
|
|
263
269
|
};
|
|
264
270
|
}, `${string}/${string}`>>;
|
|
271
|
+
/**
|
|
272
|
+
* Consulta o status de uma criação assíncrona de usuário, a partir do
|
|
273
|
+
* requestId devolvido pelo POST /users. Traz o `username` (login) gerado
|
|
274
|
+
* pelo worker — útil quando o usuário foi criado sem email.
|
|
275
|
+
*/
|
|
276
|
+
getUserCreationRequest(requestId: string): Promise<import("openapi-fetch").FetchResponse<{
|
|
277
|
+
parameters: {
|
|
278
|
+
query?: never;
|
|
279
|
+
header?: never;
|
|
280
|
+
path: {
|
|
281
|
+
requestId: string;
|
|
282
|
+
};
|
|
283
|
+
cookie?: never;
|
|
284
|
+
};
|
|
285
|
+
requestBody?: never;
|
|
286
|
+
responses: {
|
|
287
|
+
200: {
|
|
288
|
+
headers: {
|
|
289
|
+
[name: string]: unknown;
|
|
290
|
+
};
|
|
291
|
+
content: {
|
|
292
|
+
"application/json": {
|
|
293
|
+
status?: string;
|
|
294
|
+
data?: components["schemas"]["UserCreationRequest"];
|
|
295
|
+
};
|
|
296
|
+
};
|
|
297
|
+
};
|
|
298
|
+
401: components["responses"]["Unauthorized"];
|
|
299
|
+
404: components["responses"]["NotFound"];
|
|
300
|
+
500: components["responses"]["ServerError"];
|
|
301
|
+
};
|
|
302
|
+
}, {
|
|
303
|
+
params: {
|
|
304
|
+
path: {
|
|
305
|
+
requestId: string;
|
|
306
|
+
};
|
|
307
|
+
};
|
|
308
|
+
}, `${string}/${string}`>>;
|
|
265
309
|
/**
|
|
266
310
|
* Update user information
|
|
267
311
|
*/
|