@case-framework/survey-ui 0.2.0 → 0.2.2

package/dist/modules/survey-editor/registry/types.d.ts

@@ -0,0 +1,154 @@
+import { ItemCoreConstructor, ItemTypeRegistry, RawSurveyItem, SurveyItemCore, RenderedSurveyItem, SurveyItemTranslations } from '@case-framework/survey-core';
+import { Target } from '@case-framework/survey-core/editor';
+import { default as React } from 'react';
+import { ItemSearchAdapter } from './search-adapter';
+export type ItemCategory = string;
+export type ItemLocaleMap = Record<string, string>;
+export type ItemIconComponent = React.ComponentType<{
+    className?: string;
+}>;
+export interface ItemEditorComponentProps<TItem extends SurveyItemCore = SurveyItemCore> {
+    item: TItem;
+}
+export interface ItemRendererComponentProps {
+    renderedItem: RenderedSurveyItem;
+}
+export type ItemPreviewMode = "interactive" | "static";
+export interface ItemPreviewComponentProps<TItem extends SurveyItemCore = SurveyItemCore> {
+    item: TItem;
+    itemConfig: TItem["config"];
+    itemContent?: SurveyItemTranslations;
+    locale: string;
+    mode?: ItemPreviewMode;
+}
+export interface ItemEditorCapabilities {
+    usesValidationPanel?: boolean;
+    usesTranslationPanel?: boolean;
+    usesConditionsPanel?: boolean;
+}
+export interface ItemInitialData {
+    rawItem: RawSurveyItem;
+    translations?: SurveyItemTranslations;
+    children?: ItemInitialData[];
+}
+export interface ItemInfos {
+    icon: ItemIconComponent;
+    labelByLocale: ItemLocaleMap;
+    descriptionByLocale: ItemLocaleMap;
+    defaultItemClassName?: string;
+    categories: ItemCategory[];
+}
+export interface CreateItemContext {
+    editor: {
+        addItem: (target: Target, item: SurveyItemCore, content?: SurveyItemTranslations) => void;
+    };
+    targetParentId: string;
+    constructor: ItemCoreConstructor;
+}
+export interface EditorItemDefinition {
+    itemType: string;
+    infos: ItemInfos;
+    editorComponent?: React.ComponentType<ItemEditorComponentProps>;
+    renderComponent?: React.ComponentType<ItemRendererComponentProps>;
+    previewComponent?: React.ComponentType<ItemPreviewComponentProps>;
+    capabilities?: ItemEditorCapabilities;
+    isRootOnly?: boolean;
+    getInitialItem?: () => ItemInitialData;
+    createItem?: (ctx: CreateItemContext) => string;
+    searchAdapters?: ItemSearchAdapter[];
+    includeDefaultSearchAdapter?: boolean;
+}
+export type EditorItemDefinitionRegistry = Record<string, EditorItemDefinition>;
+export interface ComposedEditorItemRegistry {
+    coreRegistry: ItemTypeRegistry;
+    definitions: EditorItemDefinitionRegistry;
+}
+/**
+ * Unified registry entry type, reusable across contexts:
+ *
+ * - Participant app: needs only `constructor` + `renderComponent`
+ * - Editor: needs constructor, infos, `previewComponent`, editorComponent, searchAdapters, etc.
+ *
+ * Use the mapper helpers to derive ItemTypeRegistry, participant registry, or editor registry.
+ */
+export interface ItemRegistryEntry {
+    itemType: string;
+    /** Item core constructor. Omit for built-in types (group, pageBreak) — they use survey-core's built-in registry. Omit for virtual "root" — it maps to Group with isRoot. */
+    constructor?: ItemCoreConstructor;
+    /** Participant renderer. Required for participant app. */
+    renderComponent?: React.ComponentType<ItemRendererComponentProps>;
+    /** Editor-only: item preview renderer */
+    previewComponent?: React.ComponentType<ItemPreviewComponentProps>;
+    /** Editor-only: display metadata */
+    infos?: ItemInfos;
+    /** Editor-only: card/editor UI */
+    editorComponent?: React.ComponentType<ItemEditorComponentProps>;
+    /** Editor-only: search integration */
+    searchAdapters?: ItemSearchAdapter[];
+    /** Editor-only: include built-in key/label/itemType search adapter in addition to custom adapters. Defaults to true. */
+    includeDefaultSearchAdapter?: boolean;
+    /** Editor-only */
+    capabilities?: ItemEditorCapabilities;
+    /** Editor-only: default raw item when creating new */
+    getInitialItem?: () => ItemInitialData;
+    /** Editor-only: custom creation flow (advanced) */
+    createItem?: (ctx: CreateItemContext) => string;
+    /** Editor-only: hide from add-item options in non-root context */
+    isRootOnly?: boolean;
+}
+export type ItemRegistry = Record<string, ItemRegistryEntry>;
+/** Participant registry: core + renderer per item type. Lightweight for survey player. */
+export interface SurveyPlayerItemRegistry {
+    coreRegistry: ItemTypeRegistry;
+    getRenderer: (itemType: string) => React.ComponentType<ItemRendererComponentProps> | undefined;
+}
+export interface EntriesToParticipantRegistryOptions {
+    /** Throw when an entry in the provided list does not define a renderComponent. */
+    requireRenderer?: boolean;
+}
+export interface EntriesToComposedEditorRegistryOptions {
+    /** Require built-in editor definitions for group/pageBreak. Defaults to true. */
+    requireBuiltInTypes?: boolean;
+}
+export type RegistryValidationMode = "editor" | "player";
+export interface RegistryValidationOptions {
+    mode: RegistryValidationMode;
+    requireBuiltInTypes?: boolean;
+    requireRenderer?: boolean;
+}
+export interface RegistryValidationIssue {
+    code: string;
+    message: string;
+    itemType?: string;
+}
+export interface RegistryValidationResult {
+    errors: RegistryValidationIssue[];
+    warnings: RegistryValidationIssue[];
+}
+/**
+ * Example: unified entry for participant + editor
+ *
+ * const myEntries: ItemRegistryEntry[] = [
+ *   {
+ *     itemType: "singleChoiceQuestion",
+ *     constructor: SingleChoiceQuestionCore,
+ *     renderComponent: SingleChoiceQuestionRenderer,
+ *     previewComponent: SingleChoiceQuestionPreview,
+ *     infos: { icon: CheckCircle2, labelByLocale: { en: "Single choice" }, ... },
+ *     editorComponent: EditorCardForScgMcg,
+ *     searchAdapters: [myCustomSearchAdapter],
+ *   },
+ *   // ...
+ * ];
+ *
+ * // Participant app:
+ * const participantReg = entriesToParticipantRegistry(myEntries);
+ * Survey.fromJson(json, participantReg.coreRegistry);
+ * const Renderer = participantReg.getRenderer("singleChoiceQuestion");
+ *
+ * // Editor:
+ * const editorReg = entriesToComposedEditorRegistry(myEntries);
+ * // ... use editorReg.coreRegistry + editorReg.definitions
+ */
+export declare const DEFAULT_LOCALE = "en";
+export declare function resolveLocalizedText(map: ItemLocaleMap, locale?: string): string;

