@kentico/xperience-admin-base 14.0.0-109224

package/dist/forms/form/Form.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import { FormProps, FormRef } from './Form.types';
+/**
+* Represents component displaying form with defined fields.
+*/
+export declare const Form: React.ForwardRefExoticComponent<FormProps & React.RefAttributes<FormRef>>;

package/dist/forms/form/Form.types.d.ts

@@ -0,0 +1,129 @@
+import { UITestProps } from '@kentico/xperience-admin-components';
+import React from 'react';
+import { FormComponentProps } from '../form-components/FormComponent.types';
+import { FormCategoryProps } from './formCategory/FormCategory.types';
+/**
+ * Form reference exposing Form functions.
+ */
+export declare type FormRef = {
+    /**
+     * Submits the entire form.
+     */
+    submit: (action?: string) => void;
+    /**
+     * Resets data changed flag after successfull form submission.
+     */
+    resetDataChanged: () => void;
+} | null;
+/**
+ * Defines a form context type.
+ */
+export interface FormStatus {
+    /**
+     * Represents form name.
+     */
+    readonly name: string;
+    /**
+     * Indicates whether any form data has been changed.
+     * Form submission resets value to true.
+     */
+    readonly dataChanged?: boolean;
+}
+/**
+ * Name of the form the components are rendered within.
+ */
+export declare const FormContext: React.Context<FormStatus>;
+/**
+ * Array of form components and their categories.
+ */
+export declare type FormItems = Array<FormComponentProps | FormCategoryProps>;
+/**
+ * Form category with its form components.
+ */
+export interface CategoryWithComponents {
+    readonly category: FormCategoryProps | null;
+    readonly components: FormComponentProps[];
+}
+/**
+ * Properties for Form cmponent.
+ */
+export interface FormProps extends UITestProps {
+    /**
+     * Form component has no button rendered, define the children to display submitting component.
+     */
+    readonly children?: React.ReactNode;
+    /**
+     * Collection of form items which will be displayed inside the form.
+     */
+    readonly items: FormItems;
+    /**
+     * Name of the form.
+     */
+    readonly name?: string;
+    /**
+     * Determines whether the form is read only.
+     */
+    readonly readOnly?: boolean;
+    /**
+     * Allows to specify CSS class of the field block.
+     */
+    readonly fieldCssClass?: string;
+    /**
+     * Function for form value change monitoring.
+     */
+    readonly onChange?: (e: ChangeEventHandler) => void;
+    /**
+     * Function for a valid form value change monitoring.
+     * Raised only when a changed form component value passes all validation rules
+     * or when the form component does not have any validation rule registered.
+     */
+    readonly onValidChange?: (e: ChangeEventHandler) => void;
+    /**
+     * Submit function used to submit form data.
+     */
+    readonly onSubmit?: (e: SubmitEventHandler, action?: string) => void;
+}
+export interface ChangeEventHandler {
+    readonly changedField: {
+        name: string;
+        hasDependencies: boolean;
+    };
+    readonly values: {
+        [fieldName: string]: any;
+    };
+}
+export interface SubmitEventHandler {
+    readonly values: {
+        [fieldName: string]: any;
+    };
+}
+/**
+ * Represents result of form submission.
+ */
+export interface FormSubmissionResult {
+    /**
+     * Collection of form items and categories which will be displayed inside the form.
+     */
+    readonly items: FormItems;
+    /**
+     * Status of the form submission and validation process.
+     */
+    readonly status: FormSubmissionStatus;
+}
+/**
+ * Indicates the state of the form submission and validation result.
+ */
+export declare enum FormSubmissionStatus {
+    /**
+     * Error during the form submission.
+     */
+    Error = "error",
+    /**
+     * Form validation failed.
+     */
+    ValidationFailure = "validationFailure",
+    /**
+     * Submission and validation successful.
+     */
+    ValidationSuccess = "validationSuccess"
+}

package/dist/forms/form/FormField.d.ts

@@ -0,0 +1,5 @@
+import { FormFieldProps } from './FormField.types';
+/**
+ * Represent one particular field displayed in Form component.
+ */
+export declare const FormField: ({ ...props }: FormFieldProps) => JSX.Element;

