Add external model persistence foundation

This commit is contained in:
Julian Appel 2026-08-02 17:18:24 +02:00
parent d0fc1a7caf
commit 76493b573e
15 changed files with 3207 additions and 8 deletions

View file

@ -0,0 +1,74 @@
CREATE TABLE `external_import_batches` (
`id` text PRIMARY KEY NOT NULL,
`project_id` text NOT NULL,
`source_id` text NOT NULL,
`import_kind` text NOT NULL,
`imported_at_iso` text NOT NULL,
`file_name` text NOT NULL,
`sha256` text NOT NULL,
`applied_project_revision` integer NOT NULL,
`configuration_snapshot` text NOT NULL,
`original_bytes` blob NOT NULL,
`document` text NOT NULL,
FOREIGN KEY (`project_id`) REFERENCES `projects`(`id`) ON UPDATE no action ON DELETE cascade,
FOREIGN KEY (`source_id`) REFERENCES `external_model_sources`(`id`) ON UPDATE no action ON DELETE cascade
);
--> statement-breakpoint
CREATE INDEX `external_import_batches_project_revision_idx` ON `external_import_batches` (`project_id`,`applied_project_revision`);--> statement-breakpoint
CREATE INDEX `external_import_batches_source_imported_idx` ON `external_import_batches` (`source_id`,`imported_at_iso`);--> statement-breakpoint
CREATE TABLE `external_model_objects` (
`id` text PRIMARY KEY NOT NULL,
`project_id` text NOT NULL,
`source_id` text NOT NULL,
`ifc_guid` text NOT NULL,
`last_seen_import_batch_id` text NOT NULL,
`last_accepted_import_batch_id` text NOT NULL,
`accepted_source_values` text NOT NULL,
`planning_values` text NOT NULL,
`overridden_fields` text NOT NULL,
`external_room_mapping_id` text,
`distribution_board_id` text,
`linked_project_device_id` text,
`circuit_device_row_id` text,
`presence_status` text DEFAULT 'present' NOT NULL,
FOREIGN KEY (`project_id`) REFERENCES `projects`(`id`) ON UPDATE no action ON DELETE cascade,
FOREIGN KEY (`source_id`) REFERENCES `external_model_sources`(`id`) ON UPDATE no action ON DELETE cascade,
FOREIGN KEY (`last_seen_import_batch_id`) REFERENCES `external_import_batches`(`id`) ON UPDATE no action ON DELETE restrict,
FOREIGN KEY (`last_accepted_import_batch_id`) REFERENCES `external_import_batches`(`id`) ON UPDATE no action ON DELETE restrict,
FOREIGN KEY (`external_room_mapping_id`) REFERENCES `external_room_mappings`(`id`) ON UPDATE no action ON DELETE set null,
FOREIGN KEY (`distribution_board_id`) REFERENCES `distribution_boards`(`id`) ON UPDATE no action ON DELETE set null,
FOREIGN KEY (`linked_project_device_id`) REFERENCES `project_devices`(`id`) ON UPDATE no action ON DELETE set null,
FOREIGN KEY (`circuit_device_row_id`) REFERENCES `circuit_device_rows`(`id`) ON UPDATE no action ON DELETE set null
);
--> statement-breakpoint
CREATE UNIQUE INDEX `external_model_objects_source_ifc_guid_unique` ON `external_model_objects` (`source_id`,`ifc_guid`);--> statement-breakpoint
CREATE INDEX `external_model_objects_project_presence_idx` ON `external_model_objects` (`project_id`,`presence_status`);--> statement-breakpoint
CREATE INDEX `external_model_objects_distribution_board_idx` ON `external_model_objects` (`distribution_board_id`);--> statement-breakpoint
CREATE INDEX `external_model_objects_circuit_device_row_idx` ON `external_model_objects` (`circuit_device_row_id`);--> statement-breakpoint
CREATE TABLE `external_model_sources` (
`id` text PRIMARY KEY NOT NULL,
`project_id` text NOT NULL,
`name` text NOT NULL,
`source_type` text DEFAULT 'revit_csv' NOT NULL,
FOREIGN KEY (`project_id`) REFERENCES `projects`(`id`) ON UPDATE no action ON DELETE cascade
);
--> statement-breakpoint
CREATE UNIQUE INDEX `external_model_sources_project_type_unique` ON `external_model_sources` (`project_id`,`source_type`);--> statement-breakpoint
CREATE TABLE `external_room_mappings` (
`id` text PRIMARY KEY NOT NULL,
`project_id` text NOT NULL,
`source_id` text NOT NULL,
`normalized_source_room_key` text NOT NULL,
`source_floor_name` text,
`source_room_number` text NOT NULL,
`source_room_name` text NOT NULL,
`room_id` text,
`default_distribution_board_id` text,
FOREIGN KEY (`project_id`) REFERENCES `projects`(`id`) ON UPDATE no action ON DELETE cascade,
FOREIGN KEY (`source_id`) REFERENCES `external_model_sources`(`id`) ON UPDATE no action ON DELETE cascade,
FOREIGN KEY (`room_id`) REFERENCES `rooms`(`id`) ON UPDATE no action ON DELETE set null,
FOREIGN KEY (`default_distribution_board_id`) REFERENCES `distribution_boards`(`id`) ON UPDATE no action ON DELETE set null
);
--> statement-breakpoint
CREATE UNIQUE INDEX `external_room_mappings_source_key_unique` ON `external_room_mappings` (`source_id`,`normalized_source_room_key`);--> statement-breakpoint
CREATE INDEX `external_room_mappings_project_room_idx` ON `external_room_mappings` (`project_id`,`room_id`);

