@vuu-ui/vuu-shell 3.3.5 → 3.3.7

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.3.5",
+  "version": "3.3.7",
   "description": "VUU UI Shell",
   "main": "./src/index.js",
   "author": "heswell",
@@ -10,23 +10,23 @@
     "type-defs": "node ../../scripts/build-type-defs.mjs"
   },
   "devDependencies": {
-    "@vuu-ui/vuu-data-types": "3.3.5",
-    "@vuu-ui/vuu-protocol-types": "3.3.5",
-    "@vuu-ui/vuu-table-types": "3.3.5"
+    "@vuu-ui/vuu-data-types": "3.3.7",
+    "@vuu-ui/vuu-protocol-types": "3.3.7",
+    "@vuu-ui/vuu-table-types": "3.3.7"
   },
   "dependencies": {
     "@salt-ds/core": "1.54.1",
     "@salt-ds/styles": "0.2.1",
     "@salt-ds/window": "0.1.1",
-    "@vuu-ui/vuu-context-menu": "3.3.5",
-    "@vuu-ui/vuu-data-react": "3.3.5",
-    "@vuu-ui/vuu-data-remote": "3.3.5",
-    "@vuu-ui/vuu-icons": "3.3.5",
-    "@vuu-ui/vuu-layout": "3.3.5",
-    "@vuu-ui/vuu-notifications": "3.3.5",
-    "@vuu-ui/vuu-table": "3.3.5",
-    "@vuu-ui/vuu-ui-controls": "3.3.5",
-    "@vuu-ui/vuu-utils": "3.3.5",
+    "@vuu-ui/vuu-context-menu": "3.3.7",
+    "@vuu-ui/vuu-data-react": "3.3.7",
+    "@vuu-ui/vuu-data-remote": "3.3.7",
+    "@vuu-ui/vuu-icons": "3.3.7",
+    "@vuu-ui/vuu-layout": "3.3.7",
+    "@vuu-ui/vuu-notifications": "3.3.7",
+    "@vuu-ui/vuu-table": "3.3.7",
+    "@vuu-ui/vuu-ui-controls": "3.3.7",
+    "@vuu-ui/vuu-utils": "3.3.7",
     "html-to-image": "^1.11.11"
   },
   "peerDependencies": {

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

@@ -0,0 +1,18 @@
+import { type ApplicationSessionV1, type NamedWorkspaceDefinitionV1, type NamedWorkspaceMetadataV1, type WorkspaceSnapshotRecordV1 } from "../workspace-management/workspace-schemas";
+import type { UserPersistenceScope, WorkspacePersistenceService } from "./WorkspacePersistenceService";
+export declare class LocalWorkspacePersistenceService implements WorkspacePersistenceService {
+    #private;
+    readonly scope: UserPersistenceScope;
+    constructor(scope: UserPersistenceScope, storage?: Storage);
+    loadApplicationSession(): Promise<ApplicationSessionV1 | undefined>;
+    saveApplicationSession(session: ApplicationSessionV1): Promise<void>;
+    deleteApplicationSession(): Promise<void>;
+    listWorkspaceSnapshots(): Promise<readonly WorkspaceSnapshotRecordV1[]>;
+    loadWorkspaceSnapshot(workspaceInstanceId: string): Promise<WorkspaceSnapshotRecordV1 | undefined>;
+    saveWorkspaceSnapshot(snapshot: WorkspaceSnapshotRecordV1): Promise<void>;
+    deleteWorkspaceSnapshot(workspaceInstanceId: string): Promise<void>;
+    listNamedWorkspaceMetadata(): Promise<readonly NamedWorkspaceMetadataV1[]>;
+    loadNamedWorkspaceDefinition(id: string): Promise<NamedWorkspaceDefinitionV1 | undefined>;
+    saveNamedWorkspaceDefinition(definition: NamedWorkspaceDefinitionV1): Promise<void>;
+    deleteNamedWorkspaceDefinition(id: string): Promise<void>;
+}

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

@@ -0,0 +1,25 @@
+import { type ApplicationSessionV1, type NamedWorkspaceDefinitionV1, type NamedWorkspaceMetadataV1, type WorkspaceSnapshotRecordV1 } from "../workspace-management/workspace-schemas";
+import type { UserPersistenceScope, WorkspacePersistenceService } from "./WorkspacePersistenceService";
+export type WorkspaceRequestInitProvider = () => RequestInit | Promise<RequestInit>;
+export interface RemoteWorkspacePersistenceOptions {
+    readonly baseUrl: string;
+    readonly requestInit?: RequestInit;
+    readonly requestInitProvider?: WorkspaceRequestInitProvider;
+    readonly fetch?: typeof fetch;
+}
+export declare class RemoteWorkspacePersistenceService implements WorkspacePersistenceService {
+    #private;
+    readonly scope: UserPersistenceScope;
+    constructor(scope: UserPersistenceScope, { baseUrl, requestInit, requestInitProvider, fetch: fetchImplementation, }: RemoteWorkspacePersistenceOptions);
+    loadApplicationSession(): Promise<ApplicationSessionV1 | undefined>;
+    saveApplicationSession(session: ApplicationSessionV1): Promise<void>;
+    deleteApplicationSession(): Promise<void>;
+    listWorkspaceSnapshots(): Promise<readonly WorkspaceSnapshotRecordV1[]>;
+    loadWorkspaceSnapshot(workspaceInstanceId: string): Promise<WorkspaceSnapshotRecordV1 | undefined>;
+    saveWorkspaceSnapshot(snapshot: WorkspaceSnapshotRecordV1): Promise<void>;
+    deleteWorkspaceSnapshot(workspaceInstanceId: string): Promise<void>;
+    listNamedWorkspaceMetadata(): Promise<readonly NamedWorkspaceMetadataV1[]>;
+    loadNamedWorkspaceDefinition(id: string): Promise<NamedWorkspaceDefinitionV1 | undefined>;
+    saveNamedWorkspaceDefinition(definition: NamedWorkspaceDefinitionV1): Promise<void>;
+    deleteNamedWorkspaceDefinition(id: string): Promise<void>;
+}

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

@@ -0,0 +1,27 @@
+import type { ApplicationSessionV1, NamedWorkspaceDefinitionV1, NamedWorkspaceMetadataV1, WorkspaceSnapshotRecordV1 } from "../workspace-management/workspace-schemas";
+export interface PersistenceScope {
+    readonly applicationNamespace: string;
+    readonly applicationId: string;
+}
+export interface UserPersistenceScope extends PersistenceScope {
+    readonly userId: string;
+}
+export interface WorkspacePersistenceService {
+    readonly scope: UserPersistenceScope;
+    loadApplicationSession(): Promise<ApplicationSessionV1 | undefined>;
+    saveApplicationSession(session: ApplicationSessionV1): Promise<void>;
+    deleteApplicationSession(): Promise<void>;
+    listWorkspaceSnapshots(): Promise<readonly WorkspaceSnapshotRecordV1[]>;
+    loadWorkspaceSnapshot(workspaceInstanceId: string): Promise<WorkspaceSnapshotRecordV1 | undefined>;
+    saveWorkspaceSnapshot(snapshot: WorkspaceSnapshotRecordV1): Promise<void>;
+    deleteWorkspaceSnapshot(workspaceInstanceId: string): Promise<void>;
+    listNamedWorkspaceMetadata(): Promise<readonly NamedWorkspaceMetadataV1[]>;
+    loadNamedWorkspaceDefinition(id: string): Promise<NamedWorkspaceDefinitionV1 | undefined>;
+    saveNamedWorkspaceDefinition(definition: NamedWorkspaceDefinitionV1): Promise<void>;
+    deleteNamedWorkspaceDefinition(id: string): Promise<void>;
+}
+export declare class WorkspacePersistenceError extends Error {
+    readonly operation: string;
+    readonly status?: number | undefined;
+    constructor(message: string, operation: string, status?: number | undefined);
+}

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

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

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

@@ -0,0 +1,32 @@
+import { GridLayoutDocumentController, type GridComponentRendererRegistry, type GridComponentSettingsRegistry, type GridLayoutDocument, type GridLayoutDocumentChange } from "@heswell/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

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

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

@@ -0,0 +1,19 @@
+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/WorkspaceRepository.d.ts

@@ -0,0 +1,13 @@
+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

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

package/types/workspace-management/shell-workspace-components.d.ts

@@ -0,0 +1,2 @@
+import type { WorkspaceComponentRegistration } from "./workspace-component-registry";
+export declare const shellWorkspaceComponentRegistrations: readonly WorkspaceComponentRegistration<unknown>[];

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

@@ -0,0 +1,12 @@
+import { GridComponentRendererRegistry, GridComponentSettingsRegistry, type GridComponentRenderer, type GridComponentSettingsCodec, type JsonValue } from "@heswell/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

@@ -0,0 +1,69 @@
+import { type GridLayoutDocument, type JsonValue } from "@heswell/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;