@vuu-ui/vuu-shell 0.13.4 → 0.13.5

package/package.json

@@ -1,26 +1,26 @@
 {
-  "version": "0.13.4",
+  "version": "0.13.5",
   "description": "VUU UI Shell",
   "author": "heswell",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@vuu-ui/vuu-data-types": "0.13.4",
-    "@vuu-ui/vuu-protocol-types": "0.13.4",
-    "@vuu-ui/vuu-table-types": "0.13.4"
+    "@vuu-ui/vuu-data-types": "0.13.5",
+    "@vuu-ui/vuu-protocol-types": "0.13.5",
+    "@vuu-ui/vuu-table-types": "0.13.5"
   },
   "dependencies": {
     "@salt-ds/core": "1.43.0",
     "@salt-ds/styles": "0.2.1",
     "@salt-ds/window": "0.1.1",
-    "@vuu-ui/vuu-context-menu": "0.13.4",
-    "@vuu-ui/vuu-data-react": "0.13.4",
-    "@vuu-ui/vuu-data-remote": "0.13.4",
-    "@vuu-ui/vuu-icons": "0.13.4",
-    "@vuu-ui/vuu-layout": "0.13.4",
-    "@vuu-ui/vuu-popups": "0.13.4",
-    "@vuu-ui/vuu-table": "0.13.4",
-    "@vuu-ui/vuu-ui-controls": "0.13.4",
-    "@vuu-ui/vuu-utils": "0.13.4",
+    "@vuu-ui/vuu-context-menu": "0.13.5",
+    "@vuu-ui/vuu-data-react": "0.13.5",
+    "@vuu-ui/vuu-data-remote": "0.13.5",
+    "@vuu-ui/vuu-icons": "0.13.5",
+    "@vuu-ui/vuu-layout": "0.13.5",
+    "@vuu-ui/vuu-popups": "0.13.5",
+    "@vuu-ui/vuu-table": "0.13.5",
+    "@vuu-ui/vuu-ui-controls": "0.13.5",
+    "@vuu-ui/vuu-utils": "0.13.5",
     "html-to-image": "^1.11.11"
   },
   "peerDependencies": {
@@ -32,16 +32,19 @@
   "files": [
     "README.md",
     "esm",
-    "cjs"
+    "cjs",
+    "/types"
   ],
   "exports": {
     ".": {
       "require": "./cjs/index.js",
-      "import": "./esm/index.js"
+      "import": "./esm/index.js",
+      "types": "./types/index.d.ts"
     }
   },
   "main": "cjs/index.js",
   "module": "esm/index.js",
   "name": "@vuu-ui/vuu-shell",
-  "type": "module"
+  "type": "module",
+  "types": "types/index.d.ts"
 }

package/types/ShellContextProvider.d.ts

@@ -0,0 +1,7 @@
+import { ShellContextProps } from "@vuu-ui/vuu-utils";
+import { ReactElement, ReactNode } from "react";
+export interface ShellProviderProps {
+    children: ReactNode;
+    value?: ShellContextProps;
+}
+export declare const ShellContextProvider: ({ children, value, }: ShellProviderProps) => ReactElement;

package/types/app-header/AppHeader.d.ts

@@ -0,0 +1,6 @@
+import type { ThemeMode } from "@vuu-ui/vuu-utils";
+import { HTMLAttributes } from "react";
+export interface AppHeaderProps extends HTMLAttributes<HTMLDivElement> {
+    themeMode?: ThemeMode;
+}
+export declare const AppHeader: ({ className: classNameProp, themeMode: _, ...htmlAttributes }: AppHeaderProps) => import("react/jsx-runtime").JSX.Element;

package/types/app-header/index.d.ts

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

package/types/app-status-bar/AppStatusBar.d.ts

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

package/types/app-status-bar/index.d.ts

@@ -0,0 +1 @@
+export * from "./AppStatusBar";

package/types/application-provider/ApplicationContext.d.ts

