@owp/core 1.0.0

package/dist/types/components/layouts/shared-components/navigation/store/navigationSlice.d.ts

@@ -0,0 +1,86 @@
+import { OwpFlatNavItemType, OwpNavItemType } from '@/components/OwpNavigation/types/OwpNavItemType';
+import { AppThunk } from '@/store/store';
+import { WithSlice } from '@reduxjs/toolkit';
+import { PartialDeep } from 'type-fest';
+/**
+ * Redux Thunk actions related to the navigation store state
+ */
+/**
+ * Appends a navigation item to the navigation store state.
+ */
+export declare const appendNavigationItem: (item: OwpNavItemType, parentId?: string | null) => AppThunk;
+/**
+ * Prepends a navigation item to the navigation store state.
+ */
+export declare const prependNavigationItem: (item: OwpNavItemType, parentId?: string | null) => AppThunk;
+/**
+ * Adds a navigation item to the navigation store state at the specified index.
+ */
+export declare const updateNavigationItem: (id: string, item: PartialDeep<OwpNavItemType>) => AppThunk;
+/**
+ * Removes a navigation item from the navigation store state.
+ */
+export declare const removeNavigationItem: (id: string) => AppThunk;
+export declare const selectNavigationAll: (state: {
+    [x: string]: any;
+}) => OwpFlatNavItemType[], selectNavigationIds: (state: {
+    [x: string]: any;
+}) => string[], selectNavigationItemById: (state: {
+    [x: string]: any;
+}, id: string) => {
+    url?: string;
+    auth?: string[] | string;
+    translate?: string;
+    id: string;
+    title?: string;
+    subtitle?: string;
+    icon?: string;
+    iconClass?: string;
+    target?: string;
+    type?: string;
+    disabled?: boolean;
+    active?: boolean;
+    exact?: boolean;
+    end?: boolean;
+    badge?: import("../../../../..").OwpNavBadgeType;
+    hasPermission?: boolean;
+    children?: string[];
+    order: string;
+};
+/**
+ * The navigation slice
+ */
+export declare const navigationSlice: any;
+/**
+ * Lazy load
+ * */
+declare module '@/store/lazyLoadedSlices' {
+    interface LazyLoadedSlices extends WithSlice<typeof navigationSlice> {
+    }
+}
+export declare const setNavigation: any, resetNavigation: any;
+export declare const selectNavigation: any;
+export declare const selectFlatNavigation: ((state: unknown) => OwpFlatNavItemType[]) & {
+    clearCache: () => void;
+    resultsCount: () => number;
+    resetResultsCount: () => void;
+} & {
+    resultFunc: (resultFuncArgs_0: any) => OwpFlatNavItemType[];
+    memoizedResultFunc: ((resultFuncArgs_0: any) => OwpFlatNavItemType[]) & {
+        clearCache: () => void;
+        resultsCount: () => number;
+        resetResultsCount: () => void;
+    };
+    lastResult: () => OwpFlatNavItemType[];
+    dependencies: [any];
+    recomputations: () => number;
+    resetRecomputations: () => void;
+    dependencyRecomputations: () => number;
+    resetDependencyRecomputations: () => void;
+} & {
+    memoize: typeof import("@reduxjs/toolkit").weakMapMemoize;
+    argsMemoize: typeof import("@reduxjs/toolkit").weakMapMemoize;
+};
+export type navigationSliceType = typeof navigationSlice;
+declare const _default: any;
+export default _default;

package/dist/types/components/layouts/shared-components/quickPanel/QuickPanel.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The quick panel.
+ */
+declare function QuickPanel(): import("react/jsx-runtime").JSX.Element;
+export default QuickPanel;

package/dist/types/components/layouts/shared-components/quickPanel/QuickPanelToggleButton.d.ts

@@ -0,0 +1,9 @@
+type QuickPanelToggleButtonProps = {
+    className?: string;
+    children?: React.ReactNode;
+};
+/**
+ * The quick panel toggle button.
+ */
+declare function QuickPanelToggleButton(props: QuickPanelToggleButtonProps): import("react/jsx-runtime").JSX.Element;
+export default QuickPanelToggleButton;

package/dist/types/components/layouts/shared-components/quickPanel/quickPanelSlice.d.ts

@@ -0,0 +1,14 @@
+import type { WithSlice } from '@reduxjs/toolkit';
+/**
+ * Quick Panel data slice.
+ */
+export declare const quickPanelSlice: any;
+declare module '@/store/lazyLoadedSlices' {
+    interface LazyLoadedSlices extends WithSlice<typeof quickPanelSlice> {
+    }
+}
+export declare const selectQuickPanelData: any, selectQuickPanelOpen: any;
+export declare const removeEvents: any, toggleQuickPanel: any, openQuickPanel: any, closeQuickPanel: any;
+export type dataSliceType = typeof quickPanelSlice;
+declare const _default: any;
+export default _default;

