@eeplatform/basic-edu 1.4.2 → 1.5.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @eeplatform/basic-edu
 
+## 1.5.0
+
+### Minor Changes
+
+- 1dab40b: Section generation initial release
+
+## 1.4.3
+
+### Patch Changes
+
+- e813099: Add createdBy filter to enrollment getAll()
+
 ## 1.4.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -203,7 +203,7 @@ declare function MLearner(value: TLearner): {
 declare function useEnrollmentRepo(): {
     createIndexes: () => Promise<void>;
     add: (value: TLearner, session?: ClientSession) => Promise<ObjectId>;
-    getAll: ({ search, page, limit, sort, status, school, schoolYear, gradeLevelToEnroll, }?: {
+    getAll: ({ search, page, limit, sort, status, school, schoolYear, gradeLevelToEnroll, createdBy, }?: {
         search?: string | undefined;
         page?: number | undefined;
         limit?: number | undefined;
@@ -212,6 +212,7 @@ declare function useEnrollmentRepo(): {
         school?: string | undefined;
         schoolYear?: string | undefined;
         gradeLevelToEnroll?: string | undefined;
+        createdBy?: string | undefined;
     }) => Promise<Record<string, any> | {
         items: any[];
         pages: number;
@@ -257,6 +258,7 @@ type TGradeLevel = {
     trackStrands?: string[];
     teachingStyle: string;
     maxNumberOfLearners: number;
+    minNumberOfLearners: number;
     defaultStartTime?: string;
     defaultEndTime?: string;
     status?: string;
@@ -277,6 +279,7 @@ declare function MGradeLevel(value: TGradeLevel): {
     trackStrands: string[];
     teachingStyle: string;
     maxNumberOfLearners: number;
+    minNumberOfLearners: number;
     defaultStartTime: string;
     defaultEndTime: string;
     status: string;
@@ -319,6 +322,11 @@ declare function useGradeLevelRepo(): {
     }, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
     deleteById: (_id: string | ObjectId, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
     getByEducationLevel: (educationLevel: string, school?: string) => Promise<TGradeLevel[] | mongodb.WithId<bson.Document>[]>;
+    getByGradeLevel: (value: {
+        school: string | ObjectId;
+        gradeLevel: string;
+        status?: string;
+    }, session?: ClientSession) => Promise<mongodb.WithId<bson.Document> | TGradeLevel | null>;
 };
 
 declare function useGradeLevelController(): {
@@ -707,7 +715,7 @@ declare function usePlantillaController(): {
 declare function useLearnerRepo(): {
     createIndexes: () => Promise<void>;
     add: (value: TLearner, session?: ClientSession) => Promise<ObjectId>;
-    getAll: ({ search, page, limit, sort, status, school, schoolYear, gradeLevelToEnroll, }?: {
+    getAll: ({ search, page, limit, sort, status, school, schoolYear, level, }?: {
         search?: string | undefined;
         page?: number | undefined;
         limit?: number | undefined;
@@ -715,14 +723,27 @@ declare function useLearnerRepo(): {
         status?: string | undefined;
         school?: string | undefined;
         schoolYear?: string | undefined;
-        gradeLevelToEnroll?: string | undefined;
+        level?: string | undefined;
     }) => Promise<Record<string, any> | {
         items: any[];
         pages: number;
         pageRange: string;
     }>;
+    getCountByGradeLevel: (value: {
+        school: string | ObjectId;
+        schoolYear: string;
+        gradeLevel: string;
+        status?: string;
+    }, session?: ClientSession) => Promise<number>;
     updateStatusById: (_id: string | ObjectId, status: string, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
     getById: (_id: string | ObjectId, status?: string) => Promise<TLearner | null>;
+    getByGradeLevel: (value: {
+        school: string | ObjectId;
+        gradeLevel: string;
+        status?: string;
+        limit?: number;
+        skip?: number;
+    }, session?: ClientSession) => Promise<TLearner[]>;
 };
 
 declare function useLearnerController(): {
@@ -753,4 +774,115 @@ declare function useBasicEduCountRepo(): {
     resetById: (_id: string | ObjectId, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
 };
 
-export { MAsset, MCurriculum, MGradeLevel, MLearner, MPlantilla, MStockCard, TAddress, TAddressInformation, TAsset, TBasicEduCount, TCurriculum, TCurriculumSubject, TDivision, TGradeLevel, TLearner, TLearnerInfo, TLearningModality, TParentGuardianInfo, TPersonContact, TPlantilla, TRegion, TReturningLearnerInfo, TSchool, TSeniorHighInformation, TStockCard, modelBasicEduCount, modelDivision, modelRegion, modelSchool, schemaAsset, schemaAssetUpdateOption, schemaBasicEduCount, schemaCurriculum, schemaDivision, schemaDivisionUpdate, schemaEnrollment, schemaGradeLevel, schemaPlantilla, schemaRegion, schemaSchool, schemaSchoolUpdate, schemaStockCard, schemaUpdateStatus, useAssetController, useAssetRepo, useBasicEduCountRepo, useCurriculumController, useCurriculumRepo, useDivisionController, useDivisionRepo, useDivisionService, useEnrollmentController, useEnrollmentRepo, useEnrollmentService, useGradeLevelController, useGradeLevelRepo, useLearnerController, useLearnerRepo, usePlantillaController, usePlantillaRepo, usePlantillaService, useRegionController, useRegionRepo, useSchoolController, useSchoolRepo, useSchoolService, useStockCardController, useStockCardRepository, useStockCardService };
+type TSectionPreset = {
+    _id?: ObjectId;
+    name: string;
+    description?: string;
+    set: Array<string>;
+    status: string;
+    school: ObjectId | string;
+    createdBy: ObjectId | string;
+    createdAt?: string;
+    updatedAt?: string;
+    deletedAt?: string;
+};
+declare const schemaSectionPreset: Joi.ObjectSchema<any>;
+declare function modelSectionPreset(value: TSectionPreset): TSectionPreset;
+
+declare function useSectionPresetRepo(): {
+    createIndexes: () => Promise<void>;
+    add: (value: TSectionPreset, session?: ClientSession) => Promise<ObjectId>;
+    getAll: ({ search, page, limit, sort, status, createdBy, school, }?: {
+        search?: string;
+        page?: number;
+        limit?: number;
+        sort?: Record<string, any>;
+        status?: string;
+        createdBy?: string | ObjectId;
+        school?: string;
+    }) => Promise<Record<string, any> | {
+        items: any[];
+        pages: number;
+        pageRange: string;
+    }>;
+    getById: (_id: string | ObjectId) => Promise<TSectionPreset>;
+    updateFieldById: ({ _id, field, value }?: {
+        _id: string | ObjectId;
+        field: string;
+        value: string | Array<string>;
+    }, session?: ClientSession) => Promise<string>;
+    deleteById: (_id: string | ObjectId) => Promise<string>;
+    getByName: (name: string) => Promise<TSectionPreset>;
+};
+
+declare function useSectionPresetController(): {
+    add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getByName: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    updateField: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    deleteById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
+type TSection = {
+    _id?: ObjectId;
+    school: ObjectId | string;
+    name: string;
+    schoolYear: string;
+    gradeLevel: string;
+    adviser?: ObjectId | string;
+    adviserName?: string;
+    students: number;
+    status?: string;
+    createdAt?: string | Date;
+    updatedAt?: string | Date;
+    deletedAt?: string | Date;
+};
+declare const schemaSection: Joi.ObjectSchema<any>;
+declare const schemaGenerateSections: Joi.ObjectSchema<any>;
+declare function modelSection(value: TSection): TSection;
+
+declare function useSectionRepo(): {
+    createIndexes: () => Promise<void>;
+    add: (value: TSection, session?: ClientSession) => Promise<ObjectId>;
+    getAll: ({ search, page, limit, sort, status, school, schoolYear, gradeLevel, }?: {
+        search?: string | undefined;
+        page?: number | undefined;
+        limit?: number | undefined;
+        sort?: {} | undefined;
+        status?: string | undefined;
+        school?: string | undefined;
+        schoolYear?: string | undefined;
+        gradeLevel?: string | undefined;
+    }) => Promise<Record<string, any> | {
+        items: any[];
+        pages: number;
+        pageRange: string;
+    }>;
+    getById: (_id: string | ObjectId) => Promise<TSection>;
+    getByName: (name: string) => Promise<TSection>;
+    getBySchool: (school: string | ObjectId) => Promise<TSection[]>;
+    updateFieldById: ({ _id, field, value }?: {
+        _id: string | ObjectId;
+        field: string;
+        value: string;
+    }, session?: ClientSession) => Promise<string>;
+    addStudentToSection: (_id: string | ObjectId, studentId: string, session?: ClientSession) => Promise<string>;
+    removeStudentFromSection: (_id: string | ObjectId, studentId: string, session?: ClientSession) => Promise<string>;
+    deleteById: (_id: string | ObjectId) => Promise<string>;
+};
+
+declare function useSectionController(): {
+    add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    generateSections: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getByName: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getBySchool: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    updateField: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    addStudent: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    removeStudent: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    deleteById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
+export { MAsset, MCurriculum, MGradeLevel, MLearner, MPlantilla, MStockCard, TAddress, TAddressInformation, TAsset, TBasicEduCount, TCurriculum, TCurriculumSubject, TDivision, TGradeLevel, TLearner, TLearnerInfo, TLearningModality, TParentGuardianInfo, TPersonContact, TPlantilla, TRegion, TReturningLearnerInfo, TSchool, TSection, TSectionPreset, TSeniorHighInformation, TStockCard, modelBasicEduCount, modelDivision, modelRegion, modelSchool, modelSection, modelSectionPreset, schemaAsset, schemaAssetUpdateOption, schemaBasicEduCount, schemaCurriculum, schemaDivision, schemaDivisionUpdate, schemaEnrollment, schemaGenerateSections, schemaGradeLevel, schemaPlantilla, schemaRegion, schemaSchool, schemaSchoolUpdate, schemaSection, schemaSectionPreset, schemaStockCard, schemaUpdateStatus, useAssetController, useAssetRepo, useBasicEduCountRepo, useCurriculumController, useCurriculumRepo, useDivisionController, useDivisionRepo, useDivisionService, useEnrollmentController, useEnrollmentRepo, useEnrollmentService, useGradeLevelController, useGradeLevelRepo, useLearnerController, useLearnerRepo, usePlantillaController, usePlantillaRepo, usePlantillaService, useRegionController, useRegionRepo, useSchoolController, useSchoolRepo, useSchoolService, useSectionController, useSectionPresetController, useSectionPresetRepo, useSectionRepo, useStockCardController, useStockCardRepository, useStockCardService };