mirador-dl-plugin 0.12.0 → 0.14.0

package/README.md

@@ -1,20 +1,29 @@
-# mirador-download-plugin
+# mirador-dl-plugin
 
 [![Travis][build-badge]][build]
 [![npm package][npm-badge]][npm]
 [![Coveralls][coveralls-badge]][coveralls]
 
-Describe mirador-download-plugin here.
+`mirador-dl-plugin` is a Mirador 3 plugin that adds manifest-provided download links (e.g. `rendering`) to the window options menu. A [live demo](https://mirador-download-plugin.netlify.app/) with several institutions' manifests is available for testing.
 
-[build-badge]: https://img.shields.io/travis/user/repo/master.png?style=flat-square
-[build]: https://travis-ci.org/user/repo
+![download option in menu](https://user-images.githubusercontent.com/5402927/87057974-5e665a80-c1bc-11ea-8f10-7b783bdc972f.png)
 
-[npm-badge]: https://img.shields.io/npm/v/npm-package.png?style=flat-square
-[npm]: https://www.npmjs.org/package/npm-package
+![mirador-download-options](https://user-images.githubusercontent.com/5402927/87057857-3d056e80-c1bc-11ea-8860-7662208c19fa.png)
+
+
+[build-badge]: https://img.shields.io/travis/projectmirador/mirador-dl-plugin/master.png?style=flat-square
+[build]: https://travis-ci.org/projectmirador/mirador-dl-plugin
+
+[npm-badge]: https://img.shields.io/npm/v/mirador-dl-plugin.png?style=flat-square
+[npm]: https://www.npmjs.org/package/mirador-dl-plugin
 
 [coveralls-badge]: https://img.shields.io/coveralls/user/repo/master.png?style=flat-square
 [coveralls]: https://coveralls.io/github/user/repo
 
+## Installation
+
+`mirador-dl-plugin` requires an instance of Mirador 3. See the [Mirador wiki](https://github.com/ProjectMirador/mirador/wiki) for examples of embedding Mirador within an application and additional information about plugins. See the [live demo's index.js](https://github.com/ProjectMirador/mirador-dl-plugin/blob/master/demo/src/index.js) for an example of importing and configuring `mirador-dl-plugin`.
+
 ## Configuration
 
 Configurations for this plugin are injected when Mirador is initialized under the `miradorDownloadPlugin` key.
@@ -31,3 +40,6 @@ Configurations for this plugin are injected when Mirador is initialized under th
 | Config Key | Type | Description |
 | --- | --- | --- |
 | `restrictDownloadOnSizeDefinition` | boolean (default: false) | If set to true the `Zoomed region` link will not be rendered if the image API returns a single size in the `sizes` section and the single size height/width is the same size or smaller than the reported height/width. |
+
+## Contribute
+Mirador's development, design, and maintenance is driven by community needs and ongoing feedback and discussion. Join us at our regularly scheduled community calls, on [IIIF slack #mirador](http://bit.ly/iiif-slack), or the [mirador-tech](https://groups.google.com/forum/#!forum/mirador-tech) and [iiif-discuss](https://groups.google.com/forum/#!forum/iiif-discuss) mailing lists. To suggest features, report bugs, and clarify usage, please submit a GitHub issue.

package/es/RenderingDownloadLink.js

@@ -35,9 +35,7 @@ var RenderingDownloadLink = function (_Component) {
         React.createElement(
           Link,
           { href: rendering.id, rel: 'noopener noreferrer', target: '_blank', variant: 'body1' },
-          rendering.getLabel().map(function (label) {
-            return label.value;
-          })[0]
+          rendering.getLabel().getValue()
         ),
         rendering.getFormat() && rendering.getFormat().value && ' (' + rendering.getFormat().value + ')'
       )

package/es/index.js

@@ -1,7 +1,6 @@
 import miradorDownloadPlugin from './miradorDownloadPlugin';
 import MiradorDownloadDialogPlugin from './MiradorDownloadDialog';
 
-export default {
-  miradorDownloadPlugin: miradorDownloadPlugin,
-  MiradorDownloadDialogPlugin: MiradorDownloadDialogPlugin
-};
+export { miradorDownloadPlugin, MiradorDownloadDialogPlugin };
+
+export default [miradorDownloadPlugin, MiradorDownloadDialogPlugin];

package/lib/RenderingDownloadLink.js

@@ -55,9 +55,7 @@ var RenderingDownloadLink = function (_Component) {
         _react2.default.createElement(
           _Link2.default,
           { href: rendering.id, rel: 'noopener noreferrer', target: '_blank', variant: 'body1' },
-          rendering.getLabel().map(function (label) {
-            return label.value;
-          })[0]
+          rendering.getLabel().getValue()
         ),
         rendering.getFormat() && rendering.getFormat().value && ' (' + rendering.getFormat().value + ')'
       )

package/lib/index.js

@@ -1,6 +1,7 @@
 'use strict';
 
 exports.__esModule = true;
+exports.MiradorDownloadDialogPlugin = exports.miradorDownloadPlugin = undefined;
 
 var _miradorDownloadPlugin = require('./miradorDownloadPlugin');
 
@@ -12,8 +13,6 @@ var _MiradorDownloadDialog2 = _interopRequireDefault(_MiradorDownloadDialog);
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-exports.default = {
-  miradorDownloadPlugin: _miradorDownloadPlugin2.default,
-  MiradorDownloadDialogPlugin: _MiradorDownloadDialog2.default
-};
-module.exports = exports['default'];
+exports.miradorDownloadPlugin = _miradorDownloadPlugin2.default;
+exports.MiradorDownloadDialogPlugin = _MiradorDownloadDialog2.default;
+exports.default = [_miradorDownloadPlugin2.default, _MiradorDownloadDialog2.default];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mirador-dl-plugin",
-  "version": "0.12.0",
+  "version": "0.14.0",
   "description": "mirador-dl-plugin React component",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -11,47 +11,42 @@
     "umd"
   ],
   "scripts": {
-    "build": "nwb build-react-component",
-    "clean": "nwb clean-module && nwb clean-demo",
-    "lint": "npx eslint ./",
+    "clean": "rm -rf ./dist && rm -rf ./demo/dist",
+    "prebuild": "npm run clean",
     "prepublishOnly": "npm run build",
-    "start": "nwb serve-react-demo",
-    "test": "npm run lint && jest",
-    "test:coverage": "jest --coverage",
-    "test:watch": "jest --watch"
-  },
-  "peerDependencies": {
-    "@material-ui/core": "^4.9.11",
-    "@material-ui/icons": "^4.9.1",
-    "lodash": "^4.17.11",
-    "mirador": "^3.0.0-rc.1",
-    "prop-types": "^15.7.2",
-    "react": "16.x",
-    "react-dom": "16.x"
+    "build": "run-p build:es",
+    "build:es": "rollup -c",
+    "serve": "vite",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest"
   },
   "devDependencies": {
-    "@babel/core": "^7.7.2",
-    "@babel/preset-env": "^7.7.1",
-    "@babel/preset-react": "^7.7.0",
-    "@material-ui/core": "^4.9.11",
+    "@babel/cli": "^7.26.4",
+    "@babel/core": "^7.26.0",
+    "@babel/preset-env": "^7.21.4",
+    "@babel/preset-react": "^7.18.6",
+    "@material-ui/core": "^4.11.0",
     "@material-ui/icons": "^4.9.1",
-    "babel-eslint": "^10.0.3",
-    "babel-jest": "^24.9.0",
+    "@rollup/plugin-babel": "^6.0.3",
+    "@testing-library/jest-dom": "^6.1.5",
+    "@testing-library/react": "^12.0.0",
+    "@testing-library/user-event": "^14.6.1",
+    "@vitejs/plugin-react": "^5.1.2",
+    "@vitest/coverage-v8": "^4.0.17",
+    "@vitest/ui": "^4.0.17",
     "enzyme": "^3.9.0",
     "enzyme-adapter-react-16": "^1.15.1",
-    "eslint": "^5.3.0",
-    "eslint-config-airbnb": "^17.1.1",
-    "eslint-plugin-import": "^2.18.2",
-    "eslint-plugin-jest": "^22.21.0",
-    "eslint-plugin-jsx-a11y": "^6.2.3",
-    "eslint-plugin-react": "^7.16.0",
-    "jest": "^24.9.0",
+    "jsdom": "^27.4.0",
     "lodash": "^4.17.15",
-    "mirador": "^3.0.0-rc.1",
-    "nwb": "0.23.x",
-    "prop-types": "^15.7.2",
-    "react": "^16.12.0",
-    "react-dom": "^16.12.0"
+    "mirador": "^3.4.3",
+    "npm-run-all": "^4.1.5",
+    "parcel": "^2.8.3",
+    "rollup": "^3.29.5",
+    "url": "^0.11.4",
+    "vite": "^7.3.1",
+    "vitest": "^4.0.17",
+    "whatwg-fetch": "^3.6.20"
   },
   "author": "",
   "homepage": "",
@@ -59,5 +54,16 @@
   "repository": "",
   "keywords": [
     "react-component"
-  ]
+  ],
+  "dependencies": {
+    "@material-ui/core": "^4.11.0",
+    "@material-ui/icons": "^4.9.1",
+    "jquery": "^3.7.0",
+    "lodash": "^4.17.11",
+    "prop-types": "^15.8.1",
+    "react": "^16.14.0",
+    "react-dom": "^16.14.0",
+    "redux": "^4.2.1",
+    "redux-saga": "^1.2.3"
+  }
 }