@goweekdays/core 2.8.0 → 2.10.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @goweekdays/core
 
+## 2.10.0
+
+### Minor Changes
+
+- d140abc: Add promo usage tracking
+
+## 2.9.0
+
+### Minor Changes
+
+- acc15de: Subscription initial release with full lifecycle support
+
 ## 2.8.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import * as mongodb from 'mongodb';
 import { ObjectId, ClientSession, Db, Collection } from 'mongodb';
 import * as bson from 'bson';
 import { z } from 'zod';
+import * as _paypal_paypal_server_sdk from '@paypal/paypal-server-sdk';
 
 declare function useAuthService(): {
     login: ({ email, password }?: {
@@ -342,6 +343,7 @@ declare function useMemberRepo(): {
     }, session?: ClientSession) => Promise<string>;
     updateStatusById: (_id: string | ObjectId, status: string, session?: ClientSession) => Promise<string>;
     deleteById: (_id: string | ObjectId, session?: ClientSession) => Promise<string>;
+    updateStatusByOrg: (org: string | ObjectId, status: string, session?: ClientSession) => Promise<string>;
 };
 
 declare function useMemberController(): {
@@ -364,6 +366,7 @@ type TOrg = {
     email: string;
     contact?: string;
     createdBy: string | ObjectId;
+    promoCode?: string;
     status?: string;
     createdAt?: string | Date;
     updatedAt?: string | Date;
@@ -394,6 +397,7 @@ declare function useOrgRepo(): {
     getByName: (name: string) => Promise<TOrg | null>;
     getByEmail: (email: string) => Promise<TOrg | null>;
     updateById: (_id: string | ObjectId, options: Pick<TOrg, "name" | "description" | "email" | "contact">) => Promise<void>;
+    updateStatusById: (_id: string | ObjectId, status: string, session?: ClientSession) => Promise<string>;
 };
 
 declare function useOrgService(): {
@@ -418,8 +422,7 @@ declare function useOrgController(): {
 type TPromo = {
     _id?: ObjectId;
     code: string;
-    description?: string;
-    type: "flat" | "fixed" | "tiered";
+    type: "flat" | "fixed" | "volume";
     flatRate?: number;
     fixedRate?: number;
     tiers?: Array<{
@@ -428,11 +431,12 @@ type TPromo = {
         rate: number;
     }>;
     currency: string;
-    startDate: Date | string;
+    startDate?: Date | string;
     endDate?: Date | string;
-    assignedTo?: string | ObjectId;
-    status: "active" | "inactive" | "expired";
-    assignedAt?: Date | string;
+    apps?: string[];
+    seats?: number;
+    usage?: number;
+    status?: "active" | "inactive" | "expired";
     createdAt?: Date | string;
     updatedAt?: Date | string;
     deletedAt?: Date | string;
@@ -451,9 +455,19 @@ declare function usePromoRepo(): {
     }) => Promise<TPaginate<TPromo>>;
     getByCode: (code: string) => Promise<TPromo | null>;
     getById: (_id: string | ObjectId) => Promise<TPromo | null>;
+    updateById: (_id: string | ObjectId, options: Pick<TPromo, "code" | "apps" | "type" | "flatRate" | "fixedRate" | "tiers" | "currency" | "startDate" | "endDate" | "seats" | "usage">) => Promise<string>;
     deleteById: (_id: string | ObjectId) => Promise<string>;
 };
 
+declare function usePromoController(): {
+    add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getByCode: (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 TRole = {
     _id?: ObjectId;
     id?: string | ObjectId;
@@ -637,6 +651,35 @@ declare function useUtilController(): {
 
 declare const transactionSchema: Joi.ObjectSchema<any>;
 
+interface PaypalWebhookHeaders {
+    "paypal-auth-algo"?: string;
+    "paypal-cert-url": string;
+    "paypal-transmission-id": string;
+    "paypal-transmission-sig": string;
+    "paypal-transmission-time": string;
+}
+declare function usePaypalService(): {
+    addOrder: ({ amount, currency, customId, returnUrl, cancelUrl, action, }?: {
+        amount?: number | undefined;
+        currency?: string | undefined;
+        customId?: string | undefined;
+        returnUrl?: string | undefined;
+        cancelUrl?: string | undefined;
+        action?: string | undefined;
+    }) => Promise<_paypal_paypal_server_sdk.ApiResponse<_paypal_paypal_server_sdk.Order>>;
+    captureOrder: (id: string) => Promise<_paypal_paypal_server_sdk.ApiResponse<_paypal_paypal_server_sdk.Order>>;
+    verifySignature: (rawBody: Buffer | string, headers: PaypalWebhookHeaders, webhookId?: string) => Promise<boolean>;
+    createInvoice: (value: {
+        email: string;
+        amount: number;
+        currency: string;
+        note?: string;
+        title: string;
+        dueDate?: string;
+    }) => Promise<any>;
+    sendInvoice: (invoiceId: string) => Promise<any>;
+};
+
 type TVerificationMetadata = {
     name?: string;
     app?: string;
@@ -794,6 +837,7 @@ type TSubscription = {
     currency: string;
     billingCycle: "monthly" | "yearly";
     promoCode?: string;
+    retry?: number;
     status?: string;
     nextBillingDate: Date | string;
     createdAt?: Date | string;
@@ -817,11 +861,17 @@ declare function useSubscriptionRepo(): {
     getById: (_id: string | ObjectId) => Promise<TSubscription | null>;
     deleteById: (_id: string | ObjectId) => Promise<string>;
     updateById: (_id: string | ObjectId, options: {
-        seats: number;
+        seats?: number;
         paidSeats?: number;
         amount?: number;
         promoCode?: string;
+        status?: string;
+        nextBillingDate?: Date;
     }, session?: ClientSession) => Promise<string>;
+    getByStatus: (status?: string, limit?: number, retry?: number) => Promise<TSubscription[]>;
+    updateStatusById: (_id: string | ObjectId, status: string, session?: ClientSession) => Promise<string>;
+    updateRetryById: (_id: string | ObjectId, retry: number, session?: ClientSession) => Promise<string>;
+    getOverdueForSuspension: (limit?: number, daysOverdue?: number) => Promise<TSubscription[]>;
 };
 
 declare function useSubscriptionController(): {
@@ -831,6 +881,20 @@ declare function useSubscriptionController(): {
     updateSeats: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
+declare function useSubscriptionService(): {
+    updateSeats: ({ id, user, amount, seats, }?: {
+        id?: string | undefined;
+        user?: string | undefined;
+        amount?: number | undefined;
+        seats?: number | undefined;
+    }) => Promise<string>;
+    processInvoices: () => Promise<void>;
+    processSuspensions: () => Promise<void>;
+    scheduleInvoiceProcessing: () => void;
+    scheduleSuspensionProcessing: () => void;
+    processPaidInvoice: (invoiceId: string) => Promise<string>;
+};
+
 type TSubscriptionTransaction = {
     _id?: ObjectId;
     subscription: string | ObjectId;
@@ -1023,17 +1087,46 @@ type TJobPost = {
     deletedAt?: Date;
 };
 declare const schemaJobPost: Joi.ObjectSchema<any>;
+declare const schemaJobPostUpdate: Joi.ObjectSchema<any>;
 declare function modelJobPost(value: TJobPost): TJobPost;
 
 declare function useJobPostController(): {
     add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getJobPostsByOrg: (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>;
+    updateStatusById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
 declare function useJobPostRepo(): {
     createIndexes: () => Promise<string>;
     add: (value: TJobPost, session?: ClientSession) => Promise<ObjectId>;
+    getAll: ({ search, page, limit, status, }?: {
+        search?: string | undefined;
+        page?: number | undefined;
+        limit?: number | undefined;
+        status?: string | undefined;
+    }) => Promise<Record<string, any>>;
+    getJobPostsByOrg: ({ search, page, limit, org, status, }?: {
+        org: string | ObjectId;
+        page: number;
+        limit?: number | undefined;
+        search?: string | undefined;
+        status?: string | undefined;
+    }) => Promise<{
+        items: any[];
+        pages: number;
+        pageRange: string;
+    } | {
+        _id: ObjectId;
+        name: string;
+    }[]>;
+    getById: (_id: string | ObjectId) => Promise<TJobPost>;
+    updateById: (_id: string | ObjectId, options: Pick<TJobPost, "title" | "setup" | "location" | "type" | "description">) => Promise<string>;
     deleteById: (_id: string | ObjectId, session?: ClientSession) => Promise<string>;
+    updateStatusById: (_id: string | ObjectId, status: string) => Promise<string>;
 };
 
 declare function useJobPostService(): {
@@ -1050,6 +1143,8 @@ type TLedgerBill = {
     status: "pending" | "paid" | "overdue";
     billingFrom?: string | Date;
     billingTo?: string | Date;
+    payerViewUrl?: string;
+    invoice?: string;
     paidAt?: string | Date;
     dueDate?: string | Date;
     createdAt?: string | Date;
@@ -1072,7 +1167,9 @@ declare function useLedgerBillingRepo(): {
         status?: string | undefined;
     }) => Promise<Record<string, any>>;
     getById: (_id: string | ObjectId) => Promise<TLedgerBill | null>;
+    getByInvoice: (invoice: string) => Promise<TLedgerBill | null>;
     getSummary: (status: string, org: string | ObjectId) => Promise<bson.Document>;
+    updateStatusById: (_id: string | ObjectId, status: string, session?: ClientSession) => Promise<boolean>;
 };
 
 declare function useLedgerBillingController(): {
@@ -1120,4 +1217,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, 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 };
+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, PaypalWebhookHeaders, 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, schemaJobPostUpdate, 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, usePaypalService, usePermissionController, usePermissionGroupController, usePermissionGroupRepo, usePermissionGroupService, usePermissionRepo, usePermissionService, usePlanController, usePlanRepo, usePlanService, usePromoController, usePromoRepo, useRoleController, useRoleRepo, useRoleService, useSubscriptionController, useSubscriptionRepo, useSubscriptionService, useSubscriptionTransactionController, useSubscriptionTransactionRepo, useUserController, useUserRepo, useUserService, useUtilController, useVerificationController, useVerificationRepo, useVerificationService };