@@ -0,0 +1,11 @@
+import type { Settings, VuuUser } from "@vuu-ui/vuu-utils";
+import { VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
+import { SettingsSchema } from "../user-settings";
+export interface ApplicationContextProps {
+    onUserSettingChanged: (propertyName: string, value: VuuRowDataItemType) => void;
+    loginUrl?: string;
+    userSettings?: Settings;
+    userSettingsSchema?: SettingsSchema;
+    user: VuuUser;
+}
+export declare const ApplicationContext: import("react").Context<ApplicationContextProps>;

package/types/application-provider/ApplicationProvider.d.ts

@@ -0,0 +1,17 @@
+import { VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
+import { Density, ThemeContextProps } from "@salt-ds/core";
+import { ReactElement, ReactNode } from "react";
+import { ApplicationContextProps } from "./ApplicationContext";
+export interface ApplicationProviderProps extends Partial<Pick<ThemeContextProps, "theme" | "mode">>, Partial<Omit<ApplicationContextProps, "userSettings">> {
+    children: ReactNode;
+    density?: Density;
+}
+export declare const ApplicationProvider: ({ children, density: densityProp, loginUrl, mode, theme, userSettingsSchema: userSettingsSchema, user, }: ApplicationProviderProps) => ReactElement | null;
+export declare const useApplicationUser: () => import("@vuu-ui/vuu-utils").VuuUser;
+export declare const useLoginUrl: () => string | undefined;
+export declare const useApplicationSettings: () => {
+    onUserSettingChanged: (propertyName: string, value: VuuRowDataItemType) => void;
+    userSettings: import("@vuu-ui/vuu-utils").Settings | undefined;
+    userSettingsSchema: import("..").SettingsSchema | undefined;
+};
+export declare const useUserSetting: () => import("@vuu-ui/vuu-utils").Settings | undefined;

package/types/application-provider/index.d.ts

@@ -0,0 +1 @@
+export * from "./ApplicationProvider";

package/types/connection-status/ConnectionRetryCountdown.d.ts

@@ -0,0 +1,3 @@
+export declare const ConnectionRetryCountdown: ({ seconds: secondsProp, }: {
+    seconds: number;
+}) => import("react/jsx-runtime").JSX.Element;

package/types/connection-status/ConnectionStateDisplay.d.ts

@@ -0,0 +1,9 @@
+import type { WebSocketConnectionState } from "@vuu-ui/vuu-data-remote/src/WebSocketConnection";
+import { HTMLAttributes } from "react";
+interface ConnectionStateDisplayProps extends HTMLAttributes<HTMLDivElement> {
+    className?: string;
+    connectionState?: WebSocketConnectionState;
+    showText?: boolean;
+}
+export declare const ConnectionStateDisplay: ({ connectionState: connectionStateProp, showText, ...htmlAttributes }: ConnectionStateDisplayProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/types/connection-status/ConnectionStatusIndicator.d.ts

@@ -0,0 +1,6 @@
+import type { WebSocketConnectionState } from "@vuu-ui/vuu-data-remote";
+interface ConnectionStatusIndicatorProps {
+    connectionState: WebSocketConnectionState;
+}
+export declare const ConnectionStatusIndicator: ({ connectionState, }: ConnectionStatusIndicatorProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/types/connection-status/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./ConnectionStateDisplay";
+export * from "./ConnectionStatusIndicator";

package/types/feature/Feature.d.ts

@@ -0,0 +1,10 @@
+import { DynamicFeatureProps } from "@vuu-ui/vuu-utils";
+import React from "react";
+declare function RawFeature<Params extends object | undefined>({ url, css, ComponentProps: params, ...props }: DynamicFeatureProps<Params>): import("react/jsx-runtime").JSX.Element;
+/**
+  Feature is a wrapper around React Lazy Loading. It will load a component
+  from the given url. That url must resolve to a javascript bundle with a
+  single default export. That export must be a React component.
+ */
+export declare const Feature: React.MemoExoticComponent<typeof RawFeature>;
+export {};

package/types/feature/FeatureErrorBoundary.d.ts

@@ -0,0 +1,13 @@
+import { DynamicFeatureProps } from "@vuu-ui/vuu-utils";
+import React, { ErrorInfo, ReactNode } from "react";
+export interface FeatureErrorBoundaryProps extends DynamicFeatureProps {
+    children: ReactNode;
+}
+export declare class FeatureErrorBoundary extends React.Component<FeatureErrorBoundaryProps, any> {
+    constructor(props: FeatureErrorBoundaryProps);
+    static getDerivedStateFromError(error: Error): {
+        errorMessage: string;
+    };
+    componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
+    render(): string | number | bigint | boolean | Iterable<React.ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | null | undefined> | import("react/jsx-runtime").JSX.Element | null | undefined;
+}

package/types/feature/Loader.d.ts

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

package/types/feature/index.d.ts

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

package/types/feature-and-layout-provider/FeatureAndLayoutProvider.d.ts

@@ -0,0 +1,19 @@
+import { DynamicFeatureDescriptor, DynamicFeatureProps, FilterTableFeatureProps, StaticFeatureDescriptor, SystemLayoutMetadata } from "@vuu-ui/vuu-utils";
+import { ReactElement, ReactNode } from "react";
+export interface FeatureContextProps {
+    dynamicFeatures?: DynamicFeatureProps[];
+    tableFeatures?: DynamicFeatureProps<FilterTableFeatureProps>[];
+    staticFeatures?: StaticFeatureDescriptor[];
+}
+export interface LayoutContextProps {
+    systemLayouts?: SystemLayoutMetadata[];
+}
+export interface FeatureAndLayoutProviderProps extends Partial<FeatureContextProps> {
+    children: ReactNode;
+    dynamicFeatures?: DynamicFeatureDescriptor[];
+    staticFeatures?: StaticFeatureDescriptor[];
+    systemLayouts?: SystemLayoutMetadata[];
+}
+export declare const FeatureAndLayoutProvider: ({ children, dynamicFeatures: dynamicFeaturesProp, staticFeatures, systemLayouts, }: FeatureAndLayoutProviderProps) => ReactElement;
+export declare const useFeatures: () => FeatureContextProps;
+export declare const useLayouts: () => LayoutContextProps;

package/types/feature-and-layout-provider/index.d.ts

@@ -0,0 +1 @@
+export * from "./FeatureAndLayoutProvider";

package/types/feature-list/FeatureList.d.ts

@@ -0,0 +1,7 @@
+import { DynamicFeatureProps, StaticFeatureDescriptor } from "@vuu-ui/vuu-utils";
+import { HTMLAttributes } from "react";
+export type GroupedFeatureProps<P extends object | undefined = object> = Record<string, DynamicFeatureProps<P>[]>;
+export interface FeatureListProps extends HTMLAttributes<HTMLDivElement> {
+    features: DynamicFeatureProps[] | GroupedFeatureProps | StaticFeatureDescriptor[];
+}
+export declare const FeatureList: ({ features, title, ...htmlAttributes }: FeatureListProps) => import("react/jsx-runtime").JSX.Element;

package/types/feature-list/index.d.ts

@@ -0,0 +1 @@
+export * from "./FeatureList";

package/types/get-layout-history.d.ts

@@ -0,0 +1,8 @@
+import type { VuuUser } from "@vuu-ui/vuu-utils";
+export interface LayoutHistoryItem {
+    user: string;
+    id: string;
+    uniqueId: string;
+    lastUpdate: number;
+}
+export declare const getLayoutHistory: (user: VuuUser) => Promise<LayoutHistoryItem[]>;

package/types/index.d.ts

@@ -0,0 +1,15 @@
+export * from "./application-provider";
+export * from "./app-header";
+export * from "./connection-status";
+export * from "./feature";
+export * from "./feature-and-layout-provider";
+export * from "./left-nav";
+export * from "./login";
+export * from "./persistence-manager";
+export * from "./shell";
+export * from "./shell-layout-templates";
+export * from "./ShellContextProvider";
+export * from "./feature-list";
+export * from "./theme-switch";
+export * from "./user-settings";
+export * from "./workspace-management";

package/types/left-nav/LeftNav.d.ts

@@ -0,0 +1,14 @@
+import { HTMLAttributes } from "react";
+export type NavDisplayStatus = "menu-full" | "menu-icons" | "menu-full-content" | "menu-icons-content";
+export type NavDisplayStatusHandler = (navDisplayStatus: NavDisplayStatus) => void;
+export interface LeftNavProps extends HTMLAttributes<HTMLDivElement> {
+    "data-path"?: string;
+    defaultActiveTabIndex?: number;
+    defaultExpanded?: boolean;
+    onActiveChange?: (activeTabIndex: number) => void;
+    onTogglePrimaryMenu?: (expanded: boolean) => void;
+    sizeCollapsed?: number;
+    sizeContent?: number;
+    sizeExpanded?: number;
+}
+export declare const LeftNav: (props: LeftNavProps) => import("react/jsx-runtime").JSX.Element;

package/types/left-nav/index.d.ts

@@ -0,0 +1 @@
+export * from "./LeftNav";

package/types/login/LoginPanel.d.ts

@@ -0,0 +1,7 @@
+import { HTMLAttributes } from "react";
+export interface LoginPanelProps extends Omit<HTMLAttributes<HTMLDivElement>, "onSubmit"> {
+    appName?: string;
+    onSubmit: (username: string, password?: string) => void;
+    requirePassword?: boolean;
+}
+export declare const LoginPanel: ({ appName, className, requirePassword, onSubmit, ...htmlAttributes }: LoginPanelProps) => import("react/jsx-runtime").JSX.Element;

package/types/login/VuuLogo.d.ts

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

package/types/login/index.d.ts

@@ -0,0 +1,2 @@
+export * from './LoginPanel';
+export * from './login-utils';

package/types/login/login-utils.d.ts

@@ -0,0 +1,4 @@
+export declare const getAuthModeFromCookies: () => string;
+export declare const getAuthDetailsFromCookies: () => [string, string];
+export declare const redirectToLogin: (loginUrl?: string) => void;
+export declare const logout: (loginUrl?: string) => void;

package/types/persistence-manager/LocalPersistenceManager.d.ts

@@ -0,0 +1,21 @@
+import { ApplicationJSON, LayoutJSON, Settings, Layout, LayoutMetadata, LayoutMetadataDto } from "@vuu-ui/vuu-utils";
+import { IPersistenceManager } from "./PersistenceManager";
+export declare class LocalPersistenceManager implements IPersistenceManager {
+    #private;
+    metadataSaveLocation: string;
+    layoutsSaveLocation: string;
+    constructor(urlKey?: string);
+    createLayout(metadata: LayoutMetadataDto, layout: LayoutJSON): Promise<LayoutMetadata>;
+    updateLayout(id: string, newMetadata: LayoutMetadataDto, newLayout: LayoutJSON): Promise<void>;
+    deleteLayout(id: string): Promise<void>;
+    loadLayout(id: string): Promise<LayoutJSON>;
+    loadMetadata(): Promise<LayoutMetadata[]>;
+    loadApplicationJSON(): Promise<ApplicationJSON | undefined>;
+    saveApplicationJSON(applicationJSON: ApplicationJSON): Promise<void>;
+    loadLayouts: () => Promise<Layout[]>;
+    saveLayoutsWithMetadata: (layouts: Layout[], metadata: LayoutMetadata[]) => void;
+    validateIds: (id: string) => Promise<void>;
+    validateId: (id: string, dataType: "metadata" | "layout") => Promise<void>;
+    getUserSettings(): Promise<Settings>;
+    saveUserSettings(userSettings: Settings): void;
+}

package/types/persistence-manager/PersistenceManager.d.ts

@@ -0,0 +1,66 @@
+import type { ApplicationJSON, LayoutJSON, LayoutMetadata, LayoutMetadataDto, Settings } from "@vuu-ui/vuu-utils";
+export interface IPersistenceManager {
+    /**
+     * Saves a new layout and its corresponding metadata
+     *
+     * @param metadata - Metadata about the layout to be saved
+     * @param layout   - Full JSON representation of the layout to be saved
+     *
+     * @returns Unique identifier assigned to the saved layout
+     */
+    createLayout: (metadata: LayoutMetadataDto, layout: LayoutJSON) => Promise<LayoutMetadata>;
+    /**
+     * Overwrites an existing layout and its corresponding metadata with the provided information
+     *
+     * @param id       - Unique identifier of the existing layout to be updated
+     * @param metadata - Metadata describing the new layout to overwrite with
+     * @param layout   - Full JSON representation of the new layout to overwrite with
+     */
+    updateLayout: (id: string, metadata: LayoutMetadataDto, layout: LayoutJSON) => Promise<void>;
+    /**
+     * Deletes an existing layout and its corresponding metadata
+     *
+     * @param id - Unique identifier of the existing layout to be deleted
+     */
+    deleteLayout: (id: string) => Promise<void>;
+    /**
+     * Retrieves an existing layout
+     *
+     * @param id - Unique identifier of the existing layout to be retrieved
+     *
+     * @returns Full JSON representation of the layout corresponding to the provided ID
+     */
+    loadLayout: (id: string) => Promise<LayoutJSON>;
+    /**
+     * Retrieves metadata for all existing layouts
+     *
+     * @returns an array of all persisted layout metadata
+     */
+    loadMetadata: () => Promise<LayoutMetadata[]>;
+    /**
+     * Retrieves the application JSON. This includes the application layout,
+     * which describes all layouts on screen
+     *
+     * @returns Full JSON representation of the application json
+     */
+    loadApplicationJSON: () => Promise<ApplicationJSON | undefined>;
+    /**
+     * Saves the application JSON.  This includes the application layout,
+     * which describes all layouts on screen
+     *
+     * @param layout - Full JSON representation of the application layout to be saved
+     */
+    saveApplicationJSON: (layout: ApplicationJSON) => Promise<void>;
+    /**
+     * Save user settings. These get saved within the Application JSON.
+     *
+     * @param userSettings
+     */
+    saveUserSettings: (userSettings: Settings) => void;
+    /**
+     * Get the user settings. These are stored within Application JSON.
+     *
+     * @returns userSettings
+     */
+    getUserSettings: () => Promise<Settings>;
+}

package/types/persistence-manager/PersistenceProvider.d.ts

@@ -0,0 +1,11 @@
+import { ReactElement, ReactNode } from "react";
+import { IPersistenceManager } from ".";
+export interface PersistenceContextProps {
+    persistenceManager?: IPersistenceManager;
+}
+export declare const PersistenceContext: import("react").Context<PersistenceContextProps>;
+export interface PersistenceProviderProps extends PersistenceContextProps {
+    children: ReactNode;
+}
+export declare const PersistenceProvider: ({ children, persistenceManager, }: PersistenceProviderProps) => ReactElement;
+export declare const usePersistenceManager: () => IPersistenceManager | undefined;

package/types/persistence-manager/RemotePersistenceManager.d.ts

@@ -0,0 +1,23 @@
+import { ApplicationJSON, LayoutJSON, LayoutMetadata, LayoutMetadataDto, Settings } from "@vuu-ui/vuu-utils";
+import { IPersistenceManager } from "./PersistenceManager";
+export type CreateLayoutResponseDto = {
+    metadata: LayoutMetadata;
+};
+export type GetLayoutResponseDto = {
+    definition: LayoutJSON;
+};
+export type GetApplicationResponseDto = {
+    definition: ApplicationJSON;
+};
+export declare class RemotePersistenceManager implements IPersistenceManager {
+    username: string;
+    createLayout(metadata: LayoutMetadataDto, layout: LayoutJSON): Promise<LayoutMetadata>;
+    updateLayout(id: string, metadata: LayoutMetadataDto, newLayoutJson: LayoutJSON): Promise<void>;
+    deleteLayout(id: string): Promise<void>;
+    loadLayout(id: string): Promise<LayoutJSON>;
+    loadMetadata(): Promise<LayoutMetadata[]>;
+    saveApplicationJSON(applicationJSON: ApplicationJSON): Promise<void>;
+    loadApplicationJSON(): Promise<ApplicationJSON>;
+    getUserSettings(): Promise<{}>;
+    saveUserSettings(userSettings: Settings): void;
+}

package/types/persistence-manager/StaticPersistenceManager.d.ts

@@ -0,0 +1,21 @@
+import { ApplicationJSON, LayoutJSON, LayoutMetadata, Settings } from "@vuu-ui/vuu-utils";
+import { IPersistenceManager } from "./PersistenceManager";
+export declare class StaticPersistenceManager implements IPersistenceManager {
+    #private;
+    constructor({ applicationJSON, applicationLoadDelay, layoutMetadata, }: {
+        applicationJSON?: ApplicationJSON;
+        applicationLoadDelay?: number;
+        layoutMetadata?: LayoutMetadata[];
+    });
+    createLayout(): Promise<LayoutMetadata>;
+    updateLayout(): Promise<void>;
+    deleteLayout(): Promise<void>;
+    loadLayout(id: string): Promise<LayoutJSON<{
+        [key: string]: any;
+    }>>;
+    loadMetadata(): Promise<LayoutMetadata[]>;
+    loadApplicationJSON(): Promise<ApplicationJSON | undefined>;
+    saveApplicationJSON(applicationJson: ApplicationJSON): Promise<void>;
+    getUserSettings(): Promise<Settings>;
+    saveUserSettings(userSettings: Settings): void;
+}

package/types/persistence-manager/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./PersistenceManager";
+export * from "./PersistenceProvider";
+export * from "./LocalPersistenceManager";
+export * from "./RemotePersistenceManager";
+export * from "./StaticPersistenceManager";

package/types/shell-layout-templates/context-panel/ContextPanel.d.ts

@@ -0,0 +1,13 @@
+import { LayoutJSON } from "@vuu-ui/vuu-utils";
+import { ReactNode } from "react";
+export interface ContextPanelProps {
+    [key: string]: unknown;
+    className?: string;
+    content?: LayoutJSON;
+    expanded?: boolean;
+    id?: string;
+    onClose?: () => void;
+    overlay?: boolean;
+    title?: ReactNode;
+}
+export declare const ContextPanel: ({ className: classNameProp, expanded, content: contentProp, id, onClose, overlay, title, }: ContextPanelProps) => import("react/jsx-runtime").JSX.Element;

package/types/shell-layout-templates/context-panel/index.d.ts

@@ -0,0 +1 @@
+export * from "./ContextPanel";

package/types/shell-layout-templates/full-height-left-panel/useFullHeightLeftPanel.d.ts

@@ -0,0 +1,2 @@
+import { ShellLayoutTemplateHook } from "../useShellLayout";
+export declare const useFullHeightLeftPanel: ShellLayoutTemplateHook;

package/types/shell-layout-templates/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./context-panel";
+export * from "./useShellLayout";
+export * from "./side-panel";

package/types/shell-layout-templates/inlay-left-panel/useInlayLeftPanel.d.ts

@@ -0,0 +1,2 @@
+import { ShellLayoutTemplateHook } from "../useShellLayout";
+export declare const useInlayLeftPanel: ShellLayoutTemplateHook;

package/types/shell-layout-templates/left-main-tabs/useLeftMainTabs.d.ts

@@ -0,0 +1,2 @@
+import { ShellLayoutTemplateHook } from "../useShellLayout";
+export declare const useLeftMainTabs: ShellLayoutTemplateHook;

package/types/shell-layout-templates/side-panel/SidePanel.d.ts

@@ -0,0 +1,8 @@
+import { HTMLAttributes } from "react";
+export interface SidePanelProps extends HTMLAttributes<HTMLDivElement> {
+    open?: boolean;
+    path?: string;
+    sizeOpen?: number;
+    sizeClosed?: number;
+}
+export declare const SidePanel: ({ children, open, sizeClosed, sizeOpen, style: styleProp, ...htmlAttributes }: SidePanelProps) => import("react/jsx-runtime").JSX.Element;

package/types/shell-layout-templates/side-panel/index.d.ts

@@ -0,0 +1 @@
+export * from "./SidePanel";

package/types/shell-layout-templates/simple-content-pane/useSimpleContentPane.d.ts

@@ -0,0 +1,2 @@
+import { ShellLayoutTemplateHook } from "../useShellLayout";
+export declare const useSimpleContentPane: ShellLayoutTemplateHook;

package/types/shell-layout-templates/useShellLayout.d.ts

@@ -0,0 +1,51 @@
+import { HTMLAttributes, ReactElement, ReactNode } from "react";
+import { SidePanelProps as ShellSidePanelProps } from "./side-panel";
+declare const LayoutHook: {
+    "full-height": ShellLayoutTemplateHook;
+    inlay: ShellLayoutTemplateHook;
+    "left-main-tabs": ShellLayoutTemplateHook;
+    "simple-content-pane": ShellLayoutTemplateHook;
+};
+export type LayoutTemplateId = keyof typeof LayoutHook;
+export type ShellLayoutTemplateProps = Omit<ShellLayoutProps, "layoutTemplateId">;
+export type ShellToolbarProps = {
+    children: ReactNode;
+    position?: "left";
+    width?: number;
+};
+export type ShellLayoutTemplateHook = (props: ShellLayoutTemplateProps) => ReactElement;
+/**
+ * The Shell Layout is the outermost 'chrome' of the appliciation,
+ * enclosing the main content area. It will be rendered by one of
+ * two available templates, determined by the layoutTemplateId,
+ */
+export interface ShellLayoutProps {
+    /**
+     * App Header will be rendered in position determined by layout-template
+     */
+    appHeader?: ReactNode;
+    /**
+     * HTML attributes that will be applied to root div.
+     */
+    htmlAttributes?: HTMLAttributes<HTMLDivElement>;
+    /**
+     * identifier for shell layout template to be used. Default template
+     * will be "inlay"
+     */
+    layoutTemplateId?: LayoutTemplateId;
+    /**
+     * If template renders SidePanel, these props will be provided
+     */
+    SidePanelProps?: ShellSidePanelProps;
+    /**
+     * If template renders Toolbar, these props will be provided
+     */
+    ToolbarProps?: ShellToolbarProps;
+}
+/**
+ * This hook acts as a stub for the actual shell layout
+ * template hooks. It will delegate to the appropriate shell
+ * layout hook, based on the value of layoutTemplateId.
+ */
+export declare const useShellLayout: ({ layoutTemplateId, ...props }: ShellLayoutProps) => ReactElement<unknown, string | import("react").JSXElementConstructor<any>>;
+export {};

package/types/shell.d.ts

@@ -0,0 +1,17 @@
+import { VuuUser } from "@vuu-ui/vuu-utils";
+import { HTMLAttributes, ReactNode } from "react";
+import { ShellLayoutProps } from "./shell-layout-templates";
+import { SettingsSchema } from "./user-settings";
+import { WorkspaceProps } from "./workspace-management";
+export type LayoutTemplateName = "full-height" | "inlay";
+export interface ShellProps extends HTMLAttributes<HTMLDivElement> {
+    shellLayoutProps?: ShellLayoutProps;
+    userSettingsSchema?: SettingsSchema;
+    workspaceProps?: WorkspaceProps;
+    children?: ReactNode;
+    loginUrl?: string;
+    saveUrl?: string;
+    serverUrl?: string;
+    user: VuuUser;
+}
+export declare const Shell: ({ loginUrl, user, userSettingsSchema, workspaceProps, ...props }: ShellProps) => import("react/jsx-runtime").JSX.Element;

package/types/theme-switch/ThemeSwitch.d.ts

@@ -0,0 +1,8 @@
+import { HTMLAttributes } from "react";
+import { ThemeMode } from "@vuu-ui/vuu-utils";
+export interface ThemeSwitchProps extends Omit<HTMLAttributes<HTMLDivElement>, "onChange"> {
+    defaultMode?: ThemeMode;
+    mode?: ThemeMode;
+    onChange: (mode: ThemeMode) => void;
+}
+export declare const ThemeSwitch: ({ className: classNameProp, defaultMode: defaultModeProp, mode: modeProp, onChange, ...htmlAttributes }: ThemeSwitchProps) => import("react/jsx-runtime").JSX.Element;

package/types/theme-switch/index.d.ts

@@ -0,0 +1 @@
+export * from "./ThemeSwitch";

package/types/use-force-render.d.ts

@@ -0,0 +1 @@
+export function useForceRender(): import("react").Dispatch<import("react").SetStateAction<{}>>;

package/types/user-settings/SettingsForm.d.ts

@@ -0,0 +1,46 @@
+import { VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
+import { Settings } from "@vuu-ui/vuu-utils";
+import { DropdownProps } from "@salt-ds/core";
+import { FormEventHandler, HTMLAttributes } from "react";
+export interface SettingsSchema {
+    properties: SettingsProperty[];
+}
+export type Option<T> = {
+    label: string;
+    value: T;
+};
+export declare const isOption: (value: Option<number | string> | number | string) => value is Option<number | string>;
+export interface BaseProperty {
+    name: string;
+    label: string;
+}
+export interface StringProperty extends BaseProperty {
+    values?: string[] | Option<string>[];
+    defaultValue?: string;
+    type: "string";
+}
+export interface NumericProperty extends BaseProperty {
+    values?: number[] | Option<number>[];
+    defaultValue?: number;
+    type: "number";
+}
+export interface BooleanProperty extends BaseProperty {
+    defaultValue?: boolean;
+    type: "boolean";
+}
+export type SettingsProperty = StringProperty | NumericProperty | BooleanProperty;
+export declare const isBooleanProperty: (property: SettingsProperty) => property is BooleanProperty;
+export declare const isStringOrNumber: (value: unknown) => value is string | number;
+export declare function FormControl({ property, changeHandler, selectHandler, inputHandler, currentValue, }: {
+    property: SettingsProperty;
+    changeHandler: FormEventHandler;
+    selectHandler: DropdownProps["onSelectionChange"];
+    inputHandler: FormEventHandler;
+    currentValue: VuuRowDataItemType;
+}): import("react/jsx-runtime").JSX.Element | null;
+export interface SettingsFormProps extends HTMLAttributes<HTMLDivElement> {
+    settingsSchema: SettingsSchema;
+    settings: Settings;
+    onSettingChanged: (propertyName: string, value: string | number | boolean) => void;
+}
+export declare const SettingsForm: ({ className, settingsSchema, settings, onSettingChanged, ...htmlAttributes }: SettingsFormProps) => import("react/jsx-runtime").JSX.Element;

package/types/user-settings/UserSettingsPanel.d.ts

@@ -0,0 +1,3 @@
+import { HTMLAttributes } from "react";
+export type UserSettingsPanelProps = HTMLAttributes<HTMLDivElement>;
+export declare const UserSettingsPanel: ({ ...htmlAttributes }: UserSettingsPanelProps) => import("react/jsx-runtime").JSX.Element | null;

package/types/user-settings/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./UserSettingsPanel";
+export * from "./SettingsForm";

package/types/workspace-management/LayoutList.d.ts

@@ -0,0 +1,2 @@
+import { HTMLAttributes } from "react";
+export declare const LayoutList: ({ className, title, ...htmlAttributes }: HTMLAttributes<HTMLDivElement>) => import("react/jsx-runtime").JSX.Element;

package/types/workspace-management/LayoutTile.d.ts

@@ -0,0 +1,7 @@
+import { LayoutJSON, LayoutMetadata, SystemLayoutMetadata } from "@vuu-ui/vuu-utils";
+import { HTMLAttributes } from "react";
+export interface LayoutTileProps extends HTMLAttributes<HTMLDivElement> {
+    metadata: LayoutMetadata | SystemLayoutMetadata;
+    onLoadLayout: (layoutId?: string, layoutJSON?: LayoutJSON) => void;
+}
+export declare const LayoutTile: ({ metadata, onLoadLayout, ...htmlAttributes }: LayoutTileProps) => import("react/jsx-runtime").JSX.Element;

package/types/workspace-management/SaveLayoutPanel.d.ts

@@ -0,0 +1,9 @@
+import { LayoutMetadataDto } from "@vuu-ui/vuu-utils";
+type SaveLayoutPanelProps = {
+    componentId?: string;
+    defaultTitle?: string;
+    onCancel: () => void;
+    onSave: (layoutMetadata: LayoutMetadataDto) => void;
+};
+export declare const SaveLayoutPanel: (props: SaveLayoutPanelProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/types/workspace-management/WorkspaceProvider.d.ts

@@ -0,0 +1,52 @@
+import { LayoutMetadata, LayoutMetadataDto, type ApplicationSetting, type ApplicationSettings, type LayoutJSON } from "@vuu-ui/vuu-utils";
+import { ReactElement } from "react";
+import { type WorkspaceStackProps } from "./defaultWorkspaceJSON";
+export type WorkspaceProps = WorkspaceStackProps & {
+    layoutPlaceholderJSON?: LayoutJSON;
+    /**
+     * layoutJSON defines the default layout to render on first load and until such time as
+     * layout state has been persisted. After that, the persisted state will be rendered.
+     */
+    layoutJSON?: LayoutJSON | LayoutJSON[];
+    activeLayoutIndex?: number;
+    /**
+     * The Vuu workspace is the container into which layouts are loaded. By default, it will be
+     * a Tabbed Panel (Stack + Tabstrip), showing a tab per Layout.
+     */
+    workspaceJSON?: LayoutJSON | LayoutJSON[];
+};
+export interface WorkspaceProviderProps extends WorkspaceProps {
+    children: ReactElement | ReactElement[];
+    /**
+     * layoutPlaceholderJSON defines the layout to render when a new workspace layout is created.
+     */
+    layoutPlaceholderJSON?: LayoutJSON;
+}
+/**
+ * LayoutManagementProvider supplies an API for loading and saving layout documents.
+ * Initial layout is automatically loaded on startup. Because this hook is responsible
+ * only for loading and saving layouts, it only triggers a render when content is loaded.
+ *
+ * Initial layout displays a loading state
+ * User may supply a default layout. This will not be displayed until call has been made to
+ * persistenceManager to retrieve stored layout state. If no stored state is returned, the
+ * default layout provided by user will be set as current state (and hence rendered). If no
+ * default layout has been provided by user, the sysem default will be used (simple PlaceHolder)
+ * If saved layout state has been returned, that will be set as current state (and rendered)
+ *
+ */
+export declare const WorkspaceProvider: ({ TabstripProps, children, layoutJSON, activeLayoutIndex, layoutPlaceholderJSON, showTabs, workspaceJSON: customWorkspaceJSON, }: WorkspaceProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const useWorkspace: () => {
+    workspaceJSON: LayoutJSON<{
+        [key: string]: any;
+    }> | LayoutJSON<{
+        [key: string]: any;
+    }>[];
+    layoutMetadata: LayoutMetadata[];
+    layoutPlaceholderJSON?: LayoutJSON;
+    getApplicationSettings: (key?: keyof ApplicationSettings) => ApplicationSettings | ApplicationSetting | undefined;
+    loadLayoutById: (id: string) => void;
+    saveApplicationSettings: (settings: ApplicationSettings | ApplicationSetting, key?: keyof ApplicationSettings) => void;
+    saveLayout: (n: LayoutMetadataDto) => void;
+    saveApplicationLayout: (layout: LayoutJSON) => void;
+};

package/types/workspace-management/defaultWorkspaceJSON.d.ts

@@ -0,0 +1,10 @@
+import { StackProps } from "@vuu-ui/vuu-layout";
+import { LayoutJSON } from "@vuu-ui/vuu-utils";
+export type WorkspaceStackProps = Pick<StackProps, "showTabs" | "TabstripProps">;
+export declare const warningLayout: LayoutJSON;
+export declare const loadingJSON: Readonly<LayoutJSON>;
+export declare const defaultWorkspaceJSON: LayoutJSON<StackProps & {
+    preserve: boolean;
+}>;
+export declare const getStackWorkspaceJSON: (activeLayoutIndex?: number) => LayoutJSON;
+export declare const getWorkspaceWithLayoutJSON: (customWorkspaceJSON?: LayoutJSON | LayoutJSON[], layoutJSON?: LayoutJSON | LayoutJSON[], activeLayoutIndex?: number, stackProps?: WorkspaceStackProps) => LayoutJSON | LayoutJSON[];

package/types/workspace-management/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./SaveLayoutPanel";
+export * from "./LayoutList";
+export * from "./WorkspaceProvider";
+export * from "./defaultWorkspaceJSON";
+export * from "./useWorkspaceContextMenuItems";

package/types/workspace-management/screenshot-utils.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Takes a screenshot of the given node and returns the base64 encoded image url
+ * @param node HTMLElement to take screenshot of
+ * @returns Base64 encoded image url
+ */
+export declare const takeScreenshot: (node: HTMLElement) => Promise<string>;

package/types/workspace-management/useWorkspaceContextMenuItems.d.ts

@@ -0,0 +1,5 @@
+import { MenuActionHandler, MenuBuilder } from "@vuu-ui/vuu-context-menu";
+export declare const useWorkspaceContextMenuItems: () => {
+    buildMenuOptions: MenuBuilder;
+    handleMenuAction: MenuActionHandler;
+};