Add distribution power summaries

src/domain/models/circuit-tree.model.ts

@@ -52,6 +52,7 @@ export interface CircuitTreeSectionBlock {
   displayName: string;
   prefix: string;
   sortOrder: number;
+  sectionTotalPower: number;
   circuits: CircuitTreeCircuit[];
 }
 
@@ -60,6 +61,9 @@ export interface CircuitTreeResponse {
   currentRevision: number;
   singlePhaseVoltageV: number;
   threePhaseVoltageV: number;
+  distributionBoardSimultaneityFactor: number;
+  distributionBoardTotalPower: number;
+  distributionBoardTotalPowerWithSimultaneityFactor: number;
   sections: CircuitTreeSectionBlock[];
 }
 

src/domain/models/distribution-board-project-command.model.ts

@@ -6,11 +6,13 @@ import type { SerializedProjectCommand } from "./project-command.model.js";
 
 export const distributionBoardUpdateCommandType =
   "distribution-board.update" as const;
-export const distributionBoardUpdateCommandSchemaVersion = 1 as const;
+export const legacyDistributionBoardUpdateCommandSchemaVersion = 1 as const;
+export const distributionBoardUpdateCommandSchemaVersion = 2 as const;
 
 export interface DistributionBoardUpdateValues {
   floorId: string | null;
   supplyType: DistributionBoardSupplyType | null;
+  simultaneityFactor: number;
 }
 
 export type DistributionBoardUpdateField =
@@ -31,17 +33,27 @@ export interface DistributionBoardUpdateCommandPayload {
   changes: DistributionBoardUpdateFieldChange[];
 }
 
-export interface DistributionBoardUpdateProjectCommand
+interface CurrentDistributionBoardUpdateProjectCommand
   extends SerializedProjectCommand<DistributionBoardUpdateCommandPayload> {
   schemaVersion: typeof distributionBoardUpdateCommandSchemaVersion;
   type: typeof distributionBoardUpdateCommandType;
 }
 