File diff suppressed because it is too large Load diff

View file

@ -22,6 +22,13 @@
"when": 1785680771603,
"tag": "0002_awesome_madripoor",
"breakpoints": true
},
{
"idx": 3,
"version": "6",
"when": 1785683710155,
"tag": "0003_outstanding_maddog",
"breakpoints": true
}
]
}

View file

@ -0,0 +1,74 @@
import { asc, eq } from "drizzle-orm";
import type { ExternalModelStateReader } from "../../domain/ports/external-model-state.reader.js";
import type { ExternalModelStateSnapshot } from "../../external-model/domain/external-model-contracts.js";
import type { AppDatabase } from "../database-context.js";
import { externalImportBatches } from "../schema/external-import-batches.js";
import { externalModelObjects } from "../schema/external-model-objects.js";
import { externalModelSources } from "../schema/external-model-sources.js";
import { externalRoomMappings } from "../schema/external-room-mappings.js";
import { projects } from "../schema/projects.js";
const emptyState = (): ExternalModelStateSnapshot => ({
source: null,
importBatches: [],
roomMappings: [],
objects: [],
});
export class ExternalModelStateRepository implements ExternalModelStateReader {
constructor(private readonly database: AppDatabase) {}
getByProject(projectId: string) {
const project = this.database
.select({ id: projects.id })
.from(projects)
.where(eq(projects.id, projectId))
.get();
if (!project) return { projectExists: false, state: emptyState() };
const source = this.database
.select()
.from(externalModelSources)
.where(eq(externalModelSources.projectId, projectId))
.get() ?? null;
if (!source) return { projectExists: true, state: emptyState() };
const batches = this.database
.select()
.from(externalImportBatches)
.where(eq(externalImportBatches.sourceId, source.id))
.orderBy(
asc(externalImportBatches.appliedProjectRevision),
asc(externalImportBatches.id)
)
.all();
const roomMappings = this.database
.select()
.from(externalRoomMappings)
.where(eq(externalRoomMappings.sourceId, source.id))
.orderBy(
asc(externalRoomMappings.normalizedSourceRoomKey),
asc(externalRoomMappings.id)
)
.all();
const objects = this.database
.select()
.from(externalModelObjects)
.where(eq(externalModelObjects.sourceId, source.id))
.orderBy(asc(externalModelObjects.ifcGuid), asc(externalModelObjects.id))
.all();
return {
projectExists: true,
state: {
source,
importBatches: batches.map(({ originalBytes, ...batch }) => ({
...batch,
originalContentBase64: Buffer.from(originalBytes).toString("base64"),
})),
roomMappings,
objects,
},
};
}
}

