refactor: documents interfaces

Signed-off-by: Sebastian Krupinski <krupinski01@gmail.com>

shared/lib/Documents/Collection/CollectionBaseAbstract.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace KTXF\Documents\Collection;
+
+use KTXF\Resource\Identifier\CollectionIdentifier;
+use KTXF\Resource\Provider\Node\NodeBaseAbstract;
+
+/**
+ * Abstract Documents Collection Base Class
+ * 
+ * Provides common implementation for chrono collections
+ * 
+ * @since 2025.05.01
+ */
+abstract class CollectionBase extends NodeBaseAbstract implements CollectionBaseInterface {
+
+    protected CollectionPropertiesBaseAbstract $properties;
+
+    protected function nodeIdentifier(): CollectionIdentifier {
+        return new CollectionIdentifier($this->data[static::PROPERTY_PROVIDER], $this->data[static::PROPERTY_SERVICE], (string) $this->data[static::PROPERTY_IDENTIFIER]);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getProperties(): CollectionPropertiesBaseInterface {
+        return $this->properties;
+    }
+}

shared/lib/Documents/Collection/CollectionBaseInterface.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace KTXF\Documents\Collection;
+
+use KTXF\Resource\Provider\Node\NodeBaseInterface;
+
+/**
+ * Collection Base Interface
+ * 
+ * Interface represents a collection in a service
+ * 
+ * @since 2025.05.01
+ */
+interface CollectionBaseInterface extends NodeBaseInterface {
+
+    /**
+     * Gets the collection properties
+     * 
+     * @since 2025.05.01
+     */
+    public function getProperties(): CollectionPropertiesBaseInterface|CollectionPropertiesMutableInterface;
+
+}

shared/lib/Documents/Collection/CollectionContent.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace KTXF\Documents\Collection;
+
+use JsonSerializable;
+
+enum CollectionContent: string implements JsonSerializable {
+
+    case File = 'file';
+    case Folder = 'folder';
+
+    public function jsonSerialize(): string {
+        return $this->value;
+    }
+
+}

shared/lib/Documents/Collection/CollectionMutableAbstract.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace KTXF\Documents\Collection;
+
+use KTXF\Resource\Identifier\CollectionIdentifier;
+use KTXF\Resource\Provider\Node\NodeMutableAbstract;
+use KTXF\Resource\Provider\Node\NodePropertiesMutableInterface;
+
+/**
+ * Abstract Documents Collection Mutable Class
+ * 
+ * Provides common implementation for mutable chrono collections
+ * 
+ * @since 2025.05.01
+ */
+abstract class CollectionMutableAbstract extends NodeMutableAbstract implements CollectionMutableInterface {
+
+    protected CollectionPropertiesMutableAbstract $properties;
+
+    protected function nodeIdentifier(): CollectionIdentifier {
+        return new CollectionIdentifier($this->data[static::PROPERTY_PROVIDER], $this->data[static::PROPERTY_SERVICE], (string) $this->data[static::PROPERTY_IDENTIFIER]);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getProperties(): CollectionPropertiesMutableInterface {
+        return $this->properties;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function setProperties(NodePropertiesMutableInterface $value): static {
+        if (!$value instanceof CollectionPropertiesMutableInterface) {
+            throw new \InvalidArgumentException('Properties must implement CollectionPropertiesMutableInterface');
+        }
+
+        // Copy all property values
+        $this->properties->setLabel($value->getLabel());
+
+        return $this;
+    }
+}

shared/lib/Documents/Collection/CollectionMutableInterface.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace KTXF\Documents\Collection;
+
+use KTXF\Resource\Provider\Node\NodeMutableInterface;
+
+/**
+ * Documents Collection Mutable Interface
+ * 
+ * Interface for altering collection properties in a chrono service
+ * 
+ * @since 2025.05.01
+ * 
+ * @method static setProperties(CollectionPropertiesMutableInterface $value)
+ */
+interface CollectionMutableInterface extends CollectionBaseInterface, NodeMutableInterface {
+
+    /**
+     * Gets the collection properties (mutable)
+     * 
+     * @since 2025.05.01
+     */
+    public function getProperties(): CollectionPropertiesMutableInterface;
+
+}

shared/lib/Documents/Collection/CollectionPropertiesBaseAbstract.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace KTXF\Documents\Collection;
+
+use KTXF\Resource\Provider\Node\NodePropertiesBaseAbstract;
+
+/**
+ * Abstract Collection Properties Base Class
+ * 
+ * Provides common implementation for collection properties
+ * 
+ * @since 2025.05.01
+ */
+abstract class CollectionPropertiesBaseAbstract extends NodePropertiesBaseAbstract implements CollectionPropertiesBaseInterface {
+
+    public const JSON_TYPE = CollectionPropertiesBaseInterface::JSON_TYPE;
+
+    public function content(): CollectionContent {
+        $content = $this->data[self::PROPERTY_CONTENTS] ?? null;
+        if ($content instanceof CollectionContent) {
+            return $content;
+        }
+
+        if (is_string($content)) {
+            return CollectionContent::tryFrom($content) ?? CollectionContent::File;
+        }
+
+        return CollectionContent::File;
+    }
+
+    public function getLabel(): string {
+        return $this->data[self::PROPERTY_LABEL] ?? '';
+    }
+
+}

shared/lib/Documents/Collection/CollectionPropertiesBaseInterface.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace KTXF\Documents\Collection;
+
+use KTXF\Resource\Provider\Node\NodePropertiesBaseInterface;
+
+interface CollectionPropertiesBaseInterface extends NodePropertiesBaseInterface {
+
+	public const JSON_TYPE = 'document:collection';
+	public const PROPERTY_CONTENTS = 'content';
+	public const PROPERTY_LABEL = 'label';
+
+	public function content(): CollectionContent;
+
+	/**
+	 * Gets the human friendly name of this collection (e.g. Personal Calendar)
+	 *
+	 * @since 2025.05.01
+	 */
+	public function getLabel(): string;
+
+}

shared/lib/Documents/Collection/CollectionPropertiesMutableAbstract.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace KTXF\Documents\Collection;
+
+/**
+ * Abstract Documents Collection Properties Mutable Class
+ */
+abstract class CollectionPropertiesMutableAbstract extends CollectionPropertiesBaseAbstract implements CollectionPropertiesMutableInterface {
+
+    public const JSON_TYPE = CollectionPropertiesBaseInterface::JSON_TYPE;
+    
+    public function jsonDeserialize(array|string $data): static {
+        if (is_string($data)) {
+            $data = json_decode($data, true);
+        }
+
+        $this->data = $data;
+
+        return $this;
+    }
+    
+    public function setLabel(string $value): static {
+        $this->data[self::PROPERTY_LABEL] = $value;
+        return $this;
+    }
+
+}

shared/lib/Documents/Collection/CollectionPropertiesMutableInterface.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace KTXF\Documents\Collection;
+
+use KTXF\Resource\Provider\Node\NodePropertiesMutableInterface;
+
+interface CollectionPropertiesMutableInterface extends CollectionPropertiesBaseInterface, NodePropertiesMutableInterface {
+
+	public const JSON_TYPE = CollectionPropertiesBaseInterface::JSON_TYPE;
+
+	/**
+	 * Sets the human friendly name of this collection (e.g. Personal Calendar)
+	 *
+	 * @since 2025.05.01
+	 */
+	public function setLabel(string $value): static;
+
+}