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

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

@@ -0,0 +1,278 @@
+import * as _angular_core from '@angular/core';
+import { AXPFeatureDefinitionProvider, AXPFeatureDefinitionProviderContext } from '@acorex-platform/framework-client/core';
+import { AXPMenuProvider, AXPMenuProviderContext, AXPSearchCommandProvider, AXPSearchResult } from '@acorex-platform/framework-client/common';
+import { AXPPermissionDefinitionProvider, AXPPermissionDefinitionProviderContext } from '@acorex-platform/framework-client/auth';
+import { AXPStatusProvider, AXPStatusTransition, AXPMultiLanguageString } from '@acorex-platform/framework-shared/core';
+import { AXStyleColorType } from '@acorex/cdk/common';
+import { AXMAssetStatus, AXMAssetManagementAssetRentalHistoryEntityModel, AXMAssetTypeSectionBuilderValue } from '@acorex-platform/module-asset-management-client/contracts';
+export * from '@acorex-platform/module-asset-management-client/contracts';
+export { AXMAssetTypeSectionBuilderItemValue, AXMAssetTypeSectionBuilderSectionValue, AXMAssetTypeSectionBuilderValue } from '@acorex-platform/module-asset-management-client/contracts';
+import { AXPCommand, AXPCommandExecuteResultPromise } from '@acorex-platform/framework-shared/runtime';
+import { AXPCommandService } from '@acorex-platform/framework-client/runtime';
+import { AXPBuilderValue, AXPStandardSectionItemsBuilderConfig, AXPPageComponentProvider, AXPPageComponentDefinition } from '@acorex-platform/framework-client/layout/components';
+import { AXPPageLayoutBaseComponent, AXPLayoutDetailsViewAction } from '@acorex-platform/framework-client/layout/views';
+
+declare class AXMAssetManagementModule {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMAssetManagementModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<AXMAssetManagementModule, never, never, never>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<AXMAssetManagementModule>;
+}
+
+/**
+ * Asset Management Feature Definition Provider.
+ * Provides feature definitions for the Asset Management module.
+ */
+declare class AXMAssetManagementFeatureDefinitionProvider implements AXPFeatureDefinitionProvider {
+    provide(context: AXPFeatureDefinitionProviderContext): Promise<void>;
+}
+
+/**
+ * Asset Management Menu Provider.
+ * Provides menu items for the Asset Management module with permission and feature checks.
+ */
+declare class AXMAssetManagementMenuProvider implements AXPMenuProvider {
+    private readonly entityService;
+    provide(context: AXPMenuProviderContext): Promise<void>;
+}
+
+/**
+ * Registers Assets & Maintenance capabilities owned by asset-management.
+ */
+declare class AXMAssetManagementPermissionDefinitionProvider implements AXPPermissionDefinitionProvider {
+    define(context: AXPPermissionDefinitionProviderContext): Promise<void>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMAssetManagementPermissionDefinitionProvider, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<AXMAssetManagementPermissionDefinitionProvider>;
+}
+
+declare class AXMAssetManagementSearchCommandProvider extends AXPSearchCommandProvider {
+    commands: AXPSearchResult[];
+}
+
+declare class AXMAssetManagementAssetStatusProvider extends AXPStatusProvider {
+    readonly key = "asset-management.status.asset";
+    readonly statuses: {
+        name: AXMAssetStatus;
+        title: string;
+        icon: string;
+        color: AXStyleColorType;
+        order: number;
+        isInitial: boolean;
+        isFinal: boolean;
+        generateView: boolean;
+    }[];
+    readonly transitions: AXPStatusTransition[];
+    readonly defaultStatus = AXMAssetStatus.Available;
+}
+
+declare function assertRentalPartyForDirection(data: Pick<AXMAssetManagementAssetRentalHistoryEntityModel, 'rentalDirection' | 'rentedToId' | 'rentedFromId'>): void;
+
+type AXMAssetRentalHistoryRentDirection = 'rentFrom' | 'rentTo';
+interface CreateAssetRentalHistoryRentCommandInput {
+    data?: Record<string, unknown>;
+    options?: Record<string, unknown>;
+}
+declare abstract class AXMCreateAssetRentalHistoryRentCommandBase implements AXPCommand<CreateAssetRentalHistoryRentCommandInput, unknown> {
+    protected readonly commandService: AXPCommandService;
+    protected abstract readonly rentalDirection: AXMAssetRentalHistoryRentDirection;
+    execute(input: CreateAssetRentalHistoryRentCommandInput): AXPCommandExecuteResultPromise<unknown>;
+    private resolveSeedData;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMCreateAssetRentalHistoryRentCommandBase, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<AXMCreateAssetRentalHistoryRentCommandBase>;
+}
+declare class AXMCreateAssetRentalHistoryRentFromCommand extends AXMCreateAssetRentalHistoryRentCommandBase {
+    static readonly commandKey: "AssetManagement.AssetRentalHistory:RentFrom";
+    protected readonly rentalDirection: "rentFrom";
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMCreateAssetRentalHistoryRentFromCommand, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<AXMCreateAssetRentalHistoryRentFromCommand>;
+}
+declare class AXMCreateAssetRentalHistoryRentToCommand extends AXMCreateAssetRentalHistoryRentCommandBase {
+    static readonly commandKey: "AssetManagement.AssetRentalHistory:RentTo";
+    protected readonly rentalDirection: "rentTo";
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMCreateAssetRentalHistoryRentToCommand, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<AXMCreateAssetRentalHistoryRentToCommand>;
+}
+
+declare function normalizeAssetTypeBuilderLocalizedField(value: unknown, fallback: string): string | AXPMultiLanguageString;
+declare function createAssetTypeSectionBuilderDefaultValue(assetTypeId?: string): AXMAssetTypeSectionBuilderValue;
+declare function normalizeAssetTypeSectionBuilderValue(value: unknown, assetTypeId?: string): AXMAssetTypeSectionBuilderValue;
+
+declare class AXMAssetTypeSectionBuilderComponent {
+    #private;
+    readonly value: _angular_core.InputSignal<AXMAssetTypeSectionBuilderValue | null | undefined>;
+    readonly assetTypeId: _angular_core.InputSignal<string | undefined>;
+    readonly options: _angular_core.InputSignal<Record<string, unknown>>;
+    readonly valueChange: _angular_core.OutputEmitterRef<AXMAssetTypeSectionBuilderValue>;
+    private readonly standardRef;
+    private readonly layoutBuilder;
+    private readonly translationService;
+    private readonly disabledSectionPrompt;
+    private readonly disabledAddSectionPrompt;
+    protected readonly builderValue: _angular_core.WritableSignal<AXPBuilderValue>;
+    protected readonly standardConfig: _angular_core.Signal<AXPStandardSectionItemsBuilderConfig>;
+    protected readonly hideHeaderActions: _angular_core.Signal<boolean>;
+    protected readonly allowAddSection: _angular_core.Signal<boolean>;
+    protected readonly allowEditSection: _angular_core.Signal<boolean>;
+    protected readonly allowAddItems: _angular_core.Signal<boolean>;
+    protected readonly allowReorderSections: _angular_core.Signal<boolean>;
+    protected readonly readonly: _angular_core.Signal<boolean>;
+    protected readonly linkAssetMode: _angular_core.Signal<boolean>;
+    addSection(): Promise<void>;
+    /** Aligns section-items baseline to persisted value after save. */
+    syncAfterSave(value: AXMAssetTypeSectionBuilderValue): void;
+    /** Re-applies the current `[value]` input and clears builder dirty state after discard. */
+    resetAfterDiscard(): void;
+    protected onBuilderValueChange(next: AXPBuilderValue): void;
+    private promptAddSection;
+    private promptEditSection;
+    private promptSectionForm;
+    private isDuplicateSectionCode;
+    private getNextSectionCode;
+    private mapItemToView;
+    private promptAddItems;
+    private promptEditItem;
+    private promptEditLinkedAssetItem;
+    private promptLinkAssetForm;
+    private confirmRemoveLinkedAssetItem;
+    private buildRemoveLinkedAssetFormDefinition;
+    private unlinkLinkedAssetItem;
+    private promptItemForm;
+    private buildItemFormDefinition;
+    private buildSectionFormDefinition;
+    private buildLinkAssetFormDefinition;
+    private toFieldDefinition;
+    private toBuilderValue;
+    private fromBuilderValue;
+    private mapBuilderItemToDomain;
+    private resolveLocalizedTextForDialog;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMAssetTypeSectionBuilderComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXMAssetTypeSectionBuilderComponent, "axm-asset-type-section-builder", never, { "value": { "alias": "value"; "required": false; "isSignal": true; }; "assetTypeId": { "alias": "assetTypeId"; "required": false; "isSignal": true; }; "options": { "alias": "options"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; }, never, never, true, never>;
+}
+
+declare class AXMAssetTypeSectionBuilderPageComponent extends AXPPageLayoutBaseComponent {
+    #private;
+    /** Default `{}`: required inputs throw (NG0950) if read before `AXPPageComponentRendererDirective` calls `setInput` after `createComponent`. */
+    rootContext: _angular_core.InputSignal<Record<string, unknown>>;
+    pageConfig: _angular_core.InputSignal<Record<string, unknown> | undefined>;
+    options: _angular_core.InputSignal<Record<string, unknown>>;
+    protected readonly builderRef: _angular_core.Signal<AXMAssetTypeSectionBuilderComponent | undefined>;
+    private readonly commandService;
+    private readonly entityService;
+    private readonly hostPageLayout;
+    private readonly baselineValue;
+    protected readonly committedValue: _angular_core.WritableSignal<AXMAssetTypeSectionBuilderValue | null | undefined>;
+    private readonly config;
+    protected readonly fieldName: _angular_core.Signal<string>;
+    protected readonly sourceFieldName: _angular_core.Signal<string>;
+    protected readonly sourceIdPath: _angular_core.Signal<string>;
+    protected readonly targetIdPath: _angular_core.Signal<string>;
+    protected readonly sourceEntityRef: _angular_core.Signal<string>;
+    protected readonly targetEntityRef: _angular_core.Signal<string>;
+    protected readonly context: _angular_core.Signal<Record<string, unknown>>;
+    protected readonly sourceRecordId: _angular_core.Signal<string | undefined>;
+    protected readonly targetRecordId: _angular_core.Signal<string | undefined>;
+    protected readonly readonly: _angular_core.Signal<boolean>;
+    protected readonly linkAssetMode: _angular_core.Signal<boolean>;
+    protected readonly allowAddSection: _angular_core.Signal<boolean>;
+    protected readonly allowAddItems: _angular_core.Signal<boolean>;
+    protected readonly allowEditSection: _angular_core.Signal<boolean>;
+    protected readonly allowReorderSections: _angular_core.Signal<boolean>;
+    protected readonly builderOptions: _angular_core.Signal<{
+        hideHeaderActions: boolean;
+        readonly: boolean;
+        linkAssetMode: boolean;
+        mainAssetId: string | undefined;
+        allowAddSection: boolean;
+        allowEditSection: boolean;
+        allowAddItems: boolean;
+        allowReorderSections: boolean;
+    }>;
+    protected readonly isDirty: _angular_core.Signal<boolean>;
+    protected onValueChange(value: AXMAssetTypeSectionBuilderValue): void;
+    getWizardStepContext(): Record<string, unknown> | null;
+    hasUnsavedChanges(): boolean;
+    getPrimaryMenuItems(): Promise<AXPLayoutDetailsViewAction[]>;
+    execute(command: {
+        name: string;
+        options?: unknown;
+    }): Promise<void>;
+    private handleSave;
+    protected recompute(): void;
+    private handleDiscard;
+    /** Keeps details-view `rootContext` in sync so sidebar navigation remounts with latest data. */
+    private updateRootContextField;
+    private buildLinkedAssetValue;
+    private withSlotSuffix;
+    private toAssetComponentValue;
+    private readStringConfig;
+    private readBooleanConfig;
+    private hasSections;
+    /**
+     * Prefer links loaded with the record (`byKey`). Context often holds `assetComponents: []` from a
+     * partial row merge; `[] ?? serverLinks` would keep the empty array and hide persisted assignments.
+     */
+    private pickPersistedComponentLinks;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMAssetTypeSectionBuilderPageComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXMAssetTypeSectionBuilderPageComponent, "axm-asset-type-section-builder-page", never, { "rootContext": { "alias": "rootContext"; "required": false; "isSignal": true; }; "pageConfig": { "alias": "pageConfig"; "required": false; "isSignal": true; }; "options": { "alias": "options"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+declare class AXMAssetTypeComponentsPageComponentProvider implements AXPPageComponentProvider {
+    components(): Promise<AXPPageComponentDefinition[]>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMAssetTypeComponentsPageComponentProvider, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<AXMAssetTypeComponentsPageComponentProvider>;
+}
+
+declare const ASSET_TYPE_COMPONENTS_SAVE_COMMAND = "AssetType:Components:Save";
+interface SaveAssetTypeComponentsInput {
+    id: string;
+    entity?: string;
+    field?: string;
+    value: unknown;
+    name?: unknown;
+    title?: unknown;
+}
+declare class AXMSaveAssetTypeComponentsCommand implements AXPCommand<SaveAssetTypeComponentsInput, unknown> {
+    private readonly entityService;
+    private readonly translationService;
+    execute(input: SaveAssetTypeComponentsInput): AXPCommandExecuteResultPromise<unknown>;
+    private ensureLatinName;
+    private toLatinIdentifier;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMSaveAssetTypeComponentsCommand, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<AXMSaveAssetTypeComponentsCommand>;
+}
+
+/** Triggers consumed by {@link AXMAssetOperationalStatusService}. */
+type AXMAssetOperationalStatusTrigger = 'work-started' | 'work-completed' | 'work-signed-off';
+interface AXMAssetOperationalStatusRecalculateContext {
+    workOrderId?: string;
+    maintenanceTypeId?: string;
+}
+interface AXMAssetOperationalStatusRecalculateResult {
+    assetId: string;
+    previousStatusId: string | null;
+    statusId: string | null;
+    changed: boolean;
+    reason?: string;
+}
+
+/**
+ * Central policy for asset operational status changes driven by maintenance work orders.
+ * Callers must not set `Asset.statusId` directly from workflows — use {@link recalculate} only.
+ */
+declare class AXMAssetOperationalStatusService {
+    private readonly entityService;
+    recalculate(assetIdRaw: string, trigger: AXMAssetOperationalStatusTrigger, context?: AXMAssetOperationalStatusRecalculateContext): Promise<AXMAssetOperationalStatusRecalculateResult>;
+    private resolveMaintenanceTypeId;
+    /**
+     * Inspection-like maintenance types keep the asset blocked under the combined operational status.
+     * TODO: replace title/code heuristic with an explicit MaintenanceType classification field when available.
+     */
+    private shouldBlockAssetForMaintenance;
+    private hasBlockingWorkOrders;
+    private resolveRestoredStatus;
+    private resolveDisplayText;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMAssetOperationalStatusService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<AXMAssetOperationalStatusService>;
+}
+
+export { ASSET_TYPE_COMPONENTS_SAVE_COMMAND, AXMAssetManagementAssetStatusProvider, AXMAssetManagementFeatureDefinitionProvider, AXMAssetManagementMenuProvider, AXMAssetManagementModule, AXMAssetManagementPermissionDefinitionProvider, AXMAssetManagementSearchCommandProvider, AXMAssetOperationalStatusService, AXMAssetTypeComponentsPageComponentProvider, AXMAssetTypeSectionBuilderComponent, AXMAssetTypeSectionBuilderPageComponent, AXMCreateAssetRentalHistoryRentFromCommand, AXMCreateAssetRentalHistoryRentToCommand, AXMSaveAssetTypeComponentsCommand, assertRentalPartyForDirection, createAssetTypeSectionBuilderDefaultValue, normalizeAssetTypeBuilderLocalizedField, normalizeAssetTypeSectionBuilderValue };
+export type { AXMAssetOperationalStatusRecalculateContext, AXMAssetOperationalStatusRecalculateResult, AXMAssetOperationalStatusTrigger, CreateAssetRentalHistoryRentCommandInput, SaveAssetTypeComponentsInput };