package/dist/forms/form/FormField.types.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import { FieldInfo, FormComponentProps } from '../form-components/FormComponent.types';
+import { ValidationResult } from '../validation-rules/ValidationRule.types';
+/**
+ * General propoerties for FormField component.
+ */
+export interface FormFieldProps extends FormComponentProps {
+    readonly fieldCssClass?: string;
+    readonly onValidated?: (invalidValidationResults: ValidationResult[]) => void;
+    readonly onValidChange?: () => void;
+}
+/**
+ * The form field in which components are rendered.
+ */
+export declare const FormFieldContext: React.Context<FieldInfo>;

package/dist/forms/form/formCategory/FormCategory.d.ts

@@ -0,0 +1,2 @@
+import { FormCategoryComponentProps } from './FormCategory.types';
+export declare const FormCategory: ({ category, children, }: FormCategoryComponentProps) => JSX.Element;

package/dist/forms/form/formCategory/FormCategory.types.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+export interface FormCategoryProps {
+    readonly title: string;
+    readonly collapsible?: boolean;
+    readonly isCollapsed?: boolean;
+    readonly tooltip?: string;
+}
+export interface FormCategoryComponentProps {
+    readonly category?: FormCategoryProps | null;
+    readonly children: React.ReactNode;
+}

package/dist/forms/form/index.d.ts

@@ -0,0 +1,4 @@
+export * from './Form';
+export * from './Form.types';
+export { FormFieldContext } from './FormField.types';
+export type { FormCategoryProps } from './formCategory/FormCategory.types';

package/dist/forms/form/utils/parseFormCategories.d.ts

@@ -0,0 +1,2 @@
+import { CategoryWithComponents, FormItems } from '../../index';
+export declare const parseFormCategories: (components: FormItems) => CategoryWithComponents[];

package/dist/forms/form-components/FormComponent.types.d.ts

@@ -0,0 +1,24 @@
+import { ValidationRuleProps } from '../validation-rules/ValidationRule.types';
+export declare type OnChangeValueType = any;
+export declare type FieldInfoValueType = Record<string, any>;
+export interface FieldInfo {
+    readonly name: string;
+    readonly fieldValues: FieldInfoValueType;
+}
+export interface FormComponentProps extends FieldInfo {
+    readonly componentName: string;
+    readonly hasDependencies: boolean;
+    readonly label?: string;
+    readonly statusText?: string;
+    readonly explanationText?: string;
+    readonly tooltip?: string;
+    readonly readOnly?: boolean;
+    readonly value?: any;
+    readonly invalid?: boolean;
+    readonly validationMessage?: string;
+    readonly validationRules?: ValidationRuleProps[];
+    readonly onChange?: (value: OnChangeValueType) => void;
+    readonly required?: boolean;
+    readonly disabledMessage?: string;
+    readonly guid: string;
+}

package/dist/forms/form-components/FormComponentLoader.d.ts

@@ -0,0 +1,2 @@
+import { FormComponentProps } from './FormComponent.types';
+export declare const FormComponentLoader: (props: FormComponentProps) => JSX.Element;

package/dist/forms/form-components/asset-selector-form-component/AssetSelectorDropTile.d.ts

@@ -0,0 +1 @@
+export declare const AssetSelectorDropTile: () => JSX.Element;

package/dist/forms/form-components/asset-selector-form-component/AssetSelectorFormComponent.d.ts

@@ -0,0 +1,5 @@
+import { AssetSelectorFormComponentProps } from './AssetSelectorFormComponent.types';
+/**
+ * Form component capable of selecting multiple assets from AssetSelector component.
+ */
+export declare const AssetSelectorFormComponent: (props: AssetSelectorFormComponentProps) => JSX.Element;

package/dist/forms/form-components/asset-selector-form-component/AssetSelectorFormComponent.types.d.ts

@@ -0,0 +1,11 @@
+import { AssetTile } from '../../../shared-components/Assets';
+import { FormComponentProps } from '../FormComponent.types';
+/**
+ * Properties for AssetSelectorFormComponent component.
+ */
+export interface AssetSelectorFormComponentProps extends FormComponentProps {
+    readonly siteIdentifier: number;
+    readonly maximumAssets: number;
+    readonly allowedExtensions?: string;
+    readonly assets: AssetTile[];
+}

