Nodarx/server
1
0
Fork 0
Code Issues 1 Pull Requests Actions Projects Releases Activity

refactor: documents
All checks were successful
JS Unit Tests / test (pull_request) Successful in 21s
Details
Build Test / build (pull_request) Successful in 25s
Details
PHP Unit Tests / test (pull_request) Successful in 46s
Details

Browse Source 
Signed-off-by: Sebastian Krupinski <krupinski01@gmail.com>
This commit is contained in:
Sebastian Krupinski
2026-03-03 22:13:36 -05:00
parent 85e89dca87
commit 1f3e87535b
45 changed files with 1667 additions and 676 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
shared/lib/Chrono/Collection/CollectionMutableAbstract.php
View File

@@ -40,11 +40,7 @@ abstract class CollectionMutableAbstract extends NodeMutableAbstract implements
// Copy all property values
$this->properties->setLabel($value->getLabel());
$this->properties->setDescription($value->getDescription());
$this->properties->setPriority($value->getPriority());
$this->properties->setVisibility($value->getVisibility());
$this->properties->setColor($value->getColor());
return $this;
}
}

2
shared/lib/Chrono/Provider/ProviderServiceTestInterface.php
View File

@@ -9,7 +9,7 @@ declare(strict_types=1);
namespace KTXF\Chrono\Provider;
use KTXF\Mail\Service\ServiceBaseInterface;
use KTXF\Chrono\Service\ServiceBaseInterface;
/**
* Chrono Provider Service Test Interface

16
shared/lib/Files/Provider/IProviderBase.php
View File

@@ -1,16 +0,0 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Files\Provider;
use KTXF\Resource\Provider\ResourceProviderInterface;
interface IProviderBase extends ResourceProviderInterface {
}

333
shared/lib/Files/Service/IServiceBase.php
View File

@@ -1,333 +0,0 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Files\Service;
use JsonSerializable;
use KTXF\Files\Node\INodeBase;
use KTXF\Files\Node\INodeCollectionBase;
use KTXF\Files\Node\INodeEntityBase;
use KTXF\Resource\Filter\IFilter;
use KTXF\Resource\Range\IRange;
use KTXF\Resource\Range\RangeType;
use KTXF\Resource\Sort\ISort;
interface IServiceBase extends JsonSerializable {
// Collection Capabilities
public const CAPABILITY_COLLECTION_LIST = 'CollectionList';
public const CAPABILITY_COLLECTION_LIST_FILTER = 'CollectionListFilter';
public const CAPABILITY_COLLECTION_LIST_SORT = 'CollectionListSort';
public const CAPABILITY_COLLECTION_EXTANT = 'CollectionExtant';
public const CAPABILITY_COLLECTION_FETCH = 'CollectionFetch';
// Entity Capabilities
public const CAPABILITY_ENTITY_LIST = 'EntityList';
public const CAPABILITY_ENTITY_LIST_FILTER = 'EntityListFilter';
public const CAPABILITY_ENTITY_LIST_SORT = 'EntityListSort';
public const CAPABILITY_ENTITY_LIST_RANGE = 'EntityListRange';
public const CAPABILITY_ENTITY_DELTA = 'EntityDelta';
public const CAPABILITY_ENTITY_EXTANT = 'EntityExtant';
public const CAPABILITY_ENTITY_FETCH = 'EntityFetch';
public const CAPABILITY_ENTITY_READ = 'EntityRead';
public const CAPABILITY_ENTITY_READ_STREAM = 'EntityReadStream';
public const CAPABILITY_ENTITY_READ_CHUNK = 'EntityReadChunk';
// Node Capabilities (recursive/unified)
public const CAPABILITY_NODE_LIST = 'NodeList';
public const CAPABILITY_NODE_LIST_FILTER = 'NodeListFilter';
public const CAPABILITY_NODE_LIST_SORT = 'NodeListSort';
public const CAPABILITY_NODE_LIST_RANGE = 'NodeListRange';
public const CAPABILITY_NODE_DELTA = 'NodeDelta';
// JSON Constants
public const JSON_TYPE = 'files.service';
public const JSON_PROPERTY_TYPE = '@type';
public const JSON_PROPERTY_PROVIDER = 'provider';
public const JSON_PROPERTY_ID = 'id';
public const JSON_PROPERTY_LABEL = 'label';
public const JSON_PROPERTY_CAPABILITIES = 'capabilities';
public const JSON_PROPERTY_ENABLED = 'enabled';
/**
* Confirms if specific capability is supported
*
* @since 2025.11.01
*
* @param string $value required ability e.g. 'EntityList'
*
* @return bool
*/
public function capable(string $value): bool;
/**
* Lists all supported capabilities
*
* @since 2025.11.01
*
* @return array<string,bool>
*/
public function capabilities(): array;
/**
* Unique identifier of the provider this service belongs to
*
* @since 2025.11.01
*/
public function in(): string;
/**
* Unique arbitrary text string identifying this service (e.g. 1 or service1 or anything else)
*
* @since 2025.11.01
*/
public function id(): string|int;
/**
* Gets the localized human friendly name of this service (e.g. ACME Company File Service)
*
* @since 2025.11.01
*/
public function getLabel(): string;
/**
* Gets the active status of this service
*
* @since 2025.11.01
*/
public function getEnabled(): bool;
// ==================== Collection Methods ====================
/**
* List of accessible collections at a specific location
*
* @since 2025.11.01
*
* @param string|int|null $location Parent collection identifier, null for root
*
* @return array<string|int,INodeCollectionBase>
*/
public function collectionList(string|int|null $location = null, ?IFilter $filter = null, ?ISort $sort = null): array;
/**
* Fresh filter for collection list
*
* @since 2025.11.01
*/
public function collectionListFilter(): IFilter;
/**
* Fresh sort for collection list
*
* @since 2025.11.01
*/
public function collectionListSort(): ISort;
/**
* Confirms if specific collection exists
*
* @since 2025.11.01
*
* @param string|int|null $identifier Collection identifier
*/
public function collectionExtant(string|int|null $identifier): bool;
/**
* Fetches details about a specific collection
*
* @since 2025.11.01
*
* @param string|int|null $identifier Collection identifier
*/
public function collectionFetch(string|int|null $identifier): ?INodeCollectionBase;
// ==================== Entity Methods ====================
/**
* Lists all entities in a specific collection
*
* @since 2025.11.01
*
* @param string|int|null $collection Collection identifier
*
* @return array<string|int,INodeEntityBase>
*/
public function entityList(string|int|null $collection, ?IFilter $filter = null, ?ISort $sort = null, ?IRange $range = null): array;
/**
* Fresh filter for entity list
*
* @since 2025.11.01
*/
public function entityListFilter(): IFilter;
/**
* Fresh sort for entity list
*
* @since 2025.11.01
*/
public function entityListSort(): ISort;
/**
* Fresh range for entity list
*
* @since 2025.11.01
*/
public function entityListRange(RangeType $type): IRange;
/**
* Lists all changes from a specific signature
*
* @since 2025.11.01
*
* @param string|int|null $collection Collection identifier
* @param string $signature Sync token signature
* @param string $detail Detail level: ids | meta | full
*
* @return array{
* added: array<string|int>,
* updated: array<string|int>,
* deleted: array<string|int>,
* signature: string
* }
*/
public function entityDelta(string|int|null $collection, string $signature, string $detail = 'ids'): array;
/**
* Confirms if specific entities exist in a collection
*
* @since 2025.11.01
*
* @param string|int|null $collection Collection identifier
* @param string|int ...$identifiers Entity identifiers
*
* @return array<string|int,bool>
*/
public function entityExtant(string|int|null $collection, string|int ...$identifiers): array;
/**
* Fetches details about specific entities in a collection
*
* @since 2025.11.01
*
* @param string|int|null $collection Collection identifier
* @param string|int ...$identifiers Entity identifiers
*
* @return array<string|int,INodeEntityBase>
*/
public function entityFetch(string|int|null $collection, string|int ...$identifiers): array;
/**
* Reads the entire content of an entity as a string
*
* @since 2025.11.01
*
* @param string|int|null $collection Collection identifier
* @param string|int $identifier Entity identifier
*
* @return string|null File content or null if not found
*
* @throws \KTXF\Resource\Exceptions\InvalidArgumentException
* @throws \KTXF\Resource\Exceptions\UnsupportedException
* @throws \KTXF\Resource\Exceptions\UnauthorizedException
*/
public function entityRead(string|int|null $collection, string|int $identifier): ?string;
/**
* Opens a stream to read the content of an entity
*
* @since 2025.11.01
*
* @param string|int|null $collection Collection identifier
* @param string|int $identifier Entity identifier
*
* @return resource|null Stream resource or null if not found
*
* @throws \KTXF\Resource\Exceptions\InvalidArgumentException
* @throws \KTXF\Resource\Exceptions\UnsupportedException
* @throws \KTXF\Resource\Exceptions\UnauthorizedException
*/
public function entityReadStream(string|int|null $collection, string|int $identifier);
/**
* Reads a chunk of content from an entity
*
* @since 2025.11.01
*
* @param string|int|null $collection Collection identifier
* @param string|int $identifier Entity identifier
* @param int $offset Starting byte position (0-indexed)
* @param int $length Number of bytes to read
*
* @return string|null Chunk content or null if not found
*
* @throws \KTXF\Resource\Exceptions\InvalidArgumentException
* @throws \KTXF\Resource\Exceptions\UnsupportedException
* @throws \KTXF\Resource\Exceptions\UnauthorizedException
*/
public function entityReadChunk(string|int|null $collection, string|int $identifier, int $offset, int $length): ?string;
// ==================== Node Methods (Recursive/Unified) ====================
/**
* Lists all nodes (collections and entities) at a location, optionally recursive
* Returns a flat list with parent references via in()
*
* @since 2025.11.01
*
* @param string|int|null $location Starting location, null for root
* @param bool $recursive Whether to list recursively
*
* @return array<string|int,INodeBase>
*/
public function nodeList(string|int|null $location = null, bool $recursive = false, ?IFilter $filter = null, ?ISort $sort = null, ?IRange $range = null): array;
/**
* Fresh filter for node list
*
* @since 2025.11.01
*/
public function nodeListFilter(): IFilter;
/**
* Fresh sort for node list
*
* @since 2025.11.01
*/
public function nodeListSort(): ISort;
/**
* Fresh range for node list
*
* @since 2025.11.01
*/
public function nodeListRange(RangeType $type): IRange;
/**
* Lists all node changes from a specific signature, optionally recursive
* Returns flat list with parent references
*
* @since 2025.11.01
*
* @param string|int|null $location Starting location, null for root
* @param string $signature Sync token signature
* @param bool $recursive Whether to include recursive changes
* @param string $detail Detail level: ids | meta | full
*
* @return array{
* added: array<string|int,INodeBase>|array<string|int>,
* updated: array<string|int,INodeBase>|array<string|int>,
* deleted: array<string|int>,
* signature: string
* }
*/
public function nodeDelta(string|int|null $location, string $signature, bool $recursive = false, string $detail = 'ids'): array;
}