package/dist/modules/survey-editor/routes/editor/_components/footer.d.ts

@@ -0,0 +1,2 @@
+declare const EditorFooter: React.FC;
+export default EditorFooter;

package/dist/modules/survey-editor/routes/editor/_components/history-stack.d.ts

@@ -0,0 +1,2 @@
+declare const HistoryStack: React.FC;
+export default HistoryStack;

package/dist/modules/survey-editor/routes/editor/_components/main.d.ts

@@ -0,0 +1,2 @@
+declare const EditorMain: React.FC;
+export default EditorMain;

package/dist/modules/survey-editor/routes/editor/_components/sidebar.d.ts

@@ -0,0 +1,7 @@
+interface EditorSidebarProps {
+    onSave?: () => void;
+    onUndo?: () => void;
+    onRedo?: () => void;
+}
+declare const EditorSidebar: React.FC<EditorSidebarProps>;
+export default EditorSidebar;

package/dist/modules/survey-editor/routes/editor/index.d.ts

@@ -0,0 +1,5 @@
+interface EditorProps {
+    onSaveRequested?: () => void;
+}
+declare const Editor: React.FC<EditorProps>;
+export default Editor;

package/dist/modules/survey-editor/routes/editor/item-editor/_components/item-editor-toolbar/breadcrumbs-nav.d.ts

