@owp/core 1.0.0

package/dist/types/default-settings/OwpDefaultSettings.d.ts

@@ -0,0 +1,640 @@
+import { ThemeOptions } from '@mui/material/styles/createTheme';
+/**
+ * The defaultSettings object defines the default settings for the Owp application.
+ */
+export declare const defaultSettings: {
+    customScrollbars: boolean;
+    direction: string;
+    theme: {
+        main: {
+            palette: {
+                mode: string;
+                text: {
+                    primary: string;
+                    secondary: string;
+                    disabled: string;
+                };
+                common: {
+                    black: string;
+                    white: string;
+                };
+                background: {
+                    paper: string;
+                    default: string;
+                };
+                primary: {
+                    main: string;
+                };
+                secondary: {
+                    main: string;
+                };
+                success: {
+                    main: string;
+                };
+                info: {
+                    main: string;
+                    contrastText: string;
+                };
+                warning: {
+                    main: string;
+                    contrastText: string;
+                };
+                error: {
+                    main: string;
+                };
+            };
+        };
+        navbar: {
+            palette: {
+                mode: string;
+                text: {
+                    primary: string;
+                    secondary: string;
+                    disabled: string;
+                };
+                common: {
+                    black: string;
+                    white: string;
+                };
+                background: {
+                    paper: string;
+                    default: string;
+                };
+                primary: {
+                    main: string;
+                };
+                secondary: {
+                    main: string;
+                };
+                success: {
+                    main: string;
+                };
+                info: {
+                    main: string;
+                    contrastText: string;
+                };
+                warning: {
+                    main: string;
+                    contrastText: string;
+                };
+                error: {
+                    main: string;
+                };
+            };
+        } & {
+            palette: {
+                background: {
+                    default: string;
+                };
+            };
+        };
+        toolbar: {
+            palette: {
+                mode: string;
+                text: {
+                    primary: string;
+                    secondary: string;
+                    disabled: string;
+                };
+                common: {
+                    black: string;
+                    white: string;
+                };
+                background: {
+                    paper: string;
+                    default: string;
+                };
+                primary: {
+                    main: string;
+                };
+                secondary: {
+                    main: string;
+                };
+                success: {
+                    main: string;
+                };
+                info: {
+                    main: string;
+                    contrastText: string;
+                };
+                warning: {
+                    main: string;
+                    contrastText: string;
+                };
+                error: {
+                    main: string;
+                };
+            };
+        } & {
+            palette: {
+                mode: string;
+                background: {
+                    default: string;
+                };
+            };
+        };
+        footer: {
+            palette: {
+                mode: string;
+                text: {
+                    primary: string;
+                    secondary: string;
+                    disabled: string;
+                };
+                common: {
+                    black: string;
+                    white: string;
+                };
+                background: {
+                    paper: string;
+                    default: string;
+                };
+                primary: {
+                    main: string;
+                };
+                secondary: {
+                    main: string;
+                };
+                success: {
+                    main: string;
+                };
+                info: {
+                    main: string;
+                    contrastText: string;
+                };
+                warning: {
+                    main: string;
+                    contrastText: string;
+                };
+                error: {
+                    main: string;
+                };
+            };
+        };
+    };
+};
+/**
+ * The getParsedQuerySettings function parses the query string to retrieve the default settings for the Owp application.
+ * It returns a OwpSettingsConfigType object that can be used to configure the application.
+ */
+export declare function getParsedQuerySettings(): {};
+/**
+ * The defaultThemeOptions object defines the default options for the MUI theme.
+ */
+export declare const defaultThemeOptions: {
+    typography: {
+        fontFamily: string;
+        fontWeightLight: number;
+        fontWeightRegular: number;
+        fontWeightMedium: number;
+    };
+    components: {
+        MuiSvgIcon: {
+            defaultProps: {};
+            styleOverrides: {
+                root: {};
+                sizeSmall: {
+                    width: number;
+                    height: number;
+                };
+                sizeMedium: {
+                    width: number;
+                    height: number;
+                };
+                sizeLarge: {
+                    width: number;
+                    height: number;
+                };
+            };
+        };
+        MuiAppBar: {
+            defaultProps: {
+                enableColorOnDark: boolean;
+            };
+            styleOverrides: {
+                root: {
+                    backgroundImage: string;
+                };
+            };
+        };
+        MuiPickersPopper: {
+            styleOverrides: {
+                root: {
+                    zIndex: number;
+                };
+            };
+        };
+        MuiAutocomplete: {
+            styleOverrides: {
+                popper: {
+                    zIndex: number;
+                };
+            };
+        };
+        MuiButtonBase: {
+            defaultProps: {};
+            styleOverrides: {
+                root: {};
+            };
+        };
+        MuiIconButton: {
+            styleOverrides: {
+                root: {
+                    borderRadius: number;
+                };
+                sizeMedium: {
+                    width: number;
+                    height: number;
+                    maxHeight: number;
+                };
+                sizeSmall: {
+                    width: number;
+                    height: number;
+                    maxHeight: number;
+                };
+                sizeLarge: {
+                    width: number;
+                    height: number;
+                    maxHeight: number;
+                };
+            };
+        };
+        MuiBadge: {
+            defaultProps: {};
+            styleOverrides: {
+                root: {};
+            };
+        };
+        MuiAvatar: {
+            defaultProps: {};
+            styleOverrides: {
+                root: {
+                    width: number;
+                    height: number;
+                };
+            };
+        };
+        MuiButton: {
+            defaultProps: {
+                variant: string;
+                color: string;
+            };
+            styleOverrides: {
+                root: {
+                    textTransform: string;
+                };
+                sizeMedium: {
+                    borderRadius: number;
+                    height: number;
+                    minHeight: number;
+                    maxHeight: number;
+                };
+                sizeSmall: {
+                    borderRadius: number;
+                    height: number;
+                    minHeight: number;
+                    maxHeight: number;
+                };
+                sizeLarge: {
+                    height: number;
+                    minHeight: number;
+                    maxHeight: number;
+                    borderRadius: number;
+                };
+                contained: {
+                    boxShadow: string;
+                    '&:hover, &:focus': {
+                        boxShadow: string;
+                    };
+                };
+            };
+        };
+        MuiButtonGroup: {
+            defaultProps: {
+                color: string;
+            };
+            styleOverrides: {
+                contained: {
+                    borderRadius: number;
+                };
+            };
+        };
+        MuiTab: {
+            styleOverrides: {
+                root: {
+                    textTransform: string;
+                };
+            };
+        };
+        MuiDrawer: {
+            styleOverrides: {
+                paper: {};
+            };
+        };
+        MuiDialog: {
+            styleOverrides: {
+                paper: {
+                    borderRadius: number;
+                };
+            };
+        };
+        MuiPaper: {
+            styleOverrides: {
+                root: {
+                    backgroundImage: string;
+                };
+                rounded: {
+                    borderRadius: number;
+                };
+            };
+        };
+        MuiCard: {
+            styleOverrides: {};
+        };
+        MuiPopover: {
+            styleOverrides: {
+                paper: {
+                    borderRadius: number;
+                };
+            };
+        };
+        MuiTextField: {
+            defaultProps: {
+                color: string;
+            };
+            styleOverrides: {
+                root: {
+                    '& > .MuiFormHelperText-root': {
+                        marginLeft: number;
+                    };
+                };
+            };
+        };
+        MuiInputLabel: {
+            defaultProps: {
+                color: string;
+            };
+            styleOverrides: {
+                shrink: {
+                    transform: string;
+                };
+                root: {
+                    fontSize: string;
+                    transform: string;
+                    '&.Mui-focused': {};
+                };
+            };
+        };
+        MuiSelect: {
+            defaultProps: {
+                color: string;
+            };
+            styleOverrides: {
+                select: {
+                    minHeight: number;
+                };
+            };
+        };
+        MuiFormHelperText: {
+            styleOverrides: {
+                root: {};
+            };
+        };
+        MuiInputAdornment: {
+            styleOverrides: {
+                root: {
+                    marginRight: number;
+                };
+            };
+        };
+        MuiInputBase: {
+            styleOverrides: {
+                root: {
+                    minHeight: number;
+                    borderRadius: number;
+                    lineHeight: number;
+                };
+                legend: {
+                    fontSize: string;
+                };
+                input: {
+                    padding: string;
+                };
+                adornedStart: {
+                    paddingLeft: string;
+                };
+                sizeSmall: {
+                    height: number;
+                    minHeight: number;
+                    borderRadius: number;
+                };
+                sizeMedium: {
+                    height: number;
+                    minHeight: number;
+                    borderRadius: number;
+                };
+                sizeLarge: {
+                    height: number;
+                    minHeight: number;
+                    borderRadius: number;
+                };
+            };
+        };
+        MuiOutlinedInput: {
+            defaultProps: {
+                color: string;
+            };
+            styleOverrides: {
+                root: {};
+                input: {
+                    padding: string;
+                };
+            };
+        };
+        MuiFilledInput: {
+            styleOverrides: {
+                root: {
+                    borderRadius: number;
+                    '&:before, &:after': {
+                        display: string;
+                    };
+                };
+                input: {
+                    padding: string;
+                };
+            };
+        };
+        MuiSlider: {
+            defaultProps: {
+                color: string;
+            };
+        };
+        MuiCheckbox: {
+            defaultProps: {
+                color: string;
+            };
+        };
+        MuiRadio: {
+            defaultProps: {
+                color: string;
+            };
+        };
+        MuiSwitch: {
+            defaultProps: {
+                color: string;
+            };
+        };
+        MuiTypography: {
+            variants: {
+                props: {
+                    color: string;
+                };
+                style: {
+                    color: string;
+                };
+            }[];
+        };
+    };
+};
+/**
+ * The mustHaveThemeOptions object defines the options that must be present in the MUI theme.
+ */
+export declare const mustHaveThemeOptions: {
+    typography: {
+        htmlFontSize: number;
+        fontSize: number;
+        body1: {
+            fontSize: string;
+        };
+        body2: {
+            fontSize: string;
+        };
+    };
+};
+/**
+ * The defaultThemes object defines the default themes for the application.
+ */
+export declare const defaultThemes: {
+    default: {
+        palette: {
+            mode: string;
+            primary: {
+                50: string;
+                100: string;
+                200: string;
+                300: string;
+                400: string;
+                500: string;
+                600: string;
+                700: string;
+                800: string;
+                900: string;
+                A100: string;
+                A200: string;
+                A400: string;
+                A700: string;
+                contrastDefaultColor: string;
+            };
+            secondary: {
+                light: "#29b6f6";
+                main: "#039be5";
+                dark: "#0288d1";
+            };
+            error: {
+                50: "#ffebee";
+                100: "#ffcdd2";
+                200: "#ef9a9a";
+                300: "#e57373";
+                400: "#ef5350";
+                500: "#f44336";
+                600: "#e53935";
+                700: "#d32f2f";
+                800: "#c62828";
+                900: "#b71c1c";
+                A100: "#ff8a80";
+                A200: "#ff5252";
+                A400: "#ff1744";
+                A700: "#d50000";
+            };
+        };
+        status: {
+            danger: string;
+        };
+    };
+    defaultDark: {
+        palette: {
+            mode: string;
+            primary: {
+                50: string;
+                100: string;
+                200: string;
+                300: string;
+                400: string;
+                500: string;
+                600: string;
+                700: string;
+                800: string;
+                900: string;
+                A100: string;
+                A200: string;
+                A400: string;
+                A700: string;
+                contrastDefaultColor: string;
+            };
+            secondary: {
+                light: "#29b6f6";
+                main: "#039be5";
+                dark: "#0288d1";
+            };
+            error: {
+                50: "#ffebee";
+                100: "#ffcdd2";
+                200: "#ef9a9a";
+                300: "#e57373";
+                400: "#ef5350";
+                500: "#f44336";
+                600: "#e53935";
+                700: "#d32f2f";
+                800: "#c62828";
+                900: "#b71c1c";
+                A100: "#ff8a80";
+                A200: "#ff5252";
+                A400: "#ff1744";
+                A700: "#d50000";
+            };
+        };
+        status: {
+            danger: string;
+        };
+    };
+};
+/**
+ * The extendThemeWithMixins function extends the theme with mixins.
+ */
+export declare function extendThemeWithMixins(obj: ThemeOptions): {
+    border: (width?: number) => {
+        borderWidth: number;
+        borderStyle: string;
+        borderColor: string;
+    };
+    borderLeft: (width?: number) => {
+        borderLeftWidth: number;
+        borderStyle: string;
+        borderColor: string;
+    };
+    borderRight: (width?: number) => {
+        borderRightWidth: number;
+        borderStyle: string;
+        borderColor: string;
+    };
+    borderTop: (width?: number) => {
+        borderTopWidth: number;
+        borderStyle: string;
+        borderColor: string;
+    };
+    borderBottom: (width?: number) => {
+        borderBottomWidth: number;
+        borderStyle: string;
+        borderColor: string;
+    };
+};

