@acorex/platform 21.0.0-next.85 → 21.0.0-next.88

package/types/acorex-platform-layout-entity-contracts.d.ts

@@ -0,0 +1,864 @@
+import { AXStyleColorType, AXPopupSizeType, AXPMetaData, AXPSystemActionType, AXPValueTransformerFunctions, AXPValidationRules, AXPGridLayoutOptions, AXPExpression, AXDataSourceOperator, AXPFilterDefinition, AXPMultiLanguageString, AXPOptionsData, AXPUserReference } from '@acorex/platform/contracts';
+import { AXPQueryRequest } from '@acorex/platform/core';
+import { AXPWidgetTypesMap } from '@acorex/platform/layout/widget-core';
+
+declare enum AXPEntityCommandScope {
+    TypeLevel = "typeLevel",
+    Selected = "selected",
+    Individual = "individual",
+    Section = "section"
+}
+declare enum AXPEntityQueryType {
+    Single = "single",
+    List = "list"
+}
+interface AXPEntityCommand {
+    execute: string | Function;
+    permissions?: string[];
+}
+interface AXPEntityQuery {
+    execute: string | Function;
+    type: AXPEntityQueryType;
+}
+type AXPCommandActionType = AXPSystemActionType;
+interface AXPCommandActionLook {
+    color: AXStyleColorType;
+    icon: string;
+}
+type AXPCommandActionPriority = 'primary' | 'secondary';
+type AXPCommandActionCallback = string | {
+    name: string;
+    options?: {
+        decoration?: {
+            header?: {
+                title?: string;
+            };
+        };
+        process?: {
+            data?: any;
+            [name: string]: any;
+        };
+        layout?: {
+            size?: AXPopupSizeType;
+        };
+        [name: string]: any;
+    };
+    metadata?: AXPMetaData;
+};
+interface AXPCommandActionDisplay extends Partial<AXPCommandActionLook> {
+    name?: string;
+    command: AXPCommandActionCallback;
+    title: string;
+    type: AXPSystemActionType | string;
+    priority: 'primary' | 'secondary' | 'none';
+    separated?: boolean;
+    permissions?: string[];
+    hidden?: boolean | string;
+    disabled?: boolean | string;
+    default?: boolean;
+    order?: number;
+    /**
+     * Keyboard chords for this action (e.g. `'ctrl+shift+a'`).
+     * Pass `[]` to disable shortcuts. When omitted, platform defaults may apply for known commands.
+     */
+    shortcuts?: string[];
+}
+interface AXPEntityAction extends AXPCommandActionDisplay {
+    scope: AXPEntityCommandScope;
+    /** Child actions for dropdown submenu */
+    items?: AXPEntityAction[];
+}
+
+interface AXPEntityPropertyFilterOptions {
+    advance?: {
+        enabled?: boolean;
+        widgetType?: string;
+    };
+    inline?: {
+        enabled?: boolean;
+    };
+    preload?: {
+        enabled?: boolean;
+        required?: boolean;
+    };
+}
+interface AXPEntityPropertySortOptions {
+    enabled?: boolean;
+}
+interface AXPEntityPropertyListOptions {
+    filter?: AXPEntityPropertyFilterOptions;
+    sort?: AXPEntityPropertySortOptions;
+}
+
+interface AXEntityPropertyWidget {
+    type: string;
+    path?: string;
+    id?: string;
+    children?: AXEntityPropertyWidget[];
+    mode: 'view' | 'edit';
+    options?: Record<string, any>;
+    triggers?: {
+        event: string;
+        action: string;
+        disabled?: boolean;
+    }[];
+    valueTransforms?: AXPValueTransformerFunctions;
+}
+interface AXPEntityPropertyLayoutConfig extends AXPGridLayoutOptions {
+    label?: {
+        visible?: boolean;
+    };
+    order?: number;
+    visible?: boolean | AXPExpression;
+}
+interface AXPEntityPropertyGroup {
+    id: string;
+    title: string;
+    description?: string;
+    permissions?: string[];
+    icon?: string;
+}
+interface AXPEntityPropertyView {
+    name: string;
+    dataPath?: string;
+    permissions?: string[];
+    layout?: AXPEntityPropertyLayoutConfig;
+}
+interface AXPEntityPropertyUpdateView extends AXPEntityPropertyView {
+}
+interface AXPEntityPropertyCreateView extends AXPEntityPropertyView {
+    defaultValue?: any;
+}
+interface AXPEntitySectionView {
+    id: string;
+    order?: number;
+    collapsed?: boolean;
+    layout?: AXPEntityPropertyLayoutConfig;
+}
+interface AXPEntityProperty {
+    name: string;
+    title: string;
+    description?: string;
+    groupId?: string;
+    schema: {
+        dataType: string;
+        nullable?: boolean;
+        readonly?: boolean | string;
+        visible?: boolean | string;
+        defaultValue?: any | string | ((context: any | null) => any);
+        unique?: {
+            enabled: boolean;
+        };
+        interface?: Partial<AXEntityPropertyWidget>;
+    };
+    options?: AXPEntityPropertyListOptions;
+    validations?: AXPValidationRules;
+}
+
+/** Logical alignment for table column header/cell (respects RTL). */
+type AXPColumnContentAlign = 'start' | 'center' | 'end';
+/**
+ * Column alignment: shorthand applies to both header and cell;
+ * object form sets each side independently (omitted keys default to start).
+ */
+type AXPColumnAlign = AXPColumnContentAlign | {
+    header?: AXPColumnContentAlign;
+    cell?: AXPColumnContentAlign;
+};
+/** Shared field definition for list layouts (table columns, card fields, etc.). */
+interface AXPEntityDisplayField {
+    name: string;
+    title?: string;
+    showAs?: {
+        type: string;
+        options?: Record<string, any>;
+    };
+    options?: {
+        /** When string, evaluate against parent detail context (e.g. related list). */
+        visible?: boolean | string;
+        /** Optional dataPath override for field binding. */
+        dataPath?: string;
+        [name: string]: any;
+    };
+}
+interface AXPEntityTableColumn extends AXPEntityDisplayField {
+    options?: AXPEntityDisplayField['options'] & {
+        /** Initial column width (overrides widget column width when set). */
+        width?: string;
+        /** Header/cell alignment (shorthand or per-side). */
+        align?: AXPColumnAlign;
+    };
+}
+
+interface AXPEntityDetailListView {
+    title?: string;
+    description?: string;
+    columns: AXPEntityTableColumn[];
+    actions?: AXPEntityAction[];
+}
+
+interface AXPEntitySearchResultFormat {
+    title: string;
+    description?: string;
+}
+interface AXPEntityFormats {
+    individual: string;
+    plural: string;
+    lookup?: string;
+    displayName?: string;
+    searchResult?: AXPEntitySearchResultFormat;
+}
+
+interface AXPEntityMasterLayoutView {
+    title?: string;
+    sections: AXPEntitySectionView[];
+    properties?: AXPEntityPropertyView[];
+}
+/** Quick create config for lookup widgets (+ button) - uses subset of create form */
+interface AXPEntityQuickCreate {
+    enabled?: boolean;
+    properties?: string[];
+    layout?: {
+        size?: AXPopupSizeType;
+    };
+    excludeProperties?: string[];
+}
+interface AXPEntityMasterCreateLayoutView extends AXPEntityMasterLayoutView {
+    steps?: {
+        id: string;
+        title: string;
+        description?: string;
+    };
+    /** Quick create config for lookup widgets - uses subset of create form */
+    quickCreate?: AXPEntityQuickCreate;
+}
+interface AXPEntityMasterUpdateLayoutView extends AXPEntityMasterLayoutView {
+}
+interface AXPEntityMasterSingleLayoutView extends AXPEntityMasterLayoutView {
+    title: string;
+    description?: string;
+    actions?: AXPEntityAction[];
+}
+
+/** Card layout field presentation in master list card view. */
+type AXPCardFieldDisplay = 'simple' | 'badge';
+/** Badge color: semantic token or per-row expression (`{{ context.eval(...) }}`). */
+type AXPCardBadgeColor = AXStyleColorType | AXPExpression;
+interface AXPCardBadgeDisplayOptions {
+    /** Semantic color or expression evaluated against row context. */
+    color?: AXPCardBadgeColor;
+}
+interface AXPCardBadgeDisplay {
+    type: 'badge';
+    options?: AXPCardBadgeDisplayOptions;
+}
+/** Shorthand (`badge` / `simple`) or structured badge config with optional per-row color. */
+type AXPCardFieldDisplayConfig = AXPCardFieldDisplay | AXPCardBadgeDisplay;
+/** Card layout field in master list view. */
+type AXPCardField = AXPEntityDisplayField & {
+    layout?: AXPEntityPropertyLayoutConfig;
+    /**
+     * Field presentation. Default: `simple` (card body).
+     * Use `badge` or `{ type: 'badge', options: { color } }` for header chips beside title.
+     */
+    display?: AXPCardFieldDisplayConfig;
+    /**
+     * Badge color when presentation is badge-shaped.
+     * Prefer `display: { type: 'badge', options: { color } }` for new definitions.
+     * Omit for status fields — color is resolved from the status definition per row.
+     */
+    badgeColor?: AXPCardBadgeColor;
+};
+/** Whether the card field is shown as a header badge (not in the card body). */
+declare function isCardFieldBadgeDisplay(display: AXPCardFieldDisplayConfig | undefined): display is 'badge' | AXPCardBadgeDisplay;
+/** Resolves static badge color config from {@link AXPCardField.display} and legacy {@link AXPCardField.badgeColor}. */
+declare function resolveCardFieldBadgeColor(field: Pick<AXPCardField, 'display' | 'badgeColor'>): AXPCardBadgeColor | undefined;
+
+interface AXPQueryFilter {
+    name: string;
+    operator: AXDataSourceOperator;
+    value: any;
+}
+interface AXPQuerySort {
+    name: string;
+    dir: 'asc' | 'desc';
+}
+interface AXPQueryView {
+    name: string;
+    fixed: boolean;
+    title: string;
+    columns: string[];
+    conditions: AXPQueryFilter[];
+    sorts: AXPQuerySort[];
+    indexCol?: boolean;
+    pageSize?: number;
+    visible?: boolean;
+}
+declare function createQueryView(name: string, title: string, fixed: boolean, params?: {
+    columns?: string[];
+    conditions?: any[];
+    sorts?: AXPQuerySort[];
+}): AXPQueryView;
+declare function createAllQueryView(params?: {
+    columns?: string[];
+    conditions?: AXPQueryFilter[];
+    sorts?: AXPQuerySort[];
+} | undefined): AXPQueryView;
+
+interface AXPEntityMasterListView {
+    title?: string;
+    description?: string;
+    actions?: AXPEntityAction[];
+    views: AXPQueryView[];
+    layouts?: {
+        table?: {
+            enabled?: boolean;
+            columns: AXPEntityTableColumn[];
+        };
+        card?: {
+            enabled?: boolean;
+            header: {
+                /** Property path, expression (`{{ ... }}`), or literal — evaluated per row. */
+                title?: string;
+                description?: string;
+                icon?: string;
+            };
+            fields: AXPCardField[];
+        };
+    };
+}
+type AXPEntityMasterListLayoutType = 'table' | 'card';
+/** Master list presentation: table or card with compact (collapsed) / expanded bodies. */
+type AXPEntityMasterListDisplayMode = 'table' | 'card-compact' | 'card-expanded';
+interface AXPEntityMasterListLayoutOption {
+    id: AXPEntityMasterListLayoutType;
+    title: string;
+    icon?: string;
+}
+/** Resolves master list layouts that are currently enabled. */
+declare function resolveEnabledMasterListLayouts(layouts?: AXPEntityMasterListView['layouts']): AXPEntityMasterListLayoutType[];
+/** First enabled layout; used as the default when no user preference is stored. */
+declare function resolveDefaultMasterListLayout(layouts?: AXPEntityMasterListView['layouts']): AXPEntityMasterListLayoutType;
+
+interface AXPEntityListFilterDefinition extends AXPFilterDefinition {
+    /**
+     * Lodash-get path for inline `contains` queries on lookup/select properties.
+     * Keeps `field` as the property name for advance filters and filter widget binding.
+     */
+    inlineQueryField?: string;
+    /**
+     * Flat filter UI context key when `field` contains dots (merge-detail paths).
+     * Widget binding uses this key; storage queries still use `field`.
+     */
+    contextField?: string;
+}
+/** Encodes a dotted storage path as a flat filter context key (e.g. `person.lastName` → `person__lastName`). */
+declare function encodeEntityListFilterContextField(queryField: string): string;
+/**
+ * Resolves the flat context key used by query-filters / widget binding for a filter definition.
+ */
+declare function resolveEntityListFilterContextField(filter: Pick<AXPEntityListFilterDefinition, 'field' | 'contextField'>): string;
+/**
+ * Maps an entity list filter definition to the storage query field.
+ * Inline `contains` filters on lookup/select use `inlineQueryField` (display text path).
+ */
+declare function resolveEntityListFilterQueryField(filter: Pick<AXPFilterDefinition, 'field' | 'operator'> & Pick<AXPEntityListFilterDefinition, 'inlineQueryField'>, operator?: {
+    type?: string;
+}): string | undefined;
+
+interface AXPRelatedEntityLayout {
+    type: 'tab-detail' | 'tab-list' | 'page-detail' | 'page-list' | 'merge-detail';
+    order?: number;
+    position?: 'before' | 'after' | 'middle';
+}
+interface AXPRelatedEntityPersistence {
+    strategy?: 'embedded' | 'referenced';
+    idField?: string;
+    dataPath?: string;
+    map?: Record<string, string>;
+    hydrate?: 'eager' | 'lazy';
+    cascade?: {
+        delete?: 'none' | 'orphans' | 'all';
+    };
+    foreignKeyField?: string;
+}
+interface AXPRelatedEntity {
+    entity: string;
+    title?: string;
+    icon?: string;
+    columns?: string[] | AXPEntityTableColumn[];
+    properties?: string[];
+    excludeProperties?: string[];
+    layout?: AXPRelatedEntityLayout;
+    conditions?: AXPQueryFilter[];
+    customFilterDefinitions?: Partial<AXPEntityListFilterDefinition>[];
+    hidden?: boolean | AXPExpression;
+    actions?: AXPEntityAction[];
+    /**
+     * Controls inclusion on the host entity master **create** / **update** form.
+     * Defaults depend on layout:
+     * - **merge-detail**: omitted flags behave as **true** (opt-out with `false`).
+     * - **tab-list** / **page-list**: omitted flags behave as **false** (opt-in with `true`).
+     */
+    appearOn?: {
+        /** Include on host create form (see defaults above per layout type). */
+        create?: boolean;
+        /** Include on host update form (see defaults above per layout type). */
+        update?: boolean;
+    };
+    /**
+     * Host master-list filter policy for merge-detail related data.
+     * When omitted, filterable related properties referenced by host columns (or `properties`) are included.
+     */
+    filter?: {
+        /** Include related filterable properties on the host list (default: true). */
+        enabled?: boolean;
+    };
+    /**
+     * Relationship-level persistence strategy for merge-detail data.
+     * Defaults:
+     * - strategy: 'embedded'
+     * - idField: last segment of dataPath + 'Id' (or 'relatedId' when dataPath is missing)
+     * - map: undefined (pass-through)
+     * - hydrate: 'eager' (applies to getOne only in mock)
+     * - cascade.delete: 'none'
+     */
+    persistence?: AXPRelatedEntityPersistence;
+}
+
+declare enum AXPRelationshipKind {
+    Association = 0,
+    Composition = 1,
+    Aggregation = 2
+}
+declare enum AXPRelationshipCardinality {
+    OneToOne = 0,
+    OneToMany = 1,
+    ManyToMany = 2
+}
+interface AXPRelationship {
+    id: string;
+    from: string;
+    to: string;
+    kind: AXPRelationshipKind;
+    cardinality: AXPRelationshipCardinality;
+}
+interface AXPEntity {
+    plugins?: {
+        name: string;
+        options?: AXPOptionsData;
+    }[];
+    /**
+     * High-level rules: when expression evaluates true, apply actions to the given targets
+     * (property/section/action). Reduces repetition of the same condition across many properties.
+     * Evaluation context: form data, user, entity; precedence vs property-level visible/readonly
+     * must be defined where rules are applied.
+     */
+    rules?: Array<{
+        name: string;
+        expression: AXPExpression;
+        actions: Array<{
+            target: {
+                type: 'property' | 'section' | 'action';
+                name: string;
+            };
+            values: AXPOptionsData;
+        }>;
+    }>;
+    module: string;
+    name: string;
+    icon?: string;
+    parentKey?: string;
+    category?: AXPEntityCategoryPlugin;
+    title: string;
+    formats: AXPEntityFormats;
+    relatedEntities?: AXPRelatedEntity[];
+    pages?: AXPEntityPage[];
+    groups?: AXPEntityPropertyGroup[];
+    properties: AXPEntityProperty[];
+    columns?: AXPEntityTableColumn[];
+    commands?: {
+        create?: AXPEntityCommand | undefined;
+        update?: AXPEntityCommand | undefined;
+        delete?: AXPEntityCommand | undefined;
+        [name: string]: AXPEntityCommand | undefined;
+    };
+    queries?: {
+        byKey?: AXPEntityQuery;
+        list?: AXPEntityQuery;
+        lookup?: AXPEntityQuery;
+        history?: AXPEntityQuery;
+        comments?: AXPEntityQuery;
+        [name: string]: AXPEntityQuery | undefined;
+    };
+    validations?: AXPValidationRules;
+    interfaces?: {
+        master?: {
+            single?: AXPEntityMasterSingleLayoutView;
+            list?: AXPEntityMasterListView;
+            create?: AXPEntityMasterCreateLayoutView;
+            update?: AXPEntityMasterUpdateLayoutView;
+        };
+        detail?: {
+            list?: AXPEntityDetailListView;
+        };
+    };
+}
+declare function getEntityInfo(entity: AXPEntity): {
+    source: string;
+    module: {
+        route: string;
+    };
+    entity: {
+        route: string;
+    };
+};
+interface AXPEntityPage {
+    componentKey: string;
+    field?: string;
+    title?: AXPMultiLanguageString;
+    icon?: string;
+    description?: AXPMultiLanguageString;
+    layout?: {
+        order?: number;
+        position?: 'before' | 'after' | 'middle';
+    };
+    hidden?: boolean | string;
+    permissions?: string[];
+    appearOn?: {
+        create?: boolean;
+        update?: boolean;
+    };
+    options?: Record<string, any>;
+}
+interface AXPEntityCategoryPlugin {
+    entity: string;
+    title?: string;
+    textField?: string;
+    valueField?: string;
+    conditions?: AXPQueryFilter[];
+    applyConditions?: AXPQueryFilter[];
+}
+interface AXPEntityVersionHistory {
+    enabled?: boolean;
+    showInList?: boolean;
+    showInDetail?: boolean;
+}
+interface AXPAggregate {
+    id: string;
+    name: string;
+    title: AXPMultiLanguageString;
+    entities: AXPEntity[];
+}
+interface AXPModule {
+    name: string;
+    title: AXPMultiLanguageString;
+    aggregates: AXPAggregate[];
+    relationships?: AXPRelationship[];
+}
+interface AXPApplication {
+    name: string;
+    title: AXPMultiLanguageString;
+    modules: AXPModule[];
+}
+declare enum AXPEntityType {
+    Entity = 0,
+    AggregateRoot = 1,
+    ValueObject = 2
+}
+interface AXPEntityV2 {
+    version: 2;
+    module: string;
+    aggregate: string;
+    name: string;
+    type: AXPEntityType;
+    icon?: string;
+    title: string;
+    description?: string;
+    plugins?: {
+        name: string;
+        options?: AXPOptionsData;
+    }[];
+    pages?: AXPEntityPage[];
+    groups?: AXPEntityPropertyGroup[];
+    properties: AXPEntityProperty[];
+    formats: AXPEntityFormats;
+    columns?: AXPEntityTableColumn[];
+    validations?: AXPValidationRules;
+    interfaces?: {
+        master?: {
+            single?: AXPEntityMasterSingleLayoutView;
+            list?: AXPEntityMasterListView;
+            create?: AXPEntityMasterCreateLayoutView;
+            update?: AXPEntityMasterUpdateLayoutView;
+        };
+        detail?: {
+            list?: AXPEntityDetailListView;
+        };
+    };
+}
+
+interface AXPAuditEvent {
+    at?: Date;
+    by?: AXPUserReference;
+    reason?: string;
+    source?: string;
+}
+interface AXPRecordAuditInfo {
+    created?: AXPAuditEvent;
+    updated?: AXPAuditEvent;
+    deleted?: AXPAuditEvent;
+}
+interface AXPRecordStateInfo {
+    isHidden?: boolean;
+    isSystem?: boolean;
+    isImmutable?: boolean;
+    /** @deprecated Prefer explicit domain modeling over this flag. */
+    isDistributed?: boolean;
+}
+interface AXPRecordOwnershipInfo {
+    tenantId?: string;
+    applicationId?: string;
+    userId?: string;
+}
+interface AXPRecordWorkflowInfo {
+    instanceId?: string | null;
+    definitionId?: string | null;
+    correlationId?: string | null;
+    pinnedVersion?: number | null;
+}
+interface AXPEntityModel<Id> {
+    id: Id;
+    auditInfo?: AXPRecordAuditInfo;
+    stateInfo?: AXPRecordStateInfo;
+    ownershipInfo?: AXPRecordOwnershipInfo;
+    workflowInfo?: AXPRecordWorkflowInfo;
+}
+interface AXPEntityCreateDto {
+}
+interface AXPEntityUpdateDto<Id> {
+    id: Id;
+}
+interface AXPEntityOutputDto<Id> {
+    id: Id;
+}
+interface AXPEntityDetailDto<Id> extends AXPEntityOutputDto<Id> {
+}
+interface AXPEntityListItemDto<Id> extends AXPEntityOutputDto<Id> {
+}
+interface AXPMockDto<Id> extends AXPEntityModel<Id> {
+}
+
+type AXPEntityAggregateReducerType = 'count' | 'sum' | 'min' | 'max' | 'avg';
+interface AXPEntityAggregateMeasure {
+    reducer: AXPEntityAggregateReducerType;
+    /** Required for sum, min, max, and avg. Ignored for count (rows per group). */
+    field?: string;
+    /** Result column name; defaults are derived from the reducer and field. */
+    alias?: string;
+}
+/**
+ * Aggregate stored rows after the same filter/sort pipeline as {@link AXPQueryRequest}.
+ * Group keys use dotted field paths (same as lodash-style getters).
+ */
+interface AXPEntityAggregateRequest extends Pick<AXPQueryRequest, 'filter' | 'sort'> {
+    groupBy: string[];
+    measures: AXPEntityAggregateMeasure[];
+}
+interface AXPEntityAggregateResult {
+    rows: Record<string, unknown>[];
+}
+interface AXPEntityQueryAllOptions {
+    /**
+     * Page size for backends that read page-by-page (HTTP API).
+     * In-memory backends load the filtered set once and ignore this.
+     */
+    pageSize?: number;
+    /** Maximum rows to return or scan (safety cap). */
+    maxRows?: number;
+}
+interface AXPEntityQueryAllResult<T> {
+    items: T[];
+    /** Row count matching filter/sort before applying maxRows. */
+    total: number;
+    /** True when maxRows prevented returning every matching row. */
+    truncated: boolean;
+}
+interface AXPEntityAggregateOptions {
+    /** Maximum rows to load for aggregation when the backend pages remotely (default 50_000). */
+    maxRows?: number;
+    /** Page size for remote paging during aggregate (default 500). */
+    pageSize?: number;
+}
+
+declare function entityMasterCreateAction(): AXPEntityAction;
+declare function entityMasterEditAction(): AXPEntityAction;
+declare function entityMasterBulkDeleteAction(): AXPEntityAction;
+declare function entityMasterViewAction(): AXPEntityAction;
+declare function entityMasterDeleteAction(): AXPEntityAction;
+declare function entityMasterCrudActions(options?: {
+    create?: boolean;
+    delete?: boolean;
+    view?: boolean;
+    edit?: boolean;
+}): AXPEntityAction[];
+declare function entityMasterRecordActions(): AXPEntityAction[];
+declare function entityDetailsCreateActions(parentId: string): AXPEntityAction;
+declare function entityDetailsCreateActionsDeferredParent(): AXPEntityAction;
+declare function mergeForeignKeyFieldIntoCreateActions(foreignKeyField: string | undefined, actions: AXPEntityAction[] | undefined): AXPEntityAction[];
+declare function collectNestedCreateHiddenProperties(relatedEntity: AXPRelatedEntity): string[] | undefined;
+declare function entityDetailsSimpleCondition(fk: string): AXPQueryFilter;
+declare function entityDetailsReferenceCondition(type: string): AXPQueryFilter[];
+declare function entityDetailsEditAction(): AXPEntityAction;
+declare function entityDetailsNewEditAction(): AXPEntityAction;
+declare function entityOverrideDetailsViewAction(): AXPEntityAction;
+declare function entityDetailsCrudActions(parentId?: string, options?: {
+    create?: boolean;
+    delete?: boolean;
+    view?: boolean;
+    edit?: boolean;
+}): AXPEntityAction[];
+declare function entityDetailsReferenceCreateActions(type: string): AXPEntityAction[];
+
+/**
+ * Normalizes display templates before expression evaluation.
+ * Converts simple dot paths (e.g. `{{ position.title }}`) to `context.eval("position.title")`.
+ */
+declare function normalizeExpressionTemplate(template: string): string;
+/** @see normalizeExpressionTemplate */
+declare const normalizeEntityDisplayTemplate: typeof normalizeExpressionTemplate;
+/** True when formatted text still contains unresolved template markers. */
+declare function isUnresolvedEntityDisplayTemplate(value: string): boolean;
+/**
+ * Strips literal `undefined` / `null` tokens produced when expression segments are missing.
+ */
+declare function sanitizeResolvedEntityDisplayTitle(value: string): string;
+/** True when a resolved title is non-empty and safe to show in search or entity chrome. */
+declare function isMeaningfulEntityDisplayTitle(value: string): boolean;
+declare function isRowBoundEntityDisplayTemplate(template: string): boolean;
+
+interface AXPEntityPropertyExposeEntry {
+    source: string;
+    target: string;
+}
+type AXPEntityPropertyLike = {
+    name: string;
+    schema?: {
+        interface?: {
+            options?: Record<string, unknown>;
+        };
+    };
+};
+/**
+ * Parses lookup/select `expose` entries from a property interface options object.
+ */
+declare function parsePropertyExposeEntries(options: Record<string, unknown> | undefined): AXPEntityPropertyExposeEntry[];
+/**
+ * Collects all non-empty `expose[].target` paths from a property.
+ */
+declare function collectPropertyExposeTargetPaths(property: AXPEntityPropertyLike): string[];
+/**
+ * Resolves list column `options.dataPath` for a property when explicitly set.
+ */
+declare function resolveEntityColumnDataPath(entity: AXPEntity | null | undefined, propertyName: string): string | undefined;
+/**
+ * Resolves the lodash-get path for lookup/select display text from expose metadata.
+ */
+declare function resolvePropertyExposeDisplayTarget(options: Record<string, unknown> | undefined): string | undefined;
+/**
+ * Resolves the lodash-get path used for inline `contains` filters on lookup/select properties.
+ * Prefers list column `dataPath`, then lookup `expose` target for `textField` (or first non-id expose).
+ * Returns `undefined` when the property name should be used as-is (e.g. plain text fields).
+ */
+declare function resolveEntityPropertyInlineFilterField(entity: AXPEntity | null | undefined, property: AXPEntityPropertyLike): string | undefined;
+
+interface AXPEntitySearchTitleContext {
+    /** Templates tried after the primary `searchResult.title` fails (`single.title`, lookup, individual). */
+    fallbackTemplates: string[];
+    /** Entity property paths tried when templates do not resolve (`lookup`, identifier, common fields). */
+    fallbackFields: string[];
+}
+/**
+ * Builds entity-scoped fallback metadata for global search (registered on each entity search definition).
+ */
+declare function buildEntitySearchTitleContext(entity: AXPEntity, primaryTemplate?: string): AXPEntitySearchTitleContext;
+/**
+ * Row title template chain aligned with entity layouts.
+ * Priority: `interfaces.master.single.title` → `formats.searchResult.title` → `formats.individual`.
+ */
+declare function resolveEntityRowTitleTemplate(entity: AXPEntity | null | undefined): string | undefined;
+/**
+ * Record title template for modify popups: `interfaces.master.update.title` → `single.title`.
+ */
+declare function resolveEntityModifyRecordTitleTemplate(entity: AXPEntity | null | undefined): string | undefined;
+
+type AXPCollectEntityQuickSearchPathsResolver = (moduleName: string, entityName: string) => Promise<AXPEntity | null>;
+/**
+ * Lodash-get paths for quick search from a single entity definition: string-like property names
+ * plus lookup `expose[].target` paths (e.g. `brand.title`).
+ */
+declare function collectQuickSearchPathsFromSingleEntityDefinition(entity: AXPEntity | null | undefined): string[];
+/**
+ * Adds dotted paths from master columns (`name` or `options.dataPath`), e.g. `person.fullName`, `jobDefinition.title`.
+ */
+declare function collectNestedFieldPathsFromEntityColumns(entity: AXPEntity | null | undefined): string[];
+/**
+ * Collects lodash-get field paths used for mock/API quick search (`contains` / OR filters):
+ * host properties and lookup expose targets, dotted column paths, and merge-detail related entities
+ * prefixed with the related entity merge `persistence.dataPath` (e.g. `person.firstName`).
+ */
+declare function collectEntityQuickSearchFieldPaths(entity: AXPEntity | null | undefined, resolveRelatedDefinition: AXPCollectEntityQuickSearchPathsResolver): Promise<string[]>;
+
+interface AXPBuildEntityListFilterDefinitionsDeps {
+    resolveWidget?: (type: AXPWidgetTypesMap[keyof AXPWidgetTypesMap]) => {
+        icon?: string;
+        defaultFilterWidgetName?: string;
+    } | undefined;
+}
+/**
+ * Builds master-list filter definitions from host properties and merge-detail related entities.
+ * Related filters use `{dataPath}.{property}` query fields (e.g. `person.firstName`).
+ */
+declare function collectEntityListFilterDefinitions(entity: AXPEntity | null | undefined, resolveRelatedDefinition: AXPCollectEntityQuickSearchPathsResolver, deps?: AXPBuildEntityListFilterDefinitionsDeps): Promise<AXPEntityListFilterDefinition[]>;
+
+/** Entity query filter field for {@link AXPRecordWorkflowInfo.instanceId}. */
+declare const AXP_RECORD_WORKFLOW_INFO_INSTANCE_ID_FIELD: "workflowInfo.instanceId";
+/** Entity query filter field for {@link AXPRecordWorkflowInfo.correlationId}. */
+declare const AXP_RECORD_WORKFLOW_INFO_CORRELATION_ID_FIELD: "workflowInfo.correlationId";
+/** Entity query filter field for {@link AXPRecordWorkflowInfo.definitionId}. */
+declare const AXP_RECORD_WORKFLOW_INFO_DEFINITION_ID_FIELD: "workflowInfo.definitionId";
+/** Returns a trimmed workflow instance id from a record, if present. */
+declare function getRecordWorkflowInstanceId(record: {
+    workflowInfo?: AXPRecordWorkflowInfo | null;
+} | null | undefined): string | null;
+/** Returns a trimmed workflow correlation id from a record, if present. */
+declare function getRecordWorkflowCorrelationId(record: {
+    workflowInfo?: AXPRecordWorkflowInfo | null;
+} | null | undefined): string | null;
+/** Builds canonical workflow metadata for a domain record (engine / middleware). */
+declare function buildAXPRecordWorkflowInfo(params: {
+    instanceId: string;
+    definitionId?: string | null;
+    correlationId?: string | null;
+    pinnedVersion?: number | null;
+}): AXPRecordWorkflowInfo;
+
+/** Row path used when context carries a nested entity layout title. */
+declare const ENTITY_LAYOUT_SINGLE_TITLE_PATH = "entity.layout.single.title";
+/** Widget option for a pre-evaluated or template entity row title (entity list column mappers). */
+declare const ENTITY_ROW_POPUP_TITLE_OPTION = "popupTitle";
+/** Widget option alias for entity row title templates in view/edit forms. */
+declare const ENTITY_ROW_TITLE_TEMPLATE_OPTION = "titleTemplate";
+
+/** Platform entity layout datasource registry names. */
+declare const AXPEntityDataSourceKeys: {
+    readonly Entities: "entities";
+};
+
+declare const AXPEntityEventsKeys: {
+    readonly REFRESH_LAYOUT: "entity:refresh-layout";
+    readonly REFRESH_DATA: "entity:refresh-data";
+};
+
+export { AXPEntityCommandScope, AXPEntityDataSourceKeys, AXPEntityEventsKeys, AXPEntityQueryType, AXPEntityType, AXPRelationshipCardinality, AXPRelationshipKind, AXP_RECORD_WORKFLOW_INFO_CORRELATION_ID_FIELD, AXP_RECORD_WORKFLOW_INFO_DEFINITION_ID_FIELD, AXP_RECORD_WORKFLOW_INFO_INSTANCE_ID_FIELD, ENTITY_LAYOUT_SINGLE_TITLE_PATH, ENTITY_ROW_POPUP_TITLE_OPTION, ENTITY_ROW_TITLE_TEMPLATE_OPTION, buildAXPRecordWorkflowInfo, buildEntitySearchTitleContext, collectEntityListFilterDefinitions, collectEntityQuickSearchFieldPaths, collectNestedCreateHiddenProperties, collectNestedFieldPathsFromEntityColumns, collectPropertyExposeTargetPaths, collectQuickSearchPathsFromSingleEntityDefinition, createAllQueryView, createQueryView, encodeEntityListFilterContextField, entityDetailsCreateActions, entityDetailsCreateActionsDeferredParent, entityDetailsCrudActions, entityDetailsEditAction, entityDetailsNewEditAction, entityDetailsReferenceCondition, entityDetailsReferenceCreateActions, entityDetailsSimpleCondition, entityMasterBulkDeleteAction, entityMasterCreateAction, entityMasterCrudActions, entityMasterDeleteAction, entityMasterEditAction, entityMasterRecordActions, entityMasterViewAction, entityOverrideDetailsViewAction, getEntityInfo, getRecordWorkflowCorrelationId, getRecordWorkflowInstanceId, isCardFieldBadgeDisplay, isMeaningfulEntityDisplayTitle, isRowBoundEntityDisplayTemplate, isUnresolvedEntityDisplayTemplate, mergeForeignKeyFieldIntoCreateActions, normalizeEntityDisplayTemplate, normalizeExpressionTemplate, parsePropertyExposeEntries, resolveCardFieldBadgeColor, resolveDefaultMasterListLayout, resolveEnabledMasterListLayouts, resolveEntityColumnDataPath, resolveEntityListFilterContextField, resolveEntityListFilterQueryField, resolveEntityModifyRecordTitleTemplate, resolveEntityPropertyInlineFilterField, resolveEntityRowTitleTemplate, resolvePropertyExposeDisplayTarget, sanitizeResolvedEntityDisplayTitle };
+export type { AXEntityPropertyWidget, AXPAggregate, AXPApplication, AXPAuditEvent, AXPBuildEntityListFilterDefinitionsDeps, AXPCardBadgeColor, AXPCardBadgeDisplay, AXPCardBadgeDisplayOptions, AXPCardField, AXPCardFieldDisplay, AXPCardFieldDisplayConfig, AXPCollectEntityQuickSearchPathsResolver, AXPColumnAlign, AXPColumnContentAlign, AXPCommandActionCallback, AXPCommandActionDisplay, AXPCommandActionLook, AXPCommandActionPriority, AXPCommandActionType, AXPEntity, AXPEntityAction, AXPEntityAggregateMeasure, AXPEntityAggregateOptions, AXPEntityAggregateReducerType, AXPEntityAggregateRequest, AXPEntityAggregateResult, AXPEntityCategoryPlugin, AXPEntityCommand, AXPEntityCreateDto, AXPEntityDetailDto, AXPEntityDetailListView, AXPEntityDisplayField, AXPEntityFormats, AXPEntityListFilterDefinition, AXPEntityListItemDto, AXPEntityMasterCreateLayoutView, AXPEntityMasterLayoutView, AXPEntityMasterListDisplayMode, AXPEntityMasterListLayoutOption, AXPEntityMasterListLayoutType, AXPEntityMasterListView, AXPEntityMasterSingleLayoutView, AXPEntityMasterUpdateLayoutView, AXPEntityModel, AXPEntityOutputDto, AXPEntityPage, AXPEntityProperty, AXPEntityPropertyCreateView, AXPEntityPropertyExposeEntry, AXPEntityPropertyFilterOptions, AXPEntityPropertyGroup, AXPEntityPropertyLayoutConfig, AXPEntityPropertyLike, AXPEntityPropertyListOptions, AXPEntityPropertySortOptions, AXPEntityPropertyUpdateView, AXPEntityPropertyView, AXPEntityQuery, AXPEntityQueryAllOptions, AXPEntityQueryAllResult, AXPEntityQuickCreate, AXPEntitySearchResultFormat, AXPEntitySearchTitleContext, AXPEntitySectionView, AXPEntityTableColumn, AXPEntityUpdateDto, AXPEntityV2, AXPEntityVersionHistory, AXPMockDto, AXPModule, AXPQueryFilter, AXPQuerySort, AXPQueryView, AXPRecordAuditInfo, AXPRecordOwnershipInfo, AXPRecordStateInfo, AXPRecordWorkflowInfo, AXPRelatedEntity, AXPRelatedEntityLayout, AXPRelatedEntityPersistence, AXPRelationship };