@abpjs/identity-pro 2.7.0 → 2.9.0

package/dist/index.d.mts

@@ -1,6 +1,50 @@
-import { ABP, RestService } from '@abpjs/core';
+import { PagedResultDto, ABP, PagedAndSortedResultRequestDto, RestService } from '@abpjs/core';
 import React from 'react';
 
+/**
+ * Organization Unit With Details DTO
+ * Translated from @volo/abp.ng.identity v2.9.0
+ * @since 2.9.0
+ */
+/**
+ * Represents an organization unit with full details.
+ * Used for displaying and managing organization units in the hierarchy.
+ */
+interface OrganizationUnitWithDetailsDto {
+    /** Parent organization unit ID (null for root units) */
+    parentId?: string;
+    /** Hierarchical code of the organization unit (e.g., "00001.00002") */
+    code: string;
+    /** Display name of the organization unit */
+    displayName: string;
+    /** Roles assigned to this organization unit */
+    roles: unknown[];
+    /** Whether this unit has been soft-deleted */
+    isDeleted: boolean;
+    /** ID of the user who deleted this unit */
+    deleterId?: string;
+    /** Date and time when the unit was deleted */
+    deletionTime?: string;
+    /** Date and time of last modification */
+    lastModificationTime?: string;
+    /** ID of the user who last modified this unit */
+    lastModifierId?: string;
+    /** Date and time when the unit was created */
+    creationTime: string;
+    /** ID of the user who created this unit */
+    creatorId?: string;
+    /** Unique identifier of the organization unit */
+    id: string;
+    /** Extra properties for extensibility */
+    extraProperties: unknown[];
+}
+/**
+ * Factory function to create an OrganizationUnitWithDetailsDto with defaults.
+ * @param initialValues - Partial values to initialize the DTO
+ * @returns A new OrganizationUnitWithDetailsDto instance
+ */
+declare function createOrganizationUnitWithDetailsDto(initialValues?: Partial<OrganizationUnitWithDetailsDto>): OrganizationUnitWithDetailsDto;
+
 /**
  * Identity namespace containing all types related to identity management.
  * Translated from @volo/abp.ng.identity Identity namespace.
@@ -8,8 +52,10 @@ import React from 'react';
  * Pro features include:
  * - Claim type management
  * - User/Role claims management
+ * - Organization unit management (v2.9.0)
  *
  * @since 0.7.2
+ * @updated 2.9.0 - Added organization units support
  */
 declare namespace Identity {
     /**
@@ -27,6 +73,8 @@ declare namespace Identity {
         claims: ClaimResponse;
         /** Pro: Selected claim type for editing */
         selectedClaim: ClaimType;
+        /** Pro: Organization units (v2.9.0) */
+        organizationUnits: PagedResultDto<OrganizationUnitWithDetailsDto>;
     }
     /**
      * Paginated response for roles
@@ -77,10 +125,13 @@ declare namespace Identity {
     }
     /**
      * Request payload for creating/updating a user
+     * @updated 2.9.0 - Added organizationUnitIds
      */
     interface UserSaveRequest extends User {
         password: string;
         roleNames: string[];
+        /** Organization unit IDs the user belongs to (v2.9.0) */
+        organizationUnitIds: string[];
     }
     /**
      * Request payload for changing a user's password (admin action)
@@ -152,20 +203,169 @@ declare namespace Identity {
     }
 }
 
+/**
+ * Get Organization Unit Input
+ * Translated from @volo/abp.ng.identity v2.9.0
+ * @since 2.9.0
+ */
+
+/**
+ * Input parameters for querying organization units.
+ * Extends PagedAndSortedResultRequestDto for pagination and sorting support.
+ */
+interface GetOrganizationUnitInput extends PagedAndSortedResultRequestDto {
+    /** Filter string for searching organization units */
+    filter?: string;
+}
+/**
+ * Factory function to create a GetOrganizationUnitInput with defaults.
+ * @param initialValues - Partial values to initialize the input
+ * @returns A new GetOrganizationUnitInput instance
+ */
+declare function createGetOrganizationUnitInput(initialValues?: Partial<GetOrganizationUnitInput>): GetOrganizationUnitInput;
+
+/**
+ * Organization Unit Create/Update Base DTO
+ * Translated from @volo/abp.ng.identity v2.9.0
+ * @since 2.9.0
+ */
+/**
+ * Base interface for creating or updating organization units.
+ * Contains common properties shared between create and update operations.
+ */
+interface OrganizationUnitCreateOrUpdateDtoBase {
+    /** Display name of the organization unit */
+    displayName: string;
+}
+/**
+ * Factory function to create an OrganizationUnitCreateOrUpdateDtoBase with defaults.
+ * @param initialValues - Partial values to initialize the DTO
+ * @returns A new OrganizationUnitCreateOrUpdateDtoBase instance
+ */
+declare function createOrganizationUnitCreateOrUpdateDtoBase(initialValues?: Partial<OrganizationUnitCreateOrUpdateDtoBase>): OrganizationUnitCreateOrUpdateDtoBase;
+
+/**
+ * Organization Unit Create DTO
+ * Translated from @volo/abp.ng.identity v2.9.0
+ * @since 2.9.0
+ */
+
+/**
+ * DTO for creating a new organization unit.
+ * Extends the base DTO with parent ID for hierarchy placement.
+ */
+interface OrganizationUnitCreateDto extends OrganizationUnitCreateOrUpdateDtoBase {
+    /** Parent organization unit ID (optional, null for root units) */
+    parentId?: string;
+    /** Extra properties for extensibility */
+    extraProperties?: unknown[];
+}
+/**
+ * Factory function to create an OrganizationUnitCreateDto with defaults.
+ * @param initialValues - Partial values to initialize the DTO
+ * @returns A new OrganizationUnitCreateDto instance
+ */
+declare function createOrganizationUnitCreateDto(initialValues?: Partial<OrganizationUnitCreateDto>): OrganizationUnitCreateDto;
+
+/**
+ * Organization Unit Move Input
+ * Translated from @volo/abp.ng.identity v2.9.0
+ * @since 2.9.0
+ */
+/**
+ * Input for moving an organization unit to a new parent.
+ * Used when reorganizing the hierarchy tree.
+ */
+interface OrganizationUnitMoveInput {
+    /** New parent organization unit ID (null to move to root level) */
+    newParentId?: string;
+}
+/**
+ * Factory function to create an OrganizationUnitMoveInput with defaults.
+ * @param initialValues - Partial values to initialize the input
+ * @returns A new OrganizationUnitMoveInput instance
+ */
+declare function createOrganizationUnitMoveInput(initialValues?: Partial<OrganizationUnitMoveInput>): OrganizationUnitMoveInput;
+
+/**
+ * Organization Unit Role Input
+ * Translated from @volo/abp.ng.identity v2.9.0
+ * @since 2.9.0
+ */
+/**
+ * Input for adding roles to an organization unit.
+ * Used when assigning roles to organization units.
+ */
+interface OrganizationUnitRoleInput {
+    /** Array of role IDs to add to the organization unit */
+    roleIds: string[];
+}
+/**
+ * Factory function to create an OrganizationUnitRoleInput with defaults.
+ * @param initialValues - Partial values to initialize the input
+ * @returns A new OrganizationUnitRoleInput instance
+ */
+declare function createOrganizationUnitRoleInput(initialValues?: Partial<OrganizationUnitRoleInput>): OrganizationUnitRoleInput;
+
+/**
+ * Organization Unit Update DTO
+ * Translated from @volo/abp.ng.identity v2.9.0
+ * @since 2.9.0
+ */
+
+/**
+ * DTO for updating an existing organization unit.
+ * Extends the base DTO with optional extra properties.
+ */
+interface OrganizationUnitUpdateDto extends OrganizationUnitCreateOrUpdateDtoBase {
+    /** Extra properties for extensibility */
+    extraProperties?: unknown[];
+}
+/**
+ * Factory function to create an OrganizationUnitUpdateDto with defaults.
+ * @param initialValues - Partial values to initialize the DTO
+ * @returns A new OrganizationUnitUpdateDto instance
+ */
+declare function createOrganizationUnitUpdateDto(initialValues?: Partial<OrganizationUnitUpdateDto>): OrganizationUnitUpdateDto;
+
+/**
+ * Organization Unit User Input
+ * Translated from @volo/abp.ng.identity v2.9.0
+ * @since 2.9.0
+ */
+/**
+ * Input for adding users (members) to an organization unit.
+ * Used when assigning members to organization units.
+ */
+interface OrganizationUnitUserInput {
+    /** Array of user IDs to add to the organization unit */
+    userIds: string[];
+}
+/**
+ * Factory function to create an OrganizationUnitUserInput with defaults.
+ * @param initialValues - Partial values to initialize the input
+ * @returns A new OrganizationUnitUserInput instance
+ */
+declare function createOrganizationUnitUserInput(initialValues?: Partial<OrganizationUnitUserInput>): OrganizationUnitUserInput;
+
 /**
  * Identity Pro Component Identifiers
- * Translated from @volo/abp.ng.identity v2.7.0
+ * Translated from @volo/abp.ng.identity v2.9.0
  */
 /**
  * Enum-like const object for identity component identifiers.
  * Used for component registration and identification.
  * @since 2.4.0
  * @updated 2.7.0 - Changed from enum to const object
+ * @updated 2.9.0 - Added OrganizationUnits, OrganizationMembers, OrganizationRoles
  */
 declare const eIdentityComponents: {
     readonly Claims: "Identity.ClaimsComponent";
     readonly Roles: "Identity.RolesComponent";
     readonly Users: "Identity.UsersComponent";
+    readonly OrganizationUnits: "Identity.OrganizationUnitsComponent";
+    readonly OrganizationMembers: "Identity.OrganizationMembersComponent";
+    readonly OrganizationRoles: "Identity.OrganizationRolesComponent";
 };
 /**
  * Type for identity component key values
@@ -174,12 +374,13 @@ type IdentityComponentKey = (typeof eIdentityComponents)[keyof typeof eIdentityC
 
 /**
  * Identity Pro Route Names
- * Translated from @volo/abp.ng.identity v2.7.0
+ * Translated from @volo/abp.ng.identity v2.9.0
  */
 /**
  * Enum-like const object for identity route names.
  * Used for localization and navigation configuration.
  * @since 2.7.0
+ * @updated 2.9.0 - Added OrganizationUnits
  */
 declare const eIdentityRouteNames: {
     readonly Administration: "AbpUiNavigation::Menu:Administration";
@@ -187,6 +388,7 @@ declare const eIdentityRouteNames: {
     readonly Roles: "AbpIdentity::Roles";
     readonly Users: "AbpIdentity::Users";
     readonly ClaimTypes: "AbpIdentity::ClaimTypes";
+    readonly OrganizationUnits: "AbpIdentity::OrganizationUnits";
 };
 /**
  * Type for identity route name values
@@ -267,6 +469,13 @@ declare class IdentityService {
      * @returns Promise with the user's roles
      */
     getUserRoles(id: string): Promise<Identity.RoleResponse>;
+    /**
+     * Get organization units assigned to a user
+     * @since 2.9.0
+     * @param id - The user ID
+     * @returns Promise with the user's organization units
+     */
+    getUserOrganizationUnits(id: string): Promise<OrganizationUnitWithDetailsDto[]>;
     /**
      * Change a user's password (admin action)
      * @since 2.7.0
@@ -543,6 +752,102 @@ declare class IdentityStateService {
     dispatchGetUserRoles(id: string): Promise<Identity.RoleItem[]>;
 }
 
+/**
+ * Service for managing organization unit operations.
+ * Handles CRUD operations for organization units hierarchy.
+ *
+ * Translated from @volo/abp.ng.identity OrganizationUnitService
+ * @since 2.9.0
+ */
+declare class OrganizationUnitService {
+    /**
+     * The API name used for REST requests.
+     */
+    apiName: string;
+    private rest;
+    constructor(rest: RestService);
+    /**
+     * Add roles to an organization unit
+     * @param body - The role IDs to add
+     * @param id - The organization unit ID
+     * @returns Promise resolving when complete
+     */
+    addRolesByIdAndInput(body: OrganizationUnitRoleInput, id: string): Promise<void>;
+    /**
+     * Add members (users) to an organization unit
+     * @param body - The user IDs to add
+     * @param id - The organization unit ID
+     * @returns Promise resolving when complete
+     */
+    addMembersByIdAndInput(body: OrganizationUnitUserInput, id: string): Promise<void>;
+    /**
+     * Create a new organization unit
+     * @param body - The organization unit data
+     * @returns Promise with the created organization unit
+     */
+    createByInput(body: OrganizationUnitCreateDto): Promise<OrganizationUnitWithDetailsDto>;
+    /**
+     * Delete an organization unit
+     * @param id - The organization unit ID to delete
+     * @returns Promise resolving when complete
+     */
+    deleteById(id: string): Promise<void>;
+    /**
+     * Get an organization unit by ID
+     * @param id - The organization unit ID
+     * @returns Promise with the organization unit
+     */
+    getById(id: string): Promise<OrganizationUnitWithDetailsDto>;
+    /**
+     * Get organization units with optional filtering and pagination
+     * @param params - Query parameters for filtering and pagination
+     * @returns Promise with paginated organization units
+     */
+    getListByInput(params?: GetOrganizationUnitInput): Promise<PagedResultDto<OrganizationUnitWithDetailsDto>>;
+    /**
+     * Get roles assigned to an organization unit
+     * @param params - Query parameters for pagination
+     * @param id - The organization unit ID
+     * @returns Promise with paginated roles
+     */
+    getRolesById(params: ABP.PageQueryParams, id: string): Promise<PagedResultDto<Identity.RoleItem>>;
+    /**
+     * Get members (users) of an organization unit
+     * @param params - Query parameters for pagination
+     * @param id - The organization unit ID
+     * @returns Promise with paginated users
+     */
+    getMembersById(params: ABP.PageQueryParams, id: string): Promise<PagedResultDto<Identity.UserItem>>;
+    /**
+     * Move an organization unit to a new parent
+     * @param body - The move input with new parent ID
+     * @param id - The organization unit ID to move
+     * @returns Promise resolving when complete
+     */
+    moveByIdAndInput(body: OrganizationUnitMoveInput, id: string): Promise<void>;
+    /**
+     * Update an organization unit
+     * @param body - The updated organization unit data
+     * @param id - The organization unit ID to update
+     * @returns Promise with the updated organization unit
+     */
+    updateByIdAndInput(body: OrganizationUnitUpdateDto, id: string): Promise<OrganizationUnitWithDetailsDto>;
+    /**
+     * Remove a member (user) from an organization unit
+     * @param id - The organization unit ID
+     * @param memberId - The user ID to remove
+     * @returns Promise resolving when complete
+     */
+    removeMemberByIdAndMemberId(id: string, memberId: string): Promise<void>;
+    /**
+     * Remove a role from an organization unit
+     * @param id - The organization unit ID
+     * @param roleId - The role ID to remove
+     * @returns Promise resolving when complete
+     */
+    removeRoleByIdAndRoleId(id: string, roleId: string): Promise<void>;
+}
+
 /**
  * Result from role operations
  */
@@ -1073,4 +1378,164 @@ declare const IDENTITY_POLICIES: {
     readonly ROLES_DELETE: "AbpIdentity.Roles.Delete";
 };
 
-export { ClaimModal, type ClaimModalProps, type ClaimOperationResult, ClaimsComponent, type ClaimsComponentProps, IDENTITY_POLICIES, IDENTITY_ROUTES, IDENTITY_ROUTE_PATHS, Identity, type IdentityComponentKey, type IdentityRouteNameKey, IdentityService, IdentityStateService, type RoleOperationResult, RolesComponent, type RolesComponentProps, type SortOrder, type UseClaimsReturn, type UseIdentityReturn, type UseRolesReturn, type UseUsersReturn, type UserOperationResult, UsersComponent, type UsersComponentProps, eIdentityComponents, eIdentityRouteNames, useClaims, useIdentity, useRoles, useUsers };
+/**
+ * Tree Adapter Utility
+ * Translated from @volo/abp.ng.identity v2.9.0
+ * @since 2.9.0
+ *
+ * Provides utility classes for converting flat lists to tree structures.
+ * Used primarily for organization unit hierarchy management.
+ */
+/**
+ * Base node interface for tree structures.
+ * Entities must implement this interface to be used with TreeAdapter.
+ */
+interface BaseNode {
+    /** Unique identifier */
+    id: string;
+    /** Parent node ID (null for root nodes) */
+    parentId: string | null;
+    /** Optional name property */
+    name?: string;
+    /** Optional display name property */
+    displayName?: string;
+}
+/**
+ * Tree node wrapping an entity for tree display.
+ * Compatible with various tree UI libraries.
+ */
+interface TreeNode<T extends BaseNode> {
+    /** The wrapped entity */
+    entity: T;
+    /** Display title (resolved from name or displayName) */
+    title: string;
+    /** Unique key (same as entity id) */
+    key: string;
+    /** Optional icon */
+    icon: string | null;
+    /** Child nodes */
+    children: TreeNode<T>[];
+    /** Whether this is a leaf node (no children) */
+    isLeaf: boolean;
+    /** Whether this node is checked */
+    checked: boolean;
+    /** Whether this node is selected */
+    selected: boolean;
+    /** Whether this node is expanded */
+    expanded: boolean;
+    /** Whether this node can be selected */
+    selectable: boolean;
+    /** Whether this node is disabled */
+    disabled: boolean;
+    /** Whether the checkbox is disabled */
+    disableCheckbox: boolean;
+    /** Reference to parent node */
+    parentNode: TreeNode<T> | null;
+    /** Parent ID from entity */
+    parentId: string | null;
+    /** ID from entity */
+    id: string;
+}
+/**
+ * Creates a TreeNode from an entity.
+ * @param entity - The entity to wrap
+ * @param nameResolver - Optional function to resolve display name
+ * @returns A new TreeNode instance
+ */
+declare function createTreeNode<T extends BaseNode>(entity: T, nameResolver?: (ent: T) => string): TreeNode<T>;
+/**
+ * TreeAdapter class for managing hierarchical data.
+ * Converts flat lists into tree structures for UI rendering.
+ *
+ * @example
+ * ```tsx
+ * const units = await organizationUnitService.getListByInput();
+ * const adapter = new TreeAdapter(units.items);
+ * const treeNodes = adapter.getTree();
+ * ```
+ */
+declare class TreeAdapter<T extends BaseNode = BaseNode> {
+    private nameResolver?;
+    private list;
+    private tree;
+    private nodeMap;
+    /**
+     * Creates a new TreeAdapter instance.
+     * @param list - Optional initial list of entities
+     * @param nameResolver - Optional function to resolve display names
+     */
+    constructor(list?: T[], nameResolver?: ((ent: T) => string) | undefined);
+    /**
+     * Sets the list and rebuilds the tree.
+     * @param list - The new list of entities
+     */
+    setList(list: T[]): void;
+    /**
+     * Gets the original flat list.
+     * @returns The flat list of entities
+     */
+    getList(): T[];
+    /**
+     * Gets the tree structure.
+     * @returns Array of root TreeNodes
+     */
+    getTree(): TreeNode<T>[];
+    /**
+     * Gets a node by its ID.
+     * @param id - The node ID
+     * @returns The TreeNode or undefined
+     */
+    getNodeById(id: string): TreeNode<T> | undefined;
+    /**
+     * Handles a drop operation (moving a node).
+     * Updates the internal structure after drag-and-drop.
+     * @param node - The node that was dropped
+     */
+    handleDrop(node: TreeNode<T>): void;
+    /**
+     * Handles removing a node from the tree.
+     * @param node - The node to remove
+     */
+    handleRemove(node: TreeNode<T>): void;
+    /**
+     * Builds the tree structure from the flat list.
+     */
+    private buildTree;
+    /**
+     * Recursively sorts children by title.
+     * @param nodes - Array of nodes to sort
+     */
+    private sortChildren;
+    /**
+     * Expands all nodes in the tree.
+     */
+    expandAll(): void;
+    /**
+     * Collapses all nodes in the tree.
+     */
+    collapseAll(): void;
+    /**
+     * Gets all expanded node keys.
+     * @returns Array of expanded node IDs
+     */
+    getExpandedKeys(): string[];
+    /**
+     * Sets expanded state for specific nodes.
+     * @param keys - Array of node IDs to expand
+     */
+    setExpandedKeys(keys: string[]): void;
+    /**
+     * Finds a node and all its ancestors.
+     * Useful for expanding path to a specific node.
+     * @param id - The target node ID
+     * @returns Array of nodes from root to target
+     */
+    getPathToNode(id: string): TreeNode<T>[];
+    /**
+     * Expands the path to a specific node.
+     * @param id - The target node ID
+     */
+    expandPathToNode(id: string): void;
+}
+
+export { type BaseNode, ClaimModal, type ClaimModalProps, type ClaimOperationResult, ClaimsComponent, type ClaimsComponentProps, type GetOrganizationUnitInput, IDENTITY_POLICIES, IDENTITY_ROUTES, IDENTITY_ROUTE_PATHS, Identity, type IdentityComponentKey, type IdentityRouteNameKey, IdentityService, IdentityStateService, type OrganizationUnitCreateDto, type OrganizationUnitCreateOrUpdateDtoBase, type OrganizationUnitMoveInput, type OrganizationUnitRoleInput, OrganizationUnitService, type OrganizationUnitUpdateDto, type OrganizationUnitUserInput, type OrganizationUnitWithDetailsDto, type RoleOperationResult, RolesComponent, type RolesComponentProps, type SortOrder, TreeAdapter, type TreeNode, type UseClaimsReturn, type UseIdentityReturn, type UseRolesReturn, type UseUsersReturn, type UserOperationResult, UsersComponent, type UsersComponentProps, createGetOrganizationUnitInput, createOrganizationUnitCreateDto, createOrganizationUnitCreateOrUpdateDtoBase, createOrganizationUnitMoveInput, createOrganizationUnitRoleInput, createOrganizationUnitUpdateDto, createOrganizationUnitUserInput, createOrganizationUnitWithDetailsDto, createTreeNode, eIdentityComponents, eIdentityRouteNames, useClaims, useIdentity, useRoles, useUsers };