@abpjs/language-management 2.9.0 → 3.1.0

package/dist/index.d.mts

@@ -1,6 +1,138 @@
-import { ABP, RestService } from '@abpjs/core';
+import { RoutesService, ABP, RestService } from '@abpjs/core';
 import React from 'react';
 
+/**
+ * Language Management Policy Names
+ * Policy names for permission checking in the Language Management module.
+ * @since 3.0.0
+ */
+/**
+ * Language Management policy names enum.
+ * Used for checking permissions in the language management module.
+ * @since 3.0.0
+ */
+declare const eLanguageManagementPolicyNames: {
+    readonly LanguageManagement: "LanguageManagement.Languages || LanguageManagement.LanguageTexts";
+    readonly Languages: "LanguageManagement.Languages";
+    readonly LanguageTexts: "LanguageManagement.LanguageTexts";
+};
+/**
+ * Type for language management policy name values
+ */
+type LanguageManagementPolicyNameKey = (typeof eLanguageManagementPolicyNames)[keyof typeof eLanguageManagementPolicyNames];
+
+/**
+ * Language Management Route Names
+ * Translated from @volo/abp.ng.language-management v3.0.0
+ *
+ * @since 3.0.0
+ * Changes in v3.0.0:
+ * - Removed Administration key
+ * - Changed Languages value from 'LanguageManagement::Menu:Languages' to 'LanguageManagement::Languages'
+ * - Added LanguageManagement key for parent route
+ */
+/**
+ * Enum-like const object for language management route names.
+ * Used for localization and navigation configuration.
+ * @since 3.0.0
+ */
+declare const eLanguageManagementRouteNames: {
+    readonly LanguageManagement: "LanguageManagement::LanguageManagement";
+    readonly Languages: "LanguageManagement::Languages";
+    readonly LanguageTexts: "LanguageManagement::LanguageTexts";
+};
+/**
+ * Type for language management route name values
+ */
+type LanguageManagementRouteNameKey = (typeof eLanguageManagementRouteNames)[keyof typeof eLanguageManagementRouteNames];
+
+/**
+ * Language Management Route Provider
+ * Provides route configuration for the Language Management module.
+ * @since 3.0.0
+ */
+
+/**
+ * Configures language management routes using the provided RoutesService.
+ * @param routes - The RoutesService instance to configure routes with
+ * @returns A function that adds language management routes when called
+ */
+declare function configureRoutes(routes: RoutesService): () => void;
+/**
+ * Initializes language management routes using the global RoutesService.
+ * Convenience function that uses the global RoutesService singleton.
+ * @returns A function that adds language management routes when called
+ */
+declare function initializeLanguageManagementRoutes(): () => void;
+/**
+ * Language Management route providers object.
+ * Can be used for DI-style configuration.
+ */
+declare const LANGUAGE_MANAGEMENT_ROUTE_PROVIDERS: {
+    configureRoutes: typeof configureRoutes;
+};
+
+/**
+ * Language Management Extensions Guard
+ * Guard for loading language management extensions before route activation.
+ * @since 3.0.0
+ */
+/**
+ * Hook to guard language management routes and load extensions.
+ * In Angular, this was a CanActivate guard that loaded entity actions,
+ * toolbar actions, entity props, and form props for language management components.
+ *
+ * In React, this is implemented as a hook that can be used in route loaders
+ * or component initialization.
+ *
+ * @returns Promise that resolves to true when extensions are loaded
+ */
+declare function languageManagementExtensionsGuard(): Promise<boolean>;
+/**
+ * React hook version of the extensions guard.
+ * Can be used in route loaders or useEffect.
+ *
+ * @example
+ * ```tsx
+ * import { useLanguageManagementExtensionsGuard } from '@abpjs/language-management';
+ *
+ * function LanguageManagementLayout() {
+ *   const { isLoaded, loading } = useLanguageManagementExtensionsGuard();
+ *
+ *   if (loading) return <Loading />;
+ *
+ *   return <Outlet />;
+ * }
+ * ```
+ */
+declare function useLanguageManagementExtensionsGuard(): {
+    isLoaded: boolean;
+    loading: boolean;
+};
+/**
+ * Language Management Extensions Guard class (for compatibility with Angular pattern).
+ * @deprecated Use languageManagementExtensionsGuard function or useLanguageManagementExtensionsGuard hook instead.
+ */
+declare class LanguageManagementExtensionsGuard {
+    canActivate(): Promise<boolean>;
+}
+
+/**
+ * Language Management Component Identifiers
+ * Used for component registration and routing
+ *
+ * @since 2.4.0
+ * @updated 2.7.0 - Changed from enum to const object
+ */
+declare const eLanguageManagementComponents: {
+    readonly Languages: "LanguageManagement.LanguagesComponent";
+    readonly LanguageTexts: "LanguageManagement.LanguageTextsComponent";
+};
+/**
+ * Type for language management component key values
+ */
+type LanguageManagementComponentKey = (typeof eLanguageManagementComponents)[keyof typeof eLanguageManagementComponents];
+
 /**
  * Language Management Models
  * Translated from @volo/abp.ng.language-management v2.0.0
@@ -108,51 +240,211 @@ declare namespace LanguageManagement {
 }
 
 /**
- * Language Management Routes
- * Translated from @volo/abp.ng.language-management v0.7.2
+ * Language Management Extension Tokens
+ * Provides extension points for customizing language management components.
+ * @since 3.0.0
  */
 
 /**
- * Default routes for language management module
+ * Entity action definition for grid row actions.
+ * @template T - The entity type for the action
  */