package/dist/forms/form-components/checkbox-form-component/CheckboxFormComponent.d.ts

@@ -0,0 +1,2 @@
+import { FormComponentProps } from '../FormComponent.types';
+export declare const CheckboxFormComponent: (props: FormComponentProps) => JSX.Element;

package/dist/forms/form-components/condition-builder-form-component/ConditionBuilderFormComponent.d.ts

@@ -0,0 +1,2 @@
+import { ConditionBuilderFormComponentProps } from './ConditionBuilderFormComponent.types';
+export declare const ConditionBuilderFormComponent: ({ initialConfiguration, availableMacroRules, availableMacroRuleConfigurations, onChange, label, disabledMessage, invalid, validationMessage, readOnly, required, explanationText, tooltip, ...props }: ConditionBuilderFormComponentProps) => JSX.Element;

package/dist/forms/form-components/condition-builder-form-component/ConditionBuilderFormComponent.types.d.ts

@@ -0,0 +1,18 @@
+import { FormComponentProps } from '../FormComponent.types';
+import { ConditionBuilderProps } from '../../../shared-components/ConditionBuilder/ConditionBuilder';
+import { FormSubmissionStatus } from '../..';
+export interface ConditionBuilderFormComponentProps extends FormComponentProps, Omit<ConditionBuilderProps, 'onChange'> {
+}
+/**
+ * Represents result of form submission.
+ */
+export interface GetMacroCommandSubmissionResult {
+    /**
+     * Status of the form submission and validation process.
+     */
+    readonly status: FormSubmissionStatus;
+    /**
+     * Status of the form submission and validation process.
+     */
+    readonly result?: string;
+}

package/dist/forms/form-components/condition-builder-form-component/single-object-selector-form-component/SingleObjectSelectorFormComponent.d.ts

@@ -0,0 +1,5 @@
+import { SingleObjectSelectorFormComponentProps } from './SingleObjectSelectorFormComponentProps.types';
+export declare const SingleObjectSelectorFormComponent: {
+    ({ objectType, textColumnName, valueColumnName, fieldValues, name, ...props }: SingleObjectSelectorFormComponentProps): JSX.Element;
+    displayName: string;
+};

package/dist/forms/form-components/condition-builder-form-component/single-object-selector-form-component/SingleObjectSelectorFormComponentProps.types.d.ts

@@ -0,0 +1,16 @@
+import { DropDownOption } from '../../dropdown-form-component/DropDownFormComponentProps.types';
+import { FormComponentProps } from '../../FormComponent.types';
+export interface SingleObjectSelectorFormComponentProps extends FormComponentProps {
+    readonly objectType: string;
+    readonly textColumnName: string;
+    readonly valueColumnName: string;
+    readonly placeholder?: string;
+}
+export interface LoadOptionsCommandArguments {
+    readonly options: DropDownOption[];
+}
+export interface LoadOptionsCommandResult {
+    readonly objectType: string;
+    readonly textColumnName: string;
+    readonly valueColumnName: string;
+}

package/dist/forms/form-components/dropdown-form-component/DropDownFormComponent.d.ts

@@ -0,0 +1,2 @@
+import { DropDownFormComponentProps } from './DropDownFormComponentProps.types';
+export declare const DropdownSelectorFormComponent: ({ value, label, readOnly, placeholder, name, invalid, required, disabledMessage, tooltip, explanationText, validationMessage, options, maxContentHeight, onChange }: DropDownFormComponentProps) => JSX.Element;

package/dist/forms/form-components/dropdown-form-component/DropDownFormComponentProps.types.d.ts

@@ -0,0 +1,11 @@
+import { UITestProps } from '@kentico/xperience-admin-components';
+import { FormComponentProps } from '../FormComponent.types';
+export interface DropDownFormComponentProps extends FormComponentProps, UITestProps {
+    readonly options: DropDownOption[];
+    readonly placeholder?: string;
+    readonly maxContentHeight?: string;
+}
+export interface DropDownOption {
+    readonly value: string;
+    readonly text: string;
+}

package/dist/forms/form-components/extension-selector-form-component/ExtensionSelectorFormComponent.d.ts

