@acorex-platform/module-human-capital-management-client 0.0.21

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

@@ -0,0 +1,331 @@
+import { AXPSystemStatusType, AXPIntegrationReference, AXPMultiLanguageString, AXPSystemStatuses } from '@acorex-platform/framework-shared/core';
+import { AXPEntityModel } from '@acorex-platform/framework-shared/entity';
+import { AXMMetaDataBuilderValue } from '@acorex-platform/module-data-management-contracts';
+
+/** HR catalog scope for questionnaires, question bank items, and workflow definitions. */
+declare const HCM_CATALOG_SCOPE_HR = "human-capital-management.hr";
+
+declare const AXPHumanCapitalManagementCommandKeys: {
+    readonly PositionAssignment: {
+        readonly Assign: "HumanCapitalManagement.PositionAssignment:Assign";
+        readonly Revoke: "HumanCapitalManagement.PositionAssignment:Revoke";
+    };
+    readonly LifecycleEvent: {
+        readonly StartFlow: "HumanCapitalManagement.LifecycleEvent:StartFlow";
+    };
+    readonly LeaveRequest: {
+        readonly StartFlow: "HumanCapitalManagement.LeaveRequest:StartFlow";
+    };
+    readonly Profile: {
+        readonly EditPersonalInfo: "HumanCapitalManagement.Profile:EditPersonalInfo";
+        readonly EditSignature: "HumanCapitalManagement.Profile:EditSignature";
+    };
+};
+
+declare const AXPHumanCapitalManagementFeatureKeys: {
+    readonly EmployeeManagement: "HumanCapitalManagement:Feature:Employee.Management";
+    readonly LeaveManagement: "HumanCapitalManagement:Feature:Leave.Management";
+    readonly LifecycleManagement: "HumanCapitalManagement:Feature:Lifecycle.Management";
+};
+
+/** Statuses that block starting another run for the same employee and leave type. */
+declare const AXMLeaveRequestOpenStatusIds: readonly [AXPSystemStatusType.WaitingApproval];
+
+/** Statuses that block starting another run for the same employee and event type. */
+declare const AXMLifecycleEventOpenStatusIds: readonly [AXPSystemStatusType.InProgress, AXPSystemStatusType.WaitingSignOff];
+
+declare const AXPHumanCapitalManagementMenuKeys: {
+    readonly Root: "HumanCapitalManagement:Menu";
+    readonly Employees: "HumanCapitalManagement:Menu:Employees";
+    readonly EmploymentTypes: "HumanCapitalManagement:Menu:EmploymentTypes";
+    readonly Divider1: "HumanCapitalManagement:Menu:Divider1";
+    readonly PositionAssignments: "HumanCapitalManagement:Menu:PositionAssignments";
+    readonly Divider2: "HumanCapitalManagement:Menu:Divider2";
+    readonly LeaveTypes: "HumanCapitalManagement:Menu:LeaveTypes";
+    readonly LeaveRequests: "HumanCapitalManagement:Menu:LeaveRequests";
+    readonly LeaveRequestBoard: "HumanCapitalManagement:Menu:LeaveRequestBoard";
+    readonly LifecycleEventTypes: "HumanCapitalManagement:Menu:LifecycleEventTypes";
+};
+
+/**
+ * People & Organization capabilities used by this module.
+ * Domain capability keys for this module. Root groups live in `AXPCommonPermissionGroupKeys` (common contracts).
+ */
+declare const AXPPeopleOrganizationPermissionKeys: {
+    readonly Access: "PeopleOrganization:Permission:Access";
+    readonly ViewOrganization: "PeopleOrganization:Permission:ViewOrganization";
+    readonly MaintainOrganization: "PeopleOrganization:Permission:MaintainOrganization";
+    readonly MaintainTeams: "PeopleOrganization:Permission:MaintainTeams";
+    readonly MaintainEmployees: "PeopleOrganization:Permission:MaintainEmployees";
+    readonly ManageEmployeeActions: "PeopleOrganization:Permission:ManageEmployeeActions";
+    readonly MaintainPersons: "PeopleOrganization:Permission:MaintainPersons";
+    readonly MaintainAttendance: "PeopleOrganization:Permission:MaintainAttendance";
+    readonly ManageAttendanceActions: "PeopleOrganization:Permission:ManageAttendanceActions";
+    readonly DesignJobs: "PeopleOrganization:Permission:DesignJobs";
+    readonly Setup: "PeopleOrganization:Permission:Setup";
+};
+
+declare const AXM_POSITION_ASSIGNMENT_STATUS: {
+    readonly active: AXPSystemStatusType.Active;
+    readonly scheduled: "scheduled";
+    readonly expired: "expired";
+    readonly revoked: "revoked";
+};
+type AXMPositionAssignmentStatusId = (typeof AXM_POSITION_ASSIGNMENT_STATUS)[keyof typeof AXM_POSITION_ASSIGNMENT_STATUS];
+/**
+ * Statuses that still occupy the employee / manager seat for overlap and revoke resolution.
+ * Keep in sync with position-assignment duplicate-seat validation (mock and future API rules).
+ */
+declare const AXM_POSITION_ASSIGNMENT_OVERLAPPING_STATUS_IDS: readonly AXMPositionAssignmentStatusId[];
+
+/** Result of resolving the current session user's employee EDMS folder ref. */
+interface AXMHcmProfileDocumentDriveContext {
+    employeeId: string;
+    /** e.g. `HumanCapitalManagement.Employee` */
+    refType: string;
+    /** Employee record id used as folder `refId`. */
+    refId: string;
+    /** Allowed document type names for create/upload (matches Employee documents plugin). */
+    documentTypeNames: string[];
+}
+
+declare const AXPHumanCapitalManagementQueryKeys: {
+    readonly Profile: {
+        readonly GetMyDocumentDriveContext: "HumanCapitalManagement:Profile:GetMyDocumentDriveContext";
+    };
+};
+
+declare const RootConfig: {
+    readonly config: {
+        i18n: string;
+        module: string;
+    };
+    readonly module: {
+        readonly route: "human-capital-management";
+        readonly name: string;
+        readonly title: "@human-capital-management:module.title";
+        readonly icon: "fa-light fa-users";
+    };
+    readonly entities: {
+        readonly employee: {
+            readonly name: "Employee";
+            readonly source: `${string}.Employee`;
+            readonly title: "@human-capital-management:employees.entities.employee.title";
+            readonly titlePlural: "@human-capital-management:employees.entities.employee.plural";
+            readonly icon: "fa-light fa-address-card";
+        };
+        readonly employmentType: {
+            readonly name: "EmploymentType";
+            readonly source: `${string}.EmploymentType`;
+            readonly title: "@human-capital-management:employment-types.entities.employment-type.title";
+            readonly titlePlural: "@human-capital-management:employment-types.entities.employment-type.plural";
+            readonly icon: "fa-light fa-file-signature";
+        };
+        readonly positionAssignment: {
+            readonly name: "PositionAssignment";
+            readonly source: `${string}.PositionAssignment`;
+            readonly title: "@human-capital-management:position-assignments.entities.position-assignment.title";
+            readonly titlePlural: "@human-capital-management:position-assignments.entities.position-assignment.plural";
+            readonly icon: "fa-light fa-user-tie-hair";
+        };
+        readonly leaveType: {
+            readonly name: "LeaveType";
+            readonly source: `${string}.LeaveType`;
+            readonly title: "@human-capital-management:leave-types.entities.leave-type.title";
+            readonly titlePlural: "@human-capital-management:leave-types.entities.leave-type.plural";
+            readonly icon: "fa-light fa-calendar-days";
+        };
+        readonly leaveRequest: {
+            readonly name: "LeaveRequest";
+            readonly source: `${string}.LeaveRequest`;
+            readonly title: "@human-capital-management:leave-requests.entities.leave-request.title";
+            readonly titlePlural: "@human-capital-management:leave-requests.entities.leave-request.plural";
+            readonly icon: "fa-light fa-plane-departure";
+        };
+        readonly lifecycleEventType: {
+            readonly name: "LifecycleEventType";
+            readonly source: `${string}.LifecycleEventType`;
+            readonly title: "@human-capital-management:lifecycle-event-types.entities.lifecycle-event-type.title";
+            readonly titlePlural: "@human-capital-management:lifecycle-event-types.entities.lifecycle-event-type.plural";
+            readonly icon: "fa-light fa-diagram-next";
+        };
+        readonly lifecycleEvent: {
+            readonly name: "LifecycleEvent";
+            readonly source: `${string}.LifecycleEvent`;
+            readonly title: "@human-capital-management:lifecycle-events.entities.lifecycle-event.title";
+            readonly titlePlural: "@human-capital-management:lifecycle-events.entities.lifecycle-event.plural";
+            readonly icon: "fa-light fa-clipboard-list-check";
+        };
+    };
+    readonly pages: {
+        readonly appointmentBoard: {
+            readonly path: "Boards/ResourceAppointment";
+            readonly title: "@human-capital-management:leave-requests.menus.appointment-board.title";
+            readonly icon: "fa-light fa-calendar-lines";
+        };
+    };
+    readonly queries: {
+        readonly dashboard: {
+            readonly employeesKpi: `${string}:Dashboard:EmployeesKpi`;
+        };
+        readonly reports: {
+            readonly getHeadcountByDepartment: `${string}:Reports:GetHeadcountByDepartment`;
+            readonly getLeaveUsageByType: `${string}:Reports:GetLeaveUsageByType`;
+        };
+    };
+};
+
+interface AXMHumanCapitalManagementEmployeeEntityModel extends AXPEntityModel<string> {
+    statusId?: string;
+    employeeCode: string;
+    signature?: string;
+    jobDefinitionId: string;
+    positionId: string;
+    employmentTypeId: string;
+    hireDate: Date;
+    contactId?: string;
+    userId?: string;
+    managerId?: string;
+    manager?: AXMHumanCapitalManagementEmployeeEntityModel;
+    /** Denormalized from position assignments (mock: synced via distributed listener + seeder). */
+    activePrimaryPositionId?: string | null;
+    activePrimaryPosition?: {
+        id: string;
+        title?: unknown;
+    };
+    /** Business unit of the same primary assignment as {@link activePrimaryPositionId}. */
+    activePrimaryBusinessUnitId?: string | null;
+    activePrimaryBusinessUnit?: {
+        id: string;
+        title?: unknown;
+    };
+    personId?: string;
+    person?: {
+        id: string;
+        fullName?: string;
+    };
+    /** Link to an external HRIS employee (e.g. BambooHR). */
+    integrationRef?: AXPIntegrationReference | null;
+}
+
+interface AXMHumanCapitalManagementEmploymentTypeEntityModel {
+    id: string;
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString;
+}
+
+type AXMHumanCapitalManagementLeaveRequestStatus = typeof AXPSystemStatuses.WaitingApproval.name | typeof AXPSystemStatuses.Approved.name | typeof AXPSystemStatuses.Rejected.name | typeof AXPSystemStatuses.Cancelled.name;
+interface AXMHumanCapitalManagementLeaveRequestEntityModel extends AXPEntityModel<string> {
+    employeeId: string;
+    employee?: AXMHumanCapitalManagementEmployeeEntityModel;
+    leaveTypeId: string;
+    leaveType?: {
+        id: string;
+        title: string;
+    };
+    startDate: Date;
+    endDate: Date;
+    durationDays?: number;
+    reason?: string;
+    statusId?: AXMHumanCapitalManagementLeaveRequestStatus;
+    status?: {
+        id: AXMHumanCapitalManagementLeaveRequestStatus;
+        title?: string;
+    };
+}
+
+/** Workflow template binding and admin-configured default inputs for leave types. */
+interface AXMHumanCapitalManagementLeaveTypeWorkflowConfig {
+    workflowDefinitionId: string;
+    workflowName: string;
+    defaultInput?: Record<string, unknown>;
+}
+interface AXMHumanCapitalManagementLeaveTypeEntityModel extends AXPEntityModel<string> {
+    title: AXPMultiLanguageString;
+    description: AXPMultiLanguageString;
+    color: string;
+    /** Selected workflow and template-time input defaults for this leave type. */
+    workflowConfig?: AXMHumanCapitalManagementLeaveTypeWorkflowConfig | null;
+}
+
+type AXMHumanCapitalManagementLifecycleEventStatus = AXPSystemStatusType.InProgress | AXPSystemStatusType.WaitingSignOff | AXPSystemStatusType.Completed | AXPSystemStatusType.Cancelled;
+/**
+ * One employee lifecycle event (onboarding, separation, …), driven by {@link AXMHumanCapitalManagementLifecycleEventTypeEntityModel}.
+ */
+interface AXMHumanCapitalManagementLifecycleEventEntityModel extends AXPEntityModel<string> {
+    employeeId: string;
+    employee?: AXMHumanCapitalManagementEmployeeEntityModel;
+    eventTypeId: string;
+    eventType?: {
+        id: string;
+        title: AXPMultiLanguageString;
+    };
+    /**
+     * Platform user currently assigned the active workflow step (human task / cartable assignee).
+     * Populate from workflow engine or middleware when tasks are created or claimed.
+     */
+    assignedToUserId?: string | null;
+    assignedToUser?: {
+        id: string;
+        displayName?: string;
+    };
+    effectiveDate?: Date;
+    notes?: string;
+    statusId?: AXMHumanCapitalManagementLifecycleEventStatus;
+    status?: {
+        id: AXMHumanCapitalManagementLifecycleEventStatus;
+        title?: string;
+    };
+}
+
+/** Workflow template binding and admin-configured default inputs for lifecycle event types. */
+interface AXMHumanCapitalManagementLifecycleEventTypeWorkflowConfig {
+    workflowDefinitionId: string;
+    workflowName: string;
+    defaultInput?: Record<string, unknown>;
+}
+/**
+ * Defines workflow defaults, questionnaire, and metadata schema for employee lifecycle events (onboarding, separation, etc.).
+ */
+interface AXMHumanCapitalManagementLifecycleEventTypeEntityModel extends AXPEntityModel<string> {
+    title: AXPMultiLanguageString;
+    description?: AXPMultiLanguageString;
+    /** Selected workflow and template-time input defaults (e.g. questionnaireId). */
+    workflowConfig?: AXMHumanCapitalManagementLifecycleEventTypeWorkflowConfig | null;
+    /** Font Awesome icon classes (e.g. `fa-light fa-user-plus`). */
+    icon?: string;
+    /** Meta-data-builder schema (`metaDataList`); drives dynamic fields on lifecycle events for this template. */
+    metaDataList?: AXMMetaDataBuilderValue;
+}
+
+interface AXMHumanCapitalManagementPositionAssignmentEntityModel extends AXPEntityModel<string> {
+    employeeId: string;
+    positionId: string;
+    businessUnitId: string;
+    businessUnit?: {
+        id: string;
+        title: string;
+    };
+    employee?: {
+        id: string;
+        person?: {
+            fullName?: string;
+        };
+    };
+    position?: {
+        id: string;
+        title: string;
+    };
+    startDate: Date;
+    endDate?: Date;
+    statusId?: AXMPositionAssignmentStatusId;
+    status?: {
+        id: AXMPositionAssignmentStatusId;
+        title?: string;
+    };
+    isPrimary?: boolean;
+    notes?: string;
+}
+
+export { AXMLeaveRequestOpenStatusIds, AXMLifecycleEventOpenStatusIds, AXM_POSITION_ASSIGNMENT_OVERLAPPING_STATUS_IDS, AXM_POSITION_ASSIGNMENT_STATUS, AXPHumanCapitalManagementCommandKeys, AXPHumanCapitalManagementFeatureKeys, AXPHumanCapitalManagementMenuKeys, AXPHumanCapitalManagementQueryKeys, AXPPeopleOrganizationPermissionKeys, HCM_CATALOG_SCOPE_HR, RootConfig };
+export type { AXMHcmProfileDocumentDriveContext, AXMHumanCapitalManagementEmployeeEntityModel, AXMHumanCapitalManagementEmploymentTypeEntityModel, AXMHumanCapitalManagementLeaveRequestEntityModel, AXMHumanCapitalManagementLeaveRequestStatus, AXMHumanCapitalManagementLeaveTypeEntityModel, AXMHumanCapitalManagementLeaveTypeWorkflowConfig, AXMHumanCapitalManagementLifecycleEventEntityModel, AXMHumanCapitalManagementLifecycleEventStatus, AXMHumanCapitalManagementLifecycleEventTypeEntityModel, AXMHumanCapitalManagementLifecycleEventTypeWorkflowConfig, AXMHumanCapitalManagementPositionAssignmentEntityModel, AXMPositionAssignmentStatusId };

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

