@contentful/experience-design-system-cli 2.33.1-dev-build-5dce9a6.0 → 2.33.1-dev-build-c4ed223.0

package/dist/src/import/tui/hooks/useReviewEditor.d.ts

@@ -0,0 +1,49 @@
+import { type Dispatch, type SetStateAction } from 'react';
+import { type TokenPropSuggestion, type TokenReviewToken } from '../../../analyze/select/tui/components/TokenReviewPanel.js';
+import type { CdfReviewEntry } from './useReviewSession.js';
+export type ReviewPanel = 'none' | 'prop-rationale' | 'component-rationale' | 'source' | 'token-review';
+type UseReviewEditorOptions = {
+    components: CdfReviewEntry[];
+    selectedIdx: number;
+    extractSessionId: string;
+    availableTokens: TokenReviewToken[];
+    setComponents: Dispatch<SetStateAction<CdfReviewEntry[]>>;
+    pushHistorySnapshot: (entries: CdfReviewEntry[], label: string) => void;
+    onEditSaved: (entries: CdfReviewEntry[]) => void;
+    onTokenSaved: (entries: CdfReviewEntry[]) => void;
+};
+export type UseReviewEditorResult = {
+    panelOpen: ReviewPanel;
+    setPanelOpen: Dispatch<SetStateAction<ReviewPanel>>;
+    panelScrollOffset: number;
+    setPanelScrollOffset: Dispatch<SetStateAction<number>>;
+    jsonScrollOffset: number;
+    setJsonScrollOffset: Dispatch<SetStateAction<number>>;
+    textEntryActive: boolean;
+    setTextEntryActive: Dispatch<SetStateAction<boolean>>;
+    showJson: boolean;
+    setShowJson: Dispatch<SetStateAction<boolean>>;
+    showHiddenProps: boolean;
+    setShowHiddenProps: Dispatch<SetStateAction<boolean>>;
+    draftValue: string;
+    setDraftValue: Dispatch<SetStateAction<string>>;
+    saveError: string | null;
+    setSaveError: Dispatch<SetStateAction<string | null>>;
+    tokenReviewRow: number;
+    setTokenReviewRow: Dispatch<SetStateAction<number>>;
+    tokenReviewEditing: boolean;
+    setTokenReviewEditing: Dispatch<SetStateAction<boolean>>;
+    tokenReviewEditCursor: number;
+    setTokenReviewEditCursor: Dispatch<SetStateAction<number>>;
+    tokenReviewEditSelection: Set<string>;
+    setTokenReviewEditSelection: Dispatch<SetStateAction<Set<string>>>;
+    pendingGRef: {
+        current: boolean;
+    };
+    currentTokenSuggestions: () => TokenPropSuggestion[];
+    handleEditSave: () => void;
+    handleEditDiscard: () => void;
+    handleTokenEditSave: (suggestion: TokenPropSuggestion) => void;
+};
+export declare function useReviewEditor({ components, selectedIdx, extractSessionId, availableTokens, setComponents, pushHistorySnapshot, onEditSaved, onTokenSaved, }: UseReviewEditorOptions): UseReviewEditorResult;
+export {};

package/dist/src/import/tui/hooks/useReviewPreview.d.ts

@@ -0,0 +1,26 @@
+import type { ComponentTypeSummary, ServerPreviewResponse } from '@contentful/experience-design-system-types';
+import type { PreviewAnnotation } from '../../../analyze/select/types.js';
+import { type UseLivePreviewReturn } from '../useLivePreview.js';
+export type UseReviewPreviewOptions = {
+    components: ReadonlyArray<{
+        key: string;
+    }>;
+    loading: boolean;
+    livePreview: boolean;
+    sessionId: string;
+    tokensPath: string;
+    spaceId: string;
+    environmentId: string;
+    cmaToken: string;
+    host: string;
+    deleteAllComponents?: boolean;
+    allowDeletions?: boolean;
+    onResult?: (response: ServerPreviewResponse) => void;
+};
+export type UseReviewPreviewResult = {
+    previewAnnotations: Map<string, PreviewAnnotation>;
+    removedComponents: ComponentTypeSummary[];
+    livePreviewHook: UseLivePreviewReturn;
+    livePreviewSpinner: string;
+};
+export declare function useReviewPreview({ components, loading, livePreview, sessionId, tokensPath, spaceId, environmentId, cmaToken, host, deleteAllComponents, allowDeletions, onResult, }: UseReviewPreviewOptions): UseReviewPreviewResult;

