@godscene/playground-electron 1.7.11

package/dist/types/PlaygroundPreview.d.ts

@@ -0,0 +1,22 @@
+import type { PlaygroundRuntimeInfo, PlaygroundSDK } from '@godscene/playground';
+import type { ScreenshotViewerMode } from '@godscene/visualizer';
+import type { CSSProperties, ReactNode } from 'react';
+import type { ScrcpyErrorOverlayRenderer } from './ScrcpyPanel';
+import type { ManualDragActionType } from './manual-interaction';
+import type { ScrcpyPreviewStatus } from './scrcpy-preview';
+export interface PlaygroundPreviewProps {
+    connectingOverlay?: ReactNode;
+    onScrcpyStatusChange?: (status: ScrcpyPreviewStatus, statusText: string) => void;
+    renderErrorOverlay?: ScrcpyErrorOverlayRenderer;
+    scrcpyViewportStyle?: CSSProperties;
+    screenshotViewerMode?: ScreenshotViewerMode;
+    playgroundSDK: PlaygroundSDK;
+    runtimeInfo: PlaygroundRuntimeInfo | null;
+    serverUrl: string;
+    serverOnline: boolean;
+    isUserOperating: boolean;
+    manualControlEnabled?: boolean;
+    manualDragActionType?: ManualDragActionType;
+    manualKeyboardEnabled?: boolean;
+}
+export declare function PlaygroundPreview(props: PlaygroundPreviewProps): import("react").JSX.Element;

package/dist/types/PlaygroundThemeProvider.d.ts

@@ -0,0 +1,2 @@
+import type { PropsWithChildren } from 'react';
+export declare function PlaygroundThemeProvider({ children }: PropsWithChildren): import("react").JSX.Element;

package/dist/types/PreviewRenderer.d.ts

@@ -0,0 +1,27 @@
+import type { PlaygroundRuntimeInfo, PlaygroundSDK } from '@godscene/playground';
+import { type ScreenshotViewerMode } from '@godscene/visualizer';
+import React, { type CSSProperties, type ReactNode } from 'react';
+import { type ScrcpyErrorOverlayRenderer } from './ScrcpyPanel';
+import { type ManualDragActionType } from './manual-interaction';
+import type { ScrcpyPreviewStatus } from './scrcpy-preview';
+interface PreviewRendererProps {
+    connectingOverlay?: ReactNode;
+    onScrcpyStatusChange?: (status: ScrcpyPreviewStatus, statusText: string) => void;
+    renderErrorOverlay?: ScrcpyErrorOverlayRenderer;
+    scrcpyViewportStyle?: CSSProperties;
+    screenshotViewerMode?: ScreenshotViewerMode;
+    playgroundSDK: PlaygroundSDK;
+    runtimeInfo: PlaygroundRuntimeInfo | null;
+    serverUrl: string;
+    serverOnline: boolean;
+    isUserOperating: boolean;
+    /**
+     * When true, the preview accepts mouse/touch input and forwards it to the
+     * connected device (Android via ADB, iOS via WDA, Harmony via HDC).
+     */
+    manualControlEnabled?: boolean;
+    manualDragActionType?: ManualDragActionType;
+    manualKeyboardEnabled?: boolean;
+}
+export declare function PreviewRenderer({ connectingOverlay, onScrcpyStatusChange, renderErrorOverlay, scrcpyViewportStyle, screenshotViewerMode, playgroundSDK, runtimeInfo, serverUrl, serverOnline, isUserOperating, manualControlEnabled, manualDragActionType, manualKeyboardEnabled, }: PreviewRendererProps): React.JSX.Element;
+export {};

package/dist/types/ScrcpyPanel.d.ts

@@ -0,0 +1,21 @@
+import React, { type CSSProperties, type ReactNode } from 'react';
+import { type ScrcpyPreviewStatus } from './scrcpy-preview';
+export interface ScrcpyErrorOverlayContext {
+    errorMessage: string | null;
+    retry: () => void;
+    status: ScrcpyPreviewStatus;
+    statusText: string;
+}
+export type ScrcpyErrorOverlayRenderer = (context: ScrcpyErrorOverlayContext) => ReactNode;
+interface ScrcpyPanelProps {
+    connectingOverlay?: ReactNode;
+    deviceId?: string;
+    onStatusChange?: (status: ScrcpyPreviewStatus, statusText: string) => void;
+    renderErrorOverlay?: ScrcpyErrorOverlayRenderer;
+    serverUrl?: string;
+    metadataTimeoutMs?: number;
+    reconnectInterval?: number;
+    viewportStyle?: CSSProperties;
+}
+export declare function ScrcpyPanel({ connectingOverlay, deviceId, onStatusChange, renderErrorOverlay, serverUrl, metadataTimeoutMs, reconnectInterval, viewportStyle, }: ScrcpyPanelProps): React.JSX.Element;
+export {};

