@dashadmin/dash-auto-admin 1.3.24 → 1.3.26

package/src/hooks/useLogger.tsx

@@ -0,0 +1,23 @@
+import { SimpleLogger } from '../utils/SimpleLogger';
+
+export const useLogger = (logger: string) => {
+	const _logger = new SimpleLogger(logger, true);
+
+	const log = (...any: any[]) => {
+		_logger.log(any);
+	};
+
+	const info = (...any: any[]) => {
+		_logger.log(any);
+	};
+
+	const error = (...any: any[]) => {
+		_logger.error(any);
+	};
+
+	const warn = (...any: any[]) => {
+		_logger.warn(any);
+	};
+
+	return { info, log, error, warn };
+};

package/src/hooks/useRoutePathPattern.tsx

@@ -0,0 +1,24 @@
+import { useLocation, useParams } from 'react-router';
+
+export const useRoutePathPattern = () => {
+  const routeParams = useParams();
+  const location = useLocation();
+
+  let routePathPattern = location.pathname;
+
+  Object.keys(routeParams)
+    .filter((paramKey) => paramKey !== '*')
+    .forEach((paramKey) => {
+      const paramValue = routeParams[paramKey];
+      const regexMiddle = new RegExp(`\/${paramValue}\/`, 'g');
+      const regexEnd = new RegExp(`\/${paramValue}$`, 'g');
+
+      routePathPattern = routePathPattern.replaceAll(
+        regexMiddle,
+        `/:${paramKey}/`,
+      );
+      routePathPattern = routePathPattern.replaceAll(regexEnd, `/:${paramKey}`);
+    });
+
+  return routePathPattern;
+}

package/src/hooks/useVirtualHash.tsx

@@ -0,0 +1,34 @@
+import React from 'react';
+
+const useVirtualHash = () => {
+	const [hash, setHash] = React.useState<string>(() => window.location.hash);
+
+	const hashChangeHandler = React.useCallback((e) => {
+   
+		setHash(e.data);
+	}, []);
+
+	React.useEffect(() => {
+		window.addEventListener('virtualhash', hashChangeHandler);
+		return () => {
+			window.removeEventListener('virtualhash', hashChangeHandler);
+		};
+	}, []);
+
+	const _update = React.useCallback(
+		(newHash) => {
+			history.replaceState(null, '', newHash);
+			window.dispatchEvent(new MessageEvent('virtualhash', { data: newHash }));
+			//}
+		},
+		[hash],
+	);
+
+	const setVirtualHash = (h: string) => {
+		_update(h);
+	};
+
+	return { hash, setVirtualHash };
+};
+
+export default useVirtualHash;

package/src/index.ts

@@ -0,0 +1,85 @@
+/** Core */
+export { default as DashAutoList } from './DashAutoList';
+export { default as DashAutoDrawer } from './DashAutoDrawer';
+export { default as DashAutoCreate } from './DashAutoCreate';
+export { default as DashAutoEdit } from './DashAutoEdit';
+export { default as DashAutoFormGroups } from './DashAutoFormGroups';
+export { default as DashAutoFormLayout } from './DashAutoFormLayout';
+export { default as DashAutoAdminForm } from './DashAutoAdminForm';
+export { default as DashAutoFormTabs } from './DashAutoFormTabs';
+export { default as DashAutoFormMuiTabs } from './DashAutoFormMuiTabs';
+export { default as DashAutoReferenceTab } from './DashAutoReferenceTab';
+export { default as DashAutoTabs } from './DashAutoTabs';
+export { default as DashAutoLayout } from './DashAutoLayout';
+export { default as DashAutoAdminSaveButton } from './DashAutoAdminSaveButton';
+export type { IDashAutoAdminSaveButton } from './DashAutoAdminSaveButton';
+
+/** Context */
+export { 
+	DashAutoAdminFormProvider, 
+	useDashAutoAdminForm 
+} from './context/DashAutoAdminFormContext';
+export type { IDashAutoAdminFormContext } from './context/DashAutoAdminFormContext';
+
+export { default as DashAutoTitle } from './common/DashAutoTitle';
+
+/** Interfaces */
+export type { default as IDashAutoAdminCustomFieldComponent } from './interfaces/IDashAutoAdminCustomFieldComponent';
+export type { default as ICustomResourceSubComponent } from './interfaces/ICustomResourceSubComponent';
+export type { default as IDashAutoAdminAttribute } from './interfaces/IDashAutoAdminAttribute';
+export type { default as IDashAutoAdminResourceConfig } from './interfaces/IDashAutoAdminResourceConfig';
+export type { IDashAutoLayoutRenderFunction } from './DashAutoLayout';
+export type { IDashAutoAdminDataGrid } from './list/DashAutoListDatagridWrapper';
+export type { IDashAutoList } from './DashAutoList';
+
+/** Utils */
+export { default as isComponent } from './utils/isComponent';
+export { default as isFC } from './utils/isFC';
+export { default as isEnum } from './utils/isEnum';
+export { default as invertMap } from './utils/invertMap';
+export { default as enumToChoices } from './utils/enumToChoices';
+export { default as groupByTabs } from './utils/groupByTabs';
+export { default as validate } from './utils/validate';
+
+/** Translation utilities */
+export { 
+    useAutoAdminTranslate, 
+    isTranslationKey, 
+    translateLabelSync 
+} from './hooks/useAutoAdminTranslate';
+export { TranslatedLabel, withTranslatedLabel } from './common/components/TranslatedLabel';
+
+export { default as DashRedirect } from './DashRedirect';
+
+export { default as evalActionPermission } from './utils/evalActionPermission';
+
+export { 
+  ComponentRegistryProvider, 
+  useComponentRegistry 
+} from './DashAutoAdminComponentRegistry';
+export type { 
+  ComponentRegistryContextType, 
+  ComponentRegistryProviderProps 
+} from './DashAutoAdminComponentRegistry';
+
+export interface IDashAutoAdminSettings {
+	/** */
+	library: 'mui';
+	/** */
+	defaultTabName: string;
+}
+
+export const AutoAdminSettings: IDashAutoAdminSettings = {
+	library: 'mui',
+	defaultTabName: 'Data',
+};
+
+/** Providers */
+export {
+    createDashAuthProvider,
+    createDashDataProvider,
+    type DashAuthProviderConfig,
+    type DashAuthProviderOverrides,
+    type DashDataProviderConfig,
+    type DashDataProviderOverrides
+} from './providers';