@@ -0,0 +1,114 @@
+import * as i0 from '@angular/core';
+import { AXPTaskBadgeProvider, AXPResourceAppointmentBoardProvider, AXPResourceAppointmentBoardFilter, AXPResourceAppointmentResource, AXPResourceAppointmentStatus, AXPResourceAppointmentItem, AXPResourceAppointmentActionMenuItem } from '@acorex-platform/framework-client/layout/components';
+import { AXPExecuteCommand } from '@acorex-platform/framework-shared/core';
+import { AXMHumanCapitalManagementLeaveRequestEntityModel } from '@acorex-platform/module-human-capital-management-client/contracts';
+import { AXPCommandExecuteResultPromise } from '@acorex-platform/framework-shared/runtime';
+import { AXPTaskPopoverComponent, AXPTask } from '@acorex-platform/module-task-management-client';
+import { AXPFeatureDefinitionProvider, AXPFeatureDefinitionProviderContext, AXPModuleManifest } from '@acorex-platform/framework-client/core';
+import * as i1 from '@angular/common';
+import * as i2 from '@acorex-platform/framework-client/runtime';
+
+declare class AXMLeaveRequestBadgeProvider extends AXPTaskBadgeProvider {
+    private readonly entityService;
+    private readonly leaveRequestData;
+    private readonly commandEvents;
+    private readonly destroyRef;
+    key: string;
+    count: i0.WritableSignal<number>;
+    constructor();
+    /**
+     * Forces badge count recalculation by querying the leave request entity service.
+     */
+    refresh(): Promise<void>;
+    /**
+     * Returns true when the command event targets the leave request entity.
+     */
+    private isLeaveRequestCommandEvent;
+    /**
+     * Handles command execution events and refreshes the badge when targeted leave request commands succeed.
+     */
+    private handleCommandEvent;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMLeaveRequestBadgeProvider, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXMLeaveRequestBadgeProvider>;
+}
+
+declare class AXMLeaveRequestResourceAppointmentProvider extends AXPResourceAppointmentBoardProvider<AXMHumanCapitalManagementLeaveRequestEntityModel> {
+    private readonly entityService;
+    get name(): string;
+    get title(): string;
+    get icon(): string;
+    getList(filter?: AXPResourceAppointmentBoardFilter): Promise<AXPResourceAppointmentResource[]>;
+    getStatuses(): Promise<AXPResourceAppointmentStatus[]>;
+    getActions(context?: AXPResourceAppointmentItem): Promise<AXPResourceAppointmentActionMenuItem[]>;
+    executeCommand(command: AXPExecuteCommand): AXPCommandExecuteResultPromise;
+}
+
+interface LeaveRequestActionDialogResult {
+    reason?: string;
+    note?: string;
+    cancelled: boolean;
+}
+declare class AXPLeaveRequestDialogService {
+    private readonly layoutBuilder;
+    private readonly translationService;
+    showRejectionDialog(): Promise<LeaveRequestActionDialogResult>;
+    showCancellationDialog(): Promise<LeaveRequestActionDialogResult>;
+    showApprovalDialog(): Promise<LeaveRequestActionDialogResult>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXPLeaveRequestDialogService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXPLeaveRequestDialogService>;
+}
+
+declare class AXMLeaveRequestTaskPopoverComponent extends AXPTaskPopoverComponent {
+    task: i0.InputSignal<AXPTask<Record<string, any>>>;
+    private readonly commandExecutor;
+    private readonly dialogService;
+    protected taskData: i0.Signal<AXMHumanCapitalManagementLeaveRequestEntityModel>;
+    protected employeeName: i0.Signal<string>;
+    protected managerName: i0.Signal<string>;
+    protected leaveType: i0.Signal<string>;
+    protected canApprove: i0.Signal<boolean>;
+    protected canReject: i0.Signal<boolean>;
+    protected canCancel: i0.Signal<boolean>;
+    protected formatDate(date: Date): string;
+    protected calculateDuration(): number;
+    protected handleApprove(): Promise<void>;
+    protected handleReject(): Promise<void>;
+    protected handleCancel(): Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMLeaveRequestTaskPopoverComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AXMLeaveRequestTaskPopoverComponent, "axm-leave-request-task-popover", never, { "task": { "alias": "task"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+/**
+ * Human Capital Management Feature Definition Provider.
+ * Provides feature definitions for the Human Capital Management module.
+ */
+declare class AXPHumanCapitalManagementFeatureDefinitionProvider implements AXPFeatureDefinitionProvider {
+    provide(context: AXPFeatureDefinitionProviderContext): Promise<void>;
+}
+
+declare class AXMLeaveRequestFeatureModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMLeaveRequestFeatureModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AXMLeaveRequestFeatureModule, never, [typeof i1.CommonModule, typeof i2.AXPRuntimeModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<AXMLeaveRequestFeatureModule>;
+}
+
+declare class AXMLifecycleEventFeatureModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMLifecycleEventFeatureModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AXMLifecycleEventFeatureModule, never, [typeof i2.AXPRuntimeModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<AXMLifecycleEventFeatureModule>;
+}
+
+declare class AXMHumanCapitalManagementModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMHumanCapitalManagementModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AXMHumanCapitalManagementModule, never, [typeof i1.CommonModule, typeof i2.AXPRuntimeModule, typeof AXMLeaveRequestFeatureModule, typeof AXMLifecycleEventFeatureModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<AXMHumanCapitalManagementModule>;
+}
+
+/**
+ * Human Capital Management Module Manifest.
+ * Defines module metadata, features, and provider references.
+ */
+declare const HumanCapitalManagementManifest: AXPModuleManifest;
+
+export { AXMHumanCapitalManagementModule, AXMLeaveRequestBadgeProvider, AXMLeaveRequestResourceAppointmentProvider, AXMLeaveRequestTaskPopoverComponent, AXPHumanCapitalManagementFeatureDefinitionProvider, AXPLeaveRequestDialogService, HumanCapitalManagementManifest };
+export type { LeaveRequestActionDialogResult };