@abpjs/identity 0.7.6

package/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version of
+       the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,533 @@
+# @abpjs/identity
+
+> User and role management UI components for ABP Framework in React
+
+[![npm version](https://img.shields.io/npm/v/@abpjs/identity.svg)](https://www.npmjs.com/package/@abpjs/identity)
+[![License: LGPL-3.0](https://img.shields.io/badge/License-LGPL--3.0-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
+
+## Overview
+
+`@abpjs/identity` provides a complete identity management interface for ABP-based React applications. It includes comprehensive user and role management with CRUD operations, role assignment, permission management integration, and pagination support.
+
+This package is a React translation of the original `@abp/ng.identity` Angular package, bringing full identity management capabilities to React applications.
+
+## Features
+
+- **User Management** - Create, read, update, and delete users
+- **Role Management** - Create, read, update, and delete roles
+- **Role Assignment** - Assign roles to users with checkbox interface
+- **Permission Integration** - Seamlessly integrates with permission management
+- **Pagination** - Built-in pagination for user lists
+- **Search & Filter** - Filter users and roles by name
+- **Localization** - Full i18n support using ABP localization
+- **Chakra UI** - Beautiful, accessible components
+- **TypeScript** - Full type safety with comprehensive definitions
+
+## Installation
+
+```bash
+# Using npm
+npm install @abpjs/identity
+
+# Using yarn
+yarn add @abpjs/identity
+
+# Using pnpm
+pnpm add @abpjs/identity
+```
+
+### Required Dependencies
+
+This package requires the following peer dependencies:
+
+```bash
+npm install @abpjs/core @abpjs/theme-shared @abpjs/permission-management @chakra-ui/react @emotion/react @emotion/styled framer-motion
+```
+
+## Quick Start
+
+### Using Pre-built Components
+
+The easiest way to add identity management to your app:
+
+```tsx
+import { RolesComponent, UsersComponent } from '@abpjs/identity';
+import { Tabs, TabList, TabPanels, Tab, TabPanel } from '@chakra-ui/react';
+
+function IdentityManagement() {
+  return (
+    <Tabs>
+      <TabList>
+        <Tab>Users</Tab>
+        <Tab>Roles</Tab>
+      </TabList>
+
+      <TabPanels>
+        <TabPanel>
+          <UsersComponent
+            onUserCreated={(user) => console.log('User created:', user)}
+            onUserDeleted={(id) => console.log('User deleted:', id)}
+          />
+        </TabPanel>
+        <TabPanel>
+          <RolesComponent
+            onRoleCreated={(role) => console.log('Role created:', role)}
+            onRoleDeleted={(id) => console.log('Role deleted:', id)}
+          />
+        </TabPanel>
+      </TabPanels>
+    </Tabs>
+  );
+}
+```
+
+### Using Hooks for Custom UI
+
+Build your own identity UI using the provided hooks:
+
+```tsx
+import { useUsers, useRoles, Identity } from '@abpjs/identity';
+import { useEffect } from 'react';
+
+function CustomUsersPage() {
+  const {
+    users,
+    totalCount,
+    isLoading,
+    fetchUsers,
+    createUser,
+    deleteUser,
+  } = useUsers();
+
+  useEffect(() => {
+    fetchUsers();
+  }, [fetchUsers]);
+
+  const handleCreateUser = async (data: Identity.UserSaveRequest) => {
+    const result = await createUser(data);
+    if (result.success) {
+      console.log('User created successfully!');
+    }
+  };
+
+  return (
+    <div>
+      <h1>Users ({totalCount})</h1>
+      {users.map(user => (
+        <div key={user.id}>
+          <span>{user.userName}</span>
+          <span>{user.email}</span>
+          <button onClick={() => deleteUser(user.id)}>Delete</button>
+        </div>
+      ))}
+    </div>
+  );
+}
+```
+
+## Components
+
+### UsersComponent
+
+Complete user management component with table, search, pagination, and modals.
+
+```tsx
+import { UsersComponent } from '@abpjs/identity';
+
+<UsersComponent
+  onUserCreated={(user) => console.log('Created:', user)}
+  onUserUpdated={(user) => console.log('Updated:', user)}
+  onUserDeleted={(id) => console.log('Deleted:', id)}
+/>
+```
+
+**Props:**
+
+| Prop | Type | Description |
+|------|------|-------------|
+| `onUserCreated` | `(user: UserItem) => void` | Callback when user is created |
+| `onUserUpdated` | `(user: UserItem) => void` | Callback when user is updated |
+| `onUserDeleted` | `(id: string) => void` | Callback when user is deleted |
+
+**Features:**
+- User table with actions menu
+- Search/filter by username
+- Pagination controls
+- Create/Edit modal with tabs for user info and role assignment
+- Permission management integration
+- Delete confirmation dialog
+
+### RolesComponent
+
+Complete role management component with table, search, and modals.
+
+```tsx
+import { RolesComponent } from '@abpjs/identity';
+
+<RolesComponent
+  onRoleCreated={(role) => console.log('Created:', role)}
+  onRoleUpdated={(role) => console.log('Updated:', role)}
+  onRoleDeleted={(id) => console.log('Deleted:', id)}
+/>
+```
+
+**Props:**
+
+| Prop | Type | Description |
+|------|------|-------------|
+| `onRoleCreated` | `(role: RoleItem) => void` | Callback when role is created |
+| `onRoleUpdated` | `(role: RoleItem) => void` | Callback when role is updated |
+| `onRoleDeleted` | `(id: string) => void` | Callback when role is deleted |
+
+**Features:**
+- Role table with actions menu
+- Search/filter by role name
+- Create/Edit modal with isDefault and isPublic options
+- Permission management integration
+- Static role protection (cannot delete static roles)
+- Delete confirmation dialog
+
+## Hooks
+
+### useUsers
+
+Hook for managing users with full CRUD and pagination support.
+
+```tsx
+import { useUsers } from '@abpjs/identity';
+
+function MyUsersPage() {
+  const {
+    users,              // Array of users
+    totalCount,         // Total user count
+    selectedUser,       // Currently selected user
+    selectedUserRoles,  // Roles of selected user
+    isLoading,          // Loading state
+    error,              // Error message
+    pageQuery,          // Current pagination params
+    fetchUsers,         // Fetch users with optional params
+    getUserById,        // Get single user
+    getUserRoles,       // Get user's roles
+    createUser,         // Create new user
+    updateUser,         // Update existing user
+    deleteUser,         // Delete user
+    setSelectedUser,    // Set selected user
+    setPageQuery,       // Update pagination params
+    reset,              // Reset all state
+  } = useUsers();
+
+  // Fetch users on mount
+  useEffect(() => {
+    fetchUsers();
+  }, [fetchUsers]);
+
+  // Pagination example
+  const handlePageChange = (page: number) => {
+    const newQuery = {
+      ...pageQuery,
+      skipCount: page * pageQuery.maxResultCount,
+    };
+    setPageQuery(newQuery);
+    fetchUsers(newQuery);
+  };
+
+  // Create user example
+  const handleCreate = async () => {
+    const result = await createUser({
+      userName: 'newuser',
+      email: 'user@example.com',
+      password: 'SecurePassword123!',
+      name: 'John',
+      surname: 'Doe',
+      phoneNumber: '',
+      lockoutEnabled: true,
+      twoFactorEnabled: false,
+      roleNames: ['admin'],
+    });
+
+    if (result.success) {
+      console.log('User created!');
+    } else {
+      console.error(result.error);
+    }
+  };
+}
+```
+
+### useRoles
+
+Hook for managing roles with full CRUD support.
+
+```tsx
+import { useRoles } from '@abpjs/identity';
+
+function MyRolesPage() {
+  const {
+    roles,            // Array of roles
+    totalCount,       // Total role count
+    selectedRole,     // Currently selected role
+    isLoading,        // Loading state
+    error,            // Error message
+    fetchRoles,       // Fetch all roles
+    getRoleById,      // Get single role
+    createRole,       // Create new role
+    updateRole,       // Update existing role
+    deleteRole,       // Delete role
+    setSelectedRole,  // Set selected role
+    reset,            // Reset all state
+  } = useRoles();
+
+  // Fetch roles on mount
+  useEffect(() => {
+    fetchRoles();
+  }, [fetchRoles]);
+
+  // Create role example
+  const handleCreate = async () => {
+    const result = await createRole({
+      name: 'Manager',
+      isDefault: false,
+      isPublic: true,
+    });
+
+    if (result.success) {
+      console.log('Role created!');
+    }
+  };
+}
+```
+
+### useIdentity
+
+Combined hook for managing both users and roles.
+
+```tsx
+import { useIdentity } from '@abpjs/identity';
+
+function IdentityDashboard() {
+  const { roles, users, fetchRoles, fetchUsers } = useIdentity();
+
+  useEffect(() => {
+    fetchRoles();
+    fetchUsers();
+  }, []);
+
+  return (
+    <div>
+      <h2>Users: {users.length}</h2>
+      <h2>Roles: {roles.length}</h2>
+    </div>
+  );
+}
+```
+
+## Services
+
+### IdentityService
+
+Service class for direct API interaction.
+
+```tsx
+import { IdentityService } from '@abpjs/identity';
+import { useRestService } from '@abpjs/core';
+
+function MyComponent() {
+  const restService = useRestService();
+  const identityService = new IdentityService(restService);
+
+  // Role operations
+  const roles = await identityService.getRoles();
+  const role = await identityService.getRoleById(roleId);
+  await identityService.createRole({ name: 'Editor', isDefault: false, isPublic: true });
+  await identityService.updateRole(roleId, { name: 'Senior Editor', isDefault: false, isPublic: true });
+  await identityService.deleteRole(roleId);
+
+  // User operations
+  const users = await identityService.getUsers({ maxResultCount: 10, skipCount: 0 });
+  const user = await identityService.getUserById(userId);
+  const userRoles = await identityService.getUserRoles(userId);
+  await identityService.createUser({ userName: 'john', email: 'john@example.com', password: 'Pass123!', ... });
+  await identityService.updateUser(userId, { ... });
+  await identityService.deleteUser(userId);
+}
+```
+
+## Data Models
+
+### Identity Namespace
+
+All identity types are exported under the `Identity` namespace:
+
+```typescript
+import { Identity } from '@abpjs/identity';
+
+// State shape
+interface Identity.State {
+  roles: RoleResponse;
+  users: UserResponse;
+  selectedRole: RoleItem;
+  selectedUser: UserItem;
+  selectedUserRoles: RoleItem[];
+}
+
+// Role types
+interface Identity.RoleItem {
+  id: string;
+  name: string;
+  isDefault: boolean;
+  isPublic: boolean;
+  isStatic: boolean;
+  concurrencyStamp: string;
+}
+
+interface Identity.RoleSaveRequest {
+  name: string;
+  isDefault: boolean;
+  isPublic: boolean;
+}
+
+// User types
+interface Identity.UserItem {
+  id: string;
+  tenantId: string;
+  userName: string;
+  name: string;
+  surname: string;
+  email: string;
+  emailConfirmed: boolean;
+  phoneNumber: string;
+  phoneNumberConfirmed: boolean;
+  twoFactorEnabled: boolean;
+  lockoutEnabled: boolean;
+  isLockedOut: boolean;
+  concurrencyStamp: string;
+}
+
+interface Identity.UserSaveRequest {
+  userName: string;
+  name: string;
+  surname: string;
+  email: string;
+  phoneNumber: string;
+  password: string;
+  lockoutEnabled: boolean;
+  twoFactorEnabled: boolean;
+  roleNames: string[];
+}
+```
+
+## Integration Example
+
+Complete identity management page:
+
+```tsx
+import { useState } from 'react';
+import { usePermission } from '@abpjs/core';
+import { RolesComponent, UsersComponent } from '@abpjs/identity';
+import {
+  Box,
+  Tabs,
+  TabList,
+  TabPanels,
+  Tab,
+  TabPanel,
+  Heading,
+  useToast,
+} from '@chakra-ui/react';
+
+function IdentityManagementPage() {
+  const toast = useToast();
+  const { hasPermission } = usePermission();
+
+  const canViewUsers = hasPermission('AbpIdentity.Users');
+  const canViewRoles = hasPermission('AbpIdentity.Roles');
+
+  const handleUserCreated = (user) => {
+    toast({ title: `User ${user.userName} created`, status: 'success' });
+  };
+
+  const handleUserDeleted = () => {
+    toast({ title: 'User deleted', status: 'success' });
+  };
+
+  const handleRoleCreated = (role) => {
+    toast({ title: `Role ${role.name} created`, status: 'success' });
+  };
+
+  const handleRoleDeleted = () => {
+    toast({ title: 'Role deleted', status: 'success' });
+  };
+
+  return (
+    <Box p={4}>
+      <Heading mb={4}>Identity Management</Heading>
+
+      <Tabs>
+        <TabList>
+          {canViewUsers && <Tab>Users</Tab>}
+          {canViewRoles && <Tab>Roles</Tab>}
+        </TabList>
+
+        <TabPanels>
+          {canViewUsers && (
+            <TabPanel>
+              <UsersComponent
+                onUserCreated={handleUserCreated}
+                onUserDeleted={handleUserDeleted}
+              />
+            </TabPanel>
+          )}
+          {canViewRoles && (
+            <TabPanel>
+              <RolesComponent
+                onRoleCreated={handleRoleCreated}
+                onRoleDeleted={handleRoleDeleted}
+              />
+            </TabPanel>
+          )}
+        </TabPanels>
+      </Tabs>
+    </Box>
+  );
+}
+
+export default IdentityManagementPage;
+```
+
+## ABP Permissions
+
+This package respects ABP's identity permissions:
+
+| Permission | Description |
+|------------|-------------|
+| `AbpIdentity.Users` | View users |
+| `AbpIdentity.Users.Create` | Create users |
+| `AbpIdentity.Users.Update` | Update users |
+| `AbpIdentity.Users.Delete` | Delete users |
+| `AbpIdentity.Users.ManagePermissions` | Manage user permissions |
+| `AbpIdentity.Roles` | View roles |
+| `AbpIdentity.Roles.Create` | Create roles |
+| `AbpIdentity.Roles.Update` | Update roles |
+| `AbpIdentity.Roles.Delete` | Delete roles |
+| `AbpIdentity.Roles.ManagePermissions` | Manage role permissions |
+
+## Related Packages
+
+- [@abpjs/core](https://www.npmjs.com/package/@abpjs/core) - Core infrastructure (required)
+- [@abpjs/theme-shared](https://www.npmjs.com/package/@abpjs/theme-shared) - Shared UI components (required)
+- [@abpjs/permission-management](https://www.npmjs.com/package/@abpjs/permission-management) - Permission management (required)
+- [@abpjs/account](https://www.npmjs.com/package/@abpjs/account) - Account management
+- [@abpjs/tenant-management](https://www.npmjs.com/package/@abpjs/tenant-management) - Tenant administration
+- [@abpjs/theme-basic](https://www.npmjs.com/package/@abpjs/theme-basic) - Layout components
+
+## Contributing
+
+This package is part of the [ABP React](https://github.com/abpjs/abp-react) monorepo. Contributions are welcome!
+
+## License
+
+LGPL-3.0 - See [LICENSE](https://github.com/abpjs/abp-react/blob/main/LICENSE) for details.
+
+---
+
+**[View Full Documentation](https://docs.abpjs.io/docs/packages/identity/overview)** | **[Report Issues](https://github.com/abpjs/abp-react/issues)** | **[View Source](https://github.com/abpjs/abp-react/tree/main/packages/identity)**