View file

@ -0,0 +1,43 @@
import { blob, index, integer, sqliteTable, text } from "drizzle-orm/sqlite-core";
import type {
ExternalCsvConfiguration,
ExternalCsvDocument,
} from "../../external-model/csv/external-csv-contracts.js";
import { externalImportKinds } from "../../external-model/domain/external-model-contracts.js";
import { externalModelSources } from "./external-model-sources.js";
import { projects } from "./projects.js";
export const externalImportBatches = sqliteTable(
"external_import_batches",
{
id: text("id").primaryKey(),
projectId: text("project_id")
.notNull()
.references(() => projects.id, { onDelete: "cascade" }),
sourceId: text("source_id")
.notNull()
.references(() => externalModelSources.id, { onDelete: "cascade" }),
importKind: text("import_kind", { enum: externalImportKinds }).notNull(),
importedAtIso: text("imported_at_iso").notNull(),
fileName: text("file_name").notNull(),
sha256: text("sha256").notNull(),
appliedProjectRevision: integer("applied_project_revision").notNull(),
configurationSnapshot: text("configuration_snapshot", { mode: "json" })
.$type<ExternalCsvConfiguration>()
.notNull(),
originalBytes: blob("original_bytes", { mode: "buffer" }).notNull(),
document: text("document", { mode: "json" })
.$type<ExternalCsvDocument>()
.notNull(),
},
(table) => [
index("external_import_batches_project_revision_idx").on(
table.projectId,
table.appliedProjectRevision
),
index("external_import_batches_source_imported_idx").on(
table.sourceId,
table.importedAtIso
),
]
);

View file

@ -0,0 +1,80 @@
import { index, sqliteTable, text, uniqueIndex } from "drizzle-orm/sqlite-core";
import type {
ExternalModelObjectOverrideField,
ExternalModelObjectPlanningValues,
ExternalModelObjectSourceValues,
} from "../../external-model/domain/external-model-contracts.js";
import { externalObjectPresenceStatuses } from "../../external-model/domain/external-model-contracts.js";
import { circuitDeviceRows } from "./circuit-device-rows.js";
import { distributionBoards } from "./distribution-boards.js";
import { externalImportBatches } from "./external-import-batches.js";
import { externalModelSources } from "./external-model-sources.js";
import { externalRoomMappings } from "./external-room-mappings.js";
import { projectDevices } from "./project-devices.js";
import { projects } from "./projects.js";
export const externalModelObjects = sqliteTable(
"external_model_objects",
{
id: text("id").primaryKey(),
projectId: text("project_id")
.notNull()
.references(() => projects.id, { onDelete: "cascade" }),
sourceId: text("source_id")
.notNull()
.references(() => externalModelSources.id, { onDelete: "cascade" }),
ifcGuid: text("ifc_guid").notNull(),
lastSeenImportBatchId: text("last_seen_import_batch_id")
.notNull()
.references(() => externalImportBatches.id, { onDelete: "restrict" }),
lastAcceptedImportBatchId: text("last_accepted_import_batch_id")
.notNull()
.references(() => externalImportBatches.id, { onDelete: "restrict" }),
acceptedSourceValues: text("accepted_source_values", { mode: "json" })
.$type<ExternalModelObjectSourceValues>()
.notNull(),
planningValues: text("planning_values", { mode: "json" })
.$type<ExternalModelObjectPlanningValues>()
.notNull(),
overriddenFields: text("overridden_fields", { mode: "json" })
.$type<ExternalModelObjectOverrideField[]>()
.notNull(),
externalRoomMappingId: text("external_room_mapping_id").references(
() => externalRoomMappings.id,
{ onDelete: "set null" }
),
distributionBoardId: text("distribution_board_id").references(
() => distributionBoards.id,
{ onDelete: "set null" }
),
linkedProjectDeviceId: text("linked_project_device_id").references(
() => projectDevices.id,
{ onDelete: "set null" }
),
circuitDeviceRowId: text("circuit_device_row_id").references(
() => circuitDeviceRows.id,
{ onDelete: "set null" }
),
presenceStatus: text("presence_status", {
enum: externalObjectPresenceStatuses,
})
.notNull()
.default("present"),
},
(table) => [
uniqueIndex("external_model_objects_source_ifc_guid_unique").on(
table.sourceId,
table.ifcGuid
),
index("external_model_objects_project_presence_idx").on(
table.projectId,
table.presenceStatus
),
index("external_model_objects_distribution_board_idx").on(
table.distributionBoardId
),
index("external_model_objects_circuit_device_row_idx").on(
table.circuitDeviceRowId
),
]
);

