Files
HiveGrid-Wireframes/03 Quellen und Referenzen/hivegrid-cloud/prisma/schema/files.prisma
T

191 lines
6.7 KiB
Plaintext

// P4 Files (AK-P4a) — Files platform primitive.
//
// AD-21: one self-contained schema file per module. `tenantId` /
// `createdByUserId` / `assignedToUserId` are intentionally BARE String scalars
// (no `@relation`) so this file has zero merge-conflict surface against
// `core.prisma`/`accounts.prisma` (no back-relation fields on Tenant/User
// needed). Referential integrity is carried by app-level scoping
// (withTenantScope, §7) plus the RLS policies from the merge migration (§8).
//
// Deliberately NOT reused: the legacy boilerplate models `FileObject`,
// `FileChunk`, `FileUploadProgress` in core.prisma. The models here are named
// differently (File, FileEntityLink, FileUpload, FileUploadChunk) to avoid a
// name collision and any core edit.
//
// Scope v1 (designer brief 2026-06-12): NO versioning (FileVersion = v2),
// no Office/Video previews, no resume upload, no OCR.
enum FilePreviewStatus {
pending
generating
ready
failed
not_supported
}
enum FileScanStatus {
pending
clean
infected
skipped
}
enum FileSource {
manual_upload
customer_portal
form_submission
email_attachment
automation
api
}
enum FileUploadStatus {
in_progress
completed
failed
expired
cancelled
}
enum FileEntityType {
contact
company
lead
deal
project
user
form_submission
order
task
appointment
signature_document
// VA-P23 · mirrored mailbox message (email-inbox attachments -> Files).
// ADDITIVE cross-module touch of files.prisma, flagged per AD-21.
email_message
// AK-P15b · Team Chat attachment linked through FileEntityLink.
// ADDITIVE cross-module touch of files.prisma, flagged per AD-21.
chat_message
// AK-P21 · in-app feedback attachment (SupportTicket) linked through
// FileEntityLink. ADDITIVE cross-module touch of files.prisma, flagged per
// AD-21.
support_ticket
}
/// A stored file, scoped per tenant. `storageKey` points at the original object
/// in the private Hetzner bucket (AD-23); delivery is only via the auth-proxy
/// route. Soft-delete via `archivedAt` (archive flag). Hard-delete is a separate
/// action (files.delete).
model File {
id String @id @default(cuid())
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
tenantId String
/// Exactly one of createdByUserId / createdByPortalUserId must be non-null.
/// The merge migration adds the database CHECK; shared service helpers enforce
/// the same invariant while feature branches use prisma db push (AD-21).
createdByUserId String?
displayName String
mimeType String
sizeBytes Int
storageKey String
checksumSha256 String?
previewStatus FilePreviewStatus @default(pending)
previewStorageKey String?
thumbnailStorageKey String?
scanStatus FileScanStatus @default(pending)
assignedToUserId String?
tags String[] @default([])
notes String?
source FileSource @default(manual_upload)
createdByPortalUserId String?
isDemoData Boolean @default(false)
archivedAt DateTime?
links FileEntityLink[]
createdByPortalUser PortalUser? @relation("PortalFileActor", fields: [createdByPortalUserId, tenantId], references: [id, tenantId], onDelete: Restrict)
portalDocuments PortalProjectDocument[]
@@unique([id, tenantId])
@@index([tenantId, archivedAt, createdAt(sort: Desc)])
@@index([tenantId, createdByUserId])
@@index([tenantId, createdByPortalUserId])
@@index([tenantId, assignedToUserId])
@@index([tenantId, checksumSha256])
// pg_trgm GIN index for fast ILIKE search on displayName; created originally
// via raw SQL in 20260623160000_p4a_files_platform. Modeled here so
// migrations<->schema parity holds (requires the pg_trgm extension).
@@index([displayName(ops: raw("gin_trgm_ops"))], type: Gin, map: "File_displayName_trgm_idx")
}
/// Polymorphic link of a file to any entity (cross-cutting). `entityType` +
/// `entityId` address the target entity, `linkRole` is an optional role label
/// (e.g. "contract", "photo").
model FileEntityLink {
id String @id @default(cuid())
createdAt DateTime @default(now())
tenantId String
/// Exactly one actor column is set; see the merge-migration CHECK contract.
createdByUserId String?
createdByPortalUserId String?
fileId String
entityType FileEntityType
entityId String
linkRole String?
file File @relation(fields: [fileId], references: [id], onDelete: Cascade)
createdByPortalUser PortalUser? @relation("PortalFileEntityLinkActor", fields: [createdByPortalUserId, tenantId], references: [id, tenantId], onDelete: Restrict)
@@unique([fileId, entityType, entityId])
@@index([tenantId, entityType, entityId])
@@index([tenantId, fileId])
@@index([tenantId, createdByPortalUserId])
}
/// Chunked-upload session (replaces spec `FileUploadProgress`, renamed to avoid
/// the core collision). No resume in v1 — this session only carries progress up
/// to `complete`. `expiresAt` = now + 24h; a cleanup cron sweeps expired
/// sessions + temp chunks.
model FileUpload {
id String @id @default(cuid())
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
tenantId String
/// Exactly one actor column is set; see the merge-migration CHECK contract.
createdByUserId String?
createdByPortalUserId String?
originalFilename String
totalSizeBytes Int
mimeType String
totalChunks Int
receivedChunks Int @default(0)
status FileUploadStatus @default(in_progress)
targetFileId String?
expiresAt DateTime
failureReason String?
chunks FileUploadChunk[]
createdByPortalUser PortalUser? @relation("PortalFileUploadActor", fields: [createdByPortalUserId, tenantId], references: [id, tenantId], onDelete: Restrict)
@@index([tenantId, createdByUserId, status])
@@index([tenantId, createdByPortalUserId, status])
@@index([expiresAt])
}
/// One uploaded chunk of a `FileUpload` session (replaces spec `FileChunk`).
/// Bytes live in temp storage (`storageKey`), not in the DB.
model FileUploadChunk {
id String @id @default(cuid())
tenantId String
uploadId String
chunkIndex Int
storageKey String
sizeBytes Int
checksumSha256 String?
receivedAt DateTime @default(now())
upload FileUpload @relation(fields: [uploadId], references: [id], onDelete: Cascade)
@@unique([uploadId, chunkIndex])
@@index([tenantId, uploadId])
}