package/dist/src/import/tui/hooks/useReviewSession.d.ts

@@ -0,0 +1,74 @@
+import type { DatabaseSync } from 'node:sqlite';
+import { type Dispatch, type SetStateAction } from 'react';
+import type { CDFComponentEntry } from '@contentful/experience-design-system-types';
+import { type ComponentRationale, type ComponentReviewMetadata } from '../../../session/db.js';
+import { type TokenReviewToken } from '../../../analyze/select/tui/components/TokenReviewPanel.js';
+import type { ReviewComponentStatus } from '../../../analyze/select/types.js';
+import { type HistorySnapshot } from '../history.js';
+export type CdfReviewEntry = {
+    key: string;
+    entry: CDFComponentEntry;
+    status: ReviewComponentStatus;
+};
+export type ReviewSessionLoadResult<TExtra = undefined> = {
+    entries: CdfReviewEntry[];
+    tokens: TokenReviewToken[];
+    error: string | null;
+    extra?: TExtra;
+};
+export type ReviewSessionLoaderOptions<TExtra = undefined> = {
+    extractSessionId: string;
+    tokenSessionId?: string | null;
+    loadExtra?: (db: DatabaseSync, sessionId: string) => TExtra;
+    sortEntries: (entries: CdfReviewEntry[], extra: TExtra | undefined) => CdfReviewEntry[];
+};
+export declare function loadReviewSessionState<TExtra = undefined>({ extractSessionId, tokenSessionId, loadExtra, sortEntries, }: ReviewSessionLoaderOptions<TExtra>): ReviewSessionLoadResult<TExtra>;
+type UseReviewSessionOptions<TExtra> = {
+    loadSession: () => ReviewSessionLoadResult<TExtra>;
+    tokensPath?: string;
+    onExtraLoaded?: (extra: TExtra | undefined) => void;
+};
+type UseReviewSessionResult<TExtra> = {
+    components: CdfReviewEntry[];
+    setComponents: Dispatch<SetStateAction<CdfReviewEntry[]>>;
+    loading: boolean;
+    loadError: string | null;
+    availableTokens: TokenReviewToken[];
+    reloadFromSave: () => ReviewSessionLoadResult<TExtra> | null;
+};
+export declare function useReviewSession<TExtra = undefined>({ loadSession, tokensPath, onExtraLoaded, }: UseReviewSessionOptions<TExtra>): UseReviewSessionResult<TExtra>;
+type UseReviewMetadataOptions = {
+    components: CdfReviewEntry[];
+    selectedIdx: number;
+    extractSessionId: string;
+};
+export declare function useReviewMetadata({ components, selectedIdx, extractSessionId }: UseReviewMetadataOptions): {
+    reviewMetadata: ComponentReviewMetadata | null;
+    componentRationale: ComponentRationale | null;
+};
+export declare function createReviewHistorySnapshot(components: CdfReviewEntry[], options?: {
+    autoRejected?: readonly string[];
+    undoSnapshot?: ReadonlyMap<string, ReviewComponentStatus> | null;
+}): HistorySnapshot;
+type UseReviewHistoryOptions = {
+    loading: boolean;
+    components: CdfReviewEntry[];
+    createSnapshot: (components: CdfReviewEntry[]) => HistorySnapshot;
+    applySnapshot: (snapshot: HistorySnapshot) => void;
+};
+export declare function useReviewHistory({ loading, components, createSnapshot, applySnapshot }: UseReviewHistoryOptions): {
+    historySeededRef: {
+        current: boolean;
+    };
+    pushHistorySnapshot: (entries: CdfReviewEntry[], label: string) => void;
+    handleUndo: () => void;
+    handleRedo: () => void;
+    resetHistory: (snapshot: HistorySnapshot) => void;
+};
+export type ReviewFinalizeCounts = {
+    accepted: number;
+    rejected: number;
+    unresolved: number;
+};
+export declare function finalizeReviewSession(extractSessionId: string, components: CdfReviewEntry[]): ReviewFinalizeCounts;
+export {};

