@acorex/platform 20.3.0-next.22 → 20.3.0-next.24

package/common/index.d.ts

@@ -1153,20 +1153,262 @@ interface AXPMenuProvider {
 declare const AXP_MENU_PROVIDER: InjectionToken<AXPMenuProvider[]>;
 declare class AXPMenuProviderService {
     private providers;
+    private middlewareRegistry;
     private cache;
     private pendingInserts;
     private pendingRemovals;
     private pendingUpdates;
     private pendingAdditions;
+    /**
+     * Get menu items with middlewares applied (for end-user display)
+     */
     items(): Promise<AXPMenuItem[]>;
+    /**
+     * Get raw menu items WITHOUT middleware applied (for management/editing)
+     * Used by menu management pages to show original items before customization
+     */
+    rawItems(): Promise<AXPMenuItem[]>;
+    /**
+     * Clear the cache to force reload of menu items
+     */
+    clearCache(): void;
+    /**
+     * Apply middlewares in priority order using the enhanced context API
+     */
+    private applyMiddlewares;
+    /**
+     * Create provider context for menu providers
+     */
     private createMenuProviderContext;
     private applyPendingOperations;
     private findItemWithParent;
-    clearCache(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXPMenuProviderService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<AXPMenuProviderService>;
 }
 
+/**
+ * Rich context API for manipulating menu items within middleware
+ * Provides helper methods to find, update, remove, and add menu items easily
+ */
+interface AXPMenuMiddlewareContext {
+    /**
+     * Get all menu items
+     */
+    readonly items: AXPMenuItem[];
+    /**
+     * Find menu item(s) by name or pattern
+     */
+    find(nameOrPattern: string | RegExp): AXPMenuItemFinder;
+    /**
+     * Find menu item by name (exact match)
+     */
+    findByName(name: string): AXPMenuItemFinder;
+    /**
+     * Find menu items by pattern (regex or wildcard)
+     */
+    findByPattern(pattern: string | RegExp): AXPMenuItemFinder[];
+    /**
+     * Add new menu items to root level
+     */
+    add(...items: AXPMenuItem[]): AXPMenuMiddlewareContext;
+    /**
+     * Remove menu items by predicate
+     */
+    remove(predicate: (item: AXPMenuItem) => boolean): AXPMenuMiddlewareContext;
+    /**
+     * Sort all menu items recursively by priority
+     */
+    sort(): AXPMenuMiddlewareContext;
+    /**
+     * Get the final menu items array
+     */
+    toArray(): AXPMenuItem[];
+}
+/**
+ * Helper for finding and manipulating a specific menu item
+ */
+interface AXPMenuItemFinder {
+    /**
+     * Get the found menu item (or undefined)
+     */
+    get(): AXPMenuItem | undefined;
+    /**
+     * Check if menu item exists
+     */
+    exists(): boolean;
+    /**
+     * Update menu item properties
+     */
+    update(updater: Partial<AXPMenuItem> | ((item: AXPMenuItem) => Partial<AXPMenuItem>)): AXPMenuItemFinder;
+    /**
+     * Remove the menu item
+     */
+    remove(): AXPMenuItemFinder;
+    /**
+     * Hide the menu item (removes it from the menu)
+     */
+    hide(): AXPMenuItemFinder;
+    /**
+     * Show the menu item (currently a no-op as items are visible by default)
+     * Note: To truly implement show, we'd need to track removed items
+     */
+    show(): AXPMenuItemFinder;
+    /**
+     * Set priority
+     */
+    setPriority(priority: number): AXPMenuItemFinder;
+    /**
+     * Add children to this menu item
+     */
+    addChildren(...children: AXPMenuItem[]): AXPMenuItemFinder;
+    /**
+     * Remove children by predicate
+     */
+    removeChildren(predicate: (child: AXPMenuItem) => boolean): AXPMenuItemFinder;
+    /**
+     * Move menu item to a different parent
+     */
+    moveTo(parentName: string | null): AXPMenuItemFinder;
+    /**
+     * Insert menu items before this item
+     */
+    insertBefore(...items: AXPMenuItem[]): AXPMenuItemFinder;
+    /**
+     * Insert menu items after this item
+     */
+    insertAfter(...items: AXPMenuItem[]): AXPMenuItemFinder;
+}
+/**
+ * Middleware that processes menu items after all providers have executed
+ * Middlewares are executed in order based on their priority (higher priority = earlier execution)
+ */
+interface AXPMenuMiddleware {
+    /**
+     * Optional priority for execution order (higher = earlier)
+     * Default: 0
+     */
+    readonly priority?: number;
+    /**
+     * Optional name for debugging and identification
+     */
+    readonly name?: string;
+    /**
+     * Process menu items using the rich context API
+     * @param context - The menu middleware context with helper methods
+     * @returns Processed context or void (context is mutable)
+     */
+    process(context: AXPMenuMiddlewareContext): Promise<void | AXPMenuMiddlewareContext>;
+}
+/**
+ * Provider definition for registering middleware via multi-provider
+ */
+interface AXPMenuMiddlewareProvider {
+    /**
+     * The middleware instance
+     */
+    middleware: AXPMenuMiddleware;
+    /**
+     * Optional priority override
+     */
+    priority?: number;
+}
+/**
+ * Injection token for menu middlewares (multi-provider)
+ */
+declare const AXP_MENU_MIDDLEWARE: InjectionToken<AXPMenuMiddleware[]>;
+
+/**
+ * Creates a rich context for menu manipulation
+ * Similar to entity modifier context pattern
+ */
+declare function createMenuContext(items: AXPMenuItem[]): AXPMenuMiddlewareContext;
+
+/**
+ * Central service for managing menu middlewares with priority-based ordering
+ * Similar to token registry pattern used in identifier-management
+ */
+declare class AXPMenuMiddlewareRegistry {
+    /**
+     * Manually registered middlewares
+     */
+    private readonly manualMiddlewares;
+    /**
+     * Provider-based middlewares (multi-provider injection)
+     */
+    private readonly providerMiddlewares;
+    /**
+     * Manually register a middleware
+     * @param middleware - The middleware to register
+     */
+    register(middleware: AXPMenuMiddleware): void;
+    /**
+     * Unregister a middleware by name
+     * @param name - The name of the middleware to remove
+     */
+    unregister(name: string): void;
+    /**
+     * Get a specific middleware by name
+     * @param name - The middleware name
+     */
+    get(name: string): AXPMenuMiddleware | undefined;
+    /**
+     * Get all middlewares sorted by priority (highest first)
+     * Combines provider-based and manually registered middlewares
+     */
+    list(): AXPMenuMiddleware[];
+    /**
+     * Check if a middleware exists
+     * @param name - The middleware name
+     */
+    exists(name: string): boolean;
+    /**
+     * Clear all manually registered middlewares
+     * Provider-based middlewares are not affected
+     */
+    clear(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXPMenuMiddlewareRegistry, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXPMenuMiddlewareRegistry>;
+}
+
+/**
+ * Helper function to provide menu middlewares with proper DI setup
+ * Similar to provideCommandMiddleware pattern
+ *
+ * @example
+ * ```typescript
+ * // In app.config.ts or module providers
+ * export const appConfig: ApplicationConfig = {
+ *   providers: [
+ *     provideMenuMiddleware([
+ *       customizationMiddleware,
+ *       securityMiddleware,
+ *       loggingMiddleware
+ *     ])
+ *   ]
+ * };
+ * ```
+ */
+declare function provideMenuMiddleware(middlewares: AXPMenuMiddleware[]): EnvironmentProviders;
+/**
+ * Helper to create a class-based middleware with priority
+ *
+ * @example
+ * ```typescript
+ * const myMiddleware = createMenuMiddleware({
+ *   name: 'my-middleware',
+ *   priority: 100,
+ *   process: async (context) => {
+ *     context.find('dashboard').setPriority(1);
+ *   }
+ * });
+ * ```
+ */
+declare function createMenuMiddleware(config: {
+    name: string;
+    priority?: number;
+    process: (context: AXPMenuMiddlewareContext) => Promise<void>;
+}): AXPMenuMiddleware;
+
 declare const AXPMenuService: i0.Type<{
     items: i0.Signal<AXPMenuItem[]>;
     selectedMenuItem: _ngrx_signals.DeepSignal<{
@@ -1634,5 +1876,5 @@ declare class AXMWorkflowErrorHandler implements AXPErrorHandler {
     static ɵprov: i0.ɵɵInjectableDeclaration<AXMWorkflowErrorHandler>;
 }
 
-export { ALL_DEFAULT_OPERATORS, AXMWorkflowErrorHandler, AXPAppVersionService, AXPCleanNestedFilters, AXPClipBoardService, AXPCommonModule, AXPCommonSettings, AXPCustomOperatorService, AXPCustomOperatorServiceImpl, AXPDataProvider, AXPDialogConfirmAction, AXPEntityCommandScope, AXPEntityQueryType, AXPErrorHandlerRegistryService, AXPExportService, AXPFileStorageService, AXPFileStorageStatus, AXPFileTypeProviderService, AXPFilterOperatorMiddlewareService, AXPFilterOperatorMiddlewareServiceImpl, AXPFooterTextSlotComponent, AXPGlobalErrorHandler, AXPGlobalVariableDefinitionService, AXPGlobalVariableEvaluatorScopeProvider, 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, AXPVersioningService, 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, AXVChangeType, 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, 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, AXPVersionChange, AXPVersionEntry, AXPVersionStream, CanonicalChange, CanonicalChangeOp, VersionedFileInfo };
+export { ALL_DEFAULT_OPERATORS, AXMWorkflowErrorHandler, AXPAppVersionService, AXPCleanNestedFilters, AXPClipBoardService, AXPCommonModule, AXPCommonSettings, AXPCustomOperatorService, AXPCustomOperatorServiceImpl, AXPDataProvider, AXPDialogConfirmAction, AXPEntityCommandScope, AXPEntityQueryType, AXPErrorHandlerRegistryService, AXPExportService, AXPFileStorageService, AXPFileStorageStatus, AXPFileTypeProviderService, AXPFilterOperatorMiddlewareService, AXPFilterOperatorMiddlewareServiceImpl, AXPFooterTextSlotComponent, AXPGlobalErrorHandler, AXPGlobalVariableDefinitionService, AXPGlobalVariableEvaluatorScopeProvider, AXPHomePageModule, AXPHomePageService, AXPLockService, AXPLogoComponent, AXPMenuMiddlewareRegistry, 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, AXPVersioningService, 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_MIDDLEWARE, 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, AXVChangeType, 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, createMenuContext, createMenuMiddleware, createQueryView, getEntityInfo, provideDynamicHomePage, provideMenuMiddleware };
+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, AXPGroupSearchResult, AXPHomePageDefinition, AXPLanguage, AXPLocaleProfile, AXPLockGetInfoRequest, AXPLockInfo, AXPLockRequest, AXPLockType, AXPMenuFinderResult, AXPMenuInsertion, AXPMenuItem, AXPMenuItemCommand, AXPMenuItemFinder, AXPMenuItemWithParent, AXPMenuMiddleware, AXPMenuMiddlewareContext, AXPMenuMiddlewareProvider, 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, AXPVersionChange, AXPVersionEntry, AXPVersionStream, CanonicalChange, CanonicalChangeOp, VersionedFileInfo };