@luminix/mui-cms 0.0.1-beta.0

package/types/plugins/i18NextPlugin.d.ts

@@ -0,0 +1,19 @@
+import { Plugin } from '@luminix/core';
+import { AppFacade, AppFacades } from '@luminix/core/dist/types/App';
+import { InitOptions } from 'i18next';
+declare class i18NextPlugin extends Plugin {
+    private options;
+    name: string;
+    constructor(options: InitOptions);
+    register(app: AppFacade): void;
+    boot({ cms, model, forms }: AppFacades): void;
+    private initI18Next;
+    private translateModelNames;
+    private translateModelColumns;
+    private translateMenuEntries;
+    private translateMassActions;
+    private translateInstanceActions;
+    private translateStaticActions;
+    private translateFormLabels;
+}
+export default i18NextPlugin;

package/types/providers/DialogProvider.d.ts

@@ -0,0 +1,4 @@
+import { default as React } from 'react';
+import { DialogProps } from '@mui/material/Dialog';
+declare function DialogProvider({ children, ...props }: Omit<DialogProps, 'open' | 'onClose'>): React.ReactNode;
+export default DialogProvider;

package/types/providers/LayoutProvider.d.ts

@@ -0,0 +1,5 @@
+import { default as React } from 'react';
+declare const LayoutProvider: React.FunctionComponent<{
+    children: React.ReactNode;
+}>;
+export default LayoutProvider;

package/types/providers/ModelProvider.d.ts

@@ -0,0 +1,3 @@
+import { ModelProviderProps } from '../types/PropTypes';
+declare const ModelProvider: React.FunctionComponent<ModelProviderProps>;
+export default ModelProvider;

package/types/providers/NotificationProvider.d.ts

@@ -0,0 +1,4 @@
+import { default as React } from 'react';
+import { NotificationProviderProps } from '../types/PropTypes';
+declare const NotificationProvider: React.FC<NotificationProviderProps>;
+export default NotificationProvider;

package/types/providers/TableProvider.d.ts

@@ -0,0 +1,4 @@
+import { default as React } from 'react';
+import { TableProps } from '../types/PropTypes';
+declare const TableProvider: React.FunctionComponent<TableProps>;
+export default TableProvider;

package/types/routes.d.ts

@@ -0,0 +1,3 @@
+import { CmsRoutesReducer } from './types/Reducers';
+declare const routes: CmsRoutesReducer;
+export default routes;

package/types/support/ModelIndex/Filter/inputs.d.ts

@@ -0,0 +1,4 @@
+import { Model } from '@luminix/core';
+export declare const changeValueFromArray: (input: any) => any;
+export declare const changeValueToArray: (input: any) => any;
+export declare const mountRelationModelOption: (ModelClass: typeof Model, key: string, input: string[] | number[]) => Promise<Model[]>;

package/types/support/ModelIndex/Filter/searchParams.d.ts

@@ -0,0 +1,18 @@
+import { FilterColumn, FilteredColumn } from '../../../types/Filter';
+/**
+ * Translates the received parameters object from url 'searchParams',
+ * into an array of FilteredColumn objects.
+ *
+ * @param {string} operation
+ * @param {any} value
+ * @returns
+ */
+export declare const translateColumnsFromQuery: (columns: FilterColumn[], searchParams: any) => FilteredColumn[];
+/**
+ * Translates the selected columns to filter,
+ * into a url 'searchParams'.
+ *
+ * @param {FilterColumn[]} columns
+ * @returns
+ */
+export declare const translateColumnsToQuery: (columns: FilteredColumn[]) => URLSearchParams;

package/types/support/ModelIndex/relation.d.ts

@@ -0,0 +1,4 @@
+import { Model } from '@luminix/core';
+import { Collection } from '@luminix/core/dist/types/Collection';
+export declare const loadRelationOptions: (ModelClass: typeof Model, key: string, loadedOptions: Model[]) => Promise<Collection<Model>>;
+export declare const aggregateRelationOptions: (ModelClass: typeof Model, key: string, term: string | undefined, loadedOptions: Collection<Model>) => Promise<Collection<Model>>;

package/types/support/array.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Removes duplicates from an array.
+ * If a key is provided, duplicates are removed based on the value of that key.
+ *
+ * @param value
+ * @param key
+ * @returns
+ */
+export declare const unique: (value: any[], key?: string) => any[];

package/types/support/date.d.ts

@@ -0,0 +1 @@
+export declare const fromIsoString: (value: Date | string) => string;

package/types/support/error.d.ts

