@vuu-ui/vuu-shell 4.0.1 → 5.0.0-alpha.1

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

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

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

@@ -1,32 +0,0 @@
-import { GridLayoutDocumentController, type GridComponentRendererRegistry, type GridComponentSettingsRegistry, type GridLayoutDocument, type GridLayoutDocumentChange } from "@vuu-ui/grid-layout";
-import type { WorkspacePersistenceService } from "../persistence-manager";
-import { WorkspacePersistentStateStore } from "./WorkspacePersistentState";
-import { WorkspaceRepository } from "./WorkspaceRepository";
-import { type WorkspaceSnapshotV1 } from "./workspace-schemas";
-export interface WorkspaceControllerOptions {
-    readonly definitionId?: string;
-    readonly instanceId: string;
-    name: string;
-    readonly onError: (error: Error) => void;
-    readonly renderers: GridComponentRendererRegistry;
-    readonly service: WorkspacePersistenceService;
-    readonly settingsCodecs: GridComponentSettingsRegistry;
-    readonly snapshot: WorkspaceSnapshotV1;
-    readonly revision?: number;
-}
-export declare class WorkspaceController {
-    #private;
-    readonly definitionId?: string;
-    readonly documentController: GridLayoutDocumentController;
-    readonly instanceId: string;
-    name: string;
-    readonly persistentState: WorkspacePersistentStateStore;
-    readonly renderers: GridComponentRendererRegistry;
-    readonly repository: WorkspaceRepository;
-    readonly settingsCodecs: GridComponentSettingsRegistry;
-    constructor(options: WorkspaceControllerOptions);
-    get snapshot(): WorkspaceSnapshotV1;
-    handleDocumentChange: (document: GridLayoutDocument, change: GridLayoutDocumentChange) => void;
-    rename(name: string): void;
-    dispose(): Promise<void>;
-}

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

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

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

@@ -1,19 +0,0 @@
-import { type ReactElement, type ReactNode } from "react";
-import { type ComponentPersistentStateV1 } from "./workspace-schemas";
-export type ComponentStateUpdate = ComponentPersistentStateV1 | ((current: ComponentPersistentStateV1 | undefined) => ComponentPersistentStateV1);
-export declare class WorkspacePersistentStateStore {
-    #private;
-    constructor(initialState?: Readonly<Record<string, ComponentPersistentStateV1>>);
-    getSnapshot: () => Readonly<Record<string, ComponentPersistentStateV1>>;
-    subscribe: (listener: () => void) => (() => void);
-    get(componentInstanceId: string): ComponentPersistentStateV1 | undefined;
-    update(componentInstanceId: string, update: ComponentStateUpdate): void;
-    purge(componentInstanceId?: string): void;
-}
-export interface WorkspacePersistentStateProviderProps {
-    readonly children: ReactNode;
-    readonly store: WorkspacePersistentStateStore;
-}
-export declare const WorkspacePersistentStateProvider: ({ children, store, }: WorkspacePersistentStateProviderProps) => ReactElement;
-export declare const useWorkspacePersistentStateStore: () => WorkspacePersistentStateStore;
-export declare const useComponentPersistentState: (componentInstanceId: string) => readonly [ComponentPersistentStateV1 | undefined, (update: ComponentStateUpdate) => void, () => void];

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

@@ -1,52 +0,0 @@
-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: () => {
-    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;
-    workspaceJSON: LayoutJSON<{
-        [key: string]: any;
-    }>[] | LayoutJSON<{
-        [key: string]: any;
-    }>;
-};

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

@@ -1,13 +0,0 @@
-import type { WorkspacePersistenceService } from "../persistence-manager";
-import { type WorkspaceSnapshotRecordV1, type WorkspaceSnapshotV1 } from "./workspace-schemas";
-export declare class WorkspaceRepositoryDisposedError extends Error {
-    constructor();
-}
-export declare class WorkspaceRepository {
-    #private;
-    constructor(service: WorkspacePersistenceService, workspaceInstanceId: string, initial?: WorkspaceSnapshotRecordV1);
-    get current(): WorkspaceSnapshotRecordV1 | undefined;
-    load(): Promise<WorkspaceSnapshotRecordV1 | undefined>;
-    save(snapshot: WorkspaceSnapshotV1): Promise<WorkspaceSnapshotRecordV1>;
-    dispose(): Promise<void>;
-}

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

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

package/types/workspace-management/workspace-component-registry.d.ts

