academe-kit 0.12.1 → 0.14.0

package/dist/types/index.d.ts

@@ -20,6 +20,9 @@ export { createAcademeApiClient } from "./services";
 export type { AcademeApiClient, AcademeServices } from "./services";
 export type { ChallengeUserQuizAttempt, ChallengeUserQuizAttemptsResponse, } from "./services/ChallengeService";
 export type { JourneyStepView, JourneyChallengeView, JourneyView, } from "./services/UserProgressService";
+export type { AccessibleSerie, ClassroomSummary, UserEnrollment, } from "./services/userService";
+export type { VitrineHome, VitrinePlaylist, VitrineCard, VitrineCardKind, VitrinePlaylistSource, VitrineCardOrientation, } from "./services/VitrineService";
+export type { WatchlistItem, WatchlistResponse, WatchlistType, } from "./services/WatchlistService";
 export { cn } from "./lib/utils";
 import "./index.css";
 import "./styles/globals.css";

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

@@ -397,7 +397,6 @@ export declare function createChallengeService(apiClient: AcademeApiClient): {
                     tutorialTitle?: string;
                     tutorialDescription?: string;
                     tutorialVideoUrl?: string;
-                    redirectUrl?: string;
                     isActive?: boolean;
                 };
             };
@@ -432,7 +431,6 @@ export declare function createChallengeService(apiClient: AcademeApiClient): {
             tutorialTitle?: string;
             tutorialDescription?: string;
             tutorialVideoUrl?: string;
-            redirectUrl?: string;
             isActive?: boolean;
         };
     }, `${string}/${string}`>>;

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

@@ -161,12 +161,12 @@ export declare function createQuizService(apiClient: AcademeApiClient): {
                     "application/json": {
                         status?: string;
                         data?: {
-                            question_text?: string;
-                            question_type?: "multiple_choice" | "true_false";
-                            points?: number;
-                            options?: {
-                                text?: string;
-                                is_correct?: boolean;
+                            question_text: string;
+                            question_type: "multiple_choice" | "true_false";
+                            points: number;
+                            options: {
+                                text: string;
+                                is_correct: boolean;
                             }[];
                         }[];
                     };
@@ -494,8 +494,8 @@ export declare function createQuizService(apiClient: AcademeApiClient): {
                         type: "multiple_choice" | "true_false" | "open";
                         points?: number;
                         options?: {
-                            text?: string;
-                            is_correct?: boolean;
+                            text: string;
+                            is_correct: boolean;
                         }[];
                     }[];
                 };
@@ -525,8 +525,8 @@ export declare function createQuizService(apiClient: AcademeApiClient): {
                 type: "multiple_choice" | "true_false" | "open";
                 points?: number;
                 options?: {
-                    text?: string;
-                    is_correct?: boolean;
+                    text: string;
+                    is_correct: boolean;
                 }[];
             }[];
         };

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

@@ -10,7 +10,7 @@ export declare function createStepService(apiClient: AcademeApiClient): {
     getAll(params?: GetStepsParams): Promise<import("openapi-fetch").FetchResponse<{
         parameters: {
             query?: {
-                type?: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate" | "redirect";
+                type?: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate";
                 isActive?: boolean;
             };
             header?: never;
@@ -36,7 +36,7 @@ export declare function createStepService(apiClient: AcademeApiClient): {
     }, {
         params: {
             query: {
-                type?: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate" | "redirect";
+                type?: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate";
                 isActive?: boolean;
             } | undefined;
         };
@@ -94,7 +94,7 @@ export declare function createStepService(apiClient: AcademeApiClient): {
                     name: string;
                     color: string;
                     icon: string;
-                    type: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate" | "redirect";
+                    type: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate";
                     isActive?: boolean;
                 };
             };
@@ -120,7 +120,7 @@ export declare function createStepService(apiClient: AcademeApiClient): {
             name: string;
             color: string;
             icon: string;
-            type: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate" | "redirect";
+            type: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate";
             isActive?: boolean;
         };
     }, `${string}/${string}`>>;
@@ -142,7 +142,7 @@ export declare function createStepService(apiClient: AcademeApiClient): {
                     name?: string;
                     color?: string;
                     icon?: string;
-                    type?: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate" | "redirect";
+                    type?: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate";
                     isActive?: boolean;
                 };
             };
@@ -174,7 +174,7 @@ export declare function createStepService(apiClient: AcademeApiClient): {
             name?: string;
             color?: string;
             icon?: string;
-            type?: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate" | "redirect";
+            type?: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate";
             isActive?: boolean;
         };
     }, `${string}/${string}`>>;

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

