@harvard-lts/mirador-pdf-plugin 1.0.0-beta.1 → 2.0.1

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(
@@ -57,6 +73,7 @@ Mirador.viewer(
     ],
     miradorPdfPlugin: {
       pdfAPI: 'https://your-pdf-service.example.com/pdf/download/',
+      maxPages: 500,
     },
   },
   [...Plugin]
@@ -65,9 +82,10 @@ Mirador.viewer(
 
 ### Config options
 
-| Option   | Type   | Description                                      |
-| -------- | ------ | ------------------------------------------------ |
-| `pdfAPI` | String | Base URL of the PDF download service (required). |
+| Option     | Type   | Description                                                                                                                                              |
+| ---------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `pdfAPI`   | String | Base URL of the PDF download service (required).                                                                                                         |
+| `maxPages` | Number | Maximum pages allowed in a single request (default: 500). Keep this in sync with the service's `MAX_PAGES_PER_REQUEST` env var so client/server agree. |
 
 ### URL construction
 

package/dist/es/index.js

@@ -1,10 +1,10 @@
 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 PictureAsPdfIcon from '@mui/icons-material/PictureAsPdf';
 import { jsx, jsxs } from 'react/jsx-runtime';
-import { useState, useEffect } from 'react';
+import { useState, useEffect, useMemo } from 'react';
 import Button from '@mui/material/Button';
 import Dialog from '@mui/material/Dialog';
 import DialogActions from '@mui/material/DialogActions';
@@ -157,10 +157,10 @@ var MiradorPdfMenuItem = function MiradorPdfMenuItem(_ref3) {
     children: /*#__PURE__*/jsxs(MenuItem, {
       onClick: handleClick,
       children: [/*#__PURE__*/jsx(ListItemIcon, {
-        children: /*#__PURE__*/jsx(PictureAsPdfIcon, {})
+        children: /*#__PURE__*/jsx(PDFIcon, {})
       }), /*#__PURE__*/jsx(ListItemText, {
         primaryTypographyProps: {
-          variant: "body1"
+          variant: 'body1'
         },
         children: "Download PDF"
       })]
@@ -180,7 +180,7 @@ var miradorPdfMenuItem = {
 };
 
 var mapStateToProps = function mapStateToProps(state, _ref) {
-  var _manifest$getSequence, _state$config;
+  var _manifest$getSequence, _state$config, _state$config2;
   var windowId = _ref.windowId;
   var manifest = getManifestoInstance(state, {
     windowId: windowId
@@ -190,6 +190,7 @@ var mapStateToProps = function mapStateToProps(state, _ref) {
     manifestId: (manifest || {}).id,
     totalPages: manifest ? ((_manifest$getSequence = manifest.getSequences()[0]) === null || _manifest$getSequence === void 0 ? void 0 : _manifest$getSequence.getTotalCanvases()) || 0 : 0,
     pdfAPI: (_state$config = state.config) === null || _state$config === void 0 || (_state$config = _state$config.miradorPdfPlugin) === null || _state$config === void 0 ? void 0 : _state$config.pdfAPI,
+    maxPages: ((_state$config2 = state.config) === null || _state$config2 === void 0 || (_state$config2 = _state$config2.miradorPdfPlugin) === null || _state$config2 === void 0 ? void 0 : _state$config2.maxPages) || 500,
     containerId: state.config.id
   };
 };
@@ -209,6 +210,71 @@ var extractUrn = function extractUrn(manifestId) {
   var withoutLeadingSlash = pathname.replace(/^\//, '');
   return withoutLeadingSlash.split(':MANIFEST')[0];
 };
+
+// Pure validation of the pages input. Returns { valid, message } so it can drive
+// both the inline error text and the disabled state of the Download button
+// without setting React state during render.
+var validatePages = function validatePages(pages, totalPages, maxPages) {
+  if (pages === '') {
+    // Empty input means "all pages" — only valid if the whole document fits.
+    if (totalPages > maxPages) {
+      return {
+        valid: false,
+        message: "This document has ".concat(totalPages, " pages, which exceeds the ").concat(maxPages, "-page limit. Please enter a range of up to ").concat(maxPages, " pages.")
+      };
+    }
+    return {
+      valid: true,
+      message: ''
+    };
+  }
+  var singlePattern = /^\d+$/;
+  var rangePattern = /^(\d+)-(\d+)$/;
+  if (singlePattern.test(pages)) {
+    var num = parseInt(pages, 10);
+    if (num < 1 || num > totalPages) {
+      return {
+        valid: false,
+        message: "Page must be between 1 and ".concat(totalPages, ".")
+      };
+    }
+    return {
+      valid: true,
+      message: ''
+    };
+  }
+  var rangeMatch = pages.match(rangePattern);
+  if (rangeMatch) {
+    var start = parseInt(rangeMatch[1], 10);
+    var end = parseInt(rangeMatch[2], 10);
+    if (start < 1 || end > totalPages) {
+      return {
+        valid: false,
+        message: "Page range must be between 1 and ".concat(totalPages, ".")
+      };
+    }
+    if (start >= end) {
+      return {
+        valid: false,
+        message: 'Start page must be less than end page.'
+      };
+    }
+    if (end - start + 1 > maxPages) {
+      return {
+        valid: false,
+        message: "You can request at most ".concat(maxPages, " pages at once. Please split this into smaller requests.")
+      };
+    }
+    return {
+      valid: true,
+      message: ''
+    };
+  }
+  return {
+    valid: false,
+    message: 'Please enter a page number or range (e.g. 5 or 5-10).'
+  };
+};
 var MiradorPdfDialog = function MiradorPdfDialog(_ref3) {
   var _ref3$open = _ref3.open,
     open = _ref3$open === void 0 ? false : _ref3$open,
@@ -216,59 +282,32 @@ var MiradorPdfDialog = function MiradorPdfDialog(_ref3) {
     manifestId = _ref3.manifestId,
     totalPages = _ref3.totalPages,
     pdfAPI = _ref3.pdfAPI,
+    _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],
     setPages = _useState2[1];
-  var _useState3 = useState(''),
-    _useState4 = _slicedToArray(_useState3, 2),
-    error = _useState4[0],
-    setError = _useState4[1];
+
+  // Reset form state whenever the dialog is closed
   useEffect(function () {
     if (!open) {
       setPages('');
-      setError('');
     }
   }, [open]);
   var handleClose = function handleClose() {
     closeDialog();
     setPages('');
-    setError('');
-  };
-  var validate = function validate() {
-    if (pages === '') return true;
-    var singlePattern = /^\d+$/;
-    var rangePattern = /^(\d+)-(\d+)$/;
-    if (singlePattern.test(pages)) {
-      var num = parseInt(pages, 10);
-      if (num < 1 || num > totalPages) {
-        setError("Page must be between 1 and ".concat(totalPages, "."));
-        return false;
-      }
-      return true;
-    }
-    var rangeMatch = pages.match(rangePattern);
-    if (rangeMatch) {
-      var start = parseInt(rangeMatch[1], 10);
-      var end = parseInt(rangeMatch[2], 10);
-      if (start < 1 || end > totalPages) {
-        setError("Page range must be between 1 and ".concat(totalPages, "."));
-        return false;
-      }
-      if (start >= end) {
-        setError('Start page must be less than end page.');
-        return false;
-      }
-      return true;
-    }
-    setError('Please enter a page number or range (e.g. 5 or 5-10).');
-    return false;
   };
+
+  // Live validity drives both the disabled Download button and the helper text.
+  var validity = useMemo(function () {
+    return validatePages(pages, totalPages, maxPages);
+  }, [pages, totalPages, maxPages]);
   var handleDownload = function handleDownload() {
-    setError('');
-    if (!validate()) return;
+    if (!validity.valid) return;
     var urn = extractUrn(manifestId);
     var baseUrl = "".concat(pdfAPI.replace(/\/$/, ''), "/").concat(urn);
     var url;
@@ -295,6 +334,7 @@ var MiradorPdfDialog = function MiradorPdfDialog(_ref3) {
     fullWidth: true,
     maxWidth: "sm",
     children: [/*#__PURE__*/jsx(DialogTitle, {
+      variant: "h2",
       sx: {
         paddingBottom: 0
       },
@@ -303,7 +343,11 @@ var MiradorPdfDialog = function MiradorPdfDialog(_ref3) {
       children: [/*#__PURE__*/jsx(Typography, {
         variant: "body1",
         gutterBottom: true,
-        children: "The document contains ".concat(totalPages, " pages and has an estimated file size of ").concat((totalPages * 0.7862).toFixed(2), " MB. All pages will be included by default. If you wish to download certain portions of it, you may provide a comma separated list of pages and/or ranges.")
+        children: "The document contains ".concat(totalPages, " pages and has an estimated file size of ").concat((totalPages * 0.7862).toFixed(2), " MB. All pages will be included by default. If you wish to download certain portions of it, you may provide a single page (e.g. 5) or a range (e.g. 5-10).")
+      }), /*#__PURE__*/jsx(Typography, {
+        variant: "body2",
+        gutterBottom: true,
+        children: "You can download up to ".concat(maxPages, " pages per request. For larger documents, please request several smaller ranges (e.g. 1-").concat(maxPages, ", then ").concat(maxPages + 1, "-").concat(maxPages * 2, ").")
       }), /*#__PURE__*/jsx(TextField, {
         id: "pdf-pages-input",
         label: "Pages",
@@ -314,8 +358,8 @@ var MiradorPdfDialog = function MiradorPdfDialog(_ref3) {
         onKeyDown: function onKeyDown(e) {
           if (e.key === 'Enter') handleDownload();
         },
-        error: Boolean(error),
-        helperText: error || "Enter a page number or range (e.g. 5 or 5-10). Max: ".concat(totalPages),
+        error: !validity.valid,
+        helperText: validity.valid ? "Enter a page number or range (e.g. 5 or 5-10). Max ".concat(maxPages, " pages per request.") : validity.message,
         fullWidth: true,
         margin: "normal",
         variant: "outlined"
@@ -323,11 +367,13 @@ var MiradorPdfDialog = function MiradorPdfDialog(_ref3) {
     }), /*#__PURE__*/jsxs(DialogActions, {
       children: [/*#__PURE__*/jsx(Button, {
         onClick: handleClose,
+        color: "inherit",
         children: "Close"
       }), /*#__PURE__*/jsx(Button, {
         onClick: handleDownload,
         color: "primary",
         variant: "contained",
+        disabled: !validity.valid,
         children: "Download"
       })]
     })]

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@harvard-lts/mirador-pdf-plugin",
-  "version": "1.0.0-beta.1",
-  "description": "A Mirador 4 plugin that interacts with MPS PDF Download Service",
+  "version": "2.0.1",
+  "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,43 +27,38 @@
   "license": "Apache-2.0",
   "homepage": "https://github.com/harvard-lts/mirador-pdf-plugin#readme",
   "dependencies": {
-    "prop-types": "^15.8.1"
-  },
-  "peerDependencies": {
-    "mirador": "^4.0.0",
-    "react": "^18.0.0 || ^19.0.0",
-    "react-dom": "^18.0.0 || ^19.0.0",
+    "@emotion/react": "^11.11.0",
+    "@emotion/styled": "^11.11.0",
     "@mui/material": "^7.0.0",
     "@mui/system": "^7.0.0",
-    "@emotion/react": "^11.10.6",
-    "@emotion/styled": "^11.10.6"
+    "@mui/icons-material": "^7.0.0",
+    "jquery": "^3.7.0",
+    "prop-types": "^15.8.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": {
     "@babel/cli": "^7.26.4",
     "@babel/core": "^7.26.0",
     "@babel/preset-env": "^7.21.4",
     "@babel/preset-react": "^7.18.6",
-    "@emotion/react": "^11.10.6",
-    "@emotion/styled": "^11.10.6",
-    "@mui/material": "^7.0.0",
-    "@mui/icons-material": "^7.0.0",
-    "@mui/system": "^7.0.0",
     "@rollup/plugin-babel": "^6.0.3",
     "@testing-library/jest-dom": "^6.1.5",
     "@testing-library/react": "^16.0.0",
-    "@vitejs/plugin-react": "^5.0.0",
-    "@vitest/coverage-v8": "^1.0.0",
-    "@vitest/ui": "^1.0.0",
+    "@vitejs/plugin-react": "^5.1.2",
+    "@vitest/coverage-v8": "^4.1.11",
+    "@vitest/ui": "^4.1.11",
     "jsdom": "^23.0.0",
-    "mirador": "^4.0.0",
+    "mirador": "^4.1.0",
     "npm-run-all": "^4.1.5",
     "parcel": "^2.8.3",
-    "react": "^18.3.0",
-    "react-dom": "^18.3.0",
     "rollup": "^3.29.5",
     "url": "^0.11.4",
-    "vite": "^5.0.0",
-    "vitest": "^1.0.0",
+    "vite": "^8.0.16",
+    "vitest": "^4.1.11",
     "whatwg-fetch": "^3.6.20"
   }
 }