@harvard-lts/mirador-hide-nav-plugin 1.0.0 → 1.0.2

package/README.md

@@ -1,2 +1,42 @@
 # mirador-hide-nav-plugin
 A Mirador 3 plugin that hides viewer navigation manifest-defined single images. 
+
+## Requirements
+
+- [NVM](https://github.com/nvm-sh/nvm)
+
+## Setup
+
+1. Run `nvm use` to ensure your version of matches that in the `.nvmrc` file
+2. Run `npm i` to install dependencies
+3. Use one of the [NPM scripts](#npm-scripts) to perform the actions described below.
+
+## NPM scripts
+
+The following are some useful scripts can be ran using `npm run <script>`. A full list can be seen in [package.json](./package.json)
+
+| Script  | Description                                                                                                                |
+| ------- | -------------------------------------------------------------------------------------------------------------------------- |
+| `clean` | Removes the `dist` directories                                                                                             |
+| `build` | Builds the source files into the `./dist` directory                                                                        |
+| `serve` | Runs a local web server where the plugin can be viewed in a vanilla Mirador instance (helpful for testing and development) |
+| `test`  | Runs the automated test suites  
+
+## 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.
+
+Package you will need to install:
+
+```bash
+npm i @harvard-lts/mirador-hide-nav-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.
+
+[build-badge]: https://img.shields.io/travis/projectmirador/mirador-share-plugin/master.png?style=flat-square
+[build]: https://travis-ci.org/projectmirador/mirador-share-plugin
+
+[npm-badge]: https://img.shields.io/npm/v/mirador-share-plugin.png?style=flat-square
+[npm]: https://www.npmjs.org/package/mirador-share-plugin

package/dist/es/index.js

@@ -0,0 +1,132 @@
+import { Component } from 'react';
+import { getManifestoInstance } from 'mirador/dist/es/src/state/selectors/manifests';
+import { jsx, Fragment } from 'react/jsx-runtime';
+
+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: "viewingHint",
+    value: function viewingHint() {
+      var manifest = this.props.manifest;
+      if (!(manifest && manifest.getSequences() && manifest.getSequences()[0] && manifest.getSequences()[0].getProperty('viewingHint'))) return [''];
+      return manifest.getSequences()[0].getProperty('viewingHint');
+    }
+  }, {
+    key: "render",
+    value: function render() {
+      return /*#__PURE__*/jsx(Fragment, {});
+    }
+  }, {
+    key: "componentDidUpdate",
+    value: function componentDidUpdate() {
+      var viewingHint = this.viewingHint();
+      if (viewingHint == 'individuals') {
+        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 {
+    manifestId: (getManifestoInstance(state, {
+      windowId: windowId
+    }) || {}).id,
+    manifest: getManifestoInstance(state, {
+      windowId: windowId
+    })
+  };
+};
+var hideViewerNavigationPlugin = {
+  target: 'Window',
+  mode: 'add',
+  component: hideViewerNavigation,
+  mapStateToProps: mapStateToProps
+};
+
+var index = [hideViewerNavigationPlugin];
+
+export { index as default, hideViewerNavigationPlugin };

package/package.json

@@ -1,40 +1,53 @@
 {
   "name": "@harvard-lts/mirador-hide-nav-plugin",
-  "version": "1.0.0",
-  "description": "mirador-hide-nav-plugin React component",
-  "main": "lib/index.js",
-  "module": "es/index.js",
+  "license": "Apache-2.0",
+  "repository": "https://github.com/harvard-lts/mirador-hide-nav-plugin.git",
+  "keywords": [
+    "react-component"
+  ],
+  "version": "1.0.2",
+  "description": "mirador-analytics-plugin React component",
+  "module": "dist/es/index.js",
   "files": [
-    "css",
-    "es",
-    "lib",
-    "umd"
+    "dist"
   ],
   "scripts": {
-    "build": "nwb build-react-component",
-    "clean": "nwb clean-module && nwb clean-demo",
+    "clean": "rm -rf ./dist && rm -rf ./demo/dist",
+    "prebuild": "npm run clean",
     "prepublishOnly": "npm run build",
-    "start": "nwb serve-react-demo",
-    "test": "nwb test-react",
-    "test:coverage": "nwb test-react --coverage",
-    "test:watch": "nwb test-react --server"
-  },
-  "peerDependencies": {
-    "mirador": "^3.3.0",
-    "react": "16.x",
-    "react-dom": "16.x"
+    "build": "run-p build:es",
+    "build:es": "rollup -c",
+    "serve": "webpack serve --mode development --open",
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "test:watch": "jest --watch"
   },
-  "devDependencies": {
-    "mirador": "^3.3.0",
-    "nwb": "0.25.x",
+  "dependencies": {
+    "jquery": "^3.7.0",
+    "prop-types": "^15.8.1",
     "react": "^16.14.0",
     "react-dom": "^16.14.0"
   },
-  "author": "",
-  "homepage": "",
-  "license": "MIT",
-  "repository": "",
-  "keywords": [
-    "react-component"
-  ]
+  "devDependencies": {
+    "@babel/cli": "^7.26.4",
+    "@babel/core": "^7.26.0",
+    "@babel/preset-env": "^7.21.4",
+    "@babel/preset-react": "^7.18.6",
+    "@rollup/plugin-babel": "^6.0.3",
+    "@testing-library/jest-dom": "^5.16.5",
+    "@testing-library/react": "^12.0.0",
+    "babel-jest": "^29.7.0",
+    "babel-loader": "^9.1.2",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "mirador": "^3.4.3",
+    "npm-run-all": "^4.1.5",
+    "rollup": "^3.29.5",
+    "url": "^0.11.0",
+    "webpack": "^5.94.0",
+    "webpack-cli": "^5.1.4",
+    "webpack-dev-server": "^5.2.0",
+    "webpack-node-externals": "^3.0.0",
+    "whatwg-fetch": "^3.6.2"
+  }
 }

package/es/hideViewerNavigationPlugin.js

@@ -1,63 +0,0 @@
-function _inheritsLoose(subClass, superClass) { subClass.prototype = Object.create(superClass.prototype); subClass.prototype.constructor = subClass; _setPrototypeOf(subClass, superClass); }
-
-function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
-
-import React, { Component } from 'react';
-import { getManifestoInstance } from 'mirador/dist/es/src/state/selectors/manifests';
-
-var hideViewerNavigation = /*#__PURE__*/function (_Component) {
-  _inheritsLoose(hideViewerNavigation, _Component);
-
-  function hideViewerNavigation() {
-    return _Component.apply(this, arguments) || this;
-  }
-
-  var _proto = hideViewerNavigation.prototype;
-
-  _proto.viewingHint = function viewingHint() {
-    var manifest = this.props.manifest;
-    if (!(manifest && manifest.getSequences() && manifest.getSequences()[0] && manifest.getSequences()[0].getProperty('viewingHint'))) return [''];
-    return manifest.getSequences()[0].getProperty('viewingHint');
-  };
-
-  _proto.render = function render() {
-    return /*#__PURE__*/React.createElement(React.Fragment, null);
-  };
-
-  _proto.componentDidUpdate = function componentDidUpdate() {
-    var viewingHint = this.viewingHint();
-
-    if (viewingHint == 'individuals') {
-      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();
-      });
-    }
-  };
-
-  return hideViewerNavigation;
-}(Component);
-
-var mapStateToProps = function mapStateToProps(state, _ref) {
-  var windowId = _ref.windowId;
-  return {
-    manifestId: (getManifestoInstance(state, {
-      windowId: windowId
-    }) || {}).id,
-    manifest: getManifestoInstance(state, {
-      windowId: windowId
-    })
-  };
-};
-
-export default {
-  target: 'Window',
-  mode: 'add',
-  component: hideViewerNavigation,
-  mapStateToProps: mapStateToProps
-};

package/es/index.js

@@ -1,3 +0,0 @@
-import hideViewerNavigationPlugin from './hideViewerNavigationPlugin';
-export { hideViewerNavigationPlugin };
-export default [hideViewerNavigationPlugin];

package/lib/hideViewerNavigationPlugin.js

@@ -1,75 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports["default"] = void 0;
-
-var _react = _interopRequireWildcard(require("react"));
-
-var _manifests = require("mirador/dist/es/src/state/selectors/manifests");
-
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-function _inheritsLoose(subClass, superClass) { subClass.prototype = Object.create(superClass.prototype); subClass.prototype.constructor = subClass; _setPrototypeOf(subClass, superClass); }
-
-function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
-
-var hideViewerNavigation = /*#__PURE__*/function (_Component) {
-  _inheritsLoose(hideViewerNavigation, _Component);
-
-  function hideViewerNavigation() {
-    return _Component.apply(this, arguments) || this;
-  }
-
-  var _proto = hideViewerNavigation.prototype;
-
-  _proto.viewingHint = function viewingHint() {
-    var manifest = this.props.manifest;
-    if (!(manifest && manifest.getSequences() && manifest.getSequences()[0] && manifest.getSequences()[0].getProperty('viewingHint'))) return [''];
-    return manifest.getSequences()[0].getProperty('viewingHint');
-  };
-
-  _proto.render = function render() {
-    return /*#__PURE__*/_react["default"].createElement(_react["default"].Fragment, null);
-  };
-
-  _proto.componentDidUpdate = function componentDidUpdate() {
-    var viewingHint = this.viewingHint();
-
-    if (viewingHint == 'individuals') {
-      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();
-      });
-    }
-  };
-
-  return hideViewerNavigation;
-}(_react.Component);
-
-var mapStateToProps = function mapStateToProps(state, _ref) {
-  var windowId = _ref.windowId;
-  return {
-    manifestId: ((0, _manifests.getManifestoInstance)(state, {
-      windowId: windowId
-    }) || {}).id,
-    manifest: (0, _manifests.getManifestoInstance)(state, {
-      windowId: windowId
-    })
-  };
-};
-
-var _default = {
-  target: 'Window',
-  mode: 'add',
-  component: hideViewerNavigation,
-  mapStateToProps: mapStateToProps
-};
-exports["default"] = _default;
-module.exports = exports.default;

package/lib/index.js

@@ -1,13 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports["default"] = void 0;
-
-var _hideViewerNavigationPlugin = _interopRequireDefault(require("./hideViewerNavigationPlugin"));
-
-exports.hideViewerNavigationPlugin = _hideViewerNavigationPlugin["default"];
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
-var _default = [_hideViewerNavigationPlugin["default"]];
-exports["default"] = _default;