@@ -0,0 +1,5 @@
+import { ExtensionSelectorProps } from './ExtensionSelectorFormComponent.types';
+/**
+ * Form component used to set allowed extensions.
+ */
+export declare const ExtensionSelectorFormComponent: ({ allowedExtensions, inheritSystemSettings, settingsAllowedExtensions, ...props }: ExtensionSelectorProps) => JSX.Element;

package/dist/forms/form-components/extension-selector-form-component/ExtensionSelectorFormComponent.types.d.ts

@@ -0,0 +1,9 @@
+import { FormComponentProps } from '../FormComponent.types';
+/**
+ * Properties for ExtensionSelectorFormComponent.
+ */
+export interface ExtensionSelectorProps extends FormComponentProps {
+    readonly allowedExtensions?: string;
+    readonly settingsAllowedExtensions: string;
+    readonly inheritSystemSettings: boolean;
+}

package/dist/forms/form-components/formComponentUtils.d.ts

@@ -0,0 +1,5 @@
+import { IconName } from '@kentico/xperience-admin-components';
+/**
+ * Returns form component label icon only if tooltip text is defined
+*/
+export declare const getFormLabelIcon: (toolTipText: string | undefined) => IconName | undefined;

package/dist/forms/form-components/index.d.ts

@@ -0,0 +1,20 @@
+export * from './FormComponent.types';
+export * from './checkbox-form-component/CheckboxFormComponent';
+export * from './namespace-code-name-form-component/NamespaceCodeNameFormComponent';
+export * from './condition-builder-form-component/ConditionBuilderFormComponent';
+export * from './dropdown-form-component/DropDownFormComponent';
+export * from './dropdown-form-component/DropDownFormComponentProps.types';
+export * from './number-input-form-component/NumberInputFormComponent';
+export * from './password-form-component/PasswordFormComponent';
+export * from './radio-group-form-component/RadioGroupFormComponent';
+export * from './rich-text-editor-form-component/RichTextEditorFormComponent';
+export * from './rich-text-editor-form-component/plugins';
+export * from './text-input-form-component/TextInputFormComponent';
+export * from './text-input-form-component/TextInputFormComponentProps.types';
+export * from './textarea-form-component/TextAreaFormComponent';
+export * from './condition-builder-form-component/single-object-selector-form-component/SingleObjectSelectorFormComponent';
+export * from './asset-selector-form-component/AssetSelectorFormComponent';
+export * from './extension-selector-form-component/ExtensionSelectorFormComponent';
+export * from './validation-rule-list-form-component/ValidationRuleListFormComponent';
+export * from './text-with-label-form-component/TextWithLabelFormComponent';
+export * from './object-selector-form-component/ObjectSelectorFormComponent';

package/dist/forms/form-components/namespace-code-name-form-component/NamespaceCodeNameFormComponent.d.ts

@@ -0,0 +1,2 @@
+import { NamespaceCodeNameProps } from './NamespaceCodeNameFormComponent.types';
+export declare const NamespaceCodeNameFormComponent: (props: NamespaceCodeNameProps) => JSX.Element;

package/dist/forms/form-components/namespace-code-name-form-component/NamespaceCodeNameFormComponent.types.d.ts

@@ -0,0 +1,3 @@
+import { FormComponentProps } from '..';
+export interface NamespaceCodeNameProps extends FormComponentProps {
+}

package/dist/forms/form-components/number-input-form-component/NumberInputFormComponent.d.ts

@@ -0,0 +1,2 @@
+import { FormComponentProps } from '../FormComponent.types';
+export declare const NumberInputFormComponent: (props: FormComponentProps) => JSX.Element;

package/dist/forms/form-components/object-selector-form-component/ObjectSelectorFormComponent.d.ts

@@ -0,0 +1,5 @@
+import type { ObjectSelectorProps } from './ObjectSelectorFormComponent.types';
+export declare const ObjectSelectorFormComponent: {
+    ({ selectedObjects, maximumItems, placeholder, readOnly, invalid, required, label, statusText, explanationText, validationMessage, onChange, ...props }: ObjectSelectorProps): JSX.Element;
+    displayName: string;
+};

package/dist/forms/form-components/object-selector-form-component/ObjectSelectorFormComponent.types.d.ts

