@acorex-platform/module-learning-management-client 0.0.21

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

@@ -0,0 +1,532 @@
+import { AXPEntityModel } from '@acorex-platform/framework-shared/entity';
+import { AXPMultiLanguageString, AXPCategoryListItem } from '@acorex-platform/framework-shared/core';
+
+declare const AXMLearningManagementMenuKeys: {
+    readonly Root: "learning-management:menu";
+    readonly ConfigurationRoot: "learning-management:menu:configuration";
+    readonly Skills: "learning-management:menu:skills";
+    readonly Courses: "learning-management:menu:courses";
+    readonly Trainings: "learning-management:menu:trainings";
+    readonly Enrollments: "learning-management:menu:enrollments";
+    readonly Certificates: "learning-management:menu:certificates";
+    readonly Licenses: "learning-management:menu:licenses";
+    readonly LearningPaths: "learning-management:menu:learning-paths";
+    readonly Compliance: "learning-management:menu:compliance";
+};
+
+/**
+ * Learning capabilities used by this module.
+ * Domain capability keys for this module. Root groups live in `AXPCommonPermissionGroupKeys` (common contracts).
+ */
+declare const AXPLearningPermissionKeys: {
+    readonly Access: "Learning:Permission:Access";
+    readonly MaintainLearning: "Learning:Permission:MaintainLearning";
+    readonly Setup: "Learning:Permission:Setup";
+};
+/**
+ * @deprecated Prefer {@link AXPLearningPermissionKeys}.
+ * Legacy nested shape kept so existing imports compile during migration.
+ */
+declare const AXMLearningManagementPermissionKeys: {
+    readonly LearningManagement: {
+        readonly Management: "Learning:Permission:MaintainLearning";
+        readonly SkillCategory: {
+            readonly Management: "Learning:Permission:Setup";
+            readonly View: "Learning:Permission:Setup";
+            readonly Create: "Learning:Permission:Setup";
+            readonly Update: "Learning:Permission:Setup";
+            readonly Delete: "Learning:Permission:Setup";
+        };
+        readonly Skill: {
+            readonly Management: "Learning:Permission:Setup";
+            readonly View: "Learning:Permission:Setup";
+            readonly Create: "Learning:Permission:Setup";
+            readonly Update: "Learning:Permission:Setup";
+            readonly Delete: "Learning:Permission:Setup";
+        };
+        readonly SkillLevel: {
+            readonly Management: "Learning:Permission:Setup";
+            readonly View: "Learning:Permission:Setup";
+            readonly Create: "Learning:Permission:Setup";
+            readonly Update: "Learning:Permission:Setup";
+            readonly Delete: "Learning:Permission:Setup";
+        };
+        readonly CourseType: {
+            readonly Management: "Learning:Permission:Setup";
+            readonly View: "Learning:Permission:Setup";
+            readonly Create: "Learning:Permission:Setup";
+            readonly Update: "Learning:Permission:Setup";
+            readonly Delete: "Learning:Permission:Setup";
+        };
+        readonly Course: {
+            readonly Management: "Learning:Permission:MaintainLearning";
+            readonly View: "Learning:Permission:MaintainLearning";
+            readonly Create: "Learning:Permission:MaintainLearning";
+            readonly Update: "Learning:Permission:MaintainLearning";
+            readonly Delete: "Learning:Permission:MaintainLearning";
+            readonly Publish: "Learning:Permission:MaintainLearning";
+        };
+        readonly TrainingType: {
+            readonly Management: "Learning:Permission:Setup";
+            readonly View: "Learning:Permission:Setup";
+            readonly Create: "Learning:Permission:Setup";
+            readonly Update: "Learning:Permission:Setup";
+            readonly Delete: "Learning:Permission:Setup";
+        };
+        readonly TrainingDefinition: {
+            readonly Management: "Learning:Permission:Setup";
+            readonly View: "Learning:Permission:Setup";
+            readonly Create: "Learning:Permission:Setup";
+            readonly Update: "Learning:Permission:Setup";
+            readonly Delete: "Learning:Permission:Setup";
+            readonly Publish: "Learning:Permission:Setup";
+        };
+        readonly Training: {
+            readonly Management: "Learning:Permission:MaintainLearning";
+            readonly View: "Learning:Permission:MaintainLearning";
+            readonly Create: "Learning:Permission:MaintainLearning";
+            readonly Update: "Learning:Permission:MaintainLearning";
+            readonly Delete: "Learning:Permission:MaintainLearning";
+            readonly Schedule: "Learning:Permission:MaintainLearning";
+            readonly Close: "Learning:Permission:MaintainLearning";
+        };
+        readonly Enrollment: {
+            readonly Management: "Learning:Permission:MaintainLearning";
+            readonly View: "Learning:Permission:MaintainLearning";
+            readonly Create: "Learning:Permission:MaintainLearning";
+            readonly Update: "Learning:Permission:MaintainLearning";
+            readonly Delete: "Learning:Permission:MaintainLearning";
+            readonly Process: "Learning:Permission:MaintainLearning";
+        };
+        readonly Attendance: {
+            readonly Management: "Learning:Permission:MaintainLearning";
+            readonly View: "Learning:Permission:MaintainLearning";
+            readonly Create: "Learning:Permission:MaintainLearning";
+            readonly Update: "Learning:Permission:MaintainLearning";
+            readonly Delete: "Learning:Permission:MaintainLearning";
+            readonly Record: "Learning:Permission:MaintainLearning";
+        };
+        readonly CertificateType: {
+            readonly Management: "Learning:Permission:Setup";
+            readonly View: "Learning:Permission:Setup";
+            readonly Create: "Learning:Permission:Setup";
+            readonly Update: "Learning:Permission:Setup";
+            readonly Delete: "Learning:Permission:Setup";
+        };
+        readonly CertificateDefinition: {
+            readonly Management: "Learning:Permission:Setup";
+            readonly View: "Learning:Permission:Setup";
+            readonly Create: "Learning:Permission:Setup";
+            readonly Update: "Learning:Permission:Setup";
+            readonly Delete: "Learning:Permission:Setup";
+            readonly Publish: "Learning:Permission:Setup";
+        };
+        readonly Certificate: {
+            readonly Management: "Learning:Permission:MaintainLearning";
+            readonly View: "Learning:Permission:MaintainLearning";
+            readonly Create: "Learning:Permission:MaintainLearning";
+            readonly Update: "Learning:Permission:MaintainLearning";
+            readonly Delete: "Learning:Permission:MaintainLearning";
+            readonly Issue: "Learning:Permission:MaintainLearning";
+            readonly Renew: "Learning:Permission:MaintainLearning";
+        };
+        readonly LearningPath: {
+            readonly Management: "Learning:Permission:MaintainLearning";
+            readonly View: "Learning:Permission:MaintainLearning";
+            readonly Create: "Learning:Permission:MaintainLearning";
+            readonly Update: "Learning:Permission:MaintainLearning";
+            readonly Delete: "Learning:Permission:MaintainLearning";
+            readonly Publish: "Learning:Permission:MaintainLearning";
+            readonly Assign: "Learning:Permission:MaintainLearning";
+        };
+        readonly MandatoryTrainingRule: {
+            readonly Management: "Learning:Permission:MaintainLearning";
+            readonly View: "Learning:Permission:MaintainLearning";
+            readonly Create: "Learning:Permission:MaintainLearning";
+            readonly Update: "Learning:Permission:MaintainLearning";
+            readonly Delete: "Learning:Permission:MaintainLearning";
+            readonly Activate: "Learning:Permission:MaintainLearning";
+        };
+    };
+};
+
+declare const RootConfig: {
+    readonly config: {
+        readonly i18n: "learning-management";
+        readonly module: "LearningManagement";
+    };
+    readonly module: {
+        readonly module: "learning-management";
+        readonly name: "LearningManagement";
+        readonly title: "@learning-management:module.title";
+        readonly icon: "fa-light fa-graduation-cap";
+    };
+    readonly entities: {
+        readonly skillCategory: {
+            readonly name: "SkillCategory";
+            readonly title: "@learning-management:skills.entities.skill-category.title";
+            readonly titlePlural: "@learning-management:skills.entities.skill-category.plural";
+            readonly icon: "fa-light fa-layer-group";
+        };
+        readonly skill: {
+            readonly name: "Skill";
+            readonly title: "@learning-management:skills.entities.skill.title";
+            readonly titlePlural: "@learning-management:skills.entities.skill.plural";
+            readonly icon: "fa-light fa-lightbulb";
+        };
+        readonly skillLevel: {
+            readonly name: "SkillLevel";
+            readonly title: "@learning-management:skills.entities.skill-level.title";
+            readonly titlePlural: "@learning-management:skills.entities.skill-level.plural";
+            readonly icon: "fa-light fa-stairs";
+        };
+        readonly courseType: {
+            readonly name: "CourseType";
+            readonly title: "@learning-management:courses.entities.course-type.title";
+            readonly titlePlural: "@learning-management:courses.entities.course-type.plural";
+            readonly icon: "fa-light fa-diagram-project";
+        };
+        readonly trainingDefinition: {
+            readonly name: "TrainingDefinition";
+            readonly title: "@learning-management:trainings.entities.training-definition.title";
+            readonly titlePlural: "@learning-management:trainings.entities.training-definition.plural";
+            readonly icon: "fa-light fa-clipboard-list-check";
+        };
+        readonly course: {
+            readonly name: "Course";
+            readonly title: "@learning-management:courses.entities.course.title";
+            readonly titlePlural: "@learning-management:courses.entities.course.plural";
+            readonly icon: "fa-light fa-book-open";
+        };
+        readonly trainingType: {
+            readonly name: "TrainingType";
+            readonly title: "@learning-management:trainings.entities.training-type.title";
+            readonly titlePlural: "@learning-management:trainings.entities.training-type.plural";
+            readonly icon: "fa-light fa-clipboard-list";
+        };
+        readonly training: {
+            readonly name: "Training";
+            readonly title: "@learning-management:trainings.entities.training.title";
+            readonly titlePlural: "@learning-management:trainings.entities.training.plural";
+            readonly icon: "fa-light fa-chalkboard-teacher";
+        };
+        readonly enrollment: {
+            readonly name: "Enrollment";
+            readonly title: "@learning-management:enrollments.entities.enrollment.title";
+            readonly titlePlural: "@learning-management:enrollments.entities.enrollment.plural";
+            readonly icon: "fa-light fa-user-plus";
+        };
+        readonly attendance: {
+            readonly name: "Attendance";
+            readonly title: "@learning-management:enrollments.entities.attendance.title";
+            readonly titlePlural: "@learning-management:enrollments.entities.attendance.plural";
+            readonly icon: "fa-light fa-calendar-check";
+        };
+        readonly certificateType: {
+            readonly name: "CertificateType";
+            readonly title: "@learning-management:certificates.entities.certificate-type.title";
+            readonly titlePlural: "@learning-management:certificates.entities.certificate-type.plural";
+            readonly icon: "fa-light fa-stamp";
+        };
+        readonly certificateDefinition: {
+            readonly name: "CertificateDefinition";
+            readonly title: "@learning-management:certificates.entities.certificate-definition.title";
+            readonly titlePlural: "@learning-management:certificates.entities.certificate-definition.plural";
+            readonly icon: "fa-light fa-scroll";
+        };
+        readonly certificate: {
+            readonly name: "Certificate";
+            readonly title: "@learning-management:certificates.entities.certificate.title";
+            readonly titlePlural: "@learning-management:certificates.entities.certificate.plural";
+            readonly icon: "fa-light fa-award";
+        };
+        readonly learningPath: {
+            readonly name: "LearningPath";
+            readonly title: "@learning-management:learning-paths.entities.learning-path.title";
+            readonly titlePlural: "@learning-management:learning-paths.entities.learning-path.plural";
+            readonly icon: "fa-light fa-route";
+        };
+        readonly learningPathCourse: {
+            readonly name: "LearningPathCourse";
+            readonly title: "@learning-management:learning-paths.entities.learning-path-course.title";
+            readonly titlePlural: "@learning-management:learning-paths.entities.learning-path-course.plural";
+            readonly icon: "fa-light fa-list-ol";
+        };
+        readonly mandatoryTrainingRule: {
+            readonly name: "MandatoryTrainingRule";
+            readonly title: "@learning-management:compliance.entities.mandatory-training-rule.title";
+            readonly titlePlural: "@learning-management:compliance.entities.mandatory-training-rule.plural";
+            readonly icon: "fa-light fa-clipboard-check";
+        };
+        readonly licenseType: {
+            readonly name: "LicenseType";
+            readonly title: "@learning-management:licenses.entities.license-type.title";
+            readonly titlePlural: "@learning-management:licenses.entities.license-type.plural";
+            readonly icon: "fa-light fa-tags";
+        };
+        readonly license: {
+            readonly name: "License";
+            readonly title: "@learning-management:licenses.entities.license.title";
+            readonly titlePlural: "@learning-management:licenses.entities.license.plural";
+            readonly icon: "fa-light fa-id-card";
+        };
+    };
+    readonly queries: {
+        readonly dashboard: {
+            readonly trainingDueKpi: "LearningManagement:Dashboard:TrainingDueKpi";
+            readonly trainingComplianceGauge: "LearningManagement:Dashboard:TrainingComplianceGauge";
+            readonly trainingStatusDonut: "LearningManagement:Dashboard:TrainingStatusDonut";
+        };
+    };
+};
+
+type AttendanceStatus = 'Present' | 'Absent' | 'Late';
+interface AXMLearningManagementAttendanceEntityModel extends AXPEntityModel<string> {
+    enrollmentId: string;
+    sessionDate: string;
+    status: AttendanceStatus;
+    enrollment?: {
+        id: string;
+        employeeId: string;
+        trainingId: string;
+    };
+    notes?: string | null;
+}
+
+interface AXMLearningManagementCertificateEntityModel extends AXPEntityModel<string> {
+    certificateDefinitionId: string;
+    certificateTypeId: string;
+    employeeId: string;
+    courseId?: string | null;
+    issueDate: string;
+    expiryDate?: string | null;
+    fileId?: string | null;
+    notes?: string | null;
+    certificateDefinition?: {
+        id: string;
+        title: AXPMultiLanguageString;
+    };
+    certificateType?: {
+        id: string;
+        title: AXPMultiLanguageString;
+    };
+    employee?: {
+        id: string;
+        displayName: string;
+    };
+    course?: {
+        id: string;
+        title: AXPMultiLanguageString;
+    };
+}
+
+interface AXMLearningManagementCertificateDefinitionEntityModel extends AXPEntityModel<string> {
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString | null;
+    certificateTypeId: string;
+    certificateType?: {
+        id: string;
+        title: AXPMultiLanguageString;
+    };
+    courseId?: string | null;
+    course?: {
+        id: string;
+        title: AXPMultiLanguageString;
+    };
+    validityDays?: number | null;
+    templateId?: string | null;
+    isActive: boolean;
+}
+
+interface AXMLearningManagementCertificateTypeEntityModel extends AXPEntityModel<string> {
+    code: string;
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString | null;
+    validityDays?: number | null;
+    templateId?: string | null;
+}
+
+interface AXMLearningManagementCourseEntityModel extends AXPEntityModel<string> {
+    code: string;
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString | null;
+    courseTypeId: string;
+    durationHours?: number | null;
+    relatedSkillIds: string[];
+    certificateDefinitionIds?: string[];
+    courseType?: {
+        id: string;
+        title: AXPMultiLanguageString;
+    };
+    skills?: Array<{
+        id: string;
+        title: AXPMultiLanguageString;
+    }>;
+    certificateDefinitions?: Array<{
+        id: string;
+        title: AXPMultiLanguageString;
+    }>;
+}
+
+interface AXMLearningManagementCourseTypeEntityModel extends AXPEntityModel<string> {
+    code: string;
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString | null;
+    deliveryMode?: string | null;
+}
+
+type EnrollmentStatus = 'Requested' | 'Approved' | 'Enrolled' | 'Completed' | 'Failed' | 'Cancelled';
+interface AXMLearningManagementEnrollmentEntityModel extends AXPEntityModel<string> {
+    employeeId: string;
+    trainingId: string;
+    status: EnrollmentStatus;
+    notes?: string | null;
+    employee?: {
+        id: string;
+        displayName: string;
+    };
+    training?: {
+        id: string;
+        title: AXPMultiLanguageString;
+    };
+}
+
+interface AXMLearningManagementLearningPathEntityModel extends AXPEntityModel<string> {
+    code: string;
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString | null;
+    isActive: boolean;
+}
+
+interface AXMLearningManagementLearningPathCourseEntityModel extends AXPEntityModel<string> {
+    learningPathId: string;
+    courseId: string;
+    orderIndex: number;
+    course?: {
+        id: string;
+        title: AXPMultiLanguageString;
+    };
+}
+
+type AXMLearningManagementLicenseValidityPeriodUnit = 'day' | 'month' | 'year';
+interface AXMLearningManagementLicenseEntityModel extends AXPEntityModel<string> {
+    code: string;
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString | null;
+    licenseTypeId: string;
+    licenseType?: {
+        id: string;
+        title: AXPMultiLanguageString;
+    };
+    validityPeriod?: number | null;
+    validityPeriodUnit?: AXMLearningManagementLicenseValidityPeriodUnit | null;
+    requiresRenewal: boolean;
+    requiresLicenseNumber: boolean;
+    requiresDocument: boolean;
+    requiresVerification: boolean;
+    renewalNoticeDays?: number | null;
+    issuingAuthorityName?: string | null;
+}
+
+interface AXMLearningManagementLicenseTypeEntityModel extends AXPEntityModel<string> {
+    code: string;
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString;
+}
+
+interface AXMLearningManagementMandatoryTrainingRuleEntityModel extends AXPEntityModel<string> {
+    positionId: string;
+    courseId: string;
+    frequencyMonths?: number | null;
+    position?: {
+        id: string;
+        title: AXPMultiLanguageString;
+    };
+    course?: {
+        id: string;
+        title: AXPMultiLanguageString;
+    };
+}
+
+interface AXMLearningManagementSkillEntityModel extends AXPEntityModel<string> {
+    /** Unique programmatic key for expressions and integrations (identifier-style). */
+    name: string;
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString | null;
+    code?: string | null;
+    categoryIds: string[];
+    categories?: AXPCategoryListItem[];
+    relatedCourseIds?: string[];
+}
+
+interface AXMLearningManagementSkillLevelEntityModel extends AXPEntityModel<string> {
+    title: AXPMultiLanguageString;
+    levelNumber: number;
+    description?: AXPMultiLanguageString | null;
+}
+
+type TrainingStatus = 'Draft' | 'Open' | 'Closed' | 'Cancelled';
+interface AXMLearningManagementTrainingEntityModel extends AXPEntityModel<string> {
+    trainingDefinitionId: string;
+    courseId: string;
+    trainingTypeId: string;
+    startDate: string;
+    endDate: string;
+    locationId?: string | null;
+    instructorId?: string | null;
+    capacity?: number | null;
+    status: TrainingStatus;
+    notes?: string | null;
+    trainingDefinition?: {
+        id: string;
+        title: AXPMultiLanguageString;
+    };
+    course?: {
+        id: string;
+        title: AXPMultiLanguageString;
+    };
+    trainingType?: {
+        id: string;
+        title: AXPMultiLanguageString;
+    };
+    location?: {
+        id: string;
+        title: string;
+    };
+    instructor?: {
+        id: string;
+        displayName: string;
+    };
+}
+
+interface AXMLearningManagementTrainingDefinitionEntityModel extends AXPEntityModel<string> {
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString | null;
+    courseId: string;
+    course?: {
+        id: string;
+        title: AXPMultiLanguageString;
+    };
+    trainingTypeId: string;
+    trainingType?: {
+        id: string;
+        title: AXPMultiLanguageString;
+    };
+    defaultDurationHours?: number | null;
+    defaultCapacity?: number | null;
+    defaultLocationId?: string | null;
+    defaultLocation?: {
+        id: string;
+        title: string;
+    };
+    isActive: boolean;
+}
+
+interface AXMLearningManagementTrainingTypeEntityModel extends AXPEntityModel<string> {
+    code: string;
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString | null;
+}
+
+export { AXMLearningManagementMenuKeys, AXMLearningManagementPermissionKeys, AXPLearningPermissionKeys, RootConfig };
+export type { AXMLearningManagementAttendanceEntityModel, AXMLearningManagementCertificateDefinitionEntityModel, AXMLearningManagementCertificateEntityModel, AXMLearningManagementCertificateTypeEntityModel, AXMLearningManagementCourseEntityModel, AXMLearningManagementCourseTypeEntityModel, AXMLearningManagementEnrollmentEntityModel, AXMLearningManagementLearningPathCourseEntityModel, AXMLearningManagementLearningPathEntityModel, AXMLearningManagementLicenseEntityModel, AXMLearningManagementLicenseTypeEntityModel, AXMLearningManagementLicenseValidityPeriodUnit, AXMLearningManagementMandatoryTrainingRuleEntityModel, AXMLearningManagementSkillEntityModel, AXMLearningManagementSkillLevelEntityModel, AXMLearningManagementTrainingDefinitionEntityModel, AXMLearningManagementTrainingEntityModel, AXMLearningManagementTrainingTypeEntityModel, AttendanceStatus, EnrollmentStatus, TrainingStatus };