use Mirador for file systems and permit PCDM dc types to render in Mirador

- remove archival-iiif pending authz and plugin capability
- bump cul-mirador fork version
- DLC-1008

Author: barmintor

Gemfile

@@ -93,6 +93,7 @@ gem "devise-guests", "~> 0.3"
 gem 'rubyzip', '>= 1.2.1'
 gem 'rack-protection', '>= 1.5.5'
 gem 'loofah', '>= 2.2.1'
+gem 'best_type'
 
 group :development, :test do
   # Use Capistrano for deployment

Gemfile.lock

@@ -89,6 +89,8 @@ GEM
       sshkit (>= 1.6.1, != 1.7.0)
     ast (2.4.2)
     bcrypt (3.1.19)
+    best_type (1.0.1)
+      mime-types (~> 3.4)
     bigdecimal (3.1.4)
     blacklight (7.33.1)
       deprecation
@@ -500,6 +502,7 @@ DEPENDENCIES
   active-fedora (~> 8.7)
   active-triples!
   addressable (~> 2.8.0)
+  best_type
   bigdecimal (~> 3.0)
   blacklight (~> 7.33.1)
   bootsnap (~> 1.9.3)

app/assets/stylesheets/iiif.scss

@@ -16,15 +16,9 @@
 @import "@archival-iiif/viewer-react/dist/viewer/media/transcription.css";
 @import "@archival-iiif/viewer-react/dist/topBar/fullscreen.css";
 @import "@archival-iiif/viewer-react/dist/topBar/topbar.css";
-#mirador {
+#mirador, #aiiif {
 	height: 80vh;
 	.mosaic-root {
 		inset: 0px;
 	}
 }
-
-.aiiif-root {
-	p {
-		margin-top: initial;
-	}
-}

app/helpers/children_helper.rb