@@ -0,0 +1,2 @@
+declare const BreadcrumbsNav: React.FC;
+export default BreadcrumbsNav;

package/dist/modules/survey-editor/routes/editor/item-editor/_components/item-editor-toolbar/item-editor-toolbar.d.ts

@@ -0,0 +1,2 @@
+declare const ItemEditorToolbar: React.FC;
+export default ItemEditorToolbar;

package/dist/modules/survey-editor/routes/editor/item-editor/_components/item-editor-toolbar/language-picker.d.ts

@@ -0,0 +1,2 @@
+declare const LanguagePicker: () => import("react/jsx-runtime").JSX.Element;
+export default LanguagePicker;

package/dist/modules/survey-editor/routes/editor/item-editor/_components/item-editor-toolbar/search-trigger.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+declare const SearchTrigger: React.FC;
+export default SearchTrigger;

package/dist/modules/survey-editor/routes/editor/item-editor/_components/item-editor-toolbar/survey-search.d.ts

@@ -0,0 +1,7 @@
+import { default as React } from 'react';
+interface SurveySearchProps {
+    isOpen: boolean;
+    onOpenChange: (open: boolean) => void;
+}
+declare const SurveySearch: React.FC<SurveySearchProps>;
+export default SurveySearch;

package/dist/modules/survey-editor/routes/editor/item-editor/index.d.ts

@@ -0,0 +1,2 @@
+declare const ItemEditor: () => import("react/jsx-runtime").JSX.Element;
+export default ItemEditor;

package/dist/modules/survey-editor/routes/editor/simulator/index.d.ts

@@ -0,0 +1,2 @@
+declare const Simulator: () => import("react/jsx-runtime").JSX.Element;
+export default Simulator;

package/dist/modules/survey-editor/routes/editor/translation-mode/index.d.ts

@@ -0,0 +1,2 @@
+declare const TranslationMode: () => import("react/jsx-runtime").JSX.Element;
+export default TranslationMode;

package/dist/modules/survey-editor/session-file.d.ts

@@ -0,0 +1,13 @@
+import { Survey, ItemTypeRegistry } from '@case-framework/survey-core';
+import { SerializedSurveyEditor } from '@case-framework/survey-core/editor';
+export type ParsedSurveySessionFormat = 'raw-survey' | 'serialized-editor';
+export interface ParsedSurveySession {
+    format: ParsedSurveySessionFormat;
+    state: SerializedSurveyEditor;
+    sessionId: string;
+}
+export declare function createBlankEditorState(pluginRegistry?: ItemTypeRegistry, surveyKey?: string): SerializedSurveyEditor;
+export declare function createEditorStateFromRawSurvey(rawSurvey: Parameters<typeof Survey.fromJson>[0], pluginRegistry?: ItemTypeRegistry): SerializedSurveyEditor;
+export declare function parseEditorStateFromJsonText(jsonText: string, pluginRegistry?: ItemTypeRegistry): ParsedSurveySession;
+export declare function serializeSurveyStateForFile(state: SerializedSurveyEditor): string;
+export declare function buildSurveyFileName(state: SerializedSurveyEditor, fallback?: string): string;

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

@@ -0,0 +1,10 @@
+import { StoreApi } from 'zustand';
+import { EditorStore } from './editor-store';
+/**
+ * Context is split from the provider to avoid React Fast Refresh (HMR) issues.
+ * When the provider file is hot-reloaded, re-executing createContext would create
+ * a new context instance, causing "must be used within EditorStoreProvider" errors
+ * during the brief reconciliation window. Keeping the context in a separate module
+ * preserves its identity across HMR updates.
+ */
+export declare const EditorStoreContext: import('react').Context<StoreApi<EditorStore> | null>;

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

