Skip to content

Conversation

@soderlind
Copy link
Owner

This pull request updates the documentation and changelog to reflect a major shift in WP Loupe's focus toward a developer-first, API-driven search experience. The bundled UI (blocks, shortcodes, and form overrides) has been removed, and the recommended integration method is now via the REST API, allowing developers to build custom search UIs. The documentation has been streamlined to match this new approach, and new features and fixes are highlighted for the upcoming 0.7.0 release.

Key changes:

API and Feature Updates:

  • Added a developer-first REST Search API, including advanced POST /wp-json/wp-loupe/v1/search endpoint supporting JSON filters, facets, geo queries, and explicit sorting. [1] [2] [3]
  • Introduced an override hook for meta-field sortability and improved support for geo-point meta fields, enabling geo distance sorting when stored as post meta.

Documentation and Guide Revisions:

  • Updated the README.md to focus on building custom search UIs via the REST API, removing references to bundled UI features and blocks, and reorganizing quick links and feature lists to highlight API usage. [1] [2] [3] [4]
  • Added a Search API guide with hook-based field preparation examples (facets, geo, sorting).

Removal of Bundled UI:

  • Removed documentation and references for the bundled block, shortcode, and search form override UI. The plugin no longer provides a pre-built front-end UI; developers are encouraged to build their own using the API. [1] [2] [3] [4] [5] [6]

Changelog and Versioning:

  • Updated CHANGELOG.md for version 0.7.0, summarizing added features, fixes, and the removal of bundled UI integration. Also reorganized release tag references for clarity. [1] [2]

Tutorial and Internal Docs:

  • Revised tutorial chapters and diagrams to remove block/form integration steps and references, focusing instead on REST API integration and backend extensibility. [1] [2] [3] [4] [5] [6]

- Removed the `block-search-variation.js` file as the block editor integration is no longer included in the plugin. This change simplifies the codebase and focuses on the core search functionality.

- Updated version numbers in `package.json`, `package-lock.json`, `readme.txt`, and `wp-loupe.php` to reflect the new version 0.7.0.

- Enhanced the documentation with a new `search-api.md` file that provides a comprehensive guide on the WP Loupe Search API, including endpoints, request/response structures, and examples for both client-side and server-side implementations.

- Added new tests in `WP_Loupe_Factory_GeoSortableTest.php` and `WP_Loupe_REST_SearchPostTest.php` to ensure the correct behavior of geo-point fields and the REST search functionality, including validation of payloads and error handling.

- Updated the changelog in `readme.txt` to document the new features, fixes, and changes introduced in this release, including the addition of a Search API guide and improvements to field preparation for sorting and filtering.

- Adjusted the linting and formatting scripts in `package.json` to remove references to the deleted `block-search-variation.js` file, ensuring that the build process remains clean and efficient.
@soderlind soderlind merged commit e2c722b into main Dec 18, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants