@pimcore/studio-ui-bundle 0.13.20 → 0.14.19

package/dist/build/types/src/core/modules/rule-builder/components/shared/hooks/use-sortable-item.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 { useSortable } from '@dnd-kit/sortable';
+import type { CSSProperties } from 'react';
+export interface UseSortableItemOptions {
+    disabled?: boolean;
+}
+export interface UseSortableItemReturn {
+    attributes: ReturnType<typeof useSortable>['attributes'];
+    listeners: ReturnType<typeof useSortable>['listeners'];
+    setNodeRef: ReturnType<typeof useSortable>['setNodeRef'];
+    style: CSSProperties;
+}
+export declare function useSortableItem(id: string, options?: UseSortableItemOptions): UseSortableItemReturn;

package/dist/build/types/src/core/modules/rule-builder/components/shared/rule-item-list.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 { RuleItem } from '../../../../modules/rule-builder/types/rule-item.types';
+export interface RuleItemListProps<T extends RuleItem, P = any> {
+    value: T[];
+    disabled?: boolean;
+    onChange?: (value: T[]) => void;
+    renderItem: (item: T, disabled: boolean) => React.ReactNode;
+    renderAddButton: (disabled: boolean) => React.ReactNode;
+    Provider: React.ComponentType<P>;
+    providerProps: P;
+}
+export declare function RuleItemList<T extends RuleItem, P = any>(props: RuleItemListProps<T, P>): React.JSX.Element;

package/dist/build/types/src/core/modules/rule-builder/components/shared/rule-item-tool-strip.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 React from 'react';
+import { type DragHandleProps } from '../../../../components/toolstrip/tool-strip';
+import type { ElementIcon } from '../../../../components/icon/icon';
+export interface RuleItemToolStripProps {
+    label: string;
+    icon?: ElementIcon;
+    onMoveUp: () => void;
+    onMoveDown: () => void;
+    onRemove: () => void;
+    canMoveUp: boolean;
+    canMoveDown: boolean;
+    disabled?: boolean;
+    dragHandleProps?: DragHandleProps | false;
+}
+export declare const RuleItemToolStrip: ({ label, icon, onMoveUp, onMoveDown, onRemove, canMoveUp, canMoveDown, disabled, dragHandleProps }: RuleItemToolStripProps) => React.JSX.Element;

package/dist/build/types/src/core/modules/rule-builder/components/sortable-rules-list/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 { SortableRulesList, type SortableRulesListProps } from './sortable-rules-list';
+export { SortableRuleItem, type SortableRuleItemProps } from './sortable-rule-item';
+export type { SortableItem, SortableItemWithMenu } from './sortable-rules-list.types';

package/dist/build/types/src/core/modules/rule-builder/components/sortable-rules-list/sortable-rule-item.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)
+ */
+import React from 'react';
+import { type DropdownProps } from '../../../../components/dropdown/dropdown';
+import type { SortableItem } from './sortable-rules-list.types';
+export interface SortableRuleItemProps {
+    item: SortableItem;
+    isDragDisabled: boolean;
+    contextMenuItems?: DropdownProps['menu']['items'];
+    onClick?: (item: SortableItem) => void;
+    renderContent?: (item: SortableItem) => React.ReactNode;
+}
+export declare function SortableRuleItem({ item, isDragDisabled, contextMenuItems, onClick, renderContent }: SortableRuleItemProps): React.JSX.Element;

package/dist/build/types/src/core/modules/rule-builder/components/sortable-rules-list/sortable-rules-list.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)
+ */
+import React from 'react';
+import type { SortableItemWithMenu } from './sortable-rules-list.types';
+export interface SortableRulesListProps {
+    items: SortableItemWithMenu[];
+    isDragDisabled?: boolean;
+    onReorder?: (newOrder: SortableItemWithMenu[]) => void;
+    emptyMessage?: string;
+    onItemClick?: (item: SortableItemWithMenu) => void;
+    renderItemContent?: (item: SortableItemWithMenu) => React.ReactNode;
+}
+export declare function SortableRulesList({ items, isDragDisabled, onReorder, emptyMessage, onItemClick, renderItemContent }: SortableRulesListProps): React.JSX.Element;

package/dist/build/types/src/core/modules/rule-builder/components/sortable-rules-list/sortable-rules-list.styles.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)
+ */
+export declare const useStyles: (props?: unknown) => import("antd-style").ReturnStyles<{
+    ruleItem: import("antd-style").SerializedStyles;
+    ruleItemIcon: import("antd-style").SerializedStyles;
+    ruleItemTitle: import("antd-style").SerializedStyles;
+    inactiveIcon: import("antd-style").SerializedStyles;
+}>;