@@ -0,0 +1,23 @@
+import { FormComponentProps } from '../FormComponent.types';
+export interface ObjectSelectorProps extends FormComponentProps {
+    readonly maximumItems: number;
+    readonly placeholder?: string;
+    readonly selectedObjects: ObjectSelectorSelectionItem[];
+}
+export interface LoadObjectsArguments {
+    readonly searchTerm: string;
+    readonly pageIndex: number;
+}
+export interface LoadObjectsCommandResult {
+    readonly objects: ObjectSelectorSelectionItem[];
+    readonly nextPageAvailable: boolean;
+}
+export interface ObjectSelectorItem {
+    readonly objectCodeName: string;
+    readonly objectGuid: string;
+}
+export interface ObjectSelectorSelectionItem {
+    readonly value: ObjectSelectorItem;
+    readonly text: string;
+    readonly isValid: boolean;
+}

package/dist/forms/form-components/object-selector-form-component/async-dropdown-selector/AsyncDropDownSelector.d.ts

@@ -0,0 +1,2 @@
+import { AsyncDropDownProps } from './AsyncDropDownSelector.types';
+export declare const AsyncDropDownSelector: (props: AsyncDropDownProps) => JSX.Element;

package/dist/forms/form-components/object-selector-form-component/async-dropdown-selector/AsyncDropDownSelector.types.d.ts

@@ -0,0 +1,9 @@
+import { GroupBase } from 'react-select';
+import { AsyncPaginateProps } from 'react-select-async-paginate';
+export interface Option {
+    readonly value: string;
+    readonly label: string;
+    readonly isValid: boolean;
+}
+export interface AsyncDropDownProps extends AsyncPaginateProps<Option, GroupBase<Option>, unknown, boolean> {
+}

package/dist/forms/form-components/password-form-component/PasswordFormComponent.d.ts

@@ -0,0 +1,2 @@
+import { PasswordProps } from './PasswordFormComponent.types';
+export declare const PasswordFormComponent: ({ requiredLength, requireLowercase, requireUppercase, requiredUniqueChars, requireDigit, requireNonAlphanumeric, ignorePasswordPolicy, ...props }: PasswordProps) => JSX.Element;

package/dist/forms/form-components/password-form-component/PasswordFormComponent.types.d.ts

@@ -0,0 +1,14 @@
+import { FormComponentProps } from '..';
+/**
+ * Properties for PasswordFormComponent.
+ * Represents the valid password policy.
+ */
+export interface PasswordProps extends FormComponentProps {
+    readonly requireDigit?: boolean;
+    readonly requiredLength?: number;
+    readonly requiredUniqueChars?: number;
+    readonly requireUppercase?: boolean;
+    readonly requireLowercase?: boolean;
+    readonly requireNonAlphanumeric?: boolean;
+    readonly ignorePasswordPolicy: boolean;
+}

package/dist/forms/form-components/radio-group-form-component/RadioGroupFormComponent.d.ts

@@ -0,0 +1,2 @@
+import { RadioGroupProps } from './RadioGroupFormComponent.types';
+export declare const RadioGroupFormComponent: (props: RadioGroupProps) => JSX.Element;

package/dist/forms/form-components/radio-group-form-component/RadioGroupFormComponent.types.d.ts

@@ -0,0 +1,15 @@
+import { FormComponentProps } from '../FormComponent.types';
+/**
+ * Properties for RadioGroupFormComponent.
+ */
+export interface RadioGroupProps extends FormComponentProps {
+    readonly options: RadioButtonProps[];
+    readonly inline: boolean;
+}
+export interface RadioButtonProps {
+    readonly value: string;
+    readonly label: string;
+    readonly caption?: string;
+    readonly disabled?: boolean;
+    readonly alert?: boolean;
+}

package/dist/forms/form-components/rich-text-editor-form-component/RichTextEditorFormComponent.d.ts

@@ -0,0 +1,5 @@
+import { RichTextEditorFormComponentProps } from './RichTextEditorFormComponentProps.types';
+/**
+ * Form component capable of selecting assets from AssetsSelector component.
+ */
+export declare const RichTextEditorFormComponent: ({ label, placeholder, tooltipTextOnDisabled, configuration, value, onChange, invalid, validationMessage, readOnly, required, disabledMessage, tooltip, explanationText, guid, ...props }: RichTextEditorFormComponentProps) => JSX.Element;

