Generate unique Palette harmony color names - PR_26156_179-palette-harmony-unique-generated-names

ToolboxAid · ToolboxAid · commit 844028f668af · 2026-06-05T22:07:43.000-04:00
diff --git a/docs_build/dev/reports/palette-harmony-unique-generated-names-report.md b/docs_build/dev/reports/palette-harmony-unique-generated-names-report.md
@@ -0,0 +1,48 @@
+# PR_26156_179 Palette Harmony Unique Generated Names Report
+
+## Result
+PASS
+
+## Summary
+- Fixed Color Harmony Schemes add behavior so generated harmony names are unique in the active project palette.
+- Harmony suggestions keep stable display labels, such as `Complementary 1`, while add-time persistence increments the saved name when needed.
+- Existing generated harmony names now advance to the next available scheme number instead of failing duplicate-name validation.
+- Harmony additions skip existing RGB/hex colors before validation so repeated Add All calls do not create duplicate colors.
+- True user-entered duplicate names still use normal duplicate-name validation.
+
+## Harmony Behavior
+- Two complementary generated suggestions that both start as `Complementary 1` save as `Complementary 1` and `Complementary 2`.
+- Add All adds all non-duplicate generated harmony colors.
+- Repeating Add All skips existing harmony hex values without surfacing duplicate-name validation.
+- Single pin/dot harmony add behavior uses the same generated-name allocator.
+
+## Validation Boundary
+- Duplicate-name validation remains unchanged for manual user swatch add/update paths.
+- The duplicate-name bypass is not global; only auto-generated harmony names are incremented.
+- Duplicate RGB/hex protection remains active by pre-skipping existing harmony colors.
+
+## Validation
+- `node --check toolbox/colors/colors.js`
+  - PASS
+- `node --check toolbox/colors/palette-workspace-repository.js`
+  - PASS
+- `node --check tests/playwright/tools/PaletteToolMockRepository.spec.mjs`
+  - PASS
+- `rg "style=|<style|onclick|onchange|oninput|onsubmit" toolbox/colors/index.html toolbox/colors/colors.js toolbox/colors/palette-workspace-repository.js tests/playwright/tools/PaletteToolMockRepository.spec.mjs`
+  - PASS, no matches
+- `npx playwright test tests/playwright/tools/PaletteToolMockRepository.spec.mjs --project=playwright --workers=1 --reporter=list`
+  - PASS, 3 tests
+- `npm run test:playwright:static`
+  - PASS
+- `git diff --check`
+  - PASS
+
+## Verification Coverage
+- Adding complementary harmony colors creates unique generated names.
+- Add All adds all non-duplicate harmony colors.
+- Repeated Add All does not duplicate existing hex values.
+- Duplicate-name validation still blocks true user-entered duplicate names.
+- Harmony duplicate-name validation does not appear for auto-generated names that can be safely incremented.
+
+## Skipped
+- Full samples smoke was not run, per BUILD instruction.
diff --git a/docs_build/dev/reports/playwright_v8_coverage_report.txt b/docs_build/dev/reports/playwright_v8_coverage_report.txt
@@ -12,19 +12,19 @@ Note: entry percentages use function coverage when available, otherwise line cov
 Note: coverage entries are aggregated across every page/tool where coverageReporter.start(page) and coverageReporter.stop(page) ran.
 
 Exercised tool entry points detected:
-(86%) Toolbox Index - exercised 5 runtime JS files
+(85%) Toolbox Index - exercised 5 runtime JS files
 (0%) Tool Template V2 - not exercised by this Playwright run
 (83%) Theme V2 Shared JS - exercised 2 runtime JS files
 
 Changed runtime JS files covered:
