@abpjs/saas 2.9.0 → 3.1.0

package/dist/index.d.mts

@@ -1,6 +1,118 @@
-import { ABP, RestService } from '@abpjs/core';
+import { ABP, RoutesService, RestService } from '@abpjs/core';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
+/**
+ * SaaS Policy Names
+ * Translated from @volo/abp.ng.saas/config v3.0.0
+ *
+ * Policy name constants for SaaS module permission checking.
+ * @since 3.0.0
+ */
+/**
+ * Enum-like const object for SaaS policy names.
+ * Used for permission checking in SaaS module.
+ * @since 3.0.0
+ */
+declare const eSaasPolicyNames: {
+    /** Policy for SaaS module (Tenants OR Editions) */
+    readonly Saas: "Saas.Tenants || Saas.Editions";
+    /** Policy for Tenants management */
+    readonly Tenants: "Saas.Tenants";
+    /** Policy for Editions management */
+    readonly Editions: "Saas.Editions";
+};
+/**
+ * Type for SaaS policy name values
+ * @since 3.0.0
+ */
+type SaasPolicyNameKey = (typeof eSaasPolicyNames)[keyof typeof eSaasPolicyNames];
+
+/**
+ * SaaS Route Names
+ * Translated from @volo/abp.ng.saas/config v3.0.0
+ *
+ * Route name localization keys for SaaS module navigation.
+ * @since 3.0.0 (moved from lib/enums to config/enums)
+ *
+ * Breaking changes in v3.0.0:
+ * - Removed 'Administration' key
+ */
+/**
+ * Enum-like const object for SaaS route names.
+ * Used for localization and navigation configuration.
+ *
+ * @since 2.7.0
+ * @updated 3.0.0 - Removed Administration key, moved to config subpackage
+ */
+declare const eSaasRouteNames: {
+    /** SaaS menu route name */
+    readonly Saas: "Saas::Menu:Saas";
+    /** Tenants route name */
+    readonly Tenants: "Saas::Tenants";
+    /** Editions route name */
+    readonly Editions: "Saas::Editions";
+};
+/**
+ * Type for SaaS route name values
+ * @since 2.7.0
+ */
+type SaasRouteNameKey = (typeof eSaasRouteNames)[keyof typeof eSaasRouteNames];
+
+/**
+ * SaaS Route Provider
+ * Translated from @volo/abp.ng.saas/config v3.0.0
+ *
+ * Provides route configuration functionality for SaaS module.
+ * @since 3.0.0
+ */
+
+/**
+ * Default SaaS route configuration
+ * @since 3.0.0
+ */
+declare const SAAS_ROUTE_CONFIG: ABP.Route;
+/**
+ * Configure SaaS routes
+ * @param routes - The routes service instance
+ * @returns A function that adds SaaS routes
+ * @since 3.0.0
+ */
+declare function configureRoutes(routes: RoutesService): () => void;
+/**
+ * Initialize SaaS routes
+ * Helper function to immediately configure routes
+ * @param routes - The routes service instance
+ * @since 3.0.0
+ */
+declare function initializeSaasRoutes(routes: RoutesService): void;
+/**
+ * SaaS route providers configuration object
+ * React equivalent of Angular's APP_INITIALIZER pattern
+ * @since 3.0.0
+ */
+declare const SAAS_ROUTE_PROVIDERS: {
+    /** Configure function factory */
+    useFactory: typeof configureRoutes;
+    /** Dependencies required by the factory */
+    deps: readonly ["RoutesService"];
+};
+
+/**
+ * SaaS Component Identifiers
+ * Used for component registration and routing
+ *
+ * @since 2.4.0
+ * @updated 2.7.0 - Changed from enum to const object
+ */
+declare const eSaasComponents: {
+    readonly Editions: "Saas.EditionsComponent";
+    readonly Tenants: "Saas.TenantsComponent";
+};
+/**
+ * Type for SaaS component key values
+ */
+type SaasComponentKey = (typeof eSaasComponents)[keyof typeof eSaasComponents];
+
 /**
  * SaaS Models
  * Translated from @volo/abp.ng.saas v2.4.0
@@ -105,6 +217,315 @@ declare namespace Saas {
     }
 }
 
+/**
+ * SaaS Extension Tokens
+ * Translated from @volo/abp.ng.saas v3.0.0
+ *
+ * Default entity actions, toolbar actions, entity props, and form props
+ * for the SaaS module extensibility system.
+ *
+ * @since 3.0.0
+ */
+
+/**
+ * Entity action type for extensibility
+ * @since 3.0.0
+ */
+interface EntityAction<T = unknown> {
+    text: string;
+    action?: (record: T) => void;
+    permission?: string;
+    visible?: (record: T) => boolean;
+    icon?: string;
+}
+/**
+ * Toolbar action type for extensibility
+ * @since 3.0.0
+ */
+interface ToolbarAction<T = unknown> {
+    text: string;
+    action?: (data: T) => void;
+    permission?: string;
+    visible?: (data: T) => boolean;
+    icon?: string;
+}
+/**
+ * Entity prop type for extensibility
+ * @since 3.0.0
+ */
+interface EntityProp<T = unknown> {
+    name: string;
+    displayName?: string;
+    sortable?: boolean;
+    valueResolver?: (record: T) => string | number | boolean | null | undefined;
+    permission?: string;
+    visible?: boolean;
+}
+/**
+ * Form prop type for extensibility
+ * @since 3.0.0
+ */
+interface FormProp<T = unknown> {
+    name: string;
+    displayName?: string;
+    type?: 'string' | 'number' | 'boolean' | 'date' | 'select' | 'textarea';
+    defaultValue?: unknown;
+    validators?: Array<{
+        type: string;
+        value?: unknown;
+        message?: string;
+    }>;
+    options?: Array<{
+        label: string;
+        value: unknown;
+    }>;
+    permission?: string;
+    visible?: boolean | ((record?: T) => boolean);
+}
+/**
+ * Default entity actions for Editions component
+ * @since 3.0.0
+ */
+declare const DEFAULT_EDITIONS_ENTITY_ACTIONS: EntityAction<Saas.Edition>[];
+/**
+ * Default entity actions for Tenants component
+ * @since 3.0.0
+ */
+declare const DEFAULT_TENANTS_ENTITY_ACTIONS: EntityAction<Saas.Tenant>[];
+/**
+ * Default entity actions aggregated by component
+ * @since 3.0.0
+ */
+declare const DEFAULT_SAAS_ENTITY_ACTIONS: {
+    readonly "Saas.EditionsComponent": EntityAction<Saas.Edition>[];
+    readonly "Saas.TenantsComponent": EntityAction<Saas.Tenant>[];
+};
+/**
+ * Default toolbar actions for Editions component
+ * @since 3.0.0
+ */
+declare const DEFAULT_EDITIONS_TOOLBAR_ACTIONS: ToolbarAction<Saas.Edition[]>[];
+/**
+ * Default toolbar actions for Tenants component
+ * @since 3.0.0
+ */
+declare const DEFAULT_TENANTS_TOOLBAR_ACTIONS: ToolbarAction<Saas.Tenant[]>[];
+/**
+ * Default toolbar actions aggregated by component
+ * @since 3.0.0
+ */
+declare const DEFAULT_SAAS_TOOLBAR_ACTIONS: {
+    readonly "Saas.EditionsComponent": ToolbarAction<Saas.Edition[]>[];
+    readonly "Saas.TenantsComponent": ToolbarAction<Saas.Tenant[]>[];
+};
+/**
+ * Default entity props for Editions component
+ * @since 3.0.0
+ */
+declare const DEFAULT_EDITIONS_ENTITY_PROPS: EntityProp<Saas.Edition>[];
+/**
+ * Default entity props for Tenants component
+ * @since 3.0.0
+ */
+declare const DEFAULT_TENANTS_ENTITY_PROPS: EntityProp<Saas.Tenant>[];
+/**
+ * Default entity props aggregated by component
+ * @since 3.0.0
+ */
+declare const DEFAULT_SAAS_ENTITY_PROPS: {
+    readonly "Saas.EditionsComponent": EntityProp<Saas.Edition>[];
+    readonly "Saas.TenantsComponent": EntityProp<Saas.Tenant>[];
+};
+/**
+ * Default create form props for Editions component
+ * @since 3.0.0
+ */
+declare const DEFAULT_EDITIONS_CREATE_FORM_PROPS: FormProp<Saas.Edition>[];
+/**
+ * Default create form props for Tenants component
+ * @since 3.0.0
+ */
+declare const DEFAULT_TENANTS_CREATE_FORM_PROPS: FormProp<Saas.Tenant>[];
+/**
+ * Default create form props aggregated by component
+ * @since 3.0.0
+ */
+declare const DEFAULT_SAAS_CREATE_FORM_PROPS: {
+    readonly "Saas.EditionsComponent": FormProp<Saas.Edition>[];
+    readonly "Saas.TenantsComponent": FormProp<Saas.Tenant>[];
+};
+/**
+ * Default edit form props for Editions component
+ * @since 3.0.0
+ */
+declare const DEFAULT_EDITIONS_EDIT_FORM_PROPS: FormProp<Saas.Edition>[];
+/**
+ * Default edit form props for Tenants component
+ * @since 3.0.0
+ */
+declare const DEFAULT_TENANTS_EDIT_FORM_PROPS: FormProp<Saas.Tenant>[];
+/**
+ * Default edit form props aggregated by component
+ * @since 3.0.0
+ */
+declare const DEFAULT_SAAS_EDIT_FORM_PROPS: {
+    readonly "Saas.EditionsComponent": FormProp<Saas.Edition>[];
+    readonly "Saas.TenantsComponent": FormProp<Saas.Tenant>[];
+};
+/**
+ * Entity action contributor callback type
+ * @since 3.0.0
+ */
+type EntityActionContributorCallback<T> = (actions: EntityAction<T>[]) => EntityAction<T>[];
+/**
+ * Toolbar action contributor callback type
+ * @since 3.0.0
+ */
+type ToolbarActionContributorCallback<T> = (actions: ToolbarAction<T>[]) => ToolbarAction<T>[];
+/**
+ * Entity prop contributor callback type
+ * @since 3.0.0
+ */
+type EntityPropContributorCallback<T> = (props: EntityProp<T>[]) => EntityProp<T>[];
+/**
+ * Create form prop contributor callback type
+ * @since 3.0.0
+ */
+type CreateFormPropContributorCallback<T> = (props: FormProp<T>[]) => FormProp<T>[];
+/**
+ * Edit form prop contributor callback type
+ * @since 3.0.0
+ */
+type EditFormPropContributorCallback<T> = (props: FormProp<T>[]) => FormProp<T>[];
+/**
+ * Token for entity action contributors
+ * React equivalent of Angular InjectionToken
+ * @since 3.0.0
+ */
+declare const SAAS_ENTITY_ACTION_CONTRIBUTORS: unique symbol;
+/**
+ * Token for toolbar action contributors
+ * React equivalent of Angular InjectionToken
+ * @since 3.0.0
+ */
+declare const SAAS_TOOLBAR_ACTION_CONTRIBUTORS: unique symbol;
+/**
+ * Token for entity prop contributors
+ * React equivalent of Angular InjectionToken
+ * @since 3.0.0
+ */
+declare const SAAS_ENTITY_PROP_CONTRIBUTORS: unique symbol;
+/**
+ * Token for create form prop contributors
+ * React equivalent of Angular InjectionToken
+ * @since 3.0.0
+ */
+declare const SAAS_CREATE_FORM_PROP_CONTRIBUTORS: unique symbol;
+/**
+ * Token for edit form prop contributors
+ * React equivalent of Angular InjectionToken
+ * @since 3.0.0
+ */
+declare const SAAS_EDIT_FORM_PROP_CONTRIBUTORS: unique symbol;
+
+/**
+ * SaaS Config Options
+ * Translated from @volo/abp.ng.saas v3.0.0
+ *
+ * Configuration options for SaaS module extensibility.
+ *
+ * @since 3.0.0
+ */
+
+/**
+ * SaaS entity action contributors type
+ * Maps component keys to their entity action contributor callbacks
+ * @since 3.0.0
+ */
+type SaasEntityActionContributors = Partial<{
+    [eSaasComponents.Editions]: EntityActionContributorCallback<Saas.Edition>[];
+    [eSaasComponents.Tenants]: EntityActionContributorCallback<Saas.Tenant>[];
+}>;
+/**
+ * SaaS toolbar action contributors type
+ * Maps component keys to their toolbar action contributor callbacks
+ * @since 3.0.0
+ */
+type SaasToolbarActionContributors = Partial<{
+    [eSaasComponents.Editions]: ToolbarActionContributorCallback<Saas.Edition[]>[];
+    [eSaasComponents.Tenants]: ToolbarActionContributorCallback<Saas.Tenant[]>[];
+}>;
+/**
+ * SaaS entity prop contributors type
+ * Maps component keys to their entity prop contributor callbacks
+ * @since 3.0.0
+ */
+type SaasEntityPropContributors = Partial<{
+    [eSaasComponents.Editions]: EntityPropContributorCallback<Saas.Edition>[];
+    [eSaasComponents.Tenants]: EntityPropContributorCallback<Saas.Tenant>[];
+}>;
+/**
+ * SaaS create form prop contributors type
+ * Maps component keys to their create form prop contributor callbacks
+ * @since 3.0.0
+ */
+type SaasCreateFormPropContributors = Partial<{
+    [eSaasComponents.Editions]: CreateFormPropContributorCallback<Saas.Edition>[];
+    [eSaasComponents.Tenants]: CreateFormPropContributorCallback<Saas.Tenant>[];
+}>;
+/**
+ * SaaS edit form prop contributors type
+ * Maps component keys to their edit form prop contributor callbacks
+ * @since 3.0.0
+ */
+type SaasEditFormPropContributors = Partial<{
+    [eSaasComponents.Editions]: EditFormPropContributorCallback<Saas.Edition>[];
+    [eSaasComponents.Tenants]: EditFormPropContributorCallback<Saas.Tenant>[];
+}>;
+/**
+ * SaaS module configuration options
+ * Used to customize the SaaS module behavior through contributors
+ * @since 3.0.0
+ *
+ * @example
+ * ```tsx
+ * const options: SaasConfigOptions = {
+ *   entityActionContributors: {
+ *     [eSaasComponents.Tenants]: [
+ *       (actions) => [...actions, { text: 'Custom Action', icon: 'fa fa-star' }]
+ *     ]
+ *   },
+ *   entityPropContributors: {
+ *     [eSaasComponents.Tenants]: [
+ *       (props) => [...props, { name: 'customField', displayName: 'Custom' }]
+ *     ]
+ *   }
+ * };
+ * ```
+ */
+interface SaasConfigOptions {
+    /**
+     * Entity action contributors for customizing row actions
+     */
+    entityActionContributors?: SaasEntityActionContributors;
+    /**
+     * Toolbar action contributors for customizing toolbar buttons
+     */
+    toolbarActionContributors?: SaasToolbarActionContributors;
+    /**
+     * Entity prop contributors for customizing table columns
+     */
+    entityPropContributors?: SaasEntityPropContributors;
+    /**
+     * Create form prop contributors for customizing create form fields
+     */
+    createFormPropContributors?: SaasCreateFormPropContributors;
+    /**
+     * Edit form prop contributors for customizing edit form fields
+     */
+    editFormPropContributors?: SaasEditFormPropContributors;
+}
+
 /**
  * SaaS Routes
  * Translated from @volo/abp.ng.saas v0.7.2
@@ -118,40 +539,72 @@ declare const SAAS_ROUTES: {
 };
 
 /**
- * SaaS Component Identifiers
- * Used for component registration and routing
+ * SaaS Extensions Guard
+ * Translated from @volo/abp.ng.saas v3.0.0
  *
- * @since 2.4.0
- * @updated 2.7.0 - Changed from enum to const object
- */
-declare const eSaasComponents: {
-    readonly Editions: "Saas.EditionsComponent";
-    readonly Tenants: "Saas.TenantsComponent";
-};
-/**
- * Type for SaaS component key values
+ * Guard for protecting SaaS routes and ensuring extensions are loaded.
+ *
+ * @since 3.0.0
  */
