Add circuit group commands

src/domain/models/circuit-group-structure-project-command.model.ts

@@ -0,0 +1,192 @@
+import {
+  circuitGroupCategories,
+  type CircuitGroupCategory,
+} from "../../shared/constants/circuit-group.js";
+import { formatCircuitGroupPrefix } from "../services/circuit-group-numbering.js";
+import type { SerializedProjectCommand } from "./project-command.model.js";
+
+export const circuitGroupInsertCommandType = "circuit-group.insert" as const;
+export const circuitGroupDeleteCommandType = "circuit-group.delete" as const;
+export const circuitGroupUpdateCommandType = "circuit-group.update" as const;
+export const circuitGroupStructureCommandSchemaVersion = 1 as const;
+
+export interface CircuitGroupSnapshot {
+  id: string;
+  circuitListId: string;
+  key: string;
+  displayName: string;
+  prefix: string;
+  sortOrder: number;
+  category: CircuitGroupCategory;
+  groupNumber: number;
+}
+
+interface SnapshotPayload {
+  snapshot: CircuitGroupSnapshot;
+}
+
+interface UpdatePayload {
+  expected: CircuitGroupSnapshot;
+  target: CircuitGroupSnapshot;
+}
+
+export interface CircuitGroupInsertProjectCommand
+  extends SerializedProjectCommand<SnapshotPayload> {
+  schemaVersion: typeof circuitGroupStructureCommandSchemaVersion;
+  type: typeof circuitGroupInsertCommandType;
+}
+
+export interface CircuitGroupDeleteProjectCommand
+  extends SerializedProjectCommand<SnapshotPayload> {
+  schemaVersion: typeof circuitGroupStructureCommandSchemaVersion;
+  type: typeof circuitGroupDeleteCommandType;
+}
+
+export interface CircuitGroupUpdateProjectCommand
+  extends SerializedProjectCommand<UpdatePayload> {
+  schemaVersion: typeof circuitGroupStructureCommandSchemaVersion;
+  type: typeof circuitGroupUpdateCommandType;
+}
+
+export type CircuitGroupStructureProjectCommand =
+  | CircuitGroupInsertProjectCommand
+  | CircuitGroupDeleteProjectCommand
+  | CircuitGroupUpdateProjectCommand;
+
+export function createCircuitGroupInsertProjectCommand(
+  snapshot: CircuitGroupSnapshot
+): CircuitGroupInsertProjectCommand {
+  const command: CircuitGroupInsertProjectCommand = {
+    schemaVersion: circuitGroupStructureCommandSchemaVersion,
+    type: circuitGroupInsertCommandType,
+    payload: { snapshot },
+  };
+  assertCircuitGroupInsertProjectCommand(command);
+  return command;
+}
+
+export function createCircuitGroupDeleteProjectCommand(
+  snapshot: CircuitGroupSnapshot
+): CircuitGroupDeleteProjectCommand {
+  const command: CircuitGroupDeleteProjectCommand = {
+    schemaVersion: circuitGroupStructureCommandSchemaVersion,
+    type: circuitGroupDeleteCommandType,
+    payload: { snapshot },
+  };
+  assertCircuitGroupDeleteProjectCommand(command);
+  return command;
+}
+
+export function createCircuitGroupUpdateProjectCommand(
+  expected: CircuitGroupSnapshot,
+  target: CircuitGroupSnapshot
+): CircuitGroupUpdateProjectCommand {
+  const command: CircuitGroupUpdateProjectCommand = {
+    schemaVersion: circuitGroupStructureCommandSchemaVersion,
+    type: circuitGroupUpdateCommandType,
+    payload: { expected, target },
+  };
+  assertCircuitGroupUpdateProjectCommand(command);
+  return command;
+}
+
+export function assertCircuitGroupInsertProjectCommand(
+  command: SerializedProjectCommand<unknown>
+): asserts command is CircuitGroupInsertProjectCommand {
+  assertSnapshotCommand(command, circuitGroupInsertCommandType);
+}
+
+export function assertCircuitGroupDeleteProjectCommand(
+  command: SerializedProjectCommand<unknown>
+): asserts command is CircuitGroupDeleteProjectCommand {
+  assertSnapshotCommand(command, circuitGroupDeleteCommandType);
+}
+
+export function assertCircuitGroupUpdateProjectCommand(
+  command: SerializedProjectCommand<unknown>
+): asserts command is CircuitGroupUpdateProjectCommand {
+  if (
+    command.schemaVersion !== circuitGroupStructureCommandSchemaVersion ||
+    command.type !== circuitGroupUpdateCommandType ||
+    !isPlainObject(command.payload) ||
+    Object.keys(command.payload).length !== 2
+  ) {
+    throw new Error("Unsupported circuit-group update command.");
+  }
+  assertCircuitGroupSnapshot(command.payload.expected);
+  assertCircuitGroupSnapshot(command.payload.target);
+  for (const field of [
+    "id",
+    "circuitListId",
+    "key",
+    "prefix",
+    "sortOrder",
+    "category",
+    "groupNumber",
+  ] as const) {
+    if (command.payload.expected[field] !== command.payload.target[field]) {
+      throw new Error(
+        "Circuit-group updates can only change the display name."
+      );
+    }
+  }
+}
+
+function assertSnapshotCommand(
+  command: SerializedProjectCommand<unknown>,
+  type:
+    | typeof circuitGroupInsertCommandType
+    | typeof circuitGroupDeleteCommandType
+) {
+  if (
+    command.schemaVersion !== circuitGroupStructureCommandSchemaVersion ||
+    command.type !== type ||
+    !isPlainObject(command.payload) ||
+    Object.keys(command.payload).length !== 1
+  ) {
+    throw new Error("Unsupported circuit-group structure command.");
+  }
+  assertCircuitGroupSnapshot(command.payload.snapshot);
+}
+
+export function assertCircuitGroupSnapshot(
+  value: unknown
+): asserts value is CircuitGroupSnapshot {
+  if (!isPlainObject(value) || Object.keys(value).length !== 8) {
+    throw new Error("Circuit-group snapshot is invalid.");
+  }
+  for (const field of [
+    "id",
+    "circuitListId",
+    "key",
+    "displayName",
+    "prefix",
+  ] as const) {
+    if (typeof value[field] !== "string" || !value[field].trim()) {
+      throw new Error(`${field} must be a non-empty string.`);
+    }
+  }
+  if (
+    !circuitGroupCategories.includes(
+      value.category as CircuitGroupCategory
+    ) ||
+    !Number.isInteger(value.groupNumber) ||
+    (value.groupNumber as number) < 1 ||
+    !Number.isFinite(value.sortOrder)
+  ) {
+    throw new Error("Circuit-group category, number or order is invalid.");
+  }
+  if (
+    value.prefix !==
+    formatCircuitGroupPrefix(
+      value.category as CircuitGroupCategory,
+      value.groupNumber as number
+    )
+  ) {
+    throw new Error("Circuit-group prefix does not match its category and number.");
+  }
+}
+
+function isPlainObject(value: unknown): value is Record<string, unknown> {
+  return value !== null && typeof value === "object" && !Array.isArray(value);
+}