View file

@ -0,0 +1,23 @@
import { sqliteTable, text, uniqueIndex } from "drizzle-orm/sqlite-core";
import { externalModelSourceTypes } from "../../external-model/domain/external-model-contracts.js";
import { projects } from "./projects.js";
export const externalModelSources = sqliteTable(
"external_model_sources",
{
id: text("id").primaryKey(),
projectId: text("project_id")
.notNull()
.references(() => projects.id, { onDelete: "cascade" }),
name: text("name").notNull(),
sourceType: text("source_type", { enum: externalModelSourceTypes })
.notNull()
.default("revit_csv"),
},
(table) => [
uniqueIndex("external_model_sources_project_type_unique").on(
table.projectId,
table.sourceType
),
]
);

View file

@ -0,0 +1,37 @@
import { index, sqliteTable, text, uniqueIndex } from "drizzle-orm/sqlite-core";
import { distributionBoards } from "./distribution-boards.js";
import { externalModelSources } from "./external-model-sources.js";
import { projects } from "./projects.js";
import { rooms } from "./rooms.js";
export const externalRoomMappings = sqliteTable(
"external_room_mappings",
{
id: text("id").primaryKey(),
projectId: text("project_id")
.notNull()
.references(() => projects.id, { onDelete: "cascade" }),
sourceId: text("source_id")
.notNull()
.references(() => externalModelSources.id, { onDelete: "cascade" }),
normalizedSourceRoomKey: text("normalized_source_room_key").notNull(),
sourceFloorName: text("source_floor_name"),
sourceRoomNumber: text("source_room_number").notNull(),
sourceRoomName: text("source_room_name").notNull(),
roomId: text("room_id").references(() => rooms.id, { onDelete: "set null" }),
defaultDistributionBoardId: text("default_distribution_board_id").references(
() => distributionBoards.id,
{ onDelete: "set null" }
),
},
(table) => [
uniqueIndex("external_room_mappings_source_key_unique").on(
table.sourceId,
table.normalizedSourceRoomKey
),
index("external_room_mappings_project_room_idx").on(
table.projectId,
table.roomId
),
]
);

View file

@ -0,0 +1,10 @@
import type { ExternalModelStateSnapshot } from "../../external-model/domain/external-model-contracts.js";
export interface ExternalModelStateReadResult {
projectExists: boolean;
state: ExternalModelStateSnapshot;
}
export interface ExternalModelStateReader {
getByProject(projectId: string): ExternalModelStateReadResult;
}

View file

