@eeplatform/core 1.4.5 → 1.5.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @eeplatform/core
 
+## 1.5.1
+
+### Patch Changes
+
+- f360ea6: Curriculum mgmt - revision
+
+## 1.5.0
+
+### Minor Changes
+
+- 3eb24f7: Basic education - curriculum mgmt initial release
+
 ## 1.4.5
 
 ### Patch Changes

package/dist/index.d.ts

@@ -2690,17 +2690,20 @@ declare function useUtilController(): {
 
 type TPlantilla = {
     _id?: ObjectId;
+    org: string;
     itemNumber: string;
+    orgUnitCode?: string;
     positionTitle: string;
     positionCategory: string;
     salaryGrade: number;
-    step?: number;
+    employmentType?: string;
+    personnelType: string;
     region?: ObjectId | string;
     regionName?: string;
     division?: ObjectId | string;
     divisionName?: string;
-    incumbent?: string;
     employee?: string | ObjectId;
+    employeeName?: string;
     annualSalary?: number;
     monthlySalary?: number;
     status?: string;
@@ -2737,6 +2740,200 @@ declare function usePlantillaController(): {
     bulkAddPlantillas: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
+type TOffice = {
+    _id?: ObjectId;
+    name: string;
+    code: string;
+    type: string;
+    parent?: ObjectId | string;
+    path: string;
+    status: string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+    deletedAt?: Date | string;
+};
+declare const schemaOffice: Joi.ObjectSchema<TOffice>;
+declare function MOffice(data: Partial<TOffice>): TOffice;
+
+declare function useOfficeRepo(): {
+    createIndexes: () => Promise<void>;
+    add: (value: TOffice, session?: ClientSession, clearCache?: boolean) => Promise<ObjectId>;
+    getAll: ({ search, page, limit, sort, type, parent, status, }?: {
+        search?: string | undefined;
+        page?: number | undefined;
+        limit?: number | undefined;
+        sort?: {} | undefined;
+        type?: string | undefined;
+        parent?: string | undefined;
+        status?: string | undefined;
+    }) => Promise<Record<string, any>>;
+    getById: (_id: string | ObjectId) => Promise<TOffice | null>;
+    updateById: (_id: ObjectId | string, value: Partial<Pick<TOffice, "status" | "name" | "code" | "type" | "parent" | "path" | "updatedAt">>, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    deleteById: (_id: string | ObjectId, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    delCachedData: () => void;
+};
+
+declare function useOfficeService(): {
+    addBulk: (file: Express.Multer.File) => Promise<{
+        total: number;
+        successful: number;
+        failed: number;
+        errors: string[];
+    }>;
+};
+
+declare function useOfficeController(): {
+    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>;
+    updateById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    deleteById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    bulkAddOffices: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
+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;
+    effectiveSchoolYear: string;
+    maxTeachingHoursPerDay: number;
+    subjects?: TCurriculumSubject[];
+    curriculumMemoRef?: string;
+    status?: string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+    deletedAt?: Date | string;
+    createdBy?: string;
+    updatedBy?: string;
+    deletedBy?: string;
+};
+declare const schemaCurriculum: Joi.ObjectSchema<any>;
+declare function MCurriculum(value: TCurriculum): {
+    _id: ObjectId | undefined;
+    school: string | ObjectId;
+    code: string;
+    effectiveSchoolYear: string;
+    maxTeachingHoursPerDay: number;
+    subjects: TCurriculumSubject[];
+    curriculumMemoRef: string;
+    status: string;
+    createdAt: string | Date;
+    updatedAt: string | Date;
+    deletedAt: string | Date;
+    createdBy: string;
+    updatedBy: string;
+    deletedBy: string;
+};
+
+declare function useCurriculumRepo(): {
+    createIndexes: () => Promise<void>;
+    add: (value: TCurriculum, session?: ClientSession) => Promise<ObjectId>;
+    getAll: ({ search, page, limit, sort, status, }?: {
+        search?: string | undefined;
+        page?: number | undefined;
+        limit?: number | undefined;
+        sort?: {} | undefined;
+        status?: string | undefined;
+    }) => Promise<Record<string, any>>;
+    getById: (_id: string | ObjectId) => Promise<TCurriculum | null>;
+    updateById: (_id: ObjectId | string, value: {
+        code?: string;
+        maxTeachingHoursPerDay?: number;
+        curriculumMemoRef?: string;
+    }, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    deleteById: (_id: string | ObjectId, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+};
+
+declare function useCurriculumController(): {
+    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>;
+    updateById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    deleteById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
+type TGradeLevel = {
+    _id?: ObjectId;
+    school?: ObjectId | string;
+    educationLevel: string;
+    gradeLevel: string;
+    teachingStyle: string;
+    defaultStartTime?: string;
+    defaultEndTime?: string;
+    status?: string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+    deletedAt?: Date | string;
+    createdBy?: string;
+    updatedBy?: string;
+    deletedBy?: string;
+};
+declare const schemaGradeLevel: Joi.ObjectSchema<any>;
+declare function MGradeLevel(value: TGradeLevel): {
+    _id: ObjectId | undefined;
+    school: string | ObjectId | undefined;
+    educationLevel: string;
+    gradeLevel: string;
+    teachingStyle: string;
+    defaultStartTime: string;
+    defaultEndTime: string;
+    status: string;
+    createdAt: string | Date;
+    updatedAt: string | Date;
+    deletedAt: string | Date;
+    createdBy: string;
+    updatedBy: string;
+    deletedBy: string;
+};
+
+declare function useGradeLevelRepo(): {
+    createIndexes: () => Promise<void>;
+    add: (value: TGradeLevel, session?: ClientSession) => Promise<ObjectId>;
+    getAll: ({ search, page, limit, sort, educationLevel, gradeLevel, teachingStyle, school, status, }?: {
+        search?: string | undefined;
+        page?: number | undefined;
+        limit?: number | undefined;
+        sort?: {} | undefined;
+        educationLevel?: string | undefined;
+        gradeLevel?: string | undefined;
+        teachingStyle?: string | undefined;
+        school?: string | undefined;
+        status?: string | undefined;
+    }) => Promise<Record<string, any>>;
+    getById: (_id: string | ObjectId) => Promise<bson.Document>;
+    updateById: (_id: ObjectId | string, value: {
+        educationLevel?: string;
+        gradeLevel?: string;
+        teachingStyle?: string;
+        maxTeachingHoursPerDay?: number;
+        maxTeachingHoursPerWeek?: number;
+        defaultStartTime?: string;
+        defaultEndTime?: string;
+        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[]>;
+};
+
+declare function useGradeLevelController(): {
+    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>;
+    updateById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    deleteById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getByEducationLevel: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
 declare const MONGO_URI: string;
 declare const MONGO_DB: string;
 declare const PORT: number;
@@ -2773,4 +2970,4 @@ declare const PAYPAL_API_URL: string;
 declare const XENDIT_SECRET_KEY: string;
 declare const XENDIT_BASE_URL: string;
 
-export { ACCESS_TOKEN_EXPIRY, ACCESS_TOKEN_SECRET, APP_ACCOUNT, APP_MAIN, CardPayment, CardPaymentSchema, DEFAULT_USER_EMAIL, DEFAULT_USER_FIRST_NAME, DEFAULT_USER_LAST_NAME, DEFAULT_USER_PASSWORD, DirectDebit, DirectDebitSchema, EWalletPayment, EWalletPaymentSchema, MAILER_EMAIL, MAILER_PASSWORD, MAILER_TRANSPORT_HOST, MAILER_TRANSPORT_PORT, MAILER_TRANSPORT_SECURE, MAddress, MAsset, MBuilding, MBuildingUnit, MDivision, MEntity, MFile, MMember, MONGO_DB, MONGO_URI, MOrder, MOrg, MPaymentMethod, MPlantilla, MPromoCode, MRegion, MRole, MSchool, MStockCard, MSubscription, MToken, MUser, MUserRole, MVerification, PAYPAL_API_URL, PAYPAL_CLIENT_ID, PAYPAL_CLIENT_SECRET, PORT, REDIS_HOST, REDIS_PASSWORD, REDIS_PORT, REFRESH_TOKEN_EXPIRY, REFRESH_TOKEN_SECRET, SECRET_KEY, SPACES_ACCESS_KEY, SPACES_BUCKET, SPACES_ENDPOINT, SPACES_REGION, SPACES_SECRET_KEY, TAddress, TAsset, TBillingRecipient, TBuilding, TBuildingUnit, TCounter, TDivision, TEntity, TFile, TInvoice, TMember, TMiniRole, TOrder, TOrderMetadata, TOrg, TPayment, TPaymentMethod$1 as TPaymentMethod, TPaymentMethodType, TPlantilla, TPrice, TPriceType, TPromoCode, TPromoTier, TRegion, TRole, TSchool, TStockCard, TSubscription, TToken, TUser, TUserRole, TVerification, TVerificationMetadata, VERIFICATION_FORGET_PASSWORD_DURATION, VERIFICATION_USER_INVITE_DURATION, XENDIT_BASE_URL, XENDIT_SECRET_KEY, addressSchema, isDev, schema, schemaAsset, schemaAssetUpdateOption, schemaBuilding, schemaBuildingUnit, schemaDivision, schemaPlantilla, schemaRegion, schemaSchool, schemaStockCard, schemaUpdateOptions, useAddressController, useAddressRepo, useAssetController, useAssetRepo, useAuthController, useAuthService, useBuildingController, useBuildingRepo, useBuildingUnitController, useBuildingUnitRepo, useCounterModel, useCounterRepo, useDivisionController, useDivisionRepo, useDivisionService, useEntityController, useEntityRepo, useFileController, useFileRepo, useFileService, useGitHubService, useInvoiceController, useInvoiceModel, useInvoiceRepo, useInvoiceService, useMemberController, useMemberRepo, useOrderController, useOrderRepo, useOrgController, useOrgRepo, useOrgService, usePaymentController, usePaymentMethodController, usePaymentMethodRepo, usePaymentMethodService, usePaymentModel, usePaymentRepo, usePaypalService, usePlantillaController, usePlantillaRepo, usePriceController, usePriceModel, usePriceRepo, usePromoCodeController, usePromoCodeRepo, useRegionController, useRegionRepo, useRegionService, useRoleController, useRoleRepo, useSchoolController, useSchoolRepo, useSchoolService, useStockCardController, useStockCardRepository, useSubscriptionController, useSubscriptionRepo, useSubscriptionService, useTokenRepo, useUserController, useUserRepo, useUserService, useUtilController, useVerificationController, useVerificationRepo, useVerificationService, useXenditService, validateCardPayment, validateDirectDebit, validateEWalletPayment };
+export { ACCESS_TOKEN_EXPIRY, ACCESS_TOKEN_SECRET, APP_ACCOUNT, APP_MAIN, CardPayment, CardPaymentSchema, DEFAULT_USER_EMAIL, DEFAULT_USER_FIRST_NAME, DEFAULT_USER_LAST_NAME, DEFAULT_USER_PASSWORD, DirectDebit, DirectDebitSchema, EWalletPayment, EWalletPaymentSchema, MAILER_EMAIL, MAILER_PASSWORD, MAILER_TRANSPORT_HOST, MAILER_TRANSPORT_PORT, MAILER_TRANSPORT_SECURE, MAddress, MAsset, MBuilding, MBuildingUnit, MCurriculum, MDivision, MEntity, MFile, MGradeLevel, MMember, MONGO_DB, MONGO_URI, MOffice, MOrder, MOrg, MPaymentMethod, MPlantilla, MPromoCode, MRegion, MRole, MSchool, MStockCard, MSubscription, MToken, MUser, MUserRole, MVerification, PAYPAL_API_URL, PAYPAL_CLIENT_ID, PAYPAL_CLIENT_SECRET, PORT, REDIS_HOST, REDIS_PASSWORD, REDIS_PORT, REFRESH_TOKEN_EXPIRY, REFRESH_TOKEN_SECRET, SECRET_KEY, SPACES_ACCESS_KEY, SPACES_BUCKET, SPACES_ENDPOINT, SPACES_REGION, SPACES_SECRET_KEY, TAddress, TAsset, TBillingRecipient, TBuilding, TBuildingUnit, TCounter, TCurriculum, TCurriculumSubject, TDivision, TEntity, TFile, TGradeLevel, TInvoice, TMember, TMiniRole, TOffice, TOrder, TOrderMetadata, TOrg, TPayment, TPaymentMethod$1 as TPaymentMethod, TPaymentMethodType, TPlantilla, TPrice, TPriceType, TPromoCode, TPromoTier, TRegion, TRole, TSchool, TStockCard, TSubscription, TToken, TUser, TUserRole, TVerification, TVerificationMetadata, VERIFICATION_FORGET_PASSWORD_DURATION, VERIFICATION_USER_INVITE_DURATION, XENDIT_BASE_URL, XENDIT_SECRET_KEY, addressSchema, isDev, schema, schemaAsset, schemaAssetUpdateOption, schemaBuilding, schemaBuildingUnit, schemaCurriculum, schemaDivision, schemaGradeLevel, schemaOffice, schemaPlantilla, schemaRegion, schemaSchool, schemaStockCard, schemaUpdateOptions, useAddressController, useAddressRepo, useAssetController, useAssetRepo, useAuthController, useAuthService, useBuildingController, useBuildingRepo, useBuildingUnitController, useBuildingUnitRepo, useCounterModel, useCounterRepo, useCurriculumController, useCurriculumRepo, useDivisionController, useDivisionRepo, useDivisionService, useEntityController, useEntityRepo, useFileController, useFileRepo, useFileService, useGitHubService, useGradeLevelController, useGradeLevelRepo, useInvoiceController, useInvoiceModel, useInvoiceRepo, useInvoiceService, useMemberController, useMemberRepo, useOfficeController, useOfficeRepo, useOfficeService, useOrderController, useOrderRepo, useOrgController, useOrgRepo, useOrgService, usePaymentController, usePaymentMethodController, usePaymentMethodRepo, usePaymentMethodService, usePaymentModel, usePaymentRepo, usePaypalService, usePlantillaController, usePlantillaRepo, usePriceController, usePriceModel, usePriceRepo, usePromoCodeController, usePromoCodeRepo, useRegionController, useRegionRepo, useRegionService, useRoleController, useRoleRepo, useSchoolController, useSchoolRepo, useSchoolService, useStockCardController, useStockCardRepository, useSubscriptionController, useSubscriptionRepo, useSubscriptionService, useTokenRepo, useUserController, useUserRepo, useUserService, useUtilController, useVerificationController, useVerificationRepo, useVerificationService, useXenditService, validateCardPayment, validateDirectDebit, validateEWalletPayment };