Merge pull request #132 from keyxmakerx/claude/foundry-module-review-IrVxd

feat: add Sync Dashboard UI to Foundry VTT module

Author: keyxmakerx

foundry-module/lang/en.json

@@ -44,6 +44,72 @@
       "SyncConflict": "Sync conflict detected for: {name}",
       "ConnectionLost": "Lost connection to Chronicle. Retrying...",
       "ConnectionRestored": "Connection to Chronicle restored"
+    },
+    "Dashboard": {
+      "Title": "Chronicle Sync",
+      "OpenSettings": "Open Settings",
+      "NotConfigured": "Chronicle Sync is not configured.",
+      "NotConfiguredHint": "Go to Module Settings to enter your Chronicle URL, API key, and Campaign ID.",
+      "Tabs": {
+        "Entities": "Entities",
+        "Maps": "Maps",
+        "Calendar": "Calendar",
+        "Status": "Status"
+      },
+      "Entities": {
+        "PullAll": "Pull All",
+        "PushAll": "Push All",
+        "Refresh": "Refresh",
+        "SearchPlaceholder": "Search entities...",
+        "Synced": "Synced",
+        "Modified": "Modified",
+        "ChronicleOnly": "Chronicle",
+        "FoundryOnly": "Foundry",
+        "Pull": "Pull",
+        "Push": "Push",
+        "SyncEnabled": "Sync enabled",
+        "SyncDisabled": "Sync disabled",
+        "EnableSync": "Enable sync for this type",
+        "DisableSync": "Disable sync for this type",
+        "FoundryOnlyJournals": "Foundry-Only Journals",
+        "Unlinked": "unlinked",
+        "PrivateClickPublic": "Private — click to make public",
+        "PublicClickPrivate": "Public — click to make private",
+        "EmptyState": "No entities found. Create entities in Chronicle or journals in Foundry to get started."
+      },
+      "Maps": {
+        "ChronicleMaps": "Chronicle Maps",
+        "UnlinkedScenes": "Unlinked Foundry Scenes",
+        "LinkToScene": "Link to scene...",
+        "LinkToMap": "Link to map...",
+        "Unlink": "Unlink",
+        "NoMaps": "No maps found in this Chronicle campaign."
+      },
+      "Calendar": {
+        "CalendarModule": "Calendar Module",
+        "Chronicle": "Chronicle",
+        "Foundry": "Foundry",
+        "InSync": "In Sync",
+        "OutOfSync": "Out of Sync",
+        "PullDate": "Pull Date from Chronicle",
+        "PushDate": "Push Date to Chronicle",
+        "NoCalendar": "No calendar configured for this campaign in Chronicle.",
+        "Disabled": "Calendar sync is disabled. Enable it in Module Settings.",
+        "NoModule": "No calendar module detected.",
+        "NoModuleHint": "Install Calendaria or Simple Calendar to enable calendar sync.",
+        "UnableToRead": "Unable to read"
+      },
+      "StatusTab": {
+        "Connection": "Connection",
+        "EntitiesSynced": "Entities Synced",
+        "MapsLinked": "Maps Linked",
+        "LastSync": "Last sync",
+        "RecentActivity": "Recent Activity",
+        "NoActivity": "No recent activity.",
+        "ClearLog": "Clear Log",
+        "Settings": "Settings",
+        "Reconnect": "Reconnect"
+      }
     }
   }
 }

foundry-module/scripts/journal-sync.mjs

@@ -9,7 +9,7 @@
  * - Foundry → Chronicle: JournalEntry changes detected via Hooks, push to Chronicle API.
  */
 
-import { getSetting } from './settings.mjs';
+import { getSetting, getSyncExclusions } from './settings.mjs';
 
 // Flag namespace for Chronicle data stored on Foundry documents.
 const FLAG_SCOPE = 'chronicle-sync';
