@rozenite/storage-plugin 1.8.1 → 1.10.0

package/src/ui/panel.tsx

@@ -1,9 +1,10 @@
 import { useRozeniteDevToolsClient } from '@rozenite/plugin-bridge';
-import { useEffect, useMemo, useState } from 'react';
-import { Search, Plus } from 'lucide-react';
+import { useEffect, useMemo, useRef, useState } from 'react';
+import { Download, Plus, Search, Upload } from 'lucide-react';
 import type {
   StorageDeleteEntryEvent,
   StorageEventMap,
+  StorageImportResultEvent,
   StorageSetEntryEvent,
   StorageSnapshotEvent,
 } from '../shared/messaging';
@@ -14,10 +15,18 @@ import type {
   StorageTarget,
 } from '../shared/types';
 import { getStorageViewId } from '../shared/types';
+import {
+  buildSnapshot,
+  computePreview,
+  parseSnapshot,
+} from '../shared/snapshot';
 import { EditableTable } from './editable-table';
 import { AddEntryDialog } from './add-entry-dialog';
 import { EntryDetailDialog } from './entry-detail-dialog';
 import { EditEntryDialog } from './edit-entry-dialog';
+import { ConfirmDialog } from './confirm-dialog';
+import { ImportDialog, type ImportFlightState } from './import-dialog';
+import { buildExportFilename, downloadJson } from './utils';
 import './globals.css';
 
 type StorageSnapshotState = {
@@ -25,10 +34,22 @@ type StorageSnapshotState = {
   adapterName: string;
   storageName: string;
   capabilities: StorageCapabilities;
+  blacklist?: RegExp;
   entries: StorageEntry[];
 };
 
-const getEntryTypeFromValue = (value: StorageEntryValue): StorageEntry['type'] => {
+type AlertState = {
+  isOpen: boolean;
+  title: string;
+  message: string;
+};
+
+const sameTarget = (a: StorageTarget, b: StorageTarget) =>
+  a.adapterId === b.adapterId && a.storageId === b.storageId;
+
+const getEntryTypeFromValue = (
+  value: StorageEntryValue,
+): StorageEntry['type'] => {
   if (typeof value === 'string') {
     return 'string';
   }
@@ -46,11 +67,11 @@ const getEntryTypeFromValue = (value: StorageEntryValue): StorageEntry['type'] =
 
 export default function StoragePanel() {
   const [snapshots, setSnapshots] = useState<Map<string, StorageSnapshotState>>(
-    new Map()
-  );
-  const [selectedStorageViewId, setSelectedStorageViewId] = useState<string | null>(
-    null
+    new Map(),
   );
+  const [selectedStorageViewId, setSelectedStorageViewId] = useState<
+    string | null
+  >(null);
   const [loading, setLoading] = useState(false);
   const [searchTerm, setSearchTerm] = useState('');
   const [showAddDialog, setShowAddDialog] = useState(false);
@@ -58,6 +79,15 @@ export default function StoragePanel() {
   const [showDetailDialog, setShowDetailDialog] = useState(false);
   const [editingEntry, setEditingEntry] = useState<StorageEntry | null>(null);
   const [showEditDialog, setShowEditDialog] = useState(false);
+  const [importFlight, setImportFlight] = useState<ImportFlightState | null>(
+    null,
+  );
+  const [alertState, setAlertState] = useState<AlertState>({
+    isOpen: false,
+    title: '',
+    message: '',
+  });
+  const fileInputRef = useRef<HTMLInputElement | null>(null);
 
   const client = useRozeniteDevToolsClient<StorageEventMap>({
     pluginId: '@rozenite/storage-plugin',
@@ -71,61 +101,91 @@ export default function StoragePanel() {
     const snapshotSubscription = client.onMessage(
       'snapshot',
       (event: StorageSnapshotEvent) => {
-      const viewId = getStorageViewId(event.target);
-      setSnapshots((previous) => {
-        const next = new Map(previous);
-        next.set(viewId, {
-          target: event.target,
-          adapterName: event.adapterName,
-          storageName: event.storageName,
-          capabilities: event.capabilities,
-          entries: event.entries,
-        });
+        const viewId = getStorageViewId(event.target);
+        setSnapshots((previous) => {
+          const next = new Map(previous);
+          next.set(viewId, {
+            target: event.target,
+            adapterName: event.adapterName,
+            storageName: event.storageName,
+            capabilities: event.capabilities,
+            blacklist: event.blacklist
+              ? new RegExp(event.blacklist.source, event.blacklist.flags)
+              : undefined,
+            entries: event.entries,
+          });
 
-        if (previous.size === 0 && !selectedStorageViewId) {
-          setSelectedStorageViewId(viewId);
-        }
+          if (previous.size === 0 && !selectedStorageViewId) {
+            setSelectedStorageViewId(viewId);
+          }
 
-        return next;
-      });
+          return next;
+        });
 
-      if (viewId === selectedStorageViewId) {
-        setLoading(false);
-      }
-      }
+        if (viewId === selectedStorageViewId) {
+          setLoading(false);
+        }
+      },
     );
 
     const setEntrySubscription = client.onMessage(
       'set-entry',
       (event: StorageSetEntryEvent) => {
-      const viewId = getStorageViewId(event.target);
-      setSnapshots((previous) => {
-        const next = new Map(previous);
-        const current = next.get(viewId);
+        const viewId = getStorageViewId(event.target);
+        setSnapshots((previous) => {
+          const next = new Map(previous);
+          const current = next.get(viewId);
 
-        if (!current) {
-          return previous;
-        }
+          if (!current) {
+            return previous;
+          }
 
-        const existingIndex = current.entries.findIndex(
-          (entry) => entry.key === event.entry.key
-        );
+          const existingIndex = current.entries.findIndex(
+            (entry) => entry.key === event.entry.key,
+          );
 
-        const entries =
-          existingIndex >= 0
-            ? current.entries.map((entry) =>
-                entry.key === event.entry.key ? event.entry : entry
-              )
-            : [...current.entries, event.entry];
+          const entries =
+            existingIndex >= 0
+              ? current.entries.map((entry) =>
+                  entry.key === event.entry.key ? event.entry : entry,
+                )
+              : [...current.entries, event.entry];
 
-        next.set(viewId, {
-          ...current,
-          entries,
+          next.set(viewId, {
+            ...current,
+            entries,
+          });
+
+          return next;
         });
 
-        return next;
-      });
-      }
+        setImportFlight((previous) => {
+          if (!previous || previous.phase !== 'importing') return previous;
+          if (!sameTarget(event.target, previous.target)) return previous;
+          return { ...previous, written: previous.written + 1 };
+        });
+      },
+    );
+
+    const importResultSubscription = client.onMessage(
+      'import-result',
+      (event: StorageImportResultEvent) => {
+        setImportFlight((previous) => {
+          if (!previous || previous.phase !== 'importing') return previous;
+          if (!sameTarget(event.target, previous.target)) return previous;
+          if (event.ok) {
+            return { phase: 'result', ok: true, written: event.written };
+          }
+          return {
+            phase: 'result',
+            ok: false,
+            written: event.written,
+            total: event.total,
+            failedKey: event.failedKey,
+            error: event.error ?? 'Unknown error',
+          };
+        });
+      },
     );
 
     const deleteEntrySubscription = client.onMessage(
@@ -148,7 +208,7 @@ export default function StoragePanel() {
 
           return next;
         });
-      }
+      },
     );
 
     client.send('get-snapshot', {
@@ -160,6 +220,7 @@ export default function StoragePanel() {
       snapshotSubscription.remove();
       setEntrySubscription.remove();
       deleteEntrySubscription.remove();
+      importResultSubscription.remove();
     };
   }, [client, selectedStorageViewId]);
 
@@ -178,7 +239,7 @@ export default function StoragePanel() {
     const separatorIndex = selectedStorageViewId.indexOf(':');
     if (separatorIndex < 0) {
       console.warn(
-        `[Rozenite] Storage Plugin: Invalid storage view id "${selectedStorageViewId}".`
+        `[Rozenite] Storage Plugin: Invalid storage view id "${selectedStorageViewId}".`,
       );
       setLoading(false);
       return;
@@ -198,7 +259,7 @@ export default function StoragePanel() {
   }, [client, selectedStorageViewId, snapshots]);
 
   const selectedStorage = selectedStorageViewId
-    ? snapshots.get(selectedStorageViewId) ?? null
+    ? (snapshots.get(selectedStorageViewId) ?? null)
     : null;
 
   const entries = selectedStorage?.entries ?? [];
@@ -206,15 +267,15 @@ export default function StoragePanel() {
   const filteredEntries = useMemo(
     () =>
       entries.filter((entry) =>
-        entry.key.toLowerCase().includes(searchTerm.toLowerCase())
+        entry.key.toLowerCase().includes(searchTerm.toLowerCase()),
       ),
-    [entries, searchTerm]
+    [entries, searchTerm],
   );
 
   const supportedTypes = selectedStorage?.capabilities.supportedTypes ?? [];
 
   const updateEntriesForSelectedStorage = (
-    mutate: (entries: StorageEntry[]) => StorageEntry[]
+    mutate: (entries: StorageEntry[]) => StorageEntry[],
   ) => {
     if (!selectedStorageViewId) {
       return;
@@ -266,7 +327,7 @@ export default function StoragePanel() {
     });
 
     updateEntriesForSelectedStorage((currentEntries) =>
-      currentEntries.map((entry) => (entry.key === key ? updatedEntry : entry))
+      currentEntries.map((entry) => (entry.key === key ? updatedEntry : entry)),
     );
   };
 
@@ -282,7 +343,7 @@ export default function StoragePanel() {
     });
 
     updateEntriesForSelectedStorage((currentEntries) =>
-      currentEntries.filter((entry) => entry.key !== key)
+      currentEntries.filter((entry) => entry.key !== key),
     );
   };
 
@@ -297,7 +358,105 @@ export default function StoragePanel() {
       entry,
     });
 
-    updateEntriesForSelectedStorage((currentEntries) => [...currentEntries, entry]);
+    updateEntriesForSelectedStorage((currentEntries) => [
+      ...currentEntries,
+      entry,
+    ]);
+  };
+
+  const showAlert = (title: string, message: string) =>
+    setAlertState({ isOpen: true, title, message });
+
+  const handleImportClick = () => {
+    if (!fileInputRef.current) return;
+    fileInputRef.current.value = '';
+    fileInputRef.current.click();
+  };
+
+  const handleFileChange = async (
+    event: React.ChangeEvent<HTMLInputElement>,
+  ) => {
+    const file = event.target.files?.[0];
+    if (!file || !selectedStorage) {
+      return;
+    }
+
+    let raw: unknown;
+    try {
+      const text = await file.text();
+      raw = JSON.parse(text);
+    } catch (parseError) {
+      showAlert(
+        'Could not read file',
+        parseError instanceof Error ? parseError.message : String(parseError),
+      );
+      return;
+    }
+
+    const parsed = parseSnapshot(raw);
+    if (!parsed.ok) {
+      showAlert(
+        'Invalid snapshot',
+        `${parsed.error.path}: ${parsed.error.message}`,
+      );
+      return;
+    }
+
+    const preview = computePreview(parsed.snapshot, {
+      target: selectedStorage.target,
+      capabilities: selectedStorage.capabilities,
+      entryKeys: new Set(selectedStorage.entries.map((entry) => entry.key)),
+      isBlacklisted: selectedStorage.blacklist
+        ? (key) => selectedStorage.blacklist!.test(key)
+        : () => false,
+    });
+
+    const skippedSet = new Set(preview.skippedKeys.map((s) => s.key));
+    const unsupportedSet = new Set(preview.unsupportedTypes.map((u) => u.key));
+    const entriesToWrite = parsed.snapshot.entries.filter(
+      (entry) => !skippedSet.has(entry.key) && !unsupportedSet.has(entry.key),
+    );
+
+    setImportFlight({
+      phase: 'preview',
+      target: selectedStorage.target,
+      targetLabel: `${selectedStorage.adapterName} / ${selectedStorage.storageName}`,
+      snapshot: parsed.snapshot,
+      preview,
+      entriesToWrite,
+    });
+  };
+
+  const handleApplyImport = () => {
+    if (!client) return;
+    if (!importFlight || importFlight.phase !== 'preview') return;
+
+    client.send('import-entries', {
+      type: 'import-entries',
+      target: importFlight.target,
+      entries: importFlight.entriesToWrite,
+    });
+
+    setImportFlight({
+      phase: 'importing',
+      target: importFlight.target,
+      total: importFlight.entriesToWrite.length,
+      written: 0,
+    });
+  };
+
+  const handleCloseImport = () => setImportFlight(null);
+
+  const handleExport = () => {
+    if (!selectedStorage) return;
+    const snapshot = buildSnapshot({
+      target: selectedStorage.target,
+      adapterName: selectedStorage.adapterName,
+      storageName: selectedStorage.storageName,
+      capabilities: selectedStorage.capabilities,
+      entries: selectedStorage.entries,
+    });
+    downloadJson(snapshot, buildExportFilename(selectedStorage.target));
   };
 
   const storageOptions = [...snapshots.entries()].map(([viewId, snapshot]) => ({
@@ -346,6 +505,31 @@ export default function StoragePanel() {
           <Plus className="h-3 w-3" />
           Add Entry
         </button>
+        <button
+          onClick={handleImportClick}
+          disabled={!selectedStorage}
+          className="flex items-center gap-1 px-3 h-8 text-xs bg-gray-700 hover:bg-gray-600 disabled:bg-gray-800 disabled:cursor-not-allowed text-gray-100 rounded transition-colors"
+          title="Import entries from a JSON snapshot"
+        >
+          <Upload className="h-3 w-3" />
+          Import
+        </button>
+        <button
+          onClick={handleExport}
+          disabled={!selectedStorage || entries.length === 0}
+          className="flex items-center gap-1 px-3 h-8 text-xs bg-gray-700 hover:bg-gray-600 disabled:bg-gray-800 disabled:cursor-not-allowed text-gray-100 rounded transition-colors"
+          title="Export entries to a JSON snapshot"
+        >
+          <Download className="h-3 w-3" />
+          Export
+        </button>
+        <input
+          ref={fileInputRef}
+          type="file"
+          accept="application/json,.json"
+          className="hidden"
+          onChange={handleFileChange}
+        />
         <div className="flex-1">
           <div className="relative">
             <Search className="absolute left-2 top-1/2 transform -translate-y-1/2 h-4 w-4 text-gray-400" />
@@ -437,6 +621,22 @@ export default function StoragePanel() {
         supportedTypes={supportedTypes}
         entry={editingEntry}
       />
+
+      <ImportDialog
+        state={importFlight}
+        onApply={handleApplyImport}
+        onCancel={handleCloseImport}
+        onClose={handleCloseImport}
+      />
+
+      <ConfirmDialog
+        isOpen={alertState.isOpen}
+        onClose={() => setAlertState((prev) => ({ ...prev, isOpen: false }))}
+        onConfirm={() => setAlertState((prev) => ({ ...prev, isOpen: false }))}
+        title={alertState.title}
+        message={alertState.message}
+        type="alert"
+      />
     </div>
   );
 }

package/src/ui/type-conversion.ts

@@ -0,0 +1,105 @@
+import type { StorageEntryType, StorageEntryValue } from '../shared/types';
+
+const textEncoder = new TextEncoder();
+const strictDecoder = new TextDecoder('utf-8', { fatal: true });
+
+// Decode bytes to a string. Returns the empty string when the bytes
+// are not valid UTF-8 — used when the user switches a Hex editor's
+// non-UTF-8 buffer back to a text editor, where there's no faithful
+// representation to preserve.
+const tryDecode = (bytes: readonly number[]): string => {
+  try {
+    return strictDecoder.decode(new Uint8Array(bytes));
+  } catch {
+    return '';
+  }
+};
+
+const encode = (value: string): number[] =>
+  Array.from(textEncoder.encode(value));
+
+// Convert a value between storage primitive types for the editor
+// switcher. The headline transition is `string` ↔ `buffer`, which
+// round-trips via UTF-8 — the user opens a string entry, picks Hex,
+// and sees the bytes of that string. Other transitions preserve as
+// much information as the destination type can carry, falling back to
+// the destination's zero value when nothing meaningful remains.
+export const convertValue = (
+  from: StorageEntryType,
+  to: StorageEntryType,
+  value: StorageEntryValue,
+): StorageEntryValue => {
+  if (from === to) return value;
+
+  if (from === 'string') {
+    const str = value as string;
+    switch (to) {
+      case 'number': {
+        const n = Number(str);
+        return Number.isNaN(n) ? 0 : n;
+      }
+      case 'boolean':
+        return str === 'true';
+      case 'buffer':
+        return encode(str);
+    }
+  }
+
+  if (from === 'number') {
+    const n = value as number;
+    switch (to) {
+      case 'string':
+        return String(n);
+      case 'boolean':
+        return n !== 0;
+      case 'buffer':
+        return encode(String(n));
+    }
+  }
+
+  if (from === 'boolean') {
+    const b = value as boolean;
+    switch (to) {
+      case 'string':
+        return String(b);
+      case 'number':
+        return b ? 1 : 0;
+      case 'buffer':
+        return encode(String(b));
+    }
+  }
+
+  if (from === 'buffer') {
+    const bytes = value as number[];
+    switch (to) {
+      case 'string':
+        return tryDecode(bytes);
+      case 'number': {
+        const decoded = tryDecode(bytes);
+        const n = Number(decoded);
+        return Number.isNaN(n) ? 0 : n;
+      }
+      case 'boolean':
+        return tryDecode(bytes) === 'true';
+    }
+  }
+
+  return value;
+};
+
+// Zero value for a type — used when seeding the add-entry dialog and
+// when conversion has no meaningful starting point.
+export const defaultValueForType = (
+  type: StorageEntryType,
+): StorageEntryValue => {
+  switch (type) {
+    case 'string':
+      return '';
+    case 'number':
+      return 0;
+    case 'boolean':
+      return false;
+    case 'buffer':
+      return [];
+  }
+};

package/src/ui/typed-value-editor.tsx

@@ -0,0 +1,96 @@
+import type { StorageEntryType, StorageEntryValue } from '../shared/types';
+import { BinaryValueEditor } from './binary-value-editor';
+import { EditorSwitcher } from './editor-switcher';
+import { convertValue, defaultValueForType } from './type-conversion';
+
+export type TypedValueEditorProps = {
+  supportedTypes: StorageEntryType[];
+  type: StorageEntryType;
+  // `null` signals "the current input is unsavable" — used by the hex
+  // editor for unparseable hex or empty input. Non-buffer types never
+  // emit null. Callers should disable Save when value is null.
+  value: StorageEntryValue | null;
+  onChange: (type: StorageEntryType, value: StorageEntryValue | null) => void;
+  // `id` is forwarded to the underlying input so callers can wire up
+  // <label htmlFor>. The hex editor (which has no single input) ignores
+  // it — there's no useful target.
+  inputId?: string;
+  autoFocus?: boolean;
+};
+
+// Renders the switcher + the type-specific value editor. Switching
+// type runs `convertValue` so the user lands on a sensible starting
+// point in the new editor instead of an empty field.
+export const TypedValueEditor = ({
+  supportedTypes,
+  type,
+  value,
+  onChange,
+  inputId,
+  autoFocus,
+}: TypedValueEditorProps) => {
+  const handleTypeChange = (newType: StorageEntryType) => {
+    if (newType === type) return;
+    if (value === null) {
+      // Source value is currently unparseable — nothing meaningful to
+      // carry forward, land on the destination type's default.
+      onChange(newType, defaultValueForType(newType));
+      return;
+    }
+    onChange(newType, convertValue(type, newType, value));
+  };
+
+  return (
+    <div className="space-y-2">
+      <EditorSwitcher
+        supportedTypes={supportedTypes}
+        value={type}
+        onChange={handleTypeChange}
+      />
+
+      {type === 'buffer' ? (
+        <BinaryValueEditor
+          initialBytes={Array.isArray(value) ? value : undefined}
+          onChange={(bytes) => onChange('buffer', bytes)}
+        />
+      ) : type === 'boolean' ? (
+        <select
+          id={inputId}
+          value={String(value ?? false)}
+          onChange={(event) =>
+            onChange('boolean', event.target.value === 'true')
+          }
+          className="w-full px-3 py-2 text-sm bg-gray-700 border border-gray-600 rounded text-gray-100 focus:outline-none focus:ring-2 focus:ring-blue-500"
+          autoFocus={autoFocus}
+        >
+          <option value="true">true</option>
+          <option value="false">false</option>
+        </select>
+      ) : type === 'number' ? (
+        <input
+          id={inputId}
+          type="number"
+          value={String(value ?? '')}
+          onChange={(event) => {
+            const next = event.target.value;
+            const parsed = next === '' ? 0 : Number(next);
+            onChange('number', Number.isNaN(parsed) ? 0 : parsed);
+          }}
+          placeholder="Enter number value"
+          className="w-full px-3 py-2 text-sm bg-gray-700 border border-gray-600 rounded text-gray-100 placeholder:text-gray-400 focus:outline-none focus:ring-2 focus:ring-blue-500"
+          autoFocus={autoFocus}
+        />
+      ) : (
+        <input
+          id={inputId}
+          type="text"
+          value={String(value ?? '')}
+          onChange={(event) => onChange('string', event.target.value)}
+          placeholder="Enter string value"
+          className="w-full px-3 py-2 text-sm bg-gray-700 border border-gray-600 rounded text-gray-100 placeholder:text-gray-400 focus:outline-none focus:ring-2 focus:ring-blue-500"
+          autoFocus={autoFocus}
+        />
+      )}
+    </div>
+  );
+};

package/src/ui/utils.ts

@@ -0,0 +1,30 @@
+import type { StorageTarget } from '../shared/types';
+
+export const downloadJson = (data: unknown, filename: string): void => {
+  const json = JSON.stringify(data, null, 2);
+  const blob = new Blob([json], { type: 'application/json' });
+  const url = URL.createObjectURL(blob);
+  const link = document.createElement('a');
+  link.href = url;
+  link.download = filename;
+  document.body.appendChild(link);
+  link.click();
+  document.body.removeChild(link);
+  URL.revokeObjectURL(url);
+};
+
+const sanitize = (value: string) => value.replace(/[^a-zA-Z0-9_-]/g, '-');
+
+export const buildExportFilename = (
+  target: StorageTarget,
+  now: Date = new Date(),
+): string => {
+  const yyyy = now.getFullYear().toString().padStart(4, '0');
+  const mm = (now.getMonth() + 1).toString().padStart(2, '0');
+  const dd = now.getDate().toString().padStart(2, '0');
+  const hh = now.getHours().toString().padStart(2, '0');
+  const mi = now.getMinutes().toString().padStart(2, '0');
+  const ss = now.getSeconds().toString().padStart(2, '0');
+  const timestamp = `${yyyy}${mm}${dd}-${hh}${mi}${ss}`;
+  return `rozenite-storage-${sanitize(target.adapterId)}-${sanitize(target.storageId)}-${timestamp}.json`;
+};