@abpjs/identity 3.0.0 → 3.2.0

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { RoutesService, ABP, RestService } from '@abpjs/core';
+import { RoutesService, ExtensibleEntityDto, ExtensibleFullAuditedEntityDto, ExtensibleObject, PagedAndSortedResultRequestDto, PagedResultDto, ABP, RestService, ListResultDto } from '@abpjs/core';
 import React from 'react';
 
 /**
@@ -127,27 +127,179 @@ declare const eIdentityComponents: {
  */
 type IdentityComponentKey = (typeof eIdentityComponents)[keyof typeof eIdentityComponents];
 
+/**
+ * Identity Proxy Models
+ * Translated from @abp/ng.identity v3.2.0
+ *
+ * These are the new typed DTOs for identity API operations.
+ * @since 3.2.0
+ */
+/**
+ * Input for changing password
+ * @since 3.2.0
+ */
+interface ChangePasswordInput {
+    currentPassword: string;
+    newPassword: string;
+}
+/**
+ * Profile DTO returned from API
+ * @since 3.2.0
+ */
+interface ProfileDto extends ExtensibleObject {
+    userName: string;
+    email: string;
+    name: string;
+    surname: string;
+    phoneNumber: string;
+    isExternal: boolean;
+    hasPassword: boolean;
+}
+/**
+ * Input for updating profile
+ * @since 3.2.0
+ */
+interface UpdateProfileDto extends ExtensibleObject {
+    userName: string;
+    email: string;
+    name: string;
+    surname: string;
+    phoneNumber: string;
+}
+/**
+ * Base DTO for role create/update operations
+ * @since 3.2.0
+ */
+interface IdentityRoleCreateOrUpdateDtoBase extends ExtensibleObject {
+    name: string;
+    isDefault: boolean;
+    isPublic: boolean;
+}
+/**
+ * DTO for creating a role
+ * @since 3.2.0
+ */
+type IdentityRoleCreateDto = IdentityRoleCreateOrUpdateDtoBase;
+/**
+ * DTO for updating a role
+ * @since 3.2.0
+ */
+interface IdentityRoleUpdateDto extends IdentityRoleCreateOrUpdateDtoBase {
+    concurrencyStamp: string;
+}
+/**
+ * Role DTO returned from API
+ * @since 3.2.0
+ */
+interface IdentityRoleDto extends ExtensibleEntityDto<string> {
+    name: string;
+    isDefault: boolean;
+    isStatic: boolean;
+    isPublic: boolean;
+    concurrencyStamp: string;
+}
+/**
+ * Input for getting users with pagination and filtering
+ * @since 3.2.0
+ */
+interface GetIdentityUsersInput extends PagedAndSortedResultRequestDto {
+    filter: string;
+}
+/**
+ * Base DTO for user create/update operations
+ * @since 3.2.0
+ */
+interface IdentityUserCreateOrUpdateDtoBase extends ExtensibleObject {
+    userName: string;
+    name: string;
+    surname: string;
+    email: string;
+    phoneNumber: string;
+    lockoutEnabled: boolean;
+    roleNames: string[];
+}
+/**
+ * DTO for creating a user
+ * @since 3.2.0
+ */
+interface IdentityUserCreateDto extends IdentityUserCreateOrUpdateDtoBase {
+    password: string;
+}
+/**
+ * DTO for updating a user
+ * @since 3.2.0
+ */
+interface IdentityUserUpdateDto extends IdentityUserCreateOrUpdateDtoBase {
+    password: string;
+    concurrencyStamp: string;
+}
+/**
+ * DTO for updating user roles
+ * @since 3.2.0
+ */
+interface IdentityUserUpdateRolesDto {
+    roleNames: string[];
+}
+/**
+ * User DTO returned from API
+ * @since 3.2.0
+ */
+interface IdentityUserDto extends ExtensibleFullAuditedEntityDto<string> {
+    tenantId?: string;
+    userName: string;
+    name: string;
+    surname: string;
+    email: string;
+    emailConfirmed: boolean;
+    phoneNumber: string;
+    phoneNumberConfirmed: boolean;
+    lockoutEnabled: boolean;
+    lockoutEnd?: string;
+    concurrencyStamp: string;
+}
+/**
+ * Input for counting users in lookup
+ * @since 3.2.0
+ */
+interface UserLookupCountInputDto {
+    filter: string;
+}
+/**
+ * Input for searching users in lookup
+ * @since 3.2.0
+ */
+interface UserLookupSearchInputDto extends PagedAndSortedResultRequestDto {
+    filter: string;
+}
+
 /**
  * Identity namespace containing all types related to identity management.
  * Translated from @abp/ng.identity Identity namespace.
+ *
+ * Changes in v3.2.0:
+ * - State now uses PagedResultDto and new proxy DTOs (IdentityRoleDto, IdentityUserDto)
+ * - Legacy types (RoleResponse, RoleItem, UserResponse, UserItem, etc.) deprecated
  */
 declare namespace Identity {
     /**
      * Identity state shape for state management
+     * @updated 3.2.0 - Now uses PagedResultDto and new proxy DTOs
      */
     interface State {
-        roles: RoleResponse;
-        users: UserResponse;
-        selectedRole: RoleItem;
-        selectedUser: UserItem;
-        selectedUserRoles: RoleItem[];
+        roles: PagedResultDto<IdentityRoleDto>;
+        users: PagedResultDto<IdentityUserDto>;
+        selectedRole: IdentityRoleDto;
+        selectedUser: IdentityUserDto;
+        selectedUserRoles: IdentityRoleDto[];
     }
     /**
      * Paginated response for roles
+     * @deprecated To be deleted in v4.0. Use PagedResultDto<IdentityRoleDto> instead.
      */
     type RoleResponse = ABP.PagedResponse<RoleItem>;
     /**
      * Request payload for creating/updating a role
+     * @deprecated To be deleted in v4.0. Use IdentityRoleCreateDto or IdentityRoleUpdateDto instead.
      */
     interface RoleSaveRequest {
         name: string;
@@ -156,6 +308,7 @@ declare namespace Identity {
     }
     /**
      * Role item returned from the API
+     * @deprecated To be deleted in v4.0. Use IdentityRoleDto instead.
      */
     interface RoleItem extends RoleSaveRequest {
         isStatic: boolean;
@@ -164,10 +317,12 @@ declare namespace Identity {
     }
     /**
      * Paginated response for users
+     * @deprecated To be deleted in v4.0. Use PagedResultDto<IdentityUserDto> instead.
      */
     type UserResponse = ABP.PagedResponse<UserItem>;
     /**
      * Base user properties
+     * @deprecated To be deleted in v4.0. Use IdentityUserCreateOrUpdateDtoBase instead.
      */
     interface User {
         userName: string;
@@ -180,6 +335,7 @@ declare namespace Identity {
     }
     /**
      * User item returned from the API
+     * @deprecated To be deleted in v4.0. Use IdentityUserDto instead.
      */
     interface UserItem extends User {
         tenantId: string;
@@ -191,6 +347,7 @@ declare namespace Identity {
     }
     /**
      * Request payload for creating/updating a user
+     * @deprecated To be deleted in v4.0. Use IdentityUserCreateDto or IdentityUserUpdateDto instead.
      */
     interface UserSaveRequest extends User {
         password: string;
@@ -242,6 +399,225 @@ declare namespace Identity {
     }
 }
 
+/**
+ * Identity Role proxy service for role management API calls
+ * Translated from @abp/ng.identity v3.2.0
+ *
+ * @since 3.2.0
+ */
+declare class IdentityRoleService {
+    private restService;
+    /**
+     * The API name used for REST requests.
+     */
+    apiName: string;
+    constructor(restService: RestService);
+    /**
+     * Create a new role
+     * @param input - The role data to create
+     * @returns Promise with the created role
+     */
+    create: (input: IdentityRoleCreateDto) => Promise<IdentityRoleDto>;
+    /**
+     * Delete a role by ID
+     * @param id - The role ID to delete
+     * @returns Promise that resolves when deletion is complete
+     */
+    delete: (id: string) => Promise<void>;
+    /**
+     * Get a role by ID
+     * @param id - The role ID
+     * @returns Promise with the role
+     */
+    get: (id: string) => Promise<IdentityRoleDto>;
+    /**
+     * Get all roles without pagination
+     * @returns Promise with all roles
+     */
+    getAllList: () => Promise<ListResultDto<IdentityRoleDto>>;
+    /**
+     * Get roles with pagination
+     * @param input - Pagination and sorting parameters
+     * @returns Promise with paginated roles
+     */
+    getList: (input: PagedAndSortedResultRequestDto) => Promise<PagedResultDto<IdentityRoleDto>>;
+    /**
+     * Update a role
+     * @param id - The role ID to update
+     * @param input - The updated role data
+     * @returns Promise with the updated role
+     */
+    update: (id: string, input: IdentityRoleUpdateDto) => Promise<IdentityRoleDto>;
+}
+
+/**
+ * User data models for user lookup
+ * Translated from @abp/ng.identity v3.2.0
+ * @since 3.2.0
+ */
+/**
+ * User data returned from user lookup service
+ * @since 3.2.0
+ */
+interface UserData {
+    id: string;
+    tenantId?: string;
+    userName: string;
+    name: string;
+    surname: string;
+    email: string;
+    emailConfirmed: boolean;
+    phoneNumber: string;
+    phoneNumberConfirmed: boolean;
+}
+
+/**
+ * Identity User Lookup proxy service for user lookup API calls
+ * Translated from @abp/ng.identity v3.2.0
+ *
+ * @since 3.2.0
+ */
+declare class IdentityUserLookupService {
+    private restService;
+    /**
+     * The API name used for REST requests.
+     */
+    apiName: string;
+    constructor(restService: RestService);
+    /**
+     * Find a user by ID
+     * @param id - The user ID
+     * @returns Promise with the user data
+     */
+    findById: (id: string) => Promise<UserData>;
+    /**
+     * Find a user by username
+     * @param userName - The username to search for
+     * @returns Promise with the user data
+     */
+    findByUserName: (userName: string) => Promise<UserData>;
+    /**
+     * Get count of users matching filter
+     * @param input - Filter parameters
+     * @returns Promise with the count
+     */
+    getCount: (input: UserLookupCountInputDto) => Promise<number>;
+    /**
+     * Search for users
+     * @param input - Search and pagination parameters
+     * @returns Promise with matching users
+     */
+    search: (input: UserLookupSearchInputDto) => Promise<ListResultDto<UserData>>;
+}
+
+/**
+ * Identity User proxy service for user management API calls
+ * Translated from @abp/ng.identity v3.2.0
+ *
+ * @since 3.2.0
+ */
+declare class IdentityUserService {
+    private restService;
+    /**
+     * The API name used for REST requests.
+     */
+    apiName: string;
+    constructor(restService: RestService);
+    /**
+     * Create a new user
+     * @param input - The user data to create
+     * @returns Promise with the created user
+     */
+    create: (input: IdentityUserCreateDto) => Promise<IdentityUserDto>;
+    /**
+     * Delete a user by ID
+     * @param id - The user ID to delete
+     * @returns Promise that resolves when deletion is complete
+     */
+    delete: (id: string) => Promise<void>;
+    /**
+     * Find a user by email
+     * @param email - The user's email
+     * @returns Promise with the user
+     */
+    findByEmail: (email: string) => Promise<IdentityUserDto>;
+    /**
+     * Find a user by username
+     * @param username - The user's username
+     * @returns Promise with the user
+     */
+    findByUsername: (username: string) => Promise<IdentityUserDto>;
+    /**
+     * Get a user by ID
+     * @param id - The user ID
+     * @returns Promise with the user
+     */
+    get: (id: string) => Promise<IdentityUserDto>;
+    /**
+     * Get all roles that can be assigned to users
+     * @returns Promise with assignable roles
+     */
+    getAssignableRoles: () => Promise<ListResultDto<IdentityRoleDto>>;
+    /**
+     * Get users with pagination and filtering
+     * @param input - Pagination, sorting, and filter parameters
+     * @returns Promise with paginated users
+     */
+    getList: (input: GetIdentityUsersInput) => Promise<PagedResultDto<IdentityUserDto>>;
+    /**
+     * Get roles assigned to a user
+     * @param id - The user ID
+     * @returns Promise with the user's roles
+     */
+    getRoles: (id: string) => Promise<ListResultDto<IdentityRoleDto>>;
+    /**
+     * Update a user
+     * @param id - The user ID to update
+     * @param input - The updated user data
+     * @returns Promise with the updated user
+     */
+    update: (id: string, input: IdentityUserUpdateDto) => Promise<IdentityUserDto>;
+    /**
+     * Update a user's roles
+     * @param id - The user ID
+     * @param input - The new role assignments
+     * @returns Promise that resolves when update is complete
+     */
+    updateRoles: (id: string, input: IdentityUserUpdateRolesDto) => Promise<void>;
+}
+
+/**
+ * Profile proxy service for profile management API calls
+ * Translated from @abp/ng.identity v3.2.0
+ *
+ * @since 3.2.0
+ */
+declare class ProfileService {
+    private restService;
+    /**
+     * The API name used for REST requests.
+     */
+    apiName: string;
+    constructor(restService: RestService);
+    /**
+     * Change the current user's password
+     * @param input - Current and new password
+     * @returns Promise that resolves when password is changed
+     */
+    changePassword: (input: ChangePasswordInput) => Promise<void>;
+    /**
+     * Get the current user's profile
+     * @returns Promise with the profile data
+     */
+    get: () => Promise<ProfileDto>;
+    /**
+     * Update the current user's profile
+     * @param input - Updated profile data
+     * @returns Promise with the updated profile
+     */
+    update: (input: UpdateProfileDto) => Promise<ProfileDto>;
+}
+
 /**
  * Service for managing identity-related API operations.
  * Handles roles and users CRUD operations.
@@ -790,4 +1166,4 @@ declare const IDENTITY_POLICIES: {
     readonly ROLES_DELETE: "AbpIdentity.Roles.Delete";
 };
 
-export { IDENTITY_POLICIES, IDENTITY_ROUTE_PATHS, IDENTITY_ROUTE_PROVIDERS, Identity, type IdentityComponentKey, type IdentityPolicyNameKey, type IdentityRouteNameKey, IdentityService, IdentityStateService, type PasswordRule, type RoleOperationResult, RolesComponent, type RolesComponentProps, type SortOrder, type UseIdentityReturn, type UseRolesReturn, type UseUsersReturn, type UserOperationResult, UsersComponent, type UsersComponentProps, configureRoutes, eIdentityComponents, eIdentityPolicyNames, eIdentityRouteNames, initializeIdentityRoutes, useIdentity, useRoles, useUsers };
+export { type ChangePasswordInput, type GetIdentityUsersInput, IDENTITY_POLICIES, IDENTITY_ROUTE_PATHS, IDENTITY_ROUTE_PROVIDERS, Identity, type IdentityComponentKey, type IdentityPolicyNameKey, type IdentityRoleCreateDto, type IdentityRoleCreateOrUpdateDtoBase, type IdentityRoleDto, IdentityRoleService, type IdentityRoleUpdateDto, type IdentityRouteNameKey, IdentityService, IdentityStateService, type IdentityUserCreateDto, type IdentityUserCreateOrUpdateDtoBase, type IdentityUserDto, IdentityUserLookupService, IdentityUserService, type IdentityUserUpdateDto, type IdentityUserUpdateRolesDto, type PasswordRule, type ProfileDto, ProfileService, type RoleOperationResult, RolesComponent, type RolesComponentProps, type SortOrder, type UpdateProfileDto, type UseIdentityReturn, type UseRolesReturn, type UseUsersReturn, type UserData, type UserLookupCountInputDto, type UserLookupSearchInputDto, type UserOperationResult, UsersComponent, type UsersComponentProps, configureRoutes, eIdentityComponents, eIdentityPolicyNames, eIdentityRouteNames, initializeIdentityRoutes, useIdentity, useRoles, useUsers };