Merge branch 'develop' into trunk

Author: dkotter

.github/hookdoc-tmpl/README.md

@@ -6,4 +6,8 @@ For more information about using ClassifAI with WordPress, please see the [Class
 
 To report an issue with ClassifAI or contribute back to the project, please visit the [GitHub repository](https://github.com/10up/classifai/).
 
+## Migrating to version 3.0.0
+
+Version 3.0.0 of ClassifAI contains breaking changes. Please review the [migration guide](./tutorial-migration-guide-v2-to-v3.html) for an overview of these changes and any action that may be required.
+
 <a href="http://10up.com/contact/" class="banner"><img src="https://10updotcom-wpengine.s3.amazonaws.com/uploads/2016/10/10up-Github-Banner.png" width="850"></a>

.github/hookdoc-tmpl/static/styles-10up.css

@@ -50,6 +50,7 @@ nav ul:nth-of-type(3) {
 
 nav ul {
 	font-size: 1.2rem;
+	overflow: scroll;
 }
 
 nav li a {
@@ -132,3 +133,13 @@ footer {
 	padding: 2px 10px;
 	line-height: 16px;
 }
+
+table {
+	width: 100%;
+	table-layout: fixed;
+	overflow: scroll;
+}
+
+table td {
+	overflow: scroll;
+}

.github/workflows/build-release-zip.yml

@@ -9,9 +9,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout code
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Set Node.js 16.x
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version-file: .nvmrc
     - name: npm install and build
@@ -22,7 +22,7 @@ jobs:
         composer install --no-dev
         npm run archive
     - name: Upload the ZIP file as an artifact
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: ${{ github.event.repository.name }}
         path: release

.github/workflows/codeql-analysis.yml

@@ -38,7 +38,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.github/workflows/cypress.yml

@@ -8,6 +8,7 @@ on:
   pull_request:
     branches:
       - develop
+
 jobs:
   cypress:
     name: ${{ matrix.core.name }}
@@ -17,10 +18,10 @@ jobs:
         core:
           - {name: 'WP latest', version: 'latest'}
           - {name: 'WP minimum', version: 'WordPress/WordPress#6.1'}
-          - {name: 'WP trunk', version: 'WordPress/WordPress#master'}
+          # - {name: 'WP trunk', version: 'WordPress/WordPress#master'}
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Install dependencies
       run: npm install
@@ -51,7 +52,7 @@ jobs:
         cat ./tests/cypress/reports/mochawesome.md >> $GITHUB_STEP_SUMMARY
 
     - name: Upload artifacts
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       if: failure()
       with:
         name: cypress-artifact-classifai

.github/workflows/dependency-review.yml

@@ -15,9 +15,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout Repository'
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Dependency Review
-        uses: actions/dependency-review-action@v3
+        uses: actions/dependency-review-action@v4
         with:
           license-check: true
           vulnerability-check: false

.github/workflows/lint.yml

@@ -19,10 +19,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Setup node v16 and npm cache
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version-file: .nvmrc
         cache: npm
@@ -32,7 +32,7 @@ jobs:
 
     - name: Get updated JS files
       id: changed-files
-      uses: tj-actions/changed-files@v41
+      uses: tj-actions/changed-files@v42
       with:
         files: |
           **/*.js
@@ -52,14 +52,14 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Set standard 10up cache directories
       run: |
         composer config -g cache-dir "${{ env.COMPOSER_CACHE }}"
 
     - name: Prepare composer cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ env.COMPOSER_CACHE }}
         key: composer-${{ env.COMPOSER_VERSION }}-${{ hashFiles('**/composer.lock') }}
@@ -78,7 +78,7 @@ jobs:
 
     - name: Get updated PHP files
       id: changed-files
-      uses: tj-actions/changed-files@v41
+      uses: tj-actions/changed-files@v42
       with:
         files: |
           **/*.php
@@ -97,7 +97,7 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: VIPCS check
       uses: 10up/wpcs-action@stable

.github/workflows/release.yml

@@ -10,10 +10,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Set Node.js 16.x
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version-file: .nvmrc
 

.github/workflows/repo-automator.yml

@@ -0,0 +1,32 @@
+name: 'Repo Automator'
+on:
+  issues:
+    types:
+      - opened
+  push:
+    branches:
+      - develop
+  pull_request:
+    types:
+      - opened
+      - edited
+      - synchronize
+      - converted_to_draft
+      - ready_for_review
+    branches:
+      - develop
+
+jobs:
+  Validate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: 10up/action-repo-automator@trunk
+        with:
+          fail-label: needs:feedback
+          pass-label: needs:code-review
+          conflict-label: needs:refresh
+          reviewers: |
+            dkotter
+            team:open-source-practice
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/stable.yml

@@ -9,11 +9,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Set Node.js 16.x
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
-        node-version: 16.x
+        node-version-file: .nvmrc
     - name: npm install and build
       run: |
         npm install

.github/workflows/test.yml

@@ -27,14 +27,14 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2.4.0
+      uses: actions/checkout@v4
 
     - name: Set standard 10up cache directories
       run: |
         composer config -g cache-dir "${{ env.COMPOSER_CACHE }}"
 
     - name: Prepare composer cache
-      uses: actions/cache@v2
+      uses: actions/cache@v4
       with:
         path: ${{ env.COMPOSER_CACHE }}
         key: composer-${{ env.COMPOSER_VERSION }}-${{ hashFiles('**/composer.lock') }}
@@ -44,7 +44,7 @@ jobs:
     - uses: getong/[email protected]
 
     - name: Set PHP version
-      uses: shivammathur/setup-php@2.17.0
+      uses: shivammathur/setup-php@v2
       with:
         php-version: ${{ matrix.php }}
         coverage: none

.husky/pre-commit

@@ -1 +1 @@
-v16
+v20.11.1

.nvmrc

@@ -1,5 +1,4 @@
 {
-  "core": "WordPress/WordPress#6.1",
   "plugins": [".", "./tests/test-plugin", "https://downloads.wordpress.org/plugin/classic-editor.zip"],
   "env": {
     "tests": {

.wp-env.json

@@ -4,6 +4,60 @@ All notable changes to this project will be documented in this file, per [the Ke
 
 ## [Unreleased] - TBD
 
+## [3.0.0] - 2024-02-29
+**Note that this is a major release of ClassifAI that restructures most of the codebase and will have some breaking changes. If you're extending ClassifAI in any way, please ensure you fully test those integrations prior to running this update on production. For more details on what is changing, see the [migration guide](https://10up.github.io/classifai/tutorial-migration-guide-v2-to-v3.html).**
+
+### Added
+- New Moderation Feature that utilizes the OpenAI Moderation API to moderate comments (props [@kirtangajjar](https://github.com/kirtangajjar), [@dkotter](https://github.com/dkotter), [@Sidsector9](https://github.com/Sidsector9) via [#531](https://github.com/10up/classifai/pull/531)).
+- Added the option to use Google's Gemini API as a Provider for the Title Generation, Excerpt Generation and Content Resizing Features (props [@iamdharmesh](https://github.com/iamdharmesh), [@dkotter](https://github.com/dkotter) via [#700](https://github.com/10up/classifai/pull/700)).
+- Added the option to use Azure OpenAI as a Provider for the Title Generation, Excerpt Generation and Content Resizing Features (props [@dkotter](https://github.com/dkotter), [@jeffpaul](https://github.com/jeffpaul), [@iamdharmesh](https://github.com/iamdharmesh) via [#716](https://github.com/10up/classifai/pull/716)).
+- Role and user-based access control for all Features (props [@iamdharmesh](https://github.com/iamdharmesh), [@Sidsector9](https://github.com/Sidsector9) via [#635](https://github.com/10up/classifai/pull/635)).
+- Ability to preview which terms will be added before they get added when using the Embeddings provider (props [@dkotter](https://github.com/dkotter), [@iamdharmesh](https://github.com/iamdharmesh) via [#709](https://github.com/10up/classifai/pull/709)).
+- Show error message if generating excerpts or titles fails in the Classic Editor (props [@dkotter](https://github.com/dkotter), [@faisal-alvi](https://github.com/faisal-alvi) via [#688](https://github.com/10up/classifai/pull/688)).
+- Tool to automatically migrate settings from the old settings structure to the new feature-first settings structure (props [@Sidsector9](https://github.com/Sidsector9), [@iamdharmesh](https://github.com/iamdharmesh), [@qasumitbagthariya](https://github.com/qasumitbagthariya),  [@dkotter](https://github.com/dkotter) via [#711](https://github.com/10up/classifai/pull/711)).
+- Migration guide for the feature-first refactoring (props [@iamdharmesh](https://github.com/iamdharmesh), [@dkotter](https://github.com/dkotter) via [#726](https://github.com/10up/classifai/pull/726)).
+- Repo Automator GitHub Action to automate repo operations (props [@iamdharmesh](https://github.com/iamdharmesh), [@dkotter](https://github.com/dkotter) via [#681](https://github.com/10up/classifai/pull/681)).
+
+### Changed
+- Major refactoring of the plugin to a feature-first architecture (props [@Sidsector9](https://github.com/Sidsector9), [@dkotter](https://github.com/dkotter) via [#611](https://github.com/10up/classifai/pull/611)).
+- Update the Azure AI Vision Image Analyze API from v3.0 to v3.2 and the Azure AI Vision Smart Cropping API from v3.1 to v3.2. Note that we recommend lowering the threshold values for the Descriptive Text Generator Feature to 55% for best results (props [@kmgalanakis](https://github.com/kmgalanakis), [@dkotter](https://github.com/dkotter), [@sksaju](https://github.com/sksaju), [@iamdharmesh](https://github.com/iamdharmesh) via [#559](https://github.com/10up/classifai/pull/559)).
+- Update from using DALL·E 2 to using DALL·E 3 in our Image Generation Feature (props [@dkotter](https://github.com/dkotter), [@jeffpaul](https://github.com/jeffpaul), [@iamdharmesh](https://github.com/iamdharmesh) via [#717](https://github.com/10up/classifai/pull/717)).
+- Refactor ClassifAI onboarding to work with the new feature-first refactoring (props [@iamdharmesh](https://github.com/iamdharmesh), [@Sidsector9](https://github.com/Sidsector9) via [#642](https://github.com/10up/classifai/pull/642)).
+- Ensure the Classification functionality works the same for all Providers (props [@dkotter](https://github.com/dkotter), [@iamdharmesh](https://github.com/iamdharmesh) via [#709](https://github.com/10up/classifai/pull/709)).
+- Introduce a filter to add new arguments to the Image Generation REST route, instead of registering that route twice (props [@iamdharmesh](https://github.com/iamdharmesh), [@dkotter](https://github.com/dkotter) via [#727](https://github.com/10up/classifai/pull/727)).
+- If on a multisite install, when handling user access based on role, if a Super Admin does not have a specific role on a site, treat that user as an administrator (props [@dkotter](https://github.com/dkotter), [@jeffpaul](https://github.com/jeffpaul), [@gsarig](https://github.com/gsarig), [@iamdharmesh](https://github.com/iamdharmesh) via [#689](https://github.com/10up/classifai/pull/689)).
+- Remove the "Enable role-based access" and "Enable user-based access" settings options and instead set those to be enabled by default (props [@iamdharmesh](https://github.com/iamdharmesh), [@dkotter](https://github.com/dkotter), [@jeffpaul](https://github.com/jeffpaul) via [#692](https://github.com/10up/classifai/pull/692)).
+- Update minimum node version to 20 (props [@Sidsector9](https://github.com/Sidsector9), [@dkotter](https://github.com/dkotter) via [#722](https://github.com/10up/classifai/pull/722)).
+- Updated E2E tests to work with the new feature-first refactoring (props [@Sidsector9](https://github.com/Sidsector9), [@dkotter](https://github.com/dkotter) via [#653](https://github.com/10up/classifai/pull/653)).
+
+### Fixed
+- Ensure the classification popup works after feature-first refactoring (props [@faisal-alvi](https://github.com/faisal-alvi), [@dkotter](https://github.com/dkotter), [@Sidsector9](https://github.com/Sidsector9) via [#634](https://github.com/10up/classifai/pull/634)).
+- Ensure we only run image updates once (props [@dkotter](https://github.com/dkotter), [@Sidsector9](https://github.com/Sidsector9), [@sksaju](https://github.com/sksaju) via [#677](https://github.com/10up/classifai/pull/677)).
+- Ensure the Classification preview works as expected after feature-first refactoring (props [@dkotter](https://github.com/dkotter), [@QAharshalkadu](https://github.com/QAharshalkadu), [@Sidsector9](https://github.com/Sidsector9) via [#679](https://github.com/10up/classifai/pull/679)).
+- Ensure all `WP_CLI` commands work after the feature-first refactoring (props [@Sidsector9](https://github.com/Sidsector9), [@dkotter](https://github.com/dkotter) via [#682](https://github.com/10up/classifai/pull/682)).
+- Ensure the jQuery UI Dialog CSS is loaded properly (props [@dkotter](https://github.com/dkotter), [@faisal-alvi](https://github.com/faisal-alvi) via [#687](https://github.com/10up/classifai/pull/687)).
+- Ensure the classification button has proper bottom spacing (props [@dkotter](https://github.com/dkotter), [@QAharshalkadu](https://github.com/QAharshalkadu), [@faisal-alvi](https://github.com/faisal-alvi) via [#694](https://github.com/10up/classifai/pull/694)).
+- Load the dashicon font when the Text to Speech block is used to ensure icons display (props [@dkotter](https://github.com/dkotter), [@QAharshalkadu](https://github.com/QAharshalkadu), [@iamdharmesh](https://github.com/iamdharmesh) via [#695](https://github.com/10up/classifai/pull/695)).
+- Ensure the Text to Speech block is rendered for non-logged in users (props [@dkotter](https://github.com/dkotter), [@QAharshalkadu](https://github.com/QAharshalkadu), [@iamdharmesh](https://github.com/iamdharmesh) via [#695](https://github.com/10up/classifai/pull/695)).
+- Ensure the IBM Watson NLU credentials toggle link works properly in the ClassifAI onboarding (props [@iamdharmesh](https://github.com/iamdharmesh), [@dkotter](https://github.com/dkotter) via [#697](https://github.com/10up/classifai/pull/697)).
+- Ensure the connection status shows properly in the ClassifAI onboarding (props [@Sidsector9](https://github.com/Sidsector9), [@QAharshalkadu](https://github.com/QAharshalkadu), [@dkotter](https://github.com/dkotter) via [#702](https://github.com/10up/classifai/pull/702)).
+- Ensure the "Extract text from PDF" row action works properly in the media list table view (props [@iamdharmesh](https://github.com/iamdharmesh), [@qasumitbagthariya](https://github.com/qasumitbagthariya), [@dkotter](https://github.com/dkotter) via [#706](https://github.com/10up/classifai/pull/706)).
+- Fix fatal error if both the Classification Feature and Moderation Features are active (props [@dkotter](https://github.com/dkotter), [@QAharshalkadu](https://github.com/QAharshalkadu), [@iamdharmesh](https://github.com/iamdharmesh) via [#709](https://github.com/10up/classifai/pull/709)).
+- Ensure the stand-alone Generate Image page works if the Media Library is loaded in list mode (props [@dkotter](https://github.com/dkotter), [@qasumitbagthariya](https://github.com/qasumitbagthariya), [@Sidsector9](https://github.com/Sidsector9) via [#712](https://github.com/10up/classifai/pull/712)).
+
+### Removed
+- Subscriber from the list of allowed roles (props [@dkotter](https://github.com/dkotter), [@ankitguptaindia](https://github.com/ankitguptaindia), [@Sidsector9](https://github.com/Sidsector9) via [#690](https://github.com/10up/classifai/pull/690)).
+- `AccessControl` class as it is no longer in use after the feature-first refactoring (props [@iamdharmesh](https://github.com/iamdharmesh), [@dkotter](https://github.com/dkotter) via [#680](https://github.com/10up/classifai/pull/680)).
+- Type declaration from the `attachment_is_pdf` parameter (props [@iamdharmesh](https://github.com/iamdharmesh), [@peterwilsoncc](https://github.com/peterwilsoncc), [@dkotter](https://github.com/dkotter) via [#719](https://github.com/10up/classifai/pull/719)).
+- Eliminate all dead code that is no longer needed after the feature-first refactoring (props [@Sidsector9](https://github.com/Sidsector9), [@dkotter](https://github.com/dkotter) via [#678](https://github.com/10up/classifai/pull/678)).
+
+### Deprecated
+- Show deprecation notice for the Azure AI Personalizer provider, as this will be removed in a coming release (props [@dkotter](https://github.com/dkotter), [@jeffpaul](https://github.com/jeffpaul), [@iamdharmesh](https://github.com/iamdharmesh) via [#698](https://github.com/10up/classifai/pull/698)).
+
+### Security
+- Protect against potential prompt injection when using OpenAI's ChatGPT (props [@iamdharmesh](https://github.com/iamdharmesh), [@dkotter](https://github.com/dkotter) via [#683](https://github.com/10up/classifai/pull/683)).
+- Bump `ip` from 1.1.8 to 1.1.9 (props [@dependabot[bot]](https://github.com/apps/dependabot), [@iamdharmesh](https://github.com/iamdharmesh) via [#721](https://github.com/10up/classifai/pull/721)).
+
 ## [2.5.1] - 2024-01-11
 ### Changed
 - Switch from using the Completions API to the Models API to verify credentials (props [@dkotter](https://github.com/dkotter), [@jeffpaul](https://github.com/jeffpaul), [@iamdharmesh](https://github.com/iamdharmesh) via [#654](https://github.com/10up/classifai/pull/654)).
@@ -490,6 +544,7 @@ All notable changes to this project will be documented in this file, per [the Ke
 - Initial closed source release
 
 [Unreleased]: https://github.com/10up/classifai/compare/trunk...develop
+[3.0.0]: https://github.com/10up/classifai/compare/2.5.1...3.0.0
 [2.5.1]: https://github.com/10up/classifai/compare/2.5.0...2.5.1
 [2.5.0]: https://github.com/10up/classifai/compare/2.4.0...2.5.0
 [2.4.0]: https://github.com/10up/classifai/compare/2.3.0...2.4.0