Persist distribution board setup

2026-07-25 23:41:27 +02:00
parent 1a77eedaa8
commit 1cf26a932e
21 changed files with 1027 additions and 22 deletions
@@ -0,0 +1,243 @@
+import crypto from "node:crypto";
+import type { SerializedProjectCommand } from "./project-command.model.js";
+
+export const distributionBoardInsertCommandType =
+  "distribution-board.insert" as const;
+export const distributionBoardDeleteCommandType =
+  "distribution-board.delete" as const;
+export const distributionBoardStructureCommandSchemaVersion = 1 as const;
+
+export const defaultCircuitSectionDefinitions = [
+  {
+    key: "lighting",
+    displayName: "Lighting",
+    prefix: "-1F",
+    sortOrder: 10,
+  },
+  {
+    key: "single_phase",
+    displayName: "Single-phase circuits",
+    prefix: "-2F",
+    sortOrder: 20,
+  },
+  {
+    key: "three_phase",
+    displayName: "Three-phase circuits",
+    prefix: "-3F",
+    sortOrder: 30,
+  },
+  {
+    key: "unassigned",
+    displayName: "Unassigned",
+    prefix: "-UF",
+    sortOrder: 90,
+  },
+] as const;
+
+export interface DistributionBoardStructureSnapshot {
+  distributionBoard: {
+    id: string;
+    projectId: string;
+    name: string;
+  };
+  circuitList: {
+    id: string;
+    projectId: string;
+    distributionBoardId: string;
+    name: string;
+  };
+  sections: Array<{
+    id: string;
+    circuitListId: string;
+    key: string;
+    displayName: string;
+    prefix: string;
+    sortOrder: number;
+  }>;
+}
+
+interface DistributionBoardStructureCommandPayload {
+  structure: DistributionBoardStructureSnapshot;
+}
+
+export interface DistributionBoardInsertProjectCommand
+  extends SerializedProjectCommand<DistributionBoardStructureCommandPayload> {
+  schemaVersion: typeof distributionBoardStructureCommandSchemaVersion;
+  type: typeof distributionBoardInsertCommandType;
+}
+
+export interface DistributionBoardDeleteProjectCommand
+  extends SerializedProjectCommand<DistributionBoardStructureCommandPayload> {
+  schemaVersion: typeof distributionBoardStructureCommandSchemaVersion;
+  type: typeof distributionBoardDeleteCommandType;
+}
+
+export type DistributionBoardStructureProjectCommand =
+  | DistributionBoardInsertProjectCommand
+  | DistributionBoardDeleteProjectCommand;
+
+export function createDistributionBoardStructureSnapshot(
+  projectId: string,
+  name: string
+): DistributionBoardStructureSnapshot {
+  const normalizedName = name.trim();
+  assertNonEmptyString(projectId, "projectId");
+  assertNonEmptyString(normalizedName, "name");
+  const structureId = crypto.randomUUID();
+  const structure: DistributionBoardStructureSnapshot = {
+    distributionBoard: {
+      id: structureId,
+      projectId,
+      name: normalizedName,
+    },
+    circuitList: {
+      id: structureId,
+      projectId,
+      distributionBoardId: structureId,
+      name: `${normalizedName} Stromkreisliste`,
+    },
+    sections: defaultCircuitSectionDefinitions.map((section) => ({
+      id: crypto.randomUUID(),
+      circuitListId: structureId,
+      ...section,
+    })),
+  };
+  assertDistributionBoardStructureSnapshot(structure);
+  return structure;
+}
+
+export function createDistributionBoardInsertProjectCommand(
+  structure: DistributionBoardStructureSnapshot
+): DistributionBoardInsertProjectCommand {
+  const command: DistributionBoardInsertProjectCommand = {
+    schemaVersion: distributionBoardStructureCommandSchemaVersion,
+    type: distributionBoardInsertCommandType,
+    payload: { structure },
+  };
+  assertDistributionBoardInsertProjectCommand(command);
+  return command;
+}
+
+export function createDistributionBoardDeleteProjectCommand(
+  structure: DistributionBoardStructureSnapshot
+): DistributionBoardDeleteProjectCommand {
+  const command: DistributionBoardDeleteProjectCommand = {
+    schemaVersion: distributionBoardStructureCommandSchemaVersion,
+    type: distributionBoardDeleteCommandType,
+    payload: { structure },
+  };
+  assertDistributionBoardDeleteProjectCommand(command);
+  return command;
+}
+
+export function assertDistributionBoardInsertProjectCommand(
+  command: SerializedProjectCommand<unknown>
+): asserts command is DistributionBoardInsertProjectCommand {
+  assertDistributionBoardStructureProjectCommand(
+    command,
+    distributionBoardInsertCommandType
+  );
+}
+
+export function assertDistributionBoardDeleteProjectCommand(
+  command: SerializedProjectCommand<unknown>
+): asserts command is DistributionBoardDeleteProjectCommand {
+  assertDistributionBoardStructureProjectCommand(
+    command,
+    distributionBoardDeleteCommandType
+  );
+}
+
+export function assertDistributionBoardStructureSnapshot(
+  structure: unknown
+): asserts structure is DistributionBoardStructureSnapshot {
+  if (!isPlainObject(structure) || Object.keys(structure).length !== 3) {
+    throw new Error("Distribution-board structure is invalid.");
+  }
+  const { distributionBoard, circuitList, sections } = structure;
+  if (
+    !isPlainObject(distributionBoard) ||
+    Object.keys(distributionBoard).length !== 3 ||
+    !isPlainObject(circuitList) ||
+    Object.keys(circuitList).length !== 4 ||
+    !Array.isArray(sections) ||
+    sections.length !== defaultCircuitSectionDefinitions.length
+  ) {
+    throw new Error("Distribution-board structure is incomplete.");
+  }
+  for (const [field, value] of Object.entries(distributionBoard)) {
+    assertNonEmptyString(value, `distributionBoard.${field}`);
+  }
+  for (const [field, value] of Object.entries(circuitList)) {
+    assertNonEmptyString(value, `circuitList.${field}`);
+  }
+  if (
+    circuitList.projectId !== distributionBoard.projectId ||
+    circuitList.distributionBoardId !== distributionBoard.id ||
+    circuitList.name !==
+      `${distributionBoard.name} Stromkreisliste`
+  ) {
+    throw new Error(
+      "Distribution board and circuit list are inconsistent."
+    );
+  }
+
+  const sectionIds = new Set<string>();
+  for (let index = 0; index < sections.length; index += 1) {
+    const section = sections[index];
+    const expected = defaultCircuitSectionDefinitions[index];
+    if (
+      !isPlainObject(section) ||
+      Object.keys(section).length !== 6
+    ) {
+      throw new Error("Default circuit section is invalid.");
+    }
+    assertNonEmptyString(section.id, "section.id");
+    if (sectionIds.has(section.id)) {
+      throw new Error("Default circuit-section ids must be unique.");
+    }
+    sectionIds.add(section.id);
+    if (
+      section.circuitListId !== circuitList.id ||
+      section.key !== expected.key ||
+      section.displayName !== expected.displayName ||
+      section.prefix !== expected.prefix ||
+      section.sortOrder !== expected.sortOrder
+    ) {
+      throw new Error(
+        "Distribution-board structure has invalid default sections."
+      );
+    }
+  }
+}
+
+function assertDistributionBoardStructureProjectCommand(
+  command: SerializedProjectCommand<unknown>,
+  expectedType:
+    | typeof distributionBoardInsertCommandType
+    | typeof distributionBoardDeleteCommandType
+) {
+  if (
+    command.schemaVersion !==
+      distributionBoardStructureCommandSchemaVersion ||
+    command.type !== expectedType ||
+    !isPlainObject(command.payload) ||
+    Object.keys(command.payload).length !== 1
+  ) {
+    throw new Error("Unsupported distribution-board structure command.");
+  }
+  assertDistributionBoardStructureSnapshot(command.payload.structure);
+}
+
+function assertNonEmptyString(
+  value: unknown,
+  field: string
+): asserts value is string {
+  if (typeof value !== "string" || !value.trim()) {
+    throw new Error(`${field} must be a non-empty string.`);
+  }
+}
+
+function isPlainObject(value: unknown): value is Record<string, unknown> {
+  return value !== null && typeof value === "object" && !Array.isArray(value);
+}
@@ -0,0 +1,26 @@
+import type { DistributionBoardStructureProjectCommand } from "../models/distribution-board-structure-project-command.model.js";
+import type {
+  AppendedProjectRevision,
+  ProjectRevisionSource,
+} from "./project-revision.store.js";
+
+export interface ExecuteDistributionBoardStructureCommandInput {
+  projectId: string;
+  expectedRevision: number;
+  source: ProjectRevisionSource;
+  description?: string;
+  actorId?: string;
+  historyTargetChangeSetId?: string;
+  command: DistributionBoardStructureProjectCommand;
+}
+
+export interface ExecutedDistributionBoardStructureCommand {
+  revision: AppendedProjectRevision;
+  inverse: DistributionBoardStructureProjectCommand;
+}
+
+export interface DistributionBoardStructureProjectCommandStore {
+  execute(
+    input: ExecuteDistributionBoardStructureCommandInput
+  ): ExecutedDistributionBoardStructureCommand;
+}
@@ -37,6 +37,12 @@ import {
  circuitDeleteCommandType,
  circuitInsertCommandType,
 } from "../models/circuit-structure-project-command.model.js";
