@eeplatform/basic-edu 1.5.1 → 1.5.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @eeplatform/basic-edu
 
+## 1.5.2
+
+### Patch Changes
+
+- 6159331: Curriculum subjects initial release
+
 ## 1.5.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -4,25 +4,14 @@ import { ObjectId, ClientSession } from 'mongodb';
 import * as bson from 'bson';
 import { Request, Response, NextFunction } from 'express';
 
-type TCurriculumSubject = {
-    educationLevel: string;
-    gradeLevel: string;
-    subjectCode: string;
-    subjectName: string;
-    subjectType: string;
-    sessionFrequency: number;
-    sessionDuration: number;
-    totalMinutesPerWeek: number;
-};
 type TCurriculum = {
     _id?: ObjectId;
-    school: ObjectId | string;
-    code: string;
+    name: string;
     effectiveSchoolYear: string;
     maxTeachingHoursPerDay: number;
-    subjects?: TCurriculumSubject[];
     curriculumMemoRef?: string;
-    status?: string;
+    status?: "active" | "pilot" | "inactive" | "deprecated";
+    whitelist?: (ObjectId | string)[];
     createdAt?: Date | string;
     updatedAt?: Date | string;
     deletedAt?: Date | string;
@@ -33,13 +22,12 @@ type TCurriculum = {
 declare const schemaCurriculum: Joi.ObjectSchema<any>;
 declare function MCurriculum(value: TCurriculum): {
     _id: ObjectId | undefined;
-    school: string | ObjectId;
-    code: string;
+    name: string;
     effectiveSchoolYear: string;
     maxTeachingHoursPerDay: number;
-    subjects: TCurriculumSubject[];
     curriculumMemoRef: string;
-    status: string;
+    status: "active" | "pilot" | "inactive" | "deprecated";
+    whitelist: (string | ObjectId)[];
     createdAt: string | Date;
     updatedAt: string | Date;
     deletedAt: string | Date;
@@ -64,11 +52,18 @@ declare function useCurriculumRepo(): {
     }>;
     getById: (_id: string | ObjectId) => Promise<TCurriculum | null>;
     updateById: (_id: ObjectId | string, value: {
-        code?: string;
+        name?: string;
+        effectiveSchoolYear?: string;
         maxTeachingHoursPerDay?: number;
         curriculumMemoRef?: string;
+        status?: "active" | "pilot" | "inactive" | "deprecated";
+        whitelist?: (ObjectId | string)[];
     }, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
     deleteById: (_id: string | ObjectId, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    canSchoolAccessCurriculum: (curriculumId: string | ObjectId, schoolId: string | ObjectId) => Promise<boolean>;
+    getAvailableForSchool: (schoolId: string | ObjectId) => Promise<TCurriculum[]>;
+    addSchoolToPilotWhitelist: (curriculumId: string | ObjectId, schoolId: string | ObjectId, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    removeSchoolFromPilotWhitelist: (curriculumId: string | ObjectId, schoolId: string | ObjectId, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
 };
 
 declare function useCurriculumController(): {
@@ -77,6 +72,119 @@ declare function useCurriculumController(): {
     getById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     updateById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     deleteById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    checkSchoolAccess: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAvailableForSchool: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    addToPilotWhitelist: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    removeFromPilotWhitelist: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
+type TCurriculumSubject = {
+    _id?: ObjectId;
+    curriculum: ObjectId | string;
+    curriculumName: string;
+    effectiveSchoolYear?: number[];
+    educationLevel: string;
+    gradeLevel: string;
+    subjectCode: string;
+    subjectName: string;
+    subjectType: string;
+    sessionFrequency: number;
+    sessionDuration: number;
+    totalMinutesPerWeek: number;
+    status?: string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+    deletedAt?: Date | string;
+    createdBy?: string;
+    updatedBy?: string;
+    deletedBy?: string;
+};
+declare const schemaCurriculumSubject: Joi.ObjectSchema<any>;
+declare const schemaCurriculumSubjectAdd: Joi.ObjectSchema<any>;
+declare function MCurriculumSubject(value: TCurriculumSubject): {
+    _id: ObjectId | undefined;
+    curriculum: ObjectId;
+    curriculumName: string;
+    effectiveSchoolYear: number[];
+    educationLevel: string;
+    gradeLevel: string;
+    subjectCode: string;
+    subjectName: string;
+    subjectType: string;
+    sessionFrequency: number;
+    sessionDuration: number;
+    totalMinutesPerWeek: number;
+    status: string;
+    createdAt: string | Date;
+    updatedAt: string | Date;
+    deletedAt: string | Date;
+    createdBy: string;
+    updatedBy: string;
+    deletedBy: string;
+};
+
+declare function useCurriculumSubjectRepo(): {
+    createIndexes: () => Promise<void>;
+    add: (value: TCurriculumSubject, session?: ClientSession) => Promise<ObjectId>;
+    getAll: ({ search, page, limit, sort, status, curriculum, educationLevel, gradeLevel, schoolYear, }?: {
+        search?: string;
+        page?: number;
+        limit?: number;
+        sort?: Record<string, number>;
+        status?: string;
+        curriculum?: string;
+        educationLevel?: string;
+        gradeLevel?: string;
+        schoolYear?: number;
+    }) => Promise<Record<string, any> | {
+        items: any[];
+        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>>;
+    deleteById: (_id: string | ObjectId, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    deleteByCurriculum: (curriculumId: string | ObjectId, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+};
+
+declare function useCurriculumSubjectController(): {
+    add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    addMany: (value: {
+        curriculum: string;
+        curriculumName: string;
+        effectiveSchoolYear?: number[];
+        educationLevel: string;
+        gradeLevel: string[];
+        subjectCode: string;
+        subjectName: string;
+        subjectType: string;
+        sessionFrequency: number;
+        sessionDuration: number;
+        totalMinutesPerWeek: number;
+    }) => Promise<string>;
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getByCurriculum: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    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>;
+};
+
+declare function useCurriculumSubjectService(): {
+    addMany: (value: {
+        curriculum: string;
+        curriculumName: string;
+        effectiveSchoolYear?: number[];
+        educationLevel: string;
+        gradeLevel: string[];
+        subjectCode: string;
+        subjectName: string;
+        subjectType: string;
+        sessionFrequency: number;
+        sessionDuration: number;
+        totalMinutesPerWeek: number;
+    }) => Promise<string>;
 };
 
 type TLearner = {
@@ -321,7 +429,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<TGradeLevel[] | mongodb.WithId<bson.Document>[]>;
+    getByEducationLevel: (educationLevel: string, school?: string) => Promise<mongodb.WithId<bson.Document>[] | TGradeLevel[]>;
     getByGradeLevel: (value: {
         school: string | ObjectId;
         gradeLevel: string;
@@ -904,4 +1012,4 @@ declare function useSectionStudentRepo(): {
     add: (value: TSectionStudent, session?: ClientSession) => Promise<bson.ObjectId>;
 };
 
-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, TSectionStudent, TSeniorHighInformation, TStockCard, allowedSectionStudentStatuses, modelBasicEduCount, modelDivision, modelRegion, modelSchool, modelSection, modelSectionPreset, modelSectionStudent, schemaAsset, schemaAssetUpdateOption, schemaBasicEduCount, schemaCurriculum, schemaDivision, schemaDivisionUpdate, schemaEnrollment, schemaGenerateSections, schemaGradeLevel, schemaPlantilla, schemaRegion, schemaSchool, schemaSchoolUpdate, schemaSection, schemaSectionPreset, schemaSectionStudent, 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, useSectionStudentRepo, useStockCardController, useStockCardRepository, useStockCardService };
+export { MAsset, MCurriculum, MCurriculumSubject, MGradeLevel, MLearner, MPlantilla, MStockCard, TAddress, TAddressInformation, TAsset, TBasicEduCount, TCurriculum, TCurriculumSubject, TDivision, TGradeLevel, TLearner, TLearnerInfo, TLearningModality, TParentGuardianInfo, TPersonContact, TPlantilla, TRegion, TReturningLearnerInfo, TSchool, TSection, TSectionPreset, TSectionStudent, TSeniorHighInformation, TStockCard, allowedSectionStudentStatuses, modelBasicEduCount, modelDivision, modelRegion, modelSchool, modelSection, modelSectionPreset, modelSectionStudent, schemaAsset, schemaAssetUpdateOption, schemaBasicEduCount, schemaCurriculum, schemaCurriculumSubject, schemaCurriculumSubjectAdd, schemaDivision, schemaDivisionUpdate, schemaEnrollment, schemaGenerateSections, schemaGradeLevel, schemaPlantilla, schemaRegion, schemaSchool, schemaSchoolUpdate, schemaSection, schemaSectionPreset, schemaSectionStudent, schemaStockCard, schemaUpdateStatus, useAssetController, useAssetRepo, useBasicEduCountRepo, useCurriculumController, useCurriculumRepo, useCurriculumSubjectController, useCurriculumSubjectRepo, useCurriculumSubjectService, useDivisionController, useDivisionRepo, useDivisionService, useEnrollmentController, useEnrollmentRepo, useEnrollmentService, useGradeLevelController, useGradeLevelRepo, useLearnerController, useLearnerRepo, usePlantillaController, usePlantillaRepo, usePlantillaService, useRegionController, useRegionRepo, useSchoolController, useSchoolRepo, useSchoolService, useSectionController, useSectionPresetController, useSectionPresetRepo, useSectionRepo, useSectionStudentRepo, useStockCardController, useStockCardRepository, useStockCardService };