100
shared/lib/Files/Service/IServiceCollectionMutable.php
View File

@@ -1,100 +0,0 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Files\Service;
use KTXF\Files\Node\INodeCollectionBase;
use KTXF\Files\Node\INodeCollectionMutable;
interface IServiceCollectionMutable extends IServiceBase {
public const CAPABILITY_COLLECTION_CREATE = 'CollectionCreate';
public const CAPABILITY_COLLECTION_MODIFY = 'CollectionModify';
public const CAPABILITY_COLLECTION_DESTROY = 'CollectionDestroy';
public const CAPABILITY_COLLECTION_COPY = 'CollectionCopy';
public const CAPABILITY_COLLECTION_MOVE = 'CollectionMove';
/**
* Creates a new, empty collection node
*
* @since 2025.11.01
*/
public function collectionFresh(): INodeCollectionMutable;
/**
* Creates a new collection at the specified location
*
* @since 2025.11.01
*
* @param string|int|null $location Parent collection, null for root
* @param INodeCollectionMutable $collection The collection to create
* @param array $options Additional options
*
* @throws \KTXF\Resource\Exceptions\InvalidArgumentException
* @throws \KTXF\Resource\Exceptions\UnsupportedException
* @throws \KTXF\Resource\Exceptions\UnauthorizedException
*/
public function collectionCreate(string|int|null $location, INodeCollectionMutable $collection, array $options = []): INodeCollectionBase;
/**
* Modifies an existing collection
*
* @since 2025.11.01
*
* @param string|int $identifier Collection identifier
* @param INodeCollectionMutable $collection The collection with modifications
*
* @throws \KTXF\Resource\Exceptions\InvalidArgumentException
* @throws \KTXF\Resource\Exceptions\UnsupportedException
* @throws \KTXF\Resource\Exceptions\UnauthorizedException
*/
public function collectionModify(string|int $identifier, INodeCollectionMutable $collection): INodeCollectionBase;
/**
* Destroys an existing collection
*
* @since 2025.11.01
*
* @param string|int $identifier Collection identifier
*
* @throws \KTXF\Resource\Exceptions\InvalidArgumentException
* @throws \KTXF\Resource\Exceptions\UnsupportedException
* @throws \KTXF\Resource\Exceptions\UnauthorizedException
*/
public function collectionDestroy(string|int $identifier): bool;
/**
* Copies an existing collection to a new location
*
* @since 2025.11.01
*
* @param string|int $identifier Collection identifier
* @param string|int|null $location Destination parent collection, null for root
*
* @throws \KTXF\Resource\Exceptions\InvalidArgumentException
* @throws \KTXF\Resource\Exceptions\UnsupportedException
* @throws \KTXF\Resource\Exceptions\UnauthorizedException
*/
public function collectionCopy(string|int $identifier, string|int|null $location): INodeCollectionBase;
/**
* Moves an existing collection to a new location
*
* @since 2025.11.01
*
* @param string|int $identifier Collection identifier
* @param string|int|null $location Destination parent collection, null for root
*
* @throws \KTXF\Resource\Exceptions\InvalidArgumentException
* @throws \KTXF\Resource\Exceptions\UnsupportedException
* @throws \KTXF\Resource\Exceptions\UnauthorizedException
*/
public function collectionMove(string|int $identifier, string|int|null $location): INodeCollectionBase;
}

