@pimcore/studio-ui-bundle 0.9.30 → 0.12.9

package/dist/build/types/src/core/modules/app/component-registry/component-config.d.ts

@@ -15,8 +15,36 @@ declare const defaultComponentConfig: {
             type: ComponentType;
             name: string;
         };
+        modal: {
+            type: ComponentType;
+            name: string;
+        };
     };
     asset: {
+        listing: {
+            toolbar: {
+                component: {
+                    type: ComponentType;
+                    name: string;
+                };
+                left: {
+                    type: ComponentType;
+                    name: string;
+                    defaultEntries: {
+                        name: string;
+                        priority: number;
+                    }[];
+                };
+                right: {
+                    type: ComponentType;
+                    name: string;
+                    defaultEntries: {
+                        name: string;
+                        priority: number;
+                    }[];
+                };
+            };
+        };
         editor: {
             container: {
                 type: ComponentType;
@@ -62,9 +90,47 @@ declare const defaultComponentConfig: {
                 type: ComponentType;
                 name: string;
             };
+            tooltip: {
+                type: ComponentType;
+                name: string;
+            };
+            node: {
+                meta: {
+                    type: ComponentType;
+                    name: string;
+                    defaultEntries: {
+                        name: string;
+                        priority: number;
+                    }[];
+                };
+            };
         };
     };
     dataObject: {
+        listing: {
+            toolbar: {
+                component: {
+                    type: ComponentType;
+                    name: string;
+                };
+                left: {
+                    type: ComponentType;
+                    name: string;
+                    defaultEntries: {
+                        name: string;
+                        priority: number;
+                    }[];
+                };
+                right: {
+                    type: ComponentType;
+                    name: string;
+                    defaultEntries: {
+                        name: string;
+                        priority: number;
+                    }[];
+                };
+            };
+        };
         editor: {
             toolbar: {
                 slots: {
@@ -86,12 +152,48 @@ declare const defaultComponentConfig: {
                     };
                 };
             };
+            tab: {
+                listing: {
+                    type: ComponentType;
+                    name: string;
+                };
+                edit: {
+                    type: ComponentType;
+                    name: string;
+                };
+                preview: {
+                    type: ComponentType;
+                    name: string;
+                };
+                versions: {
+                    type: ComponentType;
+                    name: string;
+                };
+                variants: {
+                    type: ComponentType;
+                    name: string;
+                };
+            };
         };
         tree: {
             contextMenu: {
                 type: ComponentType;
                 name: string;
             };
+            tooltip: {
+                type: ComponentType;
+                name: string;
+            };
+            node: {
+                meta: {
+                    type: ComponentType;
+                    name: string;
+                    defaultEntries: {
+                        name: string;
+                        priority: number;
+                    }[];
+                };
+            };
         };
     };
     document: {
@@ -126,6 +228,50 @@ declare const defaultComponentConfig: {
                 type: ComponentType;
                 name: string;
             };
+            tooltip: {
+                type: ComponentType;
+                name: string;
+            };
+            node: {
+                meta: {
+                    type: ComponentType;
+                    name: string;
+                    defaultEntries: {
+                        name: string;
+                        priority: number;
+                    }[];
+                };
+            };
+        };
+    };
+    element: {
+        editor: {
+            tab: {
+                properties: {
+                    type: ComponentType;
+                    name: string;
+                };
+                schedule: {
+                    type: ComponentType;
+                    name: string;
+                };
+                dependencies: {
+                    type: ComponentType;
+                    name: string;
+                };
+                workflow: {
+                    type: ComponentType;
+                    name: string;
+                };
+                notesAndEvents: {
+                    type: ComponentType;
+                    name: string;
+                };
+                tags: {
+                    type: ComponentType;
+                    name: string;
+                };
+            };
         };
     };
     leftSidebar: {
@@ -138,6 +284,26 @@ declare const defaultComponentConfig: {
             }[];
         };
     };