package/dist/types/SessionSetupPanel.d.ts

@@ -0,0 +1,16 @@
+import type { PlaygroundSessionField, PlaygroundSessionSetup } from '@godscene/playground';
+import type { FormInstance } from 'antd';
+import type { PlaygroundFormValues } from './controller/types';
+import type { PlaygroundSessionViewState } from './session-state';
+import './SessionSetupPanel.less';
+export declare function getPlatformSelectorOptions(field: PlaygroundSessionField, setup: PlaygroundSessionSetup | null): PlaygroundSessionField['options'];
+export interface SessionSetupPanelProps {
+    form: FormInstance<PlaygroundFormValues>;
+    sessionSetup: PlaygroundSessionSetup | null;
+    sessionSetupError: string | null;
+    sessionViewState: PlaygroundSessionViewState;
+    sessionLoading: boolean;
+    sessionMutating: boolean;
+    onCreateSession: () => void | Promise<void>;
+}
+export declare function SessionSetupPanel({ form, sessionSetup, sessionSetupError, sessionViewState, sessionLoading, sessionMutating, onCreateSession, }: SessionSetupPanelProps): import("react").JSX.Element;

package/dist/types/components/Header/index.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+import './index.css';
+export declare function Header(props: any): React.JSX.Element;

package/dist/types/components/Nav/index.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+import './index.css';
+export declare function Nav(): React.JSX.Element;

package/dist/types/components/WinControlTool/index.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import './index.css';
+export default function WinControlTool({ token, parentToken, pageName }: any): React.JSX.Element;

package/dist/types/controller/ai-config.d.ts

@@ -0,0 +1,5 @@
+import type { PlaygroundSDK } from '@godscene/playground';
+export type PlaygroundAiConfig = Record<string, string>;
+export declare function hasPlaygroundAiConfig(config: PlaygroundAiConfig): boolean;
+export declare function serializePlaygroundAiConfig(config: PlaygroundAiConfig): string;
+export declare function applyPlaygroundAiConfig(playgroundSDK: Pick<PlaygroundSDK, 'overrideConfig'>, config: PlaygroundAiConfig): Promise<boolean>;

package/dist/types/controller/auto-create.d.ts

@@ -0,0 +1,15 @@
+export type AutoCreateInput = Record<string, unknown> | null | undefined;
+export interface ResolveAutoCreateDecisionOptions {
+    autoCreateInput: AutoCreateInput;
+    lastAttemptedSignature: string | null;
+    blockedSignature: string | null;
+}
+export interface AutoCreateDecision {
+    signature: string | null;
+    shouldCreate: boolean;
+}
+export declare function serializeAutoCreateInput(autoCreateInput: AutoCreateInput): string | null;
+export declare function resolveAutoCreateDecision({ autoCreateInput, lastAttemptedSignature, blockedSignature, }: ResolveAutoCreateDecisionOptions): AutoCreateDecision;
+export declare function shouldResetAutoCreateBlock(options?: {
+    silent?: boolean;
+}): boolean;

package/dist/types/controller/selectors.d.ts

@@ -0,0 +1,5 @@
+import type { PlaygroundRuntimeInfo } from '@godscene/playground';
+import type { PlaygroundBranding, UniversalPlaygroundConfig } from '@godscene/visualizer';
+import type { PlaygroundControllerState } from './types';
+export declare function buildConversationConfig(state: Pick<PlaygroundControllerState, 'deviceType' | 'executionUxHints' | 'countdownSeconds'>, playgroundConfig?: Partial<UniversalPlaygroundConfig>): UniversalPlaygroundConfig;
+export declare function buildConversationBranding(runtimeInfo: PlaygroundRuntimeInfo | null, title: string, appVersion: string, deviceType: string, branding?: Partial<PlaygroundBranding>): PlaygroundBranding;

package/dist/types/controller/single-flight.d.ts

