@workbench-kit/shell-react 0.0.2-prototype.0.2.33 → 0.0.2-prototype.0.2.35

package/src/field-remap/preview-controller.ts

@@ -0,0 +1,122 @@
+import {
+  convertMappedInputs,
+  isAbortError,
+  type ConvertMappedInputsInput,
+  type ConvertToShapeResult,
+} from '@workbench-kit/field-remap';
+
+import type { FieldRemapPreviewState } from './preview.js';
+
+export type FieldRemapPreviewCommand =
+  | { readonly kind: 'hidden' }
+  | { readonly kind: 'no-sample' }
+  | {
+      readonly kind: 'evaluate';
+      /** Stable signature of every durable input, including transform implementations. */
+      readonly revision: string;
+      readonly input: Omit<ConvertMappedInputsInput, 'signal'>;
+    };
+
+type FieldRemapPreviewEvaluator = (
+  input: ConvertMappedInputsInput,
+) => Promise<ConvertToShapeResult>;
+
+export interface FieldRemapPreviewController {
+  readonly getSnapshot: () => FieldRemapPreviewState;
+  readonly subscribe: (listener: () => void) => () => void;
+  readonly update: (command: FieldRemapPreviewCommand) => void;
+  readonly dispose: () => void;
+}
+
+/** Package-private execution owner. Public Flow surfaces consume only its snapshot. */
+export function createFieldRemapPreviewController(
+  evaluate: FieldRemapPreviewEvaluator = convertMappedInputs,
+): FieldRemapPreviewController {
+  let snapshot: FieldRemapPreviewState = {
+    status: 'unavailable',
+    reason: 'no-sample',
+  };
+  let generation = 0;
+  let disposed = false;
+  let abortController: AbortController | undefined;
+  let activeRevision: string | undefined;
+  const listeners = new Set<() => void>();
+
+  const publish = (next: FieldRemapPreviewState): void => {
+    if (disposed) {
+      return;
+    }
+    snapshot = next;
+    for (const listener of listeners) {
+      listener();
+    }
+  };
+
+  return {
+    getSnapshot: () => snapshot,
+    subscribe: (listener) => {
+      if (disposed) {
+        return () => {};
+      }
+      listeners.add(listener);
+      return () => listeners.delete(listener);
+    },
+    update: (command) => {
+      if (disposed) {
+        return;
+      }
+      if (command.kind === 'evaluate' && command.revision === activeRevision) {
+        return;
+      }
+
+      abortController?.abort();
+      generation += 1;
+      const currentGeneration = generation;
+      abortController = undefined;
+
+      if (command.kind !== 'evaluate') {
+        activeRevision = undefined;
+        publish({ status: 'unavailable', reason: command.kind });
+        return;
+      }
+
+      activeRevision = command.revision;
+      const controller = new AbortController();
+      abortController = controller;
+      publish({ status: 'loading' });
+
+      void evaluate({ ...command.input, signal: controller.signal })
+        .then((result) => {
+          if (disposed || controller.signal.aborted || currentGeneration !== generation) {
+            return;
+          }
+          publish({ status: 'ready', result });
+        })
+        .catch((error: unknown) => {
+          if (
+            disposed ||
+            controller.signal.aborted ||
+            currentGeneration !== generation ||
+            isAbortError(error)
+          ) {
+            return;
+          }
+          publish({
+            status: 'error',
+            message: error instanceof Error ? error.message : String(error),
+          });
+        });
+    },
+    dispose: () => {
+      if (disposed) {
+        return;
+      }
+      disposed = true;
+      generation += 1;
+      abortController?.abort();
+      abortController = undefined;
+      activeRevision = undefined;
+      listeners.clear();
+    },
+  };
+}

package/src/field-remap/preview.tsx

