@harvard-lts/mirador-hide-nav-plugin 1.0.11 → 2.0.0

package/README.md

@@ -1,5 +1,19 @@
 # mirador-hide-nav-plugin
-A Mirador 3 plugin that hides viewer navigation manifest-defined single images. 
+
+[![Node Unit Tests](https://github.com/harvard-lts/mirador-hide-nav-plugin/actions/workflows/coverage-node.yml/badge.svg)](https://github.com/harvard-lts/mirador-hide-nav-plugin/actions/workflows/coverage-node.yml)
+
+<a href="https://github.com/harvard-lts/mirador-hide-nav-plugin/actions/workflows/coverage-node.yml"><img src="https://github.com/harvard-lts/mirador-hide-nav-plugin/raw/badges/test-coverage/coverage.svg"></a>
+
+A Mirador 4 plugin that hides viewer navigation for manifest-defined single images.
+
+## Compatibility
+
+This plugin is compatible with **Mirador 4** (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).
+
+Versioning convention: Mirador 4 releases are tagged `2.x`; Mirador 3 releases
+are tagged `0.x` or `1.x`. Pin a `0.x`/`1.x` release if you still need Mirador 3.
 
 ## Requirements
 
@@ -24,7 +38,7 @@ The following are some useful scripts can be ran using `npm run <script>`. A ful
 
 ## Installing in Mirador
 
-The `mirador-hide-nav-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-hide-nav-plugin` requires an instance of Mirador 4. Visit the [Mirador wiki](https://github.com/ProjectMirador/mirador/wiki) to learn how to [create a Mirador 4 plugin](https://github.com/ProjectMirador/mirador/wiki/Creating-a-Mirador-4-Plugin) and for additional information about plugins.
 
 Package you will need to install:
 

package/dist/es/index.js

@@ -1,121 +1,35 @@
-import { Component } from 'react';
-import { getManifestoInstance } from 'mirador/dist/es/src/state/selectors/manifests';
+import { useEffect } from 'react';
+import { getManifestoInstance } from 'mirador';
 
-function _assertThisInitialized(e) {
-  if (void 0 === e) throw new ReferenceError("this hasn't been initialised - super() hasn't been called");
-  return e;
-}
-function _callSuper(t, o, e) {
-  return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e));
-}
-function _classCallCheck(a, n) {
-  if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function");
-}
-function _defineProperties(e, r) {
-  for (var t = 0; t < r.length; t++) {
-    var o = r[t];
-    o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o);
-  }
-}
-function _createClass(e, r, t) {
-  return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", {
-    writable: !1
-  }), e;
-}
-function _getPrototypeOf(t) {
-  return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) {
-    return t.__proto__ || Object.getPrototypeOf(t);
-  }, _getPrototypeOf(t);
-}
-function _inherits(t, e) {
-  if ("function" != typeof e && null !== e) throw new TypeError("Super expression must either be null or a function");
-  t.prototype = Object.create(e && e.prototype, {
-    constructor: {
-      value: t,
-      writable: !0,
-      configurable: !0
-    }
-  }), Object.defineProperty(t, "prototype", {
-    writable: !1
-  }), e && _setPrototypeOf(t, e);
-}
-function _isNativeReflectConstruct() {
-  try {
-    var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {}));
-  } catch (t) {}
-  return (_isNativeReflectConstruct = function () {
-    return !!t;
-  })();
-}
-function _possibleConstructorReturn(t, e) {
-  if (e && ("object" == typeof e || "function" == typeof e)) return e;
-  if (void 0 !== e) throw new TypeError("Derived constructors may only return object or undefined");
-  return _assertThisInitialized(t);
-}
-function _setPrototypeOf(t, e) {
-  return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) {
-    return t.__proto__ = e, t;
-  }, _setPrototypeOf(t, e);
-}
-function _toPrimitive(t, r) {
-  if ("object" != typeof t || !t) return t;
-  var e = t[Symbol.toPrimitive];
-  if (void 0 !== e) {
-    var i = e.call(t, r || "default");
-    if ("object" != typeof i) return i;
-    throw new TypeError("@@toPrimitive must return a primitive value.");
-  }
-  return ("string" === r ? String : Number)(t);
-}
-function _toPropertyKey(t) {
-  var i = _toPrimitive(t, "string");
-  return "symbol" == typeof i ? i : i + "";
-}
-
-var hideViewerNavigation = /*#__PURE__*/function (_Component) {
-  function hideViewerNavigation() {
-    _classCallCheck(this, hideViewerNavigation);
-    return _callSuper(this, hideViewerNavigation, arguments);
-  }
-  _inherits(hideViewerNavigation, _Component);
-  return _createClass(hideViewerNavigation, [{
-    key: "isIndividualImage",
-    value: function isIndividualImage() {
-      var manifest = this.props.manifest;
-      var individualValue = 'individuals';
+var isIndividualImage = function isIndividualImage(manifest) {
+  var individualValue = 'individuals';
 
-      // IIIF v2
-      if (manifest && manifest.getSequences() && manifest.getSequences()[0] && manifest.getSequences()[0].getProperty('viewingHint')) return manifest.getSequences()[0].getProperty('viewingHint') == individualValue;
+  // IIIF v2
+  if (manifest && manifest.getSequences() && manifest.getSequences()[0] && manifest.getSequences()[0].getProperty('viewingHint')) return manifest.getSequences()[0].getProperty('viewingHint') == individualValue;
 
-      // IIIF v3
-      if (manifest && manifest.getBehavior()) return manifest.getBehavior() == individualValue;
-      return false;
-    }
-  }, {
-    key: "render",
-    value: function render() {
-      return "";
-    }
-  }, {
-    key: "componentDidUpdate",
-    value: function componentDidUpdate() {
-      var isIndividualImage = this.isIndividualImage();
-      if (isIndividualImage) {
-        window.document.querySelectorAll('.mirador-osd-info').forEach(function (elem) {
-          return elem.remove();
-        });
-        window.document.querySelectorAll('.mirador-osd-navigation').forEach(function (elem) {
-          return elem.remove();
-        });
-        window.document.querySelectorAll('[class*="Connect(WithPlugins(ZoomControls))-divider-"]').forEach(function (elem) {
-          return elem.remove();
-        });
-      }
+  // IIIF v3
+  if (manifest && manifest.getBehavior()) return manifest.getBehavior() == individualValue;
+  return false;
+};
+function HideViewerNavigation(_ref) {
+  var manifest = _ref.manifest;
+  useEffect(function () {
+    if (isIndividualImage(manifest)) {
+      window.document.querySelectorAll('.mirador-osd-info').forEach(function (elem) {
+        return elem.remove();
+      });
+      window.document.querySelectorAll('.mirador-osd-navigation').forEach(function (elem) {
+        return elem.remove();
+      });
+      window.document.querySelectorAll('[class*="Connect(WithPlugins(ZoomControls))-divider-"]').forEach(function (elem) {
+        return elem.remove();
+      });
     }
-  }]);
-}(Component);
-var mapStateToProps = function mapStateToProps(state, _ref) {
-  var windowId = _ref.windowId;
+  });
+  return null;
+}
+var mapStateToProps = function mapStateToProps(state, _ref2) {
+  var windowId = _ref2.windowId;
   return {
     manifestId: (getManifestoInstance(state, {
       windowId: windowId
@@ -126,9 +40,10 @@ var mapStateToProps = function mapStateToProps(state, _ref) {
   };
 };
 var hideViewerNavigationPlugin = {
+  name: 'HideViewerNavigationPlugin',
   target: 'Window',
   mode: 'add',
-  component: hideViewerNavigation,
+  component: HideViewerNavigation,
   mapStateToProps: mapStateToProps
 };
 

package/package.json

@@ -5,7 +5,7 @@
   "keywords": [
     "react-component"
   ],
-  "version": "1.0.11",
+  "version": "2.0.0",
   "description": "mirador-analytics-plugin React component",
   "module": "dist/es/index.js",
   "files": [
@@ -20,14 +20,20 @@
     "serve": "vite",
     "test": "vitest run",
     "test:coverage": "vitest run --coverage",
+    "test:unit": "node scripts/coverage-ci.mjs",
     "test:watch": "vitest"
   },
   "dependencies": {
+    "@emotion/react": "^11.11.0",
+    "@emotion/styled": "^11.11.0",
+    "@mui/material": "^7.0.0",
+    "@mui/system": "^7.0.0",
     "jquery": "^3.7.0",
-    "node": "^22.22.3",
     "prop-types": "^15.8.1",
-    "react": "^16.14.0",
-    "react-dom": "^16.14.0"
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "react-i18next": "^15.0.0",
+    "redux": "^5.0.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.26.4",
@@ -36,12 +42,12 @@
     "@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",
+    "@testing-library/react": "^16.0.0",
     "@vitejs/plugin-react": "^5.1.2",
     "@vitest/coverage-v8": "^4.0.17",
     "@vitest/ui": "^4.0.17",
     "jsdom": "^27.4.0",
-    "mirador": "^3.4.3",
+    "mirador": "^4.1.0",
     "npm-run-all": "^4.1.5",
     "rollup": "^3.29.5",
     "url": "^0.11.4",