Adds navigation revision & autosave specific types & endpoints

Author: oguzkocer

wp_api/src/api_client.rs

@@ -19,6 +19,12 @@ use crate::{
             },
             nav_menu_items_endpoint::{NavMenuItemsRequestBuilder, NavMenuItemsRequestExecutor},
             nav_menus_endpoint::{NavMenusRequestBuilder, NavMenusRequestExecutor},
+            navigation_autosaves_endpoint::{
+                NavigationAutosavesRequestBuilder, NavigationAutosavesRequestExecutor,
+            },
+            navigation_revisions_endpoint::{
+                NavigationRevisionsRequestBuilder, NavigationRevisionsRequestExecutor,
+            },
             navigations_endpoint::{NavigationsRequestBuilder, NavigationsRequestExecutor},
             plugins_endpoint::{PluginsRequestBuilder, PluginsRequestExecutor},
             post_autosaves_endpoint::{AutosavesRequestBuilder, AutosavesRequestExecutor},
@@ -59,6 +65,8 @@ pub struct WpApiRequestBuilder {
     nav_menu_item_autosaves: Arc<NavMenuItemAutosavesRequestBuilder>,
     nav_menu_items: Arc<NavMenuItemsRequestBuilder>,
     nav_menus: Arc<NavMenusRequestBuilder>,
+    navigation_autosaves: Arc<NavigationAutosavesRequestBuilder>,
+    navigation_revisions: Arc<NavigationRevisionsRequestBuilder>,
     navigations: Arc<NavigationsRequestBuilder>,
     plugins: Arc<PluginsRequestBuilder>,
     post_revisions: Arc<PostRevisionsRequestBuilder>,
@@ -95,6 +103,8 @@ impl WpApiRequestBuilder {
             nav_menu_item_autosaves,
             nav_menu_items,
             nav_menus,
+            navigation_autosaves,
+            navigation_revisions,
             navigations,
             plugins,
             post_revisions,
@@ -141,6 +151,8 @@ pub struct WpApiClient {
     nav_menu_item_autosaves: Arc<NavMenuItemAutosavesRequestExecutor>,
     nav_menu_items: Arc<NavMenuItemsRequestExecutor>,
     nav_menus: Arc<NavMenusRequestExecutor>,
+    navigation_autosaves: Arc<NavigationAutosavesRequestExecutor>,
+    navigation_revisions: Arc<NavigationRevisionsRequestExecutor>,
     navigations: Arc<NavigationsRequestExecutor>,
     plugins: Arc<PluginsRequestExecutor>,
     post_revisions: Arc<PostRevisionsRequestExecutor>,
@@ -174,6 +186,8 @@ impl WpApiClient {
             nav_menu_item_autosaves,
             nav_menu_items,
             nav_menus,
+            navigation_autosaves,
+            navigation_revisions,
             navigations,
             plugins,
             post_revisions,
@@ -217,6 +231,8 @@ api_client_generate_endpoint_impl!(WpApi, menu_locations);
 api_client_generate_endpoint_impl!(WpApi, nav_menu_item_autosaves);
 api_client_generate_endpoint_impl!(WpApi, nav_menu_items);
 api_client_generate_endpoint_impl!(WpApi, nav_menus);
+api_client_generate_endpoint_impl!(WpApi, navigation_autosaves);
+api_client_generate_endpoint_impl!(WpApi, navigation_revisions);
 api_client_generate_endpoint_impl!(WpApi, navigations);
 api_client_generate_endpoint_impl!(WpApi, plugins);
 api_client_generate_endpoint_impl!(WpApi, post_revisions);

wp_api/src/lib.rs

@@ -22,6 +22,7 @@ pub mod middleware;
 pub mod nav_menu_item_revisions;
 pub mod nav_menu_items;
 pub mod nav_menus;
+pub mod navigation_revisions;
 pub mod navigations;
 pub mod parsed_url;
 pub mod plugins;

wp_api/src/navigation_revisions.rs

@@ -0,0 +1,111 @@
+use crate::{
+    UserId, WpApiParamOrder,
+    date::WpGmtDateTime,
+    impl_as_query_value_from_to_string,
+    navigations::NavigationId,
+    url_query::{
+        AppendUrlQueryPairs, FromUrlQueryPairs, QueryPairs, QueryPairsExtension, UrlQueryPairsMap,
+    },
+    wp_content_i64_id,
+};
+use serde::{Deserialize, Serialize};
+use wp_contextual::WpContextual;
+use wp_derive::WpDeriveParamsField;
+
+wp_content_i64_id!(NavigationRevisionId);
+
+#[derive(
+    Debug,
+    Default,
+    Clone,
+    Copy,
+    PartialEq,
+    Eq,
+    uniffi::Enum,
+    strum_macros::EnumString,
+    strum_macros::Display,
+)]
+#[strum(serialize_all = "snake_case")]
+pub enum WpApiParamNavigationRevisionsOrderBy {
+    #[default]
+    Date,
+    Id,
+    Include,
+    IncludeSlugs,
+    Relevance,
+    Slug,
+    Title,
+}
+
+impl_as_query_value_from_to_string!(WpApiParamNavigationRevisionsOrderBy);
+
+#[derive(Debug, Default, PartialEq, Eq, uniffi::Record, WpDeriveParamsField)]
+#[supports_pagination(true)]
+pub struct NavigationRevisionListParams {
+    /// Current page of the collection.
+    /// Default: `1`
+    #[uniffi(default = None)]
+    pub page: Option<u32>,
+    /// Maximum number of items to be returned in result set.
+    #[uniffi(default = None)]
+    pub per_page: Option<u32>,
+    /// Limit results to those matching a string.
+    #[uniffi(default = None)]
+    pub search: Option<String>,
+    /// Ensure result set excludes specific IDs.
+    #[uniffi(default = [])]
+    pub exclude: Vec<NavigationRevisionId>,
+    /// Limit result set to specific IDs.
+    #[uniffi(default = [])]
+    pub include: Vec<NavigationRevisionId>,
+    /// Offset the result set by a specific number of items.
+    #[uniffi(default = None)]
+    pub offset: Option<u32>,
+    /// Order sort attribute ascending or descending.
+    /// Default: desc
+    /// One of: asc, desc
+    #[uniffi(default = None)]
+    pub order: Option<WpApiParamOrder>,
+    /// Sort collection by object attribute.
+    /// Default: date
+    /// One of: date, id, include, relevance, slug, include_slugs, title
+    #[uniffi(default = None)]
+    #[field_name("orderby")]
+    pub orderby: Option<WpApiParamNavigationRevisionsOrderBy>,
+}
+
+#[derive(Debug, Serialize, Deserialize, uniffi::Record, WpContextual)]
+pub struct SparseNavigationRevision {
+    #[WpContext(edit, embed, view)]
+    pub id: Option<NavigationRevisionId>,
+    #[WpContext(edit, embed, view)]
+    pub author: Option<UserId>,
+    #[WpContext(edit, embed, view)]
+    pub date: Option<String>,
+    #[WpContext(edit, view)]
+    pub date_gmt: Option<WpGmtDateTime>,
+    #[WpContext(edit, view)]
+    pub modified: Option<String>,
+    #[WpContext(edit, view)]
+    pub modified_gmt: Option<WpGmtDateTime>,
+    #[WpContext(edit, embed, view)]
+    pub parent: Option<NavigationId>,
+    #[WpContext(edit, embed, view)]
+    pub slug: Option<String>,
+    #[WpContext(edit, view)]
+    #[WpContextualField]
+    pub guid: Option<crate::navigations::SparseNavigationGuid>,
+    #[WpContext(edit, embed, view)]
+    #[WpContextualField]
+    pub title: Option<crate::navigations::SparseNavigationTitle>,
+    #[WpContext(edit, view)]
+    #[WpContextualField]
+    pub content: Option<crate::navigations::SparseNavigationContent>,
+    // meta field omitted for now
+}
+
+#[derive(Debug, Serialize, Deserialize, uniffi::Record)]
+pub struct NavigationRevisionDeleteResponse {
+    pub deleted: bool,
+    pub previous: NavigationRevisionWithEditContext,
+}

wp_api/src/request/endpoint.rs

@@ -11,6 +11,8 @@ pub mod menu_locations_endpoint;
 pub mod nav_menu_item_autosaves_endpoint;
 pub mod nav_menu_items_endpoint;
 pub mod nav_menus_endpoint;
+pub mod navigation_autosaves_endpoint;
+pub mod navigation_revisions_endpoint;
 pub mod navigations_endpoint;
 pub mod plugins_endpoint;
 pub mod post_autosaves_endpoint;

wp_api/src/request/endpoint/navigation_autosaves_endpoint.rs

@@ -0,0 +1,19 @@
+use super::{AsNamespace, DerivedRequest, WpNamespace};
+use crate::{navigation_revisions::NavigationRevisionId, navigations::NavigationId};
+use wp_derive_request_builder::WpDerivedRequest;
+
+#[derive(WpDerivedRequest)]
+enum NavigationAutosavesRequest {
+    #[contextual_get(url = "/navigation/<navigation_id>/autosaves", output = Vec<crate::navigation_revisions::SparseNavigationRevision>, filter_by = crate::navigation_revisions::SparseNavigationRevisionField)]
+    List,
+    #[contextual_get(url = "/navigation/<navigation_id>/autosaves/<navigation_revision_id>", output = crate::navigation_revisions::SparseNavigationRevision, filter_by = crate::navigation_revisions::SparseNavigationRevisionField)]
+    Retrieve,
+    #[post(url = "/navigation/<navigation_id>/autosaves", params = &crate::navigations::NavigationCreateParams, output = crate::navigation_revisions::NavigationRevisionWithEditContext)]
+    Create,
+}
+
+impl DerivedRequest for NavigationAutosavesRequest {
+    fn namespace() -> impl AsNamespace {
+        WpNamespace::WpV2
+    }
+}

wp_api/src/request/endpoint/navigation_revisions_endpoint.rs

@@ -0,0 +1,29 @@
+use super::{AsNamespace, DerivedRequest, WpNamespace};
+use crate::{
+    navigation_revisions::{NavigationRevisionId, NavigationRevisionListParams},
+    navigations::NavigationId,
+};
+use wp_derive_request_builder::WpDerivedRequest;
+
+#[derive(WpDerivedRequest)]
+enum NavigationRevisionsRequest {
+    #[contextual_paged(url = "/navigation/<navigation_id>/revisions", params = &NavigationRevisionListParams, output = Vec<crate::navigation_revisions::SparseNavigationRevision>, filter_by = crate::navigation_revisions::SparseNavigationRevisionField)]
+    List,
+    #[contextual_get(url = "/navigation/<navigation_id>/revisions/<navigation_revision_id>", output = crate::navigation_revisions::SparseNavigationRevision, filter_by = crate::navigation_revisions::SparseNavigationRevisionField)]
+    Retrieve,
+    #[delete(url = "/navigation/<navigation_id>/revisions/<navigation_revision_id>", output = crate::navigation_revisions::NavigationRevisionDeleteResponse)]
+    Delete,
+}
+
+impl DerivedRequest for NavigationRevisionsRequest {
+    fn namespace() -> impl AsNamespace {
+        WpNamespace::WpV2
+    }
+
+    fn additional_query_pairs(&self) -> Vec<(&str, String)> {
+        match self {
+            NavigationRevisionsRequest::Delete => vec![("force", "true".to_string())],
+            _ => vec![],
+        }
+    }
+}

wp_api_integration_tests/tests/test_navigation_autosaves_err.rs

@@ -1,16 +1,15 @@
 use wp_api::{
-    post_revisions::PostRevisionId,
-    posts::{PostCreateParams, PostId},
-    request::endpoint::posts_endpoint::PostEndpointType,
+    navigation_revisions::NavigationRevisionId,
+    navigations::{NavigationCreateParams, NavigationId},
 };
 use wp_api_integration_tests::prelude::*;
 
 #[tokio::test]
 #[parallel]
 async fn list_err_post_invalid_parent() {
     api_client()
-        .autosaves()
-        .list_with_edit_context(&PostEndpointType::Navigation, &PostId(99999999))
+        .navigation_autosaves()
+        .list_with_edit_context(&NavigationId(99999999))
         .await
         .assert_wp_error(WpErrorCode::PostInvalidParent)
 }
@@ -19,8 +18,8 @@ async fn list_err_post_invalid_parent() {
 #[parallel]
 async fn list_err_cannot_read_as_subscriber() {
     api_client_as_subscriber()
-        .autosaves()
-        .list_with_edit_context(&PostEndpointType::Navigation, &autosaved_navigation_id())
+        .navigation_autosaves()
+        .list_with_edit_context(&autosaved_navigation_id())
         .await
         .assert_wp_error(WpErrorCode::CannotRead)
 }
@@ -29,12 +28,8 @@ async fn list_err_cannot_read_as_subscriber() {
 #[parallel]
 async fn retrieve_err_post_invalid_parent() {
     api_client()
-        .autosaves()
-        .retrieve_with_edit_context(
-            &PostEndpointType::Navigation,
-            &PostId(99999999),
-            &PostRevisionId(1),
-        )
+        .navigation_autosaves()
+        .retrieve_with_edit_context(&NavigationId(99999999), &NavigationRevisionId(1))
         .await
         .assert_wp_error(WpErrorCode::PostInvalidParent)
 }
@@ -43,11 +38,10 @@ async fn retrieve_err_post_invalid_parent() {
 #[parallel]
 async fn retrieve_err_post_no_autosave() {
     api_client()
-        .autosaves()
+        .navigation_autosaves()
         .retrieve_with_edit_context(
-            &PostEndpointType::Navigation,
-            &PostId(TestCredentials::instance().navigation_id),
-            &PostRevisionId(1),
+            &NavigationId(TestCredentials::instance().navigation_id),
+            &NavigationRevisionId(1),
         )
         .await
         .assert_wp_error(WpErrorCode::PostNoAutosave)
@@ -57,9 +51,8 @@ async fn retrieve_err_post_no_autosave() {
 #[parallel]
 async fn retrieve_err_cannot_read_as_subscriber() {
     api_client_as_subscriber()
-        .autosaves()
+        .navigation_autosaves()
         .retrieve_with_edit_context(
-            &PostEndpointType::Navigation,
             &autosaved_navigation_id(),
             &autosave_id_for_autosaved_navigation_id(),
         )
@@ -71,12 +64,8 @@ async fn retrieve_err_cannot_read_as_subscriber() {
 #[parallel]
 async fn create_err_post_invalid_id() {
     api_client()
-        .autosaves()
-        .create(
-            &PostEndpointType::Navigation,
-            &PostId(99999999),
-            &PostCreateParams::default(),
-        )
+        .navigation_autosaves()
+        .create(&NavigationId(99999999), &NavigationCreateParams::default())
         .await
         .assert_wp_error(WpErrorCode::PostInvalidId)
 }
@@ -85,20 +74,16 @@ async fn create_err_post_invalid_id() {
 #[parallel]
 async fn create_err_cannot_edit_as_subscriber() {
     api_client_as_subscriber()
-        .autosaves()
-        .create(
-            &PostEndpointType::Navigation,
-            &autosaved_navigation_id(),
-            &PostCreateParams::default(),
-        )
+        .navigation_autosaves()
+        .create(&autosaved_navigation_id(), &NavigationCreateParams::default())
         .await
         .assert_wp_error(WpErrorCode::CannotEdit)
 }
 
-fn autosaved_navigation_id() -> PostId {
-    PostId(TestCredentials::instance().autosaved_navigation_id)
+fn autosaved_navigation_id() -> NavigationId {
+    NavigationId(TestCredentials::instance().autosaved_navigation_id)
 }
 
-fn autosave_id_for_autosaved_navigation_id() -> PostRevisionId {
-    PostRevisionId(TestCredentials::instance().autosave_id_for_autosaved_navigation_id)
+fn autosave_id_for_autosaved_navigation_id() -> NavigationRevisionId {
+    NavigationRevisionId(TestCredentials::instance().autosave_id_for_autosaved_navigation_id)
 }