Fixing #10 (#12)

* Fixing #10

Fixing #10, `content` missing from Stories collection responses but is expected

* renaming StoryItem into StoryCollectionItem

* Add doc for StoryCollectionItem

Author: roberto-butti

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog
 
 ## 1.0.1 - WIP
+- Fixing getting list of Stories. Issue #10
 - Adding new plans in `StoryblokUtils::getPlanDescription()` method
 - Reviewing README
 - Adding dependecies license checker

src/Data/Stories.php

@@ -11,7 +11,7 @@ class Stories extends StoryblokData
     #[\Override]
     public function getDataClass(): string
     {
-        return Story::class;
+        return StoryCollectionItem::class;
     }
 
     #[\Override]

src/Data/StoryCollectionItem.php

@@ -0,0 +1,120 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Storyblok\ManagementApi\Data;
+
+use Storyblok\ManagementApi\Exceptions\StoryblokFormatException;
+
+/**
+ * Represents a lightweight story item as returned by the Storyblok "multiple stories" API endpoint.
+ *
+ * Unlike the full `Story` object returned by the single story endpoint, this class does not contain
+ * the actual content of the story. Instead, it holds metadata and system-related information such as
+ * the story's name, slug, ID, UUID, and timestamps for creation, update, and publication.
+ *
+ * `StoryCollectionItem` is typically used when retrieving a list of stories, for purposes like displaying
+ * overviews or selecting stories for further processing. Since it does not support content data or modification
+ * operations, it is read-only in nature and optimized for listing or filtering operations.
+ *
+ * For creating or updating stories, or when full content access is required, the full `Story` class should be used instead.
+ */
+class StoryCollectionItem extends BaseData
+{
+    public function __construct()
+    {
+        $this->data = [];
+
+    }
+
+    /**
+     * @param mixed[] $data
+     * @throws StoryblokFormatException
+     */
+    public static function make(array $data = []): self
+    {
+        $dataObject = new StoryblokData($data);
+        if (!($dataObject->hasKey('name') && $dataObject->hasKey('slug'))) {
+            // is not valid
+        }
+
+        $storyItem = new StoryCollectionItem();
+        $storyItem->setData($dataObject->toArray());
+        // validate
+        if (! $storyItem->isValid()) {
+            throw new StoryblokFormatException("Story is not valid");
+        }
+
+        return $storyItem;
+
+    }
+
+    public function slug(): string
+    {
+        return $this->getString('slug');
+    }
+
+    public function name(): string
+    {
+        return $this->getString('name');
+    }
+
+    public function createdAt(string $format = "Y-m-d"): null|string
+    {
+        return $this->getFormattedDateTime('created_at', "", format: $format);
+    }
+
+    public function publishedAt(string $format = "Y-m-d"): null|string
+    {
+        return $this->getFormattedDateTime('published_at', "", format: $format);
+    }
+
+    public function updatedAt(): null|string
+    {
+        return $this->getFormattedDateTime('updated_at', "", format: "Y-m-d");
+    }
+
+    public function id(): string
+    {
+        return $this->getString('id');
+    }
+
+    public function uuid(): string
+    {
+        return $this->getString('uuid');
+    }
+
+    /**
+     * Validates if the story data contains all required fields and valid values
+     */
+    public function isValid(): bool
+    {
+        if (!$this->hasKey('name') || in_array($this->getString('name'), ['', '0'], true)) {
+            return false;
+        }
+
+        return $this->hasKey('slug') && !in_array($this->getString('slug'), ['', '0'], true);
+    }
+
+    /**
+     * Set tags for Story, from a `Tags` collection
+     * @return $this
+     */
+    public function setTags(Tags $tags): self
+    {
+
+        return $this->setTagsFromArray($tags->getTagsArray());
+
+    }
+
+    /**
+     * Set tags for Story, from a string of arrays like ["tag1", "tag2"]
+     * @param string[] $tagsArray
+     * @return $this
+     */
+    public function setTagsFromArray(array $tagsArray): self
+    {
+        $this->set("tag_list", $tagsArray);
+        return $this;
+    }
+}

tests/Feature/Data/list-stories.json

@@ -6,10 +6,6 @@
         "published_at": "2024-02-08T16:27:05.705Z",
         "id": 440448565,
         "uuid": "e656e146-f4ed-44a2-8017-013e5a9d9395",
-        "content": {
-            "_uid": "cfe0ff0b-3211-4bb7-8128-66e6ad262a56",
-            "component": "page"
-        },
         "slug": "my-third-post",
         "full_slug": "posts/my-third-post",
         "sort_by_date": null,
@@ -56,10 +52,6 @@
             "published_at": "2024-02-08T16:27:05.705Z",
             "id": 440448565,
             "uuid": "e656e146-f4ed-44a2-8017-013e5a9d9395",
-            "content": {
-                "_uid": "cfe0ff0b-3211-4bb7-8128-66e6ad262a56",
-                "component": "page"
-            },
             "slug": "my-third-post",
             "full_slug": "posts/my-third-post",
             "sort_by_date": null,