Add structured data templates to terms

kevinmeijer97 · kevinmeijer97 · commit 8ba81db95543 · 2025-05-12T15:34:10.000+02:00
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ This Statamic addon provides a powerful and flexible way to add structured data
 
 ## Features
 
-- 🔄 Dynamic JSON-LD generation based on entry data
+- 🔄 Dynamic JSON-LD generation based on entry and term data
 - 📝 Template-based structured data configuration
 - 🔌 Automatic injection of structured data into your pages
 - 🎯 Support for multiple schemas per page
@@ -37,7 +37,7 @@ Create templates in your Statamic control panel that define your structured data
 
 ### 2. Assigning Templates to Entries
 
-In your entry's content, you can assign one or more structured data templates using the `structured_data_templates` field. The addon will automatically process these templates and generate the appropriate JSON-LD scripts.
+In your entry or term's content, you can assign one or more structured data templates using the `structured_data_templates` field. The addon will automatically process these templates and generate the appropriate JSON-LD scripts.
 
 ### 3. Automatic Injection
 
@@ -71,4 +71,4 @@ Here's an example of how you might structure a basic Organization schema:
 
 ## Configuration
 
-The addon works out of the box with sensible defaults. Configuration can be customized through your entry blueprints and templates.
+The addon works out of the box with sensible defaults. Configuration can be customized through your entry and term blueprints and templates.
diff --git a/config/structured-data.php b/config/structured-data.php
@@ -5,4 +5,8 @@
         // Add collection handles here that should have structured data templates
         // Example: 'pages', 'blog', 'products'
     ],
+    'taxonomies' => [
+        // Add taxonomy handles here that should have structured data objects
+        // Example: 'categories', 'tags'
+    ],
 ];
diff --git a/resources/blueprints/collections/structured_data_templates/structured_data_templates.yaml b/resources/blueprints/collections/structured_data_templates/structured_data_templates.yaml
@@ -32,6 +32,21 @@ tabs:
               type: slug
               localizable: true
               validate: 'max:200'
+          -
+            handle: blueprint_type
+            field:
+              options:
+                -
+                  key: collection
+                  value: Collection
+                -
+                  key: taxonomy
+                  value: Taxonomy
+              max_items: 1
+              default: collection
+              type: select
+              display: 'Blueprint type'
+              localizable: true
           -
             handle: use_for_collection
             field:
@@ -40,7 +55,22 @@ tabs:
               display: 'Use for collection'
               localizable: true
               validate:
+                - sometimes
+                - required
+              if:
+                blueprint_type: 'equals collection'
+          -
+            handle: use_for_taxonomy
+            field:
+              max_items: 1
+              type: taxonomies
+              display: 'Use for taxonomy'
+              localizable: true
+              validate:
+                - sometimes
                 - required
+              if:
+                blueprint_type: 'equals taxonomy'
           -
             handle: structured_data_available_variables
             field:
diff --git a/resources/dist/build/assets/statamic-structured-data-05ad0e35.css b/resources/dist/build/assets/statamic-structured-data-05ad0e35.css
diff --git a/resources/dist/build/assets/statamic-structured-data-0787df7f.js b/resources/dist/build/assets/statamic-structured-data-0787df7f.js
diff --git a/resources/dist/build/manifest.json b/resources/dist/build/manifest.json
@@ -5,14 +5,14 @@
     "src": "resources/css/statamic-structured-data.css"
   },
   "resources/js/statamic-structured-data.css": {
-    "file": "assets/statamic-structured-data-33d7377e.css",
+    "file": "assets/statamic-structured-data-05ad0e35.css",
     "src": "resources/js/statamic-structured-data.css"
   },
   "resources/js/statamic-structured-data.js": {
     "css": [
-      "assets/statamic-structured-data-33d7377e.css"
+      "assets/statamic-structured-data-05ad0e35.css"
     ],
-    "file": "assets/statamic-structured-data-08e9c173.js",
+    "file": "assets/statamic-structured-data-0787df7f.js",
     "isEntry": true,
     "src": "resources/js/statamic-structured-data.js"
   }
diff --git a/resources/js/components/fieldtypes/AvailableVariables.vue b/resources/js/components/fieldtypes/AvailableVariables.vue
@@ -68,7 +68,8 @@ export default {
         variables() {
             return this.meta?.variables || {
                 config: {},
-                entry: []
+                entry: [],
+                term: []
             };
         },
 
diff --git a/src/Fieldtypes/AvailableVariablesFieldtype.php b/src/Fieldtypes/AvailableVariablesFieldtype.php
@@ -36,6 +36,7 @@ protected function getAvailableVariables(): array
                 ],
             'globals' => $this->getGlobalVariables(),
             'entry' => $this->getEntryFields(),
