feat: add UniqueId page and database property (#268)

mariosimao · Jul 26, 2023 · a71c275 · a71c275
1 parent b140a87
commit a71c275
Show file tree

Hide file tree

Showing 12 changed files with 241 additions and 2 deletions.
diff --git a/src/Databases/Properties/PropertyCollection.php b/src/Databases/Properties/PropertyCollection.php
@@ -251,6 +251,16 @@ public function getTitleById(string $propertyId): Title
         return $this->getTypedById($propertyId, Title::class);
     }
 
+    public function getUniqueId(string $propertyName): UniqueId
+    {
+        return $this->getTyped($propertyName, UniqueId::class);
+    }
+
+    public function getUniqueIdById(string $propertyName): UniqueId
+    {
+        return $this->getTypedById($propertyName, UniqueId::class);
+    }
+
     public function getUrl(string $propertyName): Url
     {
         return $this->getTyped($propertyName, Url::class);

diff --git a/src/Databases/Properties/PropertyFactory.php b/src/Databases/Properties/PropertyFactory.php
@@ -30,6 +30,7 @@ public static function fromArray(array $array): PropertyInterface
             PropertyType::Select         => Select::fromArray($array),
             PropertyType::Status         => Status::fromArray($array),
             PropertyType::Title          => Title::fromArray($array),
+            PropertyType::UniqueId       => UniqueId::fromArray($array),
             PropertyType::Url            => Url::fromArray($array),
             default                      => Unknown::fromArray($array),
         };

diff --git a/src/Databases/Properties/PropertyType.php b/src/Databases/Properties/PropertyType.php
@@ -24,5 +24,6 @@ enum PropertyType: string
     case Status = "status";
     case Title = "title";
     case Url = "url";
+    case UniqueId = "unique_id";
     case Unknown = "unknown";
 }
diff --git a/src/Databases/Properties/UniqueId.php b/src/Databases/Properties/UniqueId.php
@@ -0,0 +1,42 @@
+<?php
+
+namespace Notion\Databases\Properties;
+
+/**
+ * @psalm-type UniqueIdJson = array{
+ *      id: string,
+ *      name: string,
+ *      type: "uniqueId",
+ *      unique_id: \stdClass,
+ * }
+ *
+ * @psalm-immutable
+ */
+class UniqueId implements PropertyInterface
+{
+    private function __construct(
+        private readonly PropertyMetadata $metadata,
+    ) {
+    }
+
+    public function metadata(): PropertyMetadata
+    {
+        return $this->metadata;
+    }
+
+    public static function fromArray(array $array): self
+    {
+        /** @psalm-var UniqueIdJson $array */
+        $metadata = PropertyMetadata::fromArray($array);
+
+        return new self($metadata);
+    }
+
+    public function toArray(): array
+    {
+        $array = $this->metadata->toArray();
+        $array["unique_id"] = new \stdClass();
+
+        return $array;
+    }
+}
diff --git a/src/Pages/Properties/PropertyCollection.php b/src/Pages/Properties/PropertyCollection.php
@@ -254,14 +254,24 @@ public function getStatusById(string $propertyId): Status
         return $this->getTypedById($propertyId, Status::class);
     }
 
+    public function getUniqueId(string $propertyName): UniqueId
+    {
+        return $this->getTyped($propertyName, UniqueId::class);
+    }
+
+    public function getUniqueIdById(string $propertyId): UniqueId
+    {
+        return $this->getTypedById($propertyId, UniqueId::class);
+    }
+
     public function getUrl(string $propertyName): Url
     {
         return $this->getTyped($propertyName, Url::class);
     }
 
-    public function getUrlById(string $propertyName): Url
+    public function getUrlById(string $propertyId): Url
     {
-        return $this->getTypedById($propertyName, Url::class);
+        return $this->getTypedById($propertyId, Url::class);
     }
 
     /**

diff --git a/src/Pages/Properties/PropertyFactory.php b/src/Pages/Properties/PropertyFactory.php
@@ -30,6 +30,7 @@ public static function fromArray(array $array): PropertyInterface
             PropertyType::Select->value         => Select::fromArray($array),
             PropertyType::Status->value         => Status::fromArray($array),
             PropertyType::Title->value          => Title::fromArray($array),
+            PropertyType::UniqueId->value       => UniqueId::fromArray($array),
             PropertyType::Url->value            => Url::fromArray($array),
             default                             => Unknown::fromArray($array),
         };

diff --git a/src/Pages/Properties/PropertyType.php b/src/Pages/Properties/PropertyType.php
@@ -23,6 +23,7 @@ enum PropertyType: string
     case Select = "select";
     case Status = "status";
     case Title = "title";
+    case UniqueId = "unique_id";
     case Url = "url";
     case Unknown = "unknown";
 }
diff --git a/src/Pages/Properties/UniqueId.php b/src/Pages/Properties/UniqueId.php
@@ -0,0 +1,53 @@
+<?php
+
+namespace Notion\Pages\Properties;
+
+/**
+ * @psalm-type UniqueIdJson = array{
+ *      id: string,
+ *      type: "unique_id",
+ *      unique_id: array{
+ *          number: int,
+ *          prefix: string|null,
+ *      },
+ * }
+ *
+ * @psalm-immutable
+ */
+class UniqueId implements PropertyInterface
+{
+    private function __construct(
+        private readonly PropertyMetadata $metadata,
+        public readonly int $number,
+        public readonly string|null $prefix,
+    ) {
+    }
+
+    public static function fromArray(array $array): self
+    {
+        /** @psalm-var UniqueIdJson $array */
+        $metadata = PropertyMetadata::fromArray($array);
+
+        $number = $array["unique_id"]["number"];
+        $prefix = $array["unique_id"]["prefix"];
+
+        return new self($metadata, $number, $prefix);
+    }
+
+    public function toArray(): array
+    {
+        $array = $this->metadata->toArray();
+
+        $array["unique_id"] = [
+            "number" => $this->number,
+            "prefix" => $this->prefix,
+        ];
+
+        return $array;
+    }
+
+    public function metadata(): PropertyMetadata
+    {
+        return $this->metadata;
+    }
+}
diff --git a/tests/Unit/Databases/Properties/PropertyCollectionTest.php b/tests/Unit/Databases/Properties/PropertyCollectionTest.php
@@ -577,4 +577,32 @@ public function test_get_url_by_id(): void
 
         $this->assertSame($p, $c->getUrlById("abc"));
     }
