@interopio/home-ui-react 2.2.8 → 4.2.8-next.0

package/dist/index.d.ts

@@ -1,25 +1,419 @@
-export { PlatformPrefsProvider, usePlatformPref, usePlatformPrefs, IOActivePanelRenderer, IODownloadManager, IONotifications, } from "@interopio/components-react";
-export * from "./lib/applications-section/applications-section";
-export * from "./lib/favorites-section/favorites-section";
-export * from "./lib/home-app-workspace/launchpad-access";
-export * from "./lib/io-connect-home/io-connect-home";
-export * from "./lib/io-connect-home/types";
-export * from "./lib/launchpad/launchpad";
-export * from "./lib/launchpad/launchpad-body";
-export * from "./lib/launchpad/launchpad-contents-container";
-export * from "./lib/launchpad/launchpad-header";
-export * from "./lib/launchpad/launchpad-pin-button";
-export * from "./lib/notifications-panel-button/notifications-panel-button";
-export * from "./lib/notifications-panels/notification-settings-panel";
-export * from "./lib/notifications-panels/notifications-panel";
-export * from "./lib/notifications-panels/notifications-panel-with-toggle-button";
-export * from "./lib/section/section";
-export * from "./lib/section/types";
-export * from "./lib/panels/panel-with-toggle-button";
-export * from "./lib/preferences-panel/preferences-panel";
-export * from "./lib/profile-panel/profile-panel";
-export * from "./lib/system-loader/system-loader";
-export * from "./lib/system-menu/system-menu";
-export * from "./lib/workspaces-section/workspaces-section";
-export * from "./hooks/useFavorites";
-export * from "./hooks/useIsLaunchpadCollapsed";
+import { Auth0ProviderOptions } from '@auth0/auth0-react';
+import { IconProps } from '@interopio/components-react';
+import { IOActivePanelRenderer } from '@interopio/components-react';
+import { IOConnectInitSettings } from '@interopio/react-hooks';
+import { IODownloadManager } from '@interopio/components-react';
+import { IONotifications } from '@interopio/components-react';
+import { IOPreferencesDesktop } from '@interopio/components-react';
+import { IOProfile } from '@interopio/components-react';
+import type { JSX as JSX_2 } from 'react/jsx-runtime';
+import { PlatformPrefsProvider } from '@interopio/components-react';
+import { default as React_2 } from 'react';
+import { SetStateAction } from 'react';
+import { usePlatformPref } from '@interopio/components-react';
+import { usePlatformPrefs } from '@interopio/components-react';
+import { User as User_2 } from '@auth0/auth0-react';
+import { WorkspacesProps } from '@interopio/workspaces-ui-react';
+
+export declare function ApplicationsSection(props: ApplicationsSectionProps): JSX_2.Element;
+
+declare type ApplicationsSectionProps = {
+    isFolderCollapsible?: boolean;
+    folderIconGetters?: {
+        [key: string]: (isOpen: boolean) => string;
+    };
+} & DefaultSectionProps;
+
+declare const AUTH0_LOGIN_TYPES: {
+    readonly POPUP: "popup";
+    readonly REDIRECT: "redirect";
+};
+
+export declare interface Auth0LoginConfig {
+    type: "auth0";
+    validateUser?: ValidateUser;
+    loginType?: LoginType;
+    providerOptions: Auth0LoginProviderOptions;
+    components?: LoginPageComponents;
+}
+
+export declare type Auth0LoginProviderOptions = Auth0ProviderOptions;
+
+export declare interface Auth0User extends User_2 {
+    id: string;
+    token: string;
+}
+
+export declare type Auth0ValidationError = {
+    message: string;
+};
+
+declare interface BaseSectionItemType {
+    description?: string;
+    icon?: IconProps["variant"];
+    iconSrc?: string;
+    id: string;
+    openInstances?: number;
+    contextMenuActions?: ContextMenuAction[];
+    title: string;
+    type: string;
+    tooltip?: string;
+    className?: string;
+}
+
+declare type BaseSectionType<Item extends BaseSectionItemType> = {
+    id: string;
+    items: (Item | BaseSectionType<Item>)[];
+    title: string;
+    isCollapsible?: boolean;
+    getIcon?: (isOpen: boolean) => string;
+};
+
+declare interface ContextMenuAction {
+    name: string;
+    displayName?: string;
+    icon?: IconProps["variant"];
+    iconSrc?: string;
+    disabled?: boolean;
+    separatorAfter?: boolean;
+}
+
+export declare interface CustomLoginConfig {
+    type: "custom";
+    onLogout: () => void;
+    user: CustomUser;
+}
+
+export declare interface CustomUser {
+    id: string;
+    username: string;
+}
+
+declare type DefaultSectionProps = {
+    isSectionCollapsible?: boolean;
+    sortOrder?: SortOrder;
+};
+
+declare type Favorite = Omit<SectionItemType, "openInstances">;
+
+export declare const FavoritesSection: (props: DefaultSectionProps) => JSX_2.Element | null;
+
+export { IOActivePanelRenderer }
+
+export declare const IOConnectHome: ({ config }: IOConnectHomeProps) => JSX_2.Element;
+
+export declare type IOConnectHomeComponents = {
+    SystemLoader?: React_2.ComponentType<{
+        text?: string;
+    }>;
+    IOInitErrorScreen?: React_2.ComponentType<{
+        errorMessage?: string;
+    }>;
+};
+
+export declare interface IOConnectHomeConfig {
+    getIOConnectConfig: (userData: UserData) => IOConnectInitSettings;
+    login?: LoginConfig;
+    setupFlow?: SetupFlowConfig;
+    workspaces?: WorkspacesConfig;
+    launchpad?: LaunchpadConfig;
+    components?: IOConnectHomeComponents;
+    settings?: IOConnectHomeSettings;
+}
+
+export declare interface IOConnectHomeProps {
+    config: IOConnectHomeConfig;
+}
+
+export declare type IOConnectHomeSettings = {
+    isBeforeunloadDialogEnabled?: boolean;
+};
+
+export { IODownloadManager }
+
+export { IONotifications }
+
+export { IOPreferencesDesktop }
+
+export { IOProfile }
+
+export declare const Launchpad: (props: LaunchpadProps) => JSX_2.Element;
+
+export declare const LaunchpadAccess: ({ Button }: LaunchpadAccessProps) => JSX_2.Element;
+
+export declare interface LaunchpadAccessProps {
+    Button?: React.ComponentType<PanelButtonProps>;
+}
+
+export declare const LaunchpadBody: ({ className }: LaunchpadBodyProps) => JSX_2.Element;
+
+declare interface LaunchpadBodyProps {
+    className?: string;
+}
+
+export declare interface LaunchpadComponents {
+    header?: LaunchpadHeaderComponents;
+    sections?: LaunchpadSection[];
+}
+
+export declare interface LaunchpadConfig {
+    components?: LaunchpadComponents;
+    settings?: LaunchpadSettings;
+}
+
+export declare const LaunchpadContentsContainer: ({ settings, components, isOpen, onClose, windowManagementPermissionState, children, className, ...rest }: LaunchpadContentsContainerProps) => JSX_2.Element;
+
+declare interface LaunchpadContentsContainerProps extends React.HTMLAttributes<HTMLDivElement> {
+    settings?: LaunchpadSettings;
+    components?: LaunchpadComponents;
+    isOpen?: boolean;
+    onClose?: () => void;
+    windowManagementPermissionState?: PermissionState;
+}
+
+export declare const LaunchpadHeader: ({ className }: LaunchpadHeaderProps) => JSX_2.Element | null;
+
+export declare interface LaunchpadHeaderComponents {
+    BeforeSearch?: React_2.ComponentType | null;
+    AfterSearch?: React_2.ComponentType | null;
+}
+
+declare interface LaunchpadHeaderProps {
+    className?: string;
+}
+
+export declare interface LaunchpadHeaderSettings {
+    showHeader?: boolean;
+    showSearch?: boolean;
+}
+
+export declare type LaunchpadMode = "pinned" | "default";
+
+export declare const LaunchpadPinButton: ({ className }: LaunchpadPinButtonProps) => JSX_2.Element;
+
+declare interface LaunchpadPinButtonProps {
+    className?: string;
+}
+
+export declare interface LaunchpadProps extends React.HTMLProps<HTMLDivElement> {
+    isOpen?: boolean;
+    onClose?: () => void;
+    settings?: LaunchpadSettings;
+    components?: LaunchpadComponents;
+    windowManagementPermissionState?: PermissionState;
+}
+
+export declare interface LaunchpadSection {
+    Component: React_2.ComponentType;
+    placementId: string;
+}
+
+export declare interface LaunchpadSettings {
+    header?: LaunchpadHeaderSettings;
+    mode?: LaunchpadMode;
+}
+
+export declare type LoginConfig = Auth0LoginConfig | SimpleLoginConfig | CustomLoginConfig;
+
+export declare interface LoginPageComponents {
+    Logo?: React_2.ComponentType;
+    Heading?: React_2.ComponentType;
+}
+
+export declare type LoginType = (typeof AUTH0_LOGIN_TYPES)[keyof typeof AUTH0_LOGIN_TYPES];
+
+export declare const NotificationSettingsPanel: ({ className, components, onClose, title }: NotificationsSettingsPanelProps) => JSX_2.Element;
+
+export declare const NotificationsPanel: ({ className, components, onClose, settings, title }: NotificationsPanelProps) => JSX_2.Element;
+
+export declare const NotificationsPanelButton: (props: NotificationsPanelButtonProps) => JSX_2.Element;
+
+declare interface NotificationsPanelButtonProps extends Omit<React.HTMLAttributes<HTMLDivElement>, "children"> {
+    active: boolean;
+}
+
+declare interface NotificationsPanelProps {
+    className?: string;
+    components?: IONotifications.PanelProps["components"];
+    settings?: IONotifications.PanelProps["settings"];
+    onClose: () => void;
+    title?: string;
+}
+
+export declare const NotificationsPanelWithToggleButton: ({ Button, Panel, position, ...rest }: Partial<Omit<PanelWithToggleButtonProps, "onClose">>) => JSX_2.Element;
+
+declare interface NotificationsSettingsPanelProps {
+    className?: string;
+    components?: IONotifications.SettingsPanelProps["components"];
+    onClose: () => void;
+    title?: string;
+}
+
+declare interface PanelButtonProps {
+    active: boolean;
+    onClick: () => void;
+}
+
+declare type PanelPosition = "left" | "right";
+
+declare interface PanelProps {
+    isOpen: boolean;
+    onClose: () => void;
+}
+
+export declare const PanelWithToggleButton: (props: PanelWithToggleButtonProps) => JSX_2.Element;
+
+export declare interface PanelWithToggleButtonProps {
+    Button: React.ComponentType<PanelButtonProps>;
+    Panel: React.ComponentType<PanelProps>;
+    panelWrapperClassName?: string;
+    pinned?: boolean;
+    position?: PanelPosition;
+    tag?: React.ElementType;
+    onClose?: () => void | Promise<void>;
+}
+
+export { PlatformPrefsProvider }
+
+export declare const PreferencesPanel: any;
+
+export declare const ProfilePanel: ({ className, components, onClose, title }: ProfilePanelProps) => JSX_2.Element;
+
+declare interface ProfilePanelProps {
+    className?: string;
+    components?: IOProfile.PanelProps["components"];
+    onClose: () => void;
+    title?: string;
+}
+
+export declare const Section: ({ config, onItemClick }: SectionProps) => JSX_2.Element;
+
+export declare type SectionItemClickedType = {
+    item: SectionItemType;
+    modifier: string | null;
+    selectedContextMenuActionName?: string;
+};
+
+export declare type SectionItemType = BaseSectionItemType;
+
+export declare interface SectionProps {
+    config: SectionType;
+    onItemClick?: (params: {
+        item: SectionItemType;
+        modifier: string | null;
+        selectedContextMenuActionName?: string;
+    }) => void;
+}
+
+export declare type SectionType = BaseSectionType<SectionItemType>;
+
+export declare interface SetupFlowComponents {
+    Logo?: React_2.ComponentType;
+}
+
+export declare interface SetupFlowConfig {
+    enabled?: boolean;
+    components?: SetupFlowComponents;
+    settings?: SetupFlowSettings;
+}
+
+export declare interface SetupFlowSettings {
+    edgeNotificationsPermissionTimeout?: number;
+}
+
+export declare interface SimpleLoginConfig {
+    type: "simple";
+    onLogin: (user: string, password: string) => Promise<User>;
+    onLogout?: () => void;
+    userInputName?: string;
+    components?: LoginPageComponents;
+}
+
+declare const SORT_ORDER: {
+    readonly ASCENDING: "ascending";
+    readonly DESCENDING: "descending";
+    readonly DISABLED: "disabled";
+};
+
+declare type SortOrder = (typeof SORT_ORDER)[keyof typeof SORT_ORDER];
+
+export declare const SystemLoader: ({ Logo, text }: SystemLoaderProps) => JSX_2.Element;
+
+export declare interface SystemLoaderProps {
+    Logo?: React.ComponentType;
+    text?: string;
+}
+
+export declare const SystemMenu: ({ actions, panelWrapperClassName }: SystemMenuProps) => JSX_2.Element;
+
+declare type SystemMenuAction = ContextMenuAction & {
+    onClick: (openPanel: (Panel: SystemMenuPanel) => void) => void;
+};
+
+declare type SystemMenuPanel = React.ComponentType<{
+    className: string;
+    onClose: () => void;
+}>;
+
+export declare interface SystemMenuProps {
+    actions: SystemMenuAction[];
+    panelWrapperClassName?: string;
+}
+
+export declare const useFavorites: () => {
+    favorites: Favorite[];
+    toggleFavorite: (item: SectionItemType) => Promise<void>;
+    removeFavorite: (item: SectionItemType) => Promise<void>;
+    isLoading: boolean;
+};
+
+export declare const useIsLaunchpadCollapsed: () => {
+    error: {
+        message: string;
+    } | undefined;
+    isLaunchpadCollapsed: boolean | undefined;
+    setIsLaunchpadCollapsed: (value: SetStateAction<boolean | undefined>) => Promise<void>;
+    isLoading: boolean;
+};
+
+export { usePlatformPref }
+
+export { usePlatformPrefs }
+
+export declare interface User {
+    id: string;
+    username?: string;
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    token?: string;
+    password?: string;
+}
+
+export declare type UserData = {
+    type: "auth0";
+    user: Auth0User;
+} | {
+    type: "custom";
+    user?: CustomUser;
+} | {
+    type: "simple";
+    user: User;
+};
+
+export declare type ValidateUser = (auth0User: User_2) => ValidationResult;
+
+declare type ValidationResult = {
+    ok: true;
+} | {
+    ok: false;
+    message: string;
+};
+
+export declare interface WorkspacesConfig {
+    components?: WorkspacesProps["components"];
+}
+
+export declare const WorkspacesSection: (props: DefaultSectionProps) => JSX_2.Element;
+
+export { }