pptx-react-viewer 1.0.0 → 1.0.8

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-present pptx-viewer contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/NOTICE

@@ -0,0 +1,16 @@
+pptx-viewer
+Copyright (c) 2025-present pptx-viewer contributors
+
+This package is licensed under the MIT License. See the LICENSE file for details.
+
+This package bundles the following component under a different license:
+
+  mtx-decompressor — MicroType Express (MTX) font decompressor
+  License: Mozilla Public License 2.0 (MPL-2.0)
+  Source:  https://github.com/ChristopherVR/pptx-viewer/tree/main/packages/mtx-decompressor
+  Origin:  Ported from libeot (https://github.com/nicowilliams/libeot)
+           by Brennan T. Vincent, licensed under MPL-2.0.
+
+Under MPL-2.0, the source code of the mtx-decompressor component remains
+available under the terms of the Mozilla Public License 2.0. The full text
+of the MPL-2.0 can be found at: https://mozilla.org/MPL/2.0/

package/README.md

@@ -296,123 +296,17 @@ import {
 
 ### High-Level Component Tree
 
-```mermaid
-flowchart TB
-    PPV["PowerPointViewer<br/>(root orchestrator)"]
-
-    PPV --> VTS["ViewerToolbarSection<br/>Toolbar + ModeSwitcher"]
-    PPV --> VMC["ViewerMainContent<br/>Canvas + sidebars + inspector"]
-    PPV --> VBP["ViewerBottomPanels<br/>Notes + status bar"]
-    PPV --> VDG["ViewerDialogGroup<br/>All modal dialogs"]
-    PPV --> VO["ViewerOverlays<br/>Shortcuts, accessibility, slide sorter"]
-    PPV --> VPL["ViewerPresentationLayer<br/>Fullscreen slideshow"]
-
-    VMC --> VSP["ViewerSidePanels<br/>Slides pane + master pane"]
-    VMC --> VCA["ViewerCanvasArea<br/>SlideCanvas + overlays"]
-    VMC --> VI["ViewerInspector<br/>Properties panel"]
-
-    VCA --> SC["SlideCanvas<br/>Main slide rendering"]
-    SC --> ER["ElementRenderer<br/>Per-element dispatch"]
-    ER --> SH["Shape / Text"]
-    ER --> IM["Image"]
-    ER --> TB["Table"]
-    ER --> CH["Chart (SVG)"]
-    ER --> CN["Connector"]
-    ER --> SA["SmartArt"]
-    ER --> M3["3D Model"]
-    ER --> MD["Media (audio/video)"]
-    ER --> IK["Ink"]
-```
+_See the [architecture diagrams on GitHub](https://github.com/ChristopherVR/pptx-viewer/blob/main/packages/react/README.md) for visual representations._
 
 ### Hook Composition
 
 The viewer's logic is decomposed into 67+ custom hooks, composed in `PowerPointViewer.tsx`:
 
-```mermaid
-flowchart TD
-    subgraph "Core State"
-        VS["useViewerState<br/>All mutable state"]
-        VCS["useViewerCoreState<br/>Slides, selection, canvas"]
-        VUI["useViewerUIState<br/>Panels, dialogs, UI flags"]
-    end
-
-    subgraph "Derived State"
-        DSS["useDerivedSlideState<br/>Visible indexes, sections"]
-        DES["useDerivedElementState<br/>Selected element computed props"]
-    end
-
-    subgraph "Core Operations"
-        EH["useEditorHistory<br/>Undo/redo snapshot stack"]
-        ZV["useZoomViewport<br/>Zoom level + viewport"]
-        EO["useEditorOperations<br/>Compose all editor ops"]
-    end
-
-    subgraph "Feature Hooks"
-        LC["useLoadContent<br/>Parse PPTX on mount"]
-        PM["usePresentationMode<br/>Slideshow navigation"]
-        PA["usePresentationAnnotations<br/>Pen/highlighter tools"]
-        IE["useInsertElements<br/>Shape/image/table insertion"]
-        EM["useElementManipulation<br/>Move/resize/delete"]
-        PH["usePointerHandlers<br/>Mouse/touch events"]
-        KS["useKeyboardShortcuts<br/>Hotkey bindings"]
-        EX["useExportHandlers<br/>PNG/SVG/PDF/video export"]
-        PR["usePrintHandlers<br/>Print dialog"]
-        SM["useSlideManagement<br/>Add/delete/reorder slides"]
-        TO["useTableOperations<br/>Row/column/cell ops"]
-        FR["useFindReplace<br/>Text search"]
-        CM["useComments<br/>Comment management"]
-    end
-
-    subgraph "Collaboration"
-        YJS["useYjsProvider<br/>WebSocket lifecycle"]
-        PT["usePresenceTracking<br/>Remote cursors"]
-        CS["useCollaborativeState<br/>CRDT shared state"]
-        CH2["useCollaborativeHistory<br/>Collab undo/redo"]
-    end
-
-    VS --> VCS
-    VS --> VUI
-    VCS --> DSS
-    VS --> EH
-    VS --> ZV
-    EH --> EO
-    ZV --> EO
-    EO --> IE
-    EO --> EM
-    EO --> PH
-    EO --> SM
-    EO --> TO
-    EO --> FR
-    EO --> CM
-```
+_See the [architecture diagrams on GitHub](https://github.com/ChristopherVR/pptx-viewer/blob/main/packages/react/README.md) for visual representations._
 
 ### Data Flow
 
-```mermaid
-sequenceDiagram
-    participant P as Parent App
-    participant V as PowerPointViewer
-    participant H as PptxHandler (core)
-    participant S as State (hooks)
-    participant C as SlideCanvas
-
-    P->>V: content={arrayBuffer}
-    V->>S: useViewerState({ content })
-    S->>H: handler.load(buffer)
-    H-->>S: PptxData { slides, theme, ... }
-    S-->>V: { slides, activeSlide, canvasSize, ... }
-    V->>C: Render active slide
-    C->>C: Map elements -> React components
-
-    Note over C: User edits element
-    C->>S: setState(updatedSlides)
-    S->>S: Push undo snapshot
-    S-->>V: Re-render with updated state
-
-    Note over V: User saves
-    V->>H: handler.save(slides)
-    H-->>P: Uint8Array via onContentChange
-```
+_See the [architecture diagrams on GitHub](https://github.com/ChristopherVR/pptx-viewer/blob/main/packages/react/README.md) for visual representations._
 
 ### Rendering Pipeline
 
@@ -423,37 +317,7 @@ Slides are rendered using **CSS positioning and transforms**, not HTML Canvas. T
 - DOM-based interaction (click, drag, resize)
 - Standard CSS effects (shadows, gradients, borders)
 
-```mermaid
-flowchart LR
-    subgraph "Data Model"
-        E["PptxElement<br/>(from core)"]
-    end
-
-    subgraph "React Components"
-        ER["ElementRenderer<br/>Type dispatch"]
-        EB["ElementBody<br/>Visual rendering"]
-        RH["ResizeHandles<br/>Selection UI"]
-    end
-
-    subgraph "CSS Output"
-        POS["position: absolute<br/>left/top/width/height"]
-        ROT["transform: rotate()"]
-        FIL["background: fill style"]
-        BOR["border: stroke style"]
-        SHD["box-shadow: effects"]
-        TXT["text styling (font, color, align)"]
-    end
-
-    E --> ER
-    ER --> EB
-    ER --> RH
-    EB --> POS
-    EB --> ROT
-    EB --> FIL
-    EB --> BOR
-    EB --> SHD
-    EB --> TXT
-```
+_See the [architecture diagrams on GitHub](https://github.com/ChristopherVR/pptx-viewer/blob/main/packages/react/README.md) for visual representations._
 
 ---
 
@@ -601,27 +465,7 @@ The right-side inspector (`InspectorPane`) displays contextual property editors:
 
 Activated by setting `mode` to `"present"`. The `ViewerPresentationLayer` takes over with:
 
-```mermaid
-flowchart TD
-    PM["usePresentationMode"] --> SN["useSlideNavigation<br/>Next/prev/goto slide"]
-    PM --> AP["useAnimationPlayback<br/>Trigger animations in sequence"]
-    PM --> PK["usePresentationKeyboard<br/>Arrow keys, Esc, N-key toggle"]
-    PM --> RT["useRehearsalTimings<br/>Practice mode with timer"]
-
-    subgraph "Rendering"
-        ST["Slide Transition<br/>(CSS + framer-motion)"]
-        AN["Animation Overlays<br/>(keyframe sequences)"]
-        AO["Annotation Overlay<br/>(pen/highlighter SVG)"]
-        PV["Presenter View<br/>(dual-screen notes + preview + timer)"]
-        TB2["Slideshow Toolbar<br/>(auto-hide on mouse idle)"]
-    end
-
-    SN --> ST
-    AP --> AN
-    PM --> AO
-    PM --> PV
-    PM --> TB2
-```
+_See the [architecture diagrams on GitHub](https://github.com/ChristopherVR/pptx-viewer/blob/main/packages/react/README.md) for visual representations._
 
 **Slide transitions** (`slide-transitions.ts`, `transition-keyframes.ts`):
 
@@ -636,25 +480,7 @@ flowchart TD
 
 The animation system (`viewer/utils/animation*.ts`, ~14 files) processes OOXML timing trees:
 
-```mermaid
-flowchart LR
-    A["PptxElementAnimation<br/>(from core)"] --> B["animation-timeline.ts<br/>Build timeline"]
-    B --> C["animation-sequencer.ts<br/>Resolve triggers:<br/>onClick, afterPrevious,<br/>withPrevious"]
-    C --> D["animation-keyframes.ts<br/>Generate CSS @keyframes"]
-    D --> E["animation-effects.ts<br/>Apply to DOM elements"]
-
-    subgraph "Effect Types"
-        F["Entrance<br/>(appear, fly in, fade, zoom)"]
-        G["Emphasis<br/>(pulse, spin, grow/shrink, color)"]
-        H["Exit<br/>(disappear, fly out, fade)"]
-        I["Motion Path<br/>(custom path with auto-rotation)"]
-    end
-
-    D --> F
-    D --> G
-    D --> H
-    D --> I
-```
+_See the [architecture diagrams on GitHub](https://github.com/ChristopherVR/pptx-viewer/blob/main/packages/react/README.md) for visual representations._
 
 Supports 40+ animation presets with configurable duration, delay, repeat, color animations, motion path auto-rotation, and text-build options (by word, by letter, by paragraph).
 
@@ -685,26 +511,7 @@ Chart chrome (axes, legends, titles, gridlines, data labels, data tables, displa
 
 The export pipeline (`viewer/utils/export*.ts`, `viewer/hooks/useExportHandlers.ts`):
 
-```mermaid
-flowchart TD
-    A["Export Request"] --> B{Format?}
-
-    B -->|PNG/JPEG| C["renderToCanvas (html2canvas)<br/>-> canvas.toDataURL()"]
-    B -->|SVG| D["DOM -> SVG serialisation<br/>(export-svg.ts)"]
-    B -->|PDF| E["jspdf + renderToCanvas<br/>-> multi-page PDF<br/>(with notes pages + overflow)"]
-    B -->|GIF| F["export-gif-encoder.ts<br/>-> animated GIF frames"]
-    B -->|Video| G["export-video.ts<br/>-> MediaRecorder API"]
-    B -->|PPTX| H["PptxHandler.save()<br/>-> Uint8Array download"]
-    B -->|Slides| I["PptxHandler.exportSlides()<br/>-> per-slide PPTX files"]
-
-    C --> J["Download / Blob URL"]
-    D --> J
-    E --> J
-    F --> J
-    G --> J
-    H --> J
-    I --> J
-```
+_See the [architecture diagrams on GitHub](https://github.com/ChristopherVR/pptx-viewer/blob/main/packages/react/README.md) for visual representations._
 
 The `renderToCanvas` wrapper (`lib/canvas-export.ts`) patches `html2canvas` to work around oklch colour space parsing issues in browsers that don't fully support it.
 
@@ -712,14 +519,7 @@ The `renderToCanvas` wrapper (`lib/canvas-export.ts`) patches `html2canvas` to w
 
 Connectors between shapes use a graph-based routing algorithm:
 
-```mermaid
-flowchart LR
-    A["Start Shape<br/>(connection point)"] --> B["connector-router.ts<br/>A* pathfinding"]
-    B --> C["connector-router-graph.ts<br/>Build obstacle grid"]
-    C --> D["connector-router-astar.ts<br/>Find shortest path"]
-    D --> E["connector-path.tsx<br/>SVG path rendering"]
-    E --> F["Arrow markers<br/>(start/end heads)"]
-```
+_See the [architecture diagrams on GitHub](https://github.com/ChristopherVR/pptx-viewer/blob/main/packages/react/README.md) for visual representations._
 
 The router avoids overlapping shapes by building an obstacle grid and using A\* pathfinding with Manhattan distance heuristics. Supports straight, elbow (bent), and curved connector types.