@vuu-ui/vuu-shell 4.0.0-alpha.25 → 4.0.0-alpha.26

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.0.0-alpha.25",
+  "version": "4.0.0-alpha.26",
   "description": "VUU UI Shell",
   "main": "./src/index.js",
   "author": "heswell",
@@ -10,26 +10,26 @@
     "type-defs": "node ../../scripts/build-type-defs.mjs"
   },
   "devDependencies": {
-    "@vuu-ui/vuu-data-types": "4.0.0-alpha.25",
-    "@vuu-ui/vuu-protocol-types": "4.0.0-alpha.25",
-    "@vuu-ui/vuu-table-types": "4.0.0-alpha.25"
+    "@vuu-ui/vuu-data-types": "4.0.0-alpha.26",
+    "@vuu-ui/vuu-protocol-types": "4.0.0-alpha.26",
+    "@vuu-ui/vuu-table-types": "4.0.0-alpha.26"
   },
   "dependencies": {
-    "@vuu-ui/grid-layout": "4.0.0-alpha.25",
+    "@vuu-ui/grid-layout": "4.0.0-alpha.26",
     "@salt-ds/core": "1.72.0",
     "@salt-ds/styles": "0.4.1",
     "@salt-ds/window": "0.1.2",
-    "@vuu-ui/vuu-context-menu": "4.0.0-alpha.25",
-    "@vuu-ui/vuu-data-react": "4.0.0-alpha.25",
-    "@vuu-ui/vuu-data-remote": "4.0.0-alpha.25",
-    "@vuu-ui/vuu-icons": "4.0.0-alpha.25",
-    "@vuu-ui/vuu-layout": "4.0.0-alpha.25",
-    "@vuu-ui/vuu-notifications": "4.0.0-alpha.25",
-    "@vuu-ui/vuu-table": "4.0.0-alpha.25",
-    "@vuu-ui/vuu-ui-controls": "4.0.0-alpha.25",
-    "@vuu-ui/vuu-utils": "4.0.0-alpha.25",
+    "@vuu-ui/vuu-context-menu": "4.0.0-alpha.26",
+    "@vuu-ui/vuu-data-react": "4.0.0-alpha.26",
+    "@vuu-ui/vuu-data-remote": "4.0.0-alpha.26",
+    "@vuu-ui/vuu-icons": "4.0.0-alpha.26",
+    "@vuu-ui/vuu-layout": "4.0.0-alpha.26",
+    "@vuu-ui/vuu-notifications": "4.0.0-alpha.26",
+    "@vuu-ui/vuu-table": "4.0.0-alpha.26",
+    "@vuu-ui/vuu-ui-controls": "4.0.0-alpha.26",
+    "@vuu-ui/vuu-utils": "4.0.0-alpha.26",
     "@module-federation/enhanced": "2.8.0",
-    "@vuu-ui/core": "4.0.0-alpha.25",
+    "@vuu-ui/core": "4.0.0-alpha.26",
     "html-to-image": "^1.11.11"
   },
   "peerDependencies": {

package/src/persistence-manager/PersistenceProvider.js

@@ -1,4 +1,5 @@
 import { jsx } from "react/jsx-runtime";
+import { WorkspacePersistenceProvider, useOptionalWorkspacePersistenceService, useWorkspacePersistenceService } from "@vuu-ui/core";
 import { createContext, useContext } from "react";
 const PersistenceContext = /*#__PURE__*/ createContext({});
 const PersistenceProvider = ({ children, persistenceManager, workspacePersistenceService })=>/*#__PURE__*/ jsx(PersistenceContext.Provider, {
@@ -6,16 +7,13 @@ const PersistenceProvider = ({ children, persistenceManager, workspacePersistenc
             persistenceManager,
             workspacePersistenceService
         },
-        children: children
+        children: /*#__PURE__*/ jsx(WorkspacePersistenceProvider, {
+            service: workspacePersistenceService,
+            children: children
+        })
     });
 const usePersistenceManager = ()=>{
     const { persistenceManager } = useContext(PersistenceContext);
     return persistenceManager;
 };
-const useWorkspacePersistenceService = ()=>{
-    const { workspacePersistenceService } = useContext(PersistenceContext);
-    if (!workspacePersistenceService) throw new Error("useWorkspacePersistenceService requires a configured PersistenceProvider");
-    return workspacePersistenceService;
-};
-const useOptionalWorkspacePersistenceService = ()=>useContext(PersistenceContext).workspacePersistenceService;
 export { PersistenceContext, PersistenceProvider, useOptionalWorkspacePersistenceService, usePersistenceManager, useWorkspacePersistenceService };

package/src/persistence-manager/index.js

@@ -3,6 +3,4 @@ export * from "./PersistenceProvider.js";
 export * from "./LocalPersistenceManager.js";
 export * from "./RemotePersistenceManager.js";
 export * from "./StaticPersistenceManager.js";
-export * from "./WorkspacePersistenceService.js";
-export * from "./LocalWorkspacePersistenceService.js";
-export * from "./RemoteWorkspacePersistenceService.js";
+export { LocalWorkspacePersistenceService, RemoteWorkspacePersistenceService, WorkspacePersistenceError } from "@vuu-ui/core";

package/src/workspace-management/LayoutList.js

@@ -4,7 +4,7 @@ import { useComponentCssInjection } from "@salt-ds/styles";
 import { useWindow } from "@salt-ds/window";
 import { IconButton } from "@vuu-ui/vuu-ui-controls";
 import clsx from "clsx";
-import { useWorkspace } from "./WorkspaceProvider.js";
+import { useWorkspace } from "@vuu-ui/core";
 import LayoutList from "./LayoutList.css";
 const classBase = "vuuLayoutList";
 const NO_SELECTION = [];

package/src/workspace-management/index.js

@@ -1,13 +1,6 @@
 export * from "./SaveLayoutPanel.js";
 export * from "./LayoutList.js";
-export * from "./WorkspaceProvider.js";
 export * from "./defaultWorkspaceJSON.js";
 export * from "./useWorkspaceContextMenuItems.js";
-export * from "./workspace-schemas.js";
-export * from "./WorkspaceRepository.js";
-export * from "./WorkspacePersistentState.js";
-export * from "./WorkspaceController.js";
-export * from "./workspace-component-registry.js";
-export * from "./WorkspaceHost.js";
-export * from "./WorkspaceStartPanel.js";
 export * from "./shell-workspace-components.js";
+export { APPLICATION_SESSION_VERSION, NAMED_WORKSPACE_DEFINITION_VERSION, StaleWorkspaceScopeError, WORKSPACE_SNAPSHOT_RECORD_VERSION, WORKSPACE_SNAPSHOT_VERSION, WorkspaceController, WorkspaceHost, WorkspacePersistentStateProvider, WorkspacePersistentStateStore, WorkspaceProvider, WorkspaceRepository, WorkspaceRepositoryDisposedError, WorkspaceStartPanel, WorkspaceValidationError, cloneWorkspaceValue, createWorkspaceComponentRegistries, emptyWorkspaceSnapshot, jsonValueWorkspaceComponentCodec, useComponentPersistentState, useWorkspace, useWorkspacePersistentStateStore, validateApplicationSessionV1, validateNamedWorkspaceDefinitionV1, validateNamedWorkspaceMetadataV1, validateWorkspaceSnapshotRecordV1, validateWorkspaceSnapshotV1, workspaceMetadata } from "@vuu-ui/core";

package/src/workspace-management/useWorkspaceContextMenuItems.js

@@ -1,8 +1,7 @@
 import { jsx } from "react/jsx-runtime";
-import { useModal } from "@vuu-ui/core";
+import { useModal, useWorkspace } from "@vuu-ui/core";
 import { useCallback, useMemo } from "react";
 import { SaveLayoutPanel } from "./SaveLayoutPanel.js";
-import { useWorkspace } from "./WorkspaceProvider.js";
 const useWorkspaceContextMenuItems = ()=>{
     const { activeWorkspace, closeWorkspace, saveActiveWorkspaceAs } = useWorkspace();
     const { showDialog, closeDialog } = useModal();

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 | import("react/jsx-runtime").JSX.Element | Iterable<React.ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | null | undefined> | null | undefined;
+}

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

@@ -1,6 +1,7 @@
+import { type WorkspacePersistenceService } from "@vuu-ui/core";
 import { type ReactElement, type ReactNode } from "react";
 import type { IPersistenceManager } from "./PersistenceManager";
-import type { WorkspacePersistenceService } from "./WorkspacePersistenceService";
+export { useOptionalWorkspacePersistenceService, useWorkspacePersistenceService, } from "@vuu-ui/core";
 export interface PersistenceContextProps {
     persistenceManager?: IPersistenceManager;
     workspacePersistenceService?: WorkspacePersistenceService;
@@ -11,5 +12,3 @@ export interface PersistenceProviderProps extends PersistenceContextProps {
 }
 export declare const PersistenceProvider: ({ children, persistenceManager, workspacePersistenceService, }: PersistenceProviderProps) => ReactElement;
 export declare const usePersistenceManager: () => IPersistenceManager | undefined;
-export declare const useWorkspacePersistenceService: () => WorkspacePersistenceService;
-export declare const useOptionalWorkspacePersistenceService: () => WorkspacePersistenceService | undefined;

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

@@ -3,6 +3,4 @@ export * from "./PersistenceProvider";
 export * from "./LocalPersistenceManager";
 export * from "./RemotePersistenceManager";
 export * from "./StaticPersistenceManager";
-export * from "./WorkspacePersistenceService";
-export * from "./LocalWorkspacePersistenceService";
-export * from "./RemoteWorkspacePersistenceService";
+export { LocalWorkspacePersistenceService, type PersistenceScope, type RemoteWorkspacePersistenceOptions, RemoteWorkspacePersistenceService, type UserPersistenceScope, WorkspacePersistenceError, type WorkspacePersistenceService, type WorkspaceRequestInitProvider, } from "@vuu-ui/core";

package/types/src/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/src/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.Element;

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

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

package/types/src/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;
+    logout?: () => void;
+    userSettings?: Settings;
+    userSettingsSchema?: SettingsSchema;
+    user: VuuUser;
+}
+export declare const ApplicationContext: import("react").Context<ApplicationContextProps>;

package/types/src/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, logout, mode, theme, userSettingsSchema: userSettingsSchema, user, }: ApplicationProviderProps) => ReactElement | null;
+export declare const useApplicationUser: () => import("@vuu-ui/vuu-utils").VuuUser;
+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;
+export declare const useLogout: () => (() => void) | undefined;

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

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

