@mui/x-tree-view 8.0.0-alpha.13 → 8.0.0-alpha.14

package/useTreeItem/useTreeItem.d.ts

@@ -1,2 +1,2 @@
 import { UseTreeItemParameters, UseTreeItemReturnValue, UseTreeItemMinimalPlugins, UseTreeItemOptionalPlugins } from "./useTreeItem.types.js";
-export declare const useTreeItem: <TSignatures extends UseTreeItemMinimalPlugins = UseTreeItemMinimalPlugins, TOptionalSignatures extends UseTreeItemOptionalPlugins = readonly []>(parameters: UseTreeItemParameters) => UseTreeItemReturnValue<TSignatures, TOptionalSignatures>;
+export declare const useTreeItem: <TSignatures extends UseTreeItemMinimalPlugins = UseTreeItemMinimalPlugins, TOptionalSignatures extends UseTreeItemOptionalPlugins = UseTreeItemOptionalPlugins>(parameters: UseTreeItemParameters) => UseTreeItemReturnValue<TSignatures, TOptionalSignatures>;

package/useTreeItem/useTreeItem.js

@@ -242,6 +242,17 @@ const useTreeItem = parameters => {
       onClick: createIconContainerHandleClick(externalEventHandlers)
     });
   };
+  const getErrorContainerProps = (externalProps = {}) => {
+    const externalEventHandlers = (0, _extractEventHandlers.default)(externalProps);
+    return (0, _extends2.default)({}, externalEventHandlers, externalProps);
+  };
+  const getLoadingContainerProps = (externalProps = {}) => {
+    const externalEventHandlers = (0, _extractEventHandlers.default)(externalProps);
+    return (0, _extends2.default)({
+      size: '12px',
+      thickness: 6
+    }, externalEventHandlers, externalProps);
+  };
   const getGroupTransitionProps = (externalProps = {}) => {
     const externalEventHandlers = (0, _extractEventHandlers.default)(externalProps);
     const response = (0, _extends2.default)({}, externalEventHandlers, {
@@ -270,6 +281,8 @@ const useTreeItem = parameters => {
     getLabelProps,
     getLabelInputProps,
     getDragAndDropOverlayProps,
+    getErrorContainerProps,
+    getLoadingContainerProps,
     rootRef: handleRootRef,
     status,
     publicAPI

package/useTreeItem/useTreeItem.types.d.ts

@@ -78,6 +78,11 @@ export interface UseTreeItemCheckboxSlotOwnProps {
   ref: React.RefObject<HTMLButtonElement | null>;
 }
 export type UseTreeItemCheckboxSlotProps<ExternalProps = {}> = ExternalProps & UseTreeItemCheckboxSlotOwnProps;
+export type UseTreeItemErrorContainerSlotProps<ExternalProps = {}> = ExternalProps & {};
+export type UseTreeItemLoadingContainerSlotProps<ExternalProps = {}> = ExternalProps & {
+  size: string;
+  thickness: number;
+};
 export interface UseTreeItemGroupTransitionSlotOwnProps {
   unmountOnExit: boolean;
   in: boolean;
@@ -96,6 +101,8 @@ export interface UseTreeItemStatus {
   disabled: boolean;
   editing: boolean;
   editable: boolean;
+  loading: boolean;
+  error: boolean;
 }
 export interface UseTreeItemReturnValue<TSignatures extends UseTreeItemMinimalPlugins, TOptionalSignatures extends UseTreeItemOptionalPlugins> {
   /**
@@ -152,6 +159,20 @@ export interface UseTreeItemReturnValue<TSignatures extends UseTreeItemMinimalPl
    * @returns {UseTreeItemDragAndDropOverlaySlotProps<ExternalProps>} Props that should be spread on the DragAndDropOverlay slot.
    */
   getDragAndDropOverlayProps: <ExternalProps extends Record<string, any> = {}>(externalProps?: ExternalProps) => UseTreeItemDragAndDropOverlaySlotProps<ExternalProps>;
+  /**
+   * Resolver for the ErrorIcon slot's props.
+   * Warning: This slot is only useful when using the `<RichTreeView />` component when lazy loading is enabled.
+   * @param {ExternalProps} externalProps Additional props for the ErrorIcon slot.
+   * @returns {UseTreeItemErrorContainerSlotProps<ExternalProps>} Props that should be spread on the ErrorIcon slot.
+   */
+  getErrorContainerProps: <ExternalProps extends Record<string, any> = {}>(externalProps?: ExternalProps) => UseTreeItemErrorContainerSlotProps<ExternalProps>;
+  /**
+   * Resolver for the LoadingIcon slot's props.
+   * Warning: This slot is only useful when using the `<RichTreeView />` component when lazy loading is enabled.
+   * @param {ExternalProps} externalProps Additional props for the LoadingIcon slot.
+   * @returns {UseTreeItemLoadingContainerSlotProps<ExternalProps>} Props that should be spread on the LoadingIcon slot.
+   */
+  getLoadingContainerProps: <ExternalProps extends Record<string, any> = {}>(externalProps?: ExternalProps) => UseTreeItemLoadingContainerSlotProps<ExternalProps>;
   /**
    * A ref to the component's root DOM element.
    */

package/utils/cache.d.ts

@@ -0,0 +1,38 @@
+import { TreeViewItemMeta } from "../internals/models/index.js";
+type DataSourceCacheDefaultConfig = {
+  /**
+   * Time To Live for each cache entry in milliseconds.
+   * After this time the cache entry will become stale and the next query will result in cache miss.
+   * @default 300000 (5 minutes)
+   */
+  ttl?: number;
+};
+export interface DataSourceCache {
+  /**
+   * Set the cache entry for the given key.
+   * @param {string} key The key of type `string`
+   * @param {TreeViewItemMeta[]} value The value to be stored in the cache
+   */
+  set: (key: string, value: TreeViewItemMeta[]) => void;
+  /**
+   * Get the cache entry for the given key.
+   * @param {string} key The key of type `string`
+   * @returns {TreeViewItemMeta[]} The value stored in the cache
+   */
+  get: (key: string) => TreeViewItemMeta[] | undefined | -1;
+  /**
+   * Clear the cache.
+   */
+  clear: () => void;
+}
+export declare class DataSourceCacheDefault {
+  private cache;
+  private ttl;
+  constructor({
+    ttl
+  }: DataSourceCacheDefaultConfig);
+  set(key: string, value: TreeViewItemMeta[]): void;
+  get(key: string): TreeViewItemMeta[] | undefined | -1;
+  clear(): void;
+}
+export {};

package/utils/cache.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DataSourceCacheDefault = void 0;
+class DataSourceCacheDefault {
+  constructor({
+    ttl = 300000
+  }) {
+    this.cache = void 0;
+    this.ttl = void 0;
+    this.cache = {};
+    this.ttl = ttl;
+  }
+  set(key, value) {
+    const expiry = Date.now() + this.ttl;
+    this.cache[key] = {
+      value,
+      expiry
+    };
+  }
+  get(key) {
+    const entry = this.cache[key];
+    if (!entry) {
+      return undefined;
+    }
+    if (Date.now() > entry.expiry) {
+      delete this.cache[key];
+      return -1;
+    }
+    return entry.value;
+  }
+  clear() {
+    this.cache = {};
+  }
+}
+exports.DataSourceCacheDefault = DataSourceCacheDefault;

package/utils/index.d.ts

@@ -0,0 +1 @@
+export * from "./cache.js";

package/utils/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _cache = require("./cache");
+Object.keys(_cache).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _cache[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _cache[key];
+    }
+  });
+});