refactor(validation): slim view by isolating document contracts

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>

Author: vitormattos

src/views/Validation.vue

@@ -129,6 +129,14 @@ import { openDocument } from '../utils/viewer.js'
 import { getStatusLabel } from '../utils/fileStatus.js'
 import { getSigningRouteUuid } from '../utils/signRequestUuid.ts'
 import { FILE_STATUS, SIGN_REQUEST_STATUS } from '../constants.js'
+import {
+	isLoadedValidationEnvelopeDocument,
+	isLoadedValidationFileDocument,
+	MODIFICATION_ALLOWED,
+	MODIFICATION_UNMODIFIED,
+	MODIFICATION_VIOLATION,
+	toValidationDocument,
+} from '../services/validationDocument'
 import logger from '../logger.js'
 import { useFilesStore } from '../store/files.js'
 import { useSignStore } from '../store/sign.js'
@@ -138,6 +146,13 @@ import type {
 	ValidatedChildFileRecord,
 	ValidationFileRecord,
 } from '../types/index'
+import type {
+	LoadedValidationEnvelopeDocumentState,
+	LoadedValidationFileDocumentState,
+	ValidationDocumentState,
+	ValidationModificationInfo,
+	ValidationStatusInfo,
+} from '../services/validationDocument'
 
 defineOptions({
 	name: 'Validation',
@@ -161,25 +176,7 @@ type RouterState = {
 }
 
 type ToggleOpenState = Record<number, boolean>
-type ValidationStatus = ValidationFileRecord['status']
-type ValidationStatusInfo = {
-	id?: number
-	label?: string
-}
-
-const MODIFICATION_UNMODIFIED = 1
-const MODIFICATION_ALLOWED = 2
-const MODIFICATION_VIOLATION = 3
 
-type ModificationValidationStatus =
-	typeof MODIFICATION_UNMODIFIED
-	| typeof MODIFICATION_ALLOWED
-	| typeof MODIFICATION_VIOLATION
-
-type ValidationModificationInfo = {
-	status?: ModificationValidationStatus
-	valid?: boolean
-}
 type ValidationDisplaySigner = SignerDetailRecord & {
 	signature_validation?: ValidationStatusInfo
 	certificate_validation?: ValidationStatusInfo
@@ -209,41 +206,8 @@ type ValidationErrorResponse = {
 	}
 }
 
-type ValidationMetadataDimension = {
-	w: number
-	h: number
-}
-
-type ValidationDocumentState = ValidationFileRecord & {
-	signers: SignerDetailRecord[]
-	metadata: NonNullable<ValidationFileRecord['metadata']>
-	settings: NonNullable<ValidationFileRecord['settings']>
-}
-
-type LoadedValidationEnvelopeDocumentState = ValidationDocumentState & {
-	nodeType: 'envelope'
-}
-
-type LoadedValidationFileDocumentState = ValidationDocumentState & {
-	nodeType: 'file'
-}
-
-type UnknownRecord = Record<string, unknown>
-
-function isRecord(value: unknown): value is Record<string, unknown> {
-	return typeof value === 'object' && value !== null
-}
-
-function hasOwn(record: UnknownRecord, key: string): boolean {
-	return Object.prototype.hasOwnProperty.call(record, key)
-}
-
-function isOptionalField(record: UnknownRecord, key: string, guard: (value: unknown) => boolean): boolean {
-	return !hasOwn(record, key) || guard(record[key])
-}
-
 function normalizeRouteRecord(value: unknown, source: 'params' | 'query'): Record<string, string> {
-	if (!isRecord(value)) {
+	if (typeof value !== 'object' || value === null) {
 		return {}
 	}
 
@@ -271,22 +235,6 @@ function toNumber(value: unknown): number | null {
 	return typeof value === 'number' && Number.isFinite(value) ? value : null
 }
 
-function isValidationStatus(value: unknown): value is ValidationStatus {
-	const normalizedValue = toNumber(value)
-	return normalizedValue === FILE_STATUS.DRAFT
-		|| normalizedValue === FILE_STATUS.ABLE_TO_SIGN
-		|| normalizedValue === FILE_STATUS.PARTIAL_SIGNED
-		|| normalizedValue === FILE_STATUS.SIGNED
-		|| normalizedValue === FILE_STATUS.DELETED
-}
-
-function isSignerStatus(value: unknown): value is SignerDetailRecord['status'] {
-	const normalizedValue = toNumber(value)
-	return normalizedValue === SIGN_REQUEST_STATUS.DRAFT
-		|| normalizedValue === SIGN_REQUEST_STATUS.ABLE_TO_SIGN
-		|| normalizedValue === SIGN_REQUEST_STATUS.SIGNED
-}
-
 function isValidationRouteName(value: RouteState['name']): value is ValidationRouteName {
 	return value === 'validation'
 		|| value === 'ValidationFile'
@@ -298,220 +246,13 @@ function isSignedDocumentStatus(status: unknown): boolean {
 	return Number(status) === FILE_STATUS.SIGNED
 }
 
-function isString(value: unknown): value is string {
-	return typeof value === 'string'
-}
-
-function isNullableString(value: unknown): value is string | null {
-	return value === null || typeof value === 'string'
-}
-
-function isValidationStatusInfo(value: unknown): value is ValidationStatusInfo {
-	if (!isRecord(value)) {
-		return false
-	}
-
-	return isOptionalField(value, 'id', fieldValue => typeof fieldValue === 'number')
-		&& isOptionalField(value, 'label', isString)
-}
-
-function isValidationModificationInfo(value: unknown): value is ValidationModificationInfo {
-	if (!isRecord(value)) {
-		return false
-	}
-
-	return isOptionalField(value, 'status', isModificationValidationStatus)
-		&& isOptionalField(value, 'valid', fieldValue => typeof fieldValue === 'boolean')
-}
-
-function isModificationValidationStatus(value: unknown): value is ModificationValidationStatus {
-	return value === MODIFICATION_UNMODIFIED
-		|| value === MODIFICATION_ALLOWED
-		|| value === MODIFICATION_VIOLATION
-}
-
-function isValidationMetadataDimension(value: unknown): value is ValidationMetadataDimension {
-	if (!isRecord(value)) {
-		return false
-	}
-
-	return typeof value.w === 'number' && Number.isFinite(value.w)
-		&& typeof value.h === 'number' && Number.isFinite(value.h)
-}
-
-function isRequestedBy(value: unknown): value is ValidationFileRecord['requested_by'] {
-	if (!isRecord(value)) {
-		return false
-	}
-	return isString(value.userId) && isString(value.displayName)
-}
-
-function isValidationMetadata(value: unknown): value is NonNullable<ValidationFileRecord['metadata']> {
-	if (!isRecord(value)) {
-		return false
-	}
-
-	if (!isString(value.extension) || typeof value.p !== 'number') {
-		return false
-	}
-
-	return isOptionalField(value, 'd', fieldValue => Array.isArray(fieldValue) && fieldValue.every(isValidationMetadataDimension))
-		&& isOptionalField(value, 'original_file_deleted', fieldValue => typeof fieldValue === 'boolean')
-		&& isOptionalField(value, 'pdfVersion', isString)
-		&& isOptionalField(value, 'status_changed_at', isString)
-}
-
-function isValidationSettings(value: unknown): value is NonNullable<ValidationFileRecord['settings']> {
-	if (!isRecord(value)) {
-		return false
-	}
-	return typeof value.canSign === 'boolean'
-		&& typeof value.canRequestSign === 'boolean'
-		&& typeof value.phoneNumber === 'string'
-		&& typeof value.hasSignatureFile === 'boolean'
-		&& typeof value.needIdentificationDocuments === 'boolean'
-		&& typeof value.identificationDocumentsWaitingApproval === 'boolean'
-		&& isOptionalField(value, 'isApprover', fieldValue => typeof fieldValue === 'boolean')
-}
-
-function isSignerDetailRecord(value: unknown): value is SignerDetailRecord {
-	if (!isRecord(value)) {
-		return false
-	}
-
-	return typeof value.signRequestId === 'number'
-		&& isString(value.displayName)
-		&& isString(value.email)
-		&& isNullableString(value.signed)
-		&& isSignerStatus(value.status)
-		&& isString(value.statusText)
-		&& isNullableString(value.description)
-		&& isString(value.request_sign_date)
-		&& typeof value.me === 'boolean'
-		&& Array.isArray(value.visibleElements)
-		&& isOptionalField(value, 'signature_validation', isValidationStatusInfo)
-		&& isOptionalField(value, 'certificate_validation', isValidationStatusInfo)
-		&& isOptionalField(value, 'modification_validation', isValidationModificationInfo)
-		&& isOptionalField(value, 'crl_validation', isString)
-		&& isOptionalField(value, 'isLibreSignRootCA', fieldValue => typeof fieldValue === 'boolean')
-}
-
-function isValidatedChildFileRecord(value: unknown): value is ValidatedChildFileRecord {
-	if (!isRecord(value)) {
-		return false
-	}
-
-	return typeof value.id === 'number'
-		&& isString(value.uuid)
-		&& isString(value.name)
-		&& isValidationStatus(value.status)
-		&& isString(value.statusText)
-		&& typeof value.nodeId === 'number'
-		&& typeof value.size === 'number'
-		&& Array.isArray(value.signers)
-		&& isString(value.file)
-		&& isValidationMetadata(value.metadata)
-}
-
-function isValidationDocumentRecord(data: unknown): data is ValidationFileRecord {
-	if (!isRecord(data)) {
-		return false
-	}
-	if (
-		typeof data.id !== 'number'
-		|| !isString(data.uuid)
-		|| !isString(data.name)
-		|| !isValidationStatus(data.status)
-		|| !isString(data.statusText)
-		|| typeof data.nodeId !== 'number'
-		|| (data.nodeType !== 'file' && data.nodeType !== 'envelope')
-		|| typeof data.signatureFlow !== 'number'
-		|| typeof data.docmdpLevel !== 'number'
-		|| typeof data.filesCount !== 'number'
-		|| !Array.isArray(data.files)
-		|| typeof data.totalPages !== 'number'
-		|| typeof data.size !== 'number'
-		|| !isString(data.pdfVersion)
-		|| !isString(data.created_at)
-		|| !isRequestedBy(data.requested_by)
-	) {
-		return false
-	}
-
-	if (!data.files.every(isValidatedChildFileRecord)) {
-		return false
-	}
-
-	if (hasOwn(data, 'signers') && (!Array.isArray(data.signers) || !data.signers.every(isSignerDetailRecord))) {
-		return false
-	}
-
-	if (hasOwn(data, 'metadata') && !isValidationMetadata(data.metadata)) {
-		return false
-	}
-
-	if (hasOwn(data, 'settings') && !isValidationSettings(data.settings)) {
-		return false
-	}
-
-	return true
-}
-
-const DEFAULT_VALIDATION_METADATA: NonNullable<ValidationFileRecord['metadata']> = {
-	extension: 'pdf',
-	p: 0,
-}
-
-const DEFAULT_VALIDATION_SETTINGS: NonNullable<ValidationFileRecord['settings']> = {
-	canSign: false,
-	canRequestSign: false,
-	phoneNumber: '',
-	hasSignatureFile: false,
-	needIdentificationDocuments: false,
-	identificationDocumentsWaitingApproval: false,
-}
-
-function toValidationDocument(data: unknown): ValidationDocumentState | null {
-	if (!isValidationDocumentRecord(data)) {
-		return null
-	}
-
-	const metadata = isValidationMetadata(data.metadata)
-		? data.metadata
-		: {
-			...DEFAULT_VALIDATION_METADATA,
-			p: data.totalPages,
-		}
-
-	const settings = isValidationSettings(data.settings)
-		? data.settings
-		: DEFAULT_VALIDATION_SETTINGS
-
-	const signers = Array.isArray(data.signers) ? data.signers : []
-
-	return {
-		...data,
-		metadata,
-		settings,
-		signers,
-	}
-}
-
 function getValidationErrorMessage(response: ValidationErrorResponse | undefined, fallback: string): string {
 	if (response?.data?.ocs?.data?.errors?.length) {
 		return response.data.ocs.data.errors[0]?.message || fallback
 	}
 	return fallback
 }
 
-function isLoadedValidationEnvelopeDocument(document: ValidationDocumentState | null): document is LoadedValidationEnvelopeDocumentState {
-	return document?.nodeType === 'envelope'
-}
-
-function isLoadedValidationFileDocument(document: ValidationDocumentState | null): document is LoadedValidationFileDocumentState {
-	return document?.nodeType === 'file'
-}
-
 const signStore = useSignStore()
 const sidebarStore = useSidebarStore()
 const filesStore = useFilesStore()
@@ -974,7 +715,7 @@ function syncValidatedDocumentToFilesStore(validationDocument: ValidationFileRec
 			? currentFile.files
 			: []
 		if (nestedFiles.length > 0) {
-			pendingFiles.push(...nestedFiles.filter((file): file is ValidatedChildFileRecord => isRecord(file)))
+			pendingFiles.push(...nestedFiles.filter((file): file is ValidatedChildFileRecord => typeof file === 'object' && file !== null))
 		}
 	}
 }