nextcloud / nextcloud/maps

Migrate off the OCA.Viewer global before Nextcloud 36

Open
#1,673 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
598
Forks
113
PR merge metrics
No merged PRs in 30d

Description

Maps opens photos in the viewer from three components:

  • src/components/Sidebar/PhotoSuggestionsSidebarTab.vue:288: OCA.Viewer.open({ path, list })
  • src/components/map/PhotoSuggestionsLayer.vue:200,253: window.OCA.Viewer.open({ path, list })
  • src/components/map/PhotosLayer.vue:172,223: window.OCA.Viewer.open({ path, list })

Both arguments change shape: the viewer takes @nextcloud/files nodes, so the photo objects
being passed as path and list need to become nodes. The if (window.OCA && window.OCA.Viewer && window.OCA.Viewer.open) guards can go with them, since importing the package is enough.


OCA.Viewer is gone in Viewer 7.0.0. The viewer ships as the
@nextcloud/viewer library rather than a
bundled app, and nextcloud/server#63954 removes the viewer app from Nextcloud 36 altogether.

Roughly what it looks like:

import { canView, getViewer } from '@nextcloud/viewer'

// OCA.Viewer.open({ path }) / ({ fileInfo, list })
getViewer().open(nodes, file)          // @nextcloud/files nodes
getViewer().openFolder(folder, file)   // when a path is all you have, let it fetch

// OCA.Viewer.mimetypes.includes(mime) / availableHandlers
canView(node)

The part that is not a rename is that the viewer takes @nextcloud/files nodes now, not
fileinfo objects or path strings. Importing the package is also all it takes to get the viewer
onto the page: no LoadViewer event to dispatch, and nothing to check about whether the app is
enabled.

[!IMPORTANT]
There is no compatibility shim, which was a deliberate call, so this is a real port rather
than a rename. Nothing breaks until the server PR lands; after that these calls throw on
Nextcloud 36.

[!TIP]
The developer manual covers the migration under
Critical changes
(being added in nextcloud/documentation#15597), and the
README
has the full before/after table. Happy to help with the port, just ping me.

👾 This issue was written with the help of Claude Code.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the three listed call sites: src/components/Sidebar/PhotoSuggestionsSidebarTab.vue, src/components/map/PhotoSuggestionsLayer.vue, and src/components/map/PhotosLayer.vue. Read the @nextcloud/viewer migration guide and inspect how these components construct photo data before converting the arguments to @nextcloud/files nodes. Done means all viewer calls use the imported viewer API, with no OCA.Viewer globals or guards, and work with Nextcloud 36.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.