@@ -0,0 +1,3 @@
+export declare function runSingleFlight<T>(pendingRef: {
+    current: Promise<T> | null;
+}, task: () => Promise<T>): Promise<T>;

package/dist/types/controller/types.d.ts

@@ -0,0 +1,36 @@
+import type { PlaygroundRuntimeInfo, PlaygroundSDK, PlaygroundSessionSetup } from '@godscene/playground';
+import type { DeviceType, ExecutionUxHint } from '@godscene/visualizer';
+import type { FormInstance } from 'antd';
+import type { PlaygroundSessionViewState } from '../session-state';
+export type PlaygroundFormValue = boolean | null | number | string | undefined;
+export type PlaygroundFormValues = Record<string, PlaygroundFormValue>;
+export interface PlaygroundControllerState {
+    playgroundSDK: PlaygroundSDK;
+    form: FormInstance<PlaygroundFormValues>;
+    formValues: Record<string, unknown>;
+    serverOnline: boolean;
+    isUserOperating: boolean;
+    deviceType: DeviceType;
+    runtimeInfo: PlaygroundRuntimeInfo | null;
+    executionUxHints: ExecutionUxHint[];
+    sessionViewState: PlaygroundSessionViewState;
+    sessionSetup: PlaygroundSessionSetup | null;
+    sessionSetupError: string | null;
+    sessionLoading: boolean;
+    sessionMutating: boolean;
+    countdown: number | string | null;
+    countdownSeconds: number;
+}
+export interface PlaygroundControllerActions {
+    refreshServerState: () => Promise<void>;
+    refreshSessionSetup: (input?: Record<string, unknown>) => Promise<void>;
+    createSession: (input?: Record<string, unknown>, options?: {
+        silent?: boolean;
+    }) => Promise<boolean>;
+    destroySession: () => Promise<void>;
+    finishCountdown: () => void;
+}
+export interface PlaygroundControllerResult {
+    state: PlaygroundControllerState;
+    actions: PlaygroundControllerActions;
+}

package/dist/types/controller/usePlaygroundController.d.ts

@@ -0,0 +1,16 @@
+import { type DeviceType } from '@godscene/visualizer';
+import type { PlaygroundControllerResult } from './types';
+export interface UsePlaygroundControllerOptions {
+    serverUrl: string;
+    defaultDeviceType?: DeviceType;
+    pollIntervalMs?: number;
+    countdownSeconds?: number;
+    /**
+     * Seed values written into the session-setup form on the first render.
+     * Useful for pre-selecting a default platform so the initial
+     * `refreshSessionSetup` poll already has a `platformId`, instead of
+     * returning a generic "Choose a platform" setup.
+     */
+    initialFormValues?: Record<string, unknown>;
+}
+export declare function usePlaygroundController({ serverUrl, defaultDeviceType, pollIntervalMs, countdownSeconds, initialFormValues, }: UsePlaygroundControllerOptions): PlaygroundControllerResult;

package/dist/types/index.d.ts

@@ -0,0 +1,13 @@
+export { PlaygroundApp } from './PlaygroundApp';
+export { PlaygroundPreview } from './PlaygroundPreview';
+export type { ManualDragActionType } from './manual-interaction';
+export { PlaygroundThemeProvider } from './PlaygroundThemeProvider';
+export { DeviceInteractionLayer } from './DeviceInteractionLayer';
+export type { DeviceInteractionLayerProps, DeviceSize, } from './DeviceInteractionLayer';
+export { PlaygroundConversationPanel } from './panels/PlaygroundConversationPanel';
+export type { PlaygroundAppProps } from './PlaygroundApp';
+export type { PlaygroundPreviewProps } from './PlaygroundPreview';
+export type { PlaygroundConversationPanelProps } from './panels/PlaygroundConversationPanel';
+export type { DeviceType } from '@godscene/visualizer';
+export type { PlaygroundControllerActions, PlaygroundControllerResult, PlaygroundControllerState, } from './controller/types';
+export { usePlaygroundController } from './controller/usePlaygroundController';

package/dist/types/manual-interaction.d.ts