@@ -93,8 +93,18 @@ def has_public_children?(document: @document, children: nil, ability: Ability.ne
     children.detect { |child| is_publicly_available_asset?(child, ability) }.present?
   end
 
+  def structured_children_of document, &block
+    structured_children(document)&.select &block
+  end
+
   def structured_children_of_type(document: @document, dc_type:)
-    structured_children(document)&.select { |child| Array(child[:dc_type_sim]).include?(dc_type) }
+    structured_children_of(@document) { |child| Array(child[:dc_type_sim]).include?(dc_type) }
+  end
+
+  def structured_children_of_valid_types(document: @document)
+    structured_children_of(@document) do |child|
+      Array(child[:dc_type_sim]).detect { |dct| BestType.dc_type.valid_type?(dct) || BestType.pcdm_type.valid_type?(dct) }
+    end
   end
 
   def structured_children_not_type(document: @document, dc_type:)

app/javascript/iiif-archives.js

@@ -1,7 +1,82 @@
-import ArchivalIIIFViewer from "@archival-iiif/viewer-react";
+import Mirador from '@columbia-libraries/mirador/dist/es/src';
+import miradorDownloadPlugins from '@columbia-libraries/mirador/dist/es/src/culPlugins/mirador-downloaddialog';
+import canvasRelatedLinksPlugin from '@columbia-libraries/mirador/dist/es/src/culPlugins/mirador-canvasRelatedLinks'
+import citationSidebar from '@columbia-libraries/mirador/dist/es/src/culPlugins/mirador-citations';
+import hintingSidebar from '@columbia-libraries/mirador/dist/es/src/culPlugins/mirador-hinting-sidebar';
+import videoJSPlugin from '@columbia-libraries/mirador/dist/es/src/culPlugins/mirador-videojs';
+import viewerNavigation from '@columbia-libraries/mirador/dist/es/src/culPlugins/mirador-pageIconViewerNavigation';
+import viewXmlPlugin from '@columbia-libraries/mirador/dist/es/src/culPlugins/mirador-viewXml';
+import collectionFoldersPlugin from '@columbia-libraries/mirador/dist/es/src/culPlugins/mirador-selectCollectionFolders';
+const flattenPluginConfigs = (...plugins) => plugins.reduce(
+  (acc, curr) => {
+    return acc.concat([...curr])
+  }, []
+);
+
 $(document).ready(function(){
-  var manifestUrl = $('#aiiif').data('manifest');
+  const manifestUrl = $('#aiiif').data('manifest');
   if (manifestUrl) {
-    new ArchivalIIIFViewer({id: 'aiiif', manifest: manifestUrl});
+    const numChildren = $('#aiiif').data('num-children');
+    const startCanvas = function(queryParams) {
+      if (queryParams.get("canvas")) {
+        const canvases = queryParams.get("canvas").split(',');
+        const canvas = canvases[0];
+        return canvas.startsWith('../') ? manifestUrl.replace('/manifest', canvas.slice(2)) : canvas;
+      } else return null;
+    }(new URL(document.location).searchParams);
+    const viewConfig = {};
+    if (numChildren && numChildren === 1) {
+      viewConfig.views = [
+        { key: 'single' }
+      ];
+      viewConfig.defaultView = 'single';
+    }
+    Mirador.viewer(
+      {
+        id: 'aiiif',
+        window: {
+          allowClose: false,
+          allowFullscreen: true,
+          allowMaximize: false,
+          panels: {
+            info: true,
+            canvas: true
+          },
+          canvasLink: {
+            active: true,
+            enabled: true,
+            singleCanvasOnly: false,
+            providers: [],
+            getCanvasLink: (manifestId, canvases) => {
+              const baseUri = window.location.href.replace(window.location.search, '');
+              const canvasIndices = canvases.map(
+                (canvas) => canvas.id.startsWith(manifestId.replace('/manifest', '')) ? '../canvas/' + canvas.id.split("/").slice(-2).join('/') : canvas.id,
+              );
+              return `${baseUri}?canvas=${canvasIndices.join(",",)}`;
+            }
+          },
+          ...viewConfig,
+        },
+        windows: [
+          { 
+            manifestId: manifestUrl,
+            canvasId: startCanvas,
+          }
+        ],
+        workspace: {
+          showZoomControls: true,
+        },
+        workspaceControlPanel: {
+          enabled: false
+        },
+        miradorDownloadPlugin: {
+          restrictDownloadOnSizeDefinition: true,
+        },
+        translations: {
+          en: { openCompanionWindow_citation: "Citation" },
+        },
+      },
+      flattenPluginConfigs(canvasRelatedLinksPlugin, citationSidebar, collectionFoldersPlugin, hintingSidebar, miradorDownloadPlugins, videoJSPlugin, viewerNavigation, viewXmlPlugin),
+    );
   }
 });

app/views/shared/_head_includes.html.erb

@@ -30,9 +30,8 @@ DLC VERSION: <%= IO.read(Rails.root.to_s+'/VERSION') %> -->
 <%= stylesheet_link_tag "dcv", media: 'all'  %>
 <%= stylesheet_link_tag "print", media: 'print' %>
 <%- is_iiif_client = @document&.fetch('iiif_behavior_ssim', nil).present? -%>
-<%- ['StillImage', 'Sound', 'MovingImage', 'Text'].each do |dc_type| -%>
-	<%- is_iiif_client ||= Array(@document&.fetch(:dc_type_sim, nil)).include?(dc_type) -%>
-	<%- is_iiif_client ||= Array(@document&.fetch(:dc_type_sim, nil)).include?('InteractiveResource') && structured_children_of_type(document: @document || {}, dc_type: dc_type).present? -%>
+<%- if !is_iiif_client && Array(@document&.fetch(:dc_type_sim, nil)).detect { |x| BestType.dc_type.valid_type?(x) || BestType.pcdm_type.valid_type?(x) } -%>
+	<%- is_iiif_client ||= Array(@document&.fetch(:dc_type_sim, nil)).include?('InteractiveResource') ? structured_children_of_valid_types(@document).present? : true -%>
 <%- end -%>
 <%- is_iiif_client ||= archive_org_id_for_document(@document) -%>
 <%- is_file_system = is_file_system?(@document) -%>

package.json

@@ -3,15 +3,14 @@
   "private": true,
   "version": "0.1.0",
   "dependencies": {
-    "@archival-iiif/viewer-react": "^3.1.0",
     "@babel/core": "^7.22.17",
     "@babel/plugin-transform-runtime": "^7.22.15",
     "@babel/preset-env": "^7.22.15",
     "@babel/preset-react": "^7.22.15",
     "@babel/runtime": "^7.22.15",
     "@blueprintjs/core": "^5.3.0",
     "@blueprintjs/icons": "^5.1.6",
-    "@columbia-libraries/mirador": "3.3.1-3789.11",
+    "@columbia-libraries/mirador": "3.3.1-3789.12",
     "@emotion/react": "^11.10.6",
     "@emotion/styled": "^11.10.6",
     "@fortawesome/fontawesome-free": "6.4.2",
@@ -77,7 +76,7 @@
   "devDependencies": {
     "@emotion/babel-preset-css-prop": "^11.11.0",
     "@webpack-cli/serve": "^2.0.5",
-    "@columbia-libraries/mirador": "3.3.1-3789.11",
+    "@columbia-libraries/mirador": "3.3.1-3789.12",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "webpack-dev-server": "^4.15.1"