package/dist/build/types/src/core/modules/rule-builder/components/sortable-rules-list/sortable-rules-list.types.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)
+ */
+import type { DropdownProps } from '../../../../components/dropdown/dropdown';
+import type { ElementIcon } from '../../../../components/icon/icon';
+export interface SortableItem {
+    id: number | string;
+    label: string;
+    active?: boolean;
+    icon?: ElementIcon;
+}
+export interface SortableItemWithMenu extends SortableItem {
+    contextMenuItems?: DropdownProps['menu']['items'];
+}

package/dist/build/types/src/core/modules/rule-builder/dynamic-types/rule-action/dynamic-type-rule-action-abstract.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 { DynamicTypeAbstract } from '../../../../modules/element/dynamic-types/registry/dynamic-type-registry-abstract';
+import { type ElementIcon } from '../../../../components/icon/icon';
+import { type ReactNode } from 'react';
+export type RuleActionConfig = Record<string, unknown>;
+export interface ActionFormProps<T = RuleActionConfig> {
+    value: T;
+    onChange: (value: T) => void;
+    disabled?: boolean;
+}
+export declare abstract class DynamicTypeRuleActionAbstract<T extends RuleActionConfig = RuleActionConfig> extends DynamicTypeAbstract {
+    abstract readonly id: string;
+    abstract readonly label: string;
+    readonly icon?: ElementIcon;
+    abstract readonly defaultValue: T;
+    /**
+     * Optional availability check. If this function returns false, the action
+     * will be disabled in the "Add Action" dropdown and show a warning if already configured.
+     * Defaults to true if not implemented.
+     */
+    readonly isAvailable?: () => boolean;
+    /**
+     * Optional hint to display when the action is not available.
+     * Shown as a tooltip in the dropdown and as a warning message in configured actions.
+     */
+    readonly notAvailableHint?: string;
+    /**
+     * Render the form for configuring this action.
+     * Must be an arrow function property to preserve 'this' binding.
+     *
+     * @example
+     * renderForm = (props: ActionFormProps<MyActionConfig>): ReactNode => {
+     *   return <MyForm {...props} />
+     * }
+     */
+    abstract renderForm: (props: ActionFormProps<T>) => ReactNode;
+}

package/dist/build/types/src/core/modules/rule-builder/dynamic-types/rule-action/dynamic-type-rule-action-registry.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 { DynamicTypeRegistryAbstract } from '../../../../modules/element/dynamic-types/registry/dynamic-type-registry-abstract';
+import { type DynamicTypeRuleActionAbstract, type ActionFormProps, type RuleActionConfig } from './dynamic-type-rule-action-abstract';
+import { type ReactNode } from 'react';
+import { type RuleItemRegistry } from '../../../../modules/rule-builder/types/rule-item.types';
+export declare class DynamicTypeRuleActionRegistry extends DynamicTypeRegistryAbstract<DynamicTypeRuleActionAbstract> implements RuleItemRegistry {
+    getActionFormComponent<T extends RuleActionConfig = RuleActionConfig>(id: string, props: ActionFormProps<T>): ReactNode;
+    getDefaultValue<T extends RuleActionConfig = RuleActionConfig>(id: string): T;
+}

package/dist/build/types/src/core/modules/rule-builder/dynamic-types/rule-condition/dynamic-type-rule-condition-abstract.d.ts

@@ -0,0 +1,40 @@
+/**
+ * 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 { DynamicTypeAbstract } from '../../../../modules/element/dynamic-types/registry/dynamic-type-registry-abstract';
+import type { RuleBaseCondition, RuleConditionFormProps } from '../../../../components/rule-condition/types/rule-condition.types';
+import type { ReactNode } from 'react';
+import type { ElementIcon } from '../../../../components/icon/icon';
+export declare abstract class DynamicTypeRuleConditionAbstract<T extends RuleBaseCondition = RuleBaseCondition> extends DynamicTypeAbstract {
+    abstract readonly id: string;
+    abstract readonly label: string;
+    readonly icon?: ElementIcon;
+    abstract readonly defaultValue: Partial<Omit<T, 'id' | 'type'>>;
+    /**
+     * Optional availability check. If this function returns false, the condition
+     * will be disabled in the "Add Condition" dropdown and show a warning if already configured.
+     * Defaults to true if not implemented.
+     */
+    readonly isAvailable?: () => boolean;
+    /**
+     * Optional hint to display when the condition is not available.
+     * Shown as a tooltip in the dropdown and as a warning message in configured conditions.
+     */
+    readonly notAvailableHint?: string;
+    /**
+     * Render the form for this condition type.
+     * Must be an arrow function property to preserve 'this' binding.
+     *
+     * @example
+     * renderForm = (props: RuleConditionFormProps<MyConditionConfig>): ReactNode => {
+     *   return <MyForm {...props} />
+     * }
+     */
+    abstract renderForm: (props: RuleConditionFormProps<T>) => ReactNode;
+}

