@acorex/platform 20.6.0-next.9 → 21.0.0-next.1

package/auth/index.d.ts

@@ -1,15 +1,20 @@
 import * as i0 from '@angular/core';
 import { InjectionToken, TemplateRef, ViewContainerRef, ModuleWithProviders, Injector } from '@angular/core';
-import { Observable } from 'rxjs';
-import { AXPLogoConfig, AXPExpressionEvaluatorScopeProvider, AXPExpressionEvaluatorScopeProviderContext } from '@acorex/platform/core';
+import { AXPLogoConfig, AXPOptionsData, AXPExpressionEvaluatorScopeProvider, AXPExpressionEvaluatorScopeProviderContext } from '@acorex/platform/core';
 import { CanActivateFn } from '@angular/router';
+import { Observable } from 'rxjs';
 
+interface AXPEdition {
+    id: string;
+    title: string;
+    description?: string;
+}
 interface AXPApplication {
     id: string;
     name: string;
     title?: string;
     version?: string;
-    editionName?: string;
+    edition?: AXPEdition;
     description?: string;
     logo?: AXPLogoConfig;
 }
@@ -52,12 +57,12 @@ declare enum AXPSessionStatus {
 }
 
 interface AXPApplicationLoader {
-    getList(context: AXPSessionContext): Observable<AXPApplication[]>;
+    getList(context: AXPSessionContext): Promise<AXPApplication[]>;
 }
 declare const AXP_APPLICATION_LOADER: InjectionToken<AXPApplicationLoader>;
 
 interface AXPTenantLoader {
-    getList(context: AXPSessionContext): Observable<AXPTenant[]>;
+    getList(context: AXPSessionContext): Promise<AXPTenant[]>;
 }
 declare const AXP_TENANT_LOADER: InjectionToken<AXPTenantLoader>;
 
@@ -89,10 +94,16 @@ type AXPPermissionDefinition = {
     title: string;
     description?: string;
     children: AXPPermissionDefinition[];
+    /**
+     * Required features for this permission to be available.
+     * Format: Array of feature names (e.g., ['PlatformManagement.menu-customization'])
+     * If any required feature is not enabled, this permission will be filtered out.
+     */
+    requiredFeatures?: string[];
 };
 
 interface AXPPermissionLoader {
-    getList(context: AXPSessionContext): Observable<AXPPermission[]>;
+    getList(context: AXPSessionContext): Promise<AXPPermission[]>;
 }
 declare const AXP_PERMISSION_LOADER: InjectionToken<AXPPermissionLoader>;
 