+interface LegacyDistributionBoardUpdateProjectCommand
+  extends SerializedProjectCommand<DistributionBoardUpdateCommandPayload> {
+  schemaVersion: typeof legacyDistributionBoardUpdateCommandSchemaVersion;
+  type: typeof distributionBoardUpdateCommandType;
+}
+
+export type DistributionBoardUpdateProjectCommand =
+  | CurrentDistributionBoardUpdateProjectCommand
+  | LegacyDistributionBoardUpdateProjectCommand;
+
 export function createDistributionBoardUpdateProjectCommand(
   distributionBoardId: string,
   patch: DistributionBoardUpdatePatch
-): DistributionBoardUpdateProjectCommand {
-  const command: DistributionBoardUpdateProjectCommand = {
+): CurrentDistributionBoardUpdateProjectCommand {
+  const command: CurrentDistributionBoardUpdateProjectCommand = {
     schemaVersion: distributionBoardUpdateCommandSchemaVersion,
     type: distributionBoardUpdateCommandType,
     payload: {
@@ -60,7 +72,9 @@ export function assertDistributionBoardUpdateProjectCommand(
   command: SerializedProjectCommand<unknown>
 ): asserts command is DistributionBoardUpdateProjectCommand {
   if (
-    command.schemaVersion !== distributionBoardUpdateCommandSchemaVersion ||
+    (command.schemaVersion !==
+      legacyDistributionBoardUpdateCommandSchemaVersion &&
+      command.schemaVersion !== distributionBoardUpdateCommandSchemaVersion) ||
     command.type !== distributionBoardUpdateCommandType ||
     !isPlainObject(command.payload)
   ) {
@@ -81,7 +95,11 @@ export function assertDistributionBoardUpdateProjectCommand(
   for (const change of changes) {
     if (
       !isPlainObject(change) ||
-      (change.field !== "floorId" && change.field !== "supplyType") ||
+      (change.field !== "floorId" &&
+        change.field !== "supplyType" &&
+        (command.schemaVersion ===
+          legacyDistributionBoardUpdateCommandSchemaVersion ||
+          change.field !== "simultaneityFactor")) ||
       seen.has(change.field)
     ) {
       throw new Error(
@@ -95,13 +113,24 @@ export function assertDistributionBoardUpdateProjectCommand(
       ) {
         throw new Error("floorId must be a non-empty string or null.");
       }
+    } else if (change.field === "supplyType") {
+      if (
+        change.value !== null &&
+        !distributionBoardSupplyTypes.includes(
+          change.value as DistributionBoardSupplyType
+        )
+      ) {
+        throw new Error("supplyType is invalid.");
+      }
     } else if (
-      change.value !== null &&
-      !distributionBoardSupplyTypes.includes(
-        change.value as DistributionBoardSupplyType
-      )
+      typeof change.value !== "number" ||
+      !Number.isFinite(change.value) ||
+      change.value < 0 ||
+      change.value > 1
     ) {
-      throw new Error("supplyType is invalid.");
+      throw new Error(
+        "simultaneityFactor must be between zero and one."
+      );
     }
     seen.add(change.field);
   }

src/domain/models/project-state-snapshot.model.ts

@@ -13,7 +13,8 @@ export const legacyProjectStateSnapshotSchemaVersion = 1 as const;
 export const previousProjectStateSnapshotSchemaVersion = 2 as const;
 export const distributionBoardProjectStateSnapshotSchemaVersion = 3 as const;
 export const supplyTypesProjectStateSnapshotSchemaVersion = 4 as const;
-export const projectStateSnapshotSchemaVersion = 5 as const;
+export const voltageProjectStateSnapshotSchemaVersion = 5 as const;
+export const projectStateSnapshotSchemaVersion = 6 as const;
 
 const idSchema = z.string().trim().min(1);
 const nullableStringSchema = z.string().nullable();
@@ -57,6 +58,12 @@ const distributionBoardSchema = legacyDistributionBoardSchema
   })
   .strict();
 
+const currentDistributionBoardSchema = distributionBoardSchema
+  .extend({
+    simultaneityFactor: finiteNumberSchema.min(0).max(1),
+  })
+  .strict();
+
 const circuitListSchema = z
   .object({
     id: idSchema,
@@ -213,9 +220,17 @@ const supplyTypesProjectStateSnapshotSchema = z
   })
   .strict();
 
-export const projectStateSnapshotSchema =
+const voltageProjectStateSnapshotSchema =
   supplyTypesProjectStateSnapshotSchema.extend({
+    schemaVersion: z.literal(
+      voltageProjectStateSnapshotSchemaVersion
+    ),
+  });
+
+export const projectStateSnapshotSchema =
+  voltageProjectStateSnapshotSchema.extend({
     schemaVersion: z.literal(projectStateSnapshotSchemaVersion),
+    distributionBoards: z.array(currentDistributionBoardSchema),
   });
 
 export type ProjectStateSnapshot = z.infer<
@@ -228,34 +243,46 @@ export function parseProjectStateSnapshot(
   const version = isPlainObject(value) ? value.schemaVersion : undefined;
   const parsedSnapshot =
     version === legacyProjectStateSnapshotSchemaVersion
-      ? upgradeSupplyTypesProjectStateSnapshot(
-          upgradeDistributionBoardProjectStateSnapshot(
-            upgradePreviousProjectStateSnapshot(
-              upgradeLegacyProjectStateSnapshot(
-                legacyProjectStateSnapshotSchema.parse(value)
+      ? upgradeVoltageProjectStateSnapshot(
+          upgradeSupplyTypesProjectStateSnapshot(
+            upgradeDistributionBoardProjectStateSnapshot(
+              upgradePreviousProjectStateSnapshot(
+                upgradeLegacyProjectStateSnapshot(
+                  legacyProjectStateSnapshotSchema.parse(value)
+                )
               )
             )
           )
         )
       : version === previousProjectStateSnapshotSchemaVersion
-        ? upgradeSupplyTypesProjectStateSnapshot(
-            upgradeDistributionBoardProjectStateSnapshot(
-              upgradePreviousProjectStateSnapshot(
-                previousProjectStateSnapshotSchema.parse(value)
+        ? upgradeVoltageProjectStateSnapshot(
+            upgradeSupplyTypesProjectStateSnapshot(
+              upgradeDistributionBoardProjectStateSnapshot(
+                upgradePreviousProjectStateSnapshot(
+                  previousProjectStateSnapshotSchema.parse(value)
+                )
               )
             )
           )
         : version === distributionBoardProjectStateSnapshotSchemaVersion
-          ? upgradeSupplyTypesProjectStateSnapshot(
-              upgradeDistributionBoardProjectStateSnapshot(
-                distributionBoardProjectStateSnapshotSchema.parse(value)
+          ? upgradeVoltageProjectStateSnapshot(
+              upgradeSupplyTypesProjectStateSnapshot(
+                upgradeDistributionBoardProjectStateSnapshot(
+                  distributionBoardProjectStateSnapshotSchema.parse(value)
+                )
               )
             )
           : version === supplyTypesProjectStateSnapshotSchemaVersion
-            ? upgradeSupplyTypesProjectStateSnapshot(
-                supplyTypesProjectStateSnapshotSchema.parse(value)
+            ? upgradeVoltageProjectStateSnapshot(
+                upgradeSupplyTypesProjectStateSnapshot(
+                  supplyTypesProjectStateSnapshotSchema.parse(value)
+                )
               )
-          : projectStateSnapshotSchema.parse(value);
+            : version === voltageProjectStateSnapshotSchemaVersion
+              ? upgradeVoltageProjectStateSnapshot(
+                  voltageProjectStateSnapshotSchema.parse(value)
+                )
+              : projectStateSnapshotSchema.parse(value);
   const snapshot = normalizeSnapshotPhaseTypes(parsedSnapshot);
   assertProjectStateSnapshotRelations(snapshot);
   return snapshot;
@@ -354,14 +381,14 @@ function upgradeDistributionBoardProjectStateSnapshot(
 
 function upgradeSupplyTypesProjectStateSnapshot(
   snapshot: z.infer<typeof supplyTypesProjectStateSnapshotSchema>
-): ProjectStateSnapshot {
+): z.infer<typeof voltageProjectStateSnapshotSchema> {
   const settings = snapshot.project;
   const sectionById = new Map(
     snapshot.circuitSections.map((section) => [section.id, section])
   );
   return {
     ...snapshot,
-    schemaVersion: projectStateSnapshotSchemaVersion,
+    schemaVersion: voltageProjectStateSnapshotSchemaVersion,
     projectDevices: snapshot.projectDevices.map((device) => ({
       ...device,
       voltageV: resolveProjectVoltage(device.phaseType, settings),
@@ -383,6 +410,19 @@ function upgradeSupplyTypesProjectStateSnapshot(
   };
 }
 
+function upgradeVoltageProjectStateSnapshot(
+  snapshot: z.infer<typeof voltageProjectStateSnapshotSchema>
+): ProjectStateSnapshot {
+  return {
+    ...snapshot,
+    schemaVersion: projectStateSnapshotSchemaVersion,
+    distributionBoards: snapshot.distributionBoards.map((board) => ({
+      ...board,
+      simultaneityFactor: 1,
+    })),
+  };
+}
+
 function isPlainObject(value: unknown): value is Record<string, unknown> {
   return value !== null && typeof value === "object" && !Array.isArray(value);
 }