@object-ui/plugin-designer 3.3.2 → 3.4.0

package/dist/packages/plugin-designer/src/components/HistoryPanel.d.ts

@@ -0,0 +1,42 @@
+import { UndoRedoState } from '../hooks/useUndoRedo';
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import * as React from 'react';
+export interface HistoryPanelProps<T> {
+    /** The undo/redo state returned by `useUndoRedo` / `useDesignerHistory`. */
+    history: UndoRedoState<T>;
+    /**
+     * Render each entry's label. Receives the entry itself, its index in the
+     * combined `[past, current, future]` timeline, and a relative position
+     * (`-N` for past, `0` for current, `+N` for future).
+     */
+    renderLabel?: (entry: T, index: number, position: number) => React.ReactNode;
+    /** Optional title shown at the top of the panel. */
+    title?: string;
+    /** Compact / minimal mode hides the title and action buttons. */
+    compact?: boolean;
+    className?: string;
+}
+/**
+ * Visual timeline of recent operations, paired with `useUndoRedo`.
+ *
+ * Renders the combined past + current + future stack as a vertical list. Each
+ * entry is clickable and jumps the underlying state via `history.jumpTo()`.
+ * The current entry is highlighted; future entries are dimmed to show that
+ * they will be re-applied if selected.
+ *
+ * Example:
+ * ```tsx
+ * const history = useDesignerHistory(initialDraft, { persistKey: 'designer' });
+ * <HistoryPanel
+ *   history={history}
+ *   renderLabel={(draft, idx) => `Step ${idx + 1}: ${draft.lastAction ?? 'edit'}`}
+ * />
+ * ```
+ */
+export declare function HistoryPanel<T>({ history, renderLabel, title, compact, className, }: HistoryPanelProps<T>): import("react/jsx-runtime").JSX.Element;

package/dist/packages/plugin-designer/src/components/index.d.ts

@@ -13,3 +13,5 @@ export { PropertyEditor } from './PropertyEditor';
 export type { PropertyEditorProps, PropertyField } from './PropertyEditor';
 export { VersionHistory } from './VersionHistory';
 export type { VersionHistoryProps, VersionEntry } from './VersionHistory';
+export { HistoryPanel } from './HistoryPanel';
+export type { HistoryPanelProps } from './HistoryPanel';

package/dist/packages/plugin-designer/src/hooks/useUndoRedo.d.ts

@@ -8,6 +8,23 @@
 export interface UndoRedoOptions {
     /** Maximum history size */
     maxHistory?: number;
+    /**
+     * When set, the history stack (past + current + future) is persisted to
+     * `sessionStorage` under this key and rehydrated on the next mount. Use a
+     * key that is unique per draft (e.g. `designer:draft:${draftId}`) so two
+     * tabs editing different drafts never overwrite each other.
+     */
+    persistKey?: string;
+    /**
+     * Storage backend. Defaults to `sessionStorage` (per-tab). Pass
+     * `localStorage` for cross-tab persistence, or your own implementation for
+     * tests / electron / mobile bridges.
+     */
+    storage?: {
+        getItem(k: string): string | null;
+        setItem(k: string, v: string): void;
+        removeItem(k: string): void;
+    };
 }
 export interface UndoRedoState<T> {
     /** Current state */
@@ -20,6 +37,14 @@ export interface UndoRedoState<T> {
     undoCount: number;
     /** Number of redo steps available */
     redoCount: number;
+    /**
+     * Snapshot of the full timeline as `[...past, current, ...future]`. The
+     * UI <HistoryPanel/> renders this as a vertical list so users can see
+     * (and jump to) any previous checkpoint.
+     */
+    timeline: T[];
+    /** Index of `current` within `timeline`. */
+    currentIndex: number;
     /** Push a new state (clears redo stack) */
     push: (state: T) => void;
     /** Undo to previous state */
@@ -28,9 +53,22 @@ export interface UndoRedoState<T> {
     redo: () => void;
     /** Reset to initial state, clearing all history */
     reset: (state: T) => void;
+    /**
+     * Jump directly to a specific timeline index. Equivalent to N undo() or
+     * redo() calls, but performed atomically so re-renders only fire once.
+     */
+    jumpTo: (index: number) => void;
+    /**
+     * Drop persisted history from the configured storage backend. Useful when
+     * the underlying draft is deleted or after a successful save.
+     */
+    clearPersisted: () => void;
 }
 /**
  * Hook for undo/redo functionality using command pattern with state history.
  * Maintains a stack of past states and future states for undo/redo operations.
+ *
+ * Pass `persistKey` to keep the stack alive across page reloads — the designer
+ * history survives a refresh, so users don't lose their unsaved progress.
  */
 export declare function useUndoRedo<T>(initialState: T, options?: UndoRedoOptions): UndoRedoState<T>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@object-ui/plugin-designer",
-  "version": "3.3.2",
+  "version": "3.4.0",
   "type": "module",
   "license": "MIT",
   "description": "Visual designer plugin for Object UI with page, data model, process, and report designers plus collaborative editing.",
@@ -30,17 +30,17 @@
     "@dnd-kit/sortable": "^10.0.0",
     "@dnd-kit/utilities": "^3.2.2",
     "clsx": "^2.1.1",
-    "lucide-react": "^1.8.0",
+    "lucide-react": "^1.14.0",
     "sonner": "^2.0.7",
     "tailwind-merge": "^3.5.0",
-    "@object-ui/components": "3.3.2",
-    "@object-ui/core": "3.3.2",
-    "@object-ui/fields": "3.3.2",
-    "@object-ui/i18n": "3.3.2",
-    "@object-ui/plugin-form": "3.3.2",
-    "@object-ui/plugin-grid": "3.3.2",
-    "@object-ui/react": "3.3.2",
-    "@object-ui/types": "3.3.2"
+    "@object-ui/core": "3.4.0",
+    "@object-ui/components": "3.4.0",
+    "@object-ui/i18n": "3.4.0",
+    "@object-ui/plugin-grid": "3.4.0",
+    "@object-ui/plugin-form": "3.4.0",
+    "@object-ui/fields": "3.4.0",
+    "@object-ui/types": "3.4.0",
+    "@object-ui/react": "3.4.0"
   },
   "devDependencies": {
     "@types/node": "^25.6.0",
@@ -48,7 +48,7 @@
     "@types/react-dom": "19.2.3",
     "@vitejs/plugin-react": "^6.0.1",
     "vite": "^8.0.10",
-    "vite-plugin-dts": "^4.5.4",
+    "vite-plugin-dts": "^5.0.0",
     "vitest": "^4.1.5"
   },
   "keywords": [