-(95%) toolbox/colors/colors.js - executed lines 793/793; executed functions 77/81
+(87%) toolbox/colors/palette-workspace-repository.js - executed lines 1218/1218; executed functions 116/134
 
 Files with executed line/function counts where available:
 (65%) toolbox/project-workspace/project-workspace-mock-repository.js - executed lines 402/402; executed functions 20/31
 (75%) toolbox/toolRegistry.js - executed lines 1754/1754; executed functions 27/36
 (80%) assets/theme-v2/js/gamefoundry-partials.js - executed lines 205/205; executed functions 16/20
 (87%) assets/theme-v2/js/tool-display-mode.js - executed lines 201/201; executed functions 13/15
-(87%) toolbox/colors/palette-workspace-repository.js - executed lines 1190/1190; executed functions 113/130
+(87%) toolbox/colors/palette-workspace-repository.js - executed lines 1218/1218; executed functions 116/134
 (95%) toolbox/colors/colors.js - executed lines 793/793; executed functions 77/81
 (100%) toolbox/colors/palette-source-mock-db.js - executed lines 927/927; executed functions 6/6
 
@@ -33,4 +33,4 @@ Uncovered or low-coverage changed JS files:
 
 Changed JS files considered:
 (0%) tests/playwright/tools/PaletteToolMockRepository.spec.mjs - changed JS file not collected as browser runtime coverage
-(95%) toolbox/colors/colors.js - changed JS file with browser V8 coverage
+(87%) toolbox/colors/palette-workspace-repository.js - changed JS file with browser V8 coverage
diff --git a/docs_build/dev/reports/testing_lane_execution_report.md b/docs_build/dev/reports/testing_lane_execution_report.md
@@ -1,15 +1,15 @@
-# PR_26156_178 Testing Lane Execution Report
+# PR_26156_179 Testing Lane Execution Report
 
 ## Result
 PASS
 
 ## Commands Run
 - `node --check toolbox/colors/colors.js`
   - PASS
+- `node --check toolbox/colors/palette-workspace-repository.js`
+  - PASS
 - `node --check tests/playwright/tools/PaletteToolMockRepository.spec.mjs`
   - PASS
-- `rg "placeholder=" toolbox/colors/index.html tests/playwright/tools/PaletteToolMockRepository.spec.mjs`
-  - PASS, no matches
 - `rg "style=|<style|onclick|onchange|oninput|onsubmit" toolbox/colors/index.html toolbox/colors/colors.js toolbox/colors/palette-workspace-repository.js tests/playwright/tools/PaletteToolMockRepository.spec.mjs`
   - PASS, no matches
 - `npx playwright test tests/playwright/tools/PaletteToolMockRepository.spec.mjs --project=playwright --workers=1 --reporter=list`
@@ -20,26 +20,25 @@ PASS
   - PASS
 
 ## Required Lanes
-- Targeted Palette Tool runtime/UI lane: PASS.
+- Targeted Palette Tool harmony runtime lane: PASS.
 - Changed-file/static validation: PASS.
 
 ## Playwright Coverage
-- Initial no-selection state shows empty disabled Swatch Editor fields: PASS.
-- Initial no-selection state shows no placeholder text in Swatch Editor fields: PASS.
-- Placeholder text is absent from Swatch Editor and User Defined Swatch inputs: PASS.
-- Selecting a source-backed swatch populates Swatch Editor selected values: PASS.
-- Selecting a user-defined swatch populates Swatch Editor selected values: PASS.
-- Removing the selected swatch returns Swatch Editor fields to empty disabled state: PASS.
-- PR_26156_177 User Defined Swatch rules remain covered: PASS.
+- Adding complementary harmony colors creates unique generated names: PASS.
+- Generated complementary suggestions that start as `Complementary 1` save as `Complementary 1` and `Complementary 2`: PASS.
+- Add All adds all non-duplicate generated harmony colors: PASS.
+- Repeated Add All skips existing harmony hex values without duplicates: PASS.
+- Duplicate-name validation still blocks true user-entered duplicate names: PASS.
+- Auto-generated harmony duplicate names are incremented instead of surfacing duplicate-name validation: PASS.
 
 ## Impacted Lane
