QT/bigcapital
1
0
Fork 0
mirror of https://github.com/bigcapitalhq/bigcapital.git synced 2026-02-16 04:40:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: add header swagger docs

Browse Source
This commit is contained in:
Ahmed Bouhuolia
2025-07-02 17:42:17 +02:00
parent b2d61160dd
commit 456a9e1ad9
65 changed files with 172 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
packages/server/src/modules/Accounts/Accounts.controller.ts
View File

@@ -24,12 +24,14 @@ import { AccountResponseDto } from './dtos/AccountResponse.dto';
import { AccountTypeResponseDto } from './dtos/AccountTypeResponse.dto';
import { GetAccountTransactionResponseDto } from './dtos/GetAccountTransactionResponse.dto';
import { GetAccountTransactionsQueryDto } from './dtos/GetAccountTransactionsQuery.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('accounts')
@ApiTags('Accounts')
@ApiExtraModels(AccountResponseDto)
@ApiExtraModels(AccountTypeResponseDto)
@ApiExtraModels(GetAccountTransactionResponseDto)
@ApiCommonHeaders()
export class AccountsController {
constructor(private readonly accountsApplication: AccountsApplication) {}

9
packages/server/src/modules/App/App.controller.ts
View File

@@ -2,11 +2,4 @@ import { Controller, Get } from '@nestjs/common';
import { AppService } from './App.service';
@Controller()
export class AppController {
constructor(private readonly appService: AppService) {}
@Get()
getHello(): string {
return this.appService.getHello();
}
}
export class AppController {}

6
packages/server/src/modules/Attachments/Attachments.controller.ts
View File

@@ -30,9 +30,11 @@ import { AttachmentsApplication } from './AttachmentsApplication';
import { AttachmentUploadPipeline } from './S3UploadPipeline';
import { FileInterceptor } from '@/common/interceptors/file.interceptor';
import { ConfigService } from '@nestjs/config';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@ApiTags('Attachments')
@Controller('/attachments')
@ApiCommonHeaders()
export class AttachmentsController {
/**
* @param {AttachmentsApplication} attachmentsApplication - Attachments application.
@@ -109,9 +111,7 @@ export class AttachmentsController {
status: 200,
description: 'The document has been deleted successfully',
})
async deleteAttachment(
@Param('id') documentId: string,
) {
async deleteAttachment(@Param('id') documentId: string) {
await this.attachmentsApplication.delete(documentId);
return {

9
packages/server/src/modules/Auth/Auth.controller.ts
View File

@@ -8,7 +8,13 @@ import {
Request,
UseGuards,
} from '@nestjs/common';
import { ApiTags, ApiOperation, ApiBody, ApiParam } from '@nestjs/swagger';
import {
ApiTags,
ApiOperation,
ApiBody,
ApiParam,
ApiExcludeController,
} from '@nestjs/swagger';
import { PublicRoute } from './guards/jwt.guard';
import { AuthenticationApplication } from './AuthApplication.sevice';
import { AuthSignupDto } from './dtos/AuthSignup.dto';
@@ -20,6 +26,7 @@ import { SystemUser } from '../System/models/SystemUser';
@Controller('/auth')
@ApiTags('Auth')
@ApiExcludeController()
@PublicRoute()
export class AuthController {
constructor(

4
packages/server/src/modules/Auth/AuthApiKeys.controllers.ts
View File

@@ -1,8 +1,12 @@
import { Controller, Post, Param, Get, Put } from '@nestjs/common';
import { GenerateApiKey } from './commands/GenerateApiKey.service';
import { GetApiKeysService } from './queries/GetApiKeys.service';
import { ApiExcludeController, ApiTags } from '@nestjs/swagger';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('api-keys')
@ApiTags('Api keys')
@ApiCommonHeaders()
export class AuthApiKeysController {
constructor(
private readonly getApiKeysService: GetApiKeysService,

8
packages/server/src/modules/Auth/Authed.controller.ts
View File

@@ -1,4 +1,9 @@
import { ApiBody, ApiOperation, ApiTags } from '@nestjs/swagger';
import {
ApiBody,
ApiExcludeController,
ApiOperation,
ApiTags,
} from '@nestjs/swagger';
import { GetAuthenticatedAccount } from './queries/GetAuthedAccount.service';
import { Controller, Get, Post } from '@nestjs/common';
import { IgnoreTenantSeededRoute } from '../Tenancy/EnsureTenantIsSeeded.guards';
@@ -9,6 +14,7 @@ import { IgnoreUserVerifiedRoute } from './guards/EnsureUserVerified.guard';
@Controller('/auth')
@ApiTags('Auth')
@ApiExcludeController()
@IgnoreTenantSeededRoute()
@IgnoreTenantInitializedRoute()
@IgnoreUserVerifiedRoute()

2
packages/server/src/modules/BankRules/BankRules.controller.ts
View File

@@ -18,10 +18,12 @@ import { BankRulesApplication } from './BankRulesApplication';
import { CreateBankRuleDto } from './dtos/BankRule.dto';
import { EditBankRuleDto } from './dtos/BankRule.dto';
import { BankRuleResponseDto } from './dtos/BankRuleResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('banking/rules')
@ApiTags('Bank Rules')
@ApiExtraModels(BankRuleResponseDto)
@ApiCommonHeaders()
export class BankRulesController {
constructor(private readonly bankRulesApplication: BankRulesApplication) {}

2
packages/server/src/modules/BankingCategorize/BankingCategorize.controller.ts
View File

@@ -3,9 +3,11 @@ import { castArray, omit } from 'lodash';
import { BankingCategorizeApplication } from './BankingCategorize.application';
import { CategorizeBankTransactionRouteDto } from './dtos/CategorizeBankTransaction.dto';
import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('banking/categorize')
@ApiTags('Banking Categorization')
@ApiCommonHeaders()
export class BankingCategorizeController {
constructor(
private readonly bankingCategorizeApplication: BankingCategorizeApplication,

2
packages/server/src/modules/BankingMatching/BankingMatching.controller.ts
View File

@@ -3,9 +3,11 @@ import { Body, Controller, Get, Param, Post, Query } from '@nestjs/common';
import { BankingMatchingApplication } from './BankingMatchingApplication';
import { GetMatchedTransactionsFilter } from './types';
import { MatchBankTransactionDto } from './dtos/MatchBankTransaction.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('banking/matching')
@ApiTags('Banking Transactions Matching')
@ApiCommonHeaders()
export class BankingMatchingController {
constructor(
private readonly bankingMatchingApplication: BankingMatchingApplication,

2
packages/server/src/modules/BankingTranasctionsRegonize/BankingRecognizedTransactions.controller.ts
View File

@@ -10,10 +10,12 @@ import {
} from '@nestjs/swagger';
import { RecognizedTransactionsApplication } from './RecognizedTransactions.application';
import { GetRecognizedTransactionResponseDto } from './dtos/GetRecognizedTransactionResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('banking/recognized')
@ApiTags('Banking Recognized Transactions')
@ApiExtraModels(GetRecognizedTransactionResponseDto)
@ApiCommonHeaders()
export class BankingRecognizedTransactionsController {
constructor(
private readonly recognizedTransactionsApplication: RecognizedTransactionsApplication,

2
packages/server/src/modules/BankingTransactions/controllers/BankingPendingTransactions.controller.ts
View File

@@ -10,10 +10,12 @@ import {
import { BankingTransactionsApplication } from '../BankingTransactionsApplication.service';
import { GetPendingTransactionsQueryDto } from '../dtos/GetPendingTransactionsQuery.dto';
import { GetPendingTransactionResponseDto } from '../dtos/GetPendingTransactionResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('banking/pending')
@ApiTags('Banking Pending Transactions')
@ApiExtraModels(GetPendingTransactionResponseDto)
@ApiCommonHeaders()
export class BankingPendingTransactionsController {
constructor(
private readonly bankingTransactionsApplication: BankingTransactionsApplication,

2
packages/server/src/modules/BankingTransactions/controllers/BankingTransactions.controller.ts
View File

@@ -22,10 +22,12 @@ import { CreateBankTransactionDto } from '../dtos/CreateBankTransaction.dto';
import { GetBankTransactionsQueryDto } from '../dtos/GetBankTranasctionsQuery.dto';
import { BankTransactionResponseDto } from '../dtos/BankTransactionResponse.dto';
import { PaginatedResponseDto } from '@/common/dtos/PaginatedResults.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('banking/transactions')
@ApiTags('Banking Transactions')
@ApiExtraModels(BankTransactionResponseDto, PaginatedResponseDto)
@ApiCommonHeaders()
export class BankingTransactionsController {
constructor(
private readonly bankingTransactionsApplication: BankingTransactionsApplication,

7
packages/server/src/modules/BankingTransactions/controllers/BankingUncategorizedTransactions.controller.ts
View File

@@ -8,9 +8,11 @@ import {
} from '@nestjs/swagger';
import { GetUncategorizedTransactionsQueryDto } from '../dtos/GetUncategorizedTransactionsQuery.dto';
import { BankingTransactionsApplication } from '../BankingTransactionsApplication.service';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('banking/uncategorized')
@ApiTags('Banking Uncategorized Transactions')
@ApiCommonHeaders()
export class BankingUncategorizedTransactionsController {
constructor(
private readonly bankingTransactionsApplication: BankingTransactionsApplication,
@@ -35,9 +37,10 @@ export class BankingUncategorizedTransactionsController {
description: 'Uncategorize transactions ID',
})
async getAutofillCategorizeTransaction(
@Query('uncategorizedTransactionIds') uncategorizedTransactionIds: Array<number> | number,
@Query('uncategorizedTransactionIds')
uncategorizedTransactionIds: Array<number> | number,
) {
console.log(uncategorizedTransactionIds)
console.log(uncategorizedTransactionIds);
return this.bankingTransactionsApplication.getAutofillCategorizeTransaction(
uncategorizedTransactionIds,
);

2
packages/server/src/modules/BankingTransactionsExclude/BankingTransactionsExclude.controller.ts
View File

@@ -18,10 +18,12 @@ import {
getSchemaPath,
} from '@nestjs/swagger';
import { GetExcludedBankTransactionResponseDto } from './dtos/GetExcludedBankTransactionResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('banking/exclude')
@ApiTags('Banking Transactions')
@ApiExtraModels(GetExcludedBankTransactionResponseDto)
@ApiCommonHeaders()
export class BankingTransactionsExcludeController {
constructor(
private readonly excludeBankTransactionsApplication: ExcludeBankTransactionsApplication,

2
packages/server/src/modules/BillLandedCosts/LandedCost.controller.ts
View File

@@ -14,9 +14,11 @@ import { BillAllocatedLandedCostTransactions } from './commands/BillAllocatedLan
import { RevertAllocatedLandedCost } from './commands/RevertAllocatedLandedCost.service';
import { LandedCostTranasctions } from './commands/LandedCostTransactions.service';
import { LandedCostTransactionsQueryDto } from './dtos/LandedCostTransactionsQuery.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@ApiTags('Landed Cost')
@Controller('landed-cost')
@ApiCommonHeaders()
export class BillAllocateLandedCostController {
constructor(
private allocateLandedCost: AllocateLandedCostService,

2
packages/server/src/modules/BillPayments/BillPayments.controller.ts
View File

@@ -25,11 +25,13 @@ import { GetBillPaymentsFilterDto } from './dtos/GetBillPaymentsFilter.dto';
import { BillPaymentsPages } from './commands/BillPaymentsPages.service';
import { BillPaymentResponseDto } from './dtos/BillPaymentResponse.dto';
import { PaginatedResponseDto } from '@/common/dtos/PaginatedResults.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('bill-payments')
@ApiTags('Bill Payments')
@ApiExtraModels(BillPaymentResponseDto)
@ApiExtraModels(PaginatedResponseDto)
@ApiCommonHeaders()
export class BillPaymentsController {
constructor(
private billPaymentsApplication: BillPaymentsApplication,

2
packages/server/src/modules/Bills/Bills.controller.ts
View File

@@ -21,11 +21,13 @@ import { IBillsFilter } from './Bills.types';
import { CreateBillDto, EditBillDto } from './dtos/Bill.dto';
import { BillResponseDto } from './dtos/BillResponse.dto';
import { PaginatedResponseDto } from '@/common/dtos/PaginatedResults.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('bills')
@ApiTags('Bills')
@ApiExtraModels(BillResponseDto)
@ApiExtraModels(PaginatedResponseDto)
@ApiCommonHeaders()
export class BillsController {
constructor(private billsApplication: BillsApplication) {}

2
packages/server/src/modules/Branches/Branches.controller.ts
View File

@@ -17,10 +17,12 @@ import {
getSchemaPath,
} from '@nestjs/swagger';
import { BranchResponseDto } from './dtos/BranchResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('branches')
@ApiTags('Branches')
@ApiExtraModels(BranchResponseDto)
@ApiCommonHeaders()
export class BranchesController {
constructor(private readonly branchesApplication: BranchesApplication) {}

2
packages/server/src/modules/CreditNoteRefunds/CreditNoteRefunds.controller.ts
View File

@@ -4,9 +4,11 @@ import { ICreditNoteRefundDTO } from '../CreditNotes/types/CreditNotes.types';
import { CreditNotesRefundsApplication } from './CreditNotesRefundsApplication.service';
import { RefundCreditNote } from './models/RefundCreditNote';
import { CreditNoteRefundDto } from './dto/CreditNoteRefund.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('credit-notes')
@ApiTags('Credit Note Refunds')
@ApiCommonHeaders()
export class CreditNoteRefundsController {
constructor(
private readonly creditNotesRefundsApplication: CreditNotesRefundsApplication,

2
packages/server/src/modules/CreditNotes/CreditNotes.controller.ts
View File

@@ -21,11 +21,13 @@ import { ICreditNotesQueryDTO } from './types/CreditNotes.types';
import { CreateCreditNoteDto, EditCreditNoteDto } from './dtos/CreditNote.dto';
import { CreditNoteResponseDto } from './dtos/CreditNoteResponse.dto';
import { PaginatedResponseDto } from '@/common/dtos/PaginatedResults.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('credit-notes')
@ApiTags('Credit Notes')
@ApiExtraModels(CreditNoteResponseDto)
@ApiExtraModels(PaginatedResponseDto)
@ApiCommonHeaders()
export class CreditNotesController {
/**
* @param {CreditNoteApplication} creditNoteApplication - The credit note application service.

2
packages/server/src/modules/Currencies/Currencies.controller.ts
View File

@@ -23,10 +23,12 @@ import { CurrenciesApplication } from './CurrenciesApplication.service';
import { CreateCurrencyDto } from './dtos/CreateCurrency.dto';
import { EditCurrencyDto } from './dtos/EditCurrency.dto';
import { CurrencyResponseDto } from './dtos/CurrencyResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@ApiTags('Currencies')
@Controller('/currencies')
@ApiExtraModels(CurrencyResponseDto)
@ApiCommonHeaders()
export class CurrenciesController {
constructor(private readonly currenciesApp: CurrenciesApplication) {}

2
packages/server/src/modules/Customers/Customers.controller.ts
View File

@@ -24,10 +24,12 @@ import { CreateCustomerDto } from './dtos/CreateCustomer.dto';
import { EditCustomerDto } from './dtos/EditCustomer.dto';
import { CustomerResponseDto } from './dtos/CustomerResponse.dto';
import { GetCustomersQueryDto } from './dtos/GetCustomersQuery.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('customers')
@ApiTags('Customers')
@ApiExtraModels(CustomerResponseDto)
@ApiCommonHeaders()
export class CustomersController {
constructor(private customersApplication: CustomersApplication) {}

2
packages/server/src/modules/Expenses/Expenses.controller.ts
View File

@@ -20,10 +20,12 @@ import {
import { CreateExpenseDto, EditExpenseDto } from './dtos/Expense.dto';
import { PaginatedResponseDto } from '@/common/dtos/PaginatedResults.dto';
import { ExpenseResponseDto } from './dtos/ExpenseResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('expenses')
@ApiTags('Expenses')
@ApiExtraModels(PaginatedResponseDto, ExpenseResponseDto)
@ApiCommonHeaders()
export class ExpensesController {
constructor(private readonly expensesApplication: ExpensesApplication) {}

2
packages/server/src/modules/FinancialStatements/modules/APAgingSummary/APAgingSummary.controller.ts
View File

@@ -10,9 +10,11 @@ import {
} from '@nestjs/swagger';
import { APAgingSummaryQueryDto } from './APAgingSummaryQuery.dto';
import { APAgingSummaryResponseExample } from './APAgingSummary.swagger';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('reports/payable-aging-summary')
@ApiTags('Reports')
@ApiCommonHeaders()
export class APAgingSummaryController {
constructor(private readonly APAgingSummaryApp: APAgingSummaryApplication) {}

2
packages/server/src/modules/FinancialStatements/modules/ARAgingSummary/ARAgingSummary.controller.ts
View File

@@ -11,9 +11,11 @@ import {
} from '@nestjs/swagger';
import { ARAgingSummaryQueryDto } from './ARAgingSummaryQuery.dto';
import { ARAgingSummaryResponseExample } from './ARAgingSummary.swagger';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('reports/receivable-aging-summary')
@ApiTags('Reports')
@ApiCommonHeaders()
export class ARAgingSummaryController {
constructor(private readonly ARAgingSummaryApp: ARAgingSummaryApplication) {}

2
packages/server/src/modules/FinancialStatements/modules/BalanceSheet/BalanceSheet.controller.ts
View File

@@ -10,9 +10,11 @@ import {
} from '@nestjs/swagger';
import { BalanceSheetQueryDto } from './BalanceSheet.dto';
import { BalanceSheetResponseExample } from './BalanceSheet.swagger';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('/reports/balance-sheet')
@ApiTags('Reports')
@ApiCommonHeaders()
export class BalanceSheetStatementController {
constructor(private readonly balanceSheetApp: BalanceSheetApplication) {}

2
packages/server/src/modules/FinancialStatements/modules/CashFlowStatement/Cashflow.controller.ts
View File

@@ -10,9 +10,11 @@ import {
} from '@nestjs/swagger';
import { CashFlowStatementQueryDto } from './CashFlowStatementQuery.dto';
import { CashflowStatementResponseExample } from './CashflowStatement.swagger';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('reports/cashflow-statement')
@ApiTags('Reports')
@ApiCommonHeaders()
export class CashflowController {
constructor(private readonly cashflowSheetApp: CashflowSheetApplication) {}

2
packages/server/src/modules/FinancialStatements/modules/CustomerBalanceSummary/CustomerBalanceSummary.controller.ts
View File

@@ -9,9 +9,11 @@ import { Controller, Get, Headers, Query, Res } from '@nestjs/common';
import { CustomerBalanceSummaryApplication } from './CustomerBalanceSummaryApplication';
import { CustomerBalanceSummaryQueryDto } from './CustomerBalanceSummaryQuery.dto';
import { AcceptType } from '@/constants/accept-type';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('/reports/customer-balance-summary')
@ApiTags('Reports')
@ApiCommonHeaders()
export class CustomerBalanceSummaryController {
constructor(
private readonly customerBalanceSummaryApp: CustomerBalanceSummaryApplication,

2
packages/server/src/modules/FinancialStatements/modules/GeneralLedger/GeneralLedger.controller.ts
View File

@@ -10,9 +10,11 @@ import { GeneralLedgerApplication } from './GeneralLedgerApplication';
import { AcceptType } from '@/constants/accept-type';
import { GeneralLedgerQueryDto } from './GeneralLedgerQuery.dto';
import { GeneralLedgerResponseExample } from './GeneralLedger.swagger';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('/reports/general-ledger')
@ApiTags('Reports')
@ApiCommonHeaders()
export class GeneralLedgerController {
constructor(
private readonly generalLedgerApplication: GeneralLedgerApplication,

2
packages/server/src/modules/FinancialStatements/modules/InventoryItemDetails/InventoryItemDetails.controller.ts
View File

@@ -4,9 +4,11 @@ import { Controller, Get, Headers, Query, Res } from '@nestjs/common';
import { InventoryItemDetailsApplication } from './InventoryItemDetailsApplication';
import { AcceptType } from '@/constants/accept-type';
import { InventoryItemDetailsQueryDto } from './InventoryItemDetailsQuery.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('reports/inventory-item-details')
@ApiTags('Reports')
@ApiCommonHeaders()
export class InventoryItemDetailsController {
constructor(
private readonly inventoryItemDetailsApp: InventoryItemDetailsApplication,

2
packages/server/src/modules/FinancialStatements/modules/InventoryValuationSheet/InventoryValuation.controller.ts
View File

@@ -9,9 +9,11 @@ import { Controller, Get, Headers, Query, Res } from '@nestjs/common';
import { InventoryValuationSheetApplication } from './InventoryValuationSheetApplication';
import { InventoryValuationQueryDto } from './InventoryValuationQuery.dto';
import { AcceptType } from '@/constants/accept-type';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('reports/inventory-valuation')
@ApiTags('Reports')
@ApiCommonHeaders()
export class InventoryValuationController {
constructor(
private readonly inventoryValuationApp: InventoryValuationSheetApplication,

2
packages/server/src/modules/FinancialStatements/modules/JournalSheet/JournalSheet.controller.ts
View File

@@ -10,9 +10,11 @@ import {
} from '@nestjs/swagger';
import { JournalSheetQueryDto } from './JournalSheetQuery.dto';
import { JournalSheetResponseExample } from './JournalSheet.swagger';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('/reports/journal')
@ApiTags('Reports')
@ApiCommonHeaders()
export class JournalSheetController {
constructor(private readonly journalSheetApp: JournalSheetApplication) {}

2
packages/server/src/modules/FinancialStatements/modules/ProfitLossSheet/ProfitLossSheet.controller.ts
View File

@@ -10,9 +10,11 @@ import {
} from '@nestjs/swagger';
import { ProfitLossSheetQueryDto } from './ProfitLossSheetQuery.dto';
import { ProfitLossSheetResponseExample } from './ProfitLossSheet.swagger';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('/reports/profit-loss-sheet')
@ApiTags('Reports')
@ApiCommonHeaders()
export class ProfitLossSheetController {
constructor(
private readonly profitLossSheetApp: ProfitLossSheetApplication,

2
packages/server/src/modules/FinancialStatements/modules/PurchasesByItems/PurchasesByItems.controller.ts
View File

@@ -4,9 +4,11 @@ import { PurchasesByItemsApplication } from './PurchasesByItemsApplication';
import { AcceptType } from '@/constants/accept-type';
import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
import { PurchasesByItemsQueryDto } from './PurchasesByItemsQuery.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('/reports/purchases-by-items')
@ApiTags('Reports')
@ApiCommonHeaders()
export class PurchasesByItemReportController {
constructor(
private readonly purchasesByItemsApp: PurchasesByItemsApplication,

2
packages/server/src/modules/FinancialStatements/modules/SalesByItems/SalesByItems.controller.ts
View File

@@ -12,9 +12,11 @@ import { SalesByItemsApplication } from './SalesByItemsApplication';
import { Response } from 'express';
import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
import { SalesByItemsQueryDto } from './SalesByItemsQuery.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('/reports/sales-by-items')
@ApiTags('Reports')
@ApiCommonHeaders()
export class SalesByItemsController {
constructor(private readonly salesByItemsApp: SalesByItemsApplication) {}

2
packages/server/src/modules/FinancialStatements/modules/SalesTaxLiabilitySummary/SalesTaxLiabilitySummary.controller.ts
View File

@@ -9,9 +9,11 @@ import { Controller, Get, Headers, Query, Res } from '@nestjs/common';
import { AcceptType } from '@/constants/accept-type';
import { SalesTaxLiabilitySummaryApplication } from './SalesTaxLiabilitySummaryApplication';
import { SalesTaxLiabilitySummaryQueryDto } from './dtos/SalesTaxLiabilityQuery.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('/reports/sales-tax-liability-summary')
@ApiTags('Reports')
@ApiCommonHeaders()
export class SalesTaxLiabilitySummaryController {
constructor(
private readonly salesTaxLiabilitySummaryApp: SalesTaxLiabilitySummaryApplication,

2
packages/server/src/modules/FinancialStatements/modules/TransactionsByCustomer/TransactionsByCustomer.controller.ts
View File

@@ -5,9 +5,11 @@ import { TransactionsByCustomerApplication } from './TransactionsByCustomersAppl
import { AcceptType } from '@/constants/accept-type';
import { Response } from 'express';
import { TransactionsByCustomerQueryDto } from './TransactionsByCustomerQuery.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('/reports/transactions-by-customers')
@ApiTags('Reports')
@ApiCommonHeaders()
export class TransactionsByCustomerController {
constructor(
private readonly transactionsByCustomersApp: TransactionsByCustomerApplication,

2
packages/server/src/modules/FinancialStatements/modules/TransactionsByVendor/TransactionsByVendor.controller.ts
View File

@@ -5,9 +5,11 @@ import { Response } from 'express';
import { TransactionsByVendorApplication } from './TransactionsByVendorApplication';
import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
import { TransactionsByVendorQueryDto } from './TransactionsByVendorQuery.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('/reports/transactions-by-vendors')
@ApiTags('Reports')
@ApiCommonHeaders()
export class TransactionsByVendorController {
constructor(
private readonly transactionsByVendorsApp: TransactionsByVendorApplication,

2
packages/server/src/modules/FinancialStatements/modules/TrialBalanceSheet/TrialBalanceSheet.controller.ts
View File

@@ -11,9 +11,11 @@ import { AcceptType } from '@/constants/accept-type';
import { TrialBalanceSheetApplication } from './TrialBalanceSheetApplication';
import { TrialBalanceSheetQueryDto } from './TrialBalanceSheetQuery.dto';
import { TrialBalanceSheetResponseExample } from './TrialBalanceSheet.swagger';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('reports/trial-balance-sheet')
@ApiTags('Reports')
@ApiCommonHeaders()
export class TrialBalanceSheetController {
constructor(
private readonly trialBalanceSheetApp: TrialBalanceSheetApplication,

2
packages/server/src/modules/FinancialStatements/modules/VendorBalanceSummary/VendorBalanceSummary.controller.ts
View File

@@ -10,9 +10,11 @@ import {
ApiTags,
} from '@nestjs/swagger';
import { VendorBalanceSummaryQueryDto } from './VendorBalanceSummaryQuery.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('/reports/vendor-balance-summary')
@ApiTags('Reports')
@ApiCommonHeaders()
export class VendorBalanceSummaryController {
constructor(
private readonly vendorBalanceSummaryApp: VendorBalanceSummaryApplication,

2
packages/server/src/modules/Import/Import.controller.ts
View File

@@ -16,9 +16,11 @@ import { ApiTags, ApiOperation, ApiResponse } from '@nestjs/swagger';
import { ImportResourceApplication } from './ImportResourceApplication';
import { uploadImportFileMulterOptions } from './ImportMulter.utils';
import { parseJsonSafe } from '@/utils/parse-json';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('import')
@ApiTags('Import')
@ApiCommonHeaders()
export class ImportController {
constructor(private readonly importResourceApp: ImportResourceApplication) {}

2
packages/server/src/modules/InventoryAdjutments/InventoryAdjustments.controller.ts
View File

@@ -20,10 +20,12 @@ import { IInventoryAdjustmentsFilter } from './types/InventoryAdjustments.types'
import { InventoryAdjustment } from './models/InventoryAdjustment';
import { CreateQuickInventoryAdjustmentDto } from './dtos/CreateQuickInventoryAdjustment.dto';
import { InventoryAdjustmentResponseDto } from './dtos/InventoryAdjustmentResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('inventory-adjustments')
@ApiTags('Inventory Adjustments')
@ApiExtraModels(InventoryAdjustmentResponseDto)
@ApiCommonHeaders()
export class InventoryAdjustmentsController {
constructor(
private readonly inventoryAdjustmentsApplicationService: InventoryAdjustmentsApplicationService,

2
packages/server/src/modules/InventoryCost/InventoryCost.controller.ts
View File

@@ -2,9 +2,11 @@ import { Controller, Get, Query } from '@nestjs/common';
import { GetItemsInventoryValuationListService } from './queries/GetItemsInventoryValuationList.service';
import { GetInventoyItemsCostQueryDto } from './dtos/GetInventoryItemsCostQuery.dto';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('inventory-cost')
@ApiTags('Inventory Cost')
@ApiCommonHeaders()
export class InventoryCostController {
constructor(
private readonly inventoryItemCost: GetItemsInventoryValuationListService,

2
packages/server/src/modules/ItemCategories/ItemCategory.controller.ts
View File

@@ -25,10 +25,12 @@ import {
EditItemCategoryDto,
} from './dtos/ItemCategory.dto';
import { ItemCategoryResponseDto } from './dtos/ItemCategoryResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('item-categories')
@ApiTags('Item Categories')
@ApiExtraModels(ItemCategoryResponseDto)
@ApiCommonHeaders()
export class ItemCategoryController {
constructor(
private readonly itemCategoryApplication: ItemCategoryApplication,

3
packages/server/src/modules/Items/Item.controller.ts
View File

@@ -4,7 +4,6 @@ import {
Delete,
Param,
Post,
UseGuards,
Patch,
Get,
Put,
@@ -29,6 +28,7 @@ import { ItemInvoiceResponseDto } from './dtos/itemInvoiceResponse.dto';
import { ItemEstimatesResponseDto } from './dtos/ItemEstimatesResponse.dto';
import { ItemBillsResponseDto } from './dtos/itemBillsResponse.dto';
import { ItemReceiptsResponseDto } from './dtos/ItemReceiptsResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('/items')
@ApiTags('Items')
@@ -39,6 +39,7 @@ import { ItemReceiptsResponseDto } from './dtos/ItemReceiptsResponse.dto';
@ApiExtraModels(ItemBillsResponseDto)
@ApiExtraModels(ItemEstimatesResponseDto)
@ApiExtraModels(ItemReceiptsResponseDto)
@ApiCommonHeaders()
export class ItemsController extends TenantController {
constructor(private readonly itemsApplication: ItemsApplicationService) {
super();

2
packages/server/src/modules/ManualJournals/ManualJournals.controller.ts
View File

@@ -24,10 +24,12 @@ import {
} from './dtos/ManualJournal.dto';
import { IManualJournalsFilter } from './types/ManualJournals.types';
import { ManualJournalResponseDto } from './dtos/ManualJournalResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('manual-journals')
@ApiTags('Manual Journals')
@ApiExtraModels(ManualJournalResponseDto)
@ApiCommonHeaders()
export class ManualJournalsController {
constructor(private manualJournalsApplication: ManualJournalsApplication) {}

2
packages/server/src/modules/Organization/Organization.controller.ts
View File

@@ -33,12 +33,14 @@ import {
OrganizationBuiltResponseExample,
} from './Organization.swagger';
import { GetCurrentOrganizationResponseDto } from './dtos/GetCurrentOrganizationResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@ApiTags('Organization')
@Controller('organization')
@IgnoreTenantInitializedRoute()
@IgnoreTenantSeededRoute()
@ApiExtraModels(GetCurrentOrganizationResponseDto)
@ApiCommonHeaders()
export class OrganizationController {
constructor(
private readonly buildOrganizationService: BuildOrganizationService,

2
packages/server/src/modules/PaymentLinks/PaymentLinks.controller.ts
View File

@@ -2,9 +2,11 @@ import { Response } from 'express';
import { Controller, Get, Param, Res } from '@nestjs/common';
import { PaymentLinksApplication } from './PaymentLinksApplication';
import { ApiOperation, ApiParam, ApiResponse, ApiTags } from '@nestjs/swagger';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('payment-links')
@ApiTags('Payment Links')
@ApiCommonHeaders()
export class PaymentLinksController {
constructor(private readonly paymentLinkApp: PaymentLinksApplication) {}

2
packages/server/src/modules/PaymentReceived/PaymentsReceived.controller.ts
View File

@@ -31,12 +31,14 @@ import { AcceptType } from '@/constants/accept-type';
import { PaymentReceivedResponseDto } from './dtos/PaymentReceivedResponse.dto';
import { PaginatedResponseDto } from '@/common/dtos/PaginatedResults.dto';
import { PaymentReceivedStateResponseDto } from './dtos/PaymentReceivedStateResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('payments-received')
@ApiTags('Payments Received')
@ApiExtraModels(PaymentReceivedResponseDto)
@ApiExtraModels(PaginatedResponseDto)
@ApiExtraModels(PaymentReceivedStateResponseDto)
@ApiCommonHeaders()
export class PaymentReceivesController {
constructor(private paymentReceivesApplication: PaymentReceivesApplication) {}

2
packages/server/src/modules/PdfTemplate/PdfTemplates.controller.ts
View File

@@ -10,9 +10,11 @@ import {
} from '@nestjs/common';
import { PdfTemplateApplication } from './PdfTemplate.application';
import { ICreateInvoicePdfTemplateDTO, IEditPdfTemplateDTO } from './types';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('pdf-templates')
@ApiTags('Pdf Templates')
@ApiCommonHeaders()
export class PdfTemplatesController {
constructor(
private readonly pdfTemplateApplication: PdfTemplateApplication,

5
packages/server/src/modules/Roles/Roles.controller.ts
View File

@@ -5,12 +5,11 @@ import {
Delete,
Param,
Body,
Res,
Next,
HttpStatus,
ParseIntPipe,
} from '@nestjs/common';
import { Response, NextFunction } from 'express';
import { NextFunction } from 'express';
import { CreateRoleDto, EditRoleDto } from './dtos/Role.dto';
import { RolesApplication } from './Roles.application';
import {
@@ -23,10 +22,12 @@ import {
ApiExtraModels,
} from '@nestjs/swagger';
import { RoleResponseDto } from './dtos/RoleResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@ApiTags('Roles')
@Controller('roles')
@ApiExtraModels(RoleResponseDto)
@ApiCommonHeaders()
export class RolesController {
constructor(private readonly rolesApp: RolesApplication) {}

2
packages/server/src/modules/SaleEstimates/SaleEstimates.controller.ts
View File

@@ -35,12 +35,14 @@ import { Response } from 'express';
import { SaleEstimateResponseDto } from './dtos/SaleEstimateResponse.dto';
import { PaginatedResponseDto } from '@/common/dtos/PaginatedResults.dto';
import { SaleEstiamteStateResponseDto } from './dtos/SaleEstimateStateResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('sale-estimates')
@ApiTags('Sale Estimates')
@ApiExtraModels(SaleEstimateResponseDto)
@ApiExtraModels(PaginatedResponseDto)
@ApiExtraModels(SaleEstiamteStateResponseDto)
@ApiCommonHeaders()
export class SaleEstimatesController {
/**
* @param {SaleEstimatesApplication} saleEstimatesApplication - Sale estimates application.

13
packages/server/src/modules/SaleInvoices/SaleInvoices.controller.ts
View File

@@ -21,7 +21,6 @@ import {
} from './SaleInvoice.types';
import { SaleInvoiceApplication } from './SaleInvoices.application';
import {
ApiHeader,
ApiOperation,
ApiParam,
ApiQuery,
@@ -39,6 +38,7 @@ import { SaleInvoiceResponseDto } from './dtos/SaleInvoiceResponse.dto';
import { PaginatedResponseDto } from '@/common/dtos/PaginatedResults.dto';
import { SaleInvoiceStateResponseDto } from './dtos/SaleInvoiceState.dto';
import { GenerateSaleInvoiceSharableLinkResponseDto } from './dtos/generateSaleInvoiceSharableLinkResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('sale-invoices')
@ApiTags('Sale Invoices')
@@ -46,16 +46,7 @@ import { GenerateSaleInvoiceSharableLinkResponseDto } from './dtos/generateSaleI
@ApiExtraModels(PaginatedResponseDto)
@ApiExtraModels(SaleInvoiceStateResponseDto)
@ApiExtraModels(GenerateSaleInvoiceSharableLinkResponseDto)
@ApiHeader({
name: 'organization-id',
description: 'The organization id',
required: true,
})
@ApiHeader({
name: 'x-access-token',
description: 'The authentication token',
required: true,
})
@ApiCommonHeaders()
export class SaleInvoicesController {
constructor(private saleInvoiceApplication: SaleInvoiceApplication) {}

2
packages/server/src/modules/SaleReceipts/SaleReceipts.controller.ts
View File

@@ -31,12 +31,14 @@ import { Response } from 'express';
import { SaleReceiptResponseDto } from './dtos/SaleReceiptResponse.dto';
import { PaginatedResponseDto } from '@/common/dtos/PaginatedResults.dto';
import { SaleReceiptStateResponseDto } from './dtos/SaleReceiptState.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('sale-receipts')
@ApiTags('Sale Receipts')
@ApiExtraModels(SaleReceiptResponseDto)
@ApiExtraModels(PaginatedResponseDto)
@ApiExtraModels(SaleReceiptStateResponseDto)
@ApiCommonHeaders()
export class SaleReceiptsController {
constructor(private saleReceiptApplication: SaleReceiptApplication) {}

2
packages/server/src/modules/System/SystemDB/SystemDB.module.ts
View File

@@ -5,7 +5,6 @@ import {
SystemKnexConnection,
SystemKnexConnectionConfigure,
} from './SystemDB.constants';
import { SystemDatabaseController } from './SystemDB.controller';
import { knexSnakeCaseMappers } from 'objection';
const providers = [
@@ -44,6 +43,5 @@ const providers = [
@Module({
providers: [...providers],
exports: [...providers],
controllers: [SystemDatabaseController],
})
export class SystemDatabaseModule {}

2
packages/server/src/modules/TaxRates/TaxRate.controller.ts
View File

@@ -17,10 +17,12 @@ import {
} from '@nestjs/swagger';
import { CreateTaxRateDto, EditTaxRateDto } from './dtos/TaxRate.dto';
import { TaxRateResponseDto } from './dtos/TaxRateResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('tax-rates')
@ApiTags('Tax Rates')
@ApiExtraModels(TaxRateResponseDto)
@ApiCommonHeaders()
export class TaxRatesController {
constructor(private readonly taxRatesApplication: TaxRatesApplication) {}

27
packages/server/src/modules/Tenancy/Tenancy.module.ts
View File

@@ -1,16 +1,13 @@
import { Module } from "@nestjs/common";
import { EnsureTenantIsInitializedGuard } from "./EnsureTenantIsInitialized.guard";
import { TenancyGlobalGuard } from "./TenancyGlobal.guard";
import { EnsureTenantIsSeededGuard } from "./EnsureTenantIsSeeded.guards";
import { APP_GUARD } from "@nestjs/core";
import { TenancyContext } from "./TenancyContext.service";
import { TenantController } from "./Tenant.controller";
import { TenancyInitializeModelsGuard } from "./TenancyInitializeModels.guard";
import { Module } from '@nestjs/common';
import { EnsureTenantIsInitializedGuard } from './EnsureTenantIsInitialized.guard';
import { TenancyGlobalGuard } from './TenancyGlobal.guard';
import { EnsureTenantIsSeededGuard } from './EnsureTenantIsSeeded.guards';
import { APP_GUARD } from '@nestjs/core';
import { TenancyContext } from './TenancyContext.service';
import { TenancyInitializeModelsGuard } from './TenancyInitializeModels.guard';
@Module({
exports: [TenancyContext],
controllers: [TenantController],
providers: [
TenancyContext,
{
@@ -23,12 +20,12 @@ import { TenancyInitializeModelsGuard } from "./TenancyInitializeModels.guard";
},
{
provide: APP_GUARD,
useClass: EnsureTenantIsSeededGuard
useClass: EnsureTenantIsSeededGuard,
},
{
provide: APP_GUARD,
useClass: TenancyInitializeModelsGuard
}
]
useClass: TenancyInitializeModelsGuard,
},
],
})
export class TenancyModule {}
export class TenancyModule {}

2
packages/server/src/modules/TransactionsLocking/TransactionsLocking.controller.ts
View File

@@ -15,10 +15,12 @@ import {
TransactionsLockingDto,
} from './dtos/TransactionsLocking.dto';
import { TransactionLockingResponseDto } from './dtos/TransactionLockingResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('transactions-locking')
@ApiTags('Transactions Locking')
@ApiExtraModels(TransactionLockingResponseDto)
@ApiCommonHeaders()
export class TransactionsLockingController {
constructor(
private readonly transactionsLockingService: TransactionsLockingService,

2
packages/server/src/modules/UsersModule/Users.controller.ts
View File

@@ -11,9 +11,11 @@ import {
import { ApiOperation, ApiTags, ApiResponse } from '@nestjs/swagger';
import { UsersApplication } from './Users.application';
import { EditUserDto } from './dtos/EditUser.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('users')
@ApiTags('Users')
@ApiCommonHeaders()
export class UsersController {
constructor(private readonly usersApplication: UsersApplication) {}

2
packages/server/src/modules/VendorCredit/VendorCredits.controller.ts
View File

@@ -15,9 +15,11 @@ import {
CreateVendorCreditDto,
EditVendorCreditDto,
} from './dtos/VendorCredit.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('vendor-credits')
@ApiTags('Vendor Credits')
@ApiCommonHeaders()
export class VendorCreditsController {
constructor(
private readonly vendorCreditsApplication: VendorCreditsApplicationService,

4
packages/server/src/modules/Vendors/Vendors.controller.ts
View File

@@ -17,9 +17,11 @@ import { ApiOperation, ApiTags } from '@nestjs/swagger';
import { CreateVendorDto } from './dtos/CreateVendor.dto';
import { EditVendorDto } from './dtos/EditVendor.dto';
import { GetVendorsQueryDto } from './dtos/GetVendorsQuery.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('vendors')
@ApiTags('vendors')
@ApiTags('Vendors')
@ApiCommonHeaders()
export class VendorsController {
constructor(private vendorsApplication: VendorsApplication) {}

2
packages/server/src/modules/Warehouses/Warehouses.controller.ts
View File

@@ -17,10 +17,12 @@ import {
} from '@nestjs/swagger';
import { CreateWarehouseDto, EditWarehouseDto } from './dtos/Warehouse.dto';
import { WarehouseResponseDto } from './dtos/WarehouseResponse.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('warehouses')
@ApiTags('Warehouses')
@ApiExtraModels(WarehouseResponseDto)
@ApiCommonHeaders()
export class WarehousesController {
constructor(private warehousesApplication: WarehousesApplication) {}

2
packages/server/src/modules/WarehousesTransfers/WarehouseTransfers.controller.ts
View File

@@ -24,10 +24,12 @@ import {
import { GetWarehouseTransfersQueryDto } from '../Warehouses/dtos/GetWarehouseTransfersQuery.dto';
import { WarehouseTransferResponseDto } from './dtos/WarehouseTransferResponse.dto';
import { PaginatedResponseDto } from '@/common/dtos/PaginatedResults.dto';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('warehouse-transfers')
@ApiTags('Warehouse Transfers')
@ApiExtraModels(WarehouseTransferResponseDto, PaginatedResponseDto)
@ApiCommonHeaders()
export class WarehouseTransfersController {
/**
* @param {WarehouseTransferApplication} warehouseTransferApplication - Warehouse transfer application.