@embedpdf/plugin-ui 2.1.2 → 2.3.0

package/dist/index.js

@@ -5,8 +5,7 @@ const manifest = {
   name: "UI Plugin",
   version: "1.0.0",
   provides: ["ui"],
-  requires: ["commands"],
-  // Depends on commands
+  requires: [],
   optional: ["i18n"],
   defaultConfig: {
     schema: {
@@ -33,6 +32,7 @@ const CLEAR_MODAL = "UI/CLEAR_MODAL";
 const OPEN_MENU = "UI/OPEN_MENU";
 const CLOSE_MENU = "UI/CLOSE_MENU";
 const CLOSE_ALL_MENUS = "UI/CLOSE_ALL_MENUS";
+const SET_OVERLAY_ENABLED = "UI/SET_OVERLAY_ENABLED";
 const SET_DISABLED_CATEGORIES = "UI/SET_DISABLED_CATEGORIES";
 const SET_HIDDEN_ITEMS = "UI/SET_HIDDEN_ITEMS";
 const initUIState = (documentId, schema) => ({
@@ -87,6 +87,10 @@ const closeAllMenus = (documentId) => ({
   type: CLOSE_ALL_MENUS,
   payload: { documentId }
 });
+const setOverlayEnabled = (documentId, overlayId, enabled) => ({
+  type: SET_OVERLAY_ENABLED,
+  payload: { documentId, overlayId, enabled }
+});
 const setDisabledCategories = (categories) => ({
   type: SET_DISABLED_CATEGORIES,
   payload: { categories }
@@ -777,6 +781,7 @@ const _UIPlugin = class _UIPlugin extends BasePlugin {
       (documentId, data) => ({ documentId, ...data }),
       { cache: false }
     );
+    this.overlayChanged$ = createScopedEmitter((documentId, data) => ({ documentId, ...data }), { cache: false });
     this.schema = config.schema;
     this.stylesheetConfig = config.stylesheetConfig || {};
     this.itemCategories = extractItemCategories(this.schema);
@@ -805,6 +810,7 @@ const _UIPlugin = class _UIPlugin extends BasePlugin {
     this.sidebarChanged$.clear();
     this.modalChanged$.clear();
     this.menuChanged$.clear();
+    this.overlayChanged$.clear();
     this.stylesheetInvalidated$.clear();
     super.destroy();
   }
@@ -817,6 +823,7 @@ const _UIPlugin = class _UIPlugin extends BasePlugin {
     this.sidebarChanged$.clearScope(documentId);
     this.modalChanged$.clearScope(documentId);
     this.menuChanged$.clearScope(documentId);
+    this.overlayChanged$.clearScope(documentId);
   }
   /**
    * Handle locale changes from i18n plugin.
@@ -917,6 +924,10 @@ const _UIPlugin = class _UIPlugin extends BasePlugin {
       openModal: (modalId, documentId) => this.openModalForDocument(modalId, documentId),
       openMenu: (menuId, triggeredByCommandId, triggeredByItemId, documentId) => this.openMenuForDocument(menuId, triggeredByCommandId, triggeredByItemId, documentId),
       toggleMenu: (menuId, triggeredByCommandId, triggeredByItemId, documentId) => this.toggleMenuForDocument(menuId, triggeredByCommandId, triggeredByItemId, documentId),
+      // Overlay operations
+      enableOverlay: (overlayId, documentId) => this.enableOverlayForDocument(overlayId, documentId),
+      disableOverlay: (overlayId, documentId) => this.disableOverlayForDocument(overlayId, documentId),
+      toggleOverlay: (overlayId, documentId) => this.toggleOverlayForDocument(overlayId, documentId),
       // Document-scoped operations
       forDocument: (documentId) => this.createUIScope(documentId),
       // Schema
@@ -937,6 +948,7 @@ const _UIPlugin = class _UIPlugin extends BasePlugin {
       onSidebarChanged: this.sidebarChanged$.onGlobal,
       onModalChanged: this.modalChanged$.onGlobal,
       onMenuChanged: this.menuChanged$.onGlobal,
+      onOverlayChanged: this.overlayChanged$.onGlobal,
       onCategoryChanged: this.categoryChanged$.on
     };
   }
@@ -972,6 +984,12 @@ const _UIPlugin = class _UIPlugin extends BasePlugin {
       closeAllMenus: () => this.closeAllMenusForDocument(documentId),
       isMenuOpen: (menuId) => this.isMenuOpenForDocument(menuId, documentId),
       getOpenMenus: () => this.getOpenMenusForDocument(documentId),
+      // ───── Overlays ─────
+      enableOverlay: (overlayId) => this.enableOverlayForDocument(overlayId, documentId),
+      disableOverlay: (overlayId) => this.disableOverlayForDocument(overlayId, documentId),
+      toggleOverlay: (overlayId) => this.toggleOverlayForDocument(overlayId, documentId),
+      isOverlayEnabled: (overlayId) => this.isOverlayEnabledForDocument(overlayId, documentId),
+      getEnabledOverlays: () => this.getEnabledOverlaysForDocument(documentId),
       // ───── Schema & state ─────
       getSchema: () => this.schema,
       getState: () => this.getDocumentStateOrThrow(documentId),
@@ -979,7 +997,8 @@ const _UIPlugin = class _UIPlugin extends BasePlugin {
       onToolbarChanged: this.toolbarChanged$.forScope(documentId),
       onSidebarChanged: this.sidebarChanged$.forScope(documentId),
       onModalChanged: this.modalChanged$.forScope(documentId),
-      onMenuChanged: this.menuChanged$.forScope(documentId)
+      onMenuChanged: this.menuChanged$.forScope(documentId),
+      onOverlayChanged: this.overlayChanged$.forScope(documentId)
     };
   }
   // ─────────────────────────────────────────────────────────
@@ -1125,6 +1144,36 @@ const _UIPlugin = class _UIPlugin extends BasePlugin {
   getOpenMenusForDocument(documentId) {
     return Object.values(this.getDocumentStateOrThrow(documentId).openMenus);
   }
+  // ─────────────────────────────────────────────────────────
+  // Core Operations - Overlays
+  // ─────────────────────────────────────────────────────────
+  enableOverlayForDocument(overlayId, documentId) {
+    const id = documentId ?? this.getActiveDocumentId();
+    this.dispatch(setOverlayEnabled(id, overlayId, true));
+    this.overlayChanged$.emit(id, { overlayId, isEnabled: true });
+  }
+  disableOverlayForDocument(overlayId, documentId) {
+    const id = documentId ?? this.getActiveDocumentId();
+    this.dispatch(setOverlayEnabled(id, overlayId, false));
+    this.overlayChanged$.emit(id, { overlayId, isEnabled: false });
+  }
+  toggleOverlayForDocument(overlayId, documentId) {
+    const id = documentId ?? this.getActiveDocumentId();
+    const isEnabled = this.isOverlayEnabledForDocument(overlayId, id);
+    if (isEnabled) {
+      this.disableOverlayForDocument(overlayId, id);
+    } else {
+      this.enableOverlayForDocument(overlayId, id);
+    }
+  }
+  isOverlayEnabledForDocument(overlayId, documentId) {
+    const enabledOverlays = this.getDocumentStateOrThrow(documentId).enabledOverlays;
+    return enabledOverlays[overlayId] ?? true;
+  }
+  getEnabledOverlaysForDocument(documentId) {
+    const enabledOverlays = this.getDocumentStateOrThrow(documentId).enabledOverlays;
+    return Object.entries(enabledOverlays).filter(([, enabled]) => enabled).map(([overlayId]) => overlayId);
+  }
 };
 _UIPlugin.id = "ui";
 let UIPlugin = _UIPlugin;
@@ -1133,7 +1182,8 @@ const initialDocumentState = {
   activeSidebars: {},
   activeModal: null,
   openMenus: {},
-  sidebarTabs: {}
+  sidebarTabs: {},
+  enabledOverlays: {}
 };
 const initialState = {
   documents: {},
@@ -1156,14 +1206,22 @@ const uiReducer = (state = initialState, action) => {
           };
         }
       });
+      const enabledOverlays = {};
+      if (schema.overlays) {
+        Object.values(schema.overlays).forEach((overlay) => {
+          enabledOverlays[overlay.id] = overlay.defaultEnabled ?? true;
+        });
+      }
       return {
         ...state,
         documents: {
           ...state.documents,
           [documentId]: {
             ...initialDocumentState,
-            activeToolbars
+            activeToolbars,
             // Initialize with permanent toolbars
+            enabledOverlays
+            // Initialize with overlay enabled states
           }
         }
       };
@@ -1402,6 +1460,26 @@ const uiReducer = (state = initialState, action) => {
         }
       };
     }
+    // ─────────────────────────────────────────────────────────
+    // Overlay Actions
+    // ─────────────────────────────────────────────────────────
+    case SET_OVERLAY_ENABLED: {
+      const { documentId, overlayId, enabled } = action.payload;
+      const docState = state.documents[documentId] || initialDocumentState;
+      return {
+        ...state,
+        documents: {
+          ...state.documents,
+          [documentId]: {
+            ...docState,
+            enabledOverlays: {
+              ...docState.enabledOverlays,
+              [overlayId]: enabled
+            }
+          }
+        }
+      };
+    }
     case SET_DISABLED_CATEGORIES: {
       return {
         ...state,
@@ -1469,6 +1547,7 @@ export {
   SET_ACTIVE_TOOLBAR,
   SET_DISABLED_CATEGORIES,
   SET_HIDDEN_ITEMS,
+  SET_OVERLAY_ENABLED,
   SET_SIDEBAR_TAB,
   UIPlugin,
   UIPluginPackage,
@@ -1506,6 +1585,7 @@ export {
   setActiveToolbar,
   setDisabledCategories,
   setHiddenItems,
+  setOverlayEnabled,
   setSidebarTab
 };
 //# sourceMappingURL=index.js.map