Support Properties links (frontmatter links) added in Obsidian 1.4.5

[rocketnova]

Changes

• Considers links in the frontmatter when determining route to central note
• Updates minimum Obsidian API version to 1.4.0 (when the frontmatterLinks property was added)

Context

The new Obsidian 1.4.5 release added a new feature called Properties. One of the things it does is add support wiki-style links (e.g. [[]]) in the yaml frontmatter. These links are not added to the .links property in CachedMetadata. Instead they are added as a new and separate property called .frontmatterLinks.

I think that the code for building the list of links could probably get tidied a little bit by using a Set instead of an array for all_links since it would naturally handle the de-duplication safety check, but I didn't want to exceed the scope of the problem, which is just to get frontmatter links into all_links.

Testing

You can test this out by doing the following.

Verify that frontmatter links are not considered without this patch:

1. Update to Obsidian 1.4.5
2. Make sure there is a central note set in the Map of Content plugin settings
3. Create a new note
4. Add a property to the new note and add a link to the central note
5. On the new note, the Map of Content viewer should show no connections to the central note

Verify that frontmatter links are considered with this patch:

1. Update to Obsidian 1.4.5
2. Update the Map of Content plugin to use this branch
3. Create a new note
4. Add a property to the new note and add a link to the central note
5. On the new note, the Map of Content viewer should the connections to the central note

Note about the API

The new property is visible in the Obsidian Developer Console, even if it isn't yet documented in the web API docs. Here are some screenshots of what is currently shown in the API docs (apparently incorrect or incomplete) and what you can see in the Obsidian Developer Console.

[rocketnova]

JFYI: While working on a PR for another plugin, I found the source of truth for the obsidian API. Here's the change in the Obsidian CachedMetadata class.

[lomky]

Bug: Map of Content does not invoke Update Map of Content on file switch when a new properties link is added

To Reproduce:

• Prereqs:

  • Obsidian v1.4.5
  • MoC on PR branch
  • MoC setting Update when switching between files: is checked

• Inline behavior (Working as expected)

  1. Create [[Foo]] and mark it as your root MoC file
  2. Create [[Bar]] and link it inline it to Foo.
     • [ ] Confirm: MoC does not update
  3. Create [[Zap]]
  4. Swap back to Bar
     • [ ] Confirm: MoC has updated to Bar -> Foo
  5. Swap back to Zap
  6. Add an inline link to Bar
  7. Swap away and back to Zap
     • [ ] Confirm: MoC has updated to Zap -> Bar -> Foo
  8. Add a inline link to Foo in Zap
  9. Swap away and back to Zap
     • [ ] Confirm: MoC has updated to Zap -> Foo

• Properties behavior (Bugged)

  1. Create [[Foo]] and mark it as your root MoC file
  2. Create [[Bar]] and link it inline it to Foo.
     • [ ] Confirm: MoC does not update
  3. Create [[Zap]]
  4. Swap back to Bar
     • [ ] Confirm: MoC has updated to Bar -> Foo
  5. Swap back to Zap
  6. Add an inline link to Bar
  7. Swap away and back to Zap
     • [ ] Confirm: MoC has updated to Zap -> Bar -> Foo
  8. Add a properties link to Foo in Zap
  9. Swap away and back to Zap
     • Expected behavior: MoC has updated to Zap -> Foo
     • [ ] Observed behavior: MoC has not updated.
  10. Invoke Map of Content: Update Map of Content
      • [ ] Confirm: MoC has updated to Zap -> Foo

Also reproduced with:

• properties link is the first link added to a new file
  • Observed behavior: MoC never added to note
• property link as string type
  • Observed behavior: update map of content not invoked
• property link as list type
  • Observed behavior: update map of content not invoked

[Robin-Haupt-1]

Thank you for contributing :+1:

[rocketnova]

Thanks for the quick turnaround and thanks for a very useful plugin!

[Robin-Haupt-1]

You're welcome! I've also fixed the issue with frontmatter links not triggering an MOC update on note change. It will be fixed with the next release. I'm currently in the process of refactoring the codebase, using camelcase everywhere, using things like sets where useful and no longer using the obsoleted workspace.activeLeaf. Once that's done and tested, i'll release it all. Please feel free to make further suggestion towards improving the code quality or adding features.

[rocketnova]

I saw that! Looks great.

[Robin-Haupt-1]

Release is out now