[Search] [Assets] Get Default grid Columns for search (#898)

* Get Grid configuration for asset Search.

* Apply php-cs-fixer changes

* Style.

---------

Co-authored-by: martineiber <11687066+martineiber@users.noreply.github.com>

Author: martineiber

config/pimcore/config.yaml

@@ -33,6 +33,15 @@ pimcore_studio_backend:
             format: "JPEG"
             quality: 90
     element_recycle_bin_threshold: 100
+    search_grid:
+        asset:
+            predefined_columns:
+                - key: type
+                  group: system
+                - key: fullpath
+                  group: system
+                - key: preview
+                  group: system
     grid:
         asset:
             predefined_columns:

doc/10_Extending_Studio/05_Grid.md

@@ -184,7 +184,7 @@ final readonly class MetadataCollector implements ColumnCollectorInterface
 }
 ```
 
-### Predefined Columns
+### Predefined Columns for Grids
 You can define what columns should be visible by default in the grid by modifying the `pimcore_studio_backend.grid.asset.predefined_columns` parameter in your `config.yaml` file.
 
 Example:
@@ -206,6 +206,23 @@ pimcore_studio_backend:
           group: system
 ```
 
+### Predefined Columns for Search Grids
+
+You can define what columns should be visible by default in the search grid by modifying the `pimcore_studio_backend.search_grid.asset.predefined_columns` parameter in your `config.yaml` file.
+
+Example:
+```yaml
+
+pimcore_studio_backend:
+  search_grid:
+    asset:
+      predefined_columns:
+        - key: id
+          group: system
+        - key: fullpath
+          group: system
+```
+
 ### Advanced Columns
 Not all data types are supported by Advanced Columns. Transforms for Advanced Columns can only work with strings.
 If you want to use a custom data type in Advanced Columns, ensure your Resolver returns a string. 

src/Asset/Controller/Search/GetConfigurationController.php

@@ -0,0 +1,77 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+namespace Pimcore\Bundle\StudioBackendBundle\Asset\Controller\Search;
+
+use OpenApi\Attributes\Get;
+use OpenApi\Attributes\JsonContent;
+use Pimcore\Bundle\StudioBackendBundle\Controller\AbstractApiController;
+use Pimcore\Bundle\StudioBackendBundle\Exception\Api\NotFoundException;
+use Pimcore\Bundle\StudioBackendBundle\Grid\Schema\DetailedConfiguration;
+use Pimcore\Bundle\StudioBackendBundle\Grid\Service\ConfigurationServiceInterface;
+use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Response\DefaultResponses;
+use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Response\SuccessResponse;
+use Pimcore\Bundle\StudioBackendBundle\OpenApi\Config\Tags;
+use Pimcore\Bundle\StudioBackendBundle\Util\Constant\HttpResponseCodes;
+use Pimcore\Bundle\StudioBackendBundle\Util\Constant\UserPermissions;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\Routing\Attribute\Route;
+use Symfony\Component\Security\Http\Attribute\IsGranted;
+use Symfony\Component\Serializer\SerializerInterface;
+
+/**
+ * @internal
+ */
+final class GetConfigurationController extends AbstractApiController
+{
+    public function __construct(
+        SerializerInterface $serializer,
+        private readonly ConfigurationServiceInterface $configurationService,
+    ) {
+        parent::__construct($serializer);
+    }
+
+    /**
+     * @throws NotFoundException
+     */
+    #[Route(
+        '/assets/search/configuration/',
+        name: 'pimcore_studio_api_get_asset_search_configuration',
+        methods: ['GET'],
+    )]
+    #[IsGranted(UserPermissions::ASSETS->value)]
+    #[Get(
+        path: self::PREFIX . '/assets/search/configuration/',
+        operationId: 'asset_get_search_configuration',
+        description: 'asset_get_search_configuration_description',
+        summary: 'asset_get_search_configuration_summary',
+        tags: [Tags::AssetSearch->value]
+    )]
+    #[SuccessResponse(
+        description: 'asset_get_search_configuration_success_response',
+        content: new JsonContent(ref: DetailedConfiguration::class)
+    )]
+    #[DefaultResponses([
+        HttpResponseCodes::BAD_REQUEST,
+        HttpResponseCodes::UNAUTHORIZED,
+    ])]
+    public function getAssetGridConfiguration(): JsonResponse
+    {
+        $configuration = $this->configurationService->getAssetSearchConfiguration();
+
+        return $this->jsonResponse($configuration);
+    }
+}

src/DependencyInjection/Configuration.php

@@ -70,6 +70,7 @@ public function getConfigTreeBuilder(): TreeBuilder
         $this->addAssetDownloadLimits($rootNode);
         $this->addCsvSettings($rootNode);
         $this->addGridConfiguration($rootNode);
+        $this->addSearchGridConfiguration($rootNode);
         $this->addNoteTypes($rootNode);
         $this->addDataObjectAdapterMapping($rootNode);
         $this->addUserNode($rootNode);
@@ -233,6 +234,27 @@ private function addGridConfiguration(ArrayNodeDefinition $node): void
             ->end();
     }
 