@@ -0,0 +1,2 @@
+import { NotifyFunction } from '../types/Notifications';
+export declare function createErrorCallback(notify: NotifyFunction): (error: unknown) => void;

package/types/support/handlers.d.ts

@@ -0,0 +1,9 @@
+import { Model } from '@luminix/core';
+import { ActionCallbackEvent, InstanceActionCallbackEvent, MassActionCallbackEvent } from '../types/Table';
+type MassActionHandlers = Record<string, (ModelClass: typeof Model) => (e: MassActionCallbackEvent) => void>;
+type InstanceActionHandlers = Record<string, (ModelClass: typeof Model) => (e: InstanceActionCallbackEvent) => void>;
+type StaticActionHandlers = Record<string, (ModelClass: typeof Model) => (e: ActionCallbackEvent) => void>;
+export declare const massActionHandlers: MassActionHandlers;
+export declare const instanceActionHandlers: InstanceActionHandlers;
+export declare const staticActionHandlers: StaticActionHandlers;
+export {};

package/types/support/misc.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @deprecated - For demo purposes
+ *
+ * Sleep for given duration
+ *
+ * @param duration in milliseconds
+ * @returns
+ */
+export declare const sleep: (duration: number) => Promise<void>;
+/**
+ * Check if value is set.
+ *
+ * @param value
+ * @returns
+ */
+export declare const isSet: (value: unknown) => boolean;

package/types/support/searchParams.d.ts

@@ -0,0 +1 @@
+export declare const searchParamsToObject: (searchParams: URLSearchParams) => Record<string, any>;

package/types/types/Config.d.ts

@@ -0,0 +1,13 @@
+import { Breakpoint } from '@mui/material/styles';
+export type CmsConfig = {
+    layout?: {
+        breakpoint?: Breakpoint;
+        drawer?: {
+            width?: number;
+        };
+        appBar?: {
+            height?: number;
+            color?: string;
+        };
+    };
+};

package/types/types/Contexts.d.ts

@@ -0,0 +1,72 @@
+import { Dispatch, SetStateAction } from 'react';
+import { SetURLSearchParams } from 'react-router-dom';
+import { Model } from '@luminix/core';
+import { Collection } from '@luminix/core/dist/types/Collection';
+import { CmsConfig } from './Config';
+import { Column, MassAction } from './Table';
+import { Notification, NotifyFunction } from './Notifications';
+import { DialogFunction, DialogMessage } from './Dialog';
+import { FilteredColumn } from './Filter';
+export type LayoutContextValue = {
+    open: boolean;
+    setOpen: Dispatch<SetStateAction<boolean>>;
+    layout: CmsConfig['layout'];
+    isBreakpointUp: boolean;
+    currentPage: string;
+    setCurrentPage: Dispatch<SetStateAction<string>>;
+    showSearch: boolean;
+    setShowSearch: Dispatch<SetStateAction<boolean>>;
+    showBackButton: boolean;
+    setShowBackButton: Dispatch<SetStateAction<boolean>>;
+};
+export type TableContextValue = {
+    columns: Column[];
+    columnCount: number;
+    massActions: MassAction[];
+    items?: Collection<Model>;
+    loading?: boolean;
+    error: Error | null;
+    Model: typeof Model;
+    selected: Collection<Model>;
+};
+export type ModelContextValue = {
+    Model: typeof Model;
+};
+export type ModelFilterContextValue = {
+    Model: typeof Model;
+    anchorEl: any;
+    setAnchorEl: React.Dispatch<React.SetStateAction<any>>;
+    columnsFilter: FilteredColumn[];
+    setColumnsFilter: React.Dispatch<React.SetStateAction<FilteredColumn[]>>;
+    searchParams: URLSearchParams;
+    setSearchParams: SetURLSearchParams;
+    clearSearchParams: () => void;
+    clearFilters: () => void;
+};
+export type ModelFilterRowContextValue = {
+    key: string;
+    type: string;
+    operator: string;
+    value: any;
+    isRelation: boolean;
+    setKey: React.Dispatch<React.SetStateAction<string>>;
+    setType: React.Dispatch<React.SetStateAction<string>>;
+    setOperator: React.Dispatch<React.SetStateAction<string>>;
+    setValue: React.Dispatch<React.SetStateAction<any>>;
+    setIsRelation: React.Dispatch<React.SetStateAction<boolean>>;
+};
+export type NotificationContextValue = {
+    isOpen: boolean;
+    notify: NotifyFunction;
+    dismissNotification: () => void;
+    notifications: Notification[];
+    current?: Notification;
+    displacement: string;
+    setDisplacement: React.Dispatch<React.SetStateAction<string>>;
+};
+export type DialogContextValue = {
+    isOpen: boolean;
+    dialog: DialogFunction;
+    dismissDialog: () => void;
+    current?: DialogMessage;
+};