package/dist/types/components/layouts/themeLayoutConfigs.d.ts

@@ -0,0 +1,27 @@
+import { ThemeFormConfigTypes } from '@/components/OwpSettings/ThemeFormConfigTypes';
+import { Layout1ConfigDefaultsType } from './layout1/Layout1Config';
+import { Layout2ConfigDefaultsType } from './layout2/Layout2Config';
+import { Layout3ConfigDefaultsType } from './layout3/Layout3Config';
+/**
+ * The type definition for the theme layout defaults.
+ */
+export type themeLayoutDefaultsProps = Layout1ConfigDefaultsType | Layout3ConfigDefaultsType | Layout2ConfigDefaultsType;
+/**
+ * The type definition for the theme layout.
+ */
+export type themeLayoutProps = {
+    title: string;
+    defaults: themeLayoutDefaultsProps;
+    form?: ThemeFormConfigTypes;
+};
+/**
+ * The type definition for the theme layout configs.
+ */
+export type themeLayoutConfigsProps = {
+    [key: string]: themeLayoutProps;
+};
+/**
+ * The theme layout configs.
+ */
+declare const themeLayoutConfigs: themeLayoutConfigsProps;
+export default themeLayoutConfigs;

package/dist/types/components/layouts/themeLayouts.d.ts

@@ -0,0 +1,13 @@
+import React, { ComponentType } from 'react';
+/**
+ * The type definition for the theme layouts.
+ */
+export type themeLayoutsType = {
+    [key: string]: ComponentType<{
+        children?: React.ReactNode;
+    }>;
+};
+/**
+ * The theme layouts.
+ */
+export declare const themeLayouts: themeLayoutsType;

package/dist/types/components/shared-components/LightDarkModeToggle.d.ts

@@ -0,0 +1,8 @@
+import { OwpThemeOption } from '@/components/OwpThemeSelector/ThemePreview';
+type LightDarkModeToggleProps = {
+    className?: string;
+    lightTheme: OwpThemeOption;
+    darkTheme: OwpThemeOption;
+};
+declare function LightDarkModeToggle(props: LightDarkModeToggleProps): import("react/jsx-runtime").JSX.Element;
+export default LightDarkModeToggle;

package/dist/types/components/shared-components/PageBreadcrumb.d.ts

@@ -0,0 +1,6 @@
+import { BreadcrumbsProps } from '@mui/material/Breadcrumbs';
+type PageBreadcrumbProps = BreadcrumbsProps & {
+    className?: string;
+};
+declare function PageBreadcrumb(props: PageBreadcrumbProps): import("react/jsx-runtime").JSX.Element;
+export default PageBreadcrumb;

package/dist/types/components/shared-components/PageTitle.d.ts

@@ -0,0 +1,11 @@
+import { ReactNode } from 'react';
+export type PageTitleProps = {
+    className?: string;
+    title?: string;
+    subtitle?: string;
+    backUrl?: string;
+    backTitle?: string;
+    badgeTitle?: string | ReactNode;
+};
+declare function PageTitle(props: PageTitleProps): import("react/jsx-runtime").JSX.Element;
+export default PageTitle;

package/dist/types/components/shared-components/data-table/DataTable.d.ts

@@ -0,0 +1,3 @@
+import { MaterialReactTableProps } from 'material-react-table';
+declare function DataTable<TData>(props: MaterialReactTableProps<TData>): import("react/jsx-runtime").JSX.Element;
+export default DataTable;

package/dist/types/components/shared-components/data-table/DataTableTopToolbar.d.ts

@@ -0,0 +1,6 @@
+import { MRT_RowData, MRT_TableInstance } from 'material-react-table';
+export interface MRT_TopToolbarProps<TData extends MRT_RowData> {
+    table: MRT_TableInstance<TData>;
+}
+declare function DataTableTopToolbar<TData extends MRT_RowData>({ table }: MRT_TopToolbarProps<TData>): import("react/jsx-runtime").JSX.Element;
+export default DataTableTopToolbar;

package/dist/types/components/shared-components/data-table/utils/parseFromValuesOrFunc.d.ts

@@ -0,0 +1,7 @@
+import { DropdownOption } from 'material-react-table';
+declare const parseFromValuesOrFunc: <T, U>(fn: ((arg: U) => T) | T | undefined, arg: U) => T | undefined;
+export declare const getValueAndLabel: (option?: DropdownOption) => {
+    label: string;
+    value: string;
+};
+export default parseFromValuesOrFunc;

package/dist/types/components/shared-components/index.d.ts

