@eeplatform/basic-edu 1.1.2 → 1.3.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @eeplatform/basic-edu
 
+## 1.3.0
+
+### Minor Changes
+
+- 89ab132: School Mgmt - revise addbulk()
+
+## 1.2.0
+
+### Minor Changes
+
+- d58a166: DepEd mgmt - initial release
+
 ## 1.1.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -358,22 +358,25 @@ declare function useGradeLevelController(): {
 type TRegion = {
     _id?: ObjectId;
     name?: string;
-    code: string;
+    director?: ObjectId;
+    directorName?: string;
+    status: string;
     createdAt?: string;
     updatedAt?: string;
     deletedAt?: string;
 };
 declare const schemaRegion: Joi.ObjectSchema<any>;
-declare function MRegion(value: TRegion): TRegion;
+declare function modelRegion(value: TRegion): TRegion;
 
 declare function useRegionRepo(): {
     createIndexes: () => Promise<void>;
     add: (value: TRegion, session?: ClientSession) => Promise<ObjectId>;
-    getAll: ({ search, page, limit, sort }?: {
+    getAll: ({ search, page, limit, sort, status, }?: {
         search?: string | undefined;
         page?: number | undefined;
         limit?: number | undefined;
         sort?: {} | undefined;
+        status?: string | undefined;
     }) => Promise<Record<string, any> | {
         items: any[];
         pages: number;
@@ -401,27 +404,28 @@ declare function useRegionController(): {
 type TDivision = {
     _id?: ObjectId;
     name?: string;
-    region?: string | ObjectId;
+    region?: ObjectId;
     regionName?: string;
-    superintendent?: string | ObjectId;
+    superintendent?: ObjectId;
     superintendentName?: string;
+    status: string;
     createdAt?: string;
     updatedAt?: string;
     deletedAt?: string;
 };
 declare const schemaDivision: Joi.ObjectSchema<any>;
-declare function MDivision(value: TDivision): TDivision;
+declare const schemaDivisionUpdate: Joi.ObjectSchema<any>;
+declare function modelDivision(value: TDivision): TDivision;
 
 declare function useDivisionRepo(): {
-    createIndex: () => Promise<void>;
-    createTextIndex: () => Promise<void>;
-    createUniqueIndex: () => Promise<void>;
+    createIndexes: () => Promise<void>;
     add: (value: TDivision, session?: ClientSession) => Promise<ObjectId>;
-    getAll: ({ search, page, limit, sort, region, }?: {
+    getAll: ({ search, page, limit, sort, status, region, }?: {
         search?: string | undefined;
         page?: number | undefined;
         limit?: number | undefined;
         sort?: {} | undefined;
+        status?: string | undefined;
         region?: string | undefined;
     }) => Promise<Record<string, any> | {
         items: any[];
@@ -434,6 +438,7 @@ declare function useDivisionRepo(): {
         field: string;
         value: string;
     }, session?: ClientSession) => Promise<string>;
+    updateById: (_id: string | ObjectId, options: Pick<TDivision, "name" | "region" | "regionName" | "superintendent" | "superintendentName">, session?: ClientSession) => Promise<string>;
     deleteById: (_id: string | ObjectId) => Promise<string>;
     getByName: (name: string) => Promise<TDivision>;
 };
@@ -443,76 +448,85 @@ declare function useDivisionService(): {
 };
 
 declare function useDivisionController(): {
-    createDivision: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    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>;
-    deleteDivision: (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>;
 };
 
 type TSchool = {
     _id?: ObjectId;
     id: string;
-    name: string;
-    country?: string;
-    address?: string;
-    continuedAddress?: string;
+    name?: string;
+    region?: ObjectId | string;
+    regionName?: string;
+    division?: ObjectId | string;
+    divisionName?: string;
+    principal?: ObjectId;
+    principalName?: string;
+    street?: string;
+    barangay?: string;
     city?: string;
     province?: string;
-    district?: string;
     postalCode?: string;
-    courses?: Array<string>;
-    principalName?: string;
-    principalEmail?: string;
-    principalNumber?: string;
-    region: string | ObjectId;
-    regionName?: string;
-    division: string | ObjectId;
-    divisionName?: string;
+    contactNumber?: string;
+    email?: string;
     status?: string;
+    createdBy?: string;
     createdAt?: string;
     updatedAt?: string;
-    createdBy?: string | ObjectId;
+    deletedAt?: string;
 };
 declare const schemaSchool: Joi.ObjectSchema<any>;
-declare function MSchool(value: TSchool): TSchool;
+declare const schemaSchoolUpdate: Joi.ObjectSchema<any>;
+declare function modelSchool(value: TSchool): TSchool;
 
 declare function useSchoolRepo(): {
-    createIndex: () => Promise<void>;
-    add: (value: TSchool, session?: ClientSession) => Promise<ObjectId>;
-    getAll: ({ page, limit, sort, status, org, app, search, }?: {
+    createIndexes: () => Promise<void>;
+    add: (value: TSchool, session?: ClientSession, clearCache?: boolean) => Promise<ObjectId>;
+    getAll: ({ search, page, limit, sort, status, }?: {
+        search?: string | undefined;
         page?: number | undefined;
         limit?: number | undefined;
-        sort?: Record<string, number> | undefined;
+        sort?: {} | undefined;
         status?: string | undefined;
-        org?: string | undefined;
-        app?: string | undefined;
-        search?: string | undefined;
-    }) => Promise<{}>;
-    updateStatusById: (_id: string | ObjectId, status: string, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    }) => Promise<Record<string, any> | {
+        items: any[];
+        pages: number;
+        pageRange: string;
+    }>;
+    getById: (_id: string | ObjectId, status?: string) => Promise<TSchool>;
+    getPendingByCreatedBy: (createdBy: string | ObjectId) => Promise<TSchool>;
+    updateStatusById: (_id: string | ObjectId, status: string, session?: ClientSession) => Promise<string>;
     updateFieldById: ({ _id, field, value }?: {
         _id: string | ObjectId;
         field: string;
-        value: string | ObjectId;
-    }, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
-    getPendingByCreatedBy: (createdBy: string | ObjectId) => Promise<{} | null>;
-    getPendingById: (_id: string | ObjectId) => Promise<TSchool>;
+        value: string;
+    }, session?: ClientSession) => Promise<string>;
+    updateById: (_id: string | ObjectId, options: Pick<TSchool, "name" | "region" | "regionName" | "division" | "divisionName" | "principal" | "principalName">, session?: ClientSession) => Promise<string>;
+    deleteById: (_id: string | ObjectId) => Promise<string>;
+    getByName: (name: string) => Promise<TSchool>;
+    delCachedData: () => void;
 };
 
 declare function useSchoolService(): {
     register: (value: TSchool) => Promise<string>;
     approve: (id: string) => Promise<string>;
     add: (value: TSchool) => Promise<string>;
-    addBulk: (file: Express.Multer.File, region: string, division: string) => Promise<{
+    addBulk: (file: Express.Multer.File, payload: {
+        region: string;
+        regionName: string;
+        division: string;
+        divisionName: string;
+    }) => Promise<{
         message: string;
-        details: {
-            successful: number;
-            failed: number;
-            total: number;
-            totalSizeMB: number;
-            errors: string[];
-        };
+        successful: number;
+        failed: number;
+        errors: string[];
+        skipped: number;
     }>;
 };
 
@@ -524,6 +538,9 @@ declare function useSchoolController(): {
     registerSchool: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     approveSchool: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     addBulk: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    updateFieldById: (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>;
 };
 
 type TAsset = {
@@ -708,4 +725,4 @@ declare function usePlantillaController(): {
     bulkAddPlantillas: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
-export { AddressInformation, BasicEducEnrForm, DisabilityType, EnrAddress, EnrCert, EnrLearnerInfo, EnrLearningModality, EnrParentGuardianInfo, EnrReturningLearnerInfo, EnrSeniorHighInformation, MAsset, MCurriculum, MDivision, MEnrollment, MGradeLevel, MPlantilla, MRegion, MSchool, MStockCard, PersonContact, TAsset, TCurriculum, TCurriculumSubject, TDivision, TGradeLevel, TPlantilla, TRegion, TSchool, TStockCard, schemaAsset, schemaAssetUpdateOption, schemaCurriculum, schemaDivision, schemaEnrollment, schemaGradeLevel, schemaPlantilla, schemaRegion, schemaSchool, schemaStockCard, useAssetController, useAssetRepo, useCurriculumController, useCurriculumRepo, useDivisionController, useDivisionRepo, useDivisionService, useEnrollmentController, useEnrollmentRepo, useEnrollmentService, useGradeLevelController, useGradeLevelRepo, usePlantillaController, usePlantillaRepo, usePlantillaService, useRegionController, useRegionRepo, useSchoolController, useSchoolRepo, useSchoolService, useStockCardController, useStockCardRepository, useStockCardService };
+export { AddressInformation, BasicEducEnrForm, DisabilityType, EnrAddress, EnrCert, 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 };