158
shared/lib/Files/Service/IServiceEntityMutable.php
View File

@@ -1,158 +0,0 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Files\Service;
use KTXF\Files\Node\INodeEntityBase;
use KTXF\Files\Node\INodeEntityMutable;
interface IServiceEntityMutable extends IServiceBase {
public const CAPABILITY_ENTITY_CREATE = 'EntityCreate';
public const CAPABILITY_ENTITY_MODIFY = 'EntityModify';
public const CAPABILITY_ENTITY_DESTROY = 'EntityDestroy';
public const CAPABILITY_ENTITY_COPY = 'EntityCopy';
public const CAPABILITY_ENTITY_MOVE = 'EntityMove';
public const CAPABILITY_ENTITY_WRITE = 'EntityWrite';
public const CAPABILITY_ENTITY_WRITE_STREAM = 'EntityWriteStream';
public const CAPABILITY_ENTITY_WRITE_CHUNK = 'EntityWriteChunk';
/**
* Creates a new, empty entity node
*
* @since 2025.11.01
*/
public function entityFresh(): INodeEntityMutable;
/**
* Creates a new entity in the specified collection
*
* @since 2025.11.01
*
* @param string|int|null $collection Collection identifier, null for root
* @param INodeEntityMutable $entity The entity to create
* @param array $options Additional options
*
* @throws \KTXF\Resource\Exceptions\InvalidArgumentException
* @throws \KTXF\Resource\Exceptions\UnsupportedException
* @throws \KTXF\Resource\Exceptions\UnauthorizedException
*/
public function entityCreate(string|int|null $collection, INodeEntityMutable $entity, array $options = []): INodeEntityBase;
/**
* Modifies an existing entity in the specified collection
*
* @since 2025.11.01
*
* @param string|int|null $collection Collection identifier
* @param string|int $identifier Entity identifier
* @param INodeEntityMutable $entity The entity with modifications
*
* @throws \KTXF\Resource\Exceptions\InvalidArgumentException
* @throws \KTXF\Resource\Exceptions\UnsupportedException
* @throws \KTXF\Resource\Exceptions\UnauthorizedException
*/
public function entityModify(string|int|null $collection, string|int $identifier, INodeEntityMutable $entity): INodeEntityBase;
/**
* Destroys an existing entity in the specified collection
*
* @since 2025.11.01
*
* @param string|int|null $collection Collection identifier
* @param string|int $identifier Entity identifier
*
* @throws \KTXF\Resource\Exceptions\InvalidArgumentException
* @throws \KTXF\Resource\Exceptions\UnsupportedException
* @throws \KTXF\Resource\Exceptions\UnauthorizedException
*/
public function entityDestroy(string|int|null $collection, string|int $identifier): bool;
/**
* Copies an existing entity to a new collection
*
* @since 2025.11.01
*
* @param string|int|null $collection Source collection identifier
* @param string|int $identifier Entity identifier
* @param string|int|null $destination Destination collection identifier, null for root
*
* @throws \KTXF\Resource\Exceptions\InvalidArgumentException
* @throws \KTXF\Resource\Exceptions\UnsupportedException
* @throws \KTXF\Resource\Exceptions\UnauthorizedException
*/
public function entityCopy(string|int|null $collection, string|int $identifier, string|int|null $destination): INodeEntityBase;
/**
* Moves an existing entity to a new collection
*
* @since 2025.11.01
*
* @param string|int|null $collection Source collection identifier
* @param string|int $identifier Entity identifier
* @param string|int|null $destination Destination collection identifier, null for root
*
* @throws \KTXF\Resource\Exceptions\InvalidArgumentException
* @throws \KTXF\Resource\Exceptions\UnsupportedException
* @throws \KTXF\Resource\Exceptions\UnauthorizedException
*/
public function entityMove(string|int|null $collection, string|int $identifier, string|int|null $destination): INodeEntityBase;
/**
* Writes the entire content of an entity from a string
*
* @since 2025.11.01
*
* @param string|int|null $collection Collection identifier
* @param string|int $identifier Entity identifier
* @param string $data Content to write
*
* @return int Number of bytes written
*
* @throws \KTXF\Resource\Exceptions\InvalidArgumentException
* @throws \KTXF\Resource\Exceptions\UnsupportedException
* @throws \KTXF\Resource\Exceptions\UnauthorizedException
*/
public function entityWrite(string|int|null $collection, string|int $identifier, string $data): int;
/**
* Opens a stream to write the content of an entity
*
* @since 2025.11.01
*
* @param string|int|null $collection Collection identifier
* @param string|int $identifier Entity identifier
*
* @return resource Stream resource for writing
*
* @throws \KTXF\Resource\Exceptions\InvalidArgumentException
* @throws \KTXF\Resource\Exceptions\UnsupportedException
* @throws \KTXF\Resource\Exceptions\UnauthorizedException
*/
public function entityWriteStream(string|int|null $collection, string|int $identifier);
/**
* Writes a chunk of content to an entity at a specific position
*
* @since 2025.11.01
*
* @param string|int|null $collection Collection identifier
* @param string|int $identifier Entity identifier
* @param int $offset Starting byte position (0-indexed)
* @param string $data Chunk content to write
*
* @return int Number of bytes written
*
* @throws \KTXF\Resource\Exceptions\InvalidArgumentException
* @throws \KTXF\Resource\Exceptions\UnsupportedException
* @throws \KTXF\Resource\Exceptions\UnauthorizedException
*/
public function entityWriteChunk(string|int|null $collection, string|int $identifier, int $offset, string $data): int;
}

