@abpjs/text-template-management 2.9.0 → 3.1.0

package/dist/index.d.mts

@@ -1,6 +1,96 @@
-import { ABP, RestService, PagedResultRequestDto, ListResultDto } from '@abpjs/core';
+import { ABP, RoutesService, RestService, PagedResultRequestDto, ListResultDto } from '@abpjs/core';
 import React from 'react';
 
+/**
+ * Text Template Management Policy Names
+ * Translated from @volo/abp.ng.text-template-management/config v3.0.0
+ *
+ * Policy name constants for Text Template Management module permission checking.
+ * @since 3.0.0
+ */
+/**
+ * Enum-like const object for Text Template Management policy names.
+ * Used for permission checking in Text Template Management module.
+ * @since 3.0.0
+ */
+declare const eTextTemplateManagementPolicyNames: {
+    /** Policy for Text Templates management */
+    readonly TextTemplates: "TextTemplateManagement.TextTemplates";
+};
+/**
+ * Type for Text Template Management policy name values
+ * @since 3.0.0
+ */
+type TextTemplateManagementPolicyNameKey = (typeof eTextTemplateManagementPolicyNames)[keyof typeof eTextTemplateManagementPolicyNames];
+
+/**
+ * Text Template Management Route Names
+ * Translated from @volo/abp.ng.text-template-management/config v3.0.0
+ *
+ * Route name keys for the Text Template Management module.
+ * These keys are used for route localization and identification.
+ *
+ * @since 3.0.0
+ *
+ * Breaking changes in v3.0.0:
+ * - Removed 'Administration' key
+ */
+/**
+ * Enum-like const object for Text Template Management route names.
+ * @since 3.0.0
+ */
+declare const eTextTemplateManagementRouteNames: {
+    /**
+     * Text Templates route name key.
+     * Used for the text templates management route.
+     */
+    readonly TextTemplates: "TextTemplateManagement::Menu:TextTemplates";
+};
+/**
+ * Type for Text Template Management route name key values
+ * @since 3.0.0
+ */
+type TextTemplateManagementRouteNameKey = (typeof eTextTemplateManagementRouteNames)[keyof typeof eTextTemplateManagementRouteNames];
+
+/**
+ * Text Template Management Route Provider
+ * Translated from @volo/abp.ng.text-template-management/config v3.0.0
+ *
+ * Provides route configuration functionality for Text Template Management module.
+ * @since 3.0.0
+ */
+
+/**
+ * Default Text Template Management route configuration
+ * @since 3.0.0
+ */
+declare const TEXT_TEMPLATE_MANAGEMENT_ROUTE_CONFIG: ABP.Route;
+/**
+ * Configure Text Template Management routes
+ * @param routes - The routes service instance
+ * @returns A function that adds Text Template Management routes
+ * @since 3.0.0
+ */
+declare function configureRoutes(routes: RoutesService): () => void;
+/**
+ * Initialize Text Template Management routes
+ * Helper function to immediately configure routes
+ * @param routes - The routes service instance
+ * @since 3.0.0
+ */
+declare function initializeTextTemplateManagementRoutes(routes: RoutesService): void;
+/**
+ * Text Template Management route providers configuration object
+ * React equivalent of Angular's APP_INITIALIZER pattern
+ * @since 3.0.0
+ */
+declare const TEXT_TEMPLATE_MANAGEMENT_ROUTE_PROVIDERS: {
+    /** Configure function factory */
+    useFactory: typeof configureRoutes;
+    /** Dependencies required by the factory */
+    deps: readonly ["RoutesService"];
+};
+
 /**
  * Component keys for the Text Template Management module.
  * These keys are used for component replacement/customization.
@@ -29,26 +119,72 @@ declare const eTextTemplateManagementComponents: {
 type TextTemplateManagementComponentKey = (typeof eTextTemplateManagementComponents)[keyof typeof eTextTemplateManagementComponents];
 
 /**
- * Route name keys for the Text Template Management module.
- * These keys are used for route localization and identification.
- * @since 2.7.0
+ * Text Template Management Extensions Guard
+ * Translated from @volo/abp.ng.text-template-management v3.0.0
+ *
+ * Guard for protecting Text Template Management routes and ensuring extensions are loaded.
+ *
+ * @since 3.0.0
  */