package/src/interfaces/ICustomResourceSubComponent.ts

@@ -0,0 +1,11 @@
+import IDashAutoAdminResourceConfig from './IDashAutoAdminResourceConfig';
+
+/**
+ * Interface for a custom resource sub-component.
+ */
+export default interface ICustomResourceSubComponent {
+	/**
+	 * Configuration for the resource.
+	 */
+	resourceConfig: IDashAutoAdminResourceConfig;
+}

package/src/interfaces/IDashApplicationLayoutMainAction.ts

@@ -0,0 +1,37 @@
+/**
+ * Interface for defining the main action in a Dash application layout.
+ */
+export default interface IDashApplicationLayoutMainAction {
+	/**
+	 * The title of the main action.
+	 */
+	title: string;
+
+	/**
+     * @deprecated
+	 * The type of the main action, which can be one of the following:
+	 * 'link', 'text', 'ghost', 'default', 'primary', 'dashed'.
+	 */
+	type?: 'link' | 'text' | 'ghost' | 'default' | 'primary' | 'dashed';
+
+	/**
+	 * The icon associated with the main action.
+	 */
+	icon?: string;
+
+	/**
+     * @deprecated
+	 * The function to be called when the main action is clicked.
+	 */
+	onClick?: Function;
+
+	/**
+	 * The URL to redirect to when the main action is triggered.
+	 */
+	redirect?: string;
+    mode?: "create" | "show" | "edit"
+	/**
+	 * The function type, which can be either 'redirect' or 'virtualhash'.
+	 */
+	fn?: 'redirect' | 'virtualhash';
+}

package/src/interfaces/IDashApplicationLayoutMenuItem.ts

@@ -0,0 +1,24 @@
+/**
+ * Interface representing a menu item in the application layout
+ */
+export default interface IApplicationLayoutMenuItem {
+	/**
+	 * The display text of the menu item
+	 */
+	title: string;
+
+	/**
+	 * Optional click handler function for the menu item
+	 */
+	onClick?: Function;
+
+	/**
+	 * Optional URL or path to redirect to when menu item is clicked
+	 */
+	redirect?: string;
+
+	/**
+	 * Optional icon identifier for the menu item
+	 */
+	icon?: string;
+}

package/src/interfaces/IDashAutoAdminAttribute.ts