@ -0,0 +1,100 @@
import type { CircuitGroupCategory } from "../../shared/constants/circuit-group.js";
import type {
ExternalCsvConfiguration,
ExternalCsvDocument,
} from "../csv/external-csv-contracts.js";
export const externalModelSourceTypes = ["revit_csv"] as const;
export type ExternalModelSourceType = (typeof externalModelSourceTypes)[number];
export const externalImportKinds = ["initial", "follow_up"] as const;
export type ExternalImportKind = (typeof externalImportKinds)[number];
export const externalObjectPresenceStatuses = ["present", "missing"] as const;
export type ExternalObjectPresenceStatus =
(typeof externalObjectPresenceStatuses)[number];
export interface ExternalModelSourceSnapshot {
id: string;
projectId: string;
name: string;
sourceType: ExternalModelSourceType;
}
export interface ExternalImportBatchSnapshot {
id: string;
projectId: string;
sourceId: string;
importKind: ExternalImportKind;
importedAtIso: string;
fileName: string;
sha256: string;
appliedProjectRevision: number;
configurationSnapshot: ExternalCsvConfiguration;
originalContentBase64: string;
document: ExternalCsvDocument;
}
export interface ExternalRoomMappingSnapshot {
id: string;
projectId: string;
sourceId: string;
normalizedSourceRoomKey: string;
sourceFloorName: string | null;
sourceRoomNumber: string;
sourceRoomName: string;
roomId: string | null;
defaultDistributionBoardId: string | null;
}
export interface ExternalModelObjectSourceValues {
rowNumber: number;
roomNumber: string;
roomName: string;
familyAndType: string;
selectionMarker: string;
circuitIdentifier: string;
power: string;
quantity: string | null;
additionalSourceValues: Record<string, string>;
}
export interface ExternalModelObjectPlanningValues {
displayName: string | null;
internalDeviceType: string | null;
category: CircuitGroupCategory | null;
connectionKind: string | null;
effectiveQuantity: number;
powerPerUnitW: number | null;
simultaneityFactor: number;
cosPhi: number | null;
costGroup: string | null;
remark: string | null;
}
export type ExternalModelObjectOverrideField =
keyof ExternalModelObjectPlanningValues;
export interface ExternalModelObjectSnapshot {
id: string;
projectId: string;
sourceId: string;
ifcGuid: string;
lastSeenImportBatchId: string;
lastAcceptedImportBatchId: string;
acceptedSourceValues: ExternalModelObjectSourceValues;
planningValues: ExternalModelObjectPlanningValues;
overriddenFields: ExternalModelObjectOverrideField[];
externalRoomMappingId: string | null;
distributionBoardId: string | null;
linkedProjectDeviceId: string | null;
circuitDeviceRowId: string | null;
presenceStatus: ExternalObjectPresenceStatus;
}
export interface ExternalModelStateSnapshot {
source: ExternalModelSourceSnapshot | null;
importBatches: ExternalImportBatchSnapshot[];
roomMappings: ExternalRoomMappingSnapshot[];
objects: ExternalModelObjectSnapshot[];
}

View file

