@goweekdays/core 2.3.1 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @goweekdays/core
 
+## 2.4.0
+
+### Minor Changes
+
+- ee525e1: Add plan, promo, and subscription modules
+
 ## 2.3.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -390,7 +390,7 @@ type TOrg = {
     _id?: ObjectId;
     name: string;
     description?: string;
-    email?: string;
+    email: string;
     contact?: string;
     createdBy: string | ObjectId;
     status?: string;
@@ -399,6 +399,8 @@ type TOrg = {
     deletedAt?: string | Date;
 };
 declare const schemaOrg: Joi.ObjectSchema<any>;
+declare const schemaOrgAdd: Joi.ObjectSchema<any>;
+declare const schemaOrgUpdate: Joi.ObjectSchema<any>;
 declare function modelOrg(value: TOrg): TOrg;
 
 declare function useOrgRepo(): {
@@ -419,10 +421,13 @@ declare function useOrgRepo(): {
     }, session?: ClientSession) => Promise<string>;
     deleteById: (_id: string | ObjectId) => Promise<string>;
     getByName: (name: string) => Promise<TOrg>;
+    updateById: (_id: string | ObjectId, options: Pick<TOrg, "name" | "description" | "email" | "contact">) => Promise<void>;
 };
 
 declare function useOrgService(): {
-    add: (value: TOrg) => Promise<string>;
+    add: (value: TOrg & {
+        seats: number;
+    }) => Promise<string>;
 };
 
 declare function useOrgController(): {
@@ -431,6 +436,7 @@ declare function useOrgController(): {
     getByName: (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>;
 };
 
 type TPSGC = {
@@ -757,6 +763,122 @@ declare function useVerificationController(): {
     forgetPassword: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
+type TPlan = {
+    _id?: ObjectId;
+    name: string;
+    description?: string;
+    features?: string[];
+    price: number;
+    currency: string;
+    billingCycle: "monthly" | "yearly";
+    default?: boolean;
+    status?: "active" | "inactive";
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+};
+declare const currencies: string[];
+declare const schemaPlan: Joi.ObjectSchema<any>;
+declare function modelPlan(data: any): TPlan;
+
+declare function usePlanRepo(): {
+    add: (value: TPlan) => Promise<string>;
+    getAll: ({ page, limit, search, status, }?: {
+        page?: number | undefined;
+        limit?: number | undefined;
+        search?: string | undefined;
+        status?: string | undefined;
+    }) => Promise<TPaginate<TPlan>>;
+    getById: (_id: string | ObjectId) => Promise<TPlan | null>;
+    getDefault: () => Promise<TPlan | null>;
+    deleteById: (_id: string | ObjectId) => Promise<string>;
+};
+
+declare function usePlanService(): {
+    addDefaultPlan: () => Promise<void>;
+};
+
+declare function usePlanController(): {
+    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>;
+    deleteById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getDefault: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
+type TSubscription = {
+    _id?: ObjectId;
+    org: string | ObjectId;
+    seats: number;
+    paidSeats: number;
+    amount: number;
+    currency: string;
+    billingCycle: "monthly" | "yearly";
+    promoCode?: string;
+    status?: string;
+    nextBillingDate: Date | string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+};
+declare const schemaSubscription: Joi.ObjectSchema<any>;
+declare const schemaSubscriptionUpdate: Joi.ObjectSchema<any>;
+declare const schemaSubscriptionSeats: Joi.ObjectSchema<any>;
+declare function modelSubscription(data: any): TSubscription;
+
+declare function useSubscriptionRepo(): {
+    add: (value: TSubscription, session?: ClientSession) => Promise<string>;
+    getAll: ({ page, limit, search, status, }?: {
+        page?: number | undefined;
+        limit?: number | undefined;
+        search?: string | undefined;
+        status?: string | undefined;
+    }) => Promise<TPaginate<TSubscription>>;
+    getByOrg: (org: string | ObjectId) => Promise<TSubscription | null>;
+    getById: (_id: string | ObjectId) => Promise<TSubscription | null>;
+    deleteById: (_id: string | ObjectId) => Promise<string>;
+    updateById: (_id: string | ObjectId, options: {
+        seats: number;
+        paidSeats?: number;
+        amount?: number;
+        promoCode?: string;
+    }, session?: ClientSession) => Promise<string>;
+};
+
+declare function useSubscriptionController(): {
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getByOrg: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    updateSeats: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
+type TSubscriptionTransaction = {
+    _id?: ObjectId;
+    subscription: string | ObjectId;
+    amount: number;
+    currency: string;
+    type: "initiate" | "add-seat" | "remove-seat" | "renewal";
+    description?: string;
+    createdBy: string | ObjectId;
+    createdByName?: string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+};
+declare const schemaSubscriptionTransaction: Joi.ObjectSchema<any>;
+declare function modelSubscriptionTransaction(data: TSubscriptionTransaction): TSubscriptionTransaction;
+
+declare function useSubscriptionTransactionRepo(): {
+    add: (value: TSubscriptionTransaction, session?: ClientSession) => Promise<string>;
+    getAll: ({ page, limit, search, id }?: {
+        page?: number | undefined;
+        limit?: number | undefined;
+        search?: string | undefined;
+        id?: string | undefined;
+    }) => Promise<TPaginate<TSubscriptionTransaction>>;
+};
+
+declare function useSubscriptionTransactionController(): {
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
 type TApp = {
     _id?: ObjectId;
     code: string;
@@ -942,4 +1064,4 @@ declare const XENDIT_SECRET_KEY: string;
 declare const XENDIT_BASE_URL: string;
 declare const DOMAIN: string;
 
-export { ACCESS_TOKEN_EXPIRY, ACCESS_TOKEN_SECRET, APP_ACCOUNT, APP_MAIN, 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, MAddress, MBuilding, MBuildingUnit, MFile, MONGO_DB, MONGO_URI, 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, TApp, TBuilding, TBuildingUnit, TCounter, TFile, TMember, TOrg, TPSGC, TPermission, TPermissionGroup, TRole, TUser, TVerification, TVerificationMetadata, VERIFICATION_FORGET_PASSWORD_DURATION, VERIFICATION_USER_INVITE_DURATION, XENDIT_BASE_URL, XENDIT_SECRET_KEY, addressSchema, isDev, modelApp, modelMember, modelOrg, modelPSGC, modelPermission, modelPermissionGroup, modelRole, modelUser, modelVerification, schemaApp, schemaAppUpdate, schemaBuilding, schemaBuildingUnit, schemaInviteMember, schemaMember, schemaMemberRole, schemaMemberStatus, schemaOrg, schemaPSGC, schemaPermission, schemaPermissionGroup, schemaPermissionGroupUpdate, schemaPermissionUpdate, schemaRole, schemaRoleUpdate, schemaUpdateOptions, schemaUser, schemaVerification, transactionSchema, useAddressController, useAddressRepo, useAppController, useAppRepo, useAppService, useAuthController, useAuthService, useBuildingController, useBuildingRepo, useBuildingService, useBuildingUnitController, useBuildingUnitRepo, useBuildingUnitService, useCounterModel, useCounterRepo, useFileController, useFileRepo, useFileService, useGitHubService, useMemberController, useMemberRepo, useOrgController, useOrgRepo, useOrgService, usePSGCController, usePSGCRepo, usePermissionController, usePermissionGroupController, usePermissionGroupRepo, usePermissionGroupService, usePermissionRepo, usePermissionService, useRoleController, useRoleRepo, useRoleService, useUserController, useUserRepo, useUserService, useUtilController, useVerificationController, useVerificationRepo, useVerificationService };
+export { ACCESS_TOKEN_EXPIRY, ACCESS_TOKEN_SECRET, APP_ACCOUNT, APP_MAIN, 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, MAddress, MBuilding, MBuildingUnit, MFile, MONGO_DB, MONGO_URI, 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, TApp, TBuilding, TBuildingUnit, TCounter, TFile, TMember, TOrg, TPSGC, TPermission, TPermissionGroup, TPlan, TRole, TSubscription, TSubscriptionTransaction, TUser, TVerification, TVerificationMetadata, VERIFICATION_FORGET_PASSWORD_DURATION, VERIFICATION_USER_INVITE_DURATION, XENDIT_BASE_URL, XENDIT_SECRET_KEY, addressSchema, currencies, isDev, modelApp, modelMember, modelOrg, modelPSGC, modelPermission, modelPermissionGroup, modelPlan, modelRole, modelSubscription, modelSubscriptionTransaction, modelUser, modelVerification, schemaApp, schemaAppUpdate, schemaBuilding, schemaBuildingUnit, schemaInviteMember, schemaMember, schemaMemberRole, schemaMemberStatus, schemaOrg, schemaOrgAdd, schemaOrgUpdate, schemaPSGC, schemaPermission, schemaPermissionGroup, schemaPermissionGroupUpdate, schemaPermissionUpdate, schemaPlan, schemaRole, schemaRoleUpdate, schemaSubscription, schemaSubscriptionSeats, schemaSubscriptionTransaction, schemaSubscriptionUpdate, schemaUpdateOptions, schemaUser, schemaVerification, transactionSchema, useAddressController, useAddressRepo, useAppController, useAppRepo, useAppService, useAuthController, useAuthService, useBuildingController, useBuildingRepo, useBuildingService, useBuildingUnitController, useBuildingUnitRepo, useBuildingUnitService, useCounterModel, useCounterRepo, useFileController, useFileRepo, useFileService, useGitHubService, useMemberController, useMemberRepo, useOrgController, useOrgRepo, useOrgService, usePSGCController, usePSGCRepo, usePermissionController, usePermissionGroupController, usePermissionGroupRepo, usePermissionGroupService, usePermissionRepo, usePermissionService, usePlanController, usePlanRepo, usePlanService, useRoleController, useRoleRepo, useRoleService, useSubscriptionController, useSubscriptionRepo, useSubscriptionTransactionController, useSubscriptionTransactionRepo, useUserController, useUserRepo, useUserService, useUtilController, useVerificationController, useVerificationRepo, useVerificationService };