Refactor conditional fields (#38)

content/content.yaml

@@ -1,6 +1,10 @@
 seo_site_name_position: end
 seo_generate_social_images: false
+seo_og_title: '@auto'
+seo_og_description: '@auto'
 seo_twitter_card: summary
+seo_twitter_title: '@auto'
+seo_twitter_description: '@auto'
 seo_canonical_type: current
 seo_noindex: false
 seo_nofollow: false

package.json

@@ -8,7 +8,8 @@
         "production": "mix --production"
     },
     "dependencies": {
-        "vue": "^2.6.14"
+        "vue": "^2.6.14",
+        "marked": "^4.0.10"
     },
     "devDependencies": {
         "autoprefixer": "^10.4.5",

resources/dist/mix-manifest.json

@@ -1,4 +1,4 @@
 {
-    "/js/cp.js": "/js/cp.js?id=a111bc589aba1b73cd9741c2cac99989",
+    "/js/cp.js": "/js/cp.js?id=ad0deeb3d85b3f2bec4c7418fb07f730",
     "/css/cp.css": "/css/cp.css?id=8061e1c7006144a94600e6bb047fcff1"
 }

resources/js/components.js

@@ -0,0 +1,9 @@
+import DefaultsPublishForm from './components/DefaultsPublishForm'
+import SocialImageFieldtype from './components/SocialImageFieldtype'
+import SourceFieldtype from './components/SourceFieldtype'
+
+Statamic.booting(() => {
+    Statamic.component('defaults-publish-form', DefaultsPublishForm)
+    Statamic.component('social_image-fieldtype', SocialImageFieldtype)
+    Statamic.component('seo_source-fieldtype', SourceFieldtype)
+})

resources/js/components/DefaultsPublishForm.vue

@@ -89,8 +89,14 @@
 </style>
 
 <script>
+import HasHiddenFields from '../../../vendor/statamic/cms/resources/js/components/data-list/HasHiddenFields';
+
 export default {
 
+    mixins: [
+        HasHiddenFields,
+    ],
+
     props: {
         publishContainer: String,
         initialReference: String,
@@ -199,7 +205,7 @@ export default {
             this.saving = true;
             this.clearErrors();
 
-            const payload = { ...this.values, ...{
+            const payload = { ...this.visibleValues, ...{
                 blueprint: this.fieldset.handle,
                 _localized: this.localizedFields,
             }};

resources/js/conditions.js

@@ -0,0 +1,19 @@
+// Fetch the conditions after Statamic has booted.
+Statamic.booted(() => {
+    Statamic.$store.dispatch("publish/advancedSeo/fetchConditions")
+})
+
+// Fetch the conditions when the user changes the site in the sidebar.
+Statamic.$store.watch(state => state.publish?.base?.site, () => {
+    Statamic.$store.dispatch("publish/advancedSeo/fetchConditions")
+})
+
+// Add the showSitemapFields condition.
+Statamic.$conditions.add('showSitemapFields', ({ store }) => {
+    return store.state.publish.advancedSeo.conditions?.showSitemapFields
+});
+
+// Add the showSocialImagesGeneratorFields condition.
+Statamic.$conditions.add('showSocialImagesGeneratorFields', ({ store }) => {
+    return store.state.publish.advancedSeo.conditions?.showSocialImagesGeneratorFields
+});

resources/js/cp.js

@@ -1,9 +1,3 @@
-import DefaultsPublishForm from './components/DefaultsPublishForm'
-import SocialImageFieldtype from './components/SocialImageFieldtype'
-import SourceFieldtype from './components/SourceFieldtype'
-
-Statamic.booting(() => {
-    Statamic.component('defaults-publish-form', DefaultsPublishForm)
-    Statamic.component('social_image-fieldtype', SocialImageFieldtype)
-    Statamic.component('seo_source-fieldtype', SourceFieldtype)
-})
+import './components'
+import './conditions'
+import './store'

resources/js/store.js

@@ -0,0 +1,33 @@
+Statamic.$store.registerModule(['publish', 'advancedSeo'], {
+
+    namespaced: true,
+
+    state: {
+        conditions: null,
+    },
+
+    getters: {
+        conditions: state => state.conditions,
+    },
+
+    actions: {
+        fetchConditions({ commit }) {
+            return Statamic.$request.post(`/!/advanced-seo/conditions`, {
+                url: window.location,
+                id: Statamic.$store.state.publish?.base?.values?.id,
+                site: Statamic.$store.state.publish.base.site,
+            })
+            .then(response => commit('setConditions', response.data))
+            .catch(function (error) {
+                console.log(error);
+            });
+        },
+    },
+
+    mutations: {
+        setConditions(state, conditions) {
+            state.conditions = conditions;
+        },
+    }
+
+})

routes/actions.php

@@ -1,8 +1,10 @@
 <?php
 
+use Aerni\AdvancedSeo\Http\Controllers\Cp\ConditionsController;
 use Aerni\AdvancedSeo\Http\Controllers\Web\SocialImagesController;
 use Illuminate\Support\Facades\Route;
 
 Route::name('advanced-seo.')->group(function () {
     Route::get('/social-images/{theme}/{type}/{id}', [SocialImagesController::class, 'show'])->name('social_images.show');
+    Route::post('/conditions', ConditionsController::class);
 });

src/Actions/EvaluateModelHandle.php

@@ -3,6 +3,7 @@
 namespace Aerni\AdvancedSeo\Actions;
 
 use Aerni\AdvancedSeo\Data\DefaultsData;
+use Aerni\AdvancedSeo\Data\SeoDefaultSet;
 use Illuminate\Support\Str;
 use Statamic\Contracts\Entries\Collection;
 use Statamic\Contracts\Entries\Entry;
@@ -16,6 +17,7 @@ class EvaluateModelHandle
     public static function handle(mixed $model): ?string
     {
         return match (true) {
+            ($model instanceof SeoDefaultSet) => $model->handle(),
             ($model instanceof Collection) => $model->handle(),
             ($model instanceof Entry) => $model->collection()->handle(),
             ($model instanceof EntryBlueprintFound) => Str::after($model->blueprint->namespace(), '.'),

src/Actions/EvaluateModelLocale.php

@@ -3,6 +3,7 @@
 namespace Aerni\AdvancedSeo\Actions;
 
 use Aerni\AdvancedSeo\Data\DefaultsData;
+use Aerni\AdvancedSeo\Data\SeoDefaultSet;
 use Statamic\Contracts\Entries\Collection;
 use Statamic\Contracts\Entries\Entry;
 use Statamic\Contracts\Taxonomies\Taxonomy;
@@ -18,6 +19,7 @@ class EvaluateModelLocale
     public static function handle(mixed $model): ?string
     {
         return match (true) {
+            ($model instanceof SeoDefaultSet) => request()->get('site') ?? $model->selectedSite(),
             ($model instanceof Collection) => Statamic::isCpRoute() ? basename(request()->path()) : Site::current()->handle(),
             ($model instanceof Entry) => $model->locale(),
             ($model instanceof EntryBlueprintFound) => Statamic::isCpRoute() ? basename(request()->path()) : Site::current()->handle(),

src/Actions/EvaluateModelParent.php

@@ -2,6 +2,7 @@
 
 namespace Aerni\AdvancedSeo\Actions;
 
+use Aerni\AdvancedSeo\Data\SeoDefaultSet;
 use Illuminate\Support\Str;
 use Statamic\Contracts\Entries\Collection;
 use Statamic\Contracts\Entries\Entry;
@@ -20,6 +21,7 @@ class EvaluateModelParent
     public static function handle(mixed $data): mixed
     {
         return match (true) {
+            ($data instanceof SeoDefaultSet) => $data,
             ($data instanceof Collection) => $data,
             ($data instanceof Entry) => $data->collection(),
             ($data instanceof EntryBlueprintFound) => CollectionApi::find(Str::after($data->blueprint->namespace(), '.')),

src/Actions/EvaluateModelSites.php

@@ -3,6 +3,7 @@
 namespace Aerni\AdvancedSeo\Actions;
 
 use Aerni\AdvancedSeo\Data\DefaultsData;
+use Aerni\AdvancedSeo\Data\SeoDefaultSet;
 use Illuminate\Support\Collection as LaravelCollection;
 use Statamic\Contracts\Entries\Collection;
 use Statamic\Contracts\Taxonomies\Taxonomy;
@@ -12,6 +13,7 @@ class EvaluateModelSites
     public static function handle(mixed $model): ?LaravelCollection
     {
         return match (true) {
+            ($model instanceof SeoDefaultSet) => $model->sites(),
             ($model instanceof Collection) => $model->sites(),
             ($model instanceof Taxonomy) => $model->sites(),
             ($model instanceof DefaultsData) => $model->sites,

src/Actions/EvaluateModelType.php

@@ -3,6 +3,7 @@
 namespace Aerni\AdvancedSeo\Actions;
 
 use Aerni\AdvancedSeo\Data\DefaultsData;
+use Aerni\AdvancedSeo\Data\SeoDefaultSet;
 use Statamic\Contracts\Entries\Collection;
 use Statamic\Contracts\Entries\Entry;
 use Statamic\Contracts\Taxonomies\Taxonomy;
@@ -15,6 +16,7 @@ class EvaluateModelType
     public static function handle(mixed $model): ?string
     {
         return match (true) {
+            ($model instanceof SeoDefaultSet) => $model->type(),
             ($model instanceof Collection) => 'collections',
             ($model instanceof Entry) => 'collections',
             ($model instanceof EntryBlueprintFound) => 'collections',

src/Actions/ShouldGenerateSocialImages.php

@@ -12,13 +12,20 @@ public static function handle(Entry $entry): bool
         // Don't generate if we're first localiting an entry.
         if (str_contains(request()->path(), 'localize')) {
             return false;
-        };
+        }
 
         // Shouldn't generate if the generator was disabled in the config.
         if (! config('advanced-seo.social_images.generator.enabled', false)) {
             return false;
         }
 
+        $disabled = config('advanced-seo.disabled.collections', []);
+
+        // Check if the collection is set to be disabled globally.
+        if (in_array($entry->collectionHandle(), $disabled)) {
+            return false;
+        }
+
         // Get the collections that are allowed to generate social images.
         $enabledCollections = Seo::find('site', 'social_media')
             ?->in($entry->site()->handle())

src/Actions/ShouldDisplaySitemapSettings.php → src/Conditions/ShowSitemapFields.php

@@ -1,14 +1,18 @@
 <?php
 
-namespace Aerni\AdvancedSeo\Actions;
+namespace Aerni\AdvancedSeo\Conditions;
 
 use Aerni\AdvancedSeo\Data\DefaultsData;
 use Aerni\AdvancedSeo\Facades\Seo;
 
-class ShouldDisplaySitemapSettings
+class ShowSitemapFields
 {
     public static function handle(DefaultsData $data): bool
     {
+        if (! config('advanced-seo.sitemap.enabled', true)) {
+            return false;
+        }
+
         $disabled = config("advanced-seo.disabled.{$data->type}", []);
 
         // Check if the collection/taxonomy is set to be disabled globally.

src/Actions/ShouldDisplaySocialImagesGenerator.php → src/Conditions/ShowSocialImagesGeneratorFields.php

@@ -1,12 +1,11 @@
 <?php
 
-namespace Aerni\AdvancedSeo\Actions;
+namespace Aerni\AdvancedSeo\Conditions;
 
 use Aerni\AdvancedSeo\Data\DefaultsData;
 use Aerni\AdvancedSeo\Facades\Seo;
-use Statamic\Facades\Site;
 
-class ShouldDisplaySocialImagesGenerator
+class ShowSocialImagesGeneratorFields
 {
     public static function handle(DefaultsData $data): bool
     {
@@ -15,13 +14,20 @@ public static function handle(DefaultsData $data): bool
             return false;
         }
 
+        $disabled = config("advanced-seo.disabled.{$data->type}", []);
+
+        // Check if the collection/taxonomy is set to be disabled globally.
+        if (in_array($data->handle, $disabled)) {
+            return false;
+        }
+
         // Terms are not yet supported.
         if ($data->type === 'taxonomies') {
             return false;
         }
 
         $enabledCollections = Seo::find('site', 'social_media')
-            ?->in(Site::selected()->handle())
+            ?->in($data->locale)
             ?->value('social_images_generator_collections') ?? [];
 
         // Don't show the generator section if the collection is not configured.

src/Contracts/SeoDefaultsRepository.php

@@ -10,9 +10,11 @@ interface SeoDefaultsRepository
 {
     public function make(): SeoDefaultSet;
 
-    public function find(string $type, string $id): ?SeoDefaultSet;
+    public function find(string $type, string $handle): ?SeoDefaultSet;
 
-    public function findOrMake(string $type, string $id): SeoDefaultSet;
+    public function findById(string $id): ?SeoDefaultSet;
+
+    public function findOrMake(string $type, string $handle): SeoDefaultSet;
 
     public function all(): Collection;