30
shared/lib/Files/Service/IServiceMutable.php
View File

@@ -1,30 +0,0 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Files\Service;
use KTXF\Json\JsonDeserializable;
interface IServiceMutable extends IServiceBase, JsonDeserializable {
/**
* Sets the localized human friendly name of this service
*
* @since 2025.11.01
*/
public function setLabel(string $value): static;
/**
* Sets the active status of this service
*
* @since 2025.11.01
*/
public function setEnabled(bool $value): static;
}

9
shared/lib/Mail/Object/MessagePropertiesBaseAbstract.php
View File

@@ -23,13 +23,6 @@ abstract class MessagePropertiesBaseAbstract extends NodePropertiesBaseAbstract
public const JSON_TYPE = MessagePropertiesBaseInterface::JSON_TYPE;
/**
* @inheritDoc
*/
public function version(): int {
return $this->data['version'] ?? 1;
}
/**
* @inheritDoc
*/
@@ -337,7 +330,7 @@ abstract class MessagePropertiesBaseAbstract extends NodePropertiesBaseAbstract
public function jsonSerialize(): array {
$data = [
self::JSON_PROPERTY_TYPE => self::JSON_TYPE,
self::JSON_PROPERTY_VERSION => $this->data['version'] ?? 1,
self::JSON_PROPERTY_SCHEMA => $this->data['schema'] ?? 1,
];
if (!empty($this->data['headers'])) {

31
shared/lib/Resource/Documents/Collection/CollectionBaseAbstract.php Normal file
View File

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

30
shared/lib/Resource/Documents/Collection/CollectionBaseInterface.php Normal file
View File

@@ -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\Resource\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;
}

23
shared/lib/Resource/Documents/Collection/CollectionContent.php Normal file
View File

@@ -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\Resource\Documents\Collection;
use JsonSerializable;
enum CollectionContent: string implements JsonSerializable {
case File = 'file';
case Folder = 'folder';
public function jsonSerialize(): string {
return $this->value;
}
}

46
shared/lib/Resource/Documents/Collection/CollectionMutableAbstract.php Normal file
View File

@@ -0,0 +1,46 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Resource\Documents\Collection;
use KTXF\Resource\Provider\Node\NodeMutableAbstract;
use KTXF\Resource\Provider\Node\NodePropertiesMutableInterface;
/**
* Abstract Chrono Collection Mutable Class
*
* Provides common implementation for mutable chrono collections
*
* @since 2025.05.01
*/
abstract class CollectionMutableAbstract extends NodeMutableAbstract implements CollectionMutableInterface {
protected CollectionPropertiesMutableAbstract $properties;
/**
* @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;
}
}

32
shared/lib/Resource/Documents/Collection/CollectionMutableInterface.php Normal file
View File

@@ -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\Resource\Documents\Collection;
use KTXF\Resource\Provider\Node\NodeMutableInterface;
/**
* Chrono 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;
}

42
shared/lib/Resource/Documents/Collection/CollectionPropertiesBaseAbstract.php Normal file
View File

@@ -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\Resource\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::JSON_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::JSON_PROPERTY_LABEL] ?? '';
}
}

29
shared/lib/Resource/Documents/Collection/CollectionPropertiesBaseInterface.php Normal file
View File

@@ -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\Resource\Documents\Collection;
use KTXF\Resource\Provider\Node\NodePropertiesBaseInterface;
interface CollectionPropertiesBaseInterface extends NodePropertiesBaseInterface {
public const JSON_TYPE = 'document:collection';
public const JSON_PROPERTY_CONTENTS = 'content';
public const JSON_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;
}

34
shared/lib/Resource/Documents/Collection/CollectionPropertiesMutableAbstract.php Normal file
View File

@@ -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\Resource\Documents\Collection;
/**
* Abstract Chrono 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::JSON_PROPERTY_LABEL] = $value;
return $this;
}
}

25
shared/lib/Resource/Documents/Collection/CollectionPropertiesMutableInterface.php Normal file
View File

@@ -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\Resource\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;
}

31
shared/lib/Resource/Documents/Entity/EntityBaseAbstract.php Normal file
View File

@@ -0,0 +1,31 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Resource\Documents\Entity;
use KTXF\Resource\Provider\Node\NodeBaseAbstract;
/**
* Abstract Chrono Entity Base Class
*
* Provides common implementation for chrono entities
*
* @since 2025.05.01
*/
abstract class EntityBaseAbstract extends NodeBaseAbstract implements EntityBaseInterface {
protected EntityPropertiesBaseAbstract $properties;
/**
* @inheritDoc
*/
public function getProperties(): EntityPropertiesBaseInterface {
return $this->properties;
}
}

25
shared/lib/Resource/Documents/Entity/EntityBaseInterface.php Normal file
View File

@@ -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\Resource\Documents\Entity;
use KTXF\Resource\Provider\Node\NodeBaseInterface;
interface EntityBaseInterface extends NodeBaseInterface {
public const JSON_TYPE = 'document:entity';
/**
* Gets the entity properties
*
* @since 2025.05.01
*/
public function getProperties(): EntityPropertiesBaseInterface|EntityPropertiesMutableInterface;
}

47
shared/lib/Resource/Documents/Entity/EntityMutableAbstract.php Normal file
View File

@@ -0,0 +1,47 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Resource\Documents\Entity;
use KTXF\Resource\Provider\Node\NodeMutableAbstract;
use KTXF\Resource\Provider\Node\NodePropertiesMutableInterface;
/**
* Abstract Chrono Entity Mutable Class
*
* Provides common implementation for mutable chrono entities
*
* @since 2025.05.01
*/
abstract class EntityMutableAbstract extends NodeMutableAbstract implements EntityMutableInterface {
public const JSON_TYPE = EntityMutableInterface::JSON_TYPE;
protected EntityPropertiesMutableAbstract $properties;
/**
* @inheritDoc
*/
public function getProperties(): EntityPropertiesMutableInterface {
return $this->properties;
}
/**
* @inheritDoc
*/
public function setProperties(NodePropertiesMutableInterface $value): static {
if (!$value instanceof EntityPropertiesMutableInterface) {
throw new \InvalidArgumentException('Properties must implement EntityPropertiesMutableInterface');
}
$this->properties->setDataRaw($value->getDataRaw());
return $this;
}
}

28
shared/lib/Resource/Documents/Entity/EntityMutableInterface.php Normal file
View File

@@ -0,0 +1,28 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Resource\Documents\Entity;
use KTXF\Resource\Provider\Node\NodeMutableInterface;
/**
* @method static setProperties(EntityPropertiesMutableInterface $value)
*/
interface EntityMutableInterface extends EntityBaseInterface, NodeMutableInterface {
public const JSON_TYPE = EntityBaseInterface::JSON_TYPE;
/**
* Gets the entity properties (mutable)
*
* @since 2025.05.01
*/
public function getProperties(): EntityPropertiesMutableInterface;
}

38
shared/lib/Resource/Documents/Entity/EntityPropertiesBaseAbstract.php Normal file
View File

@@ -0,0 +1,38 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Resource\Documents\Entity;
use KTXF\Resource\Provider\Node\NodePropertiesBaseAbstract;
abstract class EntityPropertiesBaseAbstract extends NodePropertiesBaseAbstract implements EntityPropertiesBaseInterface {
public const JSON_TYPE = EntityPropertiesBaseInterface::JSON_TYPE;
public function size(): int {
return $this->data[self::JSON_PROPERTY_SIZE] ?? 0;
}
public function getLabel(): string {
return $this->data[self::JSON_PROPERTY_LABEL] ?? '';
}
public function getMime(): string {
return $this->data[self::JSON_PROPERTY_MIME] ?? '';
}
public function getFormat(): string {
return $this->data[self::JSON_PROPERTY_FORMAT] ?? '';
}
public function getEncoding(): string {
return $this->data[self::JSON_PROPERTY_ENCODING] ?? '';
}
}

33
shared/lib/Resource/Documents/Entity/EntityPropertiesBaseInterface.php Normal file
View File

@@ -0,0 +1,33 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Resource\Documents\Entity;
use KTXF\Resource\Provider\Node\NodePropertiesBaseInterface;
interface EntityPropertiesBaseInterface extends NodePropertiesBaseInterface {
public const JSON_TYPE = 'document:file';
public const JSON_PROPERTY_LABEL = 'label';
public const JSON_PROPERTY_SIZE = 'size';
public const JSON_PROPERTY_MIME = 'mime';
public const JSON_PROPERTY_FORMAT = 'format';
public const JSON_PROPERTY_ENCODING = 'encoding';
public function size(): int;
public function getLabel(): string;
public function getMime(): string;
public function getFormat(): string;
public function getEncoding(): string;
}

46
shared/lib/Resource/Documents/Entity/EntityPropertiesMutableAbstract.php Normal file
View File

@@ -0,0 +1,46 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Resource\Documents\Entity;
abstract class EntityPropertiesMutableAbstract extends EntityPropertiesBaseAbstract implements EntityPropertiesMutableInterface {
public const JSON_TYPE = EntityPropertiesBaseInterface::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::JSON_PROPERTY_LABEL] = $value;
return $this;
}
public function setMime(string $value): static {
$this->data[self::JSON_PROPERTY_MIME] = $value;
return $this;
}
public function setFormat(string $value): static {
$this->data[self::JSON_PROPERTY_FORMAT] = $value;
return $this;
}
public function setEncoding(string $value): static {
$this->data[self::JSON_PROPERTY_ENCODING] = $value;
return $this;
}
}

