Added support for structured data templates on Terms

Author: kevinmeijer97

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.

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'
+    ],
 ];

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:

resources/dist/build/assets/statamic-structured-data-33d7377e.css renamed to resources/dist/build/assets/statamic-structured-data-05ad0e35.css

@@ -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"
   }

resources/dist/build/assets/statamic-structured-data-08e9c173.js renamed to resources/dist/build/assets/statamic-structured-data-0787df7f.js

@@ -68,7 +68,8 @@ export default {
         variables() {
             return this.meta?.variables || {
                 config: {},
-                entry: []
+                entry: [],
+                term: []
             };
         },
 

resources/dist/build/manifest.json

@@ -31,11 +31,12 @@ protected function getAvailableVariables(): array
     {
         return [
             'site' => [
-                    ['name' => 'site:name', 'description' => 'Site Name'],
-                    ['name' => 'site:url', 'description' => 'Site URL'],
-                ],
+                ['name' => 'site:name', 'description' => 'Site Name'],
+                ['name' => 'site:url', 'description' => 'Site URL'],
+            ],
             'globals' => $this->getGlobalVariables(),
             'entry' => $this->getEntryFields(),
+            'term' => $this->getTermFields(),
         ];
     }
 
@@ -65,15 +66,15 @@ protected function getEntryFields(): array
             return [];
         }
 
-        $fields = collect($dataTemplate?->use_for_collection?->entryBlueprints()?->reduce(function($carry, $blueprint) {
+        $fields = collect($dataTemplate?->use_for_collection?->entryBlueprints()?->reduce(function ($carry, $blueprint) {
             return array_merge($carry, $blueprint->fields()->items()->toArray());
         }, []) ?? []);
 
-        if(class_exists(OnPageSeoBlueprint::class)) {
+        if (class_exists(OnPageSeoBlueprint::class)) {
             $fields = $fields->merge(OnPageSeoBlueprint::requestBlueprint()->fields()?->items());
         }
 
-        if (!$fields) {
+        if (! $fields) {
             return [];
         }
 
@@ -82,9 +83,41 @@ protected function getEntryFields(): array
         $collectionFields = $fields->map(function ($field) {
             return $this->setFieldData($field);
         })
-        ->filter()
-        ->values()
-        ->all();
+            ->filter()
+            ->values()
+            ->all();
+
+        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);
     }
@@ -99,8 +132,9 @@ protected function getGlobalVariables(): array
 
             if ($fields) {
                 $globalVariables = $fields->items()->map(function ($field) use ($globalSet) {
-                    $name = ($globalSet->handle() . ':' . ($field['handle'] ?? ''));
+                    $name = ($globalSet->handle().':'.($field['handle'] ?? ''));
                     $description = ($field['field']['display'] ?? ($field['handle'] ?? ''));
+
                     return $this->setFieldData($field, $name, $description);
                 })->values()->all();
             }
@@ -113,27 +147,28 @@ protected function getGlobalVariables(): array
 
     protected function getCollectionVariables(string $collectionHandle, array $field): array
     {
-        if(!$collectionHandle || $collectionHandle === 'structured_data_templates') {
+        if (! $collectionHandle || $collectionHandle === 'structured_data_templates') {
             return [];
         }
 
         return Collection::find($collectionHandle)?->entryBlueprints()?->first()?->fields()?->items()?->map(function ($entryField) use ($field) {
-            $name = ($field['handle'] . ':' . ($entryField['handle'] ?? ''));
-            $description = (($field['field']['display'] ?? '') . ': ' . ($entryField['field']['display'] ?? ($entryField['handle'] ?? '')));
+            $name = ($field['handle'].':'.($entryField['handle'] ?? ''));
+            $description = (($field['field']['display'] ?? '').': '.($entryField['field']['display'] ?? ($entryField['handle'] ?? '')));
+
             return $this->setFieldData($entryField, $name, $description, false);
         })->filter()->values()->all();
     }
 
     protected function setFieldData(array $field, ?string $name = null, ?string $description = null, bool $recursive = true): ?array
     {
-        if(!($field['handle'] ?? false) || $field['handle'] === 'parent' || !($field['field']['type'] ?? false) || !$this->fieldTypeIsEligible($field['field']['type'])) {
+        if (! ($field['handle'] ?? false) || $field['handle'] === 'parent' || ! ($field['field']['type'] ?? false) || ! $this->fieldTypeIsEligible($field['field']['type'])) {
             return null;
         }
 
         $children = [];
 
-        if($field['field']['type'] === 'entries' && $recursive) {
-            if(!isset($field['field']['collections'][0])) {
+        if ($field['field']['type'] === 'entries' && $recursive) {
+            if (! isset($field['field']['collections'][0])) {
                 return null;
             }
 
@@ -143,7 +178,7 @@ protected function setFieldData(array $field, ?string $name = null, ?string $des
         return [
             'name' => $name ?? $field['handle'],
             'description' => $description ?? ($field['field']['display'] ?? $field['handle']),
-            'children' => $children
+            'children' => $children,
         ];
     }
 }

resources/js/components/fieldtypes/AvailableVariables.vue

@@ -4,8 +4,8 @@
 
 use Illuminate\Support\Collection;
 use Statamic\Facades\Site;
-use Statamic\Fields\Fieldtype;
 use Statamic\Facades\Taxonomy;
+use Statamic\Fields\Fieldtype;
 
 class StructuredDataBuilder extends Fieldtype
 {

src/Fieldtypes/AvailableVariablesFieldtype.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);
         }
@@ -50,7 +55,7 @@ public function getTemplates(Request $request)
 
                 $structuredData = $entry->schema_data;
 
-                if (!$structuredData) {
+                if (! $structuredData) {
                     return null;
                 }
 
@@ -86,7 +91,7 @@ public function getAvailableVariables(Request $request)
             'entry' => [],
         ];
 
-        if (!$entry) {
+        if (! $entry) {
             return response()->json($variables);
         }