@abpjs/theme-shared 2.7.0 → 3.0.0

package/dist/models/common.d.ts

@@ -3,8 +3,14 @@
  * Translated from @abp/ng.theme.shared/lib/models/common.ts
  * @since 1.1.0
  * @since 2.7.0 - Added skipHandledErrorCodes, simplified forWhichErrors type
+ * @since 2.9.0 - Added LocaleDirection type
  */
 import type { ComponentType } from 'react';
+/**
+ * Locale direction for RTL/LTR support.
+ * @since 2.9.0
+ */
+export type LocaleDirection = 'ltr' | 'rtl';
 /**
  * Root parameters for ThemeSharedModule configuration.
  * @since 1.1.0

package/dist/models/confirmation.d.ts

@@ -1,6 +1,6 @@
 /**
  * Confirmation namespace containing types for confirmation dialogs.
- * Translated from @abp/ng.theme.shared/lib/models/confirmation.ts
+ * Translated from @abp/ng.theme.shared/lib/models/confirmation.ts v3.0.0
  *
  * @since 2.0.0 - Major changes:
  * - Options no longer extends Toaster.Options
@@ -9,18 +9,24 @@
  * - Removed deprecated cancelCopy/yesCopy
  *
  * @since 2.1.0 - Added Status enum (confirmation-specific, replaces Toaster.Status usage)
+ * @since 2.9.0 - Added dismissible property, deprecated closable
+ * @since 3.0.0 - Removed closable property (use dismissible instead)
  */
 import type { Config } from '@abpjs/core';
 export declare namespace Confirmation {
     /**
      * Options for configuring a confirmation dialog.
      * @since 2.0.0 - No longer extends Toaster.Options
+     * @since 3.0.0 - Removed closable (use dismissible instead)
      */
     interface Options {
         /** Unique identifier for the confirmation */
         id?: string | number;
-        /** Whether the confirmation can be closed by clicking outside or pressing escape */
-        closable?: boolean;
+        /**
+         * Whether the confirmation can be dismissed by clicking outside or pressing escape.
+         * @since 2.9.0
+         */
+        dismissible?: boolean;
         /** Parameters for localizing the message */
         messageLocalizationParams?: string[];
         /** Parameters for localizing the title */

package/dist/models/index.d.ts

@@ -1,5 +1,10 @@
+/**
+ * Models barrel export
+ * @since 3.0.0 - Removed setting-management (now in @abpjs/core SettingTabsService)
+ * @since 3.0.0 - Added nav-item model
+ */
 export * from './common';
-export * from './toaster';
 export * from './confirmation';
-export * from './setting-management';
+export * from './nav-item';
 export * from './statistics';
+export * from './toaster';

package/dist/models/nav-item.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Nav Item Model
+ * Translated from @abp/ng.theme.shared/lib/models/nav-item.ts v3.0.0
+ *
+ * @since 3.0.0 - Added id property, changed permission to requiredPolicy
+ */
+import type { ComponentType } from 'react';
+/**
+ * Navigation item configuration.
+ * @since 3.0.0 - Added id property, changed permission to requiredPolicy
+ */
+export interface NavItem {
+    /**
+     * Unique identifier for the nav item.
+     * @since 3.0.0
+     */
+    id: string | number;
+    /**
+     * React component to render for this nav item.
+     */
+    component?: ComponentType<any>;
+    /**
+     * Raw HTML string to render (use with caution for XSS).
+     */
+    html?: string;
+    /**
+     * Action to execute when the nav item is clicked.
+     */
+    action?: () => void;
+    /**
+     * Order for sorting nav items. Lower numbers appear first.
+     */
+    order?: number;
+    /**
+     * Required policy to show this nav item.
+     * @since 3.0.0 - Renamed from permission
+     */
+    requiredPolicy?: string;
+}

package/dist/models/toaster.d.ts

@@ -1,7 +1,7 @@
 import type { Config } from '@abpjs/core';
 /**
  * Toaster namespace containing types and interfaces for toast notifications.
- * Translated from @abp/ng.theme.shared/lib/models/toaster.ts
+ * Translated from @abp/ng.theme.shared/lib/models/toaster.ts v3.0.0
  *
  * @since 2.0.0 - Major changes:
  * - `Options` renamed to `ToastOptions`
@@ -9,7 +9,7 @@ import type { Config } from '@abpjs/core';
  * - `Severity` type changed: 'warn' → 'warning', added 'neutral'
  * - ToasterService methods now return number (toast ID) instead of Observable
  *
- * @since 2.1.0 - Status enum deprecated, use Confirmation.Status instead
+ * @since 3.0.0 - Status enum removed, use Confirmation.Status instead
  */
 export declare namespace Toaster {
     /**
@@ -53,46 +53,4 @@ export declare namespace Toaster {
      * @since 2.0.0 - Changed 'warn' to 'warning', added 'neutral'
      */
     type Severity = 'neutral' | 'success' | 'info' | 'warning' | 'error';
-    /**
-     * Status values for toast/confirmation interactions.
-     * @deprecated Status will be removed from toaster model in v3.0. Use Confirmation.Status instead.
-     * @since 2.1.0 - Deprecated in favor of Confirmation.Status
-     */
-    enum Status {
-        confirm = "confirm",
-        reject = "reject",
-        dismiss = "dismiss"
-    }
-    /**
-     * @deprecated Use ToastOptions instead. Scheduled for removal in v3.0.0
-     * Preserved for backward compatibility.
-     */
-    interface Options {
-        /** Unique identifier for the toast */
-        id?: string;
-        /** Whether the toast can be manually closed */
-        closable?: boolean;
-        /** Duration in milliseconds before auto-dismiss (default varies by implementation) */
-        life?: number;
-        /** If true, toast won't auto-dismiss */
-        sticky?: boolean;
-        /** Custom data to attach to the toast */
-        data?: unknown;
-        /** Parameters for localizing the message */
-        messageLocalizationParams?: string[];
-        /** Parameters for localizing the title */
-        titleLocalizationParams?: string[];
-    }
-    /**
-     * @deprecated Use Toast instead. Scheduled for removal in v3.0.0
-     * Preserved for backward compatibility.
-     */
-    interface Message extends Options {
-        /** The message content (can be a localization key) */
-        message: string;
-        /** The title (can be a localization key) */
-        title?: string;
-        /** Severity level of the message */
-        severity: Severity;
-    }
 }

package/dist/providers/ThemeSharedProvider.d.ts

@@ -131,5 +131,5 @@ export interface ThemeSharedProviderProps {
  * }
  * ```
  */
-export declare function ThemeSharedProvider({ children, renderToasts, renderConfirmation, themeOverrides, toastPosition, enableColorMode, defaultColorMode, locale, }: ThemeSharedProviderProps): React.ReactElement;
+export declare function ThemeSharedProvider({ children, renderToasts, renderConfirmation, themeOverrides, toastPosition: _toastPosition, enableColorMode, defaultColorMode, locale, }: ThemeSharedProviderProps): React.ReactElement;
 export default ThemeSharedProvider;

package/dist/providers/index.d.ts

@@ -1 +1,2 @@
 export * from './ThemeSharedProvider';
+export * from './route.provider';

package/dist/providers/route.provider.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Route Provider
+ * Translated from @abp/ng.theme.shared/lib/providers/route.provider.ts v3.0.0
+ *
+ * Provides route configuration for the theme-shared module.
+ *
+ * @since 3.0.0
+ */
+import { RoutesService } from '@abpjs/core';
+/**
+ * Configures the theme shared routes.
+ * This function is called during app initialization to register
+ * the Administration route that other modules can use as a parent.
+ *
+ * @param routes - The RoutesService instance
+ * @returns A function that performs the route configuration
+ * @since 3.0.0
+ */
+export declare function configureRoutes(routes: RoutesService): () => void;
+/**
+ * Theme shared route providers for initialization.
+ * Use this in your app setup to configure theme-shared routes.
+ *
+ * In React, you typically call this during app initialization:
+ *
+ * @example
+ * ```tsx
+ * import { initializeThemeSharedRoutes } from '@abpjs/theme-shared';
+ *
+ * // In your app initialization
+ * initializeThemeSharedRoutes();
+ * ```
+ *
+ * @since 3.0.0
+ */
+export declare const THEME_SHARED_ROUTE_PROVIDERS: {
+    configureRoutes: typeof configureRoutes;
+};
+/**
+ * Initialize theme shared routes.
+ * Call this function during app initialization to register the Administration route.
+ *
+ * @since 3.0.0
+ *
+ * @example
+ * ```tsx
+ * import { initializeThemeSharedRoutes } from '@abpjs/theme-shared';
+ *
+ * // Call once during app initialization
+ * initializeThemeSharedRoutes();
+ * ```
+ */
+export declare function initializeThemeSharedRoutes(): void;

package/dist/services/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Services barrel export
+ * @since 3.0.0
+ */
+export * from './nav-items.service';

package/dist/services/nav-items.service.d.ts

@@ -0,0 +1,117 @@
+/**
+ * Nav Items Service
+ * Translated from @abp/ng.theme.shared/lib/services/nav-items.service.ts v3.0.0
+ *
+ * Provides a service-based approach to managing navigation items,
+ * replacing the utility functions approach from v2.9.0.
+ *
+ * @since 3.0.0
+ */
+import type { NavItem } from '../models/nav-item';
+/**
+ * NavItemsService manages navigation items with reactive updates.
+ * This is a singleton service that provides methods to add, remove, and patch nav items.
+ *
+ * @since 3.0.0 - Replaces the nav-items utility functions
+ *
+ * @example
+ * ```tsx
+ * const navItemsService = NavItemsService.getInstance();
+ *
+ * // Add items
+ * navItemsService.addItems([
+ *   { id: 'profile', component: ProfileComponent, order: 1 },
+ *   { id: 'settings', component: SettingsComponent, order: 2 },
+ * ]);
+ *
+ * // Subscribe to changes
+ * const unsubscribe = navItemsService.subscribe((items) => {
+ *   console.log('Items changed:', items);
+ * });
+ *
+ * // Remove an item
+ * navItemsService.removeItem('profile');
+ *
+ * // Patch an item
+ * navItemsService.patchItem('settings', { order: 10 });
+ * ```
+ */
+export declare class NavItemsService {
+    private static _instance;
+    private _items;
+    private _listeners;
+    /**
+     * Get singleton instance
+     * @since 3.0.0
+     */
+    static getInstance(): NavItemsService;
+    /**
+     * Reset the singleton instance (useful for testing)
+     * @internal
+     */
+    static resetInstance(): void;
+    /**
+     * Get current items (sorted by order)
+     * @since 3.0.0
+     */
+    get items(): NavItem[];
+    /**
+     * Subscribe to item changes.
+     * Returns an unsubscribe function.
+     *
+     * @param listener - Callback function to receive item updates
+     * @returns Unsubscribe function
+     * @since 3.0.0
+     */
+    subscribe(listener: (items: NavItem[]) => void): () => void;
+    /**
+     * Get items as an observable-like interface.
+     * Compatible with Angular's Observable pattern.
+     *
+     * @returns Object with subscribe method
+     * @since 3.0.0
+     */
+    get items$(): {
+        subscribe: (callback: (items: NavItem[]) => void) => {
+            unsubscribe: () => void;
+        };
+    };
+    /**
+     * Add one or more items.
+     * Items are automatically sorted by order.
+     *
+     * @param items - Array of items to add
+     * @since 3.0.0
+     */
+    addItems(items: NavItem[]): void;
+    /**
+     * Remove an item by id.
+     *
+     * @param id - The id of the item to remove
+     * @since 3.0.0
+     */
+    removeItem(id: string | number): void;
+    /**
+     * Patch an existing item by id.
+     * Updates only the specified properties.
+     *
+     * @param id - The id of the item to patch
+     * @param patch - Partial item data to merge
+     * @since 3.0.0
+     */
+    patchItem(id: string | number, patch: Partial<Omit<NavItem, 'id'>>): void;
+    /**
+     * Clear all items.
+     * @since 3.0.0
+     */
+    clear(): void;
+    /**
+     * Notify all listeners of changes.
+     */
+    private notify;
+}
+/**
+ * Get the NavItemsService singleton.
+ * @since 3.0.0
+ */
+export declare function getNavItemsService(): NavItemsService;

package/dist/tokens/index.d.ts

@@ -3,6 +3,8 @@
  * Translated from @abp/ng.theme.shared/lib/tokens
  *
  * @since 2.7.0
+ * @since 2.9.0 - Added LAZY_STYLES token
  */
 export * from './append-content.token';
 export * from './http-error.token';
+export * from './lazy-styles.token';

package/dist/tokens/lazy-styles.token.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Lazy Styles Token
+ * Translated from @abp/ng.theme.shared/lib/tokens/lazy-styles.token.ts
+ *
+ * Provides configuration for lazy-loaded stylesheets with RTL/LTR support.
+ *
+ * @since 2.9.0
+ */
+/**
+ * Default lazy styles configuration.
+ * @since 2.9.0
+ */
+export declare const DEFAULT_LAZY_STYLES: string[];
+/**
+ * Context for lazy styles configuration.
+ * @since 2.9.0
+ */
+export declare const LazyStylesContext: import("react").Context<string[]>;
+/**
+ * Hook to get lazy styles configuration.
+ * @returns Array of style patterns with {{dir}} placeholder
+ * @since 2.9.0
+ *
+ * @example
+ * ```tsx
+ * function MyComponent() {
+ *   const lazyStyles = useLazyStyles();
+ *   // lazyStyles = ['bootstrap-{{dir}}.min.css']
+ * }
+ * ```
+ */
+export declare function useLazyStyles(): string[];
+/**
+ * LAZY_STYLES constant for backwards compatibility.
+ * In React, use LazyStylesContext or useLazyStyles() hook instead.
+ * @since 2.9.0
+ */
+export declare const LAZY_STYLES: string[];

package/dist/utils/index.d.ts

@@ -1,2 +1,6 @@
+/**
+ * Utils barrel export
+ * @since 3.0.0 - Removed nav-items (use NavItemsService from services instead)
+ */
 export * from './styles';
 export * from './validation-utils';

package/dist/utils/nav-items.d.ts

@@ -0,0 +1,110 @@
+/**
+ * Nav Items Utility
+ * Translated from @abp/ng.theme.shared/lib/utils/nav-items.ts
+ *
+ * Provides functions for managing navigation items dynamically.
+ *
+ * @since 2.9.0
+ */
+import { ComponentType } from 'react';
+/**
+ * Navigation item configuration.
+ * @since 2.9.0
+ */
+export interface NavItem {
+    /**
+     * React component to render for this nav item.
+     */
+    component?: ComponentType<any>;
+    /**
+     * Raw HTML string to render (use with caution for XSS).
+     */
+    html?: string;
+    /**
+     * Action to execute when the nav item is clicked.
+     */
+    action?: () => void;
+    /**
+     * Order for sorting nav items. Lower numbers appear first.
+     */
+    order?: number;
+    /**
+     * Permission required to show this nav item.
+     */
+    permission?: string;
+}
+type NavItemSubscriber = (items: NavItem[]) => void;
+/**
+ * Add a navigation item.
+ * @param item - The nav item to add
+ * @since 2.9.0
+ *
+ * @example
+ * ```tsx
+ * addNavItem({
+ *   component: MyComponent,
+ *   order: 10,
+ *   permission: 'AbpIdentity.Users',
+ * });
+ * ```
+ */
+export declare function addNavItem(item: NavItem): void;
+/**
+ * Remove a navigation item.
+ * @param item - The nav item to remove
+ * @since 2.9.0
+ */
+export declare function removeNavItem(item: NavItem): void;
+/**
+ * Clear all navigation items.
+ * @since 2.9.0
+ */
+export declare function clearNavItems(): void;
+/**
+ * Get current navigation items.
+ * @returns Array of nav items
+ * @since 2.9.0
+ */
+export declare function getNavItemsSync(): NavItem[];
+/**
+ * Subscribe to navigation item changes.
+ * Returns an unsubscribe function.
+ *
+ * @param callback - Function to call when nav items change
+ * @returns Unsubscribe function
+ * @since 2.9.0
+ *
+ * @example
+ * ```tsx
+ * const unsubscribe = subscribeToNavItems((items) => {
+ *   console.log('Nav items changed:', items);
+ * });
+ *
+ * // Later, to unsubscribe:
+ * unsubscribe();
+ * ```
+ */
+export declare function subscribeToNavItems(callback: NavItemSubscriber): () => void;
+/**
+ * Get navigation items as an observable-like interface.
+ * Compatible with Angular's Observable pattern.
+ *
+ * @returns Object with subscribe method
+ * @since 2.9.0
+ *
+ * @example
+ * ```tsx
+ * const subscription = getNavItems().subscribe((items) => {
+ *   console.log('Nav items:', items);
+ * });
+ *
+ * // Later, to unsubscribe:
+ * subscription.unsubscribe();
+ * ```
+ */
+export declare function getNavItems(): {
+    subscribe: (callback: NavItemSubscriber) => {
+        unsubscribe: () => void;
+    };
+};
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abpjs/theme-shared",
-  "version": "2.7.0",
+  "version": "3.0.0",
   "description": "ABP Framework Theme Shared components for React - translated from @abp/ng.theme.shared",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -27,11 +27,12 @@
     "next-themes": "^0.4.6",
     "react-hook-form": "^7.48.0",
     "react-icons": "^5.5.0",
-    "@abpjs/core": "2.7.0"
+    "@abpjs/core": "3.0.0"
   },
   "devDependencies": {
-    "@abp/ng.theme.shared": "2.7.0",
-    "@vitest/coverage-v8": "^3.2.0"
+    "@abp/ng.theme.shared": "3.0.0",
+    "@vitest/coverage-v8": "^1.6.0",
+    "vitest": "^1.6.0"
   },
   "author": "tekthar.com",
   "license": "LGPL-3.0",