26
shared/lib/Resource/Documents/Entity/EntityPropertiesMutableInterface.php Normal file
View File

@@ -0,0 +1,26 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Resource\Documents\Entity;
use KTXF\Resource\Provider\Node\NodePropertiesMutableInterface;
interface EntityPropertiesMutableInterface extends EntityPropertiesBaseInterface, NodePropertiesMutableInterface {
public const JSON_TYPE = EntityPropertiesBaseInterface::JSON_TYPE;
public function setLabel(string $value): static;
public function setMime(string $value): static;
public function setFormat(string $value): static;
public function setEncoding(string $value): static;
}

23
shared/lib/Resource/Documents/Provider/ProviderBaseInterface.php Normal file
View File

@@ -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\Resource\Documents\Provider;
use KTXF\Resource\Provider\ResourceProviderBaseInterface;
/**
* Chrono Provider Base Interface
*
* @since 2025.05.01
*/
interface ProviderBaseInterface extends ResourceProviderBaseInterface{
public const JSON_TYPE = 'document:provider';
}

35
shared/lib/Resource/Documents/Provider/ProviderServiceMutateInterface.php Normal file
View File

@@ -0,0 +1,35 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Resource\Documents\Provider;
use KTXF\Resource\Provider\ResourceProviderServiceMutateInterface;
/**
* Chrono Provider Service Mutate Interface
*
* Optional interface for providers that support service CRUD operations.
*
* Implementations return ServiceMutableInterface instances (which extend ResourceServiceMutateInterface).
*
* @since 2025.05.01
*
* @method ServiceMutableInterface serviceFresh() Construct a new blank chrono service instance
* @method string serviceCreate(string $tenantId, ?string $userId, ServiceMutableInterface $service) Create a chrono service configuration
* @method string serviceModify(string $tenantId, ?string $userId, ServiceMutableInterface $service) Modify a chrono service configuration
* @method bool serviceDestroy(string $tenantId, ?string $userId, ServiceMutableInterface $service) Delete a chrono service configuration
*/
interface ProviderServiceMutateInterface extends ProviderBaseInterface, ResourceProviderServiceMutateInterface {
public const JSON_TYPE = ProviderBaseInterface::JSON_TYPE;
// Methods inherited from ResourceProviderServiceMutateInterface
// Implementations should return/accept ServiceMutableInterface instances
}

