@abpjs/saas 0.7.2

package/dist/index.d.ts

@@ -0,0 +1,470 @@
+import { ABP, RestService } from '@abpjs/core';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+/**
+ * SaaS Models
+ * Translated from @volo/abp.ng.saas v0.7.2
+ */
+
+/**
+ * Saas namespace containing all models for SaaS management
+ */
+declare namespace Saas {
+    /**
+     * State interface for SaaS
+     */
+    interface State {
+        tenants: ABP.PagedResponse<Tenant>;
+        editions: ABP.PagedResponse<Edition>;
+        usageStatistics: Record<string, number>;
+        latestTenants: Tenant[];
+    }
+    /**
+     * Tenant interface
+     */
+    interface Tenant {
+        id: string;
+        name: string;
+        editionId?: string;
+        editionName?: string;
+        concurrencyStamp?: string;
+    }
+    /**
+     * Edition interface
+     */
+    interface Edition {
+        id: string;
+        displayName: string;
+        concurrencyStamp?: string;
+    }
+    /**
+     * Query parameters for fetching tenants
+     */
+    interface TenantsQueryParams extends ABP.PageQueryParams {
+        filter?: string;
+        editionId?: string;
+        getEditionNames?: boolean;
+    }
+    /**
+     * Query parameters for fetching editions
+     */
+    interface EditionsQueryParams extends ABP.PageQueryParams {
+        filter?: string;
+    }
+    /**
+     * Create tenant request
+     */
+    interface CreateTenantRequest {
+        name: string;
+        editionId?: string;
+        adminEmailAddress?: string;
+        adminPassword?: string;
+    }
+    /**
+     * Update tenant request
+     */
+    interface UpdateTenantRequest {
+        id?: string;
+        name: string;
+        editionId?: string;
+        concurrencyStamp?: string;
+    }
+    /**
+     * Create edition request
+     */
+    interface CreateEditionRequest {
+        displayName: string;
+    }
+    /**
+     * Update edition request
+     */
+    interface UpdateEditionRequest {
+        id?: string;
+        displayName: string;
+        concurrencyStamp?: string;
+    }
+    /**
+     * Default connection string request
+     */
+    interface DefaultConnectionStringRequest {
+        id: string;
+        defaultConnectionString: string;
+    }
+    /**
+     * Paginated response for tenants
+     */
+    type TenantsResponse = ABP.PagedResponse<Tenant>;
+    /**
+     * Paginated response for editions
+     */
+    type EditionsResponse = ABP.PagedResponse<Edition>;
+    /**
+     * Usage statistics response
+     */
+    interface UsageStatisticsResponse {
+        data: Record<string, number>;
+    }
+}
+
+/**
+ * SaaS Routes
+ * Translated from @volo/abp.ng.saas v0.7.2
+ */
+
+/**
+ * Default routes for SaaS module
+ */
+declare const SAAS_ROUTES: {
+    routes: ABP.FullRoute[];
+};
+
+/**
+ * SaaS Service
+ * Translated from @volo/abp.ng.saas v0.7.2
+ *
+ * Provides REST API methods for managing tenants, editions,
+ * and connection strings in a multi-tenant SaaS application.
+ */
+
+/**
+ * Service for SaaS operations including tenant and edition management.
+ * This service wraps all REST API calls for the SaaS module.
+ *
+ * @since 0.7.2
+ */
+declare class SaasService {
+    private restService;
+    constructor(restService: RestService);
+    /**
+     * Get paginated list of tenants
+     * @param params Query parameters for filtering and pagination
+     * @returns Promise with paginated tenant response
+     */
+    getTenants(params?: Saas.TenantsQueryParams): Promise<Saas.TenantsResponse>;
+    /**
+     * Get a tenant by ID
+     * @param id Tenant ID
+     * @returns Promise with tenant data
+     */
+    getTenantById(id: string): Promise<Saas.Tenant>;
+    /**
+     * Create a new tenant
+     * @param body Tenant creation request
+     * @returns Promise with created tenant data
+     */
+    createTenant(body: Saas.CreateTenantRequest): Promise<Saas.Tenant>;
+    /**
+     * Update an existing tenant
+     * @param body Tenant update request (must include id)
+     * @returns Promise with updated tenant data
+     */
+    updateTenant(body: Saas.UpdateTenantRequest): Promise<Saas.Tenant>;
+    /**
+     * Delete a tenant by ID
+     * @param id Tenant ID to delete
+     * @returns Promise that resolves when deletion is complete
+     */
+    deleteTenant(id: string): Promise<void>;
+    /**
+     * Get the default connection string for a tenant
+     * @param id Tenant ID
+     * @returns Promise with connection string (empty string if using shared database)
+     */
+    getDefaultConnectionString(id: string): Promise<string>;
+    /**
+     * Update the default connection string for a tenant
+     * @param payload Object containing tenant ID and connection string
+     * @returns Promise that resolves when update is complete
+     */
+    updateDefaultConnectionString(payload: Saas.DefaultConnectionStringRequest): Promise<void>;
+    /**
+     * Delete the default connection string for a tenant (revert to shared database)
+     * @param id Tenant ID
+     * @returns Promise that resolves when deletion is complete
+     */
+    deleteDefaultConnectionString(id: string): Promise<void>;
+    /**
+     * Get paginated list of editions
+     * @param params Query parameters for filtering and pagination
+     * @returns Promise with paginated editions response
+     */
+    getEditions(params?: Saas.EditionsQueryParams): Promise<Saas.EditionsResponse>;
+    /**
+     * Get an edition by ID
+     * @param id Edition ID
+     * @returns Promise with edition data
+     */
+    getEditionById(id: string): Promise<Saas.Edition>;
+    /**
+     * Create a new edition
+     * @param body Edition creation request
+     * @returns Promise with created edition data
+     */
+    createEdition(body: Saas.CreateEditionRequest): Promise<Saas.Edition>;
+    /**
+     * Update an existing edition
+     * @param body Edition update request (must include id)
+     * @returns Promise with updated edition data
+     */
+    updateEdition(body: Saas.UpdateEditionRequest): Promise<Saas.Edition>;
+    /**
+     * Delete an edition by ID
+     * @param id Edition ID to delete
+     * @returns Promise that resolves when deletion is complete
+     */
+    deleteEdition(id: string): Promise<void>;
+    /**
+     * Get usage statistics for editions
+     * @returns Promise with usage statistics data
+     */
+    getUsageStatistics(): Promise<Saas.UsageStatisticsResponse>;
+}
+
+/**
+ * useTenants Hook
+ * Translated from @volo/abp.ng.saas v0.7.2
+ */
+
+/**
+ * Sort order type for tenant lists
+ */
+type SortOrder$1 = '' | 'asc' | 'desc';
+/**
+ * Result from tenant operations
+ * @since 0.7.2
+ */
+interface TenantOperationResult<T = void> {
+    success: boolean;
+    data?: T;
+    error?: string;
+}
+/**
+ * Return type for useTenants hook
+ * @since 0.7.2
+ */
+interface UseTenantsReturn {
+    /** List of tenants */
+    tenants: Saas.Tenant[];
+    /** Total count of tenants */
+    totalCount: number;
+    /** Currently selected tenant for editing */
+    selectedTenant: Saas.Tenant | null;
+    /** Loading state */
+    isLoading: boolean;
+    /** Error message if any */
+    error: string | null;
+    /** Current sort key */
+    sortKey: string;
+    /** Current sort order */
+    sortOrder: SortOrder$1;
+    /** Default connection string for selected tenant */
+    defaultConnectionString: string;
+    /** Whether the tenant uses shared database */
+    useSharedDatabase: boolean;
+    /** Fetch all tenants with optional pagination/filtering */
+    fetchTenants: (params?: Saas.TenantsQueryParams) => Promise<TenantOperationResult<Saas.TenantsResponse>>;
+    /** Get a tenant by ID and set it as selected */
+    getTenantById: (id: string) => Promise<TenantOperationResult<Saas.Tenant>>;
+    /** Create a new tenant */
+    createTenant: (tenant: Saas.CreateTenantRequest) => Promise<TenantOperationResult<Saas.Tenant>>;
+    /** Update an existing tenant */
+    updateTenant: (tenant: Saas.UpdateTenantRequest) => Promise<TenantOperationResult<Saas.Tenant>>;
+    /** Delete a tenant */
+    deleteTenant: (id: string) => Promise<TenantOperationResult>;
+    /** Get the default connection string for a tenant */
+    getDefaultConnectionString: (id: string) => Promise<TenantOperationResult<string>>;
+    /** Update the default connection string */
+    updateDefaultConnectionString: (payload: Saas.DefaultConnectionStringRequest) => Promise<TenantOperationResult>;
+    /** Delete the default connection string (use shared database) */
+    deleteDefaultConnectionString: (id: string) => Promise<TenantOperationResult>;
+    /** Set the selected tenant */
+    setSelectedTenant: (tenant: Saas.Tenant | null) => void;
+    /** Set sort key */
+    setSortKey: (key: string) => void;
+    /** Set sort order */
+    setSortOrder: (order: SortOrder$1) => void;
+    /** Reset state */
+    reset: () => void;
+}
+/**
+ * Hook for managing tenants
+ *
+ * This hook provides all the state and actions needed for tenant management
+ * including CRUD operations and connection string management.
+ *
+ * @since 0.7.2
+ *
+ * @example
+ * ```tsx
+ * function TenantsPage() {
+ *   const {
+ *     tenants,
+ *     isLoading,
+ *     fetchTenants,
+ *     createTenant,
+ *     deleteTenant,
+ *   } = useTenants();
+ *
+ *   useEffect(() => {
+ *     fetchTenants();
+ *   }, [fetchTenants]);
+ *
+ *   return (
+ *     <div>
+ *       {tenants.map(tenant => (
+ *         <div key={tenant.id}>{tenant.name}</div>
+ *       ))}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useTenants(): UseTenantsReturn;
+
+/**
+ * useEditions Hook
+ * Translated from @volo/abp.ng.saas v0.7.2
+ */
+
+/**
+ * Sort order type for edition lists
+ */
+type SortOrder = '' | 'asc' | 'desc';
+/**
+ * Result from edition operations
+ * @since 0.7.2
+ */
+interface EditionOperationResult<T = void> {
+    success: boolean;
+    data?: T;
+    error?: string;
+}
+/**
+ * Return type for useEditions hook
+ * @since 0.7.2
+ */
+interface UseEditionsReturn {
+    /** List of editions */
+    editions: Saas.Edition[];
+    /** Total count of editions */
+    totalCount: number;
+    /** Currently selected edition for editing */
+    selectedEdition: Saas.Edition | null;
+    /** Loading state */
+    isLoading: boolean;
+    /** Error message if any */
+    error: string | null;
+    /** Current sort key */
+    sortKey: string;
+    /** Current sort order */
+    sortOrder: SortOrder;
+    /** Usage statistics for editions */
+    usageStatistics: Record<string, number>;
+    /** Fetch all editions with optional pagination/filtering */
+    fetchEditions: (params?: Saas.EditionsQueryParams) => Promise<EditionOperationResult<Saas.EditionsResponse>>;
+    /** Get an edition by ID and set it as selected */
+    getEditionById: (id: string) => Promise<EditionOperationResult<Saas.Edition>>;
+    /** Create a new edition */
+    createEdition: (edition: Saas.CreateEditionRequest) => Promise<EditionOperationResult<Saas.Edition>>;
+    /** Update an existing edition */
+    updateEdition: (edition: Saas.UpdateEditionRequest) => Promise<EditionOperationResult<Saas.Edition>>;
+    /** Delete an edition */
+    deleteEdition: (id: string) => Promise<EditionOperationResult>;
+    /** Fetch usage statistics for editions */
+    fetchUsageStatistics: () => Promise<EditionOperationResult<Record<string, number>>>;
+    /** Set the selected edition */
+    setSelectedEdition: (edition: Saas.Edition | null) => void;
+    /** Set sort key */
+    setSortKey: (key: string) => void;
+    /** Set sort order */
+    setSortOrder: (order: SortOrder) => void;
+    /** Reset state */
+    reset: () => void;
+}
+/**
+ * Hook for managing editions
+ *
+ * This hook provides all the state and actions needed for edition management
+ * including CRUD operations and usage statistics.
+ *
+ * @since 0.7.2
+ *
+ * @example
+ * ```tsx
+ * function EditionsPage() {
+ *   const {
+ *     editions,
+ *     isLoading,
+ *     fetchEditions,
+ *     createEdition,
+ *     deleteEdition,
+ *   } = useEditions();
+ *
+ *   useEffect(() => {
+ *     fetchEditions();
+ *   }, [fetchEditions]);
+ *
+ *   return (
+ *     <div>
+ *       {editions.map(edition => (
+ *         <div key={edition.id}>{edition.displayName}</div>
+ *       ))}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useEditions(): UseEditionsReturn;
+
+/**
+ * Props for TenantsComponent
+ * @since 0.7.2
+ */
+interface TenantsComponentProps {
+    /** Callback when a tenant is created */
+    onTenantCreated?: (tenant: Saas.Tenant) => void;
+    /** Callback when a tenant is updated */
+    onTenantUpdated?: (tenant: Saas.Tenant) => void;
+    /** Callback when a tenant is deleted */
+    onTenantDeleted?: (id: string) => void;
+}
+/**
+ * TenantsComponent - Component for managing tenants
+ *
+ * Features:
+ * - List tenants with pagination
+ * - Create, edit, and delete tenants
+ * - Manage connection strings
+ * - Manage features per tenant
+ *
+ * @since 0.7.2
+ */
+declare function TenantsComponent({ onTenantCreated, onTenantUpdated, onTenantDeleted, }: TenantsComponentProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Props for EditionsComponent
+ * @since 0.7.2
+ */
+interface EditionsComponentProps {
+    /** Callback when an edition is created */
+    onEditionCreated?: (edition: Saas.Edition) => void;
+    /** Callback when an edition is updated */
+    onEditionUpdated?: (edition: Saas.Edition) => void;
+    /** Callback when an edition is deleted */
+    onEditionDeleted?: (id: string) => void;
+    /** Callback when features button is clicked */
+    onManageFeatures?: (editionId: string) => void;
+}
+/**
+ * EditionsComponent - Component for managing editions
+ *
+ * Features:
+ * - List editions with pagination
+ * - Create, edit, and delete editions
+ * - Manage features per edition
+ *
+ * @since 0.7.2
+ */
+declare function EditionsComponent({ onEditionCreated, onEditionUpdated, onEditionDeleted, onManageFeatures, }: EditionsComponentProps): react_jsx_runtime.JSX.Element;
+
+export { type EditionOperationResult, EditionsComponent, type EditionsComponentProps, SAAS_ROUTES, Saas, SaasService, type SortOrder$1 as SortOrder, type TenantOperationResult, TenantsComponent, type TenantsComponentProps, type UseEditionsReturn, type UseTenantsReturn, useEditions, useTenants };