-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: 🎸 mock trial-balance and ledger APIs with zod and unit
test ✅ Closes: #2641
- Loading branch information
1 parent
1da9730
commit 5a153e1
Showing
12 changed files
with
577 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
import { IZodValidator } from '@/interfaces/zod_validator'; | ||
import { z } from 'zod'; | ||
import { zodStringToNumberWithDefault, zodTimestampInSeconds } from '@/lib/utils/zod_schema/common'; | ||
import { DEFAULT_PAGE_NUMBER } from '@/constants/display'; | ||
import { DEFAULT_PAGE_LIMIT } from '@/constants/config'; | ||
import { SortOrder } from '@/constants/sort'; | ||
|
||
const ledgerListQueryValidator = z.object({ | ||
page: zodStringToNumberWithDefault(DEFAULT_PAGE_NUMBER), | ||
pageSize: zodStringToNumberWithDefault(DEFAULT_PAGE_LIMIT), | ||
sortOrder: z.nativeEnum(SortOrder).optional(), | ||
startDate: zodTimestampInSeconds(true, 0), | ||
endDate: zodTimestampInSeconds(true, Infinity), | ||
startAccountNo: z.string().optional(), | ||
endAccountNo: z.string().optional(), | ||
labelType: z.enum(['general', 'detailed', 'all']).optional(), | ||
}); | ||
|
||
export const ledgerReturnValidator = z.object({ | ||
id: z.number(), | ||
voucherDate: z.number(), | ||
no: z.string(), | ||
accountingTitle: z.string(), | ||
voucherNumber: z.string(), | ||
particulars: z.string(), | ||
debitAmount: z.number(), | ||
creditAmount: z.number(), | ||
balance: z.number(), | ||
createAt: z.number(), | ||
updateAt: z.number(), | ||
}); | ||
|
||
export const ledgerListReturnValidator = z.object({ | ||
currency: z.string(), | ||
items: z.object({ | ||
data: z.array(ledgerReturnValidator), | ||
page: z.number(), | ||
totalPages: z.number(), | ||
totalCount: z.number(), | ||
pageSize: z.number(), | ||
hasNextPage: z.boolean(), | ||
hasPreviousPage: z.boolean(), | ||
sort: z.array( | ||
z.object({ | ||
sortBy: z.string(), | ||
sortOrder: z.string(), | ||
}) | ||
), | ||
}), | ||
totalDebitAmount: z.number(), | ||
totalCreditAmount: z.number(), | ||
}); | ||
|
||
export const ledgerListValidator: IZodValidator< | ||
(typeof ledgerListQueryValidator)['shape'], | ||
z.ZodOptional<z.ZodNullable<z.ZodString>> | ||
> = { | ||
query: ledgerListQueryValidator, | ||
body: z.string().nullable().optional(), | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
import { IZodValidator } from '@/interfaces/zod_validator'; | ||
import { z } from 'zod'; | ||
import { zodStringToNumberWithDefault, zodTimestampInSeconds } from '@/lib/utils/zod_schema/common'; | ||
import { DEFAULT_PAGE_NUMBER } from '@/constants/display'; | ||
import { DEFAULT_PAGE_LIMIT } from '@/constants/config'; | ||
import { SortOrder } from '@/constants/sort'; | ||
|
||
const trialBalanceListQueryValidator = z.object({ | ||
page: zodStringToNumberWithDefault(DEFAULT_PAGE_NUMBER), | ||
pageSize: zodStringToNumberWithDefault(DEFAULT_PAGE_LIMIT), | ||
sortOrder: z.nativeEnum(SortOrder).optional(), | ||
startDate: zodTimestampInSeconds(true, 0), | ||
endDate: zodTimestampInSeconds(true, Infinity), | ||
}); | ||
|
||
const basicTrialBalanceReturnValidator = z.object({ | ||
id: z.number(), | ||
no: z.string(), | ||
accountingTitle: z.string(), | ||
beginningCreditAmount: z.number(), | ||
beginningDebitAmount: z.number(), | ||
midtermCreditAmount: z.number(), | ||
midtermDebitAmount: z.number(), | ||
endingCreditAmount: z.number(), | ||
endingDebitAmount: z.number(), | ||
createAt: z.number(), | ||
updateAt: z.number(), | ||
}); | ||
|
||
export const trialBalanceReturnValidator = z.object({ | ||
id: z.number(), | ||
no: z.string(), | ||
accountingTitle: z.string(), | ||
beginningCreditAmount: z.number(), | ||
beginningDebitAmount: z.number(), | ||
midtermCreditAmount: z.number(), | ||
midtermDebitAmount: z.number(), | ||
endingCreditAmount: z.number(), | ||
endingDebitAmount: z.number(), | ||
createAt: z.number(), | ||
updateAt: z.number(), | ||
subAccounts: z.array(basicTrialBalanceReturnValidator), | ||
}); | ||
|
||
export const trialBalanceListReturnValidator = z.array(trialBalanceReturnValidator); | ||
|
||
export const trialBalanceListValidator: IZodValidator< | ||
(typeof trialBalanceListQueryValidator)['shape'], | ||
z.ZodOptional<z.ZodNullable<z.ZodString>> | ||
> = { | ||
query: trialBalanceListQueryValidator, | ||
body: z.string().nullable().optional(), | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
import { NextApiRequest, NextApiResponse } from 'next'; | ||
import { handleGetRequest } from '@/pages/api/v2/company/[companyId]/ledger/index'; | ||
import { STATUS_MESSAGE } from '@/constants/status_code'; | ||
|
||
let req: jest.Mocked<NextApiRequest>; | ||
let res: jest.Mocked<NextApiResponse>; | ||
|
||
jest.mock('../../../../../../lib/utils/session.ts', () => ({ | ||
getSession: jest.fn().mockResolvedValue({ | ||
userId: 1001, | ||
companyId: 1001, | ||
}), | ||
})); | ||
|
||
jest.mock('../../../../../../lib/utils/request_validator', () => ({ | ||
validateRequest: jest.fn().mockReturnValue({ | ||
query: { | ||
startDate: '2024-01-01', | ||
endDate: '2024-12-31', | ||
startAccountNo: '1000', | ||
endAccountNo: '9999', | ||
labelType: 'all', | ||
page: 1, | ||
pageSize: 10, | ||
sortOrder: 'asc', | ||
}, | ||
}), | ||
})); | ||
|
||
beforeEach(() => { | ||
req = { | ||
headers: {}, | ||
query: {}, | ||
method: '', | ||
socket: {}, | ||
json: jest.fn(), | ||
} as unknown as jest.Mocked<NextApiRequest>; | ||
|
||
res = { | ||
status: jest.fn().mockReturnThis(), | ||
json: jest.fn(), | ||
} as unknown as jest.Mocked<NextApiResponse>; | ||
}); | ||
|
||
afterEach(() => { | ||
jest.clearAllMocks(); | ||
}); | ||
|
||
describe('company/[companyId]/ledger', () => { | ||
describe('GET Ledger List', () => { | ||
it('should return ledger list', async () => { | ||
req.query = { | ||
companyId: '1001', | ||
}; | ||
|
||
const { payload, statusMessage } = await handleGetRequest(req, res); | ||
|
||
expect(statusMessage).toBe(STATUS_MESSAGE.SUCCESS_LIST); | ||
expect(payload).toHaveProperty('currency', 'TWD'); | ||
expect(payload).toHaveProperty('items'); | ||
expect(payload?.items).toHaveProperty('data'); | ||
expect(payload?.items.data).toBeInstanceOf(Array); | ||
expect(payload).toHaveProperty('totalDebitAmount'); | ||
expect(payload).toHaveProperty('totalCreditAmount'); | ||
}); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,123 @@ | ||
import { STATUS_MESSAGE } from '@/constants/status_code'; | ||
import { IResponseData } from '@/interfaces/response_data'; | ||
import { formatApiResponse } from '@/lib/utils/common'; | ||
import { getSession } from '@/lib/utils/session'; | ||
import { NextApiRequest, NextApiResponse } from 'next'; | ||
import { validateRequest } from '@/lib/utils/request_validator'; | ||
import { APIName } from '@/constants/api_connection'; | ||
import { mockLedgerList } from '@/pages/api/v2/company/[companyId]/ledger/service'; | ||
|
||
type APIResponse = { | ||
currency: string; | ||
items: { | ||
data: Array<{ | ||
id: number; | ||
voucherDate: number; | ||
no: string; | ||
accountingTitle: string; | ||
voucherNumber: string; | ||
particulars: string; | ||
debitAmount: number; | ||
creditAmount: number; | ||
balance: number; | ||
createAt: number; | ||
updateAt: number; | ||
}>; | ||
page: number; | ||
totalPages: number; | ||
totalCount: number; | ||
pageSize: number; | ||
hasNextPage: boolean; | ||
hasPreviousPage: boolean; | ||
sort: Array<{ | ||
sortBy: string; | ||
sortOrder: string; | ||
}>; | ||
}; | ||
totalDebitAmount: number; | ||
totalCreditAmount: number; | ||
} | null; | ||
|
||
export async function handleGetRequest(req: NextApiRequest, res: NextApiResponse<APIResponse>) { | ||
let statusMessage: string = STATUS_MESSAGE.BAD_REQUEST; | ||
let payload: APIResponse = null; | ||
|
||
// TODO: 實作時確認 auth (20240926 - Shirley) | ||
const session = await getSession(req, res); | ||
const { userId } = session; | ||
|
||
const { query } = validateRequest(APIName.LEDGER_LIST_V2, req, userId); | ||
|
||
if (query) { | ||
// TODO: 實作 API 時補上 (20240926 - Shirley) | ||
/* eslint-disable @typescript-eslint/no-unused-vars */ | ||
const { | ||
startDate, | ||
endDate, | ||
startAccountNo, | ||
endAccountNo, | ||
labelType, | ||
page, | ||
pageSize, | ||
sortOrder, | ||
} = query; | ||
|
||
statusMessage = STATUS_MESSAGE.SUCCESS_LIST; | ||
payload = { | ||
currency: 'TWD', | ||
items: { | ||
data: mockLedgerList, | ||
page: page ?? 1, | ||
totalPages: 1, | ||
totalCount: mockLedgerList.length, | ||
pageSize: pageSize ?? mockLedgerList.length, | ||
hasNextPage: false, | ||
hasPreviousPage: false, | ||
sort: [ | ||
{ | ||
sortBy: 'no', | ||
sortOrder: 'asc', | ||
}, | ||
], | ||
}, | ||
totalDebitAmount: 2300000, | ||
totalCreditAmount: 1300000, | ||
}; | ||
} | ||
|
||
return { | ||
statusMessage, | ||
payload, | ||
}; | ||
} | ||
|
||
const methodHandlers: { | ||
[key: string]: ( | ||
req: NextApiRequest, | ||
res: NextApiResponse | ||
) => Promise<{ statusMessage: string; payload: APIResponse }>; | ||
} = { | ||
GET: handleGetRequest, | ||
}; | ||
|
||
export default async function handler( | ||
req: NextApiRequest, | ||
res: NextApiResponse<IResponseData<APIResponse>> | ||
) { | ||
let statusMessage: string = STATUS_MESSAGE.BAD_REQUEST; | ||
let payload: APIResponse = null; | ||
|
||
try { | ||
const handleRequest = methodHandlers[req.method || '']; | ||
if (handleRequest) { | ||
({ statusMessage, payload } = await handleRequest(req, res)); | ||
} else { | ||
statusMessage = STATUS_MESSAGE.METHOD_NOT_ALLOWED; | ||
} | ||
} catch (_error) { | ||
const error = _error as Error; | ||
statusMessage = error.message; | ||
} | ||
const { httpCode, result } = formatApiResponse<APIResponse>(statusMessage, payload); | ||
res.status(httpCode).json(result); | ||
} |
Oops, something went wrong.