package/dist/build/types/src/core/modules/rule-builder/dynamic-types/rule-condition/dynamic-type-rule-condition-registry.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)
+ */
+import { DynamicTypeRegistryAbstract } from '../../../../modules/element/dynamic-types/registry/dynamic-type-registry-abstract';
+import { type DynamicTypeRuleConditionAbstract } from './dynamic-type-rule-condition-abstract';
+import type { RuleConditionTypeConfig } from '../../../../components/rule-condition/types/rule-condition.types';
+export declare class DynamicTypeRuleConditionRegistry extends DynamicTypeRegistryAbstract<DynamicTypeRuleConditionAbstract<any>> {
+    getConditionTypeConfig(id: string): RuleConditionTypeConfig<any> | undefined;
+}

package/dist/build/types/src/core/modules/rule-builder/dynamic-types/rule-trigger/dynamic-type-rule-trigger-abstract.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 { DynamicTypeAbstract } from '../../../../modules/element/dynamic-types/registry/dynamic-type-registry-abstract';
+import { type ElementIcon } from '../../../../components/icon/icon';
+import { type ReactNode } from 'react';
+export type RuleTriggerConfig = Record<string, unknown>;
+export interface TriggerFormProps<T = RuleTriggerConfig> {
+    value: T;
+    onChange: (value: T) => void;
+    disabled?: boolean;
+}
+export declare abstract class DynamicTypeRuleTriggerAbstract<T extends RuleTriggerConfig = RuleTriggerConfig> extends DynamicTypeAbstract {
+    abstract readonly id: string;
+    abstract readonly label: string;
+    readonly icon?: ElementIcon;
+    abstract readonly defaultValue: T;
+    /**
+     * Optional availability check. If this function returns false, the trigger
+     * will be disabled in the "Add Trigger" dropdown and show a warning if already configured.
+     * Defaults to true if not implemented.
+     */
+    readonly isAvailable?: () => boolean;
+    /**
+     * Optional hint to display when the trigger is not available.
+     * Shown as a tooltip in the dropdown and as a warning message in configured triggers.
+     */
+    readonly notAvailableHint?: string;
+    /**
+     * Render the form for configuring this trigger.
+     * Must be an arrow function property to preserve 'this' binding.
+     *
+     * @example
+     * renderForm = (props: TriggerFormProps<MyTriggerConfig>): ReactNode => {
+     *   return <MyForm {...props} />
+     * }
+     */
+    abstract renderForm: (props: TriggerFormProps<T>) => ReactNode;
+}

package/dist/build/types/src/core/modules/rule-builder/dynamic-types/rule-trigger/dynamic-type-rule-trigger-registry.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 { DynamicTypeRegistryAbstract } from '../../../../modules/element/dynamic-types/registry/dynamic-type-registry-abstract';
+import { type DynamicTypeRuleTriggerAbstract, type TriggerFormProps, type RuleTriggerConfig } from './dynamic-type-rule-trigger-abstract';
+import { type ReactNode } from 'react';
+import { type RuleItemRegistry } from '../../../../modules/rule-builder/types/rule-item.types';
+export declare class DynamicTypeRuleTriggerRegistry extends DynamicTypeRegistryAbstract<DynamicTypeRuleTriggerAbstract> implements RuleItemRegistry {
+    getTriggerFormComponent<T extends RuleTriggerConfig = RuleTriggerConfig>(id: string, props: TriggerFormProps<T>): ReactNode;
+    getDefaultValue<T extends RuleTriggerConfig = RuleTriggerConfig>(id: string): T;
+}

package/dist/build/types/src/core/modules/rule-builder/types/rule-item.types.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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)
+ */
+/**
+ * Direction for moving rule items
+ */
+export type RuleItemMoveDirection = 'up' | 'down';
+/**
+ * Base interface for rule items (actions, triggers)
+ */
+export interface RuleItem {
+    id: string;
+    type: string;
+    config: Record<string, unknown>;
+}
+/**
+ * Registry interface for managing rule items.
+ * Registries that implement this can be used with useRuleItems hook.
+ */
+export interface RuleItemRegistry {
+    getDefaultValue: (type: string) => any;
+}