@eeplatform/core 1.7.4 → 1.8.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @eeplatform/core
 
+## 1.8.1
+
+### Patch Changes
+
+- aff1249: Revise PSGC implementation
+
+## 1.8.0
+
+### Minor Changes
+
+- de639da: PSGC mgmt - initial release
+
 ## 1.7.4
 
 ### Patch Changes

package/dist/index.d.ts

@@ -874,6 +874,57 @@ declare function useUtilController(): {
 
 declare const transactionSchema: Joi.ObjectSchema<any>;
 
+type TPSGC = {
+    _id?: ObjectId;
+    code: string;
+    name: string;
+    type: string;
+};
+declare const schemaPSGC: Joi.ObjectSchema<any>;
+declare function modelPSGC(data: any): {
+    code: any;
+    name: any;
+    type: any;
+};
+
+declare function usePSGCRepo(): {
+    createIndexes: () => Promise<void>;
+    add: (value: TPSGC, session?: ClientSession) => Promise<ObjectId>;
+    getAll: ({ search, page, limit, sort, type, prefix, }?: {
+        search?: string | undefined;
+        page?: number | undefined;
+        limit?: number | undefined;
+        sort?: {} | undefined;
+        type?: string | undefined;
+        prefix?: string | undefined;
+    }) => Promise<Record<string, any> | {
+        items: any[];
+        pages: number;
+        pageRange: string;
+    }>;
+    getById: (_id: string | ObjectId) => Promise<TPSGC>;
+    updateFieldById: ({ _id, field, value }?: {
+        _id: string | ObjectId;
+        field: string;
+        value: string;
+    }, session?: ClientSession) => Promise<string>;
+    deleteById: (_id: string | ObjectId) => Promise<string>;
+    getByName: ({ name, prefix, type }?: {
+        name: string;
+        prefix?: string;
+        type?: string;
+    }) => Promise<TPSGC | null>;
+};
+
+declare function usePSGCController(): {
+    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>;
+    deleteById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
 declare const MONGO_URI: string;
 declare const MONGO_DB: string;
 declare const PORT: number;
@@ -913,4 +964,4 @@ declare const GEMINI_API_KEY: string;
 declare const ASSEMBLY_AI_API_KEY: string;
 declare const DOMAIN: string;
 
-export { ACCESS_TOKEN_EXPIRY, ACCESS_TOKEN_SECRET, APP_ACCOUNT, APP_MAIN, ASSEMBLY_AI_API_KEY, AudioFileData, AudioTranscriptionOptions, AudioTranscriptionResult, DEFAULT_USER_EMAIL, DEFAULT_USER_FIRST_NAME, DEFAULT_USER_LAST_NAME, DEFAULT_USER_PASSWORD, DOMAIN, GEMINI_API_KEY, MAILER_EMAIL, MAILER_PASSWORD, MAILER_TRANSPORT_HOST, MAILER_TRANSPORT_PORT, MAILER_TRANSPORT_SECURE, MAddress, MBuilding, MBuildingUnit, MFile, MMember, MONGO_DB, MONGO_URI, MOrg, MRole, MToken, MUser, MUserRole, MVerification, PAYPAL_API_URL, PAYPAL_CLIENT_ID, PAYPAL_CLIENT_SECRET, PORT, PhonemeMatchOptions, PhonemeMatchResult, 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, TBuilding, TBuildingUnit, TCounter, TFile, TMember, TMiniRole, TOrg, TRole, TToken, TUser, TUserRole, TVerification, TVerificationMetadata, VERIFICATION_FORGET_PASSWORD_DURATION, VERIFICATION_USER_INVITE_DURATION, XENDIT_BASE_URL, XENDIT_SECRET_KEY, addressSchema, isDev, schemaBuilding, schemaBuildingUnit, schemaOrg, schemaUpdateOptions, transactionSchema, useAddressController, useAddressRepo, useAudioTranscriptionController, useAuthController, useAuthService, useBuildingController, useBuildingRepo, useBuildingService, useBuildingUnitController, useBuildingUnitRepo, useBuildingUnitService, useCounterModel, useCounterRepo, useFileController, useFileRepo, useFileService, useGeminiAiService, useGitHubService, useMemberController, useMemberRepo, useOrgController, useOrgRepo, useOrgService, useRoleController, useRoleRepo, useTokenRepo, useTranscribeService, useUserController, useUserRepo, useUserService, useUtilController, useVerificationController, useVerificationRepo, useVerificationService };
+export { ACCESS_TOKEN_EXPIRY, ACCESS_TOKEN_SECRET, APP_ACCOUNT, APP_MAIN, ASSEMBLY_AI_API_KEY, AudioFileData, AudioTranscriptionOptions, AudioTranscriptionResult, DEFAULT_USER_EMAIL, DEFAULT_USER_FIRST_NAME, DEFAULT_USER_LAST_NAME, DEFAULT_USER_PASSWORD, DOMAIN, GEMINI_API_KEY, MAILER_EMAIL, MAILER_PASSWORD, MAILER_TRANSPORT_HOST, MAILER_TRANSPORT_PORT, MAILER_TRANSPORT_SECURE, MAddress, MBuilding, MBuildingUnit, MFile, MMember, MONGO_DB, MONGO_URI, MOrg, MRole, MToken, MUser, MUserRole, MVerification, PAYPAL_API_URL, PAYPAL_CLIENT_ID, PAYPAL_CLIENT_SECRET, PORT, PhonemeMatchOptions, PhonemeMatchResult, 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, TBuilding, TBuildingUnit, TCounter, TFile, TMember, TMiniRole, TOrg, TPSGC, TRole, TToken, TUser, TUserRole, TVerification, TVerificationMetadata, VERIFICATION_FORGET_PASSWORD_DURATION, VERIFICATION_USER_INVITE_DURATION, XENDIT_BASE_URL, XENDIT_SECRET_KEY, addressSchema, isDev, modelPSGC, schemaBuilding, schemaBuildingUnit, schemaOrg, schemaPSGC, schemaUpdateOptions, transactionSchema, useAddressController, useAddressRepo, useAudioTranscriptionController, useAuthController, useAuthService, useBuildingController, useBuildingRepo, useBuildingService, useBuildingUnitController, useBuildingUnitRepo, useBuildingUnitService, useCounterModel, useCounterRepo, useFileController, useFileRepo, useFileService, useGeminiAiService, useGitHubService, useMemberController, useMemberRepo, useOrgController, useOrgRepo, useOrgService, usePSGCController, usePSGCRepo, useRoleController, useRoleRepo, useTokenRepo, useTranscribeService, useUserController, useUserRepo, useUserService, useUtilController, useVerificationController, useVerificationRepo, useVerificationService };

package/dist/index.js

@@ -80,9 +80,11 @@ __export(src_exports, {
   XENDIT_SECRET_KEY: () => XENDIT_SECRET_KEY,
   addressSchema: () => addressSchema,
   isDev: () => isDev,
+  modelPSGC: () => modelPSGC,
   schemaBuilding: () => schemaBuilding,
   schemaBuildingUnit: () => schemaBuildingUnit,
   schemaOrg: () => schemaOrg,
+  schemaPSGC: () => schemaPSGC,
   schemaUpdateOptions: () => schemaUpdateOptions,
   transactionSchema: () => transactionSchema,
   useAddressController: () => useAddressController,
@@ -108,6 +110,8 @@ __export(src_exports, {
   useOrgController: () => useOrgController,
   useOrgRepo: () => useOrgRepo,
   useOrgService: () => useOrgService,
+  usePSGCController: () => usePSGCController,
+  usePSGCRepo: () => usePSGCRepo,
   useRoleController: () => useRoleController,
   useRoleRepo: () => useRoleRepo,
   useTokenRepo: () => useTokenRepo,
@@ -7022,6 +7026,452 @@ var transactionSchema = import_joi17.default.object({
   updatedAt: import_joi17.default.string().optional().allow("", null),
   deletedAt: import_joi17.default.string().optional().allow("", null)
 });
+
+// src/resources/psgc/psgc.model.ts
+var import_joi18 = __toESM(require("joi"));
+var schemaPSGC = import_joi18.default.object({
+  code: import_joi18.default.string().length(10).required(),
+  name: import_joi18.default.string().required(),
+  type: import_joi18.default.string().valid("Reg", "Prov", "City", "Mun", "Bgy").required()
+});
+function modelPSGC(data) {
+  const { error } = schemaPSGC.validate(data);
+  if (error) {
+    throw new Error(`Invalid PSGC data: ${error.message}`);
+  }
+  return {
+    code: data.code,
+    name: data.name,
+    type: data.type
+  };
+}
+
+// src/resources/psgc/psgc.repository.ts
+var import_nodejs_utils39 = require("@eeplatform/nodejs-utils");
+var import_mongodb21 = require("mongodb");
+function usePSGCRepo() {
+  const db = import_nodejs_utils39.useAtlas.getDb();
+  if (!db) {
+    throw new Error("Unable to connect to server.");
+  }
+  const namespace_collection = "psgc";
+  const collection = db.collection(namespace_collection);
+  const { getCache, setCache, delNamespace } = (0, import_nodejs_utils39.useCache)(namespace_collection);
+  async function createIndexes() {
+    try {
+      await collection.createIndexes([
+        { key: { name: 1 } },
+        { key: { name: "text" } },
+        { key: { code: 1 }, unique: true, name: "unique_code" }
+      ]);
+    } catch (error) {
+      throw new Error("Failed to create index on PSGC.");
+    }
+  }
+  function delCachedData() {
+    delNamespace().then(() => {
+      import_nodejs_utils39.logger.log({
+        level: "info",
+        message: `Cache namespace cleared for ${namespace_collection}`
+      });
+    }).catch((err) => {
+      import_nodejs_utils39.logger.log({
+        level: "error",
+        message: `Failed to clear cache namespace for ${namespace_collection}: ${err.message}`
+      });
+    });
+  }
+  async function add(value, session) {
+    try {
+      value = modelPSGC(value);
+      const res = await collection.insertOne(value, { session });
+      delCachedData();
+      return res.insertedId;
+    } catch (error) {
+      import_nodejs_utils39.logger.log({
+        level: "error",
+        message: error.message
+      });
+      if (error instanceof import_nodejs_utils39.AppError) {
+        throw error;
+      } else {
+        const isDuplicated = error.message.includes("duplicate");
+        if (isDuplicated) {
+          throw new import_nodejs_utils39.BadRequestError("Region already exists.");
+        }
+        throw new Error("Failed to create PSGC.");
+      }
+    }
+  }
+  async function getAll({
+    search = "",
+    page = 1,
+    limit = 10,
+    sort = {},
+    type = "",
+    prefix = ""
+  } = {}) {
+    page = page > 0 ? page - 1 : 0;
+    const query = {
+      type
+    };
+    const cacheKeyOptions = {
+      type,
+      page,
+      limit,
+      sort: JSON.stringify(sort)
+    };
+    if (prefix) {
+      query.code = { $regex: `^${prefix}` };
+      cacheKeyOptions.prefix = prefix;
+    }
+    if (type === "City" || type === "Mun") {
+      query.type = { $in: ["City", "Mun"] };
+    }
+    sort = Object.keys(sort).length > 0 ? sort : { _id: 1 };
+    if (search) {
+      query.$text = { $search: search };
+      cacheKeyOptions.search = search;
+    }
+    const cacheKey = (0, import_nodejs_utils39.makeCacheKey)(namespace_collection, cacheKeyOptions);
+    import_nodejs_utils39.logger.log({
+      level: "info",
+      message: `Cache key for getAll PSGC: ${cacheKey}`
+    });
+    try {
+      const cached = await getCache(cacheKey);
+      if (cached) {
+        import_nodejs_utils39.logger.log({
+          level: "info",
+          message: `Cache hit for getAll PSGC: ${cacheKey}`
+        });
+        return cached;
+      }
+      const items = await collection.aggregate([
+        { $match: query },
+        { $sort: sort },
+        { $skip: page * limit },
+        { $limit: limit }
+      ]).toArray();
+      const length = await collection.countDocuments(query);
+      const data = (0, import_nodejs_utils39.paginate)(items, page, limit, length);
+      setCache(cacheKey, data, 600).then(() => {
+        import_nodejs_utils39.logger.log({
+          level: "info",
+          message: `Cache set for getAll PSGC: ${cacheKey}`
+        });
+      }).catch((err) => {
+        import_nodejs_utils39.logger.log({
+          level: "error",
+          message: `Failed to set cache for getAll PSGC: ${err.message}`
+        });
+      });
+      return data;
+    } catch (error) {
+      import_nodejs_utils39.logger.log({ level: "error", message: `${error}` });
+      throw error;
+    }
+  }
+  async function getById(_id) {
+    try {
+      _id = new import_mongodb21.ObjectId(_id);
+    } catch (error) {
+      throw new import_nodejs_utils39.BadRequestError("Invalid ID.");
+    }
+    const cacheKey = (0, import_nodejs_utils39.makeCacheKey)(namespace_collection, { _id: String(_id) });
+    try {
+      const cached = await getCache(cacheKey);
+      if (cached) {
+        import_nodejs_utils39.logger.log({
+          level: "info",
+          message: `Cache hit for getById PSGC: ${cacheKey}`
+        });
+        return cached;
+      }
+      const result = await collection.findOne({
+        _id,
+        deletedAt: { $in: ["", null] }
+      });
+      if (!result) {
+        throw new import_nodejs_utils39.BadRequestError("Region not found.");
+      }
+      setCache(cacheKey, result, 300).then(() => {
+        import_nodejs_utils39.logger.log({
+          level: "info",
+          message: `Cache set for PSGC by id: ${cacheKey}`
+        });
+      }).catch((err) => {
+        import_nodejs_utils39.logger.log({
+          level: "error",
+          message: `Failed to set cache for PSGC by id: ${err.message}`
+        });
+      });
+      return result;
+    } catch (error) {
+      if (error instanceof import_nodejs_utils39.AppError) {
+        throw error;
+      } else {
+        throw new import_nodejs_utils39.InternalServerError("Failed to get PSGC.");
+      }
+    }
+  }
+  async function getByName({ name, prefix = "", type = "" } = {}) {
+    const query = { $text: { $search: name } };
+    const cacheKeyOptions = { name };
+    if (["City", "Mun"].includes(type)) {
+      query.type = { $in: ["City", "Mun"] };
+      cacheKeyOptions.type = type;
+    }
+    if (prefix) {
+      query.code = { $regex: `^${prefix}` };
+      cacheKeyOptions.prefix = prefix;
+    }
+    const cacheKey = (0, import_nodejs_utils39.makeCacheKey)(namespace_collection, { name });
+    try {
+      const cached = await getCache(cacheKey);
+      if (cached) {
+        import_nodejs_utils39.logger.log({
+          level: "info",
+          message: `Cache hit for getByName PSGC: ${cacheKey}`
+        });
+        return cached;
+      }
+      const result = await collection.findOne(query);
+      setCache(cacheKey, result, 300).then(() => {
+        import_nodejs_utils39.logger.log({
+          level: "info",
+          message: `Cache set for PSGC by name: ${cacheKey}`
+        });
+      }).catch((err) => {
+        import_nodejs_utils39.logger.log({
+          level: "error",
+          message: `Failed to set cache for PSGC by name: ${err.message}`
+        });
+      });
+      return result;
+    } catch (error) {
+      if (error instanceof import_nodejs_utils39.AppError) {
+        throw error;
+      } else {
+        throw new import_nodejs_utils39.InternalServerError("Failed to get PSGC.");
+      }
+    }
+  }
+  async function updateFieldById({ _id, field, value } = {}, session) {
+    const allowedFields = ["name"];
+    if (!allowedFields.includes(field)) {
+      throw new import_nodejs_utils39.BadRequestError(
+        `Field "${field}" is not allowed to be updated.`
+      );
+    }
+    try {
+      _id = new import_mongodb21.ObjectId(_id);
+    } catch (error) {
+      throw new import_nodejs_utils39.BadRequestError("Invalid ID.");
+    }
+    try {
+      await collection.updateOne(
+        { _id, deletedAt: { $in: ["", null] } },
+        { $set: { [field]: value, updatedAt: (/* @__PURE__ */ new Date()).toISOString() } },
+        { session }
+      );
+      delCachedData();
+      return `Successfully updated PSGC ${field}.`;
+    } catch (error) {
+      throw new import_nodejs_utils39.InternalServerError(`Failed to update PSGC ${field}.`);
+    }
+  }
+  async function deleteById(_id) {
+    try {
+      _id = new import_mongodb21.ObjectId(_id);
+    } catch (error) {
+      throw new import_nodejs_utils39.BadRequestError("Invalid ID.");
+    }
+    try {
+      await collection.updateOne(
+        { _id },
+        { $set: { status: "deleted", deletedAt: (/* @__PURE__ */ new Date()).toISOString() } }
+      );
+      delCachedData();
+      return "Successfully deleted PSGC.";
+    } catch (error) {
+      throw new import_nodejs_utils39.InternalServerError("Failed to delete PSGC.");
+    }
+  }
+  return {
+    createIndexes,
+    add,
+    getAll,
+    getById,
+    updateFieldById,
+    deleteById,
+    getByName
+  };
+}
+
+// src/resources/psgc/psgc.controller.ts
+var import_nodejs_utils40 = require("@eeplatform/nodejs-utils");
+var import_joi19 = __toESM(require("joi"));
+function usePSGCController() {
+  const {
+    add: _add,
+    getAll: _getAll,
+    getById: _getById,
+    getByName: _getByName,
+    updateFieldById: _updateFieldById,
+    deleteById: _deleteById
+  } = usePSGCRepo();
+  async function add(req, res, next) {
+    const value = req.body;
+    const { error } = schemaPSGC.validate(value);
+    if (error) {
+      next(new import_nodejs_utils40.BadRequestError(error.message));
+      return;
+    }
+    try {
+      const data = await _add(value);
+      res.json({
+        message: "Successfully created region.",
+        data
+      });
+      return;
+    } catch (error2) {
+      next(error2);
+    }
+  }
+  async function getAll(req, res, next) {
+    const query = req.query;
+    const validation = import_joi19.default.object({
+      page: import_joi19.default.number().min(1).optional().allow("", null),
+      limit: import_joi19.default.number().min(1).optional().allow("", null),
+      search: import_joi19.default.string().optional().allow("", null),
+      type: import_joi19.default.string().valid("Reg", "Prov", "City", "Mun", "Bgy").required(),
+      prefix: import_joi19.default.string().optional().allow("", null)
+    });
+    const { error } = validation.validate(query);
+    const page = typeof req.query.page === "string" ? Number(req.query.page) : 1;
+    const limit = typeof req.query.limit === "string" ? Number(req.query.limit) : 10;
+    const search = req.query.search ?? "";
+    const type = req.query.type ?? "";
+    const prefix = req.query.prefix ? String(req.query.prefix) : "";
+    const isPageNumber = isFinite(page);
+    if (!isPageNumber) {
+      next(new import_nodejs_utils40.BadRequestError("Invalid page number."));
+      return;
+    }
+    const isLimitNumber = isFinite(limit);
+    if (!isLimitNumber) {
+      next(new import_nodejs_utils40.BadRequestError("Invalid limit number."));
+      return;
+    }
+    if (error) {
+      next(new import_nodejs_utils40.BadRequestError(error.message));
+      return;
+    }
+    try {
+      const data = await _getAll({
+        page,
+        limit,
+        search,
+        type,
+        prefix
+      });
+      res.json(data);
+      return;
+    } catch (error2) {
+      next(error2);
+    }
+  }
+  async function getById(req, res, next) {
+    const id = req.params.id;
+    const validation = import_joi19.default.object({
+      id: import_joi19.default.string().hex().required()
+    });
+    const { error } = validation.validate({ id });
+    if (error) {
+      next(new import_nodejs_utils40.BadRequestError(error.message));
+      return;
+    }
+    try {
+      const data = await _getById(id);
+      res.json({
+        message: "Successfully retrieved region.",
+        data
+      });
+      return;
+    } catch (error2) {
+      next(error2);
+    }
+  }
+  async function getByName(req, res, next) {
+    const name = req.params.name;
+    const validation = import_joi19.default.object({
+      name: import_joi19.default.string().required()
+    });
+    const { error } = validation.validate({ name });
+    if (error) {
+      next(new import_nodejs_utils40.BadRequestError(error.message));
+      return;
+    }
+    try {
+      const data = await _getByName({ name });
+      res.json({
+        message: "Successfully retrieved region.",
+        data
+      });
+      return;
+    } catch (error2) {
+      next(error2);
+    }
+  }
+  async function updateField(req, res, next) {
+    const _id = req.params.id;
+    const { field, value } = req.body;
+    const validation = import_joi19.default.object({
+      _id: import_joi19.default.string().hex().required(),
+      field: import_joi19.default.string().valid("name", "director", "directorName").required(),
+      value: import_joi19.default.string().required()
+    });
+    const { error } = validation.validate({ _id, field, value });
+    if (error) {
+      next(new import_nodejs_utils40.BadRequestError(error.message));
+      return;
+    }
+    try {
+      const message = await _updateFieldById({ _id, field, value });
+      res.json({ message });
+      return;
+    } catch (error2) {
+      next(error2);
+    }
+  }
+  async function deleteById(req, res, next) {
+    const _id = req.params.id;
+    const validation = import_joi19.default.object({
+      _id: import_joi19.default.string().hex().required()
+    });
+    const { error } = validation.validate({ _id });
+    if (error) {
+      next(new import_nodejs_utils40.BadRequestError(error.message));
+      return;
+    }
+    try {
+      const message = await _deleteById(_id);
+      res.json({ message });
+      return;
+    } catch (error2) {
+      next(error2);
+    }
+  }
+  return {
+    add,
+    getAll,
+    getById,
+    getByName,
+    updateField,
+    deleteById
+  };
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ACCESS_TOKEN_EXPIRY,
@@ -7074,9 +7524,11 @@ var transactionSchema = import_joi17.default.object({
   XENDIT_SECRET_KEY,
   addressSchema,
   isDev,
+  modelPSGC,
   schemaBuilding,
   schemaBuildingUnit,
   schemaOrg,
+  schemaPSGC,
   schemaUpdateOptions,
   transactionSchema,
   useAddressController,
@@ -7102,6 +7554,8 @@ var transactionSchema = import_joi17.default.object({
   useOrgController,
   useOrgRepo,
   useOrgService,
+  usePSGCController,
+  usePSGCRepo,
   useRoleController,
   useRoleRepo,
   useTokenRepo,