@goweekdays/core 2.7.0 → 2.8.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @goweekdays/core
 
+## 2.8.0
+
+### Minor Changes
+
+- baa7fed: Add ledger billing summary with org and status filter
+
 ## 2.7.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -1047,7 +1047,7 @@ type TLedgerBill = {
     description: string;
     amount: number;
     currency: string;
-    status: "pending" | "completed" | "overdue";
+    status: "pending" | "paid" | "overdue";
     billingFrom?: string | Date;
     billingTo?: string | Date;
     paidAt?: string | Date;
@@ -1057,6 +1057,7 @@ type TLedgerBill = {
 declare const ledgerBillTypes: string[];
 declare const ledgerBillStatuses: string[];
 declare const schemaLedgerBill: Joi.ObjectSchema<any>;
+declare const schemaLedgerBillingSummary: Joi.ObjectSchema<any>;
 declare function modelLedgerBill(value: TLedgerBill): TLedgerBill;
 
 declare function useLedgerBillingRepo(): {
@@ -1071,11 +1072,13 @@ declare function useLedgerBillingRepo(): {
         status?: string | undefined;
     }) => Promise<Record<string, any>>;
     getById: (_id: string | ObjectId) => Promise<TLedgerBill | null>;
+    getSummary: (status: string, org: string | ObjectId) => Promise<bson.Document>;
 };
 
 declare function useLedgerBillingController(): {
     getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     getById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getSummary: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
 declare const MONGO_URI: string;
@@ -1117,4 +1120,4 @@ declare const XENDIT_BASE_URL: string;
 declare const DOMAIN: string;
 declare const APP_ORG: string;
 
-export { ACCESS_TOKEN_EXPIRY, ACCESS_TOKEN_SECRET, APP_ACCOUNT, APP_MAIN, APP_ORG, DEFAULT_USER_EMAIL, DEFAULT_USER_FIRST_NAME, DEFAULT_USER_LAST_NAME, DEFAULT_USER_PASSWORD, DOMAIN, MAILER_EMAIL, MAILER_PASSWORD, MAILER_TRANSPORT_HOST, MAILER_TRANSPORT_PORT, MAILER_TRANSPORT_SECURE, MBuilding, MBuildingUnit, MFile, MONGO_DB, MONGO_URI, PAYPAL_API_URL, PAYPAL_CLIENT_ID, PAYPAL_CLIENT_SECRET, PAYPAL_WEBHOOK_ID, 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, TApp, TBuilding, TBuildingUnit, TCounter, TFile, TJobPost, TLedgerBill, TMember, TOrg, TPermission, TPermissionGroup, TPlan, TPromo, TRole, TSubscription, TSubscriptionTransaction, TUser, TVerification, TVerificationMetadata, VERIFICATION_FORGET_PASSWORD_DURATION, VERIFICATION_USER_INVITE_DURATION, XENDIT_BASE_URL, XENDIT_SECRET_KEY, currencies, isDev, ledgerBillStatuses, ledgerBillTypes, modelApp, modelJobPost, modelLedgerBill, modelMember, modelOrg, modelPermission, modelPermissionGroup, modelPlan, modelPromo, modelRole, modelSubscription, modelSubscriptionTransaction, modelUser, modelVerification, schemaApp, schemaAppUpdate, schemaBuilding, schemaBuildingUnit, schemaInviteMember, schemaJobPost, schemaLedgerBill, schemaMember, schemaMemberRole, schemaMemberStatus, schemaOrg, schemaOrgAdd, schemaOrgUpdate, schemaPermission, schemaPermissionGroup, schemaPermissionGroupUpdate, schemaPermissionUpdate, schemaPlan, schemaPromo, schemaRole, schemaRoleUpdate, schemaSubscription, schemaSubscriptionSeats, schemaSubscriptionTransaction, schemaSubscriptionUpdate, schemaUpdateOptions, schemaUser, schemaVerification, transactionSchema, useAppController, useAppRepo, useAppService, useAuthController, useAuthService, useBuildingController, useBuildingRepo, useBuildingService, useBuildingUnitController, useBuildingUnitRepo, useBuildingUnitService, useCounterModel, useCounterRepo, useFileController, useFileRepo, useFileService, useGitHubService, useJobPostController, useJobPostRepo, useJobPostService, useLedgerBillingController, useLedgerBillingRepo, useMemberController, useMemberRepo, useOrgController, useOrgRepo, useOrgService, usePermissionController, usePermissionGroupController, usePermissionGroupRepo, usePermissionGroupService, usePermissionRepo, usePermissionService, usePlanController, usePlanRepo, usePlanService, usePromoRepo, useRoleController, useRoleRepo, useRoleService, useSubscriptionController, useSubscriptionRepo, useSubscriptionTransactionController, useSubscriptionTransactionRepo, useUserController, useUserRepo, useUserService, useUtilController, useVerificationController, useVerificationRepo, useVerificationService };
+export { ACCESS_TOKEN_EXPIRY, ACCESS_TOKEN_SECRET, APP_ACCOUNT, APP_MAIN, APP_ORG, DEFAULT_USER_EMAIL, DEFAULT_USER_FIRST_NAME, DEFAULT_USER_LAST_NAME, DEFAULT_USER_PASSWORD, DOMAIN, MAILER_EMAIL, MAILER_PASSWORD, MAILER_TRANSPORT_HOST, MAILER_TRANSPORT_PORT, MAILER_TRANSPORT_SECURE, MBuilding, MBuildingUnit, MFile, MONGO_DB, MONGO_URI, PAYPAL_API_URL, PAYPAL_CLIENT_ID, PAYPAL_CLIENT_SECRET, PAYPAL_WEBHOOK_ID, 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, TApp, TBuilding, TBuildingUnit, TCounter, TFile, TJobPost, TLedgerBill, TMember, TOrg, TPermission, TPermissionGroup, TPlan, TPromo, TRole, TSubscription, TSubscriptionTransaction, TUser, TVerification, TVerificationMetadata, VERIFICATION_FORGET_PASSWORD_DURATION, VERIFICATION_USER_INVITE_DURATION, XENDIT_BASE_URL, XENDIT_SECRET_KEY, currencies, isDev, ledgerBillStatuses, ledgerBillTypes, modelApp, modelJobPost, modelLedgerBill, modelMember, modelOrg, modelPermission, modelPermissionGroup, modelPlan, modelPromo, modelRole, modelSubscription, modelSubscriptionTransaction, modelUser, modelVerification, schemaApp, schemaAppUpdate, schemaBuilding, schemaBuildingUnit, schemaInviteMember, schemaJobPost, schemaLedgerBill, schemaLedgerBillingSummary, schemaMember, schemaMemberRole, schemaMemberStatus, schemaOrg, schemaOrgAdd, schemaOrgUpdate, schemaPermission, schemaPermissionGroup, schemaPermissionGroupUpdate, schemaPermissionUpdate, schemaPlan, schemaPromo, schemaRole, schemaRoleUpdate, schemaSubscription, schemaSubscriptionSeats, schemaSubscriptionTransaction, schemaSubscriptionUpdate, schemaUpdateOptions, schemaUser, schemaVerification, transactionSchema, useAppController, useAppRepo, useAppService, useAuthController, useAuthService, useBuildingController, useBuildingRepo, useBuildingService, useBuildingUnitController, useBuildingUnitRepo, useBuildingUnitService, useCounterModel, useCounterRepo, useFileController, useFileRepo, useFileService, useGitHubService, useJobPostController, useJobPostRepo, useJobPostService, useLedgerBillingController, useLedgerBillingRepo, useMemberController, useMemberRepo, useOrgController, useOrgRepo, useOrgService, usePermissionController, usePermissionGroupController, usePermissionGroupRepo, usePermissionGroupService, usePermissionRepo, usePermissionService, usePlanController, usePlanRepo, usePlanService, usePromoRepo, useRoleController, useRoleRepo, useRoleService, useSubscriptionController, useSubscriptionRepo, useSubscriptionTransactionController, useSubscriptionTransactionRepo, useUserController, useUserRepo, useUserService, useUtilController, useVerificationController, useVerificationRepo, useVerificationService };

package/dist/index.js

@@ -95,6 +95,7 @@ __export(src_exports, {
   schemaInviteMember: () => schemaInviteMember,
   schemaJobPost: () => schemaJobPost,
   schemaLedgerBill: () => schemaLedgerBill,
+  schemaLedgerBillingSummary: () => schemaLedgerBillingSummary,
   schemaMember: () => schemaMember,
   schemaMemberRole: () => schemaMemberRole,
   schemaMemberStatus: () => schemaMemberStatus,
@@ -6761,7 +6762,7 @@ var import_utils38 = require("@goweekdays/utils");
 var import_joi29 = __toESM(require("joi"));
 var import_mongodb20 = require("mongodb");
 var ledgerBillTypes = ["setup-fee", "subscription"];
-var ledgerBillStatuses = ["pending", "completed", "overdue"];
+var ledgerBillStatuses = ["pending", "paid", "overdue"];
 var schemaLedgerBill = import_joi29.default.object({
   org: import_joi29.default.string().hex().length(24).required(),
   type: import_joi29.default.string().valid(...ledgerBillTypes).required(),
@@ -6774,6 +6775,10 @@ var schemaLedgerBill = import_joi29.default.object({
   paidAt: import_joi29.default.date().optional().allow("", null),
   dueDate: import_joi29.default.date().optional().allow("", null)
 });
+var schemaLedgerBillingSummary = import_joi29.default.object({
+  status: import_joi29.default.string().valid(...ledgerBillStatuses).required(),
+  org: import_joi29.default.string().hex().length(24).required()
+});
 function modelLedgerBill(value) {
   const { error } = schemaLedgerBill.validate(value);
   if (error) {
@@ -6957,12 +6962,59 @@ function useLedgerBillingRepo() {
       throw new import_utils39.InternalServerError("Failed to get ledger billing.");
     }
   }
+  async function getSummary(status, org) {
+    const { error } = schemaLedgerBillingSummary.validate({ status, org });
+    if (error) {
+      throw new Error(`Invalid ledger billing ID: ${error.message}`);
+    }
+    try {
+      org = new import_mongodb21.ObjectId(org);
+    } catch (error2) {
+      throw new import_utils39.BadRequestError("Invalid ledger billing org.");
+    }
+    try {
+      const cacheKey = (0, import_utils39.makeCacheKey)(namespace_collection, {
+        org: String(org),
+        status,
+        tag: "getSummaryByOrgStatus"
+      });
+      const cachedData = await getCache(cacheKey);
+      if (cachedData) {
+        return cachedData;
+      }
+      const data = await collection.aggregate([
+        { $match: { org, status } },
+        {
+          $group: {
+            _id: "$status",
+            totalAmount: { $sum: "$amount" },
+            count: { $sum: 1 }
+          }
+        }
+      ]).toArray();
+      setCache(cacheKey, data[0]).then(() => {
+        import_utils39.logger.log({
+          level: "info",
+          message: `Cache set for ledger billing summary: ${cacheKey}`
+        });
+      }).catch((err) => {
+        import_utils39.logger.log({
+          level: "error",
+          message: `Failed to set cache for ledger billing summary: ${err.message}`
+        });
+      });
+      return data[0];
+    } catch (error2) {
+      throw new import_utils39.InternalServerError("Failed to get ledger billing summary.");
+    }
+  }
   return {
     delCachedData,
     createIndexes,
     add,
     getAll,
-    getById
+    getById,
+    getSummary
   };
 }
 
@@ -6970,7 +7022,11 @@ function useLedgerBillingRepo() {
 var import_joi31 = __toESM(require("joi"));
 var import_utils40 = require("@goweekdays/utils");
 function useLedgerBillingController() {
-  const { getAll: _getAll, getById: _getById } = useLedgerBillingRepo();
+  const {
+    getAll: _getAll,
+    getById: _getById,
+    getSummary: _getSummary
+  } = useLedgerBillingRepo();
   async function getAll(req, res, next) {
     const query = req.query;
     const validation = import_joi31.default.object({
@@ -7026,9 +7082,27 @@ function useLedgerBillingController() {
       next(error2);
     }
   }
+  async function getSummary(req, res, next) {
+    const params = req.params;
+    const { error } = schemaLedgerBillingSummary.validate(params);
+    const org = req.params.org ?? "";
+    const status = req.params.status ?? "";
+    if (error) {
+      next(new import_utils40.BadRequestError(error.message));
+      return;
+    }
+    try {
+      const summary = await _getSummary(status, org);
+      res.json(summary);
+      return;
+    } catch (error2) {
+      next(error2);
+    }
+  }
   return {
     getAll,
-    getById
+    getById,
+    getSummary
   };
 }
 
@@ -7245,7 +7319,7 @@ function useOrgService() {
           description: "Setup payment during organization creation",
           currency: plan.currency,
           type: "setup-fee",
-          status: "completed"
+          status: "paid"
         },
         session
       );
@@ -10946,6 +11020,7 @@ function useJobPostController() {
   schemaInviteMember,
   schemaJobPost,
   schemaLedgerBill,
+  schemaLedgerBillingSummary,
   schemaMember,
   schemaMemberRole,
   schemaMemberStatus,