-- Palette Tool runtime/UI lane.
+- Palette Tool harmony runtime lane.
 - Changed-file/static validation lane.
 
 ## Skipped Lanes
 - Full samples smoke was skipped by BUILD instruction.
-- Shared Tool Center fullscreen UI lane was skipped because PR178 does not modify shared Tool Center or Theme V2 behavior.
-- Broader tool lanes were skipped because changes are confined to Palette Tool input markup and targeted Palette spec assertions.
+- Shared Tool Center fullscreen UI lane was skipped because PR179 does not modify shared Tool Center or Theme V2 behavior.
+- Broader tool lanes were skipped because changes are confined to Palette harmony repository behavior and targeted Palette spec assertions.
 
 ## Not Run
 - Full samples smoke was not run, per BUILD instruction.
diff --git a/tests/playwright/tools/PaletteToolMockRepository.spec.mjs b/tests/playwright/tools/PaletteToolMockRepository.spec.mjs
@@ -262,7 +262,9 @@ test("Palette repository owns active project swatches without mutating invalid p
   ]));
 
   expect(repository.addSwatch({ symbol: "H", hex: "#654321", name: "Other" }).ok).toBe(false);
-  expect(repository.addSwatch({ symbol: "O", hex: "#654321", name: "Hero Blue" }).ok).toBe(false);
+  const duplicateNameResult = repository.addSwatch({ symbol: "O", hex: "#654321", name: "Hero Blue" });
+  expect(duplicateNameResult.ok).toBe(false);
+  expect(duplicateNameResult.issues.map((issue) => issue.label)).toContain("Duplicate Name");
   expect(repository.addSwatch({ symbol: "O", hex: "#123456", name: "Other" }).ok).toBe(false);
 
   const updateResult = repository.updateSelectedSwatch({
@@ -331,8 +333,45 @@ test("Palette repository owns active project swatches without mutating invalid p
   expect(harmonySwatch).toMatchObject({ source: "harmony", tags: [] });
   const duplicateHarmonyResult = repository.addHarmonySuggestions([harmonySuggestion]);
   expect(duplicateHarmonyResult.ok).toBe(false);
+  expect(duplicateHarmonyResult.issues).toEqual([]);
   expect(repository.listSwatches().filter((swatch) => swatch.name === harmonySuggestion.name)).toHaveLength(1);
 
+  const harmonyRepository = createProjectWorkspacePaletteRepository({ sourcePaletteRows });
+  expect(harmonyRepository.addSwatch({ symbol: "A", hex: "#112233", name: "Base One" }).ok).toBe(true);
+  expect(harmonyRepository.addSwatch({ symbol: "B", hex: "#445566", name: "Base Two" }).ok).toBe(true);
+  const firstComplementary = harmonyRepository.createHarmonySuggestions(harmonyRepository.findSwatch("A"), {
+    matchSource: "calculated",
+    schemeId: "complementary"
+  })[0];
+  const secondComplementary = harmonyRepository.createHarmonySuggestions(harmonyRepository.findSwatch("B"), {
+    matchSource: "calculated",
+    schemeId: "complementary"
+  })[0];
+  expect(firstComplementary.name).toBe("Complementary 1");
+  expect(secondComplementary.name).toBe("Complementary 1");
+  expect(harmonyRepository.addHarmonySuggestion(firstComplementary).ok).toBe(true);
+  expect(harmonyRepository.addHarmonySuggestion(secondComplementary).ok).toBe(true);
+  expect(harmonyRepository.listSwatches().filter((swatch) => swatch.source === "harmony").map((swatch) => swatch.name)).toEqual([
+    "Complementary 1",
+    "Complementary 2"
+  ]);
+  const triadicSuggestions = harmonyRepository.createHarmonySuggestions(harmonyRepository.findSwatch("A"), {
+    matchSource: "calculated",
+    schemeId: "triadic"
+  });
+  const triadicAddAllResult = harmonyRepository.addHarmonySuggestions(triadicSuggestions);
+  expect(triadicAddAllResult.ok).toBe(true);
+  expect(triadicAddAllResult.message).toBe("Harmony add complete: 2 added, 0 skipped.");
+  expect(harmonyRepository.listSwatches().filter((swatch) => swatch.name.startsWith("Triadic ")).map((swatch) => swatch.name)).toEqual([
+    "Triadic 1",
+    "Triadic 2"
+  ]);
+  const repeatTriadicResult = harmonyRepository.addHarmonySuggestions(triadicSuggestions);
+  expect(repeatTriadicResult.ok).toBe(false);
+  expect(repeatTriadicResult.message).toBe("Harmony add complete: 0 added, 2 skipped.");
+  expect(repeatTriadicResult.issues).toEqual([]);
+  expect(harmonyRepository.listSwatches().filter((swatch) => swatch.name.startsWith("Triadic "))).toHaveLength(2);
+
   repository.selectSwatch("R");
   repository.recordSwatchUsage({ assetId: "asset.color.red", symbol: "R", toolId: "assets" });
   const blockedRemoval = repository.removeSelectedSwatch();
diff --git a/toolbox/colors/palette-workspace-repository.js b/toolbox/colors/palette-workspace-repository.js
@@ -527,6 +527,28 @@ function nextAvailableSymbol(existingSwatches, seedText = "") {
   return candidates.find((candidate) => !used.has(candidate)) || "";
 }
 
+function generatedHarmonyNameRoot(name) {
+  const normalizedName = normalizeText(name);
+  return normalizedName.replace(/\s+\d+$/, "") || normalizedName;
+}
+
+function nextGeneratedHarmonyName(name, existingSwatches) {
+  const normalizedName = normalizeText(name);
+  const usedNames = new Set(existingSwatches.map((swatch) => swatch.name.toLowerCase()));
+  if (normalizedName && !usedNames.has(normalizedName.toLowerCase())) {
+    return normalizedName;
+  }
+
+  const root = generatedHarmonyNameRoot(normalizedName) || "Harmony";
+  let index = 1;
+  let candidate = `${root} ${index}`;
+  while (usedNames.has(candidate.toLowerCase())) {
+    index += 1;
+    candidate = `${root} ${index}`;
+  }
+  return candidate;
+}
+
 function createUsageId(projectId, swatchSymbol, assetId) {
   return `${projectId || "project"}-${swatchSymbol || "swatch"}-${assetId || "asset"}`;
 }
@@ -996,7 +1018,6 @@ export function createProjectWorkspacePaletteRepository(options = {}) {
   function addHarmonySuggestion(suggestion = {}) {
     const projectId = activeProjectId();
     const swatches = getActiveSwatches();
-    const symbol = nextAvailableSymbol(swatches, suggestion.name);
     if (!projectId) {
       return {
         issues: [createIssue("activeProject", "Active Project", "Open a project before adding harmony colors.")],
@@ -1005,6 +1026,17 @@ export function createProjectWorkspacePaletteRepository(options = {}) {
         snapshot: getSnapshot()
       };
     }
+    if (rgbKey(suggestion.hex) && swatches.some((swatch) => rgbKey(swatch.hex) === rgbKey(suggestion.hex))) {
+      return {
+        issues: [],
+        ok: false,
+        message: "Harmony color already exists in the active project palette.",
+        snapshot: getSnapshot()
+      };
+    }
+
+    const name = nextGeneratedHarmonyName(suggestion.name, swatches);
+    const symbol = nextAvailableSymbol(swatches, name);
     if (!symbol) {
       return {
         issues: [createIssue("symbol", "Symbol", "No available one-character palette symbol remains.")],
@@ -1016,7 +1048,7 @@ export function createProjectWorkspacePaletteRepository(options = {}) {
 
     const validation = validatePaletteSwatchInput({
       hex: suggestion.hex,
-      name: suggestion.name,
+      name,
       source: "harmony",
       symbol,
       tags: []