@@ -0,0 +1,21 @@
+export type ManualDragActionType = 'Swipe' | 'DragAndDrop';
+export declare function buildManualDragInteractPayload(actionType: ManualDragActionType, start: {
+    x: number;
+    y: number;
+}, end: {
+    x: number;
+    y: number;
+}, duration: number): {
+    actionType: ManualDragActionType;
+    x: number;
+    y: number;
+    endX: number;
+    endY: number;
+} | {
+    duration: number;
+    actionType: ManualDragActionType;
+    x: number;
+    y: number;
+    endX: number;
+    endY: number;
+};

package/dist/types/panels/PlaygroundConversationPanel.d.ts

@@ -0,0 +1,25 @@
+import { type PlaygroundBranding, type UniversalPlaygroundConfig } from '@godscene/visualizer';
+import type { ReactNode } from 'react';
+import type { PlaygroundControllerResult } from '../controller/types';
+import './PlaygroundConversationPanel.less';
+export interface PlaygroundConversationPanelProps {
+    controller: PlaygroundControllerResult;
+    appVersion: string;
+    title?: string;
+    branding?: Partial<PlaygroundBranding>;
+    playgroundConfig?: Partial<UniversalPlaygroundConfig>;
+    header?: ReactNode;
+    className?: string;
+    /**
+     * Extra class appended to the inner `UniversalPlayground` root.
+     */
+    playgroundClassName?: string;
+    /**
+     * Custom content shown while the session is not yet connected.
+     * When supplied, replaces the built-in `SessionSetupPanel`, letting hosts
+     * drive device selection elsewhere.
+     */
+    notConnectedFallback?: ReactNode;
+    onHumanUse: any;
+}
+export declare function PlaygroundConversationPanel({ controller, appVersion, title, branding, playgroundConfig, header, className, playgroundClassName, notConnectedFallback, onHumanUse }: PlaygroundConversationPanelProps): import("react").JSX.Element;

package/dist/types/runtime-info.d.ts

@@ -0,0 +1,22 @@
+import type { PlaygroundRuntimeInfo } from '@godscene/playground';
+import type { DeviceType, ExecutionUxHint } from '@godscene/visualizer';
+export interface PreviewConnectionInfo {
+    type: 'none' | 'screenshot' | 'mjpeg' | 'scrcpy';
+    deviceId?: string;
+    mjpegUrl?: string;
+    scrcpyUrl?: string;
+    scrcpyPort?: number;
+}
+export declare function isValidDeviceType(type: string): type is DeviceType;
+export declare function normalizeRuntimeDeviceType(runtimeInfo: PlaygroundRuntimeInfo | null, fallback: DeviceType): DeviceType;
+export declare function buildFallbackRuntimeInfo(previousRuntimeInfo: PlaygroundRuntimeInfo | null, interfaceInfo: RuntimeInterfaceInfo): PlaygroundRuntimeInfo;
+export interface RuntimeInterfaceInfo {
+    type: string;
+    description?: string;
+    size?: {
+        width: number;
+        height: number;
+    };
+}
+export declare function filterValidExecutionUxHints(runtimeInfo: PlaygroundRuntimeInfo | null): ExecutionUxHint[];
+export declare function resolvePreviewConnectionInfo(runtimeInfo: PlaygroundRuntimeInfo | null, serverUrl: string): PreviewConnectionInfo;

package/dist/types/scrcpy-preview.d.ts

@@ -0,0 +1,11 @@
+export declare const SCRCPY_METADATA_TIMEOUT_MS: number;
+export type ScrcpyPreviewStatus = 'connecting' | 'waiting-for-stream' | 'connected' | 'disconnected' | 'error';
+export interface ScrcpyPreviewStatusEvent {
+    message: string;
+    phase?: string;
+}
+export declare function isScrcpyPreviewStatusEvent(value: unknown): value is ScrcpyPreviewStatusEvent;
+export declare function getDefaultScrcpyWaitingStatusText(): string;
+export declare function getScrcpyDecoderStatusText(): string;
+export declare function getScrcpyPreviewStatusText(status: ScrcpyPreviewStatus, waitingMessage?: string): string;
+export declare function getScrcpyMetadataTimeoutMessage(timeoutMs?: number): string;

package/dist/types/scrcpy-stream.d.ts

