academe-kit 0.12.0 → 0.13.0

package/dist/index.d.ts

@@ -18247,6 +18247,30 @@ type GetUsersParams = {
     page?: number;
     limit?: number;
 };
+/** Série acessível ao aluno (item do seletor de séries da jornada). */
+type AccessibleSerie = {
+    serieId: string;
+    serieValue: number;
+    serieLabel: string;
+    level: "fundamental" | "medio";
+};
+/** Turma do aluno (resumo) — para a listagem de turmas no perfil. */
+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. */
+type UserEnrollment = {
+    classrooms: ClassroomSummary[];
+    /** Escola atual resolvida pelo backend (1ª matrícula) — tem turma. */
+    currentInstitutionId: string | null;
+    series: AccessibleSerie[];
+};
 declare function createUserService(apiClient: AcademeApiClient): {
     /**
      * Get current authenticated user
@@ -18298,6 +18322,13 @@ 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
      */
@@ -27644,8 +27675,15 @@ 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
@@ -27931,6 +27969,57 @@ declare function createUserProgressService(apiClient: AcademeApiClient): {
 };
 type UserProgressService = ReturnType<typeof createUserProgressService>;
 
+/**
+ * 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.
+ */
+type VitrineCardKind = "course" | "module" | "lesson" | "playlist";
+type VitrinePlaylistSource = "curated" | "continue_watching" | "trending" | "watchlist" | "recent" | "continue_playlist";
+type VitrineCardOrientation = "horizontal" | "vertical" | "square" | "fullImage";
+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;
+}
+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[];
+}
+interface VitrineHome {
+    institutionId: string | null;
+    playlists: VitrinePlaylist[];
+}
+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>;
+};
+type VitrineService = ReturnType<typeof createVitrineService>;
+
 type AcademeApiClient = ReturnType<typeof openapi_fetch__default<paths>>;
 declare function createAcademeApiClient(baseUrl: string): AcademeApiClient;
 interface AcademeServices {
@@ -27956,6 +28045,7 @@ interface AcademeServices {
     step: StepService;
     submission: SubmissionService;
     userProgress: UserProgressService;
+    vitrine: VitrineService;
 }
 
 type AcademeKeycloakContextProps = {
@@ -28052,4 +28142,4 @@ declare enum NINA_ROLES {
 }
 
 export { AcademeAuthProvider, AcademeLoading, BACKOFFICE_ROLES, Button, CosmicDecor, CosmicStarsCanvas, DASHBOARD_ROLES, GLOBAL_ROLES, JourneyCrystalPin, JourneyStep, LogoA, MIKE_ROLES, NINA_ROLES, ProtectedApp, ProtectedComponent, ProtectedRouter, STREAMING_ROLES, Spinner, WIDGET_ROLES, academeApi_d as apiTypes, cn, createAcademeApiClient, index_d as types, useAcademeAuth, useProtectedAppColors };
-export type { AcademeApiClient, AcademeKeycloakContextProps, AcademeLoadingColors, AcademeLoadingProps, AcademeLoadingTheme, AcademeServices, AcademeUser, ButtonProps, ChallengeUserQuizAttempt, ChallengeUserQuizAttemptsResponse, CosmicDecorProps, CosmicDecorVariant, CosmicPlanet, CosmicStarsCanvasProps, FrameKind, JourneyChallengeView, JourneyCrystalPinProps, JourneyStepProps, JourneyStepSize, JourneyStepType, JourneyStepView, JourneyView, KeycloakUser, LogoAProps, RequiredClientRoles, SecurityContextType, SecurityProviderProps };
+export type { AcademeApiClient, AcademeKeycloakContextProps, AcademeLoadingColors, AcademeLoadingProps, AcademeLoadingTheme, AcademeServices, AcademeUser, AccessibleSerie, ButtonProps, ChallengeUserQuizAttempt, ChallengeUserQuizAttemptsResponse, ClassroomSummary, CosmicDecorProps, CosmicDecorVariant, CosmicPlanet, CosmicStarsCanvasProps, FrameKind, JourneyChallengeView, JourneyCrystalPinProps, JourneyStepProps, JourneyStepSize, JourneyStepType, JourneyStepView, JourneyView, KeycloakUser, LogoAProps, RequiredClientRoles, SecurityContextType, SecurityProviderProps, UserEnrollment, VitrineCard, VitrineCardKind, VitrineCardOrientation, VitrineHome, VitrinePlaylist, VitrinePlaylistSource };

package/dist/index.esm.js

@@ -4513,6 +4513,14 @@ function removeTrailingSlash(url) {
   return url;
 }
 
+const normalizeSerie = (s) => s?.serieId
+    ? {
+        serieId: s.serieId,
+        serieValue: s.serieValue ?? 0,
+        serieLabel: s.serieLabel ?? `${s.serieValue ?? ""}º ANO`,
+        level: s.level ?? "fundamental",
+    }
+    : null;
 function createUserService(apiClient) {
     return {
         /**
@@ -4521,6 +4529,31 @@ function createUserService(apiClient) {
         getMe() {
             return apiClient.GET("/users/me");
         },
+        /**
+         * 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).
+         */
+        async getMyEnrollment() {
+            const res = await apiClient.GET("/users/me/classrooms");
+            const data = res.data?.data;
+            return {
+                currentInstitutionId: data?.currentInstitutionId ?? null,
+                classrooms: (data?.classrooms ?? []).map((c) => ({
+                    institutionClassroomId: c.institutionClassroomId ?? "",
+                    classroomId: c.classroomId ?? "",
+                    classroomName: c.classroomName ?? "",
+                    shiftName: c.shiftName ?? null,
+                    serie: normalizeSerie(c.serie ?? {}),
+                    institutionId: c.institutionId ?? "",
+                    institutionName: c.institutionName ?? null,
+                })),
+                series: (data?.series ?? [])
+                    .map((s) => normalizeSerie(s))
+                    .filter((s) => s !== null),
+            };
+        },
         /**
          * List all users with optional filters
          */
@@ -6402,15 +6435,26 @@ function createUserProgressService(apiClient) {
          * `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)`.
          */
-        async getJourney(serieId, userId) {
+        async getJourney(serieId, userId, institutionId) {
             const query = {};
             if (serieId)
                 query.serieId = serieId;
             if (userId)
                 query.userId = userId;
+            if (institutionId)
+                query.institutionId = institutionId;
             const res = await apiClient.GET("/user-challenge-progress/journey", {
-                params: { query: Object.keys(query).length > 0 ? query : undefined },
+                params: {
+                    query: (Object.keys(query).length > 0 ? query : undefined),
+                },
             });
             return res.data.data;
         },
@@ -6487,6 +6531,23 @@ function createUserProgressService(apiClient) {
     };
 }
 
+function createVitrineService(apiClient) {
+    return {
+        /**
+         * Home do aluno para a escola atual. `institutionId` omitido = 1ª matrícula
+         * (o backend resolve). Recarregar ao trocar de escola no app.
+         */
+        async getHome(institutionId) {
+            const res = await apiClient.GET("/vitrine/home", {
+                params: {
+                    query: institutionId ? { institutionId } : undefined,
+                },
+            });
+            return (res.data?.data ?? { institutionId: null, playlists: [] });
+        },
+    };
+}
+
 function createAcademeApiClient(baseUrl) {
     return createClient({ baseUrl });
 }
@@ -6514,6 +6575,7 @@ function createAcademeServices(apiClient) {
         step: createStepService(apiClient),
         submission: createSubmissionService(apiClient),
         userProgress: createUserProgressService(apiClient),
+        vitrine: createVitrineService(apiClient),
     };
 }