@@ -0,0 +1,171 @@
+import { useMemo, type JSX } from 'react';
+import type { ConvertToShapeResult, MappingEdge } from '@workbench-kit/field-remap';
+
+import { defaultFieldRemapChromeLabels, type FieldRemapChromeLabels } from './chrome-labels.js';
+import type { FieldRemapSelection } from './flow-ops.js';
+
+export type FieldRemapPreviewState =
+  | {
+      readonly status: 'unavailable';
+      readonly reason: 'hidden' | 'no-sample';
+    }
+  | { readonly status: 'loading' }
+  | {
+      readonly status: 'ready';
+      readonly result: ConvertToShapeResult;
+    }
+  | {
+      readonly status: 'error';
+      readonly message: string;
+    };
+
+export type FieldRemapPreviewProjection =
+  | FieldRemapPreviewState
+  | {
+      readonly status: 'unsupported';
+      readonly reason: 'draft' | 'stale-selection';
+    }
+  | {
+      readonly status: 'value';
+      readonly scope: 'binding' | 'document';
+      readonly value: unknown;
+      readonly notice?: 'operator-intermediate' | 'transform-step-intermediate';
+    };
+
+export function resolveFieldRemapPreviewProjection(
+  preview: FieldRemapPreviewState,
+  selection: FieldRemapSelection,
+  edges: readonly MappingEdge[],
+  operatorExists: boolean,
+): FieldRemapPreviewProjection {
+  if (preview.status !== 'ready') {
+    return preview;
+  }
+  if (!selection) {
+    return { status: 'value', scope: 'document', value: preview.result.output };
+  }
+  if (selection.kind === 'draft') {
+    return { status: 'unsupported', reason: 'draft' };
+  }
+  if (selection.kind === 'operator') {
+    return operatorExists
+      ? {
+          status: 'value',
+          scope: 'document',
+          value: preview.result.output,
+          notice: 'operator-intermediate',
+        }
+      : { status: 'unsupported', reason: 'stale-selection' };
+  }
+
+  const edge = edges.find((item) => item.id === selection.edgeId);
+  if (!edge) {
+    return { status: 'unsupported', reason: 'stale-selection' };
+  }
+  if (
+    selection.kind === 'transformStep' &&
+    (selection.stepIndex < 0 || selection.stepIndex >= (edge.transformIds?.length ?? 0))
+  ) {
+    return { status: 'unsupported', reason: 'stale-selection' };
+  }
+
+  const slot = preview.result.slots.find((item) => item.edgeId === edge.id);
+  if (!slot) {
+    return { status: 'unsupported', reason: 'stale-selection' };
+  }
+  return {
+    status: 'value',
+    scope: 'binding',
+    value: slot.value,
+    ...(selection.kind === 'transformStep'
+      ? { notice: 'transform-step-intermediate' as const }
+      : {}),
+  };
+}
+
+function previewLabel(labels: FieldRemapChromeLabels, key: keyof FieldRemapChromeLabels): string {
+  return labels[key] ?? defaultFieldRemapChromeLabels[key];
+}
+
+function formatPreviewValue(value: unknown): string {
+  try {
+    return JSON.stringify(value, null, 2) ?? String(value);
+  } catch {
+    return String(value);
+  }
+}
+
+export interface FieldRemapPreviewRailProps {
+  readonly preview: FieldRemapPreviewState;
+  readonly selection: FieldRemapSelection;
+  readonly edges: readonly MappingEdge[];
+  readonly operatorExists: boolean;
+  readonly labels: FieldRemapChromeLabels;
+}
+
+export function FieldRemapPreviewRail({
+  preview,
+  selection,
+  edges,
+  operatorExists,
+  labels,
+}: FieldRemapPreviewRailProps): JSX.Element {
+  const projection = useMemo(
+    () => resolveFieldRemapPreviewProjection(preview, selection, edges, operatorExists),
+    [edges, operatorExists, preview, selection],
+  );
+
+  return (
+    <aside
+      className="workbench-field-remap-preview"
+      data-testid="field-remap-preview"
+      aria-label={previewLabel(labels, 'previewTitle')}
+    >
+      <h4>{previewLabel(labels, 'previewTitle')}</h4>
+      {projection.status === 'loading' ? (
+        <p role="status" data-testid="field-remap-preview-loading">
+          {previewLabel(labels, 'previewLoading')}
+        </p>
+      ) : null}
+      {projection.status === 'error' ? (
+        <p role="alert" data-testid="field-remap-preview-error">
+          {previewLabel(labels, 'previewError')}: {projection.message}
+        </p>
+      ) : null}
+      {projection.status === 'unsupported' ? (
+        <p role="status" data-testid="field-remap-preview-unavailable">
+          {previewLabel(
+            labels,
+            projection.reason === 'draft'
+              ? 'previewDraftUnavailable'
+              : 'previewSelectionUnavailable',
+          )}
+        </p>
+      ) : null}
+      {projection.status === 'value' ? (
+        <>
+          <p className="workbench-field-remap-preview__scope">
+            {previewLabel(
+              labels,
+              projection.scope === 'binding' ? 'previewBindingResult' : 'previewDocumentResult',
+            )}
+          </p>
+          {projection.notice ? (
+            <p
+              className="workbench-field-remap-preview__notice"
+              data-testid="field-remap-preview-notice"
+            >
+              {previewLabel(
+                labels,
+                projection.notice === 'transform-step-intermediate'
+                  ? 'previewStepIntermediateUnavailable'
+                  : 'previewOperatorIntermediateUnavailable',
+              )}
+            </p>
+          ) : null}
+          <pre data-testid="field-remap-preview-value">{formatPreviewValue(projection.value)}</pre>
+        </>
+      ) : null}
+    </aside>
+  );
+}

