@kentico/xperience-admin-base 14.0.0-51372 → 22.0.0

package/dist/entry.d.ts

@@ -1,10 +1,177 @@
-export * from './templates';
-export * from './template-components';
-export * from './forms';
-export * from './hooks';
-export * from './utils';
-export * from './template-properties';
-export * from './localization';
-export * from './components/portal/Portal';
-export * from './components/page-message-pane/PageMessagePane';
-export * from './commands';
+/// <reference types="react" />
+
+import { default as React_2 } from 'react';
+
+/**
+ * Command result interface.
+ */
+export declare interface Command<T = any> {
+    /**
+     * Invocation callback.
+     */
+    execute: CommandExecutor<T, void>;
+}
+
+/**
+ * Defines a command context type.
+ */
+declare interface CommandContextType {
+    /**
+     * Executes page command.
+     * @param name Name of the command to be executed.
+     * @param data Data passed to the command.
+     * @param files Files to be uploaded by the command.
+     */
+    executeCommand: <TCommandResult = void, TData = void>(name: string, data?: TData, files?: FileList) => Promise<TCommandResult | undefined>;
+    /**
+     * Registers command into the current provider.
+     * @param name Name of the command to be registered.
+     * @param execute Callback that executes the command.
+     */
+    registerCommand: <T>(name: string, execute: (data: T, files?: FileList) => Promise<void>) => void;
+}
+
+/**
+ * Command invocation callback.
+ */
+export declare type CommandExecutor<TData, TResponse> = (data?: TData, files?: FileList) => Promise<TResponse>;
+
+/**
+ * Represents information about form field.
+ */
+export declare interface FieldInfo {
+    readonly name: string;
+    readonly fieldValues: FieldInfoValueType;
+}
+
+/**
+ * Collection of field values.
+ */
+export declare type FieldInfoValueType = Record<string, any>;
+
+/**
+ * Represents basic set of form component properties.
+ */
+export declare interface FormComponentProps extends FieldInfo {
+    readonly componentName: string;
+    readonly hasDependencies: boolean;
+    readonly label?: string;
+    readonly statusText?: string;
+    readonly explanationText?: string;
+    readonly tooltip?: string;
+    readonly disabled?: boolean;
+    readonly value?: any;
+    readonly invalid?: boolean;
+    readonly validationMessage?: string;
+    readonly validationRules?: ValidationRuleProps[];
+    readonly onChange?: (value: OnChangeValueType) => void;
+    readonly required?: boolean;
+    readonly inactiveMessage?: string;
+    readonly guid: string;
+    /**
+     * Dangerously sets tooltip as inner HTML.
+     */
+    readonly tooltipAsHtml?: boolean;
+    /**
+     * Dangerously sets explanation as inner HTML.
+     */
+    readonly explanationTextAsHtml?: boolean;
+}
+
+/**
+ * Untyped alias for value used on change.
+ */
+declare type OnChangeValueType = any;
+
+export declare const RoutingContentPlaceholder: ({ children }: RoutingContentPlaceholderProps) => JSX.Element;
+
+/**
+ * Represents properties for RoutingContentPlaceholder component.
+ */
+export declare interface RoutingContentPlaceholderProps {
+    children?: React_2.ReactNode;
+}
+
+/**
+ * Command execution configuration.
+ */
+export declare type UseCommandConfig<TCommandResult, TCommandData> = {
+    /**
+     * Command data.
+     */
+    data?: TCommandData;
+    /**
+     * Indicates whether command should be invoked automatically on component mount.
+     * Defaults to `false`.
+     */
+    executeOnMount?: boolean;
+    /**
+     * Custom action executed before the command execution.
+     * If the function returns `false` the command will not be executed.
+     */
+    before?: () => boolean | void;
+    /**
+     * Custom action executed after the command execution.
+     */
+    after?: (commandResult: TCommandResult | undefined) => void;
+};
+
+/**
+ * Registers command into the current command provider and returns its invocation callback.
+ *
+ * @param fieldInfo Related form field info
+ * @param commandName Name of the command.
+ * @param config Command options.
+ * @param dependencies If present, command will only activate if the values in the list change.
+ * @returns Invocation callback to be executed manually.
+ */
+export declare const useFormComponentCommand: <TCommandResult, TCommandData = void>(fieldInfo: FieldInfo, commandName: string, config?: UseCommandConfig<TCommandResult, TCommandData> | undefined, dependencies?: React_2.DependencyList) => Command<TCommandData>;
+
+/**
+ * Returns the form command provider for the current page.
+ */
+export declare const useFormComponentCommandProvider: () => {
+    executeCommand: <TCommandResult = void, TData = void>(fieldInfo: FieldInfo, name: string, data?: TData | undefined, files?: FileList) => Promise<TCommandResult | undefined>;
+};
+
+/**
+ * Registers command into the current command provider and returns its invocation callback.
+ *
+ * @param commandName Name of the command.
+ * @param config Command options.
+ * @param dependencies If present, command will only activate if the values in the list change.
+ * @returns Invocation callback to be executed manually.
+ */
+export declare function usePageCommand<TCommandResult, TCommandData = void>(commandName: string, config?: UseCommandConfig<TCommandResult, TCommandData>, dependencies?: React_2.DependencyList): Command<TCommandData>;
+
+/**
+ * Returns the command provider for the current page.
+ */
+export declare const usePageCommandProvider: () => CommandContextType;
+
+/**
+ * Validation rule result type.
+ */
+export declare interface ValidationResult {
+    readonly isValid: boolean;
+    readonly errorMessage: string | null;
+    hasChanged?: boolean;
+}
+
+/**
+ * Base type used by validation rules.
+ */
+export declare interface ValidationRule<P extends ValidationRuleProps, T> {
+    (props: P, value: T, fieldValues: Record<string, any>): ValidationResult;
+}
+
+/**
+ * Represents basic set of validation rule properties.
+ */
+export declare interface ValidationRuleProps {
+    readonly ruleName: string;
+    readonly isValid: boolean;
+    readonly errorMessage: string | null;
+}
+
+export { }