+            'term' => $this->getTermFields(),
         ];
     }
 
@@ -89,6 +90,38 @@ protected function getEntryFields(): array
         return array_merge($baseFields, $collectionFields);
     }
 
+    protected function getTermFields(): array
+    {
+        $dataTemplate = $this->field->parent();
+
+        if (! $dataTemplate?->use_for_taxonomy?->termBlueprints()?->first()) {
+            return [];
+        }
+
+        $fields = collect($dataTemplate?->use_for_taxonomy?->termBlueprints()?->reduce(function($carry, $blueprint) {
+            return array_merge($carry, $blueprint->fields()->items()->toArray());
+        }, []) ?? []);
+
+        if(class_exists(OnPageSeoBlueprint::class)) {
+            $fields = $fields->merge(OnPageSeoBlueprint::requestBlueprint()->fields()?->items());
+        }
+
+        if (!$fields) {
+            return [];
+        }
+
+        $baseFields = [['name' => 'absolute_url', 'description' => 'Full URL']];
+
+        $collectionFields = $fields->map(function ($field) {
+            return $this->setFieldData($field);
+        })
+        ->filter()
+        ->values()
+        ->all();
+
+        return array_merge($baseFields, $collectionFields);
+    }
+
     protected function getGlobalVariables(): array
     {
         $variables = collect();
diff --git a/src/Http/Controllers/StructuredDataController.php b/src/Http/Controllers/StructuredDataController.php
@@ -6,6 +6,7 @@
 use Justbetter\StatamicStructuredData\Parser\StructuredDataParser;
 use Statamic\Facades\Entry;
 use Statamic\Facades\Site;
+use Statamic\Facades\Term;
 use Statamic\Http\Controllers\CP\CpController;
 
 class StructuredDataController extends CpController
@@ -36,6 +37,10 @@ public function getTemplates(Request $request)
         $templateIds = $request->input('ids', []);
         $contentEntry = Entry::find($request->input('entry_id'));
 
+        if (! $contentEntry) {
+            $contentEntry = Term::find($request->input('entry_id'));
+        }
+
         if (! $contentEntry) {
             return response()->json(['error' => 'Content entry not found'], 404);
         }
diff --git a/src/Http/Middleware/InjectStructuredData.php b/src/Http/Middleware/InjectStructuredData.php
@@ -11,6 +11,8 @@
 use Statamic\Facades\Site;
 use Statamic\Facades\URL;
 use Statamic\Structures\Page;
+use Statamic\Facades\Term;
+use Statamic\Taxonomies\LocalizedTerm;
 
 class InjectStructuredData
 {
@@ -31,10 +33,21 @@ public function handle(Request $request, Closure $next)
 
         $entry = $this->getCurrentEntry();
 
-        if (! $entry) {
-            return $response;
+        if ($entry) {
+            return $this->handleEntry($response, $entry);
+        }
+
+        $term = $this->getCurrentTerm();
+
+        if ($term) {
+            return $this->handleTaxonomy($response, $term);
         }
 
+        return $response;
+    }
+
+    protected function handleEntry($response, $entry)
+    {
         if ($entry instanceof Page) {
             $entry = $entry->entry();
         }
@@ -45,7 +58,23 @@ public function handle(Request $request, Closure $next)
             return $response;
         }
 
-        $scripts = $this->structuredDataService->getJsonLdScripts($entry);
+        return $this->handleScripts($response, $entry);
+    }
+
+    protected function handleTaxonomy($response, $term)
+    {
+        $enabledTaxonomies = config('justbetter.structured-data.taxonomies', []);
+
+        if (! in_array($term?->taxonomy()?->handle(), $enabledTaxonomies)) {
+            return $response;
+        }
+
+        return $this->handleScripts($response, $term);
+    }
+
+    protected function handleScripts($response, $item)
+    {
+        $scripts = $this->structuredDataService->getJsonLdScripts($item);
 
         if (!$scripts ?? false) {
             return $response;
@@ -74,4 +103,10 @@ protected function getCurrentEntry(): Page|Entry|null
         $url = URL::getCurrent();
         return EntryFacade::findByUri($url, Site::current()->handle());
     }
+
+    protected function getCurrentTerm(): LocalizedTerm|null
+    {
+        $url = URL::getCurrent();
+        return Term::findByUri($url, Site::current()->handle());
+    }
 }
diff --git a/src/Listeners/AddStructuredDataTab.php b/src/Listeners/AddStructuredDataTab.php
@@ -3,25 +3,51 @@
 namespace Justbetter\StatamicStructuredData\Listeners;
 
 use Statamic\Events\EntryBlueprintFound;
+use Statamic\Events\TermBlueprintFound;
 use Statamic\Facades\Collection;
+use Statamic\Fields\Blueprint;
 
 class AddStructuredDataTab
 {
-    public function handle(EntryBlueprintFound $event): void
+    public function handle(EntryBlueprintFound|TermBlueprintFound $event): void
     {
         $blueprint = $event->blueprint;
 
-        if (! str_contains($blueprint->namespace(), 'collections')) {
+        if ($event instanceof EntryBlueprintFound && str_contains($blueprint->namespace(), 'collections')) {
+            $this->handleCollectionBlueprintFound($blueprint);
+            return;
+        } elseif ($event instanceof TermBlueprintFound && str_contains($blueprint->namespace(), 'taxonomies')) {
+            $this->handleTaxonomyBlueprintFound($blueprint);
             return;
         }
+    }
 
+    public function handleCollectionBlueprintFound(Blueprint $blueprint): void
+    {
         $handle = str_replace('collections.', '', $blueprint->namespace());
-
         $enabledCollections = config('justbetter.structured-data.collections', []);
+        
         if (! in_array($handle, $enabledCollections)) {
             return;
         }
 
+        $this->addStructuredDataTab($blueprint);
+    }
+
+    public function handleTaxonomyBlueprintFound(Blueprint $blueprint): void
+    {
+        $handle = str_replace('taxonomies.', '', $blueprint->namespace());
+        $enabledTaxonomies = config('justbetter.structured-data.taxonomies', []);
+
+        if (! in_array($handle, $enabledTaxonomies)) {
+            return;
+        }
+
+        $this->addStructuredDataTab($blueprint);
+    }
+
+    protected function addStructuredDataTab(Blueprint $blueprint): void
+    {
         $contents = $blueprint->contents();
 
         if (! isset($contents['tabs']['structured_data'])) {
diff --git a/src/Parser/StructuredDataParser.php b/src/Parser/StructuredDataParser.php
@@ -16,16 +16,16 @@ public function __construct()
         $this->structuredDataService = new StructuredDataService($this);
     }
 
-    public function parse($data, $entry)
+    public function parse($data, $item)
     {
-        return $this->parseAntlersInData($data, $entry);
+        return $this->parseAntlersInData($data, $item);
     }
 
-    protected function parseAntlersInData($data, $entry)
+    protected function parseAntlersInData($data, $item)
     {
         if (is_string($data)) {
             if (str_contains($data, '{{')) {
-                return (string) (new Antlers)->parse($data, $this->getParseContext($entry));
+                return (string) (new Antlers)->parse($data, $this->getParseContext($item));
             }
 
             if (str_contains($data, '@dataObject::')) {
@@ -40,20 +40,20 @@ protected function parseAntlersInData($data, $entry)
 
         if (is_array($data)) {
             foreach ($data as $key => $value) {
-                $data[$key] = $this->parseAntlersInData($value, $entry);
+                $data[$key] = $this->parseAntlersInData($value, $item);
             }
         }
 
         return $data;
     }
 
-    protected function getParseContext($entry): array
+    protected function getParseContext($item): array
     {
         return array_merge(
             ['config' => config()->all()],
             ['site' => Site::current()->toAugmentedArray()],
-            ['absolute_url' => $entry->absoluteUrl()],
-            $entry->toAugmentedArray()
+            ['absolute_url' => $item->absoluteUrl()],
+            $item->toAugmentedArray()
         );
     }
 
diff --git a/src/ServiceProvider.php b/src/ServiceProvider.php
@@ -11,6 +11,7 @@
 use Justbetter\StatamicStructuredData\Http\Middleware\InjectStructuredData;
 use Justbetter\StatamicStructuredData\Listeners\AddStructuredDataTab;
 use Statamic\Events\EntryBlueprintFound;
+use Statamic\Events\TermBlueprintFound;
 use Statamic\Facades\Blueprint;
 use Statamic\Facades\Collection;
 use Statamic\Facades\Site;
@@ -52,6 +53,7 @@ public function bootAddon()
     public function bootEvents()
     {
         Event::listen(EntryBlueprintFound::class, AddStructuredDataTab::class);
+        Event::listen(TermBlueprintFound::class, AddStructuredDataTab::class);
 
         return $this;
     }
diff --git a/src/Services/StructuredDataService.php b/src/Services/StructuredDataService.php
