@abpjs/tenant-management 3.0.0 → 3.2.0

package/dist/__tests__/proxy/models.test.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Tests for proxy models (v3.2.0)
+ * Tests the new typed DTOs for Tenant Management API
+ */
+export {};

package/dist/__tests__/proxy/tenant.service.test.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Tests for TenantService (v3.2.0)
+ * Tests the typed proxy service for Tenant Management API
+ */
+export {};

package/dist/index.d.ts

@@ -1,7 +1,28 @@
 /**
  * @abpjs/tenant-management
  * ABP Framework Tenant Management module for React
- * Translated from @abp/ng.tenant-management v3.0.0
+ * Translated from @abp/ng.tenant-management v3.2.0
+ *
+ * Changes in v3.2.0:
+ * - Added proxy submodule with typed DTOs and TenantService
+ * - Added GetTenantsInput interface for tenant list queries
+ * - Added TenantCreateDto interface for creating tenants
+ * - Added TenantUpdateDto interface for updating tenants
+ * - Added TenantDto interface for tenant responses
+ * - Added TenantCreateOrUpdateDtoBase base interface
+ * - Added TenantService with typed CRUD operations (create, delete, get, getList, update)
+ * - Added TenantService.deleteDefaultConnectionString method
+ * - Added TenantService.getDefaultConnectionString method
+ * - Added TenantService.updateDefaultConnectionString method
+ * - Updated TenantManagement.State to use PagedResultDto<TenantDto> and TenantDto
+ * - Deprecated TenantManagement.Response (use PagedResultDto<TenantDto> instead)
+ * - Deprecated TenantManagement.Item (use TenantDto instead)
+ * - Deprecated TenantManagement.AddRequest (use TenantCreateDto instead)
+ * - Deprecated TenantManagement.UpdateRequest (use TenantUpdateDto instead)
+ * - Deprecated TenantManagement.DefaultConnectionStringRequest (use TenantService methods instead)
+ *
+ * Changes in v3.1.0:
+ * - Version bump only (dependency updates to @abp/ng.feature-management v3.1.0, @abp/ng.theme.shared v3.1.0)
  *
  * Changes in v3.0.0:
  * - Added config subpackage with route providers and policy names
@@ -51,6 +72,7 @@
 export * from './config';
 export * from './enums';
 export * from './models';
+export * from './proxy';
 export * from './services';
 export * from './hooks';
 export * from './constants';

package/dist/index.js

@@ -26,6 +26,7 @@ __export(index_exports, {
   TenantManagementModal: () => TenantManagementModal,
   TenantManagementService: () => TenantManagementService,
   TenantManagementStateService: () => TenantManagementStateService,
+  TenantService: () => TenantService,
   configureRoutes: () => configureRoutes,
   eTenantManagementComponents: () => eTenantManagementComponents,
   eTenantManagementPolicyNames: () => eTenantManagementPolicyNames,
@@ -104,6 +105,113 @@ var eTenantManagementComponents = {
   Tenants: "TenantManagement.TenantsComponent"
 };
 
+// src/proxy/tenant.service.ts
+var TenantService = class {
+  constructor(restService) {
+    /**
+     * The API name used for REST requests.
+     * Defaults to 'default' for the main API.
+     */
+    this.apiName = "default";
+    /**
+     * Create a new tenant.
+     * @param input - The tenant creation data including admin credentials
+     * @returns Promise resolving to the created tenant DTO
+     */
+    this.create = (input) => {
+      return this.restService.request({
+        method: "POST",
+        url: "/api/multi-tenancy/tenants",
+        body: input
+      });
+    };
+    /**
+     * Delete a tenant by ID.
+     * @param id - The tenant ID to delete
+     * @returns Promise resolving when deletion is complete
+     */
+    this.delete = (id) => {
+      return this.restService.request({
+        method: "DELETE",
+        url: `/api/multi-tenancy/tenants/${id}`
+      });
+    };
+    /**
+     * Delete the default connection string for a tenant.
+     * This will cause the tenant to use the shared/host database.
+     * @param id - The tenant ID
+     * @returns Promise resolving when deletion is complete
+     */
+    this.deleteDefaultConnectionString = (id) => {
+      return this.restService.request({
+        method: "DELETE",
+        url: `/api/multi-tenancy/tenants/${id}/default-connection-string`
+      });
+    };
+    /**
+     * Get a tenant by ID.
+     * @param id - The tenant ID
+     * @returns Promise resolving to the tenant DTO
+     */
+    this.get = (id) => {
+      return this.restService.request({
+        method: "GET",
+        url: `/api/multi-tenancy/tenants/${id}`
+      });
+    };
+    /**
+     * Get the default connection string for a tenant.
+     * @param id - The tenant ID
+     * @returns Promise resolving to the connection string (empty if using shared database)
+     */
+    this.getDefaultConnectionString = (id) => {
+      return this.restService.request({
+        method: "GET",
+        url: `/api/multi-tenancy/tenants/${id}/default-connection-string`
+      });
+    };
+    /**
+     * Get a paginated list of tenants.
+     * @param input - The query parameters including filter, pagination, and sorting
+     * @returns Promise resolving to a paged result of tenant DTOs
+     */
+    this.getList = (input) => {
+      return this.restService.request({
+        method: "GET",
+        url: "/api/multi-tenancy/tenants",
+        params: input
+      });
+    };
+    /**
+     * Update a tenant.
+     * @param id - The tenant ID to update
+     * @param input - The update data (currently only name can be updated)
+     * @returns Promise resolving to the updated tenant DTO
+     */
+    this.update = (id, input) => {
+      return this.restService.request({
+        method: "PUT",
+        url: `/api/multi-tenancy/tenants/${id}`,
+        body: input
+      });
+    };
+    /**
+     * Update the default connection string for a tenant.
+     * @param id - The tenant ID
+     * @param defaultConnectionString - The new connection string
+     * @returns Promise resolving when update is complete
+     */
+    this.updateDefaultConnectionString = (id, defaultConnectionString) => {
+      return this.restService.request({
+        method: "PUT",
+        url: `/api/multi-tenancy/tenants/${id}/default-connection-string`,
+        params: { defaultConnectionString }
+      });
+    };
+    this.restService = restService;
+  }
+};
+
 // src/services/tenant-management.service.ts
 var TenantManagementService = class {
   constructor(rest) {
@@ -985,6 +1093,7 @@ TenantManagementModal.componentKey = eTenantManagementComponents.Tenants;
   TenantManagementModal,
   TenantManagementService,
   TenantManagementStateService,
+  TenantService,
   configureRoutes,
   eTenantManagementComponents,
   eTenantManagementPolicyNames,

package/dist/index.mjs

@@ -66,6 +66,113 @@ var eTenantManagementComponents = {
   Tenants: "TenantManagement.TenantsComponent"
 };
 
+// src/proxy/tenant.service.ts
+var TenantService = class {
+  constructor(restService) {
+    /**
+     * The API name used for REST requests.
+     * Defaults to 'default' for the main API.
+     */
+    this.apiName = "default";
+    /**
+     * Create a new tenant.
+     * @param input - The tenant creation data including admin credentials
+     * @returns Promise resolving to the created tenant DTO
+     */
+    this.create = (input) => {
+      return this.restService.request({
+        method: "POST",
+        url: "/api/multi-tenancy/tenants",
+        body: input
+      });
+    };
+    /**
+     * Delete a tenant by ID.
+     * @param id - The tenant ID to delete
+     * @returns Promise resolving when deletion is complete
+     */
+    this.delete = (id) => {
+      return this.restService.request({
+        method: "DELETE",
+        url: `/api/multi-tenancy/tenants/${id}`
+      });
+    };
+    /**
+     * Delete the default connection string for a tenant.
+     * This will cause the tenant to use the shared/host database.
+     * @param id - The tenant ID
+     * @returns Promise resolving when deletion is complete
+     */
+    this.deleteDefaultConnectionString = (id) => {
+      return this.restService.request({
+        method: "DELETE",
+        url: `/api/multi-tenancy/tenants/${id}/default-connection-string`
+      });
+    };
+    /**
+     * Get a tenant by ID.
+     * @param id - The tenant ID
+     * @returns Promise resolving to the tenant DTO
+     */
+    this.get = (id) => {
+      return this.restService.request({
+        method: "GET",
+        url: `/api/multi-tenancy/tenants/${id}`
+      });
+    };
+    /**
+     * Get the default connection string for a tenant.
+     * @param id - The tenant ID
+     * @returns Promise resolving to the connection string (empty if using shared database)
+     */
+    this.getDefaultConnectionString = (id) => {
+      return this.restService.request({
+        method: "GET",
+        url: `/api/multi-tenancy/tenants/${id}/default-connection-string`
+      });
+    };
+    /**
+     * Get a paginated list of tenants.
+     * @param input - The query parameters including filter, pagination, and sorting
+     * @returns Promise resolving to a paged result of tenant DTOs
+     */
+    this.getList = (input) => {
+      return this.restService.request({
+        method: "GET",
+        url: "/api/multi-tenancy/tenants",
+        params: input
+      });
+    };
+    /**
+     * Update a tenant.
+     * @param id - The tenant ID to update
+     * @param input - The update data (currently only name can be updated)
+     * @returns Promise resolving to the updated tenant DTO
+     */
+    this.update = (id, input) => {
+      return this.restService.request({
+        method: "PUT",
+        url: `/api/multi-tenancy/tenants/${id}`,
+        body: input
+      });
+    };
+    /**
+     * Update the default connection string for a tenant.
+     * @param id - The tenant ID
+     * @param defaultConnectionString - The new connection string
+     * @returns Promise resolving when update is complete
+     */
+    this.updateDefaultConnectionString = (id, defaultConnectionString) => {
+      return this.restService.request({
+        method: "PUT",
+        url: `/api/multi-tenancy/tenants/${id}/default-connection-string`,
+        params: { defaultConnectionString }
+      });
+    };
+    this.restService = restService;
+  }
+};
+
 // src/services/tenant-management.service.ts
 var TenantManagementService = class {
   constructor(rest) {
@@ -952,6 +1059,7 @@ export {
   TenantManagementModal,
   TenantManagementService,
   TenantManagementStateService,
+  TenantService,
   configureRoutes,
   eTenantManagementComponents,
   eTenantManagementPolicyNames,

package/dist/models/index.d.ts

@@ -1,25 +1,29 @@
 /**
  * Tenant Management module type definitions
- * Translated from @abp/ng.tenant-management v2.4.0
+ * Translated from @abp/ng.tenant-management v3.2.0
  */
-import type { ABP } from '@abpjs/core';
+import type { ABP, PagedResultDto } from '@abpjs/core';
+import type { TenantDto } from '../proxy/models';
 /**
  * TenantManagement namespace containing all tenant-related types
  */
 export declare namespace TenantManagement {
     /**
      * State interface for tenant management store
+     * @since 3.2.0 - Uses PagedResultDto<TenantDto> and TenantDto instead of legacy types
      */
     interface State {
-        result: Response;
-        selectedItem: Item;
+        result: PagedResultDto<TenantDto>;
+        selectedItem: TenantDto;
     }
     /**
      * API response for tenant list (paginated)
+     * @deprecated To be deleted in v4.0. Use PagedResultDto<TenantDto> from @abpjs/core instead.
      */
     type Response = ABP.PagedResponse<Item>;
     /**
      * Single tenant item
+     * @deprecated To be deleted in v4.0. Use TenantDto from '@abpjs/tenant-management/proxy' instead.
      */
     interface Item {
         id: string;
@@ -28,6 +32,7 @@ export declare namespace TenantManagement {
     /**
      * Request payload for creating a new tenant
      * @since 2.4.0 Added adminEmailAddress and adminPassword fields
+     * @deprecated To be deleted in v4.0. Use TenantCreateDto from '@abpjs/tenant-management/proxy' instead.
      */
     interface AddRequest {
         /** Admin email address for the new tenant */
@@ -40,6 +45,7 @@ export declare namespace TenantManagement {
     /**
      * Request payload for updating an existing tenant
      * @since 2.4.0 No longer extends AddRequest (only id and name needed for update)
+     * @deprecated To be deleted in v4.0. Use TenantUpdateDto from '@abpjs/tenant-management/proxy' instead.
      */
     interface UpdateRequest {
         /** Tenant ID */
@@ -49,6 +55,7 @@ export declare namespace TenantManagement {
     }
     /**
      * Request payload for updating tenant's default connection string
+     * @deprecated To be deleted in v4.0. Use TenantService.updateDefaultConnectionString instead.
      */
     interface DefaultConnectionStringRequest {
         id: string;

package/dist/proxy/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Proxy module exports for Tenant Management
+ * Translated from @abp/ng.tenant-management v3.2.0 lib/proxy/index.d.ts
+ *
+ * This module provides typed proxy services and DTOs for the Tenant Management API.
+ * @since 3.2.0
+ */
+export * from './models';
+export * from './tenant.service';

package/dist/proxy/models.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Proxy models for Tenant Management module
+ * Translated from @abp/ng.tenant-management v3.2.0 lib/proxy/models.d.ts
+ *
+ * These are the typed DTOs for the Tenant Management API.
+ * @since 3.2.0
+ */
+import type { ExtensibleEntityDto, ExtensibleObject, PagedAndSortedResultRequestDto } from '@abpjs/core';
+/**
+ * Input parameters for getting a list of tenants.
+ * Extends PagedAndSortedResultRequestDto for pagination and sorting.
+ * @since 3.2.0
+ */
+export interface GetTenantsInput extends PagedAndSortedResultRequestDto {
+    /** Filter string to search tenants by name */
+    filter: string;
+}
+/**
+ * Base DTO for tenant create and update operations.
+ * Extends ExtensibleObject for extra properties support.
+ * @since 3.2.0
+ */
+export interface TenantCreateOrUpdateDtoBase extends ExtensibleObject {
+    /** The name of the tenant */
+    name: string;
+}
+/**
+ * DTO for creating a new tenant.
+ * Extends TenantCreateOrUpdateDtoBase with admin credentials.
+ * @since 3.2.0
+ */
+export interface TenantCreateDto extends TenantCreateOrUpdateDtoBase {
+    /** Admin email address for the new tenant */
+    adminEmailAddress: string;
+    /** Admin password for the new tenant */
+    adminPassword: string;
+}
+/**
+ * DTO for updating an existing tenant.
+ * Extends TenantCreateOrUpdateDtoBase (only name is updatable).
+ * @since 3.2.0
+ */
+export interface TenantUpdateDto extends TenantCreateOrUpdateDtoBase {
+}
+/**
+ * DTO representing a tenant entity.
+ * Extends ExtensibleEntityDto with string ID.
+ * @since 3.2.0
+ */
+export interface TenantDto extends ExtensibleEntityDto<string> {
+    /** The name of the tenant */
+    name: string;
+}

package/dist/proxy/tenant.service.d.ts

@@ -0,0 +1,101 @@
+/**
+ * Tenant Service - Typed proxy service for Tenant Management API
+ * Translated from @abp/ng.tenant-management v3.2.0 lib/proxy/tenant.service.d.ts
+ *
+ * This service provides strongly-typed API methods for tenant management operations.
+ * It replaces the legacy TenantManagementService with modern proxy patterns.
+ *
+ * @since 3.2.0
+ */
+import { RestService, PagedResultDto } from '@abpjs/core';
+import type { GetTenantsInput, TenantCreateDto, TenantDto, TenantUpdateDto } from './models';
+/**
+ * Typed proxy service for Tenant Management API operations.
+ * Provides CRUD operations for tenants with strongly-typed request/response DTOs.
+ *
+ * @example
+ * ```typescript
+ * import { TenantService } from '@abpjs/tenant-management';
+ * import { getRestService } from '@abpjs/core';
+ *
+ * const tenantService = new TenantService(getRestService());
+ *
+ * // Get list of tenants
+ * const result = await tenantService.getList({ filter: '', maxResultCount: 10, skipCount: 0 });
+ *
+ * // Create a new tenant
+ * const tenant = await tenantService.create({
+ *   name: 'MyTenant',
+ *   adminEmailAddress: 'admin@mytenant.com',
+ *   adminPassword: 'SecurePassword123!'
+ * });
+ *
+ * // Update a tenant
+ * await tenantService.update(tenant.id, { name: 'UpdatedName' });
+ *
+ * // Delete a tenant
+ * await tenantService.delete(tenant.id);
+ * ```
+ *
+ * @since 3.2.0
+ */
+export declare class TenantService {
+    private restService;
+    /**
+     * The API name used for REST requests.
+     * Defaults to 'default' for the main API.
+     */
+    apiName: string;
+    constructor(restService: RestService);
+    /**
+     * Create a new tenant.
+     * @param input - The tenant creation data including admin credentials
+     * @returns Promise resolving to the created tenant DTO
+     */
+    create: (input: TenantCreateDto) => Promise<TenantDto>;
+    /**
+     * Delete a tenant by ID.
+     * @param id - The tenant ID to delete
+     * @returns Promise resolving when deletion is complete
+     */
+    delete: (id: string) => Promise<void>;
+    /**
+     * Delete the default connection string for a tenant.
+     * This will cause the tenant to use the shared/host database.
+     * @param id - The tenant ID
+     * @returns Promise resolving when deletion is complete
+     */
+    deleteDefaultConnectionString: (id: string) => Promise<void>;
+    /**
+     * Get a tenant by ID.
+     * @param id - The tenant ID
+     * @returns Promise resolving to the tenant DTO
+     */
+    get: (id: string) => Promise<TenantDto>;
+    /**
+     * Get the default connection string for a tenant.
+     * @param id - The tenant ID
+     * @returns Promise resolving to the connection string (empty if using shared database)
+     */
+    getDefaultConnectionString: (id: string) => Promise<string>;
+    /**
+     * Get a paginated list of tenants.
+     * @param input - The query parameters including filter, pagination, and sorting
+     * @returns Promise resolving to a paged result of tenant DTOs
+     */
+    getList: (input: GetTenantsInput) => Promise<PagedResultDto<TenantDto>>;
+    /**
+     * Update a tenant.
+     * @param id - The tenant ID to update
+     * @param input - The update data (currently only name can be updated)
+     * @returns Promise resolving to the updated tenant DTO
+     */
+    update: (id: string, input: TenantUpdateDto) => Promise<TenantDto>;
+    /**
+     * Update the default connection string for a tenant.
+     * @param id - The tenant ID
+     * @param defaultConnectionString - The new connection string
+     * @returns Promise resolving when update is complete
+     */
+    updateDefaultConnectionString: (id: string, defaultConnectionString: string) => Promise<void>;
+}

package/dist/services/index.d.ts

@@ -1,2 +1,3 @@
 export { TenantManagementService } from './tenant-management.service';
 export { TenantManagementStateService, getTenantManagementStateService, } from './tenant-management-state.service';
+export { TenantService } from '../proxy/tenant.service';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abpjs/tenant-management",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "description": "ABP Framework tenant-management components for React - translated from @abp/ng.tenant-management",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -23,11 +23,11 @@
   "dependencies": {
     "@chakra-ui/react": "^3.2.0",
     "@emotion/react": "^11.11.0",
-    "@abpjs/core": "3.0.0",
-    "@abpjs/theme-shared": "3.0.0"
+    "@abpjs/core": "3.2.0",
+    "@abpjs/theme-shared": "3.2.0"
   },
   "devDependencies": {
-    "@abp/ng.tenant-management": "3.0.0",
+    "@abp/ng.tenant-management": "3.2.0",
     "@testing-library/jest-dom": "^6.4.0",
     "@testing-library/react": "^14.2.0",
     "@types/react": "^18.2.0",