@abpjs/theme-shared 2.9.0 → 3.1.0

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

@@ -0,0 +1,89 @@
+/**
+ * Nav Item Model
+ * Translated from @abp/ng.theme.shared/lib/models/nav-item.ts v3.1.0
+ *
+ * @since 3.0.0 - Added id property, changed permission to requiredPolicy
+ * @since 3.1.0 - Changed from interface to class, added visible callback
+ */
+import type { ComponentType } from 'react';
+/**
+ * Navigation item properties interface.
+ * @since 3.1.0
+ */
+export interface NavItemProps {
+    /**
+     * 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;
+    /**
+     * Callback to determine visibility of the nav item.
+     * @since 3.1.0
+     */
+    visible?: () => boolean;
+}
+/**
+ * Navigation item class.
+ * @since 3.0.0 - Added id property, changed permission to requiredPolicy
+ * @since 3.1.0 - Changed from interface to class, added visible callback
+ */
+export declare class NavItem implements NavItemProps {
+    /**
+     * 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;
+    /**
+     * Callback to determine visibility of the nav item.
+     * @since 3.1.0
+     */
+    visible?: () => boolean;
+    /**
+     * Create a new NavItem.
+     * @param props - Partial properties to initialize the nav item
+     * @since 3.1.0
+     */
+    constructor(props: Partial<NavItemProps>);
+}

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,119 @@
+/**
+ * Nav Items Service
+ * Translated from @abp/ng.theme.shared/lib/services/nav-items.service.ts v3.1.0
+ *
+ * Provides a service-based approach to managing navigation items,
+ * replacing the utility functions approach from v2.9.0.
+ *
+ * @since 3.0.0
+ * @since 3.1.0 - Updated addItems parameter name to newItems for clarity
+ */
+import { NavItem, NavItemProps } 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 newItems - Array of items to add
+     * @since 3.0.0
+     * @since 3.1.0 - Renamed parameter from items to newItems
+     */
+    addItems(newItems: (NavItem | NavItemProps)[]): 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/utils/index.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abpjs/theme-shared",
-  "version": "2.9.0",
+  "version": "3.1.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.9.0"
+    "@abpjs/core": "3.1.0"
   },
   "devDependencies": {
-    "@abp/ng.theme.shared": "2.9.0",
-    "@vitest/coverage-v8": "^3.2.0"
+    "@abp/ng.theme.shared": "3.1.0",
+    "@vitest/coverage-v8": "^1.6.0",
+    "vitest": "^1.6.0"
   },
   "author": "tekthar.com",
   "license": "LGPL-3.0",