@case-framework/survey-ui 0.5.1 → 0.6.1

package/dist/src/modules/survey-editor/routes/editor/preview-mode/preview-tree.d.ts

@@ -0,0 +1,26 @@
+import { Survey, SurveyItemCore } from '@case-framework/survey-core';
+export type PreviewLayout = "single" | "paginated";
+export type PreviewViewport = "mobile" | "tablet" | "desktop" | "wide";
+export declare const PREVIEW_VIEWPORT_WIDTHS: Record<PreviewViewport, number>;
+/** Returns every non-group item in authored tree order, including page breaks. */
+export declare const flattenPreviewItems: (survey: Survey) => SurveyItemCore[];
+/**
+ * Maps each item to the authored position immediately following it.
+ * Group items are intentionally not rendered in preview mode, so this keeps the
+ * insertion targets in each item's direct containing group rather than guessing
+ * from the flattened visual order.
+ */
+export declare const getPreviewInsertionTargets: (survey: Survey) => Map<string, {
+    parentId: string;
+    index: number;
+}>;
+/**
+ * Splits authored items into non-empty pages. Page breaks never render as page content.
+ * Leading, trailing, and consecutive breaks therefore do not create empty pages.
+ */
+export declare const paginatePreviewItems: (items: readonly SurveyItemCore[], maxItemsPerPage?: number) => SurveyItemCore[][];
+export declare const getPreviewMaxItemsPerPage: (survey: Survey, viewport: PreviewViewport) => number | undefined;
+export declare const getPreviewPageIndex: (pages: readonly (readonly SurveyItemCore[])[], itemId: string) => number;
+export declare const getPaginatedPreviewFocusTarget: (items: readonly SurveyItemCore[], requestedItemId: string) => string | undefined;
+export declare const resolvePreviewFocusItemId: (survey: Survey, requestedItemId: string | undefined, flattenedItems: readonly SurveyItemCore[]) => string | undefined;
+export declare const itemHasConditions: (item: SurveyItemCore) => boolean;

package/dist/src/modules/survey-editor/routes/editor/preview-mode/survey-preview-canvas.d.ts