@@ -0,0 +1,7 @@
+export * from './LightDarkModeToggle';
+export * from './PageBreadcrumb';
+export * from './PageTitle';
+export * from './data-table/DataTable';
+export * from './data-table/DataTableTopToolbar';
+export * from './tabs/OwpTab';
+export * from './tabs/OwpTabs';

package/dist/types/components/shared-components/tabs/OwpTab.d.ts

@@ -0,0 +1,6 @@
+declare const OwpTab: import("@emotion/styled").StyledComponent<import("@mui/material").TabOwnProps & Omit<import("@mui/material").ButtonBaseOwnProps, "classes"> & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    ref?: import("react").Ref<HTMLDivElement>;
+}, "children" | "sx" | "icon" | "disabled" | "classes" | "style" | "action" | "className" | "label" | "tabIndex" | "value" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "iconPosition" | "wrapped"> & {
+    component?: React.ElementType;
+} & import("@mui/system").MUIStyledCommonProps<import("@mui/material").Theme>, {}, {}>;
+export { OwpTab };

package/dist/types/components/shared-components/tabs/OwpTabs.d.ts

@@ -0,0 +1,6 @@
+declare const OwpTabs: import("@emotion/styled").StyledComponent<import("@mui/material").TabsOwnProps & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    ref?: import("react").Ref<HTMLDivElement>;
+}, "children" | "sx" | "classes" | "style" | "action" | "className" | "variant" | "aria-label" | "aria-labelledby" | "onChange" | "slots" | "slotProps" | "value" | "orientation" | "allowScrollButtonsMobile" | "centered" | "indicatorColor" | "ScrollButtonComponent" | "scrollButtons" | "selectionFollowsFocus" | "TabIndicatorProps" | "TabScrollButtonProps" | "textColor" | "visibleScrollbar"> & {
+    component?: React.ElementType;
+} & import("@mui/system").MUIStyledCommonProps<import("@mui/material").Theme>, {}, {}>;
+export { OwpTabs };

package/dist/types/components/withRouter/index.d.ts

@@ -0,0 +1 @@
+export { default } from './withRouter';

package/dist/types/components/withRouter/withRouter.d.ts

@@ -0,0 +1,14 @@
+import { useLocation, useNavigate } from 'react-router-dom';
+import { ComponentType } from 'react';
+export type WithRouterProps = {
+    location?: ReturnType<typeof useLocation>;
+    params?: Record<string, string>;
+    navigate?: ReturnType<typeof useNavigate>;
+};
+/**
+ * The withRouter function is a higher-order component that wraps a component with the useLocation, useParams, and useNavigate hooks from React Router.
+ * It passes the location, params, and navigate objects as props to the wrapped component.
+ * The component is memoized to prevent unnecessary re-renders.
+ */
+declare const withRouter: <Props extends WithRouterProps>(Component: ComponentType<Props>) => import("react").NamedExoticComponent<Omit<Props, keyof WithRouterProps>>;
+export default withRouter;

package/dist/types/components/withRouterAndRef/index.d.ts

@@ -0,0 +1 @@
+export { default } from './withRouterAndRef';

package/dist/types/components/withRouterAndRef/withRouterAndRef.d.ts

@@ -0,0 +1,14 @@
+import { ComponentType } from 'react';
+import { useLocation, useNavigate } from 'react-router-dom';
+export type WithRouterProps = {
+    location: ReturnType<typeof useLocation>;
+    params: Record<string, string>;
+    navigate: ReturnType<typeof useNavigate>;
+};
+/**
+ * The withRouter function is a higher-order component that wraps a component with the useLocation, useParams, and useNavigate hooks from React Router.
+ * It passes the location, params, and navigate objects as props to the wrapped component.
+ * The component is memoized to prevent unnecessary re-renders.
+ */
+declare const withRouterAndRef: <Props extends WithRouterProps>(Component: ComponentType<Props>) => () => import("react").ForwardRefExoticComponent<import("react").RefAttributes<unknown>>;
+export default withRouterAndRef;

package/dist/types/context/OwpAppProvider.d.ts

@@ -0,0 +1,15 @@
+import { OwpSettingsConfigType } from '@/components/OwpSettings/OwpSettings';
+import { ReactNode } from 'react';
+export interface OwpAppConfigs {
+    routesConfig: any;
+    settingsConfig: OwpSettingsConfigType;
+    themesConfig: any;
+    navigationConfig: any;
+}
+export declare const OwpAppContext: import("react").Context<OwpAppConfigs>;
+export interface OwpAppProviderProps {
+    configs: OwpAppConfigs;
+    children?: ReactNode;
+}
+export declare const OwpAppProvider: ({ configs, children }: OwpAppProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const useOwpAppContext: () => OwpAppConfigs;