-type SaasComponentKey = (typeof eSaasComponents)[keyof typeof eSaasComponents];
-
 /**
- * SaaS Route Names
- * Translated from @volo/abp.ng.saas v2.7.0
+ * SaaS extensions guard function
+ * Async guard function that can be used for route protection.
+ *
+ * @returns Promise<boolean> - True if navigation should proceed
+ * @since 3.0.0
+ *
+ * @example
+ * ```tsx
+ * // In route configuration
+ * const canActivate = await saasExtensionsGuard();
+ * if (canActivate) {
+ *   // Proceed with navigation
+ * }
+ * ```
  */
+declare function saasExtensionsGuard(): Promise<boolean>;
 /**
- * Enum-like const object for SaaS route names.
- * Used for localization and navigation configuration.
- * @since 2.7.0
+ * Hook for SaaS extensions guard state
+ * Provides reactive state for extension loading.
+ *
+ * @returns Object with isLoaded and loading state
+ * @since 3.0.0
+ *
+ * @example
+ * ```tsx
+ * function ProtectedRoute({ children }) {
+ *   const { isLoaded, loading } = useSaasExtensionsGuard();
+ *
+ *   if (loading) return <Loading />;
+ *   if (!isLoaded) return <Navigate to="/unauthorized" />;
+ *
+ *   return children;
+ * }
+ * ```
  */