package/dist/forms/form-components/rich-text-editor-form-component/RichTextEditorFormComponentProps.types.d.ts

@@ -0,0 +1,6 @@
+import { FormComponentProps } from '../FormComponent.types';
+export interface RichTextEditorFormComponentProps extends FormComponentProps {
+    readonly placeholder?: string;
+    readonly tooltipTextOnDisabled?: string;
+    readonly configuration?: string;
+}

package/dist/forms/form-components/rich-text-editor-form-component/hooks/useAssetPanel.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { AssetLibrary } from '../../../../shared-components/Assets/types/Assets.types';
+import { AssetPanelRef } from '../../../../shared-components/Assets/AssetPanel/AssetPanel.types';
+import { FieldInfo } from '../../../../forms';
+export declare const useAssetPanel: (fieldInfo: FieldInfo) => {
+    onLibrariesLoad: (libraries: AssetLibrary[]) => void;
+    assetPanelEnabled: boolean;
+    imageExtensions: string;
+    assetPanelRef: React.RefObject<AssetPanelRef>;
+};

package/dist/forms/form-components/rich-text-editor-form-component/hooks/useAssetPanel.types.d.ts

@@ -0,0 +1,10 @@
+export interface GetAssetPluginButtonStatusResult {
+    /**
+     * Indicates whether asset plugin button should be enabled.
+     */
+    readonly enabled: boolean;
+    /**
+     * List of allowed image extensions.
+     */
+    readonly imageExtensions: string;
+}

package/dist/forms/form-components/rich-text-editor-form-component/plugins/asset/AssetRichTextEditorPlugin.d.ts

@@ -0,0 +1,2 @@
+import { AssetRichTextEditorPluginProps } from './AssetRichTextEditorPlugin.types';
+export declare const AssetRichTextEditorPlugin: ({ editorRef, editorConfigurator }: AssetRichTextEditorPluginProps) => JSX.Element;

package/dist/forms/form-components/rich-text-editor-form-component/plugins/asset/AssetRichTextEditorPlugin.types.d.ts

@@ -0,0 +1,3 @@
+import { RichTextEditorPluginProps } from '@kentico/xperience-admin-components';
+export interface AssetRichTextEditorPluginProps extends RichTextEditorPluginProps {
+}

package/dist/forms/form-components/rich-text-editor-form-component/plugins/asset/index.d.ts

@@ -0,0 +1,2 @@
+export * from './AssetRichTextEditorPlugin';
+export * from './AssetRichTextEditorPlugin.types';

package/dist/forms/form-components/rich-text-editor-form-component/plugins/index.d.ts

@@ -0,0 +1 @@
+export * from './asset';

package/dist/forms/form-components/text-input-form-component/TextInputFormComponent.d.ts

@@ -0,0 +1,2 @@
+import { TextInputFormComponentProps } from './TextInputFormComponentProps.types';
+export declare const TextInputFormComponent: (props: TextInputFormComponentProps) => JSX.Element;

package/dist/forms/form-components/text-input-form-component/TextInputFormComponentProps.types.d.ts

@@ -0,0 +1,4 @@
+import { FormComponentProps } from '../FormComponent.types';
+export interface TextInputFormComponentProps extends FormComponentProps {
+    readonly watermarkText?: string;
+}

package/dist/forms/form-components/text-with-label-form-component/TextWithLabelFormComponent.d.ts

@@ -0,0 +1,2 @@
+import { FormComponentProps } from '../FormComponent.types';
+export declare const TextWithLabelFormComponent: (props: FormComponentProps) => JSX.Element;

package/dist/forms/form-components/textarea-form-component/TextAreaFormComponent.d.ts

@@ -0,0 +1,2 @@
+import { TextAreaFormComponentProps } from './TextAreaFormComponent.types';
+export declare const TextAreaFormComponent: (props: TextAreaFormComponentProps) => JSX.Element;

package/dist/forms/form-components/textarea-form-component/TextAreaFormComponent.types.d.ts

@@ -0,0 +1,5 @@
+import { FormComponentProps } from '../FormComponent.types';
+export interface TextAreaFormComponentProps extends FormComponentProps {
+    readonly copyButtonVisible?: boolean;
+    readonly watermarkText?: string;
+}

