Merge branch 'develop'

Author: tistre

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 9.1.0 - 2025-04-10
+
+Add support for raw JSON requests (like the ones used by the Assets UI) using SearchRequest::json.
+
 ## 9.0.0 - 2025-02-19
 
 PHP 8.4 is now required.

src/Service/SearchRequest.php

@@ -2,11 +2,11 @@
 
 namespace DerSpiegel\WoodWingAssetsClient\Service;
 
-
 use DerSpiegel\WoodWingAssetsClient\AssetsClient;
 use DerSpiegel\WoodWingAssetsClient\RelationType;
 use DerSpiegel\WoodWingAssetsClient\Request;
 
+
 /**
  * Search for assets
  *
@@ -33,33 +33,42 @@ public function __construct(
         readonly array $facets = [],
         readonly bool $appendRequestSecret = self::APPEND_REQUEST_SECRET_DEFAULT,
         readonly bool $returnHighlightedText = self::RETURN_HIGHLIGHTED_TEXT_DEFAULT,
-        readonly bool $returnThumbnailHits = self::RETURN_THUMBNAIL_HITS_DEFAULT
+        readonly bool $returnThumbnailHits = self::RETURN_THUMBNAIL_HITS_DEFAULT,
+        readonly string $json = ''
     ) {
         parent::__construct($assetsClient);
     }
 
 
     public function __invoke(): SearchResponse
     {
-        $httpResponse = $this->assetsClient->serviceRequest('POST', 'search', $this->toArray());
+        $isRawJsonRequest = !empty($this->json);
+
+        $httpResponse = $this->assetsClient->serviceRequest(
+            'POST',
+            'search',
+            $this->toArray(),
+            !$isRawJsonRequest
+        );
 
         $this->logger->debug(
             'Search performed',
             [
                 'method' => __METHOD__,
-                'query' => $this->q
+                'query' => $isRawJsonRequest ? $this->json : $this->q
             ]
         );
 
         return SearchResponse::createFromHttpResponse($httpResponse);
     }
 
 
-    /**
-     * @return array
-     */
     protected function toArray(): array
     {
+        if (!empty($this->json)) {
+            return json_decode($this->json, true, 512, JSON_THROW_ON_ERROR);
+        }
+
         $params = [
             'q' => $this->q
         ];
@@ -104,11 +113,6 @@ protected function toArray(): array
      * Get query for relation search
      *
      * @see https://helpcenter.woodwing.com/hc/en-us/articles/360041854172#additional-queries
-     *
-     * @param string $relatedTo
-     * @param string $relationTarget
-     * @param RelationType|null $relationType
-     * @return string
      */
     public static function getRelationSearchQ(
         string $relatedTo,

tests/Integration/SearchRequestTest.php

@@ -11,7 +11,7 @@ final class SearchRequestTest extends IntegrationFixture
 {
     public function testEmptySearch(): void
     {
-        $response = (new SearchRequest($this->assetsClient, q: '', num: 0))();
+        $response = new SearchRequest($this->assetsClient, q: '', num: 0)();
 
         $this->assertGreaterThan(0, $response->totalHits);
     }
@@ -22,6 +22,19 @@ public function testMalformedQuery(): void
         $this->expectException(ClientException::class);
         $this->expectExceptionCode(400);
 
-        (new SearchRequest($this->assetsClient, q: 'noSuchField:', num: 0))();
+        new SearchRequest($this->assetsClient, q: 'noSuchField:', num: 0)();
+    }
+
+
+    public function testJsonQuery(): void
+    {
+        $json = '{"start":0,"num":300,"returnHighlightedText":true,"facets":{"extension":{"field":"extension"},"assetType":{"field":"assetType"},"assetDomain":{"field":"assetDomain"},"tags":{"field":"tags"},"status":{"field":"status"}},"sorting":[{"field":"assetCreated","descending":true}],"showAssetsOfSubfolders":"true","showSubCollections":"false","query":{"BoolQuery":{"elements":[{"operator":"MUST","query":{"QueryStringQuery":{"queryString":""}}},{"operator":"MUST_NOT","query":{"BoolQuery":{"elements":[{"operator":"MUST","query":{"TermQuery":{"name":"assetType","value":"collection"}}},{"operator":"MUST","query":{"WildcardQuery":{"name":"parentContainerIds","wildcardValue":"*"}}}]}}}]}},"maxResultHits":400,"firstResult":0,"returnThumbnailHits":true}';
+
+        $response = new SearchRequest(
+            $this->assetsClient,
+            json: $json
+        )();
+
+        $this->assertGreaterThan(0, $response->totalHits);
     }
 }