@abpjs/text-template-management 2.7.0

package/dist/index.d.ts

@@ -0,0 +1,454 @@
+import { ABP, RestService, PagedResultRequestDto, ListResultDto } from '@abpjs/core';
+import React from 'react';
+
+/**
+ * Component keys for the Text Template Management module.
+ * These keys are used for component replacement/customization.
+ * @since 2.7.0
+ */
+declare const eTextTemplateManagementComponents: {
+    /**
+     * Key for the TextTemplates component.
+     * Use this to replace the default TextTemplates list with a custom implementation.
+     */
+    readonly TextTemplates: "TextTemplateManagement.TextTemplates";
+    /**
+     * Key for the TemplateContents component.
+     * Use this to replace the default template content editor.
+     */
+    readonly TemplateContents: "TextTemplateManagement.TemplateContents";
+    /**
+     * Key for the InlineTemplateContent component.
+     * Use this to replace the inline template content editor.
+     */
+    readonly InlineTemplateContent: "TextTemplateManagement.InlineTemplateContent";
+};
+/**
+ * Type for text template management component key values
+ */
+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
+ */
+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";
+};
+/**
+ * Type for text template management route name key values
+ */
+type TextTemplateManagementRouteNameKey = (typeof eTextTemplateManagementRouteNames)[keyof typeof eTextTemplateManagementRouteNames];
+
+/**
+ * Text Template Management Models
+ * Translated from @volo/abp.ng.text-template-management v2.7.0
+ */
+/**
+ * Text Template Management namespace containing types and interfaces
+ * @since 2.7.0
+ */
+declare namespace TextTemplateManagement {
+    /**
+     * Template definition DTO
+     * Represents a text template definition
+     */
+    interface TemplateDefinitionDto {
+        /** Template name (unique identifier) */
+        name: string;
+        /** Display name for the template */
+        displayName: string;
+        /** Whether this template is a layout template */
+        isLayout: boolean;
+        /** Layout template name (if this template uses a layout) */
+        layout: string;
+        /** Default culture name for the template */
+        defaultCultureName: string;
+        /** Whether the template is localized inline */
+        isInlineLocalized: boolean;
+    }
+    /**
+     * Text template content DTO
+     * Represents the content of a text template
+     */
+    interface TextTemplateContentDto {
+        /** Template name */
+        name: string;
+        /** Culture name for the content */
+        cultureName: string;
+        /** Template content */
+        content: string;
+    }
+    /**
+     * Input for getting template content
+     */
+    interface TemplateContentInput {
+        /** Template name */
+        templateName: string;
+        /** Optional culture name */
+        cultureName?: string;
+    }
+    /**
+     * DTO for creating or updating template content
+     */
+    interface CreateOrUpdateTemplateContentDto {
+        /** Template name */
+        templateName: string;
+        /** Culture name for the content */
+        cultureName: string;
+        /** Template content */
+        content: string;
+    }
+    /**
+     * State interface for text template management
+     * @since 2.7.0
+     */
+    interface State {
+        /** List of template definitions */
+        templateDefinitions: TemplateDefinitionDto[];
+        /** Total count of template definitions */
+        totalCount: number;
+        /** Currently selected template definition */
+        selectedTemplate: TemplateDefinitionDto | null;
+        /** Template content for the selected template */
+        templateContent: TextTemplateContentDto | null;
+    }
+    /**
+     * Request parameters for fetching template definitions
+     */
+    interface GetTemplateDefinitionsInput {
+        /** Filter text */
+        filterText?: string;
+        /** Skip count for pagination */
+        skipCount?: number;
+        /** Max result count for pagination */
+        maxResultCount?: number;
+        /** Sorting field and order */
+        sorting?: string;
+    }
+}
+
+/**
+ * Text Template Management Routes
+ * Translated from @volo/abp.ng.text-template-management v2.7.0
+ */
+
+/**
+ * Default routes for text template management module
+ */
+declare const TEXT_TEMPLATE_MANAGEMENT_ROUTES: {
+    routes: ABP.FullRoute[];
+};
+
+/**
+ * Template Definition Service
+ * Translated from @volo/abp.ng.text-template-management v2.7.0
+ *
+ * Provides REST API methods for managing text template definitions.
+ */
+
+/**
+ * Service for template definition operations.
+ * This service wraps all REST API calls for template definitions.
+ *
+ * @since 2.7.0
+ */
+declare class TemplateDefinitionService {
+    private restService;
+    /**
+     * API name for multi-API configurations
+     * @since 2.7.0
+     */
+    apiName: string;
+    constructor(restService: RestService);
+    /**
+     * Get list of template definitions
+     * @param params Query parameters for filtering and pagination
+     * @returns Promise with list of template definitions
+     */
+    getList(params?: Partial<PagedResultRequestDto>): Promise<ListResultDto<TextTemplateManagement.TemplateDefinitionDto>>;
+}
+
+/**
+ * Template Content Service
+ * Translated from @volo/abp.ng.text-template-management v2.7.0
+ *
+ * Provides REST API methods for managing text template content.
+ */
+
+/**
+ * Service for template content operations.
+ * This service wraps all REST API calls for template content.
+ *
+ * @since 2.7.0
+ */
+declare class TemplateContentService {
+    private restService;
+    /**
+     * API name for multi-API configurations
+     * @since 2.7.0
+     */
+    apiName: string;
+    constructor(restService: RestService);
+    /**
+     * Get template content by input parameters
+     * @param params Input parameters containing template name and optional culture name
+     * @returns Promise with template content
+     */
+    getByInput(params: TextTemplateManagement.TemplateContentInput): Promise<TextTemplateManagement.TextTemplateContentDto>;
+    /**
+     * Restore template content to default
+     * @param body Input containing template name and culture name to restore
+     * @returns Promise that resolves when restore is complete
+     */
+    restoreToDefaultByInput(body: TextTemplateManagement.TemplateContentInput): Promise<void>;
+    /**
+     * Update template content
+     * @param body DTO containing template name, culture name, and new content
+     * @returns Promise with updated template content
+     */
+    updateByInput(body: TextTemplateManagement.CreateOrUpdateTemplateContentDto): Promise<TextTemplateManagement.TextTemplateContentDto>;
+}
+
+/**
+ * Text Template Management State Service
+ * Translated from @volo/abp.ng.text-template-management v2.7.0
+ *
+ * Provides a stateful facade over text template operations,
+ * maintaining internal state similar to Angular's NGXS store pattern.
+ */
+
+/**
+ * State service for text template management.
+ * Maintains state for template definitions and content.
+ *
+ * @since 2.7.0
+ */
+declare class TextTemplateManagementStateService {
+    private templateDefinitionService;
+    private templateContentService;
+    private _state;
+    constructor(restService: RestService);
+    /**
+     * Get template definitions from state
+     * @returns Array of template definitions
+     */
+    getTemplateDefinitions(): TextTemplateManagement.TemplateDefinitionDto[];
+    /**
+     * Get total count of template definitions
+     * @returns Total count
+     */
+    getTotalCount(): number;
+    /**
+     * Get the currently selected template
+     * @returns Selected template or null
+     */
+    getSelectedTemplate(): TextTemplateManagement.TemplateDefinitionDto | null;
+    /**
+     * Get template content from state
+     * @returns Template content or null
+     */
+    getTemplateContent(): TextTemplateManagement.TextTemplateContentDto | null;
+    /**
+     * Dispatch action to fetch template definitions
+     * @param params Query parameters for filtering and pagination
+     * @returns Promise with list result
+     */
+    dispatchGetTemplateDefinitions(params?: Partial<PagedResultRequestDto>): Promise<ListResultDto<TextTemplateManagement.TemplateDefinitionDto>>;
+    /**
+     * Dispatch action to get template content
+     * @param params Input containing template name and optional culture name
+     * @returns Promise with template content
+     */
+    dispatchGetTemplateContent(params: TextTemplateManagement.TemplateContentInput): Promise<TextTemplateManagement.TextTemplateContentDto>;
+    /**
+     * Dispatch action to update template content
+     * @param body DTO containing template name, culture name, and content
+     * @returns Promise with updated template content
+     */
+    dispatchUpdateTemplateContent(body: TextTemplateManagement.CreateOrUpdateTemplateContentDto): Promise<TextTemplateManagement.TextTemplateContentDto>;
+    /**
+     * Dispatch action to restore template content to default
+     * @param body Input containing template name and culture name
+     * @returns Promise that resolves when restore is complete
+     */
+    dispatchRestoreToDefault(body: TextTemplateManagement.TemplateContentInput): Promise<void>;
+    /**
+     * Set the selected template
+     * @param template Template to select or null to clear
+     */
+    setSelectedTemplate(template: TextTemplateManagement.TemplateDefinitionDto | null): void;
+    /**
+     * Clear all state
+     */
+    reset(): void;
+}
+
+/**
+ * useTextTemplates Hook
+ * Translated from @volo/abp.ng.text-template-management v2.7.0
+ *
+ * Provides a React hook for managing text templates with state management.
+ */
+
+/**
+ * Hook return type for useTextTemplates
+ */
+interface UseTextTemplatesReturn {
+    /** List of template definitions */
+    templateDefinitions: TextTemplateManagement.TemplateDefinitionDto[];
+    /** Total count of template definitions */
+    totalCount: number;
+    /** Currently selected template */
+    selectedTemplate: TextTemplateManagement.TemplateDefinitionDto | null;
+    /** Template content for the selected template */
+    templateContent: TextTemplateManagement.TextTemplateContentDto | null;
+    /** Loading state */
+    isLoading: boolean;
+    /** Error message if any */
+    error: string | null;
+    /** Fetch template definitions */
+    fetchTemplateDefinitions: (params?: Partial<PagedResultRequestDto>) => Promise<void>;
+    /** Get template content */
+    getTemplateContent: (params: TextTemplateManagement.TemplateContentInput) => Promise<void>;
+    /** Update template content */
+    updateTemplateContent: (body: TextTemplateManagement.CreateOrUpdateTemplateContentDto) => Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+    /** Restore template content to default */
+    restoreToDefault: (params: TextTemplateManagement.TemplateContentInput) => Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+    /** Set selected template */
+    setSelectedTemplate: (template: TextTemplateManagement.TemplateDefinitionDto | null) => void;
+    /** Reset all state */
+    reset: () => void;
+}
+/**
+ * React hook for managing text templates
+ *
+ * @returns Hook state and methods
+ *
+ * @example
+ * ```tsx
+ * function TextTemplatesPage() {
+ *   const {
+ *     templateDefinitions,
+ *     isLoading,
+ *     fetchTemplateDefinitions,
+ *     getTemplateContent,
+ *   } = useTextTemplates();
+ *
+ *   useEffect(() => {
+ *     fetchTemplateDefinitions();
+ *   }, [fetchTemplateDefinitions]);
+ *
+ *   return (
+ *     <div>
+ *       {templateDefinitions.map(template => (
+ *         <div key={template.name}>{template.displayName}</div>
+ *       ))}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useTextTemplates(): UseTextTemplatesReturn;
+
+/**
+ * Text Templates Component
+ * Translated from @volo/abp.ng.text-template-management v2.7.0
+ *
+ * Displays a list of text template definitions with pagination and actions.
+ */
+
+interface TextTemplatesComponentProps {
+    /** Callback when edit contents is clicked */
+    onEditContents?: (template: TextTemplateManagement.TemplateDefinitionDto) => void;
+    /** Optional CSS class for the container */
+    className?: string;
+    /** Page size for pagination */
+    pageSize?: number;
+}
+/**
+ * Component for displaying and managing text templates.
+ * Shows a paginated list of template definitions with actions.
+ *
+ * @example
+ * ```tsx
+ * function TextTemplatesPage() {
+ *   const navigate = useNavigate();
+ *
+ *   return (
+ *     <TextTemplatesComponent
+ *       onEditContents={(template) => {
+ *         navigate(`/text-templates/${template.name}/contents`);
+ *       }}
+ *     />
+ *   );
+ * }
+ * ```
+ */
+declare function TextTemplatesComponent({ onEditContents, className, pageSize, }: TextTemplatesComponentProps): React.ReactElement;
+
+/**
+ * Template Contents Component
+ * Translated from @volo/abp.ng.text-template-management v2.7.0
+ *
+ * Displays and allows editing of template content for different cultures.
+ */
+
+interface TemplateContentsComponentProps {
+    /** Template name to edit */
+    templateName: string;
+    /** Available culture names for selection */
+    cultures?: Array<{
+        name: string;
+        displayName: string;
+    }>;
+    /** Default culture name */
+    defaultCultureName?: string;
+    /** Callback when save is successful */
+    onSave?: (content: TextTemplateManagement.TextTemplateContentDto) => void;
+    /** Callback when restore to default is successful */
+    onRestore?: () => void;
+    /** Optional CSS class for the container */
+    className?: string;
+}
+/**
+ * Component for editing template content across different cultures.
+ * Supports viewing reference content and editing/restoring localized content.
+ *
+ * @example
+ * ```tsx
+ * function EditTemplatePage() {
+ *   const { templateName } = useParams();
+ *
+ *   return (
+ *     <TemplateContentsComponent
+ *       templateName={templateName}
+ *       cultures={[
+ *         { name: 'en', displayName: 'English' },
+ *         { name: 'fr', displayName: 'French' },
+ *       ]}
+ *       onSave={() => toast.success('Template saved!')}
+ *     />
+ *   );
+ * }
+ * ```
+ */
+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 };