@@ -0,0 +1,104 @@
+import { JSX, ReactNode } from 'react';
+
+import IDashAutoAdminCustomFieldComponent from './IDashAutoAdminCustomFieldComponent';
+import IRecord from './IRecord';
+
+/**
+ * Interface for defining attributes and behavior of auto-admin fields.
+ * This interface provides a way to configure various aspects of form fields,
+ * such as their type, label, layout, and visibility in different views.
+ */
+export default interface IDashAutoAdminAttribute<M = any> {	
+    /** Model attribute name, must match with the json endpoint */
+	attribute: string;
+	/** Label for the field */
+	label?: string;
+	/** Flag to indicate if this is a custom field (deprecated - use type: "component" instead) */
+	custom?: boolean;
+	/**
+	 * Type definition for the attribute that determines how it's rendered
+	 * Can be a component, function component, string, array, object, or constructor
+	 * For paths like '/api/category/{id}/resource.name', wrap params in '{}'.
+	 * type logic is at the core of AttributeToInput and AttributeToField component.
+	 * Allows certain literals to resolve specific components.
+	 * Specific case: e.g: '/api/category/{id}/resource.name'
+	 * when a string is provided with a custom component literal such as AutoCompleteInput,
+	 * it is possible to wrap a react router param name to the resource path '{}'
+	 */
+	type:
+	| 'custom'
+	| React.FC<IRecord>
+	| string
+	| string[]
+	| Object
+	| DateConstructor
+	| NumberConstructor
+	| StringConstructor
+	| IDashAutoAdminAttribute[];
+	/** Position order of the field */
+	position?: number;
+	/** Layout position key for the field */
+	layoutPosition?: React.Key;
+	/** Input component configuration */
+	input?: /*IntrinsicAttributes &*/ IDashAutoAdminCustomFieldComponent & {
+		/** */
+		children?: ReactNode;
+	};
+	/** Attribute name in the model */
+	modelAttribute?: string;
+	/** Variant style or type */
+	variant?: any;
+	/** Tab name where this field should appear */
+	tab?: string;
+	/** Whether to show in list view */
+	inList?: boolean;
+	/** Whether to show in drawer view */
+	inDrawer?: boolean;
+	/** Whether to show in show view */
+	inShow?: boolean;
+	/** Whether to show in edit view */
+	inEdit?: boolean;
+	/** Whether to show in create view */
+	inCreate?: boolean;
+	/** Whether to display the label */
+	showLabel?: boolean;
+	/** Whether field is extended */
+	extended?: boolean;
+	/** Whether field is read-only */
+	readOnly?: boolean;
+	/** Whether field is a password input */
+	isPassword?: boolean;
+	/** Additional field options */
+	fieldProps?: any;
+    slotProps?: any;
+	/** Action for the field : ReactNode | React.FC<IRecord> | ActionCallback;*/
+	action?: any;
+	/** Additional props for the component */
+	componentProps?: any;
+	/** Validation function for the field */
+	validate?: (value: any, allValues: any) => void;
+    /** Some components handle by default the react-hook-form error, use this prop to hide the DASH Auto default error message */
+    hideErrorMessage?: boolean; 
+	/** Whether to enable pagination */
+	pagination?: boolean;
+	/** Whether multiple values are allowed */
+	multiple?: boolean;
+	/** Whether field is sortable */
+	sortable?: boolean;
+	/** Custom component for rendering the field */
+	component?: string | (React.FC<IDashAutoAdminCustomFieldComponent> | ((props:IDashAutoAdminCustomFieldComponent) => JSX.Element) | ((props:any) => JSX.Element));
+	/** Field to use for search functionality */
+	searchField?: string;
+	/** Attribute to use for list display */
+	listAttribute?: string;
+	/** Whether field is a data form */
+	isDataForm?: boolean;
+	/** Processor type for the field */
+	processor?: 'Blob' | 'RawFile' | 'Boolean' | 'Null' | string;
+	/** When true, forces use of default schema show field even with custom component */
+	useCustomShowField?: boolean;
+
+    metadata?: M;
+    default_value?: any;
+    fieldOptions?:any;
+}

package/src/interfaces/IDashAutoAdminCustomFieldComponent.ts

@@ -0,0 +1,18 @@
+import { JSX } from 'react';
+import IDashAutoAdminAttribute from './IDashAutoAdminAttribute';
+import IDashAutoAdminResourceConfig from './IDashAutoAdminResourceConfig';
+
+export default interface IDashAutoAdminCustomFieldComponent {
+    attribute: IDashAutoAdminAttribute; // TODO attribute must required?
+    method: 'list' | 'view' | 'edit' | 'create';
+    resourceConfig: IDashAutoAdminResourceConfig;
+    record?: any;
+    locale?: string;
+    options?: any;
+   
+	/** */
+	children?: JSX.Element;
+	[x: string]: any;
+}
+
+

package/src/interfaces/IDashAutoAdminFormOptions.ts

@@ -0,0 +1,22 @@
+export default interface IDashAutoAdminFormOptions {
+	/** */
+	mode: 'list' | 'create' | 'edit' | 'view';
+	/** */
+	label?: string;
+	/** */
+	saveButtonProps?: any;
+	/** */
+	useReadOnlyInputAsTextField?: boolean;
+	/** */
+	readOnlyComponent?: any;
+	/** */
+	record?: any;
+	/** */
+	meta?: any;
+	/** */
+	isDrawer?: boolean;
+    /** */
+    handleChange?: (e:any) => void;
+	/** */
+	locale?: string;
+}

package/src/interfaces/IDashAutoAdminListActions.ts

@@ -0,0 +1,13 @@
+import { PropsWithChildren } from 'react';
+import IDashAutoAdminResourceConfig from './IDashAutoAdminResourceConfig';
+
+export interface IDashAutoAdminListActions extends PropsWithChildren {
+	/** */
+	resourceConfig: IDashAutoAdminResourceConfig;
+	/** */
+	listProps: any;
+	//isLoading: boolean;
+	//data: any;
+}
+
+export default IDashAutoAdminListActions;

package/src/interfaces/IDashAutoAdminReference.ts

@@ -0,0 +1,16 @@
+import IDashAutoAdminAttribute from './IDashAutoAdminAttribute';
+
+export interface IDashAutoAdminReference {
+	/** */
+	reference: string;
+	/** */
+	target: string;
+	/** */
+	type?: 'ReferenceArrayField' | 'ReferenceManyField';
+	/** */
+	tab?: string;
+	/** */
+	schema: IDashAutoAdminAttribute[];
+	/** */
+	BulkActions?: any;
+}