@@ -16,8 +16,15 @@ export declare function createUserProgressService(apiClient: AcademeApiClient):
      * `userId` é [Admin]: quando informado, retorna a jornada do usuário-alvo
      * (ex.: backoffice visualizando a jornada de um aluno); omitido = jornada
      * do próprio usuário autenticado.
+     *
+     * `institutionId` é a escola ATUAL: a jornada é POR ESCOLA (o usuário pode
+     * estar em várias). Omitido = 1ª matrícula resolvida no backend.
+     *
+     * ⚠️ Ordem dos parâmetros: `institutionId` foi adicionado como 3º parâmetro
+     * (após `userId`) para NÃO quebrar chamadas posicionais existentes — o
+     * backoffice chama `getJourney(undefined, userId)`.
      */
-    getJourney(serieId?: string, userId?: string): Promise<JourneyView>;
+    getJourney(serieId?: string, userId?: string, institutionId?: string): Promise<JourneyView>;
     /**
      * Visão step-by-step do progresso do usuário em um desafio. Cada step traz
      * `myStartedAt`, `myCompletedAt` e (em desafios em grupo) os agregados do

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

@@ -0,0 +1,51 @@
+import type { AcademeApiClient } from "./index";
+/**
+ * Vitrine (Home) do aluno — rails/playlists estilo Netflix.
+ * Consome `GET /vitrine/home` do api-academe-v2.
+ *
+ * ⚠️ O endpoint ainda NÃO está no OpenAPI gerado (`academe-api.ts`), então os
+ * tipos abaixo são MANTIDOS À MÃO e a chamada usa cast — mesmo padrão de
+ * `InstitutionService.setUserClassrooms`. Quando o backend expuser o schema,
+ * regenerar os tipos e apertar.
+ */
+export type VitrineCardKind = "course" | "module" | "lesson" | "playlist";
+export type VitrinePlaylistSource = "curated" | "continue_watching" | "trending" | "watchlist" | "recent" | "continue_playlist";
+export type VitrineCardOrientation = "horizontal" | "vertical" | "square" | "fullImage";
+export interface VitrineCard {
+    kind: VitrineCardKind;
+    id: string;
+    courseId?: string | null;
+    title: string;
+    subtitle?: string | null;
+    coverUrl?: string | null;
+    durationSeconds?: number | null;
+    progressPct?: number | null;
+    courseTitle?: string | null;
+    lessonLabel?: string | null;
+    rank?: number | null;
+}
+export interface VitrinePlaylist {
+    id: string;
+    title: string;
+    subtitle: string | null;
+    source: VitrinePlaylistSource;
+    variant: "common" | "featured";
+    cardOrientation: VitrineCardOrientation;
+    itemsPerViewDesktop: number;
+    itemsPerViewMobile: number;
+    autoplay: boolean;
+    style: Record<string, unknown>;
+    items: VitrineCard[];
+}
+export interface VitrineHome {
+    institutionId: string | null;
+    playlists: VitrinePlaylist[];
+}
+export declare function createVitrineService(apiClient: AcademeApiClient): {
+    /**
+     * Home do aluno para a escola atual. `institutionId` omitido = 1ª matrícula
+     * (o backend resolve). Recarregar ao trocar de escola no app.
+     */
+    getHome(institutionId?: string): Promise<VitrineHome>;
+};
+export type VitrineService = ReturnType<typeof createVitrineService>;

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

