Feature/validator

package.json

@@ -1,6 +1,6 @@
 {
   "name": "iSunFA",
-  "version": "0.8.1+7",
+  "version": "0.8.1+8",
   "private": false,
   "scripts": {
     "dev": "next dev",

src/constants/api_connection.ts

@@ -48,6 +48,7 @@ export enum APIName {
   OCR_LIST = 'OCR_LIST',
   INVOICE_CREATE = 'INVOICE_CREATE',
   INVOICE_UPDATE = 'INVOICE_UPDATE',
+  INVOICE_GET_BY_ID = 'INVOICE_GET_BY_ID',
   AI_ASK_STATUS = 'AI_ASK_STATUS',
   AI_ASK_RESULT = 'AI_ASK_RESULT',
   VOUCHER_CREATE = 'VOUCHER_CREATE',
@@ -113,6 +114,7 @@ export enum APIPath {
   OCR_LIST = `${apiPrefix}/company/:companyId/ocr`,
   INVOICE_CREATE = `${apiPrefix}/company/:companyId/invoice`,
   INVOICE_UPDATE = `${apiPrefix}/company/:companyId/invoice/:invoiceId`,
+  INVOICE_GET_BY_ID = `${apiPrefix}/company/:companyId/invoice/:invoiceId`,
   AI_ASK_STATUS = `${apiPrefix}/company/:companyId/ask_ai/:resultId/status`,
   AI_ASK_RESULT = `${apiPrefix}/company/:companyId/ask_ai/:resultId`,
   VOUCHER_CREATE = `${apiPrefix}/company/:companyId/voucher`,
@@ -232,6 +234,11 @@ export const APIConfig: Record<IAPIName, IAPIConfig> = {
     method: HttpMethod.PUT,
     path: APIPath.INVOICE_UPDATE,
   }),
+  [APIName.INVOICE_GET_BY_ID]: createConfig({
+    name: APIName.INVOICE_GET_BY_ID,
+    method: HttpMethod.GET,
+    path: APIPath.INVOICE_GET_BY_ID,
+  }),
   [APIName.AI_ASK_STATUS]: createConfig({
     name: APIName.AI_ASK_STATUS,
     method: HttpMethod.GET,

src/constants/ocr.ts

@@ -1,3 +1,8 @@
 import { ONE_MINUTE_IN_MS } from '@/constants/time';
 
 export const AVERAGE_OCR_PROCESSING_TIME = 30 * ONE_MINUTE_IN_MS;
+
+export enum ocrTypes {
+  INVOICE = 'invoice',
+  CONTRACT = 'contract',
+}

src/constants/zod_schema.ts

@@ -1,4 +1,16 @@
 import { APIName } from '@/constants/api_connection';
+import {
+  invoiceCreateValidator,
+  invoiceGetByIdValidator,
+  invoiceUpdateValidator,
+} from '@/lib/utils/zod_schema/invoice';
+import {
+  ocrDeleteValidator,
+  ocrListValidator,
+  ocrResultGetByIdValidator,
+  ocrUploadValidator,
+} from '@/lib/utils/zod_schema/ocr';
+import { voucherCreateValidator, voucherUpdateValidator } from '@/lib/utils/zod_schema/voucher';
 import { zodExampleValidator } from '@/lib/utils/zod_schema/zod_example';
 
 /*
@@ -14,4 +26,13 @@ import { zodExampleValidator } from '@/lib/utils/zod_schema/zod_example';
 
 export const API_ZOD_SCHEMA = {
   [APIName.ZOD_EXAMPLE]: zodExampleValidator,
+  [APIName.OCR_LIST]: ocrListValidator,
+  [APIName.OCR_UPLOAD]: ocrUploadValidator,
+  [APIName.OCR_RESULT_GET_BY_ID]: ocrResultGetByIdValidator,
+  [APIName.OCR_DELETE]: ocrDeleteValidator,
+  [APIName.INVOICE_CREATE]: invoiceCreateValidator,
+  [APIName.INVOICE_UPDATE]: invoiceUpdateValidator,
+  [APIName.INVOICE_GET_BY_ID]: invoiceGetByIdValidator,
+  [APIName.VOUCHER_CREATE]: voucherCreateValidator,
+  [APIName.VOUCHER_UPDATE]: voucherUpdateValidator,
 };

src/interfaces/api_connection.ts

@@ -31,6 +31,7 @@ export type IAPIName =
   | 'OCR_LIST'
   | 'INVOICE_CREATE'
   | 'INVOICE_UPDATE'
+  | 'INVOICE_GET_BY_ID'
   | 'AI_ASK_STATUS'
   | 'AI_ASK_RESULT'
   | 'VOUCHER_CREATE'

src/lib/utils/repo/ocr.repo.ts

@@ -1,5 +1,6 @@
 import prisma from '@/client';
 import { ProgressStatus } from '@/constants/account';
+import { ocrTypes } from '@/constants/ocr';
 import { SortOrder } from '@/constants/sort';
 import { STATUS_MESSAGE } from '@/constants/status_code';
 import { IAccountResultStatus } from '@/interfaces/accounting_account';
@@ -39,7 +40,7 @@ export async function findUniqueCompanyInPrisma(companyId: number) {
 
 export async function findManyOCRByCompanyIdWithoutUsedInPrisma(
   companyId: number,
-  ocrType: string = 'invoice'
+  ocrType: ocrTypes = ocrTypes.INVOICE
 ): Promise<ocrIncludeFile[]> {
   let ocrData: ocrIncludeFile[] = [];
 

src/lib/utils/zod_schema/invoice.ts

@@ -0,0 +1,73 @@
+import { EventType, PaymentPeriodType, PaymentStatusType } from '@/constants/account';
+import { IZodValidator } from '@/interfaces/zod_validator';
+import { z } from 'zod';
+
+const invoiceZod = z.object({
+  journalId: z.number().nullable(),
+  date: z.number(), // Info: (20240522 - Murky) timestamp
+  eventType: z.nativeEnum(EventType),
+  paymentReason: z.string(),
+  description: z.string(),
+  vendorOrSupplier: z.string(),
+  projectId: z.number().nullable(),
+  project: z.string().nullable(),
+  contractId: z.number().nullable(),
+  contract: z.string().nullable(),
+  payment: z.object({
+    isRevenue: z.boolean(),
+    price: z.number(),
+    hasTax: z.boolean(),
+    taxPercentage: z.number(),
+    hasFee: z.boolean(),
+    fee: z.number(),
+    method: z.string(),
+    period: z.nativeEnum(PaymentPeriodType),
+    installmentPeriod: z.number(),
+    alreadyPaid: z.number(),
+    status: z.nativeEnum(PaymentStatusType),
+    progress: z.number(),
+  }),
+});
+
+const invoiceCreateQueryValidator = z.object({});
+
+const invoiceCreateBodyValidator = z.object({
+  ocrId: z.number().optional(),
+  invoice: invoiceZod,
+});
+
+export const invoiceCreateValidator: IZodValidator<
+  (typeof invoiceCreateQueryValidator)['shape'],
+  (typeof invoiceCreateBodyValidator)['shape']
+> = {
+  // Info: (20240911 - Murky) GET /ocr
+  query: invoiceCreateQueryValidator,
+  body: invoiceCreateBodyValidator,
+};
+
+const invoiceUpdateQueryValidator = z.object({});
+const invoiceUpdateBodyValidator = z.object({
+  invoice: invoiceZod,
+});
+
+export const invoiceUpdateValidator: IZodValidator<
+  (typeof invoiceUpdateQueryValidator)['shape'],
+  (typeof invoiceUpdateBodyValidator)['shape']
+> = {
+  query: invoiceUpdateQueryValidator,
+  body: invoiceUpdateBodyValidator,
+};
+
+const invoiceGetByIdQueryValidator = z.object({
+  invoiceId: z.string().regex(/^\d+$/).transform(Number),
+});
+
+const invoiceGetByIdBodyValidator = z.object({});
+
+export const invoiceGetByIdValidator: IZodValidator<
+  (typeof invoiceGetByIdQueryValidator)['shape'],
+  (typeof invoiceGetByIdBodyValidator)['shape']
+> = {
+  query: invoiceGetByIdQueryValidator,
+  body: invoiceGetByIdBodyValidator,
+};

src/lib/utils/zod_schema/ocr.ts

@@ -0,0 +1,62 @@
+import { ocrTypes } from '@/constants/ocr';
+import { IZodValidator } from '@/interfaces/zod_validator';
+import { z } from 'zod';
+
+const ocrListQueryValidator = z.object({
+  ocrType: z.nativeEnum(ocrTypes).or(z.undefined()),
+});
+
+const ocrListBodyValidator = z.object({});
+
+export const ocrListValidator: IZodValidator<
+  (typeof ocrListQueryValidator)['shape'],
+  (typeof ocrListBodyValidator)['shape']
+> = {
+  // Info: (20240911 - Murky) GET /ocr
+  query: ocrListQueryValidator,
+  body: ocrListBodyValidator,
+};
+
+const ocrUploadQueryValidator = z.object({});
+const ocrUploadBodyValidator = z.object({
+  fileId: z.number(),
+  uploadIdentifier: z.string(),
+});
+
+export const ocrUploadValidator: IZodValidator<
+  (typeof ocrUploadQueryValidator)['shape'],
+  (typeof ocrUploadBodyValidator)['shape']
+> = {
+  // Info: (20240911 - Murky) POST /ocr
+  query: ocrUploadQueryValidator,
+  body: ocrUploadBodyValidator,
+};
+
+const ocrResultGetByIdQueryValidator = z.object({
+  resultId: z.string(),
+  ocrType: z.nativeEnum(ocrTypes).or(z.undefined()),
+});
+
+const ocrResultGetByIdBodyValidator = z.object({});
+
+export const ocrResultGetByIdValidator: IZodValidator<
+  (typeof ocrResultGetByIdQueryValidator)['shape'],
+  (typeof ocrResultGetByIdBodyValidator)['shape']
+> = {
+  query: ocrResultGetByIdQueryValidator,
+  body: ocrResultGetByIdBodyValidator,
+};
+
+const ocrDeleteQueryValidator = z.object({
+  resultId: z.string(),
+});
+
+const ocrDeleteBodyValidator = z.object({});
+
+export const ocrDeleteValidator: IZodValidator<
+  (typeof ocrDeleteQueryValidator)['shape'],
+  (typeof ocrDeleteBodyValidator)['shape']
+> = {
+  query: ocrDeleteQueryValidator,
+  body: ocrDeleteBodyValidator,
+};

src/lib/utils/zod_schema/voucher.ts

@@ -0,0 +1,41 @@
+import { IZodValidator } from '@/interfaces/zod_validator';
+import { z } from 'zod';
+
+const lineItemZod = z.object({
+  lineItemIndex: z.string(),
+  account: z.string(),
+  description: z.string(),
+  debit: z.boolean(),
+  amount: z.number(),
+  accountId: z.number(),
+});
+
+const voucherZod = z.object({
+  journalId: z.number(),
+  lineItems: z.array(lineItemZod),
+});
+
+const voucherCreateQueryValidator = z.object({});
+const voucherCreateBodyValidator = z.object({
+  voucher: voucherZod,
+});
+
+export const voucherCreateValidator: IZodValidator<
+  (typeof voucherCreateQueryValidator)['shape'],
+  (typeof voucherCreateBodyValidator)['shape']
+> = {
+  query: voucherCreateQueryValidator,
+  body: voucherCreateBodyValidator,
+};
+
+const voucherUpdateQueryValidator = z.object({
+  voucherId: z.string().regex(/^\d+$/).transform(Number),
+});
+
+export const voucherUpdateValidator: IZodValidator<
+  (typeof voucherUpdateQueryValidator)['shape'],
+  (typeof voucherCreateBodyValidator)['shape']
+> = {
+  query: voucherUpdateQueryValidator,
+  body: voucherCreateBodyValidator,
+};