/pages endpoints (#885)

Author: oguzkocer

native/swift/Example/Example/ExampleApp.swift

@@ -4,6 +4,7 @@ import Combine
 
 private let userListParams = UserListParams(perPage: 5)
 private let postListParams = PostListParams(perPage: 5)
+private let pageListParams = PageListParams(perPage: 5)
 private let mediaListParams = MediaListParams(perPage: 5)
 
 @main
@@ -38,6 +39,10 @@ struct ExampleApp: App {
             let sequence = try await WordPressAPI.globalInstance.posts.sequenceWithEditContext(params: postListParams)
             return ListViewSequence(underlyingSequence: sequence)
         }),
+        RootListData(name: "Pages", sequence: {
+            let sequence = try await WordPressAPI.globalInstance.pages.sequenceWithEditContext(params: pageListParams)
+            return ListViewSequence(underlyingSequence: sequence)
+        }),
         RootListData(name: "Media", sequence: {
             let sequence = try await WordPressAPI.globalInstance.media.sequenceWithEditContext(params: mediaListParams)
             return ListViewSequence(underlyingSequence: sequence)

native/swift/Example/Example/ListViewData.swift

@@ -137,6 +137,12 @@ extension PostWithEditContext: ListViewDataConvertable {
     }
 }
 
+extension PageWithEditContext: ListViewDataConvertable {
+    var asListViewData: ListViewData {
+        ListViewData(id: self.slug, title: self.title.rendered, subtitle: "", fields: [:])
+    }
+}
+
 extension MediaWithEditContext: ListViewDataConvertable {
     var asListViewData: ListViewData {
         let details = self.mediaDetails.parseAsMimeType(mimeType: self.mimeType)

native/swift/Sources/wordpress-api/Exports.swift

@@ -105,6 +105,18 @@ public typealias PostsRequestListWithEditContextResponse = WordPressAPIInternal.
 public typealias PostsRequestListWithViewContextResponse = WordPressAPIInternal.PostsRequestListWithViewContextResponse
 public typealias PostsRequestListWithEmbedContextResponse = WordPressAPIInternal.PostsRequestListWithEmbedContextResponse
 
+// MARK: - Pages
+public typealias SparsePage = WordPressAPIInternal.SparsePage
+public typealias PageWithEditContext = WordPressAPIInternal.PageWithEditContext
+public typealias PageWithViewContext = WordPressAPIInternal.PageWithViewContext
+public typealias PageWithEmbedContext = WordPressAPIInternal.PageWithEmbedContext
+public typealias PageListParams = WordPressAPIInternal.PageListParams
+public typealias PagesRequestExecutor = WordPressAPIInternal.PagesRequestExecutor
+
+public typealias PagesRequestListWithEditContextResponse = WordPressAPIInternal.PagesRequestListWithEditContextResponse
+public typealias PagesRequestListWithViewContextResponse = WordPressAPIInternal.PagesRequestListWithViewContextResponse
+public typealias PagesRequestListWithEmbedContextResponse = WordPressAPIInternal.PagesRequestListWithEmbedContextResponse
+
 // MARK: - Media
 public typealias SparseMedia = WordPressAPIInternal.SparseMedia
 public typealias MediaUploadRequest = WordPressAPIInternal.MediaUploadRequest

native/swift/Sources/wordpress-api/Pagination.swift

@@ -205,6 +205,28 @@ extension PostsRequestExecutor: PaginationAwareExecutor {
     public typealias EmbedContextResponseType = PostsRequestListWithEmbedContextResponse
 }
 
+// MARK: - Pages
+extension PagesRequestListWithEditContextResponse: PaginatableResponse {
+    public typealias ParamsType = PageListParams
+    public typealias DataType = PageWithEditContext
+}
+
+extension PagesRequestListWithViewContextResponse: PaginatableResponse {
+    public typealias ParamsType = PageListParams
+    public typealias DataType = PageWithViewContext
+}
+
+extension PagesRequestListWithEmbedContextResponse: PaginatableResponse {
+    public typealias ParamsType = PageListParams
+    public typealias DataType = PageWithEmbedContext
+}
+
+extension PagesRequestExecutor: PaginationAwareExecutor {
+    public typealias EditContextResponseType = PagesRequestListWithEditContextResponse
+    public typealias ViewContextResponseType = PagesRequestListWithViewContextResponse
+    public typealias EmbedContextResponseType = PagesRequestListWithEmbedContextResponse
+}
+
 // MARK: - Media
 extension MediaRequestListWithEditContextResponse: PaginatableResponse, @unchecked Sendable {
     public typealias ParamsType = MediaListParams

native/swift/Sources/wordpress-api/WordPressAPI.swift

@@ -117,6 +117,10 @@ public actor WordPressAPI {
         self.requestBuilder.posts()
     }
 
+    public var pages: PagesRequestExecutor {
+        self.requestBuilder.pages()
+    }
+
     public var comments: CommentsRequestExecutor {
         self.requestBuilder.comments()
     }

scripts/setup-test-site.sh

@@ -131,6 +131,11 @@ create_test_credentials () {
   PASSWORD_PROTECTED_POST_ID="$(wp post create --post_type=post --post_password=INTEGRATION_TEST --post_title=Password_Protected --porcelain)"
   TRASHED_POST_ID="$(wp post create --post_type=post --post_title=Trashed_Post --porcelain)"
 
+  # Create test pages
+  PASSWORD_PROTECTED_PAGE_ID="$(wp post create --post_type=page --post_password=INTEGRATION_TEST --post_title=Password_Protected_Page --porcelain)"
+  TRASHED_PAGE_ID="$(wp post create --post_type=page --post_title=Trashed_Page --porcelain)"
+  FIRST_PAGE_ID="$(wp post list --post_type=page --posts_per_page=1 --orderby=ID --order=ASC --format=ids)"
+
   PASSWORD_PROTECTED_COMMENT_AUTHOR="setup-test-site.sh"
   PASSWORD_PROTECTED_COMMENT_ID="$(wp comment create --comment_post_ID="$PASSWORD_PROTECTED_POST_ID" --comment_content="test_comment_for_password_protected_post" --comment_author="$PASSWORD_PROTECTED_COMMENT_AUTHOR" --porcelain)"
 
@@ -140,8 +145,9 @@ create_test_credentials () {
 
   INTEGRATION_TEST_CUSTOM_TEMPLATE_SLUG="integration_test_custom_template"
 
-  # Trash the post
+  # Trash the post and page
   wp post delete "$TRASHED_POST_ID"
+  wp post delete "$TRASHED_PAGE_ID"
 
   echo "Creating a custom template for integration tests.."
   curl --silent --user "$ADMIN_USERNAME":"$ADMIN_PASSWORD" -H "Content-Type: application/json" -d '{"slug":"INTEGRATION_TEST_CUSTOM_TEMPLATE", "content": "Integration test custom template content"}' http://localhost/wp-json/wp/v2/templates > /dev/null
@@ -193,6 +199,11 @@ create_test_credentials () {
     revision_id_for_revisioned_post_id="$REVISION_ID_FOR_REVISIONED_POST_ID" \
     autosaved_post_id="$AUTOSAVED_POST_ID" \
     autosave_id_for_autosaved_post_id="$AUTOSAVE_ID_FOR_AUTOSAVED_POST_ID" \
+    password_protected_page_id="$PASSWORD_PROTECTED_PAGE_ID" \
+    password_protected_page_password="INTEGRATION_TEST" \
+    password_protected_page_title="Password_Protected_Page" \
+    trashed_page_id="$TRASHED_PAGE_ID" \
+    first_page_id="$FIRST_PAGE_ID" \
     > /app/test_credentials.json
 }
 create_test_credentials

wp_api/src/api_client.rs

@@ -13,6 +13,7 @@ use crate::{
             categories_endpoint::{CategoriesRequestBuilder, CategoriesRequestExecutor},
             comments_endpoint::{CommentsRequestBuilder, CommentsRequestExecutor},
             media_endpoint::{MediaRequestBuilder, MediaRequestExecutor},
+            pages_endpoint::{PagesRequestBuilder, PagesRequestExecutor},
             plugins_endpoint::{PluginsRequestBuilder, PluginsRequestExecutor},
             post_autosaves_endpoint::{AutosavesRequestBuilder, AutosavesRequestExecutor},
             post_revisions_endpoint::{PostRevisionsRequestBuilder, PostRevisionsRequestExecutor},
@@ -59,6 +60,7 @@ pub struct WpApiRequestBuilder {
     categories: Arc<CategoriesRequestBuilder>,
     comments: Arc<CommentsRequestBuilder>,
     media: Arc<MediaRequestBuilder>,
+    pages: Arc<PagesRequestBuilder>,
     plugins: Arc<PluginsRequestBuilder>,
     post_revisions: Arc<PostRevisionsRequestBuilder>,
     post_types: Arc<PostTypesRequestBuilder>,
@@ -88,6 +90,7 @@ impl WpApiRequestBuilder {
             categories,
             comments,
             media,
+            pages,
             plugins,
             post_revisions,
             post_types,
@@ -127,6 +130,7 @@ pub struct WpApiClient {
     categories: Arc<CategoriesRequestExecutor>,
     comments: Arc<CommentsRequestExecutor>,
     media: Arc<MediaRequestExecutor>,
+    pages: Arc<PagesRequestExecutor>,
     plugins: Arc<PluginsRequestExecutor>,
     post_revisions: Arc<PostRevisionsRequestExecutor>,
     post_types: Arc<PostTypesRequestExecutor>,
@@ -153,6 +157,7 @@ impl WpApiClient {
             categories,
             comments,
             media,
+            pages,
             plugins,
             post_revisions,
             post_types,
@@ -189,6 +194,7 @@ api_client_generate_endpoint_impl!(WpApi, autosaves);
 api_client_generate_endpoint_impl!(WpApi, categories);
 api_client_generate_endpoint_impl!(WpApi, comments);
 api_client_generate_endpoint_impl!(WpApi, media);
+api_client_generate_endpoint_impl!(WpApi, pages);
 api_client_generate_endpoint_impl!(WpApi, plugins);
 api_client_generate_endpoint_impl!(WpApi, post_revisions);
 api_client_generate_endpoint_impl!(WpApi, post_types);

wp_api/src/lib.rs

@@ -19,6 +19,7 @@ pub mod date;
 pub mod login;
 pub mod media;
 pub mod middleware;
+pub mod pages;
 pub mod parsed_url;
 pub mod plugins;
 pub mod post_revisions;