@harvard-lts/mirador-template-plugin 0.1.9 → 0.1.10

package/dist/es/index.js

@@ -0,0 +1,114 @@
+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 mapStateToProps = function mapStateToProps(state, _ref) {
+  var windowId = _ref.windowId;
+  return {
+    manifestId: (getManifestoInstance(state, {
+      windowId: windowId
+    }) || {}).id,
+    manifest: getManifestoInstance(state, {
+      windowId: windowId
+    })
+  };
+};
+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 /*#__PURE__*/jsx(Fragment, {});
+    }
+  }, {
+    key: "componentDidMount",
+    value: function componentDidMount() {
+      // Add custom stuff here
+    }
+  }]);
+}(Component);
+var miradorTemplatePlugin = {
+  target: 'Window',
+  mode: 'add',
+  component: miradorTemplate,
+  mapStateToProps: mapStateToProps
+};
+
+var index = [miradorTemplatePlugin];
+
+export { index as default, miradorTemplatePlugin };

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@harvard-lts/mirador-template-plugin",
-  "version": "0.1.9",
+  "version": "0.1.10",
   "description": "Template for Harvard mps-viewer Mirador plugins",
-  "main": "dist/index.js",
-  "source": "src/index.js",
-  "module": "es/index.js",
+  "module": "dist/es/index.js",
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "clean": "rm -rf ./dist && rm -rf ./demo/dist",
     "prebuild": "npm run clean",

package/.github/pull_request_template.md

@@ -1,31 +0,0 @@
-**The title of this pull-request should be a brief description of what the pull-request fixes/improves/changes. Ideally 50 characters or less.**
-
----
-
-**JIRA Ticket**: (link)
-
-- Other Relevant Links (Mailing list discussion, related pull requests, etc.)
-
-# What does this Pull Request do?
-
-A brief description of what the intended result of the PR will be and/or what problem it solves.
-
-# How should this be tested?
-
-A description of what steps someone could take to:
-
-- Reproduce the problem you are fixing (if applicable)
-- Test that the Pull Request does what is intended.
-- Please be as detailed as possible.
-- Good testing instructions help get your PR completed faster.
-
-# Test coverage
-
-Yes/No: Are changes in this pull-request covered by:
-
-- unit tests?
-- integration tests?
-
-# Interested parties
-
-Tag (@ mention) interested parties

package/.github/workflows/publish-package.yml

@@ -1,34 +0,0 @@
-name: Publish to npmjs on release
-on:
-  release:
-    types: [published]
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Compare the tag and version
-        run: |
-          NODE_VERSION=$(node -p -e "require('./package.json').version")
-          LATEST_TAG=$(git describe --tags --abbrev=0)
-          if [ "v$NODE_VERSION" != $LATEST_TAG ]; then echo "Github tag ($LATEST_TAG) and version ($NODE_VERSION) don't match" && exit 1; fi
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 18
-          registry-url: "https://registry.npmjs.org"
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Publish to npm
-        run: npm publish --access=public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.LTS_NPM_TOKEN }}

package/.nvmrc

@@ -1 +0,0 @@
-lts/hydrogen

package/.parcelrc

@@ -1,9 +0,0 @@
-{
-  "extends": "@parcel/config-default",
-  "transformers": {
-    "*.{js,mjs,jsx,cjs,ts,tsx}": [
-      "@parcel/transformer-js",
-      "@parcel/transformer-react-refresh-wrap"
-    ]
-  }
-}

package/.travis.yml

@@ -1,16 +0,0 @@
-sudo: false
-
-language: node_js
-node_js:
-  - 18
-
-before_install:
-  - npm install codecov.io coveralls
-
-after_success:
-  - cat ./coverage/lcov.info | ./node_modules/codecov.io/bin/codecov.io.js
-  - cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
-
-branches:
-  only:
-

package/CONTRIBUTING.md

@@ -1,20 +0,0 @@
-## Prerequisites
-
-Check the `.nvmrc` file for the requisite node version
-
-## Installation
-
-- Running `npm install` in the component's root directory will install everything you need for development.
-
-## Running Tests
-
-- `npm test` will run the tests once.
-
-- `npm run test:coverage` will run the tests and produce a coverage report in `coverage/`.
-
-- `npm run test:watch` will run the tests on every change.
-
-## Building
-
-- `npm run build` will build the component for publishing to npm and also bundle the demo app.
-

package/babel.config.json

@@ -1,11 +0,0 @@
-{
-  "presets": [
-    [
-      "@babel/preset-env",
-      {
-        "modules": "auto"
-      }
-    ],
-    ["@babel/preset-react", { "runtime": "automatic" }]
-  ]
-}

package/demo/demoEntry.js

