@vulog/aima-document
Version:
334 lines (322 loc) • 5.82 kB
text/typescript
import { z } from 'zod';
export type DocumentType = {
id: number;
fleetId: string;
type: string;
name: string;
mandatory: boolean;
hasNumber: boolean;
hasExpirationDate: boolean;
numberUploadUrl: number;
hasIssuingCountry: boolean;
hasIssuingOffice: boolean;
hasIssuingDate: boolean;
hasDlClass: boolean;
};
export type FileUrl = {
id: number;
url: string;
name: string;
};
export type DocumentStatus = 'MISSING' | 'VALID' | 'INVALID' | 'EXPIRED' | 'PENDING_REVIEW';
export type DocumentFull = {
id: number;
fleetId: string;
userId: string;
documentType: DocumentType;
documentNumber?: string;
expirationDate?: string;
files: FileUrl[];
uploadUrls: FileUrl[];
status: DocumentStatus;
reviewer?: string;
issuingCountry?:
| 'AD'
| 'AE'
| 'AF'
| 'AG'
| 'AI'
| 'AL'
| 'AM'
| 'AN'
| 'AO'
| 'AQ'
| 'AR'
| 'AS'
| 'AT'
| 'AU'
| 'AW'
| 'AX'
| 'AZ'
| 'BA'
| 'BB'
| 'BD'
| 'BE'
| 'BF'
| 'BG'
| 'BH'
| 'BI'
| 'BJ'
| 'BL'
| 'BM'
| 'BN'
| 'BO'
| 'BQ'
| 'BR'
| 'BS'
| 'BT'
| 'BV'
| 'BW'
| 'BY'
| 'BZ'
| 'CA'
| 'CC'
| 'CD'
| 'CF'
| 'CG'
| 'CH'
| 'CI'
| 'CK'
| 'CL'
| 'CM'
| 'CN'
| 'CO'
| 'CR'
| 'CU'
| 'CV'
| 'CW'
| 'CX'
| 'CY'
| 'CZ'
| 'DE'
| 'DJ'
| 'DK'
| 'DM'
| 'DO'
| 'DZ'
| 'EC'
| 'EE'
| 'EG'
| 'EH'
| 'ER'
| 'ES'
| 'ET'
| 'FI'
| 'FJ'
| 'FK'
| 'FM'
| 'FO'
| 'FR'
| 'GA'
| 'GB'
| 'GD'
| 'GE'
| 'GF'
| 'GG'
| 'GH'
| 'GI'
| 'GL'
| 'GM'
| 'GN'
| 'GP'
| 'GQ'
| 'GR'
| 'GS'
| 'GT'
| 'GU'
| 'GW'
| 'GY'
| 'HK'
| 'HM'
| 'HN'
| 'HR'
| 'HT'
| 'HU'
| 'ID'
| 'IE'
| 'IL'
| 'IM'
| 'IN'
| 'IO'
| 'IQ'
| 'IR'
| 'IS'
| 'IT'
| 'JE'
| 'JM'
| 'JO'
| 'JP'
| 'KE'
| 'KG'
| 'KH'
| 'KI'
| 'KM'
| 'KN'
| 'KP'
| 'KR'
| 'KW'
| 'KY'
| 'KZ'
| 'LA'
| 'LB'
| 'LC'
| 'LI'
| 'LK'
| 'LR'
| 'LS'
| 'LT'
| 'LU'
| 'LV'
| 'LY'
| 'MA'
| 'MC'
| 'MD'
| 'ME'
| 'MF'
| 'MG'
| 'MH'
| 'MK'
| 'ML'
| 'MM'
| 'MN'
| 'MO'
| 'MP'
| 'MQ'
| 'MR'
| 'MS'
| 'MT'
| 'MU'
| 'MV'
| 'MW'
| 'MX'
| 'MY'
| 'MZ'
| 'NA'
| 'NC'
| 'NE'
| 'NF'
| 'NG'
| 'NI'
| 'NL'
| 'NO'
| 'NP'
| 'NR'
| 'NU'
| 'NZ'
| 'OM'
| 'PA'
| 'PE'
| 'PF'
| 'PG'
| 'PH'
| 'PK'
| 'PL'
| 'PM'
| 'PN'
| 'PR'
| 'PS'
| 'PT'
| 'PW'
| 'PY'
| 'QA'
| 'RE'
| 'RO'
| 'RS'
| 'RU'
| 'RW'
| 'SA'
| 'SB'
| 'SC'
| 'SD'
| 'SE'
| 'SG'
| 'SH'
| 'SI'
| 'SJ'
| 'SK'
| 'SL'
| 'SM'
| 'SN'
| 'SO'
| 'SR'
| 'SS'
| 'ST'
| 'SV'
| 'SX'
| 'SY'
| 'SZ'
| 'TC'
| 'TD'
| 'TF'
| 'TG'
| 'TH'
| 'TJ'
| 'TK'
| 'TL'
| 'TM'
| 'TN'
| 'TO'
| 'TR'
| 'TT'
| 'TV'
| 'TW'
| 'TZ'
| 'UA'
| 'UG'
| 'UM'
| 'US'
| 'UY'
| 'UZ'
| 'VA'
| 'VC'
| 'VE'
| 'VG'
| 'VI'
| 'VN'
| 'VU'
| 'WF'
| 'WS'
| 'YE'
| 'YT'
| 'ZA'
| 'ZM'
| 'ZW';
issuingOffice: string;
issuingDate: string;
dlClass: string;
};
export type DocumentBody = Partial<
Omit<DocumentFull, 'id' | 'fleetId' | 'documentType' | 'files' | 'uploadUrls'> | 'status' | 'reviewer'
> & {
documentType: string;
};
export type DocumentStatusReview = {
status: DocumentStatus;
reviewer: string;
};
export type DocumentByService = {
serviceId: string;
areMandatoryPresent: boolean;
mandatoryDocumentTypeId: number[];
};
export type DocumentByFranchise = {
fleetId: string;
serviceId: string;
mandatoryDocumentTypeId: number[];
};
export type DocumentSummary = {
documentTypes: DocumentType[];
documents: DocumentFull[];
documentByService: DocumentByService[];
documentByFranchise: DocumentByFranchise[] | null;
};
export const personalInformationDocumentTypes = ['documentNumber1'] as const;
export type PersonalInformationDocumentType = (typeof personalInformationDocumentTypes)[number];
export const personalInformationDocumentTypeSchema = z.enum(personalInformationDocumentTypes);
export type PersonalInformationDocument = {
fleetId: string;
userId: string;
documentId: string;
documentNumber1?: string;
updateDate: string;
};