academe-kit 0.16.0 → 0.17.0

package/dist/types/services/QuizService.d.ts

@@ -21,6 +21,7 @@ type GetQuizzesParams = {
 type GetQuizzesWithContextParams = paths['/quiz/with-context']['get']['parameters']['query'];
 type GenerateQuizQuestionsBody = paths['/quiz/generate-questions']['post']['requestBody']['content']['application/json'];
 type BulkCreateQuizQuestionsBody = paths['/quiz-questions/bulk']['post']['requestBody']['content']['application/json'];
+type GenerateQuizExplanationsBody = NonNullable<paths['/quiz-questions/{id}/generate-explanations']['post']['requestBody']>['content']['application/json'];
 type GetQuizQuestionsParams = paths['/quiz-questions']['get']['parameters']['query'];
 type GetQuizQuestionAnswersParams = paths['/quiz-question-answers']['get']['parameters']['query'];
 type GetQuizAttemptsParams = paths['/quiz-attempts']['get']['parameters']['query'];
@@ -167,6 +168,7 @@ export declare function createQuizService(apiClient: AcademeApiClient): {
                             options?: {
                                 text?: string;
                                 is_correct?: boolean;
+                                explanation?: string;
                             }[];
                         }[];
                     };
@@ -496,6 +498,7 @@ export declare function createQuizService(apiClient: AcademeApiClient): {
                         options?: {
                             text?: string;
                             is_correct?: boolean;
+                            explanation?: string;
                         }[];
                     }[];
                 };
@@ -527,10 +530,60 @@ export declare function createQuizService(apiClient: AcademeApiClient): {
                 options?: {
                     text?: string;
                     is_correct?: boolean;
+                    explanation?: string;
                 }[];
             }[];
         };
     }, `${string}/${string}`>>;
+    /**
+     * Generate the explanation of every answer of an existing question, with AI.
+     *
+     * Backfill das perguntas criadas antes de a explicação existir. Sobrescreve
+     * o que houver — confirme com o usuário antes de chamar.
+     */
+    generateQuestionExplanations(id: string, body?: GenerateQuizExplanationsBody): Promise<import("openapi-fetch").FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    model?: string;
+                };
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        status?: string;
+                        data?: components["schemas"]["QuizQuestion"];
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["ServerError"];
+        };
+    }, {
+        params: {
+            path: {
+                id: string;
+            };
+        };
+        body: {
+            model?: string;
+        };
+    }, `${string}/${string}`>>;
     /**
      * Update quiz question
      */
@@ -728,6 +781,7 @@ export declare function createQuizService(apiClient: AcademeApiClient): {
             questionId: string;
             answer: string;
             isCorrect: boolean;
+            explanation?: string;
         };
     }, `${string}/${string}`>>;
     /**
@@ -773,6 +827,7 @@ export declare function createQuizService(apiClient: AcademeApiClient): {
         body: {
             answer?: string;
             isCorrect?: boolean;
+            explanation?: string;
         };
     }, `${string}/${string}`>>;
     /**

package/dist/types/types/academe-api.d.ts

@@ -11411,6 +11411,62 @@ export interface paths {
         };
         trace?: never;
     };
+    "/quiz-questions/{id}/generate-explanations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Generate answer explanations with AI
+         * @description Preenche via IA a explicação de cada alternativa de uma pergunta que já existe — o backfill dos quizzes criados antes da feature. Sobrescreve as explicações existentes; o backoffice confirma antes de chamar.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: {
+                content: {
+                    "application/json": {
+                        /** @description Modelo OpenRouter a usar. Omitido, usa o padrão do servidor. */
+                        model?: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Pergunta com as alternativas atualizadas */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["QuizQuestion"];
+                        };
+                    };
+                };
+                400: components["responses"]["BadRequest"];
+                401: components["responses"]["Unauthorized"];
+                404: components["responses"]["NotFound"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/quiz-questions/bulk": {
         parameters: {
             query?: never;
@@ -11444,6 +11500,8 @@ export interface paths {
                             options?: {
                                 text?: string;
                                 is_correct?: boolean;
+                                /** @description Resumo revelado ao aluno ao confirmar a resposta. */
+                                explanation?: string;
                             }[];
                         }[];
                     };
@@ -11915,6 +11973,8 @@ export interface paths {
                                 options?: {
                                     text?: string;
                                     is_correct?: boolean;
+                                    /** @description Resumo revelado ao aluno ao confirmar a resposta. String vazia quando a IA não produziu. */
+                                    explanation?: string;
                                 }[];
                             }[];
                         };
@@ -20288,6 +20348,11 @@ export interface components {
             answer?: string;
             /** @example true */
             isCorrect?: boolean;
+            /**
+             * @description Resumo revelado ao aluno ao confirmar a resposta. Na alternativa correta explica o conceito; nas incorretas, o erro que a opção representa. NULL nas perguntas anteriores à feature.
+             * @example O 'S' significa 'Secure' e indica que o protocolo utiliza SSL/TLS.
+             */
+            explanation?: string | null;
             /** Format: date-time */
             createdAt?: string;
             /** Format: date-time */
@@ -20300,10 +20365,14 @@ export interface components {
             answer: string;
             /** @example true */
             isCorrect: boolean;
+            /** @description Resumo revelado ao aluno ao confirmar a resposta. String vazia limpa. */
+            explanation?: string;
         };
         UpdateQuizQuestionAnswerDto: {
             answer?: string;
             isCorrect?: boolean;
+            /** @description Resumo revelado ao aluno ao confirmar a resposta. String vazia limpa. */
+            explanation?: string;
         };
         QuizAttempt: {
             /** Format: uuid */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "academe-kit",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "type": "module",
   "description": "Official React SDK for Academe ecosystem - Authentication, protected routes, API services, and UI components for educational management applications",
   "main": "dist/index.cjs",