@@ -0,0 +1,16 @@
+import type { ScrcpyMediaStreamPacket } from '@yume-chan/scrcpy';
+interface RawScrcpyVideoPacket {
+    type?: string;
+    data: ArrayLike<number>;
+    keyFrame?: boolean;
+}
+interface ScrcpyVideoSocketLike {
+    on(event: 'video-data', handler: (data: RawScrcpyVideoPacket) => void): void;
+    on(event: 'disconnect', handler: () => void): void;
+    on(event: 'error', handler: (error: Error) => void): void;
+    off(event: 'video-data', handler: (data: RawScrcpyVideoPacket) => void): void;
+    off(event: 'disconnect', handler: () => void): void;
+    off(event: 'error', handler: (error: Error) => void): void;
+}
+export declare function createScrcpyVideoStream(socket: ScrcpyVideoSocketLike): ReadableStream<ScrcpyMediaStreamPacket>;
+export {};

package/dist/types/session-setup.d.ts

@@ -0,0 +1,2 @@
+import type { PlaygroundSessionSetup } from '@godscene/playground';
+export declare function resolveAutoCreateSessionInput(setup: PlaygroundSessionSetup | null, existingValues?: Record<string, unknown>): Record<string, unknown> | null;

package/dist/types/session-state.d.ts

@@ -0,0 +1,9 @@
+import type { PlaygroundRuntimeInfo, PlaygroundSessionSetup } from '@godscene/playground';
+export interface PlaygroundSessionViewState {
+    connected: boolean;
+    displayName?: string;
+    setupState: 'required' | 'ready' | 'blocked';
+    setupBlockingReason?: string;
+}
+export declare function resolveSessionViewState(runtimeInfo: PlaygroundRuntimeInfo | null): PlaygroundSessionViewState;
+export declare function buildSessionInitialValues(setup: PlaygroundSessionSetup | null, existingValues?: Record<string, unknown>): Record<string, unknown>;

package/dist/types/useServerStatus.d.ts

@@ -0,0 +1,12 @@
+import type { PlaygroundRuntimeInfo, PlaygroundSDK } from '@godscene/playground';
+import type { DeviceType, ExecutionUxHint } from '@godscene/visualizer';
+interface ServerStatusResult {
+    serverOnline: boolean;
+    isUserOperating: boolean;
+    deviceType: DeviceType;
+    runtimeInfo: PlaygroundRuntimeInfo | null;
+    executionUxHints: ExecutionUxHint[];
+    refreshServerState: () => Promise<void>;
+}
+export declare function useServerStatus(playgroundSDK: PlaygroundSDK, defaultDeviceType: DeviceType, pollIntervalMs: number): ServerStatusResult;
+export {};

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@godscene/playground-electron",
+  "version": "1.7.11",
+  "description": "Reusable React shell for Midscene playground applications",
+  "repository": "https://github.com/web-infra-dev/midscene",
+  "homepage": "https://midscenejs.com/",
+  "types": "./dist/types/index.d.ts",
+  "main": "./dist/lib/index.js",
+  "module": "./dist/es/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/es/index.mjs",
+      "require": "./dist/lib/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "peerDependencies": {
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0"
+  },
+  "dependencies": {
+    "@yume-chan/scrcpy": "2.3.0",
+    "@yume-chan/scrcpy-decoder-webcodecs": "2.5.0",
+    "@ant-design/icons": "^5.3.1",
+    "antd": "^5.21.6",
+    "react-resizable-panels": "2.0.22",
+    "socket.io-client": "4.8.1",
+    "@godscene/visualizer": "1.7.11",
+    "@godscene/playground": "1.7.11",
+    "@godscene/shared": "1.7.11"
+  },
+  "devDependencies": {
+    "@rsbuild/plugin-less": "^1.5.0",
+    "@rsbuild/plugin-node-polyfill": "1.4.2",
+    "@rsbuild/plugin-react": "^1.4.1",
+    "@rsbuild/plugin-svgr": "^1.2.2",
+    "@rslib/core": "^0.18.3",
+    "@types/node": "^18.0.0",
+    "@types/react": "^18.3.1",
+    "@types/react-dom": "^18.3.1",
+    "less": "^4.2.0",
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
+    "typescript": "^5.8.3",
+    "vitest": "3.0.5"
+  },
+  "sideEffects": [
+    "**/*.css",
+    "**/*.less",
+    "**/*.sass",
+    "**/*.scss"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "license": "MIT",
+  "scripts": {
+    "dev": "npm run build:watch",
+    "build": "rslib build",
+    "build:watch": "rslib build --watch --no-clean",
+    "test": "vitest --run",
+    "test:watch": "vitest"
+  }
+}