@habit.analytics/habit-claims-journey-components 2.2.0 → 2.3.0

package/README.md

@@ -327,6 +327,7 @@ interface FormField {
 interface SummaryPanelConfig {
   title: string;
   show_pricing?: boolean;
+  show_sidebar?: boolean; // defaults to true
   sections: SummarySection[];
 }
 

package/dist/components/runner/FormRunnerWidget.d.ts

@@ -1,4 +1,4 @@
-import { JourneySpec, UploadResult } from '../../types/journey';
+import { JourneySpec, FormStep, UploadResult } from '../../types/journey';
 export type StepApiRequest = {
     step_id: string;
     method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
@@ -12,10 +12,28 @@ export type InitApiRequest = {
     url: string;
     headers?: Record<string, string>;
 };
+export interface FormRunnerSaveContext {
+    reason: 'step_change' | 'manual' | 'progress';
+    currentStep: FormStep;
+    currentStepIndex: number;
+    nextStepId?: string;
+    stage?: 'welcome' | 'form' | 'summary';
+}
 export interface FormRunnerWidgetProps {
     journey: JourneySpec;
     onSubmit?: (answers: Record<string, unknown>) => void;
-    onSave?: (partialAnswers: Record<string, unknown>) => void;
+    onSave?: (partialAnswers: Record<string, unknown>, context?: FormRunnerSaveContext) => void | Promise<void>;
+    onProgressChange?: (partialAnswers: Record<string, unknown>, context: FormRunnerSaveContext) => void;
+    /**
+     * Automatically calls `onSave` when the user advances from one step to another.
+     * Defaults to `true`; set to `false` to keep saving only under host control.
+     */
+    autoSaveOnStepChange?: boolean;
+    /**
+     * Whether to show the live summary panel while the user fills the form.
+     * Defaults to `true`. The final summary screen remains available.
+     */
+    showSummaryPanel?: boolean;
     onFileSelect?: (file: File, questionKey: string) => Promise<string | UploadResult | void> | void;
     /**
      * Optional handler to delegate per-step API calls to the host app.

package/dist/i18n/locales/en.d.ts

@@ -223,6 +223,8 @@ declare const en: {
     readonly fc_nav_field_requires_value: "Field \"{{label}}\" requires a value.";
     readonly fc_summary_panel: "Summary Panel";
     readonly fc_summary_title_label: "Summary Title";
+    readonly fc_summary_show_sidebar: "Show live summary";
+    readonly fc_summary_show_sidebar_hint: "Display the summary sidebar while the user moves through the journey.";
     readonly fc_summary_sections: "Sections";
     readonly fc_summary_add_section: "Add Section";
     readonly fc_summary_section_title_placeholder: "Section title";