@acorex-platform/module-assessment-management-client 0.0.38 → 0.0.46

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

@@ -1,9 +1,10 @@
-import { AXPMultiLanguageString, AXPExpression, AXPWidgetNode, AXPEntityReference, AXPFileListItem } from '@acorex-platform/framework-shared/core';
+import { AXPMultiLanguageString, AXPExpression, AXPWidgetNode, AXPModuleManifest, 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';
+import { AXPEntityModel, AXPEntityCreateDto, AXPEntityDetailDto, AXPEntityListItemDto, AXPEntityUpdateDto } from '@acorex-platform/framework-shared/entity';
 
 declare const AXMAssessmentManagementFeatureKeys: {
     readonly QuestionnaireManagement: "AssessmentManagement:Feature:Questionnaire.Management";
+    readonly FormTemplates: "AssessmentManagement:Feature:FormTemplates";
 };
 
 declare const AXPAssessmentManagementMenuKeys: {
@@ -12,6 +13,11 @@ declare const AXPAssessmentManagementMenuKeys: {
     readonly QuestionBankItems: "AssessmentManagement:Menu:QuestionBankItems";
 };
 
+declare const AXPFormTemplateManagementMenuKeys: {
+    readonly Root: "FormTemplateManagement:Menu";
+    readonly Templates: "FormTemplateManagement:Menu:Templates";
+};
+
 /**
  * Safety & Risk capabilities used by this module.
  * Domain capability keys for this module. Root groups live in `AXPCommonPermissionGroupKeys` (common contracts).
@@ -49,6 +55,40 @@ declare const AXMAssessmentManagementPermissionKeys: {
     };
 };
 
+/**
+ * Content & Documents capabilities used by this module.
+ * Domain capability keys for this module. Root groups live in `AXPCommonPermissionGroupKeys` (common contracts).
+ */
+declare const AXPContentDocumentsPermissionKeys: {
+    readonly Access: "ContentDocuments:Permission:Access";
+    readonly MaintainDocuments: "ContentDocuments:Permission:MaintainDocuments";
+    readonly MaintainContent: "ContentDocuments:Permission:MaintainContent";
+    readonly MaintainFormTemplates: "ContentDocuments:Permission:MaintainFormTemplates";
+    readonly Setup: "ContentDocuments:Permission:Setup";
+};
+/**
+ * @deprecated Prefer {@link AXPContentDocumentsPermissionKeys}.
+ * Legacy nested shape kept so existing imports compile during migration.
+ */
+declare const AXPFormTemplateManagementPermissionKeys: {
+    readonly FormTemplate: {
+        readonly Templates: {
+            readonly Management: "ContentDocuments:Permission:MaintainFormTemplates";
+            readonly View: "ContentDocuments:Permission:MaintainFormTemplates";
+            readonly Edit: "ContentDocuments:Permission:MaintainFormTemplates";
+            readonly Delete: "ContentDocuments:Permission:MaintainFormTemplates";
+            readonly Create: "ContentDocuments:Permission:MaintainFormTemplates";
+        };
+    };
+};
+
+declare enum AXPFormTemplateSettings {
+    HistoryPanel = "FormTemplateManagement:Setting:Designer.HistoryPanel",
+    AutoSave = "FormTemplateManagement:Setting:Designer.AutoSave",
+    AutoSaveInterval = "FormTemplateManagement:Setting:Designer.AutoSaveInterval",
+    AutoSaveTimeout = "FormTemplateManagement:Setting:Designer.AutoSaveTimeout"
+}
+
 /** Component key for the questionnaire Outcomes page tab. Register via AXP_PAGE_COMPONENT_PROVIDER. */
 declare const QUESTIONNAIRE_OUTCOMES_PAGE_COMPONENT_KEY = "questionnaire-outcomes-page";
 
@@ -283,6 +323,12 @@ declare const RootConfig: {
             readonly titlePlural: "@assessment-management:sessions.entities.assessment-session.plural";
             readonly icon: "fa-light fa-clipboard-check";
         };
+        readonly template: {
+            readonly name: "Template";
+            readonly title: "@form-template-management:templates.entities.template.title";
+            readonly source: "AssessmentManagement.Template";
+            readonly icon: "fa-light fa-file-code";
+        };
     };
     readonly queries: {
         readonly dashboard: {
@@ -294,6 +340,12 @@ declare const RootConfig: {
     };
 };
 
+/**
+ * Assessment Management Module Manifest.
+ * Defines module metadata, features, and provider references.
+ */
+declare const AssessmentManagementManifest: AXPModuleManifest;
+
 /** 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. */
@@ -560,6 +612,9 @@ declare function normalizeQuestionHintFromEntityRow(row: unknown): AXMAssessment
  */
 declare function parseQuestionHintPartialFromRecord(row: Record<string, unknown> | null | undefined): AXMAssessmentQuestionHintPartial | undefined;
 
+/**
+ * Shared pre/post content and outcome rules for questionnaires and form templates.
+ */
 /**
  * Pre- / post-questionnaire rich text (welcome, summary, etc.).
  * @alias AXPMultiLanguageString
@@ -587,16 +642,8 @@ interface PostQuestionnaireConfig {
     /** 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}).
  */
@@ -611,7 +658,8 @@ 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).
+ * Theme color chooser value: a surface class such as `warning-lightest-surface`,
+ * or three hex tokens `"#foreground #background #border"`.
  */
 type QuestionnaireOutcomeDisplayColor = string;
 /** Icon chooser value or resolved Font Awesome class string. */
@@ -683,6 +731,19 @@ declare function normalizeQuestionnaireOutcomesValue(value: QuestionnaireOutcome
 /** 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[];
+type AssessmentOutcomeItem = QuestionnaireOutcomeItem;
+type AssessmentOutcomesValue = QuestionnaireOutcomesValue;
+type AssessmentPreContent = PreQuestionnaireConfig;
+type AssessmentPostContent = PostQuestionnaireConfig;
+
+/**
+ * Entity-level display options (viewer / builder preview). Subset of {@link QuestionnaireDisplaySettings}.
+ */
+type QuestionnaireEntityDisplaySettings = Pick<QuestionnaireDisplaySettings, 'viewMode' | 'showProgressBar' | 'showTimer' | 'showQuestionNumbers' | 'validationStrategy' | 'completionMode'>;
+declare const DEFAULT_QUESTIONNAIRE_ENTITY_DISPLAY: QuestionnaireEntityDisplaySettings;
+/** Entity-level print document defaults. */
+type QuestionnaireEntityPrintSettings = QuestionnairePrintSettings;
+declare const DEFAULT_QUESTIONNAIRE_ENTITY_PRINT: Required<QuestionnaireEntityPrintSettings>;
 interface AXMAssessmentManagementQuestionnaireEntityModel extends AXPEntityModel<string> {
     title: AXPMultiLanguageString;
     description?: AXPMultiLanguageString;
@@ -748,5 +809,70 @@ declare function toDisplaySettings(q: Partial<AXMAssessmentManagementQuestionnai
  */
 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 };
+interface AXMFormTemplateTypeOption {
+    id: number;
+    title: string;
+}
+declare const AXMFormTemplateTypes: {
+    Form: {
+        id: number;
+        title: string;
+    };
+    Widget: {
+        id: number;
+        title: string;
+    };
+    Report: {
+        id: number;
+        title: string;
+    };
+};
+type AXMFormTemplateType = (typeof AXMFormTemplateTypes)[keyof typeof AXMFormTemplateTypes];
+interface AXMCreateFormTemplateDto extends AXPEntityCreateDto {
+    code: string;
+    title: string;
+    description?: string;
+    template?: string | null;
+    type: AXMFormTemplateTypeOption;
+    categoryIds: string[];
+    pre?: AssessmentPreContent;
+    post?: AssessmentPostContent;
+    outcomes?: AssessmentOutcomesValue;
+}
+interface AXMUpdateFormTemplateDto extends AXPEntityUpdateDto<string> {
+    title: string;
+    description?: string;
+    type: AXMFormTemplateTypeOption;
+    template?: string;
+    categoryIds: string[];
+    pre?: AssessmentPreContent;
+    post?: AssessmentPostContent;
+    outcomes?: AssessmentOutcomesValue;
+}
+interface AXMFormTemplateDetailDto extends AXPEntityDetailDto<string> {
+    title: string;
+    description?: string;
+    type: AXMFormTemplateTypeOption;
+    template: string | null;
+    categoryIds: string[];
+    categories: {
+        id: string;
+        title: string;
+    }[];
+    pre?: AssessmentPreContent;
+    post?: AssessmentPostContent;
+    outcomes?: AssessmentOutcomesValue;
+}
+interface AXMFormTemplateListItemDto extends AXPEntityListItemDto<string> {
+    title: string;
+    description?: string;
+    type: AXMFormTemplateTypeOption;
+    categoryIds: string[];
+    categories: {
+        id: string;
+        title: string;
+    }[];
+}
+
+export { ASSESSMENT_PRINT_CONTENT_WIDTH_MM, ASSESSMENT_PRINT_HTML_GZIP_ENCODING, ASSESSMENT_PRINT_PAGE_FORMAT, AXMAssessmentManagementFeatureKeys, AXMAssessmentManagementPermissionKeys, AXMFormTemplateTypes, AXM_ASSESSMENT_PRINT_MERGE_KEYS, AXM_ASSESSMENT_SESSION_PREVIEW_PDF_CLIENT_COMMAND_KEY, AXM_ASSESSMENT_SESSION_PREVIEW_PDF_COMMAND_KEY, AXPAssessmentManagementMenuKeys, AXPContentDocumentsPermissionKeys, AXPFormTemplateManagementMenuKeys, AXPFormTemplateManagementPermissionKeys, AXPFormTemplateSettings, AXPSafetyRiskPermissionKeys, AssessmentManagementManifest, 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, AXMCreateFormTemplateDto, AXMFormTemplateDetailDto, AXMFormTemplateListItemDto, AXMFormTemplateType, AXMFormTemplateTypeOption, AXMQuestionBankItemInterfaceMetadata, AXMQuestionBankItemInterfaceValue, AXMUpdateFormTemplateDto, AssessmentOutcomeItem, AssessmentOutcomesValue, AssessmentPostContent, AssessmentPreContent, 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 };

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

@@ -3,9 +3,10 @@ import { AXPMenuProvider, AXPMenuProviderContext, AXPSearchCommandProvider, AXPS
 import { AXPPermissionDefinitionProvider, AXPPermissionDefinitionProviderContext } from '@acorex-platform/framework-client/auth';
 import * as _angular_core from '@angular/core';
 import { OnInit } from '@angular/core';
-import * as i1 from '@acorex/core/file';
+import * as i1$1 from '@acorex-platform/framework-client/layout/widgets';
 import * as _acorex_platform_framework_client_layout_widget_core from '@acorex-platform/framework-client/layout/widget-core';
 import { AXPWidgetContainerComponent } from '@acorex-platform/framework-client/layout/widget-core';
+import * as i1 from '@acorex/core/file';
 import * as _ngrx_signals from '@ngrx/signals';
 import * as _acorex_platform_framework_shared_core from '@acorex-platform/framework-shared/core';
 import { AXPMultiLanguageString, AXPExpression, AXPWidgetNode } from '@acorex-platform/framework-shared/core';
@@ -646,7 +647,7 @@ declare class AXMQuestionnaireViewerFeatureModule {
 
 declare class AXMAssessmentManagementModule {
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMAssessmentManagementModule, never>;
-    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<AXMAssessmentManagementModule, never, [typeof AXMAssessmentManagementFileTypeModule, typeof AXMQuestionnaireBuilderFeatureModule, typeof AXMQuestionnaireViewerFeatureModule], never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<AXMAssessmentManagementModule, never, [typeof i1$1.AXPWidgetsModule, typeof _acorex_platform_framework_client_layout_widget_core.AXPWidgetCoreModule, typeof AXMAssessmentManagementFileTypeModule, typeof AXMQuestionnaireBuilderFeatureModule, typeof AXMQuestionnaireViewerFeatureModule], never>;
     static ɵinj: _angular_core.ɵɵInjectorDeclaration<AXMAssessmentManagementModule>;
 }