@js-smart/react-kit 5.12.0-beta.3 → 5.12.0

package/lib/components/CenteredCircularProgress.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Reusable Circular Progress component
+ *
+ * @author Pavan Kumar Jadda
+ * @since 0.1.0
+ */
+export declare function CenteredCircularProgress(): import("react/jsx-runtime").JSX.Element;

package/lib/components/ConfirmationDialog.d.ts

@@ -0,0 +1,11 @@
+interface ConfirmDialogProps {
+    id: string;
+    keepMounted: boolean;
+    title?: string;
+    message: string;
+    value: string;
+    open: boolean;
+    onClose: (value: string) => void;
+}
+export declare function ConfirmDialog(props: ConfirmDialogProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/lib/components/DismissibleAlert.d.ts

@@ -0,0 +1,17 @@
+import { AlertColor } from '@mui/material';
+/**
+ * Dismissible Alert properties
+ *
+ * @author Pavan Kumar Jadda
+ * @since 0.2.17
+ */
+type DismissibleAlertProps = {
+    message: string;
+    severity: AlertColor;
+    className?: string;
+    dismissible?: boolean;
+    dismissOnTimeOut?: boolean;
+    dismissTimeOut?: number;
+};
+export declare function DismissibleAlert(props: Readonly<DismissibleAlertProps>): import("react/jsx-runtime").JSX.Element;
+export {};

package/lib/components/NextLink.d.ts

@@ -0,0 +1,17 @@
+import { default as React } from 'react';
+interface Props {
+    href: string;
+    linkText?: string;
+    target?: string;
+    children?: React.ReactNode;
+}
+/**
+ * Reusable custom Next.js 13 Link component.
+ *
+ * @param props Properties of the React Node
+ *
+ * @author Pavan Kumar Jadda
+ * @since 0.3.2
+ */
+export declare function NextLink(props: Readonly<Props>): React.JSX.Element;
+export {};

package/lib/components/OpenInNewIconLink.d.ts

@@ -0,0 +1,17 @@
+import { default as React } from 'react';
+interface Props {
+    href: string;
+    linkText: string;
+    target: string;
+    children?: React.ReactNode;
+}
+/**
+ * Reusable component to open a link in new tab and show open new icon at the end
+ *
+ * @param props Properties of the component
+ *
+ * @author Pavan Kumar Jadda
+ * @since 1.2.24
+ */
+export declare function OpenInNewIconLink(props: Readonly<Props>): import("react/jsx-runtime").JSX.Element;
+export {};

package/lib/components/ReactIf.d.ts

@@ -0,0 +1,36 @@
+import { default as React, ReactNode } from 'react';
+type ReactIfProps = {
+    /**
+     * The condition that determines whether children should be rendered
+     */
+    condition: boolean | null | undefined;
+    /**
+     * Content to render when condition is true.
+     * Can be either a ReactNode or a function returning a ReactNode
+     */
+    children: ReactNode | (() => ReactNode);
+    /**
+     * Optional content to render when condition is false
+     */
+    else?: ReactNode | (() => ReactNode);
+};
+/**
+ * Reusable If component, that renders content if the condition is true. Similar to *ngIf from Angular
+ *
+ * @param props Properties of the component
+ *
+ * @example
+ * ```tsx
+ * <ReactIf condition={isVisible}>
+ *   <div>Visible content</div>
+ * </ReactIf>
+ *
+ * <ReactIf condition={isVisible} else={<div>Alternative content</div>}>
+ *   <div>Main content</div>
+ * </ReactIf>
+ *```
+ * @author Pavan Kumar Jadda
+ * @since 0.1.0
+ */
+export declare function ReactIf(props: ReactIfProps): React.ReactNode;
+export {};

package/lib/components/buttons/CancelButton.d.ts

@@ -0,0 +1,28 @@
+import { default as React } from 'react';
+import { SxProps, Theme } from '@mui/material';
+/**
+ * Reusable Success Button component properties
+ *
+ * @author Pavan Kumar Jadda
+ * @since 1.2.14
+ */
+interface CancelButtonProps {
+    children?: React.ReactNode;
+    className?: string;
+    name?: string;
+    dataCy?: string;
+    sx?: SxProps<Theme>;
+    type?: 'button' | 'submit' | 'reset';
+    variant?: 'text' | 'outlined' | 'contained';
+    color?: 'inherit' | 'primary' | 'secondary' | 'success' | 'error' | 'info' | 'warning';
+    onClick: () => void;
+    startIcon?: React.ReactNode;
+}
+/**
+ * Reusable Cancel Button component
+ *
+ * @author Pavan Kumar Jadda
+ * @since 1.2.14
+ */
+export declare function CancelButton(props: CancelButtonProps): React.JSX.Element;
+export {};

package/lib/components/buttons/DeleteButton.d.ts

@@ -0,0 +1,16 @@
+import { default as React } from 'react';
+interface DeleteButtonProps {
+    loading: boolean;
+    label?: string;
+    loadingLabel?: string;
+    loadingPosition?: 'start' | 'end' | 'center';
+    type?: 'button' | 'submit' | 'reset' | undefined;
+    variant?: 'text' | 'outlined' | 'contained';
+    color?: 'inherit' | 'primary' | 'secondary' | 'success' | 'error' | 'info' | 'warning';
+    name?: string;
+    dataCy?: string;
+    startIcon?: React.ReactNode;
+    onClick: () => void;
+}
+export declare function DeleteButton(props: DeleteButtonProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/lib/components/buttons/EditIconButton.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+interface EditIconButtonProps {
+    tooltipTitle: string;
+    onClick: React.Dispatch<React.SetStateAction<boolean>>;
+    color?: 'inherit' | 'default' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning';
+}
+export declare function EditIconButton(props: Readonly<EditIconButtonProps>): import("react/jsx-runtime").JSX.Element;
+export {};

package/lib/components/buttons/ExcelButton.d.ts

@@ -0,0 +1,26 @@
+import { default as React } from 'react';
+import { SxProps, Theme } from '@mui/material';
+/**
+ * Reusable Excel Button component properties
+ *
+ * @author Pavan Kumar Jadda
+ * @since 1.2.9
+ */
+interface SuccessButtonProps {
+    children?: React.ReactNode;
+    className?: string;
+    name?: string;
+    sx?: SxProps<Theme>;
+    type?: 'button' | 'submit' | 'reset';
+    onClick: () => void;
+    startIcon?: React.ReactNode;
+    dataCy?: string;
+}
+/**
+ * Reusable Excel Button component
+ *
+ * @author Pavan Kumar Jadda
+ * @since 1.2.9
+ */
+export declare function ExcelButton(props: SuccessButtonProps): React.JSX.Element;
+export {};

package/lib/components/buttons/GoBackButton.d.ts

@@ -0,0 +1,10 @@
+import { default as React } from 'react';
+import { NavigateFunction } from 'react-router-dom';
+interface GoBackButtonProps {
+    name?: string;
+    children?: React.ReactNode;
+    navigate: NavigateFunction;
+    color?: 'inherit' | 'primary' | 'secondary' | 'success' | 'error' | 'info' | 'warning';
+}
+export declare function GoBackButton(props: GoBackButtonProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/lib/components/buttons/HistoryButton.d.ts

@@ -0,0 +1,28 @@
+import { default as React } from 'react';
+import { SxProps, Theme } from '@mui/material';
+/**
+ * Reusable History Button component properties
+ *
+ * @author Pavan Kumar Jadda
+ * @since 1.2.15
+ */
+interface HistoryButtonProps {
+    children?: React.ReactNode;
+    className?: string;
+    name?: string;
+    dataCy?: string;
+    sx?: SxProps<Theme>;
+    type?: 'button' | 'submit' | 'reset';
+    onClick: () => void;
+    startIcon?: React.ReactNode;
+    variant?: 'text' | 'outlined' | 'contained';
+    color?: 'inherit' | 'primary' | 'secondary' | 'success' | 'error' | 'info' | 'warning';
+}
+/**
+ * Reusable History Button component
+ *
+ * @author Pavan Kumar Jadda
+ * @since 1.2.15
+ */
+export declare function HistoryButton(props: HistoryButtonProps): React.JSX.Element;
+export {};

package/lib/components/buttons/LoadingSuccessButton.d.ts

@@ -0,0 +1,28 @@
+import { default as React } from 'react';
+import { SxProps, Theme } from '@mui/material';
+/**
+ * Reusable Success Button component properties
+ *
+ * @author Pavan Kumar Jadda
+ * @since 0.3.3
+ */
+interface Props {
+    children?: React.ReactNode;
+    type?: 'button' | 'submit' | 'reset';
+    name?: string;
+    loading: boolean;
+    dataCy?: string;
+    startIcon?: React.ReactNode;
+    sx?: SxProps<Theme>;
+    onClick?: () => void;
+    variant?: 'text' | 'outlined' | 'contained';
+    color?: 'inherit' | 'primary' | 'secondary' | 'success' | 'error' | 'info' | 'warning';
+}
+/**
+ * Reusable Success Loading Button
+ *
+ * @author Pavan Kumar Jadda
+ * @since 0.1.0
+ */
+export declare function LoadingSuccessButton(props: Props): import("react/jsx-runtime").JSX.Element;
+export {};

package/lib/components/buttons/ManageButton.d.ts

@@ -0,0 +1,14 @@
+import { default as React } from 'react';
+interface ManageButtonProps {
+    size?: 'small' | 'medium' | 'large';
+    variant?: 'text' | 'outlined' | 'contained';
+    color?: 'inherit' | 'primary' | 'secondary' | 'success' | 'error' | 'info' | 'warning';
+    className?: string;
+    name?: string;
+    dataCy?: string;
+    startIcon?: React.ReactNode;
+    onClick: () => void;
+    children?: React.ReactNode;
+}
+export declare function ManageButton(props: ManageButtonProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/lib/components/buttons/SuccessButton.d.ts

@@ -0,0 +1,28 @@
+import { default as React } from 'react';
+import { SxProps, Theme } from '@mui/material';
+/**
+ * Reusable Success Button component properties
+ *
+ * @author Pavan Kumar Jadda
+ * @since 0.3.3
+ */
+interface SuccessButtonProps {
+    children?: React.ReactNode;
+    className?: string;
+    name?: string;
+    dataCy?: string;
+    sx?: SxProps<Theme>;
+    type?: 'button' | 'submit' | 'reset';
+    onClick: () => void;
+    startIcon?: React.ReactNode;
+    variant?: 'text' | 'outlined' | 'contained';
+    color?: 'inherit' | 'primary' | 'secondary' | 'success' | 'error' | 'info' | 'warning';
+}
+/**
+ * Reusable Success Button component
+ *
+ * @author Pavan Kumar Jadda
+ * @since 0.1.0
+ */
+export declare function SuccessButton(props: SuccessButtonProps): React.JSX.Element;
+export {};

package/lib/components/snack-bar/AppSnackBar.d.ts

@@ -0,0 +1,6 @@
+import { ProgressState } from '../../types/ProgressState';
+export declare const AppSnackBar: (props: {
+    open: boolean;
+    progressState: ProgressState;
+    autoHideDuration?: number;
+}) => import("react/jsx-runtime").JSX.Element;

package/lib/components/snack-bar/QuerySnackBar.d.ts

@@ -0,0 +1,18 @@
+interface QuerySnackBarProps {
+    open: boolean;
+    isPending?: boolean;
+    isSuccess: boolean;
+    isError: boolean;
+    message: string;
+    autoHideDuration?: number;
+}
+/**
+ * Reusable component to display snackbar based on React Query mutation state
+ *
+ * @param props QuerySnackBarProps
+ *
+ * @author Pavan Kumar Jadda
+ * @since 1.2.27
+ */
+export declare const QuerySnackBar: (props: QuerySnackBarProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/lib/components/table/TablePaginationActions.d.ts

@@ -0,0 +1,9 @@
+import { default as React } from 'react';
+interface TablePaginationActionsProps {
+    count: number;
+    page: number;
+    rowsPerPage: number;
+    onPageChange: (event: React.MouseEvent<HTMLButtonElement>, newPage: number) => void;
+}
+export declare function TablePaginationActions(props: TablePaginationActionsProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/lib/components/tabs/TabPanel.d.ts

@@ -0,0 +1,12 @@
+import { default as React } from 'react';
+export declare function TabPanel(props: TabPanelProps): import("react/jsx-runtime").JSX.Element;
+export declare function a11yProps(index: number): {
+    id: string;
+    'aria-controls': string;
+};
+interface TabPanelProps {
+    children?: React.ReactNode;
+    index: number;
+    value: string;
+}
+export {};

package/lib/config/fetch/FetchClient.d.ts

@@ -0,0 +1,58 @@
+import { FetchError, FetchResponse, RequestConfig } from './FetchClientTypes';
+/**
+ * Reusable fetch client class
+ *
+ * @author Pavan Kumar Jadda
+ * @since 0.2.19
+ */
+declare class FetchInstance {
+    private readonly baseURL;
+    private requestInterceptors;
+    private responseInterceptors;
+    private errorInterceptors;
+    /**
+     * Add request interceptor
+     */
+    interceptors: {
+        request: {
+            use: (interceptor: (config: RequestConfig) => RequestConfig | Promise<RequestConfig>) => void;
+        };
+        response: {
+            use: (successInterceptor?: (response: FetchResponse<unknown>) => FetchResponse<unknown> | Promise<FetchResponse<unknown>>, errorInterceptor?: (error: FetchError) => FetchError | Promise<FetchError> | void | Promise<void>) => void;
+        };
+    };
+    constructor(baseURL?: string);
+    /**
+     * GET request
+     */
+    get<T = unknown>(url: string, config?: Omit<RequestConfig, 'method' | 'url'>): Promise<FetchResponse<T>>;
+    /**
+     * POST request
+     */
+    post<T = unknown>(url: string, data?: unknown, config?: Omit<RequestConfig, 'method' | 'url' | 'body'>): Promise<FetchResponse<T>>;
+    /**
+     * PUT request
+     */
+    put<T = unknown>(url: string, data?: unknown, config?: Omit<RequestConfig, 'method' | 'url' | 'body'>): Promise<FetchResponse<T>>;
+    /**
+     * DELETE request
+     */
+    delete<T = unknown>(url: string, config?: Omit<RequestConfig, 'method' | 'url'>): Promise<FetchResponse<T>>;
+    /**
+     * PATCH request
+     */
+    patch<T = unknown>(url: string, data?: unknown, config?: Omit<RequestConfig, 'method' | 'url' | 'body'>): Promise<FetchResponse<T>>;
+    /**
+     * Generic request method
+     */
+    request<T = unknown>(config: RequestConfig): Promise<FetchResponse<T>>;
+    /**
+     * Execute request with interceptors
+     */
+    private executeRequest;
+}
+/**
+ * Callable fetch client that defaults to GET requests
+ */
+export declare const FetchClient: (<T = unknown>(url: string, config?: Omit<RequestConfig, "method" | "url">) => Promise<T>) & FetchInstance;
+export default FetchClient;

package/lib/config/fetch/FetchClientTypes.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Interface for error response structure
+ */
+export interface ErrorResponse {
+    message: string;
+    errorCode: string | null;
+    status: string;
+    statusCode: number;
+    timestamp: string;
+    errors: unknown[] | null;
+    path: string | null;
+}
+/**
+ * Interface for request configuration
+ */
+export interface RequestConfig extends RequestInit {
+    baseURL?: string;
+    url?: string;
+    params?: Record<string, string | number | boolean>;
+}
+/**
+ * Interface for response structure
+ */
+export interface FetchResponse<T = unknown> {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: Headers;
+    config: RequestConfig;
+}
+/**
+ * Interface for error structure
+ */
+export interface FetchError extends Error {
+    statusCode: number;
+    originalError: Error;
+    response?: Response;
+    request?: Request;
+}

package/lib/config/fetch/FetchInterceptor.d.ts

@@ -0,0 +1,21 @@
+import { default as React } from 'react';
+import { FetchError } from './FetchClientTypes';
+/**
+ * Adds error handling interceptor
+ *
+ * @author Pavan Kumar Jadda
+ * @since 1.1.1
+ */
+export declare const FetchInterceptor: (props: {
+    children: React.JSX.Element;
+}) => React.JSX.Element;
+/**
+ * Creates a formatted error object with additional context
+ * @param error The original error
+ * @param statusCode HTTP status code
+ * @param message Error message
+ * @param response Response object
+ * @param request Request object
+ * @returns Formatted error object
+ */
+export declare const createFormattedError: (error: Error, statusCode: number, message: string, response?: Response, request?: Request) => FetchError;

package/lib/constants/AppConstants.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Global System settings used in the application
+ *
+ * @author Pavan Kumar Jadda
+ * @since 1.0.0
+ */
+export declare enum SystemConfig {
+    SYSTEM_TIME_ZONE = "America/New_York",
+    SYSTEM_LOCALE = "en-US",
+    SYSTEM_DATE_FORMAT = "MM/dd/yyyy",
+    SYSTEM_DATE_TIME_FORMAT = "MM/dd/yyyy hh:mm:ss a",
+    ISO_DATE_FORMAT = "yyyy-MM-dd",
+    SYSTEM_COOKIE_TIMEOUT_HOURS = 24,
+    SYSTEM_COOKIE_TIMEOUT_MILLI_SECONDS = 3600000
+}

package/lib/constants/HttpConstants.d.ts

@@ -0,0 +1,13 @@
+export declare const HTTP_200 = 200;
+export declare const HTTP_201 = 201;
+export declare const HTTP_401 = 401;
+export declare const HTTP_403 = 403;
+export declare const HTTP_404 = 404;
+export declare const HTTP_405 = 405;
+export declare const HTTP_409 = 409;
+export declare const HTTP_500 = 500;
+export declare const HTTP_501 = 501;
+export declare const HTTP_502 = 502;
+export declare const HTTP_503 = 503;
+export declare const HTTP_504 = 504;
+export declare const HTTP_505 = 505;

package/lib/types/ProgressState.d.ts

@@ -0,0 +1,7 @@
+export interface ProgressState {
+    isLoading: boolean;
+    isSuccess: boolean;
+    isError: boolean;
+    isComplete: boolean;
+    message: string;
+}

package/lib/utils/BooleanUtils.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns `true` if the provided string is `undefined`, `null` or empty '' string otherwise returns false
+ *
+ * @author Pavan Kumar Jadda
+ * @since 0.1.0
+ */
+export declare function parseBoolean(value: boolean | string | null | undefined): boolean;

package/{react-kit/src/lib/utils/CssUtils.ts → lib/utils/CssUtils.d.ts}

@@ -8,6 +8,4 @@
  * @author Pavan Kumar Jadda
  * @since 1.6.0
  */
-export function getCssVariable(variable: string): string {
-	return getComputedStyle(document.documentElement).getPropertyValue(variable).trim();
-}
+export declare function getCssVariable(variable: string): string;

package/lib/utils/DateUtils.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Sets Cookie expiration to 24 hours. By default, server sets 60 minutes expiration but after each API request it extends to another 60 minutes. In client side set 24 hours as expiration date,
+ * if the user hasn't refreshed web page in 60 minutes, they would get HTTP 401 isError and redirected to login page. And redirect URL will be stored in cookie
+ *
+ * @author Pavan Kumar Jadda
+ * @since 0.2.30
+ */
+export declare const setCookieExpirationDate: () => Date;
+/**
+ * Convert String format browser Date Time to ISO Date
+ *
+ * @author Pavan Kumar Jadda
+ * @since 0.2.30
+ */
+export declare const convertToIsoDate: (currentDateTime: string) => string;
+/**
+ * Convert String format browser Date Time to ISO Date
+ *
+ * @author Pavan Kumar Jadda
+ * @since 0.2.30
+ */
+export declare const formatDate: (date: string | undefined, newFormat: string) => string;

package/lib/utils/NumberUtils.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns number parsed from the given string
+ *
+ * @author Pavan Kumar Jadda
+ * @since 0.3.5
+ */
+export declare function parseNumber(value: string | null | undefined): number | undefined;

package/lib/utils/ProgressStateUtils.d.ts

@@ -0,0 +1,38 @@
+import { ProgressState } from '../types/ProgressState';
+/**
+ * Initialize Loading or Update ProgressState
+ *
+ * @return Updated State Object
+ *
+ * @author Pavan Kumar Jadda
+ * @since 1.4.6
+ */
+export declare const initializeState: () => ProgressState;
+/**
+ * Initialize Loading or Update ProgressState
+ *
+ * @param progressState Object to initialize
+ * @return ProgressState Updated State Object
+ *
+ * @author Pavan Kumar Jadda
+ * @since 0.2.30
+ */
+export declare const markLoading: (progressState: ProgressState) => ProgressState;
+/**
+ * Update state as isSuccess
+ *
+ * @return ProgressState Updated State Object
+ *
+ * @author Pavan Kumar Jadda
+ * @since 0.2.30
+ */
+export declare const markSuccess: (progressState: ProgressState, message?: string) => ProgressState;
+/**
+ * Update state as failure or isError
+ *
+ * @return ProgressState Updated State Object
+ *
+ * @author Pavan Kumar Jadda
+ * @since 0.2.30
+ */
+export declare const markError: (progressState: ProgressState, message?: string) => ProgressState;

package/lib/utils/StringUtils.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns `true` if the provided string is `undefined`, `null` or empty '' string otherwise returns false
+ *
+ * @author Pavan Kumar Jadda
+ * @since 0.1.0
+ */
+export declare function isBlankOrEmpty(value: any): boolean;

package/lib/utils/UrlUtils.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Checks if the given URL is encoded or not
+ *
+ * @param url The URL to check
+ *
+ * @returns True if the URL is encoded, false otherwise
+ *
+ * @author Pavan Kumar Jadda
+ * @since 1.3.14
+ */
+export declare const isEncoded: (url: string) => boolean;