package/types/src/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>): React.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/src/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 | React.JSX.Element | Iterable<ReactNode> | Promise<string | number | bigint | boolean | Iterable<ReactNode> | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | React.ReactPortal | null | undefined> | null | undefined;
+}

package/types/src/feature/Loader.d.ts

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

package/types/src/feature/index.d.ts

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

package/types/src/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/src/feature-and-layout-provider/index.d.ts

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

package/types/src/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.Element;

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

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

package/types/src/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/src/index.d.ts

@@ -0,0 +1,14 @@
+export * from "./application-provider";
+export * from "./app-header";
+export * from "./feature";
+export * from "./feature-and-layout-provider";
+export * from "./left-nav";
+export { LoginPanel, type LoginPanelProps } from "./login/LoginPanel";
+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/src/left-nav/LeftNav.d.ts

@@ -0,0 +1,14 @@
+import { type 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.Element;

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

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

package/types/src/login/LoginPanel.d.ts

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

package/types/src/login/VuuLogo.d.ts

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

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

@@ -0,0 +1,20 @@
+import { ApplicationJSON, LayoutJSON, Settings, Layout, LayoutMetadata, LayoutMetadataDto } from "@vuu-ui/vuu-utils";
+import { IPersistenceManager } from "./PersistenceManager";
+export declare class LocalPersistenceManager implements IPersistenceManager {
+    #private;
+    constructor(userName: string, urlKey?: string);
+    clearUserSettings(): void;
+    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/src/persistence-manager/PersistenceManager.d.ts

@@ -0,0 +1,71 @@
+import type { ApplicationJSON, LayoutJSON, LayoutMetadata, LayoutMetadataDto, Settings } from "@vuu-ui/vuu-utils";
+export interface IPersistenceManager {
+    /**
+     *  Clear saved user settings/preferences. Right now, this clears ALL saved
+     * settimgs for user. We will introduce a more fine grained scheme here.
+     */
+    clearUserSettings: () => void;
+    /**
+     * 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/src/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/src/persistence-manager/RemotePersistenceManager.d.ts

@@ -0,0 +1,25 @@
+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 {
+    private userName;
+    constructor(userName: string);
+    createLayout(metadata: LayoutMetadataDto, layout: LayoutJSON): Promise<LayoutMetadata>;
+    clearUserSettings(): void;
+    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/src/persistence-manager/StaticPersistenceManager.d.ts

@@ -0,0 +1,25 @@
+import { ApplicationJSON, LayoutJSON, LayoutMetadata, Settings } from "@vuu-ui/vuu-utils";
+import { IPersistenceManager } from "./PersistenceManager";
+/**
+ * Use in Showcase examples only
+ */
+export declare class StaticPersistenceManager implements IPersistenceManager {
+    #private;
+    constructor({ applicationJSON, applicationLoadDelay, layoutMetadata, }: {
+        applicationJSON?: ApplicationJSON;
+        applicationLoadDelay?: number;
+        layoutMetadata?: LayoutMetadata[];
+    });
+    createLayout(): Promise<LayoutMetadata>;
+    clearUserSettings(): void;
+    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/src/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/src/shell-layout-templates/context-panel/ContextPanel.d.ts

@@ -0,0 +1,13 @@
+import { LayoutJSON } from "@vuu-ui/vuu-utils";
+import React, { ReactElement, ReactNode } from "react";
+export interface ContextPanelProps {
+    [key: string]: unknown;
+    className?: string;
+    content?: ReactElement | 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) => React.JSX.Element;

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

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

package/types/src/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/src/shell-layout-templates/index.d.ts

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

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

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

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

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

package/types/src/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.Element;

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

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

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

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

package/types/src/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 {};