package/dist/forms/form-components/validation-rule-list-form-component/ValidationRuleListFormComponent.d.ts

@@ -0,0 +1,7 @@
+import { ValidationRuleListFormComponentProps } from './ValidationRuleListFormComponentProps.types';
+/**
+ * Form component to display and edit validation rules of field in field editor.
+ * The component is meant to be used with the field editor so it correctly displays rules
+ * based on the selected component in the editor.
+ */
+export declare const ValidationRuleListFormComponent: ({ onChange, ruleDefinitions, ...props }: ValidationRuleListFormComponentProps) => JSX.Element;

package/dist/forms/form-components/validation-rule-list-form-component/ValidationRuleListFormComponentProps.types.d.ts

@@ -0,0 +1,43 @@
+import { FormComponentProps } from '../FormComponent.types';
+/**
+ * Form component properties for ValidationRulesFormComponent
+ */
+export interface ValidationRuleListFormComponentProps extends FormComponentProps {
+    readonly ruleDefinitions: ValidationRuleDefinition[];
+    readonly rulesDescriptions: Record<string, string>;
+}
+/**
+ * Validation rule metadata.
+ */
+export interface ValidationRuleDefinition {
+    readonly identifier: string;
+    readonly name: string;
+    readonly description: string;
+    readonly componentsProperties: FormComponentProps[];
+}
+/**
+ * Carries values of configured validation rules.
+ */
+export interface ValidationConfiguration {
+    readonly identifier: string;
+    readonly validationRuleIdentifier: string;
+    readonly ruleValues: Record<string, any>;
+}
+/**
+ * Arguments for the CreateValidationRule page command.
+ */
+export interface CreateValidationRuleArgs {
+    identifier: string;
+    formData: {
+        [fieldName: string]: any;
+    };
+}
+/**
+ * Result of the CreateValidationRule page command.
+ */
+export interface CreateValidationRuleResult {
+    rule: ValidationConfiguration;
+    description: string;
+    isValid: boolean;
+    componentsProperties: FormComponentProps[];
+}

package/dist/forms/hooks/FormComponentCommand.types.d.ts

@@ -0,0 +1,7 @@
+export interface FormComponentCommandModel {
+    formName: string;
+    fieldValues: Record<string, any>;
+    fieldName: string;
+    commandName: string;
+    commandData?: string;
+}

package/dist/forms/hooks/FormComponentCommandUtils.d.ts

@@ -0,0 +1,4 @@
+import { FieldInfo } from '../form-components/FormComponent.types';
+import { FormComponentCommandModel } from './FormComponentCommand.types';
+export declare const componentCommandName = "ComponentCommand";
+export declare const prepareFormComponentCommandPayload: <TData = unknown>(formName: string, fieldInfo: FieldInfo, commandName: string, data?: TData | undefined) => FormComponentCommandModel;

package/dist/forms/hooks/index.d.ts

@@ -0,0 +1,4 @@
+export * from './useFormComponentCommand';
+export * from './useFormComponentCommandProvider';
+export * from './useValidationRule';
+export * from './useDisplayDialogInFullscreen';

package/dist/forms/hooks/useDisplayDialogInFullscreen.d.ts

@@ -0,0 +1 @@
+export declare const useDisplayDialogInFullscreen: (screenWidthBreakpoint?: number | undefined, screenHeightBreakpoint?: number | undefined) => boolean;

package/dist/forms/hooks/useFormComponentCommand.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { Command, UseCommandConfig } from '../../commands';
+import { FieldInfo } from '../form-components/FormComponent.types';
+export declare const useFormComponentCommand: <TCommandResult, TCommandData = void>(fieldInfo: FieldInfo, commandName: string, config?: UseCommandConfig<TCommandResult, TCommandData> | undefined, dependencies?: React.DependencyList | undefined) => Command<TCommandData>;

package/dist/forms/hooks/useFormComponentCommandProvider.d.ts

@@ -0,0 +1,4 @@
+import { FieldInfo } from '../form-components';
+export declare const useFormComponentCommandProvider: () => {
+    executeCommand: <TCommandResult = void, TData = void>(fieldInfo: FieldInfo, name: string, data?: TData | undefined, files?: FileList | undefined) => Promise<TCommandResult | undefined>;
+};