@abpjs/tenant-management 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,549 @@
+# @abpjs/tenant-management
+
+> Multi-tenant management UI components for ABP Framework in React
+
+[![npm version](https://img.shields.io/npm/v/@abpjs/tenant-management.svg)](https://www.npmjs.com/package/@abpjs/tenant-management)
+[![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/tenant-management` provides a complete tenant management interface for ABP-based multi-tenant SaaS applications in React. It enables administrators to create, update, delete, and manage tenants through an intuitive UI.
+
+This package is a React translation of the original `@abp/ng.tenant-management` Angular package, bringing full multi-tenant management capabilities to React applications.
+
+## Features
+
+- **Tenant CRUD** - Create, read, update, and delete tenants
+- **Tenant Modal** - Ready-to-use modal dialog for tenant management
+- **Connection Strings** - Manage tenant-specific database connections
+- **Feature Management** - Configure features per tenant
+- **Permission Integration** - Seamlessly integrates with permission management
+- **Chakra UI** - Beautiful, accessible components
+- **TypeScript** - Full type safety with comprehensive definitions
+
+## Installation
+
+```bash
+# Using npm
+npm install @abpjs/tenant-management
+
+# Using yarn
+yarn add @abpjs/tenant-management
+
+# Using pnpm
+pnpm add @abpjs/tenant-management
+```
+
+### Required Dependencies
+
+This package requires the following peer dependencies:
+
+```bash
+npm install @abpjs/core @abpjs/theme-shared @chakra-ui/react @emotion/react @emotion/styled framer-motion
+```
+
+## Quick Start
+
+### Basic Tenant Management
+
+```tsx
+import { useState, useEffect } from 'react';
+import {
+  TenantManagementModal,
+  useTenantManagement
+} from '@abpjs/tenant-management';
+import {
+  Table,
+  Button,
+  IconButton,
+  useDisclosure
+} from '@chakra-ui/react';
+import { EditIcon, DeleteIcon, AddIcon } from '@chakra-ui/icons';
+
+function TenantManagementPage() {
+  const { isOpen, onOpen, onClose } = useDisclosure();
+  const { tenants, getTenants, deleteTenant, isLoading } = useTenantManagement();
+  const [selectedTenant, setSelectedTenant] = useState(null);
+
+  useEffect(() => {
+    getTenants();
+  }, []);
+
+  const handleEdit = (tenant) => {
+    setSelectedTenant(tenant);
+    onOpen();
+  };
+
+  const handleCreate = () => {
+    setSelectedTenant(null);
+    onOpen();
+  };
+
+  const handleDelete = async (tenant) => {
+    if (confirm(`Delete tenant "${tenant.name}"?`)) {
+      await deleteTenant(tenant.id);
+      getTenants();
+    }
+  };
+
+  return (
+    <div>
+      <Button leftIcon={<AddIcon />} onClick={handleCreate}>
+        New Tenant
+      </Button>
+
+      <Table>
+        <thead>
+          <tr>
+            <th>Name</th>
+            <th>Actions</th>
+          </tr>
+        </thead>
+        <tbody>
+          {tenants.map(tenant => (
+            <tr key={tenant.id}>
+              <td>{tenant.name}</td>
+              <td>
+                <IconButton
+                  icon={<EditIcon />}
+                  onClick={() => handleEdit(tenant)}
+                />
+                <IconButton
+                  icon={<DeleteIcon />}
+                  onClick={() => handleDelete(tenant)}
+                />
+              </td>
+            </tr>
+          ))}
+        </tbody>
+      </Table>
+
+      <TenantManagementModal
+        isOpen={isOpen}
+        onClose={onClose}
+        tenant={selectedTenant}
+        onSave={() => {
+          getTenants();
+          onClose();
+        }}
+      />
+    </div>
+  );
+}
+```
+
+### Creating a New Tenant
+
+```tsx
+import { TenantManagementModal } from '@abpjs/tenant-management';
+
+function CreateTenantButton() {
+  const [isOpen, setIsOpen] = useState(false);
+
+  return (
+    <>
+      <Button onClick={() => setIsOpen(true)}>
+        Create Tenant
+      </Button>
+
+      <TenantManagementModal
+        isOpen={isOpen}
+        onClose={() => setIsOpen(false)}
+        onSave={() => {
+          console.log('Tenant created!');
+          setIsOpen(false);
+        }}
+      />
+    </>
+  );
+}
+```
+
+### Editing an Existing Tenant
+
+```tsx
+import { TenantManagementModal } from '@abpjs/tenant-management';
+
+function EditTenantButton({ tenant }) {
+  const [isOpen, setIsOpen] = useState(false);
+
+  return (
+    <>
+      <Button onClick={() => setIsOpen(true)}>
+        Edit
+      </Button>
+
+      <TenantManagementModal
+        isOpen={isOpen}
+        onClose={() => setIsOpen(false)}
+        tenant={tenant}  // Pass existing tenant for edit mode
+        onSave={() => {
+          console.log('Tenant updated!');
+          setIsOpen(false);
+        }}
+      />
+    </>
+  );
+}
+```
+
+## Components
+
+### TenantManagementModal
+
+The main component for creating and editing tenants.
+
+```tsx
+import { TenantManagementModal } from '@abpjs/tenant-management';
+
+<TenantManagementModal
+  isOpen={isOpen}
+  onClose={handleClose}
+  tenant={selectedTenant}  // null for create, tenant object for edit
+  onSave={handleSave}
+/>
+```
+
+**Props:**
+
+| Prop | Type | Description |
+|------|------|-------------|
+| `isOpen` | `boolean` | Controls modal visibility |
+| `onClose` | `() => void` | Callback when modal is closed |
+| `tenant` | `Tenant \| null` | Tenant to edit, or null for create mode |
+| `onSave` | `() => void` | Callback after tenant is saved |
+
+## Hooks
+
+### useTenantManagement
+
+Hook for accessing tenant management functionality.
+
+```tsx
+import { useTenantManagement } from '@abpjs/tenant-management';
+
+function TenantsPage() {
+  const {
+    tenants,           // Array of tenants
+    isLoading,         // Loading state
+    error,             // Error state
+    getTenants,        // Fetch all tenants
+    getTenant,         // Fetch single tenant by ID
+    createTenant,      // Create new tenant
+    updateTenant,      // Update existing tenant
+    deleteTenant,      // Delete tenant
+  } = useTenantManagement();
+
+  useEffect(() => {
+    getTenants();
+  }, []);
+
+  const handleCreate = async () => {
+    await createTenant({
+      name: 'New Tenant',
+      adminEmailAddress: 'admin@newtenant.com',
+      adminPassword: 'SecurePassword123!',
+    });
+    getTenants();
+  };
+
+  return (
+    <div>
+      {isLoading ? (
+        <Spinner />
+      ) : (
+        <TenantList tenants={tenants} />
+      )}
+    </div>
+  );
+}
+```
+
+## Services
+
+### TenantManagementService
+
+Service class for direct API interaction.
+
+```tsx
+import { TenantManagementService } from '@abpjs/tenant-management';
+
+// Get all tenants
+const tenants = await TenantManagementService.getList({
+  filter: '',
+  sorting: 'name',
+  skipCount: 0,
+  maxResultCount: 10,
+});
+
+// Get single tenant
+const tenant = await TenantManagementService.get(tenantId);
+
+// Create tenant
+const newTenant = await TenantManagementService.create({
+  name: 'Acme Corp',
+  adminEmailAddress: 'admin@acme.com',
+  adminPassword: 'SecurePassword123!',
+});
+
+// Update tenant
+await TenantManagementService.update(tenantId, {
+  name: 'Acme Corporation',
+});
+
+// Delete tenant
+await TenantManagementService.delete(tenantId);
+
+// Get default connection string
+const connectionString = await TenantManagementService.getDefaultConnectionString(tenantId);
+
+// Update default connection string
+await TenantManagementService.updateDefaultConnectionString(tenantId, connectionString);
+```
+
+## Data Models
+
+### Tenant
+
+```typescript
+interface Tenant {
+  id: string;
+  name: string;
+  concurrencyStamp?: string;
+}
+```
+
+### CreateTenantInput
+
+```typescript
+interface CreateTenantInput {
+  name: string;
+  adminEmailAddress: string;
+  adminPassword: string;
+  connectionStrings?: ConnectionStrings;
+}
+```
+
+### UpdateTenantInput
+
+```typescript
+interface UpdateTenantInput {
+  name: string;
+  concurrencyStamp?: string;
+}
+```
+
+## Multi-Tenancy Concepts
+
+ABP Framework supports multi-tenancy out of the box. Key concepts:
+
+### Tenant Isolation
+
+Each tenant operates in isolation with:
+- **Separate Database** - Each tenant can have its own database
+- **Shared Database** - Tenants can share a database with data isolation
+- **Hybrid** - Mix of dedicated and shared databases
+
+### Connection Strings
+
+Manage per-tenant database connections:
+
+```tsx
+import { TenantManagementService } from '@abpjs/tenant-management';
+
+// Set tenant-specific connection string
+await TenantManagementService.updateDefaultConnectionString(
+  tenantId,
+  'Server=tenant-db;Database=TenantDB;...'
+);
+
+// Clear connection string (use host's database)
+await TenantManagementService.deleteDefaultConnectionString(tenantId);
+```
+
+## Complete Example
+
+Full tenant management page:
+
+```tsx
+import { useState, useEffect } from 'react';
+import { usePermission } from '@abpjs/core';
+import {
+  TenantManagementModal,
+  useTenantManagement
+} from '@abpjs/tenant-management';
+import { PermissionManagementModal } from '@abpjs/permission-management';
+import {
+  Box,
+  Table,
+  Thead,
+  Tbody,
+  Tr,
+  Th,
+  Td,
+  Button,
+  IconButton,
+  HStack,
+  useDisclosure,
+  useToast,
+} from '@chakra-ui/react';
+import { AddIcon, EditIcon, DeleteIcon, SettingsIcon } from '@chakra-ui/icons';
+
+function TenantManagementPage() {
+  const toast = useToast();
+  const { hasPermission } = usePermission();
+
+  // Tenant modal state
+  const tenantModal = useDisclosure();
+  const [selectedTenant, setSelectedTenant] = useState(null);
+
+  // Permission modal state
+  const permissionModal = useDisclosure();
+  const [permissionTenant, setPermissionTenant] = useState(null);
+
+  // Tenant management hook
+  const {
+    tenants,
+    getTenants,
+    deleteTenant,
+    isLoading,
+  } = useTenantManagement();
+
+  // Permission checks
+  const canCreate = hasPermission('AbpTenantManagement.Tenants.Create');
+  const canEdit = hasPermission('AbpTenantManagement.Tenants.Update');
+  const canDelete = hasPermission('AbpTenantManagement.Tenants.Delete');
+  const canManageFeatures = hasPermission('AbpTenantManagement.Tenants.ManageFeatures');
+
+  useEffect(() => {
+    getTenants();
+  }, []);
+
+  const handleCreate = () => {
+    setSelectedTenant(null);
+    tenantModal.onOpen();
+  };
+
+  const handleEdit = (tenant) => {
+    setSelectedTenant(tenant);
+    tenantModal.onOpen();
+  };
+
+  const handleDelete = async (tenant) => {
+    if (window.confirm(`Are you sure you want to delete "${tenant.name}"?`)) {
+      try {
+        await deleteTenant(tenant.id);
+        toast({ title: 'Tenant deleted', status: 'success' });
+        getTenants();
+      } catch (error) {
+        toast({ title: 'Failed to delete tenant', status: 'error' });
+      }
+    }
+  };
+
+  const handleManageFeatures = (tenant) => {
+    setPermissionTenant(tenant);
+    permissionModal.onOpen();
+  };
+
+  const handleSave = () => {
+    getTenants();
+    tenantModal.onClose();
+    toast({ title: 'Tenant saved', status: 'success' });
+  };
+
+  return (
+    <Box p={4}>
+      <HStack justify="space-between" mb={4}>
+        <h1>Tenant Management</h1>
+        {canCreate && (
+          <Button leftIcon={<AddIcon />} colorScheme="blue" onClick={handleCreate}>
+            New Tenant
+          </Button>
+        )}
+      </HStack>
+
+      <Table>
+        <Thead>
+          <Tr>
+            <Th>Name</Th>
+            <Th>Actions</Th>
+          </Tr>
+        </Thead>
+        <Tbody>
+          {tenants.map(tenant => (
+            <Tr key={tenant.id}>
+              <Td>{tenant.name}</Td>
+              <Td>
+                <HStack spacing={2}>
+                  {canEdit && (
+                    <IconButton
+                      aria-label="Edit"
+                      icon={<EditIcon />}
+                      size="sm"
+                      onClick={() => handleEdit(tenant)}
+                    />
+                  )}
+                  {canManageFeatures && (
+                    <IconButton
+                      aria-label="Manage Features"
+                      icon={<SettingsIcon />}
+                      size="sm"
+                      onClick={() => handleManageFeatures(tenant)}
+                    />
+                  )}
+                  {canDelete && (
+                    <IconButton
+                      aria-label="Delete"
+                      icon={<DeleteIcon />}
+                      size="sm"
+                      colorScheme="red"
+                      onClick={() => handleDelete(tenant)}
+                    />
+                  )}
+                </HStack>
+              </Td>
+            </Tr>
+          ))}
+        </Tbody>
+      </Table>
+
+      <TenantManagementModal
+        isOpen={tenantModal.isOpen}
+        onClose={tenantModal.onClose}
+        tenant={selectedTenant}
+        onSave={handleSave}
+      />
+
+      <PermissionManagementModal
+        isOpen={permissionModal.isOpen}
+        onClose={permissionModal.onClose}
+        providerName="T"
+        providerKey={permissionTenant?.id}
+      />
+    </Box>
+  );
+}
+
+export default TenantManagementPage;
+```
+
+## 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
+- [@abpjs/account](https://www.npmjs.com/package/@abpjs/account) - Account management
+- [@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/tenant-management/overview)** | **[Report Issues](https://github.com/abpjs/abp-react/issues)** | **[View Source](https://github.com/abpjs/abp-react/tree/main/packages/tenant-management)**