@@ -0,0 +1,29 @@
+import type { AcademeApiClient } from "./index";
+/**
+ * "Minha lista" (watchlist) do aluno. Consome `/me/watchlist` do api-academe-v2.
+ * Endpoint ainda NÃO no OpenAPI gerado → cast + tipos à mão (padrão do repo).
+ */
+export type WatchlistType = "course" | "module" | "lesson";
+export interface WatchlistItem {
+    /** id da linha (para remover pela tela). */
+    id: string;
+    type: WatchlistType;
+    /** id do conteúdo (curso/módulo/aula). */
+    contentId: string;
+    courseId: string | null;
+    title: string;
+    coverUrl: string | null;
+}
+export interface WatchlistResponse {
+    items: WatchlistItem[];
+    count: number;
+}
+export declare function createWatchlistService(apiClient: AcademeApiClient): {
+    /** Itens da "Minha lista" + contagem. */
+    getMine(): Promise<WatchlistResponse>;
+    /** Adiciona um conteúdo (idempotente). */
+    add(type: WatchlistType, id: string): Promise<void>;
+    /** Remove um conteúdo pelo alvo. */
+    remove(type: WatchlistType, id: string): Promise<void>;
+};
+export type WatchlistService = ReturnType<typeof createWatchlistService>;

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

@@ -22,6 +22,8 @@ import { type ChallengeService } from './ChallengeService';
 import { type StepService } from './StepService';
 import { type SubmissionService } from './SubmissionService';
 import { type UserProgressService } from './UserProgressService';
