academe-kit 0.2.6 → 0.2.7

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.
Files changed (4) hide show
  1. package/dist/index.d.ts +31 -23
  2. package/dist/types/services/InstitutionService.d.ts +1 -3
  3. package/dist/types/types/academe-api.d.ts +30 -20
  4. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -1695,6 +1695,12 @@ interface paths {
1695
1695
  * @default false
1696
1696
  */
1697
1697
  isDefault?: boolean;
1698
+ /**
1699
+ * @description Type of the group
1700
+ * @default other
1701
+ * @enum {string}
1702
+ */
1703
+ type?: "student" | "teacher" | "school-director" | "other";
1698
1704
  };
1699
1705
  };
1700
1706
  };
@@ -1837,6 +1843,11 @@ interface paths {
1837
1843
  name?: string;
1838
1844
  /** @description If true, group is automatically associated when creating institutions */
1839
1845
  isDefault?: boolean;
1846
+ /**
1847
+ * @description Type of the group
1848
+ * @enum {string}
1849
+ */
1850
+ type?: "student" | "teacher" | "school-director" | "other";
1840
1851
  };
1841
1852
  };
1842
1853
  };
@@ -3628,10 +3639,10 @@ interface paths {
3628
3639
  query?: {
3629
3640
  /** @description Filter by classroom (institution_classroom_id) */
3630
3641
  classroomId?: string;
3631
- /** @description Filter by student status (true = students only, false = non-students only) */
3632
- isStudent?: boolean;
3633
3642
  /** @description Filter by user active status */
3634
3643
  isActive?: boolean;
3644
+ /** @description Filter users by group type (e.g., student, teacher, school-director, other) */
3645
+ type?: "student" | "teacher" | "school-director" | "other";
3635
3646
  /** @description Filter users with certificates (true) or without (false) */
3636
3647
  hasCertificates?: boolean;
3637
3648
  /** @description Filter users with guardian (true) or without (false) */
@@ -5574,7 +5585,6 @@ interface paths {
5574
5585
  * - Classroom name
5575
5586
  * - Shift (manhã, tarde, noite)
5576
5587
  * - Serie (grade level)
5577
- * - Student status (isStudent)
5578
5588
  */
5579
5589
  get: {
5580
5590
  parameters: {
@@ -6000,6 +6010,12 @@ interface components {
6000
6010
  * @example false
6001
6011
  */
6002
6012
  isDefault?: boolean;
6013
+ /**
6014
+ * @description Type of the group
6015
+ * @example student
6016
+ * @enum {string}
6017
+ */
6018
+ type?: "student" | "teacher" | "school-director" | "other";
6003
6019
  /** Format: date-time */
6004
6020
  createdAt?: string;
6005
6021
  /** Format: date-time */
@@ -6013,12 +6029,23 @@ interface components {
6013
6029
  * @default false
6014
6030
  */
6015
6031
  isDefault: boolean;
6032
+ /**
6033
+ * @description Type of the group
6034
+ * @default other
6035
+ * @enum {string}
6036
+ */
6037
+ type: "student" | "teacher" | "school-director" | "other";
6016
6038
  };
6017
6039
  UpdateGroupDto: {
6018
6040
  /** @example students */
6019
6041
  name?: string;
6020
6042
  /** @description If true, group is automatically associated when creating institutions */
6021
6043
  isDefault?: boolean;
6044
+ /**
6045
+ * @description Type of the group
6046
+ * @enum {string}
6047
+ */
6048
+ type?: "student" | "teacher" | "school-director" | "other";
6022
6049
  };
6023
6050
  AssignUserToGroupDto: {
6024
6051
  /** Format: uuid */
@@ -6118,11 +6145,6 @@ interface components {
6118
6145
  institutionRegistration?: {
6119
6146
  /** Format: uuid */
6120
6147
  id?: string;
6121
- /**
6122
- * @description Indicates if the user is registered as a student
6123
- * @example true
6124
- */
6125
- isStudent?: boolean;
6126
6148
  /**
6127
6149
  * @description Indicates if the registration is active
6128
6150
  * @example true
@@ -6179,11 +6201,6 @@ interface components {
6179
6201
  * @description ID of the institution classroom assignment
6180
6202
  */
6181
6203
  institutionClassroomId?: string | null;
6182
- /**
6183
- * @description Indicates if the user is registered as a student
6184
- * @example true
6185
- */
6186
- isStudent?: boolean;
6187
6204
  /**
6188
6205
  * @description Indicates if the user is active in the institution
6189
6206
  * @example true
@@ -6624,11 +6641,6 @@ interface components {
6624
6641
  * @description Optional classroom ID to assign the user to
6625
6642
  */
6626
6643
  institutionClassroomId?: string | null;
6627
- /**
6628
- * @description Whether the user is a student
6629
- * @default true
6630
- */
6631
- isStudent: boolean;
6632
6644
  /**
6633
6645
  * @description Whether the registration is active
6634
6646
  * @default true
@@ -6641,8 +6653,6 @@ interface components {
6641
6653
  * @description Classroom ID to assign the user to (null to remove)
6642
6654
  */
6643
6655
  institutionClassroomId?: string | null;
6644
- /** @description Whether the user is a student */
6645
- isStudent?: boolean;
6646
6656
  /** @description Whether the registration is active */
6647
6657
  isActive?: boolean;
6648
6658
  };
@@ -8022,8 +8032,8 @@ declare function createInstitutionService(apiClient: AcademeApiClient): {
8022
8032
  parameters: {
8023
8033
  query?: {
8024
8034
  classroomId?: string;
8025
- isStudent?: boolean;
8026
8035
  isActive?: boolean;
8036
+ type?: "student" | "teacher" | "school-director" | "other";
8027
8037
  hasCertificates?: boolean;
8028
8038
  hasGuardian?: boolean;
8029
8039
  search?: string;
@@ -8212,7 +8222,6 @@ declare function createInstitutionService(apiClient: AcademeApiClient): {
8212
8222
  body: {
8213
8223
  userId: string;
8214
8224
  institutionClassroomId?: string | null;
8215
- isStudent: boolean;
8216
8225
  isActive: boolean;
8217
8226
  };
8218
8227
  }, `${string}/${string}`>>;
@@ -8257,7 +8266,6 @@ declare function createInstitutionService(apiClient: AcademeApiClient): {
8257
8266
  };
8258
8267
  body: {
8259
8268
  institutionClassroomId?: string | null;
8260
- isStudent?: boolean;
8261
8269
  isActive?: boolean;
8262
8270
  };
8263
8271
  }, `${string}/${string}`>>;
package/dist/types/services/InstitutionService.d.ts CHANGED
@@ -474,8 +474,8 @@ export declare function createInstitutionService(apiClient: AcademeApiClient): {
474
474
  parameters: {
475
475
  query?: {
476
476
  classroomId?: string;
477
- isStudent?: boolean;
478
477
  isActive?: boolean;
478
+ type?: "student" | "teacher" | "school-director" | "other";
479
479
  hasCertificates?: boolean;
480
480
  hasGuardian?: boolean;
481
481
  search?: string;
@@ -664,7 +664,6 @@ export declare function createInstitutionService(apiClient: AcademeApiClient): {
664
664
  body: {
665
665
  userId: string;
666
666
  institutionClassroomId?: string | null;
667
- isStudent: boolean;
668
667
  isActive: boolean;
669
668
  };
670
669
  }, `${string}/${string}`>>;
@@ -709,7 +708,6 @@ export declare function createInstitutionService(apiClient: AcademeApiClient): {
709
708
  };
710
709
  body: {
711
710
  institutionClassroomId?: string | null;
712
- isStudent?: boolean;
713
711
  isActive?: boolean;
714
712
  };
715
713
  }, `${string}/${string}`>>;
package/dist/types/types/academe-api.d.ts CHANGED
@@ -1658,6 +1658,12 @@ export interface paths {
1658
1658
  * @default false
1659
1659
  */
1660
1660
  isDefault?: boolean;
1661
+ /**
1662
+ * @description Type of the group
1663
+ * @default other
1664
+ * @enum {string}
1665
+ */
1666
+ type?: "student" | "teacher" | "school-director" | "other";
1661
1667
  };
1662
1668
  };
1663
1669
  };
@@ -1800,6 +1806,11 @@ export interface paths {
1800
1806
  name?: string;
1801
1807
  /** @description If true, group is automatically associated when creating institutions */
1802
1808
  isDefault?: boolean;
1809
+ /**
1810
+ * @description Type of the group
1811
+ * @enum {string}
1812
+ */
1813
+ type?: "student" | "teacher" | "school-director" | "other";
1803
1814
  };
1804
1815
  };
1805
1816
  };
@@ -3591,10 +3602,10 @@ export interface paths {
3591
3602
  query?: {
3592
3603
  /** @description Filter by classroom (institution_classroom_id) */
3593
3604
  classroomId?: string;
3594
- /** @description Filter by student status (true = students only, false = non-students only) */
3595
- isStudent?: boolean;
3596
3605
  /** @description Filter by user active status */
3597
3606
  isActive?: boolean;
3607
+ /** @description Filter users by group type (e.g., student, teacher, school-director, other) */
3608
+ type?: "student" | "teacher" | "school-director" | "other";
3598
3609
  /** @description Filter users with certificates (true) or without (false) */
3599
3610
  hasCertificates?: boolean;
3600
3611
  /** @description Filter users with guardian (true) or without (false) */
@@ -5537,7 +5548,6 @@ export interface paths {
5537
5548
  * - Classroom name
5538
5549
  * - Shift (manhã, tarde, noite)
5539
5550
  * - Serie (grade level)
5540
- * - Student status (isStudent)
5541
5551
  */
5542
5552
  get: {
5543
5553
  parameters: {
@@ -5963,6 +5973,12 @@ export interface components {
5963
5973
  * @example false
5964
5974
  */
5965
5975
  isDefault?: boolean;
5976
+ /**
5977
+ * @description Type of the group
5978
+ * @example student
5979
+ * @enum {string}
5980
+ */
5981
+ type?: "student" | "teacher" | "school-director" | "other";
5966
5982
  /** Format: date-time */
5967
5983
  createdAt?: string;
5968
5984
  /** Format: date-time */
@@ -5976,12 +5992,23 @@ export interface components {
5976
5992
  * @default false
5977
5993
  */
5978
5994
  isDefault: boolean;
5995
+ /**
5996
+ * @description Type of the group
5997
+ * @default other
5998
+ * @enum {string}
5999
+ */
6000
+ type: "student" | "teacher" | "school-director" | "other";
5979
6001
  };
5980
6002
  UpdateGroupDto: {
5981
6003
  /** @example students */
5982
6004
  name?: string;
5983
6005
  /** @description If true, group is automatically associated when creating institutions */
5984
6006
  isDefault?: boolean;
6007
+ /**
6008
+ * @description Type of the group
6009
+ * @enum {string}
6010
+ */
6011
+ type?: "student" | "teacher" | "school-director" | "other";
5985
6012
  };
5986
6013
  AssignUserToGroupDto: {
5987
6014
  /** Format: uuid */
@@ -6081,11 +6108,6 @@ export interface components {
6081
6108
  institutionRegistration?: {
6082
6109
  /** Format: uuid */
6083
6110
  id?: string;
6084
- /**
6085
- * @description Indicates if the user is registered as a student
6086
- * @example true
6087
- */
6088
- isStudent?: boolean;
6089
6111
  /**
6090
6112
  * @description Indicates if the registration is active
6091
6113
  * @example true
@@ -6142,11 +6164,6 @@ export interface components {
6142
6164
  * @description ID of the institution classroom assignment
6143
6165
  */
6144
6166
  institutionClassroomId?: string | null;
6145
- /**
6146
- * @description Indicates if the user is registered as a student
6147
- * @example true
6148
- */
6149
- isStudent?: boolean;
6150
6167
  /**
6151
6168
  * @description Indicates if the user is active in the institution
6152
6169
  * @example true
@@ -6587,11 +6604,6 @@ export interface components {
6587
6604
  * @description Optional classroom ID to assign the user to
6588
6605
  */
6589
6606
  institutionClassroomId?: string | null;
6590
- /**
6591
- * @description Whether the user is a student
6592
- * @default true
6593
- */
6594
- isStudent: boolean;
6595
6607
  /**
6596
6608
  * @description Whether the registration is active
6597
6609
  * @default true
@@ -6604,8 +6616,6 @@ export interface components {
6604
6616
  * @description Classroom ID to assign the user to (null to remove)
6605
6617
  */
6606
6618
  institutionClassroomId?: string | null;
6607
- /** @description Whether the user is a student */
6608
- isStudent?: boolean;
6609
6619
  /** @description Whether the registration is active */
6610
6620
  isActive?: boolean;
6611
6621
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "academe-kit",
3
- "version": "0.2.6",
3
+ "version": "0.2.7",
4
4
  "type": "module",
5
5
  "description": "A React component library with Tailwind CSS and Storybook",
6
6
  "main": "dist/index.js",