-declare const LANGUAGE_MANAGEMENT_ROUTES: {
-    routes: ABP.FullRoute[];
+interface EntityAction<T> {
+    text: string;
+    action?: (record: {
+        record: T;
+    }) => void;
+    visible?: (data: {
+        record: T;
+    }) => boolean;
+    permission?: string;
+    icon?: string;
+}
+/**
+ * Toolbar action definition for grid toolbar buttons.
+ * @template T - The entity array type for the action
+ */
+interface ToolbarAction<T> {
+    text: string;
+    action?: (data: {
+        data: T;
+    }) => void;
+    visible?: (data: {
+        data: T;
+    }) => boolean;
+    permission?: string;
+    icon?: string;
+}
+/**
+ * Entity prop definition for grid columns.
+ * @template T - The entity type for the prop
+ */
+interface EntityProp<T> {
+    type: string;
+    name: keyof T | string;
+    displayName: string;
+    sortable?: boolean;
+    visible?: (data: {
+        record: T;
+    }) => boolean;
+    valueResolver?: (data: {
+        record: T;
+    }) => string | number | boolean;
+}
+/**
+ * Form prop definition for form fields.
+ * @template T - The entity type for the form
+ */
+interface FormProp<T> {
+    type: string;
+    name: keyof T | string;
+    displayName: string;
+    validators?: unknown[];
+    visible?: (data: {
+        entity?: T;
+    }) => boolean;
+    defaultValue?: unknown;
+    options?: unknown[];
+}
+type EntityActionContributorCallback<T> = (actions: EntityAction<T>[]) => EntityAction<T>[];
+type ToolbarActionContributorCallback<T> = (actions: ToolbarAction<T>[]) => ToolbarAction<T>[];
+type EntityPropContributorCallback<T> = (props: EntityProp<T>[]) => EntityProp<T>[];
+type CreateFormPropContributorCallback<T> = (props: FormProp<T>[]) => FormProp<T>[];
+type EditFormPropContributorCallback<T> = (props: FormProp<T>[]) => FormProp<T>[];
+/**
+ * Default entity actions for Languages component.
+ */
+declare const DEFAULT_LANGUAGES_ENTITY_ACTIONS: EntityAction<LanguageManagement.Language>[];
+/**
+ * Default entity actions for LanguageTexts component.
+ */
+declare const DEFAULT_LANGUAGE_TEXTS_ENTITY_ACTIONS: EntityAction<LanguageManagement.LanguageText>[];
+/**
+ * Combined default language management entity actions.
+ */
+declare const DEFAULT_LANGUAGE_MANAGEMENT_ENTITY_ACTIONS: {
+    readonly 'LanguageManagement.LanguagesComponent': EntityAction<LanguageManagement.Language>[];
+    readonly 'LanguageManagement.LanguageTextsComponent': EntityAction<LanguageManagement.LanguageText>[];
 };
-
 /**
- * Language Management Component Identifiers
- * Used for component registration and routing
- *
- * @since 2.4.0
- * @updated 2.7.0 - Changed from enum to const object
+ * Default toolbar actions for Languages component.
  */
-declare const eLanguageManagementComponents: {
-    readonly Languages: "LanguageManagement.LanguagesComponent";
-    readonly LanguageTexts: "LanguageManagement.LanguageTextsComponent";
+declare const DEFAULT_LANGUAGES_TOOLBAR_ACTIONS: ToolbarAction<LanguageManagement.Language[]>[];
+/**
+ * Default toolbar actions for LanguageTexts component.
+ * Note: LanguageTexts typically doesn't have toolbar actions as texts are predefined.
+ */
+declare const DEFAULT_LANGUAGE_TEXTS_TOOLBAR_ACTIONS: ToolbarAction<LanguageManagement.LanguageText[]>[];
+/**
+ * Combined default language management toolbar actions.
+ */
+declare const DEFAULT_LANGUAGE_MANAGEMENT_TOOLBAR_ACTIONS: {
+    readonly 'LanguageManagement.LanguagesComponent': ToolbarAction<LanguageManagement.Language[]>[];
+    readonly 'LanguageManagement.LanguageTextsComponent': ToolbarAction<LanguageManagement.LanguageText[]>[];
 };
 /**
- * Type for language management component key values
+ * Default entity props for Languages component.
  */
-type LanguageManagementComponentKey = (typeof eLanguageManagementComponents)[keyof typeof eLanguageManagementComponents];
-
+declare const DEFAULT_LANGUAGES_ENTITY_PROPS: EntityProp<LanguageManagement.Language>[];
 /**
- * Language Management Route Names
- * Translated from @volo/abp.ng.language-management v2.7.0
+ * Combined default language management entity props.
+ * Note: LanguageTexts props are not included as they use a different display pattern.
  */
+declare const DEFAULT_LANGUAGE_MANAGEMENT_ENTITY_PROPS: {
+    readonly 'LanguageManagement.LanguagesComponent': EntityProp<LanguageManagement.Language>[];
+};
 /**
- * Enum-like const object for language management route names.
- * Used for localization and navigation configuration.
- * @since 2.7.0
+ * Default create form props for Languages component.
  */
-declare const eLanguageManagementRouteNames: {
-    readonly Administration: "AbpUiNavigation::Menu:Administration";
-    readonly Languages: "LanguageManagement::Menu:Languages";
-    readonly LanguageTexts: "LanguageManagement::LanguageTexts";
+declare const DEFAULT_LANGUAGES_CREATE_FORM_PROPS: FormProp<LanguageManagement.Language>[];
+/**
+ * Default edit form props for Languages component.
+ */
+declare const DEFAULT_LANGUAGES_EDIT_FORM_PROPS: FormProp<LanguageManagement.Language>[];
+/**
+ * Combined default language management create form props.
+ */
+declare const DEFAULT_LANGUAGE_MANAGEMENT_CREATE_FORM_PROPS: {
+    readonly 'LanguageManagement.LanguagesComponent': FormProp<LanguageManagement.Language>[];
 };
 /**
- * Type for language management route name values
+ * Combined default language management edit form props.
+ */
+declare const DEFAULT_LANGUAGE_MANAGEMENT_EDIT_FORM_PROPS: {
+    readonly 'LanguageManagement.LanguagesComponent': FormProp<LanguageManagement.Language>[];
+};
+/**
+ * Entity action contributors type.
+ */
+type LanguageManagementEntityActionContributors = Partial<{
+    [eLanguageManagementComponents.Languages]: EntityActionContributorCallback<LanguageManagement.Language>[];
+    [eLanguageManagementComponents.LanguageTexts]: EntityActionContributorCallback<LanguageManagement.LanguageText>[];
+}>;
+/**
+ * Toolbar action contributors type.
+ */
+type LanguageManagementToolbarActionContributors = Partial<{
+    [eLanguageManagementComponents.Languages]: ToolbarActionContributorCallback<LanguageManagement.Language[]>[];
+    [eLanguageManagementComponents.LanguageTexts]: ToolbarActionContributorCallback<LanguageManagement.LanguageText[]>[];
+}>;
+/**
+ * Entity prop contributors type.
+ */
+type LanguageManagementEntityPropContributors = Partial<{
+    [eLanguageManagementComponents.Languages]: EntityPropContributorCallback<LanguageManagement.Language>[];
+    [eLanguageManagementComponents.LanguageTexts]: EntityPropContributorCallback<LanguageManagement.LanguageText>[];
+}>;
+/**
+ * Create form prop contributors type.
+ */
+type LanguageManagementCreateFormPropContributors = Partial<{
+    [eLanguageManagementComponents.Languages]: CreateFormPropContributorCallback<LanguageManagement.Language>[];
+    [eLanguageManagementComponents.LanguageTexts]: CreateFormPropContributorCallback<LanguageManagement.LanguageText>[];
+}>;
+/**
+ * Edit form prop contributors type.
+ */
+type LanguageManagementEditFormPropContributors = Partial<{
+    [eLanguageManagementComponents.Languages]: EditFormPropContributorCallback<LanguageManagement.Language>[];
+    [eLanguageManagementComponents.LanguageTexts]: EditFormPropContributorCallback<LanguageManagement.LanguageText>[];
+}>;
+/**
+ * Token for language management entity action contributors.
+ * Use as a React Context key.
+ */
+declare const LANGUAGE_MANAGEMENT_ENTITY_ACTION_CONTRIBUTORS: unique symbol;
+/**
+ * Token for language management toolbar action contributors.
+ * Use as a React Context key.
+ */
+declare const LANGUAGE_MANAGEMENT_TOOLBAR_ACTION_CONTRIBUTORS: unique symbol;
+/**
+ * Token for language management entity prop contributors.
+ * Use as a React Context key.
+ */
+declare const LANGUAGE_MANAGEMENT_ENTITY_PROP_CONTRIBUTORS: unique symbol;
+/**
+ * Token for language management create form prop contributors.
+ * Use as a React Context key.
+ */
+declare const LANGUAGE_MANAGEMENT_CREATE_FORM_PROP_CONTRIBUTORS: unique symbol;
+/**
+ * Token for language management edit form prop contributors.
+ * Use as a React Context key.
+ */
+declare const LANGUAGE_MANAGEMENT_EDIT_FORM_PROP_CONTRIBUTORS: unique symbol;
+
+/**
+ * Language Management Routes
+ * Translated from @volo/abp.ng.language-management v0.7.2
  */
-type LanguageManagementRouteNameKey = (typeof eLanguageManagementRouteNames)[keyof typeof eLanguageManagementRouteNames];
+
+/**
+ * Default routes for language management module
+ */
+declare const LANGUAGE_MANAGEMENT_ROUTES: {
+    routes: ABP.FullRoute[];
+};
 
 /**
  * Language Management Service
@@ -251,10 +543,13 @@ declare class LanguageManagementService {
 
 /**
  * Language Management State Service
- * Translated from @volo/abp.ng.language-management v2.0.0
+ * Translated from @volo/abp.ng.language-management v3.0.0
  *
  * Provides a stateful facade over language management operations,
  * maintaining internal state that mirrors the Angular NGXS store pattern.
+ *
+ * @since 2.0.0
+ * @updated 3.0.0 - Removed getLanguagesTotalCount() method
  */
 
 /**
@@ -273,7 +568,6 @@ declare class LanguageManagementService {
  *
  * // Access the result
  * const languages = stateService.getLanguages();
- * const total = stateService.getLanguagesTotalCount();
  * ```
  */
 declare class LanguageManagementStateService {
@@ -284,10 +578,6 @@ declare class LanguageManagementStateService {
      * Get the current list of languages from state
      */
     getLanguages(): LanguageManagement.Language[];
-    /**
-     * Get the total count of languages from state
-     */
-    getLanguagesTotalCount(): number;
     /**
      * Get the current list of language texts from state
      */
@@ -630,4 +920,4 @@ interface LanguageTextsComponentProps {
  */
 declare function LanguageTextsComponent({ onLanguageTextUpdated, onLanguageTextRestored, }: LanguageTextsComponentProps): React.ReactElement;
 
-export { LANGUAGE_MANAGEMENT_ROUTES, LanguageManagement, type LanguageManagementComponentKey, type LanguageManagementRouteNameKey, LanguageManagementService, LanguageManagementStateService, type LanguageOperationResult, type LanguageTextOperationResult, LanguageTextsComponent, type LanguageTextsComponentProps, LanguagesComponent, type LanguagesComponentProps, type SortOrder$1 as SortOrder, type UseLanguageTextsReturn, type UseLanguagesReturn, eLanguageManagementComponents, eLanguageManagementRouteNames, useLanguageTexts, useLanguages };
+export { type CreateFormPropContributorCallback, DEFAULT_LANGUAGES_CREATE_FORM_PROPS, DEFAULT_LANGUAGES_EDIT_FORM_PROPS, DEFAULT_LANGUAGES_ENTITY_ACTIONS, DEFAULT_LANGUAGES_ENTITY_PROPS, DEFAULT_LANGUAGES_TOOLBAR_ACTIONS, DEFAULT_LANGUAGE_MANAGEMENT_CREATE_FORM_PROPS, DEFAULT_LANGUAGE_MANAGEMENT_EDIT_FORM_PROPS, DEFAULT_LANGUAGE_MANAGEMENT_ENTITY_ACTIONS, DEFAULT_LANGUAGE_MANAGEMENT_ENTITY_PROPS, DEFAULT_LANGUAGE_MANAGEMENT_TOOLBAR_ACTIONS, DEFAULT_LANGUAGE_TEXTS_ENTITY_ACTIONS, DEFAULT_LANGUAGE_TEXTS_TOOLBAR_ACTIONS, type EditFormPropContributorCallback, type EntityAction, type EntityActionContributorCallback, type EntityProp, type EntityPropContributorCallback, type FormProp, LANGUAGE_MANAGEMENT_CREATE_FORM_PROP_CONTRIBUTORS, LANGUAGE_MANAGEMENT_EDIT_FORM_PROP_CONTRIBUTORS, LANGUAGE_MANAGEMENT_ENTITY_ACTION_CONTRIBUTORS, LANGUAGE_MANAGEMENT_ENTITY_PROP_CONTRIBUTORS, LANGUAGE_MANAGEMENT_ROUTES, LANGUAGE_MANAGEMENT_ROUTE_PROVIDERS, LANGUAGE_MANAGEMENT_TOOLBAR_ACTION_CONTRIBUTORS, LanguageManagement, type LanguageManagementComponentKey, type LanguageManagementCreateFormPropContributors, type LanguageManagementEditFormPropContributors, type LanguageManagementEntityActionContributors, type LanguageManagementEntityPropContributors, LanguageManagementExtensionsGuard, type LanguageManagementPolicyNameKey, type LanguageManagementRouteNameKey, LanguageManagementService, LanguageManagementStateService, type LanguageManagementToolbarActionContributors, type LanguageOperationResult, type LanguageTextOperationResult, LanguageTextsComponent, type LanguageTextsComponentProps, LanguagesComponent, type LanguagesComponentProps, type SortOrder$1 as SortOrder, type ToolbarAction, type ToolbarActionContributorCallback, type UseLanguageTextsReturn, type UseLanguagesReturn, configureRoutes, eLanguageManagementComponents, eLanguageManagementPolicyNames, eLanguageManagementRouteNames, initializeLanguageManagementRoutes, languageManagementExtensionsGuard, useLanguageManagementExtensionsGuard, useLanguageTexts, useLanguages };