@abpjs/text-template-management 2.7.0

package/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version of
+       the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/dist/index.d.mts

@@ -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 };