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

package/README.md

@@ -57,6 +57,7 @@ Mirador.viewer(
     ],
     miradorPdfPlugin: {
       pdfAPI: 'https://your-pdf-service.example.com/pdf/download/',
+      maxPages: 500,
     },
   },
   [...Plugin]
@@ -65,9 +66,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,4 +1,4 @@
-import { useState, useEffect } from 'react';
+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';
@@ -183,7 +183,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
@@ -193,6 +193,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
   };
 };
@@ -212,67 +213,102 @@ 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 open = _ref3.open,
     closeDialog = _ref3.closeDialog,
     manifestId = _ref3.manifestId,
     totalPages = _ref3.totalPages,
     pdfAPI = _ref3.pdfAPI,
+    maxPages = _ref3.maxPages,
     containerId = _ref3.containerId,
     classes = _ref3.classes;
   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;
@@ -309,7 +345,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",
@@ -320,8 +360,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"
@@ -335,6 +375,7 @@ var MiradorPdfDialog = function MiradorPdfDialog(_ref3) {
         onClick: handleDownload,
         color: "primary",
         variant: "contained",
+        disabled: !validity.valid,
         children: "Download"
       })]
     })]
@@ -342,6 +383,7 @@ var MiradorPdfDialog = function MiradorPdfDialog(_ref3) {
 };
 MiradorPdfDialog.defaultProps = {
   open: false,
+  maxPages: 500,
   containerId: null
 };
 var styles = function styles() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harvard-lts/mirador-pdf-plugin",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "A Mirador 3 plugin that interacts with MPS PDF Download Service ",
   "module": "dist/es/index.js",
   "files": [
@@ -41,17 +41,17 @@
     "@rollup/plugin-babel": "^6.0.3",
     "@testing-library/jest-dom": "^6.1.5",
     "@testing-library/react": "^12.0.0",
-    "@vitejs/plugin-react": "^4.2.1",
-    "@vitest/coverage-v8": "^1.0.0",
-    "@vitest/ui": "^1.0.0",
+    "@vitejs/plugin-react": "^4.7.0",
+    "@vitest/coverage-v8": "^4.1.8",
+    "@vitest/ui": "^4.1.8",
     "jsdom": "^23.0.0",
     "mirador": "^3.4.3",
     "npm-run-all": "^4.1.5",
     "parcel": "^2.8.3",
     "rollup": "^3.29.5",
     "url": "^0.11.4",
-    "vite": "^5.0.0",
-    "vitest": "^1.0.0",
+    "vite": "^7.3.5",
+    "vitest": "^4.1.8",
     "whatwg-fetch": "^3.6.20"
   }
 }