@goweekdays/core 2.12.3 → 2.13.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @goweekdays/core
 
+## 2.13.0
+
+### Minor Changes
+
+- e083e11: Initial implementation and integration of finance module
+
 ## 2.12.3
 
 ### Patch Changes

package/dist/index.d.ts

@@ -226,8 +226,15 @@ declare function useCounterModel(db: Db): {
 
 declare function useCounterRepo(): {
     createIndexes: () => Promise<void>;
-    add: (type: string) => Promise<void>;
-    getByType: (type: string) => Promise<any>;
+    add: (type: string, session?: ClientSession) => Promise<void>;
+    getByType: (type: string) => Promise<{
+        type: string;
+        createdAt: Date;
+        count: number;
+        deletedAt?: Date | undefined;
+        _id?: bson.ObjectId | undefined;
+        updatedAt?: Date | undefined;
+    } | null>;
     incrementByType: (type: string, session?: ClientSession) => Promise<void>;
 };
 
@@ -422,6 +429,7 @@ declare function useOrgService(): {
 };
 
 declare function useOrgController(): {
+    validOrg: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     getOrgsByUserId: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     getByName: (req: Request, res: Response, next: NextFunction) => Promise<void>;
@@ -1689,6 +1697,227 @@ declare function useJobSummaryCtrl(): {
     getByOrg: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 };
 
+type TTax = {
+    _id?: ObjectId;
+    org: ObjectId;
+    name: string;
+    rate: number;
+    direction: string;
+    status?: string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+};
+declare const taxDirections: string[];
+declare const schemaTax: Joi.ObjectSchema<any>;
+declare const schemaTaxUpdate: Joi.ObjectSchema<any>;
+declare function modelTax(data: TTax): TTax;
+
+declare function useTaxRepo(): {
+    createIndexes: () => Promise<void>;
+    add: (value: TTax, session?: ClientSession) => Promise<ObjectId>;
+    getAll: (options: {
+        org: ObjectId | string;
+        search?: string;
+        page?: number;
+        limit?: number;
+        status?: string;
+    }) => Promise<Record<string, any>>;
+    getTaxesByOrg: ({ 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<TTax>;
+    updateById: (_id: string | ObjectId, options: Pick<TTax, "name" | "rate" | "direction">) => Promise<string>;
+    deleteById: (_id: string | ObjectId, session?: ClientSession) => Promise<string>;
+    updateStatusById: (_id: string | ObjectId, status: string) => Promise<string>;
+};
+
+declare function useTaxController(): {
+    add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getTaxesByOrg: (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>;
+};
+
+type TChartOfAccountType = "asset" | "liability" | "equity" | "income" | "expense";
+type TChartOfAccountStatus = "active" | "inactive" | "archived";
+type TChartOfAccountNormalBalance = "debit" | "credit";
+type TChartOfAccount = {
+    _id?: ObjectId;
+    org: ObjectId;
+    type: TChartOfAccountType;
+    normalBalance: TChartOfAccountNormalBalance;
+    parent?: ObjectId | string;
+    parentName?: string;
+    path: string;
+    name: string;
+    code: string;
+    tax?: ObjectId;
+    isContra: boolean;
+    status?: TChartOfAccountStatus;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+};
+declare const chartOfAccountTypes: TChartOfAccountType[];
+declare const chartOfAccountNormalBalances: TChartOfAccountNormalBalance[];
+declare const schemaChartOfAccountBase: Joi.ObjectSchema<any>;
+declare const schemaChartOfAccountStd: Joi.ObjectSchema<any>;
+declare const schemaChartOfAccountUpdate: Joi.ObjectSchema<any>;
+declare function modelChartOfAccount(data: TChartOfAccount): TChartOfAccount;
+
+declare function useChartOfAccountRepo(): {
+    createIndexes: () => Promise<void>;
+    add: (value: TChartOfAccount, session?: ClientSession) => Promise<ObjectId>;
+    getAll: (options: {
+        org: ObjectId | string;
+        search?: string;
+        page?: number;
+        limit?: number;
+        status?: string;
+    }) => Promise<Record<string, any>>;
+    getByOrg: ({ 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<TChartOfAccount>;
+    updateById: (_id: string | ObjectId, options: Partial<Omit<TChartOfAccount, "_id" | "org">>, session?: ClientSession) => Promise<string>;
+    deleteById: (_id: string | ObjectId, session?: ClientSession) => Promise<string>;
+    updateStatusById: (_id: string | ObjectId, status: string) => Promise<string>;
+    countByPath: (path: string) => Promise<number>;
+};
+
+declare function useChartOfAccountController(): {
+    add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getByOrg: (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>;
+};
+
+type TJournalEntryStatus = "draft" | "posted" | "voided";
+declare const journalEntryStatuses: TJournalEntryStatus[];
+type TJournalEntryType = "general" | "sales" | "purchases" | "cash-receipts" | "cash-disbursements";
+declare const journalEntryTypes: TJournalEntryType[];
+type TJournalEntryMetadata = {
+    customerId: ObjectId | string;
+    supplierId: ObjectId | string;
+    itemId: ObjectId | string;
+    assetId: ObjectId | string;
+    purchaseOrderId: ObjectId | string;
+    salesOrderId: ObjectId | string;
+};
+type TJournalEntry = {
+    _id?: ObjectId;
+    id: string;
+    org: ObjectId;
+    type: string;
+    book: TJournalEntryType;
+    date: Date | string;
+    description: string;
+    createdBy: ObjectId;
+    createdByName: string;
+    metadata: TJournalEntryMetadata;
+    status: TJournalEntryStatus;
+    postedAt?: Date | string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+};
+declare const schemaJournalEntryCtrl: Joi.ObjectSchema<any>;
+declare const schemaJournalEntryRepo: Joi.ObjectSchema<any>;
+declare const schemaJournalEntryGetAll: Joi.ObjectSchema<any>;
+declare function modelJournalEntry(data: TJournalEntry): TJournalEntry;
+
+declare function useJournalEntryRepo(): {
+    add: (value: TJournalEntry, session?: ClientSession) => Promise<ObjectId>;
+    getAll: (options: {
+        org: ObjectId | string;
+        search?: string;
+        page?: number;
+        limit?: number;
+        book: string;
+        type: string;
+        status?: string;
+    }) => Promise<Record<string, any>>;
+    getById: (_id: string | ObjectId) => Promise<TJournalEntry>;
+    updateById: (_id: string | ObjectId, options: Partial<TJournalEntry>) => Promise<string>;
+    deleteById: (_id: string | ObjectId, session?: ClientSession) => Promise<string>;
+    updateStatusById: (_id: string | ObjectId, status: string) => Promise<string>;
+};
+
+type TJournalLine = {
+    _id?: ObjectId;
+    org: ObjectId;
+    journalEntry: ObjectId | string;
+    account: ObjectId;
+    accountName: string;
+    debit: number;
+    credit: number;
+    postReference?: string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+};
+declare const schemaJournalLineCtrl: Joi.ObjectSchema<any>;
+declare const schemaJournalLineRepo: Joi.ObjectSchema<any>;
+declare function modelJournalLine(data: TJournalLine): TJournalLine;
+
+declare function useJournalEntryService(): {
+    add: (entry: TJournalEntry, lines: TJournalLine[]) => Promise<string>;
+};
+
+declare function useJournalEntryController(): {
+    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>;
+    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 useJournalLineRepo(): {
+    add: (value: TJournalLine, session?: ClientSession) => Promise<ObjectId>;
+    getAll: (options: {
+        org: ObjectId | string;
+        journalEntry?: ObjectId | string;
+        page?: number;
+        limit?: number;
+    }) => Promise<Record<string, any>>;
+    getById: (_id: string | ObjectId) => Promise<TJournalLine>;
+    updateById: (_id: string | ObjectId, options: Partial<TJournalLine>) => Promise<string>;
+    deleteById: (_id: string | ObjectId, session?: ClientSession) => Promise<string>;
+};
+
+declare function useJournalLineController(): {
+    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>;
+    deleteById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
 declare const MONGO_URI: string;
 declare const MONGO_DB: string;
 declare const PORT: number;
@@ -1728,4 +1957,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_JOB_STATUS_SETUP, 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, TJobApplication, TJobApplicationMetadata, TJobPost, TJobProfile, TJobProfileAward, TJobProfileCert, TJobProfileEdu, TJobProfileGroup, TJobProfileLang, TJobProfileMilitaryExp, TJobProfilePatent, TJobProfilePublication, TJobProfileSkill, TJobProfileWorkExp, TJobStatusSetup, TJobStatusTrans, TJobSummary, TJobSummaryMetadata, TLedgerBill, TMember, TOption, TOrg, TPermission, TPermissionGroup, TPlan, TPromo, TRole, TSubscribe, TSubscription, TSubscriptionTransaction, TUser, TVerification, TVerificationMetadata, VERIFICATION_FORGET_PASSWORD_DURATION, VERIFICATION_USER_INVITE_DURATION, XENDIT_BASE_URL, XENDIT_SECRET_KEY, currencies, isDev, jobApplicationStatuses, ledgerBillStatuses, ledgerBillTypes, modelApp, modelJobApplication, modelJobPost, modelJobProfile, modelJobProfileCert, modelJobProfileEdu, modelJobProfileLang, modelJobProfileSkill, modelJobProfileWorkExp, modelJobStatusSetup, modelJobStatusTrans, modelJobSummary, modelLedgerBill, modelMember, modelOption, modelOrg, modelPermission, modelPermissionGroup, modelPlan, modelPromo, modelRole, modelSubscription, modelSubscriptionTransaction, modelUser, modelVerification, schemaApp, schemaAppUpdate, schemaAward, schemaBuilding, schemaBuildingUnit, schemaCertification, schemaEducation, schemaGroup, schemaInviteMember, schemaJobApplication, schemaJobPost, schemaJobPostUpdate, schemaJobProfile, schemaJobProfileAdditionalInfo, schemaJobProfileCert, schemaJobProfileCertDel, schemaJobProfileContactInfo, schemaJobProfileEdu, schemaJobProfileEduDel, schemaJobProfileLang, schemaJobProfileLangDel, schemaJobProfilePersonalInfo, schemaJobProfileSkill, schemaJobProfileSkillDel, schemaJobProfileSummary, schemaJobProfileWorkExp, schemaJobProfileWorkExpDel, schemaJobStatusSetup, schemaJobStatusSetupUpdate, schemaJobStatusTrans, schemaJobSummary, schemaJobSummaryInc, schemaLanguage, schemaLedgerBill, schemaLedgerBillingSummary, schemaMember, schemaMemberRole, schemaMemberStatus, schemaMilitaryExp, schemaOption, schemaOrg, schemaOrgAdd, schemaOrgPilot, schemaOrgUpdate, schemaPatent, schemaPermission, schemaPermissionGroup, schemaPermissionGroupUpdate, schemaPermissionUpdate, schemaPlan, schemaPromo, schemaPublication, schemaRole, schemaRoleUpdate, schemaSkill, schemaSubscribe, schemaSubscription, schemaSubscriptionCompute, schemaSubscriptionPromoCode, schemaSubscriptionSeats, schemaSubscriptionTransaction, schemaSubscriptionUpdate, schemaUpdateOptions, schemaUser, schemaVerification, schemaVerificationOrgInvite, schemaWorkExp, transactionSchema, useAppController, useAppRepo, useAppService, useAuthController, useAuthService, useBuildingController, useBuildingRepo, useBuildingService, useBuildingUnitController, useBuildingUnitRepo, useBuildingUnitService, useCounterModel, useCounterRepo, useFileController, useFileRepo, useFileService, useGitHubService, useJobApplicationController, useJobApplicationRepo, useJobPostController, useJobPostRepo, useJobPostService, useJobProfileCtrl, useJobProfileRepo, useJobStatusConfigController, useJobStatusConfigRepo, useJobSummaryCtrl, useJobSummaryRepo, useJobSummarySvc, useLedgerBillingController, useLedgerBillingRepo, useMemberController, useMemberRepo, useOptionCtrl, useOptionRepo, useOrgController, useOrgRepo, useOrgService, usePaypalService, usePermissionController, usePermissionGroupController, usePermissionGroupRepo, usePermissionGroupService, usePermissionRepo, usePermissionService, usePlanController, usePlanRepo, usePlanService, usePromoController, usePromoRepo, usePromoUsageRepo, useRoleController, useRoleRepo, useRoleService, useSubscriptionController, useSubscriptionRepo, useSubscriptionService, useSubscriptionTransactionController, useSubscriptionTransactionRepo, useUserController, useUserRepo, useUserService, useUtilController, useVerificationController, useVerificationRepo, useVerificationService };
+export { ACCESS_TOKEN_EXPIRY, ACCESS_TOKEN_SECRET, APP_ACCOUNT, APP_MAIN, APP_ORG, DEFAULT_JOB_STATUS_SETUP, 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, TChartOfAccount, TChartOfAccountNormalBalance, TChartOfAccountStatus, TChartOfAccountType, TCounter, TFile, TJobApplication, TJobApplicationMetadata, TJobPost, TJobProfile, TJobProfileAward, TJobProfileCert, TJobProfileEdu, TJobProfileGroup, TJobProfileLang, TJobProfileMilitaryExp, TJobProfilePatent, TJobProfilePublication, TJobProfileSkill, TJobProfileWorkExp, TJobStatusSetup, TJobStatusTrans, TJobSummary, TJobSummaryMetadata, TJournalEntry, TJournalEntryMetadata, TJournalEntryStatus, TJournalEntryType, TJournalLine, TLedgerBill, TMember, TOption, TOrg, TPermission, TPermissionGroup, TPlan, TPromo, TRole, TSubscribe, TSubscription, TSubscriptionTransaction, TTax, TUser, TVerification, TVerificationMetadata, VERIFICATION_FORGET_PASSWORD_DURATION, VERIFICATION_USER_INVITE_DURATION, XENDIT_BASE_URL, XENDIT_SECRET_KEY, chartOfAccountNormalBalances, chartOfAccountTypes, currencies, isDev, jobApplicationStatuses, journalEntryStatuses, journalEntryTypes, ledgerBillStatuses, ledgerBillTypes, modelApp, modelChartOfAccount, modelJobApplication, modelJobPost, modelJobProfile, modelJobProfileCert, modelJobProfileEdu, modelJobProfileLang, modelJobProfileSkill, modelJobProfileWorkExp, modelJobStatusSetup, modelJobStatusTrans, modelJobSummary, modelJournalEntry, modelJournalLine, modelLedgerBill, modelMember, modelOption, modelOrg, modelPermission, modelPermissionGroup, modelPlan, modelPromo, modelRole, modelSubscription, modelSubscriptionTransaction, modelTax, modelUser, modelVerification, schemaApp, schemaAppUpdate, schemaAward, schemaBuilding, schemaBuildingUnit, schemaCertification, schemaChartOfAccountBase, schemaChartOfAccountStd, schemaChartOfAccountUpdate, schemaEducation, schemaGroup, schemaInviteMember, schemaJobApplication, schemaJobPost, schemaJobPostUpdate, schemaJobProfile, schemaJobProfileAdditionalInfo, schemaJobProfileCert, schemaJobProfileCertDel, schemaJobProfileContactInfo, schemaJobProfileEdu, schemaJobProfileEduDel, schemaJobProfileLang, schemaJobProfileLangDel, schemaJobProfilePersonalInfo, schemaJobProfileSkill, schemaJobProfileSkillDel, schemaJobProfileSummary, schemaJobProfileWorkExp, schemaJobProfileWorkExpDel, schemaJobStatusSetup, schemaJobStatusSetupUpdate, schemaJobStatusTrans, schemaJobSummary, schemaJobSummaryInc, schemaJournalEntryCtrl, schemaJournalEntryGetAll, schemaJournalEntryRepo, schemaJournalLineCtrl, schemaJournalLineRepo, schemaLanguage, schemaLedgerBill, schemaLedgerBillingSummary, schemaMember, schemaMemberRole, schemaMemberStatus, schemaMilitaryExp, schemaOption, schemaOrg, schemaOrgAdd, schemaOrgPilot, schemaOrgUpdate, schemaPatent, schemaPermission, schemaPermissionGroup, schemaPermissionGroupUpdate, schemaPermissionUpdate, schemaPlan, schemaPromo, schemaPublication, schemaRole, schemaRoleUpdate, schemaSkill, schemaSubscribe, schemaSubscription, schemaSubscriptionCompute, schemaSubscriptionPromoCode, schemaSubscriptionSeats, schemaSubscriptionTransaction, schemaSubscriptionUpdate, schemaTax, schemaTaxUpdate, schemaUpdateOptions, schemaUser, schemaVerification, schemaVerificationOrgInvite, schemaWorkExp, taxDirections, transactionSchema, useAppController, useAppRepo, useAppService, useAuthController, useAuthService, useBuildingController, useBuildingRepo, useBuildingService, useBuildingUnitController, useBuildingUnitRepo, useBuildingUnitService, useChartOfAccountController, useChartOfAccountRepo, useCounterModel, useCounterRepo, useFileController, useFileRepo, useFileService, useGitHubService, useJobApplicationController, useJobApplicationRepo, useJobPostController, useJobPostRepo, useJobPostService, useJobProfileCtrl, useJobProfileRepo, useJobStatusConfigController, useJobStatusConfigRepo, useJobSummaryCtrl, useJobSummaryRepo, useJobSummarySvc, useJournalEntryController, useJournalEntryRepo, useJournalEntryService, useJournalLineController, useJournalLineRepo, useLedgerBillingController, useLedgerBillingRepo, useMemberController, useMemberRepo, useOptionCtrl, useOptionRepo, useOrgController, useOrgRepo, useOrgService, usePaypalService, usePermissionController, usePermissionGroupController, usePermissionGroupRepo, usePermissionGroupService, usePermissionRepo, usePermissionService, usePlanController, usePlanRepo, usePlanService, usePromoController, usePromoRepo, usePromoUsageRepo, useRoleController, useRoleRepo, useRoleService, useSubscriptionController, useSubscriptionRepo, useSubscriptionService, useSubscriptionTransactionController, useSubscriptionTransactionRepo, useTaxController, useTaxRepo, useUserController, useUserRepo, useUserService, useUtilController, useVerificationController, useVerificationRepo, useVerificationService };