src/domain/ports/circuit-group-structure-project-command.store.ts

@@ -0,0 +1,22 @@
+import type { CircuitGroupStructureProjectCommand } from "../models/circuit-group-structure-project-command.model.js";
+import type {
+  AppendedProjectRevision,
+  ProjectRevisionSource,
+} from "./project-revision.store.js";
+
+export interface ExecuteCircuitGroupStructureCommandInput {
+  projectId: string;
+  expectedRevision: number;
+  source: ProjectRevisionSource;
+  description?: string;
+  actorId?: string;
+  historyTargetChangeSetId?: string;
+  command: CircuitGroupStructureProjectCommand;
+}
+
+export interface CircuitGroupStructureProjectCommandStore {
+  execute(input: ExecuteCircuitGroupStructureCommandInput): {
+    revision: AppendedProjectRevision;
+    inverse: CircuitGroupStructureProjectCommand;
+  };
+}

src/domain/services/circuit-group-numbering.ts

@@ -36,6 +36,13 @@ function getGroupStem(
   return `-${circuitGroupCategoryNumbers[category]}${functionLetter}${groupNumber}`;
 }
 
+export function formatCircuitGroupPrefix(
+  category: CircuitGroupCategory,
+  groupNumber: number
+) {
+  return `${getGroupStem(category, "F", groupNumber)}.`;
+}
+
 export function formatGroupUpstreamProtectionIdentifier(
   category: CircuitGroupCategory,
   groupNumber: number

src/domain/services/project-command.service.ts

@@ -98,6 +98,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 { CircuitGroupStructureProjectCommandStore } from "../ports/circuit-group-structure-project-command.store.js";
 import type { DistributionBoardStructureProjectCommandStore } from "../ports/distribution-board-structure-project-command.store.js";
 import type { DistributionBoardComponentStructureProjectCommandStore } from "../ports/distribution-board-component-structure-project-command.store.js";
 import type {
@@ -110,6 +111,14 @@ import type {
   ProjectHistoryDirection,
   ProjectHistoryStore,
 } from "../ports/project-history.store.js";
+import {
+  assertCircuitGroupDeleteProjectCommand,
+  assertCircuitGroupInsertProjectCommand,
+  assertCircuitGroupUpdateProjectCommand,
+  circuitGroupDeleteCommandType,
+  circuitGroupInsertCommandType,
+  circuitGroupUpdateCommandType,
+} from "../models/circuit-group-structure-project-command.model.js";
 import type { ProjectLocationStructureProjectCommandStore } from "../ports/project-location-structure-project-command.store.js";
 import type { ProjectDeviceProjectCommandStore } from "../ports/project-device-project-command.store.js";
 import type { ProjectDeviceRowSyncProjectCommandStore } from "../ports/project-device-row-sync-project-command.store.js";
@@ -145,6 +154,7 @@ export class ProjectCommandService implements ProjectCommandExecutor {
     private readonly projectSettingsStore: ProjectSettingsProjectCommandStore,
     private readonly projectStateRestoreStore: ProjectStateRestoreCommandStore,
     private readonly distributionBoardComponentStructureStore: DistributionBoardComponentStructureProjectCommandStore,
+    private readonly circuitGroupStructureStore: CircuitGroupStructureProjectCommandStore,
     private readonly historyStore: ProjectHistoryStore
   ) {}
 
@@ -333,6 +343,27 @@ export class ProjectCommandService implements ProjectCommandExecutor {
           command: input.command,
         }).revision;
       }
+      case circuitGroupInsertCommandType: {
+        assertCircuitGroupInsertProjectCommand(input.command);
+        return this.circuitGroupStructureStore.execute({
+          ...input,
+          command: input.command,
+        }).revision;
+      }
+      case circuitGroupDeleteCommandType: {
+        assertCircuitGroupDeleteProjectCommand(input.command);
+        return this.circuitGroupStructureStore.execute({
+          ...input,
+          command: input.command,
+        }).revision;
+      }
+      case circuitGroupUpdateCommandType: {
+        assertCircuitGroupUpdateProjectCommand(input.command);
+        return this.circuitGroupStructureStore.execute({
+          ...input,
+          command: input.command,
+        }).revision;
+      }
       case projectFloorInsertCommandType: {
         assertProjectFloorInsertProjectCommand(input.command);
         return this.projectLocationStructureStore.execute({