package/dist/src/import/tui/hooks/useReviewSurfaceState.d.ts

@@ -0,0 +1,12 @@
+import { type Dispatch, type SetStateAction } from 'react';
+export type UseReviewSurfaceStateResult = {
+    sidebarFocused: boolean;
+    setSidebarFocused: Dispatch<SetStateAction<boolean>>;
+    showFinalize: boolean;
+    setShowFinalize: Dispatch<SetStateAction<boolean>>;
+    showQuit: boolean;
+    setShowQuit: Dispatch<SetStateAction<boolean>>;
+    finalizeError: string | null;
+    setFinalizeError: Dispatch<SetStateAction<string | null>>;
+};
+export declare function useReviewSurfaceState(initialFinalizeError?: string | null): UseReviewSurfaceStateResult;

package/dist/src/import/tui/lineage-input.d.ts

@@ -0,0 +1,18 @@
+import type { LineageJumpable } from './hooks/useLineage.js';
+type LineageInputKey = {
+    upArrow: boolean;
+    downArrow: boolean;
+    tab: boolean;
+    return: boolean;
+};
+export declare function handleLineageNavigation({ input, key, cursor, jumpables, onCursorChange, onJump, onClose, allowTab, }: {
+    input: string;
+    key: LineageInputKey;
+    cursor: number;
+    jumpables: LineageJumpable[];
+    onCursorChange: (update: number | ((current: number) => number)) => void;
+    onJump: (name: string) => void;
+    onClose: () => void;
+    allowTab: boolean;
+}): boolean;
+export {};

package/dist/src/import/tui/preview-confirmation-input.d.ts

@@ -0,0 +1,6 @@
+import { type Dispatch, type SetStateAction } from 'react';
+type PreviewConfirmationKey = {
+    return: boolean;
+};
+export declare function usePreviewConfirmationInput(breakingWithImpact: boolean, allowDeletions: boolean, fetchedAllowDeletions: boolean, removedCount: number, onConfirm: (acknowledge: boolean, allowDeletions: boolean) => void, setAllowDeletions: Dispatch<SetStateAction<boolean>>): (input: string, key: PreviewConfirmationKey) => boolean;
+export {};

package/dist/src/import/tui/review-step-props.d.ts

@@ -0,0 +1,14 @@
+export type ReviewStepProps = {
+    extractSessionId: string;
+    tokenSessionId?: string | null;
+    onFinalize: (accepted: number, rejected: number, unresolved: number) => void;
+    onQuit: () => void;
+    livePreview?: boolean;
+    spaceId?: string;
+    environmentId?: string;
+    cmaToken?: string;
+    host?: string;
+    tokensPath?: string;
+    initialFinalizeError?: string | null;
+    allowDeletions?: boolean;
+};

package/dist/src/import/tui/scope-gate-columns.d.ts

@@ -4,7 +4,6 @@ export interface ScopeComponentLike {
     name: string;
 }
 export type Decision = 'accepted' | 'rejected' | 'undecided';
