@harvard-lts/mirador-template-plugin 0.1.4

package/.github/pull_request_template.md

@@ -0,0 +1,31 @@
+**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

@@ -0,0 +1,35 @@
+name: Publish to npmjs on release
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on:
+      group: huit-arc
+
+    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.NPM_ACCESS_TOKEN }}

package/.nvmrc

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

package/.parcelrc

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

package/.travis.yml

@@ -0,0 +1,16 @@
+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

@@ -0,0 +1,20 @@
+## 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/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,39 @@
+# mirador-template-plugin
+
+Template for Harvard mps-viewer Mirador plugins.
+
+## Requirements
+
+- [NVM](https://github.com/nvm-sh/nvm)
+
+## Setup
+
+1. Run `npm i` to install dependencies
+1. 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                                                                                                                |
+| ------- | -------------------------------------------------------------------------------------------------------------------------- |
+| `build` | Builds the source files into the `./dist` directory                                                                        |
+
+## 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.
+
+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.
+
+[build-badge]: https://img.shields.io/travis/projectmirador/mirador-template-plugin/master.png?style=flat-square
+[build]: https://travis-ci.org/projectmirador/mirador-template-plugin
+
+[npm-badge]: https://img.shields.io/npm/v/mirador-template-plugin.png?style=flat-square
+[npm]: https://www.npmjs.org/package/mirador-template-plugin

package/babel.config.json

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

package/dist/index.js

@@ -0,0 +1,69 @@
+var $gXNCa$reduxsagaeffects = require("redux-saga/effects");
+var $gXNCa$miradordistessrcstateselectors = require("mirador/dist/es/src/state/selectors");
+var $gXNCa$miradordistessrcstateactions = require("mirador/dist/es/src/state/actions");
+
+
+function $parcel$defineInteropFlag(a) {
+  Object.defineProperty(a, '__esModule', {value: true, configurable: true});
+}
+
+function $parcel$export(e, n, v, s) {
+  Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
+}
+
+$parcel$defineInteropFlag(module.exports);
+
+$parcel$export(module.exports, "default", () => $4fa36e821943b400$export$2e2bcd8739ae039);
+$parcel$export(module.exports, "MiradorTemplatePlugin", () => $a54d05f4736ae6e1$export$2e2bcd8739ae039);
+
+
+
+/**
+ * Add a canvasId query parameter to the URL
+ * @param {String} canvasId Canvas id from manifest
+ */ function $a54d05f4736ae6e1$var$insertCanvasIdIntoURL(canvasId) {
+    const searchParams = new URLSearchParams(window.location.search);
+    searchParams.set("canvasId", canvasId);
+    window.history.replaceState({}, "", `${window.location.pathname}?${searchParams.toString()}`);
+}
+/**
+ * Will be fired every time the SET_CANVAS action is dispatched
+ * This will run on first load, and works in conjunction with a canvasId initialisation option
+ * @param {Object} action Payload object
+ */ function* $a54d05f4736ae6e1$var$onCanvasChange(action) {
+    const { canvasId: canvasId, windowId: windowId } = action;
+    const windowIds = yield (0, $gXNCa$reduxsagaeffects.select)((0, $gXNCa$miradordistessrcstateselectors.getWindowIds));
+    // Disregard events from other windows
+    // (assumes we: start with/care about, one/the first window)
+    // I.e. if user adds resource, SET_CANVAS will be dispatched from here
+    // but we don't want to update the URL on those actions
+    if (windowId !== windowIds[0]) return;
+    // Resolve potentially broken canvasId to first canvas
+    const targetCanvas = yield (0, $gXNCa$reduxsagaeffects.select)((0, $gXNCa$miradordistessrcstateselectors.getCanvas), {
+        canvasId: canvasId,
+        windowId: windowId
+    });
+    if (!targetCanvas) {
+        const availableCanvases = yield (0, $gXNCa$reduxsagaeffects.select)((0, $gXNCa$miradordistessrcstateselectors.getCanvases), {
+            windowId: windowId
+        });
+        yield (0, $gXNCa$reduxsagaeffects.put)((0, $gXNCa$miradordistessrcstateactions.setCanvas)(windowId, availableCanvases[0].id));
+    }
+    // Update the URL
+    $a54d05f4736ae6e1$var$insertCanvasIdIntoURL(action.canvasId);
+}
+const $a54d05f4736ae6e1$var$rootSaga = function*() {
+    yield (0, $gXNCa$reduxsagaeffects.takeEvery)("mirador/SET_CANVAS", $a54d05f4736ae6e1$var$onCanvasChange);
+};
+var $a54d05f4736ae6e1$export$2e2bcd8739ae039 = {
+    component: ()=>null,
+    mode: "add",
+    saga: $a54d05f4736ae6e1$var$rootSaga,
+    target: "Window"
+};
+
+
+var $4fa36e821943b400$export$2e2bcd8739ae039 = (0, $a54d05f4736ae6e1$export$2e2bcd8739ae039);
+
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"mappings":";;;;;;;;;;;;;;;;;;;;ACQA;;;CAGC,GACD,SAAS,4CAAsB,QAAQ;IACrC,MAAM,eAAe,IAAI,gBAAgB,OAAO,QAAQ,CAAC,MAAM;IAC/D,aAAa,GAAG,CAAC,YAAY;IAC7B,OAAO,OAAO,CAAC,YAAY,CACzB,CAAC,GACD,IACA,GAAG,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,aAAa,QAAQ,IAAI;AAE5D;AAEA;;;;CAIC,GACD,UAAU,qCAAe,MAAM;IAC7B,MAAM,YAAE,QAAQ,YAAE,QAAQ,EAAE,GAAG;IAC/B,MAAM,YAAY,MAAM,CAAA,GAAA,8BAAK,EAAE,CAAA,GAAA,kDAAW;IAE1C,sCAAsC;IACtC,4DAA4D;IAC5D,sEAAsE;IACtE,uDAAuD;IACvD,IAAI,aAAa,SAAS,CAAC,EAAE,EAAE;IAE/B,sDAAsD;IACtD,MAAM,eAAe,MAAM,CAAA,GAAA,8BAAK,EAAE,CAAA,GAAA,+CAAQ,GAAG;kBAAE;kBAAU;IAAS;IAElE,IAAI,CAAC,cAAc;QACjB,MAAM,oBAAoB,MAAM,CAAA,GAAA,8BAAK,EAAE,CAAA,GAAA,iDAAU,GAAG;sBAAE;QAAS;QAC/D,MAAM,CAAA,GAAA,2BAAE,EAAE,CAAA,GAAA,6CAAQ,EAAE,UAAU,iBAAiB,CAAC,EAAE,CAAC,EAAE;IACvD;IAEA,iBAAiB;IACjB,4CAAsB,OAAO,QAAQ;AACvC;AAEA,MAAM,iCAAW;IACf,MAAM,CAAA,GAAA,iCAAQ,EAAE,sBAAsB;AACxC;IAEA,2CAAe;IACb,WAAW,IAAM;IACjB,MAAM;IACN,MAAM;IACN,QAAQ;AACV;;;IDtDA,2CAAe,CAAA,GAAA,wCAAoB","sources":["src/index.js","src/plugins/MiradorTemplatePlugin.js"],"sourcesContent":["import MiradorTemplatePlugin from \"./plugins/MiradorTemplatePlugin\";\n\nexport { MiradorTemplatePlugin };\n\nexport default MiradorTemplatePlugin;","import { takeEvery, select, put } from \"redux-saga/effects\";\nimport {\n  getCanvas,\n  getCanvases,\n  getWindowIds,\n} from \"mirador/dist/es/src/state/selectors\";\nimport { setCanvas } from \"mirador/dist/es/src/state/actions\";\n\n/**\n * Add a canvasId query parameter to the URL\n * @param {String} canvasId Canvas id from manifest\n */\nfunction insertCanvasIdIntoURL(canvasId) {\n  const searchParams = new URLSearchParams(window.location.search);\n  searchParams.set(\"canvasId\", canvasId);\n  window.history.replaceState(\n    {},\n    \"\",\n    `${window.location.pathname}?${searchParams.toString()}`\n  );\n}\n\n/**\n * Will be fired every time the SET_CANVAS action is dispatched\n * This will run on first load, and works in conjunction with a canvasId initialisation option\n * @param {Object} action Payload object\n */\nfunction* onCanvasChange(action) {\n  const { canvasId, windowId } = action;\n  const windowIds = yield select(getWindowIds);\n\n  // Disregard events from other windows\n  // (assumes we: start with/care about, one/the first window)\n  // I.e. if user adds resource, SET_CANVAS will be dispatched from here\n  // but we don't want to update the URL on those actions\n  if (windowId !== windowIds[0]) return;\n\n  // Resolve potentially broken canvasId to first canvas\n  const targetCanvas = yield select(getCanvas, { canvasId, windowId });\n\n  if (!targetCanvas) {\n    const availableCanvases = yield select(getCanvases, { windowId });\n    yield put(setCanvas(windowId, availableCanvases[0].id));\n  }\n\n  // Update the URL\n  insertCanvasIdIntoURL(action.canvasId);\n}\n\nconst rootSaga = function* () {\n  yield takeEvery(\"mirador/SET_CANVAS\", onCanvasChange);\n};\n\nexport default {\n  component: () => null, // No UI component\n  mode: \"add\",\n  saga: rootSaga,\n  target: \"Window\",\n};\n"],"names":[],"version":3,"file":"index.js.map"}

