@harvard-lts/mirador-pdf-plugin 0.0.5 → 2.0.0

package/README.md

@@ -1,6 +1,22 @@
 # mirador-pdf-plugin
 
-A [Mirador 3](https://projectmirador.org/) plugin that adds a **Download PDF** option to the window top-bar menu. It connects to an external PDF download service and allows users to optionally specify a page number or range before downloading.
+[![Node Unit Tests](https://github.com/harvard-lts/mirador-pdf-plugin/actions/workflows/coverage-node.yml/badge.svg)](https://github.com/harvard-lts/mirador-pdf-plugin/actions/workflows/coverage-node.yml)
+
+<a href="https://github.com/harvard-lts/mirador-pdf-plugin/actions/workflows/coverage-node.yml"><img src="https://github.com/harvard-lts/mirador-pdf-plugin/raw/badges/test-coverage/coverage.svg"></a>
+
+A [Mirador 4](https://projectmirador.org/) plugin that adds a **Download PDF** option to the window top-bar menu. It connects to an external PDF download service and allows users to optionally specify a page number or range before downloading.
+
+## Compatibility
+
+This plugin is **Mirador 4-compatible** (React 18/19, MUI 7). It is **not**
+backwards compatible with Mirador 3 — the upgrade contains breaking changes
+(top-level `mirador` imports, function/hook components, MUI 7 + Emotion styling).
+
+Versioning convention:
+
+- **Mirador 4** releases are tagged `2.x`.
+- **Mirador 3** releases are tagged `0.x` or `1.x` — pin one of these if you
+  still need Mirador 3.
 
 ## Features
 
@@ -13,7 +29,7 @@ A [Mirador 3](https://projectmirador.org/) plugin that adds a **Download PDF** o
 ## Requirements
 
 - [NVM](https://github.com/nvm-sh/nvm)
-- Mirador 3
+- Mirador 4
 
 ## Setup
 
@@ -33,7 +49,7 @@ The following are some useful scripts that can be run using `npm run <script>`.
 
 ## Installing in Mirador
 
-The `mirador-pdf-plugin` requires an instance of Mirador 3. Visit the [Mirador wiki](https://github.com/ProjectMirador/mirador/wiki) to learn how to [install an existing plugin](https://github.com/ProjectMirador/mirador/wiki/Mirador-3-plugins#installing-an-existing-plugin) and for additional information about plugins.
+The `mirador-pdf-plugin` requires an instance of Mirador 4. Visit the [Mirador wiki](https://github.com/ProjectMirador/mirador/wiki) and the [Creating a Mirador 4 Plugin](https://github.com/ProjectMirador/mirador/wiki/Creating-a-Mirador-4-Plugin) page for information about installing and building plugins.
 
 Install the package:
 
@@ -46,7 +62,7 @@ npm i @harvard-lts/mirador-pdf-plugin
 Pass a `miradorPdfPlugin` object in your Mirador config block:
 
 ```js
-import Mirador from 'mirador/dist/es/src/index';
+import Mirador from 'mirador';
 import Plugin from '@harvard-lts/mirador-pdf-plugin';
 
 Mirador.viewer(

package/dist/es/index.js

@@ -1,18 +1,17 @@
-import { useState, useEffect, useMemo } from 'react';
-import MenuItem from '@material-ui/core/MenuItem';
-import ListItemIcon from '@material-ui/core/ListItemIcon';
-import ListItemText from '@material-ui/core/ListItemText';
-import { getManifestoInstance } from 'mirador/dist/es/src/state/selectors/manifests';
-import PDFIcon from '@material-ui/icons/PictureAsPdf';
+import MenuItem from '@mui/material/MenuItem';
+import ListItemIcon from '@mui/material/ListItemIcon';
+import ListItemText from '@mui/material/ListItemText';
+import PDFIcon from '@mui/icons-material/PictureAsPdf';
+import { getManifestoInstance } from 'mirador';
 import { jsx, jsxs } from 'react/jsx-runtime';
-import { withStyles } from '@material-ui/core/styles';
-import Button from '@material-ui/core/Button';
-import Dialog from '@material-ui/core/Dialog';
-import DialogActions from '@material-ui/core/DialogActions';
-import DialogContent from '@material-ui/core/DialogContent';
-import DialogTitle from '@material-ui/core/DialogTitle';
-import TextField from '@material-ui/core/TextField';
-import Typography from '@material-ui/core/Typography';
+import { useState, useEffect, useMemo } from 'react';
+import Button from '@mui/material/Button';
+import Dialog from '@mui/material/Dialog';
+import DialogActions from '@mui/material/DialogActions';
+import DialogContent from '@mui/material/DialogContent';
+import DialogTitle from '@mui/material/DialogTitle';
+import TextField from '@mui/material/TextField';
+import Typography from '@mui/material/Typography';
 
 function _arrayLikeToArray(r, a) {
   (null == a || a > r.length) && (a = r.length);
@@ -146,8 +145,10 @@ var mapDispatchToProps$1 = function mapDispatchToProps(dispatch, _ref2) {
   };
 };
 var MiradorPdfMenuItem = function MiradorPdfMenuItem(_ref3) {
-  var handleClose = _ref3.handleClose,
-    openDialog = _ref3.openDialog;
+  var _ref3$handleClose = _ref3.handleClose,
+    handleClose = _ref3$handleClose === void 0 ? function () {} : _ref3$handleClose,
+    _ref3$openDialog = _ref3.openDialog,
+    openDialog = _ref3$openDialog === void 0 ? function () {} : _ref3$openDialog;
   var handleClick = function handleClick() {
     openDialog();
     handleClose();
@@ -159,17 +160,13 @@ var MiradorPdfMenuItem = function MiradorPdfMenuItem(_ref3) {
         children: /*#__PURE__*/jsx(PDFIcon, {})
       }), /*#__PURE__*/jsx(ListItemText, {
         primaryTypographyProps: {
-          variant: "body1"
+          variant: 'body1'
         },
         children: "Download PDF"
       })]
     })
   });
 };
-MiradorPdfMenuItem.defaultProps = {
-  handleClose: function handleClose() {},
-  openDialog: function openDialog() {}
-};
 var miradorPdfMenuItem = {
   target: 'WindowTopBarPluginMenu',
   mode: 'add',
@@ -279,14 +276,16 @@ var validatePages = function validatePages(pages, totalPages, maxPages) {
   };
 };
 var MiradorPdfDialog = function MiradorPdfDialog(_ref3) {
-  var open = _ref3.open,
+  var _ref3$open = _ref3.open,
+    open = _ref3$open === void 0 ? false : _ref3$open,
     closeDialog = _ref3.closeDialog,
     manifestId = _ref3.manifestId,
     totalPages = _ref3.totalPages,
     pdfAPI = _ref3.pdfAPI,
-    maxPages = _ref3.maxPages,
-    containerId = _ref3.containerId,
-    classes = _ref3.classes;
+    _ref3$maxPages = _ref3.maxPages,
+    maxPages = _ref3$maxPages === void 0 ? 500 : _ref3$maxPages,
+    _ref3$containerId = _ref3.containerId,
+    containerId = _ref3$containerId === void 0 ? null : _ref3$containerId;
   var _useState = useState(''),
     _useState2 = _slicedToArray(_useState, 2),
     pages = _useState2[0],
@@ -335,12 +334,11 @@ var MiradorPdfDialog = function MiradorPdfDialog(_ref3) {
     fullWidth: true,
     maxWidth: "sm",
     children: [/*#__PURE__*/jsx(DialogTitle, {
-      disableTypography: true,
-      className: classes.h2,
-      children: /*#__PURE__*/jsx(Typography, {
-        variant: "h2",
-        children: "PDF Download"
-      })
+      variant: "h2",
+      sx: {
+        paddingBottom: 0
+      },
+      children: "PDF Download"
     }), /*#__PURE__*/jsxs(DialogContent, {
       children: [/*#__PURE__*/jsx(Typography, {
         variant: "body1",
@@ -369,7 +367,7 @@ var MiradorPdfDialog = function MiradorPdfDialog(_ref3) {
     }), /*#__PURE__*/jsxs(DialogActions, {
       children: [/*#__PURE__*/jsx(Button, {
         onClick: handleClose,
-        color: "default",
+        color: "inherit",
         children: "Close"
       }), /*#__PURE__*/jsx(Button, {
         onClick: handleDownload,
@@ -381,23 +379,11 @@ var MiradorPdfDialog = function MiradorPdfDialog(_ref3) {
     })]
   });
 };
-MiradorPdfDialog.defaultProps = {
-  open: false,
-  maxPages: 500,
-  containerId: null
-};
-var styles = function styles() {
-  return {
-    h2: {
-      paddingBottom: 0
-    }
-  };
-};
 var miradorPdfDialog = {
   target: 'Window',
   mode: 'add',
   name: 'MiradorPdfDialog',
-  component: withStyles(styles)(MiradorPdfDialog),
+  component: MiradorPdfDialog,
   mapStateToProps: mapStateToProps,
   mapDispatchToProps: mapDispatchToProps
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@harvard-lts/mirador-pdf-plugin",
-  "version": "0.0.5",
-  "description": "A Mirador 3 plugin that interacts with MPS PDF Download Service ",
+  "version": "2.0.0",
+  "description": "A Mirador 4 plugin that interacts with MPS PDF Download Service ",
   "module": "dist/es/index.js",
   "files": [
     "dist"
@@ -15,7 +15,8 @@
     "serve": "vite",
     "test": "vitest run",
     "test:coverage": "vitest run --coverage",
-    "test:watch": "vitest"
+    "test:watch": "vitest",
+    "test:unit": "node scripts/coverage-ci.mjs"
   },
   "repository": {
     "type": "git",
@@ -26,11 +27,17 @@
   "license": "Apache-2.0",
   "homepage": "https://github.com/harvard-lts/mirador-pdf-plugin#readme",
   "dependencies": {
+    "@emotion/react": "^11.11.0",
+    "@emotion/styled": "^11.11.0",
+    "@mui/material": "^7.0.0",
+    "@mui/system": "^7.0.0",
+    "@mui/icons-material": "^7.0.0",
     "jquery": "^3.7.0",
     "prop-types": "^15.8.1",
-    "react": "^16.14.0",
-    "react-dom": "^16.14.0",
-    "redux": "^4.2.1",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "react-i18next": "^15.0.0",
+    "redux": "^5.0.0",
     "redux-saga": "^1.2.3"
   },
   "devDependencies": {
@@ -40,17 +47,17 @@
     "@babel/preset-react": "^7.18.6",
     "@rollup/plugin-babel": "^6.0.3",
     "@testing-library/jest-dom": "^6.1.5",
-    "@testing-library/react": "^12.0.0",
-    "@vitejs/plugin-react": "^4.7.0",
+    "@testing-library/react": "^16.0.0",
+    "@vitejs/plugin-react": "^5.1.2",
     "@vitest/coverage-v8": "^4.1.8",
     "@vitest/ui": "^4.1.8",
     "jsdom": "^23.0.0",
-    "mirador": "^3.4.3",
+    "mirador": "^4.1.0",
     "npm-run-all": "^4.1.5",
     "parcel": "^2.8.3",
     "rollup": "^3.29.5",
     "url": "^0.11.4",
-    "vite": "^7.3.5",
+    "vite": "^8.0.16",
     "vitest": "^4.1.8",
     "whatwg-fetch": "^3.6.20"
   }