@acorex/platform 20.3.0-next.1 → 20.3.0-next.11

package/common/index.d.ts

@@ -3,7 +3,7 @@ import { InjectionToken, OnChanges, ElementRef, Renderer2, SimpleChanges, EventE
 import { AXStyleColorType, AXDataSourceOperator, AXDataSourceFilterOption } from '@acorex/cdk/common';
 import * as i2 from '@acorex/components/popup';
 import { AXPopupSizeType, AXPopupService } from '@acorex/components/popup';
-import { AXPNavigateActionCommand, AXPExecuteCommand, AXPMetaData, AXPValueTransformerFunctions, AXPValidationRules, AXPPlatformScope, AXPPlatformScopeKey, AXPOptionsData, AXPWidgetTriggers, AXPAppStartUpService, AXPLogoConfig, AXPUserReference, AXPApplicationUserReference, AXPExpressionEvaluatorScopeProvider, AXPExpressionEvaluatorScopeProviderContext } from '@acorex/platform/core';
+import { AXPNavigateActionCommand, AXPExecuteCommand, AXPMetaData, AXPSystemActionType, AXPValueTransformerFunctions, AXPValidationRules, AXPOptionsData, AXPPlatformScope, AXPPlatformScopeKey, AXPWidgetTriggers, AXPAppStartUpService, AXPLogoConfig, AXPEntityReference, AXPApplicationUserReference, AXPExpressionEvaluatorScopeProvider, AXPExpressionEvaluatorScopeProviderContext } from '@acorex/platform/core';
 import { AXPWidgetTypesMap, AXPWidgetNode, AXPMetaDataDefinition } from '@acorex/platform/layout/builder';
 import * as i5 from '@angular/router';
 import { Route, Routes } from '@angular/router';
@@ -233,7 +233,7 @@ interface AXPSearchDisplayResultForSave {
 }
 interface AXPSearchAction extends Partial<AXPCommandActionLook> {
     name: string;
-    type: AXPCommandActionType;
+    type: AXPSystemActionType | string;
     priority: AXPCommandActionPriority;
     separated?: boolean;
 }
@@ -400,7 +400,7 @@ interface AXPEntitySectionView {
     id: string;
     description?: string;
     order?: number;
-    type?: 'wrapper' | 'section';
+    collapsed?: boolean;
     layout?: AXPEntityPropertyLayoutConfig;
 }
 interface AXPEntityProperty {
@@ -438,6 +438,11 @@ interface AXPEntityProperty {
 interface AXPEntityTableColumn {
     name: string;
     title?: string;
+    hidden?: boolean;
+    showAs?: {
+        type: AXPWidgetTypesMap[keyof AXPWidgetTypesMap] | string;
+        options?: Record<string, any>;
+    };
     sort?: {
         enabled?: boolean;
         dir?: 'asc' | 'desc';
@@ -457,7 +462,8 @@ interface AXPEntityQuery {
     execute: string | Function;
     type: AXPEntityQueryType;
 }
-type AXPCommandActionType = 'create' | 'update' | 'delete' | 'print' | 'confirm' | 'report' | 'info' | 'view' | 'archive' | 'design' | 'upload' | 'version-history' | 'sent' | 'review' | 'sign';
+
+type AXPCommandActionType = AXPSystemActionType;
 interface AXPCommandActionLook {
     color: AXStyleColorType;
     icon: string;
@@ -486,7 +492,7 @@ interface AXPCommandActionDisplay extends Partial<AXPCommandActionLook> {
     name?: string;
     command: AXPCommandActionCallback;
     title: string;
-    type: AXPCommandActionType;
+    type: AXPSystemActionType | string;
     priority: 'primary' | 'secondary';
     separated?: boolean;
     permissions?: string[];
@@ -498,17 +504,21 @@ interface AXPEntityAction extends AXPCommandActionDisplay {
     scope: AXPEntityCommandScope;
 }
 interface AXPEntity {
+    plugins?: {
+        name: string;
+        options?: AXPOptionsData;
+    }[];
     module: string;
     name: string;
-    source: string;
+    icon?: string;
     parentKey?: string;
     category?: AXPCategoryEntity;
-    versionHistory?: AXPEntityVersionHistory;
     title: string;
     formats: {
         individual: string;
         plural: string;
         lookup?: string;
+        displayName?: string;
         searchResult?: {
             title: string;
             description?: string;
@@ -556,7 +566,7 @@ declare function getEntityInfo(entity: AXPEntity): {
 };
 declare function createQueryView(name: string, title: string, fixed: boolean, params?: {
     columns?: string[];
-    conditions?: AXPQueryFilter[];
+    conditions?: any[];
     sorts?: AXPQuerySort[];
 }): AXPQueryView;
 declare function createAllQueryView(params?: {
@@ -567,10 +577,35 @@ declare function createAllQueryView(params?: {
 interface AXPRelatedEntity {
     entity: string;
     title?: string;
+    icon?: string;
     columns?: string[];
+    layout?: {
+        type: 'tab-detail' | 'tab-list' | 'page-detail' | 'page-list' | 'merge-detail';
+        order?: number;
+        position?: 'before' | 'after' | 'middle';
+    };
     conditions?: AXPQueryFilter[];
     hidden?: boolean | string;
     actions?: AXPEntityAction[];
+    /**
+     * 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?: {
+        strategy?: 'embedded' | 'referenced';
+        idField?: string;
+        dataPath?: string;
+        map?: Record<string, string>;
+        hydrate?: 'eager' | 'lazy';
+        cascade?: {
+            delete?: 'none' | 'orphans' | 'all';
+        };
+    };
 }
 interface AXPCategoryEntity {
     entity: string;
@@ -653,7 +688,6 @@ interface AXPQuerySort {
     name: string;
     dir: 'asc' | 'desc';
 }
-declare function resolveActionLook(tr: AXPEntityAction): AXPCommandActionLook;
 
 interface AXPFilterOperator {
     name: string;
@@ -1089,6 +1123,32 @@ interface AXPFileStorageUpdateRequest {
      */
     isPrimary?: boolean;
 }
+interface AXPFileManyStorageInfo {
+    /**
+    * The unique identifier for the stored file.
+    */
+    id?: string;
+    /**
+     * The unique identifier for the stored file.
+     */
+    fileId: string;
+    /**
+    * The unique identifier of referenced entity.
+    */
+    refId: string;
+    /**
+     * The type of the referenced entity.
+     */
+    refType: string;
+    /**
+     * The size of the file in bytes.
+     */
+    size: number;
+    /**
+     * The name of the file.
+     */
+    name?: string;
+}
 /**
  * Represents information about a file stored in the AXP file storage system.
  */
@@ -1144,6 +1204,58 @@ interface AXPFileStorageInfo {
     status: AXPFileStorageStatus;
     binary: File;
 }
+interface AXPFileStorageInfo {
+    /**
+     * The unique identifier for the stored file.
+     */
+    id?: string;
+    /**
+     * The unique identifier for the stored file.
+     */
+    fileId: string;
+    /**
+     * The unique identifier of referenced entity.
+     */
+    refId: string;
+    /**
+     * The type of the referenced entity.
+     */
+    refType: string;
+    /**
+     * The category of the file. profile-picture, company-logo, policy, document, etc.
+     */
+    category: string;
+    /**
+     * The URL where the file can be accessed.
+     */
+    url?: string;
+    /**
+     * The size of the file in bytes.
+     */
+    size: number;
+    /**
+     * The name of the file.
+     */
+    name?: string;
+    /**
+     * The MIME type of the file.
+     */
+    mimeType: string;
+    /**
+     * The date and time when the file was uploaded.
+     */
+    uploadedAt: Date;
+    /**
+     * Indicates whether the file is public or private.
+     */
+    isPublic: boolean;
+    /**
+     * Indicates whether the file is primary or not.
+     */
+    isPrimary?: boolean;
+    status: AXPFileStorageStatus;
+    binary: File;
+}
 /**
  * Represents information about a file stored in the AXP file storage system.
  */
@@ -1185,6 +1297,7 @@ declare abstract class AXPFileStorageService {
     abstract save(request: AXPFileStorageCreateRequest): Promise<AXPFileStorageInfo>;
     abstract update(request: AXPFileStorageUpdateRequest): Promise<AXPFileStorageInfo>;
     abstract find(request: AXPFileStorageFindRequest): Promise<AXPFileStorageInfo[]>;
+    abstract findMany(ids: string[]): Promise<AXPFileManyStorageInfo[]>;
     abstract getInfo(fileId: string): Promise<AXPFileStorageInfo>;
     abstract remove(fileId: string): Promise<void>;
     abstract commit(fileId: string): Promise<void>;
@@ -1267,7 +1380,7 @@ interface AXPLockRequest {
     type: AXPLockType;
     date: string;
     expireAt?: Date;
-    lockedBy: AXPUserReference;
+    lockedBy: AXPEntityReference;
 }
 interface AXPUnLockRequest {
     refId: string;
@@ -1485,5 +1598,5 @@ declare class AXMWorkflowErrorHandler implements AXPErrorHandler {
     static ɵprov: i0.ɵɵInjectableDeclaration<AXMWorkflowErrorHandler>;
 }
 
-export { ALL_DEFAULT_OPERATORS, AXMWorkflowErrorHandler, AXPAppVersionService, AXPCleanNestedFilters, AXPClipBoardService, AXPCommonModule, AXPCustomOperatorService, AXPCustomOperatorServiceImpl, AXPDataProvider, AXPDialogConfirmAction, AXPEntityCommandScope, AXPEntityQueryType, AXPErrorHandlerRegistryService, AXPExportService, AXPFileStorageService, AXPFileStorageStatus, AXPFileTypeProviderService, AXPFilterOperatorMiddlewareService, AXPFilterOperatorMiddlewareServiceImpl, AXPFooterTextSlotComponent, AXPGlobalErrorHandler, AXPGlobalVariableDefinitionService, AXPGlobalVariableEvaluatorScopeProvider, AXPGridLayoutDirective, AXPHomePageModule, AXPHomePageService, AXPLockService, AXPLogoComponent, AXPMenuProviderService, AXPMenuSearchDefinitionProvider, AXPMenuSearchProvider, AXPMenuService, AXPNavBarSlotComponent, AXPNavigateWorkflow, AXPPlatformDefaultConfigs, AXPRedirectEvent, AXPRefreshEvent, AXPRelationshipCardinality, AXPRelationshipKind, AXPReloadAction, AXPReloadEvent, AXPSearchCommandProvider, AXPSearchDefinitionActionBuilder, AXPSearchDefinitionBuilder, AXPSearchDefinitionProviderContext, AXPSearchDefinitionProviderService, AXPSearchService, AXPSettingDefaultValuesAggregatorService, AXPSettingDefinitionGroupBuilder, AXPSettingDefinitionProviderContext, AXPSettingDefinitionProviderService, AXPSettingDefinitionSectionBuilder, AXPSettingService, AXPStickyDirective, AXPToastAction, AXPWorkflowNavigateAction, AXPWorkflowRouterNavigateAction, AXP_APP_VERSION_PROVIDER, AXP_FILE_TYPE_INFO_PROVIDER, AXP_GLOBAL_VARIABLE_DEFINITION_PROVIDER, AXP_HOME_PAGES, AXP_HOME_PAGE_DEFAULT_KEY, AXP_MENU_PROVIDER, AXP_PLATFORM_CONFIG_TOKEN, AXP_ROOT_CONFIG_TOKEN, AXP_SEARCH_DEFINITION_PROVIDER, AXP_SEARCH_PROVIDER, AXP_SETTING_DEFAULT_VALUES_PROVIDERS, AXP_SETTING_DEFINITION_PROVIDER, AXP_SETTING_VALUE_PROVIDER, BETWEEN_OPER, BOOLEAN_OPERATORS, CONTAINS_OPER, DATE_OPERATORS, ENDS_WITH_OPER, ENVIRONMENT, EQ_OPER, GTE_OPER, GT_OPER, IN_OPER, IS_EMPTY_OPER, IS_NOT_EMPTY_OPER, LTE_OPER, LT_OPER, NOT_CONTAINS_OPER, NOT_EQ_OPER, NUMBER_OPERATORS, STARTS_WITH_OPER, STRING_OPERATORS, configPlatform, createAllQueryView, createQueryView, getEntityInfo, provideDynamicHomePage, resolveActionLook };
-export type { AXEntityPropertyWidget, AXPAggregate, AXPAppVersion, AXPAppVersionProvider, AXPApplication, AXPCategoryEntity, AXPCommandActionCallback, AXPCommandActionDisplay, AXPCommandActionLook, AXPCommandActionPriority, AXPCommandActionType, AXPCommonModuleConfigs, AXPCurrency, AXPDomToImageOptions, AXPEntity, AXPEntityAction, AXPEntityCommand, AXPEntityDetailListView, AXPEntityMasterCreateLayoutView, AXPEntityMasterLayoutView, AXPEntityMasterListView, AXPEntityMasterSingleLayoutView, AXPEntityMasterUpdateLayoutView, AXPEntityProperty, AXPEntityPropertyCreateView, AXPEntityPropertyGroup, AXPEntityPropertyLayoutConfig, AXPEntityPropertyUpdateView, AXPEntityPropertyView, AXPEntityQuery, AXPEntitySectionView, AXPEntityTableColumn, AXPEntityVersionHistory, AXPErrorHandler, AXPFileExtension, AXPFileStorageCreateRequest, AXPFileStorageFindRequest, AXPFileStorageInfo, AXPFileStorageUpdateRequest, AXPFileType, AXPFileTypeInfoProvider, AXPFilterOperator, AXPGeoLocation, AXPGlobalVariableDefinition, AXPGlobalVariableDefinitionProvider, AXPGlobalVariableDefinitionProviderToken, AXPGridLayoutOptions, AXPGridLayoutPositions, AXPGroupSearchResult, AXPHomePageDefinition, AXPLanguage, AXPLocaleProfile, AXPLockGetInfoRequest, AXPLockInfo, AXPLockRequest, AXPLockType, AXPMenuFinderResult, AXPMenuInsertion, AXPMenuItem, AXPMenuItemCommand, AXPMenuItemWithParent, AXPMenuProvider, AXPMenuProviderContext, AXPMenuType, AXPModule, AXPPlatformConfigs, AXPQueryFilter, AXPQuerySort, AXPQueryView, AXPRelatedEntity, AXPRelationship, AXPRootConfigs, AXPSearchAction, AXPSearchDefinition, AXPSearchDefinitionDisplayFormat, AXPSearchDefinitionProvider, AXPSearchDisplayGroupResult, AXPSearchDisplayResult, AXPSearchDisplayResultForSave, AXPSearchParentResult, AXPSearchProvider, AXPSearchResult, AXPSettingChangedEvent, AXPSettingDefaultValuesProvider, AXPSettingDefinition, AXPSettingDefinitionGroup, AXPSettingDefinitionProvider, AXPSettingDefinitionSection, AXPSettingServiceInterface, AXPSettingValue, AXPSettingValueProvider, AXPTimeZone, AXPUnLockRequest };
+export { ALL_DEFAULT_OPERATORS, AXMWorkflowErrorHandler, AXPAppVersionService, AXPCleanNestedFilters, AXPClipBoardService, AXPCommonModule, AXPCustomOperatorService, AXPCustomOperatorServiceImpl, AXPDataProvider, AXPDialogConfirmAction, AXPEntityCommandScope, AXPEntityQueryType, AXPErrorHandlerRegistryService, AXPExportService, AXPFileStorageService, AXPFileStorageStatus, AXPFileTypeProviderService, AXPFilterOperatorMiddlewareService, AXPFilterOperatorMiddlewareServiceImpl, AXPFooterTextSlotComponent, AXPGlobalErrorHandler, AXPGlobalVariableDefinitionService, AXPGlobalVariableEvaluatorScopeProvider, AXPGridLayoutDirective, AXPHomePageModule, AXPHomePageService, AXPLockService, AXPLogoComponent, AXPMenuProviderService, AXPMenuSearchDefinitionProvider, AXPMenuSearchProvider, AXPMenuService, AXPNavBarSlotComponent, AXPNavigateWorkflow, AXPPlatformDefaultConfigs, AXPRedirectEvent, AXPRefreshEvent, AXPRelationshipCardinality, AXPRelationshipKind, AXPReloadAction, AXPReloadEvent, AXPSearchCommandProvider, AXPSearchDefinitionActionBuilder, AXPSearchDefinitionBuilder, AXPSearchDefinitionProviderContext, AXPSearchDefinitionProviderService, AXPSearchService, AXPSettingDefaultValuesAggregatorService, AXPSettingDefinitionGroupBuilder, AXPSettingDefinitionProviderContext, AXPSettingDefinitionProviderService, AXPSettingDefinitionSectionBuilder, AXPSettingService, AXPStickyDirective, AXPToastAction, AXPWorkflowNavigateAction, AXPWorkflowRouterNavigateAction, AXP_APP_VERSION_PROVIDER, AXP_FILE_TYPE_INFO_PROVIDER, AXP_GLOBAL_VARIABLE_DEFINITION_PROVIDER, AXP_HOME_PAGES, AXP_HOME_PAGE_DEFAULT_KEY, AXP_MENU_PROVIDER, AXP_PLATFORM_CONFIG_TOKEN, AXP_ROOT_CONFIG_TOKEN, AXP_SEARCH_DEFINITION_PROVIDER, AXP_SEARCH_PROVIDER, AXP_SETTING_DEFAULT_VALUES_PROVIDERS, AXP_SETTING_DEFINITION_PROVIDER, AXP_SETTING_VALUE_PROVIDER, BETWEEN_OPER, BOOLEAN_OPERATORS, CONTAINS_OPER, DATE_OPERATORS, ENDS_WITH_OPER, ENVIRONMENT, EQ_OPER, GTE_OPER, GT_OPER, IN_OPER, IS_EMPTY_OPER, IS_NOT_EMPTY_OPER, LTE_OPER, LT_OPER, NOT_CONTAINS_OPER, NOT_EQ_OPER, NUMBER_OPERATORS, STARTS_WITH_OPER, STRING_OPERATORS, configPlatform, createAllQueryView, createQueryView, getEntityInfo, provideDynamicHomePage };
+export type { AXEntityPropertyWidget, AXPAggregate, AXPAppVersion, AXPAppVersionProvider, AXPApplication, AXPCategoryEntity, AXPCommandActionCallback, AXPCommandActionDisplay, AXPCommandActionLook, AXPCommandActionPriority, AXPCommandActionType, AXPCommonModuleConfigs, AXPCurrency, AXPDomToImageOptions, AXPEntity, AXPEntityAction, AXPEntityCommand, AXPEntityDetailListView, AXPEntityMasterCreateLayoutView, AXPEntityMasterLayoutView, AXPEntityMasterListView, AXPEntityMasterSingleLayoutView, AXPEntityMasterUpdateLayoutView, AXPEntityProperty, AXPEntityPropertyCreateView, AXPEntityPropertyGroup, AXPEntityPropertyLayoutConfig, AXPEntityPropertyUpdateView, AXPEntityPropertyView, AXPEntityQuery, AXPEntitySectionView, AXPEntityTableColumn, AXPEntityVersionHistory, AXPErrorHandler, AXPFileExtension, AXPFileManyStorageInfo, AXPFileStorageCreateRequest, AXPFileStorageFindRequest, AXPFileStorageInfo, AXPFileStorageUpdateRequest, AXPFileType, AXPFileTypeInfoProvider, AXPFilterOperator, AXPGeoLocation, AXPGlobalVariableDefinition, AXPGlobalVariableDefinitionProvider, AXPGlobalVariableDefinitionProviderToken, AXPGridLayoutOptions, AXPGridLayoutPositions, AXPGroupSearchResult, AXPHomePageDefinition, AXPLanguage, AXPLocaleProfile, AXPLockGetInfoRequest, AXPLockInfo, AXPLockRequest, AXPLockType, AXPMenuFinderResult, AXPMenuInsertion, AXPMenuItem, AXPMenuItemCommand, AXPMenuItemWithParent, AXPMenuProvider, AXPMenuProviderContext, AXPMenuType, AXPModule, AXPPlatformConfigs, AXPQueryFilter, AXPQuerySort, AXPQueryView, AXPRelatedEntity, AXPRelationship, AXPRootConfigs, AXPSearchAction, AXPSearchDefinition, AXPSearchDefinitionDisplayFormat, AXPSearchDefinitionProvider, AXPSearchDisplayGroupResult, AXPSearchDisplayResult, AXPSearchDisplayResultForSave, AXPSearchParentResult, AXPSearchProvider, AXPSearchResult, AXPSettingChangedEvent, AXPSettingDefaultValuesProvider, AXPSettingDefinition, AXPSettingDefinitionGroup, AXPSettingDefinitionProvider, AXPSettingDefinitionSection, AXPSettingServiceInterface, AXPSettingValue, AXPSettingValueProvider, AXPTimeZone, AXPUnLockRequest };