@kentico/xperience-admin-base 31.3.3 → 31.4.1

package/dist/entry.d.ts

@@ -1,9 +1,11 @@
 import { DefineIconParameters } from 'froala-editor';
 import { DraggableProvidedDragHandleProps } from '@hello-pangea/dnd';
+import { ForwardRefExoticComponent } from 'react';
 import { FroalaOptions } from 'froala-editor';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { MutableRefObject } from 'react';
 import { default as React_2 } from 'react';
+import { RefAttributes } from 'react';
 import { RefObject } from 'react';
 import { RegisterCommandParameters } from 'froala-editor';
 
@@ -161,6 +163,9 @@ export declare interface AssetRichTextEditorPluginOptions extends RichTextEditor
 export declare interface AssetRichTextEditorPluginProps extends RichTextEditorPluginProps {
 }
 
+/**
+ * @deprecated The interface is no longer used and will be removed in the future.
+ */
 export declare interface AssetUploadPlaceholderData {
     /**
      * The file associated with the placeholder.
@@ -336,15 +341,15 @@ declare interface DialogHandlers {
 /**
  * Represents information about form field.
  */
-export declare interface FieldInfo {
+export declare interface FieldInfo<TValues extends FieldInfoValueType = FieldInfoValueType> {
     readonly name: string;
-    readonly fieldValues: FieldInfoValueType;
+    readonly fieldValues: TValues;
 }
 
 /**
  * Collection of field values.
  */
-export declare type FieldInfoValueType = Record<string, any>;
+export declare type FieldInfoValueType = FormValues;
 
 declare interface FormCategoryProps {
     readonly title: string;
@@ -357,7 +362,7 @@ declare interface FormCategoryProps {
 /**
  * Represents basic set of form component properties.
  */
-export declare interface FormComponentProps extends FieldInfo {
+export declare interface FormComponentProps<TValue extends FormFieldValue = FormFieldValue> extends FieldInfo {
     /**
      * Name of the component.
      */
@@ -393,7 +398,7 @@ export declare interface FormComponentProps extends FieldInfo {
     /**
      * Value of the form component.
      */
-    readonly value?: any;
+    readonly value?: TValue;
     /**
      * Indicates if the form component is in invalid state.
      */
@@ -418,7 +423,7 @@ export declare interface FormComponentProps extends FieldInfo {
      * The callback function called when the value of the form component changes.
      * * @argument value changed value of the form component.
      */
-    readonly onChange?: (value: OnChangeValueType) => void;
+    readonly onChange?: (value?: TValue) => void;
     /**
      * Indicates whether the value of the form component is required.
      */
@@ -456,10 +461,19 @@ declare enum FormEditMode {
     ReadOnly = 'readOnly'
 }
 
+declare type FormFieldValue = JSONPrimitive | Date | FormFieldValue[] | {
+    [key: string]: FormFieldValue;
+};
+
 /**
  * Array of form components and their categories.
  */
-declare type FormItems = Array<FormComponentProps | FormCategoryProps>;
+declare type FormItems<TValues extends FormValues = FormValues> = Array<FormComponentProps<TValues[keyof TValues]> | FormCategoryProps>;
+
+/**
+ * Represents form submit parameters.
+ */
+declare type FormValues = Record<string, FormFieldValue>;
 
 /** Configurator enables custom Froala Typescript plugins to use global Froala configuration methods, which would be unavailable due to different module context. */
 declare interface FroalaEditorConfigurator {
@@ -508,6 +522,8 @@ declare interface InjectedProps {
     readonly children: React.ReactNode;
 }
 
+declare type JSONPrimitive = string | number | boolean | null | undefined;
+
 declare const KXIconSets = {
     'xp-default-icon-set': Icons,
     'xp-flags-icon-set': Flags
@@ -601,11 +617,6 @@ declare enum NotificationMessageType {
     Info = "info"
 }
 
-/**
- * Untyped alias for value used on change.
- */
-declare type OnChangeValueType = Object | null;
-
 /**
  * Describes single dropdown option configuration.
  */
@@ -620,14 +631,13 @@ export declare interface RichTextEditorDropdownOption {
     readonly componentName?: string;
 }
 
-export declare const RichTextEditorNestedComponentLoader: {
-    ({ onLoad, ...props }: RichTextEditorNestedComponentLoaderProps): JSX_2.Element;
-    displayName: string;
-};
+export declare const RichTextEditorNestedComponentLoader: ForwardRefExoticComponent<RichTextEditorNestedComponentLoaderProps & RefAttributes<RichTextEditorNestedComponentRef>>;
 
 export declare interface RichTextEditorNestedComponentLoaderProps extends RichTextEditorNestedComponentProps {
-    /** Function called after load of the plugin. */
-    readonly onLoad: (inputRef: RichTextEditorNestedComponentRef) => void;
+    /** Function called after load of the plugin.
+     * @deprecated - use ref instead to get the reference to the nested component and call the method on it directly
+     */
+    readonly onLoad?: (inputRef: RichTextEditorNestedComponentRef) => void;
 }
 
 export declare interface RichTextEditorNestedComponentProps {
@@ -952,8 +962,8 @@ export declare interface ValidationResult {
 /**
  * Base type used by validation rules.
  */
-export declare interface ValidationRule<P extends ValidationRuleProps, T> {
-    (props: P, value: T, fieldValues: Record<string, any>): ValidationResult;
+export declare interface ValidationRule<P extends ValidationRuleProps, TValue extends FormFieldValue> {
+    (props: P, value: TValue, fieldValues: FormValues): ValidationResult;
 }
 
 /**