@goweekdays/core 0.0.10 → 0.0.12

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @goweekdays/core
 
+## 0.0.12
+
+### Patch Changes
+
+- de8f568: Add promo code
+
+## 0.0.11
+
+### Patch Changes
+
+- 590635e: chore: update dependencies
+
 ## 0.0.10
 
 ### Patch Changes

package/dist/index.d.ts

@@ -3,6 +3,7 @@ import { ObjectId, ClientSession } from 'mongodb';
 import * as bson from 'bson';
 import { Request, Response, NextFunction } from 'express';
 import { paginate } from '@goweekdays/utils';
+import Joi from 'joi';
 
 type TVerificationMetadata = {
     name?: string;
@@ -65,9 +66,7 @@ declare function useVerificationService(): {
         email: string;
         metadata: TKeyValuePair;
     }) => Promise<bson.ObjectId>;
-    verify: (id: string) => Promise<TVerification | {
-        message: string;
-    }>;
+    verify: (id: string) => Promise<TVerification>;
     getById: (id: string) => Promise<TVerification>;
     getVerifications: ({ search, page, status, type, email, limit, }?: {
         search?: string | undefined;
@@ -144,7 +143,7 @@ type TUser = {
     birthDay?: number;
     birthYear?: number;
     gender?: string;
-    roles?: TUserRole[];
+    defaultOrg?: ObjectId;
     status?: string;
     referralCode?: string;
     referredBy?: string;
@@ -211,7 +210,7 @@ declare function useUserRepo(): {
     updateUserFieldById: ({ _id, field, value }?: {
         _id: string | ObjectId;
         field: string;
-        value: string;
+        value: string | ObjectId;
     }, session?: ClientSession) => Promise<string>;
     addUserRole: ({ _id, role }?: {
         _id: string | ObjectId;
@@ -243,7 +242,6 @@ declare function useUserService(): {
         lastName: string;
         suffix?: string | undefined;
         type: string;
-        roles: TUserRole[];
     }) => Promise<bson.ObjectId>;
     resetPassword: (id: string, newPassword: string, passwordConfirmation: string) => Promise<string>;
     updateName: (_id: string, firstName?: string, lastName?: string) => Promise<string>;
@@ -311,6 +309,7 @@ type TRole = {
     permissions?: Array<string>;
     type?: string;
     status?: string;
+    default?: boolean;
     createdBy?: string | ObjectId;
     createdAt?: string;
     updatedAt?: string;
@@ -325,6 +324,7 @@ declare class MRole implements TRole {
     permissions?: Array<string>;
     type?: string;
     status?: string;
+    default?: boolean;
     createdBy?: string | ObjectId;
     createdAt?: string;
     updatedAt?: string;
@@ -822,8 +822,19 @@ type TSubscription = {
     _id?: ObjectId;
     user?: ObjectId | string;
     org?: ObjectId | string;
-    subscriptionId: string;
+    customerId: string;
+    paymentMethodId: string;
+    amount: number;
+    description?: string;
+    currency: string;
+    promoCode?: string;
+    type: string;
+    seats?: number;
     status?: string;
+    billingCycle: "monthly" | "yearly";
+    nextBillingDate?: string;
+    lastPaymentStatus?: string;
+    failedAttempts?: number;
     createdAt?: string;
     updatedAt?: string;
     deletedAt?: string;
@@ -849,6 +860,16 @@ declare function useSubscriptionRepo(): {
         pageRange: string;
     }>;
     updateStatus: (_id: string | ObjectId, status: string) => Promise<string>;
+    getByOrgId: (org: string | ObjectId) => Promise<TSubscription | null>;
+    getByAffiliateUserId: (user: string | ObjectId) => Promise<TSubscription | null>;
+    getDueSubscriptions: (BATCH_SIZE?: number) => Promise<TSubscription[]>;
+    getFailedSubscriptions: (BATCH_SIZE?: number, maxAttempts?: number) => Promise<TSubscription[]>;
+    processSuccessfulPayment: (value: Pick<TSubscription, "_id" | "nextBillingDate">, session?: ClientSession) => Promise<string>;
+    markSubscriptionAsFailed: ({ _id, failed }?: {
+        _id: string | ObjectId;
+        failed?: boolean | undefined;
+    }, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
+    markSubscriptionAsCanceled: (_id: string | ObjectId, session?: ClientSession) => Promise<mongodb.UpdateResult<bson.Document>>;
 };
 
 type TOrg = {
@@ -882,27 +903,54 @@ type TAddress = {
 declare function MAddress(value: any): TAddress;
 
 declare function useSubscriptionService(): {
-    getByUserId: (id: string) => Promise<TSubscription>;
+    getByUserId: (id: string) => Promise<any>;
     getStatusByUser: (user: string) => Promise<string>;
-    createAffiliateSubscription: ({ user, amount, payment_method_id, customer_id, }?: {
-        user?: string | undefined;
-        amount?: number | undefined;
-        payment_method_id?: string | undefined;
-        customer_id?: string | undefined;
+    createAffiliateSubscription: (value: {
+        user: string;
+        amount: number;
+        currency: string;
+        payment_method_id: string;
+        payment_method_number: string;
+        payment_method_expiry_month?: string | undefined;
+        payment_method_expiry_year?: string | undefined;
+        payment_method_cvv?: string | undefined;
+        payment_method_cardholder_name?: string | undefined;
+        payment_method_channel: string;
+        payment_method_type: string;
+        customer_id: string;
+        billingAddress: TAddress;
     }) => Promise<string>;
     createOrgSubscription: (value: {
         user: string;
         amount: number;
+        currency: string;
         payment_method_id: string;
+        payment_method_number: string;
+        payment_method_expiry_month?: string | undefined;
+        payment_method_expiry_year?: string | undefined;
+        payment_method_cvv?: string | undefined;
+        payment_method_cardholder_name?: string | undefined;
+        payment_method_channel: string;
+        payment_method_type: string;
         customer_id: string;
         organization: TOrg;
         billingAddress: TAddress;
-    }) => Promise<string>;
+        seats: number;
+    }) => Promise<{
+        message: string;
+        data: {
+            org: string;
+        };
+    }>;
+    processSubscriptions: (batchSize?: number) => Promise<void>;
+    retryFailedPayments: (batchSize?: number) => Promise<void>;
 };
 
 declare function useSubscriptionController(): {
     add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     getByUserId: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getByOrgId: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getByAffiliateUserId: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     getSubscriptions: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     getSubscriptionStatus: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     createAffiliateSubscription: (req: Request, res: Response, next: NextFunction) => Promise<void>;
@@ -932,13 +980,14 @@ declare function useXenditService(): {
         success_return_url?: string | undefined;
         failure_return_url?: string | undefined;
     }) => Promise<any>;
-    initSubscription: ({ customer, currency, amount, paymentMethod, description, interval, }?: {
+    initSubscription: ({ customer, currency, amount, paymentMethod, description, interval, seats, }?: {
         customer?: string | undefined;
         currency?: string | undefined;
         amount?: number | undefined;
         paymentMethod?: string | undefined;
         description?: string | undefined;
         interval?: string | undefined;
+        seats?: number | undefined;
     }) => Promise<any>;
     linkPaymentMethodCard: ({ success_return_url, failure_return_url, card_number, expiry_month, expiry_year, cvv, cardholder_name, currency, }?: {
         success_return_url?: string | undefined;
@@ -959,6 +1008,16 @@ declare function useXenditService(): {
     }) => Promise<any>;
     checkSubscriptionStatus: (subscriptionId: string) => Promise<string>;
     cancelSubscription: (subscriptionId: string) => Promise<string>;
+    getSubscription: (id: string) => Promise<any>;
+    getSubscriptionCycles: (id: string) => Promise<any>;
+    pay: (value: {
+        amount: number;
+        currency: string;
+        payment_method_id: string;
+        customer_id: string;
+        description?: string;
+        metadata?: Record<string, any>;
+    }) => Promise<any>;
 };
 
 type TPaymentMethod = {
@@ -969,7 +1028,8 @@ type TPaymentMethod = {
     description?: string;
     type: string;
     number: string;
-    expiry?: string;
+    month_expiry?: string;
+    year_expiry?: string;
     cvv?: string;
     paymentId: string;
     customerId?: string;
@@ -983,20 +1043,21 @@ declare function usePaymentMethodRepo(): {
     createIndex: () => Promise<void>;
     add: (value: TPaymentMethod, session?: ClientSession) => Promise<string>;
     getByUser: (user: string | ObjectId) => Promise<bson.Document[]>;
+    getByOrg: (org: string | ObjectId) => Promise<bson.Document[]>;
     deleteById: (_id: string | ObjectId) => Promise<string>;
     createUniqueIndex: () => Promise<void>;
     getByPaymentMethodId: (paymentId: string | ObjectId) => Promise<TPaymentMethod | null>;
 };
 
 declare function usePaymentMethodService(): {
-    linkEWallet: ({ user, mobile_number, type, success_return_url, failure_return_url, cancel_return_url, metadata, }?: {
+    linkEWallet: ({ user, org, mobile_number, type, success_return_url, failure_return_url, cancel_return_url, }?: {
         user?: string | undefined;
+        org?: string | undefined;
         mobile_number?: string | undefined;
         type?: string | undefined;
         success_return_url?: string | undefined;
         failure_return_url?: string | undefined;
         cancel_return_url?: string | undefined;
-        metadata?: {} | undefined;
     }) => Promise<{
         paymentMethod: any;
         customer: any;
@@ -1020,6 +1081,7 @@ declare function usePaymentMethodController(): {
     linkEWallet: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     linkCard: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     getByUser: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getByOrg: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
 declare function useAddressRepo(): {
@@ -1076,6 +1138,7 @@ declare function useOrgController(): {
 type TMember = {
     _id?: ObjectId;
     org: string | ObjectId;
+    orgName: string;
     name: string;
     user: string | ObjectId;
     role: string | ObjectId;
@@ -1092,7 +1155,16 @@ declare function useMemberRepo(): {
     createTextIndex: () => Promise<void>;
     add: (value: TMember, session?: ClientSession) => Promise<string>;
     getById: (_id: string | ObjectId) => Promise<TMember | null>;
-    getByOrgId: (org: string | ObjectId) => Promise<TMember[]>;
+    getByUserId: ({ user, search, limit, page }?: {
+        user: string | ObjectId;
+        search: string;
+        limit: number;
+        page: number;
+    }) => Promise<{
+        items: any[];
+        pages: number;
+        pageRange: string;
+    }>;
     getOrgsByUserId: ({ search, page, limit, sort, user, status, }?: {
         user: string | ObjectId;
         page: number;
@@ -1106,6 +1178,100 @@ declare function useMemberRepo(): {
         pageRange: string;
     }>;
     updateStatusByUserId: (user: string | ObjectId, status: string) => Promise<string>;
+    updateName: (value: Pick<TMember, "name" | "user">, session?: ClientSession) => Promise<string>;
+};
+
+declare const schema: Joi.ObjectSchema<any>;
+
+type TPromoType = "tiered" | "fixed";
+type TPromoTier = {
+    min: number;
+    max: number;
+    price: number;
+};
+type TPromoCode = {
+    _id?: ObjectId;
+    code: string;
+    description?: string;
+    type: TPromoType;
+    tiers?: TPromoTier[];
+    fixed_rate?: number;
+    appliesTo?: string;
+    createdAt?: string;
+    expiresAt?: string;
+    assignedTo?: string | ObjectId;
+    status?: "active" | "expired" | "disabled";
+};
+declare function MPromoCode(data: TPromoCode): TPromoCode;
+
+declare function usePromoCodeRepo(): {
+    createIndex: () => void;
+    createUniqueIndex: () => void;
+    add: (value: TPromoCode) => void;
+    getByCode: (code: string) => Promise<mongodb.WithId<bson.Document> | null>;
+    getPromoCodes: ({ search, page, limit, sort, status, type, }?: {
+        search?: string | undefined;
+        page?: number | undefined;
+        limit?: number | undefined;
+        sort?: {} | undefined;
+        status?: string | undefined;
+        type?: string | undefined;
+    }) => Promise<{
+        items: any[];
+        pages: number;
+        pageRange: string;
+    }>;
+};
+
+declare function usePromoCodeController(): {
+    add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getByCode: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getPromoCodes: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
+type TOrderMetadata = {
+    subscriptionId?: ObjectId | string;
+    cycle?: number;
+    seats?: number;
+    promoCode?: string;
+};
+type TOrder = {
+    _id?: ObjectId;
+    payment?: string;
+    user?: ObjectId | string;
+    org?: ObjectId | string;
+    type: string;
+    amount: number;
+    currency: string;
+    description?: string;
+    metadata?: TOrderMetadata;
+    status?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    deletedAt?: string;
+};
+declare function MOrder(value: TOrder): TOrder;
+
+declare function useOrderRepo(): {
+    createIndex: () => void;
+    add: (value: TOrder, session?: ClientSession) => void;
+    getOrders: ({ search, page, limit, sort, status, type, id, }?: {
+        search?: string | undefined;
+        page?: number | undefined;
+        limit?: number | undefined;
+        sort?: {} | undefined;
+        status?: string | undefined;
+        type?: string | undefined;
+        id?: string | undefined;
+    }) => Promise<{
+        items: any[];
+        pages: number;
+        pageRange: string;
+    }>;
+};
+
+declare function useOrderController(): {
+    getOrders: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
 declare const MONGO_URI: string;
@@ -1144,4 +1310,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, DEFAULT_USER_EMAIL, DEFAULT_USER_FIRST_NAME, DEFAULT_USER_LAST_NAME, DEFAULT_USER_PASSWORD, MAILER_EMAIL, MAILER_PASSWORD, MAILER_TRANSPORT_HOST, MAILER_TRANSPORT_PORT, MAILER_TRANSPORT_SECURE, MAddress, MCapBldgAct, MComment, MEntity, MFile, MMember, MONGO_DB, MONGO_URI, MOrg, MPaymentMethod, MRole, MSubscription, MToken, MUser, MUserRole, MVerification, MWorkflow, 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, TAttachment, TCapBldgAct, TCapBldgActAssmtCriteria, TCapBldgActBasicInfo, TCapBldgActInitRevEval, TComment, TEntity, TFile, TMember, TMiniRole, TOrg, TPaymentMethod, TRole, TSubscription, TToken, TUser, TUserRole, TVerification, TVerificationMetadata, TWorkflow, TWorkflowStep, VERIFICATION_FORGET_PASSWORD_DURATION, VERIFICATION_USER_INVITE_DURATION, XENDIT_BASE_URL, XENDIT_SECRET_KEY, isDev, useAddressController, useAddressRepo, useAuthController, useAuthService, useCapBldgActController, useCapBldgActRepo, useCapBldgActService, useCommentController, useCommentRepo, useCommentService, useEntityController, useEntityRepo, useEntityService, useFileController, useFileRepo, useFileService, useMemberRepo, useOrgController, useOrgRepo, useOrgService, usePaymentMethodController, usePaymentMethodRepo, usePaymentMethodService, useRoleController, useRoleRepo, useRoleService, useSubscriptionController, useSubscriptionRepo, useSubscriptionService, useTokenRepo, useUserController, useUserRepo, useUserService, useVerificationController, useVerificationRepo, useVerificationService, useWorkflowController, useWorkflowRepo, useWorkflowService, useXenditService };
+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, MAILER_EMAIL, MAILER_PASSWORD, MAILER_TRANSPORT_HOST, MAILER_TRANSPORT_PORT, MAILER_TRANSPORT_SECURE, MAddress, MCapBldgAct, MComment, MEntity, MFile, MMember, MONGO_DB, MONGO_URI, MOrder, MOrg, MPaymentMethod, MPromoCode, MRole, MSubscription, MToken, MUser, MUserRole, MVerification, MWorkflow, 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, TAttachment, TCapBldgAct, TCapBldgActAssmtCriteria, TCapBldgActBasicInfo, TCapBldgActInitRevEval, TComment, TEntity, TFile, TMember, TMiniRole, TOrder, TOrderMetadata, TOrg, TPaymentMethod, TPromoCode, TPromoTier, TRole, TSubscription, TToken, TUser, TUserRole, TVerification, TVerificationMetadata, TWorkflow, TWorkflowStep, VERIFICATION_FORGET_PASSWORD_DURATION, VERIFICATION_USER_INVITE_DURATION, XENDIT_BASE_URL, XENDIT_SECRET_KEY, isDev, schema, useAddressController, useAddressRepo, useAuthController, useAuthService, useCapBldgActController, useCapBldgActRepo, useCapBldgActService, useCommentController, useCommentRepo, useCommentService, useEntityController, useEntityRepo, useEntityService, useFileController, useFileRepo, useFileService, useMemberRepo, useOrderController, useOrderRepo, useOrgController, useOrgRepo, useOrgService, usePaymentMethodController, usePaymentMethodRepo, usePaymentMethodService, usePromoCodeController, usePromoCodeRepo, useRoleController, useRoleRepo, useRoleService, useSubscriptionController, useSubscriptionRepo, useSubscriptionService, useTokenRepo, useUserController, useUserRepo, useUserService, useVerificationController, useVerificationRepo, useVerificationService, useWorkflowController, useWorkflowRepo, useWorkflowService, useXenditService };