CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file, per the Keep a Changelog standard, and will adhere to Semantic Versioning.

Unreleased - TBD

1.3.2 - 2023-06-16

Changed

• Bump WordPress "tested up to" version 6.2 (props @iamdharmesh, @Sidsector9 via #384).

Security

• Update dependency phpunit/phpunit from 9.5.25 to 9.5.27 (props @renovate, @jeffpaul via #349, #369).
• Update dependency 10up-toolkit from 4.3.0.to 4.3.1 (props @renovate, @jeffpaul via #366).
• Update dependency loader-utils from 2.0.2 to 2.0.4 (props @dependabot, @jeffpaul via #367).
• Update dependency actions/checkout from 3.1.0 to 3.5.3 (props @renovate, @jeffpaul, @iamdharmesh via #370, #375).
• Update dependency @wordpress/icons from 9.10.0 to 9.14.0 (props @renovate, @jeffpaul via #344).
• Update dependency snowplow/snowplow-tracker from 0.5.0 to 0.6.1 (props @renovate, @jeffpaul, @YMufleh via #372).
• Update dependency json5 from 1.0.1 to 1.0.2 (props @renovate, @iamdharmesh via #374).
• Update dependency dns-packet from 5.3.1 to 5.6.0 (props @renovate, @iamdharmesh via #385).
• Update dependency webpack from 5.72.1 to 5.87.0 (props @renovate, @iamdharmesh via #386).

1.3.1 - 2022-11-10

Changed

• Mapping for sectionNames field to reflect Primary Category or first Category (props @Sidsector9, @cadic, @jeffpaul, @vjayaseelan90, @dkotter via #350, #363).
• Update our configured check to be smarter (props @dkotter, @vjayaseelan90, @jeffpaul via #361).

Removed

• Comment out the override settings for now (props @dkotter, @jeffpaul via #362).

Fixed

• Ensure we have an array of items before iterating over them (props @dkotter, @jeffpaul via #362).
• Ensure we send tracking events when the Yoast featured category data is saved (props @dkotter, @jeffpaul via #365).

1.3.0 - 2022-10-28

Note that this version bumps the minimum WordPress version from 5.6 to 6.0 and adds an integration with the Sophi Override feature.

Added

• Override feature to the Sophi Site Automation Block (props @faisal-alvi, @jeffpaul, @fabiankaegy, @dkotter, @peterwilsoncc via #333, #345).
• [GET] /wp-json/sophi/v1/site-automation WP REST endpoint to Get Posts from Site Automation (props @faisal-alvi, @jeffpaul, @fabiankaegy, @dkotter, @peterwilsoncc via #333).
• [POST] /wp-json/sophi/v1/site-automation-override WP REST endpoint to Override the Posts for Site Automation (props @faisal-alvi, @jeffpaul, @fabiankaegy, @dkotter, @peterwilsoncc via #333).
• api_version to the block JSON files (props @faisal-alvi via #345).
• Display message when no posts are returned from Sophi Site Automation (props @faisal-alvi via #345).
• Functionality to remove old error messages when posts are found (props @faisal-alvi via #345).
• Tracker Address option on plugin settings page (props @faisal-alvi, @YMufleh, @jeffpaul via #342).
• New tutorial for modifying tracking data on documentation site (props @iamdharmesh, @YMufleh, @dkotter via #327).

Changed

• Bump minimum WordPress version from 5.6 to 6.0 (props @faisal-alvi via #346).
• Sophi Site Automation Block from a server-side-rendered custom block to a nested block (props @faisal-alvi, @jeffpaul, @fabiankaegy, @dkotter, @peterwilsoncc via #333, #345).
• Replaced hardcoded tracker endpoint value with the new Tracker Address setting (props @faisal-alvi, @YMufleh, @jeffpaul via #342).
• Developer Documentation updates (props @iamdharmesh, @jeffpaul, @faisal-alvi via #332, #333).

Fixed

• Prevent duplicate CMS publish/update event tracking (props @cadic, @peterwilsoncc, @jeffpaul via #335).

Security

• Added latest PHPCompatibility checks for PHP 8.0 (props @Sidsector9 via #331).
• Update dependency phpunit/phpunit from 8.5.29 to 9.5.25 (props @renovate, @Sidsector9, @faisal-alvi via #329, #337, #339).
• Update dependency 10up-toolkit from 4.1.2 to 4.3.0 (props @renovate, @Sidsector9, @faisal-alvi via #330, #340).
• Update actions/checkout action from v2 to v3 and v3.0.2 to v3.1.0 (props @renovate via #334).

1.2.1 - 2022-08-30

Changed

• Bump content_update schema from 2-0-3 to 2-0-5 (props @jeffpaul, @vjayaseelan90, @YMufleh via #323).

Security

• Update dependency jsdoc from 3.6.10 to 3.6.11 (props @renovate via #311).
• Bump terser from 5.13.1 to 5.14.2 (props @dependabot via #312).
• Update dependency phpunit/phpunit from 8.5.27 to 8.5.29 (props @renovate via #316).

1.2.0 - 2022-08-15

Added

• New Curator API (props @Sidsector9, @dinhtungdu via #310.
• Documentation on default handling of Sophi API empty array response (props @jeffpaul, @oscarssanchez via #307.
• New tutorial sections added to the documentation site (props @dkotter, @YMufleh via #318.

Changed

• Instead of storing responses from Sophi in an option, store that in a new CPT, sophi-response (props @oscarssanchez, @cadic, @felipeelia via #298.
• Replaces WP_Query with get_posts in details about the Sophi Automation block (props @Sidsector9, @jeffpaul via #300.

Removed

• Dependency on Auth0 and replaced with the new Curator API (props @Sidsector9, @dinhtungdu via #310.

Fixed

• Ensure we are properly getting cached responses (props @oscarssanchez, @Sidsector9, @felipeelia via #305.

Security

• Added PHP compatibility checker (props @Sidsector9, @dkotter via #317.
• Update dependency 10up-toolkit from v4.0.0 to v4.1.2 (props @renovate, @Sidsector9 via #299, #303.
• Update dependency phpunit/phpunit from v8.5.26 to v8.5.27 (props @renovate via #304.

1.1.3 - 2022-05-27

Added

• WordPress and Sophi plugin versions to Javascript and AMP Tracking (props @oscarssanchez, @jeffpaul, @YMufleh via #287).
• Documentation for sophi_cache_duration filter (props @Sidsector9, @barryceelen, @jeffpaul via #285).
• Unit tests (props @cadic via #291).

Changed

• Reverted response saving back to options table from post meta field (props @oscarssanchez via #280).
• Replace deprecated block_categories filter with block_categories_all (props @Sidsector9, @cadic, @jeffpaul via #292).
• Bump WordPress "tested up to" version 6.0 (props @Sidsector9, @jeffpaul via #293).

Fixed

• Fatal error on tracking a post with empty content (props @cadic via #289).
• Warning shown due to access of undefined array (props @Sidsector9, @cadic, @jeffpaul via #292).
• Warning on Widget page via check before accessing property (props @Sidsector9 via #295).
• PHPCS check and linting issues (props @cadic via #291).

1.1.2 - 2022-05-18

Fixed

• Incorrect posts rendered due to wrong transient name (props @Sidsector9, @cadic via #282).

1.1.1 - 2022-05-17

Added

• sophi_bypass_curated_posts_cache filter to bypess curated posts cache (props @cadic via #276).
• Send all Categories in new allSections field to Sophi (props @oscarssanchez, @jeffpaul, @tott via #275).

Changed

• $result is used instead of $request to store return value of the sophi_request_result filter (props @faisal-alvi, @Sidsector9, @cadic via #277).
• Suppress Emitter debug output and writing logs (props @cadic via #272, #274).

Fixed

• Hook Docs deployment GitHub Action and included filter docs (props @iamdharmesh, @jeffpaul, @cadic via #266, #268).

1.1.0 - 2022-05-06

Added

• Filter sophi_request_args filters arguments used in Sophi HTTP request (props @cadic, @iamdharmesh via #257).
• Filter sophi_request_result filters a Sophi HTTP request immediately after the response is received (props @cadic, @iamdharmesh via #257, #261).
• Filter sophi_cms_tracking_request_data filters the data used in Sophi track event request (props @cadic, @iamdharmesh, @jeffpaul via #257, #263).
• Action sophi_cms_tracking_result fires after tracker sends the request (props @cadic, @iamdharmesh, @jeffpaul via #257, #263).
• Filter sophi_tracker_emitter_debug allows to enable debug mode in the tracking emitter (props @cadic, @iamdharmesh via #257).
• Documentation on rational for block vs. custom query integration uses and WP_Query caveat on WordPress VIP (props @Sidsector9, @jeffpaul, @oscarssanchez via #242, #249, #251).

Changed

• Update response saving from options table to post meta field (props @Rahmon, @oscarssanchez via #253).
• Bump WordPress "tested up to" version 5.9 (props @jeffpaul via #248).
• Updated hookdocs site (now Developer Docs) to properly run on release and migrate in docs from readme (props @iamdharmesh, @jeffpaul via #256).

Fixed

• Check if $terms is an array before using count() within get_the_terms() (props @barryceelen, @Sidsector9 via #215).
• Update track_event arguments list inside sync WP-CLI command (props @cadic, @Sidsector9 via #250).

Security

• Update actions/checkout action to from v2.4.0 to v3.0.2 (props @renovate, @iamdharmesh via #240, #241, #243).
• Update actions/setup-node action from v1 to v3 (props @renovate, @iamdharmesh via #244).
• Update dependency 10up-toolkit from 3.1.2 to 4.0.0 (props @renovate, @cadic via #264).

1.0.13 - 2022-04-20

Changed

• keywords data type from string to array (props @iamdharmesh, @jeffpaul, @oscarssanchez, @YMufleh via #233).

Security

• Bump node-forge from 1.2.1 to 1.3.0 (props @dependabot via #228).
• Bump minimist from 1.2.5 to 1.2.6 (props @dependabot via #229).
• Update dependency 10up-toolkit from 3.0.3 to 3.1.2 (props @renovate via #230, #234).
• Update dependency phpunit/phpunit from 8.5.25 to 8.5.26 (props @renovate via #231).
• Bump async from 2.6.3 to 2.6.4 (props @dependabot via #235).

1.0.12 - 2022-03-23

Fixed

• PHP fatal error when duplicating posts across sites (props @YMufleh via #218).

Security

• Update dependency phpunit/phpunit from 8.5.23 to 8.5.25 (props @renovate via #214, #220).
• Update dependency 10up-toolkit from 3.0.2 to 3.0.3 (props @renovate via #217).

1.0.11 - 2022-03-03

Changed

• Update package-lock.json (props @jeffpaul via #197).

Security

• Update actions/setup-node action from v2 to v3 (props @renovate via #199).
• Update actions/checkout action from v2 to v3 (props @renovate via #202).
• Update dependency 10up-toolkit from 2.1.1 to 3.0.2 (props @renovate via #203, #210).

1.0.10 - 2022-02-28

Changed

• Sets the default timeout of the first Sophi request and the cron request to 3 seconds (props @oscarssanchez, @barryceelen, @felipeelia, @tott via #198).

Security

• Update dependency snowplow/snowplow-tracker from 0.4.0 to 0.5.0 (props @renovate via #186).

1.0.9 - 2022-02-18

Added

• hostname and path fields to schema (props @Rahmon, @dinhtungdu via #164).
• sophi_curated_post_list filter to modify the Sophi API response to allow manual posts to be injected previous to returning the filterable value from posts_pre_query (e.g., via a fallback method to inject posts that would be a good fit) (props @oscarssanchez, @barryceelen, @felipeelia via #183).

Fixed

• Sophi API empty Post ID array response changed from using WP_Query default results to a "no results" response (props @oscarssanchez, @barryceelen, @felipeelia via #183).

Security

• Update dependency phpunit/phpunit from 8.5.21 to 8.5.23 (props @renovate via #160).
• Update dependency prop-types from 15.8.0 to 15.8.1 (props @renovate via #161).
• Update dependency 10up-toolkit from 1.0.13 to 2.1.1 (props @renovate, @oscarssanchez, @jeffpaul via #169, #189).
• Update dependency marked from 2.1.3 to 4.0.10 (props @renovate via #176).
• Update dependency jsdoc from 3.6.8 to 3.6.10 (props @renovate via #177).
• Update dependency dealerdirect/phpcodesniffer-composer-installer from 0.7.1 to 0.7.2 (props @renovate via #182).

1.0.8 - 2021-12-23

Changed

• Updated auth_url and audience parameters to get respective Staging and Development environment access tokens (props @Rahmon, @felipeelia via #152).

Fixed

• Issue where multiple Sophi blocks on the same page had duplicated content (props @Rahmon, @felipeelia, @jeffpaul, @dinhtungdu via #157).
• Testing environment deploy process (props @Rahmon, @felipeelia via #155).

Security

• Update dependency prop-types from 15.7.2 to 15.8.0 (props @renovate via #158).

1.0.7 - 2021-10-29

Changed

• Sophi Auth URL value used for Production, Staging, and Development (props @jeffpaul, @barryceelen, @amckie via #148).
• Sophi Site Automation API URL structure (props @Rahmon via #149).
• Sophi Audience URL used in authorization (props @Rahmon via #150).

1.0.6 - 2021-10-27

Note: this was a hotfix release to fix an issue with deploys to WordPress.org.

1.0.5 - 2021-10-27

Added

• New content fields sent to Sophi thumbnailImageUri, embeddedImagesCount, and keywords (props @Rahmon, @felipeelia, @dinhtungdu via #116).

Changed

• Updated name convention for appId (props @Rahmon, @felipeelia, @dinhtungdu via #117).
• Send WordPress Categories to Sophi in sectionNames field (props @Rahmon, @jeffpaul, @felipeelia, @tott via #135, #138, #140, #142, #144).
• Updated JS tracking of the homepage from article to section content type (props @Rahmon, @felipeelia, @jeffpaul via #139, #140, #142).
• Updated audience URL (props @Rahmon, @jeffpaul via #143).
• Bump WordPress version "tested up to" 5.8 (props @Rahmon, @jeffpaul via #146).
• Documentation (props @dkotter via #113).

Fixed

• Stopped sending homepage (aka "page on front" or "page for posts") content updates to Sophi (props @Rahmon, @felipeelia, @jeffpaul via #139, #140, #142).

Security

• Update dependency 10up-toolkit from 1.0.9 to 1.0.13 (props @renovate via #111, #115, #129, #145).
• Update dependency phpunit/phpunit from 8.5.18 to 8.5.21 (props @renovate via #114, #120, #132).
• Update dependency automattic/vipwpcs from 2.3.2 to 2.3.3 (props @renovate via #133).

1.0.4 - 2021-07-29

Added

• Support for Yoast canonical URL (props @dinhtungdu, @dkotter via #70, #71, #72).
• Configure WhiteSource Bolt and Renovate integrations (props @whitesource-bolt, @renovate via #72, #97).

Changed

• Updated AMP and JS tracking data, changed post data type to post content type (props @dinhtungdu via #71, #72).
• Update documentation, dependencies, and pin dependencies (props @jeffpaul, @dinhtungdu, @renovate via #96, #98, #104).

Fixed

• Issue with empty sectionNames (props @dinhtungdu, @dkotter via #69).
• Set jsonschema to 2.0.0 (props @dinhtungdu, @dkotter via #69).
• Corrected variable name from contentSize to size (props @dinhtungdu via #71).
• Sending publish events when Yoast SEO is activated (props @dinhtungdu via #107).
• Only use public taxonomies to build post breadcrumb (props @dinhtungdu via #109).
• Update events via Quick Edit are now sent to Sophi when Yoast SEO is activated (props @dinhtungdu via #110).

Security

• Update dependency @10up/scripts from 1.3.1 to 1.3.4 (props @renovate via #99).
• Update dependency automattic/vipwpcs from 2.3.0 to 2.3.2 (props @renovate via #100).
• Update dependency phpunit/phpunit from 8.5.15 to 8.5.18 (props @renovate via #101, #108).
• Update actions/setup-node action from v1 to v2 (props @renovate via #102).
• Update dependency 10up-toolkit from 1.0.9 to 1.0.10 (props @renovate via #111).

1.0.3 - 2021-06-15

Added

• Data attributes to Site Automation widgets/blocks (props @dinhtungdu, @dkotter via #64).

Changed

• Revisions to tracking data collected to improve Site Automation results (props @dinhtungdu, @dkotter via #65).
• Update default Collector URL helper text (props @barryceelen via #56).
• Set default environment according to wp_get_environment_type() (props @barryceelen via #57).

Fixed

• Only load Snowplow analytics once Sophi plugin is configured (props @dinhtungdu, @dkotter, @barryceelen via #61).
• VIP CLI dry-run mode defaults to false, corrects sync limiting, adds progress bar (props @dinhtungdu, @jeffpaul, @barryceelen via #66).

1.0.2 - 2021-04-26

Changed

• Bump vipwpcs from 2.2.0 to 2.3.0 and php_codesniffer from 3.5.8 to 3.6.0 (props @dinhtungdu, @jeffpaul via #47).

Fixed

• WP-CLI command now supports both WordPress VIP and non-VIP environments (props @dinhtungdu, @dkotter, @jeffpaul via #45).

1.0.1 - 2021-04-23

Added

• noConfigFile setting (props @dinhtungdu via #48).
• GitHub Actions to deploy releases and update readme/asset changes for WordPress.org (props @jeffpaul, @dinhtungdu via #44).

Changed

• Renamed plugin from Sophi for WordPress to Sophi (props @jeffpaul via #49).

Fixed

• Minor fixes from WordPress VIP code scan (props @dkotter via #50).

1.0.0 - 2021-04-14

• Initial public release! 🎉