@vuu-ui/vuu-shell 0.0.26

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

@@ -0,0 +1,55 @@
+import { ApplicationJSON, LayoutJSON } from "@vuu-ui/vuu-layout";
+import { LayoutMetadata, LayoutMetadataDto } from "../layout-management";
+export interface PersistenceManager {
+    /**
+     * 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>;
+    /**
+     * 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>;
+}

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

@@ -0,0 +1,22 @@
+import { PersistenceManager } from "./PersistenceManager";
+import { ApplicationJSON, LayoutJSON } from "@vuu-ui/vuu-layout";
+import { LayoutMetadata, LayoutMetadataDto } from "../layout-management";
+export type CreateLayoutResponseDto = {
+    metadata: LayoutMetadata;
+};
+export type GetLayoutResponseDto = {
+    definition: LayoutJSON;
+};
+export type GetApplicationResponseDto = {
+    definition: ApplicationJSON;
+};
+export declare class RemotePersistenceManager implements PersistenceManager {
+    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>;
+}

package/types/persistence-management/defaultApplicationJson.d.ts

@@ -0,0 +1,4 @@
+import { ApplicationJSON, LayoutJSON } from "@vuu-ui/vuu-layout";
+export declare const warningLayout: LayoutJSON;
+export declare const loadingApplicationJson: Readonly<ApplicationJSON>;
+export declare const defaultApplicationJson: ApplicationJSON;

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

@@ -0,0 +1,4 @@
+export * from "./defaultApplicationJson";
+export * from "./PersistenceManager";
+export * from "./LocalPersistenceManager";
+export * from "./RemotePersistenceManager";

package/types/session-editing-form/SessionEditingForm.d.ts

@@ -0,0 +1,24 @@
+import { DataSource, TableSchema } from "@vuu-ui/vuu-data-types";
+import { VuuColumnDataType } from "@vuu-ui/vuu-protocol-types";
+import { HTMLAttributes } from "react";
+export type FormFieldDescriptor = {
+    isKeyField?: boolean;
+    label?: string;
+    name: string;
+    type: VuuColumnDataType;
+    description: string;
+    readonly?: boolean;
+    required?: boolean;
+};
+export type FormConfig = {
+    title: string;
+    key: string;
+    fields: FormFieldDescriptor[];
+};
+export interface SessionEditingFormProps extends HTMLAttributes<HTMLDivElement> {
+    config: FormConfig;
+    onClose: () => void;
+    dataSource?: DataSource;
+    schema?: TableSchema;
+}
+export declare const SessionEditingForm: ({ className, config: { fields, key: keyField }, dataSource: dataSourceProp, id: idProp, onClose, schema, ...htmlAttributes }: SessionEditingFormProps) => JSX.Element;

package/types/session-editing-form/index.d.ts

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

package/types/shell-layouts/context-panel/ContextPanel.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { LayoutJSON } from "@vuu-ui/vuu-layout";
+export interface ContextPanelProps {
+    [key: string]: unknown;
+    className?: string;
+    content?: LayoutJSON;
+    expanded?: boolean;
+    overlay?: boolean;
+}
+export declare const ContextPanel: ({ className: classNameProp, expanded, content: contentProp, overlay, title, }: ContextPanelProps) => JSX.Element;

package/types/shell-layouts/context-panel/index.d.ts

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

package/types/shell-layouts/index.d.ts

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

package/types/shell-layouts/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) => JSX.Element;

package/types/shell-layouts/side-panel/index.d.ts

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

package/types/shell-layouts/useFullHeightLeftPanel.d.ts

@@ -0,0 +1,3 @@
+import { ReactElement } from "react";
+import { ShellLayoutProps } from "./useShellLayout";
+export declare const useFullHeightLeftPanel: ({ appHeader, LeftSidePanelProps, }: ShellLayoutProps) => ReactElement;

package/types/shell-layouts/useInlayLeftPanel.d.ts

@@ -0,0 +1,3 @@
+import { ReactElement } from "react";
+import { ShellLayoutProps } from "./useShellLayout";
+export declare const useInlayLeftPanel: ({ appHeader, LeftSidePanelProps, }: ShellLayoutProps) => ReactElement;

package/types/shell-layouts/useShellLayout.d.ts

@@ -0,0 +1,10 @@
+import { ReactElement } from "react";
+import { ShellProps } from "../shell";
+export type ShellLayoutType = "full-height" | "inlay";
+export interface ShellLayoutProps {
+    LeftSidePanelProps: ShellProps["LeftSidePanelProps"];
+    appHeader: ReactElement;
+}
+export declare const useShellLayout: ({ leftSidePanelLayout, ...props }: ShellLayoutProps & {
+    leftSidePanelLayout?: "full-height" | "inlay" | undefined;
+}) => ReactElement<any, string | import("react").JSXElementConstructor<any>>;

package/types/shell.d.ts

@@ -0,0 +1,21 @@
+import { LayoutProviderProps } from "@vuu-ui/vuu-layout";
+import { HTMLAttributes, ReactNode } from "react";
+import { SidePanelProps } from "./shell-layouts";
+import { SaveLocation } from "./shellTypes";
+export type VuuUser = {
+    username: string;
+    token: string;
+};
+export type LayoutTemplateName = "full-height" | "inlay";
+export interface ShellProps extends HTMLAttributes<HTMLDivElement> {
+    LayoutProps?: Pick<LayoutProviderProps, "createNewChild" | "pathToDropTarget">;
+    LeftSidePanelProps?: SidePanelProps;
+    children?: ReactNode;
+    leftSidePanelLayout?: "full-height" | "inlay";
+    loginUrl?: string;
+    saveLocation?: SaveLocation;
+    saveUrl?: string;
+    serverUrl?: string;
+    user: VuuUser;
+}
+export declare const Shell: ({ LayoutProps, LeftSidePanelProps, children, className: classNameProp, leftSidePanelLayout, loginUrl, saveLocation: _, saveUrl, serverUrl, user, ...htmlAttributes }: ShellProps) => JSX.Element | null;

package/types/shellTypes.d.ts

@@ -0,0 +1,29 @@
+import type { VuuTable } from "@vuu-ui/vuu-protocol-types";
+import type { ViewProps } from "@vuu-ui/vuu-layout";
+declare global {
+    const vuuConfig: Promise<VuuConfig>;
+}
+export type SaveLocation = "local" | "remote";
+export interface FeatureConfig {
+    name: string;
+    title: string;
+    url: string;
+    css?: string;
+    leftNavLocation: "vuu-features" | "vuu-tables";
+    featureProps?: {
+        schema?: "*" | VuuTable;
+        schemas?: VuuTable[];
+        ViewProps?: Partial<ViewProps>;
+    };
+}
+export type Features = {
+    [key: string]: FeatureConfig;
+};
+export interface VuuConfig {
+    features: Features;
+    authUrl?: string;
+    websocketUrl: string;
+    ssl: boolean;
+}
+export declare const isWildcardSchema: (schema?: "*" | VuuTable) => schema is "*";
+export declare const isTableSchema: (schema?: "*" | VuuTable) => schema is VuuTable;

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) => 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<{}>>;