@@ -0,0 +1,7 @@
+import { PropsWithChildren } from 'react';
+/**
+ * Provider only. Hooks live in use-editor-store.ts so that .tsx files
+ * export only components — avoiding Fast Refresh invalidation that
+ * causes context loss during HMR.
+ */
+export declare const EditorStoreProvider: React.FC<PropsWithChildren>;

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

@@ -0,0 +1,96 @@
+import { StoreApi } from 'zustand';
+import { SurveyEditor, Target, SurveyItemClipboardData, CommitMeta, UndoRedoConfig } from '@case-framework/survey-core/editor';
+import { SurveyItemCore, SurveyItemTranslations, RawSurveyItem, TemplateValueDefinition, GroupItemCore, SurveyCardContent, NavigationContent, Content } from '@case-framework/survey-core';
+import { ComposedEditorItemRegistry, ItemRegistryEntry } from '../registry';
+interface StartNewSessionOptions {
+    surveyKey?: string;
+    /** Unified registry entries (recommended, matches SurveyEditor) */
+    itemRegistryEntries?: ItemRegistryEntry[];
+}
+export interface EditorStore {
+    /** Current survey/session id when editor is loaded */
+    sessionId: string | null;
+    /** The SurveyEditor instance - null when no editor is loaded */
+    editor: SurveyEditor | null;
+    /** Incremented on every mutation; select this to force re-renders when editor changes */
+    changeTick: number;
+    /** Composed item registry used by editor UI features. */
+    editorItemRegistry: ComposedEditorItemRegistry;
+    selectedLocale: string;
+    /** 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) */
+    clearEditor: () => void;
+    /** Create and set a new blank survey editor (starts a new session) */
+    startNewSession: (options: StartNewSessionOptions) => void;
+    setEditorItemRegistry: (registry: ComposedEditorItemRegistry) => void;
+    setSelectedLocale: (locale: string) => void;
+    undo: () => boolean;
+    redo: () => boolean;
+    canUndo: () => boolean;
+    canRedo: () => boolean;
+    commit: (meta: CommitMeta) => void;
+    commitByUser: (meta: Omit<CommitMeta, "source">) => void;
+    commitIfNeeded: () => void;
+    jumpToIndexInHistory: (targetIndex: number) => boolean;
+    getUndoMeta: () => CommitMeta | null;
+    getRedoMeta: () => CommitMeta | null;
+    getUndoRedoHistory: () => Array<{
+        index: number;
+        meta: CommitMeta;
+        timestamp: number;
+        memorySize: number;
+        isCurrent: boolean;
+    }>;
+    addItem: (target: Target | null, item: SurveyItemCore, content?: SurveyItemTranslations) => void;
+    removeItem: (itemId: string, nested?: boolean) => boolean;
+    moveItem: (itemId: string, newTarget: Target) => boolean;
+    updateItemTranslations: (itemId: string, updatedContent?: SurveyItemTranslations) => boolean;
+    copyItem: (itemId: string) => SurveyItemClipboardData;
+    pasteItem: (clipboardData: SurveyItemClipboardData, target: Target) => string;
+    getRootItem: () => GroupItemCore | undefined;
+    getItemDataCopy: (itemId: string) => RawSurveyItem;
+    updateItem: (itemId: string, rawItemData: RawSurveyItem | Partial<RawSurveyItem>) => void;
+    updateSurveyTranslations: (updates: {
+        surveyCard?: {
+            locale: string;
+            content?: SurveyCardContent;
+        };
+        navigation?: {
+            locale: string;
+            content?: NavigationContent;
+        };
+        validationMessages?: {
+            locale: string;
+            content?: {
+                invalidResponse?: Content;
+            };
+        };
+    }) => void;
+    getMaxItemsPerPage: () => {
+        large: number;
+        small: number;
+    } | undefined;
+    updateMaxItemsPerPage: (value: {
+        large: number;
+        small: number;
+    } | undefined) => void;
+    getMetadata: () => {
+        [key: string]: string;
+    } | undefined;
+    updateMetadata: (metadata: {
+        [key: string]: string;
+    } | undefined) => void;
+    getTemplateValue: (key: string) => TemplateValueDefinition | undefined;
+    getTemplateValues: () => Map<string, TemplateValueDefinition>;
+    setTemplateValue: (key: string, templateValue: TemplateValueDefinition) => void;
+    removeTemplateValue: (key: string) => void;
+    getMemoryUsage: () => {
+        totalMB: number;
+        entries: number;
+    };
+    getUndoRedoConfig: () => UndoRedoConfig;
+}
+export type EditorStoreApi = StoreApi<EditorStore>;
+export declare function createEditorStore(): EditorStoreApi;
+export {};

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

