@keycloak/keycloak-ui-shared 25.0.6 → 26.0.0

package/dist/alerts/AlertPanel.d.ts

@@ -0,0 +1,6 @@
+import { AlertEntry } from './Alerts';
+export type AlertPanelProps = {
+    alerts: AlertEntry[];
+    onCloseAlert: (id: number) => void;
+};
+export declare function AlertPanel({ alerts, onCloseAlert }: AlertPanelProps): import("react/jsx-runtime").JSX.Element;

package/dist/alerts/Alerts.d.ts

@@ -1,15 +1,13 @@
 import { AlertVariant } from '@patternfly/react-core';
 import { PropsWithChildren } from 'react';
-
 export type AddAlertFunction = (message: string, variant?: AlertVariant, description?: string) => void;
-export type AddErrorFunction = (message: string) => void;
+export type AddErrorFunction = (messageKey: string, error: unknown) => void;
 export type AlertProps = {
     addAlert: AddAlertFunction;
     addError: AddErrorFunction;
 };
-export declare const AlertContext: import('react').Context<AlertProps | undefined>;
 export declare const useAlerts: () => AlertProps;
-export type AlertType = {
+export type AlertEntry = {
     id: number;
     message: string;
     variant: AlertVariant;

package/dist/buttons/FormSubmitButton.d.ts

@@ -1,7 +1,6 @@
 import { ButtonProps } from '@patternfly/react-core';
 import { PropsWithChildren } from 'react';
 import { FieldValues, FormState } from 'react-hook-form';
-
 export type FormSubmitButtonProps = Omit<ButtonProps, "isDisabled"> & {
     formState: FormState<FieldValues>;
     allowNonDirty?: boolean;

package/dist/context/HelpContext.d.ts

@@ -1,5 +1,4 @@
 import { PropsWithChildren } from 'react';
-
 type HelpContextProps = {
     enabled: boolean;
     toggleHelp: () => void;

package/dist/context/KeycloakContext.d.ts

@@ -1,7 +1,6 @@
 import { default as Keycloak } from 'keycloak-js';
 import { PropsWithChildren } from 'react';
 import { BaseEnvironment } from './environment';
-
 export type KeycloakContext<T extends BaseEnvironment = BaseEnvironment> = KeycloakContextProps<T> & {
     keycloak: Keycloak;
 };

package/dist/continue-cancel/ContinueCancelModal.d.ts

@@ -1,6 +1,5 @@
 import { ReactNode } from 'react';
 import { ButtonProps, ModalProps } from '@patternfly/react-core';
-
 export type ContinueCancelModalProps = Omit<ModalProps, "ref" | "children"> & {
     modalTitle: string;
     continueLabel: string;

package/dist/controls/FormErrorText.d.ts

@@ -1,5 +1,4 @@
 import { FormHelperTextProps } from '@patternfly/react-core';
-
 export type FormErrorTextProps = FormHelperTextProps & {
     message: string;
 };

package/dist/controls/FormLabel.d.ts

@@ -1,7 +1,6 @@
 import { FormGroupProps } from '@patternfly/react-core';
 import { PropsWithChildren, ReactNode } from 'react';
 import { FieldError, FieldValues, Merge } from 'react-hook-form';
-
 export type FieldProps<T extends FieldValues = FieldValues> = {
     label?: string;
     name: string;

package/dist/controls/HelpItem.d.ts

@@ -1,5 +1,4 @@
 import { ReactNode } from 'react';
-
 type HelpItemProps = {
     helpText: string | ReactNode;
     fieldLabelId: string;

package/dist/controls/KeycloakSpinner.d.ts

@@ -0,0 +1 @@
+export declare const KeycloakSpinner: () => import("react/jsx-runtime").JSX.Element;

package/dist/controls/NumberControl.d.ts

@@ -1,6 +1,5 @@
 import { NumberInputProps } from '@patternfly/react-core';
 import { ControllerProps, FieldPath, FieldValues, UseControllerProps } from 'react-hook-form';
-
 export type NumberControlOption = {
     key: string;
     value: string;

package/dist/controls/OrganizationTable.d.ts

@@ -0,0 +1,16 @@
+import { default as OrganizationRepresentation } from '@keycloak/keycloak-admin-client/lib/defs/organizationRepresentation';
+import { FunctionComponent, PropsWithChildren, ReactNode } from 'react';
+import { LoaderFunction } from './table/KeycloakDataTable';
+type OrganizationTableProps = PropsWithChildren & {
+    loader: LoaderFunction<OrganizationRepresentation> | OrganizationRepresentation[];
+    link: FunctionComponent<PropsWithChildren<{
+        organization: OrganizationRepresentation;
+    }>>;
+    toolbarItem?: ReactNode;
+    isPaginated?: boolean;
+    onSelect?: (orgs: OrganizationRepresentation[]) => void;
+    onDelete?: (org: OrganizationRepresentation) => void;
+    deleteLabel?: string;
+};
+export declare const OrganizationTable: ({ loader, toolbarItem, isPaginated, onSelect, onDelete, deleteLabel, link, children, }: OrganizationTableProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/controls/PasswordControl.d.ts

@@ -1,6 +1,5 @@
 import { FieldPath, FieldValues, UseControllerProps } from 'react-hook-form';
 import { PasswordInputProps } from './PasswordInput';
-
 export type PasswordControlProps<T extends FieldValues, P extends FieldPath<T> = FieldPath<T>> = UseControllerProps<T, P> & Omit<PasswordInputProps, "name" | "isRequired" | "required"> & {
     label: string;
     labelIcon?: string;

package/dist/controls/PasswordInput.d.ts

@@ -1,8 +1,7 @@
 import { TextInputProps } from '@patternfly/react-core';
-
 export type PasswordInputProps = TextInputProps & {
     hasReveal?: boolean;
 };
 export declare const PasswordInput: import('react').ForwardRefExoticComponent<TextInputProps & {
-    hasReveal?: boolean | undefined;
+    hasReveal?: boolean;
 } & import('react').RefAttributes<HTMLInputElement>>;

package/dist/controls/SwitchControl.d.ts

@@ -1,6 +1,5 @@
 import { FieldValues, FieldPath, UseControllerProps } from 'react-hook-form';
 import { SwitchProps } from '@patternfly/react-core';
-
 export type SwitchControlProps<T extends FieldValues, P extends FieldPath<T> = FieldPath<T>> = Omit<SwitchProps, "name" | "defaultValue" | "ref"> & UseControllerProps<T, P> & {
     name: string;
     label?: string;

package/dist/controls/TextAreaControl.d.ts

@@ -1,6 +1,5 @@
 import { TextAreaProps } from '@patternfly/react-core';
 import { FieldPath, FieldValues, UseControllerProps } from 'react-hook-form';
-
 export type TextAreaControlProps<T extends FieldValues, P extends FieldPath<T> = FieldPath<T>> = UseControllerProps<T, P> & TextAreaProps & {
     label: string;
     labelIcon?: string;

package/dist/controls/TextControl.d.ts

@@ -1,7 +1,6 @@
 import { TextInputProps } from '@patternfly/react-core';
 import { ReactNode } from 'react';
 import { FieldPath, FieldValues, UseControllerProps } from 'react-hook-form';
-
 export type TextControlProps<T extends FieldValues, P extends FieldPath<T> = FieldPath<T>> = UseControllerProps<T, P> & Omit<TextInputProps, "name" | "isRequired" | "required"> & {
     label: string;
     labelIcon?: string | ReactNode;

package/dist/controls/keycloak-text-area/KeycloakTextArea.d.ts

@@ -1,5 +1,4 @@
 import { TextArea } from '@patternfly/react-core';
 import { ComponentProps, HTMLProps, ForwardRefExoticComponent, RefAttributes } from 'react';
-
 export type KeycloakTextAreaProps = Omit<ComponentProps<typeof TextArea>, "onFocus" | "onBlur"> & Pick<HTMLProps<HTMLTextAreaElement>, "onFocus" | "onBlur">;
-export declare const KeycloakTextArea: ForwardRefExoticComponent<Omit<import('@patternfly/react-core').TextAreaProps & RefAttributes<HTMLTextAreaElement>, "onFocus" | "onBlur"> & Pick<HTMLProps<HTMLTextAreaElement>, "onFocus" | "onBlur"> & RefAttributes<HTMLTextAreaElement>>;
+export declare const KeycloakTextArea: ForwardRefExoticComponent<KeycloakTextAreaProps & RefAttributes<HTMLTextAreaElement>>;

package/dist/controls/select-control/SelectControl.d.ts

@@ -1,6 +1,5 @@
 import { ChipGroupProps, SelectProps } from '@patternfly/react-core';
 import { ControllerProps, FieldPath, FieldValues, UseControllerProps } from 'react-hook-form';
-
 type Variant = `${SelectVariant}`;
 export declare enum SelectVariant {
     single = "single",

package/dist/controls/select-control/SingleSelectControl.d.ts

@@ -1,4 +1,3 @@
 import { FieldPath, FieldValues } from 'react-hook-form';
 import { SelectControlProps } from './SelectControl';
-
 export declare const SingleSelectControl: <T extends FieldValues, P extends FieldPath<T> = FieldPath<T>>({ id, name, label, options, controller, labelIcon, ...rest }: SelectControlProps<T, P>) => import("react/jsx-runtime").JSX.Element;

package/dist/controls/select-control/TypeaheadSelectControl.d.ts

@@ -1,4 +1,3 @@
 import { FieldPath, FieldValues } from 'react-hook-form';
 import { SelectControlProps } from './SelectControl';
-
 export declare const TypeaheadSelectControl: <T extends FieldValues, P extends FieldPath<T> = FieldPath<T>>({ id, name, label, options, controller, labelIcon, placeholderText, onFilter, variant, ...rest }: SelectControlProps<T, P>) => import("react/jsx-runtime").JSX.Element;

package/dist/controls/table/KeycloakDataTable.d.ts

@@ -0,0 +1,64 @@
+import { SVGIconProps } from '@patternfly/react-icons/dist/js/createIcon';
+import { IAction, IActionsResolver, IFormatter, ITransform, TableProps } from '@patternfly/react-table';
+import { ComponentClass, ReactNode, JSX } from 'react';
+export type Field<T> = {
+    name: string;
+    displayKey?: string;
+    cellFormatters?: IFormatter[];
+    transforms?: ITransform[];
+    cellRenderer?: (row: T) => JSX.Element | string;
+};
+export type DetailField<T> = {
+    name: string;
+    enabled?: (row: T) => boolean;
+    cellRenderer?: (row: T) => JSX.Element | string;
+};
+export type Action<T> = IAction & {
+    onRowClick?: (row: T) => Promise<boolean | void> | void;
+};
+export type LoaderFunction<T> = (first?: number, max?: number, search?: string) => Promise<T[]>;
+export type DataListProps<T> = Omit<TableProps, "rows" | "cells" | "onSelect"> & {
+    loader: T[] | LoaderFunction<T>;
+    onSelect?: (value: T[]) => void;
+    canSelectAll?: boolean;
+    detailColumns?: DetailField<T>[];
+    isRowDisabled?: (value: T) => boolean;
+    isPaginated?: boolean;
+    ariaLabelKey: string;
+    searchPlaceholderKey?: string;
+    columns: Field<T>[];
+    actions?: Action<T>[];
+    actionResolver?: IActionsResolver;
+    searchTypeComponent?: ReactNode;
+    toolbarItem?: ReactNode;
+    subToolbar?: ReactNode;
+    emptyState?: ReactNode;
+    icon?: ComponentClass<SVGIconProps>;
+    isNotCompact?: boolean;
+    isRadio?: boolean;
+    isSearching?: boolean;
+};
+/**
+ * A generic component that can be used to show the initial list most sections have. Takes care of the loading of the date and filtering.
+ * All you have to define is how the columns are displayed.
+ * @example
+ *   <KeycloakDataTable columns={[
+ *     {
+ *        name: "clientId", //name of the field from the array of object the loader returns to display in this column
+ *        displayKey: "clientId", //i18n key to use to lookup the name of the column header
+ *        cellRenderer: ClientDetailLink, //optionally you can use a component to render the column when you don't want just the content of the field, the whole row / entire object is passed in.
+ *     }
+ *   ]}
+ * @param {DataListProps} props - The properties.
+ * @param {string} props.ariaLabelKey - The aria label key i18n key to lookup the label
+ * @param {string} props.searchPlaceholderKey - The i18n key to lookup the placeholder for the search box
+ * @param {boolean} props.isPaginated - if true the the loader will be called with first, max and search and a pager will be added in the header
+ * @param {(first?: number, max?: number, search?: string) => Promise<T[]>} props.loader - loader function that will fetch the data to display first, max and search are only applicable when isPaginated = true
+ * @param {Field<T>} props.columns - definition of the columns
+ * @param {Field<T>} props.detailColumns - definition of the columns expandable columns
+ * @param {Action[]} props.actions - the actions that appear on the row
+ * @param {IActionsResolver} props.actionResolver Resolver for the given action
+ * @param {ReactNode} props.toolbarItem - Toolbar items that appear on the top of the table {@link toolbarItem}
+ * @param {ReactNode} props.emptyState - ReactNode show when the list is empty could be any component but best to use {@link ListEmptyState}
+ */
+export declare function KeycloakDataTable<T>({ ariaLabelKey, searchPlaceholderKey, isPaginated, onSelect, canSelectAll, isNotCompact, isRadio, detailColumns, isRowDisabled, loader, columns, actions, actionResolver, searchTypeComponent, toolbarItem, subToolbar, emptyState, icon, isSearching, ...props }: DataListProps<T>): import("react/jsx-runtime").JSX.Element;

package/dist/controls/table/ListEmptyState.d.ts

@@ -0,0 +1,20 @@
+import { ComponentClass, MouseEventHandler, ReactNode } from 'react';
+import { ButtonVariant } from '@patternfly/react-core';
+import { SVGIconProps } from '@patternfly/react-icons/dist/js/createIcon';
+export type Action = {
+    text: string;
+    type?: ButtonVariant;
+    onClick: MouseEventHandler<HTMLButtonElement>;
+};
+export type ListEmptyStateProps = {
+    message: string;
+    instructions: ReactNode;
+    primaryActionText?: string;
+    onPrimaryAction?: MouseEventHandler<HTMLButtonElement>;
+    hasIcon?: boolean;
+    icon?: ComponentClass<SVGIconProps>;
+    isSearchVariant?: boolean;
+    secondaryActions?: Action[];
+    isDisabled?: boolean;
+};
+export declare const ListEmptyState: ({ message, instructions, onPrimaryAction, hasIcon, isSearchVariant, primaryActionText, secondaryActions, icon, isDisabled, }: ListEmptyStateProps) => import("react/jsx-runtime").JSX.Element;

package/dist/controls/table/PaginatingTableToolbar.d.ts

@@ -0,0 +1,21 @@
+import { PropsWithChildren, ReactNode } from 'react';
+type KeycloakPaginationProps = {
+    id?: string;
+    count: number;
+    first: number;
+    max: number;
+    onNextClick: (page: number) => void;
+    onPreviousClick: (page: number) => void;
+    onPerPageSelect: (max: number, first: number) => void;
+    variant?: "top" | "bottom";
+};
+type TableToolbarProps = KeycloakPaginationProps & {
+    searchTypeComponent?: ReactNode;
+    toolbarItem?: ReactNode;
+    subToolbar?: ReactNode;
+    inputGroupName?: string;
+    inputGroupPlaceholder?: string;
+    inputGroupOnEnter?: (value: string) => void;
+};
+export declare const PaginatingTableToolbar: ({ count, searchTypeComponent, toolbarItem, subToolbar, children, inputGroupName, inputGroupPlaceholder, inputGroupOnEnter, ...rest }: PropsWithChildren<TableToolbarProps>) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/controls/table/TableToolbar.d.ts

@@ -0,0 +1,12 @@
+import { PropsWithChildren, ReactNode } from 'react';
+type TableToolbarProps = {
+    toolbarItem?: ReactNode;
+    subToolbar?: ReactNode;
+    toolbarItemFooter?: ReactNode;
+    searchTypeComponent?: ReactNode;
+    inputGroupName?: string;
+    inputGroupPlaceholder?: string;
+    inputGroupOnEnter?: (value: string) => void;
+};
+export declare const TableToolbar: ({ toolbarItem, subToolbar, toolbarItemFooter, children, searchTypeComponent, inputGroupName, inputGroupPlaceholder, inputGroupOnEnter, }: PropsWithChildren<TableToolbarProps>) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/keycloak-ui-shared.d.ts

@@ -1 +1,2 @@
 export * from './main'
+export {}