@@ -1,12 +0,0 @@
-import { GridComponentRendererRegistry, GridComponentSettingsRegistry, type GridComponentRenderer, type GridComponentSettingsCodec, type JsonValue } from "@vuu-ui/grid-layout";
-export interface WorkspaceComponentRegistration<T> {
-    readonly codec: GridComponentSettingsCodec<T>;
-    readonly render: GridComponentRenderer<T>;
-    readonly type: string;
-}
-export interface WorkspaceComponentRegistries {
-    readonly renderers: GridComponentRendererRegistry;
-    readonly settingsCodecs: GridComponentSettingsRegistry;
-}
-export declare const createWorkspaceComponentRegistries: <T>(registrations: readonly WorkspaceComponentRegistration<T>[]) => WorkspaceComponentRegistries;
-export declare const jsonValueWorkspaceComponentCodec: GridComponentSettingsCodec<JsonValue>;

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

@@ -1,69 +0,0 @@
-import { type GridLayoutDocument, type JsonValue } from "@vuu-ui/grid-layout";
-export declare const WORKSPACE_SNAPSHOT_VERSION = 1;
-export declare const APPLICATION_SESSION_VERSION = 1;
-export declare const NAMED_WORKSPACE_DEFINITION_VERSION = 1;
-export declare const WORKSPACE_SNAPSHOT_RECORD_VERSION = 1;
-export interface ComponentPersistentStateV1 {
-    readonly componentType: string;
-    readonly schemaVersion: number;
-    readonly value: JsonValue;
-}
-export interface WorkspaceSnapshotV1 {
-    readonly version: typeof WORKSPACE_SNAPSHOT_VERSION;
-    readonly layout: GridLayoutDocument;
-    readonly componentState: Readonly<Record<string, ComponentPersistentStateV1>>;
-}
-export interface OpenWorkspaceInstanceV1 {
-    readonly instanceId: string;
-    readonly definitionId?: string;
-    readonly title?: string;
-    readonly snapshotId: string;
-}
-export interface ApplicationSessionV1 {
-    readonly version: typeof APPLICATION_SESSION_VERSION;
-    readonly openWorkspaces: readonly OpenWorkspaceInstanceV1[];
-    readonly workspaceOrder: readonly string[];
-    readonly activeWorkspaceInstanceId: string | null;
-    readonly settings: Readonly<Record<string, JsonValue>>;
-}
-export interface NamedWorkspaceDefinitionV1 {
-    readonly version: typeof NAMED_WORKSPACE_DEFINITION_VERSION;
-    readonly id: string;
-    readonly name: string;
-    readonly description?: string;
-    readonly createdAt: string;
-    readonly updatedAt: string;
-    readonly snapshot: WorkspaceSnapshotV1;
-}
-export interface NamedWorkspaceMetadataV1 {
-    readonly version: typeof NAMED_WORKSPACE_DEFINITION_VERSION;
-    readonly id: string;
-    readonly name: string;
-    readonly description?: string;
-    readonly createdAt: string;
-    readonly updatedAt: string;
-}
-export interface WorkspaceSnapshotRecordV1 {
-    readonly version: typeof WORKSPACE_SNAPSHOT_RECORD_VERSION;
-    readonly workspaceInstanceId: string;
-    readonly revision: number;
-    readonly snapshot: WorkspaceSnapshotV1;
-}
-export type WorkspaceSchemaName = "WorkspaceSnapshotV1" | "ApplicationSessionV1" | "NamedWorkspaceDefinitionV1" | "NamedWorkspaceMetadataV1" | "WorkspaceSnapshotRecordV1";
-export interface WorkspaceValidationIssue {
-    readonly code: "INVALID_JSON_VALUE" | "INVALID_VALUE" | "UNEXPECTED_FIELD" | "UNSUPPORTED_VERSION";
-    readonly message: string;
-    readonly path: string;
-}
-export declare class WorkspaceValidationError extends Error {
-    readonly schema: WorkspaceSchemaName;
-    readonly issues: readonly WorkspaceValidationIssue[];
-    constructor(schema: WorkspaceSchemaName, issues: readonly WorkspaceValidationIssue[]);
-}
-export declare const validateWorkspaceSnapshotV1: (value: unknown) => WorkspaceSnapshotV1;
-export declare const validateApplicationSessionV1: (value: unknown) => ApplicationSessionV1;
-export declare const validateNamedWorkspaceDefinitionV1: (value: unknown) => NamedWorkspaceDefinitionV1;
-export declare const validateNamedWorkspaceMetadataV1: (value: unknown) => NamedWorkspaceMetadataV1;
-export declare const validateWorkspaceSnapshotRecordV1: (value: unknown) => WorkspaceSnapshotRecordV1;
-export declare const workspaceMetadata: (definition: NamedWorkspaceDefinitionV1) => NamedWorkspaceMetadataV1;
-export declare const cloneWorkspaceValue: <T>(value: T) => T;