academe-kit 0.9.9 → 0.10.1
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 +20 -5
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +30 -6
- package/dist/index.esm.js +20 -5
- package/dist/index.esm.js.map +1 -1
- package/dist/types/services/ReportService.d.ts +24 -5
- package/dist/types/types/academe-api.d.ts +6 -1
- package/package.json +1 -1
|
@@ -573,14 +573,29 @@ export declare function createReportService(apiClient: AcademeApiClient): {
|
|
|
573
573
|
/**
|
|
574
574
|
* Get encourage dashboard for an institution
|
|
575
575
|
* Retorna o payload agregado da tela /new-dashboard:
|
|
576
|
-
* overview
|
|
577
|
-
*
|
|
576
|
+
* overview (com lista de períodos do ano letivo + flag isAllPeriods),
|
|
577
|
+
* KPIs, licenças (alunos), jornada (cursos do bimestre selecionado ou do
|
|
578
|
+
* ano letivo quando allPeriods), submissões do bimestre corrente,
|
|
579
|
+
* desempenho por turma, top alunos e top professores do bimestre.
|
|
578
580
|
*
|
|
579
|
-
* @param id
|
|
581
|
+
* @param id UUID da instituição.
|
|
582
|
+
* @param params.periodId UUID do educational_model_period. Quando omitido,
|
|
583
|
+
* o backend resolve para o período corrente (NOW).
|
|
584
|
+
* Ignorado quando allPeriods=true.
|
|
585
|
+
* @param params.allPeriods Quando true, desliga o recorte por período em
|
|
586
|
+
* Jornada/Classes/TopTeachers — passa a refletir
|
|
587
|
+
* o ano letivo inteiro. SubmissionsCard continua
|
|
588
|
+
* sempre no bimestre corrente.
|
|
580
589
|
*/
|
|
581
|
-
getEncourageDashboardByInstitution(id: string
|
|
590
|
+
getEncourageDashboardByInstitution(id: string, params?: {
|
|
591
|
+
periodId?: string;
|
|
592
|
+
allPeriods?: boolean;
|
|
593
|
+
}): Promise<import("openapi-fetch").FetchResponse<{
|
|
582
594
|
parameters: {
|
|
583
|
-
query?:
|
|
595
|
+
query?: {
|
|
596
|
+
periodId?: string;
|
|
597
|
+
allPeriods?: "true";
|
|
598
|
+
};
|
|
584
599
|
header?: never;
|
|
585
600
|
path: {
|
|
586
601
|
id: string;
|
|
@@ -624,6 +639,10 @@ export declare function createReportService(apiClient: AcademeApiClient): {
|
|
|
624
639
|
path: {
|
|
625
640
|
id: string;
|
|
626
641
|
};
|
|
642
|
+
query: {
|
|
643
|
+
periodId?: string;
|
|
644
|
+
allPeriods?: "true";
|
|
645
|
+
} | undefined;
|
|
627
646
|
};
|
|
628
647
|
}, `${string}/${string}`>>;
|
|
629
648
|
};
|
|
@@ -10644,7 +10644,12 @@ export interface paths {
|
|
|
10644
10644
|
*/
|
|
10645
10645
|
get: {
|
|
10646
10646
|
parameters: {
|
|
10647
|
-
query?:
|
|
10647
|
+
query?: {
|
|
10648
|
+
/** @description UUID do educational_model_period. Quando omitido, o backend resolve para o período corrente (NOW). Ignorado quando allPeriods=true. */
|
|
10649
|
+
periodId?: string;
|
|
10650
|
+
/** @description Quando 'true', desliga o recorte por período em Jornada/Classes/TopTeachers — passa a refletir o ano letivo inteiro. SubmissionsCard continua sempre no bimestre corrente. */
|
|
10651
|
+
allPeriods?: "true";
|
|
10652
|
+
};
|
|
10648
10653
|
header?: never;
|
|
10649
10654
|
path: {
|
|
10650
10655
|
/** @description ID da instituição */
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "academe-kit",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.10.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Official React SDK for Academe ecosystem - Authentication, protected routes, API services, and UI components for educational management applications",
|
|
6
6
|
"main": "dist/index.cjs",
|