package/jest.config.js

@@ -0,0 +1,20 @@
+/** @type {import('jest').Config} */
+module.exports = {
+  testEnvironment: "jsdom",
+  transformIgnorePatterns: ["node_modules/(?!mirador)/", "node_modules/pdiiif"],
+  setupFilesAfterEnv: ["./setupTests.js"],
+  //   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/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@harvard-lts/mirador-template-plugin",
+  "version": "0.1.4",
+  "description": "Template for Harvard mps-viewer Mirador plugins",
+  "main": "dist/index.js",
+  "source": "src/index.js",
+  "module": "es/index.js",  
+  "scripts": {
+    "prebuild": "rm -rf dist && rm -rf es",
+    "prepublishOnly": "npm run build",
+    "build": "parcel build",
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "test:watch": "jest --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/harvard-lts/mirador-template-plugin.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "Apache-2.0",
+  "homepage": "https://github.com/harvard-lts/mirador-template-plugin#readme",
+  "dependencies": {
+    "mirador": "^3.3.0",
+    "redux": "^4.2.1",
+    "redux-saga": "^1.2.3"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.26.0",
+    "@babel/preset-env": "^7.21.4",
+    "@babel/preset-react": "^7.18.6",
+    "@testing-library/jest-dom": "^5.16.5",
+    "@testing-library/react": "^12.0.0",
+    "babel-jest": "^29.7.0",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "parcel": "^2.8.3",
+    "url": "^0.11.0"
+  }
+}

package/src/index.js

@@ -0,0 +1,5 @@
+import MiradorTemplatePlugin from "./plugins/MiradorTemplatePlugin";
+
+export { MiradorTemplatePlugin };
+
+export default MiradorTemplatePlugin;

package/src/plugins/MiradorTemplatePlugin.js

@@ -0,0 +1,59 @@
+import { takeEvery, select, put } from "redux-saga/effects";
+import {
+  getCanvas,
+  getCanvases,
+  getWindowIds,
+} from "mirador/dist/es/src/state/selectors";
+import { setCanvas } from "mirador/dist/es/src/state/actions";
+
+/**
+ * Add a canvasId query parameter to the URL
+ * @param {String} canvasId Canvas id from manifest
+ */
+function insertCanvasIdIntoURL(canvasId) {
+  const searchParams = new URLSearchParams(window.location.search);
+  searchParams.set("canvasId", canvasId);
+  window.history.replaceState(
+    {},
+    "",
+    `${window.location.pathname}?${searchParams.toString()}`
+  );
+}
+
+/**
+ * Will be fired every time the SET_CANVAS action is dispatched
+ * This will run on first load, and works in conjunction with a canvasId initialisation option
+ * @param {Object} action Payload object
+ */
+function* onCanvasChange(action) {
+  const { canvasId, windowId } = action;
+  const windowIds = yield select(getWindowIds);
+
+  // Disregard events from other windows
+  // (assumes we: start with/care about, one/the first window)
+  // I.e. if user adds resource, SET_CANVAS will be dispatched from here
+  // but we don't want to update the URL on those actions
+  if (windowId !== windowIds[0]) return;
+
+  // Resolve potentially broken canvasId to first canvas
+  const targetCanvas = yield select(getCanvas, { canvasId, windowId });
+
+  if (!targetCanvas) {
+    const availableCanvases = yield select(getCanvases, { windowId });
+    yield put(setCanvas(windowId, availableCanvases[0].id));
+  }
+
+  // Update the URL
+  insertCanvasIdIntoURL(action.canvasId);
+}
+
+const rootSaga = function* () {
+  yield takeEvery("mirador/SET_CANVAS", onCanvasChange);
+};
+
+export default {
+  component: () => null, // No UI component
+  mode: "add",
+  saga: rootSaga,
+  target: "Window",
+};