@@ -0,0 +1,4 @@
+import { StoreApi } from 'zustand';
+import { EditorStore } from './editor-store';
+export declare function useEditorStore<T>(selector: (state: EditorStore) => T): T;
+export declare function useEditorStoreApi(): StoreApi<EditorStore>;

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

@@ -0,0 +1,7 @@
+/**
+ * Custom hook for managing survey item navigation via state
+ */
+export declare const useItemNavigation: () => {
+    selectedItemId: string | undefined;
+    navigateToItem: (newItemId?: string) => void;
+};

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

@@ -0,0 +1,17 @@
+import { ReactNode } from 'react';
+import { SurveyEditorAIProvider } from './ai/types';
+interface SurveyEditorConfigType {
+    helpLink: string;
+    aiProvider: SurveyEditorAIProvider | null;
+    fallbackLocale: string;
+}
+interface SurveyEditorConfigProviderProps {
+    children: ReactNode;
+    helpLink: string;
+    aiProvider?: SurveyEditorAIProvider | null;
+    fallbackLocale?: string;
+}
+export declare const SurveyEditorConfigProvider: React.FC<SurveyEditorConfigProviderProps>;
+export declare const useSurveyEditorConfig: () => SurveyEditorConfigType;
+export declare const useSurveyEditorAIProvider: () => SurveyEditorAIProvider | null;
+export {};

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

@@ -0,0 +1,20 @@
+import { SerializedSurveyEditor } from '@case-framework/survey-core/editor';
+import { EditorStateChangePayload } from './hooks/useEditorStateChange';
+import { SurveyEditorNavigationAdapter } from './navigation/types';
+import { ItemRegistryEntry } from './registry';
+import { SurveyEditorAIProvider } from './ai/types';
+export type SurveyEditorStateChange = EditorStateChangePayload;
+export interface SurveyEditorProps {
+    initialEditorState?: SerializedSurveyEditor;
+    initialSessionId?: string;
+    fallbackLocale?: string;
+    itemRegistryEntries?: ItemRegistryEntry[];
+    onEditorStateChange?: (change: SurveyEditorStateChange) => void;
+    persistDebounceMs?: number;
+    helpLink?: string;
+    navigationAdapter?: SurveyEditorNavigationAdapter | null;
+    aiProvider?: SurveyEditorAIProvider | null;
+    onSaveRequested?: () => void;
+}
+declare const SurveyEditor: React.FC<SurveyEditorProps>;
+export { SurveyEditor };

package/dist/modules/survey-editor/utils/item-type-infos.d.ts

