mirror of
https://github.com/navidrome/navidrome.git
synced 2026-08-31 07:30:32 +00:00
b0c6d2e444
* initial scrobble api * feat: add scrobble retrieval api * address feedback (1) * fix spelling * be explicit about get * add primary key field, update index, remove rowid references * use unix timestamp for input and output * initial api, some testing * add tests, add count retrieval * add docs, test for rejected user * add permission validation for scrobble retriever * chore(plugins): fix typos in scrobble retriever Rename newScrobbleRetreverService, and fix FromTImestamp/nonero in the ScrobbleRetriever doc comments, which generate into the Go and Rust PDKs. Also corrects two mislabelled test entries. * fix(plugins): make scrobble pagination order deterministic Sorting only by submission_time left the order of equal timestamps up to the query planner, but the cursor skips ties by offset, so an unstable order can repeat or drop scrobbles between pages. Break ties on scrobbles.id, which the existing scrobbles_user_time index already yields for free. Descending is now honoured for every combination of From/To rather than only when both or neither is set. This changes the default for a lone ToTimestamp from newest-first to oldest-first. * refactor(plugins): return the next page's options from GetScrobbles Paging previously meant reading NextTimestamp and Cursor off the response and deciding where each belonged: NextTimestamp into FromTimestamp when ascending or ToTimestamp when descending, and Cursor copied every time, including when 0. Both are silent data-loss bugs when a plugin gets them wrong. GetScrobbles now returns the options for the following page, or nil when the range is exhausted, so a plugin passes the value straight back and repeats. ScrobbleCursor and ScrobbleList are gone; the query itself is unchanged. * docs(plugins): warn against setting ScrobbleOptions.Offset manually The all-ties carry rule assumes Offset counts already-returned rows at the boundary timestamp, which only holds for the options GetScrobbles returns. A hand-built From+Offset combination can silently skip scrobbles, so document the field as managed pagination state instead of a generic skip. * docs(plugins): document the ScrobbleRetriever host service in the README Covers the manifest permissions (including the users requirement), the four host functions, the options/ref field tables, and the pagination loop with its two gotchas: the host-managed offset and the adjusted range on the returned next options. * chore(plugins): regenerate scrobble retriever stub with nil-safe accessors --------- Co-authored-by: Deluan Quintão <deluan@navidrome.org>
62 lines
2.1 KiB
Go
62 lines
2.1 KiB
Go
// Code generated by ndpgen. DO NOT EDIT.
|
|
|
|
/*
|
|
Package host provides Navidrome Plugin Development Kit wrappers for Go/TinyGo plugins.
|
|
|
|
This package is auto-generated by the ndpgen tool and should not be edited manually.
|
|
|
|
# Usage
|
|
|
|
Add this module as a dependency in your plugin's go.mod:
|
|
|
|
require github.com/navidrome/navidrome/plugins/pdk/go/host v0.0.0
|
|
|
|
Then import the package in your plugin code:
|
|
|
|
import host "github.com/navidrome/navidrome/plugins/pdk/go/host"
|
|
|
|
func myPluginFunction() error {
|
|
// Use the cache service
|
|
_, err := host.CacheSetString("my_key", "my_value", 3600)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// Schedule a recurring task
|
|
_, err = host.SchedulerScheduleRecurring("@every 5m", "payload", "task_id")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
# Available Services
|
|
|
|
The following host services are available:
|
|
|
|
- Artwork: provides artwork public URL generation capabilities for plugins.
|
|
- Cache: provides in-memory TTL-based caching capabilities for plugins.
|
|
- Config: provides access to plugin configuration values.
|
|
- HTTP: provides outbound HTTP request capabilities for plugins.
|
|
- KVStore: provides persistent key-value storage for plugins.
|
|
- Library: provides access to music library metadata for plugins.
|
|
- Matcher: resolves externally-obtained songs to local library tracks,
|
|
- Scheduler: provides task scheduling capabilities for plugins.
|
|
- ScrobbleRetriever: allows a plugin to retrieve scrobbles for one or more authorized users.
|
|
- Storage: provides access to a plugin-specific directory with read/write permissions
|
|
- SubsonicAPI: provides access to Navidrome's Subsonic API from plugins.
|
|
- Task: provides persistent task queues for plugins.
|
|
- Users: provides access to user information for plugins.
|
|
- WebSocket: provides WebSocket communication capabilities for plugins.
|
|
|
|
# Building Plugins
|
|
|
|
Go plugins must be compiled to WebAssembly using TinyGo:
|
|
|
|
tinygo build -o plugin.wasm -target=wasip1 -buildmode=c-shared .
|
|
|
|
See the examples directory for complete plugin implementations.
|
|
*/
|
|
package host
|