@acorex-platform/module-assessment-management-client 0.0.20

package/types/acorex-platform-module-assessment-management-client-contracts.d.ts

@@ -0,0 +1,752 @@
+import { AXPMultiLanguageString, AXPExpression, AXPWidgetNode, AXPEntityReference, AXPFileListItem } from '@acorex-platform/framework-shared/core';
+import * as _acorex_platform_module_assessment_management_client_contracts from '@acorex-platform/module-assessment-management-client/contracts';
+import { AXPEntityModel } from '@acorex-platform/framework-shared/entity';
+
+declare const AXMAssessmentManagementFeatureKeys: {
+    readonly QuestionnaireManagement: "AssessmentManagement:Feature:Questionnaire.Management";
+};
+
+declare const AXPAssessmentManagementMenuKeys: {
+    readonly Questionnaires: "AssessmentManagement:Menu:Questionnaires";
+    readonly Cases: "AssessmentManagement:Menu:Cases";
+    readonly QuestionBankItems: "AssessmentManagement:Menu:QuestionBankItems";
+};
+
+/**
+ * Safety & Risk capabilities used by this module.
+ * Domain capability keys for this module. Root groups live in `AXPCommonPermissionGroupKeys` (common contracts).
+ */
+declare const AXPSafetyRiskPermissionKeys: {
+    readonly Access: "SafetyRisk:Permission:Access";
+    readonly MaintainSafety: "SafetyRisk:Permission:MaintainSafety";
+    readonly MaintainRisk: "SafetyRisk:Permission:MaintainRisk";
+    readonly MaintainHealth: "SafetyRisk:Permission:MaintainHealth";
+    readonly MaintainAssessments: "SafetyRisk:Permission:MaintainAssessments";
+    readonly Setup: "SafetyRisk:Permission:Setup";
+};
+/**
+ * @deprecated Prefer {@link AXPSafetyRiskPermissionKeys}.
+ * Legacy nested shape kept so existing imports compile during migration.
+ */
+declare const AXMAssessmentManagementPermissionKeys: {
+    readonly AssessmentManagement: {
+        readonly QuestionBank: "SafetyRisk:Permission:MaintainAssessments";
+        readonly Questionnaire: {
+            readonly Management: "SafetyRisk:Permission:MaintainAssessments";
+            readonly Create: "SafetyRisk:Permission:MaintainAssessments";
+            readonly Edit: "SafetyRisk:Permission:MaintainAssessments";
+            readonly Delete: "SafetyRisk:Permission:MaintainAssessments";
+        };
+        readonly Case: {
+            readonly Management: "SafetyRisk:Permission:MaintainAssessments";
+        };
+        readonly Session: {
+            readonly Management: "SafetyRisk:Permission:MaintainAssessments";
+        };
+        readonly Automation: {
+            readonly Management: "SafetyRisk:Permission:MaintainAssessments";
+        };
+    };
+};
+
+/** Component key for the questionnaire Outcomes page tab. Register via AXP_PAGE_COMPONENT_PROVIDER. */
+declare const QUESTIONNAIRE_OUTCOMES_PAGE_COMPONENT_KEY = "questionnaire-outcomes-page";
+
+/** Component key for the questionnaire Questions page tab. Register via AXP_PAGE_COMPONENT_PROVIDER. */
+declare const QUESTIONNAIRE_QUESTIONS_PAGE_COMPONENT_KEY = "questionnaire-questions-page";
+
+/**
+ * Respondent free-text comment configuration (per question bank item; overridable per questionnaire item).
+ *
+ * `enabled` follows the same boolean | expression pattern as question `isVisible` / `isRequired`
+ * (property-viewer toggle binding). Optional `isVisible` remains as a legacy/additional gate.
+ */
+interface AXMAssessmentQuestionCommentConfig {
+    /** `true` / `false`, or a visibility expression string (shown in Allow Comments). */
+    enabled: boolean | AXPExpression;
+    required: boolean;
+    /**
+     * Optional extra visibility gate (legacy). Prefer putting conditions on {@link enabled}.
+     * Omitted / `true` = no extra gate; `false` hides; string = expression.
+     */
+    isVisible?: boolean | AXPExpression;
+}
+/**
+ * Visual style when a hint is shown (maps to ax-alert color).
+ */
+type AXMAssessmentQuestionHintVisualMode = 'info' | 'warning' | 'danger' | 'success' | 'neutral';
+/**
+ * `off` = no hint (same intent as "hidden" / "none"); visual modes require {@link AXMAssessmentQuestionHintConfigShown.content}.
+ */
+type AXMAssessmentQuestionHintMode = 'off' | AXMAssessmentQuestionHintVisualMode;
+type AXMAssessmentQuestionHintConfigOff = {
+    mode: 'off';
+};
+type AXMAssessmentQuestionHintConfigShown = {
+    mode: AXMAssessmentQuestionHintVisualMode;
+    content: AXPMultiLanguageString;
+};
+/**
+ * Question hint configuration (question bank default; overridable per questionnaire item).
+ */
+type AXMAssessmentQuestionHintConfig = AXMAssessmentQuestionHintConfigOff | AXMAssessmentQuestionHintConfigShown;
+/**
+ * Partial override on a questionnaire item (`undefined` / omitted fields inherit from the bank).
+ */
+type AXMAssessmentQuestionHintPartial = {
+    mode?: AXMAssessmentQuestionHintMode;
+    content?: AXPMultiLanguageString;
+};
+
+/** Paper size for the generated PDF. */
+type QuestionnairePrintPaperSize = 'A4' | 'Letter' | 'Legal';
+/** Page orientation for the generated PDF. */
+type QuestionnairePrintOrientation = 'portrait' | 'landscape';
+/** Resolved print page breaks (no sidebar). Follows Display view mode. */
+type QuestionnairePrintPaging = 'single-page' | 'page-per-group' | 'page-per-question';
+/**
+ * Print document options stored on the questionnaire (defaults) and accepted as overrides
+ * by the print host / snapshot service.
+ */
+interface QuestionnairePrintSettings {
+    paperSize?: QuestionnairePrintPaperSize;
+    orientation?: QuestionnairePrintOrientation;
+    /** Optional diagonal text on every page. Empty means no watermark. */
+    watermark?: string;
+    showQuestionNumbers?: boolean;
+    showWelcomeScreen?: boolean;
+    showSummaryAfterSubmit?: boolean;
+    showOutcomeResults?: boolean;
+    showUnansweredQuestions?: boolean;
+    showComments?: boolean;
+    showAttachments?: boolean;
+    showHints?: boolean;
+    showNotes?: boolean;
+}
+declare const DEFAULT_QUESTIONNAIRE_PRINT_SETTINGS: Required<QuestionnairePrintSettings>;
+/** Side margin used by the print document and Chromium PDF engine. */
+declare const PRINT_PAGE_SIDE_MARGIN_MM = 14;
+/**
+ * Playwright paints repeating letterhead in the top/bottom margin box.
+ * These must stay large enough for the company header/footer; measuring
+ * chrome height under-reported and overlapped the questionnaire title.
+ */
+declare const PRINT_PAGE_LETTERHEAD_TOP_MARGIN_MM = 36;
+declare const PRINT_PAGE_LETTERHEAD_BOTTOM_MARGIN_MM = 28;
+declare function resolvePrintLetterheadPdfMargin(): {
+    top: string;
+    right: string;
+    bottom: string;
+    left: string;
+};
+declare function normalizePrintPaperSize(value: unknown): QuestionnairePrintPaperSize;
+declare function normalizePrintOrientation(value: unknown): QuestionnairePrintOrientation;
+declare function normalizePrintWatermark(value: unknown): string;
+/**
+ * Merges questionnaire defaults with an optional per-call override.
+ * Undefined override fields keep the stored / built-in default.
+ */
+declare function resolvePrintSettings(stored?: Partial<QuestionnairePrintSettings> | null, override?: Partial<QuestionnairePrintSettings> | null): Required<QuestionnairePrintSettings>;
+/**
+ * Resolves print page breaks from the Display view mode.
+ * `side-menu` prints as page-per-group (no sidebar).
+ */
+declare function resolvePrintPaging(displayViewMode?: string | null): QuestionnairePrintPaging;
+/** Content width after side margins, for the off-screen print host and wrapped HTML. */
+declare function resolvePrintContentWidthMm(print: Pick<QuestionnairePrintSettings, 'paperSize' | 'orientation'>): number;
+declare function resolvePrintPdfPageOptions(print: Pick<QuestionnairePrintSettings, 'paperSize' | 'orientation'>): {
+    format: QuestionnairePrintPaperSize;
+    landscape: boolean;
+};
+
+/**
+ * Display settings for questionnaire viewer
+ */
+/** Whether the respondent can save a draft before final submit. */
+type QuestionnaireCompletionMode = 'submit-only' | 'save-and-continue';
+interface QuestionnaireDisplaySettings {
+    /**
+     * View mode: single-page, page-per-group, page-per-question, side-menu
+     */
+    viewMode?: 'single-page' | 'page-per-group' | 'page-per-question' | 'side-menu';
+    /**
+     * submit-only: final submit only; save-and-continue: draft save + submit.
+     */
+    completionMode?: QuestionnaireCompletionMode;
+    /**
+     * Show progress bar
+     */
+    showProgressBar?: boolean;
+    /**
+     * Progress calculation mode: answered or navigation
+     */
+    progressMode?: 'answered' | 'navigation';
+    /**
+     * Show timer
+     */
+    showTimer?: boolean;
+    /**
+     * Show question numbers
+     */
+    showQuestionNumbers?: boolean;
+    /**
+     * Auto-save answers as user types
+     */
+    autoSave?: boolean;
+    /**
+     * Show validation errors inline
+     */
+    showValidationErrors?: boolean;
+    /**
+     * Allow skipping questions (if not required)
+     */
+    allowSkipping?: boolean;
+    /**
+     * Show question counter (e.g., "Question 3 of 10")
+     */
+    showQuestionCounter?: boolean;
+    /**
+     * Validation timing strategy:
+     * - step: validate on each step/section navigation
+     * - end: validate only at final submit
+     * Default: step
+     */
+    validationStrategy?: 'step' | 'end';
+}
+/**
+ * Value structure stored in entity (simplified for persistence)
+ */
+interface QuestionnaireBuilderValue {
+    sections: Array<{
+        name: string;
+        title: AXPMultiLanguageString;
+        description?: AXPMultiLanguageString;
+        order: number;
+        tags?: string[];
+        isVisible?: boolean | AXPExpression;
+        items: Array<{
+            name: string;
+            questionBankItemId: string;
+            order: number;
+            isRequired?: boolean | AXPExpression;
+            isVisible?: boolean | AXPExpression;
+            interfaceOverride?: AXPWidgetNode;
+            hint?: AXMAssessmentQuestionHintPartial;
+            comment?: Partial<AXMAssessmentQuestionCommentConfig>;
+            tags?: string[];
+        }>;
+    }>;
+    /**
+     * Display settings for questionnaire viewer
+     */
+    displaySettings?: QuestionnaireDisplaySettings;
+    /**
+     * Print document defaults (overridable per print call).
+     */
+    printSettings?: QuestionnairePrintSettings;
+}
+
+declare const RootConfig: {
+    readonly config: {
+        readonly i18n: "assessment-management";
+        readonly module: "AssessmentManagement";
+    };
+    readonly module: {
+        readonly module: "assessment-management";
+        readonly route: "assessment-management";
+        readonly name: "AssessmentManagement";
+        readonly title: "@assessment-management:module.title";
+        readonly icon: "fa-light fa-clipboard-list-check";
+    };
+    readonly entities: {
+        readonly questionBankItem: {
+            readonly name: "QuestionBankItem";
+            readonly title: "@assessment-management:question-bank.entities.question-bank-item.title";
+            readonly titlePlural: "@assessment-management:question-bank.entities.question-bank-item.plural";
+            readonly icon: "fa-light fa-question-circle";
+        };
+        readonly questionnaire: {
+            readonly name: "Questionnaire";
+            readonly title: "@assessment-management:questionnaires.entities.questionnaire.title";
+            readonly titlePlural: "@assessment-management:questionnaires.entities.questionnaire.plural";
+            readonly icon: "fa-light fa-clipboard-list";
+        };
+        readonly assessmentCase: {
+            readonly name: "AssessmentCase";
+            readonly title: "@assessment-management:cases.entities.assessment-case.title";
+            readonly titlePlural: "@assessment-management:cases.entities.assessment-case.plural";
+            readonly icon: "fa-light fa-briefcase";
+        };
+        readonly assessmentSession: {
+            readonly name: "AssessmentSession";
+            readonly title: "@assessment-management:sessions.entities.assessment-session.title";
+            readonly titlePlural: "@assessment-management:sessions.entities.assessment-session.plural";
+            readonly icon: "fa-light fa-clipboard-check";
+        };
+    };
+    readonly queries: {
+        readonly dashboard: {
+            readonly overdueAssessmentsKpi: "AssessmentManagement:Dashboard:OverdueAssessmentsKpi";
+            readonly pendingAssessmentsKpi: "AssessmentManagement:Dashboard:PendingAssessmentsKpi";
+            readonly myAssessmentsKpi: "AssessmentManagement:Dashboard:MyAssessmentsKpi";
+            readonly assessmentsWeekLine: "AssessmentManagement:Dashboard:AssessmentsWeekLine";
+        };
+    };
+};
+
+/** Server command that renders a filled assessment session to PDF. */
+declare const AXM_ASSESSMENT_SESSION_PREVIEW_PDF_COMMAND_KEY: "AssessmentManagement:AssessmentSession:PreviewPdf";
+/** Client / entity-menu command that opens the PDF preview dialog. */
+declare const AXM_ASSESSMENT_SESSION_PREVIEW_PDF_CLIENT_COMMAND_KEY: "AssessmentManagement.AssessmentSession:PreviewPdf";
+interface AXMAssessmentSessionPreviewPdfRequest {
+    /** Specific session. Required when `caseId` and `printHtmlGzip` are omitted. */
+    sessionId?: string;
+    /** When `sessionId` is omitted, the latest session for this case is used. */
+    caseId?: string;
+    /**
+     * Questionnaire ID. Used when there is no session (builder Preview) so the
+     * selected print text template and tenant can still be loaded.
+     */
+    questionnaireId?: string;
+    /** Locale for MLS titles and answer formatting. Defaults to `en-US`. */
+    locale?: string;
+    /**
+     * Gzipped live questionnaire HTML. When set, the PDF is rendered from this
+     * snapshot and session lookup is skipped.
+     */
+    printHtmlGzip?: string;
+    /** File / header title when rendering a live snapshot. */
+    title?: string;
+    /** Overrides questionnaire `printTemplateId` for this render. */
+    printTemplateId?: string;
+    /** Overrides questionnaire paper size for this render. */
+    paperSize?: 'A4' | 'Letter' | 'Legal';
+    /** Overrides questionnaire orientation for this render. */
+    orientation?: 'portrait' | 'landscape';
+    /** Overrides questionnaire watermark for this render. */
+    watermark?: string;
+}
+interface AXMAssessmentSessionPreviewPdfResult {
+    filename: string;
+    contentType: 'application/pdf';
+    base64: string;
+}
+
+/**
+ * Event merge keys passed to `ContentManagement:TextTemplate:Render` (`channel: print`).
+ * Names must match `PlatformManagement.Tokens` Event rows.
+ */
+declare const AXM_ASSESSMENT_PRINT_MERGE_KEYS: {
+    readonly questionnaireTitle: "questionnaireTitle";
+    readonly caseTitle: "caseTitle";
+    readonly sessionDate: "sessionDate";
+    readonly generatedAt: "generatedAt";
+    readonly status: "status";
+    readonly statusLabel: "statusLabel";
+    readonly sessionBody: "sessionBody";
+};
+type AXMAssessmentPrintMergeKey = (typeof AXM_ASSESSMENT_PRINT_MERGE_KEYS)[keyof typeof AXM_ASSESSMENT_PRINT_MERGE_KEYS];
+
+declare const ASSESSMENT_PRINT_PAGE_FORMAT: _acorex_platform_module_assessment_management_client_contracts.QuestionnairePrintPaperSize;
+/** A4 portrait content width after 14mm side margins (210 - 14 - 14). */
+declare const ASSESSMENT_PRINT_CONTENT_WIDTH_MM: number;
+declare const ASSESSMENT_PRINT_HTML_GZIP_ENCODING: "gzip-base64";
+declare function minifyPrintHtml(html: string): string;
+declare function resolvePrintPlainText(value: unknown): string;
+declare function formatPrintAnswerText(value: unknown): string;
+interface QuestionnairePrintQuestionHtml {
+    titleHtml: string;
+    answerHtml: string;
+    number?: string;
+    answered?: boolean;
+    /** Full cloned `.__question-item` card; used as-is when present. */
+    cardHtml?: string;
+}
+interface QuestionnairePrintBodySection {
+    title: string;
+    questions: QuestionnairePrintQuestionHtml[];
+}
+declare function buildQuestionnaireQuestionCardHtml(input: QuestionnairePrintQuestionHtml): string;
+declare function buildQuestionnairePrintBodyHtml(input: {
+    title: string;
+    caseTitle?: string;
+    status?: string;
+    sections: QuestionnairePrintBodySection[];
+}): string;
+/** Q&A sections only — title/date live in the questionnaire print child template. */
+declare function buildQuestionnaireSessionBodyHtml(input: {
+    sections: QuestionnairePrintBodySection[];
+}): string;
+interface QuestionnairePrintHeaderInput {
+    title: string;
+    caseTitle?: string;
+    sessionDate?: string;
+    statusLabel?: string;
+}
+/** Compact repeating questionnaire band: title left, date/status right. */
+declare function buildQuestionnairePrintHeaderRegion(input: QuestionnairePrintHeaderInput): string;
+/**
+ * Ensures the compact questionnaire header is the last `data-print-region="header"`
+ * (under the company letterhead) and removes the old first-page-only title block.
+ */
+declare function applyQuestionnairePrintHeader(html: string, input: QuestionnairePrintHeaderInput): string;
+/** Inner body of a wrapped print document, without watermark. */
+declare function extractPrintDocumentBodyHtml(html: string): string;
+declare function wrapPrintDocument(input: {
+    title: string;
+    bodyHtml: string;
+    headerHtml?: string;
+    footerHtml?: string;
+    print?: Partial<QuestionnairePrintSettings> | null;
+}): {
+    html: string;
+    headerHtml: string;
+    footerHtml: string;
+};
+declare function escapePrintDocumentText(value: string): string;
+
+type AXMAssessmentCaseStatus = 'draft' | 'active' | 'in-progress' | 'closed' | 'cancelled';
+interface AXMAssessmentManagementAssessmentCaseEntityModel extends AXPEntityModel<string> {
+    /**
+     * Single questionnaire assigned to this case.
+     */
+    questionnaireId: string;
+    /**
+     * Optional friendly title for lists/search.
+     */
+    title: string;
+    /**
+     * Target entity (e.g. AssetManagement.Asset, HumanCapital.Employee).
+     */
+    subjectRef: AXPEntityReference;
+    /** Status plugin field (`assessment-management.status.case`). */
+    statusId?: AXMAssessmentCaseStatus;
+}
+
+type AXMAssessmentSessionRole = 'responder' | 'supervisor' | 'reviewer';
+type AXMAssessmentSessionStatus = 'not-started' | 'in-progress' | 'submitted' | 'under-review' | 'approved' | 'rejected' | 'completed';
+interface AXMAssessmentManagementAssessmentSessionEntityModel extends AXPEntityModel<string> {
+    caseId: string;
+    responderId: string;
+    role: AXMAssessmentSessionRole;
+    /** Status plugin field (`assessment-management.status.session`). */
+    statusId?: AXMAssessmentSessionStatus;
+    startedAt?: Date;
+    lastSavedAt?: Date;
+    timeSpent?: number;
+    progressPercentage: number;
+    answeredQuestionsCount: number;
+    answers: Record<string, unknown>;
+    /**
+     * Evaluated questionnaire outcome values (rule `name` → value), snapshot at submit.
+     */
+    outcomes?: Record<string, unknown>;
+    /**
+     * Gzip+base64 print HTML captured on the client after submit.
+     * Server gunzips this and sends it to the HTML-to-PDF engine.
+     */
+    printHtmlGzip?: string;
+    previousId?: string;
+}
+
+/** Provenance when `interface` was loaded from a meta-data definition (frozen clone). */
+interface AXMQuestionBankItemInterfaceMetadata {
+    id: string;
+    name: string;
+    title: AXPMultiLanguageString | string;
+    /**
+     * TODO: Set from definition versioning when the versioning system is implemented (placeholder until then).
+     */
+    version: number;
+}
+type AXMQuestionBankItemInterfaceValue = AXPWidgetNode & {
+    metadata?: AXMQuestionBankItemInterfaceMetadata;
+};
+interface AXMAssessmentManagementQuestionBankItemEntityModel extends AXPEntityModel<string> {
+    /**
+     * Short label for the question bank list (administrators).
+     * Not used as the respondent-facing question text; see `question`.
+     */
+    title: AXPMultiLanguageString;
+    /** Unique variable name for questionnaire outcomes (answer.eval('name')). */
+    name?: string;
+    /** Respondent-facing question body (rich text). */
+    question?: AXPMultiLanguageString;
+    /** Optional note (rich text); formerly description. */
+    note?: AXPMultiLanguageString;
+    categoryId?: string;
+    /** Registered catalog scope keys (see platform catalog scope providers). */
+    catalogScopeKeys?: string[];
+    /** Resolved scope labels for list display (enriched by catalog-scope resolver middleware). */
+    catalogScopes?: Array<{
+        name: string;
+        title: string;
+        cssClass?: string;
+    }>;
+    tags?: string[];
+    difficulty?: 'easy' | 'medium' | 'hard';
+    estimatedTime?: number;
+    /** Default hint (rich text + style, or off). Overridable per questionnaire item. */
+    hint?: AXMAssessmentQuestionHintConfig;
+    /** Default respondent comment box policy (overridable per questionnaire item). */
+    comment?: AXMAssessmentQuestionCommentConfig;
+    interface?: AXMQuestionBankItemInterfaceValue;
+}
+
+/**
+ * Default when no configuration is stored.
+ */
+declare const DEFAULT_QUESTION_COMMENT_CONFIG: AXMAssessmentQuestionCommentConfig;
+/**
+ * Normalizes API / partial values to a complete config.
+ * Preserves expression strings on `enabled` (Allow Comments toggle binding).
+ */
+declare function normalizeQuestionCommentConfig(value: Partial<AXMAssessmentQuestionCommentConfig> | null | undefined): AXMAssessmentQuestionCommentConfig;
+/**
+ * Merges question bank defaults with optional questionnaire item overrides.
+ */
+declare function mergeQuestionCommentConfig(bank: Partial<AXMAssessmentQuestionCommentConfig> | null | undefined, override: Partial<AXMAssessmentQuestionCommentConfig> | null | undefined): AXMAssessmentQuestionCommentConfig;
+/**
+ * Returns only fields that differ from the bank default (for persisting questionnaire item overrides).
+ */
+declare function diffQuestionCommentOverride(bank: AXMAssessmentQuestionCommentConfig, edited: AXMAssessmentQuestionCommentConfig): Partial<AXMAssessmentQuestionCommentConfig> | undefined;
+/**
+ * Form context for the question edit dialog: surface legacy `isVisible` expressions on `enabled`
+ * (Allow Comments) so they display and save like question `isVisible`.
+ */
+declare function commentConfigForEditForm(merged: AXMAssessmentQuestionCommentConfig): Pick<AXMAssessmentQuestionCommentConfig, 'enabled' | 'required'>;
+/**
+ * Effective visibility flag for the comment box (for async evaluation).
+ * Prefers expression/`false` on `enabled`; falls back to legacy `isVisible` when `enabled === true`.
+ */
+declare function getQuestionCommentVisibilityFlag(comment: AXMAssessmentQuestionCommentConfig | null | undefined): boolean | AXPExpression | undefined;
+/**
+ * Context path for the respondent comment text for a questionnaire item (`answers.comments.<itemName>`).
+ */
+declare function getQuestionAnswerCommentStoragePath(questionItemName: string): string;
+
+declare const DEFAULT_QUESTION_HINT_CONFIG: AXMAssessmentQuestionHintConfig;
+/** Normalizes select / API values to a hint mode (exported for questionnaire builder forms). */
+declare function normalizeQuestionHintMode(raw: unknown): AXMAssessmentQuestionHintMode | undefined;
+/**
+ * Reads optional `hint` or legacy flat `hintContent` / `hintMode` from a record (API / persisted rows).
+ */
+declare function readHintFieldsFromRecord(rec: Record<string, unknown> | null | undefined): {
+    hint?: unknown;
+    legacyContent?: unknown;
+    legacyMode?: unknown;
+};
+/**
+ * Normalizes API / partial values to a complete config. Coerces legacy flat fields when `hint` is absent.
+ */
+declare function normalizeQuestionHintConfig(value: AXMAssessmentQuestionHintConfig | AXMAssessmentQuestionHintPartial | null | undefined, legacy?: {
+    hintContent?: AXPMultiLanguageString;
+    hintMode?: unknown;
+}): AXMAssessmentQuestionHintConfig;
+/**
+ * Merges question bank defaults with optional questionnaire item overrides (per-field, like former hintContent/hintMode).
+ */
+declare function mergeQuestionHintForViewer(bank: AXMAssessmentQuestionHintConfig | null | undefined, item: AXMAssessmentQuestionHintPartial | null | undefined): AXMAssessmentQuestionHintConfig;
+/**
+ * Returns only fields that differ from the bank default (for persisting questionnaire item overrides).
+ */
+declare function diffQuestionHintOverride(bank: AXMAssessmentQuestionHintConfig, edited: AXMAssessmentQuestionHintConfig): AXMAssessmentQuestionHintPartial | undefined;
+/**
+ * Normalizes a question bank row (or similar) to a full hint config, including legacy flat fields.
+ */
+declare function normalizeQuestionHintFromEntityRow(row: unknown): AXMAssessmentQuestionHintConfig;
+/**
+ * Reads optional questionnaire item hint override from a persisted item record (including legacy keys).
+ */
+declare function parseQuestionHintPartialFromRecord(row: Record<string, unknown> | null | undefined): AXMAssessmentQuestionHintPartial | undefined;
+
+/**
+ * Pre- / post-questionnaire rich text (welcome, summary, etc.).
+ * @alias AXPMultiLanguageString
+ */
+type PrePostContentValue = AXPMultiLanguageString;
+/**
+ * Pre-questionnaire configuration (shown before questions).
+ */
+interface PreQuestionnaireConfig {
+    enabled: boolean;
+    /** Rich text content. Supports multi-language: Record<locale, string>. */
+    content?: PrePostContentValue;
+}
+/**
+ * Post-questionnaire configuration (review before submit, summary after submit).
+ * Summary content supports placeholders: {{totalQuestions}}, {{answeredCount}}, {{totalTime}}, {{elapsedSeconds}}, and {{outcomeName}} from configured outcomes.
+ */
+interface PostQuestionnaireConfig {
+    /** Show review step before submit (all answers, edit/submit). */
+    reviewEnabled: boolean;
+    /** Show summary screen after submit. */
+    summaryEnabled: boolean;
+    /** When true, show a separate step with outcome results (name/value list). */
+    showOutcomeResults?: boolean;
+    /** Rich text content for summary. Supports multi-language and placeholders. */
+    summaryContent?: PrePostContentValue;
+}
+/**
+ * Entity-level display options (viewer / builder preview). Subset of {@link QuestionnaireDisplaySettings}.
+ */
+type QuestionnaireEntityDisplaySettings = Pick<QuestionnaireDisplaySettings, 'viewMode' | 'showProgressBar' | 'showTimer' | 'showQuestionNumbers' | 'validationStrategy' | 'completionMode'>;
+declare const DEFAULT_PRE_QUESTIONNAIRE_CONFIG: PreQuestionnaireConfig;
+declare const DEFAULT_POST_QUESTIONNAIRE_CONFIG: PostQuestionnaireConfig;
+declare const DEFAULT_QUESTIONNAIRE_ENTITY_DISPLAY: QuestionnaireEntityDisplaySettings;
+/** Entity-level print document defaults. */
+type QuestionnaireEntityPrintSettings = QuestionnairePrintSettings;
+declare const DEFAULT_QUESTIONNAIRE_ENTITY_PRINT: Required<QuestionnaireEntityPrintSettings>;
+/**
+ * Pre/post configuration for viewer flow (from {@link toPrePostConfig}).
+ */
+interface PrePostConfig {
+    pre: PreQuestionnaireConfig;
+    post: PostQuestionnaireConfig;
+}
+/** Primitive type of an evaluated outcome value (coercion after expression runs). */
+type QuestionnaireOutcomeResultKind = 'number' | 'string' | 'boolean';
+/** Text emphasis for outcome result display rules. */
+type QuestionnaireOutcomeDisplayEmphasis = 'normal' | 'medium' | 'bold';
+/** Comparison operator for display rule conditions against the evaluated outcome `value`. */
+type QuestionnaireOutcomeDisplayOperator = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte';
+/**
+ * Theme color chooser value: `"foreground background border"` (hex or utility classes).
+ */
+type QuestionnaireOutcomeDisplayColor = string;
+/** Icon chooser value or resolved Font Awesome class string. */
+type QuestionnaireOutcomeDisplayIcon = string | {
+    label?: string;
+    styleClass?: string;
+    iconClass?: string;
+};
+/**
+ * Conditional styling for an outcome value in the results step.
+ * Rules are evaluated in order; the first matching condition wins.
+ */
+interface QuestionnaireOutcomeDisplayRule {
+    id: string;
+    order: number;
+    operator: QuestionnaireOutcomeDisplayOperator;
+    compareValue: number | string | boolean;
+    /** Theme color chooser value applied to the outcome value in results. */
+    color: QuestionnaireOutcomeDisplayColor;
+    emphasis?: QuestionnaireOutcomeDisplayEmphasis;
+    icon?: QuestionnaireOutcomeDisplayIcon;
+}
+/** Parses a theme color chooser value into foreground, background, and border parts. */
+declare function parseQuestionnaireOutcomeDisplayColor(value: string | null | undefined): {
+    foreground: string;
+    background: string;
+    border: string;
+} | null;
+declare function isQuestionnaireOutcomeDisplayColorHex(value: string): boolean;
+/**
+ * Returns true when the evaluated outcome value matches the display rule condition.
+ */
+declare function matchesQuestionnaireOutcomeDisplayRule(value: unknown, rule: Pick<QuestionnaireOutcomeDisplayRule, 'operator' | 'compareValue'>): boolean;
+declare function normalizeQuestionnaireOutcomeDisplayRules(rules: QuestionnaireOutcomeDisplayRule[] | null | undefined): QuestionnaireOutcomeDisplayRule[];
+/**
+ * Named outcome rule embedded on a questionnaire.
+ * Referenced in expressions via outcome.eval('name') and in summary placeholders as {{name}}.
+ */
+interface QuestionnaireOutcomeItem {
+    id: string;
+    /** Unique programmatic name within the questionnaire (variable-name style). */
+    name: string;
+    title?: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString;
+    resultKind: QuestionnaireOutcomeResultKind;
+    /**
+     * Use `{{ ... }}` or plain expression body; scope includes `answer.eval`, `outcome.eval`, and `fn.*`.
+     */
+    expression: string;
+    /** Optional ordered display rules applied to the evaluated value in the results step. */
+    displayRules?: QuestionnaireOutcomeDisplayRule[];
+}
+/** Section grouping outcome rules (same builder pattern as questionnaire questions). */
+interface QuestionnaireOutcomeSection {
+    /** Unique technical section name. */
+    name: string;
+    title?: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString;
+    order: number;
+    items: QuestionnaireOutcomeItem[];
+    isNewlyAdded?: boolean;
+}
+/** Embedded outcome rules on questionnaire. */
+interface QuestionnaireOutcomesValue {
+    sections: QuestionnaireOutcomeSection[];
+}
+declare const DEFAULT_QUESTIONNAIRE_OUTCOMES: QuestionnaireOutcomesValue;
+declare function normalizeQuestionnaireOutcomesValue(value: QuestionnaireOutcomesValue | null | undefined): QuestionnaireOutcomesValue;
+/** All outcome items across sections (evaluation, automations, duplicate checks). */
+declare function flattenQuestionnaireOutcomeItems(value: QuestionnaireOutcomesValue | null | undefined): QuestionnaireOutcomeItem[];
+declare function findDuplicateOutcomeNames(value: QuestionnaireOutcomesValue | null | undefined): string[];
+interface AXMAssessmentManagementQuestionnaireEntityModel extends AXPEntityModel<string> {
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString;
+    type: 'questionnaire' | 'survey' | 'checklist' | 'test' | 'evaluation';
+    questions?: QuestionnaireBuilderValue;
+    /** Named outcome rules evaluated from answers (outcome.eval / summary placeholders). */
+    outcomes?: QuestionnaireOutcomesValue;
+    /** Viewer / preview display. */
+    display?: QuestionnaireEntityDisplaySettings;
+    /** Print document defaults (overridable per print call). */
+    print?: QuestionnaireEntityPrintSettings;
+    /**
+     * Content text template used for PDF chrome (child of the tenant print master).
+     * Empty uses the seeded Questionnaire Print template.
+     */
+    printTemplateId?: string | null;
+    /** Welcome screen before questions. */
+    pre?: PreQuestionnaireConfig;
+    /** Review before submit, summary / results after submit. */
+    post?: PostQuestionnaireConfig;
+    categoryId?: string;
+    /** Registered catalog scope keys (see {@link AXP_CATALOG_SCOPE_DEFINITION_PROVIDER}). */
+    catalogScopeKeys?: string[];
+    /** Resolved scope labels for list display (enriched by catalog-scope resolver middleware). */
+    catalogScopes?: Array<{
+        name: string;
+        title: AXPMultiLanguageString | string;
+        cssClass?: string;
+    }>;
+    tags?: string[];
+    color?: string;
+    /** Reference documents for respondents (attachments plugin). */
+    attachments?: AXPFileListItem[] | string[];
+}
+/**
+ * Maps entity pre/post to viewer config (defaults when omitted).
+ */
+declare function toPrePostConfig(q: Partial<AXMAssessmentManagementQuestionnaireEntityModel> | null | undefined): PrePostConfig | null;
+declare const VIEW_MODE_VALUES: readonly ["single-page", "page-per-group", "page-per-question", "side-menu"];
+type ViewModeValue = (typeof VIEW_MODE_VALUES)[number];
+declare const VALIDATION_STRATEGY_VALUES: readonly ["step", "end"];
+type ValidationStrategyValue = (typeof VALIDATION_STRATEGY_VALUES)[number];
+declare const COMPLETION_MODE_VALUES: readonly ["submit-only", "save-and-continue"];
+type CompletionModeValue = (typeof COMPLETION_MODE_VALUES)[number];
+/**
+ * Coerces stored view mode (string or SelectBox `{ id }`) to a known value.
+ */
+declare function normalizeViewMode(value: unknown): ViewModeValue;
+/**
+ * Coerces stored validation strategy (string or SelectBox `{ id }`) to a known value.
+ */
+declare function normalizeValidationStrategy(value: unknown): ValidationStrategyValue;
+/**
+ * Coerces stored completion mode (string or SelectBox `{ id }`) to a known value.
+ */
+declare function normalizeCompletionMode(value: unknown): CompletionModeValue;
+/**
+ * Maps entity `display` to {@link QuestionnaireDisplaySettings} (defaults when omitted).
+ */
+declare function toDisplaySettings(q: Partial<AXMAssessmentManagementQuestionnaireEntityModel> | null | undefined): QuestionnaireDisplaySettings | null;
+/**
+ * Maps entity `print` to {@link QuestionnairePrintSettings} (defaults when omitted).
+ */
+declare function toPrintSettings(q: Partial<AXMAssessmentManagementQuestionnaireEntityModel> | null | undefined): QuestionnairePrintSettings | null;
+
+export { ASSESSMENT_PRINT_CONTENT_WIDTH_MM, ASSESSMENT_PRINT_HTML_GZIP_ENCODING, ASSESSMENT_PRINT_PAGE_FORMAT, AXMAssessmentManagementFeatureKeys, AXMAssessmentManagementPermissionKeys, AXM_ASSESSMENT_PRINT_MERGE_KEYS, AXM_ASSESSMENT_SESSION_PREVIEW_PDF_CLIENT_COMMAND_KEY, AXM_ASSESSMENT_SESSION_PREVIEW_PDF_COMMAND_KEY, AXPAssessmentManagementMenuKeys, AXPSafetyRiskPermissionKeys, DEFAULT_POST_QUESTIONNAIRE_CONFIG, DEFAULT_PRE_QUESTIONNAIRE_CONFIG, DEFAULT_QUESTIONNAIRE_ENTITY_DISPLAY, DEFAULT_QUESTIONNAIRE_ENTITY_PRINT, DEFAULT_QUESTIONNAIRE_OUTCOMES, DEFAULT_QUESTIONNAIRE_PRINT_SETTINGS, DEFAULT_QUESTION_COMMENT_CONFIG, DEFAULT_QUESTION_HINT_CONFIG, PRINT_PAGE_LETTERHEAD_BOTTOM_MARGIN_MM, PRINT_PAGE_LETTERHEAD_TOP_MARGIN_MM, PRINT_PAGE_SIDE_MARGIN_MM, QUESTIONNAIRE_OUTCOMES_PAGE_COMPONENT_KEY, QUESTIONNAIRE_QUESTIONS_PAGE_COMPONENT_KEY, RootConfig, applyQuestionnairePrintHeader, buildQuestionnairePrintBodyHtml, buildQuestionnairePrintHeaderRegion, buildQuestionnaireQuestionCardHtml, buildQuestionnaireSessionBodyHtml, commentConfigForEditForm, diffQuestionCommentOverride, diffQuestionHintOverride, escapePrintDocumentText, extractPrintDocumentBodyHtml, findDuplicateOutcomeNames, flattenQuestionnaireOutcomeItems, formatPrintAnswerText, getQuestionAnswerCommentStoragePath, getQuestionCommentVisibilityFlag, isQuestionnaireOutcomeDisplayColorHex, matchesQuestionnaireOutcomeDisplayRule, mergeQuestionCommentConfig, mergeQuestionHintForViewer, minifyPrintHtml, normalizeCompletionMode, normalizePrintOrientation, normalizePrintPaperSize, normalizePrintWatermark, normalizeQuestionCommentConfig, normalizeQuestionHintConfig, normalizeQuestionHintFromEntityRow, normalizeQuestionHintMode, normalizeQuestionnaireOutcomeDisplayRules, normalizeQuestionnaireOutcomesValue, normalizeValidationStrategy, normalizeViewMode, parseQuestionHintPartialFromRecord, parseQuestionnaireOutcomeDisplayColor, readHintFieldsFromRecord, resolvePrintContentWidthMm, resolvePrintLetterheadPdfMargin, resolvePrintPaging, resolvePrintPdfPageOptions, resolvePrintPlainText, resolvePrintSettings, toDisplaySettings, toPrePostConfig, toPrintSettings, wrapPrintDocument };
+export type { AXMAssessmentCaseStatus, AXMAssessmentManagementAssessmentCaseEntityModel, AXMAssessmentManagementAssessmentSessionEntityModel, AXMAssessmentManagementQuestionBankItemEntityModel, AXMAssessmentManagementQuestionnaireEntityModel, AXMAssessmentPrintMergeKey, AXMAssessmentQuestionCommentConfig, AXMAssessmentQuestionHintConfig, AXMAssessmentQuestionHintConfigOff, AXMAssessmentQuestionHintConfigShown, AXMAssessmentQuestionHintMode, AXMAssessmentQuestionHintPartial, AXMAssessmentQuestionHintVisualMode, AXMAssessmentSessionPreviewPdfRequest, AXMAssessmentSessionPreviewPdfResult, AXMAssessmentSessionRole, AXMAssessmentSessionStatus, AXMQuestionBankItemInterfaceMetadata, AXMQuestionBankItemInterfaceValue, PostQuestionnaireConfig, PrePostConfig, PrePostContentValue, PreQuestionnaireConfig, QuestionnaireBuilderValue, QuestionnaireCompletionMode, QuestionnaireDisplaySettings, QuestionnaireEntityDisplaySettings, QuestionnaireEntityPrintSettings, QuestionnaireOutcomeDisplayColor, QuestionnaireOutcomeDisplayEmphasis, QuestionnaireOutcomeDisplayIcon, QuestionnaireOutcomeDisplayOperator, QuestionnaireOutcomeDisplayRule, QuestionnaireOutcomeItem, QuestionnaireOutcomeResultKind, QuestionnaireOutcomeSection, QuestionnaireOutcomesValue, QuestionnairePrintBodySection, QuestionnairePrintHeaderInput, QuestionnairePrintOrientation, QuestionnairePrintPaging, QuestionnairePrintPaperSize, QuestionnairePrintQuestionHtml, QuestionnairePrintSettings };