57
shared/lib/Resource/Documents/Provider/ProviderServiceTestInterface.php Normal file
View File

@@ -0,0 +1,57 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Resource\Documents\Provider;
use KTXF\Resource\Documents\Service\ServiceBaseInterface;
/**
* Chrono Provider Service Test Interface
*
* Optional interface for chrono providers that support testing service connections.
* Providers implementing this interface can validate connection parameters,
* test authentication, and verify service availability before creating a
* persistent service configuration.
*
* Supports two testing modes:
* 1. Testing an existing service (validate current configuration)
* 2. Testing a fresh configuration (validate before saving)
*
* @since 2025.05.01
*/
interface ProviderServiceTestInterface extends ProviderBaseInterface {
/**
* Test a service connection
*
* Tests connectivity, authentication, and capabilities of a service.
*
* For new services: use serviceFresh() to create a service, configure it with
* setters, then pass it to this method for testing before persisting.
*
* For existing services: fetch the service and pass it directly.
*
* @since 2025.05.01
*
* @param ServiceBaseInterface $service Service to test (can be fresh/unsaved or existing)
* @param array $options Provider-specific test options:
* - 'timeout' => int (seconds, default: 10)
* - 'verify_ssl' => bool (default: true)
* - 'test_send' => bool (attempt test send if capable, default: false)
* - 'test_receive' => bool (attempt mailbox access if capable, default: true)
*
* @return array Test results in the format:
* [
* 'success' => bool,
* 'message' => 'Connection successful' | 'Error message'
* ]
*/
public function serviceTest(ServiceBaseInterface $service, array $options = []): array;
}

199
shared/lib/Resource/Documents/Service/ServiceBaseInterface.php Normal file
View File

