Return the SEO Cascade via the REST API (#428)

Author: duncanmcclean

src/Fieldtypes/SeoProFieldtype.php

@@ -8,11 +8,17 @@
 use Statamic\Facades\GraphQL;
 use Statamic\Fields\Fields as BlueprintFields;
 use Statamic\Fields\Fieldtype;
+use Statamic\SeoPro\Cascade;
 use Statamic\SeoPro\Fields as SeoProFields;
+use Statamic\SeoPro\GetsSectionDefaults;
+use Statamic\SeoPro\SiteDefaults;
+use Statamic\Statamic;
 use Statamic\Support\Arr;
 
 class SeoProFieldtype extends Fieldtype
 {
+    use GetsSectionDefaults;
+
     protected $selectable = true;
     protected $icon = 'seo-search-graph';
 
@@ -77,6 +83,17 @@ public function extraRules(): array
 
     public function augment($data)
     {
+        if (Statamic::isApiRoute()) {
+            $content = $this->field()->parent();
+
+            return (new Cascade)
+                ->with(SiteDefaults::load()->augmented())
+                ->with($this->getAugmentedSectionDefaults($content))
+                ->with($data)
+                ->withCurrent($content)
+                ->get();
+        }
+
         if (empty($data) || ! is_iterable($data)) {
             return $data;
         }

tests/SeoProFieldtypeTest.php

@@ -0,0 +1,86 @@
+<?php
+
+namespace Tests;
+
+use Illuminate\Support\Facades\Request;
+use PHPUnit\Framework\Attributes\Test;
+use Statamic\Facades\Collection;
+use Statamic\Facades\Entry;
+use Statamic\Fields\Field;
+use Statamic\Fields\Value;
+use Statamic\SeoPro\Fieldtypes\SeoProFieldtype;
+
+class SeoProFieldtypeTest extends TestCase
+{
+    #[Test]
+    public function it_augments()
+    {
+        $field = (new SeoProFieldtype)->setField(new Field('test', ['type' => 'seo_pro']));
+
+        $augment = $field->augment([
+            'title' => 'Foo',
+            'description' => 'Bar',
+        ]);
+
+        $this->assertCount(2, $augment);
+
+        $this->assertInstanceOf(Value::class, $augment['title']);
+        $this->assertEquals('Foo', $augment['title']->value());
+
+        $this->assertInstanceOf(Value::class, $augment['description']);
+        $this->assertEquals('Bar', $augment['description']->value());
+    }
+
+    #[Test]
+    public function it_augments_for_api_routes()
+    {
+        config()->set('statamic.editions.pro', true);
+        config()->set('statamic.api.enabled', true);
+        config()->set('statamic.api.resources.collections', true);
+
+        // Changing our config values above won't register the API routes. To avoid
+        // undefined route errors, we'll register what we need here.
+        $this->app['router']->get('/api/collection/{collection}/entries/{handle}', fn () => null)->name('statamic.api.collections.entries.show');
+        $this->app['router']->getRoutes()->refreshNameLookups();
+
+        $this->app->instance('request', Request::create('/api/collections/pages/entries'));
+
+        $collection = tap(Collection::make('pages'))->save();
+        $entry = tap(Entry::make()->collection($collection)->data(['title' => 'Foo', 'description' => 'Bar']))->save();
+
+        $field = (new SeoProFieldtype)->setField((new Field('test', ['type' => 'seo_pro']))->setParent($entry));
+
+        $augment = $field->augment([
+            'title' => 'Foo',
+            'description' => 'Bar',
+        ]);
+
+        $this->assertArrayHasKeys([
+            'title',
+            'description',
+            'site_name',
+            'site_name_position',
+            'site_name_separator',
+            'canonical_url',
+            'priority',
+            'change_frequency',
+            'compiled_title',
+            'og_title',
+            'prev_url',
+            'next_url',
+            'home_url',
+            'humans_txt',
+            'site',
+            'alternate_locales',
+            'current_hreflang',
+            'last_modified',
+            'twitter_card',
+            'twitter_title',
+            'twitter_description',
+        ], $augment);
+
+        $this->assertEquals('Foo', (string) $augment['title']);
+        $this->assertEquals('Bar', (string) $augment['description']);
+        $this->assertEquals('Site Name', (string) $augment['site_name']); // Site default
+    }
+}

tests/TestCase.php

@@ -150,6 +150,13 @@ public static function assertStringNotContainsStringIgnoringLineEndings($needle,
         );
     }
 
+    protected function assertArrayHasKeys(array $keys, array|\ArrayAccess $array): void
+    {
+        foreach ($keys as $key) {
+            $this->assertArrayHasKey($key, $array);
+        }
+    }
+
     private function addGqlMacros()
     {
         TestResponse::macro('assertGqlOk', function () {