@@ -0,0 +1,23 @@
+import { SurveyItemCore } from '@case-framework/survey-core';
+import { ComposedEditorItemRegistry, ItemIconComponent } from '../registry';
+export declare const builtInItemColors: string[];
+export declare const getItemColorFromID: (id: string) => string;
+export declare const getItemColor: (surveyItem: SurveyItemCore) => string | undefined;
+/** Returns the registry key for an item ("root" for root groups, otherwise item.type). */
+export declare const getItemTypeKey: (item: SurveyItemCore) => string;
+export interface ItemTypeInfos {
+    key: string;
+    label: string;
+    description: string;
+    defaultItemClassName?: string;
+    icon: ItemIconComponent;
+}
+export declare const getItemTypeInfos: (item: SurveyItemCore, registry?: ComposedEditorItemRegistry) => ItemTypeInfos;
+export declare const getItemTypeInfosByType: (itemType: string | undefined, registry?: ComposedEditorItemRegistry) => ItemTypeInfos | undefined;
+/**
+ * Hook to access item type infos for a specific item type.
+ * Pass an item type string (e.g. "singleChoiceQuestion", "root") or undefined.
+ * Returns undefined when itemType is undefined.
+ * Must be used within EditorStoreProvider.
+ */
+export declare function useItemTypeInfos(itemType: string | undefined): ItemTypeInfos | undefined;

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

@@ -0,0 +1 @@
+export { SurveyPlayer } from './survey-player';

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

@@ -0,0 +1,23 @@
+import { default as React } from 'react';
+import { Survey, SurveyEngineCore } from '@case-framework/survey-core';
+export type HandlerFuncArgType = string | number | boolean | null | undefined;
+export type HandlerFunction = (handlerId: string, args?: HandlerFuncArgType[]) => Promise<{
+    error?: string;
+    result?: HandlerFuncArgType;
+}>;
+interface SurveyContextValue {
+    survey: Survey;
+    locale: string;
+    surveyEngine: SurveyEngineCore;
+    runExternalHandler?: HandlerFunction;
+}
+interface SurveyContextProviderProps {
+    survey: Survey;
+    locale: string;
+    surveyEngine: SurveyEngineCore;
+    children: React.ReactNode;
+    onRunExternalHandler?: HandlerFunction;
+}
+export declare const SurveyContextProvider: React.FC<SurveyContextProviderProps>;
+export declare const useSurveyCtx: () => SurveyContextValue;
+export {};

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

@@ -0,0 +1,17 @@
+import { RenderedSurveyItem, ResponseItem, SurveyItemCore, SurveyItemTranslations } from '@case-framework/survey-core';
+interface SurveyItemContextValue {
+    item: SurveyItemCore;
+    renderedItemInfos: RenderedSurveyItem;
+    itemTranslations?: SurveyItemTranslations;
+    currentResponse?: ResponseItem;
+    headerId: string;
+    width: number;
+    setResponse(response?: ResponseItem): void;
+}
+interface SurveyItemContextProviderProps {
+    children: React.ReactNode;
+    renderedItemInfos: RenderedSurveyItem;
+}
+export declare const SurveyItemContextProvider: React.FC<SurveyItemContextProviderProps>;
+export declare const useSurveyItemCtx: () => SurveyItemContextValue;
+export {};

package/dist/modules/survey-player/survey-item/survey-item-types/question-wrapper.d.ts

@@ -0,0 +1,5 @@
+interface QuestionWrapperProps {
+    children: React.ReactNode;
+}
+declare const QuestionWrapper: React.FC<QuestionWrapperProps>;
+export default QuestionWrapper;

package/dist/modules/survey-player/survey-item/survey-item-types/single-choice-question-renderer.d.ts

@@ -0,0 +1,7 @@
+import { default as React } from 'react';
+import { RenderedSurveyItem } from '@case-framework/survey-core';
+interface SingleChoiceQuestionRendererProps {
+    renderedItem?: RenderedSurveyItem;
+}
+declare const SingleChoiceQuestionRenderer: React.FC<SingleChoiceQuestionRendererProps>;
+export default SingleChoiceQuestionRenderer;

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

@@ -0,0 +1,7 @@
+import { default as React } from 'react';
+import { RenderedSurveyItem } from '@case-framework/survey-core';
+interface SurveyItemRendererProps {
+    item: RenderedSurveyItem;
+}
+declare const SurveyItemRenderer: React.FC<SurveyItemRendererProps>;
+export default SurveyItemRenderer;

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

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare const SurveyPlayer: React.FC;