@@ -0,0 +1,199 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Resource\Documents\Service;
use KTXF\Resource\Documents\Collection\CollectionBaseInterface;
use KTXF\Resource\Delta\Delta;
use KTXF\Resource\Filter\IFilter;
use KTXF\Resource\Provider\ResourceServiceBaseInterface;
use KTXF\Resource\Range\IRange;
use KTXF\Resource\Range\RangeType;
use KTXF\Resource\Sort\ISort;
/**
* Chrono Service Base Interface
*
* @since 2025.05.01
*/
interface ServiceBaseInterface extends ResourceServiceBaseInterface {
// Collection capabilities
public const CAPABILITY_COLLECTION_LIST = 'CollectionList';
public const CAPABILITY_COLLECTION_LIST_FILTER = 'CollectionListFilter';
public const CAPABILITY_COLLECTION_LIST_SORT = 'CollectionListSort';
public const CAPABILITY_COLLECTION_EXTANT = 'CollectionExtant';
public const CAPABILITY_COLLECTION_FETCH = 'CollectionFetch';
// Collection Filter
public const CAPABILITY_COLLECTION_FILTER_LABEL = 'label';
public const CAPABILITY_COLLECTION_FILTER_CONTENTS = 'contents';
// Collection Sort
public const CAPABILITY_COLLECTION_SORT_LABEL = 'label';
public const CAPABILITY_COLLECTION_SORT_RANK = 'rank';
// Entity capabilities
public const CAPABILITY_ENTITY_LIST = 'EntityList';
public const CAPABILITY_ENTITY_LIST_FILTER = 'EntityListFilter';
public const CAPABILITY_ENTITY_LIST_SORT = 'EntityListSort';
public const CAPABILITY_ENTITY_LIST_RANGE = 'EntityListRange';
public const CAPABILITY_ENTITY_DELTA = 'EntityDelta';
public const CAPABILITY_ENTITY_EXTANT = 'EntityExtant';
public const CAPABILITY_ENTITY_FETCH = 'EntityFetch';
public const CAPABILITY_ENTITY_READ = 'EntityRead';
// Filter capabilities
public const CAPABILITY_ENTITY_FILTER_ALL = '*';
public const CAPABILITY_ENTITY_FILTER_ID = 'id';
public const CAPABILITY_ENTITY_FILTER_URID = 'urid';
public const CAPABILITY_ENTITY_FILTER_LABEL = 'label';
// Sort capabilities
public const CAPABILITY_ENTITY_SORT_ID = 'id';
public const CAPABILITY_ENTITY_SORT_URID = 'urid';
public const CAPABILITY_ENTITY_SORT_LABEL = 'label';
public const CAPABILITY_ENTITY_SORT_PRIORITY = 'priority';
// Range capabilities
public const CAPABILITY_ENTITY_RANGE_TALLY = 'tally';
public const CAPABILITY_ENTITY_RANGE_TALLY_ABSOLUTE = 'absolute';
public const CAPABILITY_ENTITY_RANGE_TALLY_RELATIVE = 'relative';
public const CAPABILITY_ENTITY_RANGE_DATE = 'date';
public const JSON_TYPE = 'document:service';
/**
* Lists all collections in this service
*
* @since 2025.05.01
*
* @param IFilter|null $filter Optional filter criteria
* @param ISort|null $sort Optional sort order
*
* @return array<string|int,CollectionBaseInterface> Collections indexed by ID
*/
public function collectionList(string|int $location, ?IFilter $filter = null, ?ISort $sort = null): array;
/**
* Creates a filter builder for collections
*
* @since 2025.05.01
*
* @return IFilter
*/
public function collectionListFilter(): IFilter;
/**
* Creates a sort builder for collections
*
* @since 2025.05.01
*
* @return ISort
*/
public function collectionListSort(): ISort;
/**
* Checks if collections exist
*
* @since 2025.05.01
*
* @param string|int ...$identifiers Collection IDs to check
*
* @return array<string|int,bool> Map of ID => exists
*/
public function collectionExtant(string|int $location, string|int ...$identifiers): array;
/**
* Fetches a single collection
*
* @since 2025.05.01
*
* @param string|int $identifier Collection ID
*
* @return CollectionBaseInterface|null Collection or null if not found
*/
public function collectionFetch(string|int $identifier): ?CollectionBaseInterface;
/**
* Lists messages in a collection
*
* @since 2025.05.01
*
* @param string|int $collection Collection ID
* @param IFilter|null $filter Optional filter criteria
* @param ISort|null $sort Optional sort order
* @param IRange|null $range Optional pagination
* @param array|null $properties Optional message properties to fetch
*
* @return array<string|int,EntityBaseInterface> Messages indexed by ID
*/
public function entityList(string|int $collection, ?IFilter $filter = null, ?ISort $sort = null, ?IRange $range = null, ?array $properties = null): array;
/**
* Creates a filter builder for messages
*
* @since 2025.05.01
*
* @return IFilter
*/
public function entityListFilter(): IFilter;
/**
* Creates a sort builder for messages
*
* @since 2025.05.01
*
* @return ISort
*/
public function entityListSort(): ISort;
/**
* Creates a range builder for messages
*
* @since 2025.05.01
*
* @param RangeType $type Range type (offset, cursor, etc.)
*
* @return IRange
*/
public function entityListRange(RangeType $type): IRange;
/**
* Gets incremental changes since last sync
*
* @since 2025.05.01
*
* @param string|int $collection Collection ID
* @param string $signature Sync token from previous sync
* @param string $detail Detail level: 'ids', 'minimal', 'full'
*
* @return array ['signature' => string, 'added' => array, 'modified' => array, 'removed' => array]
*/
public function entityDelta(string|int $collection, string $signature, string $detail = 'ids'): Delta;
/**
* Checks if messages exist
*
* @since 2025.05.01
*
* @param string|int $collection Collection ID
* @param string|int ...$identifiers Message IDs to check
*
* @return array<string|int,bool> Map of ID => exists
*/
public function entityExtant(string|int $collection, string|int ...$identifiers): array;
/**
* Fetches one or more entities
*
* @since 2025.05.01
*
* @param string|int $collection Collection ID
* @param string|int ...$identifiers Message IDs to fetch
*
* @return array<string|int,EntityBaseInterface> Messages indexed by ID
*/
public function entityFetch(string|int $collection, string|int ...$identifiers): array;
}

73
shared/lib/Resource/Documents/Service/ServiceCollectionMutableInterface.php Normal file
View File

@@ -0,0 +1,73 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Resource\Documents\Service;
use KTXF\Resource\Documents\Collection\CollectionBaseInterface;
use KTXF\Resource\Documents\Collection\CollectionMutableInterface;
/**
* Chrono Service Collection Mutable Interface
*
* @since 2025.05.01
*/
interface ServiceCollectionMutableInterface extends ServiceBaseInterface {
public const CAPABILITY_COLLECTION_CREATE = 'CollectionCreate';
public const CAPABILITY_COLLECTION_UPDATE = 'CollectionUpdate';
public const CAPABILITY_COLLECTION_DELETE = 'CollectionDelete';
/**
* Creates a fresh collection instance for configuration
*
* @since 2025.05.01
*
* @return CollectionMutableInterface Fresh collection object
*/
public function collectionFresh(): CollectionMutableInterface;
/**
* Creates a new collection
*
* @since 2025.05.01
*
* @param string|int|null $location Parent collection ID (null for root)
* @param CollectionMutableInterface $collection Collection to create
* @param array $options Protocol-specific options
*
* @return CollectionBaseInterface Created collection with assigned ID
*/
public function collectionCreate(string|int|null $location, CollectionMutableInterface $collection, array $options = []): CollectionBaseInterface;
/**
* Updates an existing collection
*
* @since 2025.05.01
*
* @param string|int $identifier Collection ID
* @param CollectionMutableInterface $collection Updated collection data
*
* @return CollectionBaseInterface Updated collection
*/
public function collectionUpdate(string|int $identifier, CollectionMutableInterface $collection): CollectionBaseInterface;
/**
* Deletes a collection
*
* @since 2025.05.01
*
* @param string|int $identifier Collection ID
* @param bool $force Force deletion even if not empty
* @param bool $recursive Recursively delete contents
*
* @return bool True if deleted
*/
public function collectionDelete(string|int $identifier, bool $force = false, bool $recursive = false): bool;
}