@@ -0,0 +1,16 @@
+import { Survey, SurveyEngineCore } from '@case-framework/survey-core';
+import { PreviewPreferences } from './use-preview-preferences';
+interface SurveyPreviewCanvasProps {
+    survey: Survey;
+    surveyEngine: SurveyEngineCore;
+    preferences: PreviewPreferences;
+    focusedItemId?: string;
+    locateRequestKey: number;
+    initialLocateReady: boolean;
+    currentPageIndex: number;
+    onCurrentPageIndexChange: (pageIndex: number) => void;
+    onResponseChanged: () => void;
+    className?: string;
+}
+export declare const SurveyPreviewCanvas: ({ survey, surveyEngine, preferences, focusedItemId, locateRequestKey, initialLocateReady, currentPageIndex, onCurrentPageIndexChange, onResponseChanged, className, }: SurveyPreviewCanvasProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/src/modules/survey-editor/routes/editor/preview-mode/survey-preview-item.d.ts

@@ -0,0 +1,13 @@
+import { RenderedSurveyItem, SurveyItemCore } from '@case-framework/survey-core';
+import { PreviewPreferences } from './use-preview-preferences';
+interface SurveyPreviewItemProps {
+    item: SurveyItemCore;
+    renderedItem?: RenderedSurveyItem;
+    preferences: PreviewPreferences;
+    focused: boolean;
+    highlighted: boolean;
+    onFocus: () => void;
+    afterDeleteItemId: string | null;
+}
+export declare const SurveyPreviewItem: ({ item, renderedItem, preferences, focused, highlighted, onFocus, afterDeleteItemId, }: SurveyPreviewItemProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/src/modules/survey-editor/routes/editor/preview-mode/use-preview-preferences.d.ts

@@ -0,0 +1,14 @@
+import { PreviewLayout, PreviewViewport } from './preview-tree';
+export interface PreviewPreferences {
+    layout: PreviewLayout;
+    viewport: PreviewViewport;
+    showKeys: boolean;
+    showFullKeys: boolean;
+    showMetadata: boolean;
+    showConditions: boolean;
+    showPageIndicator: boolean;
+}
+export declare const usePreviewPreferences: () => {
+    preferences: PreviewPreferences;
+    updatePreferences: (updates: Partial<PreviewPreferences>) => void;
+};

package/dist/src/modules/survey-editor/store/editor-store.d.ts

@@ -2,6 +2,7 @@ import { StoreApi } from 'zustand';
 import { SurveyEditor, Target, SurveyItemClipboardData, CommitMeta, SurveyEditorHistoryCommit, UndoRedoConfig } from '@case-framework/survey-core/editor';
 import { SurveyItemCore, SurveyItemTranslations, RawSurveyItem, TemplateValueDefinition, GroupItemCore, RawSurveyAsset, SurveyCardContent, NavigationContent, Content } from '@case-framework/survey-core';
 import { ComposedEditorItemRegistry, ItemCategory, ItemLocaleMap, ItemRegistryEntry } from '../registry';
+import { SurveyApplyResult, SurveyBatchApplyResult, SurveyChangeSet, SurveyDocumentVersion } from '@case-framework/survey-assistant/protocol';
 interface StartNewSessionOptions {
     surveyKey?: string;
     /** Unified registry entries (recommended, matches SurveyEditor) */
@@ -19,6 +20,8 @@ export interface EditorStore {
     /** Composed item registry used by editor UI features. */
     editorItemRegistry: ComposedEditorItemRegistry;
     selectedLocale: string;
+    /** True while user-authored survey mutations are temporarily paused. */
+    userMutationsLocked: boolean;
     /** Set the active editor (call when opening a session) */
     setEditor: (surveyId: string | null, editor: SurveyEditor | null) => void;
     /** Clear the active editor (call when closing/unmounting to avoid stale state on next mount) */
@@ -27,6 +30,7 @@ export interface EditorStore {
     startNewSession: (options: StartNewSessionOptions) => void;
     setEditorItemRegistry: (registry: ComposedEditorItemRegistry) => void;
     setSelectedLocale: (locale: string) => void;
+    setUserMutationsLocked: (locked: boolean) => void;
     undo: () => boolean;
     redo: () => boolean;
     canUndo: () => boolean;
@@ -50,7 +54,7 @@ export interface EditorStore {
     moveItem: (itemId: string, newTarget: Target) => boolean;
     updateItemTranslations: (itemId: string, updatedContent?: SurveyItemTranslations) => boolean;
     copyItem: (itemId: string) => SurveyItemClipboardData;
-    pasteItem: (clipboardData: SurveyItemClipboardData, target: Target) => string;
+    pasteItem: (clipboardData: SurveyItemClipboardData, target: Target) => string | null;
     getRootItem: () => GroupItemCore | undefined;
     getItemDataCopy: (itemId: string) => RawSurveyItem;
     updateItem: (itemId: string, rawItemData: RawSurveyItem | Partial<RawSurveyItem>) => void;
@@ -84,6 +88,8 @@ export interface EditorStore {
     updateMetadata: (metadata: {
         [key: string]: string;
     } | undefined) => void;
+    applyAssistantChange: (change: SurveyChangeSet, currentPrecondition: SurveyDocumentVersion) => SurveyApplyResult;
+    applyAssistantChanges: (changes: SurveyChangeSet[], currentPrecondition: SurveyDocumentVersion) => SurveyBatchApplyResult;
     getTemplateValue: (key: string) => TemplateValueDefinition | undefined;
     getTemplateValues: () => Map<string, TemplateValueDefinition>;
     setTemplateValue: (key: string, templateValue: TemplateValueDefinition) => void;

package/dist/src/modules/survey-editor/survey-editor-config.d.ts

@@ -1,16 +1,19 @@
 import { ReactNode } from 'react';
 import { Locale } from 'date-fns/locale';
 import { SurveyEditorAIProvider } from './ai/types';
-import { EditorTranslate, SurveyEditorDateLocales, EditorTranslationValues, SurveyEditorLocalizations } from './localization';
+import { LocalizationCatalog, LocalizationTranslate, LocalizationValues } from '@case-framework/ui-localization';
+import { SurveyEditorDateLocales } from './localization/date-fns';
+import { SurveyEditorWorkspace } from './workspace';
 interface SurveyEditorConfigType {
     helpLink: string;
     aiProvider: SurveyEditorAIProvider | null;
     fallbackLocale: string;
     language: string;
-    localizations: SurveyEditorLocalizations;
+    localizations: LocalizationCatalog;
     dateLocales: SurveyEditorDateLocales;
     dateLocale: Locale;
-    translate: EditorTranslate;
+    translate: LocalizationTranslate;
+    workspace?: SurveyEditorWorkspace;
 }
 interface SurveyEditorConfigProviderProps {
     children: ReactNode;
@@ -18,12 +21,18 @@ interface SurveyEditorConfigProviderProps {
     aiProvider?: SurveyEditorAIProvider | null;
     fallbackLocale?: string;
     language?: string;
-    localizations?: SurveyEditorLocalizations;
+    localizations?: LocalizationCatalog;
     dateLocales?: SurveyEditorDateLocales;
+    workspace?: SurveyEditorWorkspace;
 }
+interface ResolvedSurveyEditorConfigProviderProps extends Omit<SurveyEditorConfigProviderProps, "dateLocales" | "localizations"> {
+    dateLocales: SurveyEditorDateLocales;
+    localizations: LocalizationCatalog;
+}
+export declare const ResolvedSurveyEditorConfigProvider: React.FC<ResolvedSurveyEditorConfigProviderProps>;
 export declare const SurveyEditorConfigProvider: React.FC<SurveyEditorConfigProviderProps>;
 export declare const useSurveyEditorConfig: () => SurveyEditorConfigType;
 export declare const useSurveyEditorAIProvider: () => SurveyEditorAIProvider | null;
-export declare const useEditorTranslation: (namespace?: string) => ((key: string, values?: EditorTranslationValues) => string);
+export declare const useEditorTranslation: (namespace?: string) => ((key: string, values?: LocalizationValues) => string);
 export declare const useEditorDateLocale: () => Locale;
 export {};

package/dist/src/modules/survey-editor/survey-editor.d.ts

@@ -1,24 +1,36 @@
+import { ReactNode } from 'react';
 import { SerializedSurveyEditor } from '@case-framework/survey-core/editor';
 import { EditorStateChangePayload } from './hooks/useEditorStateChange';
 import { SurveyEditorNavigationAdapter } from './navigation/types';
+import { SurveyEditorAssistantController } from './assistant';
 import { ItemCategory, ItemLocaleMap, ItemRegistryEntry } from './registry';
 import { SurveyEditorAIProvider } from './ai/types';
-import { SurveyEditorDateLocales, SurveyEditorLocalizations } from './localization';
+import { LocalizationCatalog } from '@case-framework/ui-localization';
+import { SurveyEditorDateLocales } from './localization/date-fns';
+import { SurveyEditorWorkspace } from './workspace';
 export type SurveyEditorStateChange = EditorStateChangePayload;
 export interface SurveyEditorProps {
     initialEditorState?: SerializedSurveyEditor;
     initialSessionId?: string;
     fallbackLocale?: string;
     language?: string;
-    localizations?: SurveyEditorLocalizations;
+    localizations?: LocalizationCatalog;
     dateLocales?: SurveyEditorDateLocales;
     itemRegistryEntries?: ItemRegistryEntry[];
     /** Override or extend default add-item category headings (merged with built-in defaults). */
     categoryLabels?: Partial<Record<ItemCategory, ItemLocaleMap>>;
     onEditorStateChange?: (change: SurveyEditorStateChange) => void;
+    /** Prevent user-authored survey mutations while preserving preview and navigation. */
+    readOnly?: boolean;
+    /** Optional imperative bridge for a survey assistant host. */
+    assistantControllerRef?: React.Ref<SurveyEditorAssistantController | null>;
+    /** Optional host-rendered assistant UI shown in the editor workspace. */
+    assistantPanel?: ReactNode;
     persistDebounceMs?: number;
     helpLink?: string;
     navigationAdapter?: SurveyEditorNavigationAdapter | null;
+    /** Configure the initial main panel and workspace panels. */
+    workspace?: SurveyEditorWorkspace;
     aiProvider?: SurveyEditorAIProvider | null;
     onBackRequested?: () => void;
     onSimulatorRequested?: () => void;

package/dist/src/modules/survey-editor/workspace.d.ts

@@ -0,0 +1,17 @@
+import { SurveyEditorLocation } from './navigation/types';
+export interface SurveyEditorWorkspacePanelOptions {
+    /** Whether the panel is visible when this editor is first opened. */
+    defaultOpen?: boolean;
+}
+/** Initial layout for a SurveyEditor instance. */
+export interface SurveyEditorWorkspace {
+    /**
+     * The main panel shown when no navigation adapter is supplied.
+     * Defaults to the survey preview.
+     */
+    initialLocation?: SurveyEditorLocation;
+    panels?: {
+        outline?: SurveyEditorWorkspacePanelOptions;
+        assistant?: SurveyEditorWorkspacePanelOptions;
+    };
+}

package/dist/src/modules/survey-player/index.d.ts

@@ -2,4 +2,3 @@ export { SurveyPlayer } from './survey-player';
 export { SurveyContextProvider, useSurveyCtx, useSurveyTranslation, type SurveyContextProviderProps, } from './survey-context';
 export { SurveyItemRenderer, type SurveyItemRendererProps } from './survey-item/survey-item';
 export type { SurveyPlayerProps } from './survey-player';
-export type { SurveyPlayerLocalizationMessages, SurveyPlayerLocalizations, SurveyPlayerTranslate, SurveyPlayerTranslationValue, SurveyPlayerTranslationValues, } from './localization/types';

package/dist/src/modules/survey-player/localization/default-en.d.ts

@@ -1,3 +1,3 @@
-import { SurveyPlayerLocalizations } from './types';
+import { LocalizationCatalog } from '@case-framework/ui-localization';
 export declare const DEFAULT_SURVEY_PLAYER_LANGUAGE = "en";
-export declare const defaultSurveyPlayerLocalizations: SurveyPlayerLocalizations;
+export declare const defaultSurveyPlayerLocalizations: LocalizationCatalog;

package/dist/src/modules/survey-player/localization/runtime.d.ts

@@ -1,4 +1,5 @@
-import { SurveyPlayerLocalizations, SurveyPlayerTranslate } from './types';
-export declare const mergeSurveyPlayerLocalizations: (...sources: Array<SurveyPlayerLocalizations | undefined>) => SurveyPlayerLocalizations;
-export declare const createSurveyTranslator: (language: string, localizations: SurveyPlayerLocalizations) => SurveyPlayerTranslate;
-export declare const createNamespacedSurveyTranslator: (translate: SurveyPlayerTranslate, namespace?: string) => SurveyPlayerTranslate;
+import { LocalizationCatalog, LocalizationTranslate } from '@case-framework/ui-localization';
+export declare const mergeSurveyPlayerLocalizations: (...sources: Array<LocalizationCatalog | undefined>) => LocalizationCatalog;
+export declare const mergeSurveyPlayerLocalizationSources: (...sources: Array<LocalizationCatalog | undefined>) => LocalizationCatalog;
+export declare const createSurveyTranslator: (language: string, localizations: LocalizationCatalog) => LocalizationTranslate;
+export declare const createNamespacedSurveyTranslator: (translate: LocalizationTranslate, namespace?: string) => LocalizationTranslate;

package/dist/src/modules/survey-player/survey-context.d.ts

@@ -1,7 +1,7 @@
 import { default as React } from 'react';
 import { Survey, SurveyEngineCore } from '@case-framework/survey-core';
 import { SurveyPlayerItemRegistry } from '../../../modules/survey-editor/registry';
-import { SurveyPlayerLocalizations, SurveyPlayerTranslate } from './localization/types';
+import { LocalizationCatalog, LocalizationTranslate } from '@case-framework/ui-localization';
 export type HandlerFuncArgType = string | number | boolean | null | undefined;
 export type HandlerFunction = (handlerId: string, args?: HandlerFuncArgType[]) => Promise<{
     error?: string;
@@ -14,19 +14,24 @@ interface SurveyContextValue {
     surveyPlayerRegistry?: SurveyPlayerItemRegistry;
     runExternalHandler?: HandlerFunction;
     onResponseChanged?: () => void;
-    translate: SurveyPlayerTranslate;
+    translate: LocalizationTranslate;
 }
+interface ResolvedSurveyContextProviderProps extends Omit<SurveyContextProviderProps, "localizations" | "surveyPlayerRegistry"> {
+    surveyPlayerRegistry?: SurveyPlayerItemRegistry;
+    translate: LocalizationTranslate;
+}
+export declare const ResolvedSurveyContextProvider: React.FC<ResolvedSurveyContextProviderProps>;
 export interface SurveyContextProviderProps {
     survey: Survey;
     locale: string;
     surveyEngine: SurveyEngineCore;
     surveyPlayerRegistry?: SurveyPlayerItemRegistry;
-    localizations?: SurveyPlayerLocalizations;
+    localizations?: LocalizationCatalog;
     children: React.ReactNode;
     onRunExternalHandler?: HandlerFunction;
     onResponseChanged?: () => void;
 }
 export declare const SurveyContextProvider: React.FC<SurveyContextProviderProps>;
 export declare const useSurveyCtx: () => SurveyContextValue;
-export declare const useSurveyTranslation: (namespace?: string) => SurveyPlayerTranslate;
+export declare const useSurveyTranslation: (namespace?: string) => LocalizationTranslate;
 export {};

package/dist/src/modules/survey-player/survey-player.d.ts

@@ -1,13 +1,13 @@
 import { Survey, SurveyEngineCore, ScreenSize, SurveyItemResponse } from '@case-framework/survey-core';
 import { SurveyPlayerItemRegistry } from '../../../modules/survey-editor/registry';
-import { SurveyPlayerLocalizations } from './localization/types';
+import { LocalizationCatalog } from '@case-framework/ui-localization';
 export interface SurveyPlayerProps {
     survey: Survey;
     locale?: string;
     size?: ScreenSize;
     surveyEngine?: SurveyEngineCore;
     surveyPlayerRegistry?: SurveyPlayerItemRegistry;
-    localizations?: SurveyPlayerLocalizations;
+    localizations?: LocalizationCatalog;
     onSubmit?: (responses: SurveyItemResponse[], surveyEngine: SurveyEngineCore) => void;
     className?: string;
 }