feat(type): Introduce MultiLink value object (#45)

Author: silasjoisten

phpstan-baseline.neon

@@ -54,6 +54,12 @@ parameters:
 			count: 1
 			path: src/Bridge/Faker/Provider/StoryblokProvider.php
 
+		-
+			message: '#^Method Storyblok\\Api\\Bridge\\Faker\\Provider\\StoryblokProvider\:\:multiLinkResponse\(\) should return array\{id\: string, url\: string, email\: string, linktype\: string, fieldtype\: string\} but returns array\.$#'
+			identifier: return.type
+			count: 1
+			path: src/Bridge/Faker/Provider/StoryblokProvider.php
+
 		-
 			message: '#^Method Storyblok\\Api\\Bridge\\Faker\\Provider\\StoryblokProvider\:\:richTextResponse\(\) should return array\{type\: string, content\: list\<array\<mixed\>\>\} but returns array\.$#'
 			identifier: return.type

src/Bridge/Faker/Generator.php

@@ -31,6 +31,7 @@
  * @method array  linkAlternateResponse(array $overrides = [])
  * @method array  linkResponse(array $overrides = [])
  * @method array  linksResponse(array $overrides = [])
+ * @method array  multiLinkResponse(array $overrides = [])
  * @method string relation()
  * @method array  richTextEmptyResponse()
  * @method array  richTextParagraphResponse(?string $text = null)

src/Bridge/Faker/Provider/StoryblokProvider.php

@@ -15,6 +15,7 @@
 namespace Storyblok\Api\Bridge\Faker\Provider;
 
 use Faker\Provider\Base as BaseProvider;
+use Storyblok\Api\Domain\Type\MultiLinkType;
 use function Safe\array_replace_recursive;
 use function Safe\json_encode;
 
@@ -537,6 +538,39 @@ public function richTextResponse(array $overrides = []): array
         );
     }
 
+    /**
+     * @param array{
+     *     id?: string,
+     *     url?: string,
+     *     email?: string,
+     *     linktype?: string,
+     *     fieldtype?: string
+     * } $overrides
+     *
+     * @return array{
+     *     id: string,
+     *     url: string,
+     *     email: string,
+     *     linktype: string,
+     *     fieldtype: string
+     * }
+     */
+    public function multiLinkResponse(array $overrides = []): array
+    {
+        $response = [
+            'id' => $this->generator->uuid(),
+            'url' => $this->generator->url(),
+            'email' => $this->generator->email(),
+            'linktype' => $this->generator->randomElement(MultiLinkType::cases())->value,
+            'fieldtype' => 'multilink',
+        ];
+
+        return array_replace_recursive(
+            $response,
+            $overrides,
+        );
+    }
+
     /**
      * @return array{
      *     type: 'doc',

src/Domain/Type/MultiLink.php

@@ -0,0 +1,73 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of storyblok/php-content-api-client.
+ *
+ * (c) Storyblok GmbH <[email protected]>
+ * in cooperation with SensioLabs Deutschland <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Storyblok\Api\Domain\Type;
+
+use OskarStark\Value\TrimmedNonEmptyString;
+use Storyblok\Api\Domain\Value\Uuid;
+use Webmozart\Assert\Assert;
+
+/**
+ * @experimental This class is experimental and may change in future versions.
+ * 
+ * @author Silas Joisten <[email protected]>
+ */
+final readonly class MultiLink
+{
+    public MultiLinkType $type;
+    public ?Uuid $id;
+    public ?string $url;
+
+    /**
+     * @param array<string, mixed> $values
+     */
+    public function __construct(array $values)
+    {
+        Assert::keyExists($values, 'fieldtype');
+        Assert::same($values['fieldtype'], 'multilink');
+
+        Assert::keyExists($values, 'linktype');
+        TrimmedNonEmptyString::fromString($values['linktype']);
+        $this->type = MultiLinkType::from($values['linktype']);
+
+        $url = null;
+        $id = null;
+
+        if ($this->type->equals(MultiLinkType::Asset)) {
+            Assert::keyExists($values, 'url');
+            $url = TrimmedNonEmptyString::fromString($values['url'])->toString();
+            Assert::startsWith($url, 'http');
+        }
+
+        if ($this->type->equals(MultiLinkType::Email)) {
+            Assert::keyExists($values, 'email');
+            $email = TrimmedNonEmptyString::fromString($values['email'])->toString();
+            Assert::email($email);
+            $url = \sprintf('mailto:%s', $email);
+        }
+
+        if ($this->type->equals(MultiLinkType::Story)) {
+            Assert::keyExists($values, 'id');
+            $id = new Uuid($values['id']);
+        }
+
+        if ($this->type->equals(MultiLinkType::Url)) {
+            Assert::keyExists($values, 'url');
+            $url = TrimmedNonEmptyString::fromString($values['url'])->toString();
+        }
+
+        $this->id = $id;
+        $this->url = $url;
+    }
+}

src/Domain/Type/MultiLinkType.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of storyblok/php-content-api-client.
+ *
+ * (c) Storyblok GmbH <[email protected]>
+ * in cooperation with SensioLabs Deutschland <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Storyblok\Api\Domain\Type;
+
+use OskarStark\Enum\Trait\Comparable;
+
+/**
+ * @experimental This class is experimental and may change in future versions.
+ *
+ * @author Silas Joisten <[email protected]>
+ */
+enum MultiLinkType: string
+{
+    use Comparable;
+
+    case Asset = 'asset';
+    case Email = 'email';
+    case Story = 'story';
+    case Url = 'url';
+}