@eeplatform/basic-edu 1.3.12 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @eeplatform/basic-edu
 
+## 1.4.0
+
+### Minor Changes
+
+- f35df69: Enrollment mgmt - initial stable release
+
 ## 1.3.12
 
 ### Patch Changes

package/dist/index.d.ts

@@ -79,7 +79,7 @@ declare function useCurriculumController(): {
     deleteById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
-type BasicEducEnrForm = {
+type TLearner = {
     _id?: ObjectId;
     region: string;
     regionName?: string;
@@ -88,21 +88,20 @@ type BasicEducEnrForm = {
     division: string;
     divisionName?: string;
     schoolId: string;
-    school: ObjectId;
+    school: ObjectId | string;
     schoolName?: string;
     schoolYear: string;
     gradeLevel: string;
     returningLearner: boolean;
-    learnerInfo: EnrLearnerInfo;
-    parentGuardianInfo: EnrParentGuardianInfo;
-    address: AddressInformation;
-    returningLearnerInfo?: EnrReturningLearnerInfo;
-    seniorHighInfo?: EnrSeniorHighInformation;
+    learnerInfo: TLearnerInfo;
+    parentGuardianInfo: TParentGuardianInfo;
+    address: TAddressInformation;
+    returningLearnerInfo?: TReturningLearnerInfo;
+    seniorHighInfo?: TSeniorHighInformation;
     alternativeLearningOptions?: string[];
     isCertifiedAndConsented: boolean;
     status?: string;
     remarks?: string;
-    rejectionReason?: string;
     createdAt?: Date | string;
     updatedAt?: Date | string;
     deletedAt?: Date | string;
@@ -110,7 +109,7 @@ type BasicEducEnrForm = {
     updatedBy?: string;
     deletedBy?: string;
 };
-type EnrLearnerInfo = {
+type TLearnerInfo = {
     psaBirthCertificateNo?: string;
     lrn?: string;
     lastName: string;
@@ -128,23 +127,23 @@ type EnrLearnerInfo = {
     disabilities?: string[];
     otherDisabilityDetails?: string;
 };
-type EnrParentGuardianInfo = {
-    father?: PersonContact;
-    mother?: PersonContact;
-    legalGuardian?: PersonContact;
+type TParentGuardianInfo = {
+    father?: TPersonContact;
+    mother?: TPersonContact;
+    legalGuardian?: TPersonContact;
 };
-type PersonContact = {
+type TPersonContact = {
     lastName: string;
     firstName: string;
     middleName?: string;
     contactNumber?: string;
 };
-type AddressInformation = {
-    current: EnrAddress;
-    permanent: EnrAddress;
+type TAddressInformation = {
+    current: TAddress;
+    permanent: TAddress;
     sameAsCurrent?: boolean;
 };
-type EnrAddress = {
+type TAddress = {
     houseNumber?: string;
     streetName?: string;
     sitio?: string;
@@ -154,7 +153,7 @@ type EnrAddress = {
     country?: string;
     zipCode?: string;
 };
-type EnrReturningLearnerInfo = {
+type TReturningLearnerInfo = {
     lastGradeLevelCompleted: string;
     lastSchoolYearCompleted: string;
     lastSchoolAttended: string;
@@ -162,14 +161,15 @@ type EnrReturningLearnerInfo = {
     isReturningLearner: boolean;
     isTransferIn: boolean;
 };
-type EnrSeniorHighInformation = {
+type TSeniorHighInformation = {
     semester: "1st" | "2nd";
     track: string;
     strand: string;
 };
-type EnrLearningModality = "Modular (Print)" | "Modular (Digital)" | "Online" | "Radio-Based Instruction" | "Educational Television" | "Blended" | "Homeschooling";
+type TLearningModality = "Modular (Print)" | "Modular (Digital)" | "Online" | "Radio-Based Instruction" | "Educational Television" | "Blended" | "Homeschooling";
+declare const schemaUpdateStatus: Joi.ObjectSchema<any>;
 declare const schemaEnrollment: Joi.ObjectSchema<any>;
-declare function MEnrollment(value: BasicEducEnrForm): {
+declare function MLearner(value: TLearner): {
     _id: ObjectId | undefined;
     region: string;
     regionName: string;
@@ -177,22 +177,21 @@ declare function MEnrollment(value: BasicEducEnrForm): {
     cityMunicipality: string;
     division: string;
     divisionName: string;
-    school: ObjectId;
+    school: string | ObjectId;
     schoolId: string;
     schoolName: string;
     schoolYear: string;
     gradeLevel: string;
     returningLearner: boolean;
-    learnerInfo: EnrLearnerInfo;
-    parentGuardianInfo: EnrParentGuardianInfo;
-    address: AddressInformation;
-    returningLearnerInfo: EnrReturningLearnerInfo | undefined;
-    seniorHighInfo: EnrSeniorHighInformation | undefined;
+    learnerInfo: TLearnerInfo;
+    parentGuardianInfo: TParentGuardianInfo;
+    address: TAddressInformation;
+    returningLearnerInfo: TReturningLearnerInfo | undefined;
+    seniorHighInfo: TSeniorHighInformation | undefined;
     alternativeLearningOptions: string[];
     isCertifiedAndConsented: boolean;
     status: string;
     remarks: string;
-    rejectionReason: string;
     createdAt: string | Date;
     updatedAt: string | Date;
     deletedAt: string | Date;
@@ -203,8 +202,7 @@ declare function MEnrollment(value: BasicEducEnrForm): {
 
 declare function useEnrollmentRepo(): {
     createIndexes: () => Promise<void>;
-    add: (value: BasicEducEnrForm, session?: ClientSession) => Promise<ObjectId>;
-    updateById: (_id: ObjectId | string, value: Partial<BasicEducEnrForm>, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    add: (value: TLearner, session?: ClientSession) => Promise<ObjectId>;
     getAll: ({ search, page, limit, sort, status, school, schoolYear, gradeLevelToEnroll, }?: {
         search?: string | undefined;
         page?: number | undefined;
@@ -219,9 +217,6 @@ declare function useEnrollmentRepo(): {
         pages: number;
         pageRange: string;
     }>;
-    getById: (_id: string | ObjectId) => Promise<BasicEducEnrForm>;
-    getByLrn: (lrn: string, schoolYear?: string) => Promise<BasicEducEnrForm | null>;
-    deleteById: (_id: string | ObjectId, deletedBy?: string, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
     getByApplicantInfo: ({ school, schoolYear, gradeLevel, firstName, lastName, middleName, birthDate, placeOfBirth, }?: {
         school?: string | undefined;
         schoolYear?: string | undefined;
@@ -235,60 +230,22 @@ declare function useEnrollmentRepo(): {
         accepted: boolean;
         length: number;
     }>;
-    getBySchoolAndYear: (school: string | ObjectId, schoolYear: string) => Promise<BasicEducEnrForm[]>;
+    updateStatusById: (_id: string | ObjectId, status: string, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    getById: (_id: string | ObjectId, status?: string) => Promise<TLearner | null>;
 };
 
 declare function useEnrollmentService(): {
-    createEnrollment: (value: BasicEducEnrForm) => Promise<{
+    add: (value: TLearner) => Promise<{
         message: string;
-        id: ObjectId;
-    }>;
-    updateEnrollment: (_id: string | ObjectId, value: Partial<BasicEducEnrForm>) => Promise<{
-        message: string;
-        modifiedCount: number;
-    }>;
-    getEnrollments: ({ search, page, limit, sort, status, school, schoolYear, gradeLevelToEnroll, }?: {
-        search?: string | undefined;
-        page?: number | undefined;
-        limit?: number | undefined;
-        sort?: {} | undefined;
-        status?: string | undefined;
-        school?: string | undefined;
-        schoolYear?: string | undefined;
-        gradeLevelToEnroll?: string | undefined;
-    }) => Promise<Record<string, any> | {
-        items: any[];
-        pages: number;
-        pageRange: string;
-    }>;
-    getEnrollmentById: (_id: string | ObjectId) => Promise<BasicEducEnrForm>;
-    getEnrollmentByLrn: (lrn: string, schoolYear?: string) => Promise<BasicEducEnrForm | null>;
-    deleteEnrollment: (_id: string | ObjectId, deletedBy?: string) => Promise<{
-        message: string;
-        modifiedCount: number;
-    }>;
-    getEnrollmentsBySchoolAndYear: (school: string | ObjectId, schoolYear: string) => Promise<BasicEducEnrForm[]>;
-    approveEnrollment: (_id: string | ObjectId, approvedBy: string) => Promise<{
-        message: string;
-        modifiedCount: number;
-    }>;
-    rejectEnrollment: (_id: string | ObjectId, rejectedBy: string, rejectionReason?: string) => Promise<{
-        message: string;
-        modifiedCount: number;
+        id: bson.ObjectId;
     }>;
+    updateStatusById: (_id: string, status: string) => Promise<string>;
 };
 
 declare function useEnrollmentController(): {
     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>;
-    getById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
-    getByLrn: (req: Request, res: Response, next: NextFunction) => Promise<void>;
-    deleteById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
-    getBySchoolAndYear: (req: Request, res: Response, next: NextFunction) => Promise<void>;
-    approve: (req: Request, res: Response, next: NextFunction) => Promise<void>;
-    reject: (req: Request, res: Response, next: NextFunction) => Promise<void>;
-    getStatsBySchool: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    updateStatusById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
 type TGradeLevel = {
@@ -361,7 +318,7 @@ declare function useGradeLevelRepo(): {
         school?: ObjectId | string;
     }, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
     deleteById: (_id: string | ObjectId, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
-    getByEducationLevel: (educationLevel: string, school?: string) => Promise<mongodb.WithId<bson.Document>[] | TGradeLevel[]>;
+    getByEducationLevel: (educationLevel: string, school?: string) => Promise<TGradeLevel[] | mongodb.WithId<bson.Document>[]>;
 };
 
 declare function useGradeLevelController(): {
@@ -747,4 +704,52 @@ declare function usePlantillaController(): {
     bulkAddPlantillas: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
-export { AddressInformation, BasicEducEnrForm, EnrAddress, EnrLearnerInfo, EnrLearningModality, EnrParentGuardianInfo, EnrReturningLearnerInfo, EnrSeniorHighInformation, MAsset, MCurriculum, MEnrollment, MGradeLevel, MPlantilla, MStockCard, PersonContact, TAsset, TCurriculum, TCurriculumSubject, TDivision, TGradeLevel, TPlantilla, TRegion, TSchool, TStockCard, modelDivision, modelRegion, modelSchool, schemaAsset, schemaAssetUpdateOption, schemaCurriculum, schemaDivision, schemaDivisionUpdate, schemaEnrollment, schemaGradeLevel, schemaPlantilla, schemaRegion, schemaSchool, schemaSchoolUpdate, schemaStockCard, useAssetController, useAssetRepo, useCurriculumController, useCurriculumRepo, useDivisionController, useDivisionRepo, useDivisionService, useEnrollmentController, useEnrollmentRepo, useEnrollmentService, useGradeLevelController, useGradeLevelRepo, usePlantillaController, usePlantillaRepo, usePlantillaService, useRegionController, useRegionRepo, useSchoolController, useSchoolRepo, useSchoolService, useStockCardController, useStockCardRepository, useStockCardService };
+declare function useLearnerRepo(): {
+    createIndexes: () => Promise<void>;
+    add: (value: TLearner, session?: ClientSession) => Promise<ObjectId>;
+    getAll: ({ search, page, limit, sort, status, school, schoolYear, gradeLevelToEnroll, }?: {
+        search?: string | undefined;
+        page?: number | undefined;
+        limit?: number | undefined;
+        sort?: {} | undefined;
+        status?: string | undefined;
+        school?: string | undefined;
+        schoolYear?: string | undefined;
+        gradeLevelToEnroll?: string | undefined;
+    }) => Promise<Record<string, any> | {
+        items: any[];
+        pages: number;
+        pageRange: string;
+    }>;
+    updateStatusById: (_id: string | ObjectId, status: string, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    getById: (_id: string | ObjectId, status?: string) => Promise<TLearner | null>;
+};
+
+declare function useLearnerController(): {
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    updateStatusById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
+type TBasicEduCount = {
+    _id?: ObjectId;
+    name: string;
+    count: number;
+    updatedAt?: Date | string;
+};
+declare const schemaBasicEduCount: Joi.ObjectSchema<any>;
+declare function modelBasicEduCount(value: TBasicEduCount): {
+    _id: ObjectId | undefined;
+    name: string;
+    count: number;
+    updatedAt: string | Date;
+};
+
+declare function useBasicEduCountRepo(): {
+    createIndexes: () => Promise<void>;
+    add: (value: TBasicEduCount, session?: ClientSession) => Promise<ObjectId>;
+    getById: (_id: string | ObjectId, status?: string) => Promise<TBasicEduCount | null>;
+    incrementById: (_id: string | ObjectId, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    getByName: (name: string, session?: ClientSession) => Promise<TBasicEduCount | null>;
+};
+
+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 };