efficient-shell 12.5.0 → 12.8.1

package/dist/index.d.ts

@@ -42,6 +42,7 @@ export { default as TileButton, TileButtonProps, TileSize } from './forms/TileBu
 export { default as Segmented, SegmentedOption, SegmentedProps, SegmentedSize } from './forms/Segmented.js';
 export { default as IconPicker, IconPickerOption, IconPickerProps } from './forms/IconPicker.js';
 export { Side, SidesEachToggle, SidesGlyphs, default as SidesInput, SidesInputProps, SidesValue, sidesStartEach } from './forms/SidesInput.js';
+export { default as UnitMenu, UnitMenuProps } from './forms/UnitMenu.js';
 export { PositionAxis, default as PositionInput, PositionInputProps, PositionValue } from './forms/PositionInput.js';
 export { default as BorderInput, BorderInputProps, BorderValue, borderSides, borderStartEach } from './forms/BorderInput.js';
 export { default as Switch, SwitchProps, SwitchSize } from './forms/Switch.js';
@@ -1466,6 +1467,15 @@ interface ChangelogEntry {
     changes: string[];
 }
 
+/** How a host sets the entity windows' fallback poll: a cadence in ms, `false`
+ *  for none, or a function read on every scheduling decision, so the answer
+ *  can follow live state (for example "none while the realtime socket is
+ *  connected"). */
+type EntityRefetchIntervalOption = number | false | (() => number | false);
+/** How a host sets `refetchOnWindowFocus` for entity windows: a boolean, or a
+ *  function read on every focus event. */
+type EntityRefetchOnWindowFocusOption = boolean | (() => boolean);
+
 type PreviewFileKind = 'pdf' | 'dxf' | '3d' | 'image' | 'csv';
 
 interface DesktopItem {
@@ -1481,6 +1491,12 @@ interface DesktopItem {
     fileKind?: PreviewFileKind;
 }
 
+declare function DesktopHostProvider({ value, children }: {
+    value: DesktopHostConfig;
+    children: ReactNode;
+}): react.FunctionComponentElement<react.ProviderProps<DesktopHostConfig>>;
+declare function useDesktopHost(): DesktopHostConfig;
+
 interface DesktopFolder {
     id: string;
     name: string;
@@ -1563,12 +1579,19 @@ interface DesktopHostConfig {
      *  a file on someone's Downloads folder is not a bug report. Rejecting shows
      *  the error in the HUD and keeps what the user typed. */
     onSubmitPerfReport?: (report: PerfReport) => void | Promise<void>;
+    /** Fallback poll of an open entity window's record. A number is the cadence
+     *  in ms, `false` turns polling off, a function is read at every scheduling
+     *  decision (`() => (socketConnected ? false : 60_000)`). Default 60 000. A
+     *  minimized window never polls whatever this says, and a record the server
+     *  answered with a permanent 4xx stops polling too. */
+    entityRefetchInterval?: EntityRefetchIntervalOption;
+    /** Whether an entity window refetches its record when the browser tab
+     *  regains focus: a boolean, or a function read on every focus event.
+     *  Default `true`. A host with a live push channel turns it off while the
+     *  channel is up. */
+    entityRefetchOnWindowFocus?: EntityRefetchOnWindowFocusOption;
 }
-declare function DesktopHostProvider({ value, children }: {
-    value: DesktopHostConfig;
-    children: ReactNode;
-}): react_jsx_runtime.JSX.Element;
-declare function useDesktopHost(): DesktopHostConfig;
+
 /**
  * `showItems` false draws a bare desktop: no Trash, shortcuts, folders, sticky
  * notes or version watermark, and no desktop right-click menu or rubber band.
@@ -2622,4 +2645,4 @@ declare function useUndoable<T>(value: T, apply: (next: T) => void, opts: Undoab
  */
 declare function useUndoableState<T>(initial: T | (() => T), opts: UndoableOptions): [T, React.Dispatch<React.SetStateAction<T>>];
 
-export { type ActivityKind, type AsyncEnvironment, BLOCKED_PCT_CPU, type BatteryInfo, BehaviorPanel, type BottleneckKind, type BulkColumn, type BulkColumnKind, BulkImportGrid, type BulkImportGridProps, type BulkRow, CancelButton, ChangePasswordForm, type ChangePasswordFormProps, type ChangelogEntry, type ClockCalendarConfig, CopyButton, Customization, type CustomizationOmitSection, type CustomizationProps, type CustomizationSection, DEV_BANNER_TEXT, Desktop, type DesktopContextMenuItem, type DesktopHostConfig, DesktopHostProvider, DevIndicator, DocFavStar, type DuplicateGroup, EditState, type EntityFetcher, EntityWindowFallback, type EntityWindowFallbackProps, EntityWindowLoading, EntityWindowState, type EntityWindowStateProps, FilterBar, type FilterOption, type FpsGroup, type HealthCheckResult, LOG_CAP, Layout, type LayoutMode, type LayoutProps, type LogSummary, MIN_EVENT_SAMPLES, MIN_GROUP_SAMPLES, MODAL_SUBMIT_SELECTOR, type MenuLayer, type MergeBulkOptions, type MergeBulkResult, type MobileAppConfig, Modal, ModalActions, type ModalEdit, NotificationBell, type NotificationsConfig, type OpenPageOptions, PaginatedResponse, PdfActionButton, type PdfActionButtonProps, type PerfEnvironment, type PerfLogRecord, type PerfReading, type PerfReport, PerfStats, type PerfStatsProps, type PlatformHints, SMOOTH_FPS, SearchConfig, ServerStatusIndicator, type ServerStatusIndicatorProps, type ServerStatusUser, type ShellAuth, ShellAuthProvider, type ShellBranding, ShellContextMenu, type ShellContextMenuProps, ShellEntityFetcherProvider, type ShellNotification, ShortcutHelp, SoundsPanel, type StagedTarget, StartMenu, type StickyEntityRef, type StickyResolver, SystemPreferences, type SystemPreferencesProps, type SystemPreferencesSection, type TitleParts, type TitleRole, type TodoProvider, type TodoTask, UndoControls, type UndoControlsApi, type UndoControlsProps, UndoProvider, type UndoProviderProps, type UndoSnapshot, type UndoState, type UndoStep, type UndoableOptions, type Verdict, WidgetManager, WindowCrashedFallback, WindowErrorBoundary, WindowManagerProvider, WindowRegistry, type WindowTarget, type WindowTargetOptions, WindowTitle, activateWindowById, appendRecord as appendPerfRecord, applyDevTitle, beginWindowGesture, classifyActivity, classify as classifyPerf, commitExposeHighlight, copyToClipboard, createWindowRegistry, createWindowTarget, describeMachine, describePerfReport, exitExposeMode, findDuplicateKeys, getActiveWindowRoute, getExposeHighlight, getWindowPosition, installThemeIconSets, isDevEnv, isInteracting, layoutModeOf, markMenuOpen, mergeBulkItems, notificationRowParts, toCsv as perfLogToCsv, perfReportFile, readEnvironment as readPerfEnvironment, requestAsyncEnvironment, requestWindowFront, setExposeHighlight, setShellAuthBridge, setShellNavIcons, setShellTodoProvider, setWindowDefaultPosition, setWindowPosition, splitTitle, subscribeExposeHighlight, summariseFrames, summariseLog as summarisePerfLog, toggleExposeMode, useBrowserLayoutEffect, useCurrentTabKey, useDesktopHost, useEditHotkey, useEnclosingModalId, useFilters, useInfiniteScroll, useIsActiveWindow, useModalActive, useModalDuplicate, useModalSave, useNewHotkey, usePageSearch, useSetLayoutMode, useShellAuth, useShellEntityFetcher, useUndo, useUndoCanEdit, useUndoable, useUndoableState, useWidgetSettings, useWindowDirty, useWindowManager, useWindowMenuItem, useWindowTarget, useWindowTitle };
+export { type ActivityKind, type AsyncEnvironment, BLOCKED_PCT_CPU, type BatteryInfo, BehaviorPanel, type BottleneckKind, type BulkColumn, type BulkColumnKind, BulkImportGrid, type BulkImportGridProps, type BulkRow, CancelButton, ChangePasswordForm, type ChangePasswordFormProps, type ChangelogEntry, type ClockCalendarConfig, CopyButton, Customization, type CustomizationOmitSection, type CustomizationProps, type CustomizationSection, DEV_BANNER_TEXT, Desktop, type DesktopContextMenuItem, type DesktopHostConfig, DesktopHostProvider, DevIndicator, DocFavStar, type DuplicateGroup, EditState, type EntityFetcher, type EntityRefetchIntervalOption, type EntityRefetchOnWindowFocusOption, EntityWindowFallback, type EntityWindowFallbackProps, EntityWindowLoading, EntityWindowState, type EntityWindowStateProps, FilterBar, type FilterOption, type FpsGroup, type HealthCheckResult, LOG_CAP, Layout, type LayoutMode, type LayoutProps, type LogSummary, MIN_EVENT_SAMPLES, MIN_GROUP_SAMPLES, MODAL_SUBMIT_SELECTOR, type MenuLayer, type MergeBulkOptions, type MergeBulkResult, type MobileAppConfig, Modal, ModalActions, type ModalEdit, NotificationBell, type NotificationsConfig, type OpenPageOptions, PaginatedResponse, PdfActionButton, type PdfActionButtonProps, type PerfEnvironment, type PerfLogRecord, type PerfReading, type PerfReport, PerfStats, type PerfStatsProps, type PlatformHints, SMOOTH_FPS, SearchConfig, ServerStatusIndicator, type ServerStatusIndicatorProps, type ServerStatusUser, type ShellAuth, ShellAuthProvider, type ShellBranding, ShellContextMenu, type ShellContextMenuProps, ShellEntityFetcherProvider, type ShellNotification, ShortcutHelp, SoundsPanel, type StagedTarget, StartMenu, type StickyEntityRef, type StickyResolver, SystemPreferences, type SystemPreferencesProps, type SystemPreferencesSection, type TitleParts, type TitleRole, type TodoProvider, type TodoTask, UndoControls, type UndoControlsApi, type UndoControlsProps, UndoProvider, type UndoProviderProps, type UndoSnapshot, type UndoState, type UndoStep, type UndoableOptions, type Verdict, WidgetManager, WindowCrashedFallback, WindowErrorBoundary, WindowManagerProvider, WindowRegistry, type WindowTarget, type WindowTargetOptions, WindowTitle, activateWindowById, appendRecord as appendPerfRecord, applyDevTitle, beginWindowGesture, classifyActivity, classify as classifyPerf, commitExposeHighlight, copyToClipboard, createWindowRegistry, createWindowTarget, describeMachine, describePerfReport, exitExposeMode, findDuplicateKeys, getActiveWindowRoute, getExposeHighlight, getWindowPosition, installThemeIconSets, isDevEnv, isInteracting, layoutModeOf, markMenuOpen, mergeBulkItems, notificationRowParts, toCsv as perfLogToCsv, perfReportFile, readEnvironment as readPerfEnvironment, requestAsyncEnvironment, requestWindowFront, setExposeHighlight, setShellAuthBridge, setShellNavIcons, setShellTodoProvider, setWindowDefaultPosition, setWindowPosition, splitTitle, subscribeExposeHighlight, summariseFrames, summariseLog as summarisePerfLog, toggleExposeMode, useBrowserLayoutEffect, useCurrentTabKey, useDesktopHost, useEditHotkey, useEnclosingModalId, useFilters, useInfiniteScroll, useIsActiveWindow, useModalActive, useModalDuplicate, useModalSave, useNewHotkey, usePageSearch, useSetLayoutMode, useShellAuth, useShellEntityFetcher, useUndo, useUndoCanEdit, useUndoable, useUndoableState, useWidgetSettings, useWindowDirty, useWindowManager, useWindowMenuItem, useWindowTarget, useWindowTitle };