Add new option "immich_favorites"

Author: j-a-n

docs/configuration.md

@@ -49,12 +49,13 @@ You can set the following configuration parameters for every individual Home Ass
 | iframe_load_unchanged            | Should an iframe be reloaded once its display time has expired, even if its URL remains the same?      | false     |
 | iframe_interaction               | Allow interaction with the iframe content?                                                             | false     |
 | immich_api_key                   | API key that is used for authentication at the [immich API](media-sources.md#immich-api)               |           |
-| immich_shared_albums             | Show images of shared immich albums?                                                                   | true      |
-| immich_album_names               | Only show images from these immich albums.                                                             | []        |
-| immich_tag_names                 | Only show images with this tags.                                                                       | []        |
-| immich_persons                   | Only show images with this persons.                                                                    | []        |
-| immich_memories                  | Only show today memories.                                                                              | false     |
-| immich_resolution                | The resolution to use for loading images from immich (possible values are: `preview` / `original`).    | preview   |
+| immich_shared_albums             | Display media from shared Immich albums.                                                               | true      |
+| immich_album_names               | Display media only from the specified Immich albums.                                                   | []        |
+| immich_tag_names                 | Display media only with the specified tags.                                                            | []        |
+| immich_persons                   | Display media only featuring the specified people.                                                     | []        |
+| immich_memories                  | Display only today’s memories.                                                                         | false     |
+| immich_favorites                 | Display only media marked as favorite.                                                                 | false     |
+| immich_resolution                | The resolution to use for loading media from immich (possible values are: `preview` / `original`).     | preview   |
 | exclude_filenames                | List of regular expressions for excluding files and directories from media sources. See [Media Sources](media-sources.md#exclude-files) for details. | []        |
 | exclude_media_types              | List of media types to exlcude media sources. See [Media Sources](media-sources.md#exclude-files) for details. | []        |
 | exclude_media_orientation        | Media orientation to exlcude. See [Media Sources](media-sources.md#exclude-files) for details.         |            |

docs/media-sources.md

@@ -225,6 +225,13 @@ immich_api_key: 0vOb7EZ7YSajUQckMt6Cbnri8Ifzo5dlD9Q5hnnXlc
 immich_memories: true
 ```
 
+Example showing immich favorites:
+```yaml
+image_url: immich+https://immich.your.domain/api
+immich_api_key: 0vOb7EZ7YSajUQckMt6Cbnri8Ifzo5dlD9Q5hnnXlc
+immich_favorites: true
+```
+
 ## Website as iframe
 You can also display a website in an iframe.
 Just add the prefix `iframe+` to the URL of the website you want to show:

wallpanel-src.js

@@ -56,6 +56,7 @@ const defaultConfig = {
 	immich_tag_names: [],
 	immich_persons: [],
 	immich_memories: false,
+	immich_favorites: false,
 	immich_resolution: "preview",
 	image_fit_landscape: "cover", // cover / contain
 	image_fit_portrait: "contain", // cover / contain
@@ -2806,6 +2807,29 @@ function initWallpanel() {
 							processAssets(memory.assets);
 						})
 					);
+				} else if (config.immich_favorites) {
+					logger.debug("Search for favorites in asset metadata");
+					let page = 1;
+					while (true) {
+						logger.debug(`Fetching asset metadata page ${page}`);
+						const searchResults = await wp._immichFetch(`${apiUrl}/search/metadata`, {
+							method: "POST",
+							body: JSON.stringify({ isFavorite: true, withExif: true, page: page, size: 1000 })
+						});
+						logger.debug("Got immich API response", searchResults);
+						if (!searchResults.assets.count) {
+							if (page == 1) {
+								const msg = "No favorite media items found in immich";
+								logger.error(msg);
+							}
+							break;
+						}
+						processAssets(searchResults.assets.items);
+						if (!searchResults.assets.nextPage) {
+							break;
+						}
+						page = searchResults.assets.nextPage;
+					}
 				} else if (config.immich_tag_names && config.immich_tag_names.length) {
 					const tagNamesLower = config.immich_tag_names.map((v) => v.toLowerCase());
 					logger.debug("Fetching immich tags");