@harshshahcg/survey-render 1.2.0 → 1.3.0

package/dist/components/SurveyRenderer.d.ts

@@ -1,9 +1,17 @@
 import type { SurveyConfig, SurveySubmitPayload } from "../types/survey.types";
+import type { PLCSurveyConfig } from "../converters/types";
 import type { SurveyProgressBarConfig } from "./SurveyContainer";
+/** Survey input: FMB (internal format) or PLC (converted to FMB at runtime). */
+export type SurveyInputData = SurveyConfig | PLCSurveyConfig;
+/** Payload passed to onSubmit/onSave: FMB or PLC depending on input data type. */
+export type SurveySubmitPayloadUnion = SurveySubmitPayload | import("../converters/types").PLCSubmitPayload;
 export interface SurveyRendererProps {
-    data: SurveyConfig;
-    onSubmit: (payload: SurveySubmitPayload) => void;
-    onSave?: (payload: SurveySubmitPayload) => void;
+    /** Survey config in FMB or PLC format. PLC is auto-converted to FMB internally. */
+    data: SurveyInputData;
+    /** Called with submit payload in same format as input (FMB or PLC). */
+    onSubmit: (payload: SurveySubmitPayloadUnion) => void;
+    /** Called with draft payload in same format as input (FMB or PLC). */
+    onSave?: (payload: SurveySubmitPayloadUnion) => void;
     onExit?: () => void;
     isSubmitting?: boolean;
     className?: string;
@@ -15,7 +23,6 @@ export interface SurveyRendererProps {
 }
 /**
  * Main entry component. Renders a full survey from JSON config.
- * Supports: conditional questions, validation, media uploads, progress bar, themes.
- * Wrap your app root (or survey container) with data-theme for styling.
+ * Supports FMB and PLC formats; PLC is converted to FMB internally. Output format matches input.
  */
 export declare function SurveyRenderer({ data, onSubmit, onSave, onExit, isSubmitting, className, showHeader, theme, progressBar, }: SurveyRendererProps): import("react/jsx-runtime").JSX.Element;

package/dist/converters/detectFormat.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Detect survey format from input data.
+ * Uses type field when present; otherwise infers from structure.
+ */
+import type { SurveyConfig } from "../types/survey.types";
+import type { PLCSurveyConfig, SurveyType } from "./types";
+/**
+ * Detects whether the survey data is PLC or FMB format.
+ * @param data - Survey input (must have type and questionList)
+ * @returns "PLC" | "FMB"
+ */
+export declare function detectSurveyFormat(data: unknown): SurveyType;
+/**
+ * Type guard: data is valid PLC survey config (after format detection).
+ */
+export declare function isPLCData(data: unknown): data is PLCSurveyConfig;
+/**
+ * Type guard: data is FMB survey config.
+ */
+export declare function isFMBData(data: unknown): data is SurveyConfig;

package/dist/converters/fmbToPlcOutput.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Convert FMB submit payload back to PLC format.
+ * Used when the survey was initialized with PLC data so output matches input format.
+ * Each response item includes question text, correct_answer, selected_answer (option letters), and correct_answer_option.
+ */
+import type { SurveySubmitPayload } from "../types/survey.types";
+import type { PLCSurveyConfig, PLCSubmitPayload } from "./types";
+/**
+ * Convert FMB submit payload to PLC format.
+ * @param fmbPayload - Payload in FMB format (from formatResponses / submit)
+ * @param originalPlcSurvey - The PLC config that was converted to FMB at init
+ */
+export declare function convertFMBToPLC(fmbPayload: SurveySubmitPayload, originalPlcSurvey: PLCSurveyConfig): PLCSubmitPayload;

package/dist/converters/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Format utilities: detect format, convert PLC ↔ FMB.
+ * Library always works internally with FMB; conversion is at boundary.
+ */
+export { detectSurveyFormat, isPLCData, isFMBData, } from "./detectFormat";
+export { convertPLCToFMB } from "./plcToFmbInput";
+export { convertFMBToPLC } from "./fmbToPlcOutput";
+export type { SurveyType, BaseSurveyInput, PLCQuestion, PLCSurveyConfig, PLCResponseItem, PLCSubmitPayload, SurveySubmitPayloadUnion, } from "./types";
+export { isPLCSurvey, isFMBSurvey } from "./types";

package/dist/converters/plcToFmbInput.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Convert PLC survey config to FMB (SurveyConfig).
+ * Library always works internally with FMB.
+ */
+import type { SurveyConfig } from "../types/survey.types";
+import type { PLCSurveyConfig } from "./types";
+/**
+ * Convert PLC survey config to FMB SurveyConfig.
+ * Use the result for all internal rendering and state.
+ */
+export declare function convertPLCToFMB(plcData: PLCSurveyConfig): SurveyConfig;

package/dist/converters/types.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Shared types for survey format detection and conversion.
+ * Library always works internally with FMB; PLC is converted at input and output.
+ */
+import type { SurveyConfig, SurveySubmitPayload } from "../types/survey.types";
+export type SurveyType = "FMB" | "PLC";
+export interface BaseSurveyInput {
+    type: SurveyType;
+    surveyId: string;
+    surveyCode?: string;
+    surveyName?: string;
+    medium: string;
+    config?: Record<string, unknown>;
+    questionList: unknown[];
+}
+/** PLC question structure (input format). */
+export interface PLCQuestion {
+    image: string;
+    question: string;
+    question_type: "scq" | "mcq";
+    options: string[];
+    correct_answer: string[];
+    correct_answer_option: string[];
+    question_number: number;
+    isMandatory: boolean;
+}
+/** PLC survey config (input format). */
+export interface PLCSurveyConfig extends BaseSurveyInput {
+    type: "PLC";
+    questionList: PLCQuestion[];
+}
+/** Type guard: input has type field "PLC". */
+export declare function isPLCSurvey(data: BaseSurveyInput): data is PLCSurveyConfig;
+/** Type guard: input has type field "FMB". */
+export declare function isFMBSurvey(data: BaseSurveyInput | {
+    type?: string;
+}): data is SurveyConfig;
+/** PLC response item: full question and answer info for each question. */
+export interface PLCResponseItem {
+    question_number: number;
+    question: string;
+    correct_answer: string[];
+    selected_answer: string[];
+    correct_answer_option: string[];
+}
+/** Payload returned on submit/save when input was PLC. */
+export interface PLCSubmitPayload {
+    type: "PLC";
+    surveyId: string;
+    surveyCode?: string;
+    surveyName?: string;
+    medium: string;
+    config?: Record<string, unknown>;
+    responses: PLCResponseItem[];
+}
+/** Union: submit/save callback receives FMB or PLC payload depending on input format. */
+export type SurveySubmitPayloadUnion = SurveySubmitPayload | PLCSubmitPayload;

package/dist/index.d.ts

@@ -28,10 +28,12 @@ export { validateResponses, canSubmit, } from "./utils/validation";
 export type { ValidationErrorItem } from "./utils/validation";
 export { formatResponses } from "./utils/responseFormatter";
 export type { InternalResponses } from "./utils/responseFormatter";
-export { getQuestionStatusMap } from "./utils/questionStatus";
+export { getQuestionStatusMap, getQuestionStatus } from "./utils/questionStatus";
 export type { QuestionStatus } from "./utils/questionStatus";
 export { validateFile, validateFileType, validateFileSize, fileToFileObject, isValueFileObject, getEffectiveMediaConfig, MEDIA_ALLOWED_TYPES, MEDIA_MAX_SIZE_MB, } from "./utils/fileUtils";
 export type { FileValidationResult, EffectiveMediaConfig } from "./utils/fileUtils";
 export { DEFAULT_MEDIA_ALLOWED_TYPES, DEFAULT_MEDIA_MAX_SIZE_MB, } from "./helpers/constants";
 export { getStatusClass, getStatusColor, getStatusIconClass } from "./utils/themeStatusStyles";
 export { calculateWeightedProgress, type ProgressMetrics, } from "./utils/progressCalculation";
+export { detectSurveyFormat, isPLCData, isFMBData, convertPLCToFMB, convertFMBToPLC, isPLCSurvey, isFMBSurvey, } from "./converters";
+export type { SurveyType, PLCQuestion, PLCSurveyConfig, PLCResponseItem, PLCSubmitPayload, SurveySubmitPayloadUnion, } from "./converters";