dspace-angular icon indicating copy to clipboard operation
dspace-angular copied to clipboard

Add iiif manifest bundle to suggested bundle names when uploading bitstream

Open jabrah opened this issue 1 year ago • 1 comments

References

Add references/links to any related issues or PRs. These may include:

  • Relates to ticket https://github.com/DSpace/DSpace/issues/9143
  • Requires this DSpace PR: https://github.com/DSpace/DSpace/pull/9172

Description

This change will add IIIF_MANIFEST as a default bundle suggestion when uploading bitstreams on an item if that item has IIIF enabled. This bundle is intended to hold a custom IIIF manifest file that would be used in place of DSpace's generated manifest (see linked PR to DSpace/DSpace).

Note the DSpace backend change supporting custom manifests can still function without this change. Without this, an admin adding a bitstream would have to manually input IIIF_MANIFEST as the bitstream's target bundle

Changes

  • Add IIIF_MANIFEST as a default bundle suggestion
  • Update upload-bitstream component to filter out the IIIF_MANIFEST bundle suggestion if the item does not have IIIF enabled

Instructions for Reviewers

We need to make sure the DSpace UI under test has the config changes from this PR: adding IIIF_MANIFEST to the standard bundles.

Default items in DSpace generally don't have IIIF enabled, so we can start by investigating any item in the default test data.

IIIF disabled item

  • Login as admin
  • Edit an item
    • Verify that the item's metadata does not include dspace.iiif.enabled = true
  • Navigate to Bitstreams tab, and click on the Upload button
    • This will bring up the Upload Bitstream screen with an input field for the target bundle for the new bitstream
  • Click on the Bundle input to bring up the bundle suggestions
    • Verify that IIIF_MANIFEST does NOT appear, as this item does not have IIIF enabled

IIIF Enabled item

We can reuse the same item as above for convenience, or we can use any other item or create a new item

  • Login as admin, edit an item
  • In metadata, click Add
    • Enter Field: dspace.iiif.enabled, Value: true and the green checkbox to confirm
    • Verify the metadata field was entered correctly and click Save to commit
  • Once the save goes through, navigate to the Bitstreams tab (still in the item's admin interface)
  • Click the Upload button
  • Click the Bundle input
    • Verify IIIF_MANIFEST appears in the suggestion list

Checklist

This checklist provides a reminder of what we are going to look for when reviewing your PR. You need not complete this checklist prior to creating your PR (draft PRs are always welcome). If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!

  • [x] My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • [x] My PR passes ESLint validation using yarn lint
  • [x] My PR doesn't introduce circular dependencies (verified via yarn check-circ-deps)
  • [ ] My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • [ ] My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • [x] If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • [ ] If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • [x] If my PR fixes an issue ticket, I've linked them together.

jabrah avatar Feb 06 '24 17:02 jabrah

Hi @jabrah, Conflicts have been detected against the base branch. Please resolve these conflicts as soon as you can. Thanks!

github-actions[bot] avatar Mar 08 '24 15:03 github-actions[bot]