-declare const eTextTemplateManagementRouteNames: {
-    /**
-     * Administration route name key.
-     * Used for the administration menu group.
-     */
-    readonly Administration: "AbpUiNavigation::Menu:Administration";
-    /**
-     * Text Templates route name key.
-     * Used for the text templates management route.
-     */
-    readonly TextTemplates: "TextTemplateManagement::Menu:TextTemplates";
+/**
+ * Text Template Management 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 textTemplateManagementExtensionsGuard();
+ * if (canActivate) {
+ *   // Proceed with navigation
+ * }
+ * ```
+ */
+declare function textTemplateManagementExtensionsGuard(): Promise<boolean>;
+/**
+ * Hook for Text Template Management 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 } = useTextTemplateManagementExtensionsGuard();
+ *
+ *   if (loading) return <Loading />;
+ *   if (!isLoaded) return <Navigate to="/unauthorized" />;
+ *
+ *   return children;
+ * }
+ * ```
+ */
+declare function useTextTemplateManagementExtensionsGuard(): {
+    isLoaded: boolean;
+    loading: boolean;
 };
 /**
- * Type for text template management route name key values
+ * Text Template Management Extensions Guard class
+ * Class-based guard implementation for compatibility with Angular patterns.
+ *
+ * @since 3.0.0
+ *
+ * @example
+ * ```tsx
+ * const guard = new TextTemplateManagementExtensionsGuard();
+ * const canActivate = await guard.canActivate();
+ * ```
  */
-type TextTemplateManagementRouteNameKey = (typeof eTextTemplateManagementRouteNames)[keyof typeof eTextTemplateManagementRouteNames];
+declare class TextTemplateManagementExtensionsGuard {
+    /**
+     * Check if the route can be activated
+     * @returns Promise<boolean> - True if navigation should proceed
+     */
+    canActivate(): Promise<boolean>;
+}
 
 /**
  * Text Template Management Models
@@ -137,6 +273,188 @@ declare namespace TextTemplateManagement {
         sorting?: string;
     }
 }
+/**
+ * Input for getting template definition list
+ * Extends PagedResultRequestDto with optional filterText
+ * @since 3.1.0
+ */
+interface GetTemplateDefinitionListInput {
+    /** Filter text for searching templates */
+    filterText?: string;
+    /** Skip count for pagination */
+    skipCount?: number;
+    /** Max result count for pagination */
+    maxResultCount?: number;
+    /** Sorting field and order */
+    sorting?: string;
+}
+/**
+ * Factory function to create GetTemplateDefinitionListInput
+ * @param initialValues Optional initial values
+ * @returns GetTemplateDefinitionListInput instance
+ * @since 3.1.0
+ */
+declare function createGetTemplateDefinitionListInput(initialValues?: Partial<GetTemplateDefinitionListInput>): GetTemplateDefinitionListInput;
+
+/**
+ * Text Template Management Extension Tokens
+ * Translated from @volo/abp.ng.text-template-management v3.0.0
+ *
+ * Default entity actions, toolbar actions, and entity props
+ * for the Text Template Management 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;
+}
+/**
+ * Default entity actions for TextTemplates component
+ * @since 3.0.0
+ */
+declare const DEFAULT_TEXT_TEMPLATES_ENTITY_ACTIONS: EntityAction<TextTemplateManagement.TemplateDefinitionDto>[];
+/**
+ * Default entity actions aggregated by component
+ * @since 3.0.0
+ */
+declare const DEFAULT_TEXT_TEMPLATE_MANAGEMENT_ENTITY_ACTIONS: {
+    readonly "TextTemplateManagement.TextTemplates": EntityAction<TextTemplateManagement.TemplateDefinitionDto>[];
+};
+/**
+ * Default toolbar actions for TextTemplates component
+ * Note: Text Template Management typically doesn't have create functionality
+ * as templates are defined in code
+ * @since 3.0.0
+ */
+declare const DEFAULT_TEXT_TEMPLATES_TOOLBAR_ACTIONS: ToolbarAction<TextTemplateManagement.TemplateDefinitionDto[]>[];
+/**
+ * Default toolbar actions aggregated by component
+ * @since 3.0.0
+ */
+declare const DEFAULT_TEXT_TEMPLATE_MANAGEMENT_TOOLBAR_ACTIONS: {
+    readonly "TextTemplateManagement.TextTemplates": ToolbarAction<TextTemplateManagement.TemplateDefinitionDto[]>[];
+};
+/**
+ * Default entity props for TextTemplates component
+ * @since 3.0.0
+ */
+declare const DEFAULT_TEXT_TEMPLATES_ENTITY_PROPS: EntityProp<TextTemplateManagement.TemplateDefinitionDto>[];
+/**
+ * Default entity props aggregated by component
+ * @since 3.0.0
+ */
+declare const DEFAULT_TEXT_TEMPLATE_MANAGEMENT_ENTITY_PROPS: {
+    readonly "TextTemplateManagement.TextTemplates": EntityProp<TextTemplateManagement.TemplateDefinitionDto>[];
+};
+/**
+ * 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>[];
+/**
+ * Token for entity action contributors
+ * React equivalent of Angular InjectionToken
+ * @since 3.0.0
+ */
+declare const TEXT_TEMPLATE_MANAGEMENT_ENTITY_ACTION_CONTRIBUTORS: unique symbol;
+/**
+ * Token for toolbar action contributors
+ * React equivalent of Angular InjectionToken
+ * @since 3.0.0
+ */
+declare const TEXT_TEMPLATE_MANAGEMENT_TOOLBAR_ACTION_CONTRIBUTORS: unique symbol;
+/**
+ * Token for entity prop contributors
+ * React equivalent of Angular InjectionToken
+ * @since 3.0.0
+ */
+declare const TEXT_TEMPLATE_MANAGEMENT_ENTITY_PROP_CONTRIBUTORS: unique symbol;
+
+/**
+ * Text Template Management Config Options
+ * Translated from @volo/abp.ng.text-template-management v3.0.0
+ *
+ * Configuration options and contributor types for the Text Template Management module.
+ *
+ * @since 3.0.0
+ */
+
+/**
+ * Entity action contributors type for Text Template Management
+ * @since 3.0.0
+ */
+type TextTemplateManagementEntityActionContributors = Partial<{
+    [eTextTemplateManagementComponents.TextTemplates]: EntityActionContributorCallback<TextTemplateManagement.TemplateDefinitionDto>[];
+}>;
+/**
+ * Toolbar action contributors type for Text Template Management
+ * Note: Typo fixed in v3.0.0 (was TextTemplateManagementTooolbarActionContributors)
+ * @since 3.0.0
+ */
+type TextTemplateManagementToolbarActionContributors = Partial<{
+    [eTextTemplateManagementComponents.TextTemplates]: ToolbarActionContributorCallback<TextTemplateManagement.TemplateDefinitionDto[]>[];
+}>;
+/**
+ * Entity prop contributors type for Text Template Management
+ * @since 3.0.0
+ */
+type TextTemplateManagementEntityPropContributors = Partial<{
+    [eTextTemplateManagementComponents.TextTemplates]: EntityPropContributorCallback<TextTemplateManagement.TemplateDefinitionDto>[];
+}>;
+/**
+ * Configuration options interface for Text Template Management module
+ * @since 3.0.0
+ */
+interface TextTemplateManagementConfigOptions {
+    /** Entity action contributors */
+    entityActionContributors?: TextTemplateManagementEntityActionContributors;
+    /** Toolbar action contributors */
+    toolbarActionContributors?: TextTemplateManagementToolbarActionContributors;
+    /** Entity prop contributors */
+    entityPropContributors?: TextTemplateManagementEntityPropContributors;
+}
 
 /**
  * Text Template Management Routes
@@ -451,4 +769,4 @@ interface TemplateContentsComponentProps {
  */
 declare function TemplateContentsComponent({ templateName, cultures, defaultCultureName, onSave, onRestore, className, }: TemplateContentsComponentProps): React.ReactElement;
 
-export { TEXT_TEMPLATE_MANAGEMENT_ROUTES, TemplateContentService, TemplateContentsComponent, type TemplateContentsComponentProps, TemplateDefinitionService, TextTemplateManagement, type TextTemplateManagementComponentKey, type TextTemplateManagementRouteNameKey, TextTemplateManagementStateService, TextTemplatesComponent, type TextTemplatesComponentProps, type UseTextTemplatesReturn, eTextTemplateManagementComponents, eTextTemplateManagementRouteNames, useTextTemplates };
+export { DEFAULT_TEXT_TEMPLATES_ENTITY_ACTIONS, DEFAULT_TEXT_TEMPLATES_ENTITY_PROPS, DEFAULT_TEXT_TEMPLATES_TOOLBAR_ACTIONS, DEFAULT_TEXT_TEMPLATE_MANAGEMENT_ENTITY_ACTIONS, DEFAULT_TEXT_TEMPLATE_MANAGEMENT_ENTITY_PROPS, DEFAULT_TEXT_TEMPLATE_MANAGEMENT_TOOLBAR_ACTIONS, type EntityAction, type EntityActionContributorCallback, type EntityProp, type EntityPropContributorCallback, type GetTemplateDefinitionListInput, TEXT_TEMPLATE_MANAGEMENT_ENTITY_ACTION_CONTRIBUTORS, TEXT_TEMPLATE_MANAGEMENT_ENTITY_PROP_CONTRIBUTORS, TEXT_TEMPLATE_MANAGEMENT_ROUTES, TEXT_TEMPLATE_MANAGEMENT_ROUTE_CONFIG, TEXT_TEMPLATE_MANAGEMENT_ROUTE_PROVIDERS, TEXT_TEMPLATE_MANAGEMENT_TOOLBAR_ACTION_CONTRIBUTORS, TemplateContentService, TemplateContentsComponent, type TemplateContentsComponentProps, TemplateDefinitionService, TextTemplateManagement, type TextTemplateManagementComponentKey, type TextTemplateManagementConfigOptions, type TextTemplateManagementEntityActionContributors, type TextTemplateManagementEntityPropContributors, TextTemplateManagementExtensionsGuard, type TextTemplateManagementPolicyNameKey, type TextTemplateManagementRouteNameKey, TextTemplateManagementStateService, type TextTemplateManagementToolbarActionContributors, TextTemplatesComponent, type TextTemplatesComponentProps, type ToolbarAction, type ToolbarActionContributorCallback, type UseTextTemplatesReturn, configureRoutes, createGetTemplateDefinitionListInput, eTextTemplateManagementComponents, eTextTemplateManagementPolicyNames, eTextTemplateManagementRouteNames, initializeTextTemplateManagementRoutes, textTemplateManagementExtensionsGuard, useTextTemplateManagementExtensionsGuard, useTextTemplates };