@harvard-lts/mirador-eda-plugin 0.1.1

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,34 @@
+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

@@ -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,175 @@
+# Mirador EDA Plugin
+
+A Mirador 3 plugin for displaying Emily Dickinson Archive (EDA) transcriptions with toggleable line breaks and editorial marks. This plugin replicates the viewing experience of [edickinson.org](https://www.edickinson.org) while gracefully handling non-Emily Dickinson manifests.
+
+## Features
+
+- **Edition Switcher**: Dropdown to switch between different editions (e.g., Franklin Variorum 1998, Johnson Poems 1955)
+- **Line Break Toggle**: Show/hide physical line breaks in the manuscript (shows metric line breaks by default)
+- **Editorial Marks Toggle**: Show/hide editorial marks and textual variants (hided edits by default)
+- **HTML Rendering**: Full support for HTML tags including `ruby`, `ins`, `em`, `strong`, `br`, and more
+- **Textual Variants**: Display alternate readings and editorial choices
+- **EDA Icon**: Custom fern ornament icon in the sidebar
+- **Smart Manifest Handling**: Automatically detects Emily Dickinson content and only shows the transcription button when relevant while hiding the default Annotations button
+
+## Requirements
+
+- [NVM](https://github.com/nvm-sh/nvm)
+- Node.js 14+
+- Mirador 3.x
+
+## Setup
+
+1. Run `npm i` to install dependencies
+2. 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                                                                        |
+| `serve` | Spins up the local development server at http://localhost:9000                                                             |
+| `test`  | Runs the test suite                                                                                                        |
+
+## Installing in Mirador
+
+The `@harvard-lts/mirador-eda-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.
+
+### Installation
+
+```bash
+npm i @harvard-lts/mirador-eda-plugin
+```
+
+## Emily Dickinson Archive IIIF Manifest
+
+For the plugin to show transcriptions, your IIIF manifest should include annotations with the following structure:
+
+```json
+{
+  "annotations": [
+    {
+      "id": "annotation_page_id",
+      "type": "AnnotationPage",
+      "items": [
+        {
+          "id": "annotation_id",
+          "type": "Annotation",
+          "motivation": "commenting",
+          "body": {
+            "type": "Text",
+            "language": "en",
+            "format": "text/html",
+            "value": "<div class=\"work-body\" data-exhibit=\"emily-dickinson-archive\" data-edition=\"Edition Name\">...</div>"
+          },
+          "target": "canvas_id"
+        }
+      ]
+    }
+  ]
+}
+```
+
+**Important:** The plugin specifically looks for the `data-exhibit="emily-dickinson-archive"` attribute to identify Emily Dickinson transcriptions.
+
+### Non-Emily Dickinson Manifests
+
+For non-Emily Dickinson manifests, the plugin will automatically:
+
+1. Hide the transcription button from the sidebar
+2. If a user somehow activates the panel (via API or programmatically), it will display a helpful message explaining that transcriptions are only available for Emily Dickinson content
+
+### Supported HTML Tags
+
+The plugin supports the following HTML tags and classes:
+
+- **Required attributes**: `data-exhibit="emily-dickinson-archive"` on `.work-body`
+- **Edition identification**: `data-edition` attribute on `.work-body`
+- **Line breaks**: `<br class="emily">` and `<br class="emily author">`
+- **Textual variants**: `<ruby>`, `<rt>`, `<rp>` tags
+- **Alternate readings**: `<ins class="alternate">`
+- **Text formatting**: `<em>`, `<strong>`, `<p>`, `<span>`
+- **Stanzas**: Elements with `class="stanza"`
+- **Lines**: Elements with `class="line"`
+
+## Plugin Architecture
+
+The plugin consists of these main components:
+
+1. **EdaTranscriptionButton**: Adds the EDA icon to the sidebar (only visible for EDA manifests)
+2. **EdaTranscriptionPanel**: Displays the transcription content with controls
+3. **EdaTranslationOverrideWrapper**: Provides translation and configuration
+4. **transcriptionUtils**: Utility functions for extracting transcriptions from manifests
+
+## Development
+
+```bash
+# Install dependencies
+npm i
+
+# Start development server
+npm run serve
+
+# Run tests
+npm test
+```
+
+The development server will start at http://localhost:9000 and automatically reload when you make changes.
+
+### Compatibility Notes
+
+The plugin includes a warning suppression utility for versions of Mirador prior to 4.0.0 that use a deprecated Material-UI Badge prop. This suppression:
+
+- Suppresses the `overlap="rectangle"` deprecation warning
+- Notes if the suppression file is no longer needed
+- Can be deleted once this app is upgraded to Mirador version 4.0.0 or later where the issue is fixed
+
+The warning suppression is implemented in `src/plugins/utils/suppressWarnings.js`.
+
+### Testing
+
+The plugin includes comprehensive tests using Jest and React Testing Library. The test suite is organized by responsibility:
+
+```bash
+# Run all tests
+npm test
+
+# Run specific test files
+npm test src/plugins/__tests__/[filename].spec.js
+```
+
+Test Files and Responsibilities:
+
+#### Component Tests
+- `EdaTranscriptionButton.spec.js` - Tests button rendering, visibility, and interaction
+- `EdaTranscriptionPanel.spec.js` - Tests panel UI, transcription display, and controls
+- `EdaSideBarButtonsWrapper.spec.js` - Tests sidebar button container and layout
+
+#### Manifest Tests
+- `edaManifest.spec.js` - Tests Emily Dickinson manifest handling and transcription extraction
+- `nonEdaManifest.spec.js` - Tests non-Emily Dickinson manifest behavior
+- `transcriptionUtils.spec.js` - Tests utility functions for transcription processing
+
+#### Test Fixtures
+Organized by edition in `testFixtures/`:
+- `johnsonPoems1955Transcription.js` - Johnson 1955 edition samples
+- `franklinVariorum1998Transcription.js` - Franklin Variorum 1998 samples
+- `combinedEditionsTranscriptions.js` - Multi-edition test cases
+
+Testing Philosophy:
+- Component tests focus on user interaction and rendering
+- Manifest tests verify data handling and structure
+- Each test file has a single responsibility
+- Mocks are used judiciously to isolate functionality
+- React Testing Library encourages testing user behavior over implementation
+
+## Demo
+
+The plugin includes a demo environment with sample manifests:
+
+1. Emily Dickinson Archive manifest (`data/manifest-3037.json` and `data/manifest-609.json`)
+2. Non-Emily Dickinson manifest from Harvard (`https://iiif.lib.harvard.edu/manifests/ids:488815`)
+
+To switch between them, edit the `manifestId` in `demo/demoEntry.js`.

package/__mocks__/fileMock.js

@@ -0,0 +1 @@
+module.exports = "mock-file-stub"

package/babel.config.json

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