-declare const eSaasRouteNames: {
-    readonly Administration: "AbpUiNavigation::Menu:Administration";
-    readonly Saas: "Saas::Menu:Saas";
-    readonly Tenants: "Saas::Tenants";
-    readonly Editions: "Saas::Editions";
+declare function useSaasExtensionsGuard(): {
+    isLoaded: boolean;
+    loading: boolean;
 };
 /**
- * Type for SaaS route name values
+ * SaaS Extensions Guard class
+ * Class-based guard implementation for compatibility with Angular patterns.
+ *
+ * @since 3.0.0
+ *
+ * @example
+ * ```tsx
+ * const guard = new SaasExtensionsGuard();
+ * const canActivate = await guard.canActivate();
+ * ```
  */
-type SaasRouteNameKey = (typeof eSaasRouteNames)[keyof typeof eSaasRouteNames];
+declare class SaasExtensionsGuard {
+    /**
+     * Check if the route can be activated
+     * @returns Promise<boolean> - True if navigation should proceed
+     */
+    canActivate(): Promise<boolean>;
+}
 
 /**
  * SaaS Service
@@ -659,4 +1112,4 @@ interface EditionsComponentProps {
  */
 declare function EditionsComponent({ onEditionCreated, onEditionUpdated, onEditionDeleted, onManageFeatures, }: EditionsComponentProps): react_jsx_runtime.JSX.Element;
 
-export { type EditionOperationResult, EditionsComponent, type EditionsComponentProps, SAAS_ROUTES, Saas, type SaasComponentKey, type SaasRouteNameKey, SaasService, SaasStateService, type SortOrder$1 as SortOrder, type TenantOperationResult, TenantsComponent, type TenantsComponentProps, type UseEditionsReturn, type UseTenantsReturn, eSaasComponents, eSaasRouteNames, useEditions, useTenants };
+export { type CreateFormPropContributorCallback, DEFAULT_EDITIONS_CREATE_FORM_PROPS, DEFAULT_EDITIONS_EDIT_FORM_PROPS, DEFAULT_EDITIONS_ENTITY_ACTIONS, DEFAULT_EDITIONS_ENTITY_PROPS, DEFAULT_EDITIONS_TOOLBAR_ACTIONS, DEFAULT_SAAS_CREATE_FORM_PROPS, DEFAULT_SAAS_EDIT_FORM_PROPS, DEFAULT_SAAS_ENTITY_ACTIONS, DEFAULT_SAAS_ENTITY_PROPS, DEFAULT_SAAS_TOOLBAR_ACTIONS, DEFAULT_TENANTS_CREATE_FORM_PROPS, DEFAULT_TENANTS_EDIT_FORM_PROPS, DEFAULT_TENANTS_ENTITY_ACTIONS, DEFAULT_TENANTS_ENTITY_PROPS, DEFAULT_TENANTS_TOOLBAR_ACTIONS, type EditFormPropContributorCallback, type EditionOperationResult, EditionsComponent, type EditionsComponentProps, type EntityAction, type EntityActionContributorCallback, type EntityProp, type EntityPropContributorCallback, type FormProp, SAAS_CREATE_FORM_PROP_CONTRIBUTORS, SAAS_EDIT_FORM_PROP_CONTRIBUTORS, SAAS_ENTITY_ACTION_CONTRIBUTORS, SAAS_ENTITY_PROP_CONTRIBUTORS, SAAS_ROUTES, SAAS_ROUTE_CONFIG, SAAS_ROUTE_PROVIDERS, SAAS_TOOLBAR_ACTION_CONTRIBUTORS, Saas, type SaasComponentKey, type SaasConfigOptions, type SaasCreateFormPropContributors, type SaasEditFormPropContributors, type SaasEntityActionContributors, type SaasEntityPropContributors, SaasExtensionsGuard, type SaasPolicyNameKey, type SaasRouteNameKey, SaasService, SaasStateService, type SaasToolbarActionContributors, type SortOrder$1 as SortOrder, type TenantOperationResult, TenantsComponent, type TenantsComponentProps, type ToolbarAction, type ToolbarActionContributorCallback, type UseEditionsReturn, type UseTenantsReturn, configureRoutes, eSaasComponents, eSaasPolicyNames, eSaasRouteNames, initializeSaasRoutes, saasExtensionsGuard, useEditions, useSaasExtensionsGuard, useTenants };