tp-react-elements-dev 1.12.1 → 1.12.3

package/dist/src/Utilities/Constants/FunctionConstants.d.ts

@@ -2,10 +2,60 @@ export declare const handleDownloadReactTableDataExcel: (fileName: string, rowDa
 export declare function getUsernameFromEmail(email: string): string;
 export declare function getInitials(name: string): string;
 export declare function findMenuHierarchy(menuData: any[], currentUrl: string, URLProjectNameWithSlash: string): any;
-export declare const getDesiredDate: (daysToAdd?: number, baseDate?: string | null) => string;
-export declare function calculateTotalArrayValueTotal(array: any[], key: string): any;
-export declare function CheckIsDateIsBefore(dateStr1: string, dateStr2: string): boolean;
+/**
+ * Calculates a date by adding/subtracting days from today or a base date
+ * @param dayOffset - Days to add (positive) or subtract (negative) (default: 0)
+ * @param baseDate - Base date in DD/MM/YYYY format (default: today)
+ * @returns Formatted date string in DD/MM/YYYY format
+ */
+export declare const getDesiredDate: (dayOffset?: number, baseDate?: string | null) => string;
+/**
+ * Calculates sum of numeric values for a specific property across array objects
+ * @param array - Array of objects to sum
+ * @param key - Property name to sum
+ * @returns Total sum of numeric values
+ */
+export declare function calculateTotalArrayValueTotal<T extends Record<string, any>>(array: T[], key: keyof T): number;
+/**
+ * Checks if first date comes before second date
+ * @param dateStr1 - First date in DD/MM/YYYY format
+ * @param dateStr2 - Second date in DD/MM/YYYY format
+ * @returns True if dateStr1 is before dateStr2
+ */
+export declare function checkIsDateIsBefore(dateStr1: string, dateStr2: string): boolean;
+/**
+ * Lightens a hex color by a specified percentage
+ * @param color - Hex color string (with or without #)
+ * @param percent - Percentage to lighten (0-100)
+ * @returns Lightened hex color string
+ */
 export declare function lightenColor(color: string, percent: number): string;
-export declare function getFormattedDate(offset?: number): string;
+/**
+ * Gets formatted date with optional day offset
+ * @param dayOffset - Days to add (positive) or subtract (negative) from today (default: 0)
+ * @returns Date string in DD/MM/YYYY format
+ */
+export declare function getFormattedDate(dayOffset?: number): string;
+/**
+ * Encrypts text or objects using AES encryption and Base64 encoding
+ * @param text - String to encrypt (objects will be JSON.stringify'd)
+ * @param SECRET_KEY - Secret key for encryption
+ * @returns Base64 encoded encrypted string
+ * @example
+ * ```typescript
+ * const encrypted = encryptText("Hello World", "myKey");
+ * const encryptedObj = encryptText({name: "John"}, "myKey");
+ * ```
+ */
 export declare const encryptText: (text: string, SECRET_KEY: string) => string;
+/**
+ * Decrypts Base64 encoded AES encrypted text back to original string
+ * @param ciphertext - Base64 encoded encrypted string from encryptText
+ * @param SECRET_KEY - Same secret key used for encryption
+ * @returns Original decrypted text
+ * @example
+ * ```typescript
+ * const decrypted = decryptText(encryptedString, "myKey");
+ * ```
+ */
 export declare const decryptText: (ciphertext: string, SECRET_KEY: string) => string;

package/dist/src/index.d.ts

@@ -1,6 +1,5 @@
 import { useForm } from "react-hook-form";
 import { yupResolver } from "@hookform/resolvers/yup";
-import { calculateTotalArrayValueTotal, CheckIsDateIsBefore, findMenuHierarchy, getDesiredDate, getFormattedDate, getInitials, getUsernameFromEmail, handleDownloadReactTableDataExcel, lightenColor } from "./Utilities/Constants/FunctionConstants";
 export { default as RenderForm } from "./components/Form/FormRenderWrapper";
 export { default as useFormValidatingContext } from "./components/Form/FormConstants";
 export { default as DeleteField } from "./components/DeleteComponent/DeleteField";
@@ -32,9 +31,12 @@ export * as IdleTimer from "react-idle-timer";
 export { default as CacheBuster } from "react-cache-buster";
 export { default as DatePicker } from "react-datepicker";
 export * from "@mui/x-date-pickers";
-export * as ReactRedux from "react-redux";
-export * as ReduxToolkit from "@reduxjs/toolkit";
-export * as ReduxPersist from "redux-persist";
-export * as ReactQuery from "@tanstack/react-query";
-export * as RouterDom from "react-router-dom";
-export { handleDownloadReactTableDataExcel, getUsernameFromEmail, getInitials, findMenuHierarchy, getDesiredDate, calculateTotalArrayValueTotal, CheckIsDateIsBefore, lightenColor, getFormattedDate, };
+export { useDispatch, useSelector, useStore, Provider } from "react-redux";
+export type { ProviderProps } from "react-redux";
+export type { TypedUseSelectorHook } from "react-redux";
+export * from "@reduxjs/toolkit";
+export * from "redux-persist";
+export * from "@tanstack/react-query";
+export { BrowserRouter, Routes, Route, Navigate, NavLink, Outlet, useNavigate, useParams, useLocation, useSearchParams, createBrowserRouter, RouterProvider, Link as RouterLink } from "react-router-dom";
+export type { LinkProps as RouterLinkProps } from "react-router-dom";
+export * from './Utilities/Constants/FunctionConstants';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tp-react-elements-dev",
-  "version": "1.12.1",
+  "version": "1.12.3",
   "main": "dist/index.js",
   "private": false,
   "types": "dist/index.d.ts",
@@ -9,6 +9,17 @@
     "dist/*.css",
     "dist/**/*.d.ts"
   ],
+  "exports": {
+    ".": "./index.js",
+    "./react-router-dom": "./react-router-dom.js",
+    "./react-redux": "./react-redux.js",
+    "./@reduxjs/toolkit": "./@reduxjs/toolkit.js",
+    "./redux-persist": "./redux-persist.js",
+    "./@tanstack/react-query": "./@tanstack/react-query",
+    "./material-react-table": "./material-react-table",
+    "./@mui/material": "./@mui/material",
+    "./yup": "./yup"
+  },
   "dependencies": {
     "@emotion/react": "^11.14.0",
     "@emotion/styled": "^11.14.1",