@pimcore/studio-ui-bundle 2025.4.5 → 2025.4.7

package/dist/build/types/src/core/modules/search/saved-search/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+export {};

package/dist/build/types/src/core/modules/search/saved-search/restore/object-saved-search-restore.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+/**
+ * Logic-only component mounted inside the Data Object search listing. Selects the saved class first
+ * (so its columns load) when one is set, then applies the saved search. A data-object search can be
+ * classless (search across all classes), so routing is by elementType, not by the presence of a classId.
+ */
+export declare const ObjectSavedSearchRestore: () => null;

package/dist/build/types/src/core/modules/search/saved-search/restore/saved-search-restore.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+import { type ElementType } from '../../../../types/enums/element/element-type';
+interface SavedSearchRestoreProps {
+    elementType?: ElementType;
+}
+/**
+ * Logic-only component mounted inside a search listing. Applies a pending saved search of the
+ * matching element type once the available columns have loaded; searches for other element types are
+ * left to their own listing's applier. Data Object searches need class selection first, so they use
+ * ObjectSavedSearchRestore instead.
+ */
+export declare const SavedSearchRestore: ({ elementType }: SavedSearchRestoreProps) => null;
+export {};

package/dist/build/types/src/core/modules/search/saved-search/restore/use-apply-saved-search.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+import { type SavedSearchDetailedConfiguration } from '../../../../modules/search/search-api-slice.gen';
+/**
+ * Applies the parts of a saved search that map back into the listing state: search term, field
+ * filters, tags, the system filters (PQL, unreferenced, direct-children), paging and the saved
+ * column layout, then triggers a reload. (Sorting and the type filter are not restored yet — see PR
+ * notes.)
+ */
+export declare const useApplySavedSearch: () => ((configuration: SavedSearchDetailedConfiguration) => void);

package/dist/build/types/src/core/modules/search/saved-search/saved-search-decorator.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+import { type AbstractDecorator } from '../../../modules/element/listing/decorators/abstract-decorator';
+import { type ElementType } from '../../../types/enums/element/element-type';
+export interface SavedSearchDecoratorConfig {
+    elementType: ElementType;
+    /**
+     * When true (the Quick Search typed tabs) the panel supports loading an existing saved search
+     * for update/clone. In the regular editor grids it stays false — saving is always "save as new".
+     */
+    supportsLoadedState?: boolean;
+}
+/**
+ * Adds the "Save Search" sidebar entry. Asset + Data Object listings only — not "All"/Documents, which have no saveable grid state.
+ */
+export declare const SavedSearchDecorator: AbstractDecorator<SavedSearchDecoratorConfig>;

package/dist/build/types/src/core/modules/search/saved-search/utils/resolve-element-type.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+import { type ElementType } from '../../../../types/enums/element/element-type';
+/**
+ * Resolves the element type a saved search targets from its stored `elementType`. A classless
+ * data-object search has no classId, so the stored elementType is the only reliable signal.
+ * Defaults to asset when absent.
+ */
+export declare const resolveSavedSearchElementType: (config: {
+    elementType?: string | null;
+}) => ElementType;

package/dist/build/types/src/core/modules/search/saved-search/utils/to-number-array.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+export declare const toNumberArray: (value: unknown) => number[];

package/dist/build/types/src/core/modules/search/saved-search/view-layer/with-saved-search-sidebar-entry.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+import { type AbstractDecoratorProps } from '../../../../modules/element/listing/decorators/abstract-decorator';
+import { type ElementType } from '../../../../types/enums/element/element-type';
+interface SavedSearchSidebarEntryConfig {
+    elementType?: ElementType;
+    supportsLoadedState: boolean;
+}
+export declare const withSavedSearchSidebarEntry: (useBaseHook: AbstractDecoratorProps["useSidebarOptions"], config: SavedSearchSidebarEntryConfig) => AbstractDecoratorProps["useSidebarOptions"];
+export {};

package/dist/build/types/src/core/modules/search/saved-search/widget/saved-search-result-widget.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+import React from 'react';
+import { type ElementType } from '../../../../types/enums/element/element-type';
+export interface SavedSearchResultWidgetProps {
+    savedSearchId: number;
+    elementType: ElementType;
+}
+/**
+ * Hosts a saved search as a tab in the main widget area. It loads the saved search and renders the
+ * matching search listing inside its own SearchProvider, seeded so the listing restores the search
+ * and the Save panel shows the update/clone state.
+ */
+export declare const SavedSearchResultWidget: ({ savedSearchId, elementType }: SavedSearchResultWidgetProps) => React.JSX.Element;

package/dist/build/types/src/core/modules/search/saved-search/widget/saved-search-title.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+import React from 'react';
+import { type TabTitleContainerProps } from '../../../../modules/widget-manager/title/tab-title-container';
+/**
+ * Tab title for a saved-search result widget — shows the element type next to the name (e.g.
+ * "My search (Asset)") and appends the "*" dirty indicator when the opened search has unsaved
+ * changes (driven by the saved-search dirty slice).
+ */
+export declare const SavedSearchTitle: (props: TabTitleContainerProps) => React.JSX.Element;

package/dist/build/types/src/core/modules/search/saved-search/widget/saved-search-widget.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+import { type WidgetManagerActionService } from '../../../../modules/widget-manager/services/widget-manager-action-service';
+import { type ElementType } from '../../../../types/enums/element/element-type';
+/** Widget type id for a saved-search result tab. */
+export declare const SAVED_SEARCH_RESULT_WIDGET = "saved-search-result";
+interface OpenSavedSearchResultWidgetParams {
+    id: number;
+    name: string;
+    elementType: ElementType;
+}
+/**
+ * Opens (or focuses) a saved search as a tab in the main widget area. The result widget self-loads
+ * its configuration from the id, so only the id, display name and element type are needed here.
+ */
+export declare const openSavedSearchResultWidget: (widgetManager: WidgetManagerActionService, { id, name, elementType }: OpenSavedSearchResultWidgetParams) => void;
+export {};