@babylonjs/inspector 9.3.0 → 9.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/inspector-bridge.mjs +11 -2
- package/lib/{extensionsListService-DPHWDyzb.js → extensionsListService-DA8_rCpk.js} +2 -2
- package/lib/{extensionsListService-DPHWDyzb.js.map → extensionsListService-DA8_rCpk.js.map} +1 -1
- package/lib/{index-BaFR1FRV.js → index-nEGqYbP2.js} +342 -300
- package/lib/index-nEGqYbP2.js.map +1 -0
- package/lib/index.d.ts +2 -2
- package/lib/index.js +1 -1
- package/lib/inspectable.d.ts +27 -10
- package/lib/inspector.d.ts +7 -2
- package/lib/{quickCreateToolsService-DJ1GVvH-.js → quickCreateToolsService-_L22btR5.js} +2 -2
- package/lib/{quickCreateToolsService-DJ1GVvH-.js.map → quickCreateToolsService-_L22btR5.js.map} +1 -1
- package/lib/{reflectorService-Cd41l6Tr.js → reflectorService-BMLxtZT7.js} +2 -2
- package/lib/{reflectorService-Cd41l6Tr.js.map → reflectorService-BMLxtZT7.js.map} +1 -1
- package/lib/services/cli/entityQueryService.d.ts +2 -2
- package/lib/services/cli/perfTraceCommandService.d.ts +2 -2
- package/lib/services/cli/screenshotCommandService.d.ts +2 -2
- package/lib/services/cli/shaderCommandService.d.ts +2 -2
- package/lib/services/cli/statsCommandService.d.ts +2 -2
- package/lib/services/cliConnectionStatusService.d.ts +1 -1
- package/package.json +1 -1
- package/lib/cli/protocol.d.ts +0 -202
- package/lib/index-BaFR1FRV.js.map +0 -1
- package/lib/services/cli/cliConnectionStatus.d.ts +0 -25
- package/lib/services/cli/inspectableBridgeService.d.ts +0 -28
- package/lib/services/cli/inspectableCommandRegistry.d.ts +0 -69
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
import { type IReadonlyObservable } from "@babylonjs/core/index.js";
|
|
2
|
-
import { type IService } from "@babylonjs/shared-ui-components/modularTool/modularity/serviceDefinition.js";
|
|
3
|
-
/**
|
|
4
|
-
* The service identity for the CLI connection status.
|
|
5
|
-
*/
|
|
6
|
-
export declare const CliConnectionStatusIdentity: unique symbol;
|
|
7
|
-
/**
|
|
8
|
-
* Provides the connection status and enable/disable control for the Inspector CLI bridge.
|
|
9
|
-
*/
|
|
10
|
-
export interface ICliConnectionStatus extends IService<typeof CliConnectionStatusIdentity> {
|
|
11
|
-
/**
|
|
12
|
-
* Whether the bridge is enabled. When true, the bridge actively tries to
|
|
13
|
-
* maintain a WebSocket connection. When false, the bridge is disconnected
|
|
14
|
-
* and idle.
|
|
15
|
-
*/
|
|
16
|
-
isEnabled: boolean;
|
|
17
|
-
/**
|
|
18
|
-
* Whether the bridge WebSocket is currently connected.
|
|
19
|
-
*/
|
|
20
|
-
readonly isConnected: boolean;
|
|
21
|
-
/**
|
|
22
|
-
* Observable that fires when either {@link isEnabled} or {@link isConnected} changes.
|
|
23
|
-
*/
|
|
24
|
-
readonly onConnectionStatusChanged: IReadonlyObservable<void>;
|
|
25
|
-
}
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
import { type ServiceDefinition } from "@babylonjs/shared-ui-components/modularTool/modularity/serviceDefinition.js";
|
|
2
|
-
import { type ICliConnectionStatus } from "./cliConnectionStatus";
|
|
3
|
-
import { type IInspectableCommandRegistry } from "./inspectableCommandRegistry";
|
|
4
|
-
/**
|
|
5
|
-
* Options for the inspectable bridge service.
|
|
6
|
-
*/
|
|
7
|
-
export interface IInspectableBridgeServiceOptions {
|
|
8
|
-
/**
|
|
9
|
-
* The WebSocket port for the bridge's browser port.
|
|
10
|
-
*/
|
|
11
|
-
port: number;
|
|
12
|
-
/**
|
|
13
|
-
* The session display name sent to the bridge.
|
|
14
|
-
* Can be a getter to provide a dynamic value that is re-read
|
|
15
|
-
* each time the bridge queries session information.
|
|
16
|
-
*/
|
|
17
|
-
name: string;
|
|
18
|
-
/**
|
|
19
|
-
* Whether to automatically start connecting when the service is created.
|
|
20
|
-
*/
|
|
21
|
-
autoStart: boolean;
|
|
22
|
-
}
|
|
23
|
-
/**
|
|
24
|
-
* Creates the service definition for the InspectableBridgeService.
|
|
25
|
-
* @param options The options for connecting to the bridge.
|
|
26
|
-
* @returns A service definition that produces an IInspectableCommandRegistry.
|
|
27
|
-
*/
|
|
28
|
-
export declare function MakeInspectableBridgeServiceDefinition(options: IInspectableBridgeServiceOptions): ServiceDefinition<[IInspectableCommandRegistry, ICliConnectionStatus], []>;
|
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
import { type IDisposable } from "@babylonjs/core/index.js";
|
|
2
|
-
import { type IService } from "@babylonjs/shared-ui-components/modularTool/modularity/serviceDefinition.js";
|
|
3
|
-
/**
|
|
4
|
-
* The type of an inspectable command argument, which determines how
|
|
5
|
-
* the CLI processes the value before sending it to the browser.
|
|
6
|
-
*/
|
|
7
|
-
export type InspectableCommandArgType = "string" | "file";
|
|
8
|
-
/**
|
|
9
|
-
* Describes an argument for an inspectable command.
|
|
10
|
-
*/
|
|
11
|
-
export type InspectableCommandArg = {
|
|
12
|
-
/**
|
|
13
|
-
* The name of the argument.
|
|
14
|
-
*/
|
|
15
|
-
name: string;
|
|
16
|
-
/**
|
|
17
|
-
* A description of the argument.
|
|
18
|
-
*/
|
|
19
|
-
description: string;
|
|
20
|
-
/**
|
|
21
|
-
* Whether the argument is required.
|
|
22
|
-
*/
|
|
23
|
-
required?: boolean;
|
|
24
|
-
/**
|
|
25
|
-
* The type of the argument. Defaults to "string".
|
|
26
|
-
* When set to "file", the CLI reads the file at the given path
|
|
27
|
-
* and passes its contents as the argument value.
|
|
28
|
-
*/
|
|
29
|
-
type?: InspectableCommandArgType;
|
|
30
|
-
};
|
|
31
|
-
/**
|
|
32
|
-
* Describes a command that can be invoked from the CLI.
|
|
33
|
-
*/
|
|
34
|
-
export type InspectableCommandDescriptor = {
|
|
35
|
-
/**
|
|
36
|
-
* A unique identifier for the command.
|
|
37
|
-
*/
|
|
38
|
-
id: string;
|
|
39
|
-
/**
|
|
40
|
-
* A human-readable description of what the command does.
|
|
41
|
-
*/
|
|
42
|
-
description: string;
|
|
43
|
-
/**
|
|
44
|
-
* The arguments that this command accepts.
|
|
45
|
-
*/
|
|
46
|
-
args?: InspectableCommandArg[];
|
|
47
|
-
/**
|
|
48
|
-
* Executes the command with the given arguments and returns a result string.
|
|
49
|
-
* @param args A map of argument names to their values.
|
|
50
|
-
* @returns A promise that resolves to the result string.
|
|
51
|
-
*/
|
|
52
|
-
executeAsync: (args: Record<string, string>) => Promise<string>;
|
|
53
|
-
};
|
|
54
|
-
/**
|
|
55
|
-
* The service identity for the inspectable command registry.
|
|
56
|
-
*/
|
|
57
|
-
export declare const InspectableCommandRegistryIdentity: unique symbol;
|
|
58
|
-
/**
|
|
59
|
-
* A registry for commands that can be invoked from the Inspector CLI.
|
|
60
|
-
* @experimental
|
|
61
|
-
*/
|
|
62
|
-
export interface IInspectableCommandRegistry extends IService<typeof InspectableCommandRegistryIdentity> {
|
|
63
|
-
/**
|
|
64
|
-
* Registers a command that can be invoked from the Inspector CLI.
|
|
65
|
-
* @param descriptor The command descriptor.
|
|
66
|
-
* @returns A disposable token that unregisters the command when disposed.
|
|
67
|
-
*/
|
|
68
|
-
addCommand(descriptor: InspectableCommandDescriptor): IDisposable;
|
|
69
|
-
}
|