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

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

@@ -0,0 +1,441 @@
+import { AXPEntityAction } from '@acorex-platform/framework-shared/entity';
+import { AXPMultiLanguageString } from '@acorex-platform/framework-shared/core';
+import { AXMMetaDataBuilderValue } from '@acorex-platform/module-data-management-contracts';
+
+/** Asset booking catalog scope for questionnaires, question bank items, and workflow definitions. */
+declare const ASSET_CATALOG_SCOPE_BOOKING = "asset-management.booking";
+
+declare const AXMAssetManagementCommandKeys: {
+    readonly AssetRentalHistory: {
+        readonly RentFrom: "AssetManagement.AssetRentalHistory:RentFrom";
+        readonly RentTo: "AssetManagement.AssetRentalHistory:RentTo";
+    };
+    readonly WorkflowActivity: {
+        readonly RecalculateOperationalStatus: "workflow-activity:recalculate-asset-operational-status";
+    };
+};
+
+declare const AXMAssetManagementFeatureKeys: {
+    readonly AssetManagement: "AssetManagement:Feature:Management";
+    readonly AdvancedMaintenance: "AssetManagement:Feature:Advanced.Maintenance";
+    readonly MaintenanceScheduling: "AssetManagement:Feature:Maintenance.Scheduling";
+    readonly InspectionWorkflow: "AssetManagement:Feature:Inspection.Workflow";
+};
+
+declare const AXMAssetManagementMenuKeys: {
+    readonly Root: "AssetManagement:Menu";
+    readonly MainPlanEquipmentAssetsMaintenanceDivider: "AssetManagement:Menu:MainPlanEquipment:AssetsMaintenanceDivider";
+    readonly PlanEquipmentAssets: "AssetManagement:Menu:PlantEquipment:Assets";
+    readonly PlanEquipmentAssetsMaintenanceDivider: "AssetManagement:Menu:PlantEquipment:AssetsMaintenanceDivider";
+    readonly Assets: "AssetManagement:Menu:Assets";
+    readonly AssetSystems: "AssetManagement:Menu:AssetSystems";
+    readonly AssetTypes: "AssetManagement:Menu:AssetTypes";
+    readonly AssetSystemTypes: "AssetManagement:Menu:AssetSystemTypes";
+    readonly AssetTypeSections: "AssetManagement:Menu:AssetTypeSections";
+};
+
+/**
+ * Assets & Maintenance capabilities used by this module.
+ * Domain capability keys for this module. Root groups live in `AXPCommonPermissionGroupKeys` (common contracts).
+ */
+declare const AXPAssetsMaintenancePermissionKeys: {
+    readonly Access: "AssetsMaintenance:Permission:Access";
+    readonly MaintainAssets: "AssetsMaintenance:Permission:MaintainAssets";
+    readonly MaintainMaintenance: "AssetsMaintenance:Permission:MaintainMaintenance";
+    readonly Setup: "AssetsMaintenance:Permission:Setup";
+};
+/**
+ * @deprecated Prefer {@link AXPAssetsMaintenancePermissionKeys}.
+ * Legacy nested shape kept so existing imports compile during migration.
+ */
+declare const AXMAssetManagementPermissionKeys: {
+    readonly AssetManagement: {
+        readonly Management: "AssetsMaintenance:Permission:Access";
+        readonly Asset: {
+            readonly Management: "AssetsMaintenance:Permission:MaintainAssets";
+            readonly View: "AssetsMaintenance:Permission:MaintainAssets";
+            readonly Create: "AssetsMaintenance:Permission:MaintainAssets";
+            readonly Update: "AssetsMaintenance:Permission:MaintainAssets";
+            readonly Delete: "AssetsMaintenance:Permission:MaintainAssets";
+        };
+    };
+};
+
+/** Registry key for the asset type Components custom page tab. */
+declare const ASSET_TYPE_COMPONENTS_PAGE_COMPONENT_KEY = "asset-type-components-page";
+
+/** Status provider key for `lifecycleStatusId` on AssetManagement.Asset (lifecycle status). */
+declare const AXM_ASSET_LIFECYCLE_STATUS_DEFINITION_KEY = "asset-management.status.asset-lifecycle";
+
+/** Status provider key for `statusId` on AssetManagement.Asset (operational status). */
+declare const AXM_ASSET_STATUS_DEFINITION_KEY = "asset-management.status.asset";
+
+/** Type-level create actions for rent-from / rent-to (list and asset related-entity). */
+declare const assetRentalHistoryRentActions: AXPEntityAction[];
+
+declare enum AXMAssetRentalHistoryStatus {
+    Draft = "draft",
+    Active = "active",
+    Returned = "returned",
+    Overdue = "overdue",
+    Cancelled = "cancelled"
+}
+
+interface AXMAssetTypeSectionBuilderItemValue {
+    id: string;
+    assetTypeSectionId: string;
+    /**
+     * Original source component id when a section item is expanded to multiple
+     * assignment slots (based on count) in asset-link mode.
+     */
+    assetTypeSectionComponentId?: string;
+    assetTypeId: string;
+    assetTypeSection?: {
+        id: string;
+        code: number;
+        title: string;
+        description?: string;
+    };
+    assetType: {
+        id: string;
+        name: string | AXPMultiLanguageString;
+    };
+    count: number;
+    roleName: string | AXPMultiLanguageString;
+    hasMaintenance: boolean;
+    /**
+     * Selected asset link for this slot in asset-link mode.
+     */
+    assetId?: string;
+    asset?: {
+        id: string;
+        code?: string;
+        title?: string | AXPMultiLanguageString;
+    };
+}
+interface AXMAssetTypeSectionBuilderSectionValue {
+    id: string;
+    code: number;
+    title: string | AXPMultiLanguageString;
+    assetTypeId: string;
+    description?: string | AXPMultiLanguageString;
+    items: AXMAssetTypeSectionBuilderItemValue[];
+}
+interface AXMAssetTypeSectionBuilderValue {
+    sections: AXMAssetTypeSectionBuilderSectionValue[];
+}
+
+declare enum AXMAssetStatus {
+    Available = "available",
+    Assigned = "assigned",
+    UnderMaintenanceInspection = "underMaintenanceInspection",
+    OutOfService = "outOfService",
+    Lost = "lost"
+}
+
+declare enum AXMAssetLifecycleStatus {
+    Created = "created",
+    Active = "active",
+    Retired = "retired",
+    Disposed = "disposed"
+}
+
+declare const RootConfig: {
+    readonly config: {
+        i18n: string;
+        module: string;
+        route: string;
+    };
+    readonly module: {
+        readonly route: string;
+        readonly name: string;
+        readonly title: "@asset-management:module.title";
+        readonly icon: "fa-light fa-industry";
+    };
+    readonly entities: {
+        readonly assetRentalHistory: {
+            readonly name: "AssetRentalHistory";
+            readonly source: `${string}.AssetRentalHistory`;
+            readonly title: "@asset-management:assetRentalHistories.entities.assetRentalHistory.title";
+            readonly titlePlural: "@asset-management:assetRentalHistories.entities.assetRentalHistory.plural";
+            readonly icon: "fa-light fa-file-contract";
+        };
+        readonly assetSystemAssignment: {
+            readonly name: "AssetSystemAssignment";
+            readonly source: `${string}.AssetSystemAssignment`;
+            readonly title: "@asset-management:assetSystemAssignments.entities.assetSystemAssignment.title";
+            readonly titlePlural: "@asset-management:assetSystemAssignments.entities.assetSystemAssignment.plural";
+            readonly icon: "fa-light fa-link";
+        };
+        readonly asset: {
+            readonly name: "Asset";
+            readonly source: `${string}.Asset`;
+            readonly title: "@asset-management:assets.entities.asset.title";
+            readonly titlePlural: "@asset-management:assets.entities.asset.plural";
+            readonly icon: "fa-light fa-box";
+        };
+        readonly assetType: {
+            readonly name: "AssetType";
+            readonly source: `${string}.AssetType`;
+            readonly title: "@asset-management:assetTypes.entities.assetType.title";
+            readonly titlePlural: "@asset-management:assetTypes.entities.assetType.plural";
+            readonly icon: "fa-light fa-cubes";
+        };
+        readonly assetTypeSection: {
+            readonly name: "AssetTypeSection";
+            readonly source: `${string}.AssetTypeSection`;
+            readonly title: "@asset-management:assetTypeSections.entities.assetTypeSection.title";
+            readonly titlePlural: "@asset-management:assetTypeSections.entities.assetTypeSection.plural";
+            readonly icon: "fa-light fa-layer-group";
+        };
+        readonly assetTypeSectionComponent: {
+            readonly name: "AssetTypeSectionComponent";
+            readonly source: `${string}.AssetTypeSectionComponent`;
+            readonly title: "@asset-management:assetTypeSectionComponents.entities.assetTypeSectionComponent.title";
+            readonly titlePlural: "@asset-management:assetTypeSectionComponents.entities.assetTypeSectionComponent.plural";
+            readonly icon: "fa-light fa-puzzle-piece";
+        };
+        readonly assetSystemType: {
+            readonly name: "AssetSystemType";
+            readonly source: `${string}.AssetSystemType`;
+            readonly title: "@asset-management:assetSystemTypes.entities.assetSystemType.title";
+            readonly titlePlural: "@asset-management:assetSystemTypes.entities.assetSystemType.plural";
+            readonly icon: "fa-light fa-diagram-subtask";
+        };
+        readonly assetSystem: {
+            readonly name: "AssetSystem";
+            readonly source: `${string}.AssetSystem`;
+            readonly title: "Asset System";
+            readonly titlePlural: "Asset Systems";
+            readonly icon: "fa-light fa-diagram-project";
+        };
+        readonly manualAssetCategory: {
+            readonly name: "ManualAssetCategory";
+            readonly source: `${string}.ManualAssetCategory`;
+            readonly title: "@asset-management:asset-categories.entities.asset-category.title";
+            readonly titlePlural: "@asset-management:asset-categories.entities.asset-category.plural";
+            readonly icon: "fa-light fa-tags";
+        };
+    };
+    readonly queries: {
+        readonly reports: {
+            readonly getAssetsByStatus: `${string}:Reports:GetAssetsByStatus`;
+            readonly getRentalUtilization: `${string}:Reports:GetRentalUtilization`;
+        };
+    };
+};
+
+/**
+ * Persisted link between a main asset and a child asset placed in a component slot.
+ * `assetTypeSectionComponent.assetTypeId` is the **slot template** type (required type of the
+ * linked child). It must not match the **section definition** aggregate `assetTypeId` on
+ * `asset-type-section` for the same section (parent type vs. composable child type).
+ */
+interface AXMAssetManagementAssetComponentEntityModel {
+    id: string;
+    assetId: string;
+    asset: {
+        id: string;
+        code: string;
+        title: string;
+    };
+    mainAssetId: string;
+    mainAsset: {
+        id: string;
+        code: string;
+        title: string;
+    };
+    assetTypeSectionComponentId: string;
+    assetTypeSectionComponent: {
+        id: string;
+        code: string;
+        title: string;
+        assetTypeId: string;
+        assetType: {
+            id: string;
+            name: string | AXPMultiLanguageString;
+        };
+    };
+}
+
+interface AXMAssetManagementAssetEntityModel {
+    id: string;
+    /** Business code from identifier rule `asset-code` (`ASST-{date:YYYYMM}-{seq:4}`). */
+    code: string;
+    title: string;
+    assetTypeId: string;
+    assetType?: {
+        id: string;
+        title: string;
+        code?: string;
+        hasMaintenance?: boolean;
+        maintenanceTypeIds?: string[];
+    };
+    /** Hydrated at read time from asset type and categories (not persisted). */
+    availableMaintenanceTypeIds?: string[];
+    /** Resolved from selected asset type; drives maintenance-related detail pages visibility. */
+    description?: string;
+    statusId?: AXMAssetStatus;
+    status?: {
+        id: AXMAssetStatus;
+        title: string;
+    };
+    lifecycleStatusId?: AXMAssetLifecycleStatus;
+    lifecycleStatus?: {
+        id: AXMAssetLifecycleStatus;
+        title: string;
+    };
+    serialNumber?: string;
+    testTagIdentificationNumber?: string;
+    qrCode?: string;
+    assignedToEmployeeId?: string;
+    assignedToEmployee?: {
+        id: string;
+        displayName?: string;
+    };
+    locationId?: string;
+    location?: {
+        id: string;
+        title: string;
+    };
+    tags?: string[];
+    isBookable?: boolean;
+    isRented?: boolean;
+    preBookQuestionnaireId?: string;
+    postBookQuestionnaireId?: string;
+    preBookQuestionnaire?: {
+        id: string;
+        title: string;
+    };
+    postBookQuestionnaire?: {
+        id: string;
+        title: string;
+    };
+    components?: AXMAssetTypeSectionBuilderValue;
+    assetComponents?: AXMAssetManagementAssetComponentEntityModel[];
+    licenseTypeId?: string;
+    licenseType?: {
+        id: string;
+        title: string;
+    };
+}
+
+interface AXMAssetManagementAssetRentalHistoryEntityModel {
+    id: string;
+    assetId: string;
+    asset: {
+        id: string;
+        code: string;
+        title: string;
+    };
+    rentedToId?: string;
+    rentedTo?: {
+        id: string;
+        displayName: string;
+    };
+    rentedFromId?: string;
+    rentedFrom?: {
+        id: string;
+        displayName: string;
+    };
+    createdDate: Date;
+    startDate: Date;
+    expectedReturnDate?: Date;
+    actualReturnDate?: Date;
+    status: AXMAssetRentalHistoryStatus;
+    description?: string;
+    rentalDirection: 'rentTo' | 'rentFrom';
+    monthlyRent?: number;
+}
+
+interface AXMAssetManagementAssetSystemEntityModel {
+    id: string;
+    code: string;
+    title: string;
+    assetSystemTypeId: string;
+    assetSystemType: {
+        id: string;
+        title: string;
+    };
+    description: string;
+    locationId: string;
+    location: {
+        id: string;
+        title: string;
+    };
+}
+
+interface AXMAssetManagementAssetSystemAssignmentEntityModel {
+    id: string;
+    assetSystemId: string;
+    assetSystem: {
+        id: string;
+        title: string;
+    };
+    assetId: string;
+    asset: {
+        id: string;
+        title: string;
+    };
+    startDate: Date;
+    endDate?: Date;
+    description?: string;
+}
+
+interface AXMAssetManagementAssetSystemTypeEntityModel {
+    id: string;
+    /** Business code from identifier rule `asset-system-type-code` (`ASYS-{seq:2}`). */
+    code: string;
+    title: string;
+    description: string;
+    parentId?: string;
+    parent?: {
+        id: string;
+        title: string;
+    };
+    hasChild?: boolean;
+    metaDataList?: AXMMetaDataBuilderValue;
+}
+
+interface AXMAssetManagementAssetTypeEntityModel {
+    id: string;
+    name: string;
+    /** Business code from identifier rule `asset-type-code` (`AST-{seq:4}`). */
+    title: string;
+    categoryIds?: string[];
+    metaDataList?: AXMMetaDataBuilderValue;
+    description: string;
+    hasMaintenance?: boolean;
+    maintenanceTypeIds?: string[];
+    components?: AXMAssetTypeSectionBuilderValue;
+}
+
+interface AXMAssetManagementAssetTypeSectionEntityModel {
+    id: string;
+    code: number;
+    title: string;
+    assetTypeId: string;
+    description?: string;
+}
+
+interface AXMAssetManagementAssetTypeSectionComponentEntityModel {
+    id: string;
+    assetTypeSectionId: string;
+    assetTypeSection: {
+        id: string;
+        code: number;
+        title: string;
+        description?: string;
+    };
+    assetTypeId: string;
+    assetType: {
+        id: string;
+        name: string;
+    };
+    count: number;
+    roleName?: string;
+    hasMaintenance: boolean;
+}
+
+export { ASSET_CATALOG_SCOPE_BOOKING, ASSET_TYPE_COMPONENTS_PAGE_COMPONENT_KEY, AXMAssetLifecycleStatus, AXMAssetManagementCommandKeys, AXMAssetManagementFeatureKeys, AXMAssetManagementMenuKeys, AXMAssetManagementPermissionKeys, AXMAssetRentalHistoryStatus, AXMAssetStatus, AXM_ASSET_LIFECYCLE_STATUS_DEFINITION_KEY, AXM_ASSET_STATUS_DEFINITION_KEY, AXPAssetsMaintenancePermissionKeys, RootConfig, assetRentalHistoryRentActions };
+export type { AXMAssetManagementAssetComponentEntityModel, AXMAssetManagementAssetEntityModel, AXMAssetManagementAssetRentalHistoryEntityModel, AXMAssetManagementAssetSystemAssignmentEntityModel, AXMAssetManagementAssetSystemEntityModel, AXMAssetManagementAssetSystemTypeEntityModel, AXMAssetManagementAssetTypeEntityModel, AXMAssetManagementAssetTypeSectionComponentEntityModel, AXMAssetManagementAssetTypeSectionEntityModel, AXMAssetTypeSectionBuilderItemValue, AXMAssetTypeSectionBuilderSectionValue, AXMAssetTypeSectionBuilderValue };