@acorex-platform/module-security-management-client 0.0.15

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

@@ -0,0 +1,271 @@
+import * as _angular_core from '@angular/core';
+import * as i1 from '@acorex-platform/framework-client/layout/widget-core';
+import { AXPValueWidgetComponent, AXPColumnWidgetComponent } from '@acorex-platform/framework-client/layout/widget-core';
+import { AXBasePageComponent } from '@acorex/components/page';
+import { AXPPermissionGroupDefinition, AXPPermissionDefinition } from '@acorex-platform/framework-client/auth';
+import { AXValueChangedEvent } from '@acorex/cdk/common';
+import { AXPCommand } from '@acorex-platform/framework-shared/runtime';
+import { AXPExecuteCommandResult } from '@acorex-platform/framework-shared/core';
+import { AXPWidgetConfig } from '@acorex-platform/framework-shared/widget-core';
+
+/**
+ * Terminates device sessions for the current or specified session.
+ * Implementations are provided by connectivity layers (e.g. mock or API).
+ */
+declare abstract class AXMDeviceSessionsService {
+    abstract terminate(id: string): Promise<boolean>;
+    abstract terminateAllCurrentUserSessions(): Promise<boolean>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMDeviceSessionsService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<AXMDeviceSessionsService>;
+}
+
+declare class AXMPermissionsModule {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMPermissionsModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<AXMPermissionsModule, never, [typeof i1.AXPWidgetCoreModule], never>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<AXMPermissionsModule>;
+}
+
+declare class AXMSecurityManagementModule {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMSecurityManagementModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<AXMSecurityManagementModule, never, [typeof AXMPermissionsModule], never>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<AXMSecurityManagementModule>;
+}
+
+interface MappedPermission extends Omit<AXPPermissionDefinition, 'children'> {
+    isSelected: boolean;
+    children: MappedPermission[] | null;
+}
+interface PermissionSearchGroupResult {
+    group: AXPPermissionGroupDefinition & {
+        badge: string;
+    };
+    items: MappedPermission[];
+}
+declare class AXPPermissionsEditorComponent extends AXBasePageComponent {
+    /** Service for fetching permission groups and definitions */
+    private permissionService;
+    /** Session service for checking module access */
+    private sessionService;
+    /** Translation service for resolving permission labels during search */
+    private translationService;
+    /** Currently selected permission group */
+    protected selectedGroup: _angular_core.WritableSignal<AXPPermissionGroupDefinition | null>;
+    /** Current search query */
+    protected searchQuery: _angular_core.WritableSignal<string>;
+    /** All available permission groups */
+    protected groups: _angular_core.WritableSignal<AXPPermissionGroupDefinition[]>;
+    /** Initial permissions to be selected - exposed as signal input */
+    initialPermissions: _angular_core.InputSignal<string[]>;
+    /** Whether the editor is in read-only mode */
+    readOnly: _angular_core.InputSignal<boolean>;
+    /** Whether popup footer actions (Cancel / Select) are shown */
+    showActions: _angular_core.InputSignal<boolean>;
+    /** List of selected permission names */
+    protected selectedPermissions: _angular_core.WritableSignal<string[]>;
+    /** Event emitted when permissions selection changes */
+    permissionsChanged: _angular_core.OutputEmitterRef<string[]>;
+    /** Event emitted when permissions are applied/selected */
+    permissionsSelected: _angular_core.OutputEmitterRef<string[]>;
+    /** Whether permission groups are being loaded */
+    protected isEditorLoading: _angular_core.WritableSignal<boolean>;
+    constructor();
+    /**
+     * Reads a signal input or a plain value assigned by AXPopupService data binding.
+     */
+    private readBoundValue;
+    /** Whether popup footer actions are visible (supports popup data and input binding). */
+    protected isShowActions(): boolean;
+    /** Whether the editor is read-only (supports popup data and input binding). */
+    protected isReadOnlyMode(): boolean;
+    /** Initial permission selection (supports popup data and input binding). */
+    protected getInitialPermissions(): string[];
+    /**
+     * Recursively maps permissions to include selection state and children.
+     */
+    private mapPermissions;
+    /**
+     * Computed: Returns mapped permissions for the selected group.
+     */
+    protected items: _angular_core.Signal<MappedPermission[]>;
+    /**
+     * Computed: Returns groups with badge counts, sorted by title.
+     */
+    protected groupsWithBadge: _angular_core.Signal<{
+        badge: string;
+        name: string;
+        title: string;
+        description?: string;
+        permissions: AXPPermissionDefinition[];
+    }[]>;
+    /** Sidebar group placeholders for the loading skeleton */
+    protected readonly groupSkeletonPlaceholders: _angular_core.Signal<string[]>;
+    /** Permission group placeholders (parent + child rows) for the loading skeleton */
+    protected readonly permissionGroupSkeletonPlaceholders: _angular_core.Signal<{
+        childCount: number;
+    }[]>;
+    /** Child row placeholders for a permission group skeleton */
+    protected readonly childSkeletonPlaceholders: (count: number) => number[];
+    /** Whether the user is actively searching permissions */
+    protected isSearchActive: _angular_core.Signal<boolean>;
+    /** Grouped search results across all permission groups */
+    protected searchResultsGrouped: _angular_core.Signal<PermissionSearchGroupResult[]>;
+    /** Whether the active search returned any permission groups */
+    protected hasSearchResults: _angular_core.Signal<boolean>;
+    /**
+     * Extracts module name from a permission group name.
+     * Handles multiple formats:
+     * - Permission key format: 'SecurityManagement:Permission:SecurityManagement.Management' -> 'SecurityManagement'
+     * - PascalCase: 'TenantManagement' -> 'TenantManagement'
+     * - kebab-case: 'tenant-management' -> 'TenantManagement' (converts to PascalCase)
+     */
+    private extractModuleNameFromGroupName;
+    /**
+     * Filters permission groups to only include those from enabled modules.
+     */
+    private filterGroupsByEnabledModules;
+    /**
+     * Recursively collects all permission names (parents and children) from an array.
+     */
+    private collectAllPermissionNames;
+    /**
+     * Returns the badge count for a group (all selected permissions, including parents).
+     */
+    private getBadge;
+    /**
+     * Checks if a permission is selected.
+     */
+    private isSelected;
+    /**
+     * Checks if a permission is selected.
+     */
+    protected badgeToNumber(value: unknown): number;
+    /**
+     * Returns true when searchable text contains the query.
+     */
+    private matchesSearchText;
+    /**
+     * Returns true when a permission title or description matches the query.
+     */
+    private matchesPermission;
+    /**
+     * Returns true when a permission group title or description matches the query.
+     */
+    private matchesGroup;
+    /**
+     * Filters permissions while keeping ancestor nodes for matching descendants.
+     */
+    private filterPermissions;
+    /**
+     * Returns filtered permissions for a group, or all permissions when the group itself matches.
+     */
+    private getFilteredGroupPermissions;
+    /**
+     * Recursively collects all descendant permission names for a single item (including itself).
+     */
+    private collectPermissionNames;
+    /**
+     * Gets the current selected permissions.
+     */
+    getSelectedPermissions(): string[];
+    /**
+     * Sets the selected permissions.
+     */
+    setSelectedPermissions(permissions: string[]): void;
+    /**
+     * Applies/selects the current permissions.
+     */
+    selectPermissions(): void;
+    /**
+     * Initializes the component and loads permission groups.
+     * Filters groups to only show permissions from modules enabled for the current tenant.
+     */
+    ngOnInit(): Promise<void>;
+    /**
+     * Handles group tab/menu item click.
+     */
+    protected handleMenuItemClick(item: AXPPermissionGroupDefinition): void;
+    /**
+     * Updates the search query when the search box value changes.
+     */
+    protected handleSearchChanged(event: AXValueChangedEvent<string | null>): void;
+    /**
+     * Handles permission checkbox toggle (checks/unchecks all children recursively).
+     */
+    protected onPermissionToggle(item: MappedPermission, e: AXValueChangedEvent): void;
+    /**
+     * Closes the popup without applying permission changes.
+     */
+    protected handleCancelClick(): void;
+    /**
+     * Applies the current selection and closes the popup.
+     */
+    protected handleSelectClick(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXPPermissionsEditorComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXPPermissionsEditorComponent, "axm-permissions-editor", never, { "initialPermissions": { "alias": "initialPermissions"; "required": false; "isSignal": true; }; "readOnly": { "alias": "readOnly"; "required": false; "isSignal": true; }; "showActions": { "alias": "showActions"; "required": false; "isSignal": true; }; }, { "permissionsChanged": "permissionsChanged"; "permissionsSelected": "permissionsSelected"; }, never, never, true, never>;
+}
+
+interface AXMAssignPermissionsCommandInput {
+    __context__?: {
+        data?: Record<string, unknown>;
+        entity?: string;
+        entityInfo?: {
+            name?: string;
+            module?: string;
+            title?: string;
+            parentKey?: string;
+            source?: string;
+        };
+        options?: unknown;
+    };
+}
+declare class AXMAssignPermissionsCommand implements AXPCommand<AXMAssignPermissionsCommandInput, string[] | null> {
+    private readonly popupService;
+    private readonly translationService;
+    private readonly entityRegistry;
+    private readonly toastService;
+    private readonly settingsService;
+    private readonly workflowEventService;
+    execute(input: AXMAssignPermissionsCommandInput): Promise<AXPExecuteCommandResult<string[] | null>>;
+    private resolveRoleTitle;
+    private showSuccessToast;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMAssignPermissionsCommand, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<AXMAssignPermissionsCommand>;
+}
+
+interface PermissionPath {
+    group: AXPPermissionGroupDefinition;
+    path: AXPPermissionDefinition[];
+    displayPath: string;
+}
+declare class AXPPermissionsWidgetViewComponent extends AXPValueWidgetComponent<string[]> {
+    private permissionService;
+    private readonly commandService;
+    protected groups: _angular_core.WritableSignal<AXPPermissionGroupDefinition[]>;
+    private loadGroupsEffect;
+    protected selectedPermissionsByGroup: _angular_core.Signal<Record<string, PermissionPath[]>>;
+    protected isEmpty: _angular_core.Signal<boolean>;
+    protected openPermissionsEditor(): Promise<void>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXPPermissionsWidgetViewComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXPPermissionsWidgetViewComponent, "axm-permissions-widget-view", never, {}, {}, never, never, true, never>;
+}
+
+declare class AXPPermissionsWidgetEditComponent extends AXPValueWidgetComponent<string[]> {
+    /**
+     * Handles permissions changes from the editor.
+     */
+    protected onPermissionsChanged(permissions: string[]): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXPPermissionsWidgetEditComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXPPermissionsWidgetEditComponent, "axm-permissions-widget-edit", never, {}, {}, never, never, true, never>;
+}
+
+declare class AXPPermissionsWidgetColumnComponent extends AXPColumnWidgetComponent<any> {
+    protected count: _angular_core.Signal<number>;
+    private readonly commandService;
+    openPermissionsEditor(): Promise<void>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXPPermissionsWidgetColumnComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXPPermissionsWidgetColumnComponent, "axm-permissions-widget-column", never, { "rawValue": { "alias": "rawValue"; "required": false; }; "rowData": { "alias": "rowData"; "required": false; }; }, {}, never, never, true, never>;
+}
+
+declare const AXPPermissionsWidget: AXPWidgetConfig;
+
+export { AXMAssignPermissionsCommand, AXMDeviceSessionsService, AXMPermissionsModule, AXMSecurityManagementModule, AXPPermissionsEditorComponent, AXPPermissionsWidget, AXPPermissionsWidgetColumnComponent, AXPPermissionsWidgetEditComponent, AXPPermissionsWidgetViewComponent };