26
shared/lib/Resource/Documents/Service/ServiceConfigurableInterface.php Normal file
View File

@@ -0,0 +1,26 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Resource\Documents\Service;
use KTXF\Resource\Provider\ResourceServiceConfigureInterface;
/**
* Chrono Service Configurable Interface
*
* Extends base service interface with setter methods for mutable properties.
* Used for service configuration and updates.
*
* @since 2025.05.01
*/
interface ServiceConfigurableInterface extends ServiceMutableInterface, ResourceServiceConfigureInterface {
public const JSON_TYPE = ServiceBaseInterface::JSON_TYPE;
}

78
shared/lib/Resource/Documents/Service/ServiceEntityMutableInterface.php Normal file
View File

@@ -0,0 +1,78 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Resource\Documents\Service;
use KTXF\Resource\Documents\Entity\EntityBaseInterface;
use KTXF\Resource\Documents\Entity\EntityMutableInterface;
/**
* Chrono Service Entity Mutable Interface
*
* Optional interface for services that support entity CRUD operations.
* Provides entity creation, modification, deletion, copying, moving, and flag management.
*
* @since 2025.05.01
*/
interface ServiceEntityMutableInterface extends ServiceBaseInterface {
public const CAPABILITY_ENTITY_CREATE = 'EntityCreate';
public const CAPABILITY_ENTITY_UPDATE = 'EntityUpdate';
public const CAPABILITY_ENTITY_DELETE = 'EntityDelete';
public const CAPABILITY_ENTITY_COPY = 'EntityCopy';
public const CAPABILITY_ENTITY_MOVE = 'EntityMove';
public const CAPABILITY_ENTITY_WRITE = 'EntityWrite';
/**
* Creates a fresh entity instance for composition
*
* @since 2025.05.01
*
* @return EntityMutableInterface Fresh entity object
*/
public function entityFresh(): EntityMutableInterface;
/**
* Creates/imports an entity into a collection
*
* @since 2025.05.01
*
* @param string|int $collection collection identifier
* @param EntityMutableInterface $entity Entity data
* @param array $options additional options
*
* @return EntityBaseInterface Created entity
*/
public function entityCreate(string|int $collection, EntityMutableInterface $entity, array $options = []): EntityBaseInterface;
/**
* Modifies an existing entity
*
* @since 2025.05.01
*
* @param string|int $collection Collection identifier
* @param string|int $identifier Entity identifier
* @param EntityMutableInterface $entity Entity data
*
* @return EntityBaseInterface Modified entity
*/
public function entityUpdate(string|int $collection, string|int $identifier, EntityMutableInterface $entity): EntityBaseInterface;
/**
* Deletes an existing entity in the specified collection
*
* @since 2025.05.01
*
* @param string|int $collection Collection identifier
* @param string|int $identifier Entity identifier to delete
*
* @return EntityBaseInterface Deleted entity
*/
public function entityDelete(string|int $collection, string|int $identifier): EntityBaseInterface;
}

22
shared/lib/Resource/Documents/Service/ServiceMutableInterface.php Normal file
View File

@@ -0,0 +1,22 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\Resource\Documents\Service;
/**
* Chrono Service Mutable Interface
*
* Extends base service interface with setter methods for mutable properties.
* Used for service configuration and updates.
*
* @since 2025.05.01
*/
interface ServiceMutableInterface extends ServiceBaseInterface {
}

8
shared/lib/Resource/Provider/Node/NodePropertiesBaseAbstract.php
View File

@@ -26,8 +26,8 @@ abstract class NodePropertiesBaseAbstract implements NodePropertiesBaseInterface
$data[static::JSON_PROPERTY_TYPE] = static::JSON_TYPE;
}
if (!isset($data[static::JSON_PROPERTY_VERSION])) {
$data[static::JSON_PROPERTY_VERSION] = 1;
if (!isset($data[static::JSON_PROPERTY_SCHEMA])) {
$data[static::JSON_PROPERTY_SCHEMA] = 1;
}
$this->data = $data;
@@ -50,8 +50,8 @@ abstract class NodePropertiesBaseAbstract implements NodePropertiesBaseInterface
/**
* @inheritDoc
*/
public function version(): int {
return $this->data[static::JSON_PROPERTY_VERSION];
public function schema(): int {
return $this->data[static::JSON_PROPERTY_SCHEMA];
}
}

6
shared/lib/Resource/Provider/Node/NodePropertiesBaseInterface.php
View File

@@ -22,7 +22,7 @@ interface NodePropertiesBaseInterface extends JsonSerializable {
public const JSON_TYPE = 'resource.data';
public const JSON_PROPERTY_TYPE = '@type';
public const JSON_PROPERTY_VERSION = 'version';
public const JSON_PROPERTY_SCHEMA = 'schema';
/**
* Get resource node properties type
@@ -30,8 +30,8 @@ interface NodePropertiesBaseInterface extends JsonSerializable {
public function type(): string;
/**
* Get resource node properties version
* Get resource node properties schema
*/
public function version(): int;
public function schema(): int;
}

4
shared/lib/Resource/Provider/ProviderInterface.php
View File

@@ -11,13 +11,13 @@ interface ProviderInterface
{
public const TYPE_AUTHENTICATION = 'authentication';
public const TYPE_DOCUMENT = 'document';
public const TYPE_PEOPLE = 'people';
public const TYPE_CHRONO = 'chrono';
public const TYPE_FILES = 'files';
public const TYPE_MAIL = 'mail';
/**
* Provider type (e.g., 'authentication', 'storage', 'notification')
* Provider type (e.g., 'authentication', 'document', 'people', 'chrono', 'mail')
*/
public function type(): string;