package/dist/types/hooks/useCommonCodeList.d.ts

@@ -0,0 +1,11 @@
+import { CommonCode } from '@/utils/CommonCodeUtils';
+export declare const useGetCommonCodeList: () => {
+    [codeId: string]: CommonCode[];
+};
+export declare const useSetCommonCodeList: () => (args_0: {
+    [codeId: string]: CommonCode[];
+} | typeof import("jotai/utils").RESET | ((prev: {
+    [codeId: string]: CommonCode[];
+}) => {
+    [codeId: string]: CommonCode[];
+} | typeof import("jotai/utils").RESET)) => void;

package/dist/types/hooks/useConfirm.d.ts

@@ -0,0 +1,23 @@
+import { ButtonProps } from '@mui/material';
+import { ReactNode } from 'react';
+export interface ConfirmProps {
+    title?: ReactNode | string;
+    okText?: string;
+    cancelText?: string;
+    severity?: 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning';
+    useInfo?: boolean;
+    okButtonProps?: ButtonProps;
+    onClose?: (result: boolean) => Promise<void>;
+}
+interface ConfirmBaseProps extends ConfirmProps {
+    okButtonProps?: ButtonProps;
+    cancelButtonProps?: ButtonProps;
+}
+export declare const useConfirm: () => {
+    confirm: (props: ConfirmBaseProps) => Promise<boolean>;
+    confirmInfo: ({ title, okText, severity }?: ConfirmProps | undefined) => Promise<boolean>;
+    confirmSave: ({ title, okText, cancelText, okButtonProps, }?: ConfirmProps | undefined) => Promise<boolean>;
+    confirmUpdate: ({ title, okText, cancelText, okButtonProps, }?: ConfirmProps | undefined) => Promise<boolean>;
+    confirmDelete: ({ title, okText, cancelText, okButtonProps, }?: ConfirmProps | undefined) => Promise<boolean>;
+};
+export {};