+    private function addSearchGridConfiguration(ArrayNodeDefinition $node): void
+    {
+        $node->children()
+            ->arrayNode('search_grid')
+                ->children()
+                    ->arrayNode('asset')
+                        ->children()
+                            ->arrayNode('predefined_columns')
+                                ->arrayPrototype()
+                                    ->children()
+                                        ->scalarNode('group')->end()
+                                        ->scalarNode('key')->end()
+                                    ->end()
+                                ->end()
+                            ->end()
+                        ->end()
+                    ->end()
+                ->end()
+            ->end();
+    }
+
     private function addMercureConfiguration(ArrayNodeDefinition $node): void
     {
         $node->children()

src/DependencyInjection/PimcoreStudioBackendExtension.php

@@ -109,6 +109,12 @@ public function load(array $configs, ContainerBuilder $container): void
         $definition = $container->getDefinition(ConfigurationServiceInterface::class);
         $definition->setArgument('$assetPredefinedColumns', $config['grid']['asset']['predefined_columns']);
 
+        $definition = $container->getDefinition(ConfigurationServiceInterface::class);
+        $definition->setArgument(
+            '$assetSearchPredefinedColumns',
+            $config['search_grid']['asset']['predefined_columns']
+        );
+
         $definition = $container->getDefinition(ConfigurationServiceInterface::class);
         $definition->setArgument('$dataObjectPredefinedColumns', $config['grid']['data_object']['predefined_columns']);
 

src/Grid/Service/ConfigurationService.php

@@ -50,7 +50,8 @@ public function __construct(
         private DetailedConfigurationHydratorInterface $detailedConfigurationHydrator,
         private FavoriteServiceInterface $favoriteService,
         private array $assetPredefinedColumns,
-        private array $dataObjectPredefinedColumns
+        private array $dataObjectPredefinedColumns,
+        private array $assetSearchPredefinedColumns,
     ) {
     }
 
@@ -109,6 +110,13 @@ public function getAssetGridConfiguration(?int $configurationId, int $folderId):
         return $configuration;
     }
 
+    public function getAssetSearchConfiguration(): DetailedConfiguration
+    {
+        $availableColumns = $this->columnConfigurationService->getAvailableAssetColumnConfiguration();
+
+        return $this->buildDefaultConfiguration($availableColumns, $this->assetSearchPredefinedColumns);
+    }
+
     /**
      * {@inheritdoc}
      */

src/Grid/Service/ConfigurationServiceInterface.php

@@ -32,6 +32,8 @@ interface ConfigurationServiceInterface
      */
     public function getAssetGridConfiguration(?int $configurationId, int $folderId): DetailedConfiguration;
 
+    public function getAssetSearchConfiguration(): DetailedConfiguration;
+
     /**
      * @throws NotFoundException
      */

src/OpenApi/Config/Tags.php

@@ -29,6 +29,10 @@
     name: Tags::AssetGrid->value,
     description: 'tag_asset_grid_description'
 )]
+#[Tag(
+    name: Tags::AssetSearch->value,
+    description: 'tag_asset_search_description'
+)]
 #[Tag(
     name: Tags::AssetThumbnails->value,
     description: 'tag_asset_thumbnail_description'
@@ -149,6 +153,7 @@ enum Tags: string
 {
     case Assets = 'Assets';
     case AssetGrid = 'Asset Grid';
+    case AssetSearch = 'Asset Search';
     case AssetThumbnails = 'Asset Thumbnails';
     case Authorization = 'Authorization';
     case ClassDefinition = 'Class Definition';

translations/studio_api_docs.en.yaml

@@ -178,6 +178,10 @@ asset_video_stream_by_thumbnail_description: |
   List of <b>thumbnail names</b> can be obtained via the thumbnail video collection endpoint
 asset_video_stream_by_thumbnail_success_response: Video stream based on thumbnail name
 asset_video_stream_by_thumbnail_summary: Stream video asset by ID and thumbnail name
+asset_get_search_configuration: Get asset search configuration
+asset_get_search_configuration_description: Get asset configuration
+asset_get_search_configuration_summary: Get asset search configuration
+asset_get_search_configuration_success_response: Asset search configuration
 data_object_add_description: |
   Add a new data object to the given <strong>{parentId}</strong>. <br> The <strong>{parentId}</strong> must be an ID of a folder or another data object. See the full description of request fields with the schema <strong>DataObjectAdd</strong>
 data_object_add_success_response: ID of added data object
@@ -526,6 +530,7 @@ simple_search_preview_get_success_response: Simple search results preview for el
 tag_asset_thumbnail_description: List thumbnails for assets like videos and images
 tag_assets_description: Asset operations to get/update/create/delete assets
 tag_asset_grid_description: Asset Grid operations
+tag_asset_search_description: Asset Search operations
 tag_assign_to_element_description: |
   Assign a specific tag based on the given <strong>{tagId}</strong> to an element based on <strong>{elementType}</strong> and <strong>{id}</strong>. <br>
   The <strong>{id}</strong> must be an ID of an existing element of the provided <strong>{elementType}</strong>.