package/types/types/Dialog.d.ts

@@ -0,0 +1,9 @@
+export type DialogMessage = {
+    title?: React.ReactNode;
+    message: React.ReactNode;
+    type?: 'alert' | 'confirm';
+    dismissable?: boolean;
+    confirmText?: string;
+    cancelText?: string;
+};
+export type DialogFunction = (message: string | DialogMessage) => Promise<boolean>;

package/types/types/Filter.d.ts

@@ -0,0 +1,20 @@
+export type FilterColumn = {
+    key: string;
+    label: string;
+    type: string;
+    is_relation: boolean;
+};
+export type FilteredColumn = {
+    key: string;
+    operator: string;
+    type: string;
+    value: any;
+    is_relation: boolean;
+};
+export type FilterRow = {
+    index: number;
+    column: FilteredColumn;
+};
+export type FilterValueInput = {
+    index?: number;
+};

package/types/types/Menu.d.ts

@@ -0,0 +1,11 @@
+import { default as React } from 'react';
+export type MenuItem = {
+    key: string | number;
+    text: string;
+    icon?: React.ReactNode;
+    component?: React.ComponentType;
+    to?: string;
+    onClick?: (e: React.MouseEvent) => void;
+    children?: MenuItem[];
+    element?: React.ReactNode;
+};

package/types/types/Notifications.d.ts

@@ -0,0 +1,13 @@
+import { AlertProps } from '@mui/material';
+import { default as React } from 'react';
+export type NotificationAction = {
+    label: React.ReactNode;
+    callback: () => void;
+};
+export type Notification = {
+    message: React.ReactNode;
+    severity?: AlertProps['severity'];
+    actions?: NotificationAction[];
+    title?: React.ReactNode;
+};
+export type NotifyFunction = (notification: string | Notification) => void;

package/types/types/Plugin.d.ts

@@ -0,0 +1,8 @@
+export type CmsPluginOptions = {
+    /**
+     *
+     * If true, will apply the defaults for the model User. Default is true.
+     *
+     */
+    applyUserDefaults?: boolean;
+};

package/types/types/PropTypes.d.ts

@@ -0,0 +1,100 @@
+import { Model, Plugin } from '@luminix/core';
+import { DrawerProps as MuiDrawerProps, AppBarProps as MuiAppBarProps, BoxProps, DrawerProps, MenuProps, TableProps as MuiTableProps, StackProps, TableHeadProps as MuiTableHeadProps, TableBodyProps as MuiTableBodyProps, TableRowProps as MuiTableRowProps, ThemeOptions, BreadcrumbsOwnProps, SnackbarProps, AlertProps } from '@mui/material';
+import { ListTypeMap } from '@mui/material/List';
+import { DefaultComponentProps } from '@mui/material/OverridableComponent';
+import { MenuItem } from './Menu';
+import { ModelPaginatedResponse } from '@luminix/core/dist/types/Model';
+import { Collection, CollectionIteratorCallback } from '@luminix/core/dist/types/Collection';
+import { Scope } from '@luminix/core/dist/types/Builder';
+import { InitOptions } from 'i18next';
+export type LuminixCmsProps = {
+    theme?: ThemeOptions;
+    plugins?: Plugin[];
+    i18nOptions?: InitOptions;
+};
+export type LayoutProps = BoxProps & {
+    slotProps?: {
+        AppBar?: AppBarProps;
+        Drawer?: DrawerProps;
+        main?: BoxProps;
+    };
+};
+export type AppBarProps = {
+    slots?: {
+        start?: React.ReactNode | string;
+        end?: React.ReactNode | string;
+    };
+};
+export type StyledAppBarProps = MuiAppBarProps & {
+    open?: boolean;
+    drawerWidth?: number;
+    height?: number;
+};
+export type StyledDrawerProps = MuiDrawerProps & {
+    open?: boolean;
+    width: number;
+};
+export type SearchBarProps = {
+    throttle?: number;
+};
+export type ErrorProps = {
+    error?: Error;
+};
+export type RecursiveListProps = DefaultComponentProps<ListTypeMap> & {
+    collapsed?: boolean;
+    items: MenuItem[];
+    onClick?: (e: any) => void;
+};
+export type RecursiveMenuProps = MenuProps & {
+    collapsed?: boolean;
+    items: MenuItem[];
+    onClick?: (e: any) => void;
+};
+export type ModelProviderProps = {
+    Model: typeof Model;
+    children: React.ReactNode;
+};
+export type TableProps = MuiTableProps & {
+    items?: Collection<Model>;
+    loading?: boolean;
+    error: Error | null;
+};
+export type TableHeadProps = MuiTableHeadProps & {
+    slots?: {
+        before?: React.ReactNode;
+        after?: React.ReactNode;
+    };
+};
+export type TableRowProps = MuiTableRowProps & {
+    item: Model;
+};
+export type TableBodyProps = MuiTableBodyProps & {
+    children: React.ReactNode | CollectionIteratorCallback<Model, React.ReactNode>;
+};
+export type PaginationProps = StackProps & {
+    variant?: 'default' | 'compact';
+};
+export type ModelItemProps = {
+    create?: boolean;
+};
+export type QueryProviderProps = {
+    Model: typeof Model;
+    scope?: Scope<Model, ModelPaginatedResponse>;
+    dependencies?: unknown[];
+};
+export type ActionsProps = {
+    variant?: 'default' | 'fab';
+};
+export type NotificationProviderProps = SnackbarProps & {
+    variant?: AlertProps['variant'];
+};
+export type BreadcrumbsProps = BreadcrumbsOwnProps & {
+    parts?: {
+        name: string;
+        href?: string;
+    }[];
+};
+export type InputOption = {
+    key: string;
+    label: string;
+};