@@ -111,6 +111,9 @@ export class JournalSync {
   async _onEntityCreated(entity) {
     if (!entity?.id) return;
 
+    // Skip if entity or its type is excluded from sync.
+    if (this._isExcluded(entity)) return;
+
     // Check if we already have a journal for this entity.
     const existing = game.journal.find(
       (j) => j.getFlag(FLAG_SCOPE, 'entityId') === entity.id
@@ -136,6 +139,9 @@ export class JournalSync {
   async _onEntityUpdated(entity) {
     if (!entity?.id) return;
 
+    // Skip if entity or its type is excluded from sync.
+    if (this._isExcluded(entity)) return;
+
     const journal = game.journal.find(
       (j) => j.getFlag(FLAG_SCOPE, 'entityId') === entity.id
     );
@@ -409,4 +415,17 @@ export class JournalSync {
       console.warn('Chronicle: Failed to delete entity on Chronicle', err);
     }
   }
+
+  /**
+   * Check if an entity is excluded from auto-sync via dashboard settings.
+   * @param {object} entity - Chronicle entity with id and optionally entity_type_id.
+   * @returns {boolean}
+   * @private
+   */
+  _isExcluded(entity) {
+    const exclusions = getSyncExclusions();
+    if (exclusions.excludedEntities.includes(entity.id)) return true;
+    if (entity.entity_type_id && exclusions.excludedTypes.includes(entity.entity_type_id)) return true;
+    return false;
+  }
 }

foundry-module/scripts/module.mjs

@@ -12,10 +12,14 @@ import { JournalSync } from './journal-sync.mjs';
 import { MapSync } from './map-sync.mjs';
 import { ShopWidget } from './shop-widget.mjs';
 import { CalendarSync } from './calendar-sync.mjs';
+import { SyncDashboard } from './sync-dashboard.mjs';
 
 /** @type {SyncManager|null} */
 let syncManager = null;
 
+/** @type {SyncDashboard|null} */
+let dashboard = null;
+
 /**
  * Module initialization — register settings.
  * This runs before the game is fully ready.
@@ -44,10 +48,39 @@ Hooks.once('ready', async () => {
   // Start the sync manager (connects WebSocket, performs initial sync).
   await syncManager.start();
 
+  // Create the sync dashboard (singleton, rendered on demand).
+  dashboard = new SyncDashboard();
+  dashboard.bind(syncManager);
+
   // Add sync status indicator to the UI.
   _addStatusIndicator();
 });
 
+/**
+ * Add a Chronicle Sync button to Foundry's scene controls toolbar.
+ * Visible only to GMs. Opens the Sync Dashboard on click.
+ */
+Hooks.on('getSceneControlButtons', (controls) => {
+  if (!game.user.isGM) return;
+
+  controls.push({
+    name: 'chronicle-sync',
+    title: 'Chronicle Sync',
+    icon: 'fa-solid fa-rotate',
+    layer: 'controls',
+    visible: true,
+    tools: [{
+      name: 'dashboard',
+      title: 'Open Chronicle Sync Dashboard',
+      icon: 'fa-solid fa-rotate',
+      button: true,
+      onClick: () => {
+        if (dashboard) dashboard.render(true);
+      },
+    }],
+  });
+});
+
 /**
  * Clean up when the module is deactivated.
  */
@@ -152,7 +185,9 @@ Hooks.once('ready', () => {
   if (module) {
     module.api = {
       syncManager,
+      dashboard,
       getAPI: () => syncManager?.api,
+      openDashboard: () => dashboard?.render(true),
     };
   }
 });

foundry-module/scripts/settings.mjs

@@ -90,6 +90,15 @@ export function registerSettings() {
     type: String,
     default: '',
   });
+
+  // Internal: per-type and per-entity sync exclusions (not shown in settings UI).
+  // Stored as JSON: { excludedTypes: [typeId, ...], excludedEntities: ["entityId", ...] }
+  game.settings.register(MODULE_ID, 'syncExclusions', {
+    scope: 'world',
+    config: false,
+    type: String,
+    default: '{"excludedTypes":[],"excludedEntities":[]}',
+  });
 }
 
 /**
@@ -110,6 +119,26 @@ export async function setSetting(key, value) {
   await game.settings.set(MODULE_ID, key, value);
 }
 
+/**
+ * Get sync exclusions (excluded types and entities).
+ * @returns {{ excludedTypes: number[], excludedEntities: string[] }}
+ */
+export function getSyncExclusions() {
+  try {
+    return JSON.parse(getSetting('syncExclusions'));
+  } catch {
+    return { excludedTypes: [], excludedEntities: [] };
+  }
+}
+
+/**
+ * Save sync exclusions.
+ * @param {{ excludedTypes: number[], excludedEntities: string[] }} exclusions
+ */
+export async function setSyncExclusions(exclusions) {
+  await setSetting('syncExclusions', JSON.stringify(exclusions));
+}
+
 /**
  * Check if the module is properly configured (URL + key + campaign).
  * @returns {boolean}