+import {
+  assertDistributionBoardDeleteProjectCommand,
+  assertDistributionBoardInsertProjectCommand,
+  distributionBoardDeleteCommandType,
+  distributionBoardInsertCommandType,
+} from "../models/distribution-board-structure-project-command.model.js";
 import {
  assertSerializedProjectCommand,
  type SerializedProjectCommand,
@@ -70,6 +76,7 @@ import type { CircuitProjectCommandStore } from "../ports/circuit-project-comman
 import type { CircuitSectionReorderProjectCommandStore } from "../ports/circuit-section-reorder-project-command.store.js";
 import type { CircuitSectionRenumberProjectCommandStore } from "../ports/circuit-section-renumber-project-command.store.js";
 import type { CircuitStructureProjectCommandStore } from "../ports/circuit-structure-project-command.store.js";
+import type { DistributionBoardStructureProjectCommandStore } from "../ports/distribution-board-structure-project-command.store.js";
 import type {
  ExecuteProjectHistoryCommandInput,
  ExecutedProjectCommand,
@@ -104,6 +111,7 @@ export class ProjectCommandService implements ProjectCommandExecutor {
    private readonly deviceRowStructureStore: CircuitDeviceRowStructureProjectCommandStore,
    private readonly deviceRowMoveStore: CircuitDeviceRowMoveProjectCommandStore,
    private readonly circuitStructureStore: CircuitStructureProjectCommandStore,
+    private readonly distributionBoardStructureStore: DistributionBoardStructureProjectCommandStore,
    private readonly circuitSectionReorderStore: CircuitSectionReorderProjectCommandStore,
    private readonly circuitSectionRenumberStore: CircuitSectionRenumberProjectCommandStore,
    private readonly projectDeviceStructureStore: ProjectDeviceStructureProjectCommandStore,
@@ -251,6 +259,20 @@ export class ProjectCommandService implements ProjectCommandExecutor {
          command: input.command,
        }).revision;
      }
+      case distributionBoardInsertCommandType: {
+        assertDistributionBoardInsertProjectCommand(input.command);
+        return this.distributionBoardStructureStore.execute({
+          ...input,
+          command: input.command,
+        }).revision;
+      }
+      case distributionBoardDeleteCommandType: {
+        assertDistributionBoardDeleteProjectCommand(input.command);
+        return this.distributionBoardStructureStore.execute({
+          ...input,
+          command: input.command,
+        }).revision;
+      }
      case circuitSectionReorderCommandType: {
        assertCircuitSectionReorderProjectCommand(input.command);
        return this.circuitSectionReorderStore.execute({