@harvard-lts/mirador-template-plugin 0.1.24 → 2.0.0

package/README.md

@@ -1,7 +1,20 @@
 # mirador-template-plugin
 
+[![Node Unit Tests](https://github.com/harvard-lts/mirador-template-plugin/actions/workflows/coverage-node.yml/badge.svg)](https://github.com/harvard-lts/mirador-template-plugin/actions/workflows/coverage-node.yml)
+
+<a href="https://github.com/harvard-lts/mirador-template-plugin/actions/workflows/coverage-node.yml"><img src="https://github.com/harvard-lts/mirador-template-plugin/raw/badges/test-coverage/coverage.svg"></a>
+
 Template for Harvard mps-viewer Mirador plugins.
 
+## Compatibility
+
+This plugin is compatible with **Mirador 4** (React 18/19, MUI 7). It is **not**
+backwards compatible with Mirador 3, and upgrading from an older version
+contains breaking changes — internal `mirador/dist/...` imports now resolve from
+the top-level `mirador` package, components use React function/hook patterns, and
+the build/styling stack moved to MUI 7 + Emotion. Mirador 4 versions are tagged
+`2.x`; if you still need Mirador 3 support, pin a `0.x` or `1.x` release.
+
 ## Requirements
 
 - [NVM](https://github.com/nvm-sh/nvm)
@@ -24,13 +37,13 @@ The following are some useful scripts can be ran using `npm run <script>`. A ful
 
 ## Installing in Mirador
 
-The `mirador-template-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-template-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:
 
 ```bash
 npm i @harvard-lts/mirador-template-plugin
-
+```
 
 ## 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/dist/es/index.js

@@ -1,76 +1,5 @@
-import { Component } from 'react';
-import { getManifestoInstance } from 'mirador/dist/es/src/state/selectors/manifests';
-
-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 + "";
-}
+import { useEffect } from 'react';
+import { getManifestoInstance } from 'mirador';
 
 var mapStateToProps = function mapStateToProps(state, _ref) {
   var windowId = _ref.windowId;
@@ -83,28 +12,17 @@ var mapStateToProps = function mapStateToProps(state, _ref) {
     })
   };
 };
-var miradorTemplate = /*#__PURE__*/function (_Component) {
-  function miradorTemplate() {
-    _classCallCheck(this, miradorTemplate);
-    return _callSuper(this, miradorTemplate, arguments);
-  }
-  _inherits(miradorTemplate, _Component);
-  return _createClass(miradorTemplate, [{
-    key: "render",
-    value: function render() {
-      return "";
-    }
-  }, {
-    key: "componentDidMount",
-    value: function componentDidMount() {
-      // Add custom stuff here
-    }
-  }]);
-}(Component);
+function MiradorTemplate() {
+  useEffect(function () {
+    // Add custom stuff here
+  }, []);
+  return null;
+}
 var miradorTemplatePlugin = {
+  name: 'MiradorTemplatePlugin',
   target: 'Window',
   mode: 'add',
-  component: miradorTemplate,
+  component: MiradorTemplate,
   mapStateToProps: mapStateToProps
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harvard-lts/mirador-template-plugin",
-  "version": "0.1.24",
+  "version": "2.0.0",
   "description": "Template for Harvard mps-viewer Mirador plugins",
   "module": "dist/es/index.js",
   "files": [
@@ -14,6 +14,7 @@
     "build:es": "rollup -c",
     "serve": "vite",
     "test": "vitest run",
+    "test:unit": "node scripts/coverage-ci.mjs",
     "test:coverage": "vitest run --coverage",
     "test:watch": "vitest"
   },
@@ -26,12 +27,16 @@
   "license": "Apache-2.0",
   "homepage": "https://github.com/harvard-lts/mirador-template-plugin#readme",
   "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",
-    "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": {
@@ -41,12 +46,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": "^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",