@kcndigitals/lib 1.0.0 → 1.0.2

package/dist/index.d.ts

@@ -0,0 +1,331 @@
+import { AxiosInstance } from 'axios';
+import { ButtonProps } from '@mui/material';
+import { CheckboxProps } from '@mui/material';
+import { default as default_2 } from 'react';
+import { DetailedHTMLProps } from 'react';
+import { DialogProps } from '@mui/material';
+import { Dispatch } from 'react';
+import { HTMLAttributes } from 'react';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { MUIStyledCommonProps } from '@mui/system';
+import * as React_2 from 'react';
+import { ReactNode } from 'react';
+import { SelectChangeEvent } from '@mui/material';
+import { SelectProps } from '@mui/material';
+import { SetStateAction } from 'react';
+import { StyledComponent } from '@emotion/styled';
+import { TextFieldProps } from '@mui/material';
+import { Theme } from '@mui/system';
+import { TypographyProps } from '@mui/material';
+
+export declare const addDaysToDate: (dateStr: string | Date, daysToAdd: number) => Date;
+
+declare interface AuthContextType {
+    username: string | null;
+    fullname: string | null;
+    token: string | null;
+    refreshToken: string | null;
+    isLoading: boolean;
+    login: (user: string, fullname: string, token: string, refreshToken: string) => void;
+    logout: () => void;
+}
+
+export declare const AuthProvider: default_2.FC<{
+    children: ReactNode;
+}>;
+
+export declare const AutoLogin: ({ onComplete }: {
+    onComplete: () => void;
+}) => null;
+
+declare type ButtonType = 'Save' | 'AddNew' | 'Edit' | 'Delete' | 'Refresh' | 'Display' | '';
+
+export declare function clearAllCheckboxes(setters: React.Dispatch<React.SetStateAction<boolean>>[]): void;
+
+export declare const clearAllTextFields: () => void;
+
+export declare const clearSingleTextField: (id: string) => void;
+
+declare interface Column<T> {
+    label: string;
+    valueAccessor: (item: T) => string | number;
+    align?: 'left' | 'center' | 'right';
+    width?: string;
+    summaryKey?: keyof T;
+    backgroundColor?: string | ((item: T) => string);
+}
+
+export declare const compareTwoDates: (firstDate: string, secondDate: string) => boolean;
+
+export declare const ConfirmDialogBox: ({ title, children, open, setOpen, onConfirm, onReject }: ConfirmDialogBoxProps) => JSX_2.Element;
+
+declare interface ConfirmDialogBoxProps {
+    title: string;
+    children?: default_2.ReactNode;
+    open: boolean;
+    setOpen: (open: boolean) => void;
+    onConfirm: () => void;
+    onReject: () => void;
+}
+
+export declare const ContactUs: ({ companyName, website, contactPerson, phoneNumber, backgroundColor, }: ContactUsProps) => JSX_2.Element;
+
+declare interface ContactUsProps {
+    companyName: string;
+    website: string;
+    contactPerson: string;
+    phoneNumber: string;
+    backgroundColor?: string;
+}
+
+export declare function convertToProperCase(str: string): string;
+
+export declare const DELETE_MSG_TITLE = "Delete Information";
+
+export declare const ERROR_MSG_TITLE = "Error Information";
+
+export declare const ForgotPassword: () => JSX_2.Element;
+
+export declare const formatDate: (isoDateString: string, type: formatType) => string;
+
+/**
+ * Formats a number to Indian number format with comma separators.
+ * E.g. 105621.64 => "1,05,621.64"
+ *
+ * @param value - number to format
+ * @returns formatted string with commas
+ */
+export declare function formatNumberWithCommas(value: number | string): string;
+
+export declare type formatType = 'dd-mm-yyyy' | 'yyyy-mm-dd' | 'mm-dd-yyyy' | 'MMMM yyyy';
+
+export declare const FormTemplate: ({ heading, onClose, children, width, backTo }: FormTemplateProps) => JSX_2.Element;
+
+declare type FormTemplateProps = {
+    heading: string;
+    onClose?: () => void;
+    children: default_2.ReactNode;
+    width?: string | number;
+    backTo?: string;
+};
+
+export declare const getDateFromString: (dateString: string) => Date;
+
+export declare const getFormattedDate: () => string;
+
+export declare const getFormattedTime: () => string;
+
+export declare const getInputValue: (id: string, type: InputValueType) => string | number | boolean;
+
+export declare const getMonthName: (month: number) => string;
+
+export declare const getRequestOptions: () => {
+    crossDomain: boolean;
+    method: string;
+    headers: {
+        'Content-Type': string;
+        Authorization: string;
+    };
+};
+
+export declare const getResetPasswordURL: () => string;
+
+export declare const getServerIP: () => string;
+
+export declare const HS_TAG = "Housing_Society";
+
+declare type InputType = 'text' | 'number' | 'date' | 'email' | 'password' | 'multiline';
+
+export declare type InputValueType = 'string' | 'number' | 'boolean';
+
+export declare const INVENTORY_TAG = "Inventory";
+
+export declare const InventoryLogin: () => JSX_2.Element;
+
+export declare const isValidDate: (dateStr: string) => boolean;
+
+export declare function isValidDateForYearMonth(date: Date, year: number, month: number): boolean;
+
+export declare function isValidTime(time: string): boolean;
+
+export declare function ListRecords<T>({ showList, data, columns, onEdit, onDelete, showEditColumn, showDeleteColumn, noRecordsMessage, summaryOptions, tableHeight, }: ListRecordsProps<T>): JSX_2.Element | null;
+
+export declare const ListRecordsDiv: StyledComponent<MUIStyledCommonProps<Theme> & {
+maxHeight?: string;
+}, DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
+
+declare interface ListRecordsProps<T> {
+    showList?: boolean;
+    data: T[];
+    columns: Column<T>[];
+    onEdit?: (item: T) => void;
+    onDelete?: (item: T) => void;
+    showEditColumn?: boolean;
+    showDeleteColumn?: boolean;
+    noRecordsMessage?: string;
+    summaryOptions?: SummaryOption<T>[];
+    tableHeight?: string;
+}
+
+export declare const Login: ({ tag }: LoginProps) => JSX_2.Element;
+
+declare interface LoginProps {
+    tag: LoginTag;
+}
+
+export declare enum LoginTag {
+    Inventory = "Inventory",
+    Stock = "Stock",
+    Housing_Society = "Housing_Society"
+}
+
+export declare const MAIN_MENU_ROUTE = "/mainmenu";
+
+export declare interface MainMenuItem {
+    label: string;
+    icon: ReactNode;
+    type: 'link' | 'submenu' | 'logout';
+    path?: string;
+    submenuItems?: SubMenuItem[];
+}
+
+export declare function MessageBox({ open, onClose, children, title }: MessageBoxProps): JSX_2.Element;
+
+declare interface MessageBoxProps {
+    open: boolean;
+    onClose: () => void;
+    children: default_2.ReactNode;
+    title: string;
+}
+
+export declare const ModalTemplate: ({ open, heading, onClose, children, width, maxWidth, }: ModalTemplateProps) => JSX_2.Element;
+
+declare type ModalTemplateProps = {
+    open: boolean;
+    heading: string;
+    onClose: () => void;
+    children: default_2.ReactNode;
+    width?: string | number;
+    maxWidth?: DialogProps['maxWidth'];
+};
+
+export declare const monthList: {
+    monthId: number;
+    monthName: string;
+}[];
+
+export declare const postRequestOptions: () => {
+    crossDomain: boolean;
+    method: string;
+    headers: {
+        'Content-Type': string;
+        Authorization: string;
+    };
+};
+
+export declare const printToExcel: (Heading: any[], dataToPopulate: any[], sheetName: string, fileName: string) => void;
+
+export declare const ProtectedRoute: ({ children }: ProtectedRouteProps) => JSX_2.Element;
+
+declare interface ProtectedRouteProps {
+    children: React_2.ReactNode;
+}
+
+export declare const ReButton: default_2.FC<ReButtonProps>;
+
+declare interface ReButtonProps extends ButtonProps {
+    id: string;
+    label: string;
+    buttonType: ButtonType;
+}
+
+/**
+ * Reusable Checkbox component
+ * Fully controlled and parameterized
+ */
+export declare const ReCheckbox: default_2.FC<ReCheckboxProps>;
+
+declare interface ReCheckboxProps extends Omit<CheckboxProps, "onChange"> {
+    /** Label text shown beside the checkbox */
+    label: string;
+    /** Checkbox state - controlled from parent */
+    checked: boolean;
+    /** Callback when checkbox value changes */
+    onChange: (event: default_2.ChangeEvent<HTMLInputElement>, checked: boolean) => void;
+    /** Optional unique id for accessibility */
+    id?: string;
+}
+
+export declare const ReInputLabel: ({ labelValue, variant, bold, italic }: ReInputLabelProps) => JSX_2.Element;
+
+declare interface ReInputLabelProps {
+    labelValue: string;
+    variant?: TypographyProps['variant'];
+    bold?: boolean;
+    italic?: boolean;
+}
+
+export declare function ReSelect<T>({ id, value, options, getOptionLabel, getOptionValue, onChange, width, disabled, sx, ...rest }: ReSelectProps<T>): JSX_2.Element;
+
+declare interface ReSelectProps<T> extends Omit<SelectProps, 'value' | 'onChange' | 'children'> {
+    id: string;
+    value: string | number;
+    options: T[];
+    getOptionLabel: (option: T) => string;
+    getOptionValue: (option: T) => string | number;
+    onChange?: (event: SelectChangeEvent<any>) => void;
+    width?: number | string;
+    disabled?: boolean;
+}
+
+export declare const ResetPassword: default_2.FC;
+
+export declare const ReTextField: ({ id, value, onChange, type, label, placeholder, format, width, size, sx, ...rest }: ReTextFieldProps) => JSX_2.Element;
+
+declare interface ReTextFieldProps extends Omit<TextFieldProps, 'type'> {
+    id: string;
+    value?: string | number;
+    type: InputType;
+    format?: string;
+    width?: string | number;
+}
+
+export declare const SAVE_MSG_TITLE = "Save Information";
+
+export declare const setFocus: (controlId: string) => void;
+
+export declare const setInputValue: (id: string, value: number | string | Date) => void;
+
+export declare const setLoginTag: (tag: string) => void;
+
+export declare const SignupForm: default_2.FC;
+
+export declare const STOCK_TAG = "Stock";
+
+export declare const StockLogin: () => JSX_2.Element;
+
+export declare interface SubMenuItem {
+    label: string;
+    path: string;
+    icon: ReactNode;
+}
+
+declare interface SummaryOption<T> {
+    key: keyof T;
+    type: 'sum' | 'average';
+}
+
+export declare const useAdminApi: () => AxiosInstance;
+
+export declare const useAuth: () => AuthContextType;
+
+export declare function useMessageHandler(): {
+    showMessageBox: boolean;
+    title: string;
+    displayMessage: string;
+    showMessage: (isShow: boolean, messageTitle: string, message: string, controlId?: string) => void;
+    setShowMessageBox: Dispatch<SetStateAction<boolean>>;
+    handleCloseMessageBox: () => void;
+};
+
+export { }