@nice2dev/ui-platform 1.1.10 → 1.2.1

package/dist/index.d.ts

@@ -928,7 +928,9 @@ export declare interface MergeFunction<T = unknown> {
     (client: T, server: T, base?: T): T | Promise<T>;
 }
 
-export declare const NiceAutoStart: default_2.ForwardRefExoticComponent<NiceAutoStartProps & default_2.RefAttributes<NiceAutoStartRef>>;
+export declare const NiceAutoStart: default_2.ForwardRefExoticComponent<NiceAutoStartProps & default_2.RefAttributes<NiceAutoStartRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceAutoStartProps {
     /** Startup tasks */
@@ -951,7 +953,9 @@ export declare interface NiceAutoStartProps {
     children?: ReactNode;
 }
 
-export declare const NiceAutoStartProvider: default_2.ForwardRefExoticComponent<NiceAutoStartProps & default_2.RefAttributes<NiceAutoStartRef>>;
+export declare const NiceAutoStartProvider: default_2.ForwardRefExoticComponent<NiceAutoStartProps & default_2.RefAttributes<NiceAutoStartRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceAutoStartRef {
     /** Get current state */
@@ -972,7 +976,9 @@ export declare interface NiceAutoStartRef {
     recover: () => Promise<void>;
 }
 
-export declare const NiceBackgroundSync: default_2.ForwardRefExoticComponent<NiceBackgroundSyncProps & default_2.RefAttributes<NiceBackgroundSyncRef>>;
+export declare const NiceBackgroundSync: default_2.ForwardRefExoticComponent<NiceBackgroundSyncProps & default_2.RefAttributes<NiceBackgroundSyncRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceBackgroundSyncProps {
     /** Configuration */
@@ -996,7 +1002,9 @@ export declare interface NiceBackgroundSyncProps {
     children?: ReactNode;
 }
 
-export declare const NiceBackgroundSyncProvider: default_2.ForwardRefExoticComponent<NiceBackgroundSyncProps & default_2.RefAttributes<NiceBackgroundSyncRef>>;
+export declare const NiceBackgroundSyncProvider: default_2.ForwardRefExoticComponent<NiceBackgroundSyncProps & default_2.RefAttributes<NiceBackgroundSyncRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceBackgroundSyncRef {
     /** Get current state */
@@ -1030,7 +1038,9 @@ export declare interface NiceBackgroundSyncRef {
     registerBackgroundSync: (tag: string) => Promise<boolean>;
 }
 
-export declare const NiceBarcodeScanner: default_2.ForwardRefExoticComponent<NiceBarcodeScannerProps & default_2.RefAttributes<NiceBarcodeScannerRef>>;
+export declare const NiceBarcodeScanner: default_2.ForwardRefExoticComponent<NiceBarcodeScannerProps & default_2.RefAttributes<NiceBarcodeScannerRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceBarcodeScannerProps {
     /** Configuration */
@@ -1072,7 +1082,9 @@ export declare interface NiceBarcodeScannerRef {
     requestPermission: () => Promise<boolean>;
 }
 
-export declare const NiceBatchScanner: default_2.ForwardRefExoticComponent<NiceBatchScannerProps & default_2.RefAttributes<NiceBatchScannerRef>>;
+export declare const NiceBatchScanner: default_2.ForwardRefExoticComponent<NiceBatchScannerProps & default_2.RefAttributes<NiceBatchScannerRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceBatchScannerProps {
     /** Scanner options */
@@ -1099,6 +1111,12 @@ export declare interface NiceBatchScannerProps {
     children?: default_2.ReactNode;
 }
 
+/**
+ * Shares a NiceBatchScanner's items and actions with everything below the provider, not only
+ * with the scanner's own children: `useBatchScanner()` works beside the scanner too. Without a
+ * scanner below it, the hook sees an empty, idle batch (and the actions warn in development).
+ * It used to render its children and nothing else, so the hook threw under it.
+ */
 export declare const NiceBatchScannerProvider: default_2.FC<{
     children: default_2.ReactNode;
 }>;
@@ -1126,7 +1144,9 @@ export declare interface NiceBatchScannerRef {
     isScanning: () => boolean;
 }
 
-export declare const NiceCacheStrategies: default_2.ForwardRefExoticComponent<NiceCacheStrategiesProps & default_2.RefAttributes<NiceCacheStrategiesRef>>;
+export declare const NiceCacheStrategies: default_2.ForwardRefExoticComponent<NiceCacheStrategiesProps & default_2.RefAttributes<NiceCacheStrategiesRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceCacheStrategiesProps {
     /** Configuration */
@@ -1147,7 +1167,9 @@ export declare interface NiceCacheStrategiesProps {
     children?: ReactNode;
 }
 
-export declare const NiceCacheStrategiesProvider: default_2.ForwardRefExoticComponent<NiceCacheStrategiesProps & default_2.RefAttributes<NiceCacheStrategiesRef>>;
+export declare const NiceCacheStrategiesProvider: default_2.ForwardRefExoticComponent<NiceCacheStrategiesProps & default_2.RefAttributes<NiceCacheStrategiesRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceCacheStrategiesRef {
     /** Get current state */
@@ -1185,7 +1207,9 @@ export declare interface NiceCacheStrategiesRef {
     getStrategyForUrl: (url: string) => CacheStrategy;
 }
 
-export declare const NiceConflictResolution: default_2.ForwardRefExoticComponent<NiceConflictResolutionProps & default_2.RefAttributes<NiceConflictResolutionRef>>;
+export declare const NiceConflictResolution: default_2.ForwardRefExoticComponent<NiceConflictResolutionProps & default_2.RefAttributes<NiceConflictResolutionRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceConflictResolutionProps {
     /** Configuration */
@@ -1220,7 +1244,9 @@ export declare interface NiceConflictResolutionProps {
     children?: ReactNode;
 }
 
-export declare const NiceConflictResolutionProvider: default_2.ForwardRefExoticComponent<NiceConflictResolutionProps & default_2.RefAttributes<NiceConflictResolutionRef>>;
+export declare const NiceConflictResolutionProvider: default_2.ForwardRefExoticComponent<NiceConflictResolutionProps & default_2.RefAttributes<NiceConflictResolutionRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceConflictResolutionRef {
     /** Get current state */
@@ -1251,7 +1277,9 @@ export declare interface NiceConflictResolutionRef {
     closeUI: () => void;
 }
 
-export declare const NiceExternalDisplay: default_2.ForwardRefExoticComponent<NiceExternalDisplayProps & default_2.RefAttributes<NiceExternalDisplayRef>>;
+export declare const NiceExternalDisplay: default_2.ForwardRefExoticComponent<NiceExternalDisplayProps & default_2.RefAttributes<NiceExternalDisplayRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceExternalDisplayProps {
     /** Configuration */
@@ -1268,7 +1296,9 @@ export declare interface NiceExternalDisplayProps {
     children?: ReactNode;
 }
 
-export declare const NiceExternalDisplayProvider: default_2.ForwardRefExoticComponent<NiceExternalDisplayProps & default_2.RefAttributes<NiceExternalDisplayRef>>;
+export declare const NiceExternalDisplayProvider: default_2.ForwardRefExoticComponent<NiceExternalDisplayProps & default_2.RefAttributes<NiceExternalDisplayRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceExternalDisplayRef {
     /** Get current state */
@@ -1293,7 +1323,9 @@ export declare interface NiceExternalDisplayRef {
     broadcast: (message: unknown) => void;
 }
 
-export declare const NiceHardwareBarcodeGenerator: default_2.ForwardRefExoticComponent<NiceHardwareBarcodeGeneratorProps & default_2.RefAttributes<NiceHardwareBarcodeGeneratorRef>>;
+export declare const NiceHardwareBarcodeGenerator: default_2.ForwardRefExoticComponent<NiceHardwareBarcodeGeneratorProps & default_2.RefAttributes<NiceHardwareBarcodeGeneratorRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceHardwareBarcodeGeneratorProps {
     /** Value to encode */
@@ -1323,7 +1355,9 @@ export declare interface NiceHardwareBarcodeGeneratorRef {
     regenerate: () => void;
 }
 
-export declare const NiceHardwareQRGenerator: default_2.ForwardRefExoticComponent<NiceHardwareQRGeneratorProps & default_2.RefAttributes<NiceHardwareQRGeneratorRef>>;
+export declare const NiceHardwareQRGenerator: default_2.ForwardRefExoticComponent<NiceHardwareQRGeneratorProps & default_2.RefAttributes<NiceHardwareQRGeneratorRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceHardwareQRGeneratorProps {
     /** Data to encode */
@@ -1351,7 +1385,9 @@ export declare interface NiceHardwareQRGeneratorRef {
     regenerate: () => void;
 }
 
-export declare const NiceIndexedDB: default_2.ForwardRefExoticComponent<NiceIndexedDBProps & default_2.RefAttributes<NiceIndexedDBRef>>;
+export declare const NiceIndexedDB: default_2.ForwardRefExoticComponent<NiceIndexedDBProps & default_2.RefAttributes<NiceIndexedDBRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceIndexedDBProps {
     /** Database configuration */
@@ -1368,7 +1404,9 @@ export declare interface NiceIndexedDBProps {
     children?: ReactNode;
 }
 
-export declare const NiceIndexedDBProvider: default_2.ForwardRefExoticComponent<NiceIndexedDBProps & default_2.RefAttributes<NiceIndexedDBRef>>;
+export declare const NiceIndexedDBProvider: default_2.ForwardRefExoticComponent<NiceIndexedDBProps & default_2.RefAttributes<NiceIndexedDBRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceIndexedDBRef {
     /** Get current state */
@@ -1418,7 +1456,9 @@ export declare interface NiceIndexedDBRef {
     }>;
 }
 
-export declare const NiceKioskMode: default_2.ForwardRefExoticComponent<NiceKioskModeProps & default_2.RefAttributes<NiceKioskModeRef>>;
+export declare const NiceKioskMode: default_2.ForwardRefExoticComponent<NiceKioskModeProps & default_2.RefAttributes<NiceKioskModeRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceKioskModeProps {
     /** Configuration */
@@ -1443,7 +1483,9 @@ export declare interface NiceKioskModeProps {
     onExitRequest?: (method: ExitMethod) => boolean | Promise<boolean>;
 }
 
-export declare const NiceKioskModeProvider: default_2.ForwardRefExoticComponent<NiceKioskModeProps & default_2.RefAttributes<NiceKioskModeRef>>;
+export declare const NiceKioskModeProvider: default_2.ForwardRefExoticComponent<NiceKioskModeProps & default_2.RefAttributes<NiceKioskModeRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceKioskModeRef {
     /** Get current state */
@@ -1474,7 +1516,9 @@ export declare interface NiceKioskModeRef {
     closePinDialog: () => void;
 }
 
-export declare const NiceLowPowerMode: default_2.ForwardRefExoticComponent<NiceLowPowerModeProps & default_2.RefAttributes<NiceLowPowerModeRef>>;
+export declare const NiceLowPowerMode: default_2.ForwardRefExoticComponent<NiceLowPowerModeProps & default_2.RefAttributes<NiceLowPowerModeRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceLowPowerModeProps {
     /** Configuration */
@@ -1493,7 +1537,9 @@ export declare interface NiceLowPowerModeProps {
     children?: ReactNode;
 }
 
-export declare const NiceLowPowerModeProvider: default_2.ForwardRefExoticComponent<NiceLowPowerModeProps & default_2.RefAttributes<NiceLowPowerModeRef>>;
+export declare const NiceLowPowerModeProvider: default_2.ForwardRefExoticComponent<NiceLowPowerModeProps & default_2.RefAttributes<NiceLowPowerModeRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceLowPowerModeRef {
     /** Get current state */
@@ -1517,7 +1563,9 @@ export declare interface NiceLowPowerModeRef {
     }>;
 }
 
-export declare const NiceOfflineForms: default_2.ForwardRefExoticComponent<NiceOfflineFormsProps & default_2.RefAttributes<NiceOfflineFormsRef>>;
+export declare const NiceOfflineForms: default_2.ForwardRefExoticComponent<NiceOfflineFormsProps & default_2.RefAttributes<NiceOfflineFormsRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceOfflineFormsProps {
     /** Configuration */
@@ -1539,7 +1587,9 @@ export declare interface NiceOfflineFormsProps {
     children?: ReactNode;
 }
 
-export declare const NiceOfflineFormsProvider: default_2.ForwardRefExoticComponent<NiceOfflineFormsProps & default_2.RefAttributes<NiceOfflineFormsRef>>;
+export declare const NiceOfflineFormsProvider: default_2.ForwardRefExoticComponent<NiceOfflineFormsProps & default_2.RefAttributes<NiceOfflineFormsRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceOfflineFormsRef {
     /** Get current state */
@@ -1573,7 +1623,9 @@ export declare interface NiceOfflineFormsRef {
     registerHandler: <T = Record<string, unknown>>(formId: string, handler: FormSubmitHandler<T>) => void;
 }
 
-export declare const NiceOfflineIndicator: default_2.ForwardRefExoticComponent<NiceOfflineIndicatorProps & default_2.RefAttributes<NiceOfflineIndicatorRef>>;
+export declare const NiceOfflineIndicator: default_2.ForwardRefExoticComponent<NiceOfflineIndicatorProps & default_2.RefAttributes<NiceOfflineIndicatorRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceOfflineIndicatorProps {
     /** Display mode */
@@ -1637,7 +1689,9 @@ export declare interface NiceOfflineIndicatorRef {
     toggle: () => void;
 }
 
-export declare const NiceOfflineMedia: default_2.ForwardRefExoticComponent<NiceOfflineMediaProps & default_2.RefAttributes<NiceOfflineMediaRef>>;
+export declare const NiceOfflineMedia: default_2.ForwardRefExoticComponent<NiceOfflineMediaProps & default_2.RefAttributes<NiceOfflineMediaRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceOfflineMediaProps {
     /** Configuration */
@@ -1656,7 +1710,9 @@ export declare interface NiceOfflineMediaProps {
     children?: ReactNode;
 }
 
-export declare const NiceOfflineMediaProvider: default_2.ForwardRefExoticComponent<NiceOfflineMediaProps & default_2.RefAttributes<NiceOfflineMediaRef>>;
+export declare const NiceOfflineMediaProvider: default_2.ForwardRefExoticComponent<NiceOfflineMediaProps & default_2.RefAttributes<NiceOfflineMediaRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceOfflineMediaRef {
     /** Get current state */
@@ -1709,7 +1765,9 @@ export declare interface NiceOfflineMediaRef {
     preload: (urls: string[]) => Promise<void>;
 }
 
-export declare const NiceOrientationLock: default_2.ForwardRefExoticComponent<NiceOrientationLockProps & default_2.RefAttributes<NiceOrientationLockRef>>;
+export declare const NiceOrientationLock: default_2.ForwardRefExoticComponent<NiceOrientationLockProps & default_2.RefAttributes<NiceOrientationLockRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceOrientationLockProps {
     /** Configuration */
@@ -1728,7 +1786,9 @@ export declare interface NiceOrientationLockProps {
     className?: string;
 }
 
-export declare const NiceOrientationLockProvider: default_2.ForwardRefExoticComponent<NiceOrientationLockProps & default_2.RefAttributes<NiceOrientationLockRef>>;
+export declare const NiceOrientationLockProvider: default_2.ForwardRefExoticComponent<NiceOrientationLockProps & default_2.RefAttributes<NiceOrientationLockRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceOrientationLockRef {
     /** Get current state */
@@ -1745,7 +1805,9 @@ export declare interface NiceOrientationLockRef {
     isOrientationSupported: (orientation: OrientationType_2) => boolean;
 }
 
-export declare const NiceQRScanner: default_2.ForwardRefExoticComponent<NiceQRScannerProps & default_2.RefAttributes<NiceQRScannerRef>>;
+export declare const NiceQRScanner: default_2.ForwardRefExoticComponent<NiceQRScannerProps & default_2.RefAttributes<NiceQRScannerRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceQRScannerProps {
     /** Configuration */
@@ -1785,7 +1847,9 @@ export declare interface NiceQRScannerRef {
     scanImage: (file: File) => Promise<QRScanResult | null>;
 }
 
-export declare const NiceRemoteManagement: default_2.ForwardRefExoticComponent<NiceRemoteManagementProps & default_2.RefAttributes<NiceRemoteManagementRef>>;
+export declare const NiceRemoteManagement: default_2.ForwardRefExoticComponent<NiceRemoteManagementProps & default_2.RefAttributes<NiceRemoteManagementRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceRemoteManagementProps {
     /** Configuration */
@@ -1796,11 +1860,21 @@ export declare interface NiceRemoteManagementProps {
     onCommandReceived?: (command: RemoteCommand) => void;
     /** On custom command */
     onCustomCommand?: (command: RemoteCommand) => Promise<unknown>;
+    /**
+     * Takes the screenshot for the server's `screenshot` command and for `captureScreenshot()`:
+     * return the image, e.g. as a data URL. A page cannot capture itself without asking the user,
+     * so the capture comes from the host — html2canvas / html-to-image, or the kiosk shell
+     * (Electron's `webContents.capturePage()` and the like). Without it the command reports an
+     * error to the server.
+     */
+    onCaptureScreenshot?: () => Promise<string | undefined>;
     /** Children */
     children?: ReactNode;
 }
 
-export declare const NiceRemoteManagementProvider: default_2.ForwardRefExoticComponent<NiceRemoteManagementProps & default_2.RefAttributes<NiceRemoteManagementRef>>;
+export declare const NiceRemoteManagementProvider: default_2.ForwardRefExoticComponent<NiceRemoteManagementProps & default_2.RefAttributes<NiceRemoteManagementRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceRemoteManagementRef {
     /** Get current state */
@@ -1817,13 +1891,18 @@ export declare interface NiceRemoteManagementRef {
     reportCommandResult: (commandId: string, result: unknown, error?: string) => Promise<void>;
     /** Send log */
     sendLog: (level: string, message: string, data?: unknown) => void;
-    /** Capture screenshot */
+    /**
+     * Capture a screenshot through `onCaptureScreenshot`; `undefined` when screenshots are off,
+     * there is no handler or it failed.
+     */
     captureScreenshot: () => Promise<string | undefined>;
     /** Get device info */
     getDeviceInfo: () => DeviceInfo;
 }
 
-export declare const NiceScreenBurnPrevention: default_2.ForwardRefExoticComponent<NiceScreenBurnPreventionProps & default_2.RefAttributes<NiceScreenBurnPreventionRef>>;
+export declare const NiceScreenBurnPrevention: default_2.ForwardRefExoticComponent<NiceScreenBurnPreventionProps & default_2.RefAttributes<NiceScreenBurnPreventionRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceScreenBurnPreventionProps {
     /** Configuration */
@@ -1874,7 +1953,9 @@ export declare interface NiceScreenSelectorProps {
     className?: string;
 }
 
-export declare const NiceServiceWorker: default_2.ForwardRefExoticComponent<NiceServiceWorkerProps & default_2.RefAttributes<NiceServiceWorkerRef>>;
+export declare const NiceServiceWorker: default_2.ForwardRefExoticComponent<NiceServiceWorkerProps & default_2.RefAttributes<NiceServiceWorkerRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceServiceWorkerProps {
     /** Service worker configuration */
@@ -1912,10 +1993,11 @@ export declare interface NiceServiceWorkerProps {
     className?: string;
 }
 
-export declare const NiceServiceWorkerProvider: default_2.ForwardRefExoticComponent<NiceServiceWorkerProviderProps & default_2.RefAttributes<NiceServiceWorkerRef>>;
+export declare const NiceServiceWorkerProvider: default_2.ForwardRefExoticComponent<NiceServiceWorkerProps & default_2.RefAttributes<NiceServiceWorkerRef>> & {
+    displayName: string;
+};
 
-export declare interface NiceServiceWorkerProviderProps extends NiceServiceWorkerProps {
-}
+export declare type NiceServiceWorkerProviderProps = NiceServiceWorkerProps;
 
 export declare interface NiceServiceWorkerRef {
     /** Get current state */
@@ -1946,7 +2028,9 @@ export declare interface NiceServiceWorkerRef {
     forceReload: () => void;
 }
 
-export declare const NiceSymbologyConfig: default_2.ForwardRefExoticComponent<NiceSymbologyConfigProps & default_2.RefAttributes<NiceSymbologyConfigRef>>;
+export declare const NiceSymbologyConfig: default_2.ForwardRefExoticComponent<NiceSymbologyConfigProps & default_2.RefAttributes<NiceSymbologyConfigRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceSymbologyConfigProps {
     /** Selected symbologies */
@@ -1992,7 +2076,9 @@ export declare const NiceSymbologyProvider: default_2.FC<{
     children: default_2.ReactNode;
 }>;
 
-export declare const NiceTouchCalibration: default_2.ForwardRefExoticComponent<NiceTouchCalibrationProps & default_2.RefAttributes<NiceTouchCalibrationRef>>;
+export declare const NiceTouchCalibration: default_2.ForwardRefExoticComponent<NiceTouchCalibrationProps & default_2.RefAttributes<NiceTouchCalibrationRef>> & {
+    displayName: string;
+};
 
 export declare interface NiceTouchCalibrationProps {
     /** Configuration */
@@ -2361,7 +2447,10 @@ export declare interface RemoteManagementConfig {
     enableHealthMonitoring?: boolean;
     /** Health report interval (ms) */
     healthReportInterval?: number;
-    /** Enable screenshot capture */
+    /**
+     * Answer the server's `screenshot` command (default true). The image itself comes from
+     * `onCaptureScreenshot`; with this off, or without that prop, the command reports an error.
+     */
     enableScreenshot?: boolean;
     /** Enable log collection */
     enableLogs?: boolean;
@@ -2680,6 +2769,10 @@ export declare const useAutoStart: () => AutoStartContextValue;
 
 export declare const useBackgroundSync: () => BackgroundSyncContextValue;
 
+/**
+ * The scanned items and the scanner's actions — inside a NiceBatchScanner (its children), or
+ * anywhere below a NiceBatchScannerProvider that has a NiceBatchScanner somewhere under it.
+ */
 export declare const useBatchScanner: () => BatchScannerContextValue;
 
 export declare function useCachedFetch<T = unknown>(url: string | null, options?: FetchOptions): {