@kentico/xperience-admin-base 14.0.0-109224

package/dist/commands/CommandContext.d.ts

@@ -0,0 +1,27 @@
+import React from 'react';
+/**
+ * Instance of command context type.
+ */
+export declare const CommandContext: React.Context<CommandContextType>;
+/**
+ * Defines a command context type.
+ */
+export 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;
+}
+/**
+ * Returns the command provider for the current page.
+ */
+export declare const usePageCommandProvider: () => CommandContextType;

package/dist/commands/CommandProvider.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+interface CommandProviderProps {
+    readonly children: React.ReactNode;
+}
+/**
+ * Ensures the command context for current template.
+ */
+export declare const CommandProvider: {
+    ({ children }: CommandProviderProps): JSX.Element;
+    displayName: string;
+};
+export {};

package/dist/commands/index.d.ts

@@ -0,0 +1,3 @@
+export { usePageCommand } from './usePageCommand';
+export { usePageCommandProvider } from './CommandContext';
+export type { Command, CommandExecutor, UseCommandConfig } from './useCommand.types';

package/dist/commands/useCommand.types.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Command result interface.
+ */
+export interface Command<T = any> {
+    /**
+     * Invocation callback.
+     */
+    execute: CommandExecutor<T, void>;
+}
+/**
+ * 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;
+};
+/**
+ * Command invocation callback.
+ */
+export declare type CommandExecutor<TData, TResponse> = (data?: TData, files?: FileList) => Promise<TResponse>;

package/dist/commands/useCommandInvoker.d.ts

@@ -0,0 +1,11 @@
+interface CommandInvokerResponse<T> {
+    result: T;
+    command: string;
+}
+/**
+ * Defines a command invocation function with messaging and navigation support.
+ *
+ * @returns Command invocation function.
+ */
+export declare function useCommandInvoker<T>(): (name: string, data?: any, files?: FileList | undefined) => Promise<CommandInvokerResponse<T> | undefined>;
+export {};

package/dist/commands/usePageCommand.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import { Command, UseCommandConfig } from './useCommand.types';
+/**
+ * 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.DependencyList): Command<TCommandData>;

package/dist/components/ActionList/ActionList.d.ts

@@ -0,0 +1,2 @@
+import { ActionListProps } from './ActionList.types';
+export declare const ActionList: ({ actions, dataTestId }: ActionListProps) => JSX.Element;

package/dist/components/ActionList/ActionList.types.d.ts

@@ -0,0 +1,5 @@
+import { UITestProps } from '@kentico/xperience-admin-components';
+import { Action } from '../../types';
+export interface ActionListProps extends UITestProps {
+    actions?: Action[];
+}

package/dist/components/ErrorBoundary/ErrorBoundary.d.ts

@@ -0,0 +1,15 @@
+import React, { Component, ErrorInfo } from 'react';
+import { ErrorBoundaryProps, ErrorBoundaryState } from './ErrorBoundary.types';
+/**
+ * ErrorBoundary component allows to catch the unhandled errors and display a fallback component.
+ */
+export declare class ErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> {
+    state: ErrorBoundaryState;
+    static getDerivedStateFromError(error: Error): ErrorBoundaryState;
+    componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
+    /**
+     * Ensures that previous error state is cleared on dependencies change.
+     */
+    componentDidUpdate(previousProps: ErrorBoundaryProps, previousState: ErrorBoundaryState): void;
+    render(): React.ReactNode;
+}

package/dist/components/ErrorBoundary/ErrorBoundary.types.d.ts

@@ -0,0 +1,32 @@
+import { ReactNode } from 'react';
+/**
+ * Error boundary component properties.
+ */
+export interface ErrorBoundaryProps {
+    /**
+     * Component children.
+     */
+    readonly children: ReactNode;
+    /**
+     * Fallback function allows to render custom error elements.
+     */
+    readonly fallback: (error: Error | null) => ReactNode;
+    /**
+     * Error boundary dependencies.
+     * Used for re-evaluation of error state based on array of dependencies.
+     */
+    readonly dependencies?: unknown[];
+}
+/**
+ * Error boundary inner state.
+ */
+export interface ErrorBoundaryState {
+    /**
+     * Indicates whether error has occurred.
+     */
+    readonly hasError: boolean;
+    /**
+     * Error object.
+     */
+    readonly error: Error | null;
+}

package/dist/components/ViewMenuItem/ViewMenuItem.d.ts

@@ -0,0 +1,5 @@
+import { ViewMenuItemProps } from './ViewMenuItem.types';
+/**
+ * View menu item component. Automatically handles whether is active by comparing current location with provided path.
+ */
+export declare const ViewMenuItem: (props: ViewMenuItemProps) => JSX.Element;

package/dist/components/ViewMenuItem/ViewMenuItem.types.d.ts

@@ -0,0 +1,16 @@
+import { MouseEvent } from 'react';
+import { ApplicationTileProps } from '@kentico/xperience-admin-components';
+export interface ViewMenuItemProps extends Pick<ApplicationTileProps, 'label' | 'iconName' | 'tooltip' | 'dataTestId'> {
+    /**
+     * Indicates if the menu item is disabled.
+     */
+    disabled: boolean;
+    /**
+     * Path to navigate to.
+     */
+    path: string;
+    /**
+     * Allows consumer to bind an extra `onClick` event handler raised before the navigation.
+     */
+    readonly onClick?: (event: MouseEvent<HTMLElement>) => void;
+}

package/dist/components/index.d.ts

@@ -0,0 +1,6 @@
+export { ActionList } from './ActionList/ActionList';
+export { Loader } from './loader/Loader';
+export { PageLoader } from './page-loader/PageLoader';
+export { PageMessagePane } from './page-message-pane/PageMessagePane';
+export { Portal } from './portal/Portal';
+export { ViewMenuItem } from './ViewMenuItem/ViewMenuItem';

package/dist/components/loader/Loader.d.ts

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

package/dist/components/page-loader/PageLoader.d.ts

@@ -0,0 +1,5 @@
+interface PageLoaderProps {
+    titleVisible?: boolean;
+}
+export declare const PageLoader: ({ titleVisible }: PageLoaderProps) => JSX.Element;
+export {};

package/dist/components/page-message-pane/PageMessagePane.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+export interface PageMessagePaneProps {
+    readonly title: string;
+    readonly text?: string;
+    readonly children?: React.ReactNode;
+}
+export declare const PageMessagePane: ({ title, text, children }: PageMessagePaneProps) => JSX.Element;

package/dist/components/portal/Portal.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+interface PortalProps {
+    readonly children: React.ReactNode;
+    readonly container: HTMLElement | null;
+    readonly key?: string | null | undefined;
+}
+declare const Portal: ({ children, container, key }: PortalProps) => JSX.Element;
+export { Portal };

package/dist/entry.d.ts

@@ -0,0 +1,15 @@
+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/loader/Loader';
+export * from './components/portal/Portal';
+export * from './components/ViewMenuItem/ViewMenuItem';
+export * from './components/page-message-pane/PageMessagePane';
+export * from './commands';
+export * from './shared-components';
+export * from './notifications';
+export * from './providers';