package/dist/types/hooks/useCurrentLanguage.d.ts

@@ -0,0 +1,13 @@
+export type CurrentLanguage = {
+    id: 'en' | 'kr' | 'lc';
+    title: string;
+    flag: string;
+};
+export declare const FALLBACK_LANGUAGE_LIST: string[];
+export declare const useGetLanguageList: () => {
+    id: string;
+    title: string;
+    flag: string;
+}[];
+export declare const useGetCurrentLanguage: () => CurrentLanguage;
+export declare const useSetCurrentLanguage: () => (args_0: typeof import("jotai/utils").RESET | CurrentLanguage | ((prev: CurrentLanguage) => typeof import("jotai/utils").RESET | CurrentLanguage)) => void;

package/dist/types/hooks/useCurrentLogoSrc.d.ts

@@ -0,0 +1,2 @@
+export declare const useGetCurrentLogoSrc: () => string;
+export declare const useSetCurrentLogoSrc: () => (args_0: string | typeof import("jotai/utils").RESET | ((prev: string) => string | typeof import("jotai/utils").RESET)) => void;

package/dist/types/hooks/useCurrentUserId.d.ts

@@ -0,0 +1,2 @@
+export declare const useGetCurrentUserId: () => string;
+export declare const useSetCurrentUserId: () => (args_0: string | typeof import("jotai/utils").RESET | ((prev: string) => string | typeof import("jotai/utils").RESET)) => void;

package/dist/types/hooks/useDebounce.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Debounce hook.
+ * @param {T} callback
+ * @param {number} delay
+ * @returns {T}
+ */
+export declare function useDebounce<T extends (...args: never[]) => void>(callback: T, delay: number): T;