package/src/field-remap/view.css

@@ -345,6 +345,7 @@
 .workbench-field-remap-flow[data-chrome='embed'] .workbench-field-remap-convert-palette,
 .workbench-field-remap-flow[data-chrome='embed'] .workbench-field-remap-flow__canvas,
 .workbench-field-remap-flow[data-chrome='embed'] .workbench-field-remap-detail,
+.workbench-field-remap-flow[data-chrome='embed'] .workbench-field-remap-preview,
 .workbench-field-remap-flow[data-chrome='embed'] .workbench-field-remap-convert-note {
   border-radius: 0;
 }
@@ -359,6 +360,7 @@
 }
 
 .workbench-field-remap-flow[data-chrome='embed'] .workbench-field-remap-detail,
+.workbench-field-remap-flow[data-chrome='embed'] .workbench-field-remap-preview,
 .workbench-field-remap-flow[data-chrome='embed'] .workbench-field-remap-convert-note {
   border: 0;
   border-inline-start: 1px solid var(--vscode-panel-border, var(--color-border));
@@ -374,6 +376,9 @@
 .workbench-field-remap-flow[data-chrome='embed']
   .workbench-field-remap-flow__workspace--split
   .workbench-field-remap-detail,
+.workbench-field-remap-flow[data-chrome='embed']
+  .workbench-field-remap-flow__workspace--split
+  .workbench-field-remap-preview,
 .workbench-field-remap-flow[data-chrome='embed']
   .workbench-field-remap-flow__workspace--split
   .workbench-field-remap-convert-note {
@@ -401,6 +406,7 @@
   }
 
   .workbench-field-remap-flow[data-chrome='embed'] .workbench-field-remap-detail,
+  .workbench-field-remap-flow[data-chrome='embed'] .workbench-field-remap-preview,
   .workbench-field-remap-flow[data-chrome='embed'] .workbench-field-remap-convert-note {
     border-inline-start: 0;
     border-block-start: 1px solid var(--vscode-panel-border, var(--color-border));
@@ -439,6 +445,7 @@
 }
 
 .workbench-field-remap-convert-palette__header,
+.workbench-field-remap-convert-palette__filter,
 .workbench-field-remap-convert-palette__place,
 .workbench-field-remap-convert-palette__operators {
   flex: 0 0 auto;
@@ -457,6 +464,14 @@
   font-size: 0.7rem;
 }
 
+.workbench-field-remap-convert-palette__empty {
+  flex: 1 1 auto;
+  margin: 0;
+  padding: 0.35rem;
+  font-size: 0.75rem;
+  color: var(--vscode-descriptionForeground, var(--color-text-muted));
+}
+
 .workbench-field-remap-convert-palette__operators {
   display: flex;
   flex-direction: column;
@@ -773,6 +788,63 @@
   font-size: 0.8rem;
 }
 
+.workbench-field-remap-flow__side-rail {
+  display: flex;
+  flex-direction: column;
+  min-width: 0;
+  min-height: 0;
+  height: 100%;
+  overflow: auto;
+}
+
+.workbench-field-remap-preview {
+  display: flex;
+  flex-direction: column;
+  gap: 0.6rem;
+  min-width: 0;
+  padding: 0.75rem;
+  border: 1px solid var(--vscode-panel-border, var(--color-border));
+  border-radius: 0.375rem;
+  background: var(--vscode-editor-background, var(--color-bg));
+  color: var(--vscode-foreground, var(--color-text));
+  font-size: 0.8rem;
+}
+
+.workbench-field-remap-flow__side-rail > .workbench-field-remap-preview:not(:first-child) {
+  border-block-start: 0;
+  border-start-start-radius: 0;
+  border-start-end-radius: 0;
+}
+
+.workbench-field-remap-preview h4,
+.workbench-field-remap-preview p {
+  margin: 0;
+}
+
+.workbench-field-remap-preview h4 {
+  font-size: 0.85rem;
+}
+
+.workbench-field-remap-preview__scope,
+.workbench-field-remap-preview__notice {
+  color: var(--vscode-descriptionForeground, var(--color-text-muted));
+}
+
+.workbench-field-remap-preview pre {
+  box-sizing: border-box;
+  max-height: 16rem;
+  margin: 0;
+  padding: 0.6rem;
+  overflow: auto;
+  border: 1px solid var(--vscode-panel-border, var(--color-border));
+  border-radius: 0.25rem;
+  background: var(--vscode-textCodeBlock-background, var(--color-surface));
+  color: inherit;
+  font: 0.75rem/1.45 var(--vscode-editor-font-family, ui-monospace, monospace);
+  white-space: pre-wrap;
+  word-break: break-word;
+}
+
 .workbench-field-remap-convert-note {
   border-color: var(--vscode-focusBorder, var(--color-accent, #3794ff));
   background: var(--vscode-editor-background, var(--color-bg));

package/src/index.ts

@@ -4,7 +4,12 @@ export {
   WorkbenchProvider,
   useWorkbench,
   type WorkbenchContextValue,
+  type WorkbenchExtensionActivationAccess,
+  type WorkbenchExtensionActivationStateReader,
+  type WorkbenchExtensionCatalogReader,
   type WorkbenchProviderProps,
+  type WorkbenchSettingsCapabilityPublication,
+  type WorkbenchSettingsCapabilityPublisher,
   type WorkbenchStorageAdapter,
   type WorkbenchWorkspaceHostPort,
 } from './shell/provider.js';
@@ -99,12 +104,20 @@ export {
   type SampleJdwWidgetPreviewRenderData,
 } from './jdw/document-view-data.js';
 export { SampleFieldRemapDemo, type SampleFieldRemapDemoProps } from './field-remap/demo.js';
-export { FieldRemapPanel, type FieldRemapPanelProps } from './field-remap/panel.js';
+export {
+  FieldRemapPanel,
+  type FieldRemapHistoryActions,
+  type FieldRemapHistoryAvailability,
+  type FieldRemapHistoryOwner,
+  type FieldRemapHistorySnapshot,
+  type FieldRemapPanelProps,
+} from './field-remap/panel.js';
 export {
   FieldRemapFlowMapper,
   type FieldRemapFlowActions,
   type FieldRemapFlowMapperProps,
 } from './field-remap/flow.js';
+export type { FieldRemapPreviewState } from './field-remap/preview.js';
 export {
   defaultFieldRemapChromeLabels,
   fieldRemapChromeLabelKeys,
@@ -206,6 +219,8 @@ export {
 export {
   WorkbenchShell,
   type WorkbenchLocaleOption,
+  type WorkbenchShellCommandHostProps,
+  type WorkbenchShellCommandRunContext,
   type WorkbenchShellProps,
   type WorkbenchThemeOption,
 } from './shell/shell.js';

package/src/management/keybinding-overrides-storage.ts

@@ -3,14 +3,19 @@ import {
   type WorkbenchKeybindingDefinition,
 } from '@workbench-kit/workbench-config';
 import {
+  type WorkbenchPersistenceDiagnosticOptions,
+  type WorkbenchPersistenceReadResult,
+  type WorkbenchPersistenceWriteResult,
   type WorkbenchStorageReader,
   type WorkbenchStorageWriter,
 } from '@workbench-kit/workbench-core';
 
 import {
   readLocalJsonStorage,
+  readLocalJsonStorageResult,
   resolveLocalWorkbenchStorage,
   writeLocalJsonStorage,
+  writeLocalJsonStorageResult,
 } from '../storage/local-json-storage.js';
 
 export const DEFAULT_WORKBENCH_KEYBINDING_STORAGE_KEY = 'workbench-kit/.workbench/keybindings';
@@ -26,6 +31,20 @@ export function readPersistedKeybindingOverrides(
   return readLocalJsonStorage(storageKey, parseWorkbenchKeybindingsConfig, () => [], storage);
 }
 
+export function readPersistedKeybindingOverridesResult(
+  storageKey = DEFAULT_WORKBENCH_KEYBINDING_STORAGE_KEY,
+  storage?: WorkbenchStorageReader,
+  options: WorkbenchPersistenceDiagnosticOptions = {},
+): WorkbenchPersistenceReadResult<readonly WorkbenchKeybindingDefinition[]> {
+  return readLocalJsonStorageResult(
+    storageKey,
+    parseWorkbenchKeybindingsConfig,
+    () => [],
+    storage,
+    options,
+  );
+}
+
 export function writePersistedKeybindingOverrides(
   overrides: readonly WorkbenchKeybindingDefinition[],
   storageKey = DEFAULT_WORKBENCH_KEYBINDING_STORAGE_KEY,
@@ -33,3 +52,12 @@ export function writePersistedKeybindingOverrides(
 ): void {
   writeLocalJsonStorage(storageKey, overrides, storage, { errorMode: 'throw' });
 }
+
+export function writePersistedKeybindingOverridesResult(
+  overrides: readonly WorkbenchKeybindingDefinition[],
+  storageKey = DEFAULT_WORKBENCH_KEYBINDING_STORAGE_KEY,
+  storage?: WorkbenchStorageWriter,
+  options: WorkbenchPersistenceDiagnosticOptions = {},
+): WorkbenchPersistenceWriteResult {
+  return writeLocalJsonStorageResult(storageKey, overrides, storage, options);
+}

package/src/management/preference-settings-storage.ts

@@ -3,14 +3,19 @@ import {
   type WorkbenchSettingsConfig,
 } from '@workbench-kit/workbench-config';
 import {
+  type WorkbenchPersistenceDiagnosticOptions,
+  type WorkbenchPersistenceReadResult,
+  type WorkbenchPersistenceWriteResult,
   type WorkbenchStorageReader,
   type WorkbenchStorageWriter,
 } from '@workbench-kit/workbench-core';
 
 import {
   readLocalJsonStorage,
+  readLocalJsonStorageResult,
   resolveLocalWorkbenchStorage,
   writeLocalJsonStorage,
+  writeLocalJsonStorageResult,
 } from '../storage/local-json-storage.js';
 
 export const DEFAULT_WORKBENCH_LOCAL_PREFERENCE_STORAGE_KEY =
@@ -27,6 +32,20 @@ export function readPersistedLocalPreferences(
   return readLocalJsonStorage(storageKey, parseWorkbenchSettingsConfig, () => ({}), storage);
 }
 
+export function readPersistedLocalPreferencesResult(
+  storageKey = DEFAULT_WORKBENCH_LOCAL_PREFERENCE_STORAGE_KEY,
+  storage?: WorkbenchStorageReader,
+  options: WorkbenchPersistenceDiagnosticOptions = {},
+): WorkbenchPersistenceReadResult<WorkbenchSettingsConfig> {
+  return readLocalJsonStorageResult(
+    storageKey,
+    parseWorkbenchSettingsConfig,
+    () => ({}),
+    storage,
+    options,
+  );
+}
+
 export function writePersistedLocalPreferences(
   values: WorkbenchSettingsConfig,
   storageKey = DEFAULT_WORKBENCH_LOCAL_PREFERENCE_STORAGE_KEY,
@@ -34,3 +53,12 @@ export function writePersistedLocalPreferences(
 ): void {
   writeLocalJsonStorage(storageKey, values, storage, { errorMode: 'throw' });
 }
+
+export function writePersistedLocalPreferencesResult(
+  values: WorkbenchSettingsConfig,
+  storageKey = DEFAULT_WORKBENCH_LOCAL_PREFERENCE_STORAGE_KEY,
+  storage?: WorkbenchStorageWriter,
+  options: WorkbenchPersistenceDiagnosticOptions = {},
+): WorkbenchPersistenceWriteResult {
+  return writeLocalJsonStorageResult(storageKey, values, storage, options);
+}

package/src/management/settings.tsx

@@ -55,6 +55,7 @@ export function WorkbenchExtensionManagementSettings({
     installTrustRecords,
     rememberInstallTrust,
     toggleInstalledEntry,
+    uninstallInstalledEntry,
   } = useExtensionManagementModel({ catalogTrustPolicy, catalogUrl });
 
   const isInstallTrusted = useCallback(
@@ -77,6 +78,7 @@ export function WorkbenchExtensionManagementSettings({
       onInstall={installCatalogEntry}
       onRememberInstallTrust={rememberInstallTrust}
       onToggleEnabled={toggleInstalledEntry}
+      onUninstall={uninstallInstalledEntry}
     />
   );
 }