@@ -1,17 +0,0 @@
-import Mirador from "mirador/dist/es/src/index";
-import Plugin from "../src/index";
-
-document.addEventListener("DOMContentLoaded", () => {
-  const config = {
-    id: "mirador",
-    windows: [
-      {
-        manifestId: "https://nrs.lib.harvard.edu/URN-3:HUAM:925863:MANIFEST:3"
-      }
-    ]
-  };
-
-  const plugins = [...Plugin];
-
-  Mirador.viewer(config, plugins);
-});

package/demo/index.html

@@ -1,23 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Test</title>
-    <style>
-      body {
-        margin: 0;
-        padding: 0;
-      }
-      #mirador {
-        height: 100vh;
-        width: 100vw;
-      }
-    </style>
-    <script src="demo.js"></script>
-  </head>
-  <body>
-    <div id="mirador"></div>
-    </script>
-  </body>
-</html>

package/jest.config.js

@@ -1,20 +0,0 @@
-/** @type {import('jest').Config} */
-module.exports = {
-  testEnvironment: "jsdom",
-  transformIgnorePatterns: ["node_modules/(?!mirador)/", "node_modules/pdiiif"],
-  setupFilesAfterEnv: ["@testing-library/jest-dom", "./setupTests"],
-  //   collectCoverage: true,
-  //   coverageDirectory: "coverage",
-  //   verbose: true,
-  //   testRegex: "(/tests/.*|\\.(test|spec))\\.jsx?$",
-  //   moduleFileExtensions: ["js", "json", "jsx", "node"],
-  //   coverageThreshold: {
-  //     global: {
-  //       branches: 30,
-  //       functions: 90,
-  //       lines: 90,
-  //       statements: 90,
-  //     },
-  //   },
-  //   //   setupFiles: ["./setupTests"],
-};

package/nwb.config.js

@@ -1,20 +0,0 @@
-const path = require('path');
-
-module.exports = {
-  type: 'react-component',
-  npm: {
-    esModules: true,
-    umd: {
-      global: 'miradorTemplate',
-      externals: {
-        react: 'React'
-      }
-    }
-  },
-  webpack: {
-    aliases: {
-      react: path.resolve('./', 'node_modules', 'react'),
-      'react-dom': path.resolve('./', 'node_modules', 'react-dom'),
-    },
-  },
-}

package/rollup.config.mjs

@@ -1,12 +0,0 @@
-import { babel } from "@rollup/plugin-babel";
-
-const config = {
-  input: "src/index.js",
-  output: {
-    dir: "dist/es",
-    format: "es",
-  },
-  plugins: [babel({ babelHelpers: "bundled" })],
-};
-
-export default config;

package/setupTests.js

@@ -1 +0,0 @@
-import "whatwg-fetch";

package/src/index.js

@@ -1,9 +0,0 @@
-import miradorTemplatePlugin from './plugins/MiradorTemplatePlugin';
-
-export {
-  miradorTemplatePlugin,
-};
-
-export default [
-  miradorTemplatePlugin,
-];

package/src/plugins/MiradorTemplatePlugin.js

@@ -1,27 +0,0 @@
-import React, { Component } from 'react';
-import { getManifestoInstance } from 'mirador/dist/es/src/state/selectors/manifests';
-
-const mapStateToProps = (state, { windowId }) => ({
-  manifestId: (getManifestoInstance(state, { windowId }) || {}).id,
-  manifest: getManifestoInstance(state, { windowId }),
-});
-
-class miradorTemplate extends Component {
-  render() {
-
-    return (
-      <></>
-    );
-  }
-
-  componentDidMount() {
-    // Add custom stuff here
-  }
-}
-
-export default {
-  target: 'Window',
-  mode: 'add',
-  component: miradorTemplate,
-  mapStateToProps,
-}

package/webpack.config.cjs

@@ -1,52 +0,0 @@
-const path = require("path");
-const webpack = require("webpack");
-
-module.exports = (env, options) => {
-  return {
-    mode: options.mode,
-    entry: "./demo/demoEntry.js",
-    output: {
-      path: path.resolve(__dirname, "demo", "dist"),
-      filename: "demo.js",
-      publicPath: "/",
-    },
-    resolve: {
-      extensions: [".js", ".jsx"],
-    },
-    plugins: [
-      new webpack.IgnorePlugin({
-        resourceRegExp: /@blueprintjs\/(core|icons)/, // ignore optional UI framework dependencies
-      }),
-    ],
-    module: {
-      rules: [
-        {
-          test: /\.(js|jsx)$/,
-          exclude: /node_modules/,
-          use: {
-            loader: "babel-loader",
-          },
-          resolve: {
-            fullySpecified: false,
-          },
-        },
-      ],
-    },
-    devServer: {
-      static: [
-        {
-          directory: path.join(__dirname, "demo"),
-        },
-        {
-          directory: path.join(__dirname, "demo", "dist"),
-        },
-      ],
-      compress: true,
-      port: 9000,
-      historyApiFallback: true,
-      client: {
-        overlay: false,
-      },
-    },
-  };
-};