+
+    public function test_get_unique_id(): void
+    {
+        $p = Properties\UniqueId::fromArray([
+            "id"    => "abc",
+            "name"  => "dummy",
+            "type"  => "unique_id",
+            "unique_id" => new \stdClass(),
+        ]);
+
+        $c = PropertyCollection::create($p);
+
+        $this->assertSame($p, $c->getUniqueId("dummy"));
+    }
+
+    public function test_get_unique_id_by_id(): void
+    {
+        $p = Properties\UniqueId::fromArray([
+            "id"    => "abc",
+            "name"  => "dummy",
+            "type"  => "unique_id",
+            "unique_id" => new \stdClass(),
+        ]);
+
+        $c = PropertyCollection::create($p);
+
+        $this->assertSame($p, $c->getUniqueIdById("abc"));
+    }
 }
diff --git a/tests/Unit/Databases/Properties/UniqueIdTest.php b/tests/Unit/Databases/Properties/UniqueIdTest.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace Notion\Test\Unit\Databases\Properties;
+
+use Notion\Databases\Properties\PropertyFactory;
+use Notion\Databases\Properties\PropertyType;
+use Notion\Databases\Properties\UniqueId;
+use PHPUnit\Framework\TestCase;
+
+class UniqueIdTest extends TestCase
+{
+    public function test_array_conversion(): void
+    {
+        $array = [
+            "id"    => "abc",
+            "name"  => "dummy",
+            "type"  => "unique_id",
+            "unique_id" => new \stdClass(),
+        ];
+        $prop = UniqueId::fromArray($array);
+        $fromFactory = PropertyFactory::fromArray($array);
+
+        $this->assertEquals($array, $prop->toArray());
+        $this->assertSame(PropertyType::UniqueId, $prop->metadata()->type);
+        $this->assertEquals($array, $fromFactory->toArray());
+    }
+}
diff --git a/tests/Unit/Pages/Properties/PropertyCollectionTest.php b/tests/Unit/Pages/Properties/PropertyCollectionTest.php
@@ -620,4 +620,36 @@ public function test_get_url(): void
 
         $this->assertSame($prop, $c->getUrl("Name"));
     }
+
+    public function test_get_unique_id_by_id(): void
+    {
+        $prop = Properties\UniqueId::fromArray([
+            "id" => "abc",
+            "type" => "unique_id",
+            "unique_id" => [
+                "number" => 123,
+                "prefix" => "ISSUE",
+            ],
+        ]);
+
+        $c = PropertyCollection::create([ "Name" => $prop ]);
+
+        $this->assertSame($prop, $c->getUniqueIdById("abc"));
+    }
+
+    public function test_get_unique_id(): void
+    {
+        $prop = Properties\UniqueId::fromArray([
+            "id" => "abc",
+            "type" => "unique_id",
+            "unique_id" => [
+                "number" => 123,
+                "prefix" => "ISSUE",
+            ],
+        ]);
+
+        $c = PropertyCollection::create([ "Name" => $prop ]);
+
+        $this->assertSame($prop, $c->getUniqueId("Name"));
+    }
 }
diff --git a/tests/Unit/Pages/Properties/UniqueIdTest.php b/tests/Unit/Pages/Properties/UniqueIdTest.php
@@ -0,0 +1,33 @@
+<?php
+
+namespace Notion\Test\Unit\Pages\Properties;
+
+use Notion\Pages\Properties\PropertyFactory;
+use Notion\Pages\Properties\PropertyType;
+use Notion\Pages\Properties\UniqueId;
+use PHPUnit\Framework\TestCase;
+
+class UniqueIdTest extends TestCase
+{
+    public function test_array_conversion(): void
+    {
+        $array = [
+            "id" => "abc",
+            "type" => "unique_id",
+            "unique_id" => [
+                "number" => 3,
+                "prefix" => "ISSUE"
+            ]
+        ];
+
+        $prop = UniqueId::fromArray($array);
+        $fromFactory = PropertyFactory::fromArray($array);
+
+        $this->assertEquals($array, $prop->toArray());
+        $this->assertEquals($array, $fromFactory->toArray());
+
+        $this->assertSame("ISSUE", $prop->prefix);
+        $this->assertSame(3, $prop->number);
+        $this->assertSame(PropertyType::UniqueId, $prop->metadata()->type);
+    }
+}