+    rightSidebar: {
+        slot: {
+            type: ComponentType;
+            name: string;
+            defaultEntries: {
+                name: string;
+                priority: number;
+            }[];
+        };
+        logo: {
+            image: {
+                type: ComponentType;
+                name: string;
+            };
+            subscriptionDetails: {
+                type: ComponentType;
+                name: string;
+            };
+        };
+    };
     wysiwyg: {
         editor: {
             type: ComponentType;

package/dist/build/types/src/core/modules/app/component-registry/component-registry.d.ts

@@ -35,6 +35,7 @@ export interface ComponentRegistryInterface {
     get: (name: string) => ComponentRegistryEntry<any>['component'];
     has: (name: string) => boolean;
     override: (component: ComponentRegistryEntry<any>) => void;
+    overrideSlotComponent: (slotName: string, component: ComponentRegistryEntry<any>) => void;
     registerToSlot: (slotName: string, component: ComponentRegistryEntry<any>) => void;
     getSlotComponents: (slotName: string) => Array<ComponentRegistryEntry<any>>;
     getComponentConfig: (name: string) => ComponentRegistryConfigEntry;
@@ -49,6 +50,7 @@ export declare class ComponentRegistry implements ComponentRegistryInterface {
     get<T>(name: string): ComponentRegistryEntry<T>['component'];
     has(name: string): boolean;
     override<T>(component: ComponentRegistryEntry<T>): void;
+    overrideSlotComponent(slotName: string, component: ComponentRegistryEntry<any>): void;
     registerToSlot(slotName: string, component: ComponentRegistryEntry<any>): void;
     getSlotComponents(slotName: string): Array<ComponentRegistryEntry<any>>;
     registerConfig(config: ComponentRegistryConfig): void;
@@ -57,4 +59,5 @@ export declare class ComponentRegistry implements ComponentRegistryInterface {
 export * from './enums/component-type';
 export * from './component-config';
 export * from './component-renderer';
+export * from './slot-renderer';
 export * from './use-component-registry';

package/dist/build/types/src/core/modules/app/context-menu-registry/context-menu-config.d.ts

@@ -0,0 +1,157 @@
+/**
+ * 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 interface ContextMenuSlotConfig {
+    name: string;
+    priority: Record<string, number>;
+}
+export declare const contextMenuConfig: {
+    documentTree: {
+        name: string;
+        priority: {
+            addFolder: number;
+            addPage: number;
+            addSnippet: number;
+            addLink: number;
+            addEmail: number;
+            addHardlink: number;
+            rename: number;
+            copy: number;
+            paste: number;
+            pasteInheritance: number;
+            cut: number;
+            pasteCut: number;
+            publish: number;
+            unpublish: number;
+            delete: number;
+            openInNewWindow: number;
+            advanced: number;
+            refreshTree: number;
+        };
+    };
+    documentTreeAdvanced: {
+        name: string;
+        priority: {
+            convertTo: number;
+            lock: number;
+            useAsSite: number;
+            editSite: number;
+            removeSite: number;
+        };
+    };
+    documentEditorToolbar: {
+        name: string;
+        priority: {
+            unpublish: number;
+            delete: number;
+            rename: number;
+            translations: number;
+            openInNewWindow: number;
+            openPreviewInNewWindow: number;
+        };
+    };
+    dataObjectEditorToolbar: {
+        name: string;
+        priority: {
+            unpublish: number;
+            delete: number;
+            rename: number;
+        };
+    };
+    assetEditorToolbar: {
+        name: string;
+        priority: {
+            rename: number;
+            delete: number;
+            download: number;
+            zipDownload: number;
+            clearImageThumbnail: number;
+            clearVideoThumbnail: number;
+            clearPdfThumbnail: number;
+        };
+    };
+    assetTree: {
+        name: string;
+        priority: {
+            newAssets: number;
+            addFolder: number;
+            rename: number;
+            copy: number;
+            paste: number;
+            cut: number;
+            pasteCut: number;
+            delete: number;
+            createZipDownload: number;
+            uploadNewVersion: number;
+            download: number;
+            advanced: number;
+            refreshTree: number;
+        };
+    };
+    dataObjectTree: {
+        name: string;
+        priority: {
+            addObject: number;
+            addVariant: number;
+            addFolder: number;
+            rename: number;
+            copy: number;
+            paste: number;
+            cut: number;
+            pasteCut: number;
+            publish: number;
+            unpublish: number;
+            delete: number;
+            advanced: number;
+            refreshTree: number;
+        };
+    };
+    dataObjectTreeAdvanced: {
+        name: string;
+        priority: {
+            lock: number;
+            lockAndPropagate: number;
+            unlock: number;
+            unlockAndPropagate: number;
+        };
+    };
+    dataObjectListGrid: {
+        name: string;
+        priority: {
+            open: number;
+            rename: number;
+            locateInTree: number;
+            publish: number;
+            unpublish: number;
+            delete: number;
+        };
+    };
+    assetListGrid: {
+        name: string;
+        priority: {
+            open: number;
+            rename: number;
+            locateInTree: number;
+            delete: number;
+            download: number;
+        };
+    };
+    assetPreviewCard: {
+        name: string;
+        priority: {
+            open: number;
+            info: number;
+            rename: number;
+            locateInTree: number;
+            uploadNewVersion: number;
+            download: number;
+            delete: number;
+        };
+    };
+};

package/dist/build/types/src/core/modules/app/context-menu-registry/context-menu-registry.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 ItemType } from '../../../components/dropdown/dropdown';
+export interface ContextMenuItemProvider {
+    name: string;
+    priority?: number;
+    useMenuItem: (context: any) => ItemType | null;
+}
+export type ContextMenuItemProviderUpdate = (provider: ContextMenuItemProvider) => ContextMenuItemProvider;
+export interface ContextMenuRegistryInterface {
+    registerToSlot: (slotName: string, provider: ContextMenuItemProvider) => void;
+    overrideSlotProvider: (slotName: string, provider: ContextMenuItemProvider) => void;
+    updateSlotProvider: (slotName: string, providerName: string, updater: ContextMenuItemProviderUpdate) => void;
+    getSlotProviders: (slotName: string) => ContextMenuItemProvider[];
+}
+export declare class ContextMenuRegistry implements ContextMenuRegistryInterface {
+    private slots;
+    registerToSlot(slotName: string, provider: ContextMenuItemProvider): void;
+    overrideSlotProvider(slotName: string, provider: ContextMenuItemProvider): void;
+    updateSlotProvider(slotName: string, providerName: string, updater: ContextMenuItemProviderUpdate): void;
+    getSlotProviders(slotName: string): ContextMenuItemProvider[];
+    private getSlotItem;
+}

package/dist/build/types/src/core/modules/app/context-menu-registry/context-types.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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 TreeNodeProps } from '../../../components/element-tree/node/tree-node';
+import { type Asset } from '../../../modules/asset/asset-api-slice-enhanced';
+import { type AssetGetTreeApiResponse } from '../../../modules/asset/asset-api-slice.gen';
+import { type DataObject } from '../../../modules/data-object/data-object-api-slice.gen';
+import { type Document } from '../../../modules/document/document-api-slice.gen';
+export interface TreeContextMenuProps {
+    target: TreeNodeProps;
+    onComplete?: () => void;
+}
+export interface DocumentEditorContextMenuProps {
+    target: Document;
+    onComplete?: () => void;
+}
+export interface DataObjectEditorContextMenuProps {
+    target: DataObject;
+    onComplete?: () => void;
+}
+export interface AssetEditorContextMenuProps {
+    target: Asset;
+    onComplete?: () => void;
+}
+export interface DataObjectTreeContextMenuProps {
+    target: TreeNodeProps;
+    onComplete?: () => void;
+}
+export interface AssetTreeContextMenuProps {
+    target: TreeNodeProps;
+    onComplete?: () => void;
+}
+export interface AssetListGridContextMenuProps {
+    row: {
+        id: string;
+        [x: string]: any;
+    };
+    onComplete?: () => void;
+}
+export interface AssetPreviewCardContextMenuProps {
+    asset: AssetGetTreeApiResponse['items'][number];
+    onComplete?: () => void;
+}
+export interface DataObjectListGridContextMenuProps {
+    target: DataObject;
+    onComplete?: () => void;
+}

package/dist/build/types/src/core/modules/app/context-menu-registry/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 { ContextMenuRegistry, type ContextMenuItemProvider, type ContextMenuRegistryInterface } from './context-menu-registry';
+export { useContextMenuSlot } from './use-context-menu-slot';
+export { contextMenuConfig, type ContextMenuSlotConfig } from './context-menu-config';

package/dist/build/types/src/core/modules/app/context-menu-registry/use-context-menu-slot.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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 ItemType } from '../../../components/dropdown/dropdown';
+export declare function useContextMenuSlot(slotName: string, context: any): ItemType[];

package/dist/build/types/src/core/modules/app/error-handler/classes/api-error.d.ts

@@ -7,16 +7,7 @@
  *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
  *  @license    Pimcore Open Core License (POCL)
  */
-import type { FetchBaseQueryError } from '@reduxjs/toolkit/query';
-import type { SerializedError } from '@reduxjs/toolkit';
-import { type IErrorGetContent } from '../../../../modules/app/error-handler/types';
-export type ApiErrorData = FetchBaseQueryError | SerializedError;
-export interface IApiErrorDetails {
-    detail?: string;
-    errorKey?: string;
-    message?: string;
-    error?: string;
-}
+import { type ApiErrorData, type IErrorGetContent } from '../../../../modules/app/error-handler/types';
 export declare const DEFAULT_ERROR_CONTENT = "Something went wrong.";
 declare class ApiError extends Error {
     private readonly errorData;

package/dist/build/types/src/core/modules/app/error-handler/types.d.ts

@@ -7,9 +7,18 @@
  *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
  *  @license    Pimcore Open Core License (POCL)
  */
+import type { FetchBaseQueryError } from '@reduxjs/toolkit/query';
+import type { SerializedError } from '@reduxjs/toolkit';
 export interface IErrorGetContent {
     data: string | {
         errorKey: string;
         title?: string;
     };
 }
+export type ApiErrorData = FetchBaseQueryError | SerializedError;
+export interface IApiErrorDetails {
+    detail?: string;
+    errorKey?: string;
+    message?: string;
+    error?: string;
+}

package/dist/build/types/src/core/modules/app/hook/use-date-converter.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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)
+ */
+interface UseDateConverterResult {
+    convertToTimestamp: (dateString: string, asMilliseconds?: boolean, respectServerTimezone?: boolean) => number | null;
+    convertToDateString: ({ timestamp, asMilliseconds, respectServerTimezone, format }: {
+        timestamp: number;
+        asMilliseconds?: boolean;
+        respectServerTimezone?: boolean;
+        format: string;
+    }) => string | null;
+}
+export declare const useDateConverter: () => UseDateConverterResult;
+export {};

package/dist/build/types/src/core/modules/app/hook/use-handle-keybindings.d.ts

@@ -7,4 +7,5 @@
  *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
  *  @license    Pimcore Open Core License (POCL)
  */
-export declare const useHandleKeyBindings: (callback: (evt: KeyboardEvent) => void, actionName: string, alwaysActive?: boolean) => void;
+import type { UserPermission } from '../../../modules/auth/enums/user-permission';
+export declare const useHandleKeyBindings: (callback: (evt: KeyboardEvent) => void, actionName: string, alwaysActive?: boolean, permission?: UserPermission) => void;

package/dist/build/types/src/core/modules/app/hook-processor-registry/abstract-hook-processor-registry.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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)
+ */
+/**
+ * Abstract Processor Registry
+ *
+ * Base class for managing collections of processors that transform or modify context objects.
+ * Processors are executed in priority order (highest to lowest) and can be registered/unregistered dynamically.
+ *
+ * Each processor receives a context object and can modify it through its execute method.
+ * This pattern allows for extensible, plugin-based functionality where external code can
+ * register processors to extend core behavior.
+ *
+ * @template TContext - The type of context object that processors will receive
+ */
+export interface Processor<TContext> {
+    readonly id: string;
+    readonly priority: number;
+    execute: (context: TContext) => void;
+}
+export declare abstract class AbstractProcessorRegistry<TContext> {
+    protected processors: Array<Processor<TContext>>;
+    registerProcessor(processor: Processor<TContext>): void;
+    unregisterProcessor(id: string): void;
+    executeProcessors(context: TContext): void;
+    getRegisteredProcessors(): ReadonlyArray<Processor<TContext>>;
+    hasProcessor(id: string): boolean;
+}

package/dist/build/types/src/core/modules/app/processor-registry/abstract-data-context.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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)
+ */
+/**
+ * Abstract base class for contexts that need to manipulate data objects
+ * Provides generic field manipulation methods that work with any object type
+ */
+export declare abstract class AbstractDataContext<TData extends Record<string, any>> {
+    protected data: TData;
+    constructor(data: TData);
+    /**
+     * Add or update a field in the data
+     */
+    setField<K extends keyof TData>(key: K, value: TData[K]): void;
+    /**
+     * Get a field from the data
+     */
+    getField<K extends keyof TData>(key: K): TData[K];
+    /**
+     * Check if a field exists in the data
+     */
+    hasField<K extends keyof TData>(key: K): boolean;
+    /**
+     * Get the entire data object
+     */
+    getData(): TData;
+}

package/dist/build/types/src/core/modules/app/processor-registry/abstract-processor-registry.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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)
+ */
+/**
+ * Abstract Processor Registry
+ *
+ * Base class for managing collections of processors that transform or modify context objects.
+ * Processors are executed in priority order (highest to lowest) and can be registered/unregistered dynamically.
+ *
+ * Each processor receives a context object and can modify it through its execute method.
+ * This pattern allows for extensible, plugin-based functionality where external code can
+ * register processors to extend core behavior.
+ *
+ * @template TContext - The type of context object that processors will receive
+ */
+export interface Processor<TContext> {
+    readonly id: string;
+    readonly priority: number;
+    execute: (context: TContext) => void;
+}
+export declare abstract class AbstractProcessorRegistry<TContext> {
+    protected processors: Array<Processor<TContext>>;
+    registerProcessor(processor: Processor<TContext>): void;
+    unregisterProcessor(id: string): void;
+    executeProcessors(context: TContext): void;
+    getRegisteredProcessors(): ReadonlyArray<Processor<TContext>>;
+    hasProcessor(id: string): boolean;
+}