@nice2dev/ui-platform 1.1.9 → 1.2.0

package/dist/index.d.ts

@@ -1099,6 +1099,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;
 }>;
@@ -1796,6 +1802,14 @@ 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;
 }
@@ -1817,7 +1831,10 @@ 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;
@@ -2361,7 +2378,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 +2700,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): {