@abpjs/saas 0.7.2

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,374 @@
+# @abpjs/saas
+
+> SaaS tenant and edition management UI components for ABP Framework in React
+
+[![npm version](https://img.shields.io/npm/v/@abpjs/saas.svg)](https://www.npmjs.com/package/@abpjs/saas)
+[![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/saas` provides SaaS (Software as a Service) management components for ABP-based React applications. It includes tenant management, edition management, and subscription features for multi-tenant applications.
+
+This package is a React translation of the original `@volo/abp.ng.saas` Angular package.
+
+## Features
+
+- **Tenant Management** - Create, read, update, and delete tenants
+- **Edition Management** - Create, read, update, and delete editions
+- **Feature Management** - Configure features per tenant/edition
+- **Connection Strings** - Manage tenant database connection strings
+- **Tenant Activation** - Enable/disable tenants
+- **Pagination** - Built-in pagination for all list views
+- **Search & Filter** - Filter tenants and editions by name
+- **Chakra UI** - Beautiful, accessible components
+- **TypeScript** - Full type safety with comprehensive definitions
+
+## Installation
+
+```bash
+# Using npm
+npm install @abpjs/saas
+
+# Using yarn
+yarn add @abpjs/saas
+
+# Using pnpm
+pnpm add @abpjs/saas
+```
+
+### Required Dependencies
+
+This package requires the following peer dependencies:
+
+```bash
+npm install @abpjs/core @abpjs/theme-shared @abpjs/feature-management @chakra-ui/react @emotion/react react-router-dom
+```
+
+## Quick Start
+
+### Using Pre-built Components
+
+```tsx
+import { TenantsComponent, EditionsComponent } from '@abpjs/saas';
+import { Tabs, TabList, TabPanels, Tab, TabPanel } from '@chakra-ui/react';
+
+function SaaSManagement() {
+  return (
+    <Tabs>
+      <TabList>
+        <Tab>Tenants</Tab>
+        <Tab>Editions</Tab>
+      </TabList>
+
+      <TabPanels>
+        <TabPanel>
+          <TenantsComponent
+            onTenantCreated={(tenant) => console.log('Tenant created:', tenant)}
+            onTenantDeleted={(id) => console.log('Tenant deleted:', id)}
+          />
+        </TabPanel>
+        <TabPanel>
+          <EditionsComponent
+            onEditionCreated={(edition) => console.log('Edition created:', edition)}
+            onEditionDeleted={(id) => console.log('Edition deleted:', id)}
+          />
+        </TabPanel>
+      </TabPanels>
+    </Tabs>
+  );
+}
+```
+
+### Using Hooks for Custom UI
+
+```tsx
+import { useTenants, useEditions } from '@abpjs/saas';
+import { useEffect } from 'react';
+
+function CustomSaaSView() {
+  const { tenants, fetchTenants } = useTenants();
+  const { editions, fetchEditions } = useEditions();
+
+  useEffect(() => {
+    fetchTenants();
+    fetchEditions();
+  }, [fetchTenants, fetchEditions]);
+
+  return (
+    <div>
+      <h2>Tenants: {tenants.length}</h2>
+      <h2>Editions: {editions.length}</h2>
+    </div>
+  );
+}
+```
+
+## Components
+
+### TenantsComponent
+
+Complete tenant management component with table, search, and modals.
+
+```tsx
+import { TenantsComponent } from '@abpjs/saas';
+
+<TenantsComponent
+  onTenantCreated={(tenant) => console.log('Created:', tenant)}
+  onTenantUpdated={(tenant) => console.log('Updated:', tenant)}
+  onTenantDeleted={(id) => console.log('Deleted:', id)}
+/>
+```
+
+**Props:**
+
+| Prop | Type | Required | Description |
+|------|------|----------|-------------|
+| `onTenantCreated` | `(tenant: Tenant) => void` | No | Callback when tenant is created |
+| `onTenantUpdated` | `(tenant: Tenant) => void` | No | Callback when tenant is updated |
+| `onTenantDeleted` | `(id: string) => void` | No | Callback when tenant is deleted |
+
+**Features:**
+- Tenant table with actions menu
+- Search/filter by tenant name
+- Pagination controls
+- Create/Edit modal with tabs for tenant info and connection strings
+- Edition assignment
+- Tenant activation/deactivation
+- Feature management integration
+- Delete confirmation dialog
+
+### EditionsComponent
+
+Complete edition management component.
+
+```tsx
+import { EditionsComponent } from '@abpjs/saas';
+
+<EditionsComponent
+  onEditionCreated={(edition) => console.log('Created:', edition)}
+  onEditionUpdated={(edition) => console.log('Updated:', edition)}
+  onEditionDeleted={(id) => console.log('Deleted:', id)}
+/>
+```
+
+**Props:**
+
+| Prop | Type | Required | Description |
+|------|------|----------|-------------|
+| `onEditionCreated` | `(edition: Edition) => void` | No | Callback when edition is created |
+| `onEditionUpdated` | `(edition: Edition) => void` | No | Callback when edition is updated |
+| `onEditionDeleted` | `(id: string) => void` | No | Callback when edition is deleted |
+
+**Features:**
+- Edition table with actions menu
+- Search/filter by edition name
+- Create/Edit modal
+- Feature management integration
+- Delete confirmation dialog
+
+## Hooks
+
+### useTenants
+
+Hook for managing tenants with full CRUD and pagination support.
+
+```tsx
+import { useTenants } from '@abpjs/saas';
+
+const {
+  tenants,            // Array of tenants
+  totalCount,         // Total tenant count
+  selectedTenant,     // Currently selected tenant
+  isLoading,          // Loading state
+  error,              // Error message
+  pageQuery,          // Current pagination/filter params
+  fetchTenants,       // Fetch tenants with optional params
+  getTenantById,      // Get single tenant
+  createTenant,       // Create new tenant
+  updateTenant,       // Update existing tenant
+  deleteTenant,       // Delete tenant
+  setSelectedTenant,  // Set the selected tenant
+  setPageQuery,       // Update pagination params
+  reset,              // Reset all state
+} = useTenants();
+```
+
+### useEditions
+
+Hook for managing editions with full CRUD support.
+
+```tsx
+import { useEditions } from '@abpjs/saas';
+
+const {
+  editions,           // Array of editions
+  totalCount,         // Total edition count
+  selectedEdition,    // Currently selected edition
+  isLoading,          // Loading state
+  error,              // Error message
+  fetchEditions,      // Fetch all editions
+  getEditionById,     // Get single edition
+  createEdition,      // Create new edition
+  updateEdition,      // Update existing edition
+  deleteEdition,      // Delete edition
+  setSelectedEdition, // Set the selected edition
+  reset,              // Reset all state
+} = useEditions();
+```
+
+## Services
+
+### SaaSService
+
+Service class for SaaS API operations.
+
+```tsx
+import { SaaSService } from '@abpjs/saas';
+import { useRestService } from '@abpjs/core';
+
+function MyComponent() {
+  const restService = useRestService();
+  const service = new SaaSService(restService);
+
+  // Tenant operations
+  await service.getTenants({ maxResultCount: 10, skipCount: 0 });
+  await service.getTenantById(tenantId);
+  await service.createTenant(tenantData);
+  await service.updateTenant(tenantId, tenantData);
+  await service.deleteTenant(tenantId);
+  await service.getDefaultConnectionString(tenantId);
+  await service.updateDefaultConnectionString(tenantId, connectionString);
+
+  // Edition operations
+  await service.getEditions();
+  await service.getEditionById(editionId);
+  await service.createEdition(editionData);
+  await service.updateEdition(editionId, editionData);
+  await service.deleteEdition(editionId);
+}
+```
+
+## Data Models
+
+### Tenant
+
+```typescript
+interface Tenant {
+  id: string;
+  name: string;
+  editionId: string;
+  editionName: string;
+  concurrencyStamp: string;
+  isActive: boolean;
+  activationState: TenantActivationState;
+  activationEndDate: string;
+}
+
+enum TenantActivationState {
+  Active = 0,
+  ActiveWithLimitedTime = 1,
+  Passive = 2,
+}
+```
+
+### Edition
+
+```typescript
+interface Edition {
+  id: string;
+  displayName: string;
+}
+
+interface EditionCreateDto {
+  displayName: string;
+}
+
+interface EditionUpdateDto {
+  displayName: string;
+}
+```
+
+### Tenant Connection String
+
+```typescript
+interface TenantConnectionString {
+  name: string;
+  value: string;
+}
+```
+
+## Constants
+
+### SAAS_ROUTES
+
+Default route configuration for the SaaS module:
+
+```tsx
+import { SAAS_ROUTES } from '@abpjs/saas';
+
+// Use in your router configuration
+const routes = [
+  ...SAAS_ROUTES.routes,
+  // your other routes
+];
+```
+
+## Router Setup Example
+
+```tsx
+import { BrowserRouter, Routes, Route, Navigate } from 'react-router-dom';
+import { TenantsComponent, EditionsComponent } from '@abpjs/saas';
+
+function App() {
+  return (
+    <BrowserRouter>
+      <Routes>
+        <Route path="/saas">
+          <Route index element={<Navigate to="tenants" replace />} />
+          <Route path="tenants" element={<TenantsComponent />} />
+          <Route path="editions" element={<EditionsComponent />} />
+        </Route>
+      </Routes>
+    </BrowserRouter>
+  );
+}
+```
+
+## ABP Permissions
+
+This package respects ABP's SaaS permissions:
+
+| Permission | Description |
+|------------|-------------|
+| `Saas.Tenants` | View tenants |
+| `Saas.Tenants.Create` | Create tenants |
+| `Saas.Tenants.Update` | Update tenants |
+| `Saas.Tenants.Delete` | Delete tenants |
+| `Saas.Tenants.ManageFeatures` | Manage tenant features |
+| `Saas.Tenants.ManageConnectionStrings` | Manage connection strings |
+| `Saas.Editions` | View editions |
+| `Saas.Editions.Create` | Create editions |
+| `Saas.Editions.Update` | Update editions |
+| `Saas.Editions.Delete` | Delete editions |
+| `Saas.Editions.ManageFeatures` | Manage edition features |
+
+## 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/feature-management](https://www.npmjs.com/package/@abpjs/feature-management) - Feature management (required)
+- [@abpjs/tenant-management](https://www.npmjs.com/package/@abpjs/tenant-management) - Basic tenant management
+- [@abpjs/identity-pro](https://www.npmjs.com/package/@abpjs/identity-pro) - Identity Pro features
+- [@abpjs/audit-logging](https://www.npmjs.com/package/@abpjs/audit-logging) - Audit logging
+
+## 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/saas/overview)** | **[Report Issues](https://github.com/abpjs/abp-react/issues)** | **[View Source](https://github.com/abpjs/abp-react/tree/main/packages/saas)**