-export declare const THREE_COLUMN_MIN_WIDTH = 120;
 export declare function computeColumnWidths(totalWidth: number): {
     layout: 'single' | 'three-column';
     main: number;

package/dist/src/import/tui/scope-gate-host.d.ts

@@ -2,7 +2,7 @@ import React from 'react';
 import type { ScopeComponent } from './steps/ScopeGateStep.js';
 import type { CompositionMode } from '../../lib/composition-mode.js';
 export type { ScopeComponent };
-export type AutoFilterStatus = 'idle' | 'running' | 'complete' | 'cancelled' | 'failed';
+type AutoFilterStatus = 'idle' | 'running' | 'complete' | 'cancelled' | 'failed';
 export type ScopeGateHostProps = {
     components: ReadonlyArray<ScopeComponent>;
     autoAccept: boolean;

package/dist/src/import/tui/sidebar-help.d.ts

@@ -0,0 +1,2 @@
+import type { HelpSection } from '../../analyze/select/tui/components/HelpOverlay.js';
+export declare function createSidebarViewsHelpSection(includeBreaking: boolean): HelpSection;

package/dist/src/import/tui/sidebar-input.d.ts

@@ -0,0 +1,13 @@
+type SearchInputKey = {
+    tab: boolean;
+    backspace: boolean;
+};
+type SearchInputOptions = {
+    query: string;
+    names: string[];
+    setQuery: (value: string | ((current: string) => string)) => void;
+    setCandidates: (value: string[]) => void;
+};
+export declare function handleSidebarSearchInput(input: string, key: SearchInputKey, { query, names, setQuery, setCandidates }: SearchInputOptions): boolean;
+export declare function formatSearchMatchSummary(matches: number, total: number): string;
+export {};

package/dist/src/import/tui/sidebar-navigation.d.ts

@@ -0,0 +1,18 @@
+import type { ComponentGraphNode, Closure } from '../../analyze/composite-closure.js';
+import { type GroupedSidebarItem } from '../../analyze/select/tui/components/GroupedSidebar.js';
+export declare function collectExpandedGroupRoots(closures: Map<string, Closure>, cycleParticipants: Iterable<string>): Set<string>;
+export declare function computeSidebarViewToggle({ currentView, currentKey, currentScroll, visibleCount, items, cycleParticipants, expandedGroups, graph, showFlatTier, }: {
+    currentView: 'grouped' | 'flat';
+    currentKey: string | null | undefined;
+    currentScroll: number;
+    visibleCount: number;
+    items: GroupedSidebarItem[];
+    cycleParticipants: Set<string>;
+    expandedGroups: Set<string>;
+    graph: ComponentGraphNode[];
+    showFlatTier?: boolean;
+}): {
+    view: 'grouped' | 'flat';
+    cursor: number;
+    scroll: number;
+};

package/dist/src/import/tui/steps/AtomicGenerateReviewStep.d.ts

@@ -1,5 +1,4 @@
 import React from 'react';
-import type { CDFComponentEntry } from '@contentful/experience-design-system-types';
 type GenerateReviewStepProps = {
     extractSessionId: string;
     tokenSessionId?: string | null;
@@ -25,19 +24,5 @@ type GenerateReviewStepProps = {
      */
     initialFinalizeError?: string | null;
 };
-/**
- * Sort components for the final-review sidebar so the underlying data array
- * matches the visual order. Empty components (zero classified $properties)
- * surface at the top via the warning-tier path in Sidebar.tsx; we mirror that
- * here so `selectedIdx` indexes into the same order the user sees. Without
- * this, j/k navigation lands on different rows than the visually-selected
- * one (INTEG-4259).
- *
- * Within each tier (empty / non-empty) we tie-break alphabetically by `key`.
- */
-export declare function sortComponentsForSidebar<T extends {
-    key: string;
-    entry: CDFComponentEntry;
-}>(components: T[]): T[];
 export declare function AtomicGenerateReviewStep({ extractSessionId, tokenSessionId, onFinalize, onQuit, livePreview, spaceId, environmentId, cmaToken, host, tokensPath, initialFinalizeError, }: GenerateReviewStepProps): React.ReactElement;
 export {};

package/dist/src/import/tui/steps/GenerateReviewStep.d.ts

@@ -1,19 +1,7 @@
 import React from 'react';
 import type { BreakingChange, CDFComponentEntry, ComponentTypeSummary, DownstreamImpact, ServerPreviewResponse } from '@contentful/experience-design-system-types';
-type GenerateReviewStepProps = {
-    extractSessionId: string;
-    tokenSessionId?: string | null;
-    onFinalize: (accepted: number, rejected: number, unresolved: number) => void;
-    onQuit: () => void;
-    livePreview?: boolean;
-    spaceId?: string;
-    environmentId?: string;
-    cmaToken?: string;
-    host?: string;
-    tokensPath?: string;
-    initialFinalizeError?: string | null;
-    allowDeletions?: boolean;
-};
+import type { ReviewStepProps } from '../review-step-props.js';
+type GenerateReviewStepProps = ReviewStepProps;
 export declare function sortComponentsForSidebar<T extends {
     key: string;
     entry: CDFComponentEntry;

package/dist/src/import/tui/steps/review-details-panel.d.ts

@@ -0,0 +1,26 @@
+import React from 'react';
+import { type TokenPropSuggestion } from '../../../analyze/select/tui/components/TokenReviewPanel.js';
+import type { ComponentRationale, ComponentReviewMetadata } from '../../../session/db.js';
+type ReviewPanel = 'none' | 'prop-rationale' | 'component-rationale' | 'source' | 'token-review';
+export type ReviewDetailsPanelProps = {
+    selectedKey: string;
+    panelOpen: ReviewPanel;
+    componentRationale: ComponentRationale | null;
+    reviewMetadata: ComponentReviewMetadata | null;
+    panelScrollOffset: number;
+    width: number;
+    height: number;
+    sourceBorderColor?: string;
+    tokenSuggestions: TokenPropSuggestion[];
+    tokenReviewRow: number;
+    tokenReviewEditing: boolean;
+    tokenReviewEditCursor: number;
+    tokenReviewEditSelection: Set<string>;
+    showJson: boolean;
+    jsonValue: string;
+    jsonScrollOffset: number;
+    sidebarFocused: boolean;
+    editor: React.ReactNode;
+};
+export declare function ReviewDetailsPanel({ selectedKey, panelOpen, componentRationale, reviewMetadata, panelScrollOffset, width, height, sourceBorderColor, tokenSuggestions, tokenReviewRow, tokenReviewEditing, tokenReviewEditCursor, tokenReviewEditSelection, showJson, jsonValue, jsonScrollOffset, sidebarFocused, editor, }: ReviewDetailsPanelProps): React.ReactElement;
+export {};

package/dist/src/import/tui/steps/useTerminalColumns.d.ts

@@ -0,0 +1 @@
+export declare function useTerminalColumns(): number;

package/dist/src/import/tui/useFinalizePreview.d.ts

@@ -1,5 +1,5 @@
 import type { ComponentTypeSummary } from '@contentful/experience-design-system-types';
-export type FinalizePreviewStatus = 'idle' | 'running' | 'done' | 'error';
+type FinalizePreviewStatus = 'idle' | 'running' | 'done' | 'error';
 export type UseFinalizePreviewOptions = {
     /** True while the Finalize dialog is open. Toggling true (re)fires the preview. */
     open: boolean;
@@ -21,6 +21,13 @@ export type UseFinalizePreviewReturn = {
     /** Adjust the removed-list scroll (clamped to the window). */
     scrollBy: (delta: number) => void;
 };
+export type UseReviewFinalizePreviewOptions = Omit<UseFinalizePreviewOptions, 'acceptedKeys'> & {
+    components: ReadonlyArray<{
+        key: string;
+        status: string;
+    }>;
+};
+export declare function useReviewFinalizePreview({ components, ...options }: UseReviewFinalizePreviewOptions): UseFinalizePreviewReturn;
 /**
  * Shared Finalize-dialog deletion preview, used by both the composite and
  * atomic generate-review steps so the "what will this push delete" experience
@@ -34,3 +41,4 @@ export type UseFinalizePreviewReturn = {
  * simply omits the deletion section.
  */
 export declare function useFinalizePreview(opts: UseFinalizePreviewOptions): UseFinalizePreviewReturn;
+export {};

package/dist/src/import/tui/useLivePreview.d.ts

@@ -15,7 +15,7 @@ export type UseLivePreviewOptions = {
     /** Forwarded verbatim to `runLivePreview`/`previewImport`. */
     allowDeletions?: boolean;
 };
-export type LivePreviewStatus = 'idle' | 'running';
+type LivePreviewStatus = 'idle' | 'running';
 export type UseLivePreviewReturn = {
     trigger: () => void;
     status: LivePreviewStatus;
@@ -38,3 +38,4 @@ export type UseLivePreviewReturn = {
  * is set so we don't accumulate dead timers.
  */
 export declare function useLivePreview(opts: UseLivePreviewOptions): UseLivePreviewReturn;
+export {};