@@ -108,7 +119,7 @@ declare class AXPPermissionDefinitionGroupBuilder {
     private _group;
     get group(): AXPPermissionGroupDefinition;
     constructor(context: AXPPermissionDefinitionProviderContext, group: AXPPermissionGroupDefinition);
-    addPermission(name: string, title: string, description?: string): AXPPermissionDefinitionBuilder;
+    addPermission(name: string, title: string, description?: string, requiredFeatures?: string[]): AXPPermissionDefinitionBuilder;
     endGroup(): AXPPermissionDefinitionProviderContext;
     findPermission(path: string): AXPPermissionDefinition | undefined;
     findGroup(name: string): AXPPermissionDefinitionGroupBuilder | undefined;
@@ -117,7 +128,12 @@ declare class AXPPermissionDefinitionBuilder {
     private groupBuilder;
     private permission;
     constructor(groupBuilder: AXPPermissionDefinitionGroupBuilder, permission: AXPPermissionDefinition);
-    addChild(name: string, title: string, description?: string): AXPPermissionDefinitionBuilder;
+    addChild(name: string, title: string, description?: string, requiredFeatures?: string[]): AXPPermissionDefinitionBuilder;
+    /**
+     * Set required features for this permission.
+     * @param features - Array of feature names (e.g., ['PlatformManagement.menu-customization'])
+     */
+    requireFeatures(...features: string[]): AXPPermissionDefinitionBuilder;
     endPermission(): AXPPermissionDefinitionGroupBuilder;
 }
 
@@ -127,8 +143,19 @@ interface AXPPermissionDefinitionProvider {
 declare const AXP_PERMISSION_DEFINITION_PROVIDER: InjectionToken<AXPPermissionDefinitionProvider[]>;
 declare class AXPPermissionDefinitionService {
     private providers;
+    private providerRegistry;
+    private sessionService;
     private cache;
     private load;
+    /**
+     * Filter permissions based on required features.
+     * Removes permissions that have required features that are not enabled.
+     */
+    private filterByFeatures;
+    /**
+     * Recursively filter permissions and their children based on required features.
+     */
+    private filterPermissions;
     reload(): Promise<void>;
     getGroups(): Promise<AXPPermissionGroupDefinition[]>;
     getPermissions(): Promise<AXPPermissionDefinition[]>;
@@ -187,10 +214,14 @@ interface AXPFeature {
     title: string;
     description?: string;
     value?: any;
+    interface?: {
+        type: string;
+        options?: AXPOptionsData;
+    };
 }
 
 interface AXPFeatureLoader {
-    getList(context: AXPSessionContext): Observable<AXPFeature[]>;
+    getList(context: AXPSessionContext): Promise<AXPFeature[]>;
 }
 declare const AXP_FEATURE_LOADER: InjectionToken<AXPFeatureLoader>;
 
@@ -210,6 +241,29 @@ declare class AXPFeatureDirective {
 
 declare const AXPFeatureGuard: CanActivateFn;
 
+/**
+ * Interface for feature checkers that can override feature enablement results.
+ * Checkers receive the feature keys, current context, and base result,
+ * and can return a modified result based on custom logic.
+ */
+interface AXPFeatureChecker {
+    /**
+     * Checks and potentially overrides the feature enablement result.
+     * @param keys - The feature keys being checked
+     * @param context - Current session context (user, tenant, application)
+     * @param baseResult - The result from the base feature check logic
+     * @returns The final feature enablement result (true or false)
+     */
+    check(keys: string[], context: AXPSessionContext, baseResult: boolean): boolean;
+}
+
+/**
+ * Optional injection token for feature checker.
+ * If provided, the checker will be called to potentially override
+ * feature enablement results based on custom logic.
+ */
+declare const AXP_FEATURE_CHECKER: InjectionToken<AXPFeatureChecker>;
+
 declare class AXPSessionService {
     private eventService;
     private authStrategyRegistry;
@@ -218,6 +272,9 @@ declare class AXPSessionService {
     private readonly featureLoader;
     private readonly tenantLoader;
     private readonly applicationLoader;
+    private readonly moduleProviderLoader;
+    private readonly permissionChecker;
+    private readonly featureChecker;
     private status;
     readonly status$: Observable<AXPSessionStatus>;
     private isLoading;
@@ -259,7 +316,6 @@ declare class AXPSessionService {
     authorize(...keys: string[]): boolean;
     isFeatureEnabled(...keys: string[]): boolean;
     getToken(): string | undefined;
-    private checkTokenValidation;
     getContext(): AXPSessionContext;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXPSessionService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<AXPSessionService>;
@@ -270,6 +326,29 @@ declare class AXPPermissionEvaluatorScopeProvider implements AXPExpressionEvalua
     provide(context: AXPExpressionEvaluatorScopeProviderContext): Promise<void>;
 }
 
+/**
+ * Interface for permission checkers that can override authorization results.
+ * Checkers receive the permission keys, current context, and base result,
+ * and can return a modified result based on custom logic.
+ */
+interface AXPPermissionChecker {
+    /**
+     * Checks and potentially overrides the authorization result.
+     * @param keys - The permission keys being checked
+     * @param context - Current session context (user, tenant, application)
+     * @param baseResult - The result from the base authorization logic
+     * @returns The final authorization result (true or false)
+     */
+    check(keys: string[], context: AXPSessionContext, baseResult: boolean): boolean;
+}
+
+/**
+ * Optional injection token for permission checker.
+ * If provided, the checker will be called to potentially override
+ * authorization results based on custom logic.
+ */
+declare const AXP_PERMISSION_CHECKER: InjectionToken<AXPPermissionChecker>;
+
 declare const AXPAuthGuard: CanActivateFn;
 
 interface AXPAuthModuleConfigs {
@@ -355,5 +434,5 @@ declare class AXPUnauthenticatedError extends Error {
     } | undefined);
 }
 
-export { AXPAuthGuard, AXPAuthModule, AXPAuthStrategy, AXPAuthStrategyRegistryService, AXPFeatureDirective, AXPFeatureGuard, AXPPermissionDefinitionBuilder, AXPPermissionDefinitionGroupBuilder, AXPPermissionDefinitionProviderContext, AXPPermissionDefinitionService, AXPPermissionDirective, AXPPermissionEvaluatorScopeProvider, AXPPermissionGuard, AXPSessionContext, AXPSessionService, AXPSessionStatus, AXPUnauthenticatedError, AXPUnauthorizedError, AXP_APPLICATION_LOADER, AXP_FEATURE_LOADER, AXP_PERMISSION_DEFINITION_PROVIDER, AXP_PERMISSION_LOADER, AXP_TENANT_LOADER, JwtUtil, PkceUtil, TimeUtil, initializeAppState };
-export type { AXPApplication, AXPApplicationLoader, AXPAuthModuleConfigs, AXPBaseCredentials, AXPFeature, AXPFeatureLoader, AXPPermission, AXPPermissionDefinition, AXPPermissionDefinitionProvider, AXPPermissionGroupDefinition, AXPPermissionLoader, AXPSessionData, AXPSignInResult, AXPTenant, AXPTenantLoader, AXPTokenResult, AXPUser };
+export { AXPAuthGuard, AXPAuthModule, AXPAuthStrategy, AXPAuthStrategyRegistryService, AXPFeatureDirective, AXPFeatureGuard, AXPPermissionDefinitionBuilder, AXPPermissionDefinitionGroupBuilder, AXPPermissionDefinitionProviderContext, AXPPermissionDefinitionService, AXPPermissionDirective, AXPPermissionEvaluatorScopeProvider, AXPPermissionGuard, AXPSessionContext, AXPSessionService, AXPSessionStatus, AXPUnauthenticatedError, AXPUnauthorizedError, AXP_APPLICATION_LOADER, AXP_FEATURE_CHECKER, AXP_FEATURE_LOADER, AXP_PERMISSION_CHECKER, AXP_PERMISSION_DEFINITION_PROVIDER, AXP_PERMISSION_LOADER, AXP_TENANT_LOADER, JwtUtil, PkceUtil, TimeUtil, initializeAppState };
+export type { AXPApplication, AXPApplicationLoader, AXPAuthModuleConfigs, AXPBaseCredentials, AXPEdition, AXPFeature, AXPFeatureChecker, AXPFeatureLoader, AXPPermission, AXPPermissionChecker, AXPPermissionDefinition, AXPPermissionDefinitionProvider, AXPPermissionGroupDefinition, AXPPermissionLoader, AXPSessionData, AXPSignInResult, AXPTenant, AXPTenantLoader, AXPTokenResult, AXPUser };