@eeplatform/basic-edu 1.6.0 → 1.8.0

package/dist/index.d.ts

@@ -78,13 +78,17 @@ declare function useCurriculumController(): {
     removeFromPilotWhitelist: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
-type TCurriculumSubject = {
+type TSubject = {
     _id?: ObjectId;
+    school?: ObjectId;
+    schoolName?: string;
     curriculum: ObjectId | string;
     curriculumName: string;
     effectiveSchoolYear?: number[];
     educationLevel: string;
     gradeLevel: string;
+    program?: string | ObjectId;
+    programName?: string;
     subjectCode: string;
     subjectName: string;
     subjectType: string;
@@ -99,15 +103,19 @@ type TCurriculumSubject = {
     updatedBy?: string;
     deletedBy?: string;
 };
-declare const schemaCurriculumSubject: Joi.ObjectSchema<any>;
-declare const schemaCurriculumSubjectAdd: Joi.ObjectSchema<any>;
-declare function MCurriculumSubject(value: TCurriculumSubject): {
+declare const schemaSubject: Joi.ObjectSchema<any>;
+declare const schemaSubjectAdd: Joi.ObjectSchema<any>;
+declare function modelSubject(value: TSubject): {
     _id: ObjectId | undefined;
+    school: ObjectId | undefined;
+    schoolName: string;
     curriculum: ObjectId;
     curriculumName: string;
     effectiveSchoolYear: number[];
     educationLevel: string;
     gradeLevel: string;
+    program: string | ObjectId | undefined;
+    programName: string;
     subjectCode: string;
     subjectName: string;
     subjectType: string;
@@ -123,9 +131,9 @@ declare function MCurriculumSubject(value: TCurriculumSubject): {
     deletedBy: string;
 };
 
-declare function useCurriculumSubjectRepo(): {
+declare function useSubjectRepo(): {
     createIndexes: () => Promise<void>;
-    add: (value: TCurriculumSubject, session?: ClientSession) => Promise<ObjectId>;
+    add: (value: TSubject, session?: ClientSession) => Promise<ObjectId>;
     getAll: ({ search, page, limit, sort, status, curriculum, educationLevel, gradeLevel, schoolYear, }?: {
         search?: string;
         page?: number;
@@ -141,14 +149,15 @@ declare function useCurriculumSubjectRepo(): {
         pages: number;
         pageRange: string;
     }>;
-    getById: (_id: string | ObjectId) => Promise<bson.Document | TCurriculumSubject>;
-    getByCurriculum: (curriculumId: string | ObjectId) => Promise<TCurriculumSubject[] | mongodb.WithId<bson.Document>[]>;
-    updateById: (_id: ObjectId | string, value: Partial<TCurriculumSubject>, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    getById: (_id: string | ObjectId) => Promise<bson.Document | TSubject>;
+    getByCurriculum: (curriculumId: string | ObjectId) => Promise<TSubject[] | mongodb.WithId<bson.Document>[]>;
+    updateById: (_id: ObjectId | string, value: Partial<TSubject>, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
     deleteById: (_id: string | ObjectId, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
     deleteByCurriculum: (curriculumId: string | ObjectId, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    getAsOptions: () => Promise<{}>;
 };
 
-declare function useCurriculumSubjectController(): {
+declare function useSubjectController(): {
     add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     addMany: (value: {
         curriculum: string;
@@ -169,9 +178,10 @@ declare function useCurriculumSubjectController(): {
     updateById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     deleteById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     deleteByCurriculum: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAsOptions: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
-declare function useCurriculumSubjectService(): {
+declare function useSubjectService(): {
     addMany: (value: {
         curriculum: string;
         curriculumName: string;
@@ -996,9 +1006,15 @@ declare function useSectionController(): {
 
 type TSectionStudent = {
     _id?: ObjectId;
+    lrn: string;
+    school: ObjectId | string;
+    schoolName?: string;
     section: ObjectId | string;
     student: string;
     studentName: string;
+    gradeLevel?: string;
+    educationLevel?: string;
+    schoolYear?: string;
     status?: string;
     assignedAt?: Date | string;
     updatedAt?: Date | string;
@@ -1010,13 +1026,29 @@ declare function modelSectionStudent(value: TSectionStudent): TSectionStudent;
 declare function useSectionStudentRepo(): {
     createIndexes: () => Promise<void>;
     delCachedData: () => void;
-    add: (value: TSectionStudent, session?: ClientSession) => Promise<bson.ObjectId>;
+    add: (value: TSectionStudent, session?: ClientSession) => Promise<ObjectId>;
+    getAll: ({ page, limit, search, school, status, gradeLevel, section, schoolYear, }?: {
+        page?: number;
+        limit?: number;
+        search?: string;
+        school?: string | ObjectId;
+        status?: string;
+        gradeLevel?: string;
+        section?: string | ObjectId;
+        schoolYear?: string;
+    }) => Promise<{}>;
+};
+
+declare function useSectionStudentController(): {
+    add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
 type TSectionSubject = {
     _id?: ObjectId;
     school: ObjectId | string;
     schoolName?: string;
+    curriculum: ObjectId | string;
     section: ObjectId | string;
     sectionName: string;
     gradeLevel: string;
@@ -1026,7 +1058,7 @@ type TSectionSubject = {
     subjectName: string;
     teacher?: ObjectId | string;
     teacherName?: string;
-    classroom?: string;
+    classroom?: string | ObjectId;
     classroomName?: string;
     daysOfWeek: string[];
     schedule?: string;
@@ -1070,7 +1102,7 @@ declare function useSectionSubjectRepo(): {
         field: string;
         value: string;
     }, session?: ClientSession) => Promise<string>;
-    setupById: (_id: string | ObjectId, value: Pick<TSectionSubject, "teacher" | "teacherName" | "schedule" | "daysOfWeek">, session?: ClientSession) => Promise<string>;
+    setupById: (_id: string | ObjectId, value: Pick<TSectionSubject, "teacher" | "teacherName" | "schedule" | "daysOfWeek" | "classroom" | "classroomName">, session?: ClientSession) => Promise<string>;
     deleteById: (_id: string | ObjectId) => Promise<string>;
 };
 
@@ -1198,13 +1230,14 @@ declare function useBuildingController(): {
 declare function useBuildingUnitRepo(): {
     createIndexes: () => Promise<void>;
     add: (value: TBuildingUnit, session?: ClientSession) => Promise<ObjectId>;
-    getAll: ({ search, page, limit, sort, school, building, status, }?: {
+    getAll: ({ search, page, limit, sort, school, building, type, status, }?: {
         search?: string | undefined;
         page?: number | undefined;
         limit?: number | undefined;
         sort?: {} | undefined;
         school?: string | undefined;
         building?: string | undefined;
+        type?: string | undefined;
         status?: string | undefined;
     }) => Promise<Record<string, any> | {
         items: any[];
@@ -1226,6 +1259,7 @@ declare function useBuildingUnitRepo(): {
     getByBuilding: (building: string | ObjectId) => Promise<TBuildingUnit | null>;
     deleteById: (_id: string | ObjectId, session?: ClientSession) => Promise<string>;
     updateByBuildingId: (building: string | ObjectId, value: Partial<Pick<TBuildingUnit, "buildingName">>, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    countByBuilding: (building: string | ObjectId, level?: number) => Promise<number>;
 };
 
 declare function useBuildingUnitService(): {
@@ -1233,6 +1267,7 @@ declare function useBuildingUnitService(): {
         building: TBuildingUnit;
         qty: number;
     }) => Promise<string>;
+    deleteById: (id: string) => Promise<string>;
 };
 
 declare function useBuildingUnitController(): {
@@ -1253,6 +1288,8 @@ type TPersonnel = {
     suffix?: string;
     title?: string;
     classification: string;
+    specializations?: string[];
+    gradeLevels?: string[];
     status?: string;
     createdAt?: string | Date;
     updatedAt?: string | Date;
@@ -1269,6 +1306,8 @@ declare function MPersonnel(value: TPersonnel): {
     suffix: string;
     title: string;
     classification: string;
+    specializations: string[];
+    gradeLevels: string[];
     status: string;
     createdAt: string | Date;
     updatedAt: string | Date;
@@ -1282,6 +1321,8 @@ declare function usePersonnelRepo(): {
         firstName?: string;
         lastName?: string;
         middleName?: string;
+        gradeLevels?: string[];
+        specializations?: string[];
         classification?: string;
         status?: string;
     }, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
@@ -1313,4 +1354,209 @@ declare function usePersonnelController(): {
     getByClassification: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
-export { MAsset, MBuilding, MBuildingUnit, MCurriculum, MCurriculumSubject, MGradeLevel, MLearner, MPersonnel, MPlantilla, MStockCard, TAddress, TAddressInformation, TAsset, TBasicEduCount, TBuilding, TBuildingUnit, TCurriculum, TCurriculumSubject, TDivision, TGradeLevel, TLearner, TLearnerInfo, TLearningModality, TParentGuardianInfo, TPersonContact, TPersonnel, TPlantilla, TRegion, TReturningLearnerInfo, TSchool, TSection, TSectionPreset, TSectionStudent, TSectionSubject, TSeniorHighInformation, TStockCard, allowedSectionStudentStatuses, modelBasicEduCount, modelDivision, modelRegion, modelSchool, modelSection, modelSectionPreset, modelSectionStudent, modelSectionSubject, schemaAsset, schemaAssetUpdateOption, schemaBasicEduCount, schemaBuilding, schemaBuildingUnit, schemaCurriculum, schemaCurriculumSubject, schemaCurriculumSubjectAdd, schemaDivision, schemaDivisionUpdate, schemaEnrollment, schemaGenerateSections, schemaGradeLevel, schemaPersonnel, schemaPlantilla, schemaRegion, schemaSchool, schemaSchoolUpdate, schemaSection, schemaSectionPreset, schemaSectionStudent, schemaSectionSubject, schemaSectionSubjectSetup, schemaStockCard, schemaUpdateOptions, schemaUpdateStatus, useAssetController, useAssetRepo, useBasicEduCountRepo, useBuildingController, useBuildingRepo, useBuildingService, useBuildingUnitController, useBuildingUnitRepo, useBuildingUnitService, useCurriculumController, useCurriculumRepo, useCurriculumSubjectController, useCurriculumSubjectRepo, useCurriculumSubjectService, useDivisionController, useDivisionRepo, useDivisionService, useEnrollmentController, useEnrollmentRepo, useEnrollmentService, useGradeLevelController, useGradeLevelRepo, useLearnerController, useLearnerRepo, usePersonnelController, usePersonnelRepo, usePlantillaController, usePlantillaRepo, usePlantillaService, useRegionController, useRegionRepo, useSchoolController, useSchoolRepo, useSchoolService, useSectionController, useSectionPresetController, useSectionPresetRepo, useSectionRepo, useSectionStudentRepo, useSectionSubjectController, useSectionSubjectRepo, useSectionSubjectService, useStockCardController, useStockCardRepository, useStockCardService };
+type TTeachingLoad = {
+    _id?: ObjectId;
+    school: string | ObjectId;
+    schoolName?: string;
+    schoolYear: string;
+    teacher: string | ObjectId;
+    teacherName?: string;
+    status: string;
+    createdAt?: string | Date;
+    updatedAt?: string | Date;
+    deletedAt?: string | Date;
+};
+declare const schemaTeachingLoad: Joi.ObjectSchema<any>;
+declare function modelTeachingLoad(value: TTeachingLoad): {
+    _id: ObjectId | undefined;
+    school: string | ObjectId;
+    schoolName: string;
+    schoolYear: string;
+    teacher: string | ObjectId;
+    teacherName: string;
+    status: string;
+    createdAt: string | Date;
+    updatedAt: string | Date;
+    deletedAt: string | Date;
+};
+
+declare function useTeachingLoadRepo(): {
+    createIndexes: () => Promise<void>;
+    add: (value: TTeachingLoad, session?: ClientSession) => Promise<string>;
+    updateById: (_id: ObjectId | string, value: {
+        schoolYear?: string;
+        teacher?: string | ObjectId;
+        teacherName?: string;
+        status?: string;
+    }, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    getAll: ({ school, teacher, schoolYear, page, limit, sort, status, }?: {
+        school?: string | undefined;
+        teacher?: string | undefined;
+        schoolYear?: string | undefined;
+        page?: number | undefined;
+        limit?: number | undefined;
+        sort?: {} | undefined;
+        status?: string | undefined;
+    }) => Promise<Record<string, any> | {
+        items: any[];
+        pages: number;
+        pageRange: string;
+    }>;
+    getById: (_id: string | ObjectId) => Promise<TTeachingLoad | null>;
+    deleteById: (_id: string | ObjectId, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    getByTeacher: (teacher: string | ObjectId, schoolYear?: string) => Promise<TTeachingLoad[]>;
+    delCachedData: () => void;
+};
+
+declare function useTeachingLoadController(): {
+    add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    updateById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getBySchool: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    deleteById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getByTeacher: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
+type TTeachingLoadSlot = {
+    _id?: ObjectId;
+    teachingLoad: string | ObjectId;
+    day: string;
+    startTime: string;
+    endTime: string;
+    gradeLevel: string;
+    subject: string | ObjectId;
+    subjectName?: string;
+    subjectCode?: string;
+    section: string | ObjectId;
+    sectionName?: string;
+    duration: number;
+    status?: string;
+    createdAt?: string | Date;
+    updatedAt?: string | Date;
+    deletedAt?: string | Date;
+};
+declare const schemaTeachingLoadSlot: Joi.ObjectSchema<any>;
+declare function modelTeachingLoadSlot(value: TTeachingLoadSlot): {
+    _id: ObjectId | undefined;
+    teachingLoad: string | ObjectId;
+    day: string;
+    gradeLevel: string;
+    startTime: string;
+    endTime: string;
+    subject: string | ObjectId;
+    subjectName: string;
+    subjectCode: string;
+    section: string | ObjectId;
+    sectionName: string;
+    duration: number;
+    status: string;
+    createdAt: string | Date;
+    updatedAt: string | Date;
+    deletedAt: string | Date;
+};
+
+declare function useTeachingLoadSlotRepo(): {
+    createIndexes: () => Promise<void>;
+    add: (value: TTeachingLoadSlot, session?: ClientSession) => Promise<string>;
+    updateById: (_id: ObjectId | string, value: {
+        day?: string;
+        startTime?: string;
+        endTime?: string;
+        subject?: string | ObjectId;
+        subjectName?: string;
+        section?: string | ObjectId;
+        sectionName?: string;
+        duration?: number;
+        status?: string;
+    }, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    getAll: ({ teachingLoad, subject, section, day, page, limit, sort, status, teacher, school, }?: {
+        teachingLoad?: string | undefined;
+        subject?: string | undefined;
+        section?: string | undefined;
+        day?: string | undefined;
+        page?: number | undefined;
+        limit?: number | undefined;
+        sort?: {} | undefined;
+        status?: string | undefined;
+        teacher?: string | undefined;
+        school?: string | undefined;
+    }) => Promise<{
+        items: any[];
+        pages: number;
+        pageRange: string;
+    } | {
+        item: any;
+        pages: string;
+        pageRange: string;
+    }>;
+    getById: (_id: string | ObjectId) => Promise<TTeachingLoadSlot | null>;
+    deleteById: (_id: string | ObjectId, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    delCachedData: () => void;
+};
+
+declare function useTeachingLoadSlotController(): {
+    add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    updateById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAllByTeachingLoad: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    deleteById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getByTeachingLoad: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getByTeacher: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
+type TProgram = {
+    _id?: ObjectId;
+    school: ObjectId;
+    schoolName?: string;
+    name: string;
+    code: string;
+    gradeLevels?: string[];
+    description?: string;
+    status: string;
+    createdAt?: string | Date;
+    updatedAt?: string | Date;
+    deletedAt?: string | Date;
+};
+declare const schemaProgram: Joi.ObjectSchema<any>;
+declare const schemaProgramUpdate: Joi.ObjectSchema<any>;
+declare function modelProgram(value: TProgram): TProgram;
+
+declare function useProgramRepo(): {
+    createIndexes: () => Promise<void>;
+    add: (value: TProgram, session?: ClientSession) => Promise<ObjectId>;
+    getAll: ({ search, page, limit, sort, status, school, isDefault, }?: {
+        search?: string;
+        page?: number;
+        limit?: number;
+        sort?: Record<string, any>;
+        status?: string;
+        school?: string;
+        isDefault?: boolean;
+    }) => Promise<Record<string, any> | {
+        items: any[];
+        pages: number;
+        pageRange: string;
+    }>;
+    getById: (_id: string | ObjectId) => Promise<TProgram>;
+    getByCode: (code: string, school: string | ObjectId) => Promise<TProgram>;
+    updateFieldById: ({ _id, field, value }?: {
+        _id: string | ObjectId;
+        field: string;
+        value: string | Array<string> | boolean;
+    }, session?: ClientSession) => Promise<string>;
+    deleteById: (_id: string | ObjectId) => Promise<string>;
+    updateById: (_id: string | ObjectId, value: Pick<TProgram, "name" | "code" | "description">) => Promise<string>;
+};
+
+declare function useProgramController(): {
+    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>;
+    getByCode: (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>;
+    updateById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
+export { MAsset, MBuilding, MBuildingUnit, MCurriculum, MGradeLevel, MLearner, MPersonnel, MPlantilla, MStockCard, TAddress, TAddressInformation, TAsset, TBasicEduCount, TBuilding, TBuildingUnit, TCurriculum, TDivision, TGradeLevel, TLearner, TLearnerInfo, TLearningModality, TParentGuardianInfo, TPersonContact, TPersonnel, TPlantilla, TProgram, TRegion, TReturningLearnerInfo, TSchool, TSection, TSectionPreset, TSectionStudent, TSectionSubject, TSeniorHighInformation, TStockCard, TSubject, TTeachingLoad, TTeachingLoadSlot, allowedSectionStudentStatuses, modelBasicEduCount, modelDivision, modelProgram, modelRegion, modelSchool, modelSection, modelSectionPreset, modelSectionStudent, modelSectionSubject, modelSubject, modelTeachingLoad, modelTeachingLoadSlot, schemaAsset, schemaAssetUpdateOption, schemaBasicEduCount, schemaBuilding, schemaBuildingUnit, schemaCurriculum, schemaDivision, schemaDivisionUpdate, schemaEnrollment, schemaGenerateSections, schemaGradeLevel, schemaPersonnel, schemaPlantilla, schemaProgram, schemaProgramUpdate, schemaRegion, schemaSchool, schemaSchoolUpdate, schemaSection, schemaSectionPreset, schemaSectionStudent, schemaSectionSubject, schemaSectionSubjectSetup, schemaStockCard, schemaSubject, schemaSubjectAdd, schemaTeachingLoad, schemaTeachingLoadSlot, schemaUpdateOptions, schemaUpdateStatus, useAssetController, useAssetRepo, useBasicEduCountRepo, useBuildingController, useBuildingRepo, useBuildingService, useBuildingUnitController, useBuildingUnitRepo, useBuildingUnitService, useCurriculumController, useCurriculumRepo, useDivisionController, useDivisionRepo, useDivisionService, useEnrollmentController, useEnrollmentRepo, useEnrollmentService, useGradeLevelController, useGradeLevelRepo, useLearnerController, useLearnerRepo, usePersonnelController, usePersonnelRepo, usePlantillaController, usePlantillaRepo, usePlantillaService, useProgramController, useProgramRepo, useRegionController, useRegionRepo, useSchoolController, useSchoolRepo, useSchoolService, useSectionController, useSectionPresetController, useSectionPresetRepo, useSectionRepo, useSectionStudentController, useSectionStudentRepo, useSectionSubjectController, useSectionSubjectRepo, useSectionSubjectService, useStockCardController, useStockCardRepository, useStockCardService, useSubjectController, useSubjectRepo, useSubjectService, useTeachingLoadController, useTeachingLoadRepo, useTeachingLoadSlotController, useTeachingLoadSlotRepo };