@ansible/ansible-ui-framework 0.0.720 → 0.0.722

package/framework/PageActions/PageAction.d.ts

@@ -1,60 +1,93 @@
 import { ButtonVariant } from '@patternfly/react-core';
 import { ComponentClass } from 'react';
-import { PageActionType } from './PageActionType';
-export type IPageAction<T extends object> = IPageActionSeperator | IPageActionButton | IPageBulkAction<T> | IPageSingleAction<T> | IPageDropdownAction<T>;
-export interface IPageActionCommon {
+export declare const enum PageActionType {
+    Button = 0,
+    Link = 1,
+    Switch = 2,
+    Dropdown = 3,
+    Seperator = 4
+}
+export declare const enum PageActionSelection {
+    None = 0,
+    Single = 1,
+    Multiple = 2
+}
+export type IPageAction<T extends object> = IPageActionButton | IPageActionButtonSingle<T> | IPageActionButtonMultiple<T> | IPageActionLink | IPageActionLinkSingle<T> | IPageActionSwitch | IPageActionSwitchSingle<T> | IPageActionDropdown<T> | IPageActionDropdownSingle<T> | IPageActionDropdownMultiple<T> | IPageActionSeperator;
+interface IPageActionCommon {
     icon?: ComponentClass;
     label: string;
-    shortLabel?: string;
     tooltip?: string;
     isDanger?: boolean;
     ouiaId?: string;
+    isPinned?: boolean;
 }
-export interface IPageActionSeperator {
-    type: PageActionType.seperator;
+interface IPageActionNoneCommon extends IPageActionCommon {
+    selection?: PageActionSelection.None;
+    isHidden?: () => boolean;
+    isDisabled?: string | (() => string | undefined);
 }
-type IPageActionWithLink = IPageActionCommon & {
-    type: PageActionType.button;
-    variant?: ButtonVariant;
-    isDisabled?: string | undefined;
-    href: string;
-    onClick?: never;
-};
-type IPageActionWithOnClick = IPageActionCommon & {
-    type: PageActionType.button;
+interface IPageActionSingleCommon<T extends object> extends IPageActionCommon {
+    selection?: PageActionSelection.Single;
+    isHidden?: (item: T) => boolean;
+    isDisabled?: string | ((item: T) => string | undefined);
+}
+interface IPageActionMultipleCommon<T extends object> extends IPageActionCommon {
+    selection?: PageActionSelection.Multiple;
+    isDisabled?: string | ((items: T[]) => string | undefined);
+}
+export interface IPageActionButton extends IPageActionNoneCommon {
+    type: PageActionType.Button;
+    selection: PageActionSelection.None;
     variant?: ButtonVariant;
-    isDisabled?: string | undefined;
-    onClick: (() => void) | (() => Promise<unknown>);
-    href?: never;
-};
-export type IPageActionButton = IPageActionWithLink | IPageActionWithOnClick;
-export type IPageBulkAction<T extends object> = IPageActionCommon & {
-    type: PageActionType.bulk;
+    onClick: () => unknown | Promise<unknown>;
+}
+export interface IPageActionButtonSingle<T extends object> extends IPageActionSingleCommon<T> {
+    type: PageActionType.Button;
+    selection: PageActionSelection.Single;
     variant?: ButtonVariant;
-    onClick: (selectedItems: T[]) => void;
-};
-type IPageSingleActionWithLink<T extends object> = IPageActionCommon & {
-    type: PageActionType.singleLink;
+    onClick: (item: T) => unknown | Promise<unknown>;
+}
+export interface IPageActionButtonMultiple<T extends object> extends IPageActionMultipleCommon<T> {
+    type: PageActionType.Button;
+    selection: PageActionSelection.Multiple;
     variant?: ButtonVariant;
+    onClick: (items: T[]) => unknown | Promise<unknown>;
+}
+export interface IPageActionLink extends IPageActionNoneCommon {
+    type: PageActionType.Link;
+    href: string;
+}
+export interface IPageActionLinkSingle<T extends object> extends IPageActionSingleCommon<T> {
+    type: PageActionType.Link;
     href: (item: T) => string;
-    onClick?: never;
-    isDisabled?: (item: T) => string | undefined;
-    isHidden?: (item: T) => boolean;
-};
-type IPageSingleActionWithOnClick<T extends object> = IPageActionCommon & {
-    type: PageActionType.single;
-    variant?: ButtonVariant;
-    onClick: (item: T) => void | Promise<unknown>;
-    href?: never;
-    isDisabled?: (item: T) => string | undefined;
-    isHidden?: (item: T) => boolean;
-};
-export type IPageSingleAction<T extends object> = IPageSingleActionWithLink<T> | IPageSingleActionWithOnClick<T>;
-export type IPageDropdownAction<T extends object> = IPageActionCommon & {
-    type: PageActionType.dropdown;
-    variant?: ButtonVariant;
-    isHidden?: (item: T) => boolean;
-    isDisabled?: (item: T) => string;
-    options: IPageAction<T>[];
-};
+}
+export interface IPageActionSwitch extends IPageActionNoneCommon {
+    type: PageActionType.Switch;
+    onToggle: (enable: boolean) => unknown | Promise<unknown>;
+    isSwitchOn: () => boolean;
+    showPinnedLabel?: boolean;
+    labelOff?: string;
+}
+export interface IPageActionSwitchSingle<T extends object> extends IPageActionSingleCommon<T> {
+    type: PageActionType.Switch;
+    onToggle: (item: T, enable: boolean) => unknown | Promise<unknown>;
+    isSwitchOn: (item: T) => boolean;
+    showPinnedLabel?: boolean;
+    labelOff?: string;
+}
+export interface IPageActionDropdown<T extends object> extends IPageActionNoneCommon {
+    type: PageActionType.Dropdown;
+    actions: IPageAction<T>[];
+}
+export interface IPageActionDropdownSingle<T extends object> extends IPageActionSingleCommon<T> {
+    type: PageActionType.Dropdown;
+    actions: IPageAction<T>[];
+}
+export interface IPageActionDropdownMultiple<T extends object> extends IPageActionMultipleCommon<T> {
+    type: PageActionType.Dropdown;
+    actions: IPageAction<T>[];
+}
+export interface IPageActionSeperator {
+    type: PageActionType.Seperator;
+}
 export {};

package/framework/PageActions/PageActionButton.d.ts

@@ -0,0 +1,10 @@
+import { ComponentClass, FunctionComponent } from 'react';
+import { IPageActionButton, IPageActionButtonMultiple, IPageActionButtonSingle } from './PageAction';
+export declare function PageActionButton<T extends object>(props: {
+    action: IPageActionButton | IPageActionButtonSingle<T> | IPageActionButtonMultiple<T>;
+    isSecondary?: boolean;
+    wrapper?: ComponentClass | FunctionComponent;
+    iconOnly?: boolean;
+    selectedItem?: T;
+    selectedItems?: T[];
+}): JSX.Element;

package/framework/PageActions/{PageDropdownAction.d.ts → PageActionDropdown.d.ts}

@@ -1,17 +1,19 @@
 import { ButtonVariant, DropdownPosition } from '@patternfly/react-core';
 import { ComponentClass, FunctionComponent } from 'react';
 import { IPageAction } from './PageAction';
-export declare function PageDropdownAction<T extends object>(props: {
+interface PageActionDropdownProps<T extends object> {
     actions: IPageAction<T>[];
-    label?: string;
     icon?: ComponentClass | FunctionComponent;
-    isDisabled?: boolean;
-    tooltip?: string;
-    selectedItems?: T[];
-    selectedItem?: T;
-    position?: DropdownPosition;
     iconOnly?: boolean;
+    isDisabled?: string | undefined;
+    label?: string;
     onOpen?: (label: string, open: boolean) => void;
+    position?: DropdownPosition;
+    selectedItem?: T;
+    selectedItems?: T[];
+    tooltip?: string;
     variant?: ButtonVariant;
-}): JSX.Element;
+}
+export declare function PageActionDropdown<T extends object>(props: PageActionDropdownProps<T>): JSX.Element;
 export declare function filterActionSeperators<T extends object>(actions: IPageAction<T>[]): IPageAction<T>[];
+export {};

package/framework/PageActions/PageActionLink.d.ts

@@ -0,0 +1,9 @@
+import { ComponentClass, FunctionComponent } from 'react';
+import { IPageActionLink, IPageActionLinkSingle } from './PageAction';
+export declare function PageActionLink<T extends object>(props: {
+    action: IPageActionLink | IPageActionLinkSingle<T>;
+    wrapper?: ComponentClass | FunctionComponent;
+    iconOnly?: boolean;
+    selectedItem?: T;
+    selectedItems?: T[];
+}): JSX.Element;

package/framework/PageActions/PageActionSwitch.d.ts

@@ -0,0 +1,8 @@
+import { ComponentClass, FunctionComponent } from 'react';
+import { IPageActionSwitch, IPageActionSwitchSingle } from './PageAction';
+export declare function PageActionSwitch<T extends object>(props: {
+    action: IPageActionSwitch | IPageActionSwitchSingle<T>;
+    wrapper?: ComponentClass | FunctionComponent;
+    selectedItem?: T;
+    iconOnly?: boolean;
+}): JSX.Element;

package/framework/PageActions/PageActionUtils.d.ts

@@ -0,0 +1,3 @@
+import { IPageAction } from './PageAction';
+export declare function isPageActionHidden<T extends object>(action: IPageAction<T>, selectedItem: T | undefined): boolean;
+export declare function usePageActionDisabled<T extends object>(): (action: IPageAction<T>, selectedItem: T | undefined, selectedItems?: T[] | undefined) => string | undefined;

package/framework/PageActions/PageActions.d.ts

@@ -2,7 +2,7 @@ import { DropdownPosition } from '@patternfly/react-core';
 import { ComponentClass, FunctionComponent } from 'react';
 import { WindowSize } from '../components/useBreakPoint';
 import { IPageAction } from './PageAction';
-export declare function PageActions<T extends object>(props: {
+interface PageActionProps<T extends object> {
     actions: IPageAction<T>[];
     selectedItem?: T;
     selectedItems?: T[];
@@ -11,5 +11,6 @@ export declare function PageActions<T extends object>(props: {
     position?: DropdownPosition;
     iconOnly?: boolean;
     onOpen?: (open: boolean) => void;
-}): JSX.Element;
-export declare function isHiddenAction<T extends object>(action: IPageAction<T>, selectedItem: T | undefined): boolean;
+}
+export declare function PageActions<T extends object>(props: PageActionProps<T>): JSX.Element;
+export {};

package/framework/PageActions/{PagePinnedActions.d.ts → PageActionsPinned.d.ts}

@@ -1,18 +1,21 @@
 import { ComponentClass, FunctionComponent } from 'react';
 import { IPageAction } from './PageAction';
-export declare function PagePinnedActions<T extends object>(props: {
+interface PageActionsPinnedProps<T extends object> {
     actions: IPageAction<T>[];
     selectedItem?: T;
     selectedItems?: T[];
     wrapper?: ComponentClass | FunctionComponent;
     iconOnly?: boolean;
     onOpen?: (label: string, open: boolean) => void;
-}): JSX.Element;
-export declare function PagePinnedAction<T extends object>(props: {
+}
+export declare function PageActionsPinned<T extends object>(props: PageActionsPinnedProps<T>): JSX.Element;
+interface PageActionPinnedProps<T extends object> {
     action: IPageAction<T>;
     selectedItem?: T;
     selectedItems?: T[];
     wrapper?: ComponentClass | FunctionComponent;
     iconOnly?: boolean;
     onOpen?: (label: string, open: boolean) => void;
-}): JSX.Element;
+}
+export declare function PageActionPinned<T extends object>(props: PageActionPinnedProps<T>): JSX.Element;
+export {};

package/framework/PageAlertToaster.d.ts

@@ -11,3 +11,4 @@ export declare function usePageAlertToaster(): IPageAlertToaster;
 export declare function PageAlertToasterProvider(props: {
     children: ReactNode;
 }): JSX.Element;
+export declare function errorToAlertProps(err: unknown): AlertProps;

package/framework/components/ErrorBoundary.d.ts

@@ -10,6 +10,6 @@ declare class ErrorBoundary extends Component<Props, State> {
     state: State;
     static getDerivedStateFromError(_: Error): State;
     componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
-    render(): string | number | boolean | JSX.Element | import("react").ReactFragment | null | undefined;
+    render(): string | number | boolean | import("react").ReactFragment | JSX.Element | null | undefined;
 }
 export default ErrorBoundary;

package/framework/index.d.ts

@@ -1,5 +1,4 @@
 export * from './PageActions/PageAction';
-export * from './PageActions/PageActionType';
 export * from './PageActions/PageActions';
 export * from './PageAlertToaster';
 export * from './PageBody';

package/framework/useFrameworkTranslations.d.ts

@@ -1,32 +1,34 @@
 import { Dispatch, ReactNode, SetStateAction } from 'react';
 export interface IFrameworkTranslations {
+    by: string;
     cancelText: string;
     canceledText: string;
+    clearAllFilters: string;
+    clickToRefresh: string;
     closeText: string;
     confirmText: string;
+    countMore: string;
+    documentation: string;
     errorText: string;
+    manageColumns: string;
+    moreInformation: string;
     noItemsFound: string;
+    noResultsFound: string;
+    noResultsMatchCriteria: string;
+    noSelection: string;
+    noSelections: string;
     ofText: string;
     pendingText: string;
+    pleaseFixValidationErrors: string;
     processingText: string;
+    selectNone: string;
     selectedText: string;
+    showLess: string;
     submitText: string;
     submittingText: string;
     successText: string;
-    manageColumns: string;
-    moreInformation: string;
-    showLess: string;
-    countMore: string;
-    documentation: string;
-    noResultsFound: string;
-    noResultsMatchCriteria: string;
-    clearAllFilters: string;
-    by: string;
-    selectNone: string;
-    pleaseFixValidationErrors: string;
-    validating: string;
-    clickToRefresh: string;
     unknownError: string;
+    validating: string;
 }
 export declare function FrameworkTranslationsProvider(props: {
     children: ReactNode;