package/types/types/Reducers.d.ts

@@ -0,0 +1,4 @@
+import { Model } from '@luminix/core';
+import { RouteObject } from 'react-router-dom';
+export type ComponentMapReducer = (components: Record<string, React.FunctionComponent>) => Record<string, React.FunctionComponent>;
+export type CmsRoutesReducer = (routes: RouteObject[], components: Record<string, React.FunctionComponent<any>>, models: Record<string, typeof Model>) => RouteObject[];

package/types/types/Table.d.ts

@@ -0,0 +1,41 @@
+import { Model } from '@luminix/core';
+import { Collection } from '@luminix/core/dist/types/Collection';
+import { TableCellProps } from '@mui/material';
+import { NotifyFunction } from './Notifications';
+import { DialogFunction } from './Dialog';
+import { TFunction } from 'i18next';
+export type StaticAction = {
+    key?: string;
+    label: string;
+    callback: (e: ActionCallbackEvent) => void;
+    icon?: React.ReactNode;
+};
+export type InstanceAction = {
+    key?: string;
+    label: string;
+    callback: (e: InstanceActionCallbackEvent) => void;
+    icon?: React.ReactNode;
+};
+export type MassAction = {
+    label: string;
+    key: string;
+    callback: (e: MassActionCallbackEvent) => void;
+};
+export type ActionCallbackEvent = {
+    navigate: (path: string) => void;
+    refresh: () => void;
+    notify: NotifyFunction;
+    dialog: DialogFunction;
+    t: TFunction;
+};
+export type InstanceActionCallbackEvent = ActionCallbackEvent & {
+    item: Model;
+};
+export type MassActionCallbackEvent = ActionCallbackEvent & {
+    selected: Collection<Model>;
+};
+export type Column = TableCellProps & {
+    key: string;
+    label: string;
+    sortable?: boolean;
+};

package/types/types/Tabs.d.ts

@@ -0,0 +1,4 @@
+export type DisplayableTab = {
+    label: string;
+    value: string;
+};

package/types/views/Dashboard.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+declare const Dashboard: React.FunctionComponent;
+export default Dashboard;

package/types/views/Error.d.ts

@@ -0,0 +1,4 @@
+import { default as React } from 'react';
+import { ErrorProps } from '../types/PropTypes';
+declare const Error: React.FunctionComponent<ErrorProps>;
+export default Error;

package/types/views/Layout/Layout.d.ts

@@ -0,0 +1,4 @@
+import { default as React } from 'react';
+import { LayoutProps } from '../../types/PropTypes';
+declare const Layout: React.FunctionComponent<LayoutProps>;
+export default Layout;

package/types/views/ModelIndex.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+declare const ModelIndex: React.FunctionComponent;
+export default ModelIndex;

package/types/views/ModelItem.d.ts

@@ -0,0 +1,4 @@
+import { default as React } from 'react';
+import { ModelItemProps } from '../types/PropTypes';
+declare const ModelItem: React.FunctionComponent<ModelItemProps>;
+export default ModelItem;