@interopio/home-ui-react 1.3.1 → 1.4.0

package/lib/home-app-workspace/home-app-workspace.d.ts

@@ -1,9 +1,13 @@
+/// <reference types="react" />
 import { User, WorkspacesConfig, LaunchpadConfig } from '../io-connect-home/types';
 interface HomeAppWorkspaceProps {
     onLogout?: () => void;
     user?: User | null;
     workspaces?: WorkspacesConfig;
     launchpad?: LaunchpadConfig;
+    Loader?: React.ComponentType<{
+        text?: string;
+    }>;
 }
-export declare const HomeAppWorkspace: ({ onLogout, user, workspaces, launchpad }: HomeAppWorkspaceProps) => import("react/jsx-runtime").JSX.Element;
+export declare const HomeAppWorkspace: ({ onLogout, user, workspaces, launchpad, Loader }: HomeAppWorkspaceProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/lib/home-app-workspace/no-logo.d.ts

@@ -0,0 +1,2 @@
+export declare const NoLogo: () => null;
+export default NoLogo;

package/lib/home-app-workspace/types.d.ts

@@ -0,0 +1,3 @@
+export interface PlatformWindow {
+    name: string;
+}

package/lib/icon-components/index.d.ts

@@ -2,7 +2,9 @@ export * from './browser-notifications-icon';
 export * from './google-chrome-icon';
 export * from './microsoft-edge-icon';
 export * from './opera-icon';
+export * from './popups-icon';
+export * from './pwa-install-icon';
 export * from './reopen-prompt-icon';
 export * from './start-failed-icon';
 export * from './warning-icon';
-export * from './window-placement-icon';
+export * from './window-management-icon';

package/lib/icon-components/popups-icon.d.ts

@@ -0,0 +1,2 @@
+export declare const PopupsIcon: (props: React.SVGProps<SVGSVGElement>) => import("react/jsx-runtime").JSX.Element;
+export default PopupsIcon;

package/lib/icon-components/pwa-install-icon.d.ts

@@ -0,0 +1,2 @@
+export declare const PWAInstallIcon: (props: React.SVGProps<SVGSVGElement>) => import("react/jsx-runtime").JSX.Element;
+export default PWAInstallIcon;

package/lib/icon-components/window-management-icon.d.ts

@@ -0,0 +1,2 @@
+export declare const WindowManagementIcon: (props: React.SVGProps<SVGSVGElement>) => import("react/jsx-runtime").JSX.Element;
+export default WindowManagementIcon;

package/lib/io-connect-home/no-login-home.d.ts

@@ -1,2 +1,8 @@
-import { IOConnectHomeProps } from './types';
-export declare const NoLoginHome: ({ config }: IOConnectHomeProps) => import("react/jsx-runtime").JSX.Element;
+import { CustomLoginConfig, IOConnectHomeConfig } from './types';
+interface NoLoginHomeProps {
+    config: IOConnectHomeConfig & {
+        login?: CustomLoginConfig;
+    };
+}
+export declare const NoLoginHome: ({ config }: NoLoginHomeProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/lib/io-connect-home/types.d.ts

@@ -15,6 +15,10 @@ export interface User {
     token?: string;
     password?: string;
 }
+export interface CustomUser {
+    id: string;
+    username: string;
+}
 export interface Auth0User extends Auth0BaseUser {
     token: string;
 }
@@ -59,13 +63,24 @@ export interface SimpleLoginConfig {
     userInputName?: string;
     components?: LoginPageComponents;
 }
-export type LoginConfig = Auth0LoginConfig | SimpleLoginConfig;
+export interface CustomLoginConfig {
+    type: 'custom';
+    onLogout: () => void;
+    user: CustomUser;
+}
+export type LoginConfig = Auth0LoginConfig | SimpleLoginConfig | CustomLoginConfig;
+export type IOConnectHomeComponents = {
+    SystemLoader?: React.ComponentType<{
+        text?: string;
+    }>;
+};
 export interface IOConnectHomeConfig {
-    getIOConnectConfig: (user?: Auth0User | User) => IOConnectInitSettings;
+    getIOConnectConfig: (user?: Auth0User | User | CustomUser) => IOConnectInitSettings;
     login?: LoginConfig;
     setupFlow?: SetupFlowConfig;
     workspaces?: WorkspacesConfig;
     launchpad?: LaunchpadConfig;
+    components?: IOConnectHomeComponents;
 }
 export interface IOConnectHomeProps {
     config: IOConnectHomeConfig;

package/lib/io-connect-home-provider/io-connect-home-provider.d.ts

@@ -1,14 +1,16 @@
 /// <reference types="react" />
-import type { HomePermissionStatus } from './types';
+import type { HomePermissionStatuses } from './types';
 interface IOConnectHomeProviderProps {
     children: React.ReactNode;
 }
 export declare const useIOConnectHome: () => {
     permission: {
-        isDenied: boolean;
         isLoading: boolean;
-        isSetupCompleted: boolean;
-        statuses: HomePermissionStatus[];
+        statuses: HomePermissionStatuses;
+    };
+    login: {
+        isLoggingOut: boolean;
+        setIsLoggingOut: React.Dispatch<React.SetStateAction<boolean>>;
     };
 };
 export declare const IOConnectHomeProvider: ({ children }: IOConnectHomeProviderProps) => import("react/jsx-runtime").JSX.Element;

package/lib/io-connect-home-provider/types.d.ts

@@ -1,5 +1,8 @@
 import { PERMISSION_NAMES } from './constants';
-export type PermissionNames = (typeof PERMISSION_NAMES)[keyof typeof PERMISSION_NAMES];
+export type PermissionName = (typeof PERMISSION_NAMES)[keyof typeof PERMISSION_NAMES];
 export type HomePermissionStatus = PermissionStatus & {
-    stableName: PermissionNames;
+    stableName: PermissionName;
 };
+export type HomePermissionStatuses = Record<PermissionName, {
+    state: PermissionState;
+}>;

package/lib/login/auth0/auth0-login-page.d.ts

@@ -1,11 +1,15 @@
+/// <reference types="react" />
 import { LoginPageComponents } from '../types';
 import { Auth0ValidationError } from '../../io-connect-home/types';
 export interface Auth0LoginPageProps {
-    className?: string;
     onLogin: () => void;
     isLoading: boolean;
-    components?: LoginPageComponents;
     validationError: Auth0ValidationError | null;
+    components?: LoginPageComponents & {
+        Loader?: React.ComponentType<{
+            text?: string;
+        }>;
+    };
 }
-export declare const Auth0LoginPage: ({ className, onLogin, isLoading, components, validationError }: Auth0LoginPageProps) => import("react/jsx-runtime").JSX.Element;
+export declare const Auth0LoginPage: ({ onLogin, isLoading, validationError, components: { Logo, Heading, Loader }, }: Auth0LoginPageProps) => import("react/jsx-runtime").JSX.Element;
 export default Auth0LoginPage;

package/lib/login/constants.d.ts

@@ -1 +1 @@
-export declare const LOGO_WIDTH = "256px";
+export declare const LOGO_WIDTH = "200px";

package/lib/login/index.d.ts

@@ -1,4 +1,3 @@
-export * from './logout-page';
 export * from './login-loader';
 export * from './auth0/auth0-login-page';
 export * from './simple/simple-login-page';

package/lib/login/simple/simple-login-page.d.ts

@@ -1,8 +1,12 @@
+/// <reference types="react" />
 import { LoginPageComponents } from '../types';
 export interface SimpleLoginPageProps {
-    className?: string;
     onLogin: (user: string, password: string) => Promise<void>;
     userInputName?: string;
-    components?: LoginPageComponents;
+    components?: LoginPageComponents & {
+        Loader?: React.ComponentType<{
+            text?: string;
+        }>;
+    };
 }
-export declare const SimpleLoginPage: ({ className, onLogin, components, userInputName }: SimpleLoginPageProps) => import("react/jsx-runtime").JSX.Element;
+export declare const SimpleLoginPage: ({ onLogin, userInputName, components: { Logo, Heading, Loader }, }: SimpleLoginPageProps) => import("react/jsx-runtime").JSX.Element;

package/lib/platform-setup/constants.d.ts

@@ -0,0 +1,12 @@
+import { SetupStep, SetupStepsStatuses } from './types';
+export declare const DEFAULT_SETTINGS: {
+    edgeNotificationsPermissionTimeout: number;
+};
+export declare const SETUP_STEPS_NAMES: {
+    readonly WINDOW_MANAGEMENT: "window-management";
+    readonly NOTIFICATIONS: "notifications";
+    readonly POPUPS: "popups";
+    readonly PWA_INSTALL: "pwa-install";
+};
+export declare const SETUP_STEPS: SetupStep[];
+export declare const INITIAL_STEPS_STATUSES: SetupStepsStatuses;

package/lib/platform-setup/platform-setup.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="react" />
+interface PlatformSetupProps {
+    components?: {
+        Logo?: React.ComponentType<{
+            className?: string;
+        }>;
+        Loader?: React.ComponentType<{
+            text?: string;
+        }>;
+    };
+    settings?: {
+        edgeNotificationsPermissionTimeout?: number;
+    };
+}
+export declare const PlatformSetup: ({ components: { Logo, Loader }, settings, }: PlatformSetupProps) => import("react/jsx-runtime").JSX.Element;
+export default PlatformSetup;

package/lib/platform-setup/reducers.d.ts

@@ -0,0 +1,7 @@
+import { SetupStepReducerAction, SetupStepsStatuses } from './types';
+export declare const setupStepsReducer: (stepsState: SetupStepsStatuses, action: SetupStepReducerAction) => {
+    "window-management": import("./types").SetupStepStatus;
+    notifications: import("./types").SetupStepStatus;
+    popups: import("./types").SetupStepStatus;
+    "pwa-install": import("./types").SetupStepStatus;
+};

package/lib/platform-setup/setup-steps-list.d.ts

@@ -0,0 +1,8 @@
+import { SetupStepName, SetupStepsStatuses } from './types';
+interface SetupStepsListProps {
+    activeStepName: SetupStepName;
+    showWarnIcon: boolean;
+    stepsStatuses: SetupStepsStatuses;
+}
+export declare const SetupStepsList: ({ activeStepName, showWarnIcon, stepsStatuses }: SetupStepsListProps) => import("react/jsx-runtime").JSX.Element;
+export default SetupStepsList;

package/lib/platform-setup/setup-steps.d.ts

@@ -0,0 +1,7 @@
+interface SetupStepsProps {
+    settings: {
+        edgeNotificationsPermissionTimeout: number;
+    };
+}
+export declare const SetupSteps: ({ settings }: SetupStepsProps) => import("react/jsx-runtime").JSX.Element;
+export default SetupSteps;

package/lib/platform-setup/types.d.ts

@@ -0,0 +1,33 @@
+/// <reference types="react" />
+import { SETUP_STEPS_NAMES } from './constants';
+export type SetupStepName = (typeof SETUP_STEPS_NAMES)[keyof typeof SETUP_STEPS_NAMES];
+type SetupStepState = 'prompt' | 'granted' | 'denied';
+export type SetupStepStatus = {
+    isCompleted: boolean;
+    state: SetupStepState;
+};
+export type SetupStepsStatuses = Record<SetupStepName, SetupStepStatus>;
+type SetupStepReducerActionType = 'completed' | 'skipped' | 'stateUpdated';
+export interface SetupStepReducerAction {
+    type: SetupStepReducerActionType;
+    payload: {
+        stepName: SetupStepName;
+        state?: SetupStepState;
+    };
+}
+export interface SetupStep {
+    name: SetupStepName;
+    label: string;
+    heading: string;
+    description: string;
+    instructions: {
+        initial: string;
+        additional?: string;
+    };
+    Image: (props: React.SVGProps<SVGSVGElement>) => JSX.Element;
+    actionBtnText: string;
+}
+export interface PlatformSetupStatus {
+    isCompleted: boolean;
+}
+export {};

package/lib/spinner/index.d.ts

@@ -0,0 +1 @@
+export * from './spinner';

package/lib/spinner/spinner.d.ts

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

package/lib/system-loader/system-loader.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+export interface SystemLoaderProps {
+    Logo?: React.ComponentType;
+    text?: string;
+}
+export declare const SystemLoader: ({ Logo, text }: SystemLoaderProps) => import("react/jsx-runtime").JSX.Element;
+export default SystemLoader;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@interopio/home-ui-react",
   "description": "React components for building a Home App for io.Connect Browser.",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "main": "./index.js",
   "module": "./index.mjs",
   "types": "./index.d.ts",

package/lib/icon-components/window-placement-icon.d.ts

@@ -1,2 +0,0 @@
-export declare const WindowPlacementIcon: (props: React.SVGProps<SVGSVGElement>) => import("react/jsx-runtime").JSX.Element;
-export default WindowPlacementIcon;

package/lib/loader/index.d.ts

@@ -1 +0,0 @@
-export * from './loader';

package/lib/loader/loader.d.ts

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

package/lib/login/logout-page.d.ts

@@ -1,7 +0,0 @@
-import { LoginPageComponents } from './types';
-interface LogoutPageProps {
-    components?: LoginPageComponents;
-    className?: string;
-}
-export declare const LogoutPage: ({ components, className }: LogoutPageProps) => import("react/jsx-runtime").JSX.Element;
-export default LogoutPage;

package/lib/login/verifying-credentials.d.ts

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

package/lib/permissions-setup/constants.d.ts

@@ -1,7 +0,0 @@
-import type { PermissionStep } from './types';
-export declare const NOTIFICATIONS_PERMISSION_STEP: PermissionStep;
-export declare const WINDOW_MANAGEMENT_PERMISSION_STEP: PermissionStep;
-export declare const PERMISSION_STEPS: Record<string, PermissionStep>;
-export declare const DEFAULT_SETTINGS: {
-    edgeNotificationsPermissionTimeout: number;
-};

package/lib/permissions-setup/permissions-list.d.ts

@@ -1,7 +0,0 @@
-import type { HomePermissionStatus } from '../io-connect-home-provider/types';
-interface PermissionsListProps {
-    isActiveItem?: (name: string) => boolean;
-    permissionStatuses: HomePermissionStatus[];
-}
-export declare const PermissionsList: ({ isActiveItem, permissionStatuses }: PermissionsListProps) => import("react/jsx-runtime").JSX.Element | null;
-export default PermissionsList;

package/lib/permissions-setup/permissions-setup-flow.d.ts

@@ -1,7 +0,0 @@
-interface PermissionsSetupFlowProps {
-    settings: {
-        edgeNotificationsPermissionTimeout: number;
-    };
-}
-export declare const PermissionsSetupFlow: ({ settings }: PermissionsSetupFlowProps) => import("react/jsx-runtime").JSX.Element;
-export {};

package/lib/permissions-setup/permissions-setup.d.ts

@@ -1,13 +0,0 @@
-/// <reference types="react" />
-interface PermissionsSetupProps {
-    components?: {
-        Logo?: React.ComponentType<{
-            className?: string;
-        }>;
-    };
-    settings?: {
-        edgeNotificationsPermissionTimeout?: number;
-    };
-}
-export declare const PermissionsSetup: ({ components: { Logo }, settings }: PermissionsSetupProps) => import("react/jsx-runtime").JSX.Element;
-export default PermissionsSetup;

package/lib/permissions-setup/permissions-steps.d.ts

@@ -1,7 +0,0 @@
-interface PermissionStepsProps {
-    settings: {
-        edgeNotificationsPermissionTimeout: number;
-    };
-}
-export declare const PermissionSteps: ({ settings }: PermissionStepsProps) => import("react/jsx-runtime").JSX.Element;
-export default PermissionSteps;

package/lib/permissions-setup/something-went-wrong.d.ts

@@ -1,5 +0,0 @@
-interface SomethingWentWrongProps {
-    onReopenPromptClick: () => void;
-}
-export declare const SomethingWentWrong: ({ onReopenPromptClick }: SomethingWentWrongProps) => import("react/jsx-runtime").JSX.Element;
-export {};

package/lib/permissions-setup/types.d.ts

@@ -1,12 +0,0 @@
-/// <reference types="react" />
-export interface PermissionStep {
-    heading: string;
-    description: string;
-    guidelines: Record<string, string>;
-    label: string;
-    Image?: React.ComponentType;
-    openPermissionsPrompt: (options: {
-        handleDeferredPermission: () => void;
-        handlePermissionsPromptClose: () => void;
-    }) => void;
-}

package/lib/permissions-setup/unsuccessful-setup.d.ts

@@ -1,6 +0,0 @@
-import type { PermissionNames } from '../io-connect-home-provider/types';
-interface UnsuccessfulSetupProps {
-    deniedPermissionName?: PermissionNames;
-}
-export declare const UnsuccessfulSetup: ({ deniedPermissionName }: UnsuccessfulSetupProps) => import("react/jsx-runtime").JSX.Element;
-export default UnsuccessfulSetup;