+import { type VitrineService } from './VitrineService';
+import { type WatchlistService } from './WatchlistService';
 export type AcademeApiClient = ReturnType<typeof createClient<paths>>;
 export declare function createAcademeApiClient(baseUrl: string): AcademeApiClient;
 export interface AcademeServices {
@@ -47,6 +49,8 @@ export interface AcademeServices {
     step: StepService;
     submission: SubmissionService;
     userProgress: UserProgressService;
+    vitrine: VitrineService;
+    watchlist: WatchlistService;
 }
 export declare function createAcademeServices(apiClient: AcademeApiClient): AcademeServices;
 export { createUserService, type UserService } from "./userService";
@@ -70,3 +74,5 @@ export { createChallengeService, type ChallengeService } from './ChallengeServic
 export { createStepService, type StepService } from './StepService';
 export { createSubmissionService, type SubmissionService } from './SubmissionService';
 export { createUserProgressService, type UserProgressService } from './UserProgressService';
+export { createVitrineService, type VitrineService } from './VitrineService';
+export { createWatchlistService, type WatchlistService } from './WatchlistService';

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

@@ -12,6 +12,30 @@ type GetUsersParams = {
     page?: number;
     limit?: number;
 };
+/** Série acessível ao aluno (item do seletor de séries da jornada). */
+export type AccessibleSerie = {
+    serieId: string;
+    serieValue: number;
+    serieLabel: string;
+    level: "fundamental" | "medio";
+};
+/** Turma do aluno (resumo) — para a listagem de turmas no perfil. */
+export type ClassroomSummary = {
+    institutionClassroomId: string;
+    classroomId: string;
+    classroomName: string;
+    shiftName: string | null;
+    serie: AccessibleSerie | null;
+    institutionId: string;
+    institutionName: string | null;
+};
+/** Contexto de matrícula do usuário: turmas + escola atual + séries distintas. */
+export type UserEnrollment = {
+    classrooms: ClassroomSummary[];
+    /** Escola atual resolvida pelo backend (1ª matrícula) — tem turma. */
+    currentInstitutionId: string | null;
+    series: AccessibleSerie[];
+};
 export declare function createUserService(apiClient: AcademeApiClient): {
     /**
      * Get current authenticated user
@@ -63,6 +87,13 @@ export declare function createUserService(apiClient: AcademeApiClient): {
             500: components["responses"]["ServerError"];
         };
     }> | undefined, `${string}/${string}`>>;
+    /**
+     * Contexto de matrícula do usuário: turmas (para o perfil) + séries
+     * distintas (para o seletor de séries da jornada) + escola atual. Fonte
+     * única, deduplicada e ordenada no backend. Normaliza os campos opcionais do
+     * OpenAPI. Espelha o app-academe (user.service.getMyEnrollment).
+     */
+    getMyEnrollment(): Promise<UserEnrollment>;
     /**
      * List all users with optional filters
      */

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

@@ -2335,7 +2335,6 @@ export interface paths {
          * Add a step to the challenge
          * @description Polymorphic validation:
          *     - When step.type=tutorial, tutorialVideoUrl is required
-         *     - When step.type=redirect, redirectUrl is required
          *     - The course of a step is determined by the parent challenge's courseId.
          *       Optionally, courseModuleId pinpoints a specific module within that course.
          *     - tutorial fields are optional on any step type.
@@ -2366,8 +2365,6 @@ export interface paths {
                         tutorialTitle?: string;
                         tutorialDescription?: string;
                         tutorialVideoUrl?: string;
-                        /** @description Required when parent step type=redirect */
-                        redirectUrl?: string;
                         /** @default true */
                         isActive?: boolean;
                     };
@@ -9640,69 +9637,6 @@ export interface paths {
         };
         trace?: never;
     };
-    "/quiz-questions/bulk": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /**
-         * Bulk create quiz questions
-         * @description Cria várias perguntas (com suas respostas) de uma vez para um quiz. A ordem é atribuída sequencialmente a partir da última pergunta existente.
-         */
-        post: {
-            parameters: {
-                query?: never;
-                header?: never;
-                path?: never;
-                cookie?: never;
-            };
-            requestBody: {
-                content: {
-                    "application/json": {
-                        /** Format: uuid */
-                        quizId: string;
-                        questions: {
-                            text: string;
-                            /** @enum {string} */
-                            type: "multiple_choice" | "true_false" | "open";
-                            points?: number;
-                            options?: {
-                                text?: string;
-                                is_correct?: boolean;
-                            }[];
-                        }[];
-                    };
-                };
-            };
-            responses: {
-                /** @description Perguntas criadas */
-                201: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            /** @example success */
-                            status?: string;
-                            data?: components["schemas"]["QuizQuestion"][];
-                        };
-                    };
-                };
-                400: components["responses"]["BadRequest"];
-                401: components["responses"]["Unauthorized"];
-                500: components["responses"]["ServerError"];
-            };
-        };
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/quiz-questions": {
         parameters: {
             query?: never;
@@ -9797,6 +9731,67 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/quiz-questions/bulk": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Bulk create quiz questions
+         * @description Cria várias perguntas (com respostas) de uma vez para um quiz.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        quizId: string;
+                        questions: {
+                            text: string;
+                            type: "multiple_choice" | "true_false" | "open";
+                            points?: number;
+                            options?: {
+                                text: string;
+                                is_correct: boolean;
+                            }[];
+                        }[];
+                    };
+                };
+            };
+            responses: {
+                /** @description Questions created */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["QuizQuestion"][];
+                        };
+                    };
+                };
+                400: components["responses"]["BadRequest"];
+                401: components["responses"]["Unauthorized"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/quiz-questions/{id}": {
         parameters: {
             query?: never;
@@ -10018,7 +10013,7 @@ export interface paths {
         };
         /**
          * List quizzes with course/module/category context
-         * @description Retrieve a paginated list of quizzes, each enriched with the course, module and category it belongs to. The relation is resolved on the server (Course.quizId / CourseModule.quizId), so consumers don't need to load every course to build the link map. `context` is null for standalone quizzes.
+         * @description Retrieve a paginated list of quizzes, each enriched with the course, module and category it belongs to. `context` is null for standalone quizzes.
          */
         get: {
             parameters: {
@@ -10054,20 +10049,16 @@ export interface paths {
                             data?: (components["schemas"]["Quiz"] & {
                                 context?: {
                                     course?: {
-                                        /** Format: uuid */
                                         id?: string;
                                         title?: string;
                                     } | null;
                                     module?: {
-                                        /** Format: uuid */
                                         id?: string;
                                         title?: string;
                                     } | null;
                                     category?: {
-                                        /** Format: uuid */
                                         id?: string;
                                         name?: string;
-                                        /** @example #44bd32 */
                                         color?: string | null;
                                     } | null;
                                 } | null;
@@ -10099,7 +10090,7 @@ export interface paths {
         put?: never;
         /**
          * Generate quiz questions with AI
-         * @description Gera perguntas de quiz a partir de um texto base usando IA (OpenRouter). NÃO persiste nada — apenas devolve as perguntas geradas para revisão no frontend. A chave da IA vive apenas no servidor.
+         * @description Gera perguntas a partir de um texto base via IA. Não persiste — apenas devolve.
          */
         post: {
             parameters: {
@@ -10111,23 +10102,16 @@ export interface paths {
             requestBody: {
                 content: {
                     "application/json": {
-                        /** @description Texto base para gerar as perguntas */
                         text: string;
                         numQuestions: number;
-                        /**
-                         * @default normal
-                         * @enum {string}
-                         */
                         difficulty?: "facil" | "normal" | "dificil";
-                        /** @description Textos de perguntas já existentes (para não repetir) */
                         existingQuestions?: string[];
-                        /** @description Modelo de IA a usar (OpenRouter); default do servidor quando omitido */
                         model?: string;
                     };
                 };
             };
             responses: {
-                /** @description Perguntas geradas */
+                /** @description Generated questions */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -10137,13 +10121,12 @@ export interface paths {
                             /** @example success */
                             status?: string;
                             data?: {
-                                question_text?: string;
-                                /** @enum {string} */
-                                question_type?: "multiple_choice" | "true_false";
-                                points?: number;
-                                options?: {
-                                    text?: string;
-                                    is_correct?: boolean;
+                                question_text: string;
+                                question_type: "multiple_choice" | "true_false";
+                                points: number;
+                                options: {
+                                    text: string;
+                                    is_correct: boolean;
                                 }[];
                             }[];
                         };
@@ -11845,7 +11828,7 @@ export interface paths {
             parameters: {
                 query?: {
                     /** @description Filter by step type */
-                    type?: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate" | "redirect";
+                    type?: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate";
                     /** @description Filter by active status */
                     isActive?: boolean;
                 };
@@ -11894,7 +11877,7 @@ export interface paths {
                         /** @example play-circle */
                         icon: string;
                         /** @enum {string} */
-                        type: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate" | "redirect";
+                        type: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate";
                         /** @default true */
                         isActive?: boolean;
                     };
@@ -12021,7 +12004,7 @@ export interface paths {
                         color?: string;
                         icon?: string;
                         /** @enum {string} */
-                        type?: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate" | "redirect";
+                        type?: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate";
                         isActive?: boolean;
                     };
                 };
@@ -15646,11 +15629,6 @@ export interface components {
             id?: string;
             /** @example Essential Skills */
             name?: string;
-            /**
-             * @description Hex color code for backoffice display. Null when not set.
-             * @example #44bd32
-             */
-            color?: string | null;
             /** Format: date-time */
             createdAt?: string;
             /** Format: date-time */
@@ -15922,7 +15900,7 @@ export interface components {
             /** @example play-circle */
             icon?: string;
             /** @enum {string} */
-            type?: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate" | "redirect";
+            type?: "challenge" | "course" | "tutorial" | "publication" | "evaluation" | "certificate";
             /** @example true */
             isActive?: boolean;
             /** Format: date-time */
@@ -16020,8 +15998,6 @@ export interface components {
             tutorialDescription?: string | null;
             /** @description Obrigatório quando step type=tutorial */
             tutorialVideoUrl?: string | null;
-            /** @description Obrigatório quando step type=redirect. URL para onde o aluno é redirecionado ao clicar na etapa. */
-            redirectUrl?: string | null;
             isActive?: boolean;
             /** Format: date-time */
             createdAt?: string;
@@ -16151,10 +16127,7 @@ export interface components {
              * @example Introdução a IA
              */
             courseModuleName?: string | null;
-            /**
-             * @description URL de redirecionamento desta etapa (apenas quando type=redirect)
-             * @example https://exemplo.com/atividade
-             */
+            /** @description URL de redirecionamento desta etapa (apenas quando type=redirect) */
             redirectUrl?: string | null;
         };
         /** @description Desafio da jornada com suas etapas e status computados */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "academe-kit",
-  "version": "0.12.1",
+  "version": "0.14.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",
@@ -99,4 +99,4 @@
     "tailwind-merge": "^3.3.1",
     "tailwindcss-animate": "^1.0.7"
   }
-}
+}