@ -0,0 +1,147 @@
import type { ExternalCsvConfiguration } from "../csv/external-csv-contracts.js";
import type {
ExternalModelObjectPlanningValues,
ExternalModelObjectSourceValues,
} from "./external-model-contracts.js";
export type InitialExternalObjectIssue =
| "unknown-family-and-type"
| "invalid-power"
| "invalid-quantity"
| "missing-room";
export interface InitialExternalObjectProjection {
ifcGuid: string;
sourceValues: ExternalModelObjectSourceValues;
planningValues: ExternalModelObjectPlanningValues;
issues: InitialExternalObjectIssue[];
}
export interface ExternalObjectImportCandidate {
rowNumber: number;
ifcGuid: string;
roomNumber: string;
roomName: string;
familyAndType: string;
selectionMarker: string;
circuitIdentifier: string;
power: string;
quantity: string | null;
additionalSourceValues: Record<string, string>;
}
export function normalizeExternalRoomPart(value: string): string {
return value.trim().normalize("NFKC").toLocaleUpperCase("de-DE");
}
export function createExternalRoomKey(
roomNumber: string,
roomName: string
): string | null {
const normalizedNumber = normalizeExternalRoomPart(roomNumber);
if (normalizedNumber) return `number:${normalizedNumber}`;
const normalizedName = normalizeExternalRoomPart(roomName);
return normalizedName ? `name:${normalizedName}` : null;
}
export function indexExternalObjectsByIfcGuid<T extends { ifcGuid: string }>(
objects: readonly T[]
): Map<string, T> {
const index = new Map<string, T>();
for (const object of objects) {
if (!object.ifcGuid || object.ifcGuid !== object.ifcGuid.trim()) {
throw new Error("IfcGUID must be non-empty and must not contain outer whitespace.");
}
if (index.has(object.ifcGuid)) {
throw new Error(`Duplicate IfcGUID: ${object.ifcGuid}`);
}
index.set(object.ifcGuid, object);
}
return index;
}
export function projectInitialExternalObject(
object: ExternalObjectImportCandidate,
configuration: ExternalCsvConfiguration
): InitialExternalObjectProjection {
const rule = configuration.familyTypeRules.find(
(candidate) => candidate.exactFamilyAndType === object.familyAndType
);
const issues: InitialExternalObjectIssue[] = [];
if (!rule) issues.push("unknown-family-and-type");
if (!createExternalRoomKey(object.roomNumber, object.roomName)) {
issues.push("missing-room");
}
const parsedPower = parseConfiguredNumber(object.power, configuration);
if (object.power.trim() && parsedPower === null) issues.push("invalid-power");
let effectiveQuantity = 1;
if (rule?.quantityRule.kind === "fixed") {
effectiveQuantity = rule.quantityRule.quantity;
} else if (rule?.quantityRule.kind === "mapped-column") {
const parsedQuantity = parseConfiguredNumber(object.quantity ?? "", configuration);
if (parsedQuantity === null || !Number.isInteger(parsedQuantity) || parsedQuantity <= 0) {
issues.push("invalid-quantity");
} else {
effectiveQuantity = parsedQuantity;
}
}
return {
ifcGuid: object.ifcGuid,
sourceValues: {
rowNumber: object.rowNumber,
roomNumber: object.roomNumber,
roomName: object.roomName,
familyAndType: object.familyAndType,
selectionMarker: object.selectionMarker,
circuitIdentifier: object.circuitIdentifier,
power: object.power,
quantity: object.quantity,
additionalSourceValues: { ...object.additionalSourceValues },
},
planningValues: {
displayName: rule
? resolveDisplayName(rule.displayNameSuggestion, object)
: null,
internalDeviceType: rule?.internalDeviceType ?? null,
category: rule?.category ?? null,
connectionKind: rule?.connectionKind ?? null,
effectiveQuantity,
powerPerUnitW:
parsedPower === null ? null : parsedPower * configuration.wattsPerSourceUnit,
simultaneityFactor: 1,
cosPhi: null,
costGroup: null,
remark: null,
},
issues,
};
}
function parseConfiguredNumber(
value: string,
configuration: ExternalCsvConfiguration
): number | null {
const trimmed = value.trim();
if (!trimmed) return null;
const normalized = configuration.decimalSeparator === ","
? trimmed.replace(",", ".")
: trimmed;
if (!/^[+-]?(?:\d+(?:\.\d*)?|\.\d+)$/.test(normalized)) return null;
const parsed = Number(normalized);
return Number.isFinite(parsed) && parsed >= 0 ? parsed : null;
}
function resolveDisplayName(
suggestion: ExternalCsvConfiguration["familyTypeRules"][number]["displayNameSuggestion"],
object: ExternalObjectImportCandidate
): string | null {
if (suggestion === null) return null;
if (suggestion.kind === "fixed") return suggestion.value;
if (suggestion.kind === "selection-marker") {
return object.selectionMarker.trim() || null;
}
return object.familyAndType.trim() || null;
}