mirror of
https://github.com/navidrome/navidrome.git
synced 2026-10-30 06:57:57 +01: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>
149 lines
4.2 KiB
Rust
149 lines
4.2 KiB
Rust
// Code generated by ndpgen. DO NOT EDIT.
|
|
//
|
|
//! Navidrome Host Function Wrappers for Rust Plugins
|
|
//!
|
|
//! This crate provides idiomatic Rust wrappers for all Navidrome host services.
|
|
//! It is auto-generated by the ndpgen tool and should not be edited manually.
|
|
//!
|
|
//! # Usage
|
|
//!
|
|
//! Add this crate as a dependency in your plugin's Cargo.toml:
|
|
//!
|
|
//! ```toml
|
|
//! [dependencies]
|
|
//! nd-host = { path = "../../host/rust" }
|
|
//! ```
|
|
//!
|
|
//! Then import the services you need:
|
|
//!
|
|
//! ```ignore
|
|
//! use nd_host::{cache, scheduler};
|
|
//!
|
|
//! fn my_plugin_function() -> Result<(), extism_pdk::Error> {
|
|
//! // Use the cache service
|
|
//! cache::set_string("my_key", "my_value", 3600)?;
|
|
//!
|
|
//! // Schedule a recurring task
|
|
//! scheduler::schedule_recurring("@every 5m", "payload", "task_id")?;
|
|
//!
|
|
//! Ok(())
|
|
//! }
|
|
//! ```
|
|
//!
|
|
//! # Available Services
|
|
//!
|
|
//! - [`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.
|
|
|
|
#[doc(hidden)]
|
|
mod nd_host_artwork;
|
|
/// provides artwork public URL generation capabilities for plugins.
|
|
pub mod artwork {
|
|
pub use super::nd_host_artwork::*;
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
mod nd_host_cache;
|
|
/// provides in-memory TTL-based caching capabilities for plugins.
|
|
pub mod cache {
|
|
pub use super::nd_host_cache::*;
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
mod nd_host_config;
|
|
/// provides access to plugin configuration values.
|
|
pub mod config {
|
|
pub use super::nd_host_config::*;
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
mod nd_host_http;
|
|
/// provides outbound HTTP request capabilities for plugins.
|
|
pub mod http {
|
|
pub use super::nd_host_http::*;
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
mod nd_host_kvstore;
|
|
/// provides persistent key-value storage for plugins.
|
|
pub mod kvstore {
|
|
pub use super::nd_host_kvstore::*;
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
mod nd_host_library;
|
|
/// provides access to music library metadata for plugins.
|
|
pub mod library {
|
|
pub use super::nd_host_library::*;
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
mod nd_host_matcher;
|
|
/// resolves externally-obtained songs to local library tracks,
|
|
pub mod matcher {
|
|
pub use super::nd_host_matcher::*;
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
mod nd_host_scheduler;
|
|
/// provides task scheduling capabilities for plugins.
|
|
pub mod scheduler {
|
|
pub use super::nd_host_scheduler::*;
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
mod nd_host_scrobbleretriever;
|
|
/// allows a plugin to retrieve scrobbles for one or more authorized users.
|
|
pub mod scrobbleretriever {
|
|
pub use super::nd_host_scrobbleretriever::*;
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
mod nd_host_storage;
|
|
/// provides access to a plugin-specific directory with read/write permissions
|
|
pub mod storage {
|
|
pub use super::nd_host_storage::*;
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
mod nd_host_subsonicapi;
|
|
/// provides access to Navidrome's Subsonic API from plugins.
|
|
pub mod subsonicapi {
|
|
pub use super::nd_host_subsonicapi::*;
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
mod nd_host_task;
|
|
/// provides persistent task queues for plugins.
|
|
pub mod task {
|
|
pub use super::nd_host_task::*;
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
mod nd_host_users;
|
|
/// provides access to user information for plugins.
|
|
pub mod users {
|
|
pub use super::nd_host_users::*;
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
mod nd_host_websocket;
|
|
/// provides WebSocket communication capabilities for plugins.
|
|
pub mod websocket {
|
|
pub use super::nd_host_websocket::*;
|
|
}
